2 * Copyright (c) 2009-2015 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
47 #include "dp-packet.h"
51 #include "poll-loop.h"
59 #include "unaligned.h"
61 #include "openvswitch/vlog.h"
64 VLOG_DEFINE_THIS_MODULE(ofproto);
66 COVERAGE_DEFINE(ofproto_flush);
67 COVERAGE_DEFINE(ofproto_packet_out);
68 COVERAGE_DEFINE(ofproto_queue_req);
69 COVERAGE_DEFINE(ofproto_recv_openflow);
70 COVERAGE_DEFINE(ofproto_reinit_ports);
71 COVERAGE_DEFINE(ofproto_update_port);
73 /* Default fields to use for prefix tries in each flow table, unless something
74 * else is configured. */
75 const enum mf_field_id default_prefix_fields[2] =
76 { MFF_IPV4_DST, MFF_IPV4_SRC };
79 static void oftable_init(struct oftable *);
80 static void oftable_destroy(struct oftable *);
82 static void oftable_set_name(struct oftable *, const char *name);
84 static enum ofperr evict_rules_from_table(struct oftable *)
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 /* A set of rules within a single OpenFlow table (oftable) that have the same
92 * values for the oftable's eviction_fields. A rule to be evicted, when one is
93 * needed, is taken from the eviction group that contains the greatest number
96 * An oftable owns any number of eviction groups, each of which contains any
99 * Membership in an eviction group is imprecise, based on the hash of the
100 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
101 * That is, if two rules have different eviction_fields, but those
102 * eviction_fields hash to the same value, then they will belong to the same
103 * eviction_group anyway.
105 * (When eviction is not enabled on an oftable, we don't track any eviction
106 * groups, to save time and space.) */
107 struct eviction_group {
108 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
109 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
110 struct heap rules; /* Contains "struct rule"s. */
113 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
114 OVS_REQUIRES(ofproto_mutex);
115 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *)
116 OVS_REQUIRES(ofproto_mutex);;
117 static void eviction_group_add_rule(struct rule *)
118 OVS_REQUIRES(ofproto_mutex);
119 static void eviction_group_remove_rule(struct rule *)
120 OVS_REQUIRES(ofproto_mutex);
122 /* Criteria that flow_mod and other operations use for selecting rules on
123 * which to operate. */
124 struct rule_criteria {
125 /* An OpenFlow table or 255 for all tables. */
128 /* OpenFlow matching criteria. Interpreted different in "loose" way by
129 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
130 * defined in the OpenFlow spec. */
133 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
134 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
135 * The rule will not be selected if M is 1 and B != C. */
137 ovs_be64 cookie_mask;
139 /* Selection based on actions within a rule:
141 * If out_port != OFPP_ANY, selects only rules that output to out_port.
142 * If out_group != OFPG_ALL, select only rules that output to out_group. */
146 /* If true, collects only rules that are modifiable. */
148 bool include_readonly;
151 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
152 const struct match *match, int priority,
153 cls_version_t version,
154 ovs_be64 cookie, ovs_be64 cookie_mask,
155 ofp_port_t out_port, uint32_t out_group);
156 static void rule_criteria_require_rw(struct rule_criteria *,
157 bool can_write_readonly);
158 static void rule_criteria_destroy(struct rule_criteria *);
160 static enum ofperr collect_rules_loose(struct ofproto *,
161 const struct rule_criteria *,
162 struct rule_collection *);
164 /* A packet that needs to be passed to rule_execute().
166 * (We can't do this immediately from ofopgroup_complete() because that holds
167 * ofproto_mutex, which rule_execute() needs released.) */
168 struct rule_execute {
169 struct ovs_list list_node; /* In struct ofproto's "rule_executes" list. */
170 struct rule *rule; /* Owns a reference to the rule. */
172 struct dp_packet *packet; /* Owns the packet. */
175 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
176 static void destroy_rule_executes(struct ofproto *);
178 struct learned_cookie {
180 /* In struct ofproto's 'learned_cookies' hmap. */
181 struct hmap_node hmap_node OVS_GUARDED_BY(ofproto_mutex);
183 /* In 'dead_cookies' list when removed from hmap. */
184 struct ovs_list list_node;
188 ovs_be64 cookie OVS_GUARDED_BY(ofproto_mutex);
189 uint8_t table_id OVS_GUARDED_BY(ofproto_mutex);
191 /* Number of references from "learn" actions.
193 * When this drops to 0, all of the flows in 'table_id' with the specified
194 * 'cookie' are deleted. */
195 int n OVS_GUARDED_BY(ofproto_mutex);
198 static const struct ofpact_learn *next_learn_with_delete(
199 const struct rule_actions *, const struct ofpact_learn *start);
201 static void learned_cookies_inc(struct ofproto *, const struct rule_actions *)
202 OVS_REQUIRES(ofproto_mutex);
203 static void learned_cookies_dec(struct ofproto *, const struct rule_actions *,
204 struct ovs_list *dead_cookies)
205 OVS_REQUIRES(ofproto_mutex);
206 static void learned_cookies_flush(struct ofproto *, struct ovs_list *dead_cookies)
207 OVS_REQUIRES(ofproto_mutex);
210 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
211 static void ofport_destroy(struct ofport *);
213 static void update_port(struct ofproto *, const char *devname);
214 static int init_ports(struct ofproto *);
215 static void reinit_ports(struct ofproto *);
217 static long long int ofport_get_usage(const struct ofproto *,
218 ofp_port_t ofp_port);
219 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
220 long long int last_used);
221 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
225 * Keeps track of the currently used and recently used ofport values and is
226 * used to prevent immediate recycling of ofport values. */
227 struct ofport_usage {
228 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
229 ofp_port_t ofp_port; /* OpenFlow port number. */
230 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
231 represents in-use ofports. */
235 static void ofproto_rule_send_removed(struct rule *)
236 OVS_EXCLUDED(ofproto_mutex);
237 static bool rule_is_readonly(const struct rule *);
238 static void ofproto_rule_insert__(struct ofproto *, struct rule *)
239 OVS_REQUIRES(ofproto_mutex);
240 static void ofproto_rule_remove__(struct ofproto *, struct rule *)
241 OVS_REQUIRES(ofproto_mutex);
243 /* The source of a flow_mod request, in the code that processes flow_mods.
245 * A flow table modification request can be generated externally, via OpenFlow,
246 * or internally through a function call. This structure indicates the source
247 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
248 * meaningful and thus supplied as NULL. */
249 struct flow_mod_requester {
250 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
251 const struct ofp_header *request;
255 static enum ofperr replace_rule_create(struct ofproto *,
256 struct ofputil_flow_mod *,
257 struct cls_rule *cr, uint8_t table_id,
258 struct rule *old_rule,
259 struct rule **new_rule)
260 OVS_REQUIRES(ofproto_mutex);
262 static void replace_rule_start(struct ofproto *,
263 struct rule *old_rule,
264 struct rule *new_rule,
265 struct cls_conjunction *, size_t n_conjs)
266 OVS_REQUIRES(ofproto_mutex);
268 static void replace_rule_revert(struct ofproto *, struct rule *old_rule,
269 struct rule *new_rule)
270 OVS_REQUIRES(ofproto_mutex);
272 static void replace_rule_finish(struct ofproto *, struct ofputil_flow_mod *,
273 const struct flow_mod_requester *,
274 struct rule *old_rule, struct rule *new_rule,
275 struct ovs_list *dead_cookies)
276 OVS_REQUIRES(ofproto_mutex);
277 static void delete_flows__(struct rule_collection *,
278 enum ofp_flow_removed_reason,
279 const struct flow_mod_requester *)
280 OVS_REQUIRES(ofproto_mutex);
282 static void send_buffered_packet(const struct flow_mod_requester *,
283 uint32_t buffer_id, struct rule *)
284 OVS_REQUIRES(ofproto_mutex);
286 static bool ofproto_group_exists__(const struct ofproto *ofproto,
288 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
289 static bool ofproto_group_exists(const struct ofproto *ofproto,
291 OVS_EXCLUDED(ofproto->groups_rwlock);
292 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
293 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
294 static enum ofperr do_bundle_flow_mod_start(struct ofproto *,
295 struct ofputil_flow_mod *,
296 struct ofp_bundle_entry *)
297 OVS_REQUIRES(ofproto_mutex);
298 static void do_bundle_flow_mod_finish(struct ofproto *,
299 struct ofputil_flow_mod *,
300 const struct flow_mod_requester *,
301 struct ofp_bundle_entry *)
302 OVS_REQUIRES(ofproto_mutex);
303 static enum ofperr handle_flow_mod__(struct ofproto *,
304 struct ofputil_flow_mod *,
305 const struct flow_mod_requester *)
306 OVS_EXCLUDED(ofproto_mutex);
307 static void calc_duration(long long int start, long long int now,
308 uint32_t *sec, uint32_t *nsec);
311 static uint64_t pick_datapath_id(const struct ofproto *);
312 static uint64_t pick_fallback_dpid(void);
313 static void ofproto_destroy__(struct ofproto *);
314 static void update_mtu(struct ofproto *, struct ofport *);
315 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
316 static void meter_insert_rule(struct rule *);
319 static void ofproto_unixctl_init(void);
321 /* All registered ofproto classes, in probe order. */
322 static const struct ofproto_class **ofproto_classes;
323 static size_t n_ofproto_classes;
324 static size_t allocated_ofproto_classes;
326 /* Global lock that protects all flow table operations. */
327 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
329 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
330 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
332 size_t n_handlers, n_revalidators;
336 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
337 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
339 /* Initial mappings of port to OpenFlow number mappings. */
340 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
342 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
344 /* The default value of true waits for flow restore. */
345 static bool flow_restore_wait = true;
347 /* Must be called to initialize the ofproto library.
349 * The caller may pass in 'iface_hints', which contains an shash of
350 * "iface_hint" elements indexed by the interface's name. The provider
351 * may use these hints to describe the startup configuration in order to
352 * reinitialize its state. The caller owns the provided data, so a
353 * provider will make copies of anything required. An ofproto provider
354 * will remove any existing state that is not described by the hint, and
355 * may choose to remove it all. */
357 ofproto_init(const struct shash *iface_hints)
359 struct shash_node *node;
362 ofproto_class_register(&ofproto_dpif_class);
364 /* Make a local copy, since we don't own 'iface_hints' elements. */
365 SHASH_FOR_EACH(node, iface_hints) {
366 const struct iface_hint *orig_hint = node->data;
367 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
368 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
370 new_hint->br_name = xstrdup(orig_hint->br_name);
371 new_hint->br_type = xstrdup(br_type);
372 new_hint->ofp_port = orig_hint->ofp_port;
374 shash_add(&init_ofp_ports, node->name, new_hint);
377 for (i = 0; i < n_ofproto_classes; i++) {
378 ofproto_classes[i]->init(&init_ofp_ports);
382 /* 'type' should be a normalized datapath type, as returned by
383 * ofproto_normalize_type(). Returns the corresponding ofproto_class
384 * structure, or a null pointer if there is none registered for 'type'. */
385 static const struct ofproto_class *
386 ofproto_class_find__(const char *type)
390 for (i = 0; i < n_ofproto_classes; i++) {
391 const struct ofproto_class *class = ofproto_classes[i];
396 class->enumerate_types(&types);
397 found = sset_contains(&types, type);
398 sset_destroy(&types);
404 VLOG_WARN("unknown datapath type %s", type);
408 /* Registers a new ofproto class. After successful registration, new ofprotos
409 * of that type can be created using ofproto_create(). */
411 ofproto_class_register(const struct ofproto_class *new_class)
415 for (i = 0; i < n_ofproto_classes; i++) {
416 if (ofproto_classes[i] == new_class) {
421 if (n_ofproto_classes >= allocated_ofproto_classes) {
422 ofproto_classes = x2nrealloc(ofproto_classes,
423 &allocated_ofproto_classes,
424 sizeof *ofproto_classes);
426 ofproto_classes[n_ofproto_classes++] = new_class;
430 /* Unregisters a datapath provider. 'type' must have been previously
431 * registered and not currently be in use by any ofprotos. After
432 * unregistration new datapaths of that type cannot be opened using
433 * ofproto_create(). */
435 ofproto_class_unregister(const struct ofproto_class *class)
439 for (i = 0; i < n_ofproto_classes; i++) {
440 if (ofproto_classes[i] == class) {
441 for (i++; i < n_ofproto_classes; i++) {
442 ofproto_classes[i - 1] = ofproto_classes[i];
448 VLOG_WARN("attempted to unregister an ofproto class that is not "
453 /* Clears 'types' and enumerates all registered ofproto types into it. The
454 * caller must first initialize the sset. */
456 ofproto_enumerate_types(struct sset *types)
461 for (i = 0; i < n_ofproto_classes; i++) {
462 ofproto_classes[i]->enumerate_types(types);
466 /* Returns the fully spelled out name for the given ofproto 'type'.
468 * Normalized type string can be compared with strcmp(). Unnormalized type
469 * string might be the same even if they have different spellings. */
471 ofproto_normalize_type(const char *type)
473 return type && type[0] ? type : "system";
476 /* Clears 'names' and enumerates the names of all known created ofprotos with
477 * the given 'type'. The caller must first initialize the sset. Returns 0 if
478 * successful, otherwise a positive errno value.
480 * Some kinds of datapaths might not be practically enumerable. This is not
481 * considered an error. */
483 ofproto_enumerate_names(const char *type, struct sset *names)
485 const struct ofproto_class *class = ofproto_class_find__(type);
486 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
490 ofproto_bump_tables_version(struct ofproto *ofproto)
492 ++ofproto->tables_version;
493 ofproto->ofproto_class->set_tables_version(ofproto,
494 ofproto->tables_version);
498 ofproto_create(const char *datapath_name, const char *datapath_type,
499 struct ofproto **ofprotop)
501 const struct ofproto_class *class;
502 struct ofproto *ofproto;
508 ofproto_unixctl_init();
510 datapath_type = ofproto_normalize_type(datapath_type);
511 class = ofproto_class_find__(datapath_type);
513 VLOG_WARN("could not create datapath %s of unknown type %s",
514 datapath_name, datapath_type);
518 ofproto = class->alloc();
520 VLOG_ERR("failed to allocate datapath %s of type %s",
521 datapath_name, datapath_type);
526 ovs_mutex_lock(&ofproto_mutex);
527 memset(ofproto, 0, sizeof *ofproto);
528 ofproto->ofproto_class = class;
529 ofproto->name = xstrdup(datapath_name);
530 ofproto->type = xstrdup(datapath_type);
531 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
532 hash_string(ofproto->name, 0));
533 ofproto->datapath_id = 0;
534 ofproto->forward_bpdu = false;
535 ofproto->fallback_dpid = pick_fallback_dpid();
536 ofproto->mfr_desc = NULL;
537 ofproto->hw_desc = NULL;
538 ofproto->sw_desc = NULL;
539 ofproto->serial_desc = NULL;
540 ofproto->dp_desc = NULL;
541 ofproto->frag_handling = OFPC_FRAG_NORMAL;
542 hmap_init(&ofproto->ports);
543 hmap_init(&ofproto->ofport_usage);
544 shash_init(&ofproto->port_by_name);
545 simap_init(&ofproto->ofp_requests);
546 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
547 ofproto->eviction_group_timer = LLONG_MIN;
548 ofproto->tables = NULL;
549 ofproto->n_tables = 0;
550 ofproto->tables_version = CLS_MIN_VERSION;
551 hindex_init(&ofproto->cookies);
552 hmap_init(&ofproto->learned_cookies);
553 list_init(&ofproto->expirable);
554 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
555 guarded_list_init(&ofproto->rule_executes);
556 ofproto->vlan_bitmap = NULL;
557 ofproto->vlans_changed = false;
558 ofproto->min_mtu = INT_MAX;
559 ovs_rwlock_init(&ofproto->groups_rwlock);
560 hmap_init(&ofproto->groups);
561 ovs_mutex_unlock(&ofproto_mutex);
562 ofproto->ogf.types = 0xf;
563 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
564 OFPGFC_SELECT_WEIGHT;
565 for (i = 0; i < 4; i++) {
566 ofproto->ogf.max_groups[i] = OFPG_MAX;
567 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
570 error = ofproto->ofproto_class->construct(ofproto);
572 VLOG_ERR("failed to open datapath %s: %s",
573 datapath_name, ovs_strerror(error));
574 connmgr_destroy(ofproto->connmgr);
575 ofproto_destroy__(ofproto);
579 /* Check that hidden tables, if any, are at the end. */
580 ovs_assert(ofproto->n_tables);
581 for (i = 0; i + 1 < ofproto->n_tables; i++) {
582 enum oftable_flags flags = ofproto->tables[i].flags;
583 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
585 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
588 ofproto->datapath_id = pick_datapath_id(ofproto);
591 /* Initialize meters table. */
592 if (ofproto->ofproto_class->meter_get_features) {
593 ofproto->ofproto_class->meter_get_features(ofproto,
594 &ofproto->meter_features);
596 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
598 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
599 * sizeof(struct meter *));
601 /* Set the initial tables version. */
602 ofproto_bump_tables_version(ofproto);
608 /* Must be called (only) by an ofproto implementation in its constructor
609 * function. See the large comment on 'construct' in struct ofproto_class for
612 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
614 struct oftable *table;
616 ovs_assert(!ofproto->n_tables);
617 ovs_assert(n_tables >= 1 && n_tables <= 255);
619 ofproto->n_tables = n_tables;
620 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
621 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
626 /* To be optionally called (only) by an ofproto implementation in its
627 * constructor function. See the large comment on 'construct' in struct
628 * ofproto_class for details.
630 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
631 * will then ensure that actions passed into the ofproto implementation will
632 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
633 * function is not called, there will be no such restriction.
635 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
636 * the 'max_ports' restriction. */
638 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
640 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
641 ofproto->max_ports = max_ports;
645 ofproto_get_datapath_id(const struct ofproto *ofproto)
647 return ofproto->datapath_id;
651 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
653 uint64_t old_dpid = p->datapath_id;
654 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
655 if (p->datapath_id != old_dpid) {
656 /* Force all active connections to reconnect, since there is no way to
657 * notify a controller that the datapath ID has changed. */
658 ofproto_reconnect_controllers(p);
663 ofproto_set_controllers(struct ofproto *p,
664 const struct ofproto_controller *controllers,
665 size_t n_controllers, uint32_t allowed_versions)
667 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
672 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
674 connmgr_set_fail_mode(p->connmgr, fail_mode);
677 /* Drops the connections between 'ofproto' and all of its controllers, forcing
678 * them to reconnect. */
680 ofproto_reconnect_controllers(struct ofproto *ofproto)
682 connmgr_reconnect(ofproto->connmgr);
685 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
686 * in-band control should guarantee access, in the same way that in-band
687 * control guarantees access to OpenFlow controllers. */
689 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
690 const struct sockaddr_in *extras, size_t n)
692 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
695 /* Sets the OpenFlow queue used by flows set up by in-band control on
696 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
697 * flows will use the default queue. */
699 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
701 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
704 /* Sets the number of flows at which eviction from the kernel flow table
707 ofproto_set_flow_limit(unsigned limit)
709 ofproto_flow_limit = limit;
712 /* Sets the maximum idle time for flows in the datapath before they are
715 ofproto_set_max_idle(unsigned max_idle)
717 ofproto_max_idle = max_idle;
720 /* If forward_bpdu is true, the NORMAL action will forward frames with
721 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
722 * the NORMAL action will drop these frames. */
724 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
726 bool old_val = ofproto->forward_bpdu;
727 ofproto->forward_bpdu = forward_bpdu;
728 if (old_val != ofproto->forward_bpdu) {
729 if (ofproto->ofproto_class->forward_bpdu_changed) {
730 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
735 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
736 * 'idle_time', in seconds, and the maximum number of MAC table entries to
739 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
742 if (ofproto->ofproto_class->set_mac_table_config) {
743 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
748 /* Multicast snooping configuration. */
750 /* Configures multicast snooping on 'ofproto' using the settings
751 * defined in 's'. If 's' is NULL, disables multicast snooping.
753 * Returns 0 if successful, otherwise a positive errno value. */
755 ofproto_set_mcast_snooping(struct ofproto *ofproto,
756 const struct ofproto_mcast_snooping_settings *s)
758 return (ofproto->ofproto_class->set_mcast_snooping
759 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
763 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
765 * Returns 0 if successful, otherwise a positive errno value.*/
767 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
768 const struct ofproto_mcast_snooping_port_settings *s)
770 return (ofproto->ofproto_class->set_mcast_snooping_port
771 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
776 ofproto_set_n_dpdk_rxqs(int n_rxqs)
778 n_dpdk_rxqs = MAX(n_rxqs, 0);
782 ofproto_set_cpu_mask(const char *cmask)
786 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
790 ofproto_set_threads(int n_handlers_, int n_revalidators_)
792 int threads = MAX(count_cpu_cores(), 2);
794 n_revalidators = MAX(n_revalidators_, 0);
795 n_handlers = MAX(n_handlers_, 0);
797 if (!n_revalidators) {
798 n_revalidators = n_handlers
799 ? MAX(threads - (int) n_handlers, 1)
804 n_handlers = MAX(threads - (int) n_revalidators, 1);
809 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
812 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
816 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
818 return connmgr_set_snoops(ofproto->connmgr, snoops);
822 ofproto_set_netflow(struct ofproto *ofproto,
823 const struct netflow_options *nf_options)
825 if (nf_options && sset_is_empty(&nf_options->collectors)) {
829 if (ofproto->ofproto_class->set_netflow) {
830 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
832 return nf_options ? EOPNOTSUPP : 0;
837 ofproto_set_sflow(struct ofproto *ofproto,
838 const struct ofproto_sflow_options *oso)
840 if (oso && sset_is_empty(&oso->targets)) {
844 if (ofproto->ofproto_class->set_sflow) {
845 return ofproto->ofproto_class->set_sflow(ofproto, oso);
847 return oso ? EOPNOTSUPP : 0;
852 ofproto_set_ipfix(struct ofproto *ofproto,
853 const struct ofproto_ipfix_bridge_exporter_options *bo,
854 const struct ofproto_ipfix_flow_exporter_options *fo,
857 if (ofproto->ofproto_class->set_ipfix) {
858 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
860 return (bo || fo) ? EOPNOTSUPP : 0;
865 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
867 flow_restore_wait = flow_restore_wait_db;
871 ofproto_get_flow_restore_wait(void)
873 return flow_restore_wait;
877 /* Spanning Tree Protocol (STP) configuration. */
879 /* Configures STP on 'ofproto' using the settings defined in 's'. If
880 * 's' is NULL, disables STP.
882 * Returns 0 if successful, otherwise a positive errno value. */
884 ofproto_set_stp(struct ofproto *ofproto,
885 const struct ofproto_stp_settings *s)
887 return (ofproto->ofproto_class->set_stp
888 ? ofproto->ofproto_class->set_stp(ofproto, s)
892 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
893 * 'enabled' member of 's' is false, then the other members are not
896 * Returns 0 if successful, otherwise a positive errno value. */
898 ofproto_get_stp_status(struct ofproto *ofproto,
899 struct ofproto_stp_status *s)
901 return (ofproto->ofproto_class->get_stp_status
902 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
906 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
907 * in 's'. The caller is responsible for assigning STP port numbers
908 * (using the 'port_num' member in the range of 1 through 255, inclusive)
909 * and ensuring there are no duplicates. If the 's' is NULL, then STP
910 * is disabled on the port.
912 * Returns 0 if successful, otherwise a positive errno value.*/
914 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
915 const struct ofproto_port_stp_settings *s)
917 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
919 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
920 ofproto->name, ofp_port);
924 return (ofproto->ofproto_class->set_stp_port
925 ? ofproto->ofproto_class->set_stp_port(ofport, s)
929 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
930 * 's'. If the 'enabled' member in 's' is false, then the other members
931 * are not meaningful.
933 * Returns 0 if successful, otherwise a positive errno value.*/
935 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
936 struct ofproto_port_stp_status *s)
938 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
940 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
941 "port %"PRIu16, ofproto->name, ofp_port);
945 return (ofproto->ofproto_class->get_stp_port_status
946 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
950 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
951 * 's'. If the 'enabled' member in 's' is false, then the other members
952 * are not meaningful.
954 * Returns 0 if successful, otherwise a positive errno value.*/
956 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
957 struct ofproto_port_stp_stats *s)
959 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
961 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
962 "port %"PRIu16, ofproto->name, ofp_port);
966 return (ofproto->ofproto_class->get_stp_port_stats
967 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
971 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
973 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
974 * 's' is NULL, disables RSTP.
976 * Returns 0 if successful, otherwise a positive errno value. */
978 ofproto_set_rstp(struct ofproto *ofproto,
979 const struct ofproto_rstp_settings *s)
981 if (!ofproto->ofproto_class->set_rstp) {
984 ofproto->ofproto_class->set_rstp(ofproto, s);
988 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
989 * 'enabled' member of 's' is false, then the other members are not
992 * Returns 0 if successful, otherwise a positive errno value. */
994 ofproto_get_rstp_status(struct ofproto *ofproto,
995 struct ofproto_rstp_status *s)
997 if (!ofproto->ofproto_class->get_rstp_status) {
1000 ofproto->ofproto_class->get_rstp_status(ofproto, s);
1004 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1005 * in 's'. The caller is responsible for assigning RSTP port numbers
1006 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1007 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1008 * is disabled on the port.
1010 * Returns 0 if successful, otherwise a positive errno value.*/
1012 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
1013 const struct ofproto_port_rstp_settings *s)
1015 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1017 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
1018 ofproto->name, ofp_port);
1022 if (!ofproto->ofproto_class->set_rstp_port) {
1025 ofproto->ofproto_class->set_rstp_port(ofport, s);
1029 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1030 * 's'. If the 'enabled' member in 's' is false, then the other members
1031 * are not meaningful.
1033 * Returns 0 if successful, otherwise a positive errno value.*/
1035 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1036 struct ofproto_port_rstp_status *s)
1038 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1040 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1041 "port %"PRIu16, ofproto->name, ofp_port);
1045 if (!ofproto->ofproto_class->get_rstp_port_status) {
1048 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1052 /* Queue DSCP configuration. */
1054 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1055 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1056 * to implement QoS. Instead, it is used to implement features which require
1057 * knowledge of what queues exist on a port, and some basic information about
1060 * Returns 0 if successful, otherwise a positive errno value. */
1062 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1063 const struct ofproto_port_queue *queues,
1066 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1069 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1070 ofproto->name, ofp_port);
1074 return (ofproto->ofproto_class->set_queues
1075 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1079 /* LLDP configuration. */
1081 ofproto_port_set_lldp(struct ofproto *ofproto,
1082 ofp_port_t ofp_port,
1083 const struct smap *cfg)
1085 struct ofport *ofport;
1088 ofport = ofproto_get_port(ofproto, ofp_port);
1090 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1091 ofproto->name, ofp_port);
1094 error = (ofproto->ofproto_class->set_lldp
1095 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1098 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1099 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1100 ovs_strerror(error));
1105 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1106 const struct aa_settings *s)
1108 if (!ofproto->ofproto_class->set_aa) {
1111 ofproto->ofproto_class->set_aa(ofproto, s);
1116 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1117 const struct aa_mapping_settings *s)
1119 if (!ofproto->ofproto_class->aa_mapping_set) {
1122 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1127 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1129 if (!ofproto->ofproto_class->aa_mapping_unset) {
1132 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1137 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1138 struct ovs_list *list)
1140 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1143 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1148 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1150 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1153 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1156 /* Connectivity Fault Management configuration. */
1158 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1160 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1162 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1163 if (ofport && ofproto->ofproto_class->set_cfm) {
1164 ofproto->ofproto_class->set_cfm(ofport, NULL);
1168 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1169 * basic configuration from the configuration members in 'cfm', and the remote
1170 * maintenance point ID from remote_mpid. Ignores the statistics members of
1173 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1175 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1176 const struct cfm_settings *s)
1178 struct ofport *ofport;
1181 ofport = ofproto_get_port(ofproto, ofp_port);
1183 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1184 ofproto->name, ofp_port);
1188 /* XXX: For configuration simplicity, we only support one remote_mpid
1189 * outside of the CFM module. It's not clear if this is the correct long
1190 * term solution or not. */
1191 error = (ofproto->ofproto_class->set_cfm
1192 ? ofproto->ofproto_class->set_cfm(ofport, s)
1195 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1196 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1197 ovs_strerror(error));
1201 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1202 * 'ofproto' does not have a port 'ofp_port'. */
1204 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1205 const struct smap *cfg)
1207 struct ofport *ofport;
1210 ofport = ofproto_get_port(ofproto, ofp_port);
1212 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1213 ofproto->name, ofp_port);
1217 error = (ofproto->ofproto_class->set_bfd
1218 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1221 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1222 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1223 ovs_strerror(error));
1227 /* Checks the status change of BFD on 'ofport'.
1229 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1231 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1233 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1234 return (ofport && ofproto->ofproto_class->bfd_status_changed
1235 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1239 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1240 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1241 * is not an OpenFlow port in 'ofproto'.
1243 * The caller must provide and own '*status'. */
1245 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1246 struct smap *status)
1248 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1249 return (ofport && ofproto->ofproto_class->get_bfd_status
1250 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1254 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1255 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1256 * 0 if LACP partner information is not current (generally indicating a
1257 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1259 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1261 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1262 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1263 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1268 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1270 struct ofproto *ofproto = port->ofproto;
1273 if (ofproto->ofproto_class->port_get_lacp_stats) {
1274 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1284 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1285 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1286 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1287 * configuration plus, if there is more than one slave, a bonding
1290 * If 'aux' is already registered then this function updates its configuration
1291 * to 's'. Otherwise, this function registers a new bundle.
1293 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1296 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1297 const struct ofproto_bundle_settings *s)
1299 return (ofproto->ofproto_class->bundle_set
1300 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1304 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1305 * If no such bundle has been registered, this has no effect. */
1307 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1309 return ofproto_bundle_register(ofproto, aux, NULL);
1313 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1314 * If 'aux' is already registered then this function updates its configuration
1315 * to 's'. Otherwise, this function registers a new mirror. */
1317 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1318 const struct ofproto_mirror_settings *s)
1320 return (ofproto->ofproto_class->mirror_set
1321 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1325 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1326 * If no mirror has been registered, this has no effect. */
1328 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1330 return ofproto_mirror_register(ofproto, aux, NULL);
1333 /* Retrieves statistics from mirror associated with client data pointer
1334 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1335 * 'bytes', respectively. If a particular counters is not supported,
1336 * the appropriate argument is set to UINT64_MAX.
1339 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1340 uint64_t *packets, uint64_t *bytes)
1342 if (!ofproto->ofproto_class->mirror_get_stats) {
1343 *packets = *bytes = UINT64_MAX;
1347 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1351 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1352 * which all packets are flooded, instead of using MAC learning. If
1353 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1355 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1358 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1360 return (ofproto->ofproto_class->set_flood_vlans
1361 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1365 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1366 * output for a mirror. */
1368 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1370 return (ofproto->ofproto_class->is_mirror_output_bundle
1371 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1375 /* Configuration of OpenFlow tables. */
1377 /* Returns the number of OpenFlow tables in 'ofproto'. */
1379 ofproto_get_n_tables(const struct ofproto *ofproto)
1381 return ofproto->n_tables;
1384 /* Returns the number of Controller visible OpenFlow tables
1385 * in 'ofproto'. This number will exclude Hidden tables.
1386 * This funtion's return value should be less or equal to that of
1387 * ofproto_get_n_tables() . */
1389 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1391 uint8_t n = ofproto->n_tables;
1393 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1394 * if present, are always at the end.) */
1395 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1402 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1403 * settings from 's'. 'table_id' must be in the range 0 through the number of
1404 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1406 * For read-only tables, only the name may be configured. */
1408 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1409 const struct ofproto_table_settings *s)
1411 struct oftable *table;
1413 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1414 table = &ofproto->tables[table_id];
1416 oftable_set_name(table, s->name);
1418 if (table->flags & OFTABLE_READONLY) {
1423 oftable_enable_eviction(table, s->groups, s->n_groups);
1425 oftable_disable_eviction(table);
1428 table->max_flows = s->max_flows;
1430 if (classifier_set_prefix_fields(&table->cls,
1431 s->prefix_fields, s->n_prefix_fields)) {
1432 /* XXX: Trigger revalidation. */
1435 ovs_mutex_lock(&ofproto_mutex);
1436 evict_rules_from_table(table);
1437 ovs_mutex_unlock(&ofproto_mutex);
1441 ofproto_has_snoops(const struct ofproto *ofproto)
1443 return connmgr_has_snoops(ofproto->connmgr);
1447 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1449 connmgr_get_snoops(ofproto->connmgr, snoops);
1452 /* Deletes 'rule' from 'ofproto'.
1454 * Within an ofproto implementation, this function allows an ofproto
1455 * implementation to destroy any rules that remain when its ->destruct()
1456 * function is called. This function is not suitable for use elsewhere in an
1457 * ofproto implementation.
1459 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1460 * Cycle" in ofproto-provider.h. */
1462 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1463 OVS_EXCLUDED(ofproto_mutex)
1465 /* This skips the ofmonitor and flow-removed notifications because the
1466 * switch is being deleted and any OpenFlow channels have been or soon will
1468 ovs_mutex_lock(&ofproto_mutex);
1470 if (!rule->removed) {
1471 /* Make sure there is no postponed removal of the rule. */
1472 ovs_assert(cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
1474 if (!classifier_remove(&rule->ofproto->tables[rule->table_id].cls,
1478 ofproto_rule_remove__(rule->ofproto, rule);
1479 ofproto->ofproto_class->rule_delete(rule);
1480 ofproto_rule_unref(rule);
1482 ovs_mutex_unlock(&ofproto_mutex);
1486 ofproto_flush__(struct ofproto *ofproto)
1487 OVS_EXCLUDED(ofproto_mutex)
1489 struct oftable *table;
1491 /* This will flush all datapath flows. */
1492 if (ofproto->ofproto_class->flush) {
1493 ofproto->ofproto_class->flush(ofproto);
1496 /* XXX: There is a small race window here, where new datapath flows can be
1497 * created by upcall handlers based on the existing flow table. We can not
1498 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1499 * as then we could deadlock on syncing with the handler threads waiting on
1500 * the same mutex. */
1502 ovs_mutex_lock(&ofproto_mutex);
1503 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1504 struct rule_collection rules;
1507 if (table->flags & OFTABLE_HIDDEN) {
1511 rule_collection_init(&rules);
1513 CLS_FOR_EACH (rule, cr, &table->cls) {
1514 rule_collection_add(&rules, rule);
1516 delete_flows__(&rules, OFPRR_DELETE, NULL);
1518 /* XXX: Concurrent handler threads may insert new learned flows based on
1519 * learn actions of the now deleted flows right after we release
1520 * 'ofproto_mutex'. */
1521 ovs_mutex_unlock(&ofproto_mutex);
1524 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1527 ofproto_destroy__(struct ofproto *ofproto)
1528 OVS_EXCLUDED(ofproto_mutex)
1530 struct oftable *table;
1532 destroy_rule_executes(ofproto);
1533 delete_group(ofproto, OFPG_ALL);
1535 guarded_list_destroy(&ofproto->rule_executes);
1536 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1537 hmap_destroy(&ofproto->groups);
1539 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1540 free(ofproto->name);
1541 free(ofproto->type);
1542 free(ofproto->mfr_desc);
1543 free(ofproto->hw_desc);
1544 free(ofproto->sw_desc);
1545 free(ofproto->serial_desc);
1546 free(ofproto->dp_desc);
1547 hmap_destroy(&ofproto->ports);
1548 hmap_destroy(&ofproto->ofport_usage);
1549 shash_destroy(&ofproto->port_by_name);
1550 simap_destroy(&ofproto->ofp_requests);
1552 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1553 oftable_destroy(table);
1555 free(ofproto->tables);
1557 ovs_assert(hindex_is_empty(&ofproto->cookies));
1558 hindex_destroy(&ofproto->cookies);
1560 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1561 hmap_destroy(&ofproto->learned_cookies);
1563 free(ofproto->vlan_bitmap);
1565 ofproto->ofproto_class->dealloc(ofproto);
1568 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1569 * - 1st we defer the removal of the rules from the classifier
1570 * - 2nd we defer the actual destruction of the rules. */
1572 ofproto_destroy_defer__(struct ofproto *ofproto)
1573 OVS_EXCLUDED(ofproto_mutex)
1575 ovsrcu_postpone(ofproto_destroy__, ofproto);
1579 ofproto_destroy(struct ofproto *p)
1580 OVS_EXCLUDED(ofproto_mutex)
1582 struct ofport *ofport, *next_ofport;
1583 struct ofport_usage *usage, *next_usage;
1590 meter_delete(p, 1, p->meter_features.max_meters);
1591 p->meter_features.max_meters = 0;
1597 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1598 ofport_destroy(ofport);
1601 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1602 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1606 p->ofproto_class->destruct(p);
1608 /* We should not postpone this because it involves deleting a listening
1609 * socket which we may want to reopen soon. 'connmgr' should not be used
1610 * by other threads */
1611 connmgr_destroy(p->connmgr);
1613 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1614 ovsrcu_postpone(ofproto_destroy_defer__, p);
1617 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1618 * kernel datapath, for example, this destroys the datapath in the kernel, and
1619 * with the netdev-based datapath, it tears down the data structures that
1620 * represent the datapath.
1622 * The datapath should not be currently open as an ofproto. */
1624 ofproto_delete(const char *name, const char *type)
1626 const struct ofproto_class *class = ofproto_class_find__(type);
1627 return (!class ? EAFNOSUPPORT
1628 : !class->del ? EACCES
1629 : class->del(type, name));
1633 process_port_change(struct ofproto *ofproto, int error, char *devname)
1635 if (error == ENOBUFS) {
1636 reinit_ports(ofproto);
1637 } else if (!error) {
1638 update_port(ofproto, devname);
1644 ofproto_type_run(const char *datapath_type)
1646 const struct ofproto_class *class;
1649 datapath_type = ofproto_normalize_type(datapath_type);
1650 class = ofproto_class_find__(datapath_type);
1652 error = class->type_run ? class->type_run(datapath_type) : 0;
1653 if (error && error != EAGAIN) {
1654 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1655 datapath_type, ovs_strerror(error));
1661 ofproto_type_wait(const char *datapath_type)
1663 const struct ofproto_class *class;
1665 datapath_type = ofproto_normalize_type(datapath_type);
1666 class = ofproto_class_find__(datapath_type);
1668 if (class->type_wait) {
1669 class->type_wait(datapath_type);
1674 ofproto_run(struct ofproto *p)
1679 error = p->ofproto_class->run(p);
1680 if (error && error != EAGAIN) {
1681 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1684 run_rule_executes(p);
1686 /* Restore the eviction group heap invariant occasionally. */
1687 if (p->eviction_group_timer < time_msec()) {
1690 p->eviction_group_timer = time_msec() + 1000;
1692 for (i = 0; i < p->n_tables; i++) {
1693 struct oftable *table = &p->tables[i];
1694 struct eviction_group *evg;
1697 if (!table->eviction_fields) {
1701 if (table->n_flows > 100000) {
1702 static struct vlog_rate_limit count_rl =
1703 VLOG_RATE_LIMIT_INIT(1, 1);
1704 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1705 " number of rules: %d", i, table->n_flows);
1708 ovs_mutex_lock(&ofproto_mutex);
1709 CLS_FOR_EACH (rule, cr, &table->cls) {
1710 if (rule->idle_timeout || rule->hard_timeout) {
1711 if (!rule->eviction_group) {
1712 eviction_group_add_rule(rule);
1714 heap_raw_change(&rule->evg_node,
1715 rule_eviction_priority(p, rule));
1720 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1721 heap_rebuild(&evg->rules);
1723 ovs_mutex_unlock(&ofproto_mutex);
1727 if (p->ofproto_class->port_poll) {
1730 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1731 process_port_change(p, error, devname);
1735 new_seq = seq_read(connectivity_seq_get());
1736 if (new_seq != p->change_seq) {
1737 struct sset devnames;
1738 const char *devname;
1739 struct ofport *ofport;
1741 /* Update OpenFlow port status for any port whose netdev has changed.
1743 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1744 * destroyed, so it's not safe to update ports directly from the
1745 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1746 * need this two-phase approach. */
1747 sset_init(&devnames);
1748 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1749 uint64_t port_change_seq;
1751 port_change_seq = netdev_get_change_seq(ofport->netdev);
1752 if (ofport->change_seq != port_change_seq) {
1753 ofport->change_seq = port_change_seq;
1754 sset_add(&devnames, netdev_get_name(ofport->netdev));
1757 SSET_FOR_EACH (devname, &devnames) {
1758 update_port(p, devname);
1760 sset_destroy(&devnames);
1762 p->change_seq = new_seq;
1765 connmgr_run(p->connmgr, handle_openflow);
1771 ofproto_wait(struct ofproto *p)
1773 p->ofproto_class->wait(p);
1774 if (p->ofproto_class->port_poll_wait) {
1775 p->ofproto_class->port_poll_wait(p);
1777 seq_wait(connectivity_seq_get(), p->change_seq);
1778 connmgr_wait(p->connmgr);
1782 ofproto_is_alive(const struct ofproto *p)
1784 return connmgr_has_controllers(p->connmgr);
1787 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1788 * memory_report(). */
1790 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1792 const struct oftable *table;
1793 unsigned int n_rules;
1795 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1798 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1799 n_rules += table->n_flows;
1801 simap_increase(usage, "rules", n_rules);
1803 if (ofproto->ofproto_class->get_memory_usage) {
1804 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1807 connmgr_get_memory_usage(ofproto->connmgr, usage);
1811 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1813 const struct ofproto_class *class;
1815 datapath_type = ofproto_normalize_type(datapath_type);
1816 class = ofproto_class_find__(datapath_type);
1818 if (class && class->type_get_memory_usage) {
1819 class->type_get_memory_usage(datapath_type, usage);
1824 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1827 connmgr_get_controller_info(ofproto->connmgr, info);
1831 ofproto_free_ofproto_controller_info(struct shash *info)
1833 connmgr_free_controller_info(info);
1836 /* Makes a deep copy of 'old' into 'port'. */
1838 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1840 port->name = xstrdup(old->name);
1841 port->type = xstrdup(old->type);
1842 port->ofp_port = old->ofp_port;
1845 /* Frees memory allocated to members of 'ofproto_port'.
1847 * Do not call this function on an ofproto_port obtained from
1848 * ofproto_port_dump_next(): that function retains ownership of the data in the
1851 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1853 free(ofproto_port->name);
1854 free(ofproto_port->type);
1857 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1859 * This function provides no status indication. An error status for the entire
1860 * dump operation is provided when it is completed by calling
1861 * ofproto_port_dump_done().
1864 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1865 const struct ofproto *ofproto)
1867 dump->ofproto = ofproto;
1868 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1872 /* Attempts to retrieve another port from 'dump', which must have been created
1873 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1874 * 'port' and returns true. On failure, returns false.
1876 * Failure might indicate an actual error or merely that the last port has been
1877 * dumped. An error status for the entire dump operation is provided when it
1878 * is completed by calling ofproto_port_dump_done().
1880 * The ofproto owns the data stored in 'port'. It will remain valid until at
1881 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1882 * ofproto_port_dump_done(). */
1884 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1885 struct ofproto_port *port)
1887 const struct ofproto *ofproto = dump->ofproto;
1893 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1896 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1902 /* Completes port table dump operation 'dump', which must have been created
1903 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1904 * error-free, otherwise a positive errno value describing the problem. */
1906 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1908 const struct ofproto *ofproto = dump->ofproto;
1910 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1913 return dump->error == EOF ? 0 : dump->error;
1916 /* Returns the type to pass to netdev_open() when a datapath of type
1917 * 'datapath_type' has a port of type 'port_type', for a few special
1918 * cases when a netdev type differs from a port type. For example, when
1919 * using the userspace datapath, a port of type "internal" needs to be
1922 * Returns either 'type' itself or a string literal, which must not be
1925 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1927 const struct ofproto_class *class;
1929 datapath_type = ofproto_normalize_type(datapath_type);
1930 class = ofproto_class_find__(datapath_type);
1935 return (class->port_open_type
1936 ? class->port_open_type(datapath_type, port_type)
1940 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1941 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1942 * the port's OpenFlow port number.
1944 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1945 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1946 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1947 * 'ofp_portp' is non-null). */
1949 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1950 ofp_port_t *ofp_portp)
1952 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1955 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1957 const char *netdev_name = netdev_get_name(netdev);
1959 simap_put(&ofproto->ofp_requests, netdev_name,
1960 ofp_to_u16(ofp_port));
1961 update_port(ofproto, netdev_name);
1964 *ofp_portp = OFPP_NONE;
1966 struct ofproto_port ofproto_port;
1968 error = ofproto_port_query_by_name(ofproto,
1969 netdev_get_name(netdev),
1972 *ofp_portp = ofproto_port.ofp_port;
1973 ofproto_port_destroy(&ofproto_port);
1980 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1981 * initializes '*port' appropriately; on failure, returns a positive errno
1984 * The caller owns the data in 'ofproto_port' and must free it with
1985 * ofproto_port_destroy() when it is no longer needed. */
1987 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1988 struct ofproto_port *port)
1992 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1994 memset(port, 0, sizeof *port);
1999 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
2000 * Returns 0 if successful, otherwise a positive errno. */
2002 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
2004 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2005 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
2006 struct simap_node *ofp_request_node;
2009 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
2010 if (ofp_request_node) {
2011 simap_delete(&ofproto->ofp_requests, ofp_request_node);
2014 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
2015 if (!error && ofport) {
2016 /* 'name' is the netdev's name and update_port() is going to close the
2017 * netdev. Just in case update_port() refers to 'name' after it
2018 * destroys 'ofport', make a copy of it around the update_port()
2020 char *devname = xstrdup(name);
2021 update_port(ofproto, devname);
2028 flow_mod_init(struct ofputil_flow_mod *fm,
2029 const struct match *match, int priority,
2030 const struct ofpact *ofpacts, size_t ofpacts_len,
2031 enum ofp_flow_mod_command command)
2033 memset(fm, 0, sizeof *fm);
2035 fm->priority = priority;
2038 fm->modify_cookie = false;
2040 fm->command = command;
2041 fm->idle_timeout = 0;
2042 fm->hard_timeout = 0;
2044 fm->buffer_id = UINT32_MAX;
2045 fm->out_port = OFPP_ANY;
2046 fm->out_group = OFPG_ANY;
2048 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2049 fm->ofpacts_len = ofpacts_len;
2050 fm->delete_reason = OFPRR_DELETE;
2054 simple_flow_mod(struct ofproto *ofproto,
2055 const struct match *match, int priority,
2056 const struct ofpact *ofpacts, size_t ofpacts_len,
2057 enum ofp_flow_mod_command command)
2059 struct ofputil_flow_mod fm;
2061 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2063 return handle_flow_mod__(ofproto, &fm, NULL);
2066 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2067 * performs the 'n_actions' actions in 'actions'. The new flow will not
2070 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2071 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2072 * controllers; otherwise, it will be hidden.
2074 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2076 * This is a helper function for in-band control and fail-open. */
2078 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2080 const struct ofpact *ofpacts, size_t ofpacts_len)
2081 OVS_EXCLUDED(ofproto_mutex)
2083 const struct rule *rule;
2086 /* First do a cheap check whether the rule we're looking for already exists
2087 * with the actions that we want. If it does, then we're done. */
2088 rule = rule_from_cls_rule(classifier_find_match_exactly(
2089 &ofproto->tables[0].cls, match, priority,
2092 const struct rule_actions *actions = rule_get_actions(rule);
2093 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2094 ofpacts, ofpacts_len);
2099 /* If there's no such rule or the rule doesn't have the actions we want,
2100 * fall back to a executing a full flow mod. We can't optimize this at
2101 * all because we didn't take enough locks above to ensure that the flow
2102 * table didn't already change beneath us. */
2104 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2105 OFPFC_MODIFY_STRICT);
2109 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2110 * an OFPERR_* OpenFlow error code on failure.
2112 * This is a helper function for in-band control and fail-open and the "learn"
2115 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2116 OVS_EXCLUDED(ofproto_mutex)
2118 /* Optimize for the most common case of a repeated learn action.
2119 * If an identical flow already exists we only need to update its
2120 * 'modified' time. */
2121 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2122 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2123 struct oftable *table = &ofproto->tables[fm->table_id];
2127 rule = rule_from_cls_rule(classifier_find_match_exactly(
2128 &table->cls, &fm->match, fm->priority,
2131 /* Reading many of the rule fields and writing on 'modified'
2132 * requires the rule->mutex. Also, rule->actions may change
2133 * if rule->mutex is not held. */
2134 const struct rule_actions *actions;
2136 ovs_mutex_lock(&rule->mutex);
2137 actions = rule_get_actions(rule);
2138 if (rule->idle_timeout == fm->idle_timeout
2139 && rule->hard_timeout == fm->hard_timeout
2140 && rule->importance == fm->importance
2141 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2142 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2143 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2144 actions->ofpacts, actions->ofpacts_len)) {
2145 /* Rule already exists and need not change, only update the
2146 modified timestamp. */
2147 rule->modified = time_msec();
2150 ovs_mutex_unlock(&rule->mutex);
2158 return handle_flow_mod__(ofproto, fm, NULL);
2161 /* Searches for a rule with matching criteria exactly equal to 'target' in
2162 * ofproto's table 0 and, if it finds one, deletes it.
2164 * This is a helper function for in-band control and fail-open. */
2166 ofproto_delete_flow(struct ofproto *ofproto,
2167 const struct match *target, int priority)
2168 OVS_EXCLUDED(ofproto_mutex)
2170 struct classifier *cls = &ofproto->tables[0].cls;
2173 /* First do a cheap check whether the rule we're looking for has already
2174 * been deleted. If so, then we're done. */
2175 rule = rule_from_cls_rule(classifier_find_match_exactly(
2176 cls, target, priority, CLS_MAX_VERSION));
2181 /* Execute a flow mod. We can't optimize this at all because we didn't
2182 * take enough locks above to ensure that the flow table didn't already
2183 * change beneath us. */
2184 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2187 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2188 * the flows required by in-band control and fail-open. */
2190 ofproto_flush_flows(struct ofproto *ofproto)
2192 COVERAGE_INC(ofproto_flush);
2193 ofproto_flush__(ofproto);
2194 connmgr_flushed(ofproto->connmgr);
2198 reinit_ports(struct ofproto *p)
2200 struct ofproto_port_dump dump;
2201 struct sset devnames;
2202 struct ofport *ofport;
2203 struct ofproto_port ofproto_port;
2204 const char *devname;
2206 COVERAGE_INC(ofproto_reinit_ports);
2208 sset_init(&devnames);
2209 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2210 sset_add(&devnames, netdev_get_name(ofport->netdev));
2212 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2213 sset_add(&devnames, ofproto_port.name);
2216 SSET_FOR_EACH (devname, &devnames) {
2217 update_port(p, devname);
2219 sset_destroy(&devnames);
2223 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2227 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2228 port_idx = port_idx ? port_idx : UINT16_MAX;
2230 if (port_idx >= ofproto->max_ports
2231 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2232 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2233 long long int last_used_at, lru = LLONG_MAX;
2235 /* Search for a free OpenFlow port number. We try not to
2236 * immediately reuse them to prevent problems due to old
2239 * We limit the automatically assigned port numbers to the lower half
2240 * of the port range, to reserve the upper half for assignment by
2243 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2244 ofproto->alloc_port_no = 1;
2246 last_used_at = ofport_get_usage(ofproto,
2247 u16_to_ofp(ofproto->alloc_port_no));
2248 if (!last_used_at) {
2249 port_idx = ofproto->alloc_port_no;
2251 } else if ( last_used_at < time_msec() - 60*60*1000) {
2252 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2253 * more than an hour ago, consider it usable. */
2254 ofport_remove_usage(ofproto,
2255 u16_to_ofp(ofproto->alloc_port_no));
2256 port_idx = ofproto->alloc_port_no;
2258 } else if (last_used_at < lru) {
2260 lru_ofport = ofproto->alloc_port_no;
2263 if (ofproto->alloc_port_no == end_port_no) {
2265 port_idx = lru_ofport;
2272 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2273 return u16_to_ofp(port_idx);
2277 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2279 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2280 ofport_set_usage(ofproto, ofp_port, time_msec());
2284 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2285 * pointer if the netdev cannot be opened. On success, also fills in
2287 static struct netdev *
2288 ofport_open(struct ofproto *ofproto,
2289 struct ofproto_port *ofproto_port,
2290 struct ofputil_phy_port *pp)
2292 enum netdev_flags flags;
2293 struct netdev *netdev;
2296 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2298 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2299 "cannot be opened (%s)",
2301 ofproto_port->name, ofproto_port->ofp_port,
2302 ofproto_port->name, ovs_strerror(error));
2306 if (ofproto_port->ofp_port == OFPP_NONE) {
2307 if (!strcmp(ofproto->name, ofproto_port->name)) {
2308 ofproto_port->ofp_port = OFPP_LOCAL;
2310 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2311 ofproto_port->name);
2314 pp->port_no = ofproto_port->ofp_port;
2315 netdev_get_etheraddr(netdev, pp->hw_addr);
2316 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2317 netdev_get_flags(netdev, &flags);
2318 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2319 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2320 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2321 &pp->supported, &pp->peer);
2322 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2323 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2328 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2329 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2332 ofport_equal(const struct ofputil_phy_port *a,
2333 const struct ofputil_phy_port *b)
2335 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2336 && a->state == b->state
2337 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2338 && a->curr == b->curr
2339 && a->advertised == b->advertised
2340 && a->supported == b->supported
2341 && a->peer == b->peer
2342 && a->curr_speed == b->curr_speed
2343 && a->max_speed == b->max_speed);
2346 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2347 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2348 * one with the same name or port number). */
2350 ofport_install(struct ofproto *p,
2351 struct netdev *netdev, const struct ofputil_phy_port *pp)
2353 const char *netdev_name = netdev_get_name(netdev);
2354 struct ofport *ofport;
2357 /* Create ofport. */
2358 ofport = p->ofproto_class->port_alloc();
2363 ofport->ofproto = p;
2364 ofport->netdev = netdev;
2365 ofport->change_seq = netdev_get_change_seq(netdev);
2367 ofport->ofp_port = pp->port_no;
2368 ofport->created = time_msec();
2370 /* Add port to 'p'. */
2371 hmap_insert(&p->ports, &ofport->hmap_node,
2372 hash_ofp_port(ofport->ofp_port));
2373 shash_add(&p->port_by_name, netdev_name, ofport);
2375 update_mtu(p, ofport);
2377 /* Let the ofproto_class initialize its private data. */
2378 error = p->ofproto_class->port_construct(ofport);
2382 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2386 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2387 p->name, netdev_name, ovs_strerror(error));
2389 ofport_destroy__(ofport);
2391 netdev_close(netdev);
2395 /* Removes 'ofport' from 'p' and destroys it. */
2397 ofport_remove(struct ofport *ofport)
2399 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2401 ofport_destroy(ofport);
2404 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2407 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2409 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2411 ofport_remove(port);
2415 /* Updates 'port' with new 'pp' description.
2417 * Does not handle a name or port number change. The caller must implement
2418 * such a change as a delete followed by an add. */
2420 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2422 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2423 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2424 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2425 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2426 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2427 port->pp.curr = pp->curr;
2428 port->pp.advertised = pp->advertised;
2429 port->pp.supported = pp->supported;
2430 port->pp.peer = pp->peer;
2431 port->pp.curr_speed = pp->curr_speed;
2432 port->pp.max_speed = pp->max_speed;
2434 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2435 &port->pp, OFPPR_MODIFY);
2438 /* Update OpenFlow 'state' in 'port' and notify controller. */
2440 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2442 if (port->pp.state != state) {
2443 port->pp.state = state;
2444 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2445 &port->pp, OFPPR_MODIFY);
2450 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2452 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2454 if (port->ofproto->ofproto_class->set_realdev) {
2455 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2457 if (port->ofproto->ofproto_class->set_stp_port) {
2458 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2460 if (port->ofproto->ofproto_class->set_rstp_port) {
2461 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2463 if (port->ofproto->ofproto_class->set_cfm) {
2464 port->ofproto->ofproto_class->set_cfm(port, NULL);
2466 if (port->ofproto->ofproto_class->bundle_remove) {
2467 port->ofproto->ofproto_class->bundle_remove(port);
2473 ofport_destroy__(struct ofport *port)
2475 struct ofproto *ofproto = port->ofproto;
2476 const char *name = netdev_get_name(port->netdev);
2478 hmap_remove(&ofproto->ports, &port->hmap_node);
2479 shash_delete(&ofproto->port_by_name,
2480 shash_find(&ofproto->port_by_name, name));
2482 netdev_close(port->netdev);
2483 ofproto->ofproto_class->port_dealloc(port);
2487 ofport_destroy(struct ofport *port)
2490 dealloc_ofp_port(port->ofproto, port->ofp_port);
2491 port->ofproto->ofproto_class->port_destruct(port);
2492 ofport_destroy__(port);
2497 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2499 struct ofport *port;
2501 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2503 if (port->ofp_port == ofp_port) {
2510 static long long int
2511 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2513 struct ofport_usage *usage;
2515 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2516 &ofproto->ofport_usage) {
2517 if (usage->ofp_port == ofp_port) {
2518 return usage->last_used;
2525 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2526 long long int last_used)
2528 struct ofport_usage *usage;
2529 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2530 &ofproto->ofport_usage) {
2531 if (usage->ofp_port == ofp_port) {
2532 usage->last_used = last_used;
2536 ovs_assert(last_used == LLONG_MAX);
2538 usage = xmalloc(sizeof *usage);
2539 usage->ofp_port = ofp_port;
2540 usage->last_used = last_used;
2541 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2542 hash_ofp_port(ofp_port));
2546 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2548 struct ofport_usage *usage;
2549 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2550 &ofproto->ofport_usage) {
2551 if (usage->ofp_port == ofp_port) {
2552 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2560 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2562 struct ofproto *ofproto = port->ofproto;
2565 if (ofproto->ofproto_class->port_get_stats) {
2566 error = ofproto->ofproto_class->port_get_stats(port, stats);
2575 update_port(struct ofproto *ofproto, const char *name)
2577 struct ofproto_port ofproto_port;
2578 struct ofputil_phy_port pp;
2579 struct netdev *netdev;
2580 struct ofport *port;
2582 COVERAGE_INC(ofproto_update_port);
2584 /* Fetch 'name''s location and properties from the datapath. */
2585 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2586 ? ofport_open(ofproto, &ofproto_port, &pp)
2590 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2591 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2592 struct netdev *old_netdev = port->netdev;
2594 /* 'name' hasn't changed location. Any properties changed? */
2595 if (!ofport_equal(&port->pp, &pp)) {
2596 ofport_modified(port, &pp);
2599 update_mtu(ofproto, port);
2601 /* Install the newly opened netdev in case it has changed.
2602 * Don't close the old netdev yet in case port_modified has to
2603 * remove a retained reference to it.*/
2604 port->netdev = netdev;
2605 port->change_seq = netdev_get_change_seq(netdev);
2607 if (port->ofproto->ofproto_class->port_modified) {
2608 port->ofproto->ofproto_class->port_modified(port);
2611 netdev_close(old_netdev);
2613 /* If 'port' is nonnull then its name differs from 'name' and thus
2614 * we should delete it. If we think there's a port named 'name'
2615 * then its port number must be wrong now so delete it too. */
2617 ofport_remove(port);
2619 ofport_remove_with_name(ofproto, name);
2620 ofport_install(ofproto, netdev, &pp);
2623 /* Any port named 'name' is gone now. */
2624 ofport_remove_with_name(ofproto, name);
2626 ofproto_port_destroy(&ofproto_port);
2630 init_ports(struct ofproto *p)
2632 struct ofproto_port_dump dump;
2633 struct ofproto_port ofproto_port;
2634 struct shash_node *node, *next;
2636 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2637 const char *name = ofproto_port.name;
2639 if (shash_find(&p->port_by_name, name)) {
2640 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2643 struct ofputil_phy_port pp;
2644 struct netdev *netdev;
2646 /* Check if an OpenFlow port number had been requested. */
2647 node = shash_find(&init_ofp_ports, name);
2649 const struct iface_hint *iface_hint = node->data;
2650 simap_put(&p->ofp_requests, name,
2651 ofp_to_u16(iface_hint->ofp_port));
2654 netdev = ofport_open(p, &ofproto_port, &pp);
2656 ofport_install(p, netdev, &pp);
2657 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2658 p->alloc_port_no = MAX(p->alloc_port_no,
2659 ofp_to_u16(ofproto_port.ofp_port));
2665 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2666 struct iface_hint *iface_hint = node->data;
2668 if (!strcmp(iface_hint->br_name, p->name)) {
2669 free(iface_hint->br_name);
2670 free(iface_hint->br_type);
2672 shash_delete(&init_ofp_ports, node);
2679 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2680 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2682 find_min_mtu(struct ofproto *p)
2684 struct ofport *ofport;
2687 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2688 struct netdev *netdev = ofport->netdev;
2691 /* Skip any internal ports, since that's what we're trying to
2693 if (!strcmp(netdev_get_type(netdev), "internal")) {
2697 if (netdev_get_mtu(netdev, &dev_mtu)) {
2700 if (!mtu || dev_mtu < mtu) {
2705 return mtu ? mtu: ETH_PAYLOAD_MAX;
2708 /* Update MTU of all datapath devices on 'p' to the minimum of the
2709 * non-datapath ports in event of 'port' added or changed. */
2711 update_mtu(struct ofproto *p, struct ofport *port)
2713 struct ofport *ofport;
2714 struct netdev *netdev = port->netdev;
2715 int dev_mtu, old_min;
2717 if (netdev_get_mtu(netdev, &dev_mtu)) {
2721 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2722 if (dev_mtu > p->min_mtu) {
2723 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2724 dev_mtu = p->min_mtu;
2727 port->mtu = dev_mtu;
2731 /* For non-internal port find new min mtu. */
2732 old_min = p->min_mtu;
2733 port->mtu = dev_mtu;
2734 p->min_mtu = find_min_mtu(p);
2735 if (p->min_mtu == old_min) {
2739 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2740 struct netdev *netdev = ofport->netdev;
2742 if (!strcmp(netdev_get_type(netdev), "internal")) {
2743 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2744 ofport->mtu = p->min_mtu;
2751 ofproto_rule_destroy__(struct rule *rule)
2752 OVS_NO_THREAD_SAFETY_ANALYSIS
2754 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2755 rule_actions_destroy(rule_get_actions(rule));
2756 ovs_mutex_destroy(&rule->mutex);
2757 rule->ofproto->ofproto_class->rule_dealloc(rule);
2761 rule_destroy_cb(struct rule *rule)
2762 OVS_NO_THREAD_SAFETY_ANALYSIS
2764 /* Send rule removed if needed. */
2765 if (rule->flags & OFPUTIL_FF_SEND_FLOW_REM
2766 && rule->removed_reason != OVS_OFPRR_NONE
2767 && !rule_is_hidden(rule)) {
2768 ofproto_rule_send_removed(rule);
2770 rule->ofproto->ofproto_class->rule_destruct(rule);
2771 ofproto_rule_destroy__(rule);
2775 ofproto_rule_ref(struct rule *rule)
2778 ovs_refcount_ref(&rule->ref_count);
2783 ofproto_rule_try_ref(struct rule *rule)
2786 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2791 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2792 * ref_count reaches 0.
2794 * Use of RCU allows short term use (between RCU quiescent periods) without
2795 * keeping a reference. A reference must be taken if the rule needs to
2796 * stay around accross the RCU quiescent periods. */
2798 ofproto_rule_unref(struct rule *rule)
2800 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2801 ovsrcu_postpone(rule_destroy_cb, rule);
2806 remove_rule_rcu__(struct rule *rule)
2807 OVS_REQUIRES(ofproto_mutex)
2809 struct ofproto *ofproto = rule->ofproto;
2810 struct oftable *table = &ofproto->tables[rule->table_id];
2812 ovs_assert(!cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
2813 if (!classifier_remove(&table->cls, &rule->cr)) {
2816 ofproto->ofproto_class->rule_delete(rule);
2817 ofproto_rule_unref(rule);
2821 remove_rule_rcu(struct rule *rule)
2822 OVS_EXCLUDED(ofproto_mutex)
2824 ovs_mutex_lock(&ofproto_mutex);
2825 remove_rule_rcu__(rule);
2826 ovs_mutex_unlock(&ofproto_mutex);
2829 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2831 remove_rules_rcu(struct rule **rules)
2832 OVS_EXCLUDED(ofproto_mutex)
2834 struct rule **orig_rules = rules;
2837 struct ofproto *ofproto = rules[0]->ofproto;
2838 unsigned long tables[BITMAP_N_LONGS(256)];
2842 memset(tables, 0, sizeof tables);
2844 ovs_mutex_lock(&ofproto_mutex);
2845 while ((rule = *rules++)) {
2846 /* Defer once for each new table. This defers the subtable cleanup
2847 * until later, so that when removing large number of flows the
2848 * operation is faster. */
2849 if (!bitmap_is_set(tables, rule->table_id)) {
2850 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
2852 bitmap_set1(tables, rule->table_id);
2853 classifier_defer(cls);
2855 remove_rule_rcu__(rule);
2858 BITMAP_FOR_EACH_1(table_id, 256, tables) {
2859 struct classifier *cls = &ofproto->tables[table_id].cls;
2861 classifier_publish(cls);
2863 ovs_mutex_unlock(&ofproto_mutex);
2870 ofproto_group_ref(struct ofgroup *group)
2873 ovs_refcount_ref(&group->ref_count);
2878 ofproto_group_unref(struct ofgroup *group)
2880 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2881 group->ofproto->ofproto_class->group_destruct(group);
2882 ofputil_bucket_list_destroy(&group->buckets);
2883 group->ofproto->ofproto_class->group_dealloc(group);
2887 static uint32_t get_provider_meter_id(const struct ofproto *,
2888 uint32_t of_meter_id);
2890 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2891 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2892 const struct rule_actions *
2893 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2895 struct rule_actions *actions;
2897 actions = xmalloc(sizeof *actions + ofpacts_len);
2898 actions->ofpacts_len = ofpacts_len;
2899 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2900 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2902 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2908 /* Free the actions after the RCU quiescent period is reached. */
2910 rule_actions_destroy(const struct rule_actions *actions)
2913 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2917 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2918 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2920 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2921 OVS_REQUIRES(ofproto_mutex)
2923 if (port == OFPP_ANY) {
2926 const struct rule_actions *actions = rule_get_actions(rule);
2927 return ofpacts_output_to_port(actions->ofpacts,
2928 actions->ofpacts_len, port);
2932 /* Returns true if 'rule' has group and equals group_id. */
2934 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2935 OVS_REQUIRES(ofproto_mutex)
2937 if (group_id == OFPG_ANY) {
2940 const struct rule_actions *actions = rule_get_actions(rule);
2941 return ofpacts_output_to_group(actions->ofpacts,
2942 actions->ofpacts_len, group_id);
2947 rule_execute_destroy(struct rule_execute *e)
2949 ofproto_rule_unref(e->rule);
2950 list_remove(&e->list_node);
2954 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2955 * by passing them to the ofproto provider. */
2957 run_rule_executes(struct ofproto *ofproto)
2958 OVS_EXCLUDED(ofproto_mutex)
2960 struct rule_execute *e, *next;
2961 struct ovs_list executes;
2963 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2964 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2967 flow_extract(e->packet, &flow);
2968 flow.in_port.ofp_port = e->in_port;
2969 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2971 rule_execute_destroy(e);
2975 /* Destroys and discards all "rule_execute" operations queued up in
2976 * ofproto->rule_executes. */
2978 destroy_rule_executes(struct ofproto *ofproto)
2980 struct rule_execute *e, *next;
2981 struct ovs_list executes;
2983 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2984 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2985 dp_packet_delete(e->packet);
2986 rule_execute_destroy(e);
2991 rule_is_readonly(const struct rule *rule)
2993 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2994 return (table->flags & OFTABLE_READONLY) != 0;
2998 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
3000 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
3001 return hash_3words(cookie, cookie >> 32, table_id);
3005 learned_cookies_update_one__(struct ofproto *ofproto,
3006 const struct ofpact_learn *learn,
3007 int delta, struct ovs_list *dead_cookies)
3008 OVS_REQUIRES(ofproto_mutex)
3010 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
3011 struct learned_cookie *c;
3013 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
3014 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
3016 ovs_assert(c->n >= 0);
3019 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
3020 list_push_back(dead_cookies, &c->u.list_node);
3027 ovs_assert(delta > 0);
3028 c = xmalloc(sizeof *c);
3029 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
3030 c->cookie = learn->cookie;
3031 c->table_id = learn->table_id;
3035 static const struct ofpact_learn *
3036 next_learn_with_delete(const struct rule_actions *actions,
3037 const struct ofpact_learn *start)
3039 const struct ofpact *pos;
3041 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
3042 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
3043 pos = ofpact_next(pos)) {
3044 if (pos->type == OFPACT_LEARN) {
3045 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
3046 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3056 learned_cookies_update__(struct ofproto *ofproto,
3057 const struct rule_actions *actions,
3058 int delta, struct ovs_list *dead_cookies)
3059 OVS_REQUIRES(ofproto_mutex)
3061 if (actions->has_learn_with_delete) {
3062 const struct ofpact_learn *learn;
3064 for (learn = next_learn_with_delete(actions, NULL); learn;
3065 learn = next_learn_with_delete(actions, learn)) {
3066 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3072 learned_cookies_inc(struct ofproto *ofproto,
3073 const struct rule_actions *actions)
3074 OVS_REQUIRES(ofproto_mutex)
3076 learned_cookies_update__(ofproto, actions, +1, NULL);
3080 learned_cookies_dec(struct ofproto *ofproto,
3081 const struct rule_actions *actions,
3082 struct ovs_list *dead_cookies)
3083 OVS_REQUIRES(ofproto_mutex)
3085 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3089 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3090 OVS_REQUIRES(ofproto_mutex)
3092 struct learned_cookie *c;
3094 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3095 struct rule_criteria criteria;
3096 struct rule_collection rules;
3099 match_init_catchall(&match);
3100 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3101 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3102 rule_criteria_require_rw(&criteria, false);
3103 collect_rules_loose(ofproto, &criteria, &rules);
3104 rule_criteria_destroy(&criteria);
3105 delete_flows__(&rules, OFPRR_DELETE, NULL);
3112 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3114 ofconn_send_reply(ofconn, make_echo_reply(oh));
3119 query_tables(struct ofproto *ofproto,
3120 struct ofputil_table_features **featuresp,
3121 struct ofputil_table_stats **statsp)
3123 struct mf_bitmap rw_fields = oxm_writable_fields();
3124 struct mf_bitmap match = oxm_matchable_fields();
3125 struct mf_bitmap mask = oxm_maskable_fields();
3127 struct ofputil_table_features *features;
3128 struct ofputil_table_stats *stats;
3131 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3132 for (i = 0; i < ofproto->n_tables; i++) {
3133 struct ofputil_table_features *f = &features[i];
3136 sprintf(f->name, "table%d", i);
3137 f->metadata_match = OVS_BE64_MAX;
3138 f->metadata_write = OVS_BE64_MAX;
3139 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3140 f->max_entries = 1000000;
3142 bool more_tables = false;
3143 for (int j = i + 1; j < ofproto->n_tables; j++) {
3144 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3145 bitmap_set1(f->nonmiss.next, j);
3149 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3151 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3153 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3154 f->nonmiss.write.set_fields = rw_fields;
3155 f->nonmiss.apply = f->nonmiss.write;
3156 f->miss = f->nonmiss;
3160 f->wildcard = match;
3164 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3165 for (i = 0; i < ofproto->n_tables; i++) {
3166 struct ofputil_table_stats *s = &stats[i];
3169 s->active_count = ofproto->tables[i].n_flows;
3171 s->active_count -= connmgr_count_hidden_rules(
3179 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3181 for (i = 0; i < ofproto->n_tables; i++) {
3182 const struct oftable *table = &ofproto->tables[i];
3183 struct ofputil_table_features *f = &features[i];
3186 ovs_strzcpy(f->name, table->name, sizeof f->name);
3189 if (table->max_flows < f->max_entries) {
3190 f->max_entries = table->max_flows;
3196 query_switch_features(struct ofproto *ofproto,
3197 bool *arp_match_ip, uint64_t *ofpacts)
3199 struct ofputil_table_features *features, *f;
3201 *arp_match_ip = false;
3204 query_tables(ofproto, &features, NULL);
3205 for (f = features; f < &features[ofproto->n_tables]; f++) {
3206 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3207 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3208 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3209 *arp_match_ip = true;
3215 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3219 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3221 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3222 struct ofputil_switch_features features;
3223 struct ofport *port;
3227 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3229 features.datapath_id = ofproto->datapath_id;
3230 features.n_buffers = pktbuf_capacity();
3231 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3232 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3233 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3234 OFPUTIL_C_GROUP_STATS);
3236 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3238 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3239 features.auxiliary_id = 0;
3240 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3242 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3243 ofputil_put_switch_features_port(&port->pp, b);
3246 ofconn_send_reply(ofconn, b);
3251 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3253 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3254 struct ofp_switch_config *osc;
3255 enum ofp_config_flags flags;
3259 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3260 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3261 flags = ofproto->frag_handling;
3262 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3263 if (oh->version < OFP13_VERSION
3264 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3265 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3267 osc->flags = htons(flags);
3268 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3269 ofconn_send_reply(ofconn, buf);
3275 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3277 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3278 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3279 uint16_t flags = ntohs(osc->flags);
3281 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3282 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3283 enum ofp_config_flags cur = ofproto->frag_handling;
3284 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3286 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3288 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3289 ofproto->frag_handling = next;
3291 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3293 ofputil_frag_handling_to_string(next));
3297 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3298 ofconn_set_invalid_ttl_to_controller(ofconn,
3299 (oh->version < OFP13_VERSION
3300 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3302 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3307 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3308 * error message code for the caller to propagate upward. Otherwise, returns
3311 * The log message mentions 'msg_type'. */
3313 reject_slave_controller(struct ofconn *ofconn)
3315 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3316 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3317 return OFPERR_OFPBRC_IS_SLAVE;
3323 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3326 * - If they use a meter, then 'ofproto' has that meter configured.
3328 * - If they use any groups, then 'ofproto' has that group configured.
3330 * Returns 0 if successful, otherwise an OpenFlow error. */
3332 ofproto_check_ofpacts(struct ofproto *ofproto,
3333 const struct ofpact ofpacts[], size_t ofpacts_len)
3335 const struct ofpact *a;
3338 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3339 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3340 return OFPERR_OFPMMFC_INVALID_METER;
3343 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3344 if (a->type == OFPACT_GROUP
3345 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3346 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3354 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3356 struct ofproto *p = ofconn_get_ofproto(ofconn);
3357 struct ofputil_packet_out po;
3358 struct dp_packet *payload;
3359 uint64_t ofpacts_stub[1024 / 8];
3360 struct ofpbuf ofpacts;
3364 COVERAGE_INC(ofproto_packet_out);
3366 error = reject_slave_controller(ofconn);
3371 /* Decode message. */
3372 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3373 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3375 goto exit_free_ofpacts;
3377 if (ofp_to_u16(po.in_port) >= p->max_ports
3378 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3379 error = OFPERR_OFPBRC_BAD_PORT;
3380 goto exit_free_ofpacts;
3384 if (po.buffer_id != UINT32_MAX) {
3385 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3386 if (error || !payload) {
3387 goto exit_free_ofpacts;
3390 /* Ensure that the L3 header is 32-bit aligned. */
3391 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3394 /* Verify actions against packet, then send packet if successful. */
3395 flow_extract(payload, &flow);
3396 flow.in_port.ofp_port = po.in_port;
3397 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3399 error = p->ofproto_class->packet_out(p, payload, &flow,
3400 po.ofpacts, po.ofpacts_len);
3402 dp_packet_delete(payload);
3405 ofpbuf_uninit(&ofpacts);
3411 update_port_config(struct ofconn *ofconn, struct ofport *port,
3412 enum ofputil_port_config config,
3413 enum ofputil_port_config mask)
3415 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3417 if (toggle & OFPUTIL_PC_PORT_DOWN
3418 && (config & OFPUTIL_PC_PORT_DOWN
3419 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3420 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3421 /* We tried to bring the port up or down, but it failed, so don't
3422 * update the "down" bit. */
3423 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3427 enum ofputil_port_config old_config = port->pp.config;
3428 port->pp.config ^= toggle;
3429 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3430 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3436 port_mod_start(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3437 struct ofport **port)
3439 struct ofproto *p = ofconn_get_ofproto(ofconn);
3441 *port = ofproto_get_port(p, pm->port_no);
3443 return OFPERR_OFPPMFC_BAD_PORT;
3445 if (!eth_addr_equals((*port)->pp.hw_addr, pm->hw_addr)) {
3446 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3452 port_mod_finish(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3453 struct ofport *port)
3455 update_port_config(ofconn, port, pm->config, pm->mask);
3456 if (pm->advertise) {
3457 netdev_set_advertisements(port->netdev, pm->advertise);
3462 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3464 struct ofputil_port_mod pm;
3465 struct ofport *port;
3468 error = reject_slave_controller(ofconn);
3473 error = ofputil_decode_port_mod(oh, &pm, false);
3478 error = port_mod_start(ofconn, &pm, &port);
3480 port_mod_finish(ofconn, &pm, port);
3486 handle_desc_stats_request(struct ofconn *ofconn,
3487 const struct ofp_header *request)
3489 static const char *default_mfr_desc = "Nicira, Inc.";
3490 static const char *default_hw_desc = "Open vSwitch";
3491 static const char *default_sw_desc = VERSION;
3492 static const char *default_serial_desc = "None";
3493 static const char *default_dp_desc = "None";
3495 struct ofproto *p = ofconn_get_ofproto(ofconn);
3496 struct ofp_desc_stats *ods;
3499 msg = ofpraw_alloc_stats_reply(request, 0);
3500 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3501 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3502 sizeof ods->mfr_desc);
3503 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3504 sizeof ods->hw_desc);
3505 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3506 sizeof ods->sw_desc);
3507 ovs_strlcpy(ods->serial_num,
3508 p->serial_desc ? p->serial_desc : default_serial_desc,
3509 sizeof ods->serial_num);
3510 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3511 sizeof ods->dp_desc);
3512 ofconn_send_reply(ofconn, msg);
3518 handle_table_stats_request(struct ofconn *ofconn,
3519 const struct ofp_header *request)
3521 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3522 struct ofputil_table_features *features;
3523 struct ofputil_table_stats *stats;
3524 struct ofpbuf *reply;
3527 query_tables(ofproto, &features, &stats);
3529 reply = ofputil_encode_table_stats_reply(request);
3530 for (i = 0; i < ofproto->n_tables; i++) {
3531 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3532 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3535 ofconn_send_reply(ofconn, reply);
3544 handle_table_features_request(struct ofconn *ofconn,
3545 const struct ofp_header *request)
3547 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3548 struct ofputil_table_features *features;
3549 struct ovs_list replies;
3553 ofpbuf_use_const(&msg, request, ntohs(request->length));
3554 ofpraw_pull_assert(&msg);
3555 if (msg.size || ofpmp_more(request)) {
3556 return OFPERR_OFPTFFC_EPERM;
3559 query_tables(ofproto, &features, NULL);
3561 ofpmp_init(&replies, request);
3562 for (i = 0; i < ofproto->n_tables; i++) {
3563 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3564 ofputil_append_table_features_reply(&features[i], &replies);
3567 ofconn_send_replies(ofconn, &replies);
3575 append_port_stat(struct ofport *port, struct ovs_list *replies)
3577 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3579 calc_duration(port->created, time_msec(),
3580 &ops.duration_sec, &ops.duration_nsec);
3582 /* Intentionally ignore return value, since errors will set
3583 * 'stats' to all-1s, which is correct for OpenFlow, and
3584 * netdev_get_stats() will log errors. */
3585 ofproto_port_get_stats(port, &ops.stats);
3587 ofputil_append_port_stat(replies, &ops);
3591 handle_port_request(struct ofconn *ofconn,
3592 const struct ofp_header *request, ofp_port_t port_no,
3593 void (*cb)(struct ofport *, struct ovs_list *replies))
3595 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3596 struct ofport *port;
3597 struct ovs_list replies;
3599 ofpmp_init(&replies, request);
3600 if (port_no != OFPP_ANY) {
3601 port = ofproto_get_port(ofproto, port_no);
3606 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3611 ofconn_send_replies(ofconn, &replies);
3615 handle_port_stats_request(struct ofconn *ofconn,
3616 const struct ofp_header *request)
3621 error = ofputil_decode_port_stats_request(request, &port_no);
3623 handle_port_request(ofconn, request, port_no, append_port_stat);
3629 append_port_desc(struct ofport *port, struct ovs_list *replies)
3631 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3635 handle_port_desc_stats_request(struct ofconn *ofconn,
3636 const struct ofp_header *request)
3641 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3643 handle_port_request(ofconn, request, port_no, append_port_desc);
3649 hash_cookie(ovs_be64 cookie)
3651 return hash_uint64((OVS_FORCE uint64_t)cookie);
3655 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3656 OVS_REQUIRES(ofproto_mutex)
3658 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3659 hash_cookie(rule->flow_cookie));
3663 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3664 OVS_REQUIRES(ofproto_mutex)
3666 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3670 calc_duration(long long int start, long long int now,
3671 uint32_t *sec, uint32_t *nsec)
3673 long long int msecs = now - start;
3674 *sec = msecs / 1000;
3675 *nsec = (msecs % 1000) * (1000 * 1000);
3678 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3679 * true if 'table_id' is OK, false otherwise. */
3681 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3683 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3686 static struct oftable *
3687 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3689 struct oftable *table;
3691 for (table = &ofproto->tables[table_id];
3692 table < &ofproto->tables[ofproto->n_tables];
3694 if (!(table->flags & OFTABLE_HIDDEN)) {
3702 static struct oftable *
3703 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3705 if (table_id == 0xff) {
3706 return next_visible_table(ofproto, 0);
3707 } else if (table_id < ofproto->n_tables) {
3708 return &ofproto->tables[table_id];
3714 static struct oftable *
3715 next_matching_table(const struct ofproto *ofproto,
3716 const struct oftable *table, uint8_t table_id)
3718 return (table_id == 0xff
3719 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3723 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3725 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3726 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3728 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3729 * only once, for that table. (This can be used to access tables marked
3732 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3733 * entered at all. (Perhaps you should have validated TABLE_ID with
3734 * check_table_id().)
3736 * All parameters are evaluated multiple times.
3738 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3739 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3741 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3743 /* Initializes 'criteria' in a straightforward way based on the other
3746 * By default, the criteria include flows that are read-only, on the assumption
3747 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3748 * if flows will be modified.
3750 * For "loose" matching, the 'priority' parameter is unimportant and may be
3753 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3754 const struct match *match, int priority,
3755 cls_version_t version, ovs_be64 cookie,
3756 ovs_be64 cookie_mask, ofp_port_t out_port,
3759 criteria->table_id = table_id;
3760 cls_rule_init(&criteria->cr, match, priority, version);
3761 criteria->cookie = cookie;
3762 criteria->cookie_mask = cookie_mask;
3763 criteria->out_port = out_port;
3764 criteria->out_group = out_group;
3766 /* We ordinarily want to skip hidden rules, but there has to be a way for
3767 * code internal to OVS to modify and delete them, so if the criteria
3768 * specify a priority that can only be for a hidden flow, then allow hidden
3769 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3770 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3772 criteria->include_hidden = priority > UINT16_MAX;
3774 /* We assume that the criteria are being used to collect flows for reading
3775 * but not modification. Thus, we should collect read-only flows. */
3776 criteria->include_readonly = true;
3779 /* By default, criteria initialized by rule_criteria_init() will match flows
3780 * that are read-only, on the assumption that the collected flows won't be
3781 * modified. Call this function to match only flows that are be modifiable.
3783 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3784 * caller has special privileges that allow it to modify even "read-only"
3787 rule_criteria_require_rw(struct rule_criteria *criteria,
3788 bool can_write_readonly)
3790 criteria->include_readonly = can_write_readonly;
3794 rule_criteria_destroy(struct rule_criteria *criteria)
3796 cls_rule_destroy(&criteria->cr);
3800 rule_collection_init(struct rule_collection *rules)
3802 rules->rules = rules->stub;
3804 rules->capacity = ARRAY_SIZE(rules->stub);
3808 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3810 if (rules->n >= rules->capacity) {
3811 size_t old_size, new_size;
3813 old_size = rules->capacity * sizeof *rules->rules;
3814 rules->capacity *= 2;
3815 new_size = rules->capacity * sizeof *rules->rules;
3817 if (rules->rules == rules->stub) {
3818 rules->rules = xmalloc(new_size);
3819 memcpy(rules->rules, rules->stub, old_size);
3821 rules->rules = xrealloc(rules->rules, new_size);
3825 rules->rules[rules->n++] = rule;
3829 rule_collection_ref(struct rule_collection *rules)
3830 OVS_REQUIRES(ofproto_mutex)
3834 for (i = 0; i < rules->n; i++) {
3835 ofproto_rule_ref(rules->rules[i]);
3840 rule_collection_unref(struct rule_collection *rules)
3844 for (i = 0; i < rules->n; i++) {
3845 ofproto_rule_unref(rules->rules[i]);
3849 /* Returns a NULL-terminated array of rule pointers,
3850 * destroys 'rules'. */
3851 static struct rule **
3852 rule_collection_detach(struct rule_collection *rules)
3854 struct rule **rule_array;
3856 rule_collection_add(rules, NULL);
3858 if (rules->rules == rules->stub) {
3859 rules->rules = xmemdup(rules->rules, rules->n * sizeof *rules->rules);
3862 rule_array = rules->rules;
3863 rule_collection_init(rules);
3869 rule_collection_destroy(struct rule_collection *rules)
3871 if (rules->rules != rules->stub) {
3875 /* Make repeated destruction harmless. */
3876 rule_collection_init(rules);
3879 /* Schedules postponed removal of rules, destroys 'rules'. */
3881 rule_collection_remove_postponed(struct rule_collection *rules)
3882 OVS_REQUIRES(ofproto_mutex)
3885 if (rules->n == 1) {
3886 ovsrcu_postpone(remove_rule_rcu, rules->rules[0]);
3888 ovsrcu_postpone(remove_rules_rcu, rule_collection_detach(rules));
3893 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3894 * function verifies most of the criteria in 'c' itself, but the caller must
3895 * check 'c->cr' itself.
3897 * Rules that have already been marked for removal are not collected.
3899 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3900 * 'c' only includes modifiable rules). */
3902 collect_rule(struct rule *rule, const struct rule_criteria *c,
3903 struct rule_collection *rules, size_t *n_readonly)
3904 OVS_REQUIRES(ofproto_mutex)
3906 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3907 && ofproto_rule_has_out_port(rule, c->out_port)
3908 && ofproto_rule_has_out_group(rule, c->out_group)
3909 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3910 && (!rule_is_hidden(rule) || c->include_hidden)
3911 && cls_rule_visible_in_version(&rule->cr, c->cr.version)) {
3912 /* Rule matches all the criteria... */
3913 if (!rule_is_readonly(rule) || c->include_readonly) {
3915 rule_collection_add(rules, rule);
3917 /* ...except it's read-only. */
3923 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3924 * on classifiers rules are done in the "loose" way required for OpenFlow
3925 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3928 * Returns 0 on success, otherwise an OpenFlow error code. */
3930 collect_rules_loose(struct ofproto *ofproto,
3931 const struct rule_criteria *criteria,
3932 struct rule_collection *rules)
3933 OVS_REQUIRES(ofproto_mutex)
3935 struct oftable *table;
3936 enum ofperr error = 0;
3937 size_t n_readonly = 0;
3939 rule_collection_init(rules);
3941 if (!check_table_id(ofproto, criteria->table_id)) {
3942 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3946 if (criteria->cookie_mask == OVS_BE64_MAX) {
3949 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3950 hash_cookie(criteria->cookie),
3951 &ofproto->cookies) {
3952 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3953 collect_rule(rule, criteria, rules, &n_readonly);
3957 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3960 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3961 collect_rule(rule, criteria, rules, &n_readonly);
3967 if (!error && !rules->n && n_readonly) {
3968 /* We didn't find any rules to modify. We did find some read-only
3969 * rules that we're not allowed to modify, so report that. */
3970 error = OFPERR_OFPBRC_EPERM;
3973 rule_collection_destroy(rules);
3978 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3979 * on classifiers rules are done in the "strict" way required for OpenFlow
3980 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3981 * rules on list 'rules'.
3983 * Returns 0 on success, otherwise an OpenFlow error code. */
3985 collect_rules_strict(struct ofproto *ofproto,
3986 const struct rule_criteria *criteria,
3987 struct rule_collection *rules)
3988 OVS_REQUIRES(ofproto_mutex)
3990 struct oftable *table;
3991 size_t n_readonly = 0;
3992 enum ofperr error = 0;
3994 rule_collection_init(rules);
3996 if (!check_table_id(ofproto, criteria->table_id)) {
3997 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4001 if (criteria->cookie_mask == OVS_BE64_MAX) {
4004 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4005 hash_cookie(criteria->cookie),
4006 &ofproto->cookies) {
4007 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
4008 collect_rule(rule, criteria, rules, &n_readonly);
4012 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4015 rule = rule_from_cls_rule(classifier_find_rule_exactly(
4016 &table->cls, &criteria->cr));
4018 collect_rule(rule, criteria, rules, &n_readonly);
4024 if (!error && !rules->n && n_readonly) {
4025 /* We didn't find any rules to modify. We did find some read-only
4026 * rules that we're not allowed to modify, so report that. */
4027 error = OFPERR_OFPBRC_EPERM;
4030 rule_collection_destroy(rules);
4035 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4036 * forced into the range of a uint16_t. */
4038 age_secs(long long int age_ms)
4040 return (age_ms < 0 ? 0
4041 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
4042 : (unsigned int) age_ms / 1000);
4046 handle_flow_stats_request(struct ofconn *ofconn,
4047 const struct ofp_header *request)
4048 OVS_EXCLUDED(ofproto_mutex)
4050 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4051 struct ofputil_flow_stats_request fsr;
4052 struct rule_criteria criteria;
4053 struct rule_collection rules;
4054 struct ovs_list replies;
4058 error = ofputil_decode_flow_stats_request(&fsr, request);
4063 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
4064 fsr.cookie, fsr.cookie_mask, fsr.out_port,
4067 ovs_mutex_lock(&ofproto_mutex);
4068 error = collect_rules_loose(ofproto, &criteria, &rules);
4069 rule_criteria_destroy(&criteria);
4071 rule_collection_ref(&rules);
4073 ovs_mutex_unlock(&ofproto_mutex);
4079 ofpmp_init(&replies, request);
4080 for (i = 0; i < rules.n; i++) {
4081 struct rule *rule = rules.rules[i];
4082 long long int now = time_msec();
4083 struct ofputil_flow_stats fs;
4084 long long int created, used, modified;
4085 const struct rule_actions *actions;
4086 enum ofputil_flow_mod_flags flags;
4088 ovs_mutex_lock(&rule->mutex);
4089 fs.cookie = rule->flow_cookie;
4090 fs.idle_timeout = rule->idle_timeout;
4091 fs.hard_timeout = rule->hard_timeout;
4092 fs.importance = rule->importance;
4093 created = rule->created;
4094 modified = rule->modified;
4095 actions = rule_get_actions(rule);
4096 flags = rule->flags;
4097 ovs_mutex_unlock(&rule->mutex);
4099 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
4100 &fs.byte_count, &used);
4102 minimatch_expand(&rule->cr.match, &fs.match);
4103 fs.table_id = rule->table_id;
4104 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4105 fs.priority = rule->cr.priority;
4106 fs.idle_age = age_secs(now - used);
4107 fs.hard_age = age_secs(now - modified);
4108 fs.ofpacts = actions->ofpacts;
4109 fs.ofpacts_len = actions->ofpacts_len;
4112 ofputil_append_flow_stats_reply(&fs, &replies);
4115 rule_collection_unref(&rules);
4116 rule_collection_destroy(&rules);
4118 ofconn_send_replies(ofconn, &replies);
4124 flow_stats_ds(struct rule *rule, struct ds *results)
4126 uint64_t packet_count, byte_count;
4127 const struct rule_actions *actions;
4128 long long int created, used;
4130 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4131 &byte_count, &used);
4133 ovs_mutex_lock(&rule->mutex);
4134 actions = rule_get_actions(rule);
4135 created = rule->created;
4136 ovs_mutex_unlock(&rule->mutex);
4138 if (rule->table_id != 0) {
4139 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4141 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4142 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4143 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4144 cls_rule_format(&rule->cr, results);
4145 ds_put_char(results, ',');
4147 ds_put_cstr(results, "actions=");
4148 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4150 ds_put_cstr(results, "\n");
4153 /* Adds a pretty-printed description of all flows to 'results', including
4154 * hidden flows (e.g., set up by in-band control). */
4156 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4158 struct oftable *table;
4160 OFPROTO_FOR_EACH_TABLE (table, p) {
4163 CLS_FOR_EACH (rule, cr, &table->cls) {
4164 flow_stats_ds(rule, results);
4169 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4170 * '*engine_type' and '*engine_id', respectively. */
4172 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4173 uint8_t *engine_type, uint8_t *engine_id)
4175 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4178 /* Checks the status change of CFM on 'ofport'.
4180 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4182 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4184 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4185 return (ofport && ofproto->ofproto_class->cfm_status_changed
4186 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4190 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4191 * Returns 0 if the port's CFM status was successfully stored into
4192 * '*status'. Returns positive errno if the port did not have CFM
4195 * The caller must provide and own '*status', and must free 'status->rmps'.
4196 * '*status' is indeterminate if the return value is non-zero. */
4198 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4199 struct cfm_status *status)
4201 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4202 return (ofport && ofproto->ofproto_class->get_cfm_status
4203 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4208 handle_aggregate_stats_request(struct ofconn *ofconn,
4209 const struct ofp_header *oh)
4210 OVS_EXCLUDED(ofproto_mutex)
4212 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4213 struct ofputil_flow_stats_request request;
4214 struct ofputil_aggregate_stats stats;
4215 bool unknown_packets, unknown_bytes;
4216 struct rule_criteria criteria;
4217 struct rule_collection rules;
4218 struct ofpbuf *reply;
4222 error = ofputil_decode_flow_stats_request(&request, oh);
4227 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4228 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4229 request.out_port, request.out_group);
4231 ovs_mutex_lock(&ofproto_mutex);
4232 error = collect_rules_loose(ofproto, &criteria, &rules);
4233 rule_criteria_destroy(&criteria);
4235 rule_collection_ref(&rules);
4237 ovs_mutex_unlock(&ofproto_mutex);
4243 memset(&stats, 0, sizeof stats);
4244 unknown_packets = unknown_bytes = false;
4245 for (i = 0; i < rules.n; i++) {
4246 struct rule *rule = rules.rules[i];
4247 uint64_t packet_count;
4248 uint64_t byte_count;
4251 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4252 &byte_count, &used);
4254 if (packet_count == UINT64_MAX) {
4255 unknown_packets = true;
4257 stats.packet_count += packet_count;
4260 if (byte_count == UINT64_MAX) {
4261 unknown_bytes = true;
4263 stats.byte_count += byte_count;
4268 if (unknown_packets) {
4269 stats.packet_count = UINT64_MAX;
4271 if (unknown_bytes) {
4272 stats.byte_count = UINT64_MAX;
4275 rule_collection_unref(&rules);
4276 rule_collection_destroy(&rules);
4278 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4279 ofconn_send_reply(ofconn, reply);
4284 struct queue_stats_cbdata {
4285 struct ofport *ofport;
4286 struct ovs_list replies;
4291 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4292 const struct netdev_queue_stats *stats)
4294 struct ofputil_queue_stats oqs;
4296 oqs.port_no = cbdata->ofport->pp.port_no;
4297 oqs.queue_id = queue_id;
4298 oqs.tx_bytes = stats->tx_bytes;
4299 oqs.tx_packets = stats->tx_packets;
4300 oqs.tx_errors = stats->tx_errors;
4301 if (stats->created != LLONG_MIN) {
4302 calc_duration(stats->created, cbdata->now,
4303 &oqs.duration_sec, &oqs.duration_nsec);
4305 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4307 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4311 handle_queue_stats_dump_cb(uint32_t queue_id,
4312 struct netdev_queue_stats *stats,
4315 struct queue_stats_cbdata *cbdata = cbdata_;
4317 put_queue_stats(cbdata, queue_id, stats);
4321 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4322 struct queue_stats_cbdata *cbdata)
4324 cbdata->ofport = port;
4325 if (queue_id == OFPQ_ALL) {
4326 netdev_dump_queue_stats(port->netdev,
4327 handle_queue_stats_dump_cb, cbdata);
4329 struct netdev_queue_stats stats;
4331 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4332 put_queue_stats(cbdata, queue_id, &stats);
4334 return OFPERR_OFPQOFC_BAD_QUEUE;
4341 handle_queue_stats_request(struct ofconn *ofconn,
4342 const struct ofp_header *rq)
4344 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4345 struct queue_stats_cbdata cbdata;
4346 struct ofport *port;
4348 struct ofputil_queue_stats_request oqsr;
4350 COVERAGE_INC(ofproto_queue_req);
4352 ofpmp_init(&cbdata.replies, rq);
4353 cbdata.now = time_msec();
4355 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4360 if (oqsr.port_no == OFPP_ANY) {
4361 error = OFPERR_OFPQOFC_BAD_QUEUE;
4362 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4363 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4368 port = ofproto_get_port(ofproto, oqsr.port_no);
4370 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4371 : OFPERR_OFPQOFC_BAD_PORT);
4374 ofconn_send_replies(ofconn, &cbdata.replies);
4376 ofpbuf_list_delete(&cbdata.replies);
4383 evict_rules_from_table(struct oftable *table)
4384 OVS_REQUIRES(ofproto_mutex)
4386 enum ofperr error = 0;
4387 struct rule_collection rules;
4388 unsigned int count = table->n_flows;
4389 unsigned int max_flows = table->max_flows;
4391 rule_collection_init(&rules);
4393 while (count-- > max_flows) {
4396 if (!choose_rule_to_evict(table, &rule)) {
4397 error = OFPERR_OFPFMFC_TABLE_FULL;
4400 eviction_group_remove_rule(rule);
4401 rule_collection_add(&rules, rule);
4404 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4410 is_conjunction(const struct ofpact *ofpacts, size_t ofpacts_len)
4412 return ofpacts_len > 0 && ofpacts->type == OFPACT_CONJUNCTION;
4416 get_conjunctions(const struct ofputil_flow_mod *fm,
4417 struct cls_conjunction **conjsp, size_t *n_conjsp)
4418 OVS_REQUIRES(ofproto_mutex)
4420 struct cls_conjunction *conjs = NULL;
4423 if (is_conjunction(fm->ofpacts, fm->ofpacts_len)) {
4424 const struct ofpact *ofpact;
4428 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4432 conjs = xzalloc(n_conjs * sizeof *conjs);
4434 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4435 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4436 conjs[i].clause = oc->clause;
4437 conjs[i].n_clauses = oc->n_clauses;
4438 conjs[i].id = oc->id;
4444 *n_conjsp = n_conjs;
4447 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4448 * in which no matching flow already exists in the flow table.
4450 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4451 * success, or an OpenFlow error code on failure.
4453 * On successful return the caller must complete the operation either by
4454 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4457 * The caller retains ownership of 'fm->ofpacts'. */
4459 add_flow_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4460 struct rule **old_rule, struct rule **new_rule)
4461 OVS_REQUIRES(ofproto_mutex)
4463 struct oftable *table;
4467 struct cls_conjunction *conjs;
4471 if (!check_table_id(ofproto, fm->table_id)) {
4472 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4477 if (fm->table_id == 0xff) {
4478 if (ofproto->ofproto_class->rule_choose_table) {
4479 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4485 ovs_assert(table_id < ofproto->n_tables);
4489 } else if (fm->table_id < ofproto->n_tables) {
4490 table_id = fm->table_id;
4492 return OFPERR_OFPBRC_BAD_TABLE_ID;
4495 table = &ofproto->tables[table_id];
4496 if (table->flags & OFTABLE_READONLY
4497 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4498 return OFPERR_OFPBRC_EPERM;
4501 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4502 && !match_has_default_hidden_fields(&fm->match)) {
4503 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4504 "non-default values to hidden fields", ofproto->name);
4505 return OFPERR_OFPBRC_EPERM;
4508 cls_rule_init(&cr, &fm->match, fm->priority, ofproto->tables_version + 1);
4510 /* Check for the existence of an identical rule.
4511 * This will not return rules earlier marked for removal. */
4512 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4515 /* Check for overlap, if requested. */
4516 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4517 && classifier_rule_overlaps(&table->cls, &cr)) {
4518 cls_rule_destroy(&cr);
4519 return OFPERR_OFPFMFC_OVERLAP;
4522 /* If necessary, evict an existing rule to clear out space. */
4523 if (table->n_flows >= table->max_flows) {
4524 if (!choose_rule_to_evict(table, &rule)) {
4525 error = OFPERR_OFPFMFC_TABLE_FULL;
4526 cls_rule_destroy(&cr);
4529 eviction_group_remove_rule(rule);
4530 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4532 fm->delete_reason = OFPRR_EVICTION;
4536 fm->modify_cookie = true;
4539 /* Allocate new rule. */
4540 error = replace_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4546 get_conjunctions(fm, &conjs, &n_conjs);
4547 replace_rule_start(ofproto, rule, *new_rule, conjs, n_conjs);
4553 /* Revert the effects of add_flow_start(). */
4555 add_flow_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4556 struct rule *old_rule, struct rule *new_rule)
4557 OVS_REQUIRES(ofproto_mutex)
4559 if (old_rule && fm->delete_reason == OFPRR_EVICTION) {
4560 /* Revert the eviction. */
4561 eviction_group_add_rule(old_rule);
4564 replace_rule_revert(ofproto, old_rule, new_rule);
4567 /* To be called after version bump. */
4569 add_flow_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4570 const struct flow_mod_requester *req,
4571 struct rule *old_rule, struct rule *new_rule)
4572 OVS_REQUIRES(ofproto_mutex)
4574 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4576 replace_rule_finish(ofproto, fm, req, old_rule, new_rule, &dead_cookies);
4577 learned_cookies_flush(ofproto, &dead_cookies);
4580 ovsrcu_postpone(remove_rule_rcu, old_rule);
4582 if (minimask_get_vid_mask(&new_rule->cr.match.mask) == VLAN_VID_MASK) {
4583 if (ofproto->vlan_bitmap) {
4584 uint16_t vid = miniflow_get_vid(&new_rule->cr.match.flow);
4586 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4587 bitmap_set1(ofproto->vlan_bitmap, vid);
4588 ofproto->vlans_changed = true;
4591 ofproto->vlans_changed = true;
4595 ofmonitor_report(ofproto->connmgr, new_rule, NXFME_ADDED, 0,
4596 req ? req->ofconn : NULL,
4597 req ? req->request->xid : 0, NULL);
4600 send_buffered_packet(req, fm->buffer_id, new_rule);
4603 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4605 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4606 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4607 * structures yet. Takes ownership of 'cr'. */
4609 replace_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4610 struct cls_rule *cr, uint8_t table_id,
4611 struct rule *old_rule, struct rule **new_rule)
4616 /* Allocate new rule. */
4617 rule = ofproto->ofproto_class->rule_alloc();
4619 cls_rule_destroy(cr);
4620 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
4621 return OFPERR_OFPFMFC_UNKNOWN;
4624 /* Initialize base state. */
4625 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4626 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
4627 ovs_refcount_init(&rule->ref_count);
4628 rule->flow_cookie = fm->new_cookie;
4629 rule->created = rule->modified = time_msec();
4631 ovs_mutex_init(&rule->mutex);
4632 ovs_mutex_lock(&rule->mutex);
4633 rule->idle_timeout = fm->idle_timeout;
4634 rule->hard_timeout = fm->hard_timeout;
4635 rule->importance = fm->importance;
4636 rule->removed_reason = OVS_OFPRR_NONE;
4638 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
4639 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4640 *CONST_CAST(const struct rule_actions **, &rule->actions)
4641 = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4642 list_init(&rule->meter_list_node);
4643 rule->eviction_group = NULL;
4644 list_init(&rule->expirable);
4645 rule->monitor_flags = 0;
4646 rule->add_seqno = 0;
4647 rule->modify_seqno = 0;
4649 /* Copy values from old rule for modify semantics. */
4650 if (old_rule && fm->delete_reason != OFPRR_EVICTION) {
4651 /* 'fm' says that */
4652 bool change_cookie = (fm->modify_cookie
4653 && fm->new_cookie != OVS_BE64_MAX
4654 && fm->new_cookie != old_rule->flow_cookie);
4656 ovs_mutex_lock(&old_rule->mutex);
4657 if (fm->command != OFPFC_ADD) {
4658 rule->idle_timeout = old_rule->idle_timeout;
4659 rule->hard_timeout = old_rule->hard_timeout;
4660 rule->importance = old_rule->importance;
4661 rule->flags = old_rule->flags;
4662 rule->created = old_rule->created;
4664 if (!change_cookie) {
4665 rule->flow_cookie = old_rule->flow_cookie;
4667 ovs_mutex_unlock(&old_rule->mutex);
4669 ovs_mutex_unlock(&rule->mutex);
4671 /* Construct rule, initializing derived state. */
4672 error = ofproto->ofproto_class->rule_construct(rule);
4674 ofproto_rule_destroy__(rule);
4678 rule->removed = true; /* Not yet in ofproto data structures. */
4685 replace_rule_start(struct ofproto *ofproto,
4686 struct rule *old_rule, struct rule *new_rule,
4687 struct cls_conjunction *conjs, size_t n_conjs)
4689 struct oftable *table = &ofproto->tables[new_rule->table_id];
4691 /* 'old_rule' may be either an evicted rule or replaced rule. */
4693 /* Mark the old rule for removal in the next version. */
4694 cls_rule_make_invisible_in_version(&old_rule->cr,
4695 ofproto->tables_version + 1);
4699 /* Insert flow to the classifier, so that later flow_mods may relate
4700 * to it. This is reversible, in case later errors require this to
4702 ofproto_rule_insert__(ofproto, new_rule);
4703 /* Make the new rule visible for classifier lookups only from the next
4705 classifier_insert(&table->cls, &new_rule->cr, conjs, n_conjs);
4708 static void replace_rule_revert(struct ofproto *ofproto,
4709 struct rule *old_rule, struct rule *new_rule)
4711 struct oftable *table = &ofproto->tables[new_rule->table_id];
4714 /* Restore the original visibility of the old rule. */
4715 cls_rule_restore_visibility(&old_rule->cr);
4717 /* Restore table's rule count. */
4721 /* Remove the new rule immediately. It was never visible to lookups. */
4722 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4725 ofproto_rule_remove__(ofproto, new_rule);
4726 /* The rule was not inserted to the ofproto provider, so we can
4727 * release it without deleting it from the ofproto provider. */
4728 ofproto_rule_unref(new_rule);
4731 /* Adds the 'new_rule', replacing the 'old_rule'. */
4733 replace_rule_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4734 const struct flow_mod_requester *req,
4735 struct rule *old_rule, struct rule *new_rule,
4736 struct ovs_list *dead_cookies)
4737 OVS_REQUIRES(ofproto_mutex)
4739 bool forward_stats = !(fm->flags & OFPUTIL_FF_RESET_COUNTS);
4740 struct rule *replaced_rule;
4742 replaced_rule = fm->delete_reason != OFPRR_EVICTION ? old_rule : NULL;
4744 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4745 * is a duplicate rule the 'new_rule' is replacing. The provider should
4746 * link the stats from the old rule to the new one if 'forward_stats' is
4747 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4748 ofproto->ofproto_class->rule_insert(new_rule, replaced_rule,
4750 learned_cookies_inc(ofproto, rule_get_actions(new_rule));
4753 const struct rule_actions *old_actions = rule_get_actions(old_rule);
4755 /* Remove the old rule from data structures. Removal from the
4756 * classifier and the deletion of the rule is RCU postponed by the
4758 ofproto_rule_remove__(ofproto, old_rule);
4759 learned_cookies_dec(ofproto, old_actions, dead_cookies);
4761 if (replaced_rule) {
4762 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4763 ? NXFME_ADDED : NXFME_MODIFIED;
4765 bool change_cookie = (fm->modify_cookie
4766 && fm->new_cookie != OVS_BE64_MAX
4767 && fm->new_cookie != old_rule->flow_cookie);
4769 bool change_actions = !ofpacts_equal(fm->ofpacts,
4771 old_actions->ofpacts,
4772 old_actions->ofpacts_len);
4774 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4775 ofmonitor_report(ofproto->connmgr, new_rule, event, 0,
4776 req ? req->ofconn : NULL,
4777 req ? req->request->xid : 0,
4778 change_actions ? old_actions : NULL);
4781 /* XXX: This is slight duplication with delete_flows_finish__() */
4783 old_rule->removed_reason = OFPRR_EVICTION;
4785 ofmonitor_report(ofproto->connmgr, old_rule, NXFME_DELETED,
4787 req ? req->ofconn : NULL,
4788 req ? req->request->xid : 0, NULL);
4794 modify_flows_start__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4795 struct rule_collection *old_rules,
4796 struct rule_collection *new_rules)
4797 OVS_REQUIRES(ofproto_mutex)
4801 rule_collection_init(new_rules);
4803 if (old_rules->n > 0) {
4804 struct cls_conjunction *conjs;
4808 /* Create a new 'modified' rule for each old rule. */
4809 for (i = 0; i < old_rules->n; i++) {
4810 struct rule *old_rule = old_rules->rules[i];
4811 struct rule *new_rule;
4814 cls_rule_clone_in_version(&cr, &old_rule->cr,
4815 ofproto->tables_version + 1);
4816 error = replace_rule_create(ofproto, fm, &cr, old_rule->table_id,
4817 old_rule, &new_rule);
4819 rule_collection_add(new_rules, new_rule);
4821 rule_collection_unref(new_rules);
4822 rule_collection_destroy(new_rules);
4826 ovs_assert(new_rules->n == old_rules->n);
4828 get_conjunctions(fm, &conjs, &n_conjs);
4829 for (i = 0; i < old_rules->n; i++) {
4830 replace_rule_start(ofproto, old_rules->rules[i],
4831 new_rules->rules[i], conjs, n_conjs);
4834 } else if (!(fm->cookie_mask != htonll(0)
4835 || fm->new_cookie == OVS_BE64_MAX)) {
4836 /* No match, add a new flow. */
4837 error = add_flow_start(ofproto, fm, &old_rules->rules[0],
4838 &new_rules->rules[0]);
4840 ovs_assert(fm->delete_reason == OFPRR_EVICTION
4841 || !old_rules->rules[0]);
4851 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4854 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4857 modify_flows_start_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4858 struct rule_collection *old_rules,
4859 struct rule_collection *new_rules)
4860 OVS_REQUIRES(ofproto_mutex)
4862 struct rule_criteria criteria;
4865 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4866 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4867 rule_criteria_require_rw(&criteria,
4868 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4869 error = collect_rules_loose(ofproto, &criteria, old_rules);
4870 rule_criteria_destroy(&criteria);
4873 error = modify_flows_start__(ofproto, fm, old_rules, new_rules);
4877 rule_collection_destroy(old_rules);
4883 modify_flows_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4884 struct rule_collection *old_rules,
4885 struct rule_collection *new_rules)
4886 OVS_REQUIRES(ofproto_mutex)
4888 /* Old rules were not changed yet, only need to revert new rules. */
4889 if (old_rules->n == 0 && new_rules->n == 1) {
4890 add_flow_revert(ofproto, fm, old_rules->rules[0], new_rules->rules[0]);
4891 } else if (old_rules->n > 0) {
4892 for (size_t i = 0; i < old_rules->n; i++) {
4893 replace_rule_revert(ofproto, old_rules->rules[i],
4894 new_rules->rules[i]);
4896 rule_collection_destroy(new_rules);
4897 rule_collection_destroy(old_rules);
4902 modify_flows_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4903 const struct flow_mod_requester *req,
4904 struct rule_collection *old_rules,
4905 struct rule_collection *new_rules)
4906 OVS_REQUIRES(ofproto_mutex)
4908 if (old_rules->n == 0 && new_rules->n == 1) {
4909 add_flow_finish(ofproto, fm, req, old_rules->rules[0],
4910 new_rules->rules[0]);
4911 } else if (old_rules->n > 0) {
4912 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4914 ovs_assert(new_rules->n == old_rules->n);
4916 for (size_t i = 0; i < old_rules->n; i++) {
4917 replace_rule_finish(ofproto, fm, req, old_rules->rules[i],
4918 new_rules->rules[i], &dead_cookies);
4920 learned_cookies_flush(ofproto, &dead_cookies);
4921 rule_collection_remove_postponed(old_rules);
4923 send_buffered_packet(req, fm->buffer_id, new_rules->rules[0]);
4924 rule_collection_destroy(new_rules);
4928 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4929 * code on failure. */
4931 modify_flow_start_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4932 struct rule_collection *old_rules,
4933 struct rule_collection *new_rules)
4934 OVS_REQUIRES(ofproto_mutex)
4936 struct rule_criteria criteria;
4939 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4940 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
4942 rule_criteria_require_rw(&criteria,
4943 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4944 error = collect_rules_strict(ofproto, &criteria, old_rules);
4945 rule_criteria_destroy(&criteria);
4948 /* collect_rules_strict() can return max 1 rule. */
4949 error = modify_flows_start__(ofproto, fm, old_rules, new_rules);
4953 rule_collection_destroy(old_rules);
4958 /* OFPFC_DELETE implementation. */
4961 delete_flows_start__(struct ofproto *ofproto,
4962 const struct rule_collection *rules)
4963 OVS_REQUIRES(ofproto_mutex)
4965 for (size_t i = 0; i < rules->n; i++) {
4966 struct rule *rule = rules->rules[i];
4967 struct oftable *table = &ofproto->tables[rule->table_id];
4970 cls_rule_make_invisible_in_version(&rule->cr,
4971 ofproto->tables_version + 1);
4976 delete_flows_finish__(struct ofproto *ofproto,
4977 struct rule_collection *rules,
4978 enum ofp_flow_removed_reason reason,
4979 const struct flow_mod_requester *req)
4980 OVS_REQUIRES(ofproto_mutex)
4983 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4985 for (size_t i = 0; i < rules->n; i++) {
4986 struct rule *rule = rules->rules[i];
4988 /* This value will be used to send the flow removed message right
4989 * before the rule is actually destroyed. */
4990 rule->removed_reason = reason;
4992 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4993 req ? req->ofconn : NULL,
4994 req ? req->request->xid : 0, NULL);
4995 ofproto_rule_remove__(ofproto, rule);
4996 learned_cookies_dec(ofproto, rule_get_actions(rule),
4999 rule_collection_remove_postponed(rules);
5001 learned_cookies_flush(ofproto, &dead_cookies);
5005 /* Deletes the rules listed in 'rules'.
5006 * The deleted rules will become invisible to the lookups in the next version.
5007 * Destroys 'rules'. */
5009 delete_flows__(struct rule_collection *rules,
5010 enum ofp_flow_removed_reason reason,
5011 const struct flow_mod_requester *req)
5012 OVS_REQUIRES(ofproto_mutex)
5015 struct ofproto *ofproto = rules->rules[0]->ofproto;
5017 delete_flows_start__(ofproto, rules);
5018 ofproto_bump_tables_version(ofproto);
5019 delete_flows_finish__(ofproto, rules, reason, req);
5020 ofmonitor_flush(ofproto->connmgr);
5024 /* Implements OFPFC_DELETE. */
5026 delete_flows_start_loose(struct ofproto *ofproto,
5027 const struct ofputil_flow_mod *fm,
5028 struct rule_collection *rules)
5029 OVS_REQUIRES(ofproto_mutex)
5031 struct rule_criteria criteria;
5034 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
5035 fm->cookie, fm->cookie_mask, fm->out_port,
5037 rule_criteria_require_rw(&criteria,
5038 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5039 error = collect_rules_loose(ofproto, &criteria, rules);
5040 rule_criteria_destroy(&criteria);
5043 delete_flows_start__(ofproto, rules);
5050 delete_flows_revert(struct ofproto *ofproto,
5051 struct rule_collection *rules)
5052 OVS_REQUIRES(ofproto_mutex)
5054 for (size_t i = 0; i < rules->n; i++) {
5055 struct rule *rule = rules->rules[i];
5056 struct oftable *table = &ofproto->tables[rule->table_id];
5058 /* Restore table's rule count. */
5061 /* Restore the original visibility of the rule. */
5062 cls_rule_restore_visibility(&rule->cr);
5064 rule_collection_destroy(rules);
5068 delete_flows_finish(struct ofproto *ofproto,
5069 const struct ofputil_flow_mod *fm,
5070 const struct flow_mod_requester *req,
5071 struct rule_collection *rules)
5072 OVS_REQUIRES(ofproto_mutex)
5074 delete_flows_finish__(ofproto, rules, fm->delete_reason, req);
5077 /* Implements OFPFC_DELETE_STRICT. */
5079 delete_flow_start_strict(struct ofproto *ofproto,
5080 const struct ofputil_flow_mod *fm,
5081 struct rule_collection *rules)
5082 OVS_REQUIRES(ofproto_mutex)
5084 struct rule_criteria criteria;
5087 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5088 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
5089 fm->out_port, fm->out_group);
5090 rule_criteria_require_rw(&criteria,
5091 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5092 error = collect_rules_strict(ofproto, &criteria, rules);
5093 rule_criteria_destroy(&criteria);
5096 delete_flows_start__(ofproto, rules);
5102 /* This may only be called by rule_destroy_cb()! */
5104 ofproto_rule_send_removed(struct rule *rule)
5105 OVS_EXCLUDED(ofproto_mutex)
5107 struct ofputil_flow_removed fr;
5110 minimatch_expand(&rule->cr.match, &fr.match);
5111 fr.priority = rule->cr.priority;
5113 ovs_mutex_lock(&ofproto_mutex);
5114 fr.cookie = rule->flow_cookie;
5115 fr.reason = rule->removed_reason;
5116 fr.table_id = rule->table_id;
5117 calc_duration(rule->created, time_msec(),
5118 &fr.duration_sec, &fr.duration_nsec);
5119 ovs_mutex_lock(&rule->mutex);
5120 fr.idle_timeout = rule->idle_timeout;
5121 fr.hard_timeout = rule->hard_timeout;
5122 ovs_mutex_unlock(&rule->mutex);
5123 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
5124 &fr.byte_count, &used);
5125 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
5126 ovs_mutex_unlock(&ofproto_mutex);
5129 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5130 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5133 * ofproto implementation ->run() functions should use this function to expire
5134 * OpenFlow flows. */
5136 ofproto_rule_expire(struct rule *rule, uint8_t reason)
5137 OVS_REQUIRES(ofproto_mutex)
5139 struct rule_collection rules;
5141 rules.rules = rules.stub;
5143 rules.stub[0] = rule;
5144 delete_flows__(&rules, reason, NULL);
5147 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5148 * means "infinite". */
5150 reduce_timeout(uint16_t max, uint16_t *timeout)
5152 if (max && (!*timeout || *timeout > max)) {
5157 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5158 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5159 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5161 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5163 ofproto_rule_reduce_timeouts(struct rule *rule,
5164 uint16_t idle_timeout, uint16_t hard_timeout)
5165 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5167 if (!idle_timeout && !hard_timeout) {
5171 ovs_mutex_lock(&ofproto_mutex);
5172 if (list_is_empty(&rule->expirable)) {
5173 list_insert(&rule->ofproto->expirable, &rule->expirable);
5175 ovs_mutex_unlock(&ofproto_mutex);
5177 ovs_mutex_lock(&rule->mutex);
5178 reduce_timeout(idle_timeout, &rule->idle_timeout);
5179 reduce_timeout(hard_timeout, &rule->hard_timeout);
5180 ovs_mutex_unlock(&rule->mutex);
5184 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5185 OVS_EXCLUDED(ofproto_mutex)
5187 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5188 struct ofputil_flow_mod fm;
5189 uint64_t ofpacts_stub[1024 / 8];
5190 struct ofpbuf ofpacts;
5193 error = reject_slave_controller(ofconn);
5198 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5199 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
5201 u16_to_ofp(ofproto->max_ports),
5204 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
5207 struct flow_mod_requester req;
5209 req.ofconn = ofconn;
5211 error = handle_flow_mod__(ofproto, &fm, &req);
5214 goto exit_free_ofpacts;
5217 ofconn_report_flow_mod(ofconn, fm.command);
5220 ofpbuf_uninit(&ofpacts);
5226 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
5227 const struct flow_mod_requester *req)
5228 OVS_EXCLUDED(ofproto_mutex)
5230 struct ofp_bundle_entry be;
5233 ovs_mutex_lock(&ofproto_mutex);
5234 error = do_bundle_flow_mod_start(ofproto, fm, &be);
5236 ofproto_bump_tables_version(ofproto);
5237 do_bundle_flow_mod_finish(ofproto, fm, req, &be);
5239 ofmonitor_flush(ofproto->connmgr);
5240 ovs_mutex_unlock(&ofproto_mutex);
5242 run_rule_executes(ofproto);
5247 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5249 struct ofputil_role_request request;
5250 struct ofputil_role_request reply;
5254 error = ofputil_decode_role_message(oh, &request);
5259 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5260 if (request.have_generation_id
5261 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5262 return OFPERR_OFPRRFC_STALE;
5265 ofconn_set_role(ofconn, request.role);
5268 reply.role = ofconn_get_role(ofconn);
5269 reply.have_generation_id = ofconn_get_master_election_id(
5270 ofconn, &reply.generation_id);
5271 buf = ofputil_encode_role_reply(oh, &reply);
5272 ofconn_send_reply(ofconn, buf);
5278 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5279 const struct ofp_header *oh)
5281 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5282 enum ofputil_protocol cur, next;
5284 cur = ofconn_get_protocol(ofconn);
5285 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5286 ofconn_set_protocol(ofconn, next);
5292 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5294 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5295 enum ofputil_protocol cur, next;
5296 enum ofputil_protocol next_base;
5298 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5300 return OFPERR_OFPBRC_EPERM;
5303 cur = ofconn_get_protocol(ofconn);
5304 next = ofputil_protocol_set_base(cur, next_base);
5305 ofconn_set_protocol(ofconn, next);
5311 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5312 const struct ofp_header *oh)
5314 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5317 format = ntohl(msg->format);
5318 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5319 return OFPERR_OFPBRC_EPERM;
5322 ofconn_set_packet_in_format(ofconn, format);
5327 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5329 const struct nx_async_config *msg = ofpmsg_body(oh);
5330 uint32_t master[OAM_N_TYPES];
5331 uint32_t slave[OAM_N_TYPES];
5333 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5334 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5335 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5337 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5338 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5339 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5341 ofconn_set_async_config(ofconn, master, slave);
5342 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5343 !ofconn_get_miss_send_len(ofconn)) {
5344 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5351 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5354 uint32_t master[OAM_N_TYPES];
5355 uint32_t slave[OAM_N_TYPES];
5356 struct nx_async_config *msg;
5358 ofconn_get_async_config(ofconn, master, slave);
5359 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5360 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5362 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5363 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5364 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5366 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5367 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5368 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5370 ofconn_send_reply(ofconn, buf);
5376 handle_nxt_set_controller_id(struct ofconn *ofconn,
5377 const struct ofp_header *oh)
5379 const struct nx_controller_id *nci = ofpmsg_body(oh);
5381 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5382 return OFPERR_NXBRC_MUST_BE_ZERO;
5385 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5390 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5394 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5395 ? OFPRAW_OFPT10_BARRIER_REPLY
5396 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5397 ofconn_send_reply(ofconn, buf);
5402 ofproto_compose_flow_refresh_update(const struct rule *rule,
5403 enum nx_flow_monitor_flags flags,
5404 struct ovs_list *msgs)
5405 OVS_REQUIRES(ofproto_mutex)
5407 const struct rule_actions *actions;
5408 struct ofputil_flow_update fu;
5411 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5412 ? NXFME_ADDED : NXFME_MODIFIED);
5414 ovs_mutex_lock(&rule->mutex);
5415 fu.idle_timeout = rule->idle_timeout;
5416 fu.hard_timeout = rule->hard_timeout;
5417 ovs_mutex_unlock(&rule->mutex);
5418 fu.table_id = rule->table_id;
5419 fu.cookie = rule->flow_cookie;
5420 minimatch_expand(&rule->cr.match, &match);
5422 fu.priority = rule->cr.priority;
5424 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5425 fu.ofpacts = actions ? actions->ofpacts : NULL;
5426 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5428 if (list_is_empty(msgs)) {
5429 ofputil_start_flow_update(msgs);
5431 ofputil_append_flow_update(&fu, msgs);
5435 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5436 struct ovs_list *msgs)
5437 OVS_REQUIRES(ofproto_mutex)
5441 for (i = 0; i < rules->n; i++) {
5442 struct rule *rule = rules->rules[i];
5443 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5444 rule->monitor_flags = 0;
5446 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5451 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5452 struct rule *rule, uint64_t seqno,
5453 struct rule_collection *rules)
5454 OVS_REQUIRES(ofproto_mutex)
5456 enum nx_flow_monitor_flags update;
5458 if (rule_is_hidden(rule)) {
5462 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5467 if (rule->add_seqno > seqno) {
5468 update = NXFMF_ADD | NXFMF_MODIFY;
5469 } else if (rule->modify_seqno > seqno) {
5470 update = NXFMF_MODIFY;
5475 if (!(m->flags & update)) {
5479 update = NXFMF_INITIAL;
5482 if (!rule->monitor_flags) {
5483 rule_collection_add(rules, rule);
5485 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5489 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5491 struct rule_collection *rules)
5492 OVS_REQUIRES(ofproto_mutex)
5494 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5495 const struct oftable *table;
5496 struct cls_rule target;
5498 cls_rule_init_from_minimatch(&target, &m->match, 0, CLS_MAX_VERSION);
5499 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5502 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5503 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5506 cls_rule_destroy(&target);
5510 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5511 struct rule_collection *rules)
5512 OVS_REQUIRES(ofproto_mutex)
5514 if (m->flags & NXFMF_INITIAL) {
5515 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5520 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5521 uint64_t seqno, struct rule_collection *rules)
5522 OVS_REQUIRES(ofproto_mutex)
5524 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5528 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5529 OVS_REQUIRES(ofproto_mutex)
5531 struct ofmonitor *m;
5534 m = ofmonitor_lookup(ofconn, id);
5536 ofmonitor_destroy(m);
5539 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5546 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5547 OVS_EXCLUDED(ofproto_mutex)
5549 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5550 struct ofmonitor **monitors;
5551 size_t n_monitors, allocated_monitors;
5552 struct rule_collection rules;
5553 struct ovs_list replies;
5558 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5560 n_monitors = allocated_monitors = 0;
5562 ovs_mutex_lock(&ofproto_mutex);
5564 struct ofputil_flow_monitor_request request;
5565 struct ofmonitor *m;
5568 retval = ofputil_decode_flow_monitor_request(&request, &b);
5569 if (retval == EOF) {
5571 } else if (retval) {
5576 if (request.table_id != 0xff
5577 && request.table_id >= ofproto->n_tables) {
5578 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5582 error = ofmonitor_create(&request, ofconn, &m);
5587 if (n_monitors >= allocated_monitors) {
5588 monitors = x2nrealloc(monitors, &allocated_monitors,
5591 monitors[n_monitors++] = m;
5594 rule_collection_init(&rules);
5595 for (i = 0; i < n_monitors; i++) {
5596 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5599 ofpmp_init(&replies, oh);
5600 ofmonitor_compose_refresh_updates(&rules, &replies);
5601 ovs_mutex_unlock(&ofproto_mutex);
5603 rule_collection_destroy(&rules);
5605 ofconn_send_replies(ofconn, &replies);
5611 for (i = 0; i < n_monitors; i++) {
5612 ofmonitor_destroy(monitors[i]);
5615 ovs_mutex_unlock(&ofproto_mutex);
5621 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5622 OVS_EXCLUDED(ofproto_mutex)
5627 id = ofputil_decode_flow_monitor_cancel(oh);
5629 ovs_mutex_lock(&ofproto_mutex);
5630 error = flow_monitor_delete(ofconn, id);
5631 ovs_mutex_unlock(&ofproto_mutex);
5636 /* Meters implementation.
5638 * Meter table entry, indexed by the OpenFlow meter_id.
5639 * 'created' is used to compute the duration for meter stats.
5640 * 'list rules' is needed so that we can delete the dependent rules when the
5641 * meter table entry is deleted.
5642 * 'provider_meter_id' is for the provider's private use.
5645 long long int created; /* Time created. */
5646 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5647 ofproto_meter_id provider_meter_id;
5648 uint16_t flags; /* Meter flags. */
5649 uint16_t n_bands; /* Number of meter bands. */
5650 struct ofputil_meter_band *bands;
5654 * This is used in instruction validation at flow set-up time,
5655 * as flows may not use non-existing meters.
5656 * Return value of UINT32_MAX signifies an invalid meter.
5659 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5661 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5662 const struct meter *meter = ofproto->meters[of_meter_id];
5664 return meter->provider_meter_id.uint32;
5670 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5673 meter_insert_rule(struct rule *rule)
5675 const struct rule_actions *a = rule_get_actions(rule);
5676 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5677 struct meter *meter = rule->ofproto->meters[meter_id];
5679 list_insert(&meter->rules, &rule->meter_list_node);
5683 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5687 meter->flags = config->flags;
5688 meter->n_bands = config->n_bands;
5689 meter->bands = xmemdup(config->bands,
5690 config->n_bands * sizeof *meter->bands);
5693 static struct meter *
5694 meter_create(const struct ofputil_meter_config *config,
5695 ofproto_meter_id provider_meter_id)
5697 struct meter *meter;
5699 meter = xzalloc(sizeof *meter);
5700 meter->provider_meter_id = provider_meter_id;
5701 meter->created = time_msec();
5702 list_init(&meter->rules);
5704 meter_update(meter, config);
5710 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5711 OVS_REQUIRES(ofproto_mutex)
5714 for (mid = first; mid <= last; ++mid) {
5715 struct meter *meter = ofproto->meters[mid];
5717 ofproto->meters[mid] = NULL;
5718 ofproto->ofproto_class->meter_del(ofproto,
5719 meter->provider_meter_id);
5727 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5729 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5730 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5734 return OFPERR_OFPMMFC_METER_EXISTS;
5737 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5740 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5741 *meterp = meter_create(&mm->meter, provider_meter_id);
5747 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5749 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5751 uint32_t provider_meter_id;
5754 return OFPERR_OFPMMFC_UNKNOWN_METER;
5757 provider_meter_id = meter->provider_meter_id.uint32;
5758 error = ofproto->ofproto_class->meter_set(ofproto,
5759 &meter->provider_meter_id,
5761 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5763 meter_update(meter, &mm->meter);
5769 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5770 OVS_EXCLUDED(ofproto_mutex)
5772 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5773 uint32_t meter_id = mm->meter.meter_id;
5774 struct rule_collection rules;
5775 enum ofperr error = 0;
5776 uint32_t first, last;
5778 if (meter_id == OFPM13_ALL) {
5780 last = ofproto->meter_features.max_meters;
5782 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5785 first = last = meter_id;
5788 /* First delete the rules that use this meter. If any of those rules are
5789 * currently being modified, postpone the whole operation until later. */
5790 rule_collection_init(&rules);
5791 ovs_mutex_lock(&ofproto_mutex);
5792 for (meter_id = first; meter_id <= last; ++meter_id) {
5793 struct meter *meter = ofproto->meters[meter_id];
5794 if (meter && !list_is_empty(&meter->rules)) {
5797 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5798 rule_collection_add(&rules, rule);
5802 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5804 /* Delete the meters. */
5805 meter_delete(ofproto, first, last);
5807 ovs_mutex_unlock(&ofproto_mutex);
5813 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5815 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5816 struct ofputil_meter_mod mm;
5817 uint64_t bands_stub[256 / 8];
5818 struct ofpbuf bands;
5822 error = reject_slave_controller(ofconn);
5827 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5829 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5831 goto exit_free_bands;
5834 meter_id = mm.meter.meter_id;
5836 if (mm.command != OFPMC13_DELETE) {
5837 /* Fails also when meters are not implemented by the provider. */
5838 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5839 error = OFPERR_OFPMMFC_INVALID_METER;
5840 goto exit_free_bands;
5841 } else if (meter_id > ofproto->meter_features.max_meters) {
5842 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5843 goto exit_free_bands;
5845 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5846 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5847 goto exit_free_bands;
5851 switch (mm.command) {
5853 error = handle_add_meter(ofproto, &mm);
5856 case OFPMC13_MODIFY:
5857 error = handle_modify_meter(ofproto, &mm);
5860 case OFPMC13_DELETE:
5861 error = handle_delete_meter(ofconn, &mm);
5865 error = OFPERR_OFPMMFC_BAD_COMMAND;
5870 ofpbuf_uninit(&bands);
5875 handle_meter_features_request(struct ofconn *ofconn,
5876 const struct ofp_header *request)
5878 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5879 struct ofputil_meter_features features;
5882 if (ofproto->ofproto_class->meter_get_features) {
5883 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5885 memset(&features, 0, sizeof features);
5887 b = ofputil_encode_meter_features_reply(&features, request);
5889 ofconn_send_reply(ofconn, b);
5894 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5897 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5898 struct ovs_list replies;
5899 uint64_t bands_stub[256 / 8];
5900 struct ofpbuf bands;
5901 uint32_t meter_id, first, last;
5903 ofputil_decode_meter_request(request, &meter_id);
5905 if (meter_id == OFPM13_ALL) {
5907 last = ofproto->meter_features.max_meters;
5909 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5910 !ofproto->meters[meter_id]) {
5911 return OFPERR_OFPMMFC_UNKNOWN_METER;
5913 first = last = meter_id;
5916 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5917 ofpmp_init(&replies, request);
5919 for (meter_id = first; meter_id <= last; ++meter_id) {
5920 struct meter *meter = ofproto->meters[meter_id];
5922 continue; /* Skip non-existing meters. */
5924 if (type == OFPTYPE_METER_STATS_REQUEST) {
5925 struct ofputil_meter_stats stats;
5927 stats.meter_id = meter_id;
5929 /* Provider sets the packet and byte counts, we do the rest. */
5930 stats.flow_count = list_size(&meter->rules);
5931 calc_duration(meter->created, time_msec(),
5932 &stats.duration_sec, &stats.duration_nsec);
5933 stats.n_bands = meter->n_bands;
5934 ofpbuf_clear(&bands);
5936 = ofpbuf_put_uninit(&bands,
5937 meter->n_bands * sizeof *stats.bands);
5939 if (!ofproto->ofproto_class->meter_get(ofproto,
5940 meter->provider_meter_id,
5942 ofputil_append_meter_stats(&replies, &stats);
5944 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5945 struct ofputil_meter_config config;
5947 config.meter_id = meter_id;
5948 config.flags = meter->flags;
5949 config.n_bands = meter->n_bands;
5950 config.bands = meter->bands;
5951 ofputil_append_meter_config(&replies, &config);
5955 ofconn_send_replies(ofconn, &replies);
5956 ofpbuf_uninit(&bands);
5961 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5962 struct ofgroup **group)
5963 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5965 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5966 hash_int(group_id, 0), &ofproto->groups) {
5967 if ((*group)->group_id == group_id) {
5975 /* If the group exists, this function increments the groups's reference count.
5977 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5978 * a reference to the group. */
5980 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5981 struct ofgroup **group)
5985 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5986 found = ofproto_group_lookup__(ofproto, group_id, group);
5988 ofproto_group_ref(*group);
5990 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5995 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5996 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5998 struct ofgroup *grp;
6000 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
6001 hash_int(group_id, 0), &ofproto->groups) {
6002 if (grp->group_id == group_id) {
6010 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
6011 OVS_EXCLUDED(ofproto->groups_rwlock)
6015 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6016 exists = ofproto_group_exists__(ofproto, group_id);
6017 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6023 group_get_ref_count(struct ofgroup *group)
6024 OVS_EXCLUDED(ofproto_mutex)
6026 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
6027 struct rule_criteria criteria;
6028 struct rule_collection rules;
6033 match_init_catchall(&match);
6034 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
6035 htonll(0), OFPP_ANY, group->group_id);
6036 ovs_mutex_lock(&ofproto_mutex);
6037 error = collect_rules_loose(ofproto, &criteria, &rules);
6038 ovs_mutex_unlock(&ofproto_mutex);
6039 rule_criteria_destroy(&criteria);
6041 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
6043 rule_collection_destroy(&rules);
6048 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
6050 struct ofputil_group_stats ogs;
6051 const struct ofproto *ofproto = group->ofproto;
6052 long long int now = time_msec();
6055 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
6057 /* Provider sets the packet and byte counts, we do the rest. */
6058 ogs.ref_count = group_get_ref_count(group);
6059 ogs.n_buckets = group->n_buckets;
6061 error = (ofproto->ofproto_class->group_get_stats
6062 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
6065 ogs.packet_count = UINT64_MAX;
6066 ogs.byte_count = UINT64_MAX;
6067 memset(ogs.bucket_stats, 0xff,
6068 ogs.n_buckets * sizeof *ogs.bucket_stats);
6071 ogs.group_id = group->group_id;
6072 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
6074 ofputil_append_group_stats(replies, &ogs);
6076 free(ogs.bucket_stats);
6080 handle_group_request(struct ofconn *ofconn,
6081 const struct ofp_header *request, uint32_t group_id,
6082 void (*cb)(struct ofgroup *, struct ovs_list *replies))
6084 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6085 struct ofgroup *group;
6086 struct ovs_list replies;
6088 ofpmp_init(&replies, request);
6089 if (group_id == OFPG_ALL) {
6090 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6091 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
6092 cb(group, &replies);
6094 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6096 if (ofproto_group_lookup(ofproto, group_id, &group)) {
6097 cb(group, &replies);
6098 ofproto_group_unref(group);
6101 ofconn_send_replies(ofconn, &replies);
6105 handle_group_stats_request(struct ofconn *ofconn,
6106 const struct ofp_header *request)
6111 error = ofputil_decode_group_stats_request(request, &group_id);
6116 handle_group_request(ofconn, request, group_id, append_group_stats);
6121 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
6123 struct ofputil_group_desc gds;
6125 gds.group_id = group->group_id;
6126 gds.type = group->type;
6127 gds.props = group->props;
6129 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
6133 handle_group_desc_stats_request(struct ofconn *ofconn,
6134 const struct ofp_header *request)
6136 handle_group_request(ofconn, request,
6137 ofputil_decode_group_desc_request(request),
6143 handle_group_features_stats_request(struct ofconn *ofconn,
6144 const struct ofp_header *request)
6146 struct ofproto *p = ofconn_get_ofproto(ofconn);
6149 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6151 ofconn_send_reply(ofconn, msg);
6158 handle_queue_get_config_request(struct ofconn *ofconn,
6159 const struct ofp_header *oh)
6161 struct ofproto *p = ofconn_get_ofproto(ofconn);
6162 struct netdev_queue_dump queue_dump;
6163 struct ofport *ofport;
6164 unsigned int queue_id;
6165 struct ofpbuf *reply;
6166 struct smap details;
6170 error = ofputil_decode_queue_get_config_request(oh, &request);
6175 ofport = ofproto_get_port(p, request);
6177 return OFPERR_OFPQOFC_BAD_PORT;
6180 reply = ofputil_encode_queue_get_config_reply(oh);
6182 smap_init(&details);
6183 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6184 struct ofputil_queue_config queue;
6186 /* None of the existing queues have compatible properties, so we
6187 * hard-code omitting min_rate and max_rate. */
6188 queue.queue_id = queue_id;
6189 queue.min_rate = UINT16_MAX;
6190 queue.max_rate = UINT16_MAX;
6191 ofputil_append_queue_get_config_reply(reply, &queue);
6193 smap_destroy(&details);
6195 ofconn_send_reply(ofconn, reply);
6201 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6202 struct ofgroup **ofgroup)
6205 const long long int now = time_msec();
6207 if (gm->group_id > OFPG_MAX) {
6208 return OFPERR_OFPGMFC_INVALID_GROUP;
6210 if (gm->type > OFPGT11_FF) {
6211 return OFPERR_OFPGMFC_BAD_TYPE;
6214 *ofgroup = ofproto->ofproto_class->group_alloc();
6216 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6217 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6220 (*ofgroup)->ofproto = ofproto;
6221 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6222 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6223 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6224 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6225 ovs_refcount_init(&(*ofgroup)->ref_count);
6227 list_move(&(*ofgroup)->buckets, &gm->buckets);
6228 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6229 list_size(&(*ofgroup)->buckets);
6231 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6232 &gm->props, sizeof (struct ofputil_group_props));
6234 /* Construct called BEFORE any locks are held. */
6235 error = ofproto->ofproto_class->group_construct(*ofgroup);
6237 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6238 ofproto->ofproto_class->group_dealloc(*ofgroup);
6243 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6244 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6247 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6249 struct ofgroup *ofgroup;
6252 /* Allocate new group and initialize it. */
6253 error = init_group(ofproto, gm, &ofgroup);
6258 /* We wrlock as late as possible to minimize the time we jam any other
6259 * threads: No visible state changes before acquiring the lock. */
6260 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6262 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6263 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6267 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6268 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6273 /* Insert new group. */
6274 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6275 hash_int(ofgroup->group_id, 0));
6276 ofproto->n_groups[ofgroup->type]++;
6278 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6283 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6284 ofproto->ofproto_class->group_destruct(ofgroup);
6285 ofputil_bucket_list_destroy(&ofgroup->buckets);
6286 ofproto->ofproto_class->group_dealloc(ofgroup);
6291 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6292 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6293 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6294 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6297 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6298 struct ofgroup *new_ofgroup,
6299 uint32_t command_bucket_id)
6301 struct ofputil_bucket *last = NULL;
6303 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6304 /* Check here to ensure that a bucket corresponding to
6305 * command_bucket_id exists in the old bucket list.
6307 * The subsequent search of below of new_ofgroup covers
6308 * both buckets in the old bucket list and buckets added
6309 * by the insert buckets group mod message this function processes. */
6310 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6311 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6314 if (!list_is_empty(&new_ofgroup->buckets)) {
6315 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6319 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6321 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6322 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6323 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6326 /* Rearrange list according to command_bucket_id */
6327 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6328 struct ofputil_bucket *new_first;
6329 const struct ofputil_bucket *first;
6331 first = ofputil_bucket_list_front(&ofgroup->buckets);
6332 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6335 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6336 &new_ofgroup->buckets);
6337 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6338 struct ofputil_bucket *after;
6340 /* Presence of bucket is checked above so after should never be NULL */
6341 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6343 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6344 last->list_node.next);
6350 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6351 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6352 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6353 * and OFPG15_BUCKET_ALL are also honored. */
6355 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6356 struct ofgroup *new_ofgroup,
6357 uint32_t command_bucket_id)
6359 const struct ofputil_bucket *skip = NULL;
6361 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6365 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6366 if (!list_is_empty(&ofgroup->buckets)) {
6367 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6369 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6370 if (!list_is_empty(&ofgroup->buckets)) {
6371 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6374 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6376 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6380 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6385 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6386 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6389 * Note that the group is re-created and then replaces the old group in
6390 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6391 * the xlate module hold a pointer to the group. */
6393 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6395 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6398 error = init_group(ofproto, gm, &new_ofgroup);
6403 retiring = new_ofgroup;
6405 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6406 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6407 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6411 /* Ofproto's group write lock is held now. */
6412 if (ofgroup->type != gm->type
6413 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6414 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6418 /* Manipulate bucket list for bucket commands */
6419 if (gm->command == OFPGC15_INSERT_BUCKET) {
6420 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6421 gm->command_bucket_id);
6422 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6423 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6424 gm->command_bucket_id);
6430 /* The group creation time does not change during modification. */
6431 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6432 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6434 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6440 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6441 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6442 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6443 hash_int(new_ofgroup->group_id, 0));
6444 if (ofgroup->type != new_ofgroup->type) {
6445 ofproto->n_groups[ofgroup->type]--;
6446 ofproto->n_groups[new_ofgroup->type]++;
6450 ofproto_group_unref(retiring);
6451 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6456 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6457 OVS_RELEASES(ofproto->groups_rwlock)
6460 struct ofputil_flow_mod fm;
6462 /* Delete all flow entries containing this group in a group action */
6463 match_init_catchall(&match);
6464 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6465 fm.delete_reason = OFPRR_GROUP_DELETE;
6466 fm.out_group = ofgroup->group_id;
6467 handle_flow_mod__(ofproto, &fm, NULL);
6469 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6470 /* No-one can find this group any more. */
6471 ofproto->n_groups[ofgroup->type]--;
6472 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6473 ofproto_group_unref(ofgroup);
6476 /* Implements OFPGC11_DELETE. */
6478 delete_group(struct ofproto *ofproto, uint32_t group_id)
6480 struct ofgroup *ofgroup;
6482 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6483 if (group_id == OFPG_ALL) {
6485 struct hmap_node *node = hmap_first(&ofproto->groups);
6489 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6490 delete_group__(ofproto, ofgroup);
6491 /* Lock for each node separately, so that we will not jam the
6492 * other threads for too long time. */
6493 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6496 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6497 hash_int(group_id, 0), &ofproto->groups) {
6498 if (ofgroup->group_id == group_id) {
6499 delete_group__(ofproto, ofgroup);
6504 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6508 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6510 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6511 struct ofputil_group_mod gm;
6514 error = reject_slave_controller(ofconn);
6519 error = ofputil_decode_group_mod(oh, &gm);
6524 switch (gm.command) {
6526 return add_group(ofproto, &gm);
6528 case OFPGC11_MODIFY:
6529 return modify_group(ofproto, &gm);
6531 case OFPGC11_DELETE:
6532 delete_group(ofproto, gm.group_id);
6535 case OFPGC15_INSERT_BUCKET:
6536 return modify_group(ofproto, &gm);
6538 case OFPGC15_REMOVE_BUCKET:
6539 return modify_group(ofproto, &gm);
6542 if (gm.command > OFPGC11_DELETE) {
6543 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6544 ofproto->name, gm.command);
6546 return OFPERR_OFPGMFC_BAD_COMMAND;
6550 enum ofputil_table_miss
6551 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6553 enum ofputil_table_miss value;
6555 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6560 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6562 if (!check_table_id(ofproto, tm->table_id)) {
6563 return OFPERR_OFPTMFC_BAD_TABLE;
6564 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6565 if (tm->table_id == OFPTT_ALL) {
6567 for (i = 0; i < ofproto->n_tables; i++) {
6568 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6572 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6580 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6582 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6583 struct ofputil_table_mod tm;
6586 error = reject_slave_controller(ofconn);
6591 error = ofputil_decode_table_mod(oh, &tm);
6596 return table_mod(ofproto, &tm);
6600 do_bundle_flow_mod_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6601 struct ofp_bundle_entry *be)
6602 OVS_REQUIRES(ofproto_mutex)
6604 switch (fm->command) {
6606 return add_flow_start(ofproto, fm, &be->old_rules.stub[0],
6607 &be->new_rules.stub[0]);
6609 return modify_flows_start_loose(ofproto, fm, &be->old_rules,
6611 case OFPFC_MODIFY_STRICT:
6612 return modify_flow_start_strict(ofproto, fm, &be->old_rules,
6615 return delete_flows_start_loose(ofproto, fm, &be->old_rules);
6617 case OFPFC_DELETE_STRICT:
6618 return delete_flow_start_strict(ofproto, fm, &be->old_rules);
6621 return OFPERR_OFPFMFC_BAD_COMMAND;
6625 do_bundle_flow_mod_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6626 struct ofp_bundle_entry *be)
6627 OVS_REQUIRES(ofproto_mutex)
6629 switch (fm->command) {
6631 add_flow_revert(ofproto, fm, be->old_rules.stub[0],
6632 be->new_rules.stub[0]);
6636 case OFPFC_MODIFY_STRICT:
6637 modify_flows_revert(ofproto, fm, &be->old_rules, &be->new_rules);
6641 case OFPFC_DELETE_STRICT:
6642 delete_flows_revert(ofproto, &be->old_rules);
6651 do_bundle_flow_mod_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6652 const struct flow_mod_requester *req,
6653 struct ofp_bundle_entry *be)
6654 OVS_REQUIRES(ofproto_mutex)
6656 switch (fm->command) {
6658 add_flow_finish(ofproto, fm, req, be->old_rules.stub[0],
6659 be->new_rules.stub[0]);
6663 case OFPFC_MODIFY_STRICT:
6664 modify_flows_finish(ofproto, fm, req, &be->old_rules, &be->new_rules);
6668 case OFPFC_DELETE_STRICT:
6669 delete_flows_finish(ofproto, fm, req, &be->old_rules);
6677 /* Commit phases (all while locking ofproto_mutex):
6679 * 1. Begin: Gather resources and make changes visible in the next version.
6680 * - Mark affected rules for removal in the next version.
6681 * - Create new replacement rules, make visible in the next
6683 * - Do not send any events or notifications.
6685 * 2. Revert: Fail if any errors are found. After this point no errors are
6686 * possible. No visible changes were made, so rollback is minimal (remove
6687 * added invisible rules, restore visibility of rules marked for removal).
6689 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
6690 * the ofproto provider. Remove replaced and deleted rules from ofproto data
6691 * structures, and Schedule postponed removal of deleted rules from the
6692 * classifier. Send notifications, buffered packets, etc.
6695 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6697 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6698 cls_version_t visible_version = ofproto->tables_version;
6699 struct ofp_bundle *bundle;
6700 struct ofp_bundle_entry *be;
6703 bundle = ofconn_get_bundle(ofconn, id);
6706 return OFPERR_OFPBFC_BAD_ID;
6708 if (bundle->flags != flags) {
6709 error = OFPERR_OFPBFC_BAD_FLAGS;
6711 bool prev_is_port_mod = false;
6714 ovs_mutex_lock(&ofproto_mutex);
6717 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6718 if (be->type == OFPTYPE_PORT_MOD) {
6719 /* Our port mods are not atomic. */
6720 if (flags & OFPBF_ATOMIC) {
6721 error = OFPERR_OFPBFC_MSG_FAILED;
6723 prev_is_port_mod = true;
6724 error = port_mod_start(ofconn, &be->pm, &be->port);
6726 } else if (be->type == OFPTYPE_FLOW_MOD) {
6727 /* Flow mods between port mods are applied as a single
6728 * version, but the versions are published only after
6729 * we know the commit is successful. */
6730 if (prev_is_port_mod) {
6731 ++ofproto->tables_version;
6733 prev_is_port_mod = false;
6734 error = do_bundle_flow_mod_start(ofproto, &be->fm, be);
6741 /* Store the version in which the changes should take
6743 be->version = ofproto->tables_version + 1;
6748 /* Send error referring to the original message. */
6750 ofconn_send_error(ofconn, be->ofp_msg, error);
6751 error = OFPERR_OFPBFC_MSG_FAILED;
6754 /* 2. Revert. Undo all the changes made above. */
6755 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6756 if (be->type == OFPTYPE_FLOW_MOD) {
6757 do_bundle_flow_mod_revert(ofproto, &be->fm, be);
6759 /* Nothing needs to be reverted for a port mod. */
6763 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6764 /* Bump the lookup version to the one of the current message.
6765 * This makes all the changes in the bundle at this version
6766 * visible to lookups at once. */
6767 if (visible_version < be->version) {
6768 visible_version = be->version;
6769 ofproto->ofproto_class->set_tables_version(
6770 ofproto, visible_version);
6772 if (be->type == OFPTYPE_FLOW_MOD) {
6773 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6775 do_bundle_flow_mod_finish(ofproto, &be->fm, &req, be);
6776 } else if (be->type == OFPTYPE_PORT_MOD) {
6777 /* Perform the actual port mod. This is not atomic, i.e.,
6778 * the effects will be immediately seen by upcall
6779 * processing regardless of the lookup version. It should
6780 * be noted that port configuration changes can originate
6781 * also from OVSDB changes asynchronously to all upcall
6783 port_mod_finish(ofconn, &be->pm, be->port);
6788 /* Reset the tables_version. */
6789 ofproto->tables_version = visible_version;
6791 ofmonitor_flush(ofproto->connmgr);
6792 ovs_mutex_unlock(&ofproto_mutex);
6794 run_rule_executes(ofproto);
6797 /* The bundle is discarded regardless the outcome. */
6798 ofp_bundle_remove__(ofconn, bundle, !error);
6803 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6805 struct ofputil_bundle_ctrl_msg bctrl;
6806 struct ofputil_bundle_ctrl_msg reply;
6810 error = reject_slave_controller(ofconn);
6815 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6820 reply.bundle_id = bctrl.bundle_id;
6822 switch (bctrl.type) {
6823 case OFPBCT_OPEN_REQUEST:
6824 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6825 reply.type = OFPBCT_OPEN_REPLY;
6827 case OFPBCT_CLOSE_REQUEST:
6828 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6829 reply.type = OFPBCT_CLOSE_REPLY;;
6831 case OFPBCT_COMMIT_REQUEST:
6832 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6833 reply.type = OFPBCT_COMMIT_REPLY;
6835 case OFPBCT_DISCARD_REQUEST:
6836 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6837 reply.type = OFPBCT_DISCARD_REPLY;
6840 case OFPBCT_OPEN_REPLY:
6841 case OFPBCT_CLOSE_REPLY:
6842 case OFPBCT_COMMIT_REPLY:
6843 case OFPBCT_DISCARD_REPLY:
6844 return OFPERR_OFPBFC_BAD_TYPE;
6849 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6850 ofconn_send_reply(ofconn, buf);
6856 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6858 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6860 struct ofputil_bundle_add_msg badd;
6861 struct ofp_bundle_entry *bmsg;
6864 error = reject_slave_controller(ofconn);
6869 error = ofputil_decode_bundle_add(oh, &badd, &type);
6874 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
6876 if (type == OFPTYPE_PORT_MOD) {
6877 error = ofputil_decode_port_mod(badd.msg, &bmsg->pm, false);
6878 } else if (type == OFPTYPE_FLOW_MOD) {
6879 struct ofpbuf ofpacts;
6880 uint64_t ofpacts_stub[1024 / 8];
6882 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6883 error = ofputil_decode_flow_mod(&bmsg->fm, badd.msg,
6884 ofconn_get_protocol(ofconn),
6886 u16_to_ofp(ofproto->max_ports),
6888 /* Move actions to heap. */
6889 bmsg->fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6891 if (!error && bmsg->fm.ofpacts_len) {
6892 error = ofproto_check_ofpacts(ofproto, bmsg->fm.ofpacts,
6893 bmsg->fm.ofpacts_len);
6900 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
6905 ofp_bundle_entry_free(bmsg);
6912 handle_geneve_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6914 struct ofputil_geneve_table_mod gtm;
6917 error = reject_slave_controller(ofconn);
6922 error = ofputil_decode_geneve_table_mod(oh, >m);
6927 ofputil_uninit_geneve_table(>m.mappings);
6928 return OFPERR_OFPBRC_BAD_TYPE;
6932 handle_geneve_table_request(struct ofconn *ofconn OVS_UNUSED,
6933 const struct ofp_header *oh OVS_UNUSED)
6935 return OFPERR_OFPBRC_BAD_TYPE;
6939 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6940 OVS_EXCLUDED(ofproto_mutex)
6942 const struct ofp_header *oh = msg->data;
6946 error = ofptype_decode(&type, oh);
6950 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6951 && ofpmp_more(oh)) {
6952 /* We have no buffer implementation for multipart requests.
6953 * Report overflow for requests which consists of multiple
6955 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6959 /* OpenFlow requests. */
6960 case OFPTYPE_ECHO_REQUEST:
6961 return handle_echo_request(ofconn, oh);
6963 case OFPTYPE_FEATURES_REQUEST:
6964 return handle_features_request(ofconn, oh);
6966 case OFPTYPE_GET_CONFIG_REQUEST:
6967 return handle_get_config_request(ofconn, oh);
6969 case OFPTYPE_SET_CONFIG:
6970 return handle_set_config(ofconn, oh);
6972 case OFPTYPE_PACKET_OUT:
6973 return handle_packet_out(ofconn, oh);
6975 case OFPTYPE_PORT_MOD:
6976 return handle_port_mod(ofconn, oh);
6978 case OFPTYPE_FLOW_MOD:
6979 return handle_flow_mod(ofconn, oh);
6981 case OFPTYPE_GROUP_MOD:
6982 return handle_group_mod(ofconn, oh);
6984 case OFPTYPE_TABLE_MOD:
6985 return handle_table_mod(ofconn, oh);
6987 case OFPTYPE_METER_MOD:
6988 return handle_meter_mod(ofconn, oh);
6990 case OFPTYPE_BARRIER_REQUEST:
6991 return handle_barrier_request(ofconn, oh);
6993 case OFPTYPE_ROLE_REQUEST:
6994 return handle_role_request(ofconn, oh);
6996 /* OpenFlow replies. */
6997 case OFPTYPE_ECHO_REPLY:
7000 /* Nicira extension requests. */
7001 case OFPTYPE_FLOW_MOD_TABLE_ID:
7002 return handle_nxt_flow_mod_table_id(ofconn, oh);
7004 case OFPTYPE_SET_FLOW_FORMAT:
7005 return handle_nxt_set_flow_format(ofconn, oh);
7007 case OFPTYPE_SET_PACKET_IN_FORMAT:
7008 return handle_nxt_set_packet_in_format(ofconn, oh);
7010 case OFPTYPE_SET_CONTROLLER_ID:
7011 return handle_nxt_set_controller_id(ofconn, oh);
7013 case OFPTYPE_FLOW_AGE:
7014 /* Nothing to do. */
7017 case OFPTYPE_FLOW_MONITOR_CANCEL:
7018 return handle_flow_monitor_cancel(ofconn, oh);
7020 case OFPTYPE_SET_ASYNC_CONFIG:
7021 return handle_nxt_set_async_config(ofconn, oh);
7023 case OFPTYPE_GET_ASYNC_REQUEST:
7024 return handle_nxt_get_async_request(ofconn, oh);
7026 /* Statistics requests. */
7027 case OFPTYPE_DESC_STATS_REQUEST:
7028 return handle_desc_stats_request(ofconn, oh);
7030 case OFPTYPE_FLOW_STATS_REQUEST:
7031 return handle_flow_stats_request(ofconn, oh);
7033 case OFPTYPE_AGGREGATE_STATS_REQUEST:
7034 return handle_aggregate_stats_request(ofconn, oh);
7036 case OFPTYPE_TABLE_STATS_REQUEST:
7037 return handle_table_stats_request(ofconn, oh);
7039 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
7040 return handle_table_features_request(ofconn, oh);
7042 case OFPTYPE_PORT_STATS_REQUEST:
7043 return handle_port_stats_request(ofconn, oh);
7045 case OFPTYPE_QUEUE_STATS_REQUEST:
7046 return handle_queue_stats_request(ofconn, oh);
7048 case OFPTYPE_PORT_DESC_STATS_REQUEST:
7049 return handle_port_desc_stats_request(ofconn, oh);
7051 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
7052 return handle_flow_monitor_request(ofconn, oh);
7054 case OFPTYPE_METER_STATS_REQUEST:
7055 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
7056 return handle_meter_request(ofconn, oh, type);
7058 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
7059 return handle_meter_features_request(ofconn, oh);
7061 case OFPTYPE_GROUP_STATS_REQUEST:
7062 return handle_group_stats_request(ofconn, oh);
7064 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
7065 return handle_group_desc_stats_request(ofconn, oh);
7067 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
7068 return handle_group_features_stats_request(ofconn, oh);
7070 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
7071 return handle_queue_get_config_request(ofconn, oh);
7073 case OFPTYPE_BUNDLE_CONTROL:
7074 return handle_bundle_control(ofconn, oh);
7076 case OFPTYPE_BUNDLE_ADD_MESSAGE:
7077 return handle_bundle_add(ofconn, oh);
7079 case OFPTYPE_NXT_GENEVE_TABLE_MOD:
7080 return handle_geneve_table_mod(ofconn, oh);
7082 case OFPTYPE_NXT_GENEVE_TABLE_REQUEST:
7083 return handle_geneve_table_request(ofconn, oh);
7087 case OFPTYPE_FEATURES_REPLY:
7088 case OFPTYPE_GET_CONFIG_REPLY:
7089 case OFPTYPE_PACKET_IN:
7090 case OFPTYPE_FLOW_REMOVED:
7091 case OFPTYPE_PORT_STATUS:
7092 case OFPTYPE_BARRIER_REPLY:
7093 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
7094 case OFPTYPE_DESC_STATS_REPLY:
7095 case OFPTYPE_FLOW_STATS_REPLY:
7096 case OFPTYPE_QUEUE_STATS_REPLY:
7097 case OFPTYPE_PORT_STATS_REPLY:
7098 case OFPTYPE_TABLE_STATS_REPLY:
7099 case OFPTYPE_AGGREGATE_STATS_REPLY:
7100 case OFPTYPE_PORT_DESC_STATS_REPLY:
7101 case OFPTYPE_ROLE_REPLY:
7102 case OFPTYPE_FLOW_MONITOR_PAUSED:
7103 case OFPTYPE_FLOW_MONITOR_RESUMED:
7104 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
7105 case OFPTYPE_GET_ASYNC_REPLY:
7106 case OFPTYPE_GROUP_STATS_REPLY:
7107 case OFPTYPE_GROUP_DESC_STATS_REPLY:
7108 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
7109 case OFPTYPE_METER_STATS_REPLY:
7110 case OFPTYPE_METER_CONFIG_STATS_REPLY:
7111 case OFPTYPE_METER_FEATURES_STATS_REPLY:
7112 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
7113 case OFPTYPE_ROLE_STATUS:
7114 case OFPTYPE_NXT_GENEVE_TABLE_REPLY:
7116 if (ofpmsg_is_stat_request(oh)) {
7117 return OFPERR_OFPBRC_BAD_STAT;
7119 return OFPERR_OFPBRC_BAD_TYPE;
7125 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
7126 OVS_EXCLUDED(ofproto_mutex)
7128 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
7131 ofconn_send_error(ofconn, ofp_msg->data, error);
7133 COVERAGE_INC(ofproto_recv_openflow);
7136 /* Asynchronous operations. */
7139 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
7141 OVS_REQUIRES(ofproto_mutex)
7143 if (req && req->ofconn && buffer_id != UINT32_MAX) {
7144 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
7145 struct dp_packet *packet;
7149 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
7152 struct rule_execute *re;
7154 ofproto_rule_ref(rule);
7156 re = xmalloc(sizeof *re);
7158 re->in_port = in_port;
7159 re->packet = packet;
7161 if (!guarded_list_push_back(&ofproto->rule_executes,
7162 &re->list_node, 1024)) {
7163 ofproto_rule_unref(rule);
7164 dp_packet_delete(re->packet);
7168 ofconn_send_error(req->ofconn, req->request, error);
7174 pick_datapath_id(const struct ofproto *ofproto)
7176 const struct ofport *port;
7178 port = ofproto_get_port(ofproto, OFPP_LOCAL);
7180 uint8_t ea[ETH_ADDR_LEN];
7183 error = netdev_get_etheraddr(port->netdev, ea);
7185 return eth_addr_to_uint64(ea);
7187 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7188 ofproto->name, netdev_get_name(port->netdev),
7189 ovs_strerror(error));
7191 return ofproto->fallback_dpid;
7195 pick_fallback_dpid(void)
7197 uint8_t ea[ETH_ADDR_LEN];
7198 eth_addr_nicira_random(ea);
7199 return eth_addr_to_uint64(ea);
7202 /* Table overflow policy. */
7204 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7205 * to NULL if the table is not configured to evict rules or if the table
7206 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7207 * or with no timeouts are not evictable.) */
7209 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
7210 OVS_REQUIRES(ofproto_mutex)
7212 struct eviction_group *evg;
7215 if (!table->eviction_fields) {
7219 /* In the common case, the outer and inner loops here will each be entered
7222 * - The inner loop normally "return"s in its first iteration. If the
7223 * eviction group has any evictable rules, then it always returns in
7226 * - The outer loop only iterates more than once if the largest eviction
7227 * group has no evictable rules.
7229 * - The outer loop can exit only if table's 'max_flows' is all filled up
7230 * by unevictable rules. */
7231 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7234 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7243 /* Eviction groups. */
7245 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7246 * rules. The priority contains low-order random bits to ensure that eviction
7247 * groups with the same number of rules are prioritized randomly. */
7249 eviction_group_priority(size_t n_rules)
7251 uint16_t size = MIN(UINT16_MAX, n_rules);
7252 return (size << 16) | random_uint16();
7255 /* Updates 'evg', an eviction_group within 'table', following a change that
7256 * adds or removes rules in 'evg'. */
7258 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7259 OVS_REQUIRES(ofproto_mutex)
7261 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7262 eviction_group_priority(heap_count(&evg->rules)));
7265 /* Destroys 'evg', an eviction_group within 'table':
7267 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7268 * rules themselves, just removes them from the eviction group.)
7270 * - Removes 'evg' from 'table'.
7274 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7275 OVS_REQUIRES(ofproto_mutex)
7277 while (!heap_is_empty(&evg->rules)) {
7280 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7281 rule->eviction_group = NULL;
7283 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7284 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7285 heap_destroy(&evg->rules);
7289 /* Removes 'rule' from its eviction group, if any. */
7291 eviction_group_remove_rule(struct rule *rule)
7292 OVS_REQUIRES(ofproto_mutex)
7294 if (rule->eviction_group) {
7295 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7296 struct eviction_group *evg = rule->eviction_group;
7298 rule->eviction_group = NULL;
7299 heap_remove(&evg->rules, &rule->evg_node);
7300 if (heap_is_empty(&evg->rules)) {
7301 eviction_group_destroy(table, evg);
7303 eviction_group_resized(table, evg);
7308 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7309 * returns the hash value. */
7311 eviction_group_hash_rule(struct rule *rule)
7312 OVS_REQUIRES(ofproto_mutex)
7314 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7315 const struct mf_subfield *sf;
7319 hash = table->eviction_group_id_basis;
7320 miniflow_expand(&rule->cr.match.flow, &flow);
7321 for (sf = table->eviction_fields;
7322 sf < &table->eviction_fields[table->n_eviction_fields];
7325 if (mf_are_prereqs_ok(sf->field, &flow)) {
7326 union mf_value value;
7328 mf_get_value(sf->field, &flow, &value);
7330 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7332 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7333 unsigned int start = sf->ofs + sf->n_bits;
7334 bitwise_zero(&value, sf->field->n_bytes, start,
7335 sf->field->n_bytes * 8 - start);
7337 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7339 hash = hash_int(hash, 0);
7346 /* Returns an eviction group within 'table' with the given 'id', creating one
7348 static struct eviction_group *
7349 eviction_group_find(struct oftable *table, uint32_t id)
7350 OVS_REQUIRES(ofproto_mutex)
7352 struct eviction_group *evg;
7354 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7358 evg = xmalloc(sizeof *evg);
7359 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7360 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7361 eviction_group_priority(0));
7362 heap_init(&evg->rules);
7367 /* Returns an eviction priority for 'rule'. The return value should be
7368 * interpreted so that higher priorities make a rule more attractive candidates
7370 * Called only if have a timeout. */
7372 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7373 OVS_REQUIRES(ofproto_mutex)
7375 long long int expiration = LLONG_MAX;
7376 long long int modified;
7377 uint32_t expiration_offset;
7379 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7380 ovs_mutex_lock(&rule->mutex);
7381 modified = rule->modified;
7382 ovs_mutex_unlock(&rule->mutex);
7384 if (rule->hard_timeout) {
7385 expiration = modified + rule->hard_timeout * 1000;
7387 if (rule->idle_timeout) {
7388 uint64_t packets, bytes;
7390 long long int idle_expiration;
7392 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7393 idle_expiration = used + rule->idle_timeout * 1000;
7394 expiration = MIN(expiration, idle_expiration);
7397 if (expiration == LLONG_MAX) {
7401 /* Calculate the time of expiration as a number of (approximate) seconds
7402 * after program startup.
7404 * This should work OK for program runs that last UINT32_MAX seconds or
7405 * less. Therefore, please restart OVS at least once every 136 years. */
7406 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
7408 /* Invert the expiration offset because we're using a max-heap. */
7409 return UINT32_MAX - expiration_offset;
7412 /* Adds 'rule' to an appropriate eviction group for its oftable's
7413 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7414 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7417 * The caller must ensure that 'rule' is not already in an eviction group. */
7419 eviction_group_add_rule(struct rule *rule)
7420 OVS_REQUIRES(ofproto_mutex)
7422 struct ofproto *ofproto = rule->ofproto;
7423 struct oftable *table = &ofproto->tables[rule->table_id];
7426 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7427 * so no additional protection is needed. */
7428 has_timeout = rule->hard_timeout || rule->idle_timeout;
7430 if (table->eviction_fields && has_timeout) {
7431 struct eviction_group *evg;
7433 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7435 rule->eviction_group = evg;
7436 heap_insert(&evg->rules, &rule->evg_node,
7437 rule_eviction_priority(ofproto, rule));
7438 eviction_group_resized(table, evg);
7444 /* Initializes 'table'. */
7446 oftable_init(struct oftable *table)
7448 memset(table, 0, sizeof *table);
7449 classifier_init(&table->cls, flow_segment_u64s);
7450 table->max_flows = UINT_MAX;
7452 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7454 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7455 ARRAY_SIZE(default_prefix_fields));
7457 atomic_init(&table->n_matched, 0);
7458 atomic_init(&table->n_missed, 0);
7461 /* Destroys 'table', including its classifier and eviction groups.
7463 * The caller is responsible for freeing 'table' itself. */
7465 oftable_destroy(struct oftable *table)
7467 ovs_assert(classifier_is_empty(&table->cls));
7468 oftable_disable_eviction(table);
7469 classifier_destroy(&table->cls);
7473 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7474 * string, then 'table' will use its default name.
7476 * This only affects the name exposed for a table exposed through the OpenFlow
7477 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7479 oftable_set_name(struct oftable *table, const char *name)
7481 if (name && name[0]) {
7482 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7483 if (!table->name || strncmp(name, table->name, len)) {
7485 table->name = xmemdup0(name, len);
7493 /* oftables support a choice of two policies when adding a rule would cause the
7494 * number of flows in the table to exceed the configured maximum number: either
7495 * they can refuse to add the new flow or they can evict some existing flow.
7496 * This function configures the former policy on 'table'. */
7498 oftable_disable_eviction(struct oftable *table)
7499 OVS_REQUIRES(ofproto_mutex)
7501 if (table->eviction_fields) {
7502 struct eviction_group *evg, *next;
7504 HMAP_FOR_EACH_SAFE (evg, next, id_node,
7505 &table->eviction_groups_by_id) {
7506 eviction_group_destroy(table, evg);
7508 hmap_destroy(&table->eviction_groups_by_id);
7509 heap_destroy(&table->eviction_groups_by_size);
7511 free(table->eviction_fields);
7512 table->eviction_fields = NULL;
7513 table->n_eviction_fields = 0;
7517 /* oftables support a choice of two policies when adding a rule would cause the
7518 * number of flows in the table to exceed the configured maximum number: either
7519 * they can refuse to add the new flow or they can evict some existing flow.
7520 * This function configures the latter policy on 'table', with fairness based
7521 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7522 * 'n_fields' as 0 disables fairness.) */
7524 oftable_enable_eviction(struct oftable *table,
7525 const struct mf_subfield *fields, size_t n_fields)
7526 OVS_REQUIRES(ofproto_mutex)
7530 if (table->eviction_fields
7531 && n_fields == table->n_eviction_fields
7533 || !memcmp(fields, table->eviction_fields,
7534 n_fields * sizeof *fields))) {
7539 oftable_disable_eviction(table);
7541 table->n_eviction_fields = n_fields;
7542 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
7544 table->eviction_group_id_basis = random_uint32();
7545 hmap_init(&table->eviction_groups_by_id);
7546 heap_init(&table->eviction_groups_by_size);
7548 CLS_FOR_EACH (rule, cr, &table->cls) {
7549 eviction_group_add_rule(rule);
7553 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7554 * it to the classifier. */
7556 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7557 OVS_REQUIRES(ofproto_mutex)
7559 const struct rule_actions *actions = rule_get_actions(rule);
7561 ovs_assert(rule->removed);
7563 if (rule->hard_timeout || rule->idle_timeout) {
7564 list_insert(&ofproto->expirable, &rule->expirable);
7566 cookies_insert(ofproto, rule);
7567 eviction_group_add_rule(rule);
7568 if (actions->has_meter) {
7569 meter_insert_rule(rule);
7571 rule->removed = false;
7574 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7575 * the removal from the classifier. */
7577 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7578 OVS_REQUIRES(ofproto_mutex)
7580 ovs_assert(!rule->removed);
7582 cookies_remove(ofproto, rule);
7584 eviction_group_remove_rule(rule);
7585 if (!list_is_empty(&rule->expirable)) {
7586 list_remove(&rule->expirable);
7588 if (!list_is_empty(&rule->meter_list_node)) {
7589 list_remove(&rule->meter_list_node);
7590 list_init(&rule->meter_list_node);
7593 rule->removed = true;
7596 /* unixctl commands. */
7599 ofproto_lookup(const char *name)
7601 struct ofproto *ofproto;
7603 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7605 if (!strcmp(ofproto->name, name)) {
7613 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7614 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7616 struct ofproto *ofproto;
7620 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7621 ds_put_format(&results, "%s\n", ofproto->name);
7623 unixctl_command_reply(conn, ds_cstr(&results));
7624 ds_destroy(&results);
7628 ofproto_unixctl_init(void)
7630 static bool registered;
7636 unixctl_command_register("ofproto/list", "", 0, 0,
7637 ofproto_unixctl_list, NULL);
7640 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7642 * This is deprecated. It is only for compatibility with broken device drivers
7643 * in old versions of Linux that do not properly support VLANs when VLAN
7644 * devices are not used. When broken device drivers are no longer in
7645 * widespread use, we will delete these interfaces. */
7647 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7648 * (exactly) by an OpenFlow rule in 'ofproto'. */
7650 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7653 struct cls_rule target;
7654 const struct oftable *oftable;
7656 match_init_catchall(&match);
7657 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7658 cls_rule_init(&target, &match, 0, CLS_MAX_VERSION);
7660 free(ofproto->vlan_bitmap);
7661 ofproto->vlan_bitmap = bitmap_allocate(4096);
7662 ofproto->vlans_changed = false;
7664 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7667 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7668 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7669 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7671 bitmap_set1(vlan_bitmap, vid);
7672 bitmap_set1(ofproto->vlan_bitmap, vid);
7677 cls_rule_destroy(&target);
7680 /* Returns true if new VLANs have come into use by the flow table since the
7681 * last call to ofproto_get_vlan_usage().
7683 * We don't track when old VLANs stop being used. */
7685 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7687 return ofproto->vlans_changed;
7690 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7691 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7692 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7693 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7694 * then the VLAN device is un-enslaved. */
7696 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7697 ofp_port_t realdev_ofp_port, int vid)
7699 struct ofport *ofport;
7702 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7704 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7706 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7707 ofproto->name, vlandev_ofp_port);
7711 if (!ofproto->ofproto_class->set_realdev) {
7712 if (!vlandev_ofp_port) {
7715 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7719 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7721 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7722 ofproto->name, vlandev_ofp_port,
7723 netdev_get_name(ofport->netdev), ovs_strerror(error));