2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
50 #include "poll-loop.h"
58 #include "unaligned.h"
60 #include "openvswitch/vlog.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
);
93 /* A set of rules within a single OpenFlow table (oftable) that have the same
94 * values for the oftable's eviction_fields. A rule to be evicted, when one is
95 * needed, is taken from the eviction group that contains the greatest number
98 * An oftable owns any number of eviction groups, each of which contains any
101 * Membership in an eviction group is imprecise, based on the hash of the
102 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
103 * That is, if two rules have different eviction_fields, but those
104 * eviction_fields hash to the same value, then they will belong to the same
105 * eviction_group anyway.
107 * (When eviction is not enabled on an oftable, we don't track any eviction
108 * groups, to save time and space.) */
109 struct eviction_group
{
110 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
111 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
112 struct heap rules
; /* Contains "struct rule"s. */
115 static bool choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
116 OVS_REQUIRES(ofproto_mutex
);
117 static uint32_t rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*)
118 OVS_REQUIRES(ofproto_mutex
);;
119 static void eviction_group_add_rule(struct rule
*)
120 OVS_REQUIRES(ofproto_mutex
);
121 static void eviction_group_remove_rule(struct rule
*)
122 OVS_REQUIRES(ofproto_mutex
);
124 /* Criteria that flow_mod and other operations use for selecting rules on
125 * which to operate. */
126 struct rule_criteria
{
127 /* An OpenFlow table or 255 for all tables. */
130 /* OpenFlow matching criteria. Interpreted different in "loose" way by
131 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
132 * defined in the OpenFlow spec. */
135 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
136 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
137 * The rule will not be selected if M is 1 and B != C. */
139 ovs_be64 cookie_mask
;
141 /* Selection based on actions within a rule:
143 * If out_port != OFPP_ANY, selects only rules that output to out_port.
144 * If out_group != OFPG_ALL, select only rules that output to out_group. */
148 /* If true, collects only rules that are modifiable. */
150 bool include_readonly
;
153 static void rule_criteria_init(struct rule_criteria
*, uint8_t table_id
,
154 const struct match
*match
, int priority
,
155 ovs_be64 cookie
, ovs_be64 cookie_mask
,
156 ofp_port_t out_port
, uint32_t out_group
);
157 static void rule_criteria_require_rw(struct rule_criteria
*,
158 bool can_write_readonly
);
159 static void rule_criteria_destroy(struct rule_criteria
*);
161 static enum ofperr
collect_rules_loose(struct ofproto
*,
162 const struct rule_criteria
*,
163 struct rule_collection
*);
165 /* A packet that needs to be passed to rule_execute().
167 * (We can't do this immediately from ofopgroup_complete() because that holds
168 * ofproto_mutex, which rule_execute() needs released.) */
169 struct rule_execute
{
170 struct ovs_list list_node
; /* In struct ofproto's "rule_executes" list. */
171 struct rule
*rule
; /* Owns a reference to the rule. */
173 struct ofpbuf
*packet
; /* Owns the packet. */
176 static void run_rule_executes(struct ofproto
*) OVS_EXCLUDED(ofproto_mutex
);
177 static void destroy_rule_executes(struct ofproto
*);
179 struct learned_cookie
{
181 /* In struct ofproto's 'learned_cookies' hmap. */
182 struct hmap_node hmap_node
OVS_GUARDED_BY(ofproto_mutex
);
184 /* In 'dead_cookies' list when removed from hmap. */
185 struct ovs_list list_node
;
189 ovs_be64 cookie
OVS_GUARDED_BY(ofproto_mutex
);
190 uint8_t table_id
OVS_GUARDED_BY(ofproto_mutex
);
192 /* Number of references from "learn" actions.
194 * When this drops to 0, all of the flows in 'table_id' with the specified
195 * 'cookie' are deleted. */
196 int n
OVS_GUARDED_BY(ofproto_mutex
);
199 static const struct ofpact_learn
*next_learn_with_delete(
200 const struct rule_actions
*, const struct ofpact_learn
*start
);
202 static void learned_cookies_inc(struct ofproto
*, const struct rule_actions
*)
203 OVS_REQUIRES(ofproto_mutex
);
204 static void learned_cookies_dec(struct ofproto
*, const struct rule_actions
*,
205 struct ovs_list
*dead_cookies
)
206 OVS_REQUIRES(ofproto_mutex
);
207 static void learned_cookies_flush(struct ofproto
*, struct ovs_list
*dead_cookies
)
208 OVS_REQUIRES(ofproto_mutex
);
211 static void ofport_destroy__(struct ofport
*) OVS_EXCLUDED(ofproto_mutex
);
212 static void ofport_destroy(struct ofport
*);
214 static void update_port(struct ofproto
*, const char *devname
);
215 static int init_ports(struct ofproto
*);
216 static void reinit_ports(struct ofproto
*);
218 static long long int ofport_get_usage(const struct ofproto
*,
219 ofp_port_t ofp_port
);
220 static void ofport_set_usage(struct ofproto
*, ofp_port_t ofp_port
,
221 long long int last_used
);
222 static void ofport_remove_usage(struct ofproto
*, ofp_port_t ofp_port
);
226 * Keeps track of the currently used and recently used ofport values and is
227 * used to prevent immediate recycling of ofport values. */
228 struct ofport_usage
{
229 struct hmap_node hmap_node
; /* In struct ofproto's "ofport_usage" hmap. */
230 ofp_port_t ofp_port
; /* OpenFlow port number. */
231 long long int last_used
; /* Last time the 'ofp_port' was used. LLONG_MAX
232 represents in-use ofports. */
236 static void ofproto_rule_send_removed(struct rule
*, uint8_t reason
);
237 static bool rule_is_readonly(const struct rule
*);
238 static void ofproto_rule_remove__(struct ofproto
*, struct rule
*)
239 OVS_REQUIRES(ofproto_mutex
);
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
);
1335 /* Deletes 'rule' from 'ofproto'.
1337 * Within an ofproto implementation, this function allows an ofproto
1338 * implementation to destroy any rules that remain when its ->destruct()
1339 * function is called. This function is not suitable for use elsewhere in an
1340 * ofproto implementation.
1342 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1343 * Cycle" in ofproto-provider.h. */
1345 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1346 OVS_EXCLUDED(ofproto_mutex
)
1348 /* This skips the ofmonitor and flow-removed notifications because the
1349 * switch is being deleted and any OpenFlow channels have been or soon will
1351 ovs_mutex_lock(&ofproto_mutex
);
1352 oftable_remove_rule(rule
);
1353 ofproto
->ofproto_class
->rule_delete(rule
);
1354 ovs_mutex_unlock(&ofproto_mutex
);
1358 ofproto_flush__(struct ofproto
*ofproto
)
1359 OVS_EXCLUDED(ofproto_mutex
)
1361 struct oftable
*table
;
1363 /* This will flush all datapath flows. */
1364 if (ofproto
->ofproto_class
->flush
) {
1365 ofproto
->ofproto_class
->flush(ofproto
);
1368 /* XXX: There is a small race window here, where new datapath flows can be
1369 * created by upcall handlers based on the existing flow table. We can not
1370 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1371 * as then we could deadlock on syncing with the handler threads waiting on
1372 * the same mutex. */
1374 ovs_mutex_lock(&ofproto_mutex
);
1375 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1376 struct rule_collection rules
;
1379 if (table
->flags
& OFTABLE_HIDDEN
) {
1383 rule_collection_init(&rules
);
1385 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1386 rule_collection_add(&rules
, rule
);
1388 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
1389 rule_collection_destroy(&rules
);
1391 /* XXX: Concurrent handler threads may insert new learned flows based on
1392 * learn actions of the now deleted flows right after we release
1393 * 'ofproto_mutex'. */
1394 ovs_mutex_unlock(&ofproto_mutex
);
1397 static void delete_group(struct ofproto
*ofproto
, uint32_t group_id
);
1400 ofproto_destroy__(struct ofproto
*ofproto
)
1401 OVS_EXCLUDED(ofproto_mutex
)
1403 struct oftable
*table
;
1405 destroy_rule_executes(ofproto
);
1406 delete_group(ofproto
, OFPG_ALL
);
1408 guarded_list_destroy(&ofproto
->rule_executes
);
1409 ovs_rwlock_destroy(&ofproto
->groups_rwlock
);
1410 hmap_destroy(&ofproto
->groups
);
1412 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1413 free(ofproto
->name
);
1414 free(ofproto
->type
);
1415 free(ofproto
->mfr_desc
);
1416 free(ofproto
->hw_desc
);
1417 free(ofproto
->sw_desc
);
1418 free(ofproto
->serial_desc
);
1419 free(ofproto
->dp_desc
);
1420 hmap_destroy(&ofproto
->ports
);
1421 hmap_destroy(&ofproto
->ofport_usage
);
1422 shash_destroy(&ofproto
->port_by_name
);
1423 simap_destroy(&ofproto
->ofp_requests
);
1425 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1426 oftable_destroy(table
);
1428 free(ofproto
->tables
);
1430 ovs_assert(hindex_is_empty(&ofproto
->cookies
));
1431 hindex_destroy(&ofproto
->cookies
);
1433 ovs_assert(hmap_is_empty(&ofproto
->learned_cookies
));
1434 hmap_destroy(&ofproto
->learned_cookies
);
1436 free(ofproto
->vlan_bitmap
);
1438 ofproto
->ofproto_class
->dealloc(ofproto
);
1442 ofproto_destroy(struct ofproto
*p
)
1443 OVS_EXCLUDED(ofproto_mutex
)
1445 struct ofport
*ofport
, *next_ofport
;
1446 struct ofport_usage
*usage
, *next_usage
;
1453 meter_delete(p
, 1, p
->meter_features
.max_meters
);
1454 p
->meter_features
.max_meters
= 0;
1460 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1461 ofport_destroy(ofport
);
1464 HMAP_FOR_EACH_SAFE (usage
, next_usage
, hmap_node
, &p
->ofport_usage
) {
1465 hmap_remove(&p
->ofport_usage
, &usage
->hmap_node
);
1469 p
->ofproto_class
->destruct(p
);
1471 /* We should not postpone this because it involves deleting a listening
1472 * socket which we may want to reopen soon. 'connmgr' should not be used
1473 * by other threads */
1474 connmgr_destroy(p
->connmgr
);
1476 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1477 ovsrcu_postpone(ofproto_destroy__
, p
);
1480 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1481 * kernel datapath, for example, this destroys the datapath in the kernel, and
1482 * with the netdev-based datapath, it tears down the data structures that
1483 * represent the datapath.
1485 * The datapath should not be currently open as an ofproto. */
1487 ofproto_delete(const char *name
, const char *type
)
1489 const struct ofproto_class
*class = ofproto_class_find__(type
);
1490 return (!class ? EAFNOSUPPORT
1491 : !class->del
? EACCES
1492 : class->del(type
, name
));
1496 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1498 if (error
== ENOBUFS
) {
1499 reinit_ports(ofproto
);
1500 } else if (!error
) {
1501 update_port(ofproto
, devname
);
1507 ofproto_type_run(const char *datapath_type
)
1509 const struct ofproto_class
*class;
1512 datapath_type
= ofproto_normalize_type(datapath_type
);
1513 class = ofproto_class_find__(datapath_type
);
1515 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1516 if (error
&& error
!= EAGAIN
) {
1517 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1518 datapath_type
, ovs_strerror(error
));
1524 ofproto_type_wait(const char *datapath_type
)
1526 const struct ofproto_class
*class;
1528 datapath_type
= ofproto_normalize_type(datapath_type
);
1529 class = ofproto_class_find__(datapath_type
);
1531 if (class->type_wait
) {
1532 class->type_wait(datapath_type
);
1537 ofproto_run(struct ofproto
*p
)
1542 error
= p
->ofproto_class
->run(p
);
1543 if (error
&& error
!= EAGAIN
) {
1544 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, ovs_strerror(error
));
1547 run_rule_executes(p
);
1549 /* Restore the eviction group heap invariant occasionally. */
1550 if (p
->eviction_group_timer
< time_msec()) {
1553 p
->eviction_group_timer
= time_msec() + 1000;
1555 for (i
= 0; i
< p
->n_tables
; i
++) {
1556 struct oftable
*table
= &p
->tables
[i
];
1557 struct eviction_group
*evg
;
1560 if (!table
->eviction_fields
) {
1564 if (classifier_count(&table
->cls
) > 100000) {
1565 static struct vlog_rate_limit count_rl
=
1566 VLOG_RATE_LIMIT_INIT(1, 1);
1567 VLOG_WARN_RL(&count_rl
, "Table %"PRIuSIZE
" has an excessive"
1568 " number of rules: %d", i
,
1569 classifier_count(&table
->cls
));
1572 ovs_mutex_lock(&ofproto_mutex
);
1573 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1574 if (rule
->idle_timeout
|| rule
->hard_timeout
) {
1575 if (!rule
->eviction_group
) {
1576 eviction_group_add_rule(rule
);
1578 heap_raw_change(&rule
->evg_node
,
1579 rule_eviction_priority(p
, rule
));
1584 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1585 heap_rebuild(&evg
->rules
);
1587 ovs_mutex_unlock(&ofproto_mutex
);
1591 if (p
->ofproto_class
->port_poll
) {
1594 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1595 process_port_change(p
, error
, devname
);
1599 new_seq
= seq_read(connectivity_seq_get());
1600 if (new_seq
!= p
->change_seq
) {
1601 struct sset devnames
;
1602 const char *devname
;
1603 struct ofport
*ofport
;
1605 /* Update OpenFlow port status for any port whose netdev has changed.
1607 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1608 * destroyed, so it's not safe to update ports directly from the
1609 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1610 * need this two-phase approach. */
1611 sset_init(&devnames
);
1612 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1613 uint64_t port_change_seq
;
1615 port_change_seq
= netdev_get_change_seq(ofport
->netdev
);
1616 if (ofport
->change_seq
!= port_change_seq
) {
1617 ofport
->change_seq
= port_change_seq
;
1618 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1621 SSET_FOR_EACH (devname
, &devnames
) {
1622 update_port(p
, devname
);
1624 sset_destroy(&devnames
);
1626 p
->change_seq
= new_seq
;
1629 connmgr_run(p
->connmgr
, handle_openflow
);
1635 ofproto_wait(struct ofproto
*p
)
1637 p
->ofproto_class
->wait(p
);
1638 if (p
->ofproto_class
->port_poll_wait
) {
1639 p
->ofproto_class
->port_poll_wait(p
);
1641 seq_wait(connectivity_seq_get(), p
->change_seq
);
1642 connmgr_wait(p
->connmgr
);
1646 ofproto_is_alive(const struct ofproto
*p
)
1648 return connmgr_has_controllers(p
->connmgr
);
1651 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1652 * memory_report(). */
1654 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1656 const struct oftable
*table
;
1657 unsigned int n_rules
;
1659 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1662 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1663 n_rules
+= classifier_count(&table
->cls
);
1665 simap_increase(usage
, "rules", n_rules
);
1667 if (ofproto
->ofproto_class
->get_memory_usage
) {
1668 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1671 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1675 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1677 const struct ofproto_class
*class;
1679 datapath_type
= ofproto_normalize_type(datapath_type
);
1680 class = ofproto_class_find__(datapath_type
);
1682 if (class && class->type_get_memory_usage
) {
1683 class->type_get_memory_usage(datapath_type
, usage
);
1688 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1691 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1695 ofproto_free_ofproto_controller_info(struct shash
*info
)
1697 connmgr_free_controller_info(info
);
1700 /* Makes a deep copy of 'old' into 'port'. */
1702 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1704 port
->name
= xstrdup(old
->name
);
1705 port
->type
= xstrdup(old
->type
);
1706 port
->ofp_port
= old
->ofp_port
;
1709 /* Frees memory allocated to members of 'ofproto_port'.
1711 * Do not call this function on an ofproto_port obtained from
1712 * ofproto_port_dump_next(): that function retains ownership of the data in the
1715 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1717 free(ofproto_port
->name
);
1718 free(ofproto_port
->type
);
1721 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1723 * This function provides no status indication. An error status for the entire
1724 * dump operation is provided when it is completed by calling
1725 * ofproto_port_dump_done().
1728 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1729 const struct ofproto
*ofproto
)
1731 dump
->ofproto
= ofproto
;
1732 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1736 /* Attempts to retrieve another port from 'dump', which must have been created
1737 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1738 * 'port' and returns true. On failure, returns false.
1740 * Failure might indicate an actual error or merely that the last port has been
1741 * dumped. An error status for the entire dump operation is provided when it
1742 * is completed by calling ofproto_port_dump_done().
1744 * The ofproto owns the data stored in 'port'. It will remain valid until at
1745 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1746 * ofproto_port_dump_done(). */
1748 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1749 struct ofproto_port
*port
)
1751 const struct ofproto
*ofproto
= dump
->ofproto
;
1757 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1760 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1766 /* Completes port table dump operation 'dump', which must have been created
1767 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1768 * error-free, otherwise a positive errno value describing the problem. */
1770 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1772 const struct ofproto
*ofproto
= dump
->ofproto
;
1774 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1777 return dump
->error
== EOF
? 0 : dump
->error
;
1780 /* Returns the type to pass to netdev_open() when a datapath of type
1781 * 'datapath_type' has a port of type 'port_type', for a few special
1782 * cases when a netdev type differs from a port type. For example, when
1783 * using the userspace datapath, a port of type "internal" needs to be
1786 * Returns either 'type' itself or a string literal, which must not be
1789 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1791 const struct ofproto_class
*class;
1793 datapath_type
= ofproto_normalize_type(datapath_type
);
1794 class = ofproto_class_find__(datapath_type
);
1799 return (class->port_open_type
1800 ? class->port_open_type(datapath_type
, port_type
)
1804 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1805 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1806 * the port's OpenFlow port number.
1808 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1809 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1810 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1811 * 'ofp_portp' is non-null). */
1813 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1814 ofp_port_t
*ofp_portp
)
1816 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1819 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1821 const char *netdev_name
= netdev_get_name(netdev
);
1823 simap_put(&ofproto
->ofp_requests
, netdev_name
,
1824 ofp_to_u16(ofp_port
));
1825 update_port(ofproto
, netdev_name
);
1828 *ofp_portp
= OFPP_NONE
;
1830 struct ofproto_port ofproto_port
;
1832 error
= ofproto_port_query_by_name(ofproto
,
1833 netdev_get_name(netdev
),
1836 *ofp_portp
= ofproto_port
.ofp_port
;
1837 ofproto_port_destroy(&ofproto_port
);
1844 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1845 * initializes '*port' appropriately; on failure, returns a positive errno
1848 * The caller owns the data in 'ofproto_port' and must free it with
1849 * ofproto_port_destroy() when it is no longer needed. */
1851 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1852 struct ofproto_port
*port
)
1856 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1858 memset(port
, 0, sizeof *port
);
1863 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1864 * Returns 0 if successful, otherwise a positive errno. */
1866 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1868 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1869 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
1870 struct simap_node
*ofp_request_node
;
1873 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
1874 if (ofp_request_node
) {
1875 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
1878 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
1879 if (!error
&& ofport
) {
1880 /* 'name' is the netdev's name and update_port() is going to close the
1881 * netdev. Just in case update_port() refers to 'name' after it
1882 * destroys 'ofport', make a copy of it around the update_port()
1884 char *devname
= xstrdup(name
);
1885 update_port(ofproto
, devname
);
1892 flow_mod_init(struct ofputil_flow_mod
*fm
,
1893 const struct match
*match
, int priority
,
1894 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1895 enum ofp_flow_mod_command command
)
1897 memset(fm
, 0, sizeof *fm
);
1899 fm
->priority
= priority
;
1902 fm
->modify_cookie
= false;
1904 fm
->command
= command
;
1905 fm
->idle_timeout
= 0;
1906 fm
->hard_timeout
= 0;
1908 fm
->buffer_id
= UINT32_MAX
;
1909 fm
->out_port
= OFPP_ANY
;
1910 fm
->out_group
= OFPG_ANY
;
1912 fm
->ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
);
1913 fm
->ofpacts_len
= ofpacts_len
;
1914 fm
->delete_reason
= OFPRR_DELETE
;
1918 simple_flow_mod(struct ofproto
*ofproto
,
1919 const struct match
*match
, int priority
,
1920 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1921 enum ofp_flow_mod_command command
)
1923 struct ofputil_flow_mod fm
;
1925 flow_mod_init(&fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
1927 return handle_flow_mod__(ofproto
, &fm
, NULL
);
1930 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1931 * performs the 'n_actions' actions in 'actions'. The new flow will not
1934 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1935 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1936 * controllers; otherwise, it will be hidden.
1938 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1940 * This is a helper function for in-band control and fail-open. */
1942 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
1944 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1945 OVS_EXCLUDED(ofproto_mutex
)
1947 const struct rule
*rule
;
1950 /* First do a cheap check whether the rule we're looking for already exists
1951 * with the actions that we want. If it does, then we're done. */
1952 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1953 &ofproto
->tables
[0].cls
, match
, priority
));
1955 const struct rule_actions
*actions
= rule_get_actions(rule
);
1956 must_add
= !ofpacts_equal(actions
->ofpacts
, actions
->ofpacts_len
,
1957 ofpacts
, ofpacts_len
);
1962 /* If there's no such rule or the rule doesn't have the actions we want,
1963 * fall back to a executing a full flow mod. We can't optimize this at
1964 * all because we didn't take enough locks above to ensure that the flow
1965 * table didn't already change beneath us. */
1967 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
1968 OFPFC_MODIFY_STRICT
);
1972 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1973 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1974 * operation cannot be initiated now but may be retried later.
1976 * This is a helper function for in-band control and fail-open and the "learn"
1979 ofproto_flow_mod(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
)
1980 OVS_EXCLUDED(ofproto_mutex
)
1982 /* Optimize for the most common case of a repeated learn action.
1983 * If an identical flow already exists we only need to update its
1984 * 'modified' time. */
1985 if (fm
->command
== OFPFC_MODIFY_STRICT
&& fm
->table_id
!= OFPTT_ALL
1986 && !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
)) {
1987 struct oftable
*table
= &ofproto
->tables
[fm
->table_id
];
1991 rule
= rule_from_cls_rule(classifier_find_match_exactly(&table
->cls
,
1995 /* Reading many of the rule fields and writing on 'modified'
1996 * requires the rule->mutex. Also, rule->actions may change
1997 * if rule->mutex is not held. */
1998 const struct rule_actions
*actions
;
2000 ovs_mutex_lock(&rule
->mutex
);
2001 actions
= rule_get_actions(rule
);
2002 if (rule
->idle_timeout
== fm
->idle_timeout
2003 && rule
->hard_timeout
== fm
->hard_timeout
2004 && rule
->importance
== fm
->importance
2005 && rule
->flags
== (fm
->flags
& OFPUTIL_FF_STATE
)
2006 && (!fm
->modify_cookie
|| (fm
->new_cookie
== rule
->flow_cookie
))
2007 && ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
2008 actions
->ofpacts
, actions
->ofpacts_len
)) {
2009 /* Rule already exists and need not change, only update the
2010 modified timestamp. */
2011 rule
->modified
= time_msec();
2014 ovs_mutex_unlock(&rule
->mutex
);
2022 return handle_flow_mod__(ofproto
, fm
, NULL
);
2025 /* Searches for a rule with matching criteria exactly equal to 'target' in
2026 * ofproto's table 0 and, if it finds one, deletes it.
2028 * This is a helper function for in-band control and fail-open. */
2030 ofproto_delete_flow(struct ofproto
*ofproto
,
2031 const struct match
*target
, int priority
)
2032 OVS_EXCLUDED(ofproto_mutex
)
2034 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
2037 /* First do a cheap check whether the rule we're looking for has already
2038 * been deleted. If so, then we're done. */
2039 rule
= rule_from_cls_rule(classifier_find_match_exactly(cls
, target
,
2045 /* Execute a flow mod. We can't optimize this at all because we didn't
2046 * take enough locks above to ensure that the flow table didn't already
2047 * change beneath us. */
2048 simple_flow_mod(ofproto
, target
, priority
, NULL
, 0, OFPFC_DELETE_STRICT
);
2051 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2052 * the flows required by in-band control and fail-open. */
2054 ofproto_flush_flows(struct ofproto
*ofproto
)
2056 COVERAGE_INC(ofproto_flush
);
2057 ofproto_flush__(ofproto
);
2058 connmgr_flushed(ofproto
->connmgr
);
2062 reinit_ports(struct ofproto
*p
)
2064 struct ofproto_port_dump dump
;
2065 struct sset devnames
;
2066 struct ofport
*ofport
;
2067 struct ofproto_port ofproto_port
;
2068 const char *devname
;
2070 COVERAGE_INC(ofproto_reinit_ports
);
2072 sset_init(&devnames
);
2073 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2074 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
2076 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2077 sset_add(&devnames
, ofproto_port
.name
);
2080 SSET_FOR_EACH (devname
, &devnames
) {
2081 update_port(p
, devname
);
2083 sset_destroy(&devnames
);
2087 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2091 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2092 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2094 if (port_idx
>= ofproto
->max_ports
2095 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2096 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2097 long long int last_used_at
, lru
= LLONG_MAX
;
2099 /* Search for a free OpenFlow port number. We try not to
2100 * immediately reuse them to prevent problems due to old
2103 * We limit the automatically assigned port numbers to the lower half
2104 * of the port range, to reserve the upper half for assignment by
2107 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2108 ofproto
->alloc_port_no
= 1;
2110 last_used_at
= ofport_get_usage(ofproto
,
2111 u16_to_ofp(ofproto
->alloc_port_no
));
2112 if (!last_used_at
) {
2113 port_idx
= ofproto
->alloc_port_no
;
2115 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2116 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2117 * more than an hour ago, consider it usable. */
2118 ofport_remove_usage(ofproto
,
2119 u16_to_ofp(ofproto
->alloc_port_no
));
2120 port_idx
= ofproto
->alloc_port_no
;
2122 } else if (last_used_at
< lru
) {
2124 lru_ofport
= ofproto
->alloc_port_no
;
2127 if (ofproto
->alloc_port_no
== end_port_no
) {
2129 port_idx
= lru_ofport
;
2136 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2137 return u16_to_ofp(port_idx
);
2141 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2143 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2144 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2148 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2149 * pointer if the netdev cannot be opened. On success, also fills in
2151 static struct netdev
*
2152 ofport_open(struct ofproto
*ofproto
,
2153 struct ofproto_port
*ofproto_port
,
2154 struct ofputil_phy_port
*pp
)
2156 enum netdev_flags flags
;
2157 struct netdev
*netdev
;
2160 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2162 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
2163 "cannot be opened (%s)",
2165 ofproto_port
->name
, ofproto_port
->ofp_port
,
2166 ofproto_port
->name
, ovs_strerror(error
));
2170 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2171 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2172 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2174 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2175 ofproto_port
->name
);
2178 pp
->port_no
= ofproto_port
->ofp_port
;
2179 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
2180 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2181 netdev_get_flags(netdev
, &flags
);
2182 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2183 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2184 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2185 &pp
->supported
, &pp
->peer
);
2186 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2187 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2192 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2193 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2196 ofport_equal(const struct ofputil_phy_port
*a
,
2197 const struct ofputil_phy_port
*b
)
2199 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2200 && a
->state
== b
->state
2201 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2202 && a
->curr
== b
->curr
2203 && a
->advertised
== b
->advertised
2204 && a
->supported
== b
->supported
2205 && a
->peer
== b
->peer
2206 && a
->curr_speed
== b
->curr_speed
2207 && a
->max_speed
== b
->max_speed
);
2210 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2211 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2212 * one with the same name or port number). */
2214 ofport_install(struct ofproto
*p
,
2215 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2217 const char *netdev_name
= netdev_get_name(netdev
);
2218 struct ofport
*ofport
;
2221 /* Create ofport. */
2222 ofport
= p
->ofproto_class
->port_alloc();
2227 ofport
->ofproto
= p
;
2228 ofport
->netdev
= netdev
;
2229 ofport
->change_seq
= netdev_get_change_seq(netdev
);
2231 ofport
->ofp_port
= pp
->port_no
;
2232 ofport
->created
= time_msec();
2234 /* Add port to 'p'. */
2235 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2236 hash_ofp_port(ofport
->ofp_port
));
2237 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2239 update_mtu(p
, ofport
);
2241 /* Let the ofproto_class initialize its private data. */
2242 error
= p
->ofproto_class
->port_construct(ofport
);
2246 connmgr_send_port_status(p
->connmgr
, NULL
, pp
, OFPPR_ADD
);
2250 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2251 p
->name
, netdev_name
, ovs_strerror(error
));
2253 ofport_destroy__(ofport
);
2255 netdev_close(netdev
);
2259 /* Removes 'ofport' from 'p' and destroys it. */
2261 ofport_remove(struct ofport
*ofport
)
2263 connmgr_send_port_status(ofport
->ofproto
->connmgr
, NULL
, &ofport
->pp
,
2265 ofport_destroy(ofport
);
2268 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2271 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2273 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2275 ofport_remove(port
);
2279 /* Updates 'port' with new 'pp' description.
2281 * Does not handle a name or port number change. The caller must implement
2282 * such a change as a delete followed by an add. */
2284 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2286 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
2287 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2288 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2289 port
->pp
.state
= ((port
->pp
.state
& ~OFPUTIL_PS_LINK_DOWN
)
2290 | (pp
->state
& OFPUTIL_PS_LINK_DOWN
));
2291 port
->pp
.curr
= pp
->curr
;
2292 port
->pp
.advertised
= pp
->advertised
;
2293 port
->pp
.supported
= pp
->supported
;
2294 port
->pp
.peer
= pp
->peer
;
2295 port
->pp
.curr_speed
= pp
->curr_speed
;
2296 port
->pp
.max_speed
= pp
->max_speed
;
2298 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2299 &port
->pp
, OFPPR_MODIFY
);
2302 /* Update OpenFlow 'state' in 'port' and notify controller. */
2304 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2306 if (port
->pp
.state
!= state
) {
2307 port
->pp
.state
= state
;
2308 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2309 &port
->pp
, OFPPR_MODIFY
);
2314 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2316 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2318 if (port
->ofproto
->ofproto_class
->set_realdev
) {
2319 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
2321 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2322 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2324 if (port
->ofproto
->ofproto_class
->set_rstp_port
) {
2325 port
->ofproto
->ofproto_class
->set_rstp_port(port
, NULL
);
2327 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2328 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2330 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2331 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2337 ofport_destroy__(struct ofport
*port
)
2339 struct ofproto
*ofproto
= port
->ofproto
;
2340 const char *name
= netdev_get_name(port
->netdev
);
2342 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2343 shash_delete(&ofproto
->port_by_name
,
2344 shash_find(&ofproto
->port_by_name
, name
));
2346 netdev_close(port
->netdev
);
2347 ofproto
->ofproto_class
->port_dealloc(port
);
2351 ofport_destroy(struct ofport
*port
)
2354 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2355 port
->ofproto
->ofproto_class
->port_destruct(port
);
2356 ofport_destroy__(port
);
2361 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2363 struct ofport
*port
;
2365 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2367 if (port
->ofp_port
== ofp_port
) {
2374 static long long int
2375 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2377 struct ofport_usage
*usage
;
2379 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2380 &ofproto
->ofport_usage
) {
2381 if (usage
->ofp_port
== ofp_port
) {
2382 return usage
->last_used
;
2389 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2390 long long int last_used
)
2392 struct ofport_usage
*usage
;
2393 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2394 &ofproto
->ofport_usage
) {
2395 if (usage
->ofp_port
== ofp_port
) {
2396 usage
->last_used
= last_used
;
2400 ovs_assert(last_used
== LLONG_MAX
);
2402 usage
= xmalloc(sizeof *usage
);
2403 usage
->ofp_port
= ofp_port
;
2404 usage
->last_used
= last_used
;
2405 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2406 hash_ofp_port(ofp_port
));
2410 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2412 struct ofport_usage
*usage
;
2413 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2414 &ofproto
->ofport_usage
) {
2415 if (usage
->ofp_port
== ofp_port
) {
2416 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2424 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2426 struct ofproto
*ofproto
= port
->ofproto
;
2429 if (ofproto
->ofproto_class
->port_get_stats
) {
2430 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2439 update_port(struct ofproto
*ofproto
, const char *name
)
2441 struct ofproto_port ofproto_port
;
2442 struct ofputil_phy_port pp
;
2443 struct netdev
*netdev
;
2444 struct ofport
*port
;
2446 COVERAGE_INC(ofproto_update_port
);
2448 /* Fetch 'name''s location and properties from the datapath. */
2449 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2450 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2454 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2455 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2456 struct netdev
*old_netdev
= port
->netdev
;
2458 /* 'name' hasn't changed location. Any properties changed? */
2459 if (!ofport_equal(&port
->pp
, &pp
)) {
2460 ofport_modified(port
, &pp
);
2463 update_mtu(ofproto
, port
);
2465 /* Install the newly opened netdev in case it has changed.
2466 * Don't close the old netdev yet in case port_modified has to
2467 * remove a retained reference to it.*/
2468 port
->netdev
= netdev
;
2469 port
->change_seq
= netdev_get_change_seq(netdev
);
2471 if (port
->ofproto
->ofproto_class
->port_modified
) {
2472 port
->ofproto
->ofproto_class
->port_modified(port
);
2475 netdev_close(old_netdev
);
2477 /* If 'port' is nonnull then its name differs from 'name' and thus
2478 * we should delete it. If we think there's a port named 'name'
2479 * then its port number must be wrong now so delete it too. */
2481 ofport_remove(port
);
2483 ofport_remove_with_name(ofproto
, name
);
2484 ofport_install(ofproto
, netdev
, &pp
);
2487 /* Any port named 'name' is gone now. */
2488 ofport_remove_with_name(ofproto
, name
);
2490 ofproto_port_destroy(&ofproto_port
);
2494 init_ports(struct ofproto
*p
)
2496 struct ofproto_port_dump dump
;
2497 struct ofproto_port ofproto_port
;
2498 struct shash_node
*node
, *next
;
2500 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2501 const char *name
= ofproto_port
.name
;
2503 if (shash_find(&p
->port_by_name
, name
)) {
2504 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2507 struct ofputil_phy_port pp
;
2508 struct netdev
*netdev
;
2510 /* Check if an OpenFlow port number had been requested. */
2511 node
= shash_find(&init_ofp_ports
, name
);
2513 const struct iface_hint
*iface_hint
= node
->data
;
2514 simap_put(&p
->ofp_requests
, name
,
2515 ofp_to_u16(iface_hint
->ofp_port
));
2518 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2520 ofport_install(p
, netdev
, &pp
);
2521 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2522 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2523 ofp_to_u16(ofproto_port
.ofp_port
));
2529 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2530 struct iface_hint
*iface_hint
= node
->data
;
2532 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2533 free(iface_hint
->br_name
);
2534 free(iface_hint
->br_type
);
2536 shash_delete(&init_ofp_ports
, node
);
2543 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2544 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2546 find_min_mtu(struct ofproto
*p
)
2548 struct ofport
*ofport
;
2551 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2552 struct netdev
*netdev
= ofport
->netdev
;
2555 /* Skip any internal ports, since that's what we're trying to
2557 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2561 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2564 if (!mtu
|| dev_mtu
< mtu
) {
2569 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2572 /* Update MTU of all datapath devices on 'p' to the minimum of the
2573 * non-datapath ports in event of 'port' added or changed. */
2575 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2577 struct ofport
*ofport
;
2578 struct netdev
*netdev
= port
->netdev
;
2579 int dev_mtu
, old_min
;
2581 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2585 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2586 if (dev_mtu
> p
->min_mtu
) {
2587 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2588 dev_mtu
= p
->min_mtu
;
2591 port
->mtu
= dev_mtu
;
2595 /* For non-internal port find new min mtu. */
2596 old_min
= p
->min_mtu
;
2597 port
->mtu
= dev_mtu
;
2598 p
->min_mtu
= find_min_mtu(p
);
2599 if (p
->min_mtu
== old_min
) {
2603 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2604 struct netdev
*netdev
= ofport
->netdev
;
2606 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2607 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2608 ofport
->mtu
= p
->min_mtu
;
2615 ofproto_rule_destroy__(struct rule
*rule
)
2616 OVS_NO_THREAD_SAFETY_ANALYSIS
2618 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2619 rule_actions_destroy(rule_get_actions(rule
));
2620 ovs_mutex_destroy(&rule
->mutex
);
2621 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2625 rule_destroy_cb(struct rule
*rule
)
2627 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2628 ofproto_rule_destroy__(rule
);
2632 ofproto_rule_ref(struct rule
*rule
)
2635 ovs_refcount_ref(&rule
->ref_count
);
2640 ofproto_rule_try_ref(struct rule
*rule
)
2643 return ovs_refcount_try_ref_rcu(&rule
->ref_count
);
2648 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2649 * ref_count reaches 0.
2651 * Use of RCU allows short term use (between RCU quiescent periods) without
2652 * keeping a reference. A reference must be taken if the rule needs to
2653 * stay around accross the RCU quiescent periods. */
2655 ofproto_rule_unref(struct rule
*rule
)
2657 if (rule
&& ovs_refcount_unref_relaxed(&rule
->ref_count
) == 1) {
2658 ovsrcu_postpone(rule_destroy_cb
, rule
);
2663 ofproto_group_ref(struct ofgroup
*group
)
2666 ovs_refcount_ref(&group
->ref_count
);
2671 ofproto_group_unref(struct ofgroup
*group
)
2673 if (group
&& ovs_refcount_unref(&group
->ref_count
) == 1) {
2674 group
->ofproto
->ofproto_class
->group_destruct(group
);
2675 ofputil_bucket_list_destroy(&group
->buckets
);
2676 group
->ofproto
->ofproto_class
->group_dealloc(group
);
2680 static uint32_t get_provider_meter_id(const struct ofproto
*,
2681 uint32_t of_meter_id
);
2683 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2684 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2685 const struct rule_actions
*
2686 rule_actions_create(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2688 struct rule_actions
*actions
;
2690 actions
= xmalloc(sizeof *actions
+ ofpacts_len
);
2691 actions
->ofpacts_len
= ofpacts_len
;
2692 actions
->has_meter
= ofpacts_get_meter(ofpacts
, ofpacts_len
) != 0;
2693 memcpy(actions
->ofpacts
, ofpacts
, ofpacts_len
);
2695 actions
->has_learn_with_delete
= (next_learn_with_delete(actions
, NULL
)
2701 /* Free the actions after the RCU quiescent period is reached. */
2703 rule_actions_destroy(const struct rule_actions
*actions
)
2706 ovsrcu_postpone(free
, CONST_CAST(struct rule_actions
*, actions
));
2710 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2711 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2713 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2714 OVS_REQUIRES(ofproto_mutex
)
2716 if (port
== OFPP_ANY
) {
2719 const struct rule_actions
*actions
= rule_get_actions(rule
);
2720 return ofpacts_output_to_port(actions
->ofpacts
,
2721 actions
->ofpacts_len
, port
);
2725 /* Returns true if 'rule' has group and equals group_id. */
2727 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
2728 OVS_REQUIRES(ofproto_mutex
)
2730 if (group_id
== OFPG_ANY
) {
2733 const struct rule_actions
*actions
= rule_get_actions(rule
);
2734 return ofpacts_output_to_group(actions
->ofpacts
,
2735 actions
->ofpacts_len
, group_id
);
2740 rule_execute_destroy(struct rule_execute
*e
)
2742 ofproto_rule_unref(e
->rule
);
2743 list_remove(&e
->list_node
);
2747 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2748 * by passing them to the ofproto provider. */
2750 run_rule_executes(struct ofproto
*ofproto
)
2751 OVS_EXCLUDED(ofproto_mutex
)
2753 struct rule_execute
*e
, *next
;
2754 struct ovs_list executes
;
2756 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2757 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2760 flow_extract(e
->packet
, NULL
, &flow
);
2761 flow
.in_port
.ofp_port
= e
->in_port
;
2762 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
2764 rule_execute_destroy(e
);
2768 /* Destroys and discards all "rule_execute" operations queued up in
2769 * ofproto->rule_executes. */
2771 destroy_rule_executes(struct ofproto
*ofproto
)
2773 struct rule_execute
*e
, *next
;
2774 struct ovs_list executes
;
2776 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2777 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2778 ofpbuf_delete(e
->packet
);
2779 rule_execute_destroy(e
);
2784 rule_is_readonly(const struct rule
*rule
)
2786 const struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
2787 return (table
->flags
& OFTABLE_READONLY
) != 0;
2791 hash_learned_cookie(ovs_be64 cookie_
, uint8_t table_id
)
2793 uint64_t cookie
= (OVS_FORCE
uint64_t) cookie_
;
2794 return hash_3words(cookie
, cookie
>> 32, table_id
);
2798 learned_cookies_update_one__(struct ofproto
*ofproto
,
2799 const struct ofpact_learn
*learn
,
2800 int delta
, struct ovs_list
*dead_cookies
)
2801 OVS_REQUIRES(ofproto_mutex
)
2803 uint32_t hash
= hash_learned_cookie(learn
->cookie
, learn
->table_id
);
2804 struct learned_cookie
*c
;
2806 HMAP_FOR_EACH_WITH_HASH (c
, u
.hmap_node
, hash
, &ofproto
->learned_cookies
) {
2807 if (c
->cookie
== learn
->cookie
&& c
->table_id
== learn
->table_id
) {
2809 ovs_assert(c
->n
>= 0);
2812 hmap_remove(&ofproto
->learned_cookies
, &c
->u
.hmap_node
);
2813 list_push_back(dead_cookies
, &c
->u
.list_node
);
2820 ovs_assert(delta
> 0);
2821 c
= xmalloc(sizeof *c
);
2822 hmap_insert(&ofproto
->learned_cookies
, &c
->u
.hmap_node
, hash
);
2823 c
->cookie
= learn
->cookie
;
2824 c
->table_id
= learn
->table_id
;
2828 static const struct ofpact_learn
*
2829 next_learn_with_delete(const struct rule_actions
*actions
,
2830 const struct ofpact_learn
*start
)
2832 const struct ofpact
*pos
;
2834 for (pos
= start
? ofpact_next(&start
->ofpact
) : actions
->ofpacts
;
2835 pos
< ofpact_end(actions
->ofpacts
, actions
->ofpacts_len
);
2836 pos
= ofpact_next(pos
)) {
2837 if (pos
->type
== OFPACT_LEARN
) {
2838 const struct ofpact_learn
*learn
= ofpact_get_LEARN(pos
);
2839 if (learn
->flags
& NX_LEARN_F_DELETE_LEARNED
) {
2849 learned_cookies_update__(struct ofproto
*ofproto
,
2850 const struct rule_actions
*actions
,
2851 int delta
, struct ovs_list
*dead_cookies
)
2852 OVS_REQUIRES(ofproto_mutex
)
2854 if (actions
->has_learn_with_delete
) {
2855 const struct ofpact_learn
*learn
;
2857 for (learn
= next_learn_with_delete(actions
, NULL
); learn
;
2858 learn
= next_learn_with_delete(actions
, learn
)) {
2859 learned_cookies_update_one__(ofproto
, learn
, delta
, dead_cookies
);
2865 learned_cookies_inc(struct ofproto
*ofproto
,
2866 const struct rule_actions
*actions
)
2867 OVS_REQUIRES(ofproto_mutex
)
2869 learned_cookies_update__(ofproto
, actions
, +1, NULL
);
2873 learned_cookies_dec(struct ofproto
*ofproto
,
2874 const struct rule_actions
*actions
,
2875 struct ovs_list
*dead_cookies
)
2876 OVS_REQUIRES(ofproto_mutex
)
2878 learned_cookies_update__(ofproto
, actions
, -1, dead_cookies
);
2882 learned_cookies_flush(struct ofproto
*ofproto
, struct ovs_list
*dead_cookies
)
2883 OVS_REQUIRES(ofproto_mutex
)
2885 struct learned_cookie
*c
, *next
;
2887 LIST_FOR_EACH_SAFE (c
, next
, u
.list_node
, dead_cookies
) {
2888 struct rule_criteria criteria
;
2889 struct rule_collection rules
;
2892 match_init_catchall(&match
);
2893 rule_criteria_init(&criteria
, c
->table_id
, &match
, 0,
2894 c
->cookie
, OVS_BE64_MAX
, OFPP_ANY
, OFPG_ANY
);
2895 rule_criteria_require_rw(&criteria
, false);
2896 collect_rules_loose(ofproto
, &criteria
, &rules
);
2897 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
2898 rule_criteria_destroy(&criteria
);
2899 rule_collection_destroy(&rules
);
2901 list_remove(&c
->u
.list_node
);
2907 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2909 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
2914 query_tables(struct ofproto
*ofproto
,
2915 struct ofputil_table_features
**featuresp
,
2916 struct ofputil_table_stats
**statsp
)
2918 struct mf_bitmap rw_fields
= oxm_writable_fields();
2919 struct mf_bitmap match
= oxm_matchable_fields();
2920 struct mf_bitmap mask
= oxm_maskable_fields();
2922 struct ofputil_table_features
*features
;
2923 struct ofputil_table_stats
*stats
;
2926 features
= *featuresp
= xcalloc(ofproto
->n_tables
, sizeof *features
);
2927 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2928 struct ofputil_table_features
*f
= &features
[i
];
2931 sprintf(f
->name
, "table%d", i
);
2932 f
->metadata_match
= OVS_BE64_MAX
;
2933 f
->metadata_write
= OVS_BE64_MAX
;
2934 atomic_read_relaxed(&ofproto
->tables
[i
].miss_config
, &f
->miss_config
);
2935 f
->max_entries
= 1000000;
2937 bool more_tables
= false;
2938 for (int j
= i
+ 1; j
< ofproto
->n_tables
; j
++) {
2939 if (!(ofproto
->tables
[j
].flags
& OFTABLE_HIDDEN
)) {
2940 bitmap_set1(f
->nonmiss
.next
, j
);
2944 f
->nonmiss
.instructions
= (1u << N_OVS_INSTRUCTIONS
) - 1;
2946 f
->nonmiss
.instructions
&= ~(1u << OVSINST_OFPIT11_GOTO_TABLE
);
2948 f
->nonmiss
.write
.ofpacts
= (UINT64_C(1) << N_OFPACTS
) - 1;
2949 f
->nonmiss
.write
.set_fields
= rw_fields
;
2950 f
->nonmiss
.apply
= f
->nonmiss
.write
;
2951 f
->miss
= f
->nonmiss
;
2955 f
->wildcard
= match
;
2959 stats
= *statsp
= xcalloc(ofproto
->n_tables
, sizeof *stats
);
2960 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2961 struct ofputil_table_stats
*s
= &stats
[i
];
2962 struct classifier
*cls
= &ofproto
->tables
[i
].cls
;
2965 s
->active_count
= classifier_count(cls
);
2971 ofproto
->ofproto_class
->query_tables(ofproto
, features
, stats
);
2973 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2974 const struct oftable
*table
= &ofproto
->tables
[i
];
2975 struct ofputil_table_features
*f
= &features
[i
];
2978 ovs_strzcpy(f
->name
, table
->name
, sizeof f
->name
);
2981 if (table
->max_flows
< f
->max_entries
) {
2982 f
->max_entries
= table
->max_flows
;
2988 query_switch_features(struct ofproto
*ofproto
,
2989 bool *arp_match_ip
, uint64_t *ofpacts
)
2991 struct ofputil_table_features
*features
, *f
;
2993 *arp_match_ip
= false;
2996 query_tables(ofproto
, &features
, NULL
);
2997 for (f
= features
; f
< &features
[ofproto
->n_tables
]; f
++) {
2998 *ofpacts
|= f
->nonmiss
.apply
.ofpacts
| f
->miss
.apply
.ofpacts
;
2999 if (bitmap_is_set(f
->match
.bm
, MFF_ARP_SPA
) ||
3000 bitmap_is_set(f
->match
.bm
, MFF_ARP_TPA
)) {
3001 *arp_match_ip
= true;
3007 ovs_assert(*ofpacts
& (UINT64_C(1) << OFPACT_OUTPUT
));
3011 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3013 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3014 struct ofputil_switch_features features
;
3015 struct ofport
*port
;
3019 query_switch_features(ofproto
, &arp_match_ip
, &features
.ofpacts
);
3021 features
.datapath_id
= ofproto
->datapath_id
;
3022 features
.n_buffers
= pktbuf_capacity();
3023 features
.n_tables
= ofproto_get_n_visible_tables(ofproto
);
3024 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
3025 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
|
3026 OFPUTIL_C_GROUP_STATS
);
3028 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
3030 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3031 features
.auxiliary_id
= 0;
3032 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
3034 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3035 ofputil_put_switch_features_port(&port
->pp
, b
);
3038 ofconn_send_reply(ofconn
, b
);
3043 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3045 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3046 struct ofp_switch_config
*osc
;
3047 enum ofp_config_flags flags
;
3051 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
3052 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
3053 flags
= ofproto
->frag_handling
;
3054 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3055 if (oh
->version
< OFP13_VERSION
3056 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
3057 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
3059 osc
->flags
= htons(flags
);
3060 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
3061 ofconn_send_reply(ofconn
, buf
);
3067 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3069 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
3070 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3071 uint16_t flags
= ntohs(osc
->flags
);
3073 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
3074 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
3075 enum ofp_config_flags cur
= ofproto
->frag_handling
;
3076 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
3078 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
3080 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
3081 ofproto
->frag_handling
= next
;
3083 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
3085 ofputil_frag_handling_to_string(next
));
3089 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3090 ofconn_set_invalid_ttl_to_controller(ofconn
,
3091 (oh
->version
< OFP13_VERSION
3092 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
3094 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
3099 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3100 * error message code for the caller to propagate upward. Otherwise, returns
3103 * The log message mentions 'msg_type'. */
3105 reject_slave_controller(struct ofconn
*ofconn
)
3107 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
3108 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
3109 return OFPERR_OFPBRC_EPERM
;
3115 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3118 * - If they use a meter, then 'ofproto' has that meter configured.
3120 * - If they use any groups, then 'ofproto' has that group configured.
3122 * Returns 0 if successful, otherwise an OpenFlow error. */
3124 ofproto_check_ofpacts(struct ofproto
*ofproto
,
3125 const struct ofpact ofpacts
[], size_t ofpacts_len
)
3127 const struct ofpact
*a
;
3130 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
3131 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
3132 return OFPERR_OFPMMFC_INVALID_METER
;
3135 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3136 if (a
->type
== OFPACT_GROUP
3137 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
3138 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
3146 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3148 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3149 struct ofputil_packet_out po
;
3150 struct ofpbuf
*payload
;
3151 uint64_t ofpacts_stub
[1024 / 8];
3152 struct ofpbuf ofpacts
;
3156 COVERAGE_INC(ofproto_packet_out
);
3158 error
= reject_slave_controller(ofconn
);
3163 /* Decode message. */
3164 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3165 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
3167 goto exit_free_ofpacts
;
3169 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
3170 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
3171 error
= OFPERR_OFPBRC_BAD_PORT
;
3172 goto exit_free_ofpacts
;
3176 if (po
.buffer_id
!= UINT32_MAX
) {
3177 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
3178 if (error
|| !payload
) {
3179 goto exit_free_ofpacts
;
3182 /* Ensure that the L3 header is 32-bit aligned. */
3183 payload
= ofpbuf_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
3186 /* Verify actions against packet, then send packet if successful. */
3187 flow_extract(payload
, NULL
, &flow
);
3188 flow
.in_port
.ofp_port
= po
.in_port
;
3189 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
3191 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
3192 po
.ofpacts
, po
.ofpacts_len
);
3194 ofpbuf_delete(payload
);
3197 ofpbuf_uninit(&ofpacts
);
3203 update_port_config(struct ofconn
*ofconn
, struct ofport
*port
,
3204 enum ofputil_port_config config
,
3205 enum ofputil_port_config mask
)
3207 enum ofputil_port_config toggle
= (config
^ port
->pp
.config
) & mask
;
3209 if (toggle
& OFPUTIL_PC_PORT_DOWN
3210 && (config
& OFPUTIL_PC_PORT_DOWN
3211 ? netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
)
3212 : netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
))) {
3213 /* We tried to bring the port up or down, but it failed, so don't
3214 * update the "down" bit. */
3215 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
3219 enum ofputil_port_config old_config
= port
->pp
.config
;
3220 port
->pp
.config
^= toggle
;
3221 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
3222 connmgr_send_port_status(port
->ofproto
->connmgr
, ofconn
, &port
->pp
,
3228 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3230 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3231 struct ofputil_port_mod pm
;
3232 struct ofport
*port
;
3235 error
= reject_slave_controller(ofconn
);
3240 error
= ofputil_decode_port_mod(oh
, &pm
, false);
3245 port
= ofproto_get_port(p
, pm
.port_no
);
3247 return OFPERR_OFPPMFC_BAD_PORT
;
3248 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
3249 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3251 update_port_config(ofconn
, port
, pm
.config
, pm
.mask
);
3253 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
3260 handle_desc_stats_request(struct ofconn
*ofconn
,
3261 const struct ofp_header
*request
)
3263 static const char *default_mfr_desc
= "Nicira, Inc.";
3264 static const char *default_hw_desc
= "Open vSwitch";
3265 static const char *default_sw_desc
= VERSION
;
3266 static const char *default_serial_desc
= "None";
3267 static const char *default_dp_desc
= "None";
3269 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3270 struct ofp_desc_stats
*ods
;
3273 msg
= ofpraw_alloc_stats_reply(request
, 0);
3274 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3275 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3276 sizeof ods
->mfr_desc
);
3277 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3278 sizeof ods
->hw_desc
);
3279 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3280 sizeof ods
->sw_desc
);
3281 ovs_strlcpy(ods
->serial_num
,
3282 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3283 sizeof ods
->serial_num
);
3284 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3285 sizeof ods
->dp_desc
);
3286 ofconn_send_reply(ofconn
, msg
);
3292 handle_table_stats_request(struct ofconn
*ofconn
,
3293 const struct ofp_header
*request
)
3295 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3296 struct ofputil_table_features
*features
;
3297 struct ofputil_table_stats
*stats
;
3298 struct ofpbuf
*reply
;
3301 query_tables(ofproto
, &features
, &stats
);
3303 reply
= ofputil_encode_table_stats_reply(request
);
3304 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3305 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3306 ofputil_append_table_stats_reply(reply
, &stats
[i
], &features
[i
]);
3309 ofconn_send_reply(ofconn
, reply
);
3318 handle_table_features_request(struct ofconn
*ofconn
,
3319 const struct ofp_header
*request
)
3321 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3322 struct ofputil_table_features
*features
;
3323 struct ovs_list replies
;
3327 ofpbuf_use_const(&msg
, request
, ntohs(request
->length
));
3328 ofpraw_pull_assert(&msg
);
3329 if (ofpbuf_size(&msg
) || ofpmp_more(request
)) {
3330 return OFPERR_OFPTFFC_EPERM
;
3333 query_tables(ofproto
, &features
, NULL
);
3335 ofpmp_init(&replies
, request
);
3336 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3337 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3338 ofputil_append_table_features_reply(&features
[i
], &replies
);
3341 ofconn_send_replies(ofconn
, &replies
);
3349 append_port_stat(struct ofport
*port
, struct ovs_list
*replies
)
3351 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3353 calc_duration(port
->created
, time_msec(),
3354 &ops
.duration_sec
, &ops
.duration_nsec
);
3356 /* Intentionally ignore return value, since errors will set
3357 * 'stats' to all-1s, which is correct for OpenFlow, and
3358 * netdev_get_stats() will log errors. */
3359 ofproto_port_get_stats(port
, &ops
.stats
);
3361 ofputil_append_port_stat(replies
, &ops
);
3365 handle_port_request(struct ofconn
*ofconn
,
3366 const struct ofp_header
*request
, ofp_port_t port_no
,
3367 void (*cb
)(struct ofport
*, struct ovs_list
*replies
))
3369 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3370 struct ofport
*port
;
3371 struct ovs_list replies
;
3373 ofpmp_init(&replies
, request
);
3374 if (port_no
!= OFPP_ANY
) {
3375 port
= ofproto_get_port(ofproto
, port_no
);
3380 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3385 ofconn_send_replies(ofconn
, &replies
);
3389 handle_port_stats_request(struct ofconn
*ofconn
,
3390 const struct ofp_header
*request
)
3395 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3397 handle_port_request(ofconn
, request
, port_no
, append_port_stat
);
3403 append_port_desc(struct ofport
*port
, struct ovs_list
*replies
)
3405 ofputil_append_port_desc_stats_reply(&port
->pp
, replies
);
3409 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3410 const struct ofp_header
*request
)
3415 error
= ofputil_decode_port_desc_stats_request(request
, &port_no
);
3417 handle_port_request(ofconn
, request
, port_no
, append_port_desc
);
3423 hash_cookie(ovs_be64 cookie
)
3425 return hash_uint64((OVS_FORCE
uint64_t)cookie
);
3429 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3430 OVS_REQUIRES(ofproto_mutex
)
3432 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3433 hash_cookie(rule
->flow_cookie
));
3437 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3438 OVS_REQUIRES(ofproto_mutex
)
3440 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3444 calc_duration(long long int start
, long long int now
,
3445 uint32_t *sec
, uint32_t *nsec
)
3447 long long int msecs
= now
- start
;
3448 *sec
= msecs
/ 1000;
3449 *nsec
= (msecs
% 1000) * (1000 * 1000);
3452 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3453 * true if 'table_id' is OK, false otherwise. */
3455 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3457 return table_id
== OFPTT_ALL
|| table_id
< ofproto
->n_tables
;
3460 static struct oftable
*
3461 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3463 struct oftable
*table
;
3465 for (table
= &ofproto
->tables
[table_id
];
3466 table
< &ofproto
->tables
[ofproto
->n_tables
];
3468 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3476 static struct oftable
*
3477 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3479 if (table_id
== 0xff) {
3480 return next_visible_table(ofproto
, 0);
3481 } else if (table_id
< ofproto
->n_tables
) {
3482 return &ofproto
->tables
[table_id
];
3488 static struct oftable
*
3489 next_matching_table(const struct ofproto
*ofproto
,
3490 const struct oftable
*table
, uint8_t table_id
)
3492 return (table_id
== 0xff
3493 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3497 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3499 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3500 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3502 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3503 * only once, for that table. (This can be used to access tables marked
3506 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3507 * entered at all. (Perhaps you should have validated TABLE_ID with
3508 * check_table_id().)
3510 * All parameters are evaluated multiple times.
3512 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3513 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3515 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3517 /* Initializes 'criteria' in a straightforward way based on the other
3520 * By default, the criteria include flows that are read-only, on the assumption
3521 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3522 * if flows will be modified.
3524 * For "loose" matching, the 'priority' parameter is unimportant and may be
3527 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3528 const struct match
*match
, int priority
,
3529 ovs_be64 cookie
, ovs_be64 cookie_mask
,
3530 ofp_port_t out_port
, uint32_t out_group
)
3532 criteria
->table_id
= table_id
;
3533 cls_rule_init(&criteria
->cr
, match
, priority
);
3534 criteria
->cookie
= cookie
;
3535 criteria
->cookie_mask
= cookie_mask
;
3536 criteria
->out_port
= out_port
;
3537 criteria
->out_group
= out_group
;
3539 /* We ordinarily want to skip hidden rules, but there has to be a way for
3540 * code internal to OVS to modify and delete them, so if the criteria
3541 * specify a priority that can only be for a hidden flow, then allow hidden
3542 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3543 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3545 criteria
->include_hidden
= priority
> UINT16_MAX
;
3547 /* We assume that the criteria are being used to collect flows for reading
3548 * but not modification. Thus, we should collect read-only flows. */
3549 criteria
->include_readonly
= true;
3552 /* By default, criteria initialized by rule_criteria_init() will match flows
3553 * that are read-only, on the assumption that the collected flows won't be
3554 * modified. Call this function to match only flows that are be modifiable.
3556 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3557 * caller has special privileges that allow it to modify even "read-only"
3560 rule_criteria_require_rw(struct rule_criteria
*criteria
,
3561 bool can_write_readonly
)
3563 criteria
->include_readonly
= can_write_readonly
;
3567 rule_criteria_destroy(struct rule_criteria
*criteria
)
3569 cls_rule_destroy(&criteria
->cr
);
3573 rule_collection_init(struct rule_collection
*rules
)
3575 rules
->rules
= rules
->stub
;
3577 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
3581 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
3583 if (rules
->n
>= rules
->capacity
) {
3584 size_t old_size
, new_size
;
3586 old_size
= rules
->capacity
* sizeof *rules
->rules
;
3587 rules
->capacity
*= 2;
3588 new_size
= rules
->capacity
* sizeof *rules
->rules
;
3590 if (rules
->rules
== rules
->stub
) {
3591 rules
->rules
= xmalloc(new_size
);
3592 memcpy(rules
->rules
, rules
->stub
, old_size
);
3594 rules
->rules
= xrealloc(rules
->rules
, new_size
);
3598 rules
->rules
[rules
->n
++] = rule
;
3602 rule_collection_ref(struct rule_collection
*rules
)
3603 OVS_REQUIRES(ofproto_mutex
)
3607 for (i
= 0; i
< rules
->n
; i
++) {
3608 ofproto_rule_ref(rules
->rules
[i
]);
3613 rule_collection_unref(struct rule_collection
*rules
)
3617 for (i
= 0; i
< rules
->n
; i
++) {
3618 ofproto_rule_unref(rules
->rules
[i
]);
3623 rule_collection_destroy(struct rule_collection
*rules
)
3625 if (rules
->rules
!= rules
->stub
) {
3629 /* Make repeated destruction harmless. */
3630 rule_collection_init(rules
);
3633 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3634 * function verifies most of the criteria in 'c' itself, but the caller must
3635 * check 'c->cr' itself.
3637 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3638 * 'c' only includes modifiable rules). */
3640 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
3641 struct rule_collection
*rules
, size_t *n_readonly
)
3642 OVS_REQUIRES(ofproto_mutex
)
3644 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
3645 && ofproto_rule_has_out_port(rule
, c
->out_port
)
3646 && ofproto_rule_has_out_group(rule
, c
->out_group
)
3647 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)
3648 && (!rule_is_hidden(rule
) || c
->include_hidden
)) {
3649 /* Rule matches all the criteria... */
3650 if (!rule_is_readonly(rule
) || c
->include_readonly
) {
3652 rule_collection_add(rules
, rule
);
3654 /* ...except it's read-only. */
3660 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3661 * on classifiers rules are done in the "loose" way required for OpenFlow
3662 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3665 * Returns 0 on success, otherwise an OpenFlow error code. */
3667 collect_rules_loose(struct ofproto
*ofproto
,
3668 const struct rule_criteria
*criteria
,
3669 struct rule_collection
*rules
)
3670 OVS_REQUIRES(ofproto_mutex
)
3672 struct oftable
*table
;
3673 enum ofperr error
= 0;
3674 size_t n_readonly
= 0;
3676 rule_collection_init(rules
);
3678 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3679 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3683 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3686 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3687 hash_cookie(criteria
->cookie
),
3688 &ofproto
->cookies
) {
3689 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
3690 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3694 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3697 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &criteria
->cr
) {
3698 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3704 if (!error
&& !rules
->n
&& n_readonly
) {
3705 /* We didn't find any rules to modify. We did find some read-only
3706 * rules that we're not allowed to modify, so report that. */
3707 error
= OFPERR_OFPBRC_EPERM
;
3710 rule_collection_destroy(rules
);
3715 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3716 * on classifiers rules are done in the "strict" way required for OpenFlow
3717 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3718 * rules on list 'rules'.
3720 * Returns 0 on success, otherwise an OpenFlow error code. */
3722 collect_rules_strict(struct ofproto
*ofproto
,
3723 const struct rule_criteria
*criteria
,
3724 struct rule_collection
*rules
)
3725 OVS_REQUIRES(ofproto_mutex
)
3727 struct oftable
*table
;
3728 size_t n_readonly
= 0;
3731 rule_collection_init(rules
);
3733 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3734 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3738 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3741 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3742 hash_cookie(criteria
->cookie
),
3743 &ofproto
->cookies
) {
3744 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
3745 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3749 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3752 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
3753 &table
->cls
, &criteria
->cr
));
3755 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3761 if (!error
&& !rules
->n
&& n_readonly
) {
3762 /* We didn't find any rules to modify. We did find some read-only
3763 * rules that we're not allowed to modify, so report that. */
3764 error
= OFPERR_OFPBRC_EPERM
;
3767 rule_collection_destroy(rules
);
3772 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3773 * forced into the range of a uint16_t. */
3775 age_secs(long long int age_ms
)
3777 return (age_ms
< 0 ? 0
3778 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
3779 : (unsigned int) age_ms
/ 1000);
3783 handle_flow_stats_request(struct ofconn
*ofconn
,
3784 const struct ofp_header
*request
)
3785 OVS_EXCLUDED(ofproto_mutex
)
3787 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3788 struct ofputil_flow_stats_request fsr
;
3789 struct rule_criteria criteria
;
3790 struct rule_collection rules
;
3791 struct ovs_list replies
;
3795 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
3800 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, fsr
.cookie
,
3801 fsr
.cookie_mask
, fsr
.out_port
, fsr
.out_group
);
3803 ovs_mutex_lock(&ofproto_mutex
);
3804 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3805 rule_criteria_destroy(&criteria
);
3807 rule_collection_ref(&rules
);
3809 ovs_mutex_unlock(&ofproto_mutex
);
3815 ofpmp_init(&replies
, request
);
3816 for (i
= 0; i
< rules
.n
; i
++) {
3817 struct rule
*rule
= rules
.rules
[i
];
3818 long long int now
= time_msec();
3819 struct ofputil_flow_stats fs
;
3820 long long int created
, used
, modified
;
3821 const struct rule_actions
*actions
;
3822 enum ofputil_flow_mod_flags flags
;
3824 ovs_mutex_lock(&rule
->mutex
);
3825 fs
.cookie
= rule
->flow_cookie
;
3826 fs
.idle_timeout
= rule
->idle_timeout
;
3827 fs
.hard_timeout
= rule
->hard_timeout
;
3828 fs
.importance
= rule
->importance
;
3829 created
= rule
->created
;
3830 modified
= rule
->modified
;
3831 actions
= rule_get_actions(rule
);
3832 flags
= rule
->flags
;
3833 ovs_mutex_unlock(&rule
->mutex
);
3835 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
3836 &fs
.byte_count
, &used
);
3838 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
3839 fs
.table_id
= rule
->table_id
;
3840 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
3841 fs
.priority
= rule
->cr
.priority
;
3842 fs
.idle_age
= age_secs(now
- used
);
3843 fs
.hard_age
= age_secs(now
- modified
);
3844 fs
.ofpacts
= actions
->ofpacts
;
3845 fs
.ofpacts_len
= actions
->ofpacts_len
;
3848 ofputil_append_flow_stats_reply(&fs
, &replies
);
3851 rule_collection_unref(&rules
);
3852 rule_collection_destroy(&rules
);
3854 ofconn_send_replies(ofconn
, &replies
);
3860 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
3862 uint64_t packet_count
, byte_count
;
3863 const struct rule_actions
*actions
;
3864 long long int created
, used
;
3866 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3867 &byte_count
, &used
);
3869 ovs_mutex_lock(&rule
->mutex
);
3870 actions
= rule_get_actions(rule
);
3871 created
= rule
->created
;
3872 ovs_mutex_unlock(&rule
->mutex
);
3874 if (rule
->table_id
!= 0) {
3875 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
3877 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
3878 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
3879 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
3880 cls_rule_format(&rule
->cr
, results
);
3881 ds_put_char(results
, ',');
3883 ds_put_cstr(results
, "actions=");
3884 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
3886 ds_put_cstr(results
, "\n");
3889 /* Adds a pretty-printed description of all flows to 'results', including
3890 * hidden flows (e.g., set up by in-band control). */
3892 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
3894 struct oftable
*table
;
3896 OFPROTO_FOR_EACH_TABLE (table
, p
) {
3899 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
3900 flow_stats_ds(rule
, results
);
3905 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3906 * '*engine_type' and '*engine_id', respectively. */
3908 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
3909 uint8_t *engine_type
, uint8_t *engine_id
)
3911 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
3914 /* Checks the status change of CFM on 'ofport'.
3916 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
3918 ofproto_port_cfm_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
3920 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3921 return (ofport
&& ofproto
->ofproto_class
->cfm_status_changed
3922 ? ofproto
->ofproto_class
->cfm_status_changed(ofport
)
3926 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3927 * Returns 0 if the port's CFM status was successfully stored into
3928 * '*status'. Returns positive errno if the port did not have CFM
3931 * The caller must provide and own '*status', and must free 'status->rmps'.
3932 * '*status' is indeterminate if the return value is non-zero. */
3934 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
3935 struct cfm_status
*status
)
3937 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3938 return (ofport
&& ofproto
->ofproto_class
->get_cfm_status
3939 ? ofproto
->ofproto_class
->get_cfm_status(ofport
, status
)
3944 handle_aggregate_stats_request(struct ofconn
*ofconn
,
3945 const struct ofp_header
*oh
)
3946 OVS_EXCLUDED(ofproto_mutex
)
3948 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3949 struct ofputil_flow_stats_request request
;
3950 struct ofputil_aggregate_stats stats
;
3951 bool unknown_packets
, unknown_bytes
;
3952 struct rule_criteria criteria
;
3953 struct rule_collection rules
;
3954 struct ofpbuf
*reply
;
3958 error
= ofputil_decode_flow_stats_request(&request
, oh
);
3963 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
3964 request
.cookie
, request
.cookie_mask
,
3965 request
.out_port
, request
.out_group
);
3967 ovs_mutex_lock(&ofproto_mutex
);
3968 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3969 rule_criteria_destroy(&criteria
);
3971 rule_collection_ref(&rules
);
3973 ovs_mutex_unlock(&ofproto_mutex
);
3979 memset(&stats
, 0, sizeof stats
);
3980 unknown_packets
= unknown_bytes
= false;
3981 for (i
= 0; i
< rules
.n
; i
++) {
3982 struct rule
*rule
= rules
.rules
[i
];
3983 uint64_t packet_count
;
3984 uint64_t byte_count
;
3987 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3988 &byte_count
, &used
);
3990 if (packet_count
== UINT64_MAX
) {
3991 unknown_packets
= true;
3993 stats
.packet_count
+= packet_count
;
3996 if (byte_count
== UINT64_MAX
) {
3997 unknown_bytes
= true;
3999 stats
.byte_count
+= byte_count
;
4004 if (unknown_packets
) {
4005 stats
.packet_count
= UINT64_MAX
;
4007 if (unknown_bytes
) {
4008 stats
.byte_count
= UINT64_MAX
;
4011 rule_collection_unref(&rules
);
4012 rule_collection_destroy(&rules
);
4014 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
4015 ofconn_send_reply(ofconn
, reply
);
4020 struct queue_stats_cbdata
{
4021 struct ofport
*ofport
;
4022 struct ovs_list replies
;
4027 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
4028 const struct netdev_queue_stats
*stats
)
4030 struct ofputil_queue_stats oqs
;
4032 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
4033 oqs
.queue_id
= queue_id
;
4034 oqs
.tx_bytes
= stats
->tx_bytes
;
4035 oqs
.tx_packets
= stats
->tx_packets
;
4036 oqs
.tx_errors
= stats
->tx_errors
;
4037 if (stats
->created
!= LLONG_MIN
) {
4038 calc_duration(stats
->created
, cbdata
->now
,
4039 &oqs
.duration_sec
, &oqs
.duration_nsec
);
4041 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
4043 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
4047 handle_queue_stats_dump_cb(uint32_t queue_id
,
4048 struct netdev_queue_stats
*stats
,
4051 struct queue_stats_cbdata
*cbdata
= cbdata_
;
4053 put_queue_stats(cbdata
, queue_id
, stats
);
4057 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
4058 struct queue_stats_cbdata
*cbdata
)
4060 cbdata
->ofport
= port
;
4061 if (queue_id
== OFPQ_ALL
) {
4062 netdev_dump_queue_stats(port
->netdev
,
4063 handle_queue_stats_dump_cb
, cbdata
);
4065 struct netdev_queue_stats stats
;
4067 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
4068 put_queue_stats(cbdata
, queue_id
, &stats
);
4070 return OFPERR_OFPQOFC_BAD_QUEUE
;
4077 handle_queue_stats_request(struct ofconn
*ofconn
,
4078 const struct ofp_header
*rq
)
4080 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4081 struct queue_stats_cbdata cbdata
;
4082 struct ofport
*port
;
4084 struct ofputil_queue_stats_request oqsr
;
4086 COVERAGE_INC(ofproto_queue_req
);
4088 ofpmp_init(&cbdata
.replies
, rq
);
4089 cbdata
.now
= time_msec();
4091 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
4096 if (oqsr
.port_no
== OFPP_ANY
) {
4097 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
4098 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
4099 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
4104 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
4106 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
4107 : OFPERR_OFPQOFC_BAD_PORT
);
4110 ofconn_send_replies(ofconn
, &cbdata
.replies
);
4112 ofpbuf_list_delete(&cbdata
.replies
);
4119 evict_rules_from_table(struct oftable
*table
, unsigned int extra_space
)
4120 OVS_REQUIRES(ofproto_mutex
)
4122 enum ofperr error
= 0;
4123 struct rule_collection rules
;
4124 unsigned int count
= classifier_count(&table
->cls
) + extra_space
;
4125 unsigned int max_flows
= table
->max_flows
;
4127 rule_collection_init(&rules
);
4129 while (count
-- > max_flows
) {
4132 if (!choose_rule_to_evict(table
, &rule
)) {
4133 error
= OFPERR_OFPFMFC_TABLE_FULL
;
4136 eviction_group_remove_rule(rule
);
4137 rule_collection_add(&rules
, rule
);
4140 delete_flows__(&rules
, OFPRR_EVICTION
, NULL
);
4141 rule_collection_destroy(&rules
);
4146 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4147 * in which no matching flow already exists in the flow table.
4149 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4150 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4151 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4152 * initiated now but may be retried later.
4154 * The caller retains ownership of 'fm->ofpacts'.
4156 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4159 add_flow(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4160 const struct flow_mod_requester
*req
)
4161 OVS_REQUIRES(ofproto_mutex
)
4163 const struct rule_actions
*actions
;
4164 struct oftable
*table
;
4170 if (!check_table_id(ofproto
, fm
->table_id
)) {
4171 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4176 if (fm
->table_id
== 0xff) {
4177 if (ofproto
->ofproto_class
->rule_choose_table
) {
4178 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
4184 ovs_assert(table_id
< ofproto
->n_tables
);
4188 } else if (fm
->table_id
< ofproto
->n_tables
) {
4189 table_id
= fm
->table_id
;
4191 return OFPERR_OFPBRC_BAD_TABLE_ID
;
4194 table
= &ofproto
->tables
[table_id
];
4195 if (table
->flags
& OFTABLE_READONLY
4196 && !(fm
->flags
& OFPUTIL_FF_NO_READONLY
)) {
4197 return OFPERR_OFPBRC_EPERM
;
4200 if (!(fm
->flags
& OFPUTIL_FF_HIDDEN_FIELDS
)) {
4201 if (!match_has_default_hidden_fields(&fm
->match
)) {
4202 VLOG_WARN_RL(&rl
, "%s: (add_flow) only internal flows can set "
4203 "non-default values to hidden fields", ofproto
->name
);
4204 return OFPERR_OFPBRC_EPERM
;
4208 cls_rule_init(&cr
, &fm
->match
, fm
->priority
);
4210 /* Transform "add" into "modify" if there's an existing identical flow. */
4211 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
));
4213 struct rule_collection rules
;
4215 cls_rule_destroy(&cr
);
4217 rule_collection_init(&rules
);
4218 rule_collection_add(&rules
, rule
);
4219 fm
->modify_cookie
= true;
4220 error
= modify_flows__(ofproto
, fm
, &rules
, req
);
4221 rule_collection_destroy(&rules
);
4226 /* Check for overlap, if requested. */
4227 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
) {
4228 if (classifier_rule_overlaps(&table
->cls
, &cr
)) {
4229 cls_rule_destroy(&cr
);
4230 return OFPERR_OFPFMFC_OVERLAP
;
4234 /* If necessary, evict an existing rule to clear out space. */
4235 error
= evict_rules_from_table(table
, 1);
4237 cls_rule_destroy(&cr
);
4241 /* Allocate new rule. */
4242 rule
= ofproto
->ofproto_class
->rule_alloc();
4244 cls_rule_destroy(&cr
);
4245 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
4246 ofproto
->name
, ovs_strerror(error
));
4250 /* Initialize base state. */
4251 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4252 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), &cr
);
4253 ovs_refcount_init(&rule
->ref_count
);
4254 rule
->flow_cookie
= fm
->new_cookie
;
4255 rule
->created
= rule
->modified
= time_msec();
4257 ovs_mutex_init(&rule
->mutex
);
4258 ovs_mutex_lock(&rule
->mutex
);
4259 rule
->idle_timeout
= fm
->idle_timeout
;
4260 rule
->hard_timeout
= fm
->hard_timeout
;
4261 rule
->importance
= fm
->importance
;
4262 ovs_mutex_unlock(&rule
->mutex
);
4264 *CONST_CAST(uint8_t *, &rule
->table_id
) = table
- ofproto
->tables
;
4265 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4266 actions
= rule_actions_create(fm
->ofpacts
, fm
->ofpacts_len
);
4267 ovsrcu_set(&rule
->actions
, actions
);
4268 list_init(&rule
->meter_list_node
);
4269 rule
->eviction_group
= NULL
;
4270 list_init(&rule
->expirable
);
4271 rule
->monitor_flags
= 0;
4272 rule
->add_seqno
= 0;
4273 rule
->modify_seqno
= 0;
4275 /* Construct rule, initializing derived state. */
4276 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4278 ofproto_rule_destroy__(rule
);
4282 if (fm
->hard_timeout
|| fm
->idle_timeout
) {
4283 list_insert(&ofproto
->expirable
, &rule
->expirable
);
4285 cookies_insert(ofproto
, rule
);
4286 eviction_group_add_rule(rule
);
4287 if (actions
->has_meter
) {
4288 meter_insert_rule(rule
);
4291 classifier_defer(&table
->cls
);
4292 classifier_insert(&table
->cls
, &rule
->cr
);
4294 error
= ofproto
->ofproto_class
->rule_insert(rule
);
4296 oftable_remove_rule(rule
);
4297 ofproto_rule_unref(rule
);
4300 classifier_publish(&table
->cls
);
4302 learned_cookies_inc(ofproto
, actions
);
4304 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
4305 if (ofproto
->vlan_bitmap
) {
4306 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
4307 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
4308 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
4309 ofproto
->vlans_changed
= true;
4312 ofproto
->vlans_changed
= true;
4316 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_ADDED
, 0,
4317 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0, NULL
);
4319 return req
? send_buffered_packet(req
->ofconn
, fm
->buffer_id
, rule
) : 0;
4322 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4324 /* Modifies the rules listed in 'rules', changing their actions to match those
4327 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4330 * Returns 0 on success, otherwise an OpenFlow error code. */
4332 modify_flows__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4333 const struct rule_collection
*rules
,
4334 const struct flow_mod_requester
*req
)
4335 OVS_REQUIRES(ofproto_mutex
)
4337 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
4338 enum nx_flow_update_event event
;
4341 if (ofproto
->ofproto_class
->rule_premodify_actions
) {
4342 for (i
= 0; i
< rules
->n
; i
++) {
4343 struct rule
*rule
= rules
->rules
[i
];
4346 error
= ofproto
->ofproto_class
->rule_premodify_actions(
4347 rule
, fm
->ofpacts
, fm
->ofpacts_len
);
4354 event
= fm
->command
== OFPFC_ADD
? NXFME_ADDED
: NXFME_MODIFIED
;
4355 for (i
= 0; i
< rules
->n
; i
++) {
4356 struct rule
*rule
= rules
->rules
[i
];
4358 /* 'fm' says that */
4359 bool change_cookie
= (fm
->modify_cookie
4360 && fm
->new_cookie
!= OVS_BE64_MAX
4361 && fm
->new_cookie
!= rule
->flow_cookie
);
4363 const struct rule_actions
*actions
= rule_get_actions(rule
);
4364 bool change_actions
= !ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
4366 actions
->ofpacts_len
);
4368 bool reset_counters
= (fm
->flags
& OFPUTIL_FF_RESET_COUNTS
) != 0;
4370 long long int now
= time_msec();
4372 if (change_cookie
) {
4373 cookies_remove(ofproto
, rule
);
4376 ovs_mutex_lock(&rule
->mutex
);
4377 if (fm
->command
== OFPFC_ADD
) {
4378 rule
->idle_timeout
= fm
->idle_timeout
;
4379 rule
->hard_timeout
= fm
->hard_timeout
;
4380 rule
->importance
= fm
->importance
;
4381 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4382 rule
->created
= now
;
4384 if (change_cookie
) {
4385 rule
->flow_cookie
= fm
->new_cookie
;
4387 rule
->modified
= now
;
4388 ovs_mutex_unlock(&rule
->mutex
);
4390 if (change_cookie
) {
4391 cookies_insert(ofproto
, rule
);
4393 if (fm
->command
== OFPFC_ADD
) {
4394 if (fm
->idle_timeout
|| fm
->hard_timeout
|| fm
->importance
) {
4395 if (!rule
->eviction_group
) {
4396 eviction_group_add_rule(rule
);
4399 eviction_group_remove_rule(rule
);
4403 if (change_actions
) {
4404 ovsrcu_set(&rule
->actions
, rule_actions_create(fm
->ofpacts
,
4408 if (change_actions
|| reset_counters
) {
4409 ofproto
->ofproto_class
->rule_modify_actions(rule
, reset_counters
);
4412 if (event
!= NXFME_MODIFIED
|| change_actions
|| change_cookie
) {
4413 ofmonitor_report(ofproto
->connmgr
, rule
, event
, 0,
4414 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0,
4415 change_actions
? actions
: NULL
);
4418 if (change_actions
) {
4419 learned_cookies_inc(ofproto
, rule_get_actions(rule
));
4420 learned_cookies_dec(ofproto
, actions
, &dead_cookies
);
4421 rule_actions_destroy(actions
);
4424 learned_cookies_flush(ofproto
, &dead_cookies
);
4426 if (fm
->buffer_id
!= UINT32_MAX
&& req
) {
4427 return send_buffered_packet(req
->ofconn
, fm
->buffer_id
,
4435 modify_flows_add(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4436 const struct flow_mod_requester
*req
)
4437 OVS_REQUIRES(ofproto_mutex
)
4439 if (fm
->cookie_mask
!= htonll(0) || fm
->new_cookie
== OVS_BE64_MAX
) {
4442 return add_flow(ofproto
, fm
, req
);
4445 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4448 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4451 modify_flows_loose(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4452 const struct flow_mod_requester
*req
)
4453 OVS_REQUIRES(ofproto_mutex
)
4455 struct rule_criteria criteria
;
4456 struct rule_collection rules
;
4459 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4460 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4461 rule_criteria_require_rw(&criteria
,
4462 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4463 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4464 rule_criteria_destroy(&criteria
);
4467 error
= (rules
.n
> 0
4468 ? modify_flows__(ofproto
, fm
, &rules
, req
)
4469 : modify_flows_add(ofproto
, fm
, req
));
4472 rule_collection_destroy(&rules
);
4477 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4478 * code on failure. */
4480 modify_flow_strict(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4481 const struct flow_mod_requester
*req
)
4482 OVS_REQUIRES(ofproto_mutex
)
4484 struct rule_criteria criteria
;
4485 struct rule_collection rules
;
4488 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4489 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4490 rule_criteria_require_rw(&criteria
,
4491 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4492 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4493 rule_criteria_destroy(&criteria
);
4497 error
= modify_flows_add(ofproto
, fm
, req
);
4498 } else if (rules
.n
== 1) {
4499 error
= modify_flows__(ofproto
, fm
, &rules
, req
);
4503 rule_collection_destroy(&rules
);
4508 /* OFPFC_DELETE implementation. */
4510 /* Deletes the rules listed in 'rules'. */
4512 delete_flows__(const struct rule_collection
*rules
,
4513 enum ofp_flow_removed_reason reason
,
4514 const struct flow_mod_requester
*req
)
4515 OVS_REQUIRES(ofproto_mutex
)
4518 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
4519 struct ofproto
*ofproto
= rules
->rules
[0]->ofproto
;
4520 struct rule
*rule
, *next
;
4523 for (i
= 0, next
= rules
->rules
[0];
4524 rule
= next
, next
= (++i
< rules
->n
) ? rules
->rules
[i
] : NULL
,
4526 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
4527 uint8_t next_table
= next
? next
->table_id
: UINT8_MAX
;
4529 ofproto_rule_send_removed(rule
, reason
);
4531 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_DELETED
, reason
,
4532 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0,
4535 if (next_table
== rule
->table_id
) {
4536 classifier_defer(cls
);
4538 classifier_remove(cls
, &rule
->cr
);
4539 if (next_table
!= rule
->table_id
) {
4540 classifier_publish(cls
);
4542 ofproto_rule_remove__(ofproto
, rule
);
4544 ofproto
->ofproto_class
->rule_delete(rule
);
4546 learned_cookies_dec(ofproto
, rule_get_actions(rule
),
4549 learned_cookies_flush(ofproto
, &dead_cookies
);
4550 ofmonitor_flush(ofproto
->connmgr
);
4554 /* Implements OFPFC_DELETE. */
4556 delete_flows_loose(struct ofproto
*ofproto
,
4557 const struct ofputil_flow_mod
*fm
,
4558 const struct flow_mod_requester
*req
)
4559 OVS_REQUIRES(ofproto_mutex
)
4561 struct rule_criteria criteria
;
4562 struct rule_collection rules
;
4565 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4566 fm
->cookie
, fm
->cookie_mask
,
4567 fm
->out_port
, fm
->out_group
);
4568 rule_criteria_require_rw(&criteria
,
4569 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4570 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4571 rule_criteria_destroy(&criteria
);
4574 delete_flows__(&rules
, fm
->delete_reason
, req
);
4576 rule_collection_destroy(&rules
);
4581 /* Implements OFPFC_DELETE_STRICT. */
4583 delete_flow_strict(struct ofproto
*ofproto
, const struct ofputil_flow_mod
*fm
,
4584 const struct flow_mod_requester
*req
)
4585 OVS_REQUIRES(ofproto_mutex
)
4587 struct rule_criteria criteria
;
4588 struct rule_collection rules
;
4591 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4592 fm
->cookie
, fm
->cookie_mask
,
4593 fm
->out_port
, fm
->out_group
);
4594 rule_criteria_require_rw(&criteria
,
4595 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4596 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4597 rule_criteria_destroy(&criteria
);
4600 delete_flows__(&rules
, fm
->delete_reason
, req
);
4602 rule_collection_destroy(&rules
);
4608 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
4609 OVS_REQUIRES(ofproto_mutex
)
4611 struct ofputil_flow_removed fr
;
4614 if (rule_is_hidden(rule
) ||
4615 !(rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
)) {
4619 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
4620 fr
.priority
= rule
->cr
.priority
;
4621 fr
.cookie
= rule
->flow_cookie
;
4623 fr
.table_id
= rule
->table_id
;
4624 calc_duration(rule
->created
, time_msec(),
4625 &fr
.duration_sec
, &fr
.duration_nsec
);
4626 ovs_mutex_lock(&rule
->mutex
);
4627 fr
.idle_timeout
= rule
->idle_timeout
;
4628 fr
.hard_timeout
= rule
->hard_timeout
;
4629 ovs_mutex_unlock(&rule
->mutex
);
4630 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
4631 &fr
.byte_count
, &used
);
4633 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
4636 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4637 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4640 * ofproto implementation ->run() functions should use this function to expire
4641 * OpenFlow flows. */
4643 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
4644 OVS_REQUIRES(ofproto_mutex
)
4646 struct rule_collection rules
;
4648 rules
.rules
= rules
.stub
;
4650 rules
.stub
[0] = rule
;
4651 delete_flows__(&rules
, reason
, NULL
);
4654 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4655 * means "infinite". */
4657 reduce_timeout(uint16_t max
, uint16_t *timeout
)
4659 if (max
&& (!*timeout
|| *timeout
> max
)) {
4664 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4665 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4666 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4668 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4670 ofproto_rule_reduce_timeouts(struct rule
*rule
,
4671 uint16_t idle_timeout
, uint16_t hard_timeout
)
4672 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
4674 if (!idle_timeout
&& !hard_timeout
) {
4678 ovs_mutex_lock(&ofproto_mutex
);
4679 if (list_is_empty(&rule
->expirable
)) {
4680 list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
4682 ovs_mutex_unlock(&ofproto_mutex
);
4684 ovs_mutex_lock(&rule
->mutex
);
4685 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
4686 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
4687 ovs_mutex_unlock(&rule
->mutex
);
4691 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4692 OVS_EXCLUDED(ofproto_mutex
)
4694 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4695 struct ofputil_flow_mod fm
;
4696 uint64_t ofpacts_stub
[1024 / 8];
4697 struct ofpbuf ofpacts
;
4700 error
= reject_slave_controller(ofconn
);
4705 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
4706 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
4708 u16_to_ofp(ofproto
->max_ports
),
4711 error
= ofproto_check_ofpacts(ofproto
, fm
.ofpacts
, fm
.ofpacts_len
);
4714 struct flow_mod_requester req
;
4716 req
.ofconn
= ofconn
;
4718 error
= handle_flow_mod__(ofproto
, &fm
, &req
);
4721 goto exit_free_ofpacts
;
4724 ofconn_report_flow_mod(ofconn
, fm
.command
);
4727 ofpbuf_uninit(&ofpacts
);
4733 handle_flow_mod__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4734 const struct flow_mod_requester
*req
)
4735 OVS_EXCLUDED(ofproto_mutex
)
4739 ovs_mutex_lock(&ofproto_mutex
);
4740 switch (fm
->command
) {
4742 error
= add_flow(ofproto
, fm
, req
);
4746 error
= modify_flows_loose(ofproto
, fm
, req
);
4749 case OFPFC_MODIFY_STRICT
:
4750 error
= modify_flow_strict(ofproto
, fm
, req
);
4754 error
= delete_flows_loose(ofproto
, fm
, req
);
4757 case OFPFC_DELETE_STRICT
:
4758 error
= delete_flow_strict(ofproto
, fm
, req
);
4762 if (fm
->command
> 0xff) {
4763 VLOG_WARN_RL(&rl
, "%s: flow_mod has explicit table_id but "
4764 "flow_mod_table_id extension is not enabled",
4767 error
= OFPERR_OFPFMFC_BAD_COMMAND
;
4770 ofmonitor_flush(ofproto
->connmgr
);
4771 ovs_mutex_unlock(&ofproto_mutex
);
4773 run_rule_executes(ofproto
);
4778 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4780 struct ofputil_role_request request
;
4781 struct ofputil_role_request reply
;
4785 error
= ofputil_decode_role_message(oh
, &request
);
4790 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
4791 if (request
.have_generation_id
4792 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
4793 return OFPERR_OFPRRFC_STALE
;
4796 ofconn_set_role(ofconn
, request
.role
);
4799 reply
.role
= ofconn_get_role(ofconn
);
4800 reply
.have_generation_id
= ofconn_get_master_election_id(
4801 ofconn
, &reply
.generation_id
);
4802 buf
= ofputil_encode_role_reply(oh
, &reply
);
4803 ofconn_send_reply(ofconn
, buf
);
4809 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
4810 const struct ofp_header
*oh
)
4812 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
4813 enum ofputil_protocol cur
, next
;
4815 cur
= ofconn_get_protocol(ofconn
);
4816 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
4817 ofconn_set_protocol(ofconn
, next
);
4823 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4825 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
4826 enum ofputil_protocol cur
, next
;
4827 enum ofputil_protocol next_base
;
4829 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
4831 return OFPERR_OFPBRC_EPERM
;
4834 cur
= ofconn_get_protocol(ofconn
);
4835 next
= ofputil_protocol_set_base(cur
, next_base
);
4836 ofconn_set_protocol(ofconn
, next
);
4842 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
4843 const struct ofp_header
*oh
)
4845 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
4848 format
= ntohl(msg
->format
);
4849 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
4850 return OFPERR_OFPBRC_EPERM
;
4853 ofconn_set_packet_in_format(ofconn
, format
);
4858 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4860 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
4861 uint32_t master
[OAM_N_TYPES
];
4862 uint32_t slave
[OAM_N_TYPES
];
4864 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
4865 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
4866 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
4868 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
4869 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
4870 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
4872 ofconn_set_async_config(ofconn
, master
, slave
);
4873 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
4874 !ofconn_get_miss_send_len(ofconn
)) {
4875 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
4882 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4885 uint32_t master
[OAM_N_TYPES
];
4886 uint32_t slave
[OAM_N_TYPES
];
4887 struct nx_async_config
*msg
;
4889 ofconn_get_async_config(ofconn
, master
, slave
);
4890 buf
= ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY
, oh
, 0);
4891 msg
= ofpbuf_put_zeros(buf
, sizeof *msg
);
4893 msg
->packet_in_mask
[0] = htonl(master
[OAM_PACKET_IN
]);
4894 msg
->port_status_mask
[0] = htonl(master
[OAM_PORT_STATUS
]);
4895 msg
->flow_removed_mask
[0] = htonl(master
[OAM_FLOW_REMOVED
]);
4897 msg
->packet_in_mask
[1] = htonl(slave
[OAM_PACKET_IN
]);
4898 msg
->port_status_mask
[1] = htonl(slave
[OAM_PORT_STATUS
]);
4899 msg
->flow_removed_mask
[1] = htonl(slave
[OAM_FLOW_REMOVED
]);
4901 ofconn_send_reply(ofconn
, buf
);
4907 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
4908 const struct ofp_header
*oh
)
4910 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
4912 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
4913 return OFPERR_NXBRC_MUST_BE_ZERO
;
4916 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
4921 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4925 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
4926 ? OFPRAW_OFPT10_BARRIER_REPLY
4927 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
4928 ofconn_send_reply(ofconn
, buf
);
4933 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
4934 enum nx_flow_monitor_flags flags
,
4935 struct ovs_list
*msgs
)
4936 OVS_REQUIRES(ofproto_mutex
)
4938 const struct rule_actions
*actions
;
4939 struct ofputil_flow_update fu
;
4942 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
4943 ? NXFME_ADDED
: NXFME_MODIFIED
);
4945 ovs_mutex_lock(&rule
->mutex
);
4946 fu
.idle_timeout
= rule
->idle_timeout
;
4947 fu
.hard_timeout
= rule
->hard_timeout
;
4948 ovs_mutex_unlock(&rule
->mutex
);
4949 fu
.table_id
= rule
->table_id
;
4950 fu
.cookie
= rule
->flow_cookie
;
4951 minimatch_expand(&rule
->cr
.match
, &match
);
4953 fu
.priority
= rule
->cr
.priority
;
4955 actions
= flags
& NXFMF_ACTIONS
? rule_get_actions(rule
) : NULL
;
4956 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
4957 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
4959 if (list_is_empty(msgs
)) {
4960 ofputil_start_flow_update(msgs
);
4962 ofputil_append_flow_update(&fu
, msgs
);
4966 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
4967 struct ovs_list
*msgs
)
4968 OVS_REQUIRES(ofproto_mutex
)
4972 for (i
= 0; i
< rules
->n
; i
++) {
4973 struct rule
*rule
= rules
->rules
[i
];
4974 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
4975 rule
->monitor_flags
= 0;
4977 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
4982 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
4983 struct rule
*rule
, uint64_t seqno
,
4984 struct rule_collection
*rules
)
4985 OVS_REQUIRES(ofproto_mutex
)
4987 enum nx_flow_monitor_flags update
;
4989 if (rule_is_hidden(rule
)) {
4993 if (!ofproto_rule_has_out_port(rule
, m
->out_port
)) {
4998 if (rule
->add_seqno
> seqno
) {
4999 update
= NXFMF_ADD
| NXFMF_MODIFY
;
5000 } else if (rule
->modify_seqno
> seqno
) {
5001 update
= NXFMF_MODIFY
;
5006 if (!(m
->flags
& update
)) {
5010 update
= NXFMF_INITIAL
;
5013 if (!rule
->monitor_flags
) {
5014 rule_collection_add(rules
, rule
);
5016 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
5020 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
5022 struct rule_collection
*rules
)
5023 OVS_REQUIRES(ofproto_mutex
)
5025 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
5026 const struct oftable
*table
;
5027 struct cls_rule target
;
5029 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
5030 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
5033 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &target
) {
5034 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
5037 cls_rule_destroy(&target
);
5041 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
5042 struct rule_collection
*rules
)
5043 OVS_REQUIRES(ofproto_mutex
)
5045 if (m
->flags
& NXFMF_INITIAL
) {
5046 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
5051 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
5052 uint64_t seqno
, struct rule_collection
*rules
)
5053 OVS_REQUIRES(ofproto_mutex
)
5055 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
5059 flow_monitor_delete(struct ofconn
*ofconn
, uint32_t id
)
5060 OVS_REQUIRES(ofproto_mutex
)
5062 struct ofmonitor
*m
;
5065 m
= ofmonitor_lookup(ofconn
, id
);
5067 ofmonitor_destroy(m
);
5070 error
= OFPERR_OFPMOFC_UNKNOWN_MONITOR
;
5077 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5078 OVS_EXCLUDED(ofproto_mutex
)
5080 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5081 struct ofmonitor
**monitors
;
5082 size_t n_monitors
, allocated_monitors
;
5083 struct rule_collection rules
;
5084 struct ovs_list replies
;
5089 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
5091 n_monitors
= allocated_monitors
= 0;
5093 ovs_mutex_lock(&ofproto_mutex
);
5095 struct ofputil_flow_monitor_request request
;
5096 struct ofmonitor
*m
;
5099 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
5100 if (retval
== EOF
) {
5102 } else if (retval
) {
5107 if (request
.table_id
!= 0xff
5108 && request
.table_id
>= ofproto
->n_tables
) {
5109 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
5113 error
= ofmonitor_create(&request
, ofconn
, &m
);
5118 if (n_monitors
>= allocated_monitors
) {
5119 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
5122 monitors
[n_monitors
++] = m
;
5125 rule_collection_init(&rules
);
5126 for (i
= 0; i
< n_monitors
; i
++) {
5127 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
5130 ofpmp_init(&replies
, oh
);
5131 ofmonitor_compose_refresh_updates(&rules
, &replies
);
5132 ovs_mutex_unlock(&ofproto_mutex
);
5134 rule_collection_destroy(&rules
);
5136 ofconn_send_replies(ofconn
, &replies
);
5142 for (i
= 0; i
< n_monitors
; i
++) {
5143 ofmonitor_destroy(monitors
[i
]);
5146 ovs_mutex_unlock(&ofproto_mutex
);
5152 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5153 OVS_EXCLUDED(ofproto_mutex
)
5158 id
= ofputil_decode_flow_monitor_cancel(oh
);
5160 ovs_mutex_lock(&ofproto_mutex
);
5161 error
= flow_monitor_delete(ofconn
, id
);
5162 ovs_mutex_unlock(&ofproto_mutex
);
5167 /* Meters implementation.
5169 * Meter table entry, indexed by the OpenFlow meter_id.
5170 * 'created' is used to compute the duration for meter stats.
5171 * 'list rules' is needed so that we can delete the dependent rules when the
5172 * meter table entry is deleted.
5173 * 'provider_meter_id' is for the provider's private use.
5176 long long int created
; /* Time created. */
5177 struct ovs_list rules
; /* List of "struct rule_dpif"s. */
5178 ofproto_meter_id provider_meter_id
;
5179 uint16_t flags
; /* Meter flags. */
5180 uint16_t n_bands
; /* Number of meter bands. */
5181 struct ofputil_meter_band
*bands
;
5185 * This is used in instruction validation at flow set-up time,
5186 * as flows may not use non-existing meters.
5187 * Return value of UINT32_MAX signifies an invalid meter.
5190 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
5192 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
5193 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
5195 return meter
->provider_meter_id
.uint32
;
5201 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5204 meter_insert_rule(struct rule
*rule
)
5206 const struct rule_actions
*a
= rule_get_actions(rule
);
5207 uint32_t meter_id
= ofpacts_get_meter(a
->ofpacts
, a
->ofpacts_len
);
5208 struct meter
*meter
= rule
->ofproto
->meters
[meter_id
];
5210 list_insert(&meter
->rules
, &rule
->meter_list_node
);
5214 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
5218 meter
->flags
= config
->flags
;
5219 meter
->n_bands
= config
->n_bands
;
5220 meter
->bands
= xmemdup(config
->bands
,
5221 config
->n_bands
* sizeof *meter
->bands
);
5224 static struct meter
*
5225 meter_create(const struct ofputil_meter_config
*config
,
5226 ofproto_meter_id provider_meter_id
)
5228 struct meter
*meter
;
5230 meter
= xzalloc(sizeof *meter
);
5231 meter
->provider_meter_id
= provider_meter_id
;
5232 meter
->created
= time_msec();
5233 list_init(&meter
->rules
);
5235 meter_update(meter
, config
);
5241 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5242 OVS_REQUIRES(ofproto_mutex
)
5245 for (mid
= first
; mid
<= last
; ++mid
) {
5246 struct meter
*meter
= ofproto
->meters
[mid
];
5248 ofproto
->meters
[mid
] = NULL
;
5249 ofproto
->ofproto_class
->meter_del(ofproto
,
5250 meter
->provider_meter_id
);
5258 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5260 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5261 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5265 return OFPERR_OFPMMFC_METER_EXISTS
;
5268 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5271 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5272 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5278 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5280 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5282 uint32_t provider_meter_id
;
5285 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5288 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5289 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5290 &meter
->provider_meter_id
,
5292 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5294 meter_update(meter
, &mm
->meter
);
5300 handle_delete_meter(struct ofconn
*ofconn
, struct ofputil_meter_mod
*mm
)
5301 OVS_EXCLUDED(ofproto_mutex
)
5303 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5304 uint32_t meter_id
= mm
->meter
.meter_id
;
5305 struct rule_collection rules
;
5306 enum ofperr error
= 0;
5307 uint32_t first
, last
;
5309 if (meter_id
== OFPM13_ALL
) {
5311 last
= ofproto
->meter_features
.max_meters
;
5313 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
5316 first
= last
= meter_id
;
5319 /* First delete the rules that use this meter. If any of those rules are
5320 * currently being modified, postpone the whole operation until later. */
5321 rule_collection_init(&rules
);
5322 ovs_mutex_lock(&ofproto_mutex
);
5323 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5324 struct meter
*meter
= ofproto
->meters
[meter_id
];
5325 if (meter
&& !list_is_empty(&meter
->rules
)) {
5328 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
5329 rule_collection_add(&rules
, rule
);
5333 delete_flows__(&rules
, OFPRR_METER_DELETE
, NULL
);
5335 /* Delete the meters. */
5336 meter_delete(ofproto
, first
, last
);
5338 ovs_mutex_unlock(&ofproto_mutex
);
5339 rule_collection_destroy(&rules
);
5345 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5347 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5348 struct ofputil_meter_mod mm
;
5349 uint64_t bands_stub
[256 / 8];
5350 struct ofpbuf bands
;
5354 error
= reject_slave_controller(ofconn
);
5359 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5361 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
5363 goto exit_free_bands
;
5366 meter_id
= mm
.meter
.meter_id
;
5368 if (mm
.command
!= OFPMC13_DELETE
) {
5369 /* Fails also when meters are not implemented by the provider. */
5370 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
5371 error
= OFPERR_OFPMMFC_INVALID_METER
;
5372 goto exit_free_bands
;
5373 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
5374 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
5375 goto exit_free_bands
;
5377 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
5378 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
5379 goto exit_free_bands
;
5383 switch (mm
.command
) {
5385 error
= handle_add_meter(ofproto
, &mm
);
5388 case OFPMC13_MODIFY
:
5389 error
= handle_modify_meter(ofproto
, &mm
);
5392 case OFPMC13_DELETE
:
5393 error
= handle_delete_meter(ofconn
, &mm
);
5397 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
5402 ofpbuf_uninit(&bands
);
5407 handle_meter_features_request(struct ofconn
*ofconn
,
5408 const struct ofp_header
*request
)
5410 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5411 struct ofputil_meter_features features
;
5414 if (ofproto
->ofproto_class
->meter_get_features
) {
5415 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
5417 memset(&features
, 0, sizeof features
);
5419 b
= ofputil_encode_meter_features_reply(&features
, request
);
5421 ofconn_send_reply(ofconn
, b
);
5426 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
5429 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5430 struct ovs_list replies
;
5431 uint64_t bands_stub
[256 / 8];
5432 struct ofpbuf bands
;
5433 uint32_t meter_id
, first
, last
;
5435 ofputil_decode_meter_request(request
, &meter_id
);
5437 if (meter_id
== OFPM13_ALL
) {
5439 last
= ofproto
->meter_features
.max_meters
;
5441 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
5442 !ofproto
->meters
[meter_id
]) {
5443 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5445 first
= last
= meter_id
;
5448 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5449 ofpmp_init(&replies
, request
);
5451 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5452 struct meter
*meter
= ofproto
->meters
[meter_id
];
5454 continue; /* Skip non-existing meters. */
5456 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
5457 struct ofputil_meter_stats stats
;
5459 stats
.meter_id
= meter_id
;
5461 /* Provider sets the packet and byte counts, we do the rest. */
5462 stats
.flow_count
= list_size(&meter
->rules
);
5463 calc_duration(meter
->created
, time_msec(),
5464 &stats
.duration_sec
, &stats
.duration_nsec
);
5465 stats
.n_bands
= meter
->n_bands
;
5466 ofpbuf_clear(&bands
);
5468 = ofpbuf_put_uninit(&bands
,
5469 meter
->n_bands
* sizeof *stats
.bands
);
5471 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
5472 meter
->provider_meter_id
,
5474 ofputil_append_meter_stats(&replies
, &stats
);
5476 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5477 struct ofputil_meter_config config
;
5479 config
.meter_id
= meter_id
;
5480 config
.flags
= meter
->flags
;
5481 config
.n_bands
= meter
->n_bands
;
5482 config
.bands
= meter
->bands
;
5483 ofputil_append_meter_config(&replies
, &config
);
5487 ofconn_send_replies(ofconn
, &replies
);
5488 ofpbuf_uninit(&bands
);
5493 ofproto_group_lookup__(const struct ofproto
*ofproto
, uint32_t group_id
,
5494 struct ofgroup
**group
)
5495 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5497 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5498 hash_int(group_id
, 0), &ofproto
->groups
) {
5499 if ((*group
)->group_id
== group_id
) {
5507 /* If the group exists, this function increments the groups's reference count.
5509 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5510 * a reference to the group. */
5512 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5513 struct ofgroup
**group
)
5517 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5518 found
= ofproto_group_lookup__(ofproto
, group_id
, group
);
5520 ofproto_group_ref(*group
);
5522 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5527 ofproto_group_exists__(const struct ofproto
*ofproto
, uint32_t group_id
)
5528 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5530 struct ofgroup
*grp
;
5532 HMAP_FOR_EACH_IN_BUCKET (grp
, hmap_node
,
5533 hash_int(group_id
, 0), &ofproto
->groups
) {
5534 if (grp
->group_id
== group_id
) {
5542 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
5543 OVS_EXCLUDED(ofproto
->groups_rwlock
)
5547 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5548 exists
= ofproto_group_exists__(ofproto
, group_id
);
5549 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5555 group_get_ref_count(struct ofgroup
*group
)
5556 OVS_EXCLUDED(ofproto_mutex
)
5558 struct ofproto
*ofproto
= CONST_CAST(struct ofproto
*, group
->ofproto
);
5559 struct rule_criteria criteria
;
5560 struct rule_collection rules
;
5565 match_init_catchall(&match
);
5566 rule_criteria_init(&criteria
, 0xff, &match
, 0, htonll(0), htonll(0),
5567 OFPP_ANY
, group
->group_id
);
5568 ovs_mutex_lock(&ofproto_mutex
);
5569 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
5570 ovs_mutex_unlock(&ofproto_mutex
);
5571 rule_criteria_destroy(&criteria
);
5573 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
5575 rule_collection_destroy(&rules
);
5580 append_group_stats(struct ofgroup
*group
, struct ovs_list
*replies
)
5582 struct ofputil_group_stats ogs
;
5583 const struct ofproto
*ofproto
= group
->ofproto
;
5584 long long int now
= time_msec();
5587 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
5589 /* Provider sets the packet and byte counts, we do the rest. */
5590 ogs
.ref_count
= group_get_ref_count(group
);
5591 ogs
.n_buckets
= group
->n_buckets
;
5593 error
= (ofproto
->ofproto_class
->group_get_stats
5594 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
5597 ogs
.packet_count
= UINT64_MAX
;
5598 ogs
.byte_count
= UINT64_MAX
;
5599 memset(ogs
.bucket_stats
, 0xff,
5600 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
5603 ogs
.group_id
= group
->group_id
;
5604 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
5606 ofputil_append_group_stats(replies
, &ogs
);
5608 free(ogs
.bucket_stats
);
5612 handle_group_request(struct ofconn
*ofconn
,
5613 const struct ofp_header
*request
, uint32_t group_id
,
5614 void (*cb
)(struct ofgroup
*, struct ovs_list
*replies
))
5616 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5617 struct ofgroup
*group
;
5618 struct ovs_list replies
;
5620 ofpmp_init(&replies
, request
);
5621 if (group_id
== OFPG_ALL
) {
5622 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5623 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5624 cb(group
, &replies
);
5626 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5628 if (ofproto_group_lookup(ofproto
, group_id
, &group
)) {
5629 cb(group
, &replies
);
5630 ofproto_group_unref(group
);
5633 ofconn_send_replies(ofconn
, &replies
);
5637 handle_group_stats_request(struct ofconn
*ofconn
,
5638 const struct ofp_header
*request
)
5643 error
= ofputil_decode_group_stats_request(request
, &group_id
);
5648 handle_group_request(ofconn
, request
, group_id
, append_group_stats
);
5653 append_group_desc(struct ofgroup
*group
, struct ovs_list
*replies
)
5655 struct ofputil_group_desc gds
;
5657 gds
.group_id
= group
->group_id
;
5658 gds
.type
= group
->type
;
5659 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, replies
);
5663 handle_group_desc_stats_request(struct ofconn
*ofconn
,
5664 const struct ofp_header
*request
)
5666 handle_group_request(ofconn
, request
,
5667 ofputil_decode_group_desc_request(request
),
5673 handle_group_features_stats_request(struct ofconn
*ofconn
,
5674 const struct ofp_header
*request
)
5676 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5679 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
5681 ofconn_send_reply(ofconn
, msg
);
5688 handle_queue_get_config_request(struct ofconn
*ofconn
,
5689 const struct ofp_header
*oh
)
5691 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5692 struct netdev_queue_dump queue_dump
;
5693 struct ofport
*ofport
;
5694 unsigned int queue_id
;
5695 struct ofpbuf
*reply
;
5696 struct smap details
;
5700 error
= ofputil_decode_queue_get_config_request(oh
, &request
);
5705 ofport
= ofproto_get_port(p
, request
);
5707 return OFPERR_OFPQOFC_BAD_PORT
;
5710 reply
= ofputil_encode_queue_get_config_reply(oh
);
5712 smap_init(&details
);
5713 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
, ofport
->netdev
) {
5714 struct ofputil_queue_config queue
;
5716 /* None of the existing queues have compatible properties, so we
5717 * hard-code omitting min_rate and max_rate. */
5718 queue
.queue_id
= queue_id
;
5719 queue
.min_rate
= UINT16_MAX
;
5720 queue
.max_rate
= UINT16_MAX
;
5721 ofputil_append_queue_get_config_reply(reply
, &queue
);
5723 smap_destroy(&details
);
5725 ofconn_send_reply(ofconn
, reply
);
5731 init_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
,
5732 struct ofgroup
**ofgroup
)
5735 const long long int now
= time_msec();
5737 if (gm
->group_id
> OFPG_MAX
) {
5738 return OFPERR_OFPGMFC_INVALID_GROUP
;
5740 if (gm
->type
> OFPGT11_FF
) {
5741 return OFPERR_OFPGMFC_BAD_TYPE
;
5744 *ofgroup
= ofproto
->ofproto_class
->group_alloc();
5746 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
5747 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5750 (*ofgroup
)->ofproto
= ofproto
;
5751 *CONST_CAST(uint32_t *, &((*ofgroup
)->group_id
)) = gm
->group_id
;
5752 *CONST_CAST(enum ofp11_group_type
*, &(*ofgroup
)->type
) = gm
->type
;
5753 *CONST_CAST(long long int *, &((*ofgroup
)->created
)) = now
;
5754 *CONST_CAST(long long int *, &((*ofgroup
)->modified
)) = now
;
5755 ovs_refcount_init(&(*ofgroup
)->ref_count
);
5757 list_move(&(*ofgroup
)->buckets
, &gm
->buckets
);
5758 *CONST_CAST(uint32_t *, &(*ofgroup
)->n_buckets
) =
5759 list_size(&(*ofgroup
)->buckets
);
5761 /* Construct called BEFORE any locks are held. */
5762 error
= ofproto
->ofproto_class
->group_construct(*ofgroup
);
5764 ofputil_bucket_list_destroy(&(*ofgroup
)->buckets
);
5765 ofproto
->ofproto_class
->group_dealloc(*ofgroup
);
5770 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
5771 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
5774 add_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5776 struct ofgroup
*ofgroup
;
5779 /* Allocate new group and initialize it. */
5780 error
= init_group(ofproto
, gm
, &ofgroup
);
5785 /* We wrlock as late as possible to minimize the time we jam any other
5786 * threads: No visible state changes before acquiring the lock. */
5787 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5789 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5790 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5794 if (ofproto_group_exists__(ofproto
, gm
->group_id
)) {
5795 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
5800 /* Insert new group. */
5801 hmap_insert(&ofproto
->groups
, &ofgroup
->hmap_node
,
5802 hash_int(ofgroup
->group_id
, 0));
5803 ofproto
->n_groups
[ofgroup
->type
]++;
5805 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5810 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5811 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5812 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5813 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5818 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
5819 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
5820 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
5821 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
5824 copy_buckets_for_insert_bucket(const struct ofgroup
*ofgroup
,
5825 struct ofgroup
*new_ofgroup
,
5826 uint32_t command_bucket_id
)
5828 struct ofputil_bucket
*last
= NULL
;
5830 if (command_bucket_id
<= OFPG15_BUCKET_MAX
) {
5831 /* Check here to ensure that a bucket corresponding to
5832 * command_bucket_id exists in the old bucket list.
5834 * The subsequent search of below of new_ofgroup covers
5835 * both buckets in the old bucket list and buckets added
5836 * by the insert buckets group mod message this function processes. */
5837 if (!ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
)) {
5838 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
5841 if (!list_is_empty(&new_ofgroup
->buckets
)) {
5842 last
= ofputil_bucket_list_back(&new_ofgroup
->buckets
);
5846 ofputil_bucket_clone_list(&new_ofgroup
->buckets
, &ofgroup
->buckets
, NULL
);
5848 if (ofputil_bucket_check_duplicate_id(&ofgroup
->buckets
)) {
5849 VLOG_WARN_RL(&rl
, "Duplicate bucket id");
5850 return OFPERR_OFPGMFC_BUCKET_EXISTS
;
5853 /* Rearrange list according to command_bucket_id */
5854 if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
5855 struct ofputil_bucket
*new_first
;
5856 const struct ofputil_bucket
*first
;
5858 first
= ofputil_bucket_list_front(&ofgroup
->buckets
);
5859 new_first
= ofputil_bucket_find(&new_ofgroup
->buckets
,
5862 list_splice(new_ofgroup
->buckets
.next
, &new_first
->list_node
,
5863 &new_ofgroup
->buckets
);
5864 } else if (command_bucket_id
<= OFPG15_BUCKET_MAX
&& last
) {
5865 struct ofputil_bucket
*after
;
5867 /* Presence of bucket is checked above so after should never be NULL */
5868 after
= ofputil_bucket_find(&new_ofgroup
->buckets
, command_bucket_id
);
5870 list_splice(after
->list_node
.next
, new_ofgroup
->buckets
.next
,
5871 last
->list_node
.next
);
5877 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
5878 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
5879 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
5880 * and OFPG15_BUCKET_ALL are also honored. */
5882 copy_buckets_for_remove_bucket(const struct ofgroup
*ofgroup
,
5883 struct ofgroup
*new_ofgroup
,
5884 uint32_t command_bucket_id
)
5886 const struct ofputil_bucket
*skip
= NULL
;
5888 if (command_bucket_id
== OFPG15_BUCKET_ALL
) {
5892 if (command_bucket_id
== OFPG15_BUCKET_FIRST
) {
5893 if (!list_is_empty(&ofgroup
->buckets
)) {
5894 skip
= ofputil_bucket_list_front(&ofgroup
->buckets
);
5896 } else if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
5897 if (!list_is_empty(&ofgroup
->buckets
)) {
5898 skip
= ofputil_bucket_list_back(&ofgroup
->buckets
);
5901 skip
= ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
);
5903 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
5907 ofputil_bucket_clone_list(&new_ofgroup
->buckets
, &ofgroup
->buckets
, skip
);
5912 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
5913 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
5916 * Note that the group is re-created and then replaces the old group in
5917 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
5918 * the xlate module hold a pointer to the group. */
5920 modify_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5922 struct ofgroup
*ofgroup
, *new_ofgroup
, *retiring
;
5925 error
= init_group(ofproto
, gm
, &new_ofgroup
);
5930 retiring
= new_ofgroup
;
5932 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5933 if (!ofproto_group_lookup__(ofproto
, gm
->group_id
, &ofgroup
)) {
5934 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
5938 /* Ofproto's group write lock is held now. */
5939 if (ofgroup
->type
!= gm
->type
5940 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5941 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5945 /* Manipulate bucket list for bucket commands */
5946 if (gm
->command
== OFPGC15_INSERT_BUCKET
) {
5947 error
= copy_buckets_for_insert_bucket(ofgroup
, new_ofgroup
,
5948 gm
->command_bucket_id
);
5949 } else if (gm
->command
== OFPGC15_REMOVE_BUCKET
) {
5950 error
= copy_buckets_for_remove_bucket(ofgroup
, new_ofgroup
,
5951 gm
->command_bucket_id
);
5957 /* The group creation time does not change during modification. */
5958 *CONST_CAST(long long int *, &(new_ofgroup
->created
)) = ofgroup
->created
;
5959 *CONST_CAST(long long int *, &(new_ofgroup
->modified
)) = time_msec();
5961 error
= ofproto
->ofproto_class
->group_modify(new_ofgroup
);
5967 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
5968 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5969 hmap_insert(&ofproto
->groups
, &new_ofgroup
->hmap_node
,
5970 hash_int(new_ofgroup
->group_id
, 0));
5971 if (ofgroup
->type
!= new_ofgroup
->type
) {
5972 ofproto
->n_groups
[ofgroup
->type
]--;
5973 ofproto
->n_groups
[new_ofgroup
->type
]++;
5977 ofproto_group_unref(retiring
);
5978 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5983 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
5984 OVS_RELEASES(ofproto
->groups_rwlock
)
5987 struct ofputil_flow_mod fm
;
5989 /* Delete all flow entries containing this group in a group action */
5990 match_init_catchall(&match
);
5991 flow_mod_init(&fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
5992 fm
.delete_reason
= OFPRR_GROUP_DELETE
;
5993 fm
.out_group
= ofgroup
->group_id
;
5994 handle_flow_mod__(ofproto
, &fm
, NULL
);
5996 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5997 /* No-one can find this group any more. */
5998 ofproto
->n_groups
[ofgroup
->type
]--;
5999 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6000 ofproto_group_unref(ofgroup
);
6003 /* Implements OFPGC11_DELETE. */
6005 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
6007 struct ofgroup
*ofgroup
;
6009 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6010 if (group_id
== OFPG_ALL
) {
6012 struct hmap_node
*node
= hmap_first(&ofproto
->groups
);
6016 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, hmap_node
);
6017 delete_group__(ofproto
, ofgroup
);
6018 /* Lock for each node separately, so that we will not jam the
6019 * other threads for too long time. */
6020 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6023 HMAP_FOR_EACH_IN_BUCKET (ofgroup
, hmap_node
,
6024 hash_int(group_id
, 0), &ofproto
->groups
) {
6025 if (ofgroup
->group_id
== group_id
) {
6026 delete_group__(ofproto
, ofgroup
);
6031 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6035 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6037 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6038 struct ofputil_group_mod gm
;
6041 error
= reject_slave_controller(ofconn
);
6046 error
= ofputil_decode_group_mod(oh
, &gm
);
6051 switch (gm
.command
) {
6053 return add_group(ofproto
, &gm
);
6055 case OFPGC11_MODIFY
:
6056 return modify_group(ofproto
, &gm
);
6058 case OFPGC11_DELETE
:
6059 delete_group(ofproto
, gm
.group_id
);
6062 case OFPGC15_INSERT_BUCKET
:
6063 return modify_group(ofproto
, &gm
);
6065 case OFPGC15_REMOVE_BUCKET
:
6066 return modify_group(ofproto
, &gm
);
6069 if (gm
.command
> OFPGC11_DELETE
) {
6070 VLOG_WARN_RL(&rl
, "%s: Invalid group_mod command type %d",
6071 ofproto
->name
, gm
.command
);
6073 return OFPERR_OFPGMFC_BAD_COMMAND
;
6077 enum ofputil_table_miss
6078 ofproto_table_get_miss_config(const struct ofproto
*ofproto
, uint8_t table_id
)
6080 enum ofputil_table_miss value
;
6082 atomic_read_relaxed(&ofproto
->tables
[table_id
].miss_config
, &value
);
6087 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
6089 if (!check_table_id(ofproto
, tm
->table_id
)) {
6090 return OFPERR_OFPTMFC_BAD_TABLE
;
6091 } else if (tm
->miss_config
!= OFPUTIL_TABLE_MISS_DEFAULT
) {
6092 if (tm
->table_id
== OFPTT_ALL
) {
6094 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
6095 atomic_store_relaxed(&ofproto
->tables
[i
].miss_config
,
6099 atomic_store_relaxed(&ofproto
->tables
[tm
->table_id
].miss_config
,
6107 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6109 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6110 struct ofputil_table_mod tm
;
6113 error
= reject_slave_controller(ofconn
);
6118 error
= ofputil_decode_table_mod(oh
, &tm
);
6123 return table_mod(ofproto
, &tm
);
6127 handle_bundle_control(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6130 struct ofputil_bundle_ctrl_msg bctrl
;
6132 struct ofputil_bundle_ctrl_msg reply
;
6134 error
= reject_slave_controller(ofconn
);
6139 error
= ofputil_decode_bundle_ctrl(oh
, &bctrl
);
6144 reply
.bundle_id
= bctrl
.bundle_id
;
6146 switch (bctrl
.type
) {
6147 case OFPBCT_OPEN_REQUEST
:
6148 error
= ofp_bundle_open(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6149 reply
.type
= OFPBCT_OPEN_REPLY
;
6151 case OFPBCT_CLOSE_REQUEST
:
6152 error
= ofp_bundle_close(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6153 reply
.type
= OFPBCT_CLOSE_REPLY
;;
6155 case OFPBCT_COMMIT_REQUEST
:
6156 error
= ofp_bundle_commit(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6157 reply
.type
= OFPBCT_COMMIT_REPLY
;
6159 case OFPBCT_DISCARD_REQUEST
:
6160 error
= ofp_bundle_discard(ofconn
, bctrl
.bundle_id
);
6161 reply
.type
= OFPBCT_DISCARD_REPLY
;
6164 case OFPBCT_OPEN_REPLY
:
6165 case OFPBCT_CLOSE_REPLY
:
6166 case OFPBCT_COMMIT_REPLY
:
6167 case OFPBCT_DISCARD_REPLY
:
6168 return OFPERR_OFPBFC_BAD_TYPE
;
6173 buf
= ofputil_encode_bundle_ctrl_reply(oh
, &reply
);
6174 ofconn_send_reply(ofconn
, buf
);
6181 handle_bundle_add(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6184 struct ofputil_bundle_add_msg badd
;
6186 error
= reject_slave_controller(ofconn
);
6191 error
= ofputil_decode_bundle_add(oh
, &badd
);
6196 return ofp_bundle_add_message(ofconn
, &badd
);
6200 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
6201 OVS_EXCLUDED(ofproto_mutex
)
6203 const struct ofp_header
*oh
= ofpbuf_data(msg
);
6207 error
= ofptype_decode(&type
, oh
);
6211 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
6212 && ofpmp_more(oh
)) {
6213 /* We have no buffer implementation for multipart requests.
6214 * Report overflow for requests which consists of multiple
6216 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
6220 /* OpenFlow requests. */
6221 case OFPTYPE_ECHO_REQUEST
:
6222 return handle_echo_request(ofconn
, oh
);
6224 case OFPTYPE_FEATURES_REQUEST
:
6225 return handle_features_request(ofconn
, oh
);
6227 case OFPTYPE_GET_CONFIG_REQUEST
:
6228 return handle_get_config_request(ofconn
, oh
);
6230 case OFPTYPE_SET_CONFIG
:
6231 return handle_set_config(ofconn
, oh
);
6233 case OFPTYPE_PACKET_OUT
:
6234 return handle_packet_out(ofconn
, oh
);
6236 case OFPTYPE_PORT_MOD
:
6237 return handle_port_mod(ofconn
, oh
);
6239 case OFPTYPE_FLOW_MOD
:
6240 return handle_flow_mod(ofconn
, oh
);
6242 case OFPTYPE_GROUP_MOD
:
6243 return handle_group_mod(ofconn
, oh
);
6245 case OFPTYPE_TABLE_MOD
:
6246 return handle_table_mod(ofconn
, oh
);
6248 case OFPTYPE_METER_MOD
:
6249 return handle_meter_mod(ofconn
, oh
);
6251 case OFPTYPE_BARRIER_REQUEST
:
6252 return handle_barrier_request(ofconn
, oh
);
6254 case OFPTYPE_ROLE_REQUEST
:
6255 return handle_role_request(ofconn
, oh
);
6257 /* OpenFlow replies. */
6258 case OFPTYPE_ECHO_REPLY
:
6261 /* Nicira extension requests. */
6262 case OFPTYPE_FLOW_MOD_TABLE_ID
:
6263 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
6265 case OFPTYPE_SET_FLOW_FORMAT
:
6266 return handle_nxt_set_flow_format(ofconn
, oh
);
6268 case OFPTYPE_SET_PACKET_IN_FORMAT
:
6269 return handle_nxt_set_packet_in_format(ofconn
, oh
);
6271 case OFPTYPE_SET_CONTROLLER_ID
:
6272 return handle_nxt_set_controller_id(ofconn
, oh
);
6274 case OFPTYPE_FLOW_AGE
:
6275 /* Nothing to do. */
6278 case OFPTYPE_FLOW_MONITOR_CANCEL
:
6279 return handle_flow_monitor_cancel(ofconn
, oh
);
6281 case OFPTYPE_SET_ASYNC_CONFIG
:
6282 return handle_nxt_set_async_config(ofconn
, oh
);
6284 case OFPTYPE_GET_ASYNC_REQUEST
:
6285 return handle_nxt_get_async_request(ofconn
, oh
);
6287 /* Statistics requests. */
6288 case OFPTYPE_DESC_STATS_REQUEST
:
6289 return handle_desc_stats_request(ofconn
, oh
);
6291 case OFPTYPE_FLOW_STATS_REQUEST
:
6292 return handle_flow_stats_request(ofconn
, oh
);
6294 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
6295 return handle_aggregate_stats_request(ofconn
, oh
);
6297 case OFPTYPE_TABLE_STATS_REQUEST
:
6298 return handle_table_stats_request(ofconn
, oh
);
6300 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
6301 return handle_table_features_request(ofconn
, oh
);
6303 case OFPTYPE_PORT_STATS_REQUEST
:
6304 return handle_port_stats_request(ofconn
, oh
);
6306 case OFPTYPE_QUEUE_STATS_REQUEST
:
6307 return handle_queue_stats_request(ofconn
, oh
);
6309 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
6310 return handle_port_desc_stats_request(ofconn
, oh
);
6312 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
6313 return handle_flow_monitor_request(ofconn
, oh
);
6315 case OFPTYPE_METER_STATS_REQUEST
:
6316 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
6317 return handle_meter_request(ofconn
, oh
, type
);
6319 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
6320 return handle_meter_features_request(ofconn
, oh
);
6322 case OFPTYPE_GROUP_STATS_REQUEST
:
6323 return handle_group_stats_request(ofconn
, oh
);
6325 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
6326 return handle_group_desc_stats_request(ofconn
, oh
);
6328 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
6329 return handle_group_features_stats_request(ofconn
, oh
);
6331 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
6332 return handle_queue_get_config_request(ofconn
, oh
);
6334 case OFPTYPE_BUNDLE_CONTROL
:
6335 return handle_bundle_control(ofconn
, oh
);
6337 case OFPTYPE_BUNDLE_ADD_MESSAGE
:
6338 return handle_bundle_add(ofconn
, oh
);
6342 case OFPTYPE_FEATURES_REPLY
:
6343 case OFPTYPE_GET_CONFIG_REPLY
:
6344 case OFPTYPE_PACKET_IN
:
6345 case OFPTYPE_FLOW_REMOVED
:
6346 case OFPTYPE_PORT_STATUS
:
6347 case OFPTYPE_BARRIER_REPLY
:
6348 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
6349 case OFPTYPE_DESC_STATS_REPLY
:
6350 case OFPTYPE_FLOW_STATS_REPLY
:
6351 case OFPTYPE_QUEUE_STATS_REPLY
:
6352 case OFPTYPE_PORT_STATS_REPLY
:
6353 case OFPTYPE_TABLE_STATS_REPLY
:
6354 case OFPTYPE_AGGREGATE_STATS_REPLY
:
6355 case OFPTYPE_PORT_DESC_STATS_REPLY
:
6356 case OFPTYPE_ROLE_REPLY
:
6357 case OFPTYPE_FLOW_MONITOR_PAUSED
:
6358 case OFPTYPE_FLOW_MONITOR_RESUMED
:
6359 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
6360 case OFPTYPE_GET_ASYNC_REPLY
:
6361 case OFPTYPE_GROUP_STATS_REPLY
:
6362 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
6363 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
6364 case OFPTYPE_METER_STATS_REPLY
:
6365 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
6366 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
6367 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
6368 case OFPTYPE_ROLE_STATUS
:
6370 if (ofpmsg_is_stat_request(oh
)) {
6371 return OFPERR_OFPBRC_BAD_STAT
;
6373 return OFPERR_OFPBRC_BAD_TYPE
;
6379 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
6380 OVS_EXCLUDED(ofproto_mutex
)
6382 int error
= handle_openflow__(ofconn
, ofp_msg
);
6384 ofconn_send_error(ofconn
, ofpbuf_data(ofp_msg
), error
);
6386 COVERAGE_INC(ofproto_recv_openflow
);
6389 /* Asynchronous operations. */
6392 send_buffered_packet(struct ofconn
*ofconn
, uint32_t buffer_id
,
6394 OVS_REQUIRES(ofproto_mutex
)
6396 enum ofperr error
= 0;
6397 if (ofconn
&& buffer_id
!= UINT32_MAX
) {
6398 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6399 struct ofpbuf
*packet
;
6402 error
= ofconn_pktbuf_retrieve(ofconn
, buffer_id
, &packet
, &in_port
);
6404 struct rule_execute
*re
;
6406 ofproto_rule_ref(rule
);
6408 re
= xmalloc(sizeof *re
);
6410 re
->in_port
= in_port
;
6411 re
->packet
= packet
;
6413 if (!guarded_list_push_back(&ofproto
->rule_executes
,
6414 &re
->list_node
, 1024)) {
6415 ofproto_rule_unref(rule
);
6416 ofpbuf_delete(re
->packet
);
6425 pick_datapath_id(const struct ofproto
*ofproto
)
6427 const struct ofport
*port
;
6429 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
6431 uint8_t ea
[ETH_ADDR_LEN
];
6434 error
= netdev_get_etheraddr(port
->netdev
, ea
);
6436 return eth_addr_to_uint64(ea
);
6438 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6439 ofproto
->name
, netdev_get_name(port
->netdev
),
6440 ovs_strerror(error
));
6442 return ofproto
->fallback_dpid
;
6446 pick_fallback_dpid(void)
6448 uint8_t ea
[ETH_ADDR_LEN
];
6449 eth_addr_nicira_random(ea
);
6450 return eth_addr_to_uint64(ea
);
6453 /* Table overflow policy. */
6455 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6456 * to NULL if the table is not configured to evict rules or if the table
6457 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6458 * or with no timeouts are not evictable.) */
6460 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
6461 OVS_REQUIRES(ofproto_mutex
)
6463 struct eviction_group
*evg
;
6466 if (!table
->eviction_fields
) {
6470 /* In the common case, the outer and inner loops here will each be entered
6473 * - The inner loop normally "return"s in its first iteration. If the
6474 * eviction group has any evictable rules, then it always returns in
6477 * - The outer loop only iterates more than once if the largest eviction
6478 * group has no evictable rules.
6480 * - The outer loop can exit only if table's 'max_flows' is all filled up
6481 * by unevictable rules. */
6482 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
6485 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
6494 /* Eviction groups. */
6496 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6497 * rules. The priority contains low-order random bits to ensure that eviction
6498 * groups with the same number of rules are prioritized randomly. */
6500 eviction_group_priority(size_t n_rules
)
6502 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
6503 return (size
<< 16) | random_uint16();
6506 /* Updates 'evg', an eviction_group within 'table', following a change that
6507 * adds or removes rules in 'evg'. */
6509 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
6510 OVS_REQUIRES(ofproto_mutex
)
6512 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
6513 eviction_group_priority(heap_count(&evg
->rules
)));
6516 /* Destroys 'evg', an eviction_group within 'table':
6518 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6519 * rules themselves, just removes them from the eviction group.)
6521 * - Removes 'evg' from 'table'.
6525 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
6526 OVS_REQUIRES(ofproto_mutex
)
6528 while (!heap_is_empty(&evg
->rules
)) {
6531 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
6532 rule
->eviction_group
= NULL
;
6534 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
6535 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
6536 heap_destroy(&evg
->rules
);
6540 /* Removes 'rule' from its eviction group, if any. */
6542 eviction_group_remove_rule(struct rule
*rule
)
6543 OVS_REQUIRES(ofproto_mutex
)
6545 if (rule
->eviction_group
) {
6546 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6547 struct eviction_group
*evg
= rule
->eviction_group
;
6549 rule
->eviction_group
= NULL
;
6550 heap_remove(&evg
->rules
, &rule
->evg_node
);
6551 if (heap_is_empty(&evg
->rules
)) {
6552 eviction_group_destroy(table
, evg
);
6554 eviction_group_resized(table
, evg
);
6559 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6560 * returns the hash value. */
6562 eviction_group_hash_rule(struct rule
*rule
)
6563 OVS_REQUIRES(ofproto_mutex
)
6565 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6566 const struct mf_subfield
*sf
;
6570 hash
= table
->eviction_group_id_basis
;
6571 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
6572 for (sf
= table
->eviction_fields
;
6573 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
6576 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
6577 union mf_value value
;
6579 mf_get_value(sf
->field
, &flow
, &value
);
6581 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
6583 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
6584 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
6585 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
6586 sf
->field
->n_bytes
* 8 - start
);
6588 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
6590 hash
= hash_int(hash
, 0);
6597 /* Returns an eviction group within 'table' with the given 'id', creating one
6599 static struct eviction_group
*
6600 eviction_group_find(struct oftable
*table
, uint32_t id
)
6601 OVS_REQUIRES(ofproto_mutex
)
6603 struct eviction_group
*evg
;
6605 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
6609 evg
= xmalloc(sizeof *evg
);
6610 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
6611 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
6612 eviction_group_priority(0));
6613 heap_init(&evg
->rules
);
6618 /* Returns an eviction priority for 'rule'. The return value should be
6619 * interpreted so that higher priorities make a rule more attractive candidates
6621 * Called only if have a timeout. */
6623 rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*rule
)
6624 OVS_REQUIRES(ofproto_mutex
)
6626 long long int expiration
= LLONG_MAX
;
6627 long long int modified
;
6628 uint32_t expiration_offset
;
6630 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6631 ovs_mutex_lock(&rule
->mutex
);
6632 modified
= rule
->modified
;
6633 ovs_mutex_unlock(&rule
->mutex
);
6635 if (rule
->hard_timeout
) {
6636 expiration
= modified
+ rule
->hard_timeout
* 1000;
6638 if (rule
->idle_timeout
) {
6639 uint64_t packets
, bytes
;
6641 long long int idle_expiration
;
6643 ofproto
->ofproto_class
->rule_get_stats(rule
, &packets
, &bytes
, &used
);
6644 idle_expiration
= used
+ rule
->idle_timeout
* 1000;
6645 expiration
= MIN(expiration
, idle_expiration
);
6648 if (expiration
== LLONG_MAX
) {
6652 /* Calculate the time of expiration as a number of (approximate) seconds
6653 * after program startup.
6655 * This should work OK for program runs that last UINT32_MAX seconds or
6656 * less. Therefore, please restart OVS at least once every 136 years. */
6657 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
6659 /* Invert the expiration offset because we're using a max-heap. */
6660 return UINT32_MAX
- expiration_offset
;
6663 /* Adds 'rule' to an appropriate eviction group for its oftable's
6664 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6665 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6668 * The caller must ensure that 'rule' is not already in an eviction group. */
6670 eviction_group_add_rule(struct rule
*rule
)
6671 OVS_REQUIRES(ofproto_mutex
)
6673 struct ofproto
*ofproto
= rule
->ofproto
;
6674 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6677 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6678 * so no additional protection is needed. */
6679 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
6681 if (table
->eviction_fields
&& has_timeout
) {
6682 struct eviction_group
*evg
;
6684 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
6686 rule
->eviction_group
= evg
;
6687 heap_insert(&evg
->rules
, &rule
->evg_node
,
6688 rule_eviction_priority(ofproto
, rule
));
6689 eviction_group_resized(table
, evg
);
6695 /* Initializes 'table'. */
6697 oftable_init(struct oftable
*table
)
6699 memset(table
, 0, sizeof *table
);
6700 classifier_init(&table
->cls
, flow_segment_u32s
);
6701 table
->max_flows
= UINT_MAX
;
6702 atomic_init(&table
->miss_config
, OFPUTIL_TABLE_MISS_DEFAULT
);
6704 classifier_set_prefix_fields(&table
->cls
, default_prefix_fields
,
6705 ARRAY_SIZE(default_prefix_fields
));
6707 atomic_init(&table
->n_matched
, 0);
6708 atomic_init(&table
->n_missed
, 0);
6711 /* Destroys 'table', including its classifier and eviction groups.
6713 * The caller is responsible for freeing 'table' itself. */
6715 oftable_destroy(struct oftable
*table
)
6717 ovs_assert(classifier_is_empty(&table
->cls
));
6718 oftable_disable_eviction(table
);
6719 classifier_destroy(&table
->cls
);
6723 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6724 * string, then 'table' will use its default name.
6726 * This only affects the name exposed for a table exposed through the OpenFlow
6727 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6729 oftable_set_name(struct oftable
*table
, const char *name
)
6731 if (name
&& name
[0]) {
6732 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
6733 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
6735 table
->name
= xmemdup0(name
, len
);
6743 /* oftables support a choice of two policies when adding a rule would cause the
6744 * number of flows in the table to exceed the configured maximum number: either
6745 * they can refuse to add the new flow or they can evict some existing flow.
6746 * This function configures the former policy on 'table'. */
6748 oftable_disable_eviction(struct oftable
*table
)
6749 OVS_REQUIRES(ofproto_mutex
)
6751 if (table
->eviction_fields
) {
6752 struct eviction_group
*evg
, *next
;
6754 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
6755 &table
->eviction_groups_by_id
) {
6756 eviction_group_destroy(table
, evg
);
6758 hmap_destroy(&table
->eviction_groups_by_id
);
6759 heap_destroy(&table
->eviction_groups_by_size
);
6761 free(table
->eviction_fields
);
6762 table
->eviction_fields
= NULL
;
6763 table
->n_eviction_fields
= 0;
6767 /* oftables support a choice of two policies when adding a rule would cause the
6768 * number of flows in the table to exceed the configured maximum number: either
6769 * they can refuse to add the new flow or they can evict some existing flow.
6770 * This function configures the latter policy on 'table', with fairness based
6771 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6772 * 'n_fields' as 0 disables fairness.) */
6774 oftable_enable_eviction(struct oftable
*table
,
6775 const struct mf_subfield
*fields
, size_t n_fields
)
6776 OVS_REQUIRES(ofproto_mutex
)
6780 if (table
->eviction_fields
6781 && n_fields
== table
->n_eviction_fields
6783 || !memcmp(fields
, table
->eviction_fields
,
6784 n_fields
* sizeof *fields
))) {
6789 oftable_disable_eviction(table
);
6791 table
->n_eviction_fields
= n_fields
;
6792 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
6794 table
->eviction_group_id_basis
= random_uint32();
6795 hmap_init(&table
->eviction_groups_by_id
);
6796 heap_init(&table
->eviction_groups_by_size
);
6798 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
6799 eviction_group_add_rule(rule
);
6803 /* Removes 'rule' from the ofproto data structures AFTER caller has removed
6804 * it from the classifier. */
6806 ofproto_rule_remove__(struct ofproto
*ofproto
, struct rule
*rule
)
6807 OVS_REQUIRES(ofproto_mutex
)
6809 cookies_remove(ofproto
, rule
);
6811 eviction_group_remove_rule(rule
);
6812 if (!list_is_empty(&rule
->expirable
)) {
6813 list_remove(&rule
->expirable
);
6815 if (!list_is_empty(&rule
->meter_list_node
)) {
6816 list_remove(&rule
->meter_list_node
);
6817 list_init(&rule
->meter_list_node
);
6822 oftable_remove_rule(struct rule
*rule
)
6823 OVS_REQUIRES(ofproto_mutex
)
6825 struct classifier
*cls
= &rule
->ofproto
->tables
[rule
->table_id
].cls
;
6827 if (classifier_remove(cls
, &rule
->cr
)) {
6828 ofproto_rule_remove__(rule
->ofproto
, rule
);
6832 /* unixctl commands. */
6835 ofproto_lookup(const char *name
)
6837 struct ofproto
*ofproto
;
6839 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
6841 if (!strcmp(ofproto
->name
, name
)) {
6849 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
6850 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
6852 struct ofproto
*ofproto
;
6856 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
6857 ds_put_format(&results
, "%s\n", ofproto
->name
);
6859 unixctl_command_reply(conn
, ds_cstr(&results
));
6860 ds_destroy(&results
);
6864 ofproto_unixctl_init(void)
6866 static bool registered
;
6872 unixctl_command_register("ofproto/list", "", 0, 0,
6873 ofproto_unixctl_list
, NULL
);
6876 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6878 * This is deprecated. It is only for compatibility with broken device drivers
6879 * in old versions of Linux that do not properly support VLANs when VLAN
6880 * devices are not used. When broken device drivers are no longer in
6881 * widespread use, we will delete these interfaces. */
6883 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6884 * (exactly) by an OpenFlow rule in 'ofproto'. */
6886 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
6889 struct cls_rule target
;
6890 const struct oftable
*oftable
;
6892 match_init_catchall(&match
);
6893 match_set_vlan_vid_masked(&match
, htons(VLAN_CFI
), htons(VLAN_CFI
));
6894 cls_rule_init(&target
, &match
, 0);
6896 free(ofproto
->vlan_bitmap
);
6897 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
6898 ofproto
->vlans_changed
= false;
6900 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
6903 CLS_FOR_EACH_TARGET (rule
, cr
, &oftable
->cls
, &target
) {
6904 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
6905 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
6907 bitmap_set1(vlan_bitmap
, vid
);
6908 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6913 cls_rule_destroy(&target
);
6916 /* Returns true if new VLANs have come into use by the flow table since the
6917 * last call to ofproto_get_vlan_usage().
6919 * We don't track when old VLANs stop being used. */
6921 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
6923 return ofproto
->vlans_changed
;
6926 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6927 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6928 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6929 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6930 * then the VLAN device is un-enslaved. */
6932 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
6933 ofp_port_t realdev_ofp_port
, int vid
)
6935 struct ofport
*ofport
;
6938 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
6940 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
6942 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
6943 ofproto
->name
, vlandev_ofp_port
);
6947 if (!ofproto
->ofproto_class
->set_realdev
) {
6948 if (!vlandev_ofp_port
) {
6951 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
6955 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
6957 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
6958 ofproto
->name
, vlandev_ofp_port
,
6959 netdev_get_name(ofport
->netdev
), ovs_strerror(error
));