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 OVS_REQUIRES(ofproto_mutex);
88 static void oftable_enable_eviction(struct oftable *,
89 const struct mf_subfield *fields,
91 OVS_REQUIRES(ofproto_mutex);
93 /* A set of rules within a single OpenFlow table (oftable) that have the same
94 * values for the oftable's eviction_fields. A rule to be evicted, when one is
95 * needed, is taken from the eviction group that contains the greatest number
98 * An oftable owns any number of eviction groups, each of which contains any
101 * Membership in an eviction group is imprecise, based on the hash of the
102 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
103 * That is, if two rules have different eviction_fields, but those
104 * eviction_fields hash to the same value, then they will belong to the same
105 * eviction_group anyway.
107 * (When eviction is not enabled on an oftable, we don't track any eviction
108 * groups, to save time and space.) */
109 struct eviction_group {
110 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
111 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
112 struct heap rules; /* Contains "struct rule"s. */
115 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
116 OVS_REQUIRES(ofproto_mutex);
117 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *)
118 OVS_REQUIRES(ofproto_mutex);;
119 static void eviction_group_add_rule(struct rule *)
120 OVS_REQUIRES(ofproto_mutex);
121 static void eviction_group_remove_rule(struct rule *)
122 OVS_REQUIRES(ofproto_mutex);
124 /* Criteria that flow_mod and other operations use for selecting rules on
125 * which to operate. */
126 struct rule_criteria {
127 /* An OpenFlow table or 255 for all tables. */
130 /* OpenFlow matching criteria. Interpreted different in "loose" way by
131 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
132 * defined in the OpenFlow spec. */
135 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
136 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
137 * The rule will not be selected if M is 1 and B != C. */
139 ovs_be64 cookie_mask;
141 /* Selection based on actions within a rule:
143 * If out_port != OFPP_ANY, selects only rules that output to out_port.
144 * If out_group != OFPG_ALL, select only rules that output to out_group. */
148 /* If true, collects only rules that are modifiable. */
150 bool include_readonly;
153 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
154 const struct match *match, int priority,
155 cls_version_t version,
156 ovs_be64 cookie, ovs_be64 cookie_mask,
157 ofp_port_t out_port, uint32_t out_group);
158 static void rule_criteria_require_rw(struct rule_criteria *,
159 bool can_write_readonly);
160 static void rule_criteria_destroy(struct rule_criteria *);
162 static enum ofperr collect_rules_loose(struct ofproto *,
163 const struct rule_criteria *,
164 struct rule_collection *);
166 /* A packet that needs to be passed to rule_execute().
168 * (We can't do this immediately from ofopgroup_complete() because that holds
169 * ofproto_mutex, which rule_execute() needs released.) */
170 struct rule_execute {
171 struct ovs_list list_node; /* In struct ofproto's "rule_executes" list. */
172 struct rule *rule; /* Owns a reference to the rule. */
174 struct dp_packet *packet; /* Owns the packet. */
177 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
178 static void destroy_rule_executes(struct ofproto *);
180 struct learned_cookie {
182 /* In struct ofproto's 'learned_cookies' hmap. */
183 struct hmap_node hmap_node OVS_GUARDED_BY(ofproto_mutex);
185 /* In 'dead_cookies' list when removed from hmap. */
186 struct ovs_list list_node;
190 ovs_be64 cookie OVS_GUARDED_BY(ofproto_mutex);
191 uint8_t table_id OVS_GUARDED_BY(ofproto_mutex);
193 /* Number of references from "learn" actions.
195 * When this drops to 0, all of the flows in 'table_id' with the specified
196 * 'cookie' are deleted. */
197 int n OVS_GUARDED_BY(ofproto_mutex);
200 static const struct ofpact_learn *next_learn_with_delete(
201 const struct rule_actions *, const struct ofpact_learn *start);
203 static void learned_cookies_inc(struct ofproto *, const struct rule_actions *)
204 OVS_REQUIRES(ofproto_mutex);
205 static void learned_cookies_dec(struct ofproto *, const struct rule_actions *,
206 struct ovs_list *dead_cookies)
207 OVS_REQUIRES(ofproto_mutex);
208 static void learned_cookies_flush(struct ofproto *, struct ovs_list *dead_cookies)
209 OVS_REQUIRES(ofproto_mutex);
212 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
213 static void ofport_destroy(struct ofport *);
215 static void update_port(struct ofproto *, const char *devname);
216 static int init_ports(struct ofproto *);
217 static void reinit_ports(struct ofproto *);
219 static long long int ofport_get_usage(const struct ofproto *,
220 ofp_port_t ofp_port);
221 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
222 long long int last_used);
223 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
227 * Keeps track of the currently used and recently used ofport values and is
228 * used to prevent immediate recycling of ofport values. */
229 struct ofport_usage {
230 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
231 ofp_port_t ofp_port; /* OpenFlow port number. */
232 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
233 represents in-use ofports. */
237 static void ofproto_rule_send_removed(struct rule *)
238 OVS_EXCLUDED(ofproto_mutex);
239 static bool rule_is_readonly(const struct rule *);
240 static void ofproto_rule_insert__(struct ofproto *, struct rule *)
241 OVS_REQUIRES(ofproto_mutex);
242 static void ofproto_rule_remove__(struct ofproto *, struct rule *)
243 OVS_REQUIRES(ofproto_mutex);
245 /* The source of a flow_mod request, in the code that processes flow_mods.
247 * A flow table modification request can be generated externally, via OpenFlow,
248 * or internally through a function call. This structure indicates the source
249 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
250 * meaningful and thus supplied as NULL. */
251 struct flow_mod_requester {
252 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
253 const struct ofp_header *request;
257 static enum ofperr replace_rule_create(struct ofproto *,
258 struct ofputil_flow_mod *,
259 struct cls_rule *cr, uint8_t table_id,
260 struct rule *old_rule,
261 struct rule **new_rule)
262 OVS_REQUIRES(ofproto_mutex);
264 static void replace_rule_start(struct ofproto *,
265 struct rule *old_rule,
266 struct rule *new_rule,
267 struct cls_conjunction *, size_t n_conjs)
268 OVS_REQUIRES(ofproto_mutex);
270 static void replace_rule_revert(struct ofproto *, struct rule *old_rule,
271 struct rule *new_rule)
272 OVS_REQUIRES(ofproto_mutex);
274 static void replace_rule_finish(struct ofproto *, struct ofputil_flow_mod *,
275 const struct flow_mod_requester *,
276 struct rule *old_rule, struct rule *new_rule,
277 struct ovs_list *dead_cookies)
278 OVS_REQUIRES(ofproto_mutex);
279 static void delete_flows__(struct rule_collection *,
280 enum ofp_flow_removed_reason,
281 const struct flow_mod_requester *)
282 OVS_REQUIRES(ofproto_mutex);
284 static void send_buffered_packet(const struct flow_mod_requester *,
285 uint32_t buffer_id, struct rule *)
286 OVS_REQUIRES(ofproto_mutex);
288 static bool ofproto_group_exists__(const struct ofproto *ofproto,
290 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
291 static bool ofproto_group_exists(const struct ofproto *ofproto,
293 OVS_EXCLUDED(ofproto->groups_rwlock);
294 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
295 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
296 static enum ofperr do_bundle_flow_mod_start(struct ofproto *,
297 struct ofputil_flow_mod *,
298 struct ofp_bundle_entry *)
299 OVS_REQUIRES(ofproto_mutex);
300 static void do_bundle_flow_mod_finish(struct ofproto *,
301 struct ofputil_flow_mod *,
302 const struct flow_mod_requester *,
303 struct ofp_bundle_entry *)
304 OVS_REQUIRES(ofproto_mutex);
305 static enum ofperr handle_flow_mod__(struct ofproto *,
306 struct ofputil_flow_mod *,
307 const struct flow_mod_requester *)
308 OVS_EXCLUDED(ofproto_mutex);
309 static void calc_duration(long long int start, long long int now,
310 uint32_t *sec, uint32_t *nsec);
313 static uint64_t pick_datapath_id(const struct ofproto *);
314 static uint64_t pick_fallback_dpid(void);
315 static void ofproto_destroy__(struct ofproto *);
316 static void update_mtu(struct ofproto *, struct ofport *);
317 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
318 static void meter_insert_rule(struct rule *);
321 static void ofproto_unixctl_init(void);
323 /* All registered ofproto classes, in probe order. */
324 static const struct ofproto_class **ofproto_classes;
325 static size_t n_ofproto_classes;
326 static size_t allocated_ofproto_classes;
328 /* Global lock that protects all flow table operations. */
329 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
331 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
332 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
334 size_t n_handlers, n_revalidators;
338 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
339 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
341 /* Initial mappings of port to OpenFlow number mappings. */
342 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
344 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
346 /* The default value of true waits for flow restore. */
347 static bool flow_restore_wait = true;
349 /* Must be called to initialize the ofproto library.
351 * The caller may pass in 'iface_hints', which contains an shash of
352 * "iface_hint" elements indexed by the interface's name. The provider
353 * may use these hints to describe the startup configuration in order to
354 * reinitialize its state. The caller owns the provided data, so a
355 * provider will make copies of anything required. An ofproto provider
356 * will remove any existing state that is not described by the hint, and
357 * may choose to remove it all. */
359 ofproto_init(const struct shash *iface_hints)
361 struct shash_node *node;
364 ofproto_class_register(&ofproto_dpif_class);
366 /* Make a local copy, since we don't own 'iface_hints' elements. */
367 SHASH_FOR_EACH(node, iface_hints) {
368 const struct iface_hint *orig_hint = node->data;
369 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
370 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
372 new_hint->br_name = xstrdup(orig_hint->br_name);
373 new_hint->br_type = xstrdup(br_type);
374 new_hint->ofp_port = orig_hint->ofp_port;
376 shash_add(&init_ofp_ports, node->name, new_hint);
379 for (i = 0; i < n_ofproto_classes; i++) {
380 ofproto_classes[i]->init(&init_ofp_ports);
383 ofproto_unixctl_init();
386 /* 'type' should be a normalized datapath type, as returned by
387 * ofproto_normalize_type(). Returns the corresponding ofproto_class
388 * structure, or a null pointer if there is none registered for 'type'. */
389 static const struct ofproto_class *
390 ofproto_class_find__(const char *type)
394 for (i = 0; i < n_ofproto_classes; i++) {
395 const struct ofproto_class *class = ofproto_classes[i];
400 class->enumerate_types(&types);
401 found = sset_contains(&types, type);
402 sset_destroy(&types);
408 VLOG_WARN("unknown datapath type %s", type);
412 /* Registers a new ofproto class. After successful registration, new ofprotos
413 * of that type can be created using ofproto_create(). */
415 ofproto_class_register(const struct ofproto_class *new_class)
419 for (i = 0; i < n_ofproto_classes; i++) {
420 if (ofproto_classes[i] == new_class) {
425 if (n_ofproto_classes >= allocated_ofproto_classes) {
426 ofproto_classes = x2nrealloc(ofproto_classes,
427 &allocated_ofproto_classes,
428 sizeof *ofproto_classes);
430 ofproto_classes[n_ofproto_classes++] = new_class;
434 /* Unregisters a datapath provider. 'type' must have been previously
435 * registered and not currently be in use by any ofprotos. After
436 * unregistration new datapaths of that type cannot be opened using
437 * ofproto_create(). */
439 ofproto_class_unregister(const struct ofproto_class *class)
443 for (i = 0; i < n_ofproto_classes; i++) {
444 if (ofproto_classes[i] == class) {
445 for (i++; i < n_ofproto_classes; i++) {
446 ofproto_classes[i - 1] = ofproto_classes[i];
452 VLOG_WARN("attempted to unregister an ofproto class that is not "
457 /* Clears 'types' and enumerates all registered ofproto types into it. The
458 * caller must first initialize the sset. */
460 ofproto_enumerate_types(struct sset *types)
465 for (i = 0; i < n_ofproto_classes; i++) {
466 ofproto_classes[i]->enumerate_types(types);
470 /* Returns the fully spelled out name for the given ofproto 'type'.
472 * Normalized type string can be compared with strcmp(). Unnormalized type
473 * string might be the same even if they have different spellings. */
475 ofproto_normalize_type(const char *type)
477 return type && type[0] ? type : "system";
480 /* Clears 'names' and enumerates the names of all known created ofprotos with
481 * the given 'type'. The caller must first initialize the sset. Returns 0 if
482 * successful, otherwise a positive errno value.
484 * Some kinds of datapaths might not be practically enumerable. This is not
485 * considered an error. */
487 ofproto_enumerate_names(const char *type, struct sset *names)
489 const struct ofproto_class *class = ofproto_class_find__(type);
490 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
494 ofproto_bump_tables_version(struct ofproto *ofproto)
496 ++ofproto->tables_version;
497 ofproto->ofproto_class->set_tables_version(ofproto,
498 ofproto->tables_version);
502 ofproto_create(const char *datapath_name, const char *datapath_type,
503 struct ofproto **ofprotop)
505 const struct ofproto_class *class;
506 struct ofproto *ofproto;
512 datapath_type = ofproto_normalize_type(datapath_type);
513 class = ofproto_class_find__(datapath_type);
515 VLOG_WARN("could not create datapath %s of unknown type %s",
516 datapath_name, datapath_type);
520 ofproto = class->alloc();
522 VLOG_ERR("failed to allocate datapath %s of type %s",
523 datapath_name, datapath_type);
528 ovs_mutex_lock(&ofproto_mutex);
529 memset(ofproto, 0, sizeof *ofproto);
530 ofproto->ofproto_class = class;
531 ofproto->name = xstrdup(datapath_name);
532 ofproto->type = xstrdup(datapath_type);
533 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
534 hash_string(ofproto->name, 0));
535 ofproto->datapath_id = 0;
536 ofproto->forward_bpdu = false;
537 ofproto->fallback_dpid = pick_fallback_dpid();
538 ofproto->mfr_desc = NULL;
539 ofproto->hw_desc = NULL;
540 ofproto->sw_desc = NULL;
541 ofproto->serial_desc = NULL;
542 ofproto->dp_desc = NULL;
543 ofproto->frag_handling = OFPC_FRAG_NORMAL;
544 hmap_init(&ofproto->ports);
545 hmap_init(&ofproto->ofport_usage);
546 shash_init(&ofproto->port_by_name);
547 simap_init(&ofproto->ofp_requests);
548 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
549 ofproto->eviction_group_timer = LLONG_MIN;
550 ofproto->tables = NULL;
551 ofproto->n_tables = 0;
552 ofproto->tables_version = CLS_MIN_VERSION;
553 hindex_init(&ofproto->cookies);
554 hmap_init(&ofproto->learned_cookies);
555 list_init(&ofproto->expirable);
556 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
557 guarded_list_init(&ofproto->rule_executes);
558 ofproto->vlan_bitmap = NULL;
559 ofproto->vlans_changed = false;
560 ofproto->min_mtu = INT_MAX;
561 ovs_rwlock_init(&ofproto->groups_rwlock);
562 hmap_init(&ofproto->groups);
563 ovs_mutex_unlock(&ofproto_mutex);
564 ofproto->ogf.types = 0xf;
565 ofproto->ogf.capabilities = OFPGFC_SELECT_LIVENESS | OFPGFC_SELECT_WEIGHT;
566 for (i = 0; i < 4; i++) {
567 ofproto->ogf.max_groups[i] = OFPG_MAX;
568 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
571 error = ofproto->ofproto_class->construct(ofproto);
573 VLOG_ERR("failed to open datapath %s: %s",
574 datapath_name, ovs_strerror(error));
575 connmgr_destroy(ofproto->connmgr);
576 ofproto_destroy__(ofproto);
580 /* Check that hidden tables, if any, are at the end. */
581 ovs_assert(ofproto->n_tables);
582 for (i = 0; i + 1 < ofproto->n_tables; i++) {
583 enum oftable_flags flags = ofproto->tables[i].flags;
584 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
586 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
589 ofproto->datapath_id = pick_datapath_id(ofproto);
592 /* Initialize meters table. */
593 if (ofproto->ofproto_class->meter_get_features) {
594 ofproto->ofproto_class->meter_get_features(ofproto,
595 &ofproto->meter_features);
597 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
599 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
600 * sizeof(struct meter *));
602 /* Set the initial tables version. */
603 ofproto_bump_tables_version(ofproto);
609 /* Must be called (only) by an ofproto implementation in its constructor
610 * function. See the large comment on 'construct' in struct ofproto_class for
613 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
615 struct oftable *table;
617 ovs_assert(!ofproto->n_tables);
618 ovs_assert(n_tables >= 1 && n_tables <= 255);
620 ofproto->n_tables = n_tables;
621 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
622 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
627 /* To be optionally called (only) by an ofproto implementation in its
628 * constructor function. See the large comment on 'construct' in struct
629 * ofproto_class for details.
631 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
632 * will then ensure that actions passed into the ofproto implementation will
633 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
634 * function is not called, there will be no such restriction.
636 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
637 * the 'max_ports' restriction. */
639 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
641 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
642 ofproto->max_ports = max_ports;
646 ofproto_get_datapath_id(const struct ofproto *ofproto)
648 return ofproto->datapath_id;
652 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
654 uint64_t old_dpid = p->datapath_id;
655 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
656 if (p->datapath_id != old_dpid) {
657 /* Force all active connections to reconnect, since there is no way to
658 * notify a controller that the datapath ID has changed. */
659 ofproto_reconnect_controllers(p);
664 ofproto_set_controllers(struct ofproto *p,
665 const struct ofproto_controller *controllers,
666 size_t n_controllers, uint32_t allowed_versions)
668 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
673 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
675 connmgr_set_fail_mode(p->connmgr, fail_mode);
678 /* Drops the connections between 'ofproto' and all of its controllers, forcing
679 * them to reconnect. */
681 ofproto_reconnect_controllers(struct ofproto *ofproto)
683 connmgr_reconnect(ofproto->connmgr);
686 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
687 * in-band control should guarantee access, in the same way that in-band
688 * control guarantees access to OpenFlow controllers. */
690 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
691 const struct sockaddr_in *extras, size_t n)
693 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
696 /* Sets the OpenFlow queue used by flows set up by in-band control on
697 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
698 * flows will use the default queue. */
700 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
702 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
705 /* Sets the number of flows at which eviction from the kernel flow table
708 ofproto_set_flow_limit(unsigned limit)
710 ofproto_flow_limit = limit;
713 /* Sets the maximum idle time for flows in the datapath before they are
716 ofproto_set_max_idle(unsigned max_idle)
718 ofproto_max_idle = max_idle;
721 /* If forward_bpdu is true, the NORMAL action will forward frames with
722 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
723 * the NORMAL action will drop these frames. */
725 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
727 bool old_val = ofproto->forward_bpdu;
728 ofproto->forward_bpdu = forward_bpdu;
729 if (old_val != ofproto->forward_bpdu) {
730 if (ofproto->ofproto_class->forward_bpdu_changed) {
731 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
736 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
737 * 'idle_time', in seconds, and the maximum number of MAC table entries to
740 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
743 if (ofproto->ofproto_class->set_mac_table_config) {
744 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
749 /* Multicast snooping configuration. */
751 /* Configures multicast snooping on 'ofproto' using the settings
752 * defined in 's'. If 's' is NULL, disables multicast snooping.
754 * Returns 0 if successful, otherwise a positive errno value. */
756 ofproto_set_mcast_snooping(struct ofproto *ofproto,
757 const struct ofproto_mcast_snooping_settings *s)
759 return (ofproto->ofproto_class->set_mcast_snooping
760 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
764 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
766 * Returns 0 if successful, otherwise a positive errno value.*/
768 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
769 const struct ofproto_mcast_snooping_port_settings *s)
771 return (ofproto->ofproto_class->set_mcast_snooping_port
772 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
777 ofproto_set_n_dpdk_rxqs(int n_rxqs)
779 n_dpdk_rxqs = MAX(n_rxqs, 0);
783 ofproto_set_cpu_mask(const char *cmask)
787 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
791 ofproto_set_threads(int n_handlers_, int n_revalidators_)
793 int threads = MAX(count_cpu_cores(), 2);
795 n_revalidators = MAX(n_revalidators_, 0);
796 n_handlers = MAX(n_handlers_, 0);
798 if (!n_revalidators) {
799 n_revalidators = n_handlers
800 ? MAX(threads - (int) n_handlers, 1)
805 n_handlers = MAX(threads - (int) n_revalidators, 1);
810 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
813 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
817 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
819 return connmgr_set_snoops(ofproto->connmgr, snoops);
823 ofproto_set_netflow(struct ofproto *ofproto,
824 const struct netflow_options *nf_options)
826 if (nf_options && sset_is_empty(&nf_options->collectors)) {
830 if (ofproto->ofproto_class->set_netflow) {
831 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
833 return nf_options ? EOPNOTSUPP : 0;
838 ofproto_set_sflow(struct ofproto *ofproto,
839 const struct ofproto_sflow_options *oso)
841 if (oso && sset_is_empty(&oso->targets)) {
845 if (ofproto->ofproto_class->set_sflow) {
846 return ofproto->ofproto_class->set_sflow(ofproto, oso);
848 return oso ? EOPNOTSUPP : 0;
853 ofproto_set_ipfix(struct ofproto *ofproto,
854 const struct ofproto_ipfix_bridge_exporter_options *bo,
855 const struct ofproto_ipfix_flow_exporter_options *fo,
858 if (ofproto->ofproto_class->set_ipfix) {
859 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
861 return (bo || fo) ? EOPNOTSUPP : 0;
866 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
868 flow_restore_wait = flow_restore_wait_db;
872 ofproto_get_flow_restore_wait(void)
874 return flow_restore_wait;
878 /* Spanning Tree Protocol (STP) configuration. */
880 /* Configures STP on 'ofproto' using the settings defined in 's'. If
881 * 's' is NULL, disables STP.
883 * Returns 0 if successful, otherwise a positive errno value. */
885 ofproto_set_stp(struct ofproto *ofproto,
886 const struct ofproto_stp_settings *s)
888 return (ofproto->ofproto_class->set_stp
889 ? ofproto->ofproto_class->set_stp(ofproto, s)
893 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
894 * 'enabled' member of 's' is false, then the other members are not
897 * Returns 0 if successful, otherwise a positive errno value. */
899 ofproto_get_stp_status(struct ofproto *ofproto,
900 struct ofproto_stp_status *s)
902 return (ofproto->ofproto_class->get_stp_status
903 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
907 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
908 * in 's'. The caller is responsible for assigning STP port numbers
909 * (using the 'port_num' member in the range of 1 through 255, inclusive)
910 * and ensuring there are no duplicates. If the 's' is NULL, then STP
911 * is disabled on the port.
913 * Returns 0 if successful, otherwise a positive errno value.*/
915 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
916 const struct ofproto_port_stp_settings *s)
918 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
920 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
921 ofproto->name, ofp_port);
925 return (ofproto->ofproto_class->set_stp_port
926 ? ofproto->ofproto_class->set_stp_port(ofport, s)
930 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
931 * 's'. If the 'enabled' member in 's' is false, then the other members
932 * are not meaningful.
934 * Returns 0 if successful, otherwise a positive errno value.*/
936 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
937 struct ofproto_port_stp_status *s)
939 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
941 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
942 "port %"PRIu16, ofproto->name, ofp_port);
946 return (ofproto->ofproto_class->get_stp_port_status
947 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
951 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
952 * 's'. If the 'enabled' member in 's' is false, then the other members
953 * are not meaningful.
955 * Returns 0 if successful, otherwise a positive errno value.*/
957 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
958 struct ofproto_port_stp_stats *s)
960 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
962 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
963 "port %"PRIu16, ofproto->name, ofp_port);
967 return (ofproto->ofproto_class->get_stp_port_stats
968 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
972 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
974 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
975 * 's' is NULL, disables RSTP.
977 * Returns 0 if successful, otherwise a positive errno value. */
979 ofproto_set_rstp(struct ofproto *ofproto,
980 const struct ofproto_rstp_settings *s)
982 if (!ofproto->ofproto_class->set_rstp) {
985 ofproto->ofproto_class->set_rstp(ofproto, s);
989 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
990 * 'enabled' member of 's' is false, then the other members are not
993 * Returns 0 if successful, otherwise a positive errno value. */
995 ofproto_get_rstp_status(struct ofproto *ofproto,
996 struct ofproto_rstp_status *s)
998 if (!ofproto->ofproto_class->get_rstp_status) {
1001 ofproto->ofproto_class->get_rstp_status(ofproto, s);
1005 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1006 * in 's'. The caller is responsible for assigning RSTP port numbers
1007 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1008 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1009 * is disabled on the port.
1011 * Returns 0 if successful, otherwise a positive errno value.*/
1013 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
1014 const struct ofproto_port_rstp_settings *s)
1016 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1018 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
1019 ofproto->name, ofp_port);
1023 if (!ofproto->ofproto_class->set_rstp_port) {
1026 ofproto->ofproto_class->set_rstp_port(ofport, s);
1030 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1031 * 's'. If the 'enabled' member in 's' is false, then the other members
1032 * are not meaningful.
1034 * Returns 0 if successful, otherwise a positive errno value.*/
1036 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1037 struct ofproto_port_rstp_status *s)
1039 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1041 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1042 "port %"PRIu16, ofproto->name, ofp_port);
1046 if (!ofproto->ofproto_class->get_rstp_port_status) {
1049 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1053 /* Queue DSCP configuration. */
1055 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1056 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1057 * to implement QoS. Instead, it is used to implement features which require
1058 * knowledge of what queues exist on a port, and some basic information about
1061 * Returns 0 if successful, otherwise a positive errno value. */
1063 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1064 const struct ofproto_port_queue *queues,
1067 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1070 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1071 ofproto->name, ofp_port);
1075 return (ofproto->ofproto_class->set_queues
1076 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1080 /* LLDP configuration. */
1082 ofproto_port_set_lldp(struct ofproto *ofproto,
1083 ofp_port_t ofp_port,
1084 const struct smap *cfg)
1086 struct ofport *ofport;
1089 ofport = ofproto_get_port(ofproto, ofp_port);
1091 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1092 ofproto->name, ofp_port);
1095 error = (ofproto->ofproto_class->set_lldp
1096 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1099 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1100 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1101 ovs_strerror(error));
1106 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1107 const struct aa_settings *s)
1109 if (!ofproto->ofproto_class->set_aa) {
1112 ofproto->ofproto_class->set_aa(ofproto, s);
1117 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1118 const struct aa_mapping_settings *s)
1120 if (!ofproto->ofproto_class->aa_mapping_set) {
1123 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1128 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1130 if (!ofproto->ofproto_class->aa_mapping_unset) {
1133 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1138 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1139 struct ovs_list *list)
1141 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1144 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1149 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1151 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1154 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1157 /* Connectivity Fault Management configuration. */
1159 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1161 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1163 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1164 if (ofport && ofproto->ofproto_class->set_cfm) {
1165 ofproto->ofproto_class->set_cfm(ofport, NULL);
1169 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1170 * basic configuration from the configuration members in 'cfm', and the remote
1171 * maintenance point ID from remote_mpid. Ignores the statistics members of
1174 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1176 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1177 const struct cfm_settings *s)
1179 struct ofport *ofport;
1182 ofport = ofproto_get_port(ofproto, ofp_port);
1184 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1185 ofproto->name, ofp_port);
1189 /* XXX: For configuration simplicity, we only support one remote_mpid
1190 * outside of the CFM module. It's not clear if this is the correct long
1191 * term solution or not. */
1192 error = (ofproto->ofproto_class->set_cfm
1193 ? ofproto->ofproto_class->set_cfm(ofport, s)
1196 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1197 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1198 ovs_strerror(error));
1202 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1203 * 'ofproto' does not have a port 'ofp_port'. */
1205 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1206 const struct smap *cfg)
1208 struct ofport *ofport;
1211 ofport = ofproto_get_port(ofproto, ofp_port);
1213 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1214 ofproto->name, ofp_port);
1218 error = (ofproto->ofproto_class->set_bfd
1219 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1222 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1223 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1224 ovs_strerror(error));
1228 /* Checks the status change of BFD on 'ofport'.
1230 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1232 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1234 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1235 return (ofport && ofproto->ofproto_class->bfd_status_changed
1236 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1240 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1241 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1242 * is not an OpenFlow port in 'ofproto'.
1244 * The caller must provide and own '*status'. */
1246 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1247 struct smap *status)
1249 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1250 return (ofport && ofproto->ofproto_class->get_bfd_status
1251 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1255 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1256 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1257 * 0 if LACP partner information is not current (generally indicating a
1258 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1260 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1262 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1263 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1264 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1269 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1271 struct ofproto *ofproto = port->ofproto;
1274 if (ofproto->ofproto_class->port_get_lacp_stats) {
1275 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1285 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1286 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1287 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1288 * configuration plus, if there is more than one slave, a bonding
1291 * If 'aux' is already registered then this function updates its configuration
1292 * to 's'. Otherwise, this function registers a new bundle.
1294 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1297 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1298 const struct ofproto_bundle_settings *s)
1300 return (ofproto->ofproto_class->bundle_set
1301 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1305 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1306 * If no such bundle has been registered, this has no effect. */
1308 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1310 return ofproto_bundle_register(ofproto, aux, NULL);
1314 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1315 * If 'aux' is already registered then this function updates its configuration
1316 * to 's'. Otherwise, this function registers a new mirror. */
1318 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1319 const struct ofproto_mirror_settings *s)
1321 return (ofproto->ofproto_class->mirror_set
1322 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1326 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1327 * If no mirror has been registered, this has no effect. */
1329 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1331 return ofproto_mirror_register(ofproto, aux, NULL);
1334 /* Retrieves statistics from mirror associated with client data pointer
1335 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1336 * 'bytes', respectively. If a particular counters is not supported,
1337 * the appropriate argument is set to UINT64_MAX.
1340 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1341 uint64_t *packets, uint64_t *bytes)
1343 if (!ofproto->ofproto_class->mirror_get_stats) {
1344 *packets = *bytes = UINT64_MAX;
1348 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1352 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1353 * which all packets are flooded, instead of using MAC learning. If
1354 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1356 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1359 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1361 return (ofproto->ofproto_class->set_flood_vlans
1362 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1366 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1367 * output for a mirror. */
1369 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1371 return (ofproto->ofproto_class->is_mirror_output_bundle
1372 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1376 /* Configuration of OpenFlow tables. */
1378 /* Returns the number of OpenFlow tables in 'ofproto'. */
1380 ofproto_get_n_tables(const struct ofproto *ofproto)
1382 return ofproto->n_tables;
1385 /* Returns the number of Controller visible OpenFlow tables
1386 * in 'ofproto'. This number will exclude Hidden tables.
1387 * This funtion's return value should be less or equal to that of
1388 * ofproto_get_n_tables() . */
1390 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1392 uint8_t n = ofproto->n_tables;
1394 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1395 * if present, are always at the end.) */
1396 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1403 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1404 * settings from 's'. 'table_id' must be in the range 0 through the number of
1405 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1407 * For read-only tables, only the name may be configured. */
1409 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1410 const struct ofproto_table_settings *s)
1412 struct oftable *table;
1414 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1415 table = &ofproto->tables[table_id];
1417 oftable_set_name(table, s->name);
1419 if (table->flags & OFTABLE_READONLY) {
1423 if (classifier_set_prefix_fields(&table->cls,
1424 s->prefix_fields, s->n_prefix_fields)) {
1425 /* XXX: Trigger revalidation. */
1428 ovs_mutex_lock(&ofproto_mutex);
1430 oftable_enable_eviction(table, s->groups, s->n_groups);
1432 oftable_disable_eviction(table);
1434 table->max_flows = s->max_flows;
1435 evict_rules_from_table(table);
1436 ovs_mutex_unlock(&ofproto_mutex);
1440 ofproto_has_snoops(const struct ofproto *ofproto)
1442 return connmgr_has_snoops(ofproto->connmgr);
1446 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1448 connmgr_get_snoops(ofproto->connmgr, snoops);
1451 /* Deletes 'rule' from 'ofproto'.
1453 * Within an ofproto implementation, this function allows an ofproto
1454 * implementation to destroy any rules that remain when its ->destruct()
1455 * function is called. This function is not suitable for use elsewhere in an
1456 * ofproto implementation.
1458 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1459 * Cycle" in ofproto-provider.h. */
1461 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1462 OVS_EXCLUDED(ofproto_mutex)
1464 /* This skips the ofmonitor and flow-removed notifications because the
1465 * switch is being deleted and any OpenFlow channels have been or soon will
1467 ovs_mutex_lock(&ofproto_mutex);
1469 if (!rule->removed) {
1470 /* Make sure there is no postponed removal of the rule. */
1471 ovs_assert(cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
1473 if (!classifier_remove(&rule->ofproto->tables[rule->table_id].cls,
1477 ofproto_rule_remove__(rule->ofproto, rule);
1478 ofproto->ofproto_class->rule_delete(rule);
1479 ofproto_rule_unref(rule);
1481 ovs_mutex_unlock(&ofproto_mutex);
1485 ofproto_flush__(struct ofproto *ofproto)
1486 OVS_EXCLUDED(ofproto_mutex)
1488 struct oftable *table;
1490 /* This will flush all datapath flows. */
1491 if (ofproto->ofproto_class->flush) {
1492 ofproto->ofproto_class->flush(ofproto);
1495 /* XXX: There is a small race window here, where new datapath flows can be
1496 * created by upcall handlers based on the existing flow table. We can not
1497 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1498 * as then we could deadlock on syncing with the handler threads waiting on
1499 * the same mutex. */
1501 ovs_mutex_lock(&ofproto_mutex);
1502 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1503 struct rule_collection rules;
1506 if (table->flags & OFTABLE_HIDDEN) {
1510 rule_collection_init(&rules);
1512 CLS_FOR_EACH (rule, cr, &table->cls) {
1513 rule_collection_add(&rules, rule);
1515 delete_flows__(&rules, OFPRR_DELETE, NULL);
1517 /* XXX: Concurrent handler threads may insert new learned flows based on
1518 * learn actions of the now deleted flows right after we release
1519 * 'ofproto_mutex'. */
1520 ovs_mutex_unlock(&ofproto_mutex);
1523 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1526 ofproto_destroy__(struct ofproto *ofproto)
1527 OVS_EXCLUDED(ofproto_mutex)
1529 struct oftable *table;
1531 destroy_rule_executes(ofproto);
1533 guarded_list_destroy(&ofproto->rule_executes);
1534 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1535 hmap_destroy(&ofproto->groups);
1537 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1538 free(ofproto->name);
1539 free(ofproto->type);
1540 free(ofproto->mfr_desc);
1541 free(ofproto->hw_desc);
1542 free(ofproto->sw_desc);
1543 free(ofproto->serial_desc);
1544 free(ofproto->dp_desc);
1545 hmap_destroy(&ofproto->ports);
1546 hmap_destroy(&ofproto->ofport_usage);
1547 shash_destroy(&ofproto->port_by_name);
1548 simap_destroy(&ofproto->ofp_requests);
1550 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1551 oftable_destroy(table);
1553 free(ofproto->tables);
1555 ovs_assert(hindex_is_empty(&ofproto->cookies));
1556 hindex_destroy(&ofproto->cookies);
1558 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1559 hmap_destroy(&ofproto->learned_cookies);
1561 free(ofproto->vlan_bitmap);
1563 ofproto->ofproto_class->dealloc(ofproto);
1566 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1567 * - 1st we defer the removal of the rules from the classifier
1568 * - 2nd we defer the actual destruction of the rules. */
1570 ofproto_destroy_defer__(struct ofproto *ofproto)
1571 OVS_EXCLUDED(ofproto_mutex)
1573 ovsrcu_postpone(ofproto_destroy__, ofproto);
1577 ofproto_destroy(struct ofproto *p)
1578 OVS_EXCLUDED(ofproto_mutex)
1580 struct ofport *ofport, *next_ofport;
1581 struct ofport_usage *usage, *next_usage;
1588 meter_delete(p, 1, p->meter_features.max_meters);
1589 p->meter_features.max_meters = 0;
1595 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1596 ofport_destroy(ofport);
1599 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1600 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1604 p->ofproto_class->destruct(p);
1606 /* We should not postpone this because it involves deleting a listening
1607 * socket which we may want to reopen soon. 'connmgr' should not be used
1608 * by other threads */
1609 connmgr_destroy(p->connmgr);
1611 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1612 ovsrcu_postpone(ofproto_destroy_defer__, p);
1615 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1616 * kernel datapath, for example, this destroys the datapath in the kernel, and
1617 * with the netdev-based datapath, it tears down the data structures that
1618 * represent the datapath.
1620 * The datapath should not be currently open as an ofproto. */
1622 ofproto_delete(const char *name, const char *type)
1624 const struct ofproto_class *class = ofproto_class_find__(type);
1625 return (!class ? EAFNOSUPPORT
1626 : !class->del ? EACCES
1627 : class->del(type, name));
1631 process_port_change(struct ofproto *ofproto, int error, char *devname)
1633 if (error == ENOBUFS) {
1634 reinit_ports(ofproto);
1635 } else if (!error) {
1636 update_port(ofproto, devname);
1642 ofproto_type_run(const char *datapath_type)
1644 const struct ofproto_class *class;
1647 datapath_type = ofproto_normalize_type(datapath_type);
1648 class = ofproto_class_find__(datapath_type);
1650 error = class->type_run ? class->type_run(datapath_type) : 0;
1651 if (error && error != EAGAIN) {
1652 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1653 datapath_type, ovs_strerror(error));
1659 ofproto_type_wait(const char *datapath_type)
1661 const struct ofproto_class *class;
1663 datapath_type = ofproto_normalize_type(datapath_type);
1664 class = ofproto_class_find__(datapath_type);
1666 if (class->type_wait) {
1667 class->type_wait(datapath_type);
1672 ofproto_run(struct ofproto *p)
1677 error = p->ofproto_class->run(p);
1678 if (error && error != EAGAIN) {
1679 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1682 run_rule_executes(p);
1684 /* Restore the eviction group heap invariant occasionally. */
1685 if (p->eviction_group_timer < time_msec()) {
1688 p->eviction_group_timer = time_msec() + 1000;
1690 for (i = 0; i < p->n_tables; i++) {
1691 struct oftable *table = &p->tables[i];
1692 struct eviction_group *evg;
1695 if (!table->eviction_fields) {
1699 if (table->n_flows > 100000) {
1700 static struct vlog_rate_limit count_rl =
1701 VLOG_RATE_LIMIT_INIT(1, 1);
1702 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1703 " number of rules: %d", i, table->n_flows);
1706 ovs_mutex_lock(&ofproto_mutex);
1707 CLS_FOR_EACH (rule, cr, &table->cls) {
1708 if (rule->idle_timeout || rule->hard_timeout) {
1709 if (!rule->eviction_group) {
1710 eviction_group_add_rule(rule);
1712 heap_raw_change(&rule->evg_node,
1713 rule_eviction_priority(p, rule));
1718 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1719 heap_rebuild(&evg->rules);
1721 ovs_mutex_unlock(&ofproto_mutex);
1725 if (p->ofproto_class->port_poll) {
1728 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1729 process_port_change(p, error, devname);
1733 new_seq = seq_read(connectivity_seq_get());
1734 if (new_seq != p->change_seq) {
1735 struct sset devnames;
1736 const char *devname;
1737 struct ofport *ofport;
1739 /* Update OpenFlow port status for any port whose netdev has changed.
1741 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1742 * destroyed, so it's not safe to update ports directly from the
1743 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1744 * need this two-phase approach. */
1745 sset_init(&devnames);
1746 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1747 uint64_t port_change_seq;
1749 port_change_seq = netdev_get_change_seq(ofport->netdev);
1750 if (ofport->change_seq != port_change_seq) {
1751 ofport->change_seq = port_change_seq;
1752 sset_add(&devnames, netdev_get_name(ofport->netdev));
1755 SSET_FOR_EACH (devname, &devnames) {
1756 update_port(p, devname);
1758 sset_destroy(&devnames);
1760 p->change_seq = new_seq;
1763 connmgr_run(p->connmgr, handle_openflow);
1769 ofproto_wait(struct ofproto *p)
1771 p->ofproto_class->wait(p);
1772 if (p->ofproto_class->port_poll_wait) {
1773 p->ofproto_class->port_poll_wait(p);
1775 seq_wait(connectivity_seq_get(), p->change_seq);
1776 connmgr_wait(p->connmgr);
1780 ofproto_is_alive(const struct ofproto *p)
1782 return connmgr_has_controllers(p->connmgr);
1785 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1786 * memory_report(). */
1788 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1790 const struct oftable *table;
1791 unsigned int n_rules;
1793 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1796 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1797 n_rules += table->n_flows;
1799 simap_increase(usage, "rules", n_rules);
1801 if (ofproto->ofproto_class->get_memory_usage) {
1802 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1805 connmgr_get_memory_usage(ofproto->connmgr, usage);
1809 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1811 const struct ofproto_class *class;
1813 datapath_type = ofproto_normalize_type(datapath_type);
1814 class = ofproto_class_find__(datapath_type);
1816 if (class && class->type_get_memory_usage) {
1817 class->type_get_memory_usage(datapath_type, usage);
1822 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1825 connmgr_get_controller_info(ofproto->connmgr, info);
1829 ofproto_free_ofproto_controller_info(struct shash *info)
1831 connmgr_free_controller_info(info);
1834 /* Makes a deep copy of 'old' into 'port'. */
1836 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1838 port->name = xstrdup(old->name);
1839 port->type = xstrdup(old->type);
1840 port->ofp_port = old->ofp_port;
1843 /* Frees memory allocated to members of 'ofproto_port'.
1845 * Do not call this function on an ofproto_port obtained from
1846 * ofproto_port_dump_next(): that function retains ownership of the data in the
1849 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1851 free(ofproto_port->name);
1852 free(ofproto_port->type);
1855 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1857 * This function provides no status indication. An error status for the entire
1858 * dump operation is provided when it is completed by calling
1859 * ofproto_port_dump_done().
1862 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1863 const struct ofproto *ofproto)
1865 dump->ofproto = ofproto;
1866 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1870 /* Attempts to retrieve another port from 'dump', which must have been created
1871 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1872 * 'port' and returns true. On failure, returns false.
1874 * Failure might indicate an actual error or merely that the last port has been
1875 * dumped. An error status for the entire dump operation is provided when it
1876 * is completed by calling ofproto_port_dump_done().
1878 * The ofproto owns the data stored in 'port'. It will remain valid until at
1879 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1880 * ofproto_port_dump_done(). */
1882 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1883 struct ofproto_port *port)
1885 const struct ofproto *ofproto = dump->ofproto;
1891 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1894 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1900 /* Completes port table dump operation 'dump', which must have been created
1901 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1902 * error-free, otherwise a positive errno value describing the problem. */
1904 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1906 const struct ofproto *ofproto = dump->ofproto;
1908 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1911 return dump->error == EOF ? 0 : dump->error;
1914 /* Returns the type to pass to netdev_open() when a datapath of type
1915 * 'datapath_type' has a port of type 'port_type', for a few special
1916 * cases when a netdev type differs from a port type. For example, when
1917 * using the userspace datapath, a port of type "internal" needs to be
1920 * Returns either 'type' itself or a string literal, which must not be
1923 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1925 const struct ofproto_class *class;
1927 datapath_type = ofproto_normalize_type(datapath_type);
1928 class = ofproto_class_find__(datapath_type);
1933 return (class->port_open_type
1934 ? class->port_open_type(datapath_type, port_type)
1938 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1939 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1940 * the port's OpenFlow port number.
1942 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1943 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1944 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1945 * 'ofp_portp' is non-null). */
1947 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1948 ofp_port_t *ofp_portp)
1950 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1953 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1955 const char *netdev_name = netdev_get_name(netdev);
1957 simap_put(&ofproto->ofp_requests, netdev_name,
1958 ofp_to_u16(ofp_port));
1959 update_port(ofproto, netdev_name);
1962 *ofp_portp = OFPP_NONE;
1964 struct ofproto_port ofproto_port;
1966 error = ofproto_port_query_by_name(ofproto,
1967 netdev_get_name(netdev),
1970 *ofp_portp = ofproto_port.ofp_port;
1971 ofproto_port_destroy(&ofproto_port);
1978 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1979 * initializes '*port' appropriately; on failure, returns a positive errno
1982 * The caller owns the data in 'ofproto_port' and must free it with
1983 * ofproto_port_destroy() when it is no longer needed. */
1985 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1986 struct ofproto_port *port)
1990 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1992 memset(port, 0, sizeof *port);
1997 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1998 * Returns 0 if successful, otherwise a positive errno. */
2000 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
2002 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2003 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
2004 struct simap_node *ofp_request_node;
2007 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
2008 if (ofp_request_node) {
2009 simap_delete(&ofproto->ofp_requests, ofp_request_node);
2012 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
2013 if (!error && ofport) {
2014 /* 'name' is the netdev's name and update_port() is going to close the
2015 * netdev. Just in case update_port() refers to 'name' after it
2016 * destroys 'ofport', make a copy of it around the update_port()
2018 char *devname = xstrdup(name);
2019 update_port(ofproto, devname);
2026 flow_mod_init(struct ofputil_flow_mod *fm,
2027 const struct match *match, int priority,
2028 const struct ofpact *ofpacts, size_t ofpacts_len,
2029 enum ofp_flow_mod_command command)
2031 memset(fm, 0, sizeof *fm);
2033 fm->priority = priority;
2036 fm->modify_cookie = false;
2038 fm->command = command;
2039 fm->idle_timeout = 0;
2040 fm->hard_timeout = 0;
2042 fm->buffer_id = UINT32_MAX;
2043 fm->out_port = OFPP_ANY;
2044 fm->out_group = OFPG_ANY;
2046 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2047 fm->ofpacts_len = ofpacts_len;
2048 fm->delete_reason = OFPRR_DELETE;
2052 simple_flow_mod(struct ofproto *ofproto,
2053 const struct match *match, int priority,
2054 const struct ofpact *ofpacts, size_t ofpacts_len,
2055 enum ofp_flow_mod_command command)
2057 struct ofputil_flow_mod fm;
2059 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2061 return handle_flow_mod__(ofproto, &fm, NULL);
2064 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2065 * performs the 'n_actions' actions in 'actions'. The new flow will not
2068 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2069 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2070 * controllers; otherwise, it will be hidden.
2072 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2074 * This is a helper function for in-band control and fail-open. */
2076 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2078 const struct ofpact *ofpacts, size_t ofpacts_len)
2079 OVS_EXCLUDED(ofproto_mutex)
2081 const struct rule *rule;
2084 /* First do a cheap check whether the rule we're looking for already exists
2085 * with the actions that we want. If it does, then we're done. */
2086 rule = rule_from_cls_rule(classifier_find_match_exactly(
2087 &ofproto->tables[0].cls, match, priority,
2090 const struct rule_actions *actions = rule_get_actions(rule);
2091 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2092 ofpacts, ofpacts_len);
2097 /* If there's no such rule or the rule doesn't have the actions we want,
2098 * fall back to a executing a full flow mod. We can't optimize this at
2099 * all because we didn't take enough locks above to ensure that the flow
2100 * table didn't already change beneath us. */
2102 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2103 OFPFC_MODIFY_STRICT);
2107 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2108 * an OFPERR_* OpenFlow error code on failure.
2110 * This is a helper function for in-band control and fail-open and the "learn"
2113 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2114 OVS_EXCLUDED(ofproto_mutex)
2116 /* Optimize for the most common case of a repeated learn action.
2117 * If an identical flow already exists we only need to update its
2118 * 'modified' time. */
2119 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2120 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2121 struct oftable *table = &ofproto->tables[fm->table_id];
2125 rule = rule_from_cls_rule(classifier_find_match_exactly(
2126 &table->cls, &fm->match, fm->priority,
2129 /* Reading many of the rule fields and writing on 'modified'
2130 * requires the rule->mutex. Also, rule->actions may change
2131 * if rule->mutex is not held. */
2132 const struct rule_actions *actions;
2134 ovs_mutex_lock(&rule->mutex);
2135 actions = rule_get_actions(rule);
2136 if (rule->idle_timeout == fm->idle_timeout
2137 && rule->hard_timeout == fm->hard_timeout
2138 && rule->importance == fm->importance
2139 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2140 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2141 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2142 actions->ofpacts, actions->ofpacts_len)) {
2143 /* Rule already exists and need not change, only update the
2144 modified timestamp. */
2145 rule->modified = time_msec();
2148 ovs_mutex_unlock(&rule->mutex);
2156 return handle_flow_mod__(ofproto, fm, NULL);
2159 /* Searches for a rule with matching criteria exactly equal to 'target' in
2160 * ofproto's table 0 and, if it finds one, deletes it.
2162 * This is a helper function for in-band control and fail-open. */
2164 ofproto_delete_flow(struct ofproto *ofproto,
2165 const struct match *target, int priority)
2166 OVS_EXCLUDED(ofproto_mutex)
2168 struct classifier *cls = &ofproto->tables[0].cls;
2171 /* First do a cheap check whether the rule we're looking for has already
2172 * been deleted. If so, then we're done. */
2173 rule = rule_from_cls_rule(classifier_find_match_exactly(
2174 cls, target, priority, CLS_MAX_VERSION));
2179 /* Execute a flow mod. We can't optimize this at all because we didn't
2180 * take enough locks above to ensure that the flow table didn't already
2181 * change beneath us. */
2182 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2185 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2186 * the flows required by in-band control and fail-open. */
2188 ofproto_flush_flows(struct ofproto *ofproto)
2190 COVERAGE_INC(ofproto_flush);
2191 ofproto_flush__(ofproto);
2192 connmgr_flushed(ofproto->connmgr);
2196 reinit_ports(struct ofproto *p)
2198 struct ofproto_port_dump dump;
2199 struct sset devnames;
2200 struct ofport *ofport;
2201 struct ofproto_port ofproto_port;
2202 const char *devname;
2204 COVERAGE_INC(ofproto_reinit_ports);
2206 sset_init(&devnames);
2207 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2208 sset_add(&devnames, netdev_get_name(ofport->netdev));
2210 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2211 sset_add(&devnames, ofproto_port.name);
2214 SSET_FOR_EACH (devname, &devnames) {
2215 update_port(p, devname);
2217 sset_destroy(&devnames);
2221 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2225 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2226 port_idx = port_idx ? port_idx : UINT16_MAX;
2228 if (port_idx >= ofproto->max_ports
2229 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2230 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2231 long long int last_used_at, lru = LLONG_MAX;
2233 /* Search for a free OpenFlow port number. We try not to
2234 * immediately reuse them to prevent problems due to old
2237 * We limit the automatically assigned port numbers to the lower half
2238 * of the port range, to reserve the upper half for assignment by
2241 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2242 ofproto->alloc_port_no = 1;
2244 last_used_at = ofport_get_usage(ofproto,
2245 u16_to_ofp(ofproto->alloc_port_no));
2246 if (!last_used_at) {
2247 port_idx = ofproto->alloc_port_no;
2249 } else if ( last_used_at < time_msec() - 60*60*1000) {
2250 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2251 * more than an hour ago, consider it usable. */
2252 ofport_remove_usage(ofproto,
2253 u16_to_ofp(ofproto->alloc_port_no));
2254 port_idx = ofproto->alloc_port_no;
2256 } else if (last_used_at < lru) {
2258 lru_ofport = ofproto->alloc_port_no;
2261 if (ofproto->alloc_port_no == end_port_no) {
2263 port_idx = lru_ofport;
2270 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2271 return u16_to_ofp(port_idx);
2275 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2277 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2278 ofport_set_usage(ofproto, ofp_port, time_msec());
2282 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2283 * pointer if the netdev cannot be opened. On success, also fills in
2285 static struct netdev *
2286 ofport_open(struct ofproto *ofproto,
2287 struct ofproto_port *ofproto_port,
2288 struct ofputil_phy_port *pp)
2290 enum netdev_flags flags;
2291 struct netdev *netdev;
2294 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2296 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2297 "cannot be opened (%s)",
2299 ofproto_port->name, ofproto_port->ofp_port,
2300 ofproto_port->name, ovs_strerror(error));
2304 if (ofproto_port->ofp_port == OFPP_NONE) {
2305 if (!strcmp(ofproto->name, ofproto_port->name)) {
2306 ofproto_port->ofp_port = OFPP_LOCAL;
2308 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2309 ofproto_port->name);
2312 pp->port_no = ofproto_port->ofp_port;
2313 netdev_get_etheraddr(netdev, pp->hw_addr);
2314 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2315 netdev_get_flags(netdev, &flags);
2316 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2317 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2318 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2319 &pp->supported, &pp->peer);
2320 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2321 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2326 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2327 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2330 ofport_equal(const struct ofputil_phy_port *a,
2331 const struct ofputil_phy_port *b)
2333 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2334 && a->state == b->state
2335 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2336 && a->curr == b->curr
2337 && a->advertised == b->advertised
2338 && a->supported == b->supported
2339 && a->peer == b->peer
2340 && a->curr_speed == b->curr_speed
2341 && a->max_speed == b->max_speed);
2344 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2345 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2346 * one with the same name or port number). */
2348 ofport_install(struct ofproto *p,
2349 struct netdev *netdev, const struct ofputil_phy_port *pp)
2351 const char *netdev_name = netdev_get_name(netdev);
2352 struct ofport *ofport;
2355 /* Create ofport. */
2356 ofport = p->ofproto_class->port_alloc();
2361 ofport->ofproto = p;
2362 ofport->netdev = netdev;
2363 ofport->change_seq = netdev_get_change_seq(netdev);
2365 ofport->ofp_port = pp->port_no;
2366 ofport->created = time_msec();
2368 /* Add port to 'p'. */
2369 hmap_insert(&p->ports, &ofport->hmap_node,
2370 hash_ofp_port(ofport->ofp_port));
2371 shash_add(&p->port_by_name, netdev_name, ofport);
2373 update_mtu(p, ofport);
2375 /* Let the ofproto_class initialize its private data. */
2376 error = p->ofproto_class->port_construct(ofport);
2380 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2384 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2385 p->name, netdev_name, ovs_strerror(error));
2387 ofport_destroy__(ofport);
2389 netdev_close(netdev);
2393 /* Removes 'ofport' from 'p' and destroys it. */
2395 ofport_remove(struct ofport *ofport)
2397 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2399 ofport_destroy(ofport);
2402 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2405 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2407 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2409 ofport_remove(port);
2413 /* Updates 'port' with new 'pp' description.
2415 * Does not handle a name or port number change. The caller must implement
2416 * such a change as a delete followed by an add. */
2418 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2420 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2421 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2422 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2423 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2424 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2425 port->pp.curr = pp->curr;
2426 port->pp.advertised = pp->advertised;
2427 port->pp.supported = pp->supported;
2428 port->pp.peer = pp->peer;
2429 port->pp.curr_speed = pp->curr_speed;
2430 port->pp.max_speed = pp->max_speed;
2432 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2433 &port->pp, OFPPR_MODIFY);
2436 /* Update OpenFlow 'state' in 'port' and notify controller. */
2438 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2440 if (port->pp.state != state) {
2441 port->pp.state = state;
2442 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2443 &port->pp, OFPPR_MODIFY);
2448 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2450 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2452 if (port->ofproto->ofproto_class->set_realdev) {
2453 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2455 if (port->ofproto->ofproto_class->set_stp_port) {
2456 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2458 if (port->ofproto->ofproto_class->set_rstp_port) {
2459 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2461 if (port->ofproto->ofproto_class->set_cfm) {
2462 port->ofproto->ofproto_class->set_cfm(port, NULL);
2464 if (port->ofproto->ofproto_class->bundle_remove) {
2465 port->ofproto->ofproto_class->bundle_remove(port);
2471 ofport_destroy__(struct ofport *port)
2473 struct ofproto *ofproto = port->ofproto;
2474 const char *name = netdev_get_name(port->netdev);
2476 hmap_remove(&ofproto->ports, &port->hmap_node);
2477 shash_delete(&ofproto->port_by_name,
2478 shash_find(&ofproto->port_by_name, name));
2480 netdev_close(port->netdev);
2481 ofproto->ofproto_class->port_dealloc(port);
2485 ofport_destroy(struct ofport *port)
2488 dealloc_ofp_port(port->ofproto, port->ofp_port);
2489 port->ofproto->ofproto_class->port_destruct(port);
2490 ofport_destroy__(port);
2495 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2497 struct ofport *port;
2499 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2501 if (port->ofp_port == ofp_port) {
2508 static long long int
2509 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2511 struct ofport_usage *usage;
2513 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2514 &ofproto->ofport_usage) {
2515 if (usage->ofp_port == ofp_port) {
2516 return usage->last_used;
2523 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2524 long long int last_used)
2526 struct ofport_usage *usage;
2527 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2528 &ofproto->ofport_usage) {
2529 if (usage->ofp_port == ofp_port) {
2530 usage->last_used = last_used;
2534 ovs_assert(last_used == LLONG_MAX);
2536 usage = xmalloc(sizeof *usage);
2537 usage->ofp_port = ofp_port;
2538 usage->last_used = last_used;
2539 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2540 hash_ofp_port(ofp_port));
2544 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2546 struct ofport_usage *usage;
2547 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2548 &ofproto->ofport_usage) {
2549 if (usage->ofp_port == ofp_port) {
2550 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2558 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2560 struct ofproto *ofproto = port->ofproto;
2563 if (ofproto->ofproto_class->port_get_stats) {
2564 error = ofproto->ofproto_class->port_get_stats(port, stats);
2573 update_port(struct ofproto *ofproto, const char *name)
2575 struct ofproto_port ofproto_port;
2576 struct ofputil_phy_port pp;
2577 struct netdev *netdev;
2578 struct ofport *port;
2580 COVERAGE_INC(ofproto_update_port);
2582 /* Fetch 'name''s location and properties from the datapath. */
2583 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2584 ? ofport_open(ofproto, &ofproto_port, &pp)
2588 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2589 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2590 struct netdev *old_netdev = port->netdev;
2592 /* 'name' hasn't changed location. Any properties changed? */
2593 if (!ofport_equal(&port->pp, &pp)) {
2594 ofport_modified(port, &pp);
2597 update_mtu(ofproto, port);
2599 /* Install the newly opened netdev in case it has changed.
2600 * Don't close the old netdev yet in case port_modified has to
2601 * remove a retained reference to it.*/
2602 port->netdev = netdev;
2603 port->change_seq = netdev_get_change_seq(netdev);
2605 if (port->ofproto->ofproto_class->port_modified) {
2606 port->ofproto->ofproto_class->port_modified(port);
2609 netdev_close(old_netdev);
2611 /* If 'port' is nonnull then its name differs from 'name' and thus
2612 * we should delete it. If we think there's a port named 'name'
2613 * then its port number must be wrong now so delete it too. */
2615 ofport_remove(port);
2617 ofport_remove_with_name(ofproto, name);
2618 ofport_install(ofproto, netdev, &pp);
2621 /* Any port named 'name' is gone now. */
2622 ofport_remove_with_name(ofproto, name);
2624 ofproto_port_destroy(&ofproto_port);
2628 init_ports(struct ofproto *p)
2630 struct ofproto_port_dump dump;
2631 struct ofproto_port ofproto_port;
2632 struct shash_node *node, *next;
2634 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2635 const char *name = ofproto_port.name;
2637 if (shash_find(&p->port_by_name, name)) {
2638 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2641 struct ofputil_phy_port pp;
2642 struct netdev *netdev;
2644 /* Check if an OpenFlow port number had been requested. */
2645 node = shash_find(&init_ofp_ports, name);
2647 const struct iface_hint *iface_hint = node->data;
2648 simap_put(&p->ofp_requests, name,
2649 ofp_to_u16(iface_hint->ofp_port));
2652 netdev = ofport_open(p, &ofproto_port, &pp);
2654 ofport_install(p, netdev, &pp);
2655 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2656 p->alloc_port_no = MAX(p->alloc_port_no,
2657 ofp_to_u16(ofproto_port.ofp_port));
2663 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2664 struct iface_hint *iface_hint = node->data;
2666 if (!strcmp(iface_hint->br_name, p->name)) {
2667 free(iface_hint->br_name);
2668 free(iface_hint->br_type);
2670 shash_delete(&init_ofp_ports, node);
2677 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2678 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2680 find_min_mtu(struct ofproto *p)
2682 struct ofport *ofport;
2685 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2686 struct netdev *netdev = ofport->netdev;
2689 /* Skip any internal ports, since that's what we're trying to
2691 if (!strcmp(netdev_get_type(netdev), "internal")) {
2695 if (netdev_get_mtu(netdev, &dev_mtu)) {
2698 if (!mtu || dev_mtu < mtu) {
2703 return mtu ? mtu: ETH_PAYLOAD_MAX;
2706 /* Update MTU of all datapath devices on 'p' to the minimum of the
2707 * non-datapath ports in event of 'port' added or changed. */
2709 update_mtu(struct ofproto *p, struct ofport *port)
2711 struct ofport *ofport;
2712 struct netdev *netdev = port->netdev;
2713 int dev_mtu, old_min;
2715 if (netdev_get_mtu(netdev, &dev_mtu)) {
2719 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2720 if (dev_mtu > p->min_mtu) {
2721 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2722 dev_mtu = p->min_mtu;
2725 port->mtu = dev_mtu;
2729 /* For non-internal port find new min mtu. */
2730 old_min = p->min_mtu;
2731 port->mtu = dev_mtu;
2732 p->min_mtu = find_min_mtu(p);
2733 if (p->min_mtu == old_min) {
2737 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2738 struct netdev *netdev = ofport->netdev;
2740 if (!strcmp(netdev_get_type(netdev), "internal")) {
2741 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2742 ofport->mtu = p->min_mtu;
2749 ofproto_rule_destroy__(struct rule *rule)
2750 OVS_NO_THREAD_SAFETY_ANALYSIS
2752 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2753 rule_actions_destroy(rule_get_actions(rule));
2754 ovs_mutex_destroy(&rule->mutex);
2755 rule->ofproto->ofproto_class->rule_dealloc(rule);
2759 rule_destroy_cb(struct rule *rule)
2760 OVS_NO_THREAD_SAFETY_ANALYSIS
2762 /* Send rule removed if needed. */
2763 if (rule->flags & OFPUTIL_FF_SEND_FLOW_REM
2764 && rule->removed_reason != OVS_OFPRR_NONE
2765 && !rule_is_hidden(rule)) {
2766 ofproto_rule_send_removed(rule);
2768 rule->ofproto->ofproto_class->rule_destruct(rule);
2769 ofproto_rule_destroy__(rule);
2773 ofproto_rule_ref(struct rule *rule)
2776 ovs_refcount_ref(&rule->ref_count);
2781 ofproto_rule_try_ref(struct rule *rule)
2784 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2789 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2790 * ref_count reaches 0.
2792 * Use of RCU allows short term use (between RCU quiescent periods) without
2793 * keeping a reference. A reference must be taken if the rule needs to
2794 * stay around accross the RCU quiescent periods. */
2796 ofproto_rule_unref(struct rule *rule)
2798 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2799 ovsrcu_postpone(rule_destroy_cb, rule);
2804 remove_rule_rcu__(struct rule *rule)
2805 OVS_REQUIRES(ofproto_mutex)
2807 struct ofproto *ofproto = rule->ofproto;
2808 struct oftable *table = &ofproto->tables[rule->table_id];
2810 ovs_assert(!cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
2811 if (!classifier_remove(&table->cls, &rule->cr)) {
2814 ofproto->ofproto_class->rule_delete(rule);
2815 ofproto_rule_unref(rule);
2819 remove_rule_rcu(struct rule *rule)
2820 OVS_EXCLUDED(ofproto_mutex)
2822 ovs_mutex_lock(&ofproto_mutex);
2823 remove_rule_rcu__(rule);
2824 ovs_mutex_unlock(&ofproto_mutex);
2827 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2829 remove_rules_rcu(struct rule **rules)
2830 OVS_EXCLUDED(ofproto_mutex)
2832 struct rule **orig_rules = rules;
2835 struct ofproto *ofproto = rules[0]->ofproto;
2836 unsigned long tables[BITMAP_N_LONGS(256)];
2840 memset(tables, 0, sizeof tables);
2842 ovs_mutex_lock(&ofproto_mutex);
2843 while ((rule = *rules++)) {
2844 /* Defer once for each new table. This defers the subtable cleanup
2845 * until later, so that when removing large number of flows the
2846 * operation is faster. */
2847 if (!bitmap_is_set(tables, rule->table_id)) {
2848 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
2850 bitmap_set1(tables, rule->table_id);
2851 classifier_defer(cls);
2853 remove_rule_rcu__(rule);
2856 BITMAP_FOR_EACH_1(table_id, 256, tables) {
2857 struct classifier *cls = &ofproto->tables[table_id].cls;
2859 classifier_publish(cls);
2861 ovs_mutex_unlock(&ofproto_mutex);
2868 ofproto_group_ref(struct ofgroup *group)
2871 ovs_refcount_ref(&group->ref_count);
2876 ofproto_group_unref(struct ofgroup *group)
2878 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2879 group->ofproto->ofproto_class->group_destruct(group);
2880 ofputil_bucket_list_destroy(&group->buckets);
2881 group->ofproto->ofproto_class->group_dealloc(group);
2885 static uint32_t get_provider_meter_id(const struct ofproto *,
2886 uint32_t of_meter_id);
2888 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2889 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2890 const struct rule_actions *
2891 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2893 struct rule_actions *actions;
2895 actions = xmalloc(sizeof *actions + ofpacts_len);
2896 actions->ofpacts_len = ofpacts_len;
2897 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2898 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2900 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2906 /* Free the actions after the RCU quiescent period is reached. */
2908 rule_actions_destroy(const struct rule_actions *actions)
2911 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2915 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2916 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2918 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2919 OVS_REQUIRES(ofproto_mutex)
2921 if (port == OFPP_ANY) {
2924 const struct rule_actions *actions = rule_get_actions(rule);
2925 return ofpacts_output_to_port(actions->ofpacts,
2926 actions->ofpacts_len, port);
2930 /* Returns true if 'rule' has group and equals group_id. */
2932 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2933 OVS_REQUIRES(ofproto_mutex)
2935 if (group_id == OFPG_ANY) {
2938 const struct rule_actions *actions = rule_get_actions(rule);
2939 return ofpacts_output_to_group(actions->ofpacts,
2940 actions->ofpacts_len, group_id);
2945 rule_execute_destroy(struct rule_execute *e)
2947 ofproto_rule_unref(e->rule);
2948 list_remove(&e->list_node);
2952 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2953 * by passing them to the ofproto provider. */
2955 run_rule_executes(struct ofproto *ofproto)
2956 OVS_EXCLUDED(ofproto_mutex)
2958 struct rule_execute *e, *next;
2959 struct ovs_list executes;
2961 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2962 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2965 flow_extract(e->packet, &flow);
2966 flow.in_port.ofp_port = e->in_port;
2967 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2969 rule_execute_destroy(e);
2973 /* Destroys and discards all "rule_execute" operations queued up in
2974 * ofproto->rule_executes. */
2976 destroy_rule_executes(struct ofproto *ofproto)
2978 struct rule_execute *e, *next;
2979 struct ovs_list executes;
2981 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2982 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2983 dp_packet_delete(e->packet);
2984 rule_execute_destroy(e);
2989 rule_is_readonly(const struct rule *rule)
2991 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2992 return (table->flags & OFTABLE_READONLY) != 0;
2996 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2998 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2999 return hash_3words(cookie, cookie >> 32, table_id);
3003 learned_cookies_update_one__(struct ofproto *ofproto,
3004 const struct ofpact_learn *learn,
3005 int delta, struct ovs_list *dead_cookies)
3006 OVS_REQUIRES(ofproto_mutex)
3008 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
3009 struct learned_cookie *c;
3011 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
3012 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
3014 ovs_assert(c->n >= 0);
3017 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
3018 list_push_back(dead_cookies, &c->u.list_node);
3025 ovs_assert(delta > 0);
3026 c = xmalloc(sizeof *c);
3027 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
3028 c->cookie = learn->cookie;
3029 c->table_id = learn->table_id;
3033 static const struct ofpact_learn *
3034 next_learn_with_delete(const struct rule_actions *actions,
3035 const struct ofpact_learn *start)
3037 const struct ofpact *pos;
3039 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
3040 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
3041 pos = ofpact_next(pos)) {
3042 if (pos->type == OFPACT_LEARN) {
3043 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
3044 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3054 learned_cookies_update__(struct ofproto *ofproto,
3055 const struct rule_actions *actions,
3056 int delta, struct ovs_list *dead_cookies)
3057 OVS_REQUIRES(ofproto_mutex)
3059 if (actions->has_learn_with_delete) {
3060 const struct ofpact_learn *learn;
3062 for (learn = next_learn_with_delete(actions, NULL); learn;
3063 learn = next_learn_with_delete(actions, learn)) {
3064 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3070 learned_cookies_inc(struct ofproto *ofproto,
3071 const struct rule_actions *actions)
3072 OVS_REQUIRES(ofproto_mutex)
3074 learned_cookies_update__(ofproto, actions, +1, NULL);
3078 learned_cookies_dec(struct ofproto *ofproto,
3079 const struct rule_actions *actions,
3080 struct ovs_list *dead_cookies)
3081 OVS_REQUIRES(ofproto_mutex)
3083 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3087 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3088 OVS_REQUIRES(ofproto_mutex)
3090 struct learned_cookie *c;
3092 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3093 struct rule_criteria criteria;
3094 struct rule_collection rules;
3097 match_init_catchall(&match);
3098 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3099 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3100 rule_criteria_require_rw(&criteria, false);
3101 collect_rules_loose(ofproto, &criteria, &rules);
3102 rule_criteria_destroy(&criteria);
3103 delete_flows__(&rules, OFPRR_DELETE, NULL);
3110 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3112 ofconn_send_reply(ofconn, make_echo_reply(oh));
3117 query_tables(struct ofproto *ofproto,
3118 struct ofputil_table_features **featuresp,
3119 struct ofputil_table_stats **statsp)
3121 struct mf_bitmap rw_fields = oxm_writable_fields();
3122 struct mf_bitmap match = oxm_matchable_fields();
3123 struct mf_bitmap mask = oxm_maskable_fields();
3125 struct ofputil_table_features *features;
3126 struct ofputil_table_stats *stats;
3129 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3130 for (i = 0; i < ofproto->n_tables; i++) {
3131 struct ofputil_table_features *f = &features[i];
3134 sprintf(f->name, "table%d", i);
3135 f->metadata_match = OVS_BE64_MAX;
3136 f->metadata_write = OVS_BE64_MAX;
3137 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3138 f->max_entries = 1000000;
3140 bool more_tables = false;
3141 for (int j = i + 1; j < ofproto->n_tables; j++) {
3142 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3143 bitmap_set1(f->nonmiss.next, j);
3147 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3149 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3151 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3152 f->nonmiss.write.set_fields = rw_fields;
3153 f->nonmiss.apply = f->nonmiss.write;
3154 f->miss = f->nonmiss;
3158 f->wildcard = match;
3162 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3163 for (i = 0; i < ofproto->n_tables; i++) {
3164 struct ofputil_table_stats *s = &stats[i];
3167 s->active_count = ofproto->tables[i].n_flows;
3169 s->active_count -= connmgr_count_hidden_rules(
3177 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3179 for (i = 0; i < ofproto->n_tables; i++) {
3180 const struct oftable *table = &ofproto->tables[i];
3181 struct ofputil_table_features *f = &features[i];
3184 ovs_strzcpy(f->name, table->name, sizeof f->name);
3187 if (table->max_flows < f->max_entries) {
3188 f->max_entries = table->max_flows;
3194 query_switch_features(struct ofproto *ofproto,
3195 bool *arp_match_ip, uint64_t *ofpacts)
3197 struct ofputil_table_features *features, *f;
3199 *arp_match_ip = false;
3202 query_tables(ofproto, &features, NULL);
3203 for (f = features; f < &features[ofproto->n_tables]; f++) {
3204 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3205 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3206 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3207 *arp_match_ip = true;
3213 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3217 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3219 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3220 struct ofputil_switch_features features;
3221 struct ofport *port;
3225 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3227 features.datapath_id = ofproto->datapath_id;
3228 features.n_buffers = pktbuf_capacity();
3229 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3230 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3231 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3232 OFPUTIL_C_GROUP_STATS);
3234 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3236 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3237 features.auxiliary_id = 0;
3238 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3240 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3241 ofputil_put_switch_features_port(&port->pp, b);
3244 ofconn_send_reply(ofconn, b);
3249 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3251 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3252 struct ofp_switch_config *osc;
3253 enum ofp_config_flags flags;
3257 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3258 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3259 flags = ofproto->frag_handling;
3260 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3261 if (oh->version < OFP13_VERSION
3262 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3263 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3265 osc->flags = htons(flags);
3266 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3267 ofconn_send_reply(ofconn, buf);
3273 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3275 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3276 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3277 uint16_t flags = ntohs(osc->flags);
3279 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3280 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3281 enum ofp_config_flags cur = ofproto->frag_handling;
3282 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3284 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3286 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3287 ofproto->frag_handling = next;
3289 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3291 ofputil_frag_handling_to_string(next));
3295 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3296 ofconn_set_invalid_ttl_to_controller(ofconn,
3297 (oh->version < OFP13_VERSION
3298 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3300 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3305 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3306 * error message code for the caller to propagate upward. Otherwise, returns
3309 * The log message mentions 'msg_type'. */
3311 reject_slave_controller(struct ofconn *ofconn)
3313 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3314 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3315 return OFPERR_OFPBRC_IS_SLAVE;
3321 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3324 * - If they use a meter, then 'ofproto' has that meter configured.
3326 * - If they use any groups, then 'ofproto' has that group configured.
3328 * Returns 0 if successful, otherwise an OpenFlow error. */
3330 ofproto_check_ofpacts(struct ofproto *ofproto,
3331 const struct ofpact ofpacts[], size_t ofpacts_len)
3333 const struct ofpact *a;
3336 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3337 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3338 return OFPERR_OFPMMFC_INVALID_METER;
3341 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3342 if (a->type == OFPACT_GROUP
3343 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3344 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3352 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3354 struct ofproto *p = ofconn_get_ofproto(ofconn);
3355 struct ofputil_packet_out po;
3356 struct dp_packet *payload;
3357 uint64_t ofpacts_stub[1024 / 8];
3358 struct ofpbuf ofpacts;
3362 COVERAGE_INC(ofproto_packet_out);
3364 error = reject_slave_controller(ofconn);
3369 /* Decode message. */
3370 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3371 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3373 goto exit_free_ofpacts;
3375 if (ofp_to_u16(po.in_port) >= p->max_ports
3376 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3377 error = OFPERR_OFPBRC_BAD_PORT;
3378 goto exit_free_ofpacts;
3382 if (po.buffer_id != UINT32_MAX) {
3383 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3384 if (error || !payload) {
3385 goto exit_free_ofpacts;
3388 /* Ensure that the L3 header is 32-bit aligned. */
3389 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3392 /* Verify actions against packet, then send packet if successful. */
3393 flow_extract(payload, &flow);
3394 flow.in_port.ofp_port = po.in_port;
3395 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3397 error = p->ofproto_class->packet_out(p, payload, &flow,
3398 po.ofpacts, po.ofpacts_len);
3400 dp_packet_delete(payload);
3403 ofpbuf_uninit(&ofpacts);
3409 update_port_config(struct ofconn *ofconn, struct ofport *port,
3410 enum ofputil_port_config config,
3411 enum ofputil_port_config mask)
3413 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3415 if (toggle & OFPUTIL_PC_PORT_DOWN
3416 && (config & OFPUTIL_PC_PORT_DOWN
3417 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3418 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3419 /* We tried to bring the port up or down, but it failed, so don't
3420 * update the "down" bit. */
3421 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3425 enum ofputil_port_config old_config = port->pp.config;
3426 port->pp.config ^= toggle;
3427 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3428 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3434 port_mod_start(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3435 struct ofport **port)
3437 struct ofproto *p = ofconn_get_ofproto(ofconn);
3439 *port = ofproto_get_port(p, pm->port_no);
3441 return OFPERR_OFPPMFC_BAD_PORT;
3443 if (!eth_addr_equals((*port)->pp.hw_addr, pm->hw_addr)) {
3444 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3450 port_mod_finish(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3451 struct ofport *port)
3453 update_port_config(ofconn, port, pm->config, pm->mask);
3454 if (pm->advertise) {
3455 netdev_set_advertisements(port->netdev, pm->advertise);
3460 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3462 struct ofputil_port_mod pm;
3463 struct ofport *port;
3466 error = reject_slave_controller(ofconn);
3471 error = ofputil_decode_port_mod(oh, &pm, false);
3476 error = port_mod_start(ofconn, &pm, &port);
3478 port_mod_finish(ofconn, &pm, port);
3484 handle_desc_stats_request(struct ofconn *ofconn,
3485 const struct ofp_header *request)
3487 static const char *default_mfr_desc = "Nicira, Inc.";
3488 static const char *default_hw_desc = "Open vSwitch";
3489 static const char *default_sw_desc = VERSION;
3490 static const char *default_serial_desc = "None";
3491 static const char *default_dp_desc = "None";
3493 struct ofproto *p = ofconn_get_ofproto(ofconn);
3494 struct ofp_desc_stats *ods;
3497 msg = ofpraw_alloc_stats_reply(request, 0);
3498 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3499 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3500 sizeof ods->mfr_desc);
3501 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3502 sizeof ods->hw_desc);
3503 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3504 sizeof ods->sw_desc);
3505 ovs_strlcpy(ods->serial_num,
3506 p->serial_desc ? p->serial_desc : default_serial_desc,
3507 sizeof ods->serial_num);
3508 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3509 sizeof ods->dp_desc);
3510 ofconn_send_reply(ofconn, msg);
3516 handle_table_stats_request(struct ofconn *ofconn,
3517 const struct ofp_header *request)
3519 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3520 struct ofputil_table_features *features;
3521 struct ofputil_table_stats *stats;
3522 struct ofpbuf *reply;
3525 query_tables(ofproto, &features, &stats);
3527 reply = ofputil_encode_table_stats_reply(request);
3528 for (i = 0; i < ofproto->n_tables; i++) {
3529 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3530 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3533 ofconn_send_reply(ofconn, reply);
3542 handle_table_features_request(struct ofconn *ofconn,
3543 const struct ofp_header *request)
3545 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3546 struct ofputil_table_features *features;
3547 struct ovs_list replies;
3551 ofpbuf_use_const(&msg, request, ntohs(request->length));
3552 ofpraw_pull_assert(&msg);
3553 if (msg.size || ofpmp_more(request)) {
3554 return OFPERR_OFPTFFC_EPERM;
3557 query_tables(ofproto, &features, NULL);
3559 ofpmp_init(&replies, request);
3560 for (i = 0; i < ofproto->n_tables; i++) {
3561 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3562 ofputil_append_table_features_reply(&features[i], &replies);
3565 ofconn_send_replies(ofconn, &replies);
3573 append_port_stat(struct ofport *port, struct ovs_list *replies)
3575 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3577 calc_duration(port->created, time_msec(),
3578 &ops.duration_sec, &ops.duration_nsec);
3580 /* Intentionally ignore return value, since errors will set
3581 * 'stats' to all-1s, which is correct for OpenFlow, and
3582 * netdev_get_stats() will log errors. */
3583 ofproto_port_get_stats(port, &ops.stats);
3585 ofputil_append_port_stat(replies, &ops);
3589 handle_port_request(struct ofconn *ofconn,
3590 const struct ofp_header *request, ofp_port_t port_no,
3591 void (*cb)(struct ofport *, struct ovs_list *replies))
3593 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3594 struct ofport *port;
3595 struct ovs_list replies;
3597 ofpmp_init(&replies, request);
3598 if (port_no != OFPP_ANY) {
3599 port = ofproto_get_port(ofproto, port_no);
3604 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3609 ofconn_send_replies(ofconn, &replies);
3613 handle_port_stats_request(struct ofconn *ofconn,
3614 const struct ofp_header *request)
3619 error = ofputil_decode_port_stats_request(request, &port_no);
3621 handle_port_request(ofconn, request, port_no, append_port_stat);
3627 append_port_desc(struct ofport *port, struct ovs_list *replies)
3629 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3633 handle_port_desc_stats_request(struct ofconn *ofconn,
3634 const struct ofp_header *request)
3639 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3641 handle_port_request(ofconn, request, port_no, append_port_desc);
3647 hash_cookie(ovs_be64 cookie)
3649 return hash_uint64((OVS_FORCE uint64_t)cookie);
3653 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3654 OVS_REQUIRES(ofproto_mutex)
3656 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3657 hash_cookie(rule->flow_cookie));
3661 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3662 OVS_REQUIRES(ofproto_mutex)
3664 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3668 calc_duration(long long int start, long long int now,
3669 uint32_t *sec, uint32_t *nsec)
3671 long long int msecs = now - start;
3672 *sec = msecs / 1000;
3673 *nsec = (msecs % 1000) * (1000 * 1000);
3676 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3677 * true if 'table_id' is OK, false otherwise. */
3679 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3681 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3684 static struct oftable *
3685 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3687 struct oftable *table;
3689 for (table = &ofproto->tables[table_id];
3690 table < &ofproto->tables[ofproto->n_tables];
3692 if (!(table->flags & OFTABLE_HIDDEN)) {
3700 static struct oftable *
3701 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3703 if (table_id == 0xff) {
3704 return next_visible_table(ofproto, 0);
3705 } else if (table_id < ofproto->n_tables) {
3706 return &ofproto->tables[table_id];
3712 static struct oftable *
3713 next_matching_table(const struct ofproto *ofproto,
3714 const struct oftable *table, uint8_t table_id)
3716 return (table_id == 0xff
3717 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3721 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3723 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3724 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3726 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3727 * only once, for that table. (This can be used to access tables marked
3730 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3731 * entered at all. (Perhaps you should have validated TABLE_ID with
3732 * check_table_id().)
3734 * All parameters are evaluated multiple times.
3736 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3737 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3739 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3741 /* Initializes 'criteria' in a straightforward way based on the other
3744 * By default, the criteria include flows that are read-only, on the assumption
3745 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3746 * if flows will be modified.
3748 * For "loose" matching, the 'priority' parameter is unimportant and may be
3751 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3752 const struct match *match, int priority,
3753 cls_version_t version, ovs_be64 cookie,
3754 ovs_be64 cookie_mask, ofp_port_t out_port,
3757 criteria->table_id = table_id;
3758 cls_rule_init(&criteria->cr, match, priority, version);
3759 criteria->cookie = cookie;
3760 criteria->cookie_mask = cookie_mask;
3761 criteria->out_port = out_port;
3762 criteria->out_group = out_group;
3764 /* We ordinarily want to skip hidden rules, but there has to be a way for
3765 * code internal to OVS to modify and delete them, so if the criteria
3766 * specify a priority that can only be for a hidden flow, then allow hidden
3767 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3768 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3770 criteria->include_hidden = priority > UINT16_MAX;
3772 /* We assume that the criteria are being used to collect flows for reading
3773 * but not modification. Thus, we should collect read-only flows. */
3774 criteria->include_readonly = true;
3777 /* By default, criteria initialized by rule_criteria_init() will match flows
3778 * that are read-only, on the assumption that the collected flows won't be
3779 * modified. Call this function to match only flows that are be modifiable.
3781 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3782 * caller has special privileges that allow it to modify even "read-only"
3785 rule_criteria_require_rw(struct rule_criteria *criteria,
3786 bool can_write_readonly)
3788 criteria->include_readonly = can_write_readonly;
3792 rule_criteria_destroy(struct rule_criteria *criteria)
3794 cls_rule_destroy(&criteria->cr);
3798 rule_collection_init(struct rule_collection *rules)
3800 rules->rules = rules->stub;
3802 rules->capacity = ARRAY_SIZE(rules->stub);
3806 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3808 if (rules->n >= rules->capacity) {
3809 size_t old_size, new_size;
3811 old_size = rules->capacity * sizeof *rules->rules;
3812 rules->capacity *= 2;
3813 new_size = rules->capacity * sizeof *rules->rules;
3815 if (rules->rules == rules->stub) {
3816 rules->rules = xmalloc(new_size);
3817 memcpy(rules->rules, rules->stub, old_size);
3819 rules->rules = xrealloc(rules->rules, new_size);
3823 rules->rules[rules->n++] = rule;
3827 rule_collection_ref(struct rule_collection *rules)
3828 OVS_REQUIRES(ofproto_mutex)
3832 for (i = 0; i < rules->n; i++) {
3833 ofproto_rule_ref(rules->rules[i]);
3838 rule_collection_unref(struct rule_collection *rules)
3842 for (i = 0; i < rules->n; i++) {
3843 ofproto_rule_unref(rules->rules[i]);
3847 /* Returns a NULL-terminated array of rule pointers,
3848 * destroys 'rules'. */
3849 static struct rule **
3850 rule_collection_detach(struct rule_collection *rules)
3852 struct rule **rule_array;
3854 rule_collection_add(rules, NULL);
3856 if (rules->rules == rules->stub) {
3857 rules->rules = xmemdup(rules->rules, rules->n * sizeof *rules->rules);
3860 rule_array = rules->rules;
3861 rule_collection_init(rules);
3867 rule_collection_destroy(struct rule_collection *rules)
3869 if (rules->rules != rules->stub) {
3873 /* Make repeated destruction harmless. */
3874 rule_collection_init(rules);
3877 /* Schedules postponed removal of rules, destroys 'rules'. */
3879 rule_collection_remove_postponed(struct rule_collection *rules)
3880 OVS_REQUIRES(ofproto_mutex)
3883 if (rules->n == 1) {
3884 ovsrcu_postpone(remove_rule_rcu, rules->rules[0]);
3886 ovsrcu_postpone(remove_rules_rcu, rule_collection_detach(rules));
3891 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3892 * function verifies most of the criteria in 'c' itself, but the caller must
3893 * check 'c->cr' itself.
3895 * Rules that have already been marked for removal are not collected.
3897 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3898 * 'c' only includes modifiable rules). */
3900 collect_rule(struct rule *rule, const struct rule_criteria *c,
3901 struct rule_collection *rules, size_t *n_readonly)
3902 OVS_REQUIRES(ofproto_mutex)
3904 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3905 && ofproto_rule_has_out_port(rule, c->out_port)
3906 && ofproto_rule_has_out_group(rule, c->out_group)
3907 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3908 && (!rule_is_hidden(rule) || c->include_hidden)
3909 && cls_rule_visible_in_version(&rule->cr, c->cr.version)) {
3910 /* Rule matches all the criteria... */
3911 if (!rule_is_readonly(rule) || c->include_readonly) {
3913 rule_collection_add(rules, rule);
3915 /* ...except it's read-only. */
3921 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3922 * on classifiers rules are done in the "loose" way required for OpenFlow
3923 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3926 * Returns 0 on success, otherwise an OpenFlow error code. */
3928 collect_rules_loose(struct ofproto *ofproto,
3929 const struct rule_criteria *criteria,
3930 struct rule_collection *rules)
3931 OVS_REQUIRES(ofproto_mutex)
3933 struct oftable *table;
3934 enum ofperr error = 0;
3935 size_t n_readonly = 0;
3937 rule_collection_init(rules);
3939 if (!check_table_id(ofproto, criteria->table_id)) {
3940 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3944 if (criteria->cookie_mask == OVS_BE64_MAX) {
3947 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3948 hash_cookie(criteria->cookie),
3949 &ofproto->cookies) {
3950 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3951 collect_rule(rule, criteria, rules, &n_readonly);
3955 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3958 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3959 collect_rule(rule, criteria, rules, &n_readonly);
3965 if (!error && !rules->n && n_readonly) {
3966 /* We didn't find any rules to modify. We did find some read-only
3967 * rules that we're not allowed to modify, so report that. */
3968 error = OFPERR_OFPBRC_EPERM;
3971 rule_collection_destroy(rules);
3976 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3977 * on classifiers rules are done in the "strict" way required for OpenFlow
3978 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3979 * rules on list 'rules'.
3981 * Returns 0 on success, otherwise an OpenFlow error code. */
3983 collect_rules_strict(struct ofproto *ofproto,
3984 const struct rule_criteria *criteria,
3985 struct rule_collection *rules)
3986 OVS_REQUIRES(ofproto_mutex)
3988 struct oftable *table;
3989 size_t n_readonly = 0;
3990 enum ofperr error = 0;
3992 rule_collection_init(rules);
3994 if (!check_table_id(ofproto, criteria->table_id)) {
3995 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3999 if (criteria->cookie_mask == OVS_BE64_MAX) {
4002 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4003 hash_cookie(criteria->cookie),
4004 &ofproto->cookies) {
4005 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
4006 collect_rule(rule, criteria, rules, &n_readonly);
4010 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4013 rule = rule_from_cls_rule(classifier_find_rule_exactly(
4014 &table->cls, &criteria->cr));
4016 collect_rule(rule, criteria, rules, &n_readonly);
4022 if (!error && !rules->n && n_readonly) {
4023 /* We didn't find any rules to modify. We did find some read-only
4024 * rules that we're not allowed to modify, so report that. */
4025 error = OFPERR_OFPBRC_EPERM;
4028 rule_collection_destroy(rules);
4033 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4034 * forced into the range of a uint16_t. */
4036 age_secs(long long int age_ms)
4038 return (age_ms < 0 ? 0
4039 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
4040 : (unsigned int) age_ms / 1000);
4044 handle_flow_stats_request(struct ofconn *ofconn,
4045 const struct ofp_header *request)
4046 OVS_EXCLUDED(ofproto_mutex)
4048 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4049 struct ofputil_flow_stats_request fsr;
4050 struct rule_criteria criteria;
4051 struct rule_collection rules;
4052 struct ovs_list replies;
4056 error = ofputil_decode_flow_stats_request(&fsr, request);
4061 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
4062 fsr.cookie, fsr.cookie_mask, fsr.out_port,
4065 ovs_mutex_lock(&ofproto_mutex);
4066 error = collect_rules_loose(ofproto, &criteria, &rules);
4067 rule_criteria_destroy(&criteria);
4069 rule_collection_ref(&rules);
4071 ovs_mutex_unlock(&ofproto_mutex);
4077 ofpmp_init(&replies, request);
4078 for (i = 0; i < rules.n; i++) {
4079 struct rule *rule = rules.rules[i];
4080 long long int now = time_msec();
4081 struct ofputil_flow_stats fs;
4082 long long int created, used, modified;
4083 const struct rule_actions *actions;
4084 enum ofputil_flow_mod_flags flags;
4086 ovs_mutex_lock(&rule->mutex);
4087 fs.cookie = rule->flow_cookie;
4088 fs.idle_timeout = rule->idle_timeout;
4089 fs.hard_timeout = rule->hard_timeout;
4090 fs.importance = rule->importance;
4091 created = rule->created;
4092 modified = rule->modified;
4093 actions = rule_get_actions(rule);
4094 flags = rule->flags;
4095 ovs_mutex_unlock(&rule->mutex);
4097 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
4098 &fs.byte_count, &used);
4100 minimatch_expand(&rule->cr.match, &fs.match);
4101 fs.table_id = rule->table_id;
4102 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4103 fs.priority = rule->cr.priority;
4104 fs.idle_age = age_secs(now - used);
4105 fs.hard_age = age_secs(now - modified);
4106 fs.ofpacts = actions->ofpacts;
4107 fs.ofpacts_len = actions->ofpacts_len;
4110 ofputil_append_flow_stats_reply(&fs, &replies);
4113 rule_collection_unref(&rules);
4114 rule_collection_destroy(&rules);
4116 ofconn_send_replies(ofconn, &replies);
4122 flow_stats_ds(struct rule *rule, struct ds *results)
4124 uint64_t packet_count, byte_count;
4125 const struct rule_actions *actions;
4126 long long int created, used;
4128 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4129 &byte_count, &used);
4131 ovs_mutex_lock(&rule->mutex);
4132 actions = rule_get_actions(rule);
4133 created = rule->created;
4134 ovs_mutex_unlock(&rule->mutex);
4136 if (rule->table_id != 0) {
4137 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4139 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4140 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4141 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4142 cls_rule_format(&rule->cr, results);
4143 ds_put_char(results, ',');
4145 ds_put_cstr(results, "actions=");
4146 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4148 ds_put_cstr(results, "\n");
4151 /* Adds a pretty-printed description of all flows to 'results', including
4152 * hidden flows (e.g., set up by in-band control). */
4154 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4156 struct oftable *table;
4158 OFPROTO_FOR_EACH_TABLE (table, p) {
4161 CLS_FOR_EACH (rule, cr, &table->cls) {
4162 flow_stats_ds(rule, results);
4167 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4168 * '*engine_type' and '*engine_id', respectively. */
4170 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4171 uint8_t *engine_type, uint8_t *engine_id)
4173 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4176 /* Checks the status change of CFM on 'ofport'.
4178 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4180 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4182 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4183 return (ofport && ofproto->ofproto_class->cfm_status_changed
4184 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4188 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4189 * Returns 0 if the port's CFM status was successfully stored into
4190 * '*status'. Returns positive errno if the port did not have CFM
4193 * The caller must provide and own '*status', and must free 'status->rmps'.
4194 * '*status' is indeterminate if the return value is non-zero. */
4196 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4197 struct cfm_status *status)
4199 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4200 return (ofport && ofproto->ofproto_class->get_cfm_status
4201 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4206 handle_aggregate_stats_request(struct ofconn *ofconn,
4207 const struct ofp_header *oh)
4208 OVS_EXCLUDED(ofproto_mutex)
4210 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4211 struct ofputil_flow_stats_request request;
4212 struct ofputil_aggregate_stats stats;
4213 bool unknown_packets, unknown_bytes;
4214 struct rule_criteria criteria;
4215 struct rule_collection rules;
4216 struct ofpbuf *reply;
4220 error = ofputil_decode_flow_stats_request(&request, oh);
4225 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4226 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4227 request.out_port, request.out_group);
4229 ovs_mutex_lock(&ofproto_mutex);
4230 error = collect_rules_loose(ofproto, &criteria, &rules);
4231 rule_criteria_destroy(&criteria);
4233 rule_collection_ref(&rules);
4235 ovs_mutex_unlock(&ofproto_mutex);
4241 memset(&stats, 0, sizeof stats);
4242 unknown_packets = unknown_bytes = false;
4243 for (i = 0; i < rules.n; i++) {
4244 struct rule *rule = rules.rules[i];
4245 uint64_t packet_count;
4246 uint64_t byte_count;
4249 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4250 &byte_count, &used);
4252 if (packet_count == UINT64_MAX) {
4253 unknown_packets = true;
4255 stats.packet_count += packet_count;
4258 if (byte_count == UINT64_MAX) {
4259 unknown_bytes = true;
4261 stats.byte_count += byte_count;
4266 if (unknown_packets) {
4267 stats.packet_count = UINT64_MAX;
4269 if (unknown_bytes) {
4270 stats.byte_count = UINT64_MAX;
4273 rule_collection_unref(&rules);
4274 rule_collection_destroy(&rules);
4276 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4277 ofconn_send_reply(ofconn, reply);
4282 struct queue_stats_cbdata {
4283 struct ofport *ofport;
4284 struct ovs_list replies;
4289 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4290 const struct netdev_queue_stats *stats)
4292 struct ofputil_queue_stats oqs;
4294 oqs.port_no = cbdata->ofport->pp.port_no;
4295 oqs.queue_id = queue_id;
4296 oqs.tx_bytes = stats->tx_bytes;
4297 oqs.tx_packets = stats->tx_packets;
4298 oqs.tx_errors = stats->tx_errors;
4299 if (stats->created != LLONG_MIN) {
4300 calc_duration(stats->created, cbdata->now,
4301 &oqs.duration_sec, &oqs.duration_nsec);
4303 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4305 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4309 handle_queue_stats_dump_cb(uint32_t queue_id,
4310 struct netdev_queue_stats *stats,
4313 struct queue_stats_cbdata *cbdata = cbdata_;
4315 put_queue_stats(cbdata, queue_id, stats);
4319 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4320 struct queue_stats_cbdata *cbdata)
4322 cbdata->ofport = port;
4323 if (queue_id == OFPQ_ALL) {
4324 netdev_dump_queue_stats(port->netdev,
4325 handle_queue_stats_dump_cb, cbdata);
4327 struct netdev_queue_stats stats;
4329 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4330 put_queue_stats(cbdata, queue_id, &stats);
4332 return OFPERR_OFPQOFC_BAD_QUEUE;
4339 handle_queue_stats_request(struct ofconn *ofconn,
4340 const struct ofp_header *rq)
4342 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4343 struct queue_stats_cbdata cbdata;
4344 struct ofport *port;
4346 struct ofputil_queue_stats_request oqsr;
4348 COVERAGE_INC(ofproto_queue_req);
4350 ofpmp_init(&cbdata.replies, rq);
4351 cbdata.now = time_msec();
4353 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4358 if (oqsr.port_no == OFPP_ANY) {
4359 error = OFPERR_OFPQOFC_BAD_QUEUE;
4360 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4361 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4366 port = ofproto_get_port(ofproto, oqsr.port_no);
4368 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4369 : OFPERR_OFPQOFC_BAD_PORT);
4372 ofconn_send_replies(ofconn, &cbdata.replies);
4374 ofpbuf_list_delete(&cbdata.replies);
4381 evict_rules_from_table(struct oftable *table)
4382 OVS_REQUIRES(ofproto_mutex)
4384 enum ofperr error = 0;
4385 struct rule_collection rules;
4386 unsigned int count = table->n_flows;
4387 unsigned int max_flows = table->max_flows;
4389 rule_collection_init(&rules);
4391 while (count-- > max_flows) {
4394 if (!choose_rule_to_evict(table, &rule)) {
4395 error = OFPERR_OFPFMFC_TABLE_FULL;
4398 eviction_group_remove_rule(rule);
4399 rule_collection_add(&rules, rule);
4402 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4408 get_conjunctions(const struct ofputil_flow_mod *fm,
4409 struct cls_conjunction **conjsp, size_t *n_conjsp)
4410 OVS_REQUIRES(ofproto_mutex)
4412 struct cls_conjunction *conjs = NULL;
4415 const struct ofpact *ofpact;
4416 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4417 if (ofpact->type == OFPACT_CONJUNCTION) {
4419 } else if (ofpact->type != OFPACT_NOTE) {
4420 /* "conjunction" may appear with "note" actions but not with any
4421 * other type of actions. */
4422 ovs_assert(!n_conjs);
4429 conjs = xzalloc(n_conjs * sizeof *conjs);
4430 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4431 if (ofpact->type == OFPACT_CONJUNCTION) {
4432 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4433 conjs[i].clause = oc->clause;
4434 conjs[i].n_clauses = oc->n_clauses;
4435 conjs[i].id = oc->id;
4442 *n_conjsp = n_conjs;
4445 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4446 * in which no matching flow already exists in the flow table.
4448 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4449 * success, or an OpenFlow error code on failure.
4451 * On successful return the caller must complete the operation either by
4452 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4455 * The caller retains ownership of 'fm->ofpacts'. */
4457 add_flow_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4458 struct rule **old_rule, struct rule **new_rule)
4459 OVS_REQUIRES(ofproto_mutex)
4461 struct oftable *table;
4465 struct cls_conjunction *conjs;
4469 if (!check_table_id(ofproto, fm->table_id)) {
4470 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4475 if (fm->table_id == 0xff) {
4476 if (ofproto->ofproto_class->rule_choose_table) {
4477 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4483 ovs_assert(table_id < ofproto->n_tables);
4487 } else if (fm->table_id < ofproto->n_tables) {
4488 table_id = fm->table_id;
4490 return OFPERR_OFPBRC_BAD_TABLE_ID;
4493 table = &ofproto->tables[table_id];
4494 if (table->flags & OFTABLE_READONLY
4495 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4496 return OFPERR_OFPBRC_EPERM;
4499 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4500 && !match_has_default_hidden_fields(&fm->match)) {
4501 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4502 "non-default values to hidden fields", ofproto->name);
4503 return OFPERR_OFPBRC_EPERM;
4506 cls_rule_init(&cr, &fm->match, fm->priority, ofproto->tables_version + 1);
4508 /* Check for the existence of an identical rule.
4509 * This will not return rules earlier marked for removal. */
4510 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4513 /* Check for overlap, if requested. */
4514 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4515 && classifier_rule_overlaps(&table->cls, &cr)) {
4516 cls_rule_destroy(&cr);
4517 return OFPERR_OFPFMFC_OVERLAP;
4520 /* If necessary, evict an existing rule to clear out space. */
4521 if (table->n_flows >= table->max_flows) {
4522 if (!choose_rule_to_evict(table, &rule)) {
4523 error = OFPERR_OFPFMFC_TABLE_FULL;
4524 cls_rule_destroy(&cr);
4527 eviction_group_remove_rule(rule);
4528 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4530 fm->delete_reason = OFPRR_EVICTION;
4534 fm->modify_cookie = true;
4537 /* Allocate new rule. */
4538 error = replace_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4544 get_conjunctions(fm, &conjs, &n_conjs);
4545 replace_rule_start(ofproto, rule, *new_rule, conjs, n_conjs);
4551 /* Revert the effects of add_flow_start(). */
4553 add_flow_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4554 struct rule *old_rule, struct rule *new_rule)
4555 OVS_REQUIRES(ofproto_mutex)
4557 if (old_rule && fm->delete_reason == OFPRR_EVICTION) {
4558 /* Revert the eviction. */
4559 eviction_group_add_rule(old_rule);
4562 replace_rule_revert(ofproto, old_rule, new_rule);
4565 /* To be called after version bump. */
4567 add_flow_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4568 const struct flow_mod_requester *req,
4569 struct rule *old_rule, struct rule *new_rule)
4570 OVS_REQUIRES(ofproto_mutex)
4572 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4574 replace_rule_finish(ofproto, fm, req, old_rule, new_rule, &dead_cookies);
4575 learned_cookies_flush(ofproto, &dead_cookies);
4578 ovsrcu_postpone(remove_rule_rcu, old_rule);
4580 if (minimask_get_vid_mask(&new_rule->cr.match.mask) == VLAN_VID_MASK) {
4581 if (ofproto->vlan_bitmap) {
4582 uint16_t vid = miniflow_get_vid(&new_rule->cr.match.flow);
4584 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4585 bitmap_set1(ofproto->vlan_bitmap, vid);
4586 ofproto->vlans_changed = true;
4589 ofproto->vlans_changed = true;
4593 ofmonitor_report(ofproto->connmgr, new_rule, NXFME_ADDED, 0,
4594 req ? req->ofconn : NULL,
4595 req ? req->request->xid : 0, NULL);
4598 send_buffered_packet(req, fm->buffer_id, new_rule);
4601 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4603 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4604 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4605 * structures yet. Takes ownership of 'cr'. */
4607 replace_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4608 struct cls_rule *cr, uint8_t table_id,
4609 struct rule *old_rule, struct rule **new_rule)
4614 /* Allocate new rule. */
4615 rule = ofproto->ofproto_class->rule_alloc();
4617 cls_rule_destroy(cr);
4618 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
4619 return OFPERR_OFPFMFC_UNKNOWN;
4622 /* Initialize base state. */
4623 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4624 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
4625 ovs_refcount_init(&rule->ref_count);
4626 rule->flow_cookie = fm->new_cookie;
4627 rule->created = rule->modified = time_msec();
4629 ovs_mutex_init(&rule->mutex);
4630 ovs_mutex_lock(&rule->mutex);
4631 rule->idle_timeout = fm->idle_timeout;
4632 rule->hard_timeout = fm->hard_timeout;
4633 rule->importance = fm->importance;
4634 rule->removed_reason = OVS_OFPRR_NONE;
4636 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
4637 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4638 *CONST_CAST(const struct rule_actions **, &rule->actions)
4639 = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4640 list_init(&rule->meter_list_node);
4641 rule->eviction_group = NULL;
4642 list_init(&rule->expirable);
4643 rule->monitor_flags = 0;
4644 rule->add_seqno = 0;
4645 rule->modify_seqno = 0;
4647 /* Copy values from old rule for modify semantics. */
4648 if (old_rule && fm->delete_reason != OFPRR_EVICTION) {
4649 /* 'fm' says that */
4650 bool change_cookie = (fm->modify_cookie
4651 && fm->new_cookie != OVS_BE64_MAX
4652 && fm->new_cookie != old_rule->flow_cookie);
4654 ovs_mutex_lock(&old_rule->mutex);
4655 if (fm->command != OFPFC_ADD) {
4656 rule->idle_timeout = old_rule->idle_timeout;
4657 rule->hard_timeout = old_rule->hard_timeout;
4658 rule->importance = old_rule->importance;
4659 rule->flags = old_rule->flags;
4660 rule->created = old_rule->created;
4662 if (!change_cookie) {
4663 rule->flow_cookie = old_rule->flow_cookie;
4665 ovs_mutex_unlock(&old_rule->mutex);
4667 ovs_mutex_unlock(&rule->mutex);
4669 /* Construct rule, initializing derived state. */
4670 error = ofproto->ofproto_class->rule_construct(rule);
4672 ofproto_rule_destroy__(rule);
4676 rule->removed = true; /* Not yet in ofproto data structures. */
4683 replace_rule_start(struct ofproto *ofproto,
4684 struct rule *old_rule, struct rule *new_rule,
4685 struct cls_conjunction *conjs, size_t n_conjs)
4687 struct oftable *table = &ofproto->tables[new_rule->table_id];
4689 /* 'old_rule' may be either an evicted rule or replaced rule. */
4691 /* Mark the old rule for removal in the next version. */
4692 cls_rule_make_invisible_in_version(&old_rule->cr,
4693 ofproto->tables_version + 1);
4697 /* Insert flow to the classifier, so that later flow_mods may relate
4698 * to it. This is reversible, in case later errors require this to
4700 ofproto_rule_insert__(ofproto, new_rule);
4701 /* Make the new rule visible for classifier lookups only from the next
4703 classifier_insert(&table->cls, &new_rule->cr, conjs, n_conjs);
4706 static void replace_rule_revert(struct ofproto *ofproto,
4707 struct rule *old_rule, struct rule *new_rule)
4709 struct oftable *table = &ofproto->tables[new_rule->table_id];
4712 /* Restore the original visibility of the old rule. */
4713 cls_rule_restore_visibility(&old_rule->cr);
4715 /* Restore table's rule count. */
4719 /* Remove the new rule immediately. It was never visible to lookups. */
4720 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4723 ofproto_rule_remove__(ofproto, new_rule);
4724 /* The rule was not inserted to the ofproto provider, so we can
4725 * release it without deleting it from the ofproto provider. */
4726 ofproto_rule_unref(new_rule);
4729 /* Adds the 'new_rule', replacing the 'old_rule'. */
4731 replace_rule_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4732 const struct flow_mod_requester *req,
4733 struct rule *old_rule, struct rule *new_rule,
4734 struct ovs_list *dead_cookies)
4735 OVS_REQUIRES(ofproto_mutex)
4737 bool forward_stats = !(fm->flags & OFPUTIL_FF_RESET_COUNTS);
4738 struct rule *replaced_rule;
4740 replaced_rule = fm->delete_reason != OFPRR_EVICTION ? old_rule : NULL;
4742 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4743 * is a duplicate rule the 'new_rule' is replacing. The provider should
4744 * link the stats from the old rule to the new one if 'forward_stats' is
4745 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4746 ofproto->ofproto_class->rule_insert(new_rule, replaced_rule,
4748 learned_cookies_inc(ofproto, rule_get_actions(new_rule));
4751 const struct rule_actions *old_actions = rule_get_actions(old_rule);
4753 /* Remove the old rule from data structures. Removal from the
4754 * classifier and the deletion of the rule is RCU postponed by the
4756 ofproto_rule_remove__(ofproto, old_rule);
4757 learned_cookies_dec(ofproto, old_actions, dead_cookies);
4759 if (replaced_rule) {
4760 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4761 ? NXFME_ADDED : NXFME_MODIFIED;
4763 bool change_cookie = (fm->modify_cookie
4764 && fm->new_cookie != OVS_BE64_MAX
4765 && fm->new_cookie != old_rule->flow_cookie);
4767 bool change_actions = !ofpacts_equal(fm->ofpacts,
4769 old_actions->ofpacts,
4770 old_actions->ofpacts_len);
4772 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4773 ofmonitor_report(ofproto->connmgr, new_rule, event, 0,
4774 req ? req->ofconn : NULL,
4775 req ? req->request->xid : 0,
4776 change_actions ? old_actions : NULL);
4779 /* XXX: This is slight duplication with delete_flows_finish__() */
4781 old_rule->removed_reason = OFPRR_EVICTION;
4783 ofmonitor_report(ofproto->connmgr, old_rule, NXFME_DELETED,
4785 req ? req->ofconn : NULL,
4786 req ? req->request->xid : 0, NULL);
4792 modify_flows_start__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4793 struct rule_collection *old_rules,
4794 struct rule_collection *new_rules)
4795 OVS_REQUIRES(ofproto_mutex)
4799 rule_collection_init(new_rules);
4801 if (old_rules->n > 0) {
4802 struct cls_conjunction *conjs;
4806 /* Create a new 'modified' rule for each old rule. */
4807 for (i = 0; i < old_rules->n; i++) {
4808 struct rule *old_rule = old_rules->rules[i];
4809 struct rule *new_rule;
4812 cls_rule_clone_in_version(&cr, &old_rule->cr,
4813 ofproto->tables_version + 1);
4814 error = replace_rule_create(ofproto, fm, &cr, old_rule->table_id,
4815 old_rule, &new_rule);
4817 rule_collection_add(new_rules, new_rule);
4819 rule_collection_unref(new_rules);
4820 rule_collection_destroy(new_rules);
4824 ovs_assert(new_rules->n == old_rules->n);
4826 get_conjunctions(fm, &conjs, &n_conjs);
4827 for (i = 0; i < old_rules->n; i++) {
4828 replace_rule_start(ofproto, old_rules->rules[i],
4829 new_rules->rules[i], conjs, n_conjs);
4832 } else if (!(fm->cookie_mask != htonll(0)
4833 || fm->new_cookie == OVS_BE64_MAX)) {
4834 /* No match, add a new flow. */
4835 error = add_flow_start(ofproto, fm, &old_rules->rules[0],
4836 &new_rules->rules[0]);
4838 ovs_assert(fm->delete_reason == OFPRR_EVICTION
4839 || !old_rules->rules[0]);
4849 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4852 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4855 modify_flows_start_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4856 struct rule_collection *old_rules,
4857 struct rule_collection *new_rules)
4858 OVS_REQUIRES(ofproto_mutex)
4860 struct rule_criteria criteria;
4863 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4864 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4865 rule_criteria_require_rw(&criteria,
4866 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4867 error = collect_rules_loose(ofproto, &criteria, old_rules);
4868 rule_criteria_destroy(&criteria);
4871 error = modify_flows_start__(ofproto, fm, old_rules, new_rules);
4875 rule_collection_destroy(old_rules);
4881 modify_flows_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4882 struct rule_collection *old_rules,
4883 struct rule_collection *new_rules)
4884 OVS_REQUIRES(ofproto_mutex)
4886 /* Old rules were not changed yet, only need to revert new rules. */
4887 if (old_rules->n == 0 && new_rules->n == 1) {
4888 add_flow_revert(ofproto, fm, old_rules->rules[0], new_rules->rules[0]);
4889 } else if (old_rules->n > 0) {
4890 for (size_t i = 0; i < old_rules->n; i++) {
4891 replace_rule_revert(ofproto, old_rules->rules[i],
4892 new_rules->rules[i]);
4894 rule_collection_destroy(new_rules);
4895 rule_collection_destroy(old_rules);
4900 modify_flows_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4901 const struct flow_mod_requester *req,
4902 struct rule_collection *old_rules,
4903 struct rule_collection *new_rules)
4904 OVS_REQUIRES(ofproto_mutex)
4906 if (old_rules->n == 0 && new_rules->n == 1) {
4907 add_flow_finish(ofproto, fm, req, old_rules->rules[0],
4908 new_rules->rules[0]);
4909 } else if (old_rules->n > 0) {
4910 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4912 ovs_assert(new_rules->n == old_rules->n);
4914 for (size_t i = 0; i < old_rules->n; i++) {
4915 replace_rule_finish(ofproto, fm, req, old_rules->rules[i],
4916 new_rules->rules[i], &dead_cookies);
4918 learned_cookies_flush(ofproto, &dead_cookies);
4919 rule_collection_remove_postponed(old_rules);
4921 send_buffered_packet(req, fm->buffer_id, new_rules->rules[0]);
4922 rule_collection_destroy(new_rules);
4926 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4927 * code on failure. */
4929 modify_flow_start_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4930 struct rule_collection *old_rules,
4931 struct rule_collection *new_rules)
4932 OVS_REQUIRES(ofproto_mutex)
4934 struct rule_criteria criteria;
4937 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4938 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
4940 rule_criteria_require_rw(&criteria,
4941 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4942 error = collect_rules_strict(ofproto, &criteria, old_rules);
4943 rule_criteria_destroy(&criteria);
4946 /* collect_rules_strict() can return max 1 rule. */
4947 error = modify_flows_start__(ofproto, fm, old_rules, new_rules);
4951 rule_collection_destroy(old_rules);
4956 /* OFPFC_DELETE implementation. */
4959 delete_flows_start__(struct ofproto *ofproto,
4960 const struct rule_collection *rules)
4961 OVS_REQUIRES(ofproto_mutex)
4963 for (size_t i = 0; i < rules->n; i++) {
4964 struct rule *rule = rules->rules[i];
4965 struct oftable *table = &ofproto->tables[rule->table_id];
4968 cls_rule_make_invisible_in_version(&rule->cr,
4969 ofproto->tables_version + 1);
4974 delete_flows_finish__(struct ofproto *ofproto,
4975 struct rule_collection *rules,
4976 enum ofp_flow_removed_reason reason,
4977 const struct flow_mod_requester *req)
4978 OVS_REQUIRES(ofproto_mutex)
4981 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4983 for (size_t i = 0; i < rules->n; i++) {
4984 struct rule *rule = rules->rules[i];
4986 /* This value will be used to send the flow removed message right
4987 * before the rule is actually destroyed. */
4988 rule->removed_reason = reason;
4990 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4991 req ? req->ofconn : NULL,
4992 req ? req->request->xid : 0, NULL);
4993 ofproto_rule_remove__(ofproto, rule);
4994 learned_cookies_dec(ofproto, rule_get_actions(rule),
4997 rule_collection_remove_postponed(rules);
4999 learned_cookies_flush(ofproto, &dead_cookies);
5003 /* Deletes the rules listed in 'rules'.
5004 * The deleted rules will become invisible to the lookups in the next version.
5005 * Destroys 'rules'. */
5007 delete_flows__(struct rule_collection *rules,
5008 enum ofp_flow_removed_reason reason,
5009 const struct flow_mod_requester *req)
5010 OVS_REQUIRES(ofproto_mutex)
5013 struct ofproto *ofproto = rules->rules[0]->ofproto;
5015 delete_flows_start__(ofproto, rules);
5016 ofproto_bump_tables_version(ofproto);
5017 delete_flows_finish__(ofproto, rules, reason, req);
5018 ofmonitor_flush(ofproto->connmgr);
5022 /* Implements OFPFC_DELETE. */
5024 delete_flows_start_loose(struct ofproto *ofproto,
5025 const struct ofputil_flow_mod *fm,
5026 struct rule_collection *rules)
5027 OVS_REQUIRES(ofproto_mutex)
5029 struct rule_criteria criteria;
5032 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
5033 fm->cookie, fm->cookie_mask, fm->out_port,
5035 rule_criteria_require_rw(&criteria,
5036 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5037 error = collect_rules_loose(ofproto, &criteria, rules);
5038 rule_criteria_destroy(&criteria);
5041 delete_flows_start__(ofproto, rules);
5048 delete_flows_revert(struct ofproto *ofproto,
5049 struct rule_collection *rules)
5050 OVS_REQUIRES(ofproto_mutex)
5052 for (size_t i = 0; i < rules->n; i++) {
5053 struct rule *rule = rules->rules[i];
5054 struct oftable *table = &ofproto->tables[rule->table_id];
5056 /* Restore table's rule count. */
5059 /* Restore the original visibility of the rule. */
5060 cls_rule_restore_visibility(&rule->cr);
5062 rule_collection_destroy(rules);
5066 delete_flows_finish(struct ofproto *ofproto,
5067 const struct ofputil_flow_mod *fm,
5068 const struct flow_mod_requester *req,
5069 struct rule_collection *rules)
5070 OVS_REQUIRES(ofproto_mutex)
5072 delete_flows_finish__(ofproto, rules, fm->delete_reason, req);
5075 /* Implements OFPFC_DELETE_STRICT. */
5077 delete_flow_start_strict(struct ofproto *ofproto,
5078 const struct ofputil_flow_mod *fm,
5079 struct rule_collection *rules)
5080 OVS_REQUIRES(ofproto_mutex)
5082 struct rule_criteria criteria;
5085 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5086 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
5087 fm->out_port, fm->out_group);
5088 rule_criteria_require_rw(&criteria,
5089 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5090 error = collect_rules_strict(ofproto, &criteria, rules);
5091 rule_criteria_destroy(&criteria);
5094 delete_flows_start__(ofproto, rules);
5100 /* This may only be called by rule_destroy_cb()! */
5102 ofproto_rule_send_removed(struct rule *rule)
5103 OVS_EXCLUDED(ofproto_mutex)
5105 struct ofputil_flow_removed fr;
5108 minimatch_expand(&rule->cr.match, &fr.match);
5109 fr.priority = rule->cr.priority;
5111 ovs_mutex_lock(&ofproto_mutex);
5112 fr.cookie = rule->flow_cookie;
5113 fr.reason = rule->removed_reason;
5114 fr.table_id = rule->table_id;
5115 calc_duration(rule->created, time_msec(),
5116 &fr.duration_sec, &fr.duration_nsec);
5117 ovs_mutex_lock(&rule->mutex);
5118 fr.idle_timeout = rule->idle_timeout;
5119 fr.hard_timeout = rule->hard_timeout;
5120 ovs_mutex_unlock(&rule->mutex);
5121 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
5122 &fr.byte_count, &used);
5123 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
5124 ovs_mutex_unlock(&ofproto_mutex);
5127 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5128 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5131 * ofproto implementation ->run() functions should use this function to expire
5132 * OpenFlow flows. */
5134 ofproto_rule_expire(struct rule *rule, uint8_t reason)
5135 OVS_REQUIRES(ofproto_mutex)
5137 struct rule_collection rules;
5139 rules.rules = rules.stub;
5141 rules.stub[0] = rule;
5142 delete_flows__(&rules, reason, NULL);
5145 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5146 * means "infinite". */
5148 reduce_timeout(uint16_t max, uint16_t *timeout)
5150 if (max && (!*timeout || *timeout > max)) {
5155 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5156 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5157 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5159 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5161 ofproto_rule_reduce_timeouts(struct rule *rule,
5162 uint16_t idle_timeout, uint16_t hard_timeout)
5163 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5165 if (!idle_timeout && !hard_timeout) {
5169 ovs_mutex_lock(&ofproto_mutex);
5170 if (list_is_empty(&rule->expirable)) {
5171 list_insert(&rule->ofproto->expirable, &rule->expirable);
5173 ovs_mutex_unlock(&ofproto_mutex);
5175 ovs_mutex_lock(&rule->mutex);
5176 reduce_timeout(idle_timeout, &rule->idle_timeout);
5177 reduce_timeout(hard_timeout, &rule->hard_timeout);
5178 ovs_mutex_unlock(&rule->mutex);
5182 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5183 OVS_EXCLUDED(ofproto_mutex)
5185 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5186 struct ofputil_flow_mod fm;
5187 uint64_t ofpacts_stub[1024 / 8];
5188 struct ofpbuf ofpacts;
5191 error = reject_slave_controller(ofconn);
5196 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5197 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
5199 u16_to_ofp(ofproto->max_ports),
5202 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
5205 struct flow_mod_requester req;
5207 req.ofconn = ofconn;
5209 error = handle_flow_mod__(ofproto, &fm, &req);
5212 goto exit_free_ofpacts;
5215 ofconn_report_flow_mod(ofconn, fm.command);
5218 ofpbuf_uninit(&ofpacts);
5224 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
5225 const struct flow_mod_requester *req)
5226 OVS_EXCLUDED(ofproto_mutex)
5228 struct ofp_bundle_entry be;
5231 ovs_mutex_lock(&ofproto_mutex);
5232 error = do_bundle_flow_mod_start(ofproto, fm, &be);
5234 ofproto_bump_tables_version(ofproto);
5235 do_bundle_flow_mod_finish(ofproto, fm, req, &be);
5237 ofmonitor_flush(ofproto->connmgr);
5238 ovs_mutex_unlock(&ofproto_mutex);
5240 run_rule_executes(ofproto);
5245 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5247 struct ofputil_role_request request;
5248 struct ofputil_role_request reply;
5252 error = ofputil_decode_role_message(oh, &request);
5257 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5258 if (request.have_generation_id
5259 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5260 return OFPERR_OFPRRFC_STALE;
5263 ofconn_set_role(ofconn, request.role);
5266 reply.role = ofconn_get_role(ofconn);
5267 reply.have_generation_id = ofconn_get_master_election_id(
5268 ofconn, &reply.generation_id);
5269 buf = ofputil_encode_role_reply(oh, &reply);
5270 ofconn_send_reply(ofconn, buf);
5276 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5277 const struct ofp_header *oh)
5279 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5280 enum ofputil_protocol cur, next;
5282 cur = ofconn_get_protocol(ofconn);
5283 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5284 ofconn_set_protocol(ofconn, next);
5290 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5292 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5293 enum ofputil_protocol cur, next;
5294 enum ofputil_protocol next_base;
5296 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5298 return OFPERR_OFPBRC_EPERM;
5301 cur = ofconn_get_protocol(ofconn);
5302 next = ofputil_protocol_set_base(cur, next_base);
5303 ofconn_set_protocol(ofconn, next);
5309 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5310 const struct ofp_header *oh)
5312 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5315 format = ntohl(msg->format);
5316 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5317 return OFPERR_OFPBRC_EPERM;
5320 ofconn_set_packet_in_format(ofconn, format);
5325 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5327 const struct nx_async_config *msg = ofpmsg_body(oh);
5328 uint32_t master[OAM_N_TYPES];
5329 uint32_t slave[OAM_N_TYPES];
5331 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5332 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5333 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5335 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5336 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5337 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5339 ofconn_set_async_config(ofconn, master, slave);
5340 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5341 !ofconn_get_miss_send_len(ofconn)) {
5342 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5349 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5352 uint32_t master[OAM_N_TYPES];
5353 uint32_t slave[OAM_N_TYPES];
5354 struct nx_async_config *msg;
5356 ofconn_get_async_config(ofconn, master, slave);
5357 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5358 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5360 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5361 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5362 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5364 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5365 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5366 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5368 ofconn_send_reply(ofconn, buf);
5374 handle_nxt_set_controller_id(struct ofconn *ofconn,
5375 const struct ofp_header *oh)
5377 const struct nx_controller_id *nci = ofpmsg_body(oh);
5379 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5380 return OFPERR_NXBRC_MUST_BE_ZERO;
5383 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5388 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5392 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5393 ? OFPRAW_OFPT10_BARRIER_REPLY
5394 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5395 ofconn_send_reply(ofconn, buf);
5400 ofproto_compose_flow_refresh_update(const struct rule *rule,
5401 enum nx_flow_monitor_flags flags,
5402 struct ovs_list *msgs)
5403 OVS_REQUIRES(ofproto_mutex)
5405 const struct rule_actions *actions;
5406 struct ofputil_flow_update fu;
5409 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5410 ? NXFME_ADDED : NXFME_MODIFIED);
5412 ovs_mutex_lock(&rule->mutex);
5413 fu.idle_timeout = rule->idle_timeout;
5414 fu.hard_timeout = rule->hard_timeout;
5415 ovs_mutex_unlock(&rule->mutex);
5416 fu.table_id = rule->table_id;
5417 fu.cookie = rule->flow_cookie;
5418 minimatch_expand(&rule->cr.match, &match);
5420 fu.priority = rule->cr.priority;
5422 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5423 fu.ofpacts = actions ? actions->ofpacts : NULL;
5424 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5426 if (list_is_empty(msgs)) {
5427 ofputil_start_flow_update(msgs);
5429 ofputil_append_flow_update(&fu, msgs);
5433 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5434 struct ovs_list *msgs)
5435 OVS_REQUIRES(ofproto_mutex)
5439 for (i = 0; i < rules->n; i++) {
5440 struct rule *rule = rules->rules[i];
5441 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5442 rule->monitor_flags = 0;
5444 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5449 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5450 struct rule *rule, uint64_t seqno,
5451 struct rule_collection *rules)
5452 OVS_REQUIRES(ofproto_mutex)
5454 enum nx_flow_monitor_flags update;
5456 if (rule_is_hidden(rule)) {
5460 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5465 if (rule->add_seqno > seqno) {
5466 update = NXFMF_ADD | NXFMF_MODIFY;
5467 } else if (rule->modify_seqno > seqno) {
5468 update = NXFMF_MODIFY;
5473 if (!(m->flags & update)) {
5477 update = NXFMF_INITIAL;
5480 if (!rule->monitor_flags) {
5481 rule_collection_add(rules, rule);
5483 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5487 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5489 struct rule_collection *rules)
5490 OVS_REQUIRES(ofproto_mutex)
5492 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5493 const struct oftable *table;
5494 struct cls_rule target;
5496 cls_rule_init_from_minimatch(&target, &m->match, 0, CLS_MAX_VERSION);
5497 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5500 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5501 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5504 cls_rule_destroy(&target);
5508 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5509 struct rule_collection *rules)
5510 OVS_REQUIRES(ofproto_mutex)
5512 if (m->flags & NXFMF_INITIAL) {
5513 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5518 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5519 uint64_t seqno, struct rule_collection *rules)
5520 OVS_REQUIRES(ofproto_mutex)
5522 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5526 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5527 OVS_REQUIRES(ofproto_mutex)
5529 struct ofmonitor *m;
5532 m = ofmonitor_lookup(ofconn, id);
5534 ofmonitor_destroy(m);
5537 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5544 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5545 OVS_EXCLUDED(ofproto_mutex)
5547 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5548 struct ofmonitor **monitors;
5549 size_t n_monitors, allocated_monitors;
5550 struct rule_collection rules;
5551 struct ovs_list replies;
5556 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5558 n_monitors = allocated_monitors = 0;
5560 ovs_mutex_lock(&ofproto_mutex);
5562 struct ofputil_flow_monitor_request request;
5563 struct ofmonitor *m;
5566 retval = ofputil_decode_flow_monitor_request(&request, &b);
5567 if (retval == EOF) {
5569 } else if (retval) {
5574 if (request.table_id != 0xff
5575 && request.table_id >= ofproto->n_tables) {
5576 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5580 error = ofmonitor_create(&request, ofconn, &m);
5585 if (n_monitors >= allocated_monitors) {
5586 monitors = x2nrealloc(monitors, &allocated_monitors,
5589 monitors[n_monitors++] = m;
5592 rule_collection_init(&rules);
5593 for (i = 0; i < n_monitors; i++) {
5594 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5597 ofpmp_init(&replies, oh);
5598 ofmonitor_compose_refresh_updates(&rules, &replies);
5599 ovs_mutex_unlock(&ofproto_mutex);
5601 rule_collection_destroy(&rules);
5603 ofconn_send_replies(ofconn, &replies);
5609 for (i = 0; i < n_monitors; i++) {
5610 ofmonitor_destroy(monitors[i]);
5613 ovs_mutex_unlock(&ofproto_mutex);
5619 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5620 OVS_EXCLUDED(ofproto_mutex)
5625 id = ofputil_decode_flow_monitor_cancel(oh);
5627 ovs_mutex_lock(&ofproto_mutex);
5628 error = flow_monitor_delete(ofconn, id);
5629 ovs_mutex_unlock(&ofproto_mutex);
5634 /* Meters implementation.
5636 * Meter table entry, indexed by the OpenFlow meter_id.
5637 * 'created' is used to compute the duration for meter stats.
5638 * 'list rules' is needed so that we can delete the dependent rules when the
5639 * meter table entry is deleted.
5640 * 'provider_meter_id' is for the provider's private use.
5643 long long int created; /* Time created. */
5644 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5645 ofproto_meter_id provider_meter_id;
5646 uint16_t flags; /* Meter flags. */
5647 uint16_t n_bands; /* Number of meter bands. */
5648 struct ofputil_meter_band *bands;
5652 * This is used in instruction validation at flow set-up time,
5653 * as flows may not use non-existing meters.
5654 * Return value of UINT32_MAX signifies an invalid meter.
5657 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5659 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5660 const struct meter *meter = ofproto->meters[of_meter_id];
5662 return meter->provider_meter_id.uint32;
5668 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5671 meter_insert_rule(struct rule *rule)
5673 const struct rule_actions *a = rule_get_actions(rule);
5674 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5675 struct meter *meter = rule->ofproto->meters[meter_id];
5677 list_insert(&meter->rules, &rule->meter_list_node);
5681 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5685 meter->flags = config->flags;
5686 meter->n_bands = config->n_bands;
5687 meter->bands = xmemdup(config->bands,
5688 config->n_bands * sizeof *meter->bands);
5691 static struct meter *
5692 meter_create(const struct ofputil_meter_config *config,
5693 ofproto_meter_id provider_meter_id)
5695 struct meter *meter;
5697 meter = xzalloc(sizeof *meter);
5698 meter->provider_meter_id = provider_meter_id;
5699 meter->created = time_msec();
5700 list_init(&meter->rules);
5702 meter_update(meter, config);
5708 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5709 OVS_REQUIRES(ofproto_mutex)
5712 for (mid = first; mid <= last; ++mid) {
5713 struct meter *meter = ofproto->meters[mid];
5715 ofproto->meters[mid] = NULL;
5716 ofproto->ofproto_class->meter_del(ofproto,
5717 meter->provider_meter_id);
5725 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5727 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5728 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5732 return OFPERR_OFPMMFC_METER_EXISTS;
5735 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5738 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5739 *meterp = meter_create(&mm->meter, provider_meter_id);
5745 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5747 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5749 uint32_t provider_meter_id;
5752 return OFPERR_OFPMMFC_UNKNOWN_METER;
5755 provider_meter_id = meter->provider_meter_id.uint32;
5756 error = ofproto->ofproto_class->meter_set(ofproto,
5757 &meter->provider_meter_id,
5759 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5761 meter_update(meter, &mm->meter);
5767 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5768 OVS_EXCLUDED(ofproto_mutex)
5770 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5771 uint32_t meter_id = mm->meter.meter_id;
5772 struct rule_collection rules;
5773 enum ofperr error = 0;
5774 uint32_t first, last;
5776 if (meter_id == OFPM13_ALL) {
5778 last = ofproto->meter_features.max_meters;
5780 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5783 first = last = meter_id;
5786 /* First delete the rules that use this meter. If any of those rules are
5787 * currently being modified, postpone the whole operation until later. */
5788 rule_collection_init(&rules);
5789 ovs_mutex_lock(&ofproto_mutex);
5790 for (meter_id = first; meter_id <= last; ++meter_id) {
5791 struct meter *meter = ofproto->meters[meter_id];
5792 if (meter && !list_is_empty(&meter->rules)) {
5795 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5796 rule_collection_add(&rules, rule);
5800 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5802 /* Delete the meters. */
5803 meter_delete(ofproto, first, last);
5805 ovs_mutex_unlock(&ofproto_mutex);
5811 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5813 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5814 struct ofputil_meter_mod mm;
5815 uint64_t bands_stub[256 / 8];
5816 struct ofpbuf bands;
5820 error = reject_slave_controller(ofconn);
5825 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5827 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5829 goto exit_free_bands;
5832 meter_id = mm.meter.meter_id;
5834 if (mm.command != OFPMC13_DELETE) {
5835 /* Fails also when meters are not implemented by the provider. */
5836 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5837 error = OFPERR_OFPMMFC_INVALID_METER;
5838 goto exit_free_bands;
5839 } else if (meter_id > ofproto->meter_features.max_meters) {
5840 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5841 goto exit_free_bands;
5843 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5844 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5845 goto exit_free_bands;
5849 switch (mm.command) {
5851 error = handle_add_meter(ofproto, &mm);
5854 case OFPMC13_MODIFY:
5855 error = handle_modify_meter(ofproto, &mm);
5858 case OFPMC13_DELETE:
5859 error = handle_delete_meter(ofconn, &mm);
5863 error = OFPERR_OFPMMFC_BAD_COMMAND;
5868 ofpbuf_uninit(&bands);
5873 handle_meter_features_request(struct ofconn *ofconn,
5874 const struct ofp_header *request)
5876 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5877 struct ofputil_meter_features features;
5880 if (ofproto->ofproto_class->meter_get_features) {
5881 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5883 memset(&features, 0, sizeof features);
5885 b = ofputil_encode_meter_features_reply(&features, request);
5887 ofconn_send_reply(ofconn, b);
5892 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5895 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5896 struct ovs_list replies;
5897 uint64_t bands_stub[256 / 8];
5898 struct ofpbuf bands;
5899 uint32_t meter_id, first, last;
5901 ofputil_decode_meter_request(request, &meter_id);
5903 if (meter_id == OFPM13_ALL) {
5905 last = ofproto->meter_features.max_meters;
5907 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5908 !ofproto->meters[meter_id]) {
5909 return OFPERR_OFPMMFC_UNKNOWN_METER;
5911 first = last = meter_id;
5914 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5915 ofpmp_init(&replies, request);
5917 for (meter_id = first; meter_id <= last; ++meter_id) {
5918 struct meter *meter = ofproto->meters[meter_id];
5920 continue; /* Skip non-existing meters. */
5922 if (type == OFPTYPE_METER_STATS_REQUEST) {
5923 struct ofputil_meter_stats stats;
5925 stats.meter_id = meter_id;
5927 /* Provider sets the packet and byte counts, we do the rest. */
5928 stats.flow_count = list_size(&meter->rules);
5929 calc_duration(meter->created, time_msec(),
5930 &stats.duration_sec, &stats.duration_nsec);
5931 stats.n_bands = meter->n_bands;
5932 ofpbuf_clear(&bands);
5934 = ofpbuf_put_uninit(&bands,
5935 meter->n_bands * sizeof *stats.bands);
5937 if (!ofproto->ofproto_class->meter_get(ofproto,
5938 meter->provider_meter_id,
5940 ofputil_append_meter_stats(&replies, &stats);
5942 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5943 struct ofputil_meter_config config;
5945 config.meter_id = meter_id;
5946 config.flags = meter->flags;
5947 config.n_bands = meter->n_bands;
5948 config.bands = meter->bands;
5949 ofputil_append_meter_config(&replies, &config);
5953 ofconn_send_replies(ofconn, &replies);
5954 ofpbuf_uninit(&bands);
5959 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5960 struct ofgroup **group)
5961 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5963 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5964 hash_int(group_id, 0), &ofproto->groups) {
5965 if ((*group)->group_id == group_id) {
5973 /* If the group exists, this function increments the groups's reference count.
5975 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5976 * a reference to the group. */
5978 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5979 struct ofgroup **group)
5983 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5984 found = ofproto_group_lookup__(ofproto, group_id, group);
5986 ofproto_group_ref(*group);
5988 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5993 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5994 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5996 struct ofgroup *grp;
5998 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5999 hash_int(group_id, 0), &ofproto->groups) {
6000 if (grp->group_id == group_id) {
6008 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
6009 OVS_EXCLUDED(ofproto->groups_rwlock)
6013 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6014 exists = ofproto_group_exists__(ofproto, group_id);
6015 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6021 group_get_ref_count(struct ofgroup *group)
6022 OVS_EXCLUDED(ofproto_mutex)
6024 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
6025 struct rule_criteria criteria;
6026 struct rule_collection rules;
6031 match_init_catchall(&match);
6032 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
6033 htonll(0), OFPP_ANY, group->group_id);
6034 ovs_mutex_lock(&ofproto_mutex);
6035 error = collect_rules_loose(ofproto, &criteria, &rules);
6036 ovs_mutex_unlock(&ofproto_mutex);
6037 rule_criteria_destroy(&criteria);
6039 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
6041 rule_collection_destroy(&rules);
6046 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
6048 struct ofputil_group_stats ogs;
6049 const struct ofproto *ofproto = group->ofproto;
6050 long long int now = time_msec();
6053 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
6055 /* Provider sets the packet and byte counts, we do the rest. */
6056 ogs.ref_count = group_get_ref_count(group);
6057 ogs.n_buckets = group->n_buckets;
6059 error = (ofproto->ofproto_class->group_get_stats
6060 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
6063 ogs.packet_count = UINT64_MAX;
6064 ogs.byte_count = UINT64_MAX;
6065 memset(ogs.bucket_stats, 0xff,
6066 ogs.n_buckets * sizeof *ogs.bucket_stats);
6069 ogs.group_id = group->group_id;
6070 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
6072 ofputil_append_group_stats(replies, &ogs);
6074 free(ogs.bucket_stats);
6078 handle_group_request(struct ofconn *ofconn,
6079 const struct ofp_header *request, uint32_t group_id,
6080 void (*cb)(struct ofgroup *, struct ovs_list *replies))
6082 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6083 struct ofgroup *group;
6084 struct ovs_list replies;
6086 ofpmp_init(&replies, request);
6087 if (group_id == OFPG_ALL) {
6088 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6089 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
6090 cb(group, &replies);
6092 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6094 if (ofproto_group_lookup(ofproto, group_id, &group)) {
6095 cb(group, &replies);
6096 ofproto_group_unref(group);
6099 ofconn_send_replies(ofconn, &replies);
6103 handle_group_stats_request(struct ofconn *ofconn,
6104 const struct ofp_header *request)
6109 error = ofputil_decode_group_stats_request(request, &group_id);
6114 handle_group_request(ofconn, request, group_id, append_group_stats);
6119 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
6121 struct ofputil_group_desc gds;
6123 gds.group_id = group->group_id;
6124 gds.type = group->type;
6125 gds.props = group->props;
6127 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
6131 handle_group_desc_stats_request(struct ofconn *ofconn,
6132 const struct ofp_header *request)
6134 handle_group_request(ofconn, request,
6135 ofputil_decode_group_desc_request(request),
6141 handle_group_features_stats_request(struct ofconn *ofconn,
6142 const struct ofp_header *request)
6144 struct ofproto *p = ofconn_get_ofproto(ofconn);
6147 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6149 ofconn_send_reply(ofconn, msg);
6156 handle_queue_get_config_request(struct ofconn *ofconn,
6157 const struct ofp_header *oh)
6159 struct ofproto *p = ofconn_get_ofproto(ofconn);
6160 struct netdev_queue_dump queue_dump;
6161 struct ofport *ofport;
6162 unsigned int queue_id;
6163 struct ofpbuf *reply;
6164 struct smap details;
6168 error = ofputil_decode_queue_get_config_request(oh, &request);
6173 ofport = ofproto_get_port(p, request);
6175 return OFPERR_OFPQOFC_BAD_PORT;
6178 reply = ofputil_encode_queue_get_config_reply(oh);
6180 smap_init(&details);
6181 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6182 struct ofputil_queue_config queue;
6184 /* None of the existing queues have compatible properties, so we
6185 * hard-code omitting min_rate and max_rate. */
6186 queue.queue_id = queue_id;
6187 queue.min_rate = UINT16_MAX;
6188 queue.max_rate = UINT16_MAX;
6189 ofputil_append_queue_get_config_reply(reply, &queue);
6191 smap_destroy(&details);
6193 ofconn_send_reply(ofconn, reply);
6199 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6200 struct ofgroup **ofgroup)
6203 const long long int now = time_msec();
6205 if (gm->group_id > OFPG_MAX) {
6206 return OFPERR_OFPGMFC_INVALID_GROUP;
6208 if (gm->type > OFPGT11_FF) {
6209 return OFPERR_OFPGMFC_BAD_TYPE;
6212 *ofgroup = ofproto->ofproto_class->group_alloc();
6214 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6215 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6218 (*ofgroup)->ofproto = ofproto;
6219 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6220 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6221 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6222 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6223 ovs_refcount_init(&(*ofgroup)->ref_count);
6225 list_move(&(*ofgroup)->buckets, &gm->buckets);
6226 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6227 list_size(&(*ofgroup)->buckets);
6229 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6230 &gm->props, sizeof (struct ofputil_group_props));
6232 /* Construct called BEFORE any locks are held. */
6233 error = ofproto->ofproto_class->group_construct(*ofgroup);
6235 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6236 ofproto->ofproto_class->group_dealloc(*ofgroup);
6241 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6242 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6245 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6247 struct ofgroup *ofgroup;
6250 /* Allocate new group and initialize it. */
6251 error = init_group(ofproto, gm, &ofgroup);
6256 /* We wrlock as late as possible to minimize the time we jam any other
6257 * threads: No visible state changes before acquiring the lock. */
6258 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6260 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6261 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6265 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6266 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6271 /* Insert new group. */
6272 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6273 hash_int(ofgroup->group_id, 0));
6274 ofproto->n_groups[ofgroup->type]++;
6276 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6281 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6282 ofproto->ofproto_class->group_destruct(ofgroup);
6283 ofputil_bucket_list_destroy(&ofgroup->buckets);
6284 ofproto->ofproto_class->group_dealloc(ofgroup);
6289 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6290 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6291 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6292 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6295 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6296 struct ofgroup *new_ofgroup,
6297 uint32_t command_bucket_id)
6299 struct ofputil_bucket *last = NULL;
6301 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6302 /* Check here to ensure that a bucket corresponding to
6303 * command_bucket_id exists in the old bucket list.
6305 * The subsequent search of below of new_ofgroup covers
6306 * both buckets in the old bucket list and buckets added
6307 * by the insert buckets group mod message this function processes. */
6308 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6309 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6312 if (!list_is_empty(&new_ofgroup->buckets)) {
6313 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6317 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6319 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6320 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6321 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6324 /* Rearrange list according to command_bucket_id */
6325 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6326 struct ofputil_bucket *new_first;
6327 const struct ofputil_bucket *first;
6329 first = ofputil_bucket_list_front(&ofgroup->buckets);
6330 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6333 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6334 &new_ofgroup->buckets);
6335 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6336 struct ofputil_bucket *after;
6338 /* Presence of bucket is checked above so after should never be NULL */
6339 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6341 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6342 last->list_node.next);
6348 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6349 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6350 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6351 * and OFPG15_BUCKET_ALL are also honored. */
6353 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6354 struct ofgroup *new_ofgroup,
6355 uint32_t command_bucket_id)
6357 const struct ofputil_bucket *skip = NULL;
6359 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6363 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6364 if (!list_is_empty(&ofgroup->buckets)) {
6365 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6367 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6368 if (!list_is_empty(&ofgroup->buckets)) {
6369 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6372 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6374 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6378 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6383 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6384 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6387 * Note that the group is re-created and then replaces the old group in
6388 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6389 * the xlate module hold a pointer to the group. */
6391 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6393 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6396 error = init_group(ofproto, gm, &new_ofgroup);
6401 retiring = new_ofgroup;
6403 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6404 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6405 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6409 /* Ofproto's group write lock is held now. */
6410 if (ofgroup->type != gm->type
6411 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6412 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6416 /* Manipulate bucket list for bucket commands */
6417 if (gm->command == OFPGC15_INSERT_BUCKET) {
6418 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6419 gm->command_bucket_id);
6420 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6421 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6422 gm->command_bucket_id);
6428 /* The group creation time does not change during modification. */
6429 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6430 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6432 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6438 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6439 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6440 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6441 hash_int(new_ofgroup->group_id, 0));
6442 if (ofgroup->type != new_ofgroup->type) {
6443 ofproto->n_groups[ofgroup->type]--;
6444 ofproto->n_groups[new_ofgroup->type]++;
6448 ofproto_group_unref(retiring);
6449 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6454 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6455 OVS_RELEASES(ofproto->groups_rwlock)
6458 struct ofputil_flow_mod fm;
6460 /* Delete all flow entries containing this group in a group action */
6461 match_init_catchall(&match);
6462 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6463 fm.delete_reason = OFPRR_GROUP_DELETE;
6464 fm.out_group = ofgroup->group_id;
6465 handle_flow_mod__(ofproto, &fm, NULL);
6467 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6468 /* No-one can find this group any more. */
6469 ofproto->n_groups[ofgroup->type]--;
6470 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6471 ofproto_group_unref(ofgroup);
6474 /* Implements OFPGC11_DELETE. */
6476 delete_group(struct ofproto *ofproto, uint32_t group_id)
6478 struct ofgroup *ofgroup;
6480 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6481 if (group_id == OFPG_ALL) {
6483 struct hmap_node *node = hmap_first(&ofproto->groups);
6487 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6488 delete_group__(ofproto, ofgroup);
6489 /* Lock for each node separately, so that we will not jam the
6490 * other threads for too long time. */
6491 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6494 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6495 hash_int(group_id, 0), &ofproto->groups) {
6496 if (ofgroup->group_id == group_id) {
6497 delete_group__(ofproto, ofgroup);
6502 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6505 /* Delete all groups from 'ofproto'.
6507 * This is intended for use within an ofproto provider's 'destruct'
6510 ofproto_group_delete_all(struct ofproto *ofproto)
6512 delete_group(ofproto, OFPG_ALL);
6516 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6518 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6519 struct ofputil_group_mod gm;
6522 error = reject_slave_controller(ofconn);
6527 error = ofputil_decode_group_mod(oh, &gm);
6532 switch (gm.command) {
6534 return add_group(ofproto, &gm);
6536 case OFPGC11_MODIFY:
6537 return modify_group(ofproto, &gm);
6539 case OFPGC11_DELETE:
6540 delete_group(ofproto, gm.group_id);
6543 case OFPGC15_INSERT_BUCKET:
6544 return modify_group(ofproto, &gm);
6546 case OFPGC15_REMOVE_BUCKET:
6547 return modify_group(ofproto, &gm);
6550 if (gm.command > OFPGC11_DELETE) {
6551 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6552 ofproto->name, gm.command);
6554 return OFPERR_OFPGMFC_BAD_COMMAND;
6558 enum ofputil_table_miss
6559 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6561 enum ofputil_table_miss value;
6563 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6568 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6570 if (!check_table_id(ofproto, tm->table_id)) {
6571 return OFPERR_OFPTMFC_BAD_TABLE;
6572 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6573 if (tm->table_id == OFPTT_ALL) {
6575 for (i = 0; i < ofproto->n_tables; i++) {
6576 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6580 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6588 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6590 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6591 struct ofputil_table_mod tm;
6594 error = reject_slave_controller(ofconn);
6599 error = ofputil_decode_table_mod(oh, &tm);
6604 return table_mod(ofproto, &tm);
6608 do_bundle_flow_mod_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6609 struct ofp_bundle_entry *be)
6610 OVS_REQUIRES(ofproto_mutex)
6612 switch (fm->command) {
6614 return add_flow_start(ofproto, fm, &be->old_rules.stub[0],
6615 &be->new_rules.stub[0]);
6617 return modify_flows_start_loose(ofproto, fm, &be->old_rules,
6619 case OFPFC_MODIFY_STRICT:
6620 return modify_flow_start_strict(ofproto, fm, &be->old_rules,
6623 return delete_flows_start_loose(ofproto, fm, &be->old_rules);
6625 case OFPFC_DELETE_STRICT:
6626 return delete_flow_start_strict(ofproto, fm, &be->old_rules);
6629 return OFPERR_OFPFMFC_BAD_COMMAND;
6633 do_bundle_flow_mod_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6634 struct ofp_bundle_entry *be)
6635 OVS_REQUIRES(ofproto_mutex)
6637 switch (fm->command) {
6639 add_flow_revert(ofproto, fm, be->old_rules.stub[0],
6640 be->new_rules.stub[0]);
6644 case OFPFC_MODIFY_STRICT:
6645 modify_flows_revert(ofproto, fm, &be->old_rules, &be->new_rules);
6649 case OFPFC_DELETE_STRICT:
6650 delete_flows_revert(ofproto, &be->old_rules);
6659 do_bundle_flow_mod_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6660 const struct flow_mod_requester *req,
6661 struct ofp_bundle_entry *be)
6662 OVS_REQUIRES(ofproto_mutex)
6664 switch (fm->command) {
6666 add_flow_finish(ofproto, fm, req, be->old_rules.stub[0],
6667 be->new_rules.stub[0]);
6671 case OFPFC_MODIFY_STRICT:
6672 modify_flows_finish(ofproto, fm, req, &be->old_rules, &be->new_rules);
6676 case OFPFC_DELETE_STRICT:
6677 delete_flows_finish(ofproto, fm, req, &be->old_rules);
6685 /* Commit phases (all while locking ofproto_mutex):
6687 * 1. Begin: Gather resources and make changes visible in the next version.
6688 * - Mark affected rules for removal in the next version.
6689 * - Create new replacement rules, make visible in the next
6691 * - Do not send any events or notifications.
6693 * 2. Revert: Fail if any errors are found. After this point no errors are
6694 * possible. No visible changes were made, so rollback is minimal (remove
6695 * added invisible rules, restore visibility of rules marked for removal).
6697 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
6698 * the ofproto provider. Remove replaced and deleted rules from ofproto data
6699 * structures, and Schedule postponed removal of deleted rules from the
6700 * classifier. Send notifications, buffered packets, etc.
6703 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6705 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6706 cls_version_t visible_version = ofproto->tables_version;
6707 struct ofp_bundle *bundle;
6708 struct ofp_bundle_entry *be;
6711 bundle = ofconn_get_bundle(ofconn, id);
6714 return OFPERR_OFPBFC_BAD_ID;
6716 if (bundle->flags != flags) {
6717 error = OFPERR_OFPBFC_BAD_FLAGS;
6719 bool prev_is_port_mod = false;
6722 ovs_mutex_lock(&ofproto_mutex);
6725 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6726 if (be->type == OFPTYPE_PORT_MOD) {
6727 /* Our port mods are not atomic. */
6728 if (flags & OFPBF_ATOMIC) {
6729 error = OFPERR_OFPBFC_MSG_FAILED;
6731 prev_is_port_mod = true;
6732 error = port_mod_start(ofconn, &be->pm, &be->port);
6734 } else if (be->type == OFPTYPE_FLOW_MOD) {
6735 /* Flow mods between port mods are applied as a single
6736 * version, but the versions are published only after
6737 * we know the commit is successful. */
6738 if (prev_is_port_mod) {
6739 ++ofproto->tables_version;
6741 prev_is_port_mod = false;
6742 error = do_bundle_flow_mod_start(ofproto, &be->fm, be);
6749 /* Store the version in which the changes should take
6751 be->version = ofproto->tables_version + 1;
6756 /* Send error referring to the original message. */
6758 ofconn_send_error(ofconn, be->ofp_msg, error);
6759 error = OFPERR_OFPBFC_MSG_FAILED;
6762 /* 2. Revert. Undo all the changes made above. */
6763 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6764 if (be->type == OFPTYPE_FLOW_MOD) {
6765 do_bundle_flow_mod_revert(ofproto, &be->fm, be);
6767 /* Nothing needs to be reverted for a port mod. */
6771 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6772 /* Bump the lookup version to the one of the current message.
6773 * This makes all the changes in the bundle at this version
6774 * visible to lookups at once. */
6775 if (visible_version < be->version) {
6776 visible_version = be->version;
6777 ofproto->ofproto_class->set_tables_version(
6778 ofproto, visible_version);
6780 if (be->type == OFPTYPE_FLOW_MOD) {
6781 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6783 do_bundle_flow_mod_finish(ofproto, &be->fm, &req, be);
6784 } else if (be->type == OFPTYPE_PORT_MOD) {
6785 /* Perform the actual port mod. This is not atomic, i.e.,
6786 * the effects will be immediately seen by upcall
6787 * processing regardless of the lookup version. It should
6788 * be noted that port configuration changes can originate
6789 * also from OVSDB changes asynchronously to all upcall
6791 port_mod_finish(ofconn, &be->pm, be->port);
6796 /* Reset the tables_version. */
6797 ofproto->tables_version = visible_version;
6799 ofmonitor_flush(ofproto->connmgr);
6800 ovs_mutex_unlock(&ofproto_mutex);
6802 run_rule_executes(ofproto);
6805 /* The bundle is discarded regardless the outcome. */
6806 ofp_bundle_remove__(ofconn, bundle, !error);
6811 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6813 struct ofputil_bundle_ctrl_msg bctrl;
6814 struct ofputil_bundle_ctrl_msg reply;
6818 error = reject_slave_controller(ofconn);
6823 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6828 reply.bundle_id = bctrl.bundle_id;
6830 switch (bctrl.type) {
6831 case OFPBCT_OPEN_REQUEST:
6832 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6833 reply.type = OFPBCT_OPEN_REPLY;
6835 case OFPBCT_CLOSE_REQUEST:
6836 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6837 reply.type = OFPBCT_CLOSE_REPLY;;
6839 case OFPBCT_COMMIT_REQUEST:
6840 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6841 reply.type = OFPBCT_COMMIT_REPLY;
6843 case OFPBCT_DISCARD_REQUEST:
6844 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6845 reply.type = OFPBCT_DISCARD_REPLY;
6848 case OFPBCT_OPEN_REPLY:
6849 case OFPBCT_CLOSE_REPLY:
6850 case OFPBCT_COMMIT_REPLY:
6851 case OFPBCT_DISCARD_REPLY:
6852 return OFPERR_OFPBFC_BAD_TYPE;
6857 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6858 ofconn_send_reply(ofconn, buf);
6864 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6866 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6868 struct ofputil_bundle_add_msg badd;
6869 struct ofp_bundle_entry *bmsg;
6872 error = reject_slave_controller(ofconn);
6877 error = ofputil_decode_bundle_add(oh, &badd, &type);
6882 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
6884 if (type == OFPTYPE_PORT_MOD) {
6885 error = ofputil_decode_port_mod(badd.msg, &bmsg->pm, false);
6886 } else if (type == OFPTYPE_FLOW_MOD) {
6887 struct ofpbuf ofpacts;
6888 uint64_t ofpacts_stub[1024 / 8];
6890 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6891 error = ofputil_decode_flow_mod(&bmsg->fm, badd.msg,
6892 ofconn_get_protocol(ofconn),
6894 u16_to_ofp(ofproto->max_ports),
6896 /* Move actions to heap. */
6897 bmsg->fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6899 if (!error && bmsg->fm.ofpacts_len) {
6900 error = ofproto_check_ofpacts(ofproto, bmsg->fm.ofpacts,
6901 bmsg->fm.ofpacts_len);
6908 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
6913 ofp_bundle_entry_free(bmsg);
6920 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6921 OVS_EXCLUDED(ofproto_mutex)
6923 const struct ofp_header *oh = msg->data;
6927 error = ofptype_decode(&type, oh);
6931 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6932 && ofpmp_more(oh)) {
6933 /* We have no buffer implementation for multipart requests.
6934 * Report overflow for requests which consists of multiple
6936 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6940 /* OpenFlow requests. */
6941 case OFPTYPE_ECHO_REQUEST:
6942 return handle_echo_request(ofconn, oh);
6944 case OFPTYPE_FEATURES_REQUEST:
6945 return handle_features_request(ofconn, oh);
6947 case OFPTYPE_GET_CONFIG_REQUEST:
6948 return handle_get_config_request(ofconn, oh);
6950 case OFPTYPE_SET_CONFIG:
6951 return handle_set_config(ofconn, oh);
6953 case OFPTYPE_PACKET_OUT:
6954 return handle_packet_out(ofconn, oh);
6956 case OFPTYPE_PORT_MOD:
6957 return handle_port_mod(ofconn, oh);
6959 case OFPTYPE_FLOW_MOD:
6960 return handle_flow_mod(ofconn, oh);
6962 case OFPTYPE_GROUP_MOD:
6963 return handle_group_mod(ofconn, oh);
6965 case OFPTYPE_TABLE_MOD:
6966 return handle_table_mod(ofconn, oh);
6968 case OFPTYPE_METER_MOD:
6969 return handle_meter_mod(ofconn, oh);
6971 case OFPTYPE_BARRIER_REQUEST:
6972 return handle_barrier_request(ofconn, oh);
6974 case OFPTYPE_ROLE_REQUEST:
6975 return handle_role_request(ofconn, oh);
6977 /* OpenFlow replies. */
6978 case OFPTYPE_ECHO_REPLY:
6981 /* Nicira extension requests. */
6982 case OFPTYPE_FLOW_MOD_TABLE_ID:
6983 return handle_nxt_flow_mod_table_id(ofconn, oh);
6985 case OFPTYPE_SET_FLOW_FORMAT:
6986 return handle_nxt_set_flow_format(ofconn, oh);
6988 case OFPTYPE_SET_PACKET_IN_FORMAT:
6989 return handle_nxt_set_packet_in_format(ofconn, oh);
6991 case OFPTYPE_SET_CONTROLLER_ID:
6992 return handle_nxt_set_controller_id(ofconn, oh);
6994 case OFPTYPE_FLOW_AGE:
6995 /* Nothing to do. */
6998 case OFPTYPE_FLOW_MONITOR_CANCEL:
6999 return handle_flow_monitor_cancel(ofconn, oh);
7001 case OFPTYPE_SET_ASYNC_CONFIG:
7002 return handle_nxt_set_async_config(ofconn, oh);
7004 case OFPTYPE_GET_ASYNC_REQUEST:
7005 return handle_nxt_get_async_request(ofconn, oh);
7007 /* Statistics requests. */
7008 case OFPTYPE_DESC_STATS_REQUEST:
7009 return handle_desc_stats_request(ofconn, oh);
7011 case OFPTYPE_FLOW_STATS_REQUEST:
7012 return handle_flow_stats_request(ofconn, oh);
7014 case OFPTYPE_AGGREGATE_STATS_REQUEST:
7015 return handle_aggregate_stats_request(ofconn, oh);
7017 case OFPTYPE_TABLE_STATS_REQUEST:
7018 return handle_table_stats_request(ofconn, oh);
7020 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
7021 return handle_table_features_request(ofconn, oh);
7023 case OFPTYPE_PORT_STATS_REQUEST:
7024 return handle_port_stats_request(ofconn, oh);
7026 case OFPTYPE_QUEUE_STATS_REQUEST:
7027 return handle_queue_stats_request(ofconn, oh);
7029 case OFPTYPE_PORT_DESC_STATS_REQUEST:
7030 return handle_port_desc_stats_request(ofconn, oh);
7032 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
7033 return handle_flow_monitor_request(ofconn, oh);
7035 case OFPTYPE_METER_STATS_REQUEST:
7036 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
7037 return handle_meter_request(ofconn, oh, type);
7039 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
7040 return handle_meter_features_request(ofconn, oh);
7042 case OFPTYPE_GROUP_STATS_REQUEST:
7043 return handle_group_stats_request(ofconn, oh);
7045 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
7046 return handle_group_desc_stats_request(ofconn, oh);
7048 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
7049 return handle_group_features_stats_request(ofconn, oh);
7051 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
7052 return handle_queue_get_config_request(ofconn, oh);
7054 case OFPTYPE_BUNDLE_CONTROL:
7055 return handle_bundle_control(ofconn, oh);
7057 case OFPTYPE_BUNDLE_ADD_MESSAGE:
7058 return handle_bundle_add(ofconn, oh);
7062 case OFPTYPE_FEATURES_REPLY:
7063 case OFPTYPE_GET_CONFIG_REPLY:
7064 case OFPTYPE_PACKET_IN:
7065 case OFPTYPE_FLOW_REMOVED:
7066 case OFPTYPE_PORT_STATUS:
7067 case OFPTYPE_BARRIER_REPLY:
7068 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
7069 case OFPTYPE_DESC_STATS_REPLY:
7070 case OFPTYPE_FLOW_STATS_REPLY:
7071 case OFPTYPE_QUEUE_STATS_REPLY:
7072 case OFPTYPE_PORT_STATS_REPLY:
7073 case OFPTYPE_TABLE_STATS_REPLY:
7074 case OFPTYPE_AGGREGATE_STATS_REPLY:
7075 case OFPTYPE_PORT_DESC_STATS_REPLY:
7076 case OFPTYPE_ROLE_REPLY:
7077 case OFPTYPE_FLOW_MONITOR_PAUSED:
7078 case OFPTYPE_FLOW_MONITOR_RESUMED:
7079 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
7080 case OFPTYPE_GET_ASYNC_REPLY:
7081 case OFPTYPE_GROUP_STATS_REPLY:
7082 case OFPTYPE_GROUP_DESC_STATS_REPLY:
7083 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
7084 case OFPTYPE_METER_STATS_REPLY:
7085 case OFPTYPE_METER_CONFIG_STATS_REPLY:
7086 case OFPTYPE_METER_FEATURES_STATS_REPLY:
7087 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
7088 case OFPTYPE_ROLE_STATUS:
7090 if (ofpmsg_is_stat_request(oh)) {
7091 return OFPERR_OFPBRC_BAD_STAT;
7093 return OFPERR_OFPBRC_BAD_TYPE;
7099 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
7100 OVS_EXCLUDED(ofproto_mutex)
7102 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
7105 ofconn_send_error(ofconn, ofp_msg->data, error);
7107 COVERAGE_INC(ofproto_recv_openflow);
7110 /* Asynchronous operations. */
7113 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
7115 OVS_REQUIRES(ofproto_mutex)
7117 if (req && req->ofconn && buffer_id != UINT32_MAX) {
7118 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
7119 struct dp_packet *packet;
7123 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
7126 struct rule_execute *re;
7128 ofproto_rule_ref(rule);
7130 re = xmalloc(sizeof *re);
7132 re->in_port = in_port;
7133 re->packet = packet;
7135 if (!guarded_list_push_back(&ofproto->rule_executes,
7136 &re->list_node, 1024)) {
7137 ofproto_rule_unref(rule);
7138 dp_packet_delete(re->packet);
7142 ofconn_send_error(req->ofconn, req->request, error);
7148 pick_datapath_id(const struct ofproto *ofproto)
7150 const struct ofport *port;
7152 port = ofproto_get_port(ofproto, OFPP_LOCAL);
7154 uint8_t ea[ETH_ADDR_LEN];
7157 error = netdev_get_etheraddr(port->netdev, ea);
7159 return eth_addr_to_uint64(ea);
7161 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7162 ofproto->name, netdev_get_name(port->netdev),
7163 ovs_strerror(error));
7165 return ofproto->fallback_dpid;
7169 pick_fallback_dpid(void)
7171 uint8_t ea[ETH_ADDR_LEN];
7172 eth_addr_nicira_random(ea);
7173 return eth_addr_to_uint64(ea);
7176 /* Table overflow policy. */
7178 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7179 * to NULL if the table is not configured to evict rules or if the table
7180 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7181 * or with no timeouts are not evictable.) */
7183 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
7184 OVS_REQUIRES(ofproto_mutex)
7186 struct eviction_group *evg;
7189 if (!table->eviction_fields) {
7193 /* In the common case, the outer and inner loops here will each be entered
7196 * - The inner loop normally "return"s in its first iteration. If the
7197 * eviction group has any evictable rules, then it always returns in
7200 * - The outer loop only iterates more than once if the largest eviction
7201 * group has no evictable rules.
7203 * - The outer loop can exit only if table's 'max_flows' is all filled up
7204 * by unevictable rules. */
7205 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7208 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7217 /* Eviction groups. */
7219 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7220 * rules. The priority contains low-order random bits to ensure that eviction
7221 * groups with the same number of rules are prioritized randomly. */
7223 eviction_group_priority(size_t n_rules)
7225 uint16_t size = MIN(UINT16_MAX, n_rules);
7226 return (size << 16) | random_uint16();
7229 /* Updates 'evg', an eviction_group within 'table', following a change that
7230 * adds or removes rules in 'evg'. */
7232 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7233 OVS_REQUIRES(ofproto_mutex)
7235 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7236 eviction_group_priority(heap_count(&evg->rules)));
7239 /* Destroys 'evg', an eviction_group within 'table':
7241 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7242 * rules themselves, just removes them from the eviction group.)
7244 * - Removes 'evg' from 'table'.
7248 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7249 OVS_REQUIRES(ofproto_mutex)
7251 while (!heap_is_empty(&evg->rules)) {
7254 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7255 rule->eviction_group = NULL;
7257 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7258 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7259 heap_destroy(&evg->rules);
7263 /* Removes 'rule' from its eviction group, if any. */
7265 eviction_group_remove_rule(struct rule *rule)
7266 OVS_REQUIRES(ofproto_mutex)
7268 if (rule->eviction_group) {
7269 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7270 struct eviction_group *evg = rule->eviction_group;
7272 rule->eviction_group = NULL;
7273 heap_remove(&evg->rules, &rule->evg_node);
7274 if (heap_is_empty(&evg->rules)) {
7275 eviction_group_destroy(table, evg);
7277 eviction_group_resized(table, evg);
7282 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7283 * returns the hash value. */
7285 eviction_group_hash_rule(struct rule *rule)
7286 OVS_REQUIRES(ofproto_mutex)
7288 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7289 const struct mf_subfield *sf;
7293 hash = table->eviction_group_id_basis;
7294 miniflow_expand(&rule->cr.match.flow, &flow);
7295 for (sf = table->eviction_fields;
7296 sf < &table->eviction_fields[table->n_eviction_fields];
7299 if (mf_are_prereqs_ok(sf->field, &flow)) {
7300 union mf_value value;
7302 mf_get_value(sf->field, &flow, &value);
7304 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7306 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7307 unsigned int start = sf->ofs + sf->n_bits;
7308 bitwise_zero(&value, sf->field->n_bytes, start,
7309 sf->field->n_bytes * 8 - start);
7311 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7313 hash = hash_int(hash, 0);
7320 /* Returns an eviction group within 'table' with the given 'id', creating one
7322 static struct eviction_group *
7323 eviction_group_find(struct oftable *table, uint32_t id)
7324 OVS_REQUIRES(ofproto_mutex)
7326 struct eviction_group *evg;
7328 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7332 evg = xmalloc(sizeof *evg);
7333 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7334 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7335 eviction_group_priority(0));
7336 heap_init(&evg->rules);
7341 /* Returns an eviction priority for 'rule'. The return value should be
7342 * interpreted so that higher priorities make a rule more attractive candidates
7344 * Called only if have a timeout. */
7346 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7347 OVS_REQUIRES(ofproto_mutex)
7349 long long int expiration = LLONG_MAX;
7350 long long int modified;
7351 uint32_t expiration_offset;
7353 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7354 ovs_mutex_lock(&rule->mutex);
7355 modified = rule->modified;
7356 ovs_mutex_unlock(&rule->mutex);
7358 if (rule->hard_timeout) {
7359 expiration = modified + rule->hard_timeout * 1000;
7361 if (rule->idle_timeout) {
7362 uint64_t packets, bytes;
7364 long long int idle_expiration;
7366 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7367 idle_expiration = used + rule->idle_timeout * 1000;
7368 expiration = MIN(expiration, idle_expiration);
7371 if (expiration == LLONG_MAX) {
7375 /* Calculate the time of expiration as a number of (approximate) seconds
7376 * after program startup.
7378 * This should work OK for program runs that last UINT32_MAX seconds or
7379 * less. Therefore, please restart OVS at least once every 136 years. */
7380 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
7382 /* Invert the expiration offset because we're using a max-heap. */
7383 return UINT32_MAX - expiration_offset;
7386 /* Adds 'rule' to an appropriate eviction group for its oftable's
7387 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7388 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7391 * The caller must ensure that 'rule' is not already in an eviction group. */
7393 eviction_group_add_rule(struct rule *rule)
7394 OVS_REQUIRES(ofproto_mutex)
7396 struct ofproto *ofproto = rule->ofproto;
7397 struct oftable *table = &ofproto->tables[rule->table_id];
7400 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7401 * so no additional protection is needed. */
7402 has_timeout = rule->hard_timeout || rule->idle_timeout;
7404 if (table->eviction_fields && has_timeout) {
7405 struct eviction_group *evg;
7407 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7409 rule->eviction_group = evg;
7410 heap_insert(&evg->rules, &rule->evg_node,
7411 rule_eviction_priority(ofproto, rule));
7412 eviction_group_resized(table, evg);
7418 /* Initializes 'table'. */
7420 oftable_init(struct oftable *table)
7422 memset(table, 0, sizeof *table);
7423 classifier_init(&table->cls, flow_segment_u64s);
7424 table->max_flows = UINT_MAX;
7426 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7428 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7429 ARRAY_SIZE(default_prefix_fields));
7431 atomic_init(&table->n_matched, 0);
7432 atomic_init(&table->n_missed, 0);
7435 /* Destroys 'table', including its classifier and eviction groups.
7437 * The caller is responsible for freeing 'table' itself. */
7439 oftable_destroy(struct oftable *table)
7441 ovs_assert(classifier_is_empty(&table->cls));
7442 ovs_mutex_lock(&ofproto_mutex);
7443 oftable_disable_eviction(table);
7444 ovs_mutex_unlock(&ofproto_mutex);
7445 classifier_destroy(&table->cls);
7449 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7450 * string, then 'table' will use its default name.
7452 * This only affects the name exposed for a table exposed through the OpenFlow
7453 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7455 oftable_set_name(struct oftable *table, const char *name)
7457 if (name && name[0]) {
7458 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7459 if (!table->name || strncmp(name, table->name, len)) {
7461 table->name = xmemdup0(name, len);
7469 /* oftables support a choice of two policies when adding a rule would cause the
7470 * number of flows in the table to exceed the configured maximum number: either
7471 * they can refuse to add the new flow or they can evict some existing flow.
7472 * This function configures the former policy on 'table'. */
7474 oftable_disable_eviction(struct oftable *table)
7475 OVS_REQUIRES(ofproto_mutex)
7477 if (table->eviction_fields) {
7478 struct eviction_group *evg, *next;
7480 HMAP_FOR_EACH_SAFE (evg, next, id_node,
7481 &table->eviction_groups_by_id) {
7482 eviction_group_destroy(table, evg);
7484 hmap_destroy(&table->eviction_groups_by_id);
7485 heap_destroy(&table->eviction_groups_by_size);
7487 free(table->eviction_fields);
7488 table->eviction_fields = NULL;
7489 table->n_eviction_fields = 0;
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 latter policy on 'table', with fairness based
7497 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7498 * 'n_fields' as 0 disables fairness.) */
7500 oftable_enable_eviction(struct oftable *table,
7501 const struct mf_subfield *fields, size_t n_fields)
7502 OVS_REQUIRES(ofproto_mutex)
7506 if (table->eviction_fields
7507 && n_fields == table->n_eviction_fields
7509 || !memcmp(fields, table->eviction_fields,
7510 n_fields * sizeof *fields))) {
7515 oftable_disable_eviction(table);
7517 table->n_eviction_fields = n_fields;
7518 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
7520 table->eviction_group_id_basis = random_uint32();
7521 hmap_init(&table->eviction_groups_by_id);
7522 heap_init(&table->eviction_groups_by_size);
7524 CLS_FOR_EACH (rule, cr, &table->cls) {
7525 eviction_group_add_rule(rule);
7529 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7530 * it to the classifier. */
7532 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7533 OVS_REQUIRES(ofproto_mutex)
7535 const struct rule_actions *actions = rule_get_actions(rule);
7537 ovs_assert(rule->removed);
7539 if (rule->hard_timeout || rule->idle_timeout) {
7540 list_insert(&ofproto->expirable, &rule->expirable);
7542 cookies_insert(ofproto, rule);
7543 eviction_group_add_rule(rule);
7544 if (actions->has_meter) {
7545 meter_insert_rule(rule);
7547 rule->removed = false;
7550 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7551 * the removal from the classifier. */
7553 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7554 OVS_REQUIRES(ofproto_mutex)
7556 ovs_assert(!rule->removed);
7558 cookies_remove(ofproto, rule);
7560 eviction_group_remove_rule(rule);
7561 if (!list_is_empty(&rule->expirable)) {
7562 list_remove(&rule->expirable);
7564 if (!list_is_empty(&rule->meter_list_node)) {
7565 list_remove(&rule->meter_list_node);
7566 list_init(&rule->meter_list_node);
7569 rule->removed = true;
7572 /* unixctl commands. */
7575 ofproto_lookup(const char *name)
7577 struct ofproto *ofproto;
7579 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7581 if (!strcmp(ofproto->name, name)) {
7589 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7590 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7592 struct ofproto *ofproto;
7596 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7597 ds_put_format(&results, "%s\n", ofproto->name);
7599 unixctl_command_reply(conn, ds_cstr(&results));
7600 ds_destroy(&results);
7604 ofproto_unixctl_init(void)
7606 static bool registered;
7612 unixctl_command_register("ofproto/list", "", 0, 0,
7613 ofproto_unixctl_list, NULL);
7616 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7618 * This is deprecated. It is only for compatibility with broken device drivers
7619 * in old versions of Linux that do not properly support VLANs when VLAN
7620 * devices are not used. When broken device drivers are no longer in
7621 * widespread use, we will delete these interfaces. */
7623 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7624 * (exactly) by an OpenFlow rule in 'ofproto'. */
7626 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7629 struct cls_rule target;
7630 const struct oftable *oftable;
7632 match_init_catchall(&match);
7633 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7634 cls_rule_init(&target, &match, 0, CLS_MAX_VERSION);
7636 free(ofproto->vlan_bitmap);
7637 ofproto->vlan_bitmap = bitmap_allocate(4096);
7638 ofproto->vlans_changed = false;
7640 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7643 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7644 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7645 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7647 bitmap_set1(vlan_bitmap, vid);
7648 bitmap_set1(ofproto->vlan_bitmap, vid);
7653 cls_rule_destroy(&target);
7656 /* Returns true if new VLANs have come into use by the flow table since the
7657 * last call to ofproto_get_vlan_usage().
7659 * We don't track when old VLANs stop being used. */
7661 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7663 return ofproto->vlans_changed;
7666 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7667 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7668 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7669 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7670 * then the VLAN device is un-enslaved. */
7672 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7673 ofp_port_t realdev_ofp_port, int vid)
7675 struct ofport *ofport;
7678 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7680 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7682 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7683 ofproto->name, vlandev_ofp_port);
7687 if (!ofproto->ofproto_class->set_realdev) {
7688 if (!vlandev_ofp_port) {
7691 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7695 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7697 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7698 ofproto->name, vlandev_ofp_port,
7699 netdev_get_name(ofport->netdev), ovs_strerror(error));