2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
50 #include "poll-loop.h"
58 #include "unaligned.h"
63 VLOG_DEFINE_THIS_MODULE(ofproto
);
65 COVERAGE_DEFINE(ofproto_flush
);
66 COVERAGE_DEFINE(ofproto_packet_out
);
67 COVERAGE_DEFINE(ofproto_queue_req
);
68 COVERAGE_DEFINE(ofproto_recv_openflow
);
69 COVERAGE_DEFINE(ofproto_reinit_ports
);
70 COVERAGE_DEFINE(ofproto_update_port
);
72 /* Default fields to use for prefix tries in each flow table, unless something
73 * else is configured. */
74 const enum mf_field_id default_prefix_fields
[2] =
75 { MFF_IPV4_DST
, MFF_IPV4_SRC
};
78 static void oftable_init(struct oftable
*);
79 static void oftable_destroy(struct oftable
*);
81 static void oftable_set_name(struct oftable
*, const char *name
);
83 static enum ofperr
evict_rules_from_table(struct oftable
*,
84 unsigned int extra_space
)
85 OVS_REQUIRES(ofproto_mutex
);
86 static void oftable_disable_eviction(struct oftable
*);
87 static void oftable_enable_eviction(struct oftable
*,
88 const struct mf_subfield
*fields
,
91 static void oftable_remove_rule(struct rule
*rule
) OVS_REQUIRES(ofproto_mutex
);
92 static void oftable_remove_rule__(struct ofproto
*, struct rule
*)
93 OVS_REQUIRES(ofproto_mutex
);
95 /* A set of rules within a single OpenFlow table (oftable) that have the same
96 * values for the oftable's eviction_fields. A rule to be evicted, when one is
97 * needed, is taken from the eviction group that contains the greatest number
100 * An oftable owns any number of eviction groups, each of which contains any
103 * Membership in an eviction group is imprecise, based on the hash of the
104 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
105 * That is, if two rules have different eviction_fields, but those
106 * eviction_fields hash to the same value, then they will belong to the same
107 * eviction_group anyway.
109 * (When eviction is not enabled on an oftable, we don't track any eviction
110 * groups, to save time and space.) */
111 struct eviction_group
{
112 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
113 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
114 struct heap rules
; /* Contains "struct rule"s. */
117 static bool choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
118 OVS_REQUIRES(ofproto_mutex
);
119 static uint32_t rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*)
120 OVS_REQUIRES(ofproto_mutex
);;
121 static void eviction_group_add_rule(struct rule
*)
122 OVS_REQUIRES(ofproto_mutex
);
123 static void eviction_group_remove_rule(struct rule
*)
124 OVS_REQUIRES(ofproto_mutex
);
126 /* Criteria that flow_mod and other operations use for selecting rules on
127 * which to operate. */
128 struct rule_criteria
{
129 /* An OpenFlow table or 255 for all tables. */
132 /* OpenFlow matching criteria. Interpreted different in "loose" way by
133 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
134 * defined in the OpenFlow spec. */
137 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
138 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
139 * The rule will not be selected if M is 1 and B != C. */
141 ovs_be64 cookie_mask
;
143 /* Selection based on actions within a rule:
145 * If out_port != OFPP_ANY, selects only rules that output to out_port.
146 * If out_group != OFPG_ALL, select only rules that output to out_group. */
150 /* If true, collects only rules that are modifiable. */
152 bool include_readonly
;
155 static void rule_criteria_init(struct rule_criteria
*, uint8_t table_id
,
156 const struct match
*match
, int priority
,
157 ovs_be64 cookie
, ovs_be64 cookie_mask
,
158 ofp_port_t out_port
, uint32_t out_group
);
159 static void rule_criteria_require_rw(struct rule_criteria
*,
160 bool can_write_readonly
);
161 static void rule_criteria_destroy(struct rule_criteria
*);
163 static enum ofperr
collect_rules_loose(struct ofproto
*,
164 const struct rule_criteria
*,
165 struct rule_collection
*);
167 /* A packet that needs to be passed to rule_execute().
169 * (We can't do this immediately from ofopgroup_complete() because that holds
170 * ofproto_mutex, which rule_execute() needs released.) */
171 struct rule_execute
{
172 struct list list_node
; /* In struct ofproto's "rule_executes" list. */
173 struct rule
*rule
; /* Owns a reference to the rule. */
175 struct ofpbuf
*packet
; /* Owns the packet. */
178 static void run_rule_executes(struct ofproto
*) OVS_EXCLUDED(ofproto_mutex
);
179 static void destroy_rule_executes(struct ofproto
*);
181 struct learned_cookie
{
183 /* In struct ofproto's 'learned_cookies' hmap. */
184 struct hmap_node hmap_node
OVS_GUARDED_BY(ofproto_mutex
);
186 /* In 'dead_cookies' list when removed from hmap. */
187 struct list list_node
;
191 ovs_be64 cookie
OVS_GUARDED_BY(ofproto_mutex
);
192 uint8_t table_id
OVS_GUARDED_BY(ofproto_mutex
);
194 /* Number of references from "learn" actions.
196 * When this drops to 0, all of the flows in 'table_id' with the specified
197 * 'cookie' are deleted. */
198 int n
OVS_GUARDED_BY(ofproto_mutex
);
201 static const struct ofpact_learn
*next_learn_with_delete(
202 const struct rule_actions
*, const struct ofpact_learn
*start
);
204 static void learned_cookies_inc(struct ofproto
*, const struct rule_actions
*)
205 OVS_REQUIRES(ofproto_mutex
);
206 static void learned_cookies_dec(struct ofproto
*, const struct rule_actions
*,
207 struct list
*dead_cookies
)
208 OVS_REQUIRES(ofproto_mutex
);
209 static void learned_cookies_flush(struct ofproto
*, struct list
*dead_cookies
)
210 OVS_REQUIRES(ofproto_mutex
);
213 static void ofport_destroy__(struct ofport
*) OVS_EXCLUDED(ofproto_mutex
);
214 static void ofport_destroy(struct ofport
*);
216 static void update_port(struct ofproto
*, const char *devname
);
217 static int init_ports(struct ofproto
*);
218 static void reinit_ports(struct ofproto
*);
220 static long long int ofport_get_usage(const struct ofproto
*,
221 ofp_port_t ofp_port
);
222 static void ofport_set_usage(struct ofproto
*, ofp_port_t ofp_port
,
223 long long int last_used
);
224 static void ofport_remove_usage(struct ofproto
*, ofp_port_t ofp_port
);
228 * Keeps track of the currently used and recently used ofport values and is
229 * used to prevent immediate recycling of ofport values. */
230 struct ofport_usage
{
231 struct hmap_node hmap_node
; /* In struct ofproto's "ofport_usage" hmap. */
232 ofp_port_t ofp_port
; /* OpenFlow port number. */
233 long long int last_used
; /* Last time the 'ofp_port' was used. LLONG_MAX
234 represents in-use ofports. */
238 static void ofproto_rule_send_removed(struct rule
*, uint8_t reason
);
239 static bool rule_is_readonly(const struct rule
*);
241 /* The source of a flow_mod request, in the code that processes flow_mods.
243 * A flow table modification request can be generated externally, via OpenFlow,
244 * or internally through a function call. This structure indicates the source
245 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
246 * meaningful and thus supplied as NULL. */
247 struct flow_mod_requester
{
248 struct ofconn
*ofconn
; /* Connection on which flow_mod arrived. */
249 ovs_be32 xid
; /* OpenFlow xid of flow_mod request. */
253 static enum ofperr
add_flow(struct ofproto
*, struct ofputil_flow_mod
*,
254 const struct flow_mod_requester
*);
256 static enum ofperr
modify_flows__(struct ofproto
*, struct ofputil_flow_mod
*,
257 const struct rule_collection
*,
258 const struct flow_mod_requester
*);
259 static void delete_flows__(const struct rule_collection
*,
260 enum ofp_flow_removed_reason
,
261 const struct flow_mod_requester
*)
262 OVS_REQUIRES(ofproto_mutex
);
264 static enum ofperr
send_buffered_packet(struct ofconn
*, uint32_t buffer_id
,
266 OVS_REQUIRES(ofproto_mutex
);
268 static bool ofproto_group_exists__(const struct ofproto
*ofproto
,
270 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
);
271 static bool ofproto_group_exists(const struct ofproto
*ofproto
,
273 OVS_EXCLUDED(ofproto
->groups_rwlock
);
274 static enum ofperr
add_group(struct ofproto
*, struct ofputil_group_mod
*);
275 static void handle_openflow(struct ofconn
*, const struct ofpbuf
*);
276 static enum ofperr
handle_flow_mod__(struct ofproto
*,
277 struct ofputil_flow_mod
*,
278 const struct flow_mod_requester
*)
279 OVS_EXCLUDED(ofproto_mutex
);
280 static void calc_duration(long long int start
, long long int now
,
281 uint32_t *sec
, uint32_t *nsec
);
284 static uint64_t pick_datapath_id(const struct ofproto
*);
285 static uint64_t pick_fallback_dpid(void);
286 static void ofproto_destroy__(struct ofproto
*);
287 static void update_mtu(struct ofproto
*, struct ofport
*);
288 static void meter_delete(struct ofproto
*, uint32_t first
, uint32_t last
);
289 static void meter_insert_rule(struct rule
*);
292 static void ofproto_unixctl_init(void);
294 /* All registered ofproto classes, in probe order. */
295 static const struct ofproto_class
**ofproto_classes
;
296 static size_t n_ofproto_classes
;
297 static size_t allocated_ofproto_classes
;
299 /* Global lock that protects all flow table operations. */
300 struct ovs_mutex ofproto_mutex
= OVS_MUTEX_INITIALIZER
;
302 unsigned ofproto_flow_limit
= OFPROTO_FLOW_LIMIT_DEFAULT
;
303 unsigned ofproto_max_idle
= OFPROTO_MAX_IDLE_DEFAULT
;
305 size_t n_handlers
, n_revalidators
;
309 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
310 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
312 /* Initial mappings of port to OpenFlow number mappings. */
313 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
315 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
317 /* The default value of true waits for flow restore. */
318 static bool flow_restore_wait
= true;
320 /* Must be called to initialize the ofproto library.
322 * The caller may pass in 'iface_hints', which contains an shash of
323 * "iface_hint" elements indexed by the interface's name. The provider
324 * may use these hints to describe the startup configuration in order to
325 * reinitialize its state. The caller owns the provided data, so a
326 * provider will make copies of anything required. An ofproto provider
327 * will remove any existing state that is not described by the hint, and
328 * may choose to remove it all. */
330 ofproto_init(const struct shash
*iface_hints
)
332 struct shash_node
*node
;
335 ofproto_class_register(&ofproto_dpif_class
);
337 /* Make a local copy, since we don't own 'iface_hints' elements. */
338 SHASH_FOR_EACH(node
, iface_hints
) {
339 const struct iface_hint
*orig_hint
= node
->data
;
340 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
341 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
343 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
344 new_hint
->br_type
= xstrdup(br_type
);
345 new_hint
->ofp_port
= orig_hint
->ofp_port
;
347 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
350 for (i
= 0; i
< n_ofproto_classes
; i
++) {
351 ofproto_classes
[i
]->init(&init_ofp_ports
);
355 /* 'type' should be a normalized datapath type, as returned by
356 * ofproto_normalize_type(). Returns the corresponding ofproto_class
357 * structure, or a null pointer if there is none registered for 'type'. */
358 static const struct ofproto_class
*
359 ofproto_class_find__(const char *type
)
363 for (i
= 0; i
< n_ofproto_classes
; i
++) {
364 const struct ofproto_class
*class = ofproto_classes
[i
];
369 class->enumerate_types(&types
);
370 found
= sset_contains(&types
, type
);
371 sset_destroy(&types
);
377 VLOG_WARN("unknown datapath type %s", type
);
381 /* Registers a new ofproto class. After successful registration, new ofprotos
382 * of that type can be created using ofproto_create(). */
384 ofproto_class_register(const struct ofproto_class
*new_class
)
388 for (i
= 0; i
< n_ofproto_classes
; i
++) {
389 if (ofproto_classes
[i
] == new_class
) {
394 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
395 ofproto_classes
= x2nrealloc(ofproto_classes
,
396 &allocated_ofproto_classes
,
397 sizeof *ofproto_classes
);
399 ofproto_classes
[n_ofproto_classes
++] = new_class
;
403 /* Unregisters a datapath provider. 'type' must have been previously
404 * registered and not currently be in use by any ofprotos. After
405 * unregistration new datapaths of that type cannot be opened using
406 * ofproto_create(). */
408 ofproto_class_unregister(const struct ofproto_class
*class)
412 for (i
= 0; i
< n_ofproto_classes
; i
++) {
413 if (ofproto_classes
[i
] == class) {
414 for (i
++; i
< n_ofproto_classes
; i
++) {
415 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
421 VLOG_WARN("attempted to unregister an ofproto class that is not "
426 /* Clears 'types' and enumerates all registered ofproto types into it. The
427 * caller must first initialize the sset. */
429 ofproto_enumerate_types(struct sset
*types
)
434 for (i
= 0; i
< n_ofproto_classes
; i
++) {
435 ofproto_classes
[i
]->enumerate_types(types
);
439 /* Returns the fully spelled out name for the given ofproto 'type'.
441 * Normalized type string can be compared with strcmp(). Unnormalized type
442 * string might be the same even if they have different spellings. */
444 ofproto_normalize_type(const char *type
)
446 return type
&& type
[0] ? type
: "system";
449 /* Clears 'names' and enumerates the names of all known created ofprotos with
450 * the given 'type'. The caller must first initialize the sset. Returns 0 if
451 * successful, otherwise a positive errno value.
453 * Some kinds of datapaths might not be practically enumerable. This is not
454 * considered an error. */
456 ofproto_enumerate_names(const char *type
, struct sset
*names
)
458 const struct ofproto_class
*class = ofproto_class_find__(type
);
459 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
463 ofproto_create(const char *datapath_name
, const char *datapath_type
,
464 struct ofproto
**ofprotop
)
466 const struct ofproto_class
*class;
467 struct ofproto
*ofproto
;
473 ofproto_unixctl_init();
475 datapath_type
= ofproto_normalize_type(datapath_type
);
476 class = ofproto_class_find__(datapath_type
);
478 VLOG_WARN("could not create datapath %s of unknown type %s",
479 datapath_name
, datapath_type
);
483 ofproto
= class->alloc();
485 VLOG_ERR("failed to allocate datapath %s of type %s",
486 datapath_name
, datapath_type
);
491 ovs_mutex_lock(&ofproto_mutex
);
492 memset(ofproto
, 0, sizeof *ofproto
);
493 ofproto
->ofproto_class
= class;
494 ofproto
->name
= xstrdup(datapath_name
);
495 ofproto
->type
= xstrdup(datapath_type
);
496 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
497 hash_string(ofproto
->name
, 0));
498 ofproto
->datapath_id
= 0;
499 ofproto
->forward_bpdu
= false;
500 ofproto
->fallback_dpid
= pick_fallback_dpid();
501 ofproto
->mfr_desc
= NULL
;
502 ofproto
->hw_desc
= NULL
;
503 ofproto
->sw_desc
= NULL
;
504 ofproto
->serial_desc
= NULL
;
505 ofproto
->dp_desc
= NULL
;
506 ofproto
->frag_handling
= OFPC_FRAG_NORMAL
;
507 hmap_init(&ofproto
->ports
);
508 hmap_init(&ofproto
->ofport_usage
);
509 shash_init(&ofproto
->port_by_name
);
510 simap_init(&ofproto
->ofp_requests
);
511 ofproto
->max_ports
= ofp_to_u16(OFPP_MAX
);
512 ofproto
->eviction_group_timer
= LLONG_MIN
;
513 ofproto
->tables
= NULL
;
514 ofproto
->n_tables
= 0;
515 hindex_init(&ofproto
->cookies
);
516 hmap_init(&ofproto
->learned_cookies
);
517 list_init(&ofproto
->expirable
);
518 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
519 guarded_list_init(&ofproto
->rule_executes
);
520 ofproto
->vlan_bitmap
= NULL
;
521 ofproto
->vlans_changed
= false;
522 ofproto
->min_mtu
= INT_MAX
;
523 ovs_rwlock_init(&ofproto
->groups_rwlock
);
524 hmap_init(&ofproto
->groups
);
525 ovs_mutex_unlock(&ofproto_mutex
);
526 ofproto
->ogf
.capabilities
= OFPGFC_CHAINING
| OFPGFC_SELECT_LIVENESS
|
527 OFPGFC_SELECT_WEIGHT
;
528 for (i
= 0; i
< 4; i
++) {
529 ofproto
->ogf
.max_groups
[i
] = OFPG_MAX
;
530 ofproto
->ogf
.ofpacts
[i
] = (UINT64_C(1) << N_OFPACTS
) - 1;
533 error
= ofproto
->ofproto_class
->construct(ofproto
);
535 VLOG_ERR("failed to open datapath %s: %s",
536 datapath_name
, ovs_strerror(error
));
537 connmgr_destroy(ofproto
->connmgr
);
538 ofproto_destroy__(ofproto
);
542 /* Check that hidden tables, if any, are at the end. */
543 ovs_assert(ofproto
->n_tables
);
544 for (i
= 0; i
+ 1 < ofproto
->n_tables
; i
++) {
545 enum oftable_flags flags
= ofproto
->tables
[i
].flags
;
546 enum oftable_flags next_flags
= ofproto
->tables
[i
+ 1].flags
;
548 ovs_assert(!(flags
& OFTABLE_HIDDEN
) || next_flags
& OFTABLE_HIDDEN
);
551 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
554 /* Initialize meters table. */
555 if (ofproto
->ofproto_class
->meter_get_features
) {
556 ofproto
->ofproto_class
->meter_get_features(ofproto
,
557 &ofproto
->meter_features
);
559 memset(&ofproto
->meter_features
, 0, sizeof ofproto
->meter_features
);
561 ofproto
->meters
= xzalloc((ofproto
->meter_features
.max_meters
+ 1)
562 * sizeof(struct meter
*));
568 /* Must be called (only) by an ofproto implementation in its constructor
569 * function. See the large comment on 'construct' in struct ofproto_class for
572 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
574 struct oftable
*table
;
576 ovs_assert(!ofproto
->n_tables
);
577 ovs_assert(n_tables
>= 1 && n_tables
<= 255);
579 ofproto
->n_tables
= n_tables
;
580 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
581 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
586 /* To be optionally called (only) by an ofproto implementation in its
587 * constructor function. See the large comment on 'construct' in struct
588 * ofproto_class for details.
590 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
591 * will then ensure that actions passed into the ofproto implementation will
592 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
593 * function is not called, there will be no such restriction.
595 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
596 * the 'max_ports' restriction. */
598 ofproto_init_max_ports(struct ofproto
*ofproto
, uint16_t max_ports
)
600 ovs_assert(max_ports
<= ofp_to_u16(OFPP_MAX
));
601 ofproto
->max_ports
= max_ports
;
605 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
607 return ofproto
->datapath_id
;
611 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
613 uint64_t old_dpid
= p
->datapath_id
;
614 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
615 if (p
->datapath_id
!= old_dpid
) {
616 /* Force all active connections to reconnect, since there is no way to
617 * notify a controller that the datapath ID has changed. */
618 ofproto_reconnect_controllers(p
);
623 ofproto_set_controllers(struct ofproto
*p
,
624 const struct ofproto_controller
*controllers
,
625 size_t n_controllers
, uint32_t allowed_versions
)
627 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
,
632 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
634 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
637 /* Drops the connections between 'ofproto' and all of its controllers, forcing
638 * them to reconnect. */
640 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
642 connmgr_reconnect(ofproto
->connmgr
);
645 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
646 * in-band control should guarantee access, in the same way that in-band
647 * control guarantees access to OpenFlow controllers. */
649 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
650 const struct sockaddr_in
*extras
, size_t n
)
652 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
655 /* Sets the OpenFlow queue used by flows set up by in-band control on
656 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
657 * flows will use the default queue. */
659 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
661 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
664 /* Sets the number of flows at which eviction from the kernel flow table
667 ofproto_set_flow_limit(unsigned limit
)
669 ofproto_flow_limit
= limit
;
672 /* Sets the maximum idle time for flows in the datapath before they are
675 ofproto_set_max_idle(unsigned max_idle
)
677 ofproto_max_idle
= max_idle
;
680 /* If forward_bpdu is true, the NORMAL action will forward frames with
681 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
682 * the NORMAL action will drop these frames. */
684 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
686 bool old_val
= ofproto
->forward_bpdu
;
687 ofproto
->forward_bpdu
= forward_bpdu
;
688 if (old_val
!= ofproto
->forward_bpdu
) {
689 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
690 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
695 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
696 * 'idle_time', in seconds, and the maximum number of MAC table entries to
699 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
702 if (ofproto
->ofproto_class
->set_mac_table_config
) {
703 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
708 /* Multicast snooping configuration. */
710 /* Configures multicast snooping on 'ofproto' using the settings
711 * defined in 's'. If 's' is NULL, disables multicast snooping.
713 * Returns 0 if successful, otherwise a positive errno value. */
715 ofproto_set_mcast_snooping(struct ofproto
*ofproto
,
716 const struct ofproto_mcast_snooping_settings
*s
)
718 return (ofproto
->ofproto_class
->set_mcast_snooping
719 ? ofproto
->ofproto_class
->set_mcast_snooping(ofproto
, s
)
723 /* Configures multicast snooping flood setting on 'ofp_port' of 'ofproto'.
725 * Returns 0 if successful, otherwise a positive errno value.*/
727 ofproto_port_set_mcast_snooping(struct ofproto
*ofproto
, void *aux
, bool flood
)
729 return (ofproto
->ofproto_class
->set_mcast_snooping_port
730 ? ofproto
->ofproto_class
->set_mcast_snooping_port(ofproto
, aux
,
736 ofproto_set_n_dpdk_rxqs(int n_rxqs
)
738 n_dpdk_rxqs
= MAX(n_rxqs
, 0);
742 ofproto_set_cpu_mask(const char *cmask
)
746 pmd_cpu_mask
= cmask
? xstrdup(cmask
) : NULL
;
750 ofproto_set_threads(int n_handlers_
, int n_revalidators_
)
752 int threads
= MAX(count_cpu_cores(), 2);
754 n_revalidators
= MAX(n_revalidators_
, 0);
755 n_handlers
= MAX(n_handlers_
, 0);
757 if (!n_revalidators
) {
758 n_revalidators
= n_handlers
759 ? MAX(threads
- (int) n_handlers
, 1)
764 n_handlers
= MAX(threads
- (int) n_revalidators
, 1);
769 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
772 p
->dp_desc
= dp_desc
? xstrdup(dp_desc
) : NULL
;
776 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
778 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
782 ofproto_set_netflow(struct ofproto
*ofproto
,
783 const struct netflow_options
*nf_options
)
785 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
789 if (ofproto
->ofproto_class
->set_netflow
) {
790 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
792 return nf_options
? EOPNOTSUPP
: 0;
797 ofproto_set_sflow(struct ofproto
*ofproto
,
798 const struct ofproto_sflow_options
*oso
)
800 if (oso
&& sset_is_empty(&oso
->targets
)) {
804 if (ofproto
->ofproto_class
->set_sflow
) {
805 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
807 return oso
? EOPNOTSUPP
: 0;
812 ofproto_set_ipfix(struct ofproto
*ofproto
,
813 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
814 const struct ofproto_ipfix_flow_exporter_options
*fo
,
817 if (ofproto
->ofproto_class
->set_ipfix
) {
818 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
820 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
825 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
827 flow_restore_wait
= flow_restore_wait_db
;
831 ofproto_get_flow_restore_wait(void)
833 return flow_restore_wait
;
837 /* Spanning Tree Protocol (STP) configuration. */
839 /* Configures STP on 'ofproto' using the settings defined in 's'. If
840 * 's' is NULL, disables STP.
842 * Returns 0 if successful, otherwise a positive errno value. */
844 ofproto_set_stp(struct ofproto
*ofproto
,
845 const struct ofproto_stp_settings
*s
)
847 return (ofproto
->ofproto_class
->set_stp
848 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
852 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
853 * 'enabled' member of 's' is false, then the other members are not
856 * Returns 0 if successful, otherwise a positive errno value. */
858 ofproto_get_stp_status(struct ofproto
*ofproto
,
859 struct ofproto_stp_status
*s
)
861 return (ofproto
->ofproto_class
->get_stp_status
862 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
866 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
867 * in 's'. The caller is responsible for assigning STP port numbers
868 * (using the 'port_num' member in the range of 1 through 255, inclusive)
869 * and ensuring there are no duplicates. If the 's' is NULL, then STP
870 * is disabled on the port.
872 * Returns 0 if successful, otherwise a positive errno value.*/
874 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
875 const struct ofproto_port_stp_settings
*s
)
877 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
879 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
880 ofproto
->name
, ofp_port
);
884 return (ofproto
->ofproto_class
->set_stp_port
885 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
889 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
890 * 's'. If the 'enabled' member in 's' is false, then the other members
891 * are not meaningful.
893 * Returns 0 if successful, otherwise a positive errno value.*/
895 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
896 struct ofproto_port_stp_status
*s
)
898 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
900 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
901 "port %"PRIu16
, ofproto
->name
, ofp_port
);
905 return (ofproto
->ofproto_class
->get_stp_port_status
906 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
910 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
911 * 's'. If the 'enabled' member in 's' is false, then the other members
912 * are not meaningful.
914 * Returns 0 if successful, otherwise a positive errno value.*/
916 ofproto_port_get_stp_stats(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
917 struct ofproto_port_stp_stats
*s
)
919 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
921 VLOG_WARN_RL(&rl
, "%s: cannot get STP stats on nonexistent "
922 "port %"PRIu16
, ofproto
->name
, ofp_port
);
926 return (ofproto
->ofproto_class
->get_stp_port_stats
927 ? ofproto
->ofproto_class
->get_stp_port_stats(ofport
, s
)
931 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
933 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
934 * 's' is NULL, disables RSTP.
936 * Returns 0 if successful, otherwise a positive errno value. */
938 ofproto_set_rstp(struct ofproto
*ofproto
,
939 const struct ofproto_rstp_settings
*s
)
941 if (!ofproto
->ofproto_class
->set_rstp
) {
944 ofproto
->ofproto_class
->set_rstp(ofproto
, s
);
948 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
949 * 'enabled' member of 's' is false, then the other members are not
952 * Returns 0 if successful, otherwise a positive errno value. */
954 ofproto_get_rstp_status(struct ofproto
*ofproto
,
955 struct ofproto_rstp_status
*s
)
957 if (!ofproto
->ofproto_class
->get_rstp_status
) {
960 ofproto
->ofproto_class
->get_rstp_status(ofproto
, s
);
964 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
965 * in 's'. The caller is responsible for assigning RSTP port numbers
966 * (using the 'port_num' member in the range of 1 through 255, inclusive)
967 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
968 * is disabled on the port.
970 * Returns 0 if successful, otherwise a positive errno value.*/
972 ofproto_port_set_rstp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
973 const struct ofproto_port_rstp_settings
*s
)
975 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
977 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16
,
978 ofproto
->name
, ofp_port
);
982 if (!ofproto
->ofproto_class
->set_rstp_port
) {
985 ofproto
->ofproto_class
->set_rstp_port(ofport
, s
);
989 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
990 * 's'. If the 'enabled' member in 's' is false, then the other members
991 * are not meaningful.
993 * Returns 0 if successful, otherwise a positive errno value.*/
995 ofproto_port_get_rstp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
996 struct ofproto_port_rstp_status
*s
)
998 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1000 VLOG_WARN_RL(&rl
, "%s: cannot get RSTP status on nonexistent "
1001 "port %"PRIu16
, ofproto
->name
, ofp_port
);
1005 if (!ofproto
->ofproto_class
->get_rstp_port_status
) {
1008 ofproto
->ofproto_class
->get_rstp_port_status(ofport
, s
);
1012 /* Queue DSCP configuration. */
1014 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1015 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1016 * to implement QoS. Instead, it is used to implement features which require
1017 * knowledge of what queues exist on a port, and some basic information about
1020 * Returns 0 if successful, otherwise a positive errno value. */
1022 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1023 const struct ofproto_port_queue
*queues
,
1026 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1029 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
1030 ofproto
->name
, ofp_port
);
1034 return (ofproto
->ofproto_class
->set_queues
1035 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
1039 /* Connectivity Fault Management configuration. */
1041 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1043 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1045 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1046 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
1047 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
1051 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1052 * basic configuration from the configuration members in 'cfm', and the remote
1053 * maintenance point ID from remote_mpid. Ignores the statistics members of
1056 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1058 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1059 const struct cfm_settings
*s
)
1061 struct ofport
*ofport
;
1064 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1066 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
1067 ofproto
->name
, ofp_port
);
1071 /* XXX: For configuration simplicity, we only support one remote_mpid
1072 * outside of the CFM module. It's not clear if this is the correct long
1073 * term solution or not. */
1074 error
= (ofproto
->ofproto_class
->set_cfm
1075 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
1078 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
1079 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1080 ovs_strerror(error
));
1084 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1085 * 'ofproto' does not have a port 'ofp_port'. */
1087 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1088 const struct smap
*cfg
)
1090 struct ofport
*ofport
;
1093 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1095 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16
,
1096 ofproto
->name
, ofp_port
);
1100 error
= (ofproto
->ofproto_class
->set_bfd
1101 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
1104 VLOG_WARN("%s: bfd configuration on port %"PRIu16
" (%s) failed (%s)",
1105 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1106 ovs_strerror(error
));
1110 /* Checks the status change of BFD on 'ofport'.
1112 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1114 ofproto_port_bfd_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1116 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1117 return (ofport
&& ofproto
->ofproto_class
->bfd_status_changed
1118 ? ofproto
->ofproto_class
->bfd_status_changed(ofport
)
1122 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1123 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1124 * is not an OpenFlow port in 'ofproto'.
1126 * The caller must provide and own '*status'. */
1128 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1129 struct smap
*status
)
1131 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1132 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
1133 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
1137 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1138 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1139 * 0 if LACP partner information is not current (generally indicating a
1140 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1142 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1144 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1145 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
1146 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
1152 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1153 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1154 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1155 * configuration plus, if there is more than one slave, a bonding
1158 * If 'aux' is already registered then this function updates its configuration
1159 * to 's'. Otherwise, this function registers a new bundle.
1161 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1164 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
1165 const struct ofproto_bundle_settings
*s
)
1167 return (ofproto
->ofproto_class
->bundle_set
1168 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
1172 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1173 * If no such bundle has been registered, this has no effect. */
1175 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
1177 return ofproto_bundle_register(ofproto
, aux
, NULL
);
1181 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1182 * If 'aux' is already registered then this function updates its configuration
1183 * to 's'. Otherwise, this function registers a new mirror. */
1185 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
1186 const struct ofproto_mirror_settings
*s
)
1188 return (ofproto
->ofproto_class
->mirror_set
1189 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
1193 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1194 * If no mirror has been registered, this has no effect. */
1196 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
1198 return ofproto_mirror_register(ofproto
, aux
, NULL
);
1201 /* Retrieves statistics from mirror associated with client data pointer
1202 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1203 * 'bytes', respectively. If a particular counters is not supported,
1204 * the appropriate argument is set to UINT64_MAX. */
1206 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
1207 uint64_t *packets
, uint64_t *bytes
)
1209 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
1210 *packets
= *bytes
= UINT64_MAX
;
1214 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
1218 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1219 * which all packets are flooded, instead of using MAC learning. If
1220 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1222 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1225 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
1227 return (ofproto
->ofproto_class
->set_flood_vlans
1228 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
1232 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1233 * output for a mirror. */
1235 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
1237 return (ofproto
->ofproto_class
->is_mirror_output_bundle
1238 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
1242 /* Configuration of OpenFlow tables. */
1244 /* Returns the number of OpenFlow tables in 'ofproto'. */
1246 ofproto_get_n_tables(const struct ofproto
*ofproto
)
1248 return ofproto
->n_tables
;
1251 /* Returns the number of Controller visible OpenFlow tables
1252 * in 'ofproto'. This number will exclude Hidden tables.
1253 * This funtion's return value should be less or equal to that of
1254 * ofproto_get_n_tables() . */
1256 ofproto_get_n_visible_tables(const struct ofproto
*ofproto
)
1258 uint8_t n
= ofproto
->n_tables
;
1260 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1261 * if present, are always at the end.) */
1262 while(n
&& (ofproto
->tables
[n
- 1].flags
& OFTABLE_HIDDEN
)) {
1269 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1270 * settings from 's'. 'table_id' must be in the range 0 through the number of
1271 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1273 * For read-only tables, only the name may be configured. */
1275 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
1276 const struct ofproto_table_settings
*s
)
1278 struct oftable
*table
;
1280 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
1281 table
= &ofproto
->tables
[table_id
];
1283 oftable_set_name(table
, s
->name
);
1285 if (table
->flags
& OFTABLE_READONLY
) {
1290 oftable_enable_eviction(table
, s
->groups
, s
->n_groups
);
1292 oftable_disable_eviction(table
);
1295 table
->max_flows
= s
->max_flows
;
1297 if (classifier_set_prefix_fields(&table
->cls
,
1298 s
->prefix_fields
, s
->n_prefix_fields
)) {
1299 /* XXX: Trigger revalidation. */
1302 ovs_mutex_lock(&ofproto_mutex
);
1303 evict_rules_from_table(table
, 0);
1304 ovs_mutex_unlock(&ofproto_mutex
);
1308 ofproto_has_snoops(const struct ofproto
*ofproto
)
1310 return connmgr_has_snoops(ofproto
->connmgr
);
1314 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1316 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1320 ofproto_rule_delete__(struct rule
*rule
, uint8_t reason
)
1321 OVS_REQUIRES(ofproto_mutex
)
1323 struct rule_collection rules
;
1325 rules
.rules
= rules
.stub
;
1327 rules
.stub
[0] = rule
;
1328 delete_flows__(&rules
, reason
, NULL
);
1331 /* Deletes 'rule' from 'ofproto'.
1333 * Within an ofproto implementation, this function allows an ofproto
1334 * implementation to destroy any rules that remain when its ->destruct()
1335 * function is called. This function is not suitable for use elsewhere in an
1336 * ofproto implementation.
1338 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1339 * Cycle" in ofproto-provider.h. */
1341 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1342 OVS_EXCLUDED(ofproto_mutex
)
1344 /* This skips the ofmonitor and flow-removed notifications because the
1345 * switch is being deleted and any OpenFlow channels have been or soon will
1347 ovs_mutex_lock(&ofproto_mutex
);
1348 oftable_remove_rule__(ofproto
, rule
);
1349 ofproto
->ofproto_class
->rule_delete(rule
);
1350 ovs_mutex_unlock(&ofproto_mutex
);
1354 ofproto_flush__(struct ofproto
*ofproto
)
1355 OVS_EXCLUDED(ofproto_mutex
)
1357 struct oftable
*table
;
1359 /* This will flush all datapath flows. */
1360 if (ofproto
->ofproto_class
->flush
) {
1361 ofproto
->ofproto_class
->flush(ofproto
);
1364 /* XXX: There is a small race window here, where new datapath flows can be
1365 * created by upcall handlers based on the existing flow table. We can not
1366 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1367 * as then we could deadlock on syncing with the handler threads waiting on
1368 * the same mutex. */
1370 ovs_mutex_lock(&ofproto_mutex
);
1371 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1374 if (table
->flags
& OFTABLE_HIDDEN
) {
1378 CLS_FOR_EACH_SAFE (rule
, cr
, &table
->cls
) {
1379 ofproto_rule_delete__(rule
, OFPRR_DELETE
);
1382 /* XXX: Concurrent handler threads may insert new learned flows based on
1383 * learn actions of the now deleted flows right after we release
1384 * 'ofproto_mutex'. */
1385 ovs_mutex_unlock(&ofproto_mutex
);
1388 static void delete_group(struct ofproto
*ofproto
, uint32_t group_id
);
1391 ofproto_destroy__(struct ofproto
*ofproto
)
1392 OVS_EXCLUDED(ofproto_mutex
)
1394 struct oftable
*table
;
1396 destroy_rule_executes(ofproto
);
1397 delete_group(ofproto
, OFPG_ALL
);
1399 guarded_list_destroy(&ofproto
->rule_executes
);
1400 ovs_rwlock_destroy(&ofproto
->groups_rwlock
);
1401 hmap_destroy(&ofproto
->groups
);
1403 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1404 free(ofproto
->name
);
1405 free(ofproto
->type
);
1406 free(ofproto
->mfr_desc
);
1407 free(ofproto
->hw_desc
);
1408 free(ofproto
->sw_desc
);
1409 free(ofproto
->serial_desc
);
1410 free(ofproto
->dp_desc
);
1411 hmap_destroy(&ofproto
->ports
);
1412 hmap_destroy(&ofproto
->ofport_usage
);
1413 shash_destroy(&ofproto
->port_by_name
);
1414 simap_destroy(&ofproto
->ofp_requests
);
1416 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1417 oftable_destroy(table
);
1419 free(ofproto
->tables
);
1421 ovs_assert(hindex_is_empty(&ofproto
->cookies
));
1422 hindex_destroy(&ofproto
->cookies
);
1424 ovs_assert(hmap_is_empty(&ofproto
->learned_cookies
));
1425 hmap_destroy(&ofproto
->learned_cookies
);
1427 free(ofproto
->vlan_bitmap
);
1429 ofproto
->ofproto_class
->dealloc(ofproto
);
1433 ofproto_destroy(struct ofproto
*p
)
1434 OVS_EXCLUDED(ofproto_mutex
)
1436 struct ofport
*ofport
, *next_ofport
;
1437 struct ofport_usage
*usage
, *next_usage
;
1444 meter_delete(p
, 1, p
->meter_features
.max_meters
);
1445 p
->meter_features
.max_meters
= 0;
1451 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1452 ofport_destroy(ofport
);
1455 HMAP_FOR_EACH_SAFE (usage
, next_usage
, hmap_node
, &p
->ofport_usage
) {
1456 hmap_remove(&p
->ofport_usage
, &usage
->hmap_node
);
1460 p
->ofproto_class
->destruct(p
);
1462 /* We should not postpone this because it involves deleting a listening
1463 * socket which we may want to reopen soon. 'connmgr' should not be used
1464 * by other threads */
1465 connmgr_destroy(p
->connmgr
);
1467 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1468 ovsrcu_postpone(ofproto_destroy__
, p
);
1471 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1472 * kernel datapath, for example, this destroys the datapath in the kernel, and
1473 * with the netdev-based datapath, it tears down the data structures that
1474 * represent the datapath.
1476 * The datapath should not be currently open as an ofproto. */
1478 ofproto_delete(const char *name
, const char *type
)
1480 const struct ofproto_class
*class = ofproto_class_find__(type
);
1481 return (!class ? EAFNOSUPPORT
1482 : !class->del
? EACCES
1483 : class->del(type
, name
));
1487 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1489 if (error
== ENOBUFS
) {
1490 reinit_ports(ofproto
);
1491 } else if (!error
) {
1492 update_port(ofproto
, devname
);
1498 ofproto_type_run(const char *datapath_type
)
1500 const struct ofproto_class
*class;
1503 datapath_type
= ofproto_normalize_type(datapath_type
);
1504 class = ofproto_class_find__(datapath_type
);
1506 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1507 if (error
&& error
!= EAGAIN
) {
1508 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1509 datapath_type
, ovs_strerror(error
));
1515 ofproto_type_wait(const char *datapath_type
)
1517 const struct ofproto_class
*class;
1519 datapath_type
= ofproto_normalize_type(datapath_type
);
1520 class = ofproto_class_find__(datapath_type
);
1522 if (class->type_wait
) {
1523 class->type_wait(datapath_type
);
1528 ofproto_run(struct ofproto
*p
)
1533 error
= p
->ofproto_class
->run(p
);
1534 if (error
&& error
!= EAGAIN
) {
1535 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, ovs_strerror(error
));
1538 run_rule_executes(p
);
1540 /* Restore the eviction group heap invariant occasionally. */
1541 if (p
->eviction_group_timer
< time_msec()) {
1544 p
->eviction_group_timer
= time_msec() + 1000;
1546 for (i
= 0; i
< p
->n_tables
; i
++) {
1547 struct oftable
*table
= &p
->tables
[i
];
1548 struct eviction_group
*evg
;
1551 if (!table
->eviction_fields
) {
1555 if (classifier_count(&table
->cls
) > 100000) {
1556 static struct vlog_rate_limit count_rl
=
1557 VLOG_RATE_LIMIT_INIT(1, 1);
1558 VLOG_WARN_RL(&count_rl
, "Table %"PRIuSIZE
" has an excessive"
1559 " number of rules: %d", i
,
1560 classifier_count(&table
->cls
));
1563 ovs_mutex_lock(&ofproto_mutex
);
1564 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1565 if (rule
->idle_timeout
|| rule
->hard_timeout
) {
1566 if (!rule
->eviction_group
) {
1567 eviction_group_add_rule(rule
);
1569 heap_raw_change(&rule
->evg_node
,
1570 rule_eviction_priority(p
, rule
));
1575 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1576 heap_rebuild(&evg
->rules
);
1578 ovs_mutex_unlock(&ofproto_mutex
);
1582 if (p
->ofproto_class
->port_poll
) {
1585 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1586 process_port_change(p
, error
, devname
);
1590 new_seq
= seq_read(connectivity_seq_get());
1591 if (new_seq
!= p
->change_seq
) {
1592 struct sset devnames
;
1593 const char *devname
;
1594 struct ofport
*ofport
;
1596 /* Update OpenFlow port status for any port whose netdev has changed.
1598 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1599 * destroyed, so it's not safe to update ports directly from the
1600 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1601 * need this two-phase approach. */
1602 sset_init(&devnames
);
1603 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1604 uint64_t port_change_seq
;
1606 port_change_seq
= netdev_get_change_seq(ofport
->netdev
);
1607 if (ofport
->change_seq
!= port_change_seq
) {
1608 ofport
->change_seq
= port_change_seq
;
1609 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1612 SSET_FOR_EACH (devname
, &devnames
) {
1613 update_port(p
, devname
);
1615 sset_destroy(&devnames
);
1617 p
->change_seq
= new_seq
;
1620 connmgr_run(p
->connmgr
, handle_openflow
);
1626 ofproto_wait(struct ofproto
*p
)
1628 p
->ofproto_class
->wait(p
);
1629 if (p
->ofproto_class
->port_poll_wait
) {
1630 p
->ofproto_class
->port_poll_wait(p
);
1632 seq_wait(connectivity_seq_get(), p
->change_seq
);
1633 connmgr_wait(p
->connmgr
);
1637 ofproto_is_alive(const struct ofproto
*p
)
1639 return connmgr_has_controllers(p
->connmgr
);
1642 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1643 * memory_report(). */
1645 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1647 const struct oftable
*table
;
1648 unsigned int n_rules
;
1650 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1653 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1654 n_rules
+= classifier_count(&table
->cls
);
1656 simap_increase(usage
, "rules", n_rules
);
1658 if (ofproto
->ofproto_class
->get_memory_usage
) {
1659 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1662 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1666 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1668 const struct ofproto_class
*class;
1670 datapath_type
= ofproto_normalize_type(datapath_type
);
1671 class = ofproto_class_find__(datapath_type
);
1673 if (class && class->type_get_memory_usage
) {
1674 class->type_get_memory_usage(datapath_type
, usage
);
1679 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1682 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1686 ofproto_free_ofproto_controller_info(struct shash
*info
)
1688 connmgr_free_controller_info(info
);
1691 /* Makes a deep copy of 'old' into 'port'. */
1693 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1695 port
->name
= xstrdup(old
->name
);
1696 port
->type
= xstrdup(old
->type
);
1697 port
->ofp_port
= old
->ofp_port
;
1700 /* Frees memory allocated to members of 'ofproto_port'.
1702 * Do not call this function on an ofproto_port obtained from
1703 * ofproto_port_dump_next(): that function retains ownership of the data in the
1706 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1708 free(ofproto_port
->name
);
1709 free(ofproto_port
->type
);
1712 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1714 * This function provides no status indication. An error status for the entire
1715 * dump operation is provided when it is completed by calling
1716 * ofproto_port_dump_done().
1719 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1720 const struct ofproto
*ofproto
)
1722 dump
->ofproto
= ofproto
;
1723 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1727 /* Attempts to retrieve another port from 'dump', which must have been created
1728 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1729 * 'port' and returns true. On failure, returns false.
1731 * Failure might indicate an actual error or merely that the last port has been
1732 * dumped. An error status for the entire dump operation is provided when it
1733 * is completed by calling ofproto_port_dump_done().
1735 * The ofproto owns the data stored in 'port'. It will remain valid until at
1736 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1737 * ofproto_port_dump_done(). */
1739 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1740 struct ofproto_port
*port
)
1742 const struct ofproto
*ofproto
= dump
->ofproto
;
1748 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1751 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1757 /* Completes port table dump operation 'dump', which must have been created
1758 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1759 * error-free, otherwise a positive errno value describing the problem. */
1761 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1763 const struct ofproto
*ofproto
= dump
->ofproto
;
1765 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1768 return dump
->error
== EOF
? 0 : dump
->error
;
1771 /* Returns the type to pass to netdev_open() when a datapath of type
1772 * 'datapath_type' has a port of type 'port_type', for a few special
1773 * cases when a netdev type differs from a port type. For example, when
1774 * using the userspace datapath, a port of type "internal" needs to be
1777 * Returns either 'type' itself or a string literal, which must not be
1780 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1782 const struct ofproto_class
*class;
1784 datapath_type
= ofproto_normalize_type(datapath_type
);
1785 class = ofproto_class_find__(datapath_type
);
1790 return (class->port_open_type
1791 ? class->port_open_type(datapath_type
, port_type
)
1795 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1796 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1797 * the port's OpenFlow port number.
1799 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1800 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1801 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1802 * 'ofp_portp' is non-null). */
1804 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1805 ofp_port_t
*ofp_portp
)
1807 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1810 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1812 const char *netdev_name
= netdev_get_name(netdev
);
1814 simap_put(&ofproto
->ofp_requests
, netdev_name
,
1815 ofp_to_u16(ofp_port
));
1816 update_port(ofproto
, netdev_name
);
1819 *ofp_portp
= OFPP_NONE
;
1821 struct ofproto_port ofproto_port
;
1823 error
= ofproto_port_query_by_name(ofproto
,
1824 netdev_get_name(netdev
),
1827 *ofp_portp
= ofproto_port
.ofp_port
;
1828 ofproto_port_destroy(&ofproto_port
);
1835 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1836 * initializes '*port' appropriately; on failure, returns a positive errno
1839 * The caller owns the data in 'ofproto_port' and must free it with
1840 * ofproto_port_destroy() when it is no longer needed. */
1842 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1843 struct ofproto_port
*port
)
1847 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1849 memset(port
, 0, sizeof *port
);
1854 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1855 * Returns 0 if successful, otherwise a positive errno. */
1857 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1859 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1860 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
1861 struct simap_node
*ofp_request_node
;
1864 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
1865 if (ofp_request_node
) {
1866 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
1869 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
1870 if (!error
&& ofport
) {
1871 /* 'name' is the netdev's name and update_port() is going to close the
1872 * netdev. Just in case update_port() refers to 'name' after it
1873 * destroys 'ofport', make a copy of it around the update_port()
1875 char *devname
= xstrdup(name
);
1876 update_port(ofproto
, devname
);
1883 flow_mod_init(struct ofputil_flow_mod
*fm
,
1884 const struct match
*match
, int priority
,
1885 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1886 enum ofp_flow_mod_command command
)
1888 memset(fm
, 0, sizeof *fm
);
1890 fm
->priority
= priority
;
1893 fm
->modify_cookie
= false;
1895 fm
->command
= command
;
1896 fm
->idle_timeout
= 0;
1897 fm
->hard_timeout
= 0;
1898 fm
->buffer_id
= UINT32_MAX
;
1899 fm
->out_port
= OFPP_ANY
;
1900 fm
->out_group
= OFPG_ANY
;
1902 fm
->ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
);
1903 fm
->ofpacts_len
= ofpacts_len
;
1904 fm
->delete_reason
= OFPRR_DELETE
;
1908 simple_flow_mod(struct ofproto
*ofproto
,
1909 const struct match
*match
, int priority
,
1910 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1911 enum ofp_flow_mod_command command
)
1913 struct ofputil_flow_mod fm
;
1915 flow_mod_init(&fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
1917 return handle_flow_mod__(ofproto
, &fm
, NULL
);
1920 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1921 * performs the 'n_actions' actions in 'actions'. The new flow will not
1924 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1925 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1926 * controllers; otherwise, it will be hidden.
1928 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1930 * This is a helper function for in-band control and fail-open. */
1932 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
1934 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1935 OVS_EXCLUDED(ofproto_mutex
)
1937 const struct rule
*rule
;
1940 /* First do a cheap check whether the rule we're looking for already exists
1941 * with the actions that we want. If it does, then we're done. */
1942 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1943 &ofproto
->tables
[0].cls
, match
, priority
));
1945 const struct rule_actions
*actions
= rule_get_actions(rule
);
1946 must_add
= !ofpacts_equal(actions
->ofpacts
, actions
->ofpacts_len
,
1947 ofpacts
, ofpacts_len
);
1952 /* If there's no such rule or the rule doesn't have the actions we want,
1953 * fall back to a executing a full flow mod. We can't optimize this at
1954 * all because we didn't take enough locks above to ensure that the flow
1955 * table didn't already change beneath us. */
1957 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
1958 OFPFC_MODIFY_STRICT
);
1962 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1963 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1964 * operation cannot be initiated now but may be retried later.
1966 * This is a helper function for in-band control and fail-open and the "learn"
1969 ofproto_flow_mod(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
)
1970 OVS_EXCLUDED(ofproto_mutex
)
1972 /* Optimize for the most common case of a repeated learn action.
1973 * If an identical flow already exists we only need to update its
1974 * 'modified' time. */
1975 if (fm
->command
== OFPFC_MODIFY_STRICT
&& fm
->table_id
!= OFPTT_ALL
1976 && !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
)) {
1977 struct oftable
*table
= &ofproto
->tables
[fm
->table_id
];
1981 rule
= rule_from_cls_rule(classifier_find_match_exactly(&table
->cls
,
1985 /* Reading many of the rule fields and writing on 'modified'
1986 * requires the rule->mutex. Also, rule->actions may change
1987 * if rule->mutex is not held. */
1988 const struct rule_actions
*actions
;
1990 ovs_mutex_lock(&rule
->mutex
);
1991 actions
= rule_get_actions(rule
);
1992 if (rule
->idle_timeout
== fm
->idle_timeout
1993 && rule
->hard_timeout
== fm
->hard_timeout
1994 && rule
->flags
== (fm
->flags
& OFPUTIL_FF_STATE
)
1995 && (!fm
->modify_cookie
|| (fm
->new_cookie
== rule
->flow_cookie
))
1996 && ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
1997 actions
->ofpacts
, actions
->ofpacts_len
)) {
1998 /* Rule already exists and need not change, only update the
1999 modified timestamp. */
2000 rule
->modified
= time_msec();
2003 ovs_mutex_unlock(&rule
->mutex
);
2011 return handle_flow_mod__(ofproto
, fm
, NULL
);
2014 /* Searches for a rule with matching criteria exactly equal to 'target' in
2015 * ofproto's table 0 and, if it finds one, deletes it.
2017 * This is a helper function for in-band control and fail-open. */
2019 ofproto_delete_flow(struct ofproto
*ofproto
,
2020 const struct match
*target
, int priority
)
2021 OVS_EXCLUDED(ofproto_mutex
)
2023 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
2026 /* First do a cheap check whether the rule we're looking for has already
2027 * been deleted. If so, then we're done. */
2028 rule
= rule_from_cls_rule(classifier_find_match_exactly(cls
, target
,
2034 /* Execute a flow mod. We can't optimize this at all because we didn't
2035 * take enough locks above to ensure that the flow table didn't already
2036 * change beneath us. */
2037 simple_flow_mod(ofproto
, target
, priority
, NULL
, 0, OFPFC_DELETE_STRICT
);
2040 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2041 * the flows required by in-band control and fail-open. */
2043 ofproto_flush_flows(struct ofproto
*ofproto
)
2045 COVERAGE_INC(ofproto_flush
);
2046 ofproto_flush__(ofproto
);
2047 connmgr_flushed(ofproto
->connmgr
);
2051 reinit_ports(struct ofproto
*p
)
2053 struct ofproto_port_dump dump
;
2054 struct sset devnames
;
2055 struct ofport
*ofport
;
2056 struct ofproto_port ofproto_port
;
2057 const char *devname
;
2059 COVERAGE_INC(ofproto_reinit_ports
);
2061 sset_init(&devnames
);
2062 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2063 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
2065 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2066 sset_add(&devnames
, ofproto_port
.name
);
2069 SSET_FOR_EACH (devname
, &devnames
) {
2070 update_port(p
, devname
);
2072 sset_destroy(&devnames
);
2076 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2080 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2081 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2083 if (port_idx
>= ofproto
->max_ports
2084 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2085 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2086 long long int last_used_at
, lru
= LLONG_MAX
;
2088 /* Search for a free OpenFlow port number. We try not to
2089 * immediately reuse them to prevent problems due to old
2092 * We limit the automatically assigned port numbers to the lower half
2093 * of the port range, to reserve the upper half for assignment by
2096 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2097 ofproto
->alloc_port_no
= 1;
2099 last_used_at
= ofport_get_usage(ofproto
,
2100 u16_to_ofp(ofproto
->alloc_port_no
));
2101 if (!last_used_at
) {
2102 port_idx
= ofproto
->alloc_port_no
;
2104 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2105 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2106 * more than an hour ago, consider it usable. */
2107 ofport_remove_usage(ofproto
,
2108 u16_to_ofp(ofproto
->alloc_port_no
));
2109 port_idx
= ofproto
->alloc_port_no
;
2111 } else if (last_used_at
< lru
) {
2113 lru_ofport
= ofproto
->alloc_port_no
;
2116 if (ofproto
->alloc_port_no
== end_port_no
) {
2118 port_idx
= lru_ofport
;
2125 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2126 return u16_to_ofp(port_idx
);
2130 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2132 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2133 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2137 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2138 * pointer if the netdev cannot be opened. On success, also fills in
2140 static struct netdev
*
2141 ofport_open(struct ofproto
*ofproto
,
2142 struct ofproto_port
*ofproto_port
,
2143 struct ofputil_phy_port
*pp
)
2145 enum netdev_flags flags
;
2146 struct netdev
*netdev
;
2149 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2151 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
2152 "cannot be opened (%s)",
2154 ofproto_port
->name
, ofproto_port
->ofp_port
,
2155 ofproto_port
->name
, ovs_strerror(error
));
2159 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2160 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2161 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2163 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2164 ofproto_port
->name
);
2167 pp
->port_no
= ofproto_port
->ofp_port
;
2168 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
2169 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2170 netdev_get_flags(netdev
, &flags
);
2171 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2172 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2173 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2174 &pp
->supported
, &pp
->peer
);
2175 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2176 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2181 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2182 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2185 ofport_equal(const struct ofputil_phy_port
*a
,
2186 const struct ofputil_phy_port
*b
)
2188 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2189 && a
->state
== b
->state
2190 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2191 && a
->curr
== b
->curr
2192 && a
->advertised
== b
->advertised
2193 && a
->supported
== b
->supported
2194 && a
->peer
== b
->peer
2195 && a
->curr_speed
== b
->curr_speed
2196 && a
->max_speed
== b
->max_speed
);
2199 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2200 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2201 * one with the same name or port number). */
2203 ofport_install(struct ofproto
*p
,
2204 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2206 const char *netdev_name
= netdev_get_name(netdev
);
2207 struct ofport
*ofport
;
2210 /* Create ofport. */
2211 ofport
= p
->ofproto_class
->port_alloc();
2216 ofport
->ofproto
= p
;
2217 ofport
->netdev
= netdev
;
2218 ofport
->change_seq
= netdev_get_change_seq(netdev
);
2220 ofport
->ofp_port
= pp
->port_no
;
2221 ofport
->created
= time_msec();
2223 /* Add port to 'p'. */
2224 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2225 hash_ofp_port(ofport
->ofp_port
));
2226 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2228 update_mtu(p
, ofport
);
2230 /* Let the ofproto_class initialize its private data. */
2231 error
= p
->ofproto_class
->port_construct(ofport
);
2235 connmgr_send_port_status(p
->connmgr
, NULL
, pp
, OFPPR_ADD
);
2239 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2240 p
->name
, netdev_name
, ovs_strerror(error
));
2242 ofport_destroy__(ofport
);
2244 netdev_close(netdev
);
2248 /* Removes 'ofport' from 'p' and destroys it. */
2250 ofport_remove(struct ofport
*ofport
)
2252 connmgr_send_port_status(ofport
->ofproto
->connmgr
, NULL
, &ofport
->pp
,
2254 ofport_destroy(ofport
);
2257 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2260 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2262 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2264 ofport_remove(port
);
2268 /* Updates 'port' with new 'pp' description.
2270 * Does not handle a name or port number change. The caller must implement
2271 * such a change as a delete followed by an add. */
2273 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2275 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
2276 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2277 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2278 port
->pp
.state
= ((port
->pp
.state
& ~OFPUTIL_PS_LINK_DOWN
)
2279 | (pp
->state
& OFPUTIL_PS_LINK_DOWN
));
2280 port
->pp
.curr
= pp
->curr
;
2281 port
->pp
.advertised
= pp
->advertised
;
2282 port
->pp
.supported
= pp
->supported
;
2283 port
->pp
.peer
= pp
->peer
;
2284 port
->pp
.curr_speed
= pp
->curr_speed
;
2285 port
->pp
.max_speed
= pp
->max_speed
;
2287 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2288 &port
->pp
, OFPPR_MODIFY
);
2291 /* Update OpenFlow 'state' in 'port' and notify controller. */
2293 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2295 if (port
->pp
.state
!= state
) {
2296 port
->pp
.state
= state
;
2297 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2298 &port
->pp
, OFPPR_MODIFY
);
2303 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2305 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2307 if (port
->ofproto
->ofproto_class
->set_realdev
) {
2308 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
2310 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2311 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2313 if (port
->ofproto
->ofproto_class
->set_rstp_port
) {
2314 port
->ofproto
->ofproto_class
->set_rstp_port(port
, NULL
);
2316 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2317 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2319 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2320 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2326 ofport_destroy__(struct ofport
*port
)
2328 struct ofproto
*ofproto
= port
->ofproto
;
2329 const char *name
= netdev_get_name(port
->netdev
);
2331 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2332 shash_delete(&ofproto
->port_by_name
,
2333 shash_find(&ofproto
->port_by_name
, name
));
2335 netdev_close(port
->netdev
);
2336 ofproto
->ofproto_class
->port_dealloc(port
);
2340 ofport_destroy(struct ofport
*port
)
2343 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2344 port
->ofproto
->ofproto_class
->port_destruct(port
);
2345 ofport_destroy__(port
);
2350 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2352 struct ofport
*port
;
2354 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2356 if (port
->ofp_port
== ofp_port
) {
2363 static long long int
2364 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2366 struct ofport_usage
*usage
;
2368 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2369 &ofproto
->ofport_usage
) {
2370 if (usage
->ofp_port
== ofp_port
) {
2371 return usage
->last_used
;
2378 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2379 long long int last_used
)
2381 struct ofport_usage
*usage
;
2382 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2383 &ofproto
->ofport_usage
) {
2384 if (usage
->ofp_port
== ofp_port
) {
2385 usage
->last_used
= last_used
;
2389 ovs_assert(last_used
== LLONG_MAX
);
2391 usage
= xmalloc(sizeof *usage
);
2392 usage
->ofp_port
= ofp_port
;
2393 usage
->last_used
= last_used
;
2394 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2395 hash_ofp_port(ofp_port
));
2399 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2401 struct ofport_usage
*usage
;
2402 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2403 &ofproto
->ofport_usage
) {
2404 if (usage
->ofp_port
== ofp_port
) {
2405 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2413 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2415 struct ofproto
*ofproto
= port
->ofproto
;
2418 if (ofproto
->ofproto_class
->port_get_stats
) {
2419 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2428 update_port(struct ofproto
*ofproto
, const char *name
)
2430 struct ofproto_port ofproto_port
;
2431 struct ofputil_phy_port pp
;
2432 struct netdev
*netdev
;
2433 struct ofport
*port
;
2435 COVERAGE_INC(ofproto_update_port
);
2437 /* Fetch 'name''s location and properties from the datapath. */
2438 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2439 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2443 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2444 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2445 struct netdev
*old_netdev
= port
->netdev
;
2447 /* 'name' hasn't changed location. Any properties changed? */
2448 if (!ofport_equal(&port
->pp
, &pp
)) {
2449 ofport_modified(port
, &pp
);
2452 update_mtu(ofproto
, port
);
2454 /* Install the newly opened netdev in case it has changed.
2455 * Don't close the old netdev yet in case port_modified has to
2456 * remove a retained reference to it.*/
2457 port
->netdev
= netdev
;
2458 port
->change_seq
= netdev_get_change_seq(netdev
);
2460 if (port
->ofproto
->ofproto_class
->port_modified
) {
2461 port
->ofproto
->ofproto_class
->port_modified(port
);
2464 netdev_close(old_netdev
);
2466 /* If 'port' is nonnull then its name differs from 'name' and thus
2467 * we should delete it. If we think there's a port named 'name'
2468 * then its port number must be wrong now so delete it too. */
2470 ofport_remove(port
);
2472 ofport_remove_with_name(ofproto
, name
);
2473 ofport_install(ofproto
, netdev
, &pp
);
2476 /* Any port named 'name' is gone now. */
2477 ofport_remove_with_name(ofproto
, name
);
2479 ofproto_port_destroy(&ofproto_port
);
2483 init_ports(struct ofproto
*p
)
2485 struct ofproto_port_dump dump
;
2486 struct ofproto_port ofproto_port
;
2487 struct shash_node
*node
, *next
;
2489 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2490 const char *name
= ofproto_port
.name
;
2492 if (shash_find(&p
->port_by_name
, name
)) {
2493 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2496 struct ofputil_phy_port pp
;
2497 struct netdev
*netdev
;
2499 /* Check if an OpenFlow port number had been requested. */
2500 node
= shash_find(&init_ofp_ports
, name
);
2502 const struct iface_hint
*iface_hint
= node
->data
;
2503 simap_put(&p
->ofp_requests
, name
,
2504 ofp_to_u16(iface_hint
->ofp_port
));
2507 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2509 ofport_install(p
, netdev
, &pp
);
2510 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2511 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2512 ofp_to_u16(ofproto_port
.ofp_port
));
2518 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2519 struct iface_hint
*iface_hint
= node
->data
;
2521 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2522 free(iface_hint
->br_name
);
2523 free(iface_hint
->br_type
);
2525 shash_delete(&init_ofp_ports
, node
);
2532 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2533 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2535 find_min_mtu(struct ofproto
*p
)
2537 struct ofport
*ofport
;
2540 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2541 struct netdev
*netdev
= ofport
->netdev
;
2544 /* Skip any internal ports, since that's what we're trying to
2546 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2550 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2553 if (!mtu
|| dev_mtu
< mtu
) {
2558 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2561 /* Update MTU of all datapath devices on 'p' to the minimum of the
2562 * non-datapath ports in event of 'port' added or changed. */
2564 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2566 struct ofport
*ofport
;
2567 struct netdev
*netdev
= port
->netdev
;
2568 int dev_mtu
, old_min
;
2570 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2574 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2575 if (dev_mtu
> p
->min_mtu
) {
2576 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2577 dev_mtu
= p
->min_mtu
;
2580 port
->mtu
= dev_mtu
;
2584 /* For non-internal port find new min mtu. */
2585 old_min
= p
->min_mtu
;
2586 port
->mtu
= dev_mtu
;
2587 p
->min_mtu
= find_min_mtu(p
);
2588 if (p
->min_mtu
== old_min
) {
2592 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2593 struct netdev
*netdev
= ofport
->netdev
;
2595 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2596 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2597 ofport
->mtu
= p
->min_mtu
;
2604 ofproto_rule_destroy__(struct rule
*rule
)
2605 OVS_NO_THREAD_SAFETY_ANALYSIS
2607 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2608 rule_actions_destroy(rule_get_actions(rule
));
2609 ovs_mutex_destroy(&rule
->mutex
);
2610 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2614 rule_destroy_cb(struct rule
*rule
)
2616 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2617 ofproto_rule_destroy__(rule
);
2621 ofproto_rule_ref(struct rule
*rule
)
2624 ovs_refcount_ref(&rule
->ref_count
);
2629 ofproto_rule_try_ref(struct rule
*rule
)
2632 return ovs_refcount_try_ref_rcu(&rule
->ref_count
);
2637 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2638 * ref_count reaches 0.
2640 * Use of RCU allows short term use (between RCU quiescent periods) without
2641 * keeping a reference. A reference must be taken if the rule needs to
2642 * stay around accross the RCU quiescent periods. */
2644 ofproto_rule_unref(struct rule
*rule
)
2646 if (rule
&& ovs_refcount_unref_relaxed(&rule
->ref_count
) == 1) {
2647 ovsrcu_postpone(rule_destroy_cb
, rule
);
2652 ofproto_group_ref(struct ofgroup
*group
)
2655 ovs_refcount_ref(&group
->ref_count
);
2660 ofproto_group_unref(struct ofgroup
*group
)
2662 if (group
&& ovs_refcount_unref(&group
->ref_count
) == 1) {
2663 group
->ofproto
->ofproto_class
->group_destruct(group
);
2664 ofputil_bucket_list_destroy(&group
->buckets
);
2665 group
->ofproto
->ofproto_class
->group_dealloc(group
);
2669 static uint32_t get_provider_meter_id(const struct ofproto
*,
2670 uint32_t of_meter_id
);
2672 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2673 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2674 const struct rule_actions
*
2675 rule_actions_create(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2677 struct rule_actions
*actions
;
2679 actions
= xmalloc(sizeof *actions
+ ofpacts_len
);
2680 actions
->ofpacts_len
= ofpacts_len
;
2681 actions
->has_meter
= ofpacts_get_meter(ofpacts
, ofpacts_len
) != 0;
2682 memcpy(actions
->ofpacts
, ofpacts
, ofpacts_len
);
2684 actions
->has_learn_with_delete
= (next_learn_with_delete(actions
, NULL
)
2690 /* Free the actions after the RCU quiescent period is reached. */
2692 rule_actions_destroy(const struct rule_actions
*actions
)
2695 ovsrcu_postpone(free
, CONST_CAST(struct rule_actions
*, actions
));
2699 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2700 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2702 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2703 OVS_REQUIRES(ofproto_mutex
)
2705 if (port
== OFPP_ANY
) {
2708 const struct rule_actions
*actions
= rule_get_actions(rule
);
2709 return ofpacts_output_to_port(actions
->ofpacts
,
2710 actions
->ofpacts_len
, port
);
2714 /* Returns true if 'rule' has group and equals group_id. */
2716 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
2717 OVS_REQUIRES(ofproto_mutex
)
2719 if (group_id
== OFPG_ANY
) {
2722 const struct rule_actions
*actions
= rule_get_actions(rule
);
2723 return ofpacts_output_to_group(actions
->ofpacts
,
2724 actions
->ofpacts_len
, group_id
);
2729 rule_execute_destroy(struct rule_execute
*e
)
2731 ofproto_rule_unref(e
->rule
);
2732 list_remove(&e
->list_node
);
2736 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2737 * by passing them to the ofproto provider. */
2739 run_rule_executes(struct ofproto
*ofproto
)
2740 OVS_EXCLUDED(ofproto_mutex
)
2742 struct rule_execute
*e
, *next
;
2743 struct list executes
;
2745 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2746 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2749 flow_extract(e
->packet
, NULL
, &flow
);
2750 flow
.in_port
.ofp_port
= e
->in_port
;
2751 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
2753 rule_execute_destroy(e
);
2757 /* Destroys and discards all "rule_execute" operations queued up in
2758 * ofproto->rule_executes. */
2760 destroy_rule_executes(struct ofproto
*ofproto
)
2762 struct rule_execute
*e
, *next
;
2763 struct list executes
;
2765 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2766 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2767 ofpbuf_delete(e
->packet
);
2768 rule_execute_destroy(e
);
2773 rule_is_readonly(const struct rule
*rule
)
2775 const struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
2776 return (table
->flags
& OFTABLE_READONLY
) != 0;
2780 hash_learned_cookie(ovs_be64 cookie_
, uint8_t table_id
)
2782 uint64_t cookie
= (OVS_FORCE
uint64_t) cookie_
;
2783 return hash_3words(cookie
, cookie
>> 32, table_id
);
2787 learned_cookies_update_one__(struct ofproto
*ofproto
,
2788 const struct ofpact_learn
*learn
,
2789 int delta
, struct list
*dead_cookies
)
2790 OVS_REQUIRES(ofproto_mutex
)
2792 uint32_t hash
= hash_learned_cookie(learn
->cookie
, learn
->table_id
);
2793 struct learned_cookie
*c
;
2795 HMAP_FOR_EACH_WITH_HASH (c
, u
.hmap_node
, hash
, &ofproto
->learned_cookies
) {
2796 if (c
->cookie
== learn
->cookie
&& c
->table_id
== learn
->table_id
) {
2798 ovs_assert(c
->n
>= 0);
2801 hmap_remove(&ofproto
->learned_cookies
, &c
->u
.hmap_node
);
2802 list_push_back(dead_cookies
, &c
->u
.list_node
);
2809 ovs_assert(delta
> 0);
2810 c
= xmalloc(sizeof *c
);
2811 hmap_insert(&ofproto
->learned_cookies
, &c
->u
.hmap_node
, hash
);
2812 c
->cookie
= learn
->cookie
;
2813 c
->table_id
= learn
->table_id
;
2817 static const struct ofpact_learn
*
2818 next_learn_with_delete(const struct rule_actions
*actions
,
2819 const struct ofpact_learn
*start
)
2821 const struct ofpact
*pos
;
2823 for (pos
= start
? ofpact_next(&start
->ofpact
) : actions
->ofpacts
;
2824 pos
< ofpact_end(actions
->ofpacts
, actions
->ofpacts_len
);
2825 pos
= ofpact_next(pos
)) {
2826 if (pos
->type
== OFPACT_LEARN
) {
2827 const struct ofpact_learn
*learn
= ofpact_get_LEARN(pos
);
2828 if (learn
->flags
& NX_LEARN_F_DELETE_LEARNED
) {
2838 learned_cookies_update__(struct ofproto
*ofproto
,
2839 const struct rule_actions
*actions
,
2840 int delta
, struct list
*dead_cookies
)
2841 OVS_REQUIRES(ofproto_mutex
)
2843 if (actions
->has_learn_with_delete
) {
2844 const struct ofpact_learn
*learn
;
2846 for (learn
= next_learn_with_delete(actions
, NULL
); learn
;
2847 learn
= next_learn_with_delete(actions
, learn
)) {
2848 learned_cookies_update_one__(ofproto
, learn
, delta
, dead_cookies
);
2854 learned_cookies_inc(struct ofproto
*ofproto
,
2855 const struct rule_actions
*actions
)
2856 OVS_REQUIRES(ofproto_mutex
)
2858 learned_cookies_update__(ofproto
, actions
, +1, NULL
);
2862 learned_cookies_dec(struct ofproto
*ofproto
,
2863 const struct rule_actions
*actions
,
2864 struct list
*dead_cookies
)
2865 OVS_REQUIRES(ofproto_mutex
)
2867 learned_cookies_update__(ofproto
, actions
, -1, dead_cookies
);
2871 learned_cookies_flush(struct ofproto
*ofproto
, struct list
*dead_cookies
)
2872 OVS_REQUIRES(ofproto_mutex
)
2874 struct learned_cookie
*c
, *next
;
2876 LIST_FOR_EACH_SAFE (c
, next
, u
.list_node
, dead_cookies
) {
2877 struct rule_criteria criteria
;
2878 struct rule_collection rules
;
2881 match_init_catchall(&match
);
2882 rule_criteria_init(&criteria
, c
->table_id
, &match
, 0,
2883 c
->cookie
, OVS_BE64_MAX
, OFPP_ANY
, OFPG_ANY
);
2884 rule_criteria_require_rw(&criteria
, false);
2885 collect_rules_loose(ofproto
, &criteria
, &rules
);
2886 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
2887 rule_criteria_destroy(&criteria
);
2888 rule_collection_destroy(&rules
);
2890 list_remove(&c
->u
.list_node
);
2896 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2898 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
2903 query_tables(struct ofproto
*ofproto
,
2904 struct ofputil_table_features
**featuresp
,
2905 struct ofputil_table_stats
**statsp
)
2907 struct mf_bitmap rw_fields
= oxm_writable_fields();
2908 struct mf_bitmap match
= oxm_matchable_fields();
2909 struct mf_bitmap mask
= oxm_maskable_fields();
2911 struct ofputil_table_features
*features
;
2912 struct ofputil_table_stats
*stats
;
2915 features
= *featuresp
= xcalloc(ofproto
->n_tables
, sizeof *features
);
2916 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2917 struct ofputil_table_features
*f
= &features
[i
];
2920 sprintf(f
->name
, "table%d", i
);
2921 f
->metadata_match
= OVS_BE64_MAX
;
2922 f
->metadata_write
= OVS_BE64_MAX
;
2923 atomic_read_relaxed(&ofproto
->tables
[i
].miss_config
, &f
->miss_config
);
2924 f
->max_entries
= 1000000;
2926 bitmap_set_multiple(f
->nonmiss
.next
, i
+ 1,
2927 ofproto
->n_tables
- (i
+ 1), true);
2928 f
->nonmiss
.instructions
= (1u << N_OVS_INSTRUCTIONS
) - 1;
2929 if (i
== ofproto
->n_tables
- 1) {
2930 f
->nonmiss
.instructions
&= ~(1u << OVSINST_OFPIT11_GOTO_TABLE
);
2932 f
->nonmiss
.write
.ofpacts
= (UINT64_C(1) << N_OFPACTS
) - 1;
2933 f
->nonmiss
.write
.set_fields
= rw_fields
;
2934 f
->nonmiss
.apply
= f
->nonmiss
.write
;
2935 f
->miss
= f
->nonmiss
;
2939 f
->wildcard
= match
;
2943 stats
= *statsp
= xcalloc(ofproto
->n_tables
, sizeof *stats
);
2944 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2945 struct ofputil_table_stats
*s
= &stats
[i
];
2946 struct classifier
*cls
= &ofproto
->tables
[i
].cls
;
2949 s
->active_count
= classifier_count(cls
);
2955 ofproto
->ofproto_class
->query_tables(ofproto
, features
, stats
);
2957 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2958 const struct oftable
*table
= &ofproto
->tables
[i
];
2959 struct ofputil_table_features
*f
= &features
[i
];
2962 ovs_strzcpy(f
->name
, table
->name
, sizeof f
->name
);
2965 if (table
->max_flows
< f
->max_entries
) {
2966 f
->max_entries
= table
->max_flows
;
2972 query_switch_features(struct ofproto
*ofproto
,
2973 bool *arp_match_ip
, uint64_t *ofpacts
)
2975 struct ofputil_table_features
*features
, *f
;
2977 *arp_match_ip
= false;
2980 query_tables(ofproto
, &features
, NULL
);
2981 for (f
= features
; f
< &features
[ofproto
->n_tables
]; f
++) {
2982 *ofpacts
|= f
->nonmiss
.apply
.ofpacts
| f
->miss
.apply
.ofpacts
;
2983 if (bitmap_is_set(f
->match
.bm
, MFF_ARP_SPA
) ||
2984 bitmap_is_set(f
->match
.bm
, MFF_ARP_TPA
)) {
2985 *arp_match_ip
= true;
2991 ovs_assert(*ofpacts
& (UINT64_C(1) << OFPACT_OUTPUT
));
2995 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2997 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2998 struct ofputil_switch_features features
;
2999 struct ofport
*port
;
3003 query_switch_features(ofproto
, &arp_match_ip
, &features
.ofpacts
);
3005 features
.datapath_id
= ofproto
->datapath_id
;
3006 features
.n_buffers
= pktbuf_capacity();
3007 features
.n_tables
= ofproto_get_n_visible_tables(ofproto
);
3008 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
3009 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
|
3010 OFPUTIL_C_GROUP_STATS
);
3012 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
3014 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3015 features
.auxiliary_id
= 0;
3016 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
3018 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3019 ofputil_put_switch_features_port(&port
->pp
, b
);
3022 ofconn_send_reply(ofconn
, b
);
3027 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3029 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3030 struct ofp_switch_config
*osc
;
3031 enum ofp_config_flags flags
;
3035 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
3036 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
3037 flags
= ofproto
->frag_handling
;
3038 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3039 if (oh
->version
< OFP13_VERSION
3040 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
3041 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
3043 osc
->flags
= htons(flags
);
3044 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
3045 ofconn_send_reply(ofconn
, buf
);
3051 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3053 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
3054 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3055 uint16_t flags
= ntohs(osc
->flags
);
3057 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
3058 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
3059 enum ofp_config_flags cur
= ofproto
->frag_handling
;
3060 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
3062 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
3064 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
3065 ofproto
->frag_handling
= next
;
3067 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
3069 ofputil_frag_handling_to_string(next
));
3073 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3074 ofconn_set_invalid_ttl_to_controller(ofconn
,
3075 (oh
->version
< OFP13_VERSION
3076 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
3078 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
3083 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3084 * error message code for the caller to propagate upward. Otherwise, returns
3087 * The log message mentions 'msg_type'. */
3089 reject_slave_controller(struct ofconn
*ofconn
)
3091 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
3092 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
3093 return OFPERR_OFPBRC_EPERM
;
3099 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3102 * - If they use a meter, then 'ofproto' has that meter configured.
3104 * - If they use any groups, then 'ofproto' has that group configured.
3106 * Returns 0 if successful, otherwise an OpenFlow error. */
3108 ofproto_check_ofpacts(struct ofproto
*ofproto
,
3109 const struct ofpact ofpacts
[], size_t ofpacts_len
)
3111 const struct ofpact
*a
;
3114 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
3115 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
3116 return OFPERR_OFPMMFC_INVALID_METER
;
3119 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3120 if (a
->type
== OFPACT_GROUP
3121 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
3122 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
3130 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3132 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3133 struct ofputil_packet_out po
;
3134 struct ofpbuf
*payload
;
3135 uint64_t ofpacts_stub
[1024 / 8];
3136 struct ofpbuf ofpacts
;
3140 COVERAGE_INC(ofproto_packet_out
);
3142 error
= reject_slave_controller(ofconn
);
3147 /* Decode message. */
3148 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3149 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
3151 goto exit_free_ofpacts
;
3153 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
3154 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
3155 error
= OFPERR_OFPBRC_BAD_PORT
;
3156 goto exit_free_ofpacts
;
3160 if (po
.buffer_id
!= UINT32_MAX
) {
3161 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
3162 if (error
|| !payload
) {
3163 goto exit_free_ofpacts
;
3166 /* Ensure that the L3 header is 32-bit aligned. */
3167 payload
= ofpbuf_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
3170 /* Verify actions against packet, then send packet if successful. */
3171 flow_extract(payload
, NULL
, &flow
);
3172 flow
.in_port
.ofp_port
= po
.in_port
;
3173 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
3175 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
3176 po
.ofpacts
, po
.ofpacts_len
);
3178 ofpbuf_delete(payload
);
3181 ofpbuf_uninit(&ofpacts
);
3187 update_port_config(struct ofconn
*ofconn
, struct ofport
*port
,
3188 enum ofputil_port_config config
,
3189 enum ofputil_port_config mask
)
3191 enum ofputil_port_config toggle
= (config
^ port
->pp
.config
) & mask
;
3193 if (toggle
& OFPUTIL_PC_PORT_DOWN
3194 && (config
& OFPUTIL_PC_PORT_DOWN
3195 ? netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
)
3196 : netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
))) {
3197 /* We tried to bring the port up or down, but it failed, so don't
3198 * update the "down" bit. */
3199 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
3203 enum ofputil_port_config old_config
= port
->pp
.config
;
3204 port
->pp
.config
^= toggle
;
3205 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
3206 connmgr_send_port_status(port
->ofproto
->connmgr
, ofconn
, &port
->pp
,
3212 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3214 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3215 struct ofputil_port_mod pm
;
3216 struct ofport
*port
;
3219 error
= reject_slave_controller(ofconn
);
3224 error
= ofputil_decode_port_mod(oh
, &pm
, false);
3229 port
= ofproto_get_port(p
, pm
.port_no
);
3231 return OFPERR_OFPPMFC_BAD_PORT
;
3232 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
3233 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3235 update_port_config(ofconn
, port
, pm
.config
, pm
.mask
);
3237 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
3244 handle_desc_stats_request(struct ofconn
*ofconn
,
3245 const struct ofp_header
*request
)
3247 static const char *default_mfr_desc
= "Nicira, Inc.";
3248 static const char *default_hw_desc
= "Open vSwitch";
3249 static const char *default_sw_desc
= VERSION
;
3250 static const char *default_serial_desc
= "None";
3251 static const char *default_dp_desc
= "None";
3253 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3254 struct ofp_desc_stats
*ods
;
3257 msg
= ofpraw_alloc_stats_reply(request
, 0);
3258 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3259 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3260 sizeof ods
->mfr_desc
);
3261 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3262 sizeof ods
->hw_desc
);
3263 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3264 sizeof ods
->sw_desc
);
3265 ovs_strlcpy(ods
->serial_num
,
3266 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3267 sizeof ods
->serial_num
);
3268 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3269 sizeof ods
->dp_desc
);
3270 ofconn_send_reply(ofconn
, msg
);
3276 handle_table_stats_request(struct ofconn
*ofconn
,
3277 const struct ofp_header
*request
)
3279 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3280 struct ofputil_table_features
*features
;
3281 struct ofputil_table_stats
*stats
;
3282 struct ofpbuf
*reply
;
3285 query_tables(ofproto
, &features
, &stats
);
3287 reply
= ofputil_encode_table_stats_reply(request
);
3288 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3289 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3290 ofputil_append_table_stats_reply(reply
, &stats
[i
], &features
[i
]);
3293 ofconn_send_reply(ofconn
, reply
);
3302 handle_table_features_request(struct ofconn
*ofconn
,
3303 const struct ofp_header
*request
)
3305 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3306 struct ofputil_table_features
*features
;
3307 struct list replies
;
3311 ofpbuf_use_const(&msg
, request
, ntohs(request
->length
));
3312 ofpraw_pull_assert(&msg
);
3313 if (ofpbuf_size(&msg
) || ofpmp_more(request
)) {
3314 return OFPERR_OFPTFFC_EPERM
;
3317 query_tables(ofproto
, &features
, NULL
);
3319 ofpmp_init(&replies
, request
);
3320 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3321 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3322 ofputil_append_table_features_reply(&features
[i
], &replies
);
3325 ofconn_send_replies(ofconn
, &replies
);
3333 append_port_stat(struct ofport
*port
, struct list
*replies
)
3335 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3337 calc_duration(port
->created
, time_msec(),
3338 &ops
.duration_sec
, &ops
.duration_nsec
);
3340 /* Intentionally ignore return value, since errors will set
3341 * 'stats' to all-1s, which is correct for OpenFlow, and
3342 * netdev_get_stats() will log errors. */
3343 ofproto_port_get_stats(port
, &ops
.stats
);
3345 ofputil_append_port_stat(replies
, &ops
);
3349 handle_port_request(struct ofconn
*ofconn
,
3350 const struct ofp_header
*request
, ofp_port_t port_no
,
3351 void (*cb
)(struct ofport
*, struct list
*replies
))
3353 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3354 struct ofport
*port
;
3355 struct list replies
;
3357 ofpmp_init(&replies
, request
);
3358 if (port_no
!= OFPP_ANY
) {
3359 port
= ofproto_get_port(ofproto
, port_no
);
3364 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3369 ofconn_send_replies(ofconn
, &replies
);
3373 handle_port_stats_request(struct ofconn
*ofconn
,
3374 const struct ofp_header
*request
)
3379 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3381 handle_port_request(ofconn
, request
, port_no
, append_port_stat
);
3387 append_port_desc(struct ofport
*port
, struct list
*replies
)
3389 ofputil_append_port_desc_stats_reply(&port
->pp
, replies
);
3393 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3394 const struct ofp_header
*request
)
3399 error
= ofputil_decode_port_desc_stats_request(request
, &port_no
);
3401 handle_port_request(ofconn
, request
, port_no
, append_port_desc
);
3407 hash_cookie(ovs_be64 cookie
)
3409 return hash_uint64((OVS_FORCE
uint64_t)cookie
);
3413 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3414 OVS_REQUIRES(ofproto_mutex
)
3416 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3417 hash_cookie(rule
->flow_cookie
));
3421 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3422 OVS_REQUIRES(ofproto_mutex
)
3424 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3428 calc_duration(long long int start
, long long int now
,
3429 uint32_t *sec
, uint32_t *nsec
)
3431 long long int msecs
= now
- start
;
3432 *sec
= msecs
/ 1000;
3433 *nsec
= (msecs
% 1000) * (1000 * 1000);
3436 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3437 * true if 'table_id' is OK, false otherwise. */
3439 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3441 return table_id
== OFPTT_ALL
|| table_id
< ofproto
->n_tables
;
3444 static struct oftable
*
3445 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3447 struct oftable
*table
;
3449 for (table
= &ofproto
->tables
[table_id
];
3450 table
< &ofproto
->tables
[ofproto
->n_tables
];
3452 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3460 static struct oftable
*
3461 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3463 if (table_id
== 0xff) {
3464 return next_visible_table(ofproto
, 0);
3465 } else if (table_id
< ofproto
->n_tables
) {
3466 return &ofproto
->tables
[table_id
];
3472 static struct oftable
*
3473 next_matching_table(const struct ofproto
*ofproto
,
3474 const struct oftable
*table
, uint8_t table_id
)
3476 return (table_id
== 0xff
3477 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3481 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3483 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3484 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3486 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3487 * only once, for that table. (This can be used to access tables marked
3490 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3491 * entered at all. (Perhaps you should have validated TABLE_ID with
3492 * check_table_id().)
3494 * All parameters are evaluated multiple times.
3496 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3497 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3499 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3501 /* Initializes 'criteria' in a straightforward way based on the other
3504 * By default, the criteria include flows that are read-only, on the assumption
3505 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3506 * if flows will be modified.
3508 * For "loose" matching, the 'priority' parameter is unimportant and may be
3511 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3512 const struct match
*match
, int priority
,
3513 ovs_be64 cookie
, ovs_be64 cookie_mask
,
3514 ofp_port_t out_port
, uint32_t out_group
)
3516 criteria
->table_id
= table_id
;
3517 cls_rule_init(&criteria
->cr
, match
, priority
);
3518 criteria
->cookie
= cookie
;
3519 criteria
->cookie_mask
= cookie_mask
;
3520 criteria
->out_port
= out_port
;
3521 criteria
->out_group
= out_group
;
3523 /* We ordinarily want to skip hidden rules, but there has to be a way for
3524 * code internal to OVS to modify and delete them, so if the criteria
3525 * specify a priority that can only be for a hidden flow, then allow hidden
3526 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3527 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3529 criteria
->include_hidden
= priority
> UINT16_MAX
;
3531 /* We assume that the criteria are being used to collect flows for reading
3532 * but not modification. Thus, we should collect read-only flows. */
3533 criteria
->include_readonly
= true;
3536 /* By default, criteria initialized by rule_criteria_init() will match flows
3537 * that are read-only, on the assumption that the collected flows won't be
3538 * modified. Call this function to match only flows that are be modifiable.
3540 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3541 * caller has special privileges that allow it to modify even "read-only"
3544 rule_criteria_require_rw(struct rule_criteria
*criteria
,
3545 bool can_write_readonly
)
3547 criteria
->include_readonly
= can_write_readonly
;
3551 rule_criteria_destroy(struct rule_criteria
*criteria
)
3553 cls_rule_destroy(&criteria
->cr
);
3557 rule_collection_init(struct rule_collection
*rules
)
3559 rules
->rules
= rules
->stub
;
3561 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
3565 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
3567 if (rules
->n
>= rules
->capacity
) {
3568 size_t old_size
, new_size
;
3570 old_size
= rules
->capacity
* sizeof *rules
->rules
;
3571 rules
->capacity
*= 2;
3572 new_size
= rules
->capacity
* sizeof *rules
->rules
;
3574 if (rules
->rules
== rules
->stub
) {
3575 rules
->rules
= xmalloc(new_size
);
3576 memcpy(rules
->rules
, rules
->stub
, old_size
);
3578 rules
->rules
= xrealloc(rules
->rules
, new_size
);
3582 rules
->rules
[rules
->n
++] = rule
;
3586 rule_collection_ref(struct rule_collection
*rules
)
3587 OVS_REQUIRES(ofproto_mutex
)
3591 for (i
= 0; i
< rules
->n
; i
++) {
3592 ofproto_rule_ref(rules
->rules
[i
]);
3597 rule_collection_unref(struct rule_collection
*rules
)
3601 for (i
= 0; i
< rules
->n
; i
++) {
3602 ofproto_rule_unref(rules
->rules
[i
]);
3607 rule_collection_destroy(struct rule_collection
*rules
)
3609 if (rules
->rules
!= rules
->stub
) {
3613 /* Make repeated destruction harmless. */
3614 rule_collection_init(rules
);
3617 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3618 * function verifies most of the criteria in 'c' itself, but the caller must
3619 * check 'c->cr' itself.
3621 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3622 * 'c' only includes modifiable rules). */
3624 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
3625 struct rule_collection
*rules
, size_t *n_readonly
)
3626 OVS_REQUIRES(ofproto_mutex
)
3628 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
3629 && ofproto_rule_has_out_port(rule
, c
->out_port
)
3630 && ofproto_rule_has_out_group(rule
, c
->out_group
)
3631 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)
3632 && (!rule_is_hidden(rule
) || c
->include_hidden
)) {
3633 /* Rule matches all the criteria... */
3634 if (!rule_is_readonly(rule
) || c
->include_readonly
) {
3636 rule_collection_add(rules
, rule
);
3638 /* ...except it's read-only. */
3644 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3645 * on classifiers rules are done in the "loose" way required for OpenFlow
3646 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3649 * Returns 0 on success, otherwise an OpenFlow error code. */
3651 collect_rules_loose(struct ofproto
*ofproto
,
3652 const struct rule_criteria
*criteria
,
3653 struct rule_collection
*rules
)
3654 OVS_REQUIRES(ofproto_mutex
)
3656 struct oftable
*table
;
3657 enum ofperr error
= 0;
3658 size_t n_readonly
= 0;
3660 rule_collection_init(rules
);
3662 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3663 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3667 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3670 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3671 hash_cookie(criteria
->cookie
),
3672 &ofproto
->cookies
) {
3673 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
3674 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3678 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3681 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &criteria
->cr
) {
3682 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3688 if (!error
&& !rules
->n
&& n_readonly
) {
3689 /* We didn't find any rules to modify. We did find some read-only
3690 * rules that we're not allowed to modify, so report that. */
3691 error
= OFPERR_OFPBRC_EPERM
;
3694 rule_collection_destroy(rules
);
3699 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3700 * on classifiers rules are done in the "strict" way required for OpenFlow
3701 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3702 * rules on list 'rules'.
3704 * Returns 0 on success, otherwise an OpenFlow error code. */
3706 collect_rules_strict(struct ofproto
*ofproto
,
3707 const struct rule_criteria
*criteria
,
3708 struct rule_collection
*rules
)
3709 OVS_REQUIRES(ofproto_mutex
)
3711 struct oftable
*table
;
3712 size_t n_readonly
= 0;
3715 rule_collection_init(rules
);
3717 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3718 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3722 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3725 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3726 hash_cookie(criteria
->cookie
),
3727 &ofproto
->cookies
) {
3728 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
3729 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3733 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3736 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
3737 &table
->cls
, &criteria
->cr
));
3739 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3745 if (!error
&& !rules
->n
&& n_readonly
) {
3746 /* We didn't find any rules to modify. We did find some read-only
3747 * rules that we're not allowed to modify, so report that. */
3748 error
= OFPERR_OFPBRC_EPERM
;
3751 rule_collection_destroy(rules
);
3756 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3757 * forced into the range of a uint16_t. */
3759 age_secs(long long int age_ms
)
3761 return (age_ms
< 0 ? 0
3762 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
3763 : (unsigned int) age_ms
/ 1000);
3767 handle_flow_stats_request(struct ofconn
*ofconn
,
3768 const struct ofp_header
*request
)
3769 OVS_EXCLUDED(ofproto_mutex
)
3771 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3772 struct ofputil_flow_stats_request fsr
;
3773 struct rule_criteria criteria
;
3774 struct rule_collection rules
;
3775 struct list replies
;
3779 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
3784 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, fsr
.cookie
,
3785 fsr
.cookie_mask
, fsr
.out_port
, fsr
.out_group
);
3787 ovs_mutex_lock(&ofproto_mutex
);
3788 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3789 rule_criteria_destroy(&criteria
);
3791 rule_collection_ref(&rules
);
3793 ovs_mutex_unlock(&ofproto_mutex
);
3799 ofpmp_init(&replies
, request
);
3800 for (i
= 0; i
< rules
.n
; i
++) {
3801 struct rule
*rule
= rules
.rules
[i
];
3802 long long int now
= time_msec();
3803 struct ofputil_flow_stats fs
;
3804 long long int created
, used
, modified
;
3805 const struct rule_actions
*actions
;
3806 enum ofputil_flow_mod_flags flags
;
3808 ovs_mutex_lock(&rule
->mutex
);
3809 fs
.cookie
= rule
->flow_cookie
;
3810 fs
.idle_timeout
= rule
->idle_timeout
;
3811 fs
.hard_timeout
= rule
->hard_timeout
;
3812 created
= rule
->created
;
3813 modified
= rule
->modified
;
3814 actions
= rule_get_actions(rule
);
3815 flags
= rule
->flags
;
3816 ovs_mutex_unlock(&rule
->mutex
);
3818 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
3819 &fs
.byte_count
, &used
);
3821 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
3822 fs
.table_id
= rule
->table_id
;
3823 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
3824 fs
.priority
= rule
->cr
.priority
;
3825 fs
.idle_age
= age_secs(now
- used
);
3826 fs
.hard_age
= age_secs(now
- modified
);
3827 fs
.ofpacts
= actions
->ofpacts
;
3828 fs
.ofpacts_len
= actions
->ofpacts_len
;
3831 ofputil_append_flow_stats_reply(&fs
, &replies
);
3834 rule_collection_unref(&rules
);
3835 rule_collection_destroy(&rules
);
3837 ofconn_send_replies(ofconn
, &replies
);
3843 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
3845 uint64_t packet_count
, byte_count
;
3846 const struct rule_actions
*actions
;
3847 long long int created
, used
;
3849 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3850 &byte_count
, &used
);
3852 ovs_mutex_lock(&rule
->mutex
);
3853 actions
= rule_get_actions(rule
);
3854 created
= rule
->created
;
3855 ovs_mutex_unlock(&rule
->mutex
);
3857 if (rule
->table_id
!= 0) {
3858 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
3860 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
3861 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
3862 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
3863 cls_rule_format(&rule
->cr
, results
);
3864 ds_put_char(results
, ',');
3866 ds_put_cstr(results
, "actions=");
3867 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
3869 ds_put_cstr(results
, "\n");
3872 /* Adds a pretty-printed description of all flows to 'results', including
3873 * hidden flows (e.g., set up by in-band control). */
3875 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
3877 struct oftable
*table
;
3879 OFPROTO_FOR_EACH_TABLE (table
, p
) {
3882 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
3883 flow_stats_ds(rule
, results
);
3888 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3889 * '*engine_type' and '*engine_id', respectively. */
3891 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
3892 uint8_t *engine_type
, uint8_t *engine_id
)
3894 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
3897 /* Checks the status change of CFM on 'ofport'.
3899 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
3901 ofproto_port_cfm_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
3903 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3904 return (ofport
&& ofproto
->ofproto_class
->cfm_status_changed
3905 ? ofproto
->ofproto_class
->cfm_status_changed(ofport
)
3909 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3910 * Returns 0 if the port's CFM status was successfully stored into
3911 * '*status'. Returns positive errno if the port did not have CFM
3914 * The caller must provide and own '*status', and must free 'status->rmps'.
3915 * '*status' is indeterminate if the return value is non-zero. */
3917 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
3918 struct cfm_status
*status
)
3920 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3921 return (ofport
&& ofproto
->ofproto_class
->get_cfm_status
3922 ? ofproto
->ofproto_class
->get_cfm_status(ofport
, status
)
3927 handle_aggregate_stats_request(struct ofconn
*ofconn
,
3928 const struct ofp_header
*oh
)
3929 OVS_EXCLUDED(ofproto_mutex
)
3931 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3932 struct ofputil_flow_stats_request request
;
3933 struct ofputil_aggregate_stats stats
;
3934 bool unknown_packets
, unknown_bytes
;
3935 struct rule_criteria criteria
;
3936 struct rule_collection rules
;
3937 struct ofpbuf
*reply
;
3941 error
= ofputil_decode_flow_stats_request(&request
, oh
);
3946 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
3947 request
.cookie
, request
.cookie_mask
,
3948 request
.out_port
, request
.out_group
);
3950 ovs_mutex_lock(&ofproto_mutex
);
3951 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3952 rule_criteria_destroy(&criteria
);
3954 rule_collection_ref(&rules
);
3956 ovs_mutex_unlock(&ofproto_mutex
);
3962 memset(&stats
, 0, sizeof stats
);
3963 unknown_packets
= unknown_bytes
= false;
3964 for (i
= 0; i
< rules
.n
; i
++) {
3965 struct rule
*rule
= rules
.rules
[i
];
3966 uint64_t packet_count
;
3967 uint64_t byte_count
;
3970 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3971 &byte_count
, &used
);
3973 if (packet_count
== UINT64_MAX
) {
3974 unknown_packets
= true;
3976 stats
.packet_count
+= packet_count
;
3979 if (byte_count
== UINT64_MAX
) {
3980 unknown_bytes
= true;
3982 stats
.byte_count
+= byte_count
;
3987 if (unknown_packets
) {
3988 stats
.packet_count
= UINT64_MAX
;
3990 if (unknown_bytes
) {
3991 stats
.byte_count
= UINT64_MAX
;
3994 rule_collection_unref(&rules
);
3995 rule_collection_destroy(&rules
);
3997 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
3998 ofconn_send_reply(ofconn
, reply
);
4003 struct queue_stats_cbdata
{
4004 struct ofport
*ofport
;
4005 struct list replies
;
4010 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
4011 const struct netdev_queue_stats
*stats
)
4013 struct ofputil_queue_stats oqs
;
4015 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
4016 oqs
.queue_id
= queue_id
;
4017 oqs
.tx_bytes
= stats
->tx_bytes
;
4018 oqs
.tx_packets
= stats
->tx_packets
;
4019 oqs
.tx_errors
= stats
->tx_errors
;
4020 if (stats
->created
!= LLONG_MIN
) {
4021 calc_duration(stats
->created
, cbdata
->now
,
4022 &oqs
.duration_sec
, &oqs
.duration_nsec
);
4024 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
4026 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
4030 handle_queue_stats_dump_cb(uint32_t queue_id
,
4031 struct netdev_queue_stats
*stats
,
4034 struct queue_stats_cbdata
*cbdata
= cbdata_
;
4036 put_queue_stats(cbdata
, queue_id
, stats
);
4040 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
4041 struct queue_stats_cbdata
*cbdata
)
4043 cbdata
->ofport
= port
;
4044 if (queue_id
== OFPQ_ALL
) {
4045 netdev_dump_queue_stats(port
->netdev
,
4046 handle_queue_stats_dump_cb
, cbdata
);
4048 struct netdev_queue_stats stats
;
4050 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
4051 put_queue_stats(cbdata
, queue_id
, &stats
);
4053 return OFPERR_OFPQOFC_BAD_QUEUE
;
4060 handle_queue_stats_request(struct ofconn
*ofconn
,
4061 const struct ofp_header
*rq
)
4063 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4064 struct queue_stats_cbdata cbdata
;
4065 struct ofport
*port
;
4067 struct ofputil_queue_stats_request oqsr
;
4069 COVERAGE_INC(ofproto_queue_req
);
4071 ofpmp_init(&cbdata
.replies
, rq
);
4072 cbdata
.now
= time_msec();
4074 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
4079 if (oqsr
.port_no
== OFPP_ANY
) {
4080 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
4081 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
4082 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
4087 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
4089 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
4090 : OFPERR_OFPQOFC_BAD_PORT
);
4093 ofconn_send_replies(ofconn
, &cbdata
.replies
);
4095 ofpbuf_list_delete(&cbdata
.replies
);
4102 should_evict_a_rule(struct oftable
*table
, unsigned int extra_space
)
4103 OVS_REQUIRES(ofproto_mutex
)
4104 OVS_NO_THREAD_SAFETY_ANALYSIS
4106 return classifier_count(&table
->cls
) + extra_space
> table
->max_flows
;
4110 evict_rules_from_table(struct oftable
*table
, unsigned int extra_space
)
4111 OVS_REQUIRES(ofproto_mutex
)
4113 while (should_evict_a_rule(table
, extra_space
)) {
4116 if (!choose_rule_to_evict(table
, &rule
)) {
4117 return OFPERR_OFPFMFC_TABLE_FULL
;
4119 ofproto_rule_delete__(rule
, OFPRR_EVICTION
);
4126 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4127 * in which no matching flow already exists in the flow table.
4129 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4130 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4131 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4132 * initiated now but may be retried later.
4134 * The caller retains ownership of 'fm->ofpacts'.
4136 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4139 add_flow(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4140 const struct flow_mod_requester
*req
)
4141 OVS_REQUIRES(ofproto_mutex
)
4143 const struct rule_actions
*actions
;
4144 struct oftable
*table
;
4150 if (!check_table_id(ofproto
, fm
->table_id
)) {
4151 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4156 if (fm
->table_id
== 0xff) {
4157 if (ofproto
->ofproto_class
->rule_choose_table
) {
4158 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
4164 ovs_assert(table_id
< ofproto
->n_tables
);
4168 } else if (fm
->table_id
< ofproto
->n_tables
) {
4169 table_id
= fm
->table_id
;
4171 return OFPERR_OFPBRC_BAD_TABLE_ID
;
4174 table
= &ofproto
->tables
[table_id
];
4175 if (table
->flags
& OFTABLE_READONLY
4176 && !(fm
->flags
& OFPUTIL_FF_NO_READONLY
)) {
4177 return OFPERR_OFPBRC_EPERM
;
4180 if (!(fm
->flags
& OFPUTIL_FF_HIDDEN_FIELDS
)) {
4181 if (!match_has_default_hidden_fields(&fm
->match
)) {
4182 VLOG_WARN_RL(&rl
, "%s: (add_flow) only internal flows can set "
4183 "non-default values to hidden fields", ofproto
->name
);
4184 return OFPERR_OFPBRC_EPERM
;
4188 cls_rule_init(&cr
, &fm
->match
, fm
->priority
);
4190 /* Transform "add" into "modify" if there's an existing identical flow. */
4191 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
));
4193 struct rule_collection rules
;
4195 cls_rule_destroy(&cr
);
4197 rule_collection_init(&rules
);
4198 rule_collection_add(&rules
, rule
);
4199 fm
->modify_cookie
= true;
4200 error
= modify_flows__(ofproto
, fm
, &rules
, req
);
4201 rule_collection_destroy(&rules
);
4206 /* Check for overlap, if requested. */
4207 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
) {
4208 if (classifier_rule_overlaps(&table
->cls
, &cr
)) {
4209 cls_rule_destroy(&cr
);
4210 return OFPERR_OFPFMFC_OVERLAP
;
4214 /* If necessary, evict an existing rule to clear out space. */
4215 error
= evict_rules_from_table(table
, 1);
4217 cls_rule_destroy(&cr
);
4221 /* Allocate new rule. */
4222 rule
= ofproto
->ofproto_class
->rule_alloc();
4224 cls_rule_destroy(&cr
);
4225 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
4226 ofproto
->name
, ovs_strerror(error
));
4230 /* Initialize base state. */
4231 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4232 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), &cr
);
4233 ovs_refcount_init(&rule
->ref_count
);
4234 rule
->flow_cookie
= fm
->new_cookie
;
4235 rule
->created
= rule
->modified
= time_msec();
4237 ovs_mutex_init(&rule
->mutex
);
4238 ovs_mutex_lock(&rule
->mutex
);
4239 rule
->idle_timeout
= fm
->idle_timeout
;
4240 rule
->hard_timeout
= fm
->hard_timeout
;
4241 ovs_mutex_unlock(&rule
->mutex
);
4243 *CONST_CAST(uint8_t *, &rule
->table_id
) = table
- ofproto
->tables
;
4244 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4245 actions
= rule_actions_create(fm
->ofpacts
, fm
->ofpacts_len
);
4246 ovsrcu_set(&rule
->actions
, actions
);
4247 list_init(&rule
->meter_list_node
);
4248 rule
->eviction_group
= NULL
;
4249 list_init(&rule
->expirable
);
4250 rule
->monitor_flags
= 0;
4251 rule
->add_seqno
= 0;
4252 rule
->modify_seqno
= 0;
4254 /* Construct rule, initializing derived state. */
4255 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4257 ofproto_rule_destroy__(rule
);
4261 if (fm
->hard_timeout
|| fm
->idle_timeout
) {
4262 list_insert(&ofproto
->expirable
, &rule
->expirable
);
4264 cookies_insert(ofproto
, rule
);
4265 eviction_group_add_rule(rule
);
4266 if (actions
->has_meter
) {
4267 meter_insert_rule(rule
);
4270 classifier_insert(&table
->cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
4272 error
= ofproto
->ofproto_class
->rule_insert(rule
);
4274 oftable_remove_rule(rule
);
4275 ofproto_rule_unref(rule
);
4278 learned_cookies_inc(ofproto
, actions
);
4280 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
4281 if (ofproto
->vlan_bitmap
) {
4282 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
4283 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
4284 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
4285 ofproto
->vlans_changed
= true;
4288 ofproto
->vlans_changed
= true;
4292 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_ADDED
, 0,
4293 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0, NULL
);
4295 return req
? send_buffered_packet(req
->ofconn
, fm
->buffer_id
, rule
) : 0;
4298 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4300 /* Modifies the rules listed in 'rules', changing their actions to match those
4303 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4306 * Returns 0 on success, otherwise an OpenFlow error code. */
4308 modify_flows__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4309 const struct rule_collection
*rules
,
4310 const struct flow_mod_requester
*req
)
4311 OVS_REQUIRES(ofproto_mutex
)
4313 struct list dead_cookies
= LIST_INITIALIZER(&dead_cookies
);
4314 enum nx_flow_update_event event
;
4317 if (ofproto
->ofproto_class
->rule_premodify_actions
) {
4318 for (i
= 0; i
< rules
->n
; i
++) {
4319 struct rule
*rule
= rules
->rules
[i
];
4322 error
= ofproto
->ofproto_class
->rule_premodify_actions(
4323 rule
, fm
->ofpacts
, fm
->ofpacts_len
);
4330 event
= fm
->command
== OFPFC_ADD
? NXFME_ADDED
: NXFME_MODIFIED
;
4331 for (i
= 0; i
< rules
->n
; i
++) {
4332 struct rule
*rule
= rules
->rules
[i
];
4334 /* 'fm' says that */
4335 bool change_cookie
= (fm
->modify_cookie
4336 && fm
->new_cookie
!= OVS_BE64_MAX
4337 && fm
->new_cookie
!= rule
->flow_cookie
);
4339 const struct rule_actions
*actions
= rule_get_actions(rule
);
4340 bool change_actions
= !ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
4342 actions
->ofpacts_len
);
4344 bool reset_counters
= (fm
->flags
& OFPUTIL_FF_RESET_COUNTS
) != 0;
4346 long long int now
= time_msec();
4348 if (change_cookie
) {
4349 cookies_remove(ofproto
, rule
);
4352 ovs_mutex_lock(&rule
->mutex
);
4353 if (fm
->command
== OFPFC_ADD
) {
4354 rule
->idle_timeout
= fm
->idle_timeout
;
4355 rule
->hard_timeout
= fm
->hard_timeout
;
4356 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4357 rule
->created
= now
;
4359 if (change_cookie
) {
4360 rule
->flow_cookie
= fm
->new_cookie
;
4362 rule
->modified
= now
;
4363 ovs_mutex_unlock(&rule
->mutex
);
4365 if (change_cookie
) {
4366 cookies_insert(ofproto
, rule
);
4368 if (fm
->command
== OFPFC_ADD
) {
4369 if (fm
->idle_timeout
|| fm
->hard_timeout
) {
4370 if (!rule
->eviction_group
) {
4371 eviction_group_add_rule(rule
);
4374 eviction_group_remove_rule(rule
);
4378 if (change_actions
) {
4379 ovsrcu_set(&rule
->actions
, rule_actions_create(fm
->ofpacts
,
4383 if (change_actions
|| reset_counters
) {
4384 ofproto
->ofproto_class
->rule_modify_actions(rule
, reset_counters
);
4387 if (event
!= NXFME_MODIFIED
|| change_actions
|| change_cookie
) {
4388 ofmonitor_report(ofproto
->connmgr
, rule
, event
, 0,
4389 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0,
4390 change_actions
? actions
: NULL
);
4393 if (change_actions
) {
4394 learned_cookies_inc(ofproto
, rule_get_actions(rule
));
4395 learned_cookies_dec(ofproto
, actions
, &dead_cookies
);
4396 rule_actions_destroy(actions
);
4399 learned_cookies_flush(ofproto
, &dead_cookies
);
4401 if (fm
->buffer_id
!= UINT32_MAX
&& req
) {
4402 return send_buffered_packet(req
->ofconn
, fm
->buffer_id
,
4410 modify_flows_add(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4411 const struct flow_mod_requester
*req
)
4412 OVS_REQUIRES(ofproto_mutex
)
4414 if (fm
->cookie_mask
!= htonll(0) || fm
->new_cookie
== OVS_BE64_MAX
) {
4417 return add_flow(ofproto
, fm
, req
);
4420 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4423 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4426 modify_flows_loose(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4427 const struct flow_mod_requester
*req
)
4428 OVS_REQUIRES(ofproto_mutex
)
4430 struct rule_criteria criteria
;
4431 struct rule_collection rules
;
4434 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4435 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4436 rule_criteria_require_rw(&criteria
,
4437 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4438 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4439 rule_criteria_destroy(&criteria
);
4442 error
= (rules
.n
> 0
4443 ? modify_flows__(ofproto
, fm
, &rules
, req
)
4444 : modify_flows_add(ofproto
, fm
, req
));
4447 rule_collection_destroy(&rules
);
4452 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4453 * code on failure. */
4455 modify_flow_strict(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4456 const struct flow_mod_requester
*req
)
4457 OVS_REQUIRES(ofproto_mutex
)
4459 struct rule_criteria criteria
;
4460 struct rule_collection rules
;
4463 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4464 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4465 rule_criteria_require_rw(&criteria
,
4466 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4467 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4468 rule_criteria_destroy(&criteria
);
4472 error
= modify_flows_add(ofproto
, fm
, req
);
4473 } else if (rules
.n
== 1) {
4474 error
= modify_flows__(ofproto
, fm
, &rules
, req
);
4478 rule_collection_destroy(&rules
);
4483 /* OFPFC_DELETE implementation. */
4485 /* Deletes the rules listed in 'rules'. */
4487 delete_flows__(const struct rule_collection
*rules
,
4488 enum ofp_flow_removed_reason reason
,
4489 const struct flow_mod_requester
*req
)
4490 OVS_REQUIRES(ofproto_mutex
)
4493 struct list dead_cookies
= LIST_INITIALIZER(&dead_cookies
);
4494 struct ofproto
*ofproto
= rules
->rules
[0]->ofproto
;
4497 for (i
= 0; i
< rules
->n
; i
++) {
4498 struct rule
*rule
= rules
->rules
[i
];
4499 const struct rule_actions
*actions
= rule_get_actions(rule
);
4501 ofproto_rule_send_removed(rule
, reason
);
4503 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_DELETED
, reason
,
4504 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0,
4506 oftable_remove_rule(rule
);
4507 ofproto
->ofproto_class
->rule_delete(rule
);
4509 learned_cookies_dec(ofproto
, actions
, &dead_cookies
);
4511 learned_cookies_flush(ofproto
, &dead_cookies
);
4512 ofmonitor_flush(ofproto
->connmgr
);
4516 /* Implements OFPFC_DELETE. */
4518 delete_flows_loose(struct ofproto
*ofproto
,
4519 const struct ofputil_flow_mod
*fm
,
4520 const struct flow_mod_requester
*req
)
4521 OVS_REQUIRES(ofproto_mutex
)
4523 struct rule_criteria criteria
;
4524 struct rule_collection rules
;
4527 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4528 fm
->cookie
, fm
->cookie_mask
,
4529 fm
->out_port
, fm
->out_group
);
4530 rule_criteria_require_rw(&criteria
,
4531 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4532 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4533 rule_criteria_destroy(&criteria
);
4535 if (!error
&& rules
.n
> 0) {
4536 delete_flows__(&rules
, fm
->delete_reason
, req
);
4538 rule_collection_destroy(&rules
);
4543 /* Implements OFPFC_DELETE_STRICT. */
4545 delete_flow_strict(struct ofproto
*ofproto
, const struct ofputil_flow_mod
*fm
,
4546 const struct flow_mod_requester
*req
)
4547 OVS_REQUIRES(ofproto_mutex
)
4549 struct rule_criteria criteria
;
4550 struct rule_collection rules
;
4553 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4554 fm
->cookie
, fm
->cookie_mask
,
4555 fm
->out_port
, fm
->out_group
);
4556 rule_criteria_require_rw(&criteria
,
4557 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4558 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4559 rule_criteria_destroy(&criteria
);
4561 if (!error
&& rules
.n
> 0) {
4562 delete_flows__(&rules
, fm
->delete_reason
, req
);
4564 rule_collection_destroy(&rules
);
4570 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
4571 OVS_REQUIRES(ofproto_mutex
)
4573 struct ofputil_flow_removed fr
;
4576 if (rule_is_hidden(rule
) ||
4577 !(rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
)) {
4581 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
4582 fr
.priority
= rule
->cr
.priority
;
4583 fr
.cookie
= rule
->flow_cookie
;
4585 fr
.table_id
= rule
->table_id
;
4586 calc_duration(rule
->created
, time_msec(),
4587 &fr
.duration_sec
, &fr
.duration_nsec
);
4588 ovs_mutex_lock(&rule
->mutex
);
4589 fr
.idle_timeout
= rule
->idle_timeout
;
4590 fr
.hard_timeout
= rule
->hard_timeout
;
4591 ovs_mutex_unlock(&rule
->mutex
);
4592 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
4593 &fr
.byte_count
, &used
);
4595 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
4598 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4599 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4602 * ofproto implementation ->run() functions should use this function to expire
4603 * OpenFlow flows. */
4605 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
4606 OVS_REQUIRES(ofproto_mutex
)
4608 ofproto_rule_delete__(rule
, reason
);
4611 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4612 * means "infinite". */
4614 reduce_timeout(uint16_t max
, uint16_t *timeout
)
4616 if (max
&& (!*timeout
|| *timeout
> max
)) {
4621 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4622 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4623 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4625 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4627 ofproto_rule_reduce_timeouts(struct rule
*rule
,
4628 uint16_t idle_timeout
, uint16_t hard_timeout
)
4629 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
4631 if (!idle_timeout
&& !hard_timeout
) {
4635 ovs_mutex_lock(&ofproto_mutex
);
4636 if (list_is_empty(&rule
->expirable
)) {
4637 list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
4639 ovs_mutex_unlock(&ofproto_mutex
);
4641 ovs_mutex_lock(&rule
->mutex
);
4642 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
4643 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
4644 ovs_mutex_unlock(&rule
->mutex
);
4648 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4649 OVS_EXCLUDED(ofproto_mutex
)
4651 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4652 struct ofputil_flow_mod fm
;
4653 uint64_t ofpacts_stub
[1024 / 8];
4654 struct ofpbuf ofpacts
;
4657 error
= reject_slave_controller(ofconn
);
4662 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
4663 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
4665 u16_to_ofp(ofproto
->max_ports
),
4668 error
= ofproto_check_ofpacts(ofproto
, fm
.ofpacts
, fm
.ofpacts_len
);
4671 struct flow_mod_requester req
;
4673 req
.ofconn
= ofconn
;
4675 error
= handle_flow_mod__(ofproto
, &fm
, &req
);
4678 goto exit_free_ofpacts
;
4681 ofconn_report_flow_mod(ofconn
, fm
.command
);
4684 ofpbuf_uninit(&ofpacts
);
4690 handle_flow_mod__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4691 const struct flow_mod_requester
*req
)
4692 OVS_EXCLUDED(ofproto_mutex
)
4696 ovs_mutex_lock(&ofproto_mutex
);
4697 switch (fm
->command
) {
4699 error
= add_flow(ofproto
, fm
, req
);
4703 error
= modify_flows_loose(ofproto
, fm
, req
);
4706 case OFPFC_MODIFY_STRICT
:
4707 error
= modify_flow_strict(ofproto
, fm
, req
);
4711 error
= delete_flows_loose(ofproto
, fm
, req
);
4714 case OFPFC_DELETE_STRICT
:
4715 error
= delete_flow_strict(ofproto
, fm
, req
);
4719 if (fm
->command
> 0xff) {
4720 VLOG_WARN_RL(&rl
, "%s: flow_mod has explicit table_id but "
4721 "flow_mod_table_id extension is not enabled",
4724 error
= OFPERR_OFPFMFC_BAD_COMMAND
;
4727 ofmonitor_flush(ofproto
->connmgr
);
4728 ovs_mutex_unlock(&ofproto_mutex
);
4730 run_rule_executes(ofproto
);
4735 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4737 struct ofputil_role_request request
;
4738 struct ofputil_role_request reply
;
4742 error
= ofputil_decode_role_message(oh
, &request
);
4747 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
4748 if (request
.have_generation_id
4749 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
4750 return OFPERR_OFPRRFC_STALE
;
4753 ofconn_set_role(ofconn
, request
.role
);
4756 reply
.role
= ofconn_get_role(ofconn
);
4757 reply
.have_generation_id
= ofconn_get_master_election_id(
4758 ofconn
, &reply
.generation_id
);
4759 buf
= ofputil_encode_role_reply(oh
, &reply
);
4760 ofconn_send_reply(ofconn
, buf
);
4766 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
4767 const struct ofp_header
*oh
)
4769 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
4770 enum ofputil_protocol cur
, next
;
4772 cur
= ofconn_get_protocol(ofconn
);
4773 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
4774 ofconn_set_protocol(ofconn
, next
);
4780 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4782 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
4783 enum ofputil_protocol cur
, next
;
4784 enum ofputil_protocol next_base
;
4786 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
4788 return OFPERR_OFPBRC_EPERM
;
4791 cur
= ofconn_get_protocol(ofconn
);
4792 next
= ofputil_protocol_set_base(cur
, next_base
);
4793 ofconn_set_protocol(ofconn
, next
);
4799 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
4800 const struct ofp_header
*oh
)
4802 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
4805 format
= ntohl(msg
->format
);
4806 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
4807 return OFPERR_OFPBRC_EPERM
;
4810 ofconn_set_packet_in_format(ofconn
, format
);
4815 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4817 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
4818 uint32_t master
[OAM_N_TYPES
];
4819 uint32_t slave
[OAM_N_TYPES
];
4821 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
4822 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
4823 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
4825 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
4826 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
4827 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
4829 ofconn_set_async_config(ofconn
, master
, slave
);
4830 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
4831 !ofconn_get_miss_send_len(ofconn
)) {
4832 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
4839 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4842 uint32_t master
[OAM_N_TYPES
];
4843 uint32_t slave
[OAM_N_TYPES
];
4844 struct nx_async_config
*msg
;
4846 ofconn_get_async_config(ofconn
, master
, slave
);
4847 buf
= ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY
, oh
, 0);
4848 msg
= ofpbuf_put_zeros(buf
, sizeof *msg
);
4850 msg
->packet_in_mask
[0] = htonl(master
[OAM_PACKET_IN
]);
4851 msg
->port_status_mask
[0] = htonl(master
[OAM_PORT_STATUS
]);
4852 msg
->flow_removed_mask
[0] = htonl(master
[OAM_FLOW_REMOVED
]);
4854 msg
->packet_in_mask
[1] = htonl(slave
[OAM_PACKET_IN
]);
4855 msg
->port_status_mask
[1] = htonl(slave
[OAM_PORT_STATUS
]);
4856 msg
->flow_removed_mask
[1] = htonl(slave
[OAM_FLOW_REMOVED
]);
4858 ofconn_send_reply(ofconn
, buf
);
4864 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
4865 const struct ofp_header
*oh
)
4867 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
4869 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
4870 return OFPERR_NXBRC_MUST_BE_ZERO
;
4873 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
4878 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4882 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
4883 ? OFPRAW_OFPT10_BARRIER_REPLY
4884 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
4885 ofconn_send_reply(ofconn
, buf
);
4890 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
4891 enum nx_flow_monitor_flags flags
,
4893 OVS_REQUIRES(ofproto_mutex
)
4895 const struct rule_actions
*actions
;
4896 struct ofputil_flow_update fu
;
4899 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
4900 ? NXFME_ADDED
: NXFME_MODIFIED
);
4902 ovs_mutex_lock(&rule
->mutex
);
4903 fu
.idle_timeout
= rule
->idle_timeout
;
4904 fu
.hard_timeout
= rule
->hard_timeout
;
4905 ovs_mutex_unlock(&rule
->mutex
);
4906 fu
.table_id
= rule
->table_id
;
4907 fu
.cookie
= rule
->flow_cookie
;
4908 minimatch_expand(&rule
->cr
.match
, &match
);
4910 fu
.priority
= rule
->cr
.priority
;
4912 actions
= flags
& NXFMF_ACTIONS
? rule_get_actions(rule
) : NULL
;
4913 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
4914 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
4916 if (list_is_empty(msgs
)) {
4917 ofputil_start_flow_update(msgs
);
4919 ofputil_append_flow_update(&fu
, msgs
);
4923 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
4925 OVS_REQUIRES(ofproto_mutex
)
4929 for (i
= 0; i
< rules
->n
; i
++) {
4930 struct rule
*rule
= rules
->rules
[i
];
4931 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
4932 rule
->monitor_flags
= 0;
4934 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
4939 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
4940 struct rule
*rule
, uint64_t seqno
,
4941 struct rule_collection
*rules
)
4942 OVS_REQUIRES(ofproto_mutex
)
4944 enum nx_flow_monitor_flags update
;
4946 if (rule_is_hidden(rule
)) {
4950 if (!ofproto_rule_has_out_port(rule
, m
->out_port
)) {
4955 if (rule
->add_seqno
> seqno
) {
4956 update
= NXFMF_ADD
| NXFMF_MODIFY
;
4957 } else if (rule
->modify_seqno
> seqno
) {
4958 update
= NXFMF_MODIFY
;
4963 if (!(m
->flags
& update
)) {
4967 update
= NXFMF_INITIAL
;
4970 if (!rule
->monitor_flags
) {
4971 rule_collection_add(rules
, rule
);
4973 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
4977 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
4979 struct rule_collection
*rules
)
4980 OVS_REQUIRES(ofproto_mutex
)
4982 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
4983 const struct oftable
*table
;
4984 struct cls_rule target
;
4986 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
4987 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
4990 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &target
) {
4991 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4994 cls_rule_destroy(&target
);
4998 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
4999 struct rule_collection
*rules
)
5000 OVS_REQUIRES(ofproto_mutex
)
5002 if (m
->flags
& NXFMF_INITIAL
) {
5003 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
5008 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
5009 uint64_t seqno
, struct rule_collection
*rules
)
5010 OVS_REQUIRES(ofproto_mutex
)
5012 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
5016 flow_monitor_delete(struct ofconn
*ofconn
, uint32_t id
)
5017 OVS_REQUIRES(ofproto_mutex
)
5019 struct ofmonitor
*m
;
5022 m
= ofmonitor_lookup(ofconn
, id
);
5024 ofmonitor_destroy(m
);
5027 error
= OFPERR_OFPMOFC_UNKNOWN_MONITOR
;
5034 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5035 OVS_EXCLUDED(ofproto_mutex
)
5037 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5038 struct ofmonitor
**monitors
;
5039 size_t n_monitors
, allocated_monitors
;
5040 struct rule_collection rules
;
5041 struct list replies
;
5046 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
5048 n_monitors
= allocated_monitors
= 0;
5050 ovs_mutex_lock(&ofproto_mutex
);
5052 struct ofputil_flow_monitor_request request
;
5053 struct ofmonitor
*m
;
5056 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
5057 if (retval
== EOF
) {
5059 } else if (retval
) {
5064 if (request
.table_id
!= 0xff
5065 && request
.table_id
>= ofproto
->n_tables
) {
5066 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
5070 error
= ofmonitor_create(&request
, ofconn
, &m
);
5075 if (n_monitors
>= allocated_monitors
) {
5076 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
5079 monitors
[n_monitors
++] = m
;
5082 rule_collection_init(&rules
);
5083 for (i
= 0; i
< n_monitors
; i
++) {
5084 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
5087 ofpmp_init(&replies
, oh
);
5088 ofmonitor_compose_refresh_updates(&rules
, &replies
);
5089 ovs_mutex_unlock(&ofproto_mutex
);
5091 rule_collection_destroy(&rules
);
5093 ofconn_send_replies(ofconn
, &replies
);
5099 for (i
= 0; i
< n_monitors
; i
++) {
5100 ofmonitor_destroy(monitors
[i
]);
5103 ovs_mutex_unlock(&ofproto_mutex
);
5109 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5110 OVS_EXCLUDED(ofproto_mutex
)
5115 id
= ofputil_decode_flow_monitor_cancel(oh
);
5117 ovs_mutex_lock(&ofproto_mutex
);
5118 error
= flow_monitor_delete(ofconn
, id
);
5119 ovs_mutex_unlock(&ofproto_mutex
);
5124 /* Meters implementation.
5126 * Meter table entry, indexed by the OpenFlow meter_id.
5127 * 'created' is used to compute the duration for meter stats.
5128 * 'list rules' is needed so that we can delete the dependent rules when the
5129 * meter table entry is deleted.
5130 * 'provider_meter_id' is for the provider's private use.
5133 long long int created
; /* Time created. */
5134 struct list rules
; /* List of "struct rule_dpif"s. */
5135 ofproto_meter_id provider_meter_id
;
5136 uint16_t flags
; /* Meter flags. */
5137 uint16_t n_bands
; /* Number of meter bands. */
5138 struct ofputil_meter_band
*bands
;
5142 * This is used in instruction validation at flow set-up time,
5143 * as flows may not use non-existing meters.
5144 * Return value of UINT32_MAX signifies an invalid meter.
5147 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
5149 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
5150 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
5152 return meter
->provider_meter_id
.uint32
;
5158 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5161 meter_insert_rule(struct rule
*rule
)
5163 const struct rule_actions
*a
= rule_get_actions(rule
);
5164 uint32_t meter_id
= ofpacts_get_meter(a
->ofpacts
, a
->ofpacts_len
);
5165 struct meter
*meter
= rule
->ofproto
->meters
[meter_id
];
5167 list_insert(&meter
->rules
, &rule
->meter_list_node
);
5171 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
5175 meter
->flags
= config
->flags
;
5176 meter
->n_bands
= config
->n_bands
;
5177 meter
->bands
= xmemdup(config
->bands
,
5178 config
->n_bands
* sizeof *meter
->bands
);
5181 static struct meter
*
5182 meter_create(const struct ofputil_meter_config
*config
,
5183 ofproto_meter_id provider_meter_id
)
5185 struct meter
*meter
;
5187 meter
= xzalloc(sizeof *meter
);
5188 meter
->provider_meter_id
= provider_meter_id
;
5189 meter
->created
= time_msec();
5190 list_init(&meter
->rules
);
5192 meter_update(meter
, config
);
5198 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5199 OVS_REQUIRES(ofproto_mutex
)
5202 for (mid
= first
; mid
<= last
; ++mid
) {
5203 struct meter
*meter
= ofproto
->meters
[mid
];
5205 ofproto
->meters
[mid
] = NULL
;
5206 ofproto
->ofproto_class
->meter_del(ofproto
,
5207 meter
->provider_meter_id
);
5215 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5217 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5218 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5222 return OFPERR_OFPMMFC_METER_EXISTS
;
5225 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5228 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5229 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5235 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5237 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5239 uint32_t provider_meter_id
;
5242 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5245 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5246 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5247 &meter
->provider_meter_id
,
5249 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5251 meter_update(meter
, &mm
->meter
);
5257 handle_delete_meter(struct ofconn
*ofconn
, struct ofputil_meter_mod
*mm
)
5258 OVS_EXCLUDED(ofproto_mutex
)
5260 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5261 uint32_t meter_id
= mm
->meter
.meter_id
;
5262 struct rule_collection rules
;
5263 enum ofperr error
= 0;
5264 uint32_t first
, last
;
5266 if (meter_id
== OFPM13_ALL
) {
5268 last
= ofproto
->meter_features
.max_meters
;
5270 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
5273 first
= last
= meter_id
;
5276 /* First delete the rules that use this meter. If any of those rules are
5277 * currently being modified, postpone the whole operation until later. */
5278 rule_collection_init(&rules
);
5279 ovs_mutex_lock(&ofproto_mutex
);
5280 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5281 struct meter
*meter
= ofproto
->meters
[meter_id
];
5282 if (meter
&& !list_is_empty(&meter
->rules
)) {
5285 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
5286 rule_collection_add(&rules
, rule
);
5291 delete_flows__(&rules
, OFPRR_METER_DELETE
, NULL
);
5294 /* Delete the meters. */
5295 meter_delete(ofproto
, first
, last
);
5297 ovs_mutex_unlock(&ofproto_mutex
);
5298 rule_collection_destroy(&rules
);
5304 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5306 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5307 struct ofputil_meter_mod mm
;
5308 uint64_t bands_stub
[256 / 8];
5309 struct ofpbuf bands
;
5313 error
= reject_slave_controller(ofconn
);
5318 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5320 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
5322 goto exit_free_bands
;
5325 meter_id
= mm
.meter
.meter_id
;
5327 if (mm
.command
!= OFPMC13_DELETE
) {
5328 /* Fails also when meters are not implemented by the provider. */
5329 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
5330 error
= OFPERR_OFPMMFC_INVALID_METER
;
5331 goto exit_free_bands
;
5332 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
5333 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
5334 goto exit_free_bands
;
5336 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
5337 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
5338 goto exit_free_bands
;
5342 switch (mm
.command
) {
5344 error
= handle_add_meter(ofproto
, &mm
);
5347 case OFPMC13_MODIFY
:
5348 error
= handle_modify_meter(ofproto
, &mm
);
5351 case OFPMC13_DELETE
:
5352 error
= handle_delete_meter(ofconn
, &mm
);
5356 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
5361 ofpbuf_uninit(&bands
);
5366 handle_meter_features_request(struct ofconn
*ofconn
,
5367 const struct ofp_header
*request
)
5369 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5370 struct ofputil_meter_features features
;
5373 if (ofproto
->ofproto_class
->meter_get_features
) {
5374 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
5376 memset(&features
, 0, sizeof features
);
5378 b
= ofputil_encode_meter_features_reply(&features
, request
);
5380 ofconn_send_reply(ofconn
, b
);
5385 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
5388 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5389 struct list replies
;
5390 uint64_t bands_stub
[256 / 8];
5391 struct ofpbuf bands
;
5392 uint32_t meter_id
, first
, last
;
5394 ofputil_decode_meter_request(request
, &meter_id
);
5396 if (meter_id
== OFPM13_ALL
) {
5398 last
= ofproto
->meter_features
.max_meters
;
5400 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
5401 !ofproto
->meters
[meter_id
]) {
5402 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5404 first
= last
= meter_id
;
5407 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5408 ofpmp_init(&replies
, request
);
5410 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5411 struct meter
*meter
= ofproto
->meters
[meter_id
];
5413 continue; /* Skip non-existing meters. */
5415 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
5416 struct ofputil_meter_stats stats
;
5418 stats
.meter_id
= meter_id
;
5420 /* Provider sets the packet and byte counts, we do the rest. */
5421 stats
.flow_count
= list_size(&meter
->rules
);
5422 calc_duration(meter
->created
, time_msec(),
5423 &stats
.duration_sec
, &stats
.duration_nsec
);
5424 stats
.n_bands
= meter
->n_bands
;
5425 ofpbuf_clear(&bands
);
5427 = ofpbuf_put_uninit(&bands
,
5428 meter
->n_bands
* sizeof *stats
.bands
);
5430 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
5431 meter
->provider_meter_id
,
5433 ofputil_append_meter_stats(&replies
, &stats
);
5435 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5436 struct ofputil_meter_config config
;
5438 config
.meter_id
= meter_id
;
5439 config
.flags
= meter
->flags
;
5440 config
.n_bands
= meter
->n_bands
;
5441 config
.bands
= meter
->bands
;
5442 ofputil_append_meter_config(&replies
, &config
);
5446 ofconn_send_replies(ofconn
, &replies
);
5447 ofpbuf_uninit(&bands
);
5452 ofproto_group_lookup__(const struct ofproto
*ofproto
, uint32_t group_id
,
5453 struct ofgroup
**group
)
5454 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5456 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5457 hash_int(group_id
, 0), &ofproto
->groups
) {
5458 if ((*group
)->group_id
== group_id
) {
5466 /* If the group exists, this function increments the groups's reference count.
5468 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5469 * a reference to the group. */
5471 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5472 struct ofgroup
**group
)
5476 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5477 found
= ofproto_group_lookup__(ofproto
, group_id
, group
);
5479 ofproto_group_ref(*group
);
5481 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5486 ofproto_group_exists__(const struct ofproto
*ofproto
, uint32_t group_id
)
5487 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5489 struct ofgroup
*grp
;
5491 HMAP_FOR_EACH_IN_BUCKET (grp
, hmap_node
,
5492 hash_int(group_id
, 0), &ofproto
->groups
) {
5493 if (grp
->group_id
== group_id
) {
5501 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
5502 OVS_EXCLUDED(ofproto
->groups_rwlock
)
5506 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5507 exists
= ofproto_group_exists__(ofproto
, group_id
);
5508 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5514 group_get_ref_count(struct ofgroup
*group
)
5515 OVS_EXCLUDED(ofproto_mutex
)
5517 struct ofproto
*ofproto
= CONST_CAST(struct ofproto
*, group
->ofproto
);
5518 struct rule_criteria criteria
;
5519 struct rule_collection rules
;
5524 match_init_catchall(&match
);
5525 rule_criteria_init(&criteria
, 0xff, &match
, 0, htonll(0), htonll(0),
5526 OFPP_ANY
, group
->group_id
);
5527 ovs_mutex_lock(&ofproto_mutex
);
5528 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
5529 ovs_mutex_unlock(&ofproto_mutex
);
5530 rule_criteria_destroy(&criteria
);
5532 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
5534 rule_collection_destroy(&rules
);
5539 append_group_stats(struct ofgroup
*group
, struct list
*replies
)
5541 struct ofputil_group_stats ogs
;
5542 const struct ofproto
*ofproto
= group
->ofproto
;
5543 long long int now
= time_msec();
5546 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
5548 /* Provider sets the packet and byte counts, we do the rest. */
5549 ogs
.ref_count
= group_get_ref_count(group
);
5550 ogs
.n_buckets
= group
->n_buckets
;
5552 error
= (ofproto
->ofproto_class
->group_get_stats
5553 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
5556 ogs
.packet_count
= UINT64_MAX
;
5557 ogs
.byte_count
= UINT64_MAX
;
5558 memset(ogs
.bucket_stats
, 0xff,
5559 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
5562 ogs
.group_id
= group
->group_id
;
5563 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
5565 ofputil_append_group_stats(replies
, &ogs
);
5567 free(ogs
.bucket_stats
);
5571 handle_group_request(struct ofconn
*ofconn
,
5572 const struct ofp_header
*request
, uint32_t group_id
,
5573 void (*cb
)(struct ofgroup
*, struct list
*replies
))
5575 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5576 struct ofgroup
*group
;
5577 struct list replies
;
5579 ofpmp_init(&replies
, request
);
5580 if (group_id
== OFPG_ALL
) {
5581 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5582 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5583 cb(group
, &replies
);
5585 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5587 if (ofproto_group_lookup(ofproto
, group_id
, &group
)) {
5588 cb(group
, &replies
);
5589 ofproto_group_unref(group
);
5592 ofconn_send_replies(ofconn
, &replies
);
5596 handle_group_stats_request(struct ofconn
*ofconn
,
5597 const struct ofp_header
*request
)
5602 error
= ofputil_decode_group_stats_request(request
, &group_id
);
5607 handle_group_request(ofconn
, request
, group_id
, append_group_stats
);
5612 append_group_desc(struct ofgroup
*group
, struct list
*replies
)
5614 struct ofputil_group_desc gds
;
5616 gds
.group_id
= group
->group_id
;
5617 gds
.type
= group
->type
;
5618 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, replies
);
5622 handle_group_desc_stats_request(struct ofconn
*ofconn
,
5623 const struct ofp_header
*request
)
5625 handle_group_request(ofconn
, request
,
5626 ofputil_decode_group_desc_request(request
),
5632 handle_group_features_stats_request(struct ofconn
*ofconn
,
5633 const struct ofp_header
*request
)
5635 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5638 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
5640 ofconn_send_reply(ofconn
, msg
);
5647 handle_queue_get_config_request(struct ofconn
*ofconn
,
5648 const struct ofp_header
*oh
)
5650 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5651 struct netdev_queue_dump queue_dump
;
5652 struct ofport
*ofport
;
5653 unsigned int queue_id
;
5654 struct ofpbuf
*reply
;
5655 struct smap details
;
5659 error
= ofputil_decode_queue_get_config_request(oh
, &request
);
5664 ofport
= ofproto_get_port(p
, request
);
5666 return OFPERR_OFPQOFC_BAD_PORT
;
5669 reply
= ofputil_encode_queue_get_config_reply(oh
);
5671 smap_init(&details
);
5672 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
, ofport
->netdev
) {
5673 struct ofputil_queue_config queue
;
5675 /* None of the existing queues have compatible properties, so we
5676 * hard-code omitting min_rate and max_rate. */
5677 queue
.queue_id
= queue_id
;
5678 queue
.min_rate
= UINT16_MAX
;
5679 queue
.max_rate
= UINT16_MAX
;
5680 ofputil_append_queue_get_config_reply(reply
, &queue
);
5682 smap_destroy(&details
);
5684 ofconn_send_reply(ofconn
, reply
);
5690 init_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
,
5691 struct ofgroup
**ofgroup
)
5694 const long long int now
= time_msec();
5696 if (gm
->group_id
> OFPG_MAX
) {
5697 return OFPERR_OFPGMFC_INVALID_GROUP
;
5699 if (gm
->type
> OFPGT11_FF
) {
5700 return OFPERR_OFPGMFC_BAD_TYPE
;
5703 *ofgroup
= ofproto
->ofproto_class
->group_alloc();
5705 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
5706 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5709 (*ofgroup
)->ofproto
= ofproto
;
5710 *CONST_CAST(uint32_t *, &((*ofgroup
)->group_id
)) = gm
->group_id
;
5711 *CONST_CAST(enum ofp11_group_type
*, &(*ofgroup
)->type
) = gm
->type
;
5712 *CONST_CAST(long long int *, &((*ofgroup
)->created
)) = now
;
5713 *CONST_CAST(long long int *, &((*ofgroup
)->modified
)) = now
;
5714 ovs_refcount_init(&(*ofgroup
)->ref_count
);
5716 list_move(&(*ofgroup
)->buckets
, &gm
->buckets
);
5717 *CONST_CAST(uint32_t *, &(*ofgroup
)->n_buckets
) =
5718 list_size(&(*ofgroup
)->buckets
);
5720 /* Construct called BEFORE any locks are held. */
5721 error
= ofproto
->ofproto_class
->group_construct(*ofgroup
);
5723 ofputil_bucket_list_destroy(&(*ofgroup
)->buckets
);
5724 ofproto
->ofproto_class
->group_dealloc(*ofgroup
);
5729 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
5730 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
5733 add_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5735 struct ofgroup
*ofgroup
;
5738 /* Allocate new group and initialize it. */
5739 error
= init_group(ofproto
, gm
, &ofgroup
);
5744 /* We wrlock as late as possible to minimize the time we jam any other
5745 * threads: No visible state changes before acquiring the lock. */
5746 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5748 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5749 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5753 if (ofproto_group_exists__(ofproto
, gm
->group_id
)) {
5754 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
5759 /* Insert new group. */
5760 hmap_insert(&ofproto
->groups
, &ofgroup
->hmap_node
,
5761 hash_int(ofgroup
->group_id
, 0));
5762 ofproto
->n_groups
[ofgroup
->type
]++;
5764 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5769 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5770 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5771 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5772 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5777 /* Implements OFPGC11_MODIFY. Returns 0 on success or an OpenFlow error code
5780 * Note that the group is re-created and then replaces the old group in
5781 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
5782 * the xlate module hold a pointer to the group. */
5784 modify_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5786 struct ofgroup
*ofgroup
, *new_ofgroup
, *retiring
;
5789 error
= init_group(ofproto
, gm
, &new_ofgroup
);
5794 retiring
= new_ofgroup
;
5796 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5797 if (!ofproto_group_lookup__(ofproto
, gm
->group_id
, &ofgroup
)) {
5798 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
5802 /* Ofproto's group write lock is held now. */
5803 if (ofgroup
->type
!= gm
->type
5804 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5805 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5809 /* The group creation time does not change during modification. */
5810 *CONST_CAST(long long int *, &(new_ofgroup
->created
)) = ofgroup
->created
;
5811 *CONST_CAST(long long int *, &(new_ofgroup
->modified
)) = time_msec();
5813 error
= ofproto
->ofproto_class
->group_modify(new_ofgroup
);
5819 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
5820 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5821 hmap_insert(&ofproto
->groups
, &new_ofgroup
->hmap_node
,
5822 hash_int(new_ofgroup
->group_id
, 0));
5823 if (ofgroup
->type
!= new_ofgroup
->type
) {
5824 ofproto
->n_groups
[ofgroup
->type
]--;
5825 ofproto
->n_groups
[new_ofgroup
->type
]++;
5829 ofproto_group_unref(retiring
);
5830 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5835 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
5836 OVS_RELEASES(ofproto
->groups_rwlock
)
5839 struct ofputil_flow_mod fm
;
5841 /* Delete all flow entries containing this group in a group action */
5842 match_init_catchall(&match
);
5843 flow_mod_init(&fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
5844 fm
.delete_reason
= OFPRR_GROUP_DELETE
;
5845 fm
.out_group
= ofgroup
->group_id
;
5846 handle_flow_mod__(ofproto
, &fm
, NULL
);
5848 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5849 /* No-one can find this group any more. */
5850 ofproto
->n_groups
[ofgroup
->type
]--;
5851 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5852 ofproto_group_unref(ofgroup
);
5855 /* Implements OFPGC11_DELETE. */
5857 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
5859 struct ofgroup
*ofgroup
;
5861 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5862 if (group_id
== OFPG_ALL
) {
5864 struct hmap_node
*node
= hmap_first(&ofproto
->groups
);
5868 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, hmap_node
);
5869 delete_group__(ofproto
, ofgroup
);
5870 /* Lock for each node separately, so that we will not jam the
5871 * other threads for too long time. */
5872 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5875 HMAP_FOR_EACH_IN_BUCKET (ofgroup
, hmap_node
,
5876 hash_int(group_id
, 0), &ofproto
->groups
) {
5877 if (ofgroup
->group_id
== group_id
) {
5878 delete_group__(ofproto
, ofgroup
);
5883 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5887 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5889 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5890 struct ofputil_group_mod gm
;
5893 error
= reject_slave_controller(ofconn
);
5898 error
= ofputil_decode_group_mod(oh
, &gm
);
5903 switch (gm
.command
) {
5905 return add_group(ofproto
, &gm
);
5907 case OFPGC11_MODIFY
:
5908 return modify_group(ofproto
, &gm
);
5910 case OFPGC11_DELETE
:
5911 delete_group(ofproto
, gm
.group_id
);
5915 if (gm
.command
> OFPGC11_DELETE
) {
5916 VLOG_WARN_RL(&rl
, "%s: Invalid group_mod command type %d",
5917 ofproto
->name
, gm
.command
);
5919 return OFPERR_OFPGMFC_BAD_COMMAND
;
5923 enum ofputil_table_miss
5924 ofproto_table_get_miss_config(const struct ofproto
*ofproto
, uint8_t table_id
)
5926 enum ofputil_table_miss value
;
5928 atomic_read_relaxed(&ofproto
->tables
[table_id
].miss_config
, &value
);
5933 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
5935 if (!check_table_id(ofproto
, tm
->table_id
)) {
5936 return OFPERR_OFPTMFC_BAD_TABLE
;
5937 } else if (tm
->miss_config
!= OFPUTIL_TABLE_MISS_DEFAULT
) {
5938 if (tm
->table_id
== OFPTT_ALL
) {
5940 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
5941 atomic_store_relaxed(&ofproto
->tables
[i
].miss_config
,
5945 atomic_store_relaxed(&ofproto
->tables
[tm
->table_id
].miss_config
,
5953 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5955 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5956 struct ofputil_table_mod tm
;
5959 error
= reject_slave_controller(ofconn
);
5964 error
= ofputil_decode_table_mod(oh
, &tm
);
5969 return table_mod(ofproto
, &tm
);
5973 handle_bundle_control(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5976 struct ofputil_bundle_ctrl_msg bctrl
;
5978 struct ofputil_bundle_ctrl_msg reply
;
5980 error
= ofputil_decode_bundle_ctrl(oh
, &bctrl
);
5985 reply
.bundle_id
= bctrl
.bundle_id
;
5987 switch (bctrl
.type
) {
5988 case OFPBCT_OPEN_REQUEST
:
5989 error
= ofp_bundle_open(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
5990 reply
.type
= OFPBCT_OPEN_REPLY
;
5992 case OFPBCT_CLOSE_REQUEST
:
5993 error
= ofp_bundle_close(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
5994 reply
.type
= OFPBCT_CLOSE_REPLY
;;
5996 case OFPBCT_COMMIT_REQUEST
:
5997 error
= ofp_bundle_commit(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
5998 reply
.type
= OFPBCT_COMMIT_REPLY
;
6000 case OFPBCT_DISCARD_REQUEST
:
6001 error
= ofp_bundle_discard(ofconn
, bctrl
.bundle_id
);
6002 reply
.type
= OFPBCT_DISCARD_REPLY
;
6005 case OFPBCT_OPEN_REPLY
:
6006 case OFPBCT_CLOSE_REPLY
:
6007 case OFPBCT_COMMIT_REPLY
:
6008 case OFPBCT_DISCARD_REPLY
:
6009 return OFPERR_OFPBFC_BAD_TYPE
;
6014 buf
= ofputil_encode_bundle_ctrl_reply(oh
, &reply
);
6015 ofconn_send_reply(ofconn
, buf
);
6022 handle_bundle_add(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6025 struct ofputil_bundle_add_msg badd
;
6027 error
= ofputil_decode_bundle_add(oh
, &badd
);
6032 return ofp_bundle_add_message(ofconn
, &badd
);
6036 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
6037 OVS_EXCLUDED(ofproto_mutex
)
6039 const struct ofp_header
*oh
= ofpbuf_data(msg
);
6043 error
= ofptype_decode(&type
, oh
);
6047 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
6048 && ofpmp_more(oh
)) {
6049 /* We have no buffer implementation for multipart requests.
6050 * Report overflow for requests which consists of multiple
6052 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
6056 /* OpenFlow requests. */
6057 case OFPTYPE_ECHO_REQUEST
:
6058 return handle_echo_request(ofconn
, oh
);
6060 case OFPTYPE_FEATURES_REQUEST
:
6061 return handle_features_request(ofconn
, oh
);
6063 case OFPTYPE_GET_CONFIG_REQUEST
:
6064 return handle_get_config_request(ofconn
, oh
);
6066 case OFPTYPE_SET_CONFIG
:
6067 return handle_set_config(ofconn
, oh
);
6069 case OFPTYPE_PACKET_OUT
:
6070 return handle_packet_out(ofconn
, oh
);
6072 case OFPTYPE_PORT_MOD
:
6073 return handle_port_mod(ofconn
, oh
);
6075 case OFPTYPE_FLOW_MOD
:
6076 return handle_flow_mod(ofconn
, oh
);
6078 case OFPTYPE_GROUP_MOD
:
6079 return handle_group_mod(ofconn
, oh
);
6081 case OFPTYPE_TABLE_MOD
:
6082 return handle_table_mod(ofconn
, oh
);
6084 case OFPTYPE_METER_MOD
:
6085 return handle_meter_mod(ofconn
, oh
);
6087 case OFPTYPE_BARRIER_REQUEST
:
6088 return handle_barrier_request(ofconn
, oh
);
6090 case OFPTYPE_ROLE_REQUEST
:
6091 return handle_role_request(ofconn
, oh
);
6093 /* OpenFlow replies. */
6094 case OFPTYPE_ECHO_REPLY
:
6097 /* Nicira extension requests. */
6098 case OFPTYPE_FLOW_MOD_TABLE_ID
:
6099 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
6101 case OFPTYPE_SET_FLOW_FORMAT
:
6102 return handle_nxt_set_flow_format(ofconn
, oh
);
6104 case OFPTYPE_SET_PACKET_IN_FORMAT
:
6105 return handle_nxt_set_packet_in_format(ofconn
, oh
);
6107 case OFPTYPE_SET_CONTROLLER_ID
:
6108 return handle_nxt_set_controller_id(ofconn
, oh
);
6110 case OFPTYPE_FLOW_AGE
:
6111 /* Nothing to do. */
6114 case OFPTYPE_FLOW_MONITOR_CANCEL
:
6115 return handle_flow_monitor_cancel(ofconn
, oh
);
6117 case OFPTYPE_SET_ASYNC_CONFIG
:
6118 return handle_nxt_set_async_config(ofconn
, oh
);
6120 case OFPTYPE_GET_ASYNC_REQUEST
:
6121 return handle_nxt_get_async_request(ofconn
, oh
);
6123 /* Statistics requests. */
6124 case OFPTYPE_DESC_STATS_REQUEST
:
6125 return handle_desc_stats_request(ofconn
, oh
);
6127 case OFPTYPE_FLOW_STATS_REQUEST
:
6128 return handle_flow_stats_request(ofconn
, oh
);
6130 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
6131 return handle_aggregate_stats_request(ofconn
, oh
);
6133 case OFPTYPE_TABLE_STATS_REQUEST
:
6134 return handle_table_stats_request(ofconn
, oh
);
6136 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
6137 return handle_table_features_request(ofconn
, oh
);
6139 case OFPTYPE_PORT_STATS_REQUEST
:
6140 return handle_port_stats_request(ofconn
, oh
);
6142 case OFPTYPE_QUEUE_STATS_REQUEST
:
6143 return handle_queue_stats_request(ofconn
, oh
);
6145 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
6146 return handle_port_desc_stats_request(ofconn
, oh
);
6148 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
6149 return handle_flow_monitor_request(ofconn
, oh
);
6151 case OFPTYPE_METER_STATS_REQUEST
:
6152 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
6153 return handle_meter_request(ofconn
, oh
, type
);
6155 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
6156 return handle_meter_features_request(ofconn
, oh
);
6158 case OFPTYPE_GROUP_STATS_REQUEST
:
6159 return handle_group_stats_request(ofconn
, oh
);
6161 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
6162 return handle_group_desc_stats_request(ofconn
, oh
);
6164 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
6165 return handle_group_features_stats_request(ofconn
, oh
);
6167 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
6168 return handle_queue_get_config_request(ofconn
, oh
);
6170 case OFPTYPE_BUNDLE_CONTROL
:
6171 return handle_bundle_control(ofconn
, oh
);
6173 case OFPTYPE_BUNDLE_ADD_MESSAGE
:
6174 return handle_bundle_add(ofconn
, oh
);
6178 case OFPTYPE_FEATURES_REPLY
:
6179 case OFPTYPE_GET_CONFIG_REPLY
:
6180 case OFPTYPE_PACKET_IN
:
6181 case OFPTYPE_FLOW_REMOVED
:
6182 case OFPTYPE_PORT_STATUS
:
6183 case OFPTYPE_BARRIER_REPLY
:
6184 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
6185 case OFPTYPE_DESC_STATS_REPLY
:
6186 case OFPTYPE_FLOW_STATS_REPLY
:
6187 case OFPTYPE_QUEUE_STATS_REPLY
:
6188 case OFPTYPE_PORT_STATS_REPLY
:
6189 case OFPTYPE_TABLE_STATS_REPLY
:
6190 case OFPTYPE_AGGREGATE_STATS_REPLY
:
6191 case OFPTYPE_PORT_DESC_STATS_REPLY
:
6192 case OFPTYPE_ROLE_REPLY
:
6193 case OFPTYPE_FLOW_MONITOR_PAUSED
:
6194 case OFPTYPE_FLOW_MONITOR_RESUMED
:
6195 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
6196 case OFPTYPE_GET_ASYNC_REPLY
:
6197 case OFPTYPE_GROUP_STATS_REPLY
:
6198 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
6199 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
6200 case OFPTYPE_METER_STATS_REPLY
:
6201 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
6202 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
6203 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
6204 case OFPTYPE_ROLE_STATUS
:
6206 if (ofpmsg_is_stat_request(oh
)) {
6207 return OFPERR_OFPBRC_BAD_STAT
;
6209 return OFPERR_OFPBRC_BAD_TYPE
;
6215 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
6216 OVS_EXCLUDED(ofproto_mutex
)
6218 int error
= handle_openflow__(ofconn
, ofp_msg
);
6220 ofconn_send_error(ofconn
, ofpbuf_data(ofp_msg
), error
);
6222 COVERAGE_INC(ofproto_recv_openflow
);
6225 /* Asynchronous operations. */
6228 send_buffered_packet(struct ofconn
*ofconn
, uint32_t buffer_id
,
6230 OVS_REQUIRES(ofproto_mutex
)
6232 enum ofperr error
= 0;
6233 if (ofconn
&& buffer_id
!= UINT32_MAX
) {
6234 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6235 struct ofpbuf
*packet
;
6238 error
= ofconn_pktbuf_retrieve(ofconn
, buffer_id
, &packet
, &in_port
);
6240 struct rule_execute
*re
;
6242 ofproto_rule_ref(rule
);
6244 re
= xmalloc(sizeof *re
);
6246 re
->in_port
= in_port
;
6247 re
->packet
= packet
;
6249 if (!guarded_list_push_back(&ofproto
->rule_executes
,
6250 &re
->list_node
, 1024)) {
6251 ofproto_rule_unref(rule
);
6252 ofpbuf_delete(re
->packet
);
6261 pick_datapath_id(const struct ofproto
*ofproto
)
6263 const struct ofport
*port
;
6265 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
6267 uint8_t ea
[ETH_ADDR_LEN
];
6270 error
= netdev_get_etheraddr(port
->netdev
, ea
);
6272 return eth_addr_to_uint64(ea
);
6274 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6275 ofproto
->name
, netdev_get_name(port
->netdev
),
6276 ovs_strerror(error
));
6278 return ofproto
->fallback_dpid
;
6282 pick_fallback_dpid(void)
6284 uint8_t ea
[ETH_ADDR_LEN
];
6285 eth_addr_nicira_random(ea
);
6286 return eth_addr_to_uint64(ea
);
6289 /* Table overflow policy. */
6291 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6292 * to NULL if the table is not configured to evict rules or if the table
6293 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6294 * or with no timeouts are not evictable.) */
6296 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
6297 OVS_REQUIRES(ofproto_mutex
)
6299 struct eviction_group
*evg
;
6302 if (!table
->eviction_fields
) {
6306 /* In the common case, the outer and inner loops here will each be entered
6309 * - The inner loop normally "return"s in its first iteration. If the
6310 * eviction group has any evictable rules, then it always returns in
6313 * - The outer loop only iterates more than once if the largest eviction
6314 * group has no evictable rules.
6316 * - The outer loop can exit only if table's 'max_flows' is all filled up
6317 * by unevictable rules. */
6318 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
6321 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
6330 /* Eviction groups. */
6332 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6333 * rules. The priority contains low-order random bits to ensure that eviction
6334 * groups with the same number of rules are prioritized randomly. */
6336 eviction_group_priority(size_t n_rules
)
6338 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
6339 return (size
<< 16) | random_uint16();
6342 /* Updates 'evg', an eviction_group within 'table', following a change that
6343 * adds or removes rules in 'evg'. */
6345 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
6346 OVS_REQUIRES(ofproto_mutex
)
6348 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
6349 eviction_group_priority(heap_count(&evg
->rules
)));
6352 /* Destroys 'evg', an eviction_group within 'table':
6354 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6355 * rules themselves, just removes them from the eviction group.)
6357 * - Removes 'evg' from 'table'.
6361 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
6362 OVS_REQUIRES(ofproto_mutex
)
6364 while (!heap_is_empty(&evg
->rules
)) {
6367 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
6368 rule
->eviction_group
= NULL
;
6370 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
6371 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
6372 heap_destroy(&evg
->rules
);
6376 /* Removes 'rule' from its eviction group, if any. */
6378 eviction_group_remove_rule(struct rule
*rule
)
6379 OVS_REQUIRES(ofproto_mutex
)
6381 if (rule
->eviction_group
) {
6382 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6383 struct eviction_group
*evg
= rule
->eviction_group
;
6385 rule
->eviction_group
= NULL
;
6386 heap_remove(&evg
->rules
, &rule
->evg_node
);
6387 if (heap_is_empty(&evg
->rules
)) {
6388 eviction_group_destroy(table
, evg
);
6390 eviction_group_resized(table
, evg
);
6395 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6396 * returns the hash value. */
6398 eviction_group_hash_rule(struct rule
*rule
)
6399 OVS_REQUIRES(ofproto_mutex
)
6401 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6402 const struct mf_subfield
*sf
;
6406 hash
= table
->eviction_group_id_basis
;
6407 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
6408 for (sf
= table
->eviction_fields
;
6409 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
6412 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
6413 union mf_value value
;
6415 mf_get_value(sf
->field
, &flow
, &value
);
6417 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
6419 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
6420 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
6421 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
6422 sf
->field
->n_bytes
* 8 - start
);
6424 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
6426 hash
= hash_int(hash
, 0);
6433 /* Returns an eviction group within 'table' with the given 'id', creating one
6435 static struct eviction_group
*
6436 eviction_group_find(struct oftable
*table
, uint32_t id
)
6437 OVS_REQUIRES(ofproto_mutex
)
6439 struct eviction_group
*evg
;
6441 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
6445 evg
= xmalloc(sizeof *evg
);
6446 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
6447 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
6448 eviction_group_priority(0));
6449 heap_init(&evg
->rules
);
6454 /* Returns an eviction priority for 'rule'. The return value should be
6455 * interpreted so that higher priorities make a rule more attractive candidates
6457 * Called only if have a timeout. */
6459 rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*rule
)
6460 OVS_REQUIRES(ofproto_mutex
)
6462 long long int expiration
= LLONG_MAX
;
6463 long long int modified
;
6464 uint32_t expiration_offset
;
6466 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6467 ovs_mutex_lock(&rule
->mutex
);
6468 modified
= rule
->modified
;
6469 ovs_mutex_unlock(&rule
->mutex
);
6471 if (rule
->hard_timeout
) {
6472 expiration
= modified
+ rule
->hard_timeout
* 1000;
6474 if (rule
->idle_timeout
) {
6475 uint64_t packets
, bytes
;
6477 long long int idle_expiration
;
6479 ofproto
->ofproto_class
->rule_get_stats(rule
, &packets
, &bytes
, &used
);
6480 idle_expiration
= used
+ rule
->idle_timeout
* 1000;
6481 expiration
= MIN(expiration
, idle_expiration
);
6484 if (expiration
== LLONG_MAX
) {
6488 /* Calculate the time of expiration as a number of (approximate) seconds
6489 * after program startup.
6491 * This should work OK for program runs that last UINT32_MAX seconds or
6492 * less. Therefore, please restart OVS at least once every 136 years. */
6493 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
6495 /* Invert the expiration offset because we're using a max-heap. */
6496 return UINT32_MAX
- expiration_offset
;
6499 /* Adds 'rule' to an appropriate eviction group for its oftable's
6500 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6501 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6504 * The caller must ensure that 'rule' is not already in an eviction group. */
6506 eviction_group_add_rule(struct rule
*rule
)
6507 OVS_REQUIRES(ofproto_mutex
)
6509 struct ofproto
*ofproto
= rule
->ofproto
;
6510 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6513 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6514 * so no additional protection is needed. */
6515 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
6517 if (table
->eviction_fields
&& has_timeout
) {
6518 struct eviction_group
*evg
;
6520 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
6522 rule
->eviction_group
= evg
;
6523 heap_insert(&evg
->rules
, &rule
->evg_node
,
6524 rule_eviction_priority(ofproto
, rule
));
6525 eviction_group_resized(table
, evg
);
6531 /* Initializes 'table'. */
6533 oftable_init(struct oftable
*table
)
6535 memset(table
, 0, sizeof *table
);
6536 classifier_init(&table
->cls
, flow_segment_u32s
);
6537 table
->max_flows
= UINT_MAX
;
6538 atomic_init(&table
->miss_config
, OFPUTIL_TABLE_MISS_DEFAULT
);
6540 classifier_set_prefix_fields(&table
->cls
, default_prefix_fields
,
6541 ARRAY_SIZE(default_prefix_fields
));
6543 atomic_init(&table
->n_matched
, 0);
6544 atomic_init(&table
->n_missed
, 0);
6547 /* Destroys 'table', including its classifier and eviction groups.
6549 * The caller is responsible for freeing 'table' itself. */
6551 oftable_destroy(struct oftable
*table
)
6553 ovs_assert(classifier_is_empty(&table
->cls
));
6554 oftable_disable_eviction(table
);
6555 classifier_destroy(&table
->cls
);
6559 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6560 * string, then 'table' will use its default name.
6562 * This only affects the name exposed for a table exposed through the OpenFlow
6563 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6565 oftable_set_name(struct oftable
*table
, const char *name
)
6567 if (name
&& name
[0]) {
6568 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
6569 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
6571 table
->name
= xmemdup0(name
, len
);
6579 /* oftables support a choice of two policies when adding a rule would cause the
6580 * number of flows in the table to exceed the configured maximum number: either
6581 * they can refuse to add the new flow or they can evict some existing flow.
6582 * This function configures the former policy on 'table'. */
6584 oftable_disable_eviction(struct oftable
*table
)
6585 OVS_REQUIRES(ofproto_mutex
)
6587 if (table
->eviction_fields
) {
6588 struct eviction_group
*evg
, *next
;
6590 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
6591 &table
->eviction_groups_by_id
) {
6592 eviction_group_destroy(table
, evg
);
6594 hmap_destroy(&table
->eviction_groups_by_id
);
6595 heap_destroy(&table
->eviction_groups_by_size
);
6597 free(table
->eviction_fields
);
6598 table
->eviction_fields
= NULL
;
6599 table
->n_eviction_fields
= 0;
6603 /* oftables support a choice of two policies when adding a rule would cause the
6604 * number of flows in the table to exceed the configured maximum number: either
6605 * they can refuse to add the new flow or they can evict some existing flow.
6606 * This function configures the latter policy on 'table', with fairness based
6607 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6608 * 'n_fields' as 0 disables fairness.) */
6610 oftable_enable_eviction(struct oftable
*table
,
6611 const struct mf_subfield
*fields
, size_t n_fields
)
6612 OVS_REQUIRES(ofproto_mutex
)
6616 if (table
->eviction_fields
6617 && n_fields
== table
->n_eviction_fields
6619 || !memcmp(fields
, table
->eviction_fields
,
6620 n_fields
* sizeof *fields
))) {
6625 oftable_disable_eviction(table
);
6627 table
->n_eviction_fields
= n_fields
;
6628 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
6630 table
->eviction_group_id_basis
= random_uint32();
6631 hmap_init(&table
->eviction_groups_by_id
);
6632 heap_init(&table
->eviction_groups_by_size
);
6634 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
6635 eviction_group_add_rule(rule
);
6639 /* Removes 'rule' from the oftable that contains it. */
6641 oftable_remove_rule__(struct ofproto
*ofproto
, struct rule
*rule
)
6642 OVS_REQUIRES(ofproto_mutex
)
6644 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
6646 classifier_remove(cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
6648 cookies_remove(ofproto
, rule
);
6650 eviction_group_remove_rule(rule
);
6651 if (!list_is_empty(&rule
->expirable
)) {
6652 list_remove(&rule
->expirable
);
6654 if (!list_is_empty(&rule
->meter_list_node
)) {
6655 list_remove(&rule
->meter_list_node
);
6656 list_init(&rule
->meter_list_node
);
6661 oftable_remove_rule(struct rule
*rule
)
6662 OVS_REQUIRES(ofproto_mutex
)
6664 oftable_remove_rule__(rule
->ofproto
, rule
);
6667 /* unixctl commands. */
6670 ofproto_lookup(const char *name
)
6672 struct ofproto
*ofproto
;
6674 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
6676 if (!strcmp(ofproto
->name
, name
)) {
6684 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
6685 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
6687 struct ofproto
*ofproto
;
6691 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
6692 ds_put_format(&results
, "%s\n", ofproto
->name
);
6694 unixctl_command_reply(conn
, ds_cstr(&results
));
6695 ds_destroy(&results
);
6699 ofproto_unixctl_init(void)
6701 static bool registered
;
6707 unixctl_command_register("ofproto/list", "", 0, 0,
6708 ofproto_unixctl_list
, NULL
);
6711 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6713 * This is deprecated. It is only for compatibility with broken device drivers
6714 * in old versions of Linux that do not properly support VLANs when VLAN
6715 * devices are not used. When broken device drivers are no longer in
6716 * widespread use, we will delete these interfaces. */
6718 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6719 * (exactly) by an OpenFlow rule in 'ofproto'. */
6721 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
6724 struct cls_rule target
;
6725 const struct oftable
*oftable
;
6727 match_init_catchall(&match
);
6728 match_set_vlan_vid_masked(&match
, htons(VLAN_CFI
), htons(VLAN_CFI
));
6729 cls_rule_init(&target
, &match
, 0);
6731 free(ofproto
->vlan_bitmap
);
6732 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
6733 ofproto
->vlans_changed
= false;
6735 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
6738 CLS_FOR_EACH_TARGET (rule
, cr
, &oftable
->cls
, &target
) {
6739 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
6740 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
6742 bitmap_set1(vlan_bitmap
, vid
);
6743 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6748 cls_rule_destroy(&target
);
6751 /* Returns true if new VLANs have come into use by the flow table since the
6752 * last call to ofproto_get_vlan_usage().
6754 * We don't track when old VLANs stop being used. */
6756 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
6758 return ofproto
->vlans_changed
;
6761 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6762 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6763 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6764 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6765 * then the VLAN device is un-enslaved. */
6767 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
6768 ofp_port_t realdev_ofp_port
, int vid
)
6770 struct ofport
*ofport
;
6773 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
6775 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
6777 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
6778 ofproto
->name
, vlandev_ofp_port
);
6782 if (!ofproto
->ofproto_class
->set_realdev
) {
6783 if (!vlandev_ofp_port
) {
6786 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
6790 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
6792 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
6793 ofproto
->name
, vlandev_ofp_port
,
6794 netdev_get_name(ofport
->netdev
), ovs_strerror(error
));