2 * Copyright (c) 2009-2015 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
47 #include "dp-packet.h"
51 #include "poll-loop.h"
59 #include "tun-metadata.h"
60 #include "unaligned.h"
62 #include "openvswitch/vlog.h"
65 VLOG_DEFINE_THIS_MODULE(ofproto
);
67 COVERAGE_DEFINE(ofproto_flush
);
68 COVERAGE_DEFINE(ofproto_packet_out
);
69 COVERAGE_DEFINE(ofproto_queue_req
);
70 COVERAGE_DEFINE(ofproto_recv_openflow
);
71 COVERAGE_DEFINE(ofproto_reinit_ports
);
72 COVERAGE_DEFINE(ofproto_update_port
);
74 /* Default fields to use for prefix tries in each flow table, unless something
75 * else is configured. */
76 const enum mf_field_id default_prefix_fields
[2] =
77 { MFF_IPV4_DST
, MFF_IPV4_SRC
};
80 static void oftable_init(struct oftable
*);
81 static void oftable_destroy(struct oftable
*);
83 static void oftable_set_name(struct oftable
*, const char *name
);
85 static enum ofperr
evict_rules_from_table(struct oftable
*)
86 OVS_REQUIRES(ofproto_mutex
);
87 static void oftable_configure_eviction(struct oftable
*,
88 unsigned int eviction
,
89 const struct mf_subfield
*fields
,
91 OVS_REQUIRES(ofproto_mutex
);
93 /* This is the only combination of OpenFlow eviction flags that OVS supports: a
94 * combination of OF1.4+ importance, the remaining lifetime of the flow, and
95 * fairness based on user-specified fields. */
96 #define OFPROTO_EVICTION_FLAGS \
97 (OFPTMPEF14_OTHER | OFPTMPEF14_IMPORTANCE | OFPTMPEF14_LIFETIME)
99 /* A set of rules within a single OpenFlow table (oftable) that have the same
100 * values for the oftable's eviction_fields. A rule to be evicted, when one is
101 * needed, is taken from the eviction group that contains the greatest number
104 * An oftable owns any number of eviction groups, each of which contains any
107 * Membership in an eviction group is imprecise, based on the hash of the
108 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
109 * That is, if two rules have different eviction_fields, but those
110 * eviction_fields hash to the same value, then they will belong to the same
111 * eviction_group anyway.
113 * (When eviction is not enabled on an oftable, we don't track any eviction
114 * groups, to save time and space.) */
115 struct eviction_group
{
116 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
117 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
118 struct heap rules
; /* Contains "struct rule"s. */
121 static bool choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
122 OVS_REQUIRES(ofproto_mutex
);
123 static uint64_t rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*)
124 OVS_REQUIRES(ofproto_mutex
);
125 static void eviction_group_add_rule(struct rule
*)
126 OVS_REQUIRES(ofproto_mutex
);
127 static void eviction_group_remove_rule(struct rule
*)
128 OVS_REQUIRES(ofproto_mutex
);
130 /* Criteria that flow_mod and other operations use for selecting rules on
131 * which to operate. */
132 struct rule_criteria
{
133 /* An OpenFlow table or 255 for all tables. */
136 /* OpenFlow matching criteria. Interpreted different in "loose" way by
137 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
138 * defined in the OpenFlow spec. */
141 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
142 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
143 * The rule will not be selected if M is 1 and B != C. */
145 ovs_be64 cookie_mask
;
147 /* Selection based on actions within a rule:
149 * If out_port != OFPP_ANY, selects only rules that output to out_port.
150 * If out_group != OFPG_ALL, select only rules that output to out_group. */
154 /* If true, collects only rules that are modifiable. */
156 bool include_readonly
;
159 static void rule_criteria_init(struct rule_criteria
*, uint8_t table_id
,
160 const struct match
*match
, int priority
,
161 cls_version_t version
,
162 ovs_be64 cookie
, ovs_be64 cookie_mask
,
163 ofp_port_t out_port
, uint32_t out_group
);
164 static void rule_criteria_require_rw(struct rule_criteria
*,
165 bool can_write_readonly
);
166 static void rule_criteria_destroy(struct rule_criteria
*);
168 static enum ofperr
collect_rules_loose(struct ofproto
*,
169 const struct rule_criteria
*,
170 struct rule_collection
*);
172 /* A packet that needs to be passed to rule_execute().
174 * (We can't do this immediately from ofopgroup_complete() because that holds
175 * ofproto_mutex, which rule_execute() needs released.) */
176 struct rule_execute
{
177 struct ovs_list list_node
; /* In struct ofproto's "rule_executes" list. */
178 struct rule
*rule
; /* Owns a reference to the rule. */
180 struct dp_packet
*packet
; /* Owns the packet. */
183 static void run_rule_executes(struct ofproto
*) OVS_EXCLUDED(ofproto_mutex
);
184 static void destroy_rule_executes(struct ofproto
*);
186 struct learned_cookie
{
188 /* In struct ofproto's 'learned_cookies' hmap. */
189 struct hmap_node hmap_node
OVS_GUARDED_BY(ofproto_mutex
);
191 /* In 'dead_cookies' list when removed from hmap. */
192 struct ovs_list list_node
;
196 ovs_be64 cookie
OVS_GUARDED_BY(ofproto_mutex
);
197 uint8_t table_id
OVS_GUARDED_BY(ofproto_mutex
);
199 /* Number of references from "learn" actions.
201 * When this drops to 0, all of the flows in 'table_id' with the specified
202 * 'cookie' are deleted. */
203 int n
OVS_GUARDED_BY(ofproto_mutex
);
206 static const struct ofpact_learn
*next_learn_with_delete(
207 const struct rule_actions
*, const struct ofpact_learn
*start
);
209 static void learned_cookies_inc(struct ofproto
*, const struct rule_actions
*)
210 OVS_REQUIRES(ofproto_mutex
);
211 static void learned_cookies_dec(struct ofproto
*, const struct rule_actions
*,
212 struct ovs_list
*dead_cookies
)
213 OVS_REQUIRES(ofproto_mutex
);
214 static void learned_cookies_flush(struct ofproto
*, struct ovs_list
*dead_cookies
)
215 OVS_REQUIRES(ofproto_mutex
);
218 static void ofport_destroy__(struct ofport
*) OVS_EXCLUDED(ofproto_mutex
);
219 static void ofport_destroy(struct ofport
*);
221 static void update_port(struct ofproto
*, const char *devname
);
222 static int init_ports(struct ofproto
*);
223 static void reinit_ports(struct ofproto
*);
225 static long long int ofport_get_usage(const struct ofproto
*,
226 ofp_port_t ofp_port
);
227 static void ofport_set_usage(struct ofproto
*, ofp_port_t ofp_port
,
228 long long int last_used
);
229 static void ofport_remove_usage(struct ofproto
*, ofp_port_t ofp_port
);
233 * Keeps track of the currently used and recently used ofport values and is
234 * used to prevent immediate recycling of ofport values. */
235 struct ofport_usage
{
236 struct hmap_node hmap_node
; /* In struct ofproto's "ofport_usage" hmap. */
237 ofp_port_t ofp_port
; /* OpenFlow port number. */
238 long long int last_used
; /* Last time the 'ofp_port' was used. LLONG_MAX
239 represents in-use ofports. */
243 static void ofproto_rule_send_removed(struct rule
*)
244 OVS_EXCLUDED(ofproto_mutex
);
245 static bool rule_is_readonly(const struct rule
*);
246 static void ofproto_rule_insert__(struct ofproto
*, struct rule
*)
247 OVS_REQUIRES(ofproto_mutex
);
248 static void ofproto_rule_remove__(struct ofproto
*, struct rule
*)
249 OVS_REQUIRES(ofproto_mutex
);
251 /* The source of a flow_mod request, in the code that processes flow_mods.
253 * A flow table modification request can be generated externally, via OpenFlow,
254 * or internally through a function call. This structure indicates the source
255 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
256 * meaningful and thus supplied as NULL. */
257 struct flow_mod_requester
{
258 struct ofconn
*ofconn
; /* Connection on which flow_mod arrived. */
259 const struct ofp_header
*request
;
263 static enum ofperr
replace_rule_create(struct ofproto
*,
264 struct ofputil_flow_mod
*,
265 struct cls_rule
*cr
, uint8_t table_id
,
266 struct rule
*old_rule
,
267 struct rule
**new_rule
)
268 OVS_REQUIRES(ofproto_mutex
);
270 static void replace_rule_start(struct ofproto
*,
271 struct rule
*old_rule
,
272 struct rule
*new_rule
,
273 struct cls_conjunction
*, size_t n_conjs
)
274 OVS_REQUIRES(ofproto_mutex
);
276 static void replace_rule_revert(struct ofproto
*, struct rule
*old_rule
,
277 struct rule
*new_rule
)
278 OVS_REQUIRES(ofproto_mutex
);
280 static void replace_rule_finish(struct ofproto
*, struct ofputil_flow_mod
*,
281 const struct flow_mod_requester
*,
282 struct rule
*old_rule
, struct rule
*new_rule
,
283 struct ovs_list
*dead_cookies
)
284 OVS_REQUIRES(ofproto_mutex
);
285 static void delete_flows__(struct rule_collection
*,
286 enum ofp_flow_removed_reason
,
287 const struct flow_mod_requester
*)
288 OVS_REQUIRES(ofproto_mutex
);
290 static void send_buffered_packet(const struct flow_mod_requester
*,
291 uint32_t buffer_id
, struct rule
*)
292 OVS_REQUIRES(ofproto_mutex
);
294 static bool ofproto_group_exists__(const struct ofproto
*ofproto
,
296 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
);
297 static bool ofproto_group_exists(const struct ofproto
*ofproto
,
299 OVS_EXCLUDED(ofproto
->groups_rwlock
);
300 static enum ofperr
add_group(struct ofproto
*, struct ofputil_group_mod
*);
301 static void handle_openflow(struct ofconn
*, const struct ofpbuf
*);
302 static enum ofperr
do_bundle_flow_mod_start(struct ofproto
*,
303 struct ofputil_flow_mod
*,
304 struct ofp_bundle_entry
*)
305 OVS_REQUIRES(ofproto_mutex
);
306 static void do_bundle_flow_mod_finish(struct ofproto
*,
307 struct ofputil_flow_mod
*,
308 const struct flow_mod_requester
*,
309 struct ofp_bundle_entry
*)
310 OVS_REQUIRES(ofproto_mutex
);
311 static enum ofperr
handle_flow_mod__(struct ofproto
*,
312 struct ofputil_flow_mod
*,
313 const struct flow_mod_requester
*)
314 OVS_EXCLUDED(ofproto_mutex
);
315 static void calc_duration(long long int start
, long long int now
,
316 uint32_t *sec
, uint32_t *nsec
);
319 static uint64_t pick_datapath_id(const struct ofproto
*);
320 static uint64_t pick_fallback_dpid(void);
321 static void ofproto_destroy__(struct ofproto
*);
322 static void update_mtu(struct ofproto
*, struct ofport
*);
323 static void meter_delete(struct ofproto
*, uint32_t first
, uint32_t last
);
324 static void meter_insert_rule(struct rule
*);
327 static void ofproto_unixctl_init(void);
329 /* All registered ofproto classes, in probe order. */
330 static const struct ofproto_class
**ofproto_classes
;
331 static size_t n_ofproto_classes
;
332 static size_t allocated_ofproto_classes
;
334 /* Global lock that protects all flow table operations. */
335 struct ovs_mutex ofproto_mutex
= OVS_MUTEX_INITIALIZER
;
337 unsigned ofproto_flow_limit
= OFPROTO_FLOW_LIMIT_DEFAULT
;
338 unsigned ofproto_max_idle
= OFPROTO_MAX_IDLE_DEFAULT
;
340 size_t n_handlers
, n_revalidators
;
344 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
345 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
347 /* Initial mappings of port to OpenFlow number mappings. */
348 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
350 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
352 /* The default value of true waits for flow restore. */
353 static bool flow_restore_wait
= true;
355 /* Must be called to initialize the ofproto library.
357 * The caller may pass in 'iface_hints', which contains an shash of
358 * "iface_hint" elements indexed by the interface's name. The provider
359 * may use these hints to describe the startup configuration in order to
360 * reinitialize its state. The caller owns the provided data, so a
361 * provider will make copies of anything required. An ofproto provider
362 * will remove any existing state that is not described by the hint, and
363 * may choose to remove it all. */
365 ofproto_init(const struct shash
*iface_hints
)
367 struct shash_node
*node
;
370 ofproto_class_register(&ofproto_dpif_class
);
372 /* Make a local copy, since we don't own 'iface_hints' elements. */
373 SHASH_FOR_EACH(node
, iface_hints
) {
374 const struct iface_hint
*orig_hint
= node
->data
;
375 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
376 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
378 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
379 new_hint
->br_type
= xstrdup(br_type
);
380 new_hint
->ofp_port
= orig_hint
->ofp_port
;
382 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
385 for (i
= 0; i
< n_ofproto_classes
; i
++) {
386 ofproto_classes
[i
]->init(&init_ofp_ports
);
390 /* 'type' should be a normalized datapath type, as returned by
391 * ofproto_normalize_type(). Returns the corresponding ofproto_class
392 * structure, or a null pointer if there is none registered for 'type'. */
393 static const struct ofproto_class
*
394 ofproto_class_find__(const char *type
)
398 for (i
= 0; i
< n_ofproto_classes
; i
++) {
399 const struct ofproto_class
*class = ofproto_classes
[i
];
404 class->enumerate_types(&types
);
405 found
= sset_contains(&types
, type
);
406 sset_destroy(&types
);
412 VLOG_WARN("unknown datapath type %s", type
);
416 /* Registers a new ofproto class. After successful registration, new ofprotos
417 * of that type can be created using ofproto_create(). */
419 ofproto_class_register(const struct ofproto_class
*new_class
)
423 for (i
= 0; i
< n_ofproto_classes
; i
++) {
424 if (ofproto_classes
[i
] == new_class
) {
429 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
430 ofproto_classes
= x2nrealloc(ofproto_classes
,
431 &allocated_ofproto_classes
,
432 sizeof *ofproto_classes
);
434 ofproto_classes
[n_ofproto_classes
++] = new_class
;
438 /* Unregisters a datapath provider. 'type' must have been previously
439 * registered and not currently be in use by any ofprotos. After
440 * unregistration new datapaths of that type cannot be opened using
441 * ofproto_create(). */
443 ofproto_class_unregister(const struct ofproto_class
*class)
447 for (i
= 0; i
< n_ofproto_classes
; i
++) {
448 if (ofproto_classes
[i
] == class) {
449 for (i
++; i
< n_ofproto_classes
; i
++) {
450 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
456 VLOG_WARN("attempted to unregister an ofproto class that is not "
461 /* Clears 'types' and enumerates all registered ofproto types into it. The
462 * caller must first initialize the sset. */
464 ofproto_enumerate_types(struct sset
*types
)
469 for (i
= 0; i
< n_ofproto_classes
; i
++) {
470 ofproto_classes
[i
]->enumerate_types(types
);
474 /* Returns the fully spelled out name for the given ofproto 'type'.
476 * Normalized type string can be compared with strcmp(). Unnormalized type
477 * string might be the same even if they have different spellings. */
479 ofproto_normalize_type(const char *type
)
481 return type
&& type
[0] ? type
: "system";
484 /* Clears 'names' and enumerates the names of all known created ofprotos with
485 * the given 'type'. The caller must first initialize the sset. Returns 0 if
486 * successful, otherwise a positive errno value.
488 * Some kinds of datapaths might not be practically enumerable. This is not
489 * considered an error. */
491 ofproto_enumerate_names(const char *type
, struct sset
*names
)
493 const struct ofproto_class
*class = ofproto_class_find__(type
);
494 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
498 ofproto_bump_tables_version(struct ofproto
*ofproto
)
500 ++ofproto
->tables_version
;
501 ofproto
->ofproto_class
->set_tables_version(ofproto
,
502 ofproto
->tables_version
);
506 ofproto_create(const char *datapath_name
, const char *datapath_type
,
507 struct ofproto
**ofprotop
)
509 const struct ofproto_class
*class;
510 struct ofproto
*ofproto
;
516 ofproto_unixctl_init();
518 datapath_type
= ofproto_normalize_type(datapath_type
);
519 class = ofproto_class_find__(datapath_type
);
521 VLOG_WARN("could not create datapath %s of unknown type %s",
522 datapath_name
, datapath_type
);
526 ofproto
= class->alloc();
528 VLOG_ERR("failed to allocate datapath %s of type %s",
529 datapath_name
, datapath_type
);
534 ovs_mutex_lock(&ofproto_mutex
);
535 memset(ofproto
, 0, sizeof *ofproto
);
536 ofproto
->ofproto_class
= class;
537 ofproto
->name
= xstrdup(datapath_name
);
538 ofproto
->type
= xstrdup(datapath_type
);
539 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
540 hash_string(ofproto
->name
, 0));
541 ofproto
->datapath_id
= 0;
542 ofproto
->forward_bpdu
= false;
543 ofproto
->fallback_dpid
= pick_fallback_dpid();
544 ofproto
->mfr_desc
= NULL
;
545 ofproto
->hw_desc
= NULL
;
546 ofproto
->sw_desc
= NULL
;
547 ofproto
->serial_desc
= NULL
;
548 ofproto
->dp_desc
= NULL
;
549 ofproto
->frag_handling
= OFPC_FRAG_NORMAL
;
550 hmap_init(&ofproto
->ports
);
551 hmap_init(&ofproto
->ofport_usage
);
552 shash_init(&ofproto
->port_by_name
);
553 simap_init(&ofproto
->ofp_requests
);
554 ofproto
->max_ports
= ofp_to_u16(OFPP_MAX
);
555 ofproto
->eviction_group_timer
= LLONG_MIN
;
556 ofproto
->tables
= NULL
;
557 ofproto
->n_tables
= 0;
558 ofproto
->tables_version
= CLS_MIN_VERSION
;
559 hindex_init(&ofproto
->cookies
);
560 hmap_init(&ofproto
->learned_cookies
);
561 list_init(&ofproto
->expirable
);
562 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
563 guarded_list_init(&ofproto
->rule_executes
);
564 ofproto
->vlan_bitmap
= NULL
;
565 ofproto
->vlans_changed
= false;
566 ofproto
->min_mtu
= INT_MAX
;
567 ovs_rwlock_init(&ofproto
->groups_rwlock
);
568 hmap_init(&ofproto
->groups
);
569 ovs_mutex_unlock(&ofproto_mutex
);
570 ofproto
->ogf
.types
= 0xf;
571 ofproto
->ogf
.capabilities
= OFPGFC_CHAINING
| OFPGFC_SELECT_LIVENESS
|
572 OFPGFC_SELECT_WEIGHT
;
573 for (i
= 0; i
< 4; i
++) {
574 ofproto
->ogf
.max_groups
[i
] = OFPG_MAX
;
575 ofproto
->ogf
.ofpacts
[i
] = (UINT64_C(1) << N_OFPACTS
) - 1;
579 error
= ofproto
->ofproto_class
->construct(ofproto
);
581 VLOG_ERR("failed to open datapath %s: %s",
582 datapath_name
, ovs_strerror(error
));
583 connmgr_destroy(ofproto
->connmgr
);
584 ofproto_destroy__(ofproto
);
588 /* Check that hidden tables, if any, are at the end. */
589 ovs_assert(ofproto
->n_tables
);
590 for (i
= 0; i
+ 1 < ofproto
->n_tables
; i
++) {
591 enum oftable_flags flags
= ofproto
->tables
[i
].flags
;
592 enum oftable_flags next_flags
= ofproto
->tables
[i
+ 1].flags
;
594 ovs_assert(!(flags
& OFTABLE_HIDDEN
) || next_flags
& OFTABLE_HIDDEN
);
597 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
600 /* Initialize meters table. */
601 if (ofproto
->ofproto_class
->meter_get_features
) {
602 ofproto
->ofproto_class
->meter_get_features(ofproto
,
603 &ofproto
->meter_features
);
605 memset(&ofproto
->meter_features
, 0, sizeof ofproto
->meter_features
);
607 ofproto
->meters
= xzalloc((ofproto
->meter_features
.max_meters
+ 1)
608 * sizeof(struct meter
*));
610 /* Set the initial tables version. */
611 ofproto_bump_tables_version(ofproto
);
617 /* Must be called (only) by an ofproto implementation in its constructor
618 * function. See the large comment on 'construct' in struct ofproto_class for
621 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
623 struct oftable
*table
;
625 ovs_assert(!ofproto
->n_tables
);
626 ovs_assert(n_tables
>= 1 && n_tables
<= 255);
628 ofproto
->n_tables
= n_tables
;
629 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
630 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
635 /* To be optionally called (only) by an ofproto implementation in its
636 * constructor function. See the large comment on 'construct' in struct
637 * ofproto_class for details.
639 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
640 * will then ensure that actions passed into the ofproto implementation will
641 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
642 * function is not called, there will be no such restriction.
644 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
645 * the 'max_ports' restriction. */
647 ofproto_init_max_ports(struct ofproto
*ofproto
, uint16_t max_ports
)
649 ovs_assert(max_ports
<= ofp_to_u16(OFPP_MAX
));
650 ofproto
->max_ports
= max_ports
;
654 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
656 return ofproto
->datapath_id
;
660 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
662 uint64_t old_dpid
= p
->datapath_id
;
663 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
664 if (p
->datapath_id
!= old_dpid
) {
665 /* Force all active connections to reconnect, since there is no way to
666 * notify a controller that the datapath ID has changed. */
667 ofproto_reconnect_controllers(p
);
672 ofproto_set_controllers(struct ofproto
*p
,
673 const struct ofproto_controller
*controllers
,
674 size_t n_controllers
, uint32_t allowed_versions
)
676 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
,
681 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
683 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
686 /* Drops the connections between 'ofproto' and all of its controllers, forcing
687 * them to reconnect. */
689 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
691 connmgr_reconnect(ofproto
->connmgr
);
694 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
695 * in-band control should guarantee access, in the same way that in-band
696 * control guarantees access to OpenFlow controllers. */
698 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
699 const struct sockaddr_in
*extras
, size_t n
)
701 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
704 /* Sets the OpenFlow queue used by flows set up by in-band control on
705 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
706 * flows will use the default queue. */
708 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
710 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
713 /* Sets the number of flows at which eviction from the kernel flow table
716 ofproto_set_flow_limit(unsigned limit
)
718 ofproto_flow_limit
= limit
;
721 /* Sets the maximum idle time for flows in the datapath before they are
724 ofproto_set_max_idle(unsigned max_idle
)
726 ofproto_max_idle
= max_idle
;
729 /* If forward_bpdu is true, the NORMAL action will forward frames with
730 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
731 * the NORMAL action will drop these frames. */
733 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
735 bool old_val
= ofproto
->forward_bpdu
;
736 ofproto
->forward_bpdu
= forward_bpdu
;
737 if (old_val
!= ofproto
->forward_bpdu
) {
738 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
739 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
744 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
745 * 'idle_time', in seconds, and the maximum number of MAC table entries to
748 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
751 if (ofproto
->ofproto_class
->set_mac_table_config
) {
752 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
757 /* Multicast snooping configuration. */
759 /* Configures multicast snooping on 'ofproto' using the settings
760 * defined in 's'. If 's' is NULL, disables multicast snooping.
762 * Returns 0 if successful, otherwise a positive errno value. */
764 ofproto_set_mcast_snooping(struct ofproto
*ofproto
,
765 const struct ofproto_mcast_snooping_settings
*s
)
767 return (ofproto
->ofproto_class
->set_mcast_snooping
768 ? ofproto
->ofproto_class
->set_mcast_snooping(ofproto
, s
)
772 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
774 * Returns 0 if successful, otherwise a positive errno value.*/
776 ofproto_port_set_mcast_snooping(struct ofproto
*ofproto
, void *aux
,
777 const struct ofproto_mcast_snooping_port_settings
*s
)
779 return (ofproto
->ofproto_class
->set_mcast_snooping_port
780 ? ofproto
->ofproto_class
->set_mcast_snooping_port(ofproto
, aux
, s
)
785 ofproto_set_n_dpdk_rxqs(int n_rxqs
)
787 n_dpdk_rxqs
= MAX(n_rxqs
, 0);
791 ofproto_set_cpu_mask(const char *cmask
)
795 pmd_cpu_mask
= cmask
? xstrdup(cmask
) : NULL
;
799 ofproto_set_threads(int n_handlers_
, int n_revalidators_
)
801 int threads
= MAX(count_cpu_cores(), 2);
803 n_revalidators
= MAX(n_revalidators_
, 0);
804 n_handlers
= MAX(n_handlers_
, 0);
806 if (!n_revalidators
) {
807 n_revalidators
= n_handlers
808 ? MAX(threads
- (int) n_handlers
, 1)
813 n_handlers
= MAX(threads
- (int) n_revalidators
, 1);
818 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
821 p
->dp_desc
= dp_desc
? xstrdup(dp_desc
) : NULL
;
825 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
827 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
831 ofproto_set_netflow(struct ofproto
*ofproto
,
832 const struct netflow_options
*nf_options
)
834 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
838 if (ofproto
->ofproto_class
->set_netflow
) {
839 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
841 return nf_options
? EOPNOTSUPP
: 0;
846 ofproto_set_sflow(struct ofproto
*ofproto
,
847 const struct ofproto_sflow_options
*oso
)
849 if (oso
&& sset_is_empty(&oso
->targets
)) {
853 if (ofproto
->ofproto_class
->set_sflow
) {
854 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
856 return oso
? EOPNOTSUPP
: 0;
861 ofproto_set_ipfix(struct ofproto
*ofproto
,
862 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
863 const struct ofproto_ipfix_flow_exporter_options
*fo
,
866 if (ofproto
->ofproto_class
->set_ipfix
) {
867 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
869 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
874 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
876 flow_restore_wait
= flow_restore_wait_db
;
880 ofproto_get_flow_restore_wait(void)
882 return flow_restore_wait
;
886 /* Spanning Tree Protocol (STP) configuration. */
888 /* Configures STP on 'ofproto' using the settings defined in 's'. If
889 * 's' is NULL, disables STP.
891 * Returns 0 if successful, otherwise a positive errno value. */
893 ofproto_set_stp(struct ofproto
*ofproto
,
894 const struct ofproto_stp_settings
*s
)
896 return (ofproto
->ofproto_class
->set_stp
897 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
901 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
902 * 'enabled' member of 's' is false, then the other members are not
905 * Returns 0 if successful, otherwise a positive errno value. */
907 ofproto_get_stp_status(struct ofproto
*ofproto
,
908 struct ofproto_stp_status
*s
)
910 return (ofproto
->ofproto_class
->get_stp_status
911 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
915 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
916 * in 's'. The caller is responsible for assigning STP port numbers
917 * (using the 'port_num' member in the range of 1 through 255, inclusive)
918 * and ensuring there are no duplicates. If the 's' is NULL, then STP
919 * is disabled on the port.
921 * Returns 0 if successful, otherwise a positive errno value.*/
923 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
924 const struct ofproto_port_stp_settings
*s
)
926 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
928 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
929 ofproto
->name
, ofp_port
);
933 return (ofproto
->ofproto_class
->set_stp_port
934 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
938 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
939 * 's'. If the 'enabled' member in 's' is false, then the other members
940 * are not meaningful.
942 * Returns 0 if successful, otherwise a positive errno value.*/
944 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
945 struct ofproto_port_stp_status
*s
)
947 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
949 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
950 "port %"PRIu16
, ofproto
->name
, ofp_port
);
954 return (ofproto
->ofproto_class
->get_stp_port_status
955 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
959 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
960 * 's'. If the 'enabled' member in 's' is false, then the other members
961 * are not meaningful.
963 * Returns 0 if successful, otherwise a positive errno value.*/
965 ofproto_port_get_stp_stats(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
966 struct ofproto_port_stp_stats
*s
)
968 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
970 VLOG_WARN_RL(&rl
, "%s: cannot get STP stats on nonexistent "
971 "port %"PRIu16
, ofproto
->name
, ofp_port
);
975 return (ofproto
->ofproto_class
->get_stp_port_stats
976 ? ofproto
->ofproto_class
->get_stp_port_stats(ofport
, s
)
980 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
982 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
983 * 's' is NULL, disables RSTP.
985 * Returns 0 if successful, otherwise a positive errno value. */
987 ofproto_set_rstp(struct ofproto
*ofproto
,
988 const struct ofproto_rstp_settings
*s
)
990 if (!ofproto
->ofproto_class
->set_rstp
) {
993 ofproto
->ofproto_class
->set_rstp(ofproto
, s
);
997 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
998 * 'enabled' member of 's' is false, then the other members are not
1001 * Returns 0 if successful, otherwise a positive errno value. */
1003 ofproto_get_rstp_status(struct ofproto
*ofproto
,
1004 struct ofproto_rstp_status
*s
)
1006 if (!ofproto
->ofproto_class
->get_rstp_status
) {
1009 ofproto
->ofproto_class
->get_rstp_status(ofproto
, s
);
1013 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1014 * in 's'. The caller is responsible for assigning RSTP port numbers
1015 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1016 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1017 * is disabled on the port.
1019 * Returns 0 if successful, otherwise a positive errno value.*/
1021 ofproto_port_set_rstp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1022 const struct ofproto_port_rstp_settings
*s
)
1024 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1026 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16
,
1027 ofproto
->name
, ofp_port
);
1031 if (!ofproto
->ofproto_class
->set_rstp_port
) {
1034 ofproto
->ofproto_class
->set_rstp_port(ofport
, s
);
1038 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1039 * 's'. If the 'enabled' member in 's' is false, then the other members
1040 * are not meaningful.
1042 * Returns 0 if successful, otherwise a positive errno value.*/
1044 ofproto_port_get_rstp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1045 struct ofproto_port_rstp_status
*s
)
1047 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1049 VLOG_WARN_RL(&rl
, "%s: cannot get RSTP status on nonexistent "
1050 "port %"PRIu16
, ofproto
->name
, ofp_port
);
1054 if (!ofproto
->ofproto_class
->get_rstp_port_status
) {
1057 ofproto
->ofproto_class
->get_rstp_port_status(ofport
, s
);
1061 /* Queue DSCP configuration. */
1063 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1064 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1065 * to implement QoS. Instead, it is used to implement features which require
1066 * knowledge of what queues exist on a port, and some basic information about
1069 * Returns 0 if successful, otherwise a positive errno value. */
1071 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1072 const struct ofproto_port_queue
*queues
,
1075 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1078 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
1079 ofproto
->name
, ofp_port
);
1083 return (ofproto
->ofproto_class
->set_queues
1084 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
1088 /* LLDP configuration. */
1090 ofproto_port_set_lldp(struct ofproto
*ofproto
,
1091 ofp_port_t ofp_port
,
1092 const struct smap
*cfg
)
1094 struct ofport
*ofport
;
1097 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1099 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16
,
1100 ofproto
->name
, ofp_port
);
1103 error
= (ofproto
->ofproto_class
->set_lldp
1104 ? ofproto
->ofproto_class
->set_lldp(ofport
, cfg
)
1107 VLOG_WARN("%s: lldp configuration on port %"PRIu16
" (%s) failed (%s)",
1108 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1109 ovs_strerror(error
));
1114 ofproto_set_aa(struct ofproto
*ofproto
, void *aux OVS_UNUSED
,
1115 const struct aa_settings
*s
)
1117 if (!ofproto
->ofproto_class
->set_aa
) {
1120 ofproto
->ofproto_class
->set_aa(ofproto
, s
);
1125 ofproto_aa_mapping_register(struct ofproto
*ofproto
, void *aux
,
1126 const struct aa_mapping_settings
*s
)
1128 if (!ofproto
->ofproto_class
->aa_mapping_set
) {
1131 ofproto
->ofproto_class
->aa_mapping_set(ofproto
, aux
, s
);
1136 ofproto_aa_mapping_unregister(struct ofproto
*ofproto
, void *aux
)
1138 if (!ofproto
->ofproto_class
->aa_mapping_unset
) {
1141 ofproto
->ofproto_class
->aa_mapping_unset(ofproto
, aux
);
1146 ofproto_aa_vlan_get_queued(struct ofproto
*ofproto
,
1147 struct ovs_list
*list
)
1149 if (!ofproto
->ofproto_class
->aa_vlan_get_queued
) {
1152 ofproto
->ofproto_class
->aa_vlan_get_queued(ofproto
, list
);
1157 ofproto_aa_vlan_get_queue_size(struct ofproto
*ofproto
)
1159 if (!ofproto
->ofproto_class
->aa_vlan_get_queue_size
) {
1162 return ofproto
->ofproto_class
->aa_vlan_get_queue_size(ofproto
);
1165 /* Connectivity Fault Management configuration. */
1167 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1169 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1171 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1172 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
1173 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
1177 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1178 * basic configuration from the configuration members in 'cfm', and the remote
1179 * maintenance point ID from remote_mpid. Ignores the statistics members of
1182 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1184 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1185 const struct cfm_settings
*s
)
1187 struct ofport
*ofport
;
1190 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1192 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
1193 ofproto
->name
, ofp_port
);
1197 /* XXX: For configuration simplicity, we only support one remote_mpid
1198 * outside of the CFM module. It's not clear if this is the correct long
1199 * term solution or not. */
1200 error
= (ofproto
->ofproto_class
->set_cfm
1201 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
1204 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
1205 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1206 ovs_strerror(error
));
1210 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1211 * 'ofproto' does not have a port 'ofp_port'. */
1213 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1214 const struct smap
*cfg
)
1216 struct ofport
*ofport
;
1219 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1221 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16
,
1222 ofproto
->name
, ofp_port
);
1226 error
= (ofproto
->ofproto_class
->set_bfd
1227 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
1230 VLOG_WARN("%s: bfd configuration on port %"PRIu16
" (%s) failed (%s)",
1231 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1232 ovs_strerror(error
));
1236 /* Checks the status change of BFD on 'ofport'.
1238 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1240 ofproto_port_bfd_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1242 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1243 return (ofport
&& ofproto
->ofproto_class
->bfd_status_changed
1244 ? ofproto
->ofproto_class
->bfd_status_changed(ofport
)
1248 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1249 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1250 * is not an OpenFlow port in 'ofproto'.
1252 * The caller must provide and own '*status'. */
1254 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1255 struct smap
*status
)
1257 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1258 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
1259 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
1263 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1264 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1265 * 0 if LACP partner information is not current (generally indicating a
1266 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1268 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1270 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1271 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
1272 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
1277 ofproto_port_get_lacp_stats(const struct ofport
*port
, struct lacp_slave_stats
*stats
)
1279 struct ofproto
*ofproto
= port
->ofproto
;
1282 if (ofproto
->ofproto_class
->port_get_lacp_stats
) {
1283 error
= ofproto
->ofproto_class
->port_get_lacp_stats(port
, stats
);
1293 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1294 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1295 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1296 * configuration plus, if there is more than one slave, a bonding
1299 * If 'aux' is already registered then this function updates its configuration
1300 * to 's'. Otherwise, this function registers a new bundle.
1302 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1305 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
1306 const struct ofproto_bundle_settings
*s
)
1308 return (ofproto
->ofproto_class
->bundle_set
1309 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
1313 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1314 * If no such bundle has been registered, this has no effect. */
1316 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
1318 return ofproto_bundle_register(ofproto
, aux
, NULL
);
1322 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1323 * If 'aux' is already registered then this function updates its configuration
1324 * to 's'. Otherwise, this function registers a new mirror. */
1326 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
1327 const struct ofproto_mirror_settings
*s
)
1329 return (ofproto
->ofproto_class
->mirror_set
1330 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
1334 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1335 * If no mirror has been registered, this has no effect. */
1337 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
1339 return ofproto_mirror_register(ofproto
, aux
, NULL
);
1342 /* Retrieves statistics from mirror associated with client data pointer
1343 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1344 * 'bytes', respectively. If a particular counters is not supported,
1345 * the appropriate argument is set to UINT64_MAX.
1348 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
1349 uint64_t *packets
, uint64_t *bytes
)
1351 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
1352 *packets
= *bytes
= UINT64_MAX
;
1356 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
1360 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1361 * which all packets are flooded, instead of using MAC learning. If
1362 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1364 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1367 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
1369 return (ofproto
->ofproto_class
->set_flood_vlans
1370 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
1374 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1375 * output for a mirror. */
1377 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
1379 return (ofproto
->ofproto_class
->is_mirror_output_bundle
1380 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
1384 /* Configuration of OpenFlow tables. */
1386 /* Returns the number of OpenFlow tables in 'ofproto'. */
1388 ofproto_get_n_tables(const struct ofproto
*ofproto
)
1390 return ofproto
->n_tables
;
1393 /* Returns the number of Controller visible OpenFlow tables
1394 * in 'ofproto'. This number will exclude Hidden tables.
1395 * This funtion's return value should be less or equal to that of
1396 * ofproto_get_n_tables() . */
1398 ofproto_get_n_visible_tables(const struct ofproto
*ofproto
)
1400 uint8_t n
= ofproto
->n_tables
;
1402 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1403 * if present, are always at the end.) */
1404 while(n
&& (ofproto
->tables
[n
- 1].flags
& OFTABLE_HIDDEN
)) {
1411 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1412 * settings from 's'. 'table_id' must be in the range 0 through the number of
1413 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1415 * For read-only tables, only the name may be configured. */
1417 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
1418 const struct ofproto_table_settings
*s
)
1420 struct oftable
*table
;
1422 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
1423 table
= &ofproto
->tables
[table_id
];
1425 oftable_set_name(table
, s
->name
);
1427 if (table
->flags
& OFTABLE_READONLY
) {
1431 if (classifier_set_prefix_fields(&table
->cls
,
1432 s
->prefix_fields
, s
->n_prefix_fields
)) {
1433 /* XXX: Trigger revalidation. */
1436 ovs_mutex_lock(&ofproto_mutex
);
1437 unsigned int new_eviction
= (s
->enable_eviction
1438 ? table
->eviction
| EVICTION_CLIENT
1439 : table
->eviction
& ~EVICTION_CLIENT
);
1440 oftable_configure_eviction(table
, new_eviction
, s
->groups
, s
->n_groups
);
1441 table
->max_flows
= s
->max_flows
;
1442 evict_rules_from_table(table
);
1443 ovs_mutex_unlock(&ofproto_mutex
);
1447 ofproto_has_snoops(const struct ofproto
*ofproto
)
1449 return connmgr_has_snoops(ofproto
->connmgr
);
1453 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1455 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1458 /* Deletes 'rule' from 'ofproto'.
1460 * Within an ofproto implementation, this function allows an ofproto
1461 * implementation to destroy any rules that remain when its ->destruct()
1462 * function is called. This function is not suitable for use elsewhere in an
1463 * ofproto implementation.
1465 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1466 * Cycle" in ofproto-provider.h. */
1468 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1469 OVS_EXCLUDED(ofproto_mutex
)
1471 /* This skips the ofmonitor and flow-removed notifications because the
1472 * switch is being deleted and any OpenFlow channels have been or soon will
1474 ovs_mutex_lock(&ofproto_mutex
);
1476 if (!rule
->removed
) {
1477 /* Make sure there is no postponed removal of the rule. */
1478 ovs_assert(cls_rule_visible_in_version(&rule
->cr
, CLS_MAX_VERSION
));
1480 if (!classifier_remove(&rule
->ofproto
->tables
[rule
->table_id
].cls
,
1484 ofproto_rule_remove__(rule
->ofproto
, rule
);
1485 ofproto
->ofproto_class
->rule_delete(rule
);
1486 ofproto_rule_unref(rule
);
1488 ovs_mutex_unlock(&ofproto_mutex
);
1492 ofproto_flush__(struct ofproto
*ofproto
)
1493 OVS_EXCLUDED(ofproto_mutex
)
1495 struct oftable
*table
;
1497 /* This will flush all datapath flows. */
1498 if (ofproto
->ofproto_class
->flush
) {
1499 ofproto
->ofproto_class
->flush(ofproto
);
1502 /* XXX: There is a small race window here, where new datapath flows can be
1503 * created by upcall handlers based on the existing flow table. We can not
1504 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1505 * as then we could deadlock on syncing with the handler threads waiting on
1506 * the same mutex. */
1508 ovs_mutex_lock(&ofproto_mutex
);
1509 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1510 struct rule_collection rules
;
1513 if (table
->flags
& OFTABLE_HIDDEN
) {
1517 rule_collection_init(&rules
);
1519 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1520 rule_collection_add(&rules
, rule
);
1522 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
1524 /* XXX: Concurrent handler threads may insert new learned flows based on
1525 * learn actions of the now deleted flows right after we release
1526 * 'ofproto_mutex'. */
1527 ovs_mutex_unlock(&ofproto_mutex
);
1530 static void delete_group(struct ofproto
*ofproto
, uint32_t group_id
);
1533 ofproto_destroy__(struct ofproto
*ofproto
)
1534 OVS_EXCLUDED(ofproto_mutex
)
1536 struct oftable
*table
;
1538 destroy_rule_executes(ofproto
);
1540 guarded_list_destroy(&ofproto
->rule_executes
);
1541 ovs_rwlock_destroy(&ofproto
->groups_rwlock
);
1542 hmap_destroy(&ofproto
->groups
);
1544 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1545 free(ofproto
->name
);
1546 free(ofproto
->type
);
1547 free(ofproto
->mfr_desc
);
1548 free(ofproto
->hw_desc
);
1549 free(ofproto
->sw_desc
);
1550 free(ofproto
->serial_desc
);
1551 free(ofproto
->dp_desc
);
1552 hmap_destroy(&ofproto
->ports
);
1553 hmap_destroy(&ofproto
->ofport_usage
);
1554 shash_destroy(&ofproto
->port_by_name
);
1555 simap_destroy(&ofproto
->ofp_requests
);
1557 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1558 oftable_destroy(table
);
1560 free(ofproto
->tables
);
1562 ovs_assert(hindex_is_empty(&ofproto
->cookies
));
1563 hindex_destroy(&ofproto
->cookies
);
1565 ovs_assert(hmap_is_empty(&ofproto
->learned_cookies
));
1566 hmap_destroy(&ofproto
->learned_cookies
);
1568 free(ofproto
->vlan_bitmap
);
1570 ofproto
->ofproto_class
->dealloc(ofproto
);
1573 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1574 * - 1st we defer the removal of the rules from the classifier
1575 * - 2nd we defer the actual destruction of the rules. */
1577 ofproto_destroy_defer__(struct ofproto
*ofproto
)
1578 OVS_EXCLUDED(ofproto_mutex
)
1580 ovsrcu_postpone(ofproto_destroy__
, ofproto
);
1584 ofproto_destroy(struct ofproto
*p
)
1585 OVS_EXCLUDED(ofproto_mutex
)
1587 struct ofport
*ofport
, *next_ofport
;
1588 struct ofport_usage
*usage
, *next_usage
;
1595 meter_delete(p
, 1, p
->meter_features
.max_meters
);
1596 p
->meter_features
.max_meters
= 0;
1602 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1603 ofport_destroy(ofport
);
1606 HMAP_FOR_EACH_SAFE (usage
, next_usage
, hmap_node
, &p
->ofport_usage
) {
1607 hmap_remove(&p
->ofport_usage
, &usage
->hmap_node
);
1611 p
->ofproto_class
->destruct(p
);
1613 /* We should not postpone this because it involves deleting a listening
1614 * socket which we may want to reopen soon. 'connmgr' should not be used
1615 * by other threads */
1616 connmgr_destroy(p
->connmgr
);
1618 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1619 ovsrcu_postpone(ofproto_destroy_defer__
, p
);
1622 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1623 * kernel datapath, for example, this destroys the datapath in the kernel, and
1624 * with the netdev-based datapath, it tears down the data structures that
1625 * represent the datapath.
1627 * The datapath should not be currently open as an ofproto. */
1629 ofproto_delete(const char *name
, const char *type
)
1631 const struct ofproto_class
*class = ofproto_class_find__(type
);
1632 return (!class ? EAFNOSUPPORT
1633 : !class->del
? EACCES
1634 : class->del(type
, name
));
1638 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1640 if (error
== ENOBUFS
) {
1641 reinit_ports(ofproto
);
1642 } else if (!error
) {
1643 update_port(ofproto
, devname
);
1649 ofproto_type_run(const char *datapath_type
)
1651 const struct ofproto_class
*class;
1654 datapath_type
= ofproto_normalize_type(datapath_type
);
1655 class = ofproto_class_find__(datapath_type
);
1657 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1658 if (error
&& error
!= EAGAIN
) {
1659 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1660 datapath_type
, ovs_strerror(error
));
1666 ofproto_type_wait(const char *datapath_type
)
1668 const struct ofproto_class
*class;
1670 datapath_type
= ofproto_normalize_type(datapath_type
);
1671 class = ofproto_class_find__(datapath_type
);
1673 if (class->type_wait
) {
1674 class->type_wait(datapath_type
);
1679 ofproto_run(struct ofproto
*p
)
1684 error
= p
->ofproto_class
->run(p
);
1685 if (error
&& error
!= EAGAIN
) {
1686 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, ovs_strerror(error
));
1689 run_rule_executes(p
);
1691 /* Restore the eviction group heap invariant occasionally. */
1692 if (p
->eviction_group_timer
< time_msec()) {
1695 p
->eviction_group_timer
= time_msec() + 1000;
1697 for (i
= 0; i
< p
->n_tables
; i
++) {
1698 struct oftable
*table
= &p
->tables
[i
];
1699 struct eviction_group
*evg
;
1702 if (!table
->eviction
) {
1706 if (table
->n_flows
> 100000) {
1707 static struct vlog_rate_limit count_rl
=
1708 VLOG_RATE_LIMIT_INIT(1, 1);
1709 VLOG_WARN_RL(&count_rl
, "Table %"PRIuSIZE
" has an excessive"
1710 " number of rules: %d", i
, table
->n_flows
);
1713 ovs_mutex_lock(&ofproto_mutex
);
1714 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1715 if (rule
->idle_timeout
|| rule
->hard_timeout
) {
1716 if (!rule
->eviction_group
) {
1717 eviction_group_add_rule(rule
);
1719 heap_raw_change(&rule
->evg_node
,
1720 rule_eviction_priority(p
, rule
));
1725 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1726 heap_rebuild(&evg
->rules
);
1728 ovs_mutex_unlock(&ofproto_mutex
);
1732 if (p
->ofproto_class
->port_poll
) {
1735 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1736 process_port_change(p
, error
, devname
);
1740 new_seq
= seq_read(connectivity_seq_get());
1741 if (new_seq
!= p
->change_seq
) {
1742 struct sset devnames
;
1743 const char *devname
;
1744 struct ofport
*ofport
;
1746 /* Update OpenFlow port status for any port whose netdev has changed.
1748 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1749 * destroyed, so it's not safe to update ports directly from the
1750 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1751 * need this two-phase approach. */
1752 sset_init(&devnames
);
1753 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1754 uint64_t port_change_seq
;
1756 port_change_seq
= netdev_get_change_seq(ofport
->netdev
);
1757 if (ofport
->change_seq
!= port_change_seq
) {
1758 ofport
->change_seq
= port_change_seq
;
1759 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1762 SSET_FOR_EACH (devname
, &devnames
) {
1763 update_port(p
, devname
);
1765 sset_destroy(&devnames
);
1767 p
->change_seq
= new_seq
;
1770 connmgr_run(p
->connmgr
, handle_openflow
);
1776 ofproto_wait(struct ofproto
*p
)
1778 p
->ofproto_class
->wait(p
);
1779 if (p
->ofproto_class
->port_poll_wait
) {
1780 p
->ofproto_class
->port_poll_wait(p
);
1782 seq_wait(connectivity_seq_get(), p
->change_seq
);
1783 connmgr_wait(p
->connmgr
);
1787 ofproto_is_alive(const struct ofproto
*p
)
1789 return connmgr_has_controllers(p
->connmgr
);
1792 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1793 * memory_report(). */
1795 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1797 const struct oftable
*table
;
1798 unsigned int n_rules
;
1800 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1803 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1804 n_rules
+= table
->n_flows
;
1806 simap_increase(usage
, "rules", n_rules
);
1808 if (ofproto
->ofproto_class
->get_memory_usage
) {
1809 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1812 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1816 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1818 const struct ofproto_class
*class;
1820 datapath_type
= ofproto_normalize_type(datapath_type
);
1821 class = ofproto_class_find__(datapath_type
);
1823 if (class && class->type_get_memory_usage
) {
1824 class->type_get_memory_usage(datapath_type
, usage
);
1829 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1832 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1836 ofproto_free_ofproto_controller_info(struct shash
*info
)
1838 connmgr_free_controller_info(info
);
1841 /* Makes a deep copy of 'old' into 'port'. */
1843 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1845 port
->name
= xstrdup(old
->name
);
1846 port
->type
= xstrdup(old
->type
);
1847 port
->ofp_port
= old
->ofp_port
;
1850 /* Frees memory allocated to members of 'ofproto_port'.
1852 * Do not call this function on an ofproto_port obtained from
1853 * ofproto_port_dump_next(): that function retains ownership of the data in the
1856 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1858 free(ofproto_port
->name
);
1859 free(ofproto_port
->type
);
1862 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1864 * This function provides no status indication. An error status for the entire
1865 * dump operation is provided when it is completed by calling
1866 * ofproto_port_dump_done().
1869 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1870 const struct ofproto
*ofproto
)
1872 dump
->ofproto
= ofproto
;
1873 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1877 /* Attempts to retrieve another port from 'dump', which must have been created
1878 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1879 * 'port' and returns true. On failure, returns false.
1881 * Failure might indicate an actual error or merely that the last port has been
1882 * dumped. An error status for the entire dump operation is provided when it
1883 * is completed by calling ofproto_port_dump_done().
1885 * The ofproto owns the data stored in 'port'. It will remain valid until at
1886 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1887 * ofproto_port_dump_done(). */
1889 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1890 struct ofproto_port
*port
)
1892 const struct ofproto
*ofproto
= dump
->ofproto
;
1898 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1901 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1907 /* Completes port table dump operation 'dump', which must have been created
1908 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1909 * error-free, otherwise a positive errno value describing the problem. */
1911 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1913 const struct ofproto
*ofproto
= dump
->ofproto
;
1915 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1918 return dump
->error
== EOF
? 0 : dump
->error
;
1921 /* Returns the type to pass to netdev_open() when a datapath of type
1922 * 'datapath_type' has a port of type 'port_type', for a few special
1923 * cases when a netdev type differs from a port type. For example, when
1924 * using the userspace datapath, a port of type "internal" needs to be
1927 * Returns either 'type' itself or a string literal, which must not be
1930 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1932 const struct ofproto_class
*class;
1934 datapath_type
= ofproto_normalize_type(datapath_type
);
1935 class = ofproto_class_find__(datapath_type
);
1940 return (class->port_open_type
1941 ? class->port_open_type(datapath_type
, port_type
)
1945 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1946 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1947 * the port's OpenFlow port number.
1949 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1950 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1951 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1952 * 'ofp_portp' is non-null). */
1954 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1955 ofp_port_t
*ofp_portp
)
1957 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1960 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1962 const char *netdev_name
= netdev_get_name(netdev
);
1964 simap_put(&ofproto
->ofp_requests
, netdev_name
,
1965 ofp_to_u16(ofp_port
));
1966 update_port(ofproto
, netdev_name
);
1969 *ofp_portp
= OFPP_NONE
;
1971 struct ofproto_port ofproto_port
;
1973 error
= ofproto_port_query_by_name(ofproto
,
1974 netdev_get_name(netdev
),
1977 *ofp_portp
= ofproto_port
.ofp_port
;
1978 ofproto_port_destroy(&ofproto_port
);
1985 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1986 * initializes '*port' appropriately; on failure, returns a positive errno
1989 * The caller owns the data in 'ofproto_port' and must free it with
1990 * ofproto_port_destroy() when it is no longer needed. */
1992 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1993 struct ofproto_port
*port
)
1997 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1999 memset(port
, 0, sizeof *port
);
2004 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
2005 * Returns 0 if successful, otherwise a positive errno. */
2007 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2009 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2010 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
2011 struct simap_node
*ofp_request_node
;
2014 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
2015 if (ofp_request_node
) {
2016 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
2019 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
2020 if (!error
&& ofport
) {
2021 /* 'name' is the netdev's name and update_port() is going to close the
2022 * netdev. Just in case update_port() refers to 'name' after it
2023 * destroys 'ofport', make a copy of it around the update_port()
2025 char *devname
= xstrdup(name
);
2026 update_port(ofproto
, devname
);
2033 flow_mod_init(struct ofputil_flow_mod
*fm
,
2034 const struct match
*match
, int priority
,
2035 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
2036 enum ofp_flow_mod_command command
)
2038 memset(fm
, 0, sizeof *fm
);
2040 fm
->priority
= priority
;
2043 fm
->modify_cookie
= false;
2045 fm
->command
= command
;
2046 fm
->idle_timeout
= 0;
2047 fm
->hard_timeout
= 0;
2049 fm
->buffer_id
= UINT32_MAX
;
2050 fm
->out_port
= OFPP_ANY
;
2051 fm
->out_group
= OFPG_ANY
;
2053 fm
->ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
);
2054 fm
->ofpacts_len
= ofpacts_len
;
2055 fm
->delete_reason
= OFPRR_DELETE
;
2059 simple_flow_mod(struct ofproto
*ofproto
,
2060 const struct match
*match
, int priority
,
2061 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
2062 enum ofp_flow_mod_command command
)
2064 struct ofputil_flow_mod fm
;
2066 flow_mod_init(&fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
2068 return handle_flow_mod__(ofproto
, &fm
, NULL
);
2071 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2072 * performs the 'n_actions' actions in 'actions'. The new flow will not
2075 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2076 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2077 * controllers; otherwise, it will be hidden.
2079 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2081 * This is a helper function for in-band control and fail-open. */
2083 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
2085 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2086 OVS_EXCLUDED(ofproto_mutex
)
2088 const struct rule
*rule
;
2091 /* First do a cheap check whether the rule we're looking for already exists
2092 * with the actions that we want. If it does, then we're done. */
2093 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2094 &ofproto
->tables
[0].cls
, match
, priority
,
2097 const struct rule_actions
*actions
= rule_get_actions(rule
);
2098 must_add
= !ofpacts_equal(actions
->ofpacts
, actions
->ofpacts_len
,
2099 ofpacts
, ofpacts_len
);
2104 /* If there's no such rule or the rule doesn't have the actions we want,
2105 * fall back to a executing a full flow mod. We can't optimize this at
2106 * all because we didn't take enough locks above to ensure that the flow
2107 * table didn't already change beneath us. */
2109 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
2110 OFPFC_MODIFY_STRICT
);
2114 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2115 * an OFPERR_* OpenFlow error code on failure.
2117 * This is a helper function for in-band control and fail-open and the "learn"
2120 ofproto_flow_mod(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
)
2121 OVS_EXCLUDED(ofproto_mutex
)
2123 /* Optimize for the most common case of a repeated learn action.
2124 * If an identical flow already exists we only need to update its
2125 * 'modified' time. */
2126 if (fm
->command
== OFPFC_MODIFY_STRICT
&& fm
->table_id
!= OFPTT_ALL
2127 && !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
)) {
2128 struct oftable
*table
= &ofproto
->tables
[fm
->table_id
];
2132 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2133 &table
->cls
, &fm
->match
, fm
->priority
,
2136 /* Reading many of the rule fields and writing on 'modified'
2137 * requires the rule->mutex. Also, rule->actions may change
2138 * if rule->mutex is not held. */
2139 const struct rule_actions
*actions
;
2141 ovs_mutex_lock(&rule
->mutex
);
2142 actions
= rule_get_actions(rule
);
2143 if (rule
->idle_timeout
== fm
->idle_timeout
2144 && rule
->hard_timeout
== fm
->hard_timeout
2145 && rule
->importance
== fm
->importance
2146 && rule
->flags
== (fm
->flags
& OFPUTIL_FF_STATE
)
2147 && (!fm
->modify_cookie
|| (fm
->new_cookie
== rule
->flow_cookie
))
2148 && ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
2149 actions
->ofpacts
, actions
->ofpacts_len
)) {
2150 /* Rule already exists and need not change, only update the
2151 modified timestamp. */
2152 rule
->modified
= time_msec();
2155 ovs_mutex_unlock(&rule
->mutex
);
2163 return handle_flow_mod__(ofproto
, fm
, NULL
);
2166 /* Searches for a rule with matching criteria exactly equal to 'target' in
2167 * ofproto's table 0 and, if it finds one, deletes it.
2169 * This is a helper function for in-band control and fail-open. */
2171 ofproto_delete_flow(struct ofproto
*ofproto
,
2172 const struct match
*target
, int priority
)
2173 OVS_EXCLUDED(ofproto_mutex
)
2175 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
2178 /* First do a cheap check whether the rule we're looking for has already
2179 * been deleted. If so, then we're done. */
2180 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2181 cls
, target
, priority
, CLS_MAX_VERSION
));
2186 /* Execute a flow mod. We can't optimize this at all because we didn't
2187 * take enough locks above to ensure that the flow table didn't already
2188 * change beneath us. */
2189 simple_flow_mod(ofproto
, target
, priority
, NULL
, 0, OFPFC_DELETE_STRICT
);
2192 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2193 * the flows required by in-band control and fail-open. */
2195 ofproto_flush_flows(struct ofproto
*ofproto
)
2197 COVERAGE_INC(ofproto_flush
);
2198 ofproto_flush__(ofproto
);
2199 connmgr_flushed(ofproto
->connmgr
);
2203 reinit_ports(struct ofproto
*p
)
2205 struct ofproto_port_dump dump
;
2206 struct sset devnames
;
2207 struct ofport
*ofport
;
2208 struct ofproto_port ofproto_port
;
2209 const char *devname
;
2211 COVERAGE_INC(ofproto_reinit_ports
);
2213 sset_init(&devnames
);
2214 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2215 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
2217 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2218 sset_add(&devnames
, ofproto_port
.name
);
2221 SSET_FOR_EACH (devname
, &devnames
) {
2222 update_port(p
, devname
);
2224 sset_destroy(&devnames
);
2228 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2232 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2233 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2235 if (port_idx
>= ofproto
->max_ports
2236 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2237 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2238 long long int last_used_at
, lru
= LLONG_MAX
;
2240 /* Search for a free OpenFlow port number. We try not to
2241 * immediately reuse them to prevent problems due to old
2244 * We limit the automatically assigned port numbers to the lower half
2245 * of the port range, to reserve the upper half for assignment by
2248 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2249 ofproto
->alloc_port_no
= 1;
2251 last_used_at
= ofport_get_usage(ofproto
,
2252 u16_to_ofp(ofproto
->alloc_port_no
));
2253 if (!last_used_at
) {
2254 port_idx
= ofproto
->alloc_port_no
;
2256 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2257 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2258 * more than an hour ago, consider it usable. */
2259 ofport_remove_usage(ofproto
,
2260 u16_to_ofp(ofproto
->alloc_port_no
));
2261 port_idx
= ofproto
->alloc_port_no
;
2263 } else if (last_used_at
< lru
) {
2265 lru_ofport
= ofproto
->alloc_port_no
;
2268 if (ofproto
->alloc_port_no
== end_port_no
) {
2270 port_idx
= lru_ofport
;
2277 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2278 return u16_to_ofp(port_idx
);
2282 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2284 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2285 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2289 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2290 * pointer if the netdev cannot be opened. On success, also fills in
2292 static struct netdev
*
2293 ofport_open(struct ofproto
*ofproto
,
2294 struct ofproto_port
*ofproto_port
,
2295 struct ofputil_phy_port
*pp
)
2297 enum netdev_flags flags
;
2298 struct netdev
*netdev
;
2301 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2303 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
2304 "cannot be opened (%s)",
2306 ofproto_port
->name
, ofproto_port
->ofp_port
,
2307 ofproto_port
->name
, ovs_strerror(error
));
2311 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2312 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2313 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2315 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2316 ofproto_port
->name
);
2319 pp
->port_no
= ofproto_port
->ofp_port
;
2320 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
2321 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2322 netdev_get_flags(netdev
, &flags
);
2323 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2324 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2325 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2326 &pp
->supported
, &pp
->peer
);
2327 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2328 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2333 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2334 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2337 ofport_equal(const struct ofputil_phy_port
*a
,
2338 const struct ofputil_phy_port
*b
)
2340 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2341 && a
->state
== b
->state
2342 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2343 && a
->curr
== b
->curr
2344 && a
->advertised
== b
->advertised
2345 && a
->supported
== b
->supported
2346 && a
->peer
== b
->peer
2347 && a
->curr_speed
== b
->curr_speed
2348 && a
->max_speed
== b
->max_speed
);
2351 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2352 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2353 * one with the same name or port number). */
2355 ofport_install(struct ofproto
*p
,
2356 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2358 const char *netdev_name
= netdev_get_name(netdev
);
2359 struct ofport
*ofport
;
2362 /* Create ofport. */
2363 ofport
= p
->ofproto_class
->port_alloc();
2368 ofport
->ofproto
= p
;
2369 ofport
->netdev
= netdev
;
2370 ofport
->change_seq
= netdev_get_change_seq(netdev
);
2372 ofport
->ofp_port
= pp
->port_no
;
2373 ofport
->created
= time_msec();
2375 /* Add port to 'p'. */
2376 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2377 hash_ofp_port(ofport
->ofp_port
));
2378 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2380 update_mtu(p
, ofport
);
2382 /* Let the ofproto_class initialize its private data. */
2383 error
= p
->ofproto_class
->port_construct(ofport
);
2387 connmgr_send_port_status(p
->connmgr
, NULL
, pp
, OFPPR_ADD
);
2391 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2392 p
->name
, netdev_name
, ovs_strerror(error
));
2394 ofport_destroy__(ofport
);
2396 netdev_close(netdev
);
2400 /* Removes 'ofport' from 'p' and destroys it. */
2402 ofport_remove(struct ofport
*ofport
)
2404 connmgr_send_port_status(ofport
->ofproto
->connmgr
, NULL
, &ofport
->pp
,
2406 ofport_destroy(ofport
);
2409 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2412 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2414 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2416 ofport_remove(port
);
2420 /* Updates 'port' with new 'pp' description.
2422 * Does not handle a name or port number change. The caller must implement
2423 * such a change as a delete followed by an add. */
2425 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2427 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
2428 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2429 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2430 port
->pp
.state
= ((port
->pp
.state
& ~OFPUTIL_PS_LINK_DOWN
)
2431 | (pp
->state
& OFPUTIL_PS_LINK_DOWN
));
2432 port
->pp
.curr
= pp
->curr
;
2433 port
->pp
.advertised
= pp
->advertised
;
2434 port
->pp
.supported
= pp
->supported
;
2435 port
->pp
.peer
= pp
->peer
;
2436 port
->pp
.curr_speed
= pp
->curr_speed
;
2437 port
->pp
.max_speed
= pp
->max_speed
;
2439 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2440 &port
->pp
, OFPPR_MODIFY
);
2443 /* Update OpenFlow 'state' in 'port' and notify controller. */
2445 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2447 if (port
->pp
.state
!= state
) {
2448 port
->pp
.state
= state
;
2449 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2450 &port
->pp
, OFPPR_MODIFY
);
2455 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2457 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2459 if (port
->ofproto
->ofproto_class
->set_realdev
) {
2460 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
2462 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2463 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2465 if (port
->ofproto
->ofproto_class
->set_rstp_port
) {
2466 port
->ofproto
->ofproto_class
->set_rstp_port(port
, NULL
);
2468 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2469 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2471 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2472 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2478 ofport_destroy__(struct ofport
*port
)
2480 struct ofproto
*ofproto
= port
->ofproto
;
2481 const char *name
= netdev_get_name(port
->netdev
);
2483 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2484 shash_delete(&ofproto
->port_by_name
,
2485 shash_find(&ofproto
->port_by_name
, name
));
2487 netdev_close(port
->netdev
);
2488 ofproto
->ofproto_class
->port_dealloc(port
);
2492 ofport_destroy(struct ofport
*port
)
2495 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2496 port
->ofproto
->ofproto_class
->port_destruct(port
);
2497 ofport_destroy__(port
);
2502 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2504 struct ofport
*port
;
2506 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2508 if (port
->ofp_port
== ofp_port
) {
2515 static long long int
2516 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2518 struct ofport_usage
*usage
;
2520 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2521 &ofproto
->ofport_usage
) {
2522 if (usage
->ofp_port
== ofp_port
) {
2523 return usage
->last_used
;
2530 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2531 long long int last_used
)
2533 struct ofport_usage
*usage
;
2534 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2535 &ofproto
->ofport_usage
) {
2536 if (usage
->ofp_port
== ofp_port
) {
2537 usage
->last_used
= last_used
;
2541 ovs_assert(last_used
== LLONG_MAX
);
2543 usage
= xmalloc(sizeof *usage
);
2544 usage
->ofp_port
= ofp_port
;
2545 usage
->last_used
= last_used
;
2546 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2547 hash_ofp_port(ofp_port
));
2551 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2553 struct ofport_usage
*usage
;
2554 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2555 &ofproto
->ofport_usage
) {
2556 if (usage
->ofp_port
== ofp_port
) {
2557 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2565 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2567 struct ofproto
*ofproto
= port
->ofproto
;
2570 if (ofproto
->ofproto_class
->port_get_stats
) {
2571 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2580 update_port(struct ofproto
*ofproto
, const char *name
)
2582 struct ofproto_port ofproto_port
;
2583 struct ofputil_phy_port pp
;
2584 struct netdev
*netdev
;
2585 struct ofport
*port
;
2587 COVERAGE_INC(ofproto_update_port
);
2589 /* Fetch 'name''s location and properties from the datapath. */
2590 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2591 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2595 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2596 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2597 struct netdev
*old_netdev
= port
->netdev
;
2599 /* 'name' hasn't changed location. Any properties changed? */
2600 if (!ofport_equal(&port
->pp
, &pp
)) {
2601 ofport_modified(port
, &pp
);
2604 update_mtu(ofproto
, port
);
2606 /* Install the newly opened netdev in case it has changed.
2607 * Don't close the old netdev yet in case port_modified has to
2608 * remove a retained reference to it.*/
2609 port
->netdev
= netdev
;
2610 port
->change_seq
= netdev_get_change_seq(netdev
);
2612 if (port
->ofproto
->ofproto_class
->port_modified
) {
2613 port
->ofproto
->ofproto_class
->port_modified(port
);
2616 netdev_close(old_netdev
);
2618 /* If 'port' is nonnull then its name differs from 'name' and thus
2619 * we should delete it. If we think there's a port named 'name'
2620 * then its port number must be wrong now so delete it too. */
2622 ofport_remove(port
);
2624 ofport_remove_with_name(ofproto
, name
);
2625 ofport_install(ofproto
, netdev
, &pp
);
2628 /* Any port named 'name' is gone now. */
2629 ofport_remove_with_name(ofproto
, name
);
2631 ofproto_port_destroy(&ofproto_port
);
2635 init_ports(struct ofproto
*p
)
2637 struct ofproto_port_dump dump
;
2638 struct ofproto_port ofproto_port
;
2639 struct shash_node
*node
, *next
;
2641 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2642 const char *name
= ofproto_port
.name
;
2644 if (shash_find(&p
->port_by_name
, name
)) {
2645 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2648 struct ofputil_phy_port pp
;
2649 struct netdev
*netdev
;
2651 /* Check if an OpenFlow port number had been requested. */
2652 node
= shash_find(&init_ofp_ports
, name
);
2654 const struct iface_hint
*iface_hint
= node
->data
;
2655 simap_put(&p
->ofp_requests
, name
,
2656 ofp_to_u16(iface_hint
->ofp_port
));
2659 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2661 ofport_install(p
, netdev
, &pp
);
2662 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2663 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2664 ofp_to_u16(ofproto_port
.ofp_port
));
2670 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2671 struct iface_hint
*iface_hint
= node
->data
;
2673 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2674 free(iface_hint
->br_name
);
2675 free(iface_hint
->br_type
);
2677 shash_delete(&init_ofp_ports
, node
);
2684 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2685 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2687 find_min_mtu(struct ofproto
*p
)
2689 struct ofport
*ofport
;
2692 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2693 struct netdev
*netdev
= ofport
->netdev
;
2696 /* Skip any internal ports, since that's what we're trying to
2698 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2702 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2705 if (!mtu
|| dev_mtu
< mtu
) {
2710 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2713 /* Update MTU of all datapath devices on 'p' to the minimum of the
2714 * non-datapath ports in event of 'port' added or changed. */
2716 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2718 struct ofport
*ofport
;
2719 struct netdev
*netdev
= port
->netdev
;
2720 int dev_mtu
, old_min
;
2722 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2726 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2727 if (dev_mtu
> p
->min_mtu
) {
2728 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2729 dev_mtu
= p
->min_mtu
;
2732 port
->mtu
= dev_mtu
;
2736 /* For non-internal port find new min mtu. */
2737 old_min
= p
->min_mtu
;
2738 port
->mtu
= dev_mtu
;
2739 p
->min_mtu
= find_min_mtu(p
);
2740 if (p
->min_mtu
== old_min
) {
2744 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2745 struct netdev
*netdev
= ofport
->netdev
;
2747 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2748 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2749 ofport
->mtu
= p
->min_mtu
;
2756 ofproto_rule_destroy__(struct rule
*rule
)
2757 OVS_NO_THREAD_SAFETY_ANALYSIS
2759 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2760 rule_actions_destroy(rule_get_actions(rule
));
2761 ovs_mutex_destroy(&rule
->mutex
);
2762 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2766 rule_destroy_cb(struct rule
*rule
)
2767 OVS_NO_THREAD_SAFETY_ANALYSIS
2769 /* Send rule removed if needed. */
2770 if (rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
2771 && rule
->removed_reason
!= OVS_OFPRR_NONE
2772 && !rule_is_hidden(rule
)) {
2773 ofproto_rule_send_removed(rule
);
2775 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2776 ofproto_rule_destroy__(rule
);
2780 ofproto_rule_ref(struct rule
*rule
)
2783 ovs_refcount_ref(&rule
->ref_count
);
2788 ofproto_rule_try_ref(struct rule
*rule
)
2791 return ovs_refcount_try_ref_rcu(&rule
->ref_count
);
2796 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2797 * ref_count reaches 0.
2799 * Use of RCU allows short term use (between RCU quiescent periods) without
2800 * keeping a reference. A reference must be taken if the rule needs to
2801 * stay around accross the RCU quiescent periods. */
2803 ofproto_rule_unref(struct rule
*rule
)
2805 if (rule
&& ovs_refcount_unref_relaxed(&rule
->ref_count
) == 1) {
2806 ovsrcu_postpone(rule_destroy_cb
, rule
);
2811 remove_rule_rcu__(struct rule
*rule
)
2812 OVS_REQUIRES(ofproto_mutex
)
2814 struct ofproto
*ofproto
= rule
->ofproto
;
2815 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
2817 ovs_assert(!cls_rule_visible_in_version(&rule
->cr
, CLS_MAX_VERSION
));
2818 if (!classifier_remove(&table
->cls
, &rule
->cr
)) {
2821 ofproto
->ofproto_class
->rule_delete(rule
);
2822 ofproto_rule_unref(rule
);
2826 remove_rule_rcu(struct rule
*rule
)
2827 OVS_EXCLUDED(ofproto_mutex
)
2829 ovs_mutex_lock(&ofproto_mutex
);
2830 remove_rule_rcu__(rule
);
2831 ovs_mutex_unlock(&ofproto_mutex
);
2834 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2836 remove_rules_rcu(struct rule
**rules
)
2837 OVS_EXCLUDED(ofproto_mutex
)
2839 struct rule
**orig_rules
= rules
;
2842 struct ofproto
*ofproto
= rules
[0]->ofproto
;
2843 unsigned long tables
[BITMAP_N_LONGS(256)];
2847 memset(tables
, 0, sizeof tables
);
2849 ovs_mutex_lock(&ofproto_mutex
);
2850 while ((rule
= *rules
++)) {
2851 /* Defer once for each new table. This defers the subtable cleanup
2852 * until later, so that when removing large number of flows the
2853 * operation is faster. */
2854 if (!bitmap_is_set(tables
, rule
->table_id
)) {
2855 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
2857 bitmap_set1(tables
, rule
->table_id
);
2858 classifier_defer(cls
);
2860 remove_rule_rcu__(rule
);
2863 BITMAP_FOR_EACH_1(table_id
, 256, tables
) {
2864 struct classifier
*cls
= &ofproto
->tables
[table_id
].cls
;
2866 classifier_publish(cls
);
2868 ovs_mutex_unlock(&ofproto_mutex
);
2875 ofproto_group_ref(struct ofgroup
*group
)
2878 ovs_refcount_ref(&group
->ref_count
);
2883 ofproto_group_unref(struct ofgroup
*group
)
2885 if (group
&& ovs_refcount_unref(&group
->ref_count
) == 1) {
2886 group
->ofproto
->ofproto_class
->group_destruct(group
);
2887 ofputil_bucket_list_destroy(&group
->buckets
);
2888 group
->ofproto
->ofproto_class
->group_dealloc(group
);
2892 static uint32_t get_provider_meter_id(const struct ofproto
*,
2893 uint32_t of_meter_id
);
2895 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2896 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2897 const struct rule_actions
*
2898 rule_actions_create(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2900 struct rule_actions
*actions
;
2902 actions
= xmalloc(sizeof *actions
+ ofpacts_len
);
2903 actions
->ofpacts_len
= ofpacts_len
;
2904 actions
->has_meter
= ofpacts_get_meter(ofpacts
, ofpacts_len
) != 0;
2905 memcpy(actions
->ofpacts
, ofpacts
, ofpacts_len
);
2907 actions
->has_learn_with_delete
= (next_learn_with_delete(actions
, NULL
)
2913 /* Free the actions after the RCU quiescent period is reached. */
2915 rule_actions_destroy(const struct rule_actions
*actions
)
2918 ovsrcu_postpone(free
, CONST_CAST(struct rule_actions
*, actions
));
2922 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2923 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2925 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2926 OVS_REQUIRES(ofproto_mutex
)
2928 if (port
== OFPP_ANY
) {
2931 const struct rule_actions
*actions
= rule_get_actions(rule
);
2932 return ofpacts_output_to_port(actions
->ofpacts
,
2933 actions
->ofpacts_len
, port
);
2937 /* Returns true if 'rule' has group and equals group_id. */
2939 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
2940 OVS_REQUIRES(ofproto_mutex
)
2942 if (group_id
== OFPG_ANY
) {
2945 const struct rule_actions
*actions
= rule_get_actions(rule
);
2946 return ofpacts_output_to_group(actions
->ofpacts
,
2947 actions
->ofpacts_len
, group_id
);
2952 rule_execute_destroy(struct rule_execute
*e
)
2954 ofproto_rule_unref(e
->rule
);
2955 list_remove(&e
->list_node
);
2959 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2960 * by passing them to the ofproto provider. */
2962 run_rule_executes(struct ofproto
*ofproto
)
2963 OVS_EXCLUDED(ofproto_mutex
)
2965 struct rule_execute
*e
, *next
;
2966 struct ovs_list executes
;
2968 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2969 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2972 flow_extract(e
->packet
, &flow
);
2973 flow
.in_port
.ofp_port
= e
->in_port
;
2974 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
2976 rule_execute_destroy(e
);
2980 /* Destroys and discards all "rule_execute" operations queued up in
2981 * ofproto->rule_executes. */
2983 destroy_rule_executes(struct ofproto
*ofproto
)
2985 struct rule_execute
*e
, *next
;
2986 struct ovs_list executes
;
2988 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2989 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2990 dp_packet_delete(e
->packet
);
2991 rule_execute_destroy(e
);
2996 rule_is_readonly(const struct rule
*rule
)
2998 const struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
2999 return (table
->flags
& OFTABLE_READONLY
) != 0;
3003 hash_learned_cookie(ovs_be64 cookie_
, uint8_t table_id
)
3005 uint64_t cookie
= (OVS_FORCE
uint64_t) cookie_
;
3006 return hash_3words(cookie
, cookie
>> 32, table_id
);
3010 learned_cookies_update_one__(struct ofproto
*ofproto
,
3011 const struct ofpact_learn
*learn
,
3012 int delta
, struct ovs_list
*dead_cookies
)
3013 OVS_REQUIRES(ofproto_mutex
)
3015 uint32_t hash
= hash_learned_cookie(learn
->cookie
, learn
->table_id
);
3016 struct learned_cookie
*c
;
3018 HMAP_FOR_EACH_WITH_HASH (c
, u
.hmap_node
, hash
, &ofproto
->learned_cookies
) {
3019 if (c
->cookie
== learn
->cookie
&& c
->table_id
== learn
->table_id
) {
3021 ovs_assert(c
->n
>= 0);
3024 hmap_remove(&ofproto
->learned_cookies
, &c
->u
.hmap_node
);
3025 list_push_back(dead_cookies
, &c
->u
.list_node
);
3032 ovs_assert(delta
> 0);
3033 c
= xmalloc(sizeof *c
);
3034 hmap_insert(&ofproto
->learned_cookies
, &c
->u
.hmap_node
, hash
);
3035 c
->cookie
= learn
->cookie
;
3036 c
->table_id
= learn
->table_id
;
3040 static const struct ofpact_learn
*
3041 next_learn_with_delete(const struct rule_actions
*actions
,
3042 const struct ofpact_learn
*start
)
3044 const struct ofpact
*pos
;
3046 for (pos
= start
? ofpact_next(&start
->ofpact
) : actions
->ofpacts
;
3047 pos
< ofpact_end(actions
->ofpacts
, actions
->ofpacts_len
);
3048 pos
= ofpact_next(pos
)) {
3049 if (pos
->type
== OFPACT_LEARN
) {
3050 const struct ofpact_learn
*learn
= ofpact_get_LEARN(pos
);
3051 if (learn
->flags
& NX_LEARN_F_DELETE_LEARNED
) {
3061 learned_cookies_update__(struct ofproto
*ofproto
,
3062 const struct rule_actions
*actions
,
3063 int delta
, struct ovs_list
*dead_cookies
)
3064 OVS_REQUIRES(ofproto_mutex
)
3066 if (actions
->has_learn_with_delete
) {
3067 const struct ofpact_learn
*learn
;
3069 for (learn
= next_learn_with_delete(actions
, NULL
); learn
;
3070 learn
= next_learn_with_delete(actions
, learn
)) {
3071 learned_cookies_update_one__(ofproto
, learn
, delta
, dead_cookies
);
3077 learned_cookies_inc(struct ofproto
*ofproto
,
3078 const struct rule_actions
*actions
)
3079 OVS_REQUIRES(ofproto_mutex
)
3081 learned_cookies_update__(ofproto
, actions
, +1, NULL
);
3085 learned_cookies_dec(struct ofproto
*ofproto
,
3086 const struct rule_actions
*actions
,
3087 struct ovs_list
*dead_cookies
)
3088 OVS_REQUIRES(ofproto_mutex
)
3090 learned_cookies_update__(ofproto
, actions
, -1, dead_cookies
);
3094 learned_cookies_flush(struct ofproto
*ofproto
, struct ovs_list
*dead_cookies
)
3095 OVS_REQUIRES(ofproto_mutex
)
3097 struct learned_cookie
*c
;
3099 LIST_FOR_EACH_POP (c
, u
.list_node
, dead_cookies
) {
3100 struct rule_criteria criteria
;
3101 struct rule_collection rules
;
3104 match_init_catchall(&match
);
3105 rule_criteria_init(&criteria
, c
->table_id
, &match
, 0, CLS_MAX_VERSION
,
3106 c
->cookie
, OVS_BE64_MAX
, OFPP_ANY
, OFPG_ANY
);
3107 rule_criteria_require_rw(&criteria
, false);
3108 collect_rules_loose(ofproto
, &criteria
, &rules
);
3109 rule_criteria_destroy(&criteria
);
3110 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
3117 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3119 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
3124 query_tables(struct ofproto
*ofproto
,
3125 struct ofputil_table_features
**featuresp
,
3126 struct ofputil_table_stats
**statsp
)
3128 struct mf_bitmap rw_fields
= oxm_writable_fields();
3129 struct mf_bitmap match
= oxm_matchable_fields();
3130 struct mf_bitmap mask
= oxm_maskable_fields();
3132 struct ofputil_table_features
*features
;
3133 struct ofputil_table_stats
*stats
;
3136 features
= *featuresp
= xcalloc(ofproto
->n_tables
, sizeof *features
);
3137 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3138 struct ofputil_table_features
*f
= &features
[i
];
3141 sprintf(f
->name
, "table%d", i
);
3142 f
->metadata_match
= OVS_BE64_MAX
;
3143 f
->metadata_write
= OVS_BE64_MAX
;
3144 atomic_read_relaxed(&ofproto
->tables
[i
].miss_config
, &f
->miss_config
);
3145 f
->max_entries
= 1000000;
3147 bool more_tables
= false;
3148 for (int j
= i
+ 1; j
< ofproto
->n_tables
; j
++) {
3149 if (!(ofproto
->tables
[j
].flags
& OFTABLE_HIDDEN
)) {
3150 bitmap_set1(f
->nonmiss
.next
, j
);
3154 f
->nonmiss
.instructions
= (1u << N_OVS_INSTRUCTIONS
) - 1;
3156 f
->nonmiss
.instructions
&= ~(1u << OVSINST_OFPIT11_GOTO_TABLE
);
3158 f
->nonmiss
.write
.ofpacts
= (UINT64_C(1) << N_OFPACTS
) - 1;
3159 f
->nonmiss
.write
.set_fields
= rw_fields
;
3160 f
->nonmiss
.apply
= f
->nonmiss
.write
;
3161 f
->miss
= f
->nonmiss
;
3165 f
->wildcard
= match
;
3169 stats
= *statsp
= xcalloc(ofproto
->n_tables
, sizeof *stats
);
3170 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3171 struct ofputil_table_stats
*s
= &stats
[i
];
3174 s
->active_count
= ofproto
->tables
[i
].n_flows
;
3176 s
->active_count
-= connmgr_count_hidden_rules(
3184 ofproto
->ofproto_class
->query_tables(ofproto
, features
, stats
);
3186 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3187 const struct oftable
*table
= &ofproto
->tables
[i
];
3188 struct ofputil_table_features
*f
= &features
[i
];
3191 ovs_strzcpy(f
->name
, table
->name
, sizeof f
->name
);
3194 if (table
->max_flows
< f
->max_entries
) {
3195 f
->max_entries
= table
->max_flows
;
3201 query_switch_features(struct ofproto
*ofproto
,
3202 bool *arp_match_ip
, uint64_t *ofpacts
)
3204 struct ofputil_table_features
*features
, *f
;
3206 *arp_match_ip
= false;
3209 query_tables(ofproto
, &features
, NULL
);
3210 for (f
= features
; f
< &features
[ofproto
->n_tables
]; f
++) {
3211 *ofpacts
|= f
->nonmiss
.apply
.ofpacts
| f
->miss
.apply
.ofpacts
;
3212 if (bitmap_is_set(f
->match
.bm
, MFF_ARP_SPA
) ||
3213 bitmap_is_set(f
->match
.bm
, MFF_ARP_TPA
)) {
3214 *arp_match_ip
= true;
3220 ovs_assert(*ofpacts
& (UINT64_C(1) << OFPACT_OUTPUT
));
3224 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3226 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3227 struct ofputil_switch_features features
;
3228 struct ofport
*port
;
3232 query_switch_features(ofproto
, &arp_match_ip
, &features
.ofpacts
);
3234 features
.datapath_id
= ofproto
->datapath_id
;
3235 features
.n_buffers
= pktbuf_capacity();
3236 features
.n_tables
= ofproto_get_n_visible_tables(ofproto
);
3237 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
3238 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
|
3239 OFPUTIL_C_GROUP_STATS
);
3241 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
3243 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3244 features
.auxiliary_id
= 0;
3245 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
3247 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3248 ofputil_put_switch_features_port(&port
->pp
, b
);
3251 ofconn_send_reply(ofconn
, b
);
3256 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3258 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3259 struct ofp_switch_config
*osc
;
3260 enum ofp_config_flags flags
;
3264 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
3265 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
3266 flags
= ofproto
->frag_handling
;
3267 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3268 if (oh
->version
< OFP13_VERSION
3269 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
3270 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
3272 osc
->flags
= htons(flags
);
3273 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
3274 ofconn_send_reply(ofconn
, buf
);
3280 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3282 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
3283 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3284 uint16_t flags
= ntohs(osc
->flags
);
3286 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
3287 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
3288 enum ofp_config_flags cur
= ofproto
->frag_handling
;
3289 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
3291 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
3293 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
3294 ofproto
->frag_handling
= next
;
3296 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
3298 ofputil_frag_handling_to_string(next
));
3302 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3303 ofconn_set_invalid_ttl_to_controller(ofconn
,
3304 (oh
->version
< OFP13_VERSION
3305 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
3307 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
3312 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3313 * error message code for the caller to propagate upward. Otherwise, returns
3316 * The log message mentions 'msg_type'. */
3318 reject_slave_controller(struct ofconn
*ofconn
)
3320 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
3321 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
3322 return OFPERR_OFPBRC_IS_SLAVE
;
3328 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3331 * - If they use a meter, then 'ofproto' has that meter configured.
3333 * - If they use any groups, then 'ofproto' has that group configured.
3335 * Returns 0 if successful, otherwise an OpenFlow error. */
3337 ofproto_check_ofpacts(struct ofproto
*ofproto
,
3338 const struct ofpact ofpacts
[], size_t ofpacts_len
)
3340 const struct ofpact
*a
;
3343 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
3344 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
3345 return OFPERR_OFPMMFC_INVALID_METER
;
3348 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3349 if (a
->type
== OFPACT_GROUP
3350 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
3351 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
3359 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3361 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3362 struct ofputil_packet_out po
;
3363 struct dp_packet
*payload
;
3364 uint64_t ofpacts_stub
[1024 / 8];
3365 struct ofpbuf ofpacts
;
3369 COVERAGE_INC(ofproto_packet_out
);
3371 error
= reject_slave_controller(ofconn
);
3376 /* Decode message. */
3377 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3378 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
3380 goto exit_free_ofpacts
;
3382 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
3383 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
3384 error
= OFPERR_OFPBRC_BAD_PORT
;
3385 goto exit_free_ofpacts
;
3389 if (po
.buffer_id
!= UINT32_MAX
) {
3390 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
3391 if (error
|| !payload
) {
3392 goto exit_free_ofpacts
;
3395 /* Ensure that the L3 header is 32-bit aligned. */
3396 payload
= dp_packet_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
3399 /* Verify actions against packet, then send packet if successful. */
3400 flow_extract(payload
, &flow
);
3401 flow
.in_port
.ofp_port
= po
.in_port
;
3402 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
3404 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
3405 po
.ofpacts
, po
.ofpacts_len
);
3407 dp_packet_delete(payload
);
3410 ofpbuf_uninit(&ofpacts
);
3416 update_port_config(struct ofconn
*ofconn
, struct ofport
*port
,
3417 enum ofputil_port_config config
,
3418 enum ofputil_port_config mask
)
3420 enum ofputil_port_config toggle
= (config
^ port
->pp
.config
) & mask
;
3422 if (toggle
& OFPUTIL_PC_PORT_DOWN
3423 && (config
& OFPUTIL_PC_PORT_DOWN
3424 ? netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
)
3425 : netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
))) {
3426 /* We tried to bring the port up or down, but it failed, so don't
3427 * update the "down" bit. */
3428 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
3432 enum ofputil_port_config old_config
= port
->pp
.config
;
3433 port
->pp
.config
^= toggle
;
3434 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
3435 connmgr_send_port_status(port
->ofproto
->connmgr
, ofconn
, &port
->pp
,
3441 port_mod_start(struct ofconn
*ofconn
, struct ofputil_port_mod
*pm
,
3442 struct ofport
**port
)
3444 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3446 *port
= ofproto_get_port(p
, pm
->port_no
);
3448 return OFPERR_OFPPMFC_BAD_PORT
;
3450 if (!eth_addr_equals((*port
)->pp
.hw_addr
, pm
->hw_addr
)) {
3451 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3457 port_mod_finish(struct ofconn
*ofconn
, struct ofputil_port_mod
*pm
,
3458 struct ofport
*port
)
3460 update_port_config(ofconn
, port
, pm
->config
, pm
->mask
);
3461 if (pm
->advertise
) {
3462 netdev_set_advertisements(port
->netdev
, pm
->advertise
);
3467 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3469 struct ofputil_port_mod pm
;
3470 struct ofport
*port
;
3473 error
= reject_slave_controller(ofconn
);
3478 error
= ofputil_decode_port_mod(oh
, &pm
, false);
3483 error
= port_mod_start(ofconn
, &pm
, &port
);
3485 port_mod_finish(ofconn
, &pm
, port
);
3491 handle_desc_stats_request(struct ofconn
*ofconn
,
3492 const struct ofp_header
*request
)
3494 static const char *default_mfr_desc
= "Nicira, Inc.";
3495 static const char *default_hw_desc
= "Open vSwitch";
3496 static const char *default_sw_desc
= VERSION
;
3497 static const char *default_serial_desc
= "None";
3498 static const char *default_dp_desc
= "None";
3500 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3501 struct ofp_desc_stats
*ods
;
3504 msg
= ofpraw_alloc_stats_reply(request
, 0);
3505 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3506 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3507 sizeof ods
->mfr_desc
);
3508 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3509 sizeof ods
->hw_desc
);
3510 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3511 sizeof ods
->sw_desc
);
3512 ovs_strlcpy(ods
->serial_num
,
3513 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3514 sizeof ods
->serial_num
);
3515 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3516 sizeof ods
->dp_desc
);
3517 ofconn_send_reply(ofconn
, msg
);
3523 handle_table_stats_request(struct ofconn
*ofconn
,
3524 const struct ofp_header
*request
)
3526 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3527 struct ofputil_table_features
*features
;
3528 struct ofputil_table_stats
*stats
;
3529 struct ofpbuf
*reply
;
3532 query_tables(ofproto
, &features
, &stats
);
3534 reply
= ofputil_encode_table_stats_reply(request
);
3535 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3536 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3537 ofputil_append_table_stats_reply(reply
, &stats
[i
], &features
[i
]);
3540 ofconn_send_reply(ofconn
, reply
);
3549 handle_table_features_request(struct ofconn
*ofconn
,
3550 const struct ofp_header
*request
)
3552 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3553 struct ofputil_table_features
*features
;
3554 struct ovs_list replies
;
3558 ofpbuf_use_const(&msg
, request
, ntohs(request
->length
));
3559 ofpraw_pull_assert(&msg
);
3560 if (msg
.size
|| ofpmp_more(request
)) {
3561 return OFPERR_OFPTFFC_EPERM
;
3564 query_tables(ofproto
, &features
, NULL
);
3566 ofpmp_init(&replies
, request
);
3567 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3568 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3569 ofputil_append_table_features_reply(&features
[i
], &replies
);
3572 ofconn_send_replies(ofconn
, &replies
);
3579 /* This function queries the database for dumping table-desc. */
3581 query_tables_desc(struct ofproto
*ofproto
, struct ofputil_table_desc
**descp
)
3583 struct ofputil_table_desc
*table_desc
;
3586 table_desc
= *descp
= xcalloc(ofproto
->n_tables
, sizeof *table_desc
);
3587 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3588 struct ofputil_table_desc
*td
= &table_desc
[i
];
3590 td
->eviction
= (ofproto
->tables
[i
].eviction
& EVICTION_OPENFLOW
3591 ? OFPUTIL_TABLE_EVICTION_ON
3592 : OFPUTIL_TABLE_EVICTION_OFF
);
3593 td
->eviction_flags
= OFPROTO_EVICTION_FLAGS
;
3597 /* Function to handle dump-table-desc request. */
3599 handle_table_desc_request(struct ofconn
*ofconn
,
3600 const struct ofp_header
*request
)
3602 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3603 struct ofputil_table_desc
*table_desc
;
3604 struct ovs_list replies
;
3607 query_tables_desc(ofproto
, &table_desc
);
3608 ofpmp_init(&replies
, request
);
3609 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3610 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3611 ofputil_append_table_desc_reply(&table_desc
[i
], &replies
,
3615 ofconn_send_replies(ofconn
, &replies
);
3621 append_port_stat(struct ofport
*port
, struct ovs_list
*replies
)
3623 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3625 calc_duration(port
->created
, time_msec(),
3626 &ops
.duration_sec
, &ops
.duration_nsec
);
3628 /* Intentionally ignore return value, since errors will set
3629 * 'stats' to all-1s, which is correct for OpenFlow, and
3630 * netdev_get_stats() will log errors. */
3631 ofproto_port_get_stats(port
, &ops
.stats
);
3633 ofputil_append_port_stat(replies
, &ops
);
3637 handle_port_request(struct ofconn
*ofconn
,
3638 const struct ofp_header
*request
, ofp_port_t port_no
,
3639 void (*cb
)(struct ofport
*, struct ovs_list
*replies
))
3641 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3642 struct ofport
*port
;
3643 struct ovs_list replies
;
3645 ofpmp_init(&replies
, request
);
3646 if (port_no
!= OFPP_ANY
) {
3647 port
= ofproto_get_port(ofproto
, port_no
);
3652 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3657 ofconn_send_replies(ofconn
, &replies
);
3661 handle_port_stats_request(struct ofconn
*ofconn
,
3662 const struct ofp_header
*request
)
3667 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3669 handle_port_request(ofconn
, request
, port_no
, append_port_stat
);
3675 append_port_desc(struct ofport
*port
, struct ovs_list
*replies
)
3677 ofputil_append_port_desc_stats_reply(&port
->pp
, replies
);
3681 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3682 const struct ofp_header
*request
)
3687 error
= ofputil_decode_port_desc_stats_request(request
, &port_no
);
3689 handle_port_request(ofconn
, request
, port_no
, append_port_desc
);
3695 hash_cookie(ovs_be64 cookie
)
3697 return hash_uint64((OVS_FORCE
uint64_t)cookie
);
3701 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3702 OVS_REQUIRES(ofproto_mutex
)
3704 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3705 hash_cookie(rule
->flow_cookie
));
3709 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3710 OVS_REQUIRES(ofproto_mutex
)
3712 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3716 calc_duration(long long int start
, long long int now
,
3717 uint32_t *sec
, uint32_t *nsec
)
3719 long long int msecs
= now
- start
;
3720 *sec
= msecs
/ 1000;
3721 *nsec
= (msecs
% 1000) * (1000 * 1000);
3724 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3725 * true if 'table_id' is OK, false otherwise. */
3727 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3729 return table_id
== OFPTT_ALL
|| table_id
< ofproto
->n_tables
;
3732 static struct oftable
*
3733 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3735 struct oftable
*table
;
3737 for (table
= &ofproto
->tables
[table_id
];
3738 table
< &ofproto
->tables
[ofproto
->n_tables
];
3740 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3748 static struct oftable
*
3749 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3751 if (table_id
== 0xff) {
3752 return next_visible_table(ofproto
, 0);
3753 } else if (table_id
< ofproto
->n_tables
) {
3754 return &ofproto
->tables
[table_id
];
3760 static struct oftable
*
3761 next_matching_table(const struct ofproto
*ofproto
,
3762 const struct oftable
*table
, uint8_t table_id
)
3764 return (table_id
== 0xff
3765 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3769 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3771 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3772 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3774 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3775 * only once, for that table. (This can be used to access tables marked
3778 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3779 * entered at all. (Perhaps you should have validated TABLE_ID with
3780 * check_table_id().)
3782 * All parameters are evaluated multiple times.
3784 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3785 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3787 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3789 /* Initializes 'criteria' in a straightforward way based on the other
3792 * By default, the criteria include flows that are read-only, on the assumption
3793 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3794 * if flows will be modified.
3796 * For "loose" matching, the 'priority' parameter is unimportant and may be
3799 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3800 const struct match
*match
, int priority
,
3801 cls_version_t version
, ovs_be64 cookie
,
3802 ovs_be64 cookie_mask
, ofp_port_t out_port
,
3805 criteria
->table_id
= table_id
;
3806 cls_rule_init(&criteria
->cr
, match
, priority
, version
);
3807 criteria
->cookie
= cookie
;
3808 criteria
->cookie_mask
= cookie_mask
;
3809 criteria
->out_port
= out_port
;
3810 criteria
->out_group
= out_group
;
3812 /* We ordinarily want to skip hidden rules, but there has to be a way for
3813 * code internal to OVS to modify and delete them, so if the criteria
3814 * specify a priority that can only be for a hidden flow, then allow hidden
3815 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3816 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3818 criteria
->include_hidden
= priority
> UINT16_MAX
;
3820 /* We assume that the criteria are being used to collect flows for reading
3821 * but not modification. Thus, we should collect read-only flows. */
3822 criteria
->include_readonly
= true;
3825 /* By default, criteria initialized by rule_criteria_init() will match flows
3826 * that are read-only, on the assumption that the collected flows won't be
3827 * modified. Call this function to match only flows that are be modifiable.
3829 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3830 * caller has special privileges that allow it to modify even "read-only"
3833 rule_criteria_require_rw(struct rule_criteria
*criteria
,
3834 bool can_write_readonly
)
3836 criteria
->include_readonly
= can_write_readonly
;
3840 rule_criteria_destroy(struct rule_criteria
*criteria
)
3842 cls_rule_destroy(&criteria
->cr
);
3846 rule_collection_init(struct rule_collection
*rules
)
3848 rules
->rules
= rules
->stub
;
3850 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
3854 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
3856 if (rules
->n
>= rules
->capacity
) {
3857 size_t old_size
, new_size
;
3859 old_size
= rules
->capacity
* sizeof *rules
->rules
;
3860 rules
->capacity
*= 2;
3861 new_size
= rules
->capacity
* sizeof *rules
->rules
;
3863 if (rules
->rules
== rules
->stub
) {
3864 rules
->rules
= xmalloc(new_size
);
3865 memcpy(rules
->rules
, rules
->stub
, old_size
);
3867 rules
->rules
= xrealloc(rules
->rules
, new_size
);
3871 rules
->rules
[rules
->n
++] = rule
;
3875 rule_collection_ref(struct rule_collection
*rules
)
3876 OVS_REQUIRES(ofproto_mutex
)
3880 for (i
= 0; i
< rules
->n
; i
++) {
3881 ofproto_rule_ref(rules
->rules
[i
]);
3886 rule_collection_unref(struct rule_collection
*rules
)
3890 for (i
= 0; i
< rules
->n
; i
++) {
3891 ofproto_rule_unref(rules
->rules
[i
]);
3895 /* Returns a NULL-terminated array of rule pointers,
3896 * destroys 'rules'. */
3897 static struct rule
**
3898 rule_collection_detach(struct rule_collection
*rules
)
3900 struct rule
**rule_array
;
3902 rule_collection_add(rules
, NULL
);
3904 if (rules
->rules
== rules
->stub
) {
3905 rules
->rules
= xmemdup(rules
->rules
, rules
->n
* sizeof *rules
->rules
);
3908 rule_array
= rules
->rules
;
3909 rule_collection_init(rules
);
3915 rule_collection_destroy(struct rule_collection
*rules
)
3917 if (rules
->rules
!= rules
->stub
) {
3921 /* Make repeated destruction harmless. */
3922 rule_collection_init(rules
);
3925 /* Schedules postponed removal of rules, destroys 'rules'. */
3927 rule_collection_remove_postponed(struct rule_collection
*rules
)
3928 OVS_REQUIRES(ofproto_mutex
)
3931 if (rules
->n
== 1) {
3932 ovsrcu_postpone(remove_rule_rcu
, rules
->rules
[0]);
3934 ovsrcu_postpone(remove_rules_rcu
, rule_collection_detach(rules
));
3939 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3940 * function verifies most of the criteria in 'c' itself, but the caller must
3941 * check 'c->cr' itself.
3943 * Rules that have already been marked for removal are not collected.
3945 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3946 * 'c' only includes modifiable rules). */
3948 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
3949 struct rule_collection
*rules
, size_t *n_readonly
)
3950 OVS_REQUIRES(ofproto_mutex
)
3952 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
3953 && ofproto_rule_has_out_port(rule
, c
->out_port
)
3954 && ofproto_rule_has_out_group(rule
, c
->out_group
)
3955 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)
3956 && (!rule_is_hidden(rule
) || c
->include_hidden
)
3957 && cls_rule_visible_in_version(&rule
->cr
, c
->cr
.version
)) {
3958 /* Rule matches all the criteria... */
3959 if (!rule_is_readonly(rule
) || c
->include_readonly
) {
3961 rule_collection_add(rules
, rule
);
3963 /* ...except it's read-only. */
3969 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3970 * on classifiers rules are done in the "loose" way required for OpenFlow
3971 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3974 * Returns 0 on success, otherwise an OpenFlow error code. */
3976 collect_rules_loose(struct ofproto
*ofproto
,
3977 const struct rule_criteria
*criteria
,
3978 struct rule_collection
*rules
)
3979 OVS_REQUIRES(ofproto_mutex
)
3981 struct oftable
*table
;
3982 enum ofperr error
= 0;
3983 size_t n_readonly
= 0;
3985 rule_collection_init(rules
);
3987 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3988 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3992 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3995 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3996 hash_cookie(criteria
->cookie
),
3997 &ofproto
->cookies
) {
3998 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
3999 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4003 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
4006 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &criteria
->cr
) {
4007 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4013 if (!error
&& !rules
->n
&& n_readonly
) {
4014 /* We didn't find any rules to modify. We did find some read-only
4015 * rules that we're not allowed to modify, so report that. */
4016 error
= OFPERR_OFPBRC_EPERM
;
4019 rule_collection_destroy(rules
);
4024 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4025 * on classifiers rules are done in the "strict" way required for OpenFlow
4026 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
4027 * rules on list 'rules'.
4029 * Returns 0 on success, otherwise an OpenFlow error code. */
4031 collect_rules_strict(struct ofproto
*ofproto
,
4032 const struct rule_criteria
*criteria
,
4033 struct rule_collection
*rules
)
4034 OVS_REQUIRES(ofproto_mutex
)
4036 struct oftable
*table
;
4037 size_t n_readonly
= 0;
4038 enum ofperr error
= 0;
4040 rule_collection_init(rules
);
4042 if (!check_table_id(ofproto
, criteria
->table_id
)) {
4043 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4047 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
4050 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
4051 hash_cookie(criteria
->cookie
),
4052 &ofproto
->cookies
) {
4053 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
4054 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4058 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
4061 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
4062 &table
->cls
, &criteria
->cr
));
4064 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4070 if (!error
&& !rules
->n
&& n_readonly
) {
4071 /* We didn't find any rules to modify. We did find some read-only
4072 * rules that we're not allowed to modify, so report that. */
4073 error
= OFPERR_OFPBRC_EPERM
;
4076 rule_collection_destroy(rules
);
4081 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4082 * forced into the range of a uint16_t. */
4084 age_secs(long long int age_ms
)
4086 return (age_ms
< 0 ? 0
4087 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
4088 : (unsigned int) age_ms
/ 1000);
4092 handle_flow_stats_request(struct ofconn
*ofconn
,
4093 const struct ofp_header
*request
)
4094 OVS_EXCLUDED(ofproto_mutex
)
4096 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4097 struct ofputil_flow_stats_request fsr
;
4098 struct rule_criteria criteria
;
4099 struct rule_collection rules
;
4100 struct ovs_list replies
;
4104 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
4109 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, CLS_MAX_VERSION
,
4110 fsr
.cookie
, fsr
.cookie_mask
, fsr
.out_port
,
4113 ovs_mutex_lock(&ofproto_mutex
);
4114 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4115 rule_criteria_destroy(&criteria
);
4117 rule_collection_ref(&rules
);
4119 ovs_mutex_unlock(&ofproto_mutex
);
4125 ofpmp_init(&replies
, request
);
4126 for (i
= 0; i
< rules
.n
; i
++) {
4127 struct rule
*rule
= rules
.rules
[i
];
4128 long long int now
= time_msec();
4129 struct ofputil_flow_stats fs
;
4130 long long int created
, used
, modified
;
4131 const struct rule_actions
*actions
;
4132 enum ofputil_flow_mod_flags flags
;
4134 ovs_mutex_lock(&rule
->mutex
);
4135 fs
.cookie
= rule
->flow_cookie
;
4136 fs
.idle_timeout
= rule
->idle_timeout
;
4137 fs
.hard_timeout
= rule
->hard_timeout
;
4138 fs
.importance
= rule
->importance
;
4139 created
= rule
->created
;
4140 modified
= rule
->modified
;
4141 actions
= rule_get_actions(rule
);
4142 flags
= rule
->flags
;
4143 ovs_mutex_unlock(&rule
->mutex
);
4145 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
4146 &fs
.byte_count
, &used
);
4148 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
4149 fs
.table_id
= rule
->table_id
;
4150 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
4151 fs
.priority
= rule
->cr
.priority
;
4152 fs
.idle_age
= age_secs(now
- used
);
4153 fs
.hard_age
= age_secs(now
- modified
);
4154 fs
.ofpacts
= actions
->ofpacts
;
4155 fs
.ofpacts_len
= actions
->ofpacts_len
;
4158 ofputil_append_flow_stats_reply(&fs
, &replies
);
4161 rule_collection_unref(&rules
);
4162 rule_collection_destroy(&rules
);
4164 ofconn_send_replies(ofconn
, &replies
);
4170 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
4172 uint64_t packet_count
, byte_count
;
4173 const struct rule_actions
*actions
;
4174 long long int created
, used
;
4176 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
4177 &byte_count
, &used
);
4179 ovs_mutex_lock(&rule
->mutex
);
4180 actions
= rule_get_actions(rule
);
4181 created
= rule
->created
;
4182 ovs_mutex_unlock(&rule
->mutex
);
4184 if (rule
->table_id
!= 0) {
4185 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
4187 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
4188 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
4189 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
4190 cls_rule_format(&rule
->cr
, results
);
4191 ds_put_char(results
, ',');
4193 ds_put_cstr(results
, "actions=");
4194 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
4196 ds_put_cstr(results
, "\n");
4199 /* Adds a pretty-printed description of all flows to 'results', including
4200 * hidden flows (e.g., set up by in-band control). */
4202 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
4204 struct oftable
*table
;
4206 OFPROTO_FOR_EACH_TABLE (table
, p
) {
4209 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
4210 flow_stats_ds(rule
, results
);
4215 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4216 * '*engine_type' and '*engine_id', respectively. */
4218 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
4219 uint8_t *engine_type
, uint8_t *engine_id
)
4221 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
4224 /* Checks the status change of CFM on 'ofport'.
4226 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4228 ofproto_port_cfm_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
4230 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
4231 return (ofport
&& ofproto
->ofproto_class
->cfm_status_changed
4232 ? ofproto
->ofproto_class
->cfm_status_changed(ofport
)
4236 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4237 * Returns 0 if the port's CFM status was successfully stored into
4238 * '*status'. Returns positive errno if the port did not have CFM
4241 * The caller must provide and own '*status', and must free 'status->rmps'.
4242 * '*status' is indeterminate if the return value is non-zero. */
4244 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
4245 struct cfm_status
*status
)
4247 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
4248 return (ofport
&& ofproto
->ofproto_class
->get_cfm_status
4249 ? ofproto
->ofproto_class
->get_cfm_status(ofport
, status
)
4254 handle_aggregate_stats_request(struct ofconn
*ofconn
,
4255 const struct ofp_header
*oh
)
4256 OVS_EXCLUDED(ofproto_mutex
)
4258 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4259 struct ofputil_flow_stats_request request
;
4260 struct ofputil_aggregate_stats stats
;
4261 bool unknown_packets
, unknown_bytes
;
4262 struct rule_criteria criteria
;
4263 struct rule_collection rules
;
4264 struct ofpbuf
*reply
;
4268 error
= ofputil_decode_flow_stats_request(&request
, oh
);
4273 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
4274 CLS_MAX_VERSION
, request
.cookie
, request
.cookie_mask
,
4275 request
.out_port
, request
.out_group
);
4277 ovs_mutex_lock(&ofproto_mutex
);
4278 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4279 rule_criteria_destroy(&criteria
);
4281 rule_collection_ref(&rules
);
4283 ovs_mutex_unlock(&ofproto_mutex
);
4289 memset(&stats
, 0, sizeof stats
);
4290 unknown_packets
= unknown_bytes
= false;
4291 for (i
= 0; i
< rules
.n
; i
++) {
4292 struct rule
*rule
= rules
.rules
[i
];
4293 uint64_t packet_count
;
4294 uint64_t byte_count
;
4297 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
4298 &byte_count
, &used
);
4300 if (packet_count
== UINT64_MAX
) {
4301 unknown_packets
= true;
4303 stats
.packet_count
+= packet_count
;
4306 if (byte_count
== UINT64_MAX
) {
4307 unknown_bytes
= true;
4309 stats
.byte_count
+= byte_count
;
4314 if (unknown_packets
) {
4315 stats
.packet_count
= UINT64_MAX
;
4317 if (unknown_bytes
) {
4318 stats
.byte_count
= UINT64_MAX
;
4321 rule_collection_unref(&rules
);
4322 rule_collection_destroy(&rules
);
4324 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
4325 ofconn_send_reply(ofconn
, reply
);
4330 struct queue_stats_cbdata
{
4331 struct ofport
*ofport
;
4332 struct ovs_list replies
;
4337 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
4338 const struct netdev_queue_stats
*stats
)
4340 struct ofputil_queue_stats oqs
;
4342 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
4343 oqs
.queue_id
= queue_id
;
4344 oqs
.tx_bytes
= stats
->tx_bytes
;
4345 oqs
.tx_packets
= stats
->tx_packets
;
4346 oqs
.tx_errors
= stats
->tx_errors
;
4347 if (stats
->created
!= LLONG_MIN
) {
4348 calc_duration(stats
->created
, cbdata
->now
,
4349 &oqs
.duration_sec
, &oqs
.duration_nsec
);
4351 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
4353 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
4357 handle_queue_stats_dump_cb(uint32_t queue_id
,
4358 struct netdev_queue_stats
*stats
,
4361 struct queue_stats_cbdata
*cbdata
= cbdata_
;
4363 put_queue_stats(cbdata
, queue_id
, stats
);
4367 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
4368 struct queue_stats_cbdata
*cbdata
)
4370 cbdata
->ofport
= port
;
4371 if (queue_id
== OFPQ_ALL
) {
4372 netdev_dump_queue_stats(port
->netdev
,
4373 handle_queue_stats_dump_cb
, cbdata
);
4375 struct netdev_queue_stats stats
;
4377 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
4378 put_queue_stats(cbdata
, queue_id
, &stats
);
4380 return OFPERR_OFPQOFC_BAD_QUEUE
;
4387 handle_queue_stats_request(struct ofconn
*ofconn
,
4388 const struct ofp_header
*rq
)
4390 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4391 struct queue_stats_cbdata cbdata
;
4392 struct ofport
*port
;
4394 struct ofputil_queue_stats_request oqsr
;
4396 COVERAGE_INC(ofproto_queue_req
);
4398 ofpmp_init(&cbdata
.replies
, rq
);
4399 cbdata
.now
= time_msec();
4401 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
4406 if (oqsr
.port_no
== OFPP_ANY
) {
4407 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
4408 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
4409 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
4414 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
4416 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
4417 : OFPERR_OFPQOFC_BAD_PORT
);
4420 ofconn_send_replies(ofconn
, &cbdata
.replies
);
4422 ofpbuf_list_delete(&cbdata
.replies
);
4429 evict_rules_from_table(struct oftable
*table
)
4430 OVS_REQUIRES(ofproto_mutex
)
4432 enum ofperr error
= 0;
4433 struct rule_collection rules
;
4434 unsigned int count
= table
->n_flows
;
4435 unsigned int max_flows
= table
->max_flows
;
4437 rule_collection_init(&rules
);
4439 while (count
-- > max_flows
) {
4442 if (!choose_rule_to_evict(table
, &rule
)) {
4443 error
= OFPERR_OFPFMFC_TABLE_FULL
;
4446 eviction_group_remove_rule(rule
);
4447 rule_collection_add(&rules
, rule
);
4450 delete_flows__(&rules
, OFPRR_EVICTION
, NULL
);
4456 get_conjunctions(const struct ofputil_flow_mod
*fm
,
4457 struct cls_conjunction
**conjsp
, size_t *n_conjsp
)
4458 OVS_REQUIRES(ofproto_mutex
)
4460 struct cls_conjunction
*conjs
= NULL
;
4463 const struct ofpact
*ofpact
;
4464 OFPACT_FOR_EACH (ofpact
, fm
->ofpacts
, fm
->ofpacts_len
) {
4465 if (ofpact
->type
== OFPACT_CONJUNCTION
) {
4467 } else if (ofpact
->type
!= OFPACT_NOTE
) {
4468 /* "conjunction" may appear with "note" actions but not with any
4469 * other type of actions. */
4470 ovs_assert(!n_conjs
);
4477 conjs
= xzalloc(n_conjs
* sizeof *conjs
);
4478 OFPACT_FOR_EACH (ofpact
, fm
->ofpacts
, fm
->ofpacts_len
) {
4479 if (ofpact
->type
== OFPACT_CONJUNCTION
) {
4480 struct ofpact_conjunction
*oc
= ofpact_get_CONJUNCTION(ofpact
);
4481 conjs
[i
].clause
= oc
->clause
;
4482 conjs
[i
].n_clauses
= oc
->n_clauses
;
4483 conjs
[i
].id
= oc
->id
;
4490 *n_conjsp
= n_conjs
;
4493 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4494 * in which no matching flow already exists in the flow table.
4496 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4497 * success, or an OpenFlow error code on failure.
4499 * On successful return the caller must complete the operation either by
4500 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4503 * The caller retains ownership of 'fm->ofpacts'. */
4505 add_flow_start(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4506 struct rule
**old_rule
, struct rule
**new_rule
)
4507 OVS_REQUIRES(ofproto_mutex
)
4509 struct oftable
*table
;
4513 struct cls_conjunction
*conjs
;
4517 if (!check_table_id(ofproto
, fm
->table_id
)) {
4518 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4523 if (fm
->table_id
== 0xff) {
4524 if (ofproto
->ofproto_class
->rule_choose_table
) {
4525 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
4531 ovs_assert(table_id
< ofproto
->n_tables
);
4535 } else if (fm
->table_id
< ofproto
->n_tables
) {
4536 table_id
= fm
->table_id
;
4538 return OFPERR_OFPBRC_BAD_TABLE_ID
;
4541 table
= &ofproto
->tables
[table_id
];
4542 if (table
->flags
& OFTABLE_READONLY
4543 && !(fm
->flags
& OFPUTIL_FF_NO_READONLY
)) {
4544 return OFPERR_OFPBRC_EPERM
;
4547 if (!(fm
->flags
& OFPUTIL_FF_HIDDEN_FIELDS
)
4548 && !match_has_default_hidden_fields(&fm
->match
)) {
4549 VLOG_WARN_RL(&rl
, "%s: (add_flow) only internal flows can set "
4550 "non-default values to hidden fields", ofproto
->name
);
4551 return OFPERR_OFPBRC_EPERM
;
4554 cls_rule_init(&cr
, &fm
->match
, fm
->priority
, ofproto
->tables_version
+ 1);
4556 /* Check for the existence of an identical rule.
4557 * This will not return rules earlier marked for removal. */
4558 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
));
4561 /* Check for overlap, if requested. */
4562 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
4563 && classifier_rule_overlaps(&table
->cls
, &cr
)) {
4564 cls_rule_destroy(&cr
);
4565 return OFPERR_OFPFMFC_OVERLAP
;
4568 /* If necessary, evict an existing rule to clear out space. */
4569 if (table
->n_flows
>= table
->max_flows
) {
4570 if (!choose_rule_to_evict(table
, &rule
)) {
4571 error
= OFPERR_OFPFMFC_TABLE_FULL
;
4572 cls_rule_destroy(&cr
);
4575 eviction_group_remove_rule(rule
);
4576 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4578 fm
->delete_reason
= OFPRR_EVICTION
;
4582 fm
->modify_cookie
= true;
4585 /* Allocate new rule. */
4586 error
= replace_rule_create(ofproto
, fm
, &cr
, table
- ofproto
->tables
,
4592 get_conjunctions(fm
, &conjs
, &n_conjs
);
4593 replace_rule_start(ofproto
, rule
, *new_rule
, conjs
, n_conjs
);
4599 /* Revert the effects of add_flow_start(). */
4601 add_flow_revert(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4602 struct rule
*old_rule
, struct rule
*new_rule
)
4603 OVS_REQUIRES(ofproto_mutex
)
4605 if (old_rule
&& fm
->delete_reason
== OFPRR_EVICTION
) {
4606 /* Revert the eviction. */
4607 eviction_group_add_rule(old_rule
);
4610 replace_rule_revert(ofproto
, old_rule
, new_rule
);
4613 /* To be called after version bump. */
4615 add_flow_finish(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4616 const struct flow_mod_requester
*req
,
4617 struct rule
*old_rule
, struct rule
*new_rule
)
4618 OVS_REQUIRES(ofproto_mutex
)
4620 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
4622 replace_rule_finish(ofproto
, fm
, req
, old_rule
, new_rule
, &dead_cookies
);
4623 learned_cookies_flush(ofproto
, &dead_cookies
);
4626 ovsrcu_postpone(remove_rule_rcu
, old_rule
);
4628 if (minimask_get_vid_mask(&new_rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
4629 if (ofproto
->vlan_bitmap
) {
4630 uint16_t vid
= miniflow_get_vid(&new_rule
->cr
.match
.flow
);
4632 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
4633 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
4634 ofproto
->vlans_changed
= true;
4637 ofproto
->vlans_changed
= true;
4641 ofmonitor_report(ofproto
->connmgr
, new_rule
, NXFME_ADDED
, 0,
4642 req
? req
->ofconn
: NULL
,
4643 req
? req
->request
->xid
: 0, NULL
);
4646 send_buffered_packet(req
, fm
->buffer_id
, new_rule
);
4649 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4651 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4652 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4653 * structures yet. Takes ownership of 'cr'. */
4655 replace_rule_create(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4656 struct cls_rule
*cr
, uint8_t table_id
,
4657 struct rule
*old_rule
, struct rule
**new_rule
)
4662 /* Allocate new rule. */
4663 rule
= ofproto
->ofproto_class
->rule_alloc();
4665 cls_rule_destroy(cr
);
4666 VLOG_WARN_RL(&rl
, "%s: failed to allocate a rule.", ofproto
->name
);
4667 return OFPERR_OFPFMFC_UNKNOWN
;
4670 /* Initialize base state. */
4671 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4672 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), cr
);
4673 ovs_refcount_init(&rule
->ref_count
);
4674 rule
->flow_cookie
= fm
->new_cookie
;
4675 rule
->created
= rule
->modified
= time_msec();
4677 ovs_mutex_init(&rule
->mutex
);
4678 ovs_mutex_lock(&rule
->mutex
);
4679 rule
->idle_timeout
= fm
->idle_timeout
;
4680 rule
->hard_timeout
= fm
->hard_timeout
;
4681 *CONST_CAST(uint16_t *, &rule
->importance
) = fm
->importance
;
4682 rule
->removed_reason
= OVS_OFPRR_NONE
;
4684 *CONST_CAST(uint8_t *, &rule
->table_id
) = table_id
;
4685 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4686 *CONST_CAST(const struct rule_actions
**, &rule
->actions
)
4687 = rule_actions_create(fm
->ofpacts
, fm
->ofpacts_len
);
4688 list_init(&rule
->meter_list_node
);
4689 rule
->eviction_group
= NULL
;
4690 list_init(&rule
->expirable
);
4691 rule
->monitor_flags
= 0;
4692 rule
->add_seqno
= 0;
4693 rule
->modify_seqno
= 0;
4695 /* Copy values from old rule for modify semantics. */
4696 if (old_rule
&& fm
->delete_reason
!= OFPRR_EVICTION
) {
4697 bool change_cookie
= (fm
->modify_cookie
4698 && fm
->new_cookie
!= OVS_BE64_MAX
4699 && fm
->new_cookie
!= old_rule
->flow_cookie
);
4701 ovs_mutex_lock(&old_rule
->mutex
);
4702 if (fm
->command
!= OFPFC_ADD
) {
4703 rule
->idle_timeout
= old_rule
->idle_timeout
;
4704 rule
->hard_timeout
= old_rule
->hard_timeout
;
4705 *CONST_CAST(uint16_t *, &rule
->importance
) = old_rule
->importance
;
4706 rule
->flags
= old_rule
->flags
;
4707 rule
->created
= old_rule
->created
;
4709 if (!change_cookie
) {
4710 rule
->flow_cookie
= old_rule
->flow_cookie
;
4712 ovs_mutex_unlock(&old_rule
->mutex
);
4714 ovs_mutex_unlock(&rule
->mutex
);
4716 /* Construct rule, initializing derived state. */
4717 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4719 ofproto_rule_destroy__(rule
);
4723 rule
->removed
= true; /* Not yet in ofproto data structures. */
4730 replace_rule_start(struct ofproto
*ofproto
,
4731 struct rule
*old_rule
, struct rule
*new_rule
,
4732 struct cls_conjunction
*conjs
, size_t n_conjs
)
4734 struct oftable
*table
= &ofproto
->tables
[new_rule
->table_id
];
4736 /* 'old_rule' may be either an evicted rule or replaced rule. */
4738 /* Mark the old rule for removal in the next version. */
4739 cls_rule_make_invisible_in_version(&old_rule
->cr
,
4740 ofproto
->tables_version
+ 1);
4744 /* Insert flow to the classifier, so that later flow_mods may relate
4745 * to it. This is reversible, in case later errors require this to
4747 ofproto_rule_insert__(ofproto
, new_rule
);
4748 /* Make the new rule visible for classifier lookups only from the next
4750 classifier_insert(&table
->cls
, &new_rule
->cr
, conjs
, n_conjs
);
4753 static void replace_rule_revert(struct ofproto
*ofproto
,
4754 struct rule
*old_rule
, struct rule
*new_rule
)
4756 struct oftable
*table
= &ofproto
->tables
[new_rule
->table_id
];
4759 /* Restore the original visibility of the old rule. */
4760 cls_rule_restore_visibility(&old_rule
->cr
);
4762 /* Restore table's rule count. */
4766 /* Remove the new rule immediately. It was never visible to lookups. */
4767 if (!classifier_remove(&table
->cls
, &new_rule
->cr
)) {
4770 ofproto_rule_remove__(ofproto
, new_rule
);
4771 /* The rule was not inserted to the ofproto provider, so we can
4772 * release it without deleting it from the ofproto provider. */
4773 ofproto_rule_unref(new_rule
);
4776 /* Adds the 'new_rule', replacing the 'old_rule'. */
4778 replace_rule_finish(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4779 const struct flow_mod_requester
*req
,
4780 struct rule
*old_rule
, struct rule
*new_rule
,
4781 struct ovs_list
*dead_cookies
)
4782 OVS_REQUIRES(ofproto_mutex
)
4784 bool forward_stats
= !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
);
4785 struct rule
*replaced_rule
;
4787 replaced_rule
= fm
->delete_reason
!= OFPRR_EVICTION
? old_rule
: NULL
;
4789 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4790 * is a duplicate rule the 'new_rule' is replacing. The provider should
4791 * link the stats from the old rule to the new one if 'forward_stats' is
4792 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4793 ofproto
->ofproto_class
->rule_insert(new_rule
, replaced_rule
,
4795 learned_cookies_inc(ofproto
, rule_get_actions(new_rule
));
4798 const struct rule_actions
*old_actions
= rule_get_actions(old_rule
);
4800 /* Remove the old rule from data structures. Removal from the
4801 * classifier and the deletion of the rule is RCU postponed by the
4803 ofproto_rule_remove__(ofproto
, old_rule
);
4804 learned_cookies_dec(ofproto
, old_actions
, dead_cookies
);
4806 if (replaced_rule
) {
4807 enum nx_flow_update_event event
= fm
->command
== OFPFC_ADD
4808 ? NXFME_ADDED
: NXFME_MODIFIED
;
4810 bool change_cookie
= (fm
->modify_cookie
4811 && fm
->new_cookie
!= OVS_BE64_MAX
4812 && fm
->new_cookie
!= old_rule
->flow_cookie
);
4814 bool change_actions
= !ofpacts_equal(fm
->ofpacts
,
4816 old_actions
->ofpacts
,
4817 old_actions
->ofpacts_len
);
4819 if (event
!= NXFME_MODIFIED
|| change_actions
|| change_cookie
) {
4820 ofmonitor_report(ofproto
->connmgr
, new_rule
, event
, 0,
4821 req
? req
->ofconn
: NULL
,
4822 req
? req
->request
->xid
: 0,
4823 change_actions
? old_actions
: NULL
);
4826 /* XXX: This is slight duplication with delete_flows_finish__() */
4828 old_rule
->removed_reason
= OFPRR_EVICTION
;
4830 ofmonitor_report(ofproto
->connmgr
, old_rule
, NXFME_DELETED
,
4832 req
? req
->ofconn
: NULL
,
4833 req
? req
->request
->xid
: 0, NULL
);
4839 modify_flows_start__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4840 struct rule_collection
*old_rules
,
4841 struct rule_collection
*new_rules
)
4842 OVS_REQUIRES(ofproto_mutex
)
4846 rule_collection_init(new_rules
);
4848 if (old_rules
->n
> 0) {
4849 struct cls_conjunction
*conjs
;
4853 /* Create a new 'modified' rule for each old rule. */
4854 for (i
= 0; i
< old_rules
->n
; i
++) {
4855 struct rule
*old_rule
= old_rules
->rules
[i
];
4856 struct rule
*new_rule
;
4859 cls_rule_clone_in_version(&cr
, &old_rule
->cr
,
4860 ofproto
->tables_version
+ 1);
4861 error
= replace_rule_create(ofproto
, fm
, &cr
, old_rule
->table_id
,
4862 old_rule
, &new_rule
);
4864 rule_collection_add(new_rules
, new_rule
);
4866 rule_collection_unref(new_rules
);
4867 rule_collection_destroy(new_rules
);
4871 ovs_assert(new_rules
->n
== old_rules
->n
);
4873 get_conjunctions(fm
, &conjs
, &n_conjs
);
4874 for (i
= 0; i
< old_rules
->n
; i
++) {
4875 replace_rule_start(ofproto
, old_rules
->rules
[i
],
4876 new_rules
->rules
[i
], conjs
, n_conjs
);
4879 } else if (!(fm
->cookie_mask
!= htonll(0)
4880 || fm
->new_cookie
== OVS_BE64_MAX
)) {
4881 /* No match, add a new flow. */
4882 error
= add_flow_start(ofproto
, fm
, &old_rules
->rules
[0],
4883 &new_rules
->rules
[0]);
4885 ovs_assert(fm
->delete_reason
== OFPRR_EVICTION
4886 || !old_rules
->rules
[0]);
4896 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4899 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4902 modify_flows_start_loose(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4903 struct rule_collection
*old_rules
,
4904 struct rule_collection
*new_rules
)
4905 OVS_REQUIRES(ofproto_mutex
)
4907 struct rule_criteria criteria
;
4910 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0, CLS_MAX_VERSION
,
4911 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4912 rule_criteria_require_rw(&criteria
,
4913 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4914 error
= collect_rules_loose(ofproto
, &criteria
, old_rules
);
4915 rule_criteria_destroy(&criteria
);
4918 error
= modify_flows_start__(ofproto
, fm
, old_rules
, new_rules
);
4922 rule_collection_destroy(old_rules
);
4928 modify_flows_revert(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4929 struct rule_collection
*old_rules
,
4930 struct rule_collection
*new_rules
)
4931 OVS_REQUIRES(ofproto_mutex
)
4933 /* Old rules were not changed yet, only need to revert new rules. */
4934 if (old_rules
->n
== 0 && new_rules
->n
== 1) {
4935 add_flow_revert(ofproto
, fm
, old_rules
->rules
[0], new_rules
->rules
[0]);
4936 } else if (old_rules
->n
> 0) {
4937 for (size_t i
= 0; i
< old_rules
->n
; i
++) {
4938 replace_rule_revert(ofproto
, old_rules
->rules
[i
],
4939 new_rules
->rules
[i
]);
4941 rule_collection_destroy(new_rules
);
4942 rule_collection_destroy(old_rules
);
4947 modify_flows_finish(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4948 const struct flow_mod_requester
*req
,
4949 struct rule_collection
*old_rules
,
4950 struct rule_collection
*new_rules
)
4951 OVS_REQUIRES(ofproto_mutex
)
4953 if (old_rules
->n
== 0 && new_rules
->n
== 1) {
4954 add_flow_finish(ofproto
, fm
, req
, old_rules
->rules
[0],
4955 new_rules
->rules
[0]);
4956 } else if (old_rules
->n
> 0) {
4957 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
4959 ovs_assert(new_rules
->n
== old_rules
->n
);
4961 for (size_t i
= 0; i
< old_rules
->n
; i
++) {
4962 replace_rule_finish(ofproto
, fm
, req
, old_rules
->rules
[i
],
4963 new_rules
->rules
[i
], &dead_cookies
);
4965 learned_cookies_flush(ofproto
, &dead_cookies
);
4966 rule_collection_remove_postponed(old_rules
);
4968 send_buffered_packet(req
, fm
->buffer_id
, new_rules
->rules
[0]);
4969 rule_collection_destroy(new_rules
);
4973 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4974 * code on failure. */
4976 modify_flow_start_strict(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4977 struct rule_collection
*old_rules
,
4978 struct rule_collection
*new_rules
)
4979 OVS_REQUIRES(ofproto_mutex
)
4981 struct rule_criteria criteria
;
4984 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4985 CLS_MAX_VERSION
, fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
,
4987 rule_criteria_require_rw(&criteria
,
4988 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4989 error
= collect_rules_strict(ofproto
, &criteria
, old_rules
);
4990 rule_criteria_destroy(&criteria
);
4993 /* collect_rules_strict() can return max 1 rule. */
4994 error
= modify_flows_start__(ofproto
, fm
, old_rules
, new_rules
);
4998 rule_collection_destroy(old_rules
);
5003 /* OFPFC_DELETE implementation. */
5006 delete_flows_start__(struct ofproto
*ofproto
,
5007 const struct rule_collection
*rules
)
5008 OVS_REQUIRES(ofproto_mutex
)
5010 for (size_t i
= 0; i
< rules
->n
; i
++) {
5011 struct rule
*rule
= rules
->rules
[i
];
5012 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
5015 cls_rule_make_invisible_in_version(&rule
->cr
,
5016 ofproto
->tables_version
+ 1);
5021 delete_flows_finish__(struct ofproto
*ofproto
,
5022 struct rule_collection
*rules
,
5023 enum ofp_flow_removed_reason reason
,
5024 const struct flow_mod_requester
*req
)
5025 OVS_REQUIRES(ofproto_mutex
)
5028 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
5030 for (size_t i
= 0; i
< rules
->n
; i
++) {
5031 struct rule
*rule
= rules
->rules
[i
];
5033 /* This value will be used to send the flow removed message right
5034 * before the rule is actually destroyed. */
5035 rule
->removed_reason
= reason
;
5037 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_DELETED
, reason
,
5038 req
? req
->ofconn
: NULL
,
5039 req
? req
->request
->xid
: 0, NULL
);
5040 ofproto_rule_remove__(ofproto
, rule
);
5041 learned_cookies_dec(ofproto
, rule_get_actions(rule
),
5044 rule_collection_remove_postponed(rules
);
5046 learned_cookies_flush(ofproto
, &dead_cookies
);
5050 /* Deletes the rules listed in 'rules'.
5051 * The deleted rules will become invisible to the lookups in the next version.
5052 * Destroys 'rules'. */
5054 delete_flows__(struct rule_collection
*rules
,
5055 enum ofp_flow_removed_reason reason
,
5056 const struct flow_mod_requester
*req
)
5057 OVS_REQUIRES(ofproto_mutex
)
5060 struct ofproto
*ofproto
= rules
->rules
[0]->ofproto
;
5062 delete_flows_start__(ofproto
, rules
);
5063 ofproto_bump_tables_version(ofproto
);
5064 delete_flows_finish__(ofproto
, rules
, reason
, req
);
5065 ofmonitor_flush(ofproto
->connmgr
);
5069 /* Implements OFPFC_DELETE. */
5071 delete_flows_start_loose(struct ofproto
*ofproto
,
5072 const struct ofputil_flow_mod
*fm
,
5073 struct rule_collection
*rules
)
5074 OVS_REQUIRES(ofproto_mutex
)
5076 struct rule_criteria criteria
;
5079 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0, CLS_MAX_VERSION
,
5080 fm
->cookie
, fm
->cookie_mask
, fm
->out_port
,
5082 rule_criteria_require_rw(&criteria
,
5083 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5084 error
= collect_rules_loose(ofproto
, &criteria
, rules
);
5085 rule_criteria_destroy(&criteria
);
5088 delete_flows_start__(ofproto
, rules
);
5095 delete_flows_revert(struct ofproto
*ofproto
,
5096 struct rule_collection
*rules
)
5097 OVS_REQUIRES(ofproto_mutex
)
5099 for (size_t i
= 0; i
< rules
->n
; i
++) {
5100 struct rule
*rule
= rules
->rules
[i
];
5101 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
5103 /* Restore table's rule count. */
5106 /* Restore the original visibility of the rule. */
5107 cls_rule_restore_visibility(&rule
->cr
);
5109 rule_collection_destroy(rules
);
5113 delete_flows_finish(struct ofproto
*ofproto
,
5114 const struct ofputil_flow_mod
*fm
,
5115 const struct flow_mod_requester
*req
,
5116 struct rule_collection
*rules
)
5117 OVS_REQUIRES(ofproto_mutex
)
5119 delete_flows_finish__(ofproto
, rules
, fm
->delete_reason
, req
);
5122 /* Implements OFPFC_DELETE_STRICT. */
5124 delete_flow_start_strict(struct ofproto
*ofproto
,
5125 const struct ofputil_flow_mod
*fm
,
5126 struct rule_collection
*rules
)
5127 OVS_REQUIRES(ofproto_mutex
)
5129 struct rule_criteria criteria
;
5132 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
5133 CLS_MAX_VERSION
, fm
->cookie
, fm
->cookie_mask
,
5134 fm
->out_port
, fm
->out_group
);
5135 rule_criteria_require_rw(&criteria
,
5136 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5137 error
= collect_rules_strict(ofproto
, &criteria
, rules
);
5138 rule_criteria_destroy(&criteria
);
5141 delete_flows_start__(ofproto
, rules
);
5147 /* This may only be called by rule_destroy_cb()! */
5149 ofproto_rule_send_removed(struct rule
*rule
)
5150 OVS_EXCLUDED(ofproto_mutex
)
5152 struct ofputil_flow_removed fr
;
5155 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
5156 fr
.priority
= rule
->cr
.priority
;
5158 ovs_mutex_lock(&ofproto_mutex
);
5159 fr
.cookie
= rule
->flow_cookie
;
5160 fr
.reason
= rule
->removed_reason
;
5161 fr
.table_id
= rule
->table_id
;
5162 calc_duration(rule
->created
, time_msec(),
5163 &fr
.duration_sec
, &fr
.duration_nsec
);
5164 ovs_mutex_lock(&rule
->mutex
);
5165 fr
.idle_timeout
= rule
->idle_timeout
;
5166 fr
.hard_timeout
= rule
->hard_timeout
;
5167 ovs_mutex_unlock(&rule
->mutex
);
5168 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
5169 &fr
.byte_count
, &used
);
5170 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
5171 ovs_mutex_unlock(&ofproto_mutex
);
5174 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5175 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5178 * ofproto implementation ->run() functions should use this function to expire
5179 * OpenFlow flows. */
5181 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
5182 OVS_REQUIRES(ofproto_mutex
)
5184 struct rule_collection rules
;
5186 rules
.rules
= rules
.stub
;
5188 rules
.stub
[0] = rule
;
5189 delete_flows__(&rules
, reason
, NULL
);
5192 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5193 * means "infinite". */
5195 reduce_timeout(uint16_t max
, uint16_t *timeout
)
5197 if (max
&& (!*timeout
|| *timeout
> max
)) {
5202 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5203 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5204 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5206 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5208 ofproto_rule_reduce_timeouts(struct rule
*rule
,
5209 uint16_t idle_timeout
, uint16_t hard_timeout
)
5210 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
5212 if (!idle_timeout
&& !hard_timeout
) {
5216 ovs_mutex_lock(&ofproto_mutex
);
5217 if (list_is_empty(&rule
->expirable
)) {
5218 list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
5220 ovs_mutex_unlock(&ofproto_mutex
);
5222 ovs_mutex_lock(&rule
->mutex
);
5223 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
5224 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
5225 ovs_mutex_unlock(&rule
->mutex
);
5229 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5230 OVS_EXCLUDED(ofproto_mutex
)
5232 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5233 struct ofputil_flow_mod fm
;
5234 uint64_t ofpacts_stub
[1024 / 8];
5235 struct ofpbuf ofpacts
;
5238 error
= reject_slave_controller(ofconn
);
5243 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
5244 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
5246 u16_to_ofp(ofproto
->max_ports
),
5249 error
= ofproto_check_ofpacts(ofproto
, fm
.ofpacts
, fm
.ofpacts_len
);
5252 struct flow_mod_requester req
;
5254 req
.ofconn
= ofconn
;
5256 error
= handle_flow_mod__(ofproto
, &fm
, &req
);
5259 goto exit_free_ofpacts
;
5262 ofconn_report_flow_mod(ofconn
, fm
.command
);
5265 ofpbuf_uninit(&ofpacts
);
5271 handle_flow_mod__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
5272 const struct flow_mod_requester
*req
)
5273 OVS_EXCLUDED(ofproto_mutex
)
5275 struct ofp_bundle_entry be
;
5278 ovs_mutex_lock(&ofproto_mutex
);
5279 error
= do_bundle_flow_mod_start(ofproto
, fm
, &be
);
5281 ofproto_bump_tables_version(ofproto
);
5282 do_bundle_flow_mod_finish(ofproto
, fm
, req
, &be
);
5284 ofmonitor_flush(ofproto
->connmgr
);
5285 ovs_mutex_unlock(&ofproto_mutex
);
5287 run_rule_executes(ofproto
);
5292 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5294 struct ofputil_role_request request
;
5295 struct ofputil_role_request reply
;
5299 error
= ofputil_decode_role_message(oh
, &request
);
5304 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
5305 if (request
.have_generation_id
5306 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
5307 return OFPERR_OFPRRFC_STALE
;
5310 ofconn_set_role(ofconn
, request
.role
);
5313 reply
.role
= ofconn_get_role(ofconn
);
5314 reply
.have_generation_id
= ofconn_get_master_election_id(
5315 ofconn
, &reply
.generation_id
);
5316 buf
= ofputil_encode_role_reply(oh
, &reply
);
5317 ofconn_send_reply(ofconn
, buf
);
5323 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
5324 const struct ofp_header
*oh
)
5326 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
5327 enum ofputil_protocol cur
, next
;
5329 cur
= ofconn_get_protocol(ofconn
);
5330 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
5331 ofconn_set_protocol(ofconn
, next
);
5337 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5339 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
5340 enum ofputil_protocol cur
, next
;
5341 enum ofputil_protocol next_base
;
5343 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
5345 return OFPERR_OFPBRC_EPERM
;
5348 cur
= ofconn_get_protocol(ofconn
);
5349 next
= ofputil_protocol_set_base(cur
, next_base
);
5350 ofconn_set_protocol(ofconn
, next
);
5356 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
5357 const struct ofp_header
*oh
)
5359 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
5362 format
= ntohl(msg
->format
);
5363 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
5364 return OFPERR_OFPBRC_EPERM
;
5367 ofconn_set_packet_in_format(ofconn
, format
);
5372 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5374 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
5375 uint32_t master
[OAM_N_TYPES
];
5376 uint32_t slave
[OAM_N_TYPES
];
5378 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
5379 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
5380 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
5382 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
5383 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
5384 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
5386 ofconn_set_async_config(ofconn
, master
, slave
);
5387 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
5388 !ofconn_get_miss_send_len(ofconn
)) {
5389 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
5396 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5399 uint32_t master
[OAM_N_TYPES
];
5400 uint32_t slave
[OAM_N_TYPES
];
5401 struct nx_async_config
*msg
;
5403 ofconn_get_async_config(ofconn
, master
, slave
);
5404 buf
= ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY
, oh
, 0);
5405 msg
= ofpbuf_put_zeros(buf
, sizeof *msg
);
5407 msg
->packet_in_mask
[0] = htonl(master
[OAM_PACKET_IN
]);
5408 msg
->port_status_mask
[0] = htonl(master
[OAM_PORT_STATUS
]);
5409 msg
->flow_removed_mask
[0] = htonl(master
[OAM_FLOW_REMOVED
]);
5411 msg
->packet_in_mask
[1] = htonl(slave
[OAM_PACKET_IN
]);
5412 msg
->port_status_mask
[1] = htonl(slave
[OAM_PORT_STATUS
]);
5413 msg
->flow_removed_mask
[1] = htonl(slave
[OAM_FLOW_REMOVED
]);
5415 ofconn_send_reply(ofconn
, buf
);
5421 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
5422 const struct ofp_header
*oh
)
5424 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
5426 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
5427 return OFPERR_NXBRC_MUST_BE_ZERO
;
5430 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
5435 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5439 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
5440 ? OFPRAW_OFPT10_BARRIER_REPLY
5441 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
5442 ofconn_send_reply(ofconn
, buf
);
5447 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
5448 enum nx_flow_monitor_flags flags
,
5449 struct ovs_list
*msgs
)
5450 OVS_REQUIRES(ofproto_mutex
)
5452 const struct rule_actions
*actions
;
5453 struct ofputil_flow_update fu
;
5456 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
5457 ? NXFME_ADDED
: NXFME_MODIFIED
);
5459 ovs_mutex_lock(&rule
->mutex
);
5460 fu
.idle_timeout
= rule
->idle_timeout
;
5461 fu
.hard_timeout
= rule
->hard_timeout
;
5462 ovs_mutex_unlock(&rule
->mutex
);
5463 fu
.table_id
= rule
->table_id
;
5464 fu
.cookie
= rule
->flow_cookie
;
5465 minimatch_expand(&rule
->cr
.match
, &match
);
5467 fu
.priority
= rule
->cr
.priority
;
5469 actions
= flags
& NXFMF_ACTIONS
? rule_get_actions(rule
) : NULL
;
5470 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
5471 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
5473 if (list_is_empty(msgs
)) {
5474 ofputil_start_flow_update(msgs
);
5476 ofputil_append_flow_update(&fu
, msgs
);
5480 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
5481 struct ovs_list
*msgs
)
5482 OVS_REQUIRES(ofproto_mutex
)
5486 for (i
= 0; i
< rules
->n
; i
++) {
5487 struct rule
*rule
= rules
->rules
[i
];
5488 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
5489 rule
->monitor_flags
= 0;
5491 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
5496 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
5497 struct rule
*rule
, uint64_t seqno
,
5498 struct rule_collection
*rules
)
5499 OVS_REQUIRES(ofproto_mutex
)
5501 enum nx_flow_monitor_flags update
;
5503 if (rule_is_hidden(rule
)) {
5507 if (!ofproto_rule_has_out_port(rule
, m
->out_port
)) {
5512 if (rule
->add_seqno
> seqno
) {
5513 update
= NXFMF_ADD
| NXFMF_MODIFY
;
5514 } else if (rule
->modify_seqno
> seqno
) {
5515 update
= NXFMF_MODIFY
;
5520 if (!(m
->flags
& update
)) {
5524 update
= NXFMF_INITIAL
;
5527 if (!rule
->monitor_flags
) {
5528 rule_collection_add(rules
, rule
);
5530 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
5534 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
5536 struct rule_collection
*rules
)
5537 OVS_REQUIRES(ofproto_mutex
)
5539 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
5540 const struct oftable
*table
;
5541 struct cls_rule target
;
5543 cls_rule_init_from_minimatch(&target
, &m
->match
, 0, CLS_MAX_VERSION
);
5544 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
5547 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &target
) {
5548 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
5551 cls_rule_destroy(&target
);
5555 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
5556 struct rule_collection
*rules
)
5557 OVS_REQUIRES(ofproto_mutex
)
5559 if (m
->flags
& NXFMF_INITIAL
) {
5560 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
5565 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
5566 uint64_t seqno
, struct rule_collection
*rules
)
5567 OVS_REQUIRES(ofproto_mutex
)
5569 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
5573 flow_monitor_delete(struct ofconn
*ofconn
, uint32_t id
)
5574 OVS_REQUIRES(ofproto_mutex
)
5576 struct ofmonitor
*m
;
5579 m
= ofmonitor_lookup(ofconn
, id
);
5581 ofmonitor_destroy(m
);
5584 error
= OFPERR_OFPMOFC_UNKNOWN_MONITOR
;
5591 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5592 OVS_EXCLUDED(ofproto_mutex
)
5594 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5595 struct ofmonitor
**monitors
;
5596 size_t n_monitors
, allocated_monitors
;
5597 struct rule_collection rules
;
5598 struct ovs_list replies
;
5603 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
5605 n_monitors
= allocated_monitors
= 0;
5607 ovs_mutex_lock(&ofproto_mutex
);
5609 struct ofputil_flow_monitor_request request
;
5610 struct ofmonitor
*m
;
5613 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
5614 if (retval
== EOF
) {
5616 } else if (retval
) {
5621 if (request
.table_id
!= 0xff
5622 && request
.table_id
>= ofproto
->n_tables
) {
5623 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
5627 error
= ofmonitor_create(&request
, ofconn
, &m
);
5632 if (n_monitors
>= allocated_monitors
) {
5633 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
5636 monitors
[n_monitors
++] = m
;
5639 rule_collection_init(&rules
);
5640 for (i
= 0; i
< n_monitors
; i
++) {
5641 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
5644 ofpmp_init(&replies
, oh
);
5645 ofmonitor_compose_refresh_updates(&rules
, &replies
);
5646 ovs_mutex_unlock(&ofproto_mutex
);
5648 rule_collection_destroy(&rules
);
5650 ofconn_send_replies(ofconn
, &replies
);
5656 for (i
= 0; i
< n_monitors
; i
++) {
5657 ofmonitor_destroy(monitors
[i
]);
5660 ovs_mutex_unlock(&ofproto_mutex
);
5666 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5667 OVS_EXCLUDED(ofproto_mutex
)
5672 id
= ofputil_decode_flow_monitor_cancel(oh
);
5674 ovs_mutex_lock(&ofproto_mutex
);
5675 error
= flow_monitor_delete(ofconn
, id
);
5676 ovs_mutex_unlock(&ofproto_mutex
);
5681 /* Meters implementation.
5683 * Meter table entry, indexed by the OpenFlow meter_id.
5684 * 'created' is used to compute the duration for meter stats.
5685 * 'list rules' is needed so that we can delete the dependent rules when the
5686 * meter table entry is deleted.
5687 * 'provider_meter_id' is for the provider's private use.
5690 long long int created
; /* Time created. */
5691 struct ovs_list rules
; /* List of "struct rule_dpif"s. */
5692 ofproto_meter_id provider_meter_id
;
5693 uint16_t flags
; /* Meter flags. */
5694 uint16_t n_bands
; /* Number of meter bands. */
5695 struct ofputil_meter_band
*bands
;
5699 * This is used in instruction validation at flow set-up time,
5700 * as flows may not use non-existing meters.
5701 * Return value of UINT32_MAX signifies an invalid meter.
5704 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
5706 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
5707 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
5709 return meter
->provider_meter_id
.uint32
;
5715 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5718 meter_insert_rule(struct rule
*rule
)
5720 const struct rule_actions
*a
= rule_get_actions(rule
);
5721 uint32_t meter_id
= ofpacts_get_meter(a
->ofpacts
, a
->ofpacts_len
);
5722 struct meter
*meter
= rule
->ofproto
->meters
[meter_id
];
5724 list_insert(&meter
->rules
, &rule
->meter_list_node
);
5728 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
5732 meter
->flags
= config
->flags
;
5733 meter
->n_bands
= config
->n_bands
;
5734 meter
->bands
= xmemdup(config
->bands
,
5735 config
->n_bands
* sizeof *meter
->bands
);
5738 static struct meter
*
5739 meter_create(const struct ofputil_meter_config
*config
,
5740 ofproto_meter_id provider_meter_id
)
5742 struct meter
*meter
;
5744 meter
= xzalloc(sizeof *meter
);
5745 meter
->provider_meter_id
= provider_meter_id
;
5746 meter
->created
= time_msec();
5747 list_init(&meter
->rules
);
5749 meter_update(meter
, config
);
5755 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5756 OVS_REQUIRES(ofproto_mutex
)
5759 for (mid
= first
; mid
<= last
; ++mid
) {
5760 struct meter
*meter
= ofproto
->meters
[mid
];
5762 ofproto
->meters
[mid
] = NULL
;
5763 ofproto
->ofproto_class
->meter_del(ofproto
,
5764 meter
->provider_meter_id
);
5772 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5774 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5775 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5779 return OFPERR_OFPMMFC_METER_EXISTS
;
5782 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5785 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5786 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5792 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5794 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5796 uint32_t provider_meter_id
;
5799 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5802 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5803 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5804 &meter
->provider_meter_id
,
5806 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5808 meter_update(meter
, &mm
->meter
);
5814 handle_delete_meter(struct ofconn
*ofconn
, struct ofputil_meter_mod
*mm
)
5815 OVS_EXCLUDED(ofproto_mutex
)
5817 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5818 uint32_t meter_id
= mm
->meter
.meter_id
;
5819 struct rule_collection rules
;
5820 enum ofperr error
= 0;
5821 uint32_t first
, last
;
5823 if (meter_id
== OFPM13_ALL
) {
5825 last
= ofproto
->meter_features
.max_meters
;
5827 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
5830 first
= last
= meter_id
;
5833 /* First delete the rules that use this meter. If any of those rules are
5834 * currently being modified, postpone the whole operation until later. */
5835 rule_collection_init(&rules
);
5836 ovs_mutex_lock(&ofproto_mutex
);
5837 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5838 struct meter
*meter
= ofproto
->meters
[meter_id
];
5839 if (meter
&& !list_is_empty(&meter
->rules
)) {
5842 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
5843 rule_collection_add(&rules
, rule
);
5847 delete_flows__(&rules
, OFPRR_METER_DELETE
, NULL
);
5849 /* Delete the meters. */
5850 meter_delete(ofproto
, first
, last
);
5852 ovs_mutex_unlock(&ofproto_mutex
);
5858 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5860 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5861 struct ofputil_meter_mod mm
;
5862 uint64_t bands_stub
[256 / 8];
5863 struct ofpbuf bands
;
5867 error
= reject_slave_controller(ofconn
);
5872 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5874 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
5876 goto exit_free_bands
;
5879 meter_id
= mm
.meter
.meter_id
;
5881 if (mm
.command
!= OFPMC13_DELETE
) {
5882 /* Fails also when meters are not implemented by the provider. */
5883 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
5884 error
= OFPERR_OFPMMFC_INVALID_METER
;
5885 goto exit_free_bands
;
5886 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
5887 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
5888 goto exit_free_bands
;
5890 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
5891 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
5892 goto exit_free_bands
;
5896 switch (mm
.command
) {
5898 error
= handle_add_meter(ofproto
, &mm
);
5901 case OFPMC13_MODIFY
:
5902 error
= handle_modify_meter(ofproto
, &mm
);
5905 case OFPMC13_DELETE
:
5906 error
= handle_delete_meter(ofconn
, &mm
);
5910 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
5915 ofpbuf_uninit(&bands
);
5920 handle_meter_features_request(struct ofconn
*ofconn
,
5921 const struct ofp_header
*request
)
5923 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5924 struct ofputil_meter_features features
;
5927 if (ofproto
->ofproto_class
->meter_get_features
) {
5928 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
5930 memset(&features
, 0, sizeof features
);
5932 b
= ofputil_encode_meter_features_reply(&features
, request
);
5934 ofconn_send_reply(ofconn
, b
);
5939 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
5942 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5943 struct ovs_list replies
;
5944 uint64_t bands_stub
[256 / 8];
5945 struct ofpbuf bands
;
5946 uint32_t meter_id
, first
, last
;
5948 ofputil_decode_meter_request(request
, &meter_id
);
5950 if (meter_id
== OFPM13_ALL
) {
5952 last
= ofproto
->meter_features
.max_meters
;
5954 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
5955 !ofproto
->meters
[meter_id
]) {
5956 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5958 first
= last
= meter_id
;
5961 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5962 ofpmp_init(&replies
, request
);
5964 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5965 struct meter
*meter
= ofproto
->meters
[meter_id
];
5967 continue; /* Skip non-existing meters. */
5969 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
5970 struct ofputil_meter_stats stats
;
5972 stats
.meter_id
= meter_id
;
5974 /* Provider sets the packet and byte counts, we do the rest. */
5975 stats
.flow_count
= list_size(&meter
->rules
);
5976 calc_duration(meter
->created
, time_msec(),
5977 &stats
.duration_sec
, &stats
.duration_nsec
);
5978 stats
.n_bands
= meter
->n_bands
;
5979 ofpbuf_clear(&bands
);
5981 = ofpbuf_put_uninit(&bands
,
5982 meter
->n_bands
* sizeof *stats
.bands
);
5984 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
5985 meter
->provider_meter_id
,
5987 ofputil_append_meter_stats(&replies
, &stats
);
5989 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5990 struct ofputil_meter_config config
;
5992 config
.meter_id
= meter_id
;
5993 config
.flags
= meter
->flags
;
5994 config
.n_bands
= meter
->n_bands
;
5995 config
.bands
= meter
->bands
;
5996 ofputil_append_meter_config(&replies
, &config
);
6000 ofconn_send_replies(ofconn
, &replies
);
6001 ofpbuf_uninit(&bands
);
6006 ofproto_group_lookup__(const struct ofproto
*ofproto
, uint32_t group_id
,
6007 struct ofgroup
**group
)
6008 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
6010 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
6011 hash_int(group_id
, 0), &ofproto
->groups
) {
6012 if ((*group
)->group_id
== group_id
) {
6020 /* If the group exists, this function increments the groups's reference count.
6022 * Make sure to call ofproto_group_unref() after no longer needing to maintain
6023 * a reference to the group. */
6025 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
6026 struct ofgroup
**group
)
6030 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
6031 found
= ofproto_group_lookup__(ofproto
, group_id
, group
);
6033 ofproto_group_ref(*group
);
6035 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6040 ofproto_group_exists__(const struct ofproto
*ofproto
, uint32_t group_id
)
6041 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
6043 struct ofgroup
*grp
;
6045 HMAP_FOR_EACH_IN_BUCKET (grp
, hmap_node
,
6046 hash_int(group_id
, 0), &ofproto
->groups
) {
6047 if (grp
->group_id
== group_id
) {
6055 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
6056 OVS_EXCLUDED(ofproto
->groups_rwlock
)
6060 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
6061 exists
= ofproto_group_exists__(ofproto
, group_id
);
6062 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6068 group_get_ref_count(struct ofgroup
*group
)
6069 OVS_EXCLUDED(ofproto_mutex
)
6071 struct ofproto
*ofproto
= CONST_CAST(struct ofproto
*, group
->ofproto
);
6072 struct rule_criteria criteria
;
6073 struct rule_collection rules
;
6078 match_init_catchall(&match
);
6079 rule_criteria_init(&criteria
, 0xff, &match
, 0, CLS_MAX_VERSION
, htonll(0),
6080 htonll(0), OFPP_ANY
, group
->group_id
);
6081 ovs_mutex_lock(&ofproto_mutex
);
6082 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
6083 ovs_mutex_unlock(&ofproto_mutex
);
6084 rule_criteria_destroy(&criteria
);
6086 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
6088 rule_collection_destroy(&rules
);
6093 append_group_stats(struct ofgroup
*group
, struct ovs_list
*replies
)
6095 struct ofputil_group_stats ogs
;
6096 const struct ofproto
*ofproto
= group
->ofproto
;
6097 long long int now
= time_msec();
6100 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
6102 /* Provider sets the packet and byte counts, we do the rest. */
6103 ogs
.ref_count
= group_get_ref_count(group
);
6104 ogs
.n_buckets
= group
->n_buckets
;
6106 error
= (ofproto
->ofproto_class
->group_get_stats
6107 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
6110 ogs
.packet_count
= UINT64_MAX
;
6111 ogs
.byte_count
= UINT64_MAX
;
6112 memset(ogs
.bucket_stats
, 0xff,
6113 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
6116 ogs
.group_id
= group
->group_id
;
6117 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
6119 ofputil_append_group_stats(replies
, &ogs
);
6121 free(ogs
.bucket_stats
);
6125 handle_group_request(struct ofconn
*ofconn
,
6126 const struct ofp_header
*request
, uint32_t group_id
,
6127 void (*cb
)(struct ofgroup
*, struct ovs_list
*replies
))
6129 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6130 struct ofgroup
*group
;
6131 struct ovs_list replies
;
6133 ofpmp_init(&replies
, request
);
6134 if (group_id
== OFPG_ALL
) {
6135 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
6136 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
6137 cb(group
, &replies
);
6139 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6141 if (ofproto_group_lookup(ofproto
, group_id
, &group
)) {
6142 cb(group
, &replies
);
6143 ofproto_group_unref(group
);
6146 ofconn_send_replies(ofconn
, &replies
);
6150 handle_group_stats_request(struct ofconn
*ofconn
,
6151 const struct ofp_header
*request
)
6156 error
= ofputil_decode_group_stats_request(request
, &group_id
);
6161 handle_group_request(ofconn
, request
, group_id
, append_group_stats
);
6166 append_group_desc(struct ofgroup
*group
, struct ovs_list
*replies
)
6168 struct ofputil_group_desc gds
;
6170 gds
.group_id
= group
->group_id
;
6171 gds
.type
= group
->type
;
6172 gds
.props
= group
->props
;
6174 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, replies
);
6178 handle_group_desc_stats_request(struct ofconn
*ofconn
,
6179 const struct ofp_header
*request
)
6181 handle_group_request(ofconn
, request
,
6182 ofputil_decode_group_desc_request(request
),
6188 handle_group_features_stats_request(struct ofconn
*ofconn
,
6189 const struct ofp_header
*request
)
6191 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
6194 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
6196 ofconn_send_reply(ofconn
, msg
);
6203 handle_queue_get_config_request(struct ofconn
*ofconn
,
6204 const struct ofp_header
*oh
)
6206 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
6207 struct netdev_queue_dump queue_dump
;
6208 struct ofport
*ofport
;
6209 unsigned int queue_id
;
6210 struct ofpbuf
*reply
;
6211 struct smap details
;
6215 error
= ofputil_decode_queue_get_config_request(oh
, &request
);
6220 ofport
= ofproto_get_port(p
, request
);
6222 return OFPERR_OFPQOFC_BAD_PORT
;
6225 reply
= ofputil_encode_queue_get_config_reply(oh
);
6227 smap_init(&details
);
6228 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
, ofport
->netdev
) {
6229 struct ofputil_queue_config queue
;
6231 /* None of the existing queues have compatible properties, so we
6232 * hard-code omitting min_rate and max_rate. */
6233 queue
.queue_id
= queue_id
;
6234 queue
.min_rate
= UINT16_MAX
;
6235 queue
.max_rate
= UINT16_MAX
;
6236 ofputil_append_queue_get_config_reply(reply
, &queue
);
6238 smap_destroy(&details
);
6240 ofconn_send_reply(ofconn
, reply
);
6246 init_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
,
6247 struct ofgroup
**ofgroup
)
6250 const long long int now
= time_msec();
6252 if (gm
->group_id
> OFPG_MAX
) {
6253 return OFPERR_OFPGMFC_INVALID_GROUP
;
6255 if (gm
->type
> OFPGT11_FF
) {
6256 return OFPERR_OFPGMFC_BAD_TYPE
;
6259 *ofgroup
= ofproto
->ofproto_class
->group_alloc();
6261 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
6262 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6265 (*ofgroup
)->ofproto
= ofproto
;
6266 *CONST_CAST(uint32_t *, &((*ofgroup
)->group_id
)) = gm
->group_id
;
6267 *CONST_CAST(enum ofp11_group_type
*, &(*ofgroup
)->type
) = gm
->type
;
6268 *CONST_CAST(long long int *, &((*ofgroup
)->created
)) = now
;
6269 *CONST_CAST(long long int *, &((*ofgroup
)->modified
)) = now
;
6270 ovs_refcount_init(&(*ofgroup
)->ref_count
);
6272 list_move(&(*ofgroup
)->buckets
, &gm
->buckets
);
6273 *CONST_CAST(uint32_t *, &(*ofgroup
)->n_buckets
) =
6274 list_size(&(*ofgroup
)->buckets
);
6276 memcpy(CONST_CAST(struct ofputil_group_props
*, &(*ofgroup
)->props
),
6277 &gm
->props
, sizeof (struct ofputil_group_props
));
6279 /* Construct called BEFORE any locks are held. */
6280 error
= ofproto
->ofproto_class
->group_construct(*ofgroup
);
6282 ofputil_bucket_list_destroy(&(*ofgroup
)->buckets
);
6283 ofproto
->ofproto_class
->group_dealloc(*ofgroup
);
6288 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6289 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6292 add_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
6294 struct ofgroup
*ofgroup
;
6297 /* Allocate new group and initialize it. */
6298 error
= init_group(ofproto
, gm
, &ofgroup
);
6303 /* We wrlock as late as possible to minimize the time we jam any other
6304 * threads: No visible state changes before acquiring the lock. */
6305 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6307 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
6308 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6312 if (ofproto_group_exists__(ofproto
, gm
->group_id
)) {
6313 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
6318 /* Insert new group. */
6319 hmap_insert(&ofproto
->groups
, &ofgroup
->hmap_node
,
6320 hash_int(ofgroup
->group_id
, 0));
6321 ofproto
->n_groups
[ofgroup
->type
]++;
6323 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6328 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6329 ofproto
->ofproto_class
->group_destruct(ofgroup
);
6330 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
6331 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
6336 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6337 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6338 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6339 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6342 copy_buckets_for_insert_bucket(const struct ofgroup
*ofgroup
,
6343 struct ofgroup
*new_ofgroup
,
6344 uint32_t command_bucket_id
)
6346 struct ofputil_bucket
*last
= NULL
;
6348 if (command_bucket_id
<= OFPG15_BUCKET_MAX
) {
6349 /* Check here to ensure that a bucket corresponding to
6350 * command_bucket_id exists in the old bucket list.
6352 * The subsequent search of below of new_ofgroup covers
6353 * both buckets in the old bucket list and buckets added
6354 * by the insert buckets group mod message this function processes. */
6355 if (!ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
)) {
6356 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
6359 if (!list_is_empty(&new_ofgroup
->buckets
)) {
6360 last
= ofputil_bucket_list_back(&new_ofgroup
->buckets
);
6364 ofputil_bucket_clone_list(&new_ofgroup
->buckets
, &ofgroup
->buckets
, NULL
);
6366 if (ofputil_bucket_check_duplicate_id(&ofgroup
->buckets
)) {
6367 VLOG_WARN_RL(&rl
, "Duplicate bucket id");
6368 return OFPERR_OFPGMFC_BUCKET_EXISTS
;
6371 /* Rearrange list according to command_bucket_id */
6372 if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
6373 struct ofputil_bucket
*new_first
;
6374 const struct ofputil_bucket
*first
;
6376 first
= ofputil_bucket_list_front(&ofgroup
->buckets
);
6377 new_first
= ofputil_bucket_find(&new_ofgroup
->buckets
,
6380 list_splice(new_ofgroup
->buckets
.next
, &new_first
->list_node
,
6381 &new_ofgroup
->buckets
);
6382 } else if (command_bucket_id
<= OFPG15_BUCKET_MAX
&& last
) {
6383 struct ofputil_bucket
*after
;
6385 /* Presence of bucket is checked above so after should never be NULL */
6386 after
= ofputil_bucket_find(&new_ofgroup
->buckets
, command_bucket_id
);
6388 list_splice(after
->list_node
.next
, new_ofgroup
->buckets
.next
,
6389 last
->list_node
.next
);
6395 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6396 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6397 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6398 * and OFPG15_BUCKET_ALL are also honored. */
6400 copy_buckets_for_remove_bucket(const struct ofgroup
*ofgroup
,
6401 struct ofgroup
*new_ofgroup
,
6402 uint32_t command_bucket_id
)
6404 const struct ofputil_bucket
*skip
= NULL
;
6406 if (command_bucket_id
== OFPG15_BUCKET_ALL
) {
6410 if (command_bucket_id
== OFPG15_BUCKET_FIRST
) {
6411 if (!list_is_empty(&ofgroup
->buckets
)) {
6412 skip
= ofputil_bucket_list_front(&ofgroup
->buckets
);
6414 } else if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
6415 if (!list_is_empty(&ofgroup
->buckets
)) {
6416 skip
= ofputil_bucket_list_back(&ofgroup
->buckets
);
6419 skip
= ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
);
6421 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
6425 ofputil_bucket_clone_list(&new_ofgroup
->buckets
, &ofgroup
->buckets
, skip
);
6430 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6431 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6434 * Note that the group is re-created and then replaces the old group in
6435 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6436 * the xlate module hold a pointer to the group. */
6438 modify_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
6440 struct ofgroup
*ofgroup
, *new_ofgroup
, *retiring
;
6443 error
= init_group(ofproto
, gm
, &new_ofgroup
);
6448 retiring
= new_ofgroup
;
6450 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6451 if (!ofproto_group_lookup__(ofproto
, gm
->group_id
, &ofgroup
)) {
6452 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
6456 /* Ofproto's group write lock is held now. */
6457 if (ofgroup
->type
!= gm
->type
6458 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
6459 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6463 /* Manipulate bucket list for bucket commands */
6464 if (gm
->command
== OFPGC15_INSERT_BUCKET
) {
6465 error
= copy_buckets_for_insert_bucket(ofgroup
, new_ofgroup
,
6466 gm
->command_bucket_id
);
6467 } else if (gm
->command
== OFPGC15_REMOVE_BUCKET
) {
6468 error
= copy_buckets_for_remove_bucket(ofgroup
, new_ofgroup
,
6469 gm
->command_bucket_id
);
6475 /* The group creation time does not change during modification. */
6476 *CONST_CAST(long long int *, &(new_ofgroup
->created
)) = ofgroup
->created
;
6477 *CONST_CAST(long long int *, &(new_ofgroup
->modified
)) = time_msec();
6479 error
= ofproto
->ofproto_class
->group_modify(new_ofgroup
);
6485 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6486 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
6487 hmap_insert(&ofproto
->groups
, &new_ofgroup
->hmap_node
,
6488 hash_int(new_ofgroup
->group_id
, 0));
6489 if (ofgroup
->type
!= new_ofgroup
->type
) {
6490 ofproto
->n_groups
[ofgroup
->type
]--;
6491 ofproto
->n_groups
[new_ofgroup
->type
]++;
6495 ofproto_group_unref(retiring
);
6496 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6501 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
6502 OVS_RELEASES(ofproto
->groups_rwlock
)
6505 struct ofputil_flow_mod fm
;
6507 /* Delete all flow entries containing this group in a group action */
6508 match_init_catchall(&match
);
6509 flow_mod_init(&fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
6510 fm
.delete_reason
= OFPRR_GROUP_DELETE
;
6511 fm
.out_group
= ofgroup
->group_id
;
6512 handle_flow_mod__(ofproto
, &fm
, NULL
);
6514 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
6515 /* No-one can find this group any more. */
6516 ofproto
->n_groups
[ofgroup
->type
]--;
6517 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6518 ofproto_group_unref(ofgroup
);
6521 /* Implements OFPGC11_DELETE. */
6523 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
6525 struct ofgroup
*ofgroup
;
6527 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6528 if (group_id
== OFPG_ALL
) {
6530 struct hmap_node
*node
= hmap_first(&ofproto
->groups
);
6534 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, hmap_node
);
6535 delete_group__(ofproto
, ofgroup
);
6536 /* Lock for each node separately, so that we will not jam the
6537 * other threads for too long time. */
6538 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6541 HMAP_FOR_EACH_IN_BUCKET (ofgroup
, hmap_node
,
6542 hash_int(group_id
, 0), &ofproto
->groups
) {
6543 if (ofgroup
->group_id
== group_id
) {
6544 delete_group__(ofproto
, ofgroup
);
6549 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6552 /* Delete all groups from 'ofproto'.
6554 * This is intended for use within an ofproto provider's 'destruct'
6557 ofproto_group_delete_all(struct ofproto
*ofproto
)
6559 delete_group(ofproto
, OFPG_ALL
);
6563 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6565 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6566 struct ofputil_group_mod gm
;
6569 error
= reject_slave_controller(ofconn
);
6574 error
= ofputil_decode_group_mod(oh
, &gm
);
6579 switch (gm
.command
) {
6581 return add_group(ofproto
, &gm
);
6583 case OFPGC11_MODIFY
:
6584 return modify_group(ofproto
, &gm
);
6586 case OFPGC11_DELETE
:
6587 delete_group(ofproto
, gm
.group_id
);
6590 case OFPGC15_INSERT_BUCKET
:
6591 return modify_group(ofproto
, &gm
);
6593 case OFPGC15_REMOVE_BUCKET
:
6594 return modify_group(ofproto
, &gm
);
6597 if (gm
.command
> OFPGC11_DELETE
) {
6598 VLOG_WARN_RL(&rl
, "%s: Invalid group_mod command type %d",
6599 ofproto
->name
, gm
.command
);
6601 return OFPERR_OFPGMFC_BAD_COMMAND
;
6605 enum ofputil_table_miss
6606 ofproto_table_get_miss_config(const struct ofproto
*ofproto
, uint8_t table_id
)
6608 enum ofputil_table_miss miss
;
6610 atomic_read_relaxed(&ofproto
->tables
[table_id
].miss_config
, &miss
);
6615 table_mod__(struct oftable
*oftable
,
6616 enum ofputil_table_miss miss
, enum ofputil_table_eviction eviction
)
6618 if (miss
== OFPUTIL_TABLE_MISS_DEFAULT
) {
6619 /* This is how an OFPT_TABLE_MOD decodes if it doesn't specify any
6620 * table-miss configuration (because the protocol used doesn't have
6621 * such a concept), so there's nothing to do. */
6623 atomic_store_relaxed(&oftable
->miss_config
, miss
);
6626 unsigned int new_eviction
= oftable
->eviction
;
6627 if (eviction
== OFPUTIL_TABLE_EVICTION_ON
) {
6628 new_eviction
|= EVICTION_OPENFLOW
;
6629 } else if (eviction
== OFPUTIL_TABLE_EVICTION_OFF
) {
6630 new_eviction
&= ~EVICTION_OPENFLOW
;
6633 if (new_eviction
!= oftable
->eviction
) {
6634 ovs_mutex_lock(&ofproto_mutex
);
6635 oftable_configure_eviction(oftable
, new_eviction
,
6636 oftable
->eviction_fields
,
6637 oftable
->n_eviction_fields
);
6638 ovs_mutex_unlock(&ofproto_mutex
);
6643 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
6645 if (!check_table_id(ofproto
, tm
->table_id
)) {
6646 return OFPERR_OFPTMFC_BAD_TABLE
;
6649 /* Don't allow the eviction flags to be changed (except to the only fixed
6650 * value that OVS supports). OF1.4 says this is normal: "The
6651 * OFPTMPT_EVICTION property usually cannot be modified using a
6652 * OFP_TABLE_MOD request, because the eviction mechanism is switch
6654 if (tm
->eviction_flags
!= UINT32_MAX
6655 && tm
->eviction_flags
!= OFPROTO_EVICTION_FLAGS
) {
6656 return OFPERR_OFPTMFC_BAD_CONFIG
;
6659 if (tm
->table_id
== OFPTT_ALL
) {
6660 struct oftable
*oftable
;
6661 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
6662 if (!(oftable
->flags
& (OFTABLE_HIDDEN
| OFTABLE_READONLY
))) {
6663 table_mod__(oftable
, tm
->miss
, tm
->eviction
);
6667 struct oftable
*oftable
= &ofproto
->tables
[tm
->table_id
];
6668 if (oftable
->flags
& OFTABLE_READONLY
) {
6669 return OFPERR_OFPTMFC_EPERM
;
6671 table_mod__(oftable
, tm
->miss
, tm
->eviction
);
6678 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6680 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6681 struct ofputil_table_mod tm
;
6684 error
= reject_slave_controller(ofconn
);
6689 error
= ofputil_decode_table_mod(oh
, &tm
);
6694 return table_mod(ofproto
, &tm
);
6698 do_bundle_flow_mod_start(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
6699 struct ofp_bundle_entry
*be
)
6700 OVS_REQUIRES(ofproto_mutex
)
6702 switch (fm
->command
) {
6704 return add_flow_start(ofproto
, fm
, &be
->old_rules
.stub
[0],
6705 &be
->new_rules
.stub
[0]);
6707 return modify_flows_start_loose(ofproto
, fm
, &be
->old_rules
,
6709 case OFPFC_MODIFY_STRICT
:
6710 return modify_flow_start_strict(ofproto
, fm
, &be
->old_rules
,
6713 return delete_flows_start_loose(ofproto
, fm
, &be
->old_rules
);
6715 case OFPFC_DELETE_STRICT
:
6716 return delete_flow_start_strict(ofproto
, fm
, &be
->old_rules
);
6719 return OFPERR_OFPFMFC_BAD_COMMAND
;
6723 do_bundle_flow_mod_revert(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
6724 struct ofp_bundle_entry
*be
)
6725 OVS_REQUIRES(ofproto_mutex
)
6727 switch (fm
->command
) {
6729 add_flow_revert(ofproto
, fm
, be
->old_rules
.stub
[0],
6730 be
->new_rules
.stub
[0]);
6734 case OFPFC_MODIFY_STRICT
:
6735 modify_flows_revert(ofproto
, fm
, &be
->old_rules
, &be
->new_rules
);
6739 case OFPFC_DELETE_STRICT
:
6740 delete_flows_revert(ofproto
, &be
->old_rules
);
6749 do_bundle_flow_mod_finish(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
6750 const struct flow_mod_requester
*req
,
6751 struct ofp_bundle_entry
*be
)
6752 OVS_REQUIRES(ofproto_mutex
)
6754 switch (fm
->command
) {
6756 add_flow_finish(ofproto
, fm
, req
, be
->old_rules
.stub
[0],
6757 be
->new_rules
.stub
[0]);
6761 case OFPFC_MODIFY_STRICT
:
6762 modify_flows_finish(ofproto
, fm
, req
, &be
->old_rules
, &be
->new_rules
);
6766 case OFPFC_DELETE_STRICT
:
6767 delete_flows_finish(ofproto
, fm
, req
, &be
->old_rules
);
6775 /* Commit phases (all while locking ofproto_mutex):
6777 * 1. Begin: Gather resources and make changes visible in the next version.
6778 * - Mark affected rules for removal in the next version.
6779 * - Create new replacement rules, make visible in the next
6781 * - Do not send any events or notifications.
6783 * 2. Revert: Fail if any errors are found. After this point no errors are
6784 * possible. No visible changes were made, so rollback is minimal (remove
6785 * added invisible rules, restore visibility of rules marked for removal).
6787 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
6788 * the ofproto provider. Remove replaced and deleted rules from ofproto data
6789 * structures, and Schedule postponed removal of deleted rules from the
6790 * classifier. Send notifications, buffered packets, etc.
6793 do_bundle_commit(struct ofconn
*ofconn
, uint32_t id
, uint16_t flags
)
6795 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6796 cls_version_t visible_version
= ofproto
->tables_version
;
6797 struct ofp_bundle
*bundle
;
6798 struct ofp_bundle_entry
*be
;
6801 bundle
= ofconn_get_bundle(ofconn
, id
);
6804 return OFPERR_OFPBFC_BAD_ID
;
6806 if (bundle
->flags
!= flags
) {
6807 error
= OFPERR_OFPBFC_BAD_FLAGS
;
6809 bool prev_is_port_mod
= false;
6812 ovs_mutex_lock(&ofproto_mutex
);
6815 LIST_FOR_EACH (be
, node
, &bundle
->msg_list
) {
6816 if (be
->type
== OFPTYPE_PORT_MOD
) {
6817 /* Our port mods are not atomic. */
6818 if (flags
& OFPBF_ATOMIC
) {
6819 error
= OFPERR_OFPBFC_MSG_FAILED
;
6821 prev_is_port_mod
= true;
6822 error
= port_mod_start(ofconn
, &be
->pm
, &be
->port
);
6824 } else if (be
->type
== OFPTYPE_FLOW_MOD
) {
6825 /* Flow mods between port mods are applied as a single
6826 * version, but the versions are published only after
6827 * we know the commit is successful. */
6828 if (prev_is_port_mod
) {
6829 ++ofproto
->tables_version
;
6831 prev_is_port_mod
= false;
6832 error
= do_bundle_flow_mod_start(ofproto
, &be
->fm
, be
);
6839 /* Store the version in which the changes should take
6841 be
->version
= ofproto
->tables_version
+ 1;
6846 /* Send error referring to the original message. */
6848 ofconn_send_error(ofconn
, be
->ofp_msg
, error
);
6849 error
= OFPERR_OFPBFC_MSG_FAILED
;
6852 /* 2. Revert. Undo all the changes made above. */
6853 LIST_FOR_EACH_REVERSE_CONTINUE(be
, node
, &bundle
->msg_list
) {
6854 if (be
->type
== OFPTYPE_FLOW_MOD
) {
6855 do_bundle_flow_mod_revert(ofproto
, &be
->fm
, be
);
6857 /* Nothing needs to be reverted for a port mod. */
6861 LIST_FOR_EACH (be
, node
, &bundle
->msg_list
) {
6862 /* Bump the lookup version to the one of the current message.
6863 * This makes all the changes in the bundle at this version
6864 * visible to lookups at once. */
6865 if (visible_version
< be
->version
) {
6866 visible_version
= be
->version
;
6867 ofproto
->ofproto_class
->set_tables_version(
6868 ofproto
, visible_version
);
6870 if (be
->type
== OFPTYPE_FLOW_MOD
) {
6871 struct flow_mod_requester req
= { ofconn
, be
->ofp_msg
};
6873 do_bundle_flow_mod_finish(ofproto
, &be
->fm
, &req
, be
);
6874 } else if (be
->type
== OFPTYPE_PORT_MOD
) {
6875 /* Perform the actual port mod. This is not atomic, i.e.,
6876 * the effects will be immediately seen by upcall
6877 * processing regardless of the lookup version. It should
6878 * be noted that port configuration changes can originate
6879 * also from OVSDB changes asynchronously to all upcall
6881 port_mod_finish(ofconn
, &be
->pm
, be
->port
);
6886 /* Reset the tables_version. */
6887 ofproto
->tables_version
= visible_version
;
6889 ofmonitor_flush(ofproto
->connmgr
);
6890 ovs_mutex_unlock(&ofproto_mutex
);
6892 run_rule_executes(ofproto
);
6895 /* The bundle is discarded regardless the outcome. */
6896 ofp_bundle_remove__(ofconn
, bundle
, !error
);
6901 handle_bundle_control(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6903 struct ofputil_bundle_ctrl_msg bctrl
;
6904 struct ofputil_bundle_ctrl_msg reply
;
6908 error
= reject_slave_controller(ofconn
);
6913 error
= ofputil_decode_bundle_ctrl(oh
, &bctrl
);
6918 reply
.bundle_id
= bctrl
.bundle_id
;
6920 switch (bctrl
.type
) {
6921 case OFPBCT_OPEN_REQUEST
:
6922 error
= ofp_bundle_open(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6923 reply
.type
= OFPBCT_OPEN_REPLY
;
6925 case OFPBCT_CLOSE_REQUEST
:
6926 error
= ofp_bundle_close(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6927 reply
.type
= OFPBCT_CLOSE_REPLY
;;
6929 case OFPBCT_COMMIT_REQUEST
:
6930 error
= do_bundle_commit(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6931 reply
.type
= OFPBCT_COMMIT_REPLY
;
6933 case OFPBCT_DISCARD_REQUEST
:
6934 error
= ofp_bundle_discard(ofconn
, bctrl
.bundle_id
);
6935 reply
.type
= OFPBCT_DISCARD_REPLY
;
6938 case OFPBCT_OPEN_REPLY
:
6939 case OFPBCT_CLOSE_REPLY
:
6940 case OFPBCT_COMMIT_REPLY
:
6941 case OFPBCT_DISCARD_REPLY
:
6942 return OFPERR_OFPBFC_BAD_TYPE
;
6947 buf
= ofputil_encode_bundle_ctrl_reply(oh
, &reply
);
6948 ofconn_send_reply(ofconn
, buf
);
6954 handle_bundle_add(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6956 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6958 struct ofputil_bundle_add_msg badd
;
6959 struct ofp_bundle_entry
*bmsg
;
6962 error
= reject_slave_controller(ofconn
);
6967 error
= ofputil_decode_bundle_add(oh
, &badd
, &type
);
6972 bmsg
= ofp_bundle_entry_alloc(type
, badd
.msg
);
6974 if (type
== OFPTYPE_PORT_MOD
) {
6975 error
= ofputil_decode_port_mod(badd
.msg
, &bmsg
->pm
, false);
6976 } else if (type
== OFPTYPE_FLOW_MOD
) {
6977 struct ofpbuf ofpacts
;
6978 uint64_t ofpacts_stub
[1024 / 8];
6980 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
6981 error
= ofputil_decode_flow_mod(&bmsg
->fm
, badd
.msg
,
6982 ofconn_get_protocol(ofconn
),
6984 u16_to_ofp(ofproto
->max_ports
),
6986 /* Move actions to heap. */
6987 bmsg
->fm
.ofpacts
= ofpbuf_steal_data(&ofpacts
);
6989 if (!error
&& bmsg
->fm
.ofpacts_len
) {
6990 error
= ofproto_check_ofpacts(ofproto
, bmsg
->fm
.ofpacts
,
6991 bmsg
->fm
.ofpacts_len
);
6998 error
= ofp_bundle_add_message(ofconn
, badd
.bundle_id
, badd
.flags
,
7003 ofp_bundle_entry_free(bmsg
);
7010 handle_geneve_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7012 struct ofputil_geneve_table_mod gtm
;
7015 error
= reject_slave_controller(ofconn
);
7020 error
= ofputil_decode_geneve_table_mod(oh
, >m
);
7025 error
= tun_metadata_table_mod(>m
);
7027 ofputil_uninit_geneve_table(>m
.mappings
);
7032 handle_geneve_table_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7034 struct ofputil_geneve_table_reply gtr
;
7037 tun_metadata_table_request(>r
);
7038 b
= ofputil_encode_geneve_table_reply(oh
, >r
);
7039 ofputil_uninit_geneve_table(>r
.mappings
);
7041 ofconn_send_reply(ofconn
, b
);
7046 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
7047 OVS_EXCLUDED(ofproto_mutex
)
7049 const struct ofp_header
*oh
= msg
->data
;
7053 error
= ofptype_decode(&type
, oh
);
7057 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
7058 && ofpmp_more(oh
)) {
7059 /* We have no buffer implementation for multipart requests.
7060 * Report overflow for requests which consists of multiple
7062 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
7066 /* OpenFlow requests. */
7067 case OFPTYPE_ECHO_REQUEST
:
7068 return handle_echo_request(ofconn
, oh
);
7070 case OFPTYPE_FEATURES_REQUEST
:
7071 return handle_features_request(ofconn
, oh
);
7073 case OFPTYPE_GET_CONFIG_REQUEST
:
7074 return handle_get_config_request(ofconn
, oh
);
7076 case OFPTYPE_SET_CONFIG
:
7077 return handle_set_config(ofconn
, oh
);
7079 case OFPTYPE_PACKET_OUT
:
7080 return handle_packet_out(ofconn
, oh
);
7082 case OFPTYPE_PORT_MOD
:
7083 return handle_port_mod(ofconn
, oh
);
7085 case OFPTYPE_FLOW_MOD
:
7086 return handle_flow_mod(ofconn
, oh
);
7088 case OFPTYPE_GROUP_MOD
:
7089 return handle_group_mod(ofconn
, oh
);
7091 case OFPTYPE_TABLE_MOD
:
7092 return handle_table_mod(ofconn
, oh
);
7094 case OFPTYPE_METER_MOD
:
7095 return handle_meter_mod(ofconn
, oh
);
7097 case OFPTYPE_BARRIER_REQUEST
:
7098 return handle_barrier_request(ofconn
, oh
);
7100 case OFPTYPE_ROLE_REQUEST
:
7101 return handle_role_request(ofconn
, oh
);
7103 /* OpenFlow replies. */
7104 case OFPTYPE_ECHO_REPLY
:
7107 /* Nicira extension requests. */
7108 case OFPTYPE_FLOW_MOD_TABLE_ID
:
7109 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
7111 case OFPTYPE_SET_FLOW_FORMAT
:
7112 return handle_nxt_set_flow_format(ofconn
, oh
);
7114 case OFPTYPE_SET_PACKET_IN_FORMAT
:
7115 return handle_nxt_set_packet_in_format(ofconn
, oh
);
7117 case OFPTYPE_SET_CONTROLLER_ID
:
7118 return handle_nxt_set_controller_id(ofconn
, oh
);
7120 case OFPTYPE_FLOW_AGE
:
7121 /* Nothing to do. */
7124 case OFPTYPE_FLOW_MONITOR_CANCEL
:
7125 return handle_flow_monitor_cancel(ofconn
, oh
);
7127 case OFPTYPE_SET_ASYNC_CONFIG
:
7128 return handle_nxt_set_async_config(ofconn
, oh
);
7130 case OFPTYPE_GET_ASYNC_REQUEST
:
7131 return handle_nxt_get_async_request(ofconn
, oh
);
7133 /* Statistics requests. */
7134 case OFPTYPE_DESC_STATS_REQUEST
:
7135 return handle_desc_stats_request(ofconn
, oh
);
7137 case OFPTYPE_FLOW_STATS_REQUEST
:
7138 return handle_flow_stats_request(ofconn
, oh
);
7140 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
7141 return handle_aggregate_stats_request(ofconn
, oh
);
7143 case OFPTYPE_TABLE_STATS_REQUEST
:
7144 return handle_table_stats_request(ofconn
, oh
);
7146 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
7147 return handle_table_features_request(ofconn
, oh
);
7149 case OFPTYPE_TABLE_DESC_REQUEST
:
7150 return handle_table_desc_request(ofconn
, oh
);
7152 case OFPTYPE_PORT_STATS_REQUEST
:
7153 return handle_port_stats_request(ofconn
, oh
);
7155 case OFPTYPE_QUEUE_STATS_REQUEST
:
7156 return handle_queue_stats_request(ofconn
, oh
);
7158 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
7159 return handle_port_desc_stats_request(ofconn
, oh
);
7161 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
7162 return handle_flow_monitor_request(ofconn
, oh
);
7164 case OFPTYPE_METER_STATS_REQUEST
:
7165 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
7166 return handle_meter_request(ofconn
, oh
, type
);
7168 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
7169 return handle_meter_features_request(ofconn
, oh
);
7171 case OFPTYPE_GROUP_STATS_REQUEST
:
7172 return handle_group_stats_request(ofconn
, oh
);
7174 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
7175 return handle_group_desc_stats_request(ofconn
, oh
);
7177 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
7178 return handle_group_features_stats_request(ofconn
, oh
);
7180 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
7181 return handle_queue_get_config_request(ofconn
, oh
);
7183 case OFPTYPE_BUNDLE_CONTROL
:
7184 return handle_bundle_control(ofconn
, oh
);
7186 case OFPTYPE_BUNDLE_ADD_MESSAGE
:
7187 return handle_bundle_add(ofconn
, oh
);
7189 case OFPTYPE_NXT_GENEVE_TABLE_MOD
:
7190 return handle_geneve_table_mod(ofconn
, oh
);
7192 case OFPTYPE_NXT_GENEVE_TABLE_REQUEST
:
7193 return handle_geneve_table_request(ofconn
, oh
);
7197 case OFPTYPE_FEATURES_REPLY
:
7198 case OFPTYPE_GET_CONFIG_REPLY
:
7199 case OFPTYPE_PACKET_IN
:
7200 case OFPTYPE_FLOW_REMOVED
:
7201 case OFPTYPE_PORT_STATUS
:
7202 case OFPTYPE_BARRIER_REPLY
:
7203 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
7204 case OFPTYPE_DESC_STATS_REPLY
:
7205 case OFPTYPE_FLOW_STATS_REPLY
:
7206 case OFPTYPE_QUEUE_STATS_REPLY
:
7207 case OFPTYPE_PORT_STATS_REPLY
:
7208 case OFPTYPE_TABLE_STATS_REPLY
:
7209 case OFPTYPE_AGGREGATE_STATS_REPLY
:
7210 case OFPTYPE_PORT_DESC_STATS_REPLY
:
7211 case OFPTYPE_ROLE_REPLY
:
7212 case OFPTYPE_FLOW_MONITOR_PAUSED
:
7213 case OFPTYPE_FLOW_MONITOR_RESUMED
:
7214 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
7215 case OFPTYPE_GET_ASYNC_REPLY
:
7216 case OFPTYPE_GROUP_STATS_REPLY
:
7217 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
7218 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
7219 case OFPTYPE_METER_STATS_REPLY
:
7220 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
7221 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
7222 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
7223 case OFPTYPE_TABLE_DESC_REPLY
:
7224 case OFPTYPE_ROLE_STATUS
:
7225 case OFPTYPE_NXT_GENEVE_TABLE_REPLY
:
7227 if (ofpmsg_is_stat_request(oh
)) {
7228 return OFPERR_OFPBRC_BAD_STAT
;
7230 return OFPERR_OFPBRC_BAD_TYPE
;
7236 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
7237 OVS_EXCLUDED(ofproto_mutex
)
7239 enum ofperr error
= handle_openflow__(ofconn
, ofp_msg
);
7242 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
7244 COVERAGE_INC(ofproto_recv_openflow
);
7247 /* Asynchronous operations. */
7250 send_buffered_packet(const struct flow_mod_requester
*req
, uint32_t buffer_id
,
7252 OVS_REQUIRES(ofproto_mutex
)
7254 if (req
&& req
->ofconn
&& buffer_id
!= UINT32_MAX
) {
7255 struct ofproto
*ofproto
= ofconn_get_ofproto(req
->ofconn
);
7256 struct dp_packet
*packet
;
7260 error
= ofconn_pktbuf_retrieve(req
->ofconn
, buffer_id
, &packet
,
7263 struct rule_execute
*re
;
7265 ofproto_rule_ref(rule
);
7267 re
= xmalloc(sizeof *re
);
7269 re
->in_port
= in_port
;
7270 re
->packet
= packet
;
7272 if (!guarded_list_push_back(&ofproto
->rule_executes
,
7273 &re
->list_node
, 1024)) {
7274 ofproto_rule_unref(rule
);
7275 dp_packet_delete(re
->packet
);
7279 ofconn_send_error(req
->ofconn
, req
->request
, error
);
7285 pick_datapath_id(const struct ofproto
*ofproto
)
7287 const struct ofport
*port
;
7289 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
7291 uint8_t ea
[ETH_ADDR_LEN
];
7294 error
= netdev_get_etheraddr(port
->netdev
, ea
);
7296 return eth_addr_to_uint64(ea
);
7298 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7299 ofproto
->name
, netdev_get_name(port
->netdev
),
7300 ovs_strerror(error
));
7302 return ofproto
->fallback_dpid
;
7306 pick_fallback_dpid(void)
7308 uint8_t ea
[ETH_ADDR_LEN
];
7309 eth_addr_nicira_random(ea
);
7310 return eth_addr_to_uint64(ea
);
7313 /* Table overflow policy. */
7315 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7316 * to NULL if the table is not configured to evict rules or if the table
7317 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7318 * or with no timeouts are not evictable.) */
7320 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
7321 OVS_REQUIRES(ofproto_mutex
)
7323 struct eviction_group
*evg
;
7326 if (!table
->eviction
) {
7330 /* In the common case, the outer and inner loops here will each be entered
7333 * - The inner loop normally "return"s in its first iteration. If the
7334 * eviction group has any evictable rules, then it always returns in
7337 * - The outer loop only iterates more than once if the largest eviction
7338 * group has no evictable rules.
7340 * - The outer loop can exit only if table's 'max_flows' is all filled up
7341 * by unevictable rules. */
7342 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
7345 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
7354 /* Eviction groups. */
7356 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7357 * rules. The priority contains low-order random bits to ensure that eviction
7358 * groups with the same number of rules are prioritized randomly. */
7360 eviction_group_priority(size_t n_rules
)
7362 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
7363 return (size
<< 16) | random_uint16();
7366 /* Updates 'evg', an eviction_group within 'table', following a change that
7367 * adds or removes rules in 'evg'. */
7369 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
7370 OVS_REQUIRES(ofproto_mutex
)
7372 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
7373 eviction_group_priority(heap_count(&evg
->rules
)));
7376 /* Destroys 'evg', an eviction_group within 'table':
7378 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7379 * rules themselves, just removes them from the eviction group.)
7381 * - Removes 'evg' from 'table'.
7385 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
7386 OVS_REQUIRES(ofproto_mutex
)
7388 while (!heap_is_empty(&evg
->rules
)) {
7391 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
7392 rule
->eviction_group
= NULL
;
7394 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
7395 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
7396 heap_destroy(&evg
->rules
);
7400 /* Removes 'rule' from its eviction group, if any. */
7402 eviction_group_remove_rule(struct rule
*rule
)
7403 OVS_REQUIRES(ofproto_mutex
)
7405 if (rule
->eviction_group
) {
7406 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
7407 struct eviction_group
*evg
= rule
->eviction_group
;
7409 rule
->eviction_group
= NULL
;
7410 heap_remove(&evg
->rules
, &rule
->evg_node
);
7411 if (heap_is_empty(&evg
->rules
)) {
7412 eviction_group_destroy(table
, evg
);
7414 eviction_group_resized(table
, evg
);
7419 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7420 * returns the hash value. */
7422 eviction_group_hash_rule(struct rule
*rule
)
7423 OVS_REQUIRES(ofproto_mutex
)
7425 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
7426 const struct mf_subfield
*sf
;
7430 hash
= table
->eviction_group_id_basis
;
7431 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
7432 for (sf
= table
->eviction_fields
;
7433 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
7436 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
7437 union mf_value value
;
7439 mf_get_value(sf
->field
, &flow
, &value
);
7441 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
7443 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
7444 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
7445 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
7446 sf
->field
->n_bytes
* 8 - start
);
7448 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
7450 hash
= hash_int(hash
, 0);
7457 /* Returns an eviction group within 'table' with the given 'id', creating one
7459 static struct eviction_group
*
7460 eviction_group_find(struct oftable
*table
, uint32_t id
)
7461 OVS_REQUIRES(ofproto_mutex
)
7463 struct eviction_group
*evg
;
7465 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
7469 evg
= xmalloc(sizeof *evg
);
7470 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
7471 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
7472 eviction_group_priority(0));
7473 heap_init(&evg
->rules
);
7478 /* Returns an eviction priority for 'rule'. The return value should be
7479 * interpreted so that higher priorities make a rule a more attractive
7480 * candidate for eviction. */
7482 rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*rule
)
7483 OVS_REQUIRES(ofproto_mutex
)
7485 /* Calculate absolute time when this flow will expire. If it will never
7486 * expire, then return 0 to make it unevictable. */
7487 long long int expiration
= LLONG_MAX
;
7488 if (rule
->hard_timeout
) {
7489 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7490 ovs_mutex_lock(&rule
->mutex
);
7491 long long int modified
= rule
->modified
;
7492 ovs_mutex_unlock(&rule
->mutex
);
7494 expiration
= modified
+ rule
->hard_timeout
* 1000;
7496 if (rule
->idle_timeout
) {
7497 uint64_t packets
, bytes
;
7499 long long int idle_expiration
;
7501 ofproto
->ofproto_class
->rule_get_stats(rule
, &packets
, &bytes
, &used
);
7502 idle_expiration
= used
+ rule
->idle_timeout
* 1000;
7503 expiration
= MIN(expiration
, idle_expiration
);
7505 if (expiration
== LLONG_MAX
) {
7509 /* Calculate the time of expiration as a number of (approximate) seconds
7510 * after program startup.
7512 * This should work OK for program runs that last UINT32_MAX seconds or
7513 * less. Therefore, please restart OVS at least once every 136 years. */
7514 uint32_t expiration_ofs
= (expiration
>> 10) - (time_boot_msec() >> 10);
7516 /* Combine expiration time with OpenFlow "importance" to form a single
7517 * priority value. We want flows with relatively low "importance" to be
7518 * evicted before even considering expiration time, so put "importance" in
7519 * the most significant bits and expiration time in the least significant
7522 * Small 'priority' should be evicted before those with large 'priority'.
7523 * The caller expects the opposite convention (a large return value being
7524 * more attractive for eviction) so we invert it before returning. */
7525 uint64_t priority
= ((uint64_t) rule
->importance
<< 32) + expiration_ofs
;
7526 return UINT64_MAX
- priority
;
7529 /* Adds 'rule' to an appropriate eviction group for its oftable's
7530 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7531 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7534 * The caller must ensure that 'rule' is not already in an eviction group. */
7536 eviction_group_add_rule(struct rule
*rule
)
7537 OVS_REQUIRES(ofproto_mutex
)
7539 struct ofproto
*ofproto
= rule
->ofproto
;
7540 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
7543 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7544 * so no additional protection is needed. */
7545 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
7547 if (table
->eviction
&& has_timeout
) {
7548 struct eviction_group
*evg
;
7550 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
7552 rule
->eviction_group
= evg
;
7553 heap_insert(&evg
->rules
, &rule
->evg_node
,
7554 rule_eviction_priority(ofproto
, rule
));
7555 eviction_group_resized(table
, evg
);
7561 /* Initializes 'table'. */
7563 oftable_init(struct oftable
*table
)
7565 memset(table
, 0, sizeof *table
);
7566 classifier_init(&table
->cls
, flow_segment_u64s
);
7567 table
->max_flows
= UINT_MAX
;
7569 hmap_init(&table
->eviction_groups_by_id
);
7570 heap_init(&table
->eviction_groups_by_size
);
7571 atomic_init(&table
->miss_config
, OFPUTIL_TABLE_MISS_DEFAULT
);
7573 classifier_set_prefix_fields(&table
->cls
, default_prefix_fields
,
7574 ARRAY_SIZE(default_prefix_fields
));
7576 atomic_init(&table
->n_matched
, 0);
7577 atomic_init(&table
->n_missed
, 0);
7580 /* Destroys 'table', including its classifier and eviction groups.
7582 * The caller is responsible for freeing 'table' itself. */
7584 oftable_destroy(struct oftable
*table
)
7586 ovs_assert(classifier_is_empty(&table
->cls
));
7588 ovs_mutex_lock(&ofproto_mutex
);
7589 oftable_configure_eviction(table
, 0, NULL
, 0);
7590 ovs_mutex_unlock(&ofproto_mutex
);
7592 hmap_destroy(&table
->eviction_groups_by_id
);
7593 heap_destroy(&table
->eviction_groups_by_size
);
7594 classifier_destroy(&table
->cls
);
7598 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7599 * string, then 'table' will use its default name.
7601 * This only affects the name exposed for a table exposed through the OpenFlow
7602 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7604 oftable_set_name(struct oftable
*table
, const char *name
)
7606 if (name
&& name
[0]) {
7607 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
7608 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
7610 table
->name
= xmemdup0(name
, len
);
7618 /* oftables support a choice of two policies when adding a rule would cause the
7619 * number of flows in the table to exceed the configured maximum number: either
7620 * they can refuse to add the new flow or they can evict some existing flow.
7621 * This function configures the latter policy on 'table', with fairness based
7622 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7623 * 'n_fields' as 0 disables fairness.) */
7625 oftable_configure_eviction(struct oftable
*table
, unsigned int eviction
,
7626 const struct mf_subfield
*fields
, size_t n_fields
)
7627 OVS_REQUIRES(ofproto_mutex
)
7631 if ((table
->eviction
!= 0) == (eviction
!= 0)
7632 && n_fields
== table
->n_eviction_fields
7634 || !memcmp(fields
, table
->eviction_fields
,
7635 n_fields
* sizeof *fields
))) {
7636 /* The set of eviction fields did not change. If 'eviction' changed,
7637 * it remains nonzero, so that we can just update table->eviction
7638 * without fussing with the eviction groups. */
7639 table
->eviction
= eviction
;
7643 /* Destroy existing eviction groups, then destroy and recreate data
7644 * structures to recover memory. */
7645 struct eviction_group
*evg
, *next
;
7646 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
, &table
->eviction_groups_by_id
) {
7647 eviction_group_destroy(table
, evg
);
7649 hmap_destroy(&table
->eviction_groups_by_id
);
7650 hmap_init(&table
->eviction_groups_by_id
);
7651 heap_destroy(&table
->eviction_groups_by_size
);
7652 heap_init(&table
->eviction_groups_by_size
);
7654 /* Replace eviction groups by the new ones, if there is a change. Free the
7655 * old fields only after allocating the new ones, because 'fields ==
7656 * table->eviction_fields' is possible. */
7657 struct mf_subfield
*old_fields
= table
->eviction_fields
;
7658 table
->n_eviction_fields
= n_fields
;
7659 table
->eviction_fields
= (fields
7660 ? xmemdup(fields
, n_fields
* sizeof *fields
)
7664 /* Add the new eviction groups, if enabled. */
7665 table
->eviction
= eviction
;
7666 if (table
->eviction
) {
7667 table
->eviction_group_id_basis
= random_uint32();
7668 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
7669 eviction_group_add_rule(rule
);
7674 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7675 * it to the classifier. */
7677 ofproto_rule_insert__(struct ofproto
*ofproto
, struct rule
*rule
)
7678 OVS_REQUIRES(ofproto_mutex
)
7680 const struct rule_actions
*actions
= rule_get_actions(rule
);
7682 ovs_assert(rule
->removed
);
7684 if (rule
->hard_timeout
|| rule
->idle_timeout
) {
7685 list_insert(&ofproto
->expirable
, &rule
->expirable
);
7687 cookies_insert(ofproto
, rule
);
7688 eviction_group_add_rule(rule
);
7689 if (actions
->has_meter
) {
7690 meter_insert_rule(rule
);
7692 rule
->removed
= false;
7695 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7696 * the removal from the classifier. */
7698 ofproto_rule_remove__(struct ofproto
*ofproto
, struct rule
*rule
)
7699 OVS_REQUIRES(ofproto_mutex
)
7701 ovs_assert(!rule
->removed
);
7703 cookies_remove(ofproto
, rule
);
7705 eviction_group_remove_rule(rule
);
7706 if (!list_is_empty(&rule
->expirable
)) {
7707 list_remove(&rule
->expirable
);
7709 if (!list_is_empty(&rule
->meter_list_node
)) {
7710 list_remove(&rule
->meter_list_node
);
7711 list_init(&rule
->meter_list_node
);
7714 rule
->removed
= true;
7717 /* unixctl commands. */
7720 ofproto_lookup(const char *name
)
7722 struct ofproto
*ofproto
;
7724 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
7726 if (!strcmp(ofproto
->name
, name
)) {
7734 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
7735 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
7737 struct ofproto
*ofproto
;
7741 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
7742 ds_put_format(&results
, "%s\n", ofproto
->name
);
7744 unixctl_command_reply(conn
, ds_cstr(&results
));
7745 ds_destroy(&results
);
7749 ofproto_unixctl_init(void)
7751 static bool registered
;
7757 unixctl_command_register("ofproto/list", "", 0, 0,
7758 ofproto_unixctl_list
, NULL
);
7761 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7763 * This is deprecated. It is only for compatibility with broken device drivers
7764 * in old versions of Linux that do not properly support VLANs when VLAN
7765 * devices are not used. When broken device drivers are no longer in
7766 * widespread use, we will delete these interfaces. */
7768 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7769 * (exactly) by an OpenFlow rule in 'ofproto'. */
7771 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
7774 struct cls_rule target
;
7775 const struct oftable
*oftable
;
7777 match_init_catchall(&match
);
7778 match_set_vlan_vid_masked(&match
, htons(VLAN_CFI
), htons(VLAN_CFI
));
7779 cls_rule_init(&target
, &match
, 0, CLS_MAX_VERSION
);
7781 free(ofproto
->vlan_bitmap
);
7782 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
7783 ofproto
->vlans_changed
= false;
7785 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
7788 CLS_FOR_EACH_TARGET (rule
, cr
, &oftable
->cls
, &target
) {
7789 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
7790 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
7792 bitmap_set1(vlan_bitmap
, vid
);
7793 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
7798 cls_rule_destroy(&target
);
7801 /* Returns true if new VLANs have come into use by the flow table since the
7802 * last call to ofproto_get_vlan_usage().
7804 * We don't track when old VLANs stop being used. */
7806 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
7808 return ofproto
->vlans_changed
;
7811 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7812 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7813 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7814 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7815 * then the VLAN device is un-enslaved. */
7817 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
7818 ofp_port_t realdev_ofp_port
, int vid
)
7820 struct ofport
*ofport
;
7823 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
7825 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
7827 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
7828 ofproto
->name
, vlandev_ofp_port
);
7832 if (!ofproto
->ofproto_class
->set_realdev
) {
7833 if (!vlandev_ofp_port
) {
7836 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
7840 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
7842 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
7843 ofproto
->name
, vlandev_ofp_port
,
7844 netdev_get_name(ofport
->netdev
), ovs_strerror(error
));