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 unsigned int extra_space)
86 OVS_REQUIRES(ofproto_mutex);
87 static void oftable_disable_eviction(struct oftable *);
88 static void oftable_enable_eviction(struct oftable *,
89 const struct mf_subfield *fields,
92 /* A set of rules within a single OpenFlow table (oftable) that have the same
93 * values for the oftable's eviction_fields. A rule to be evicted, when one is
94 * needed, is taken from the eviction group that contains the greatest number
97 * An oftable owns any number of eviction groups, each of which contains any
100 * Membership in an eviction group is imprecise, based on the hash of the
101 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
102 * That is, if two rules have different eviction_fields, but those
103 * eviction_fields hash to the same value, then they will belong to the same
104 * eviction_group anyway.
106 * (When eviction is not enabled on an oftable, we don't track any eviction
107 * groups, to save time and space.) */
108 struct eviction_group {
109 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
110 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
111 struct heap rules; /* Contains "struct rule"s. */
114 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
115 OVS_REQUIRES(ofproto_mutex);
116 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *)
117 OVS_REQUIRES(ofproto_mutex);;
118 static void eviction_group_add_rule(struct rule *)
119 OVS_REQUIRES(ofproto_mutex);
120 static void eviction_group_remove_rule(struct rule *)
121 OVS_REQUIRES(ofproto_mutex);
123 /* Criteria that flow_mod and other operations use for selecting rules on
124 * which to operate. */
125 struct rule_criteria {
126 /* An OpenFlow table or 255 for all tables. */
129 /* OpenFlow matching criteria. Interpreted different in "loose" way by
130 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
131 * defined in the OpenFlow spec. */
134 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
135 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
136 * The rule will not be selected if M is 1 and B != C. */
138 ovs_be64 cookie_mask;
140 /* Selection based on actions within a rule:
142 * If out_port != OFPP_ANY, selects only rules that output to out_port.
143 * If out_group != OFPG_ALL, select only rules that output to out_group. */
147 /* If true, collects only rules that are modifiable. */
149 bool include_readonly;
152 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
153 const struct match *match, int priority,
155 ovs_be64 cookie, ovs_be64 cookie_mask,
156 ofp_port_t out_port, uint32_t out_group);
157 static void rule_criteria_require_rw(struct rule_criteria *,
158 bool can_write_readonly);
159 static void rule_criteria_destroy(struct rule_criteria *);
161 static enum ofperr collect_rules_loose(struct ofproto *,
162 const struct rule_criteria *,
163 struct rule_collection *);
165 /* A packet that needs to be passed to rule_execute().
167 * (We can't do this immediately from ofopgroup_complete() because that holds
168 * ofproto_mutex, which rule_execute() needs released.) */
169 struct rule_execute {
170 struct ovs_list list_node; /* In struct ofproto's "rule_executes" list. */
171 struct rule *rule; /* Owns a reference to the rule. */
173 struct dp_packet *packet; /* Owns the packet. */
176 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
177 static void destroy_rule_executes(struct ofproto *);
179 struct learned_cookie {
181 /* In struct ofproto's 'learned_cookies' hmap. */
182 struct hmap_node hmap_node OVS_GUARDED_BY(ofproto_mutex);
184 /* In 'dead_cookies' list when removed from hmap. */
185 struct ovs_list list_node;
189 ovs_be64 cookie OVS_GUARDED_BY(ofproto_mutex);
190 uint8_t table_id OVS_GUARDED_BY(ofproto_mutex);
192 /* Number of references from "learn" actions.
194 * When this drops to 0, all of the flows in 'table_id' with the specified
195 * 'cookie' are deleted. */
196 int n OVS_GUARDED_BY(ofproto_mutex);
199 static const struct ofpact_learn *next_learn_with_delete(
200 const struct rule_actions *, const struct ofpact_learn *start);
202 static void learned_cookies_inc(struct ofproto *, const struct rule_actions *)
203 OVS_REQUIRES(ofproto_mutex);
204 static void learned_cookies_dec(struct ofproto *, const struct rule_actions *,
205 struct ovs_list *dead_cookies)
206 OVS_REQUIRES(ofproto_mutex);
207 static void learned_cookies_flush(struct ofproto *, struct ovs_list *dead_cookies)
208 OVS_REQUIRES(ofproto_mutex);
211 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
212 static void ofport_destroy(struct ofport *);
214 static void update_port(struct ofproto *, const char *devname);
215 static int init_ports(struct ofproto *);
216 static void reinit_ports(struct ofproto *);
218 static long long int ofport_get_usage(const struct ofproto *,
219 ofp_port_t ofp_port);
220 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
221 long long int last_used);
222 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
226 * Keeps track of the currently used and recently used ofport values and is
227 * used to prevent immediate recycling of ofport values. */
228 struct ofport_usage {
229 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
230 ofp_port_t ofp_port; /* OpenFlow port number. */
231 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
232 represents in-use ofports. */
236 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
237 static bool rule_is_readonly(const struct rule *);
238 static void ofproto_rule_insert__(struct ofproto *, struct rule *)
239 OVS_REQUIRES(ofproto_mutex);
240 static void ofproto_rule_remove__(struct ofproto *, struct rule *)
241 OVS_REQUIRES(ofproto_mutex);
243 /* The source of a flow_mod request, in the code that processes flow_mods.
245 * A flow table modification request can be generated externally, via OpenFlow,
246 * or internally through a function call. This structure indicates the source
247 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
248 * meaningful and thus supplied as NULL. */
249 struct flow_mod_requester {
250 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
251 const struct ofp_header *request;
255 static enum ofperr replace_rule_create(struct ofproto *,
256 struct ofputil_flow_mod *,
257 struct cls_rule *cr, uint8_t table_id,
258 struct rule *old_rule,
259 struct rule **new_rule)
260 OVS_REQUIRES(ofproto_mutex);
262 static void replace_rule_start(struct ofproto *,
263 struct rule *old_rule,
264 struct rule *new_rule,
265 struct cls_conjunction *, size_t n_conjs)
266 OVS_REQUIRES(ofproto_mutex);
268 static void replace_rule_revert(struct ofproto *,
269 struct rule *old_rule, struct rule *new_rule)
270 OVS_REQUIRES(ofproto_mutex);
272 static void replace_rule_finish(struct ofproto *, struct ofputil_flow_mod *,
273 const struct flow_mod_requester *,
274 struct rule *old_rule, struct rule *new_rule,
275 struct ovs_list *dead_cookies)
276 OVS_REQUIRES(ofproto_mutex);
277 static void delete_flows__(struct rule_collection *,
278 enum ofp_flow_removed_reason,
279 const struct flow_mod_requester *)
280 OVS_REQUIRES(ofproto_mutex);
282 static void send_buffered_packet(const struct flow_mod_requester *,
283 uint32_t buffer_id, struct rule *)
284 OVS_REQUIRES(ofproto_mutex);
286 static bool ofproto_group_exists__(const struct ofproto *ofproto,
288 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
289 static bool ofproto_group_exists(const struct ofproto *ofproto,
291 OVS_EXCLUDED(ofproto->groups_rwlock);
292 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
293 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
294 static enum ofperr do_bundle_flow_mod_start(struct ofproto *,
295 struct ofputil_flow_mod *,
296 struct ofp_bundle_entry *)
297 OVS_REQUIRES(ofproto_mutex);
298 static void do_bundle_flow_mod_finish(struct ofproto *,
299 struct ofputil_flow_mod *,
300 const struct flow_mod_requester *,
301 struct ofp_bundle_entry *)
302 OVS_REQUIRES(ofproto_mutex);
303 static enum ofperr handle_flow_mod__(struct ofproto *,
304 struct ofputil_flow_mod *,
305 const struct flow_mod_requester *)
306 OVS_EXCLUDED(ofproto_mutex);
307 static void calc_duration(long long int start, long long int now,
308 uint32_t *sec, uint32_t *nsec);
311 static uint64_t pick_datapath_id(const struct ofproto *);
312 static uint64_t pick_fallback_dpid(void);
313 static void ofproto_destroy__(struct ofproto *);
314 static void update_mtu(struct ofproto *, struct ofport *);
315 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
316 static void meter_insert_rule(struct rule *);
319 static void ofproto_unixctl_init(void);
321 /* All registered ofproto classes, in probe order. */
322 static const struct ofproto_class **ofproto_classes;
323 static size_t n_ofproto_classes;
324 static size_t allocated_ofproto_classes;
326 /* Global lock that protects all flow table operations. */
327 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
329 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
330 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
332 size_t n_handlers, n_revalidators;
336 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
337 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
339 /* Initial mappings of port to OpenFlow number mappings. */
340 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
342 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
344 /* The default value of true waits for flow restore. */
345 static bool flow_restore_wait = true;
347 /* Must be called to initialize the ofproto library.
349 * The caller may pass in 'iface_hints', which contains an shash of
350 * "iface_hint" elements indexed by the interface's name. The provider
351 * may use these hints to describe the startup configuration in order to
352 * reinitialize its state. The caller owns the provided data, so a
353 * provider will make copies of anything required. An ofproto provider
354 * will remove any existing state that is not described by the hint, and
355 * may choose to remove it all. */
357 ofproto_init(const struct shash *iface_hints)
359 struct shash_node *node;
362 ofproto_class_register(&ofproto_dpif_class);
364 /* Make a local copy, since we don't own 'iface_hints' elements. */
365 SHASH_FOR_EACH(node, iface_hints) {
366 const struct iface_hint *orig_hint = node->data;
367 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
368 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
370 new_hint->br_name = xstrdup(orig_hint->br_name);
371 new_hint->br_type = xstrdup(br_type);
372 new_hint->ofp_port = orig_hint->ofp_port;
374 shash_add(&init_ofp_ports, node->name, new_hint);
377 for (i = 0; i < n_ofproto_classes; i++) {
378 ofproto_classes[i]->init(&init_ofp_ports);
382 /* 'type' should be a normalized datapath type, as returned by
383 * ofproto_normalize_type(). Returns the corresponding ofproto_class
384 * structure, or a null pointer if there is none registered for 'type'. */
385 static const struct ofproto_class *
386 ofproto_class_find__(const char *type)
390 for (i = 0; i < n_ofproto_classes; i++) {
391 const struct ofproto_class *class = ofproto_classes[i];
396 class->enumerate_types(&types);
397 found = sset_contains(&types, type);
398 sset_destroy(&types);
404 VLOG_WARN("unknown datapath type %s", type);
408 /* Registers a new ofproto class. After successful registration, new ofprotos
409 * of that type can be created using ofproto_create(). */
411 ofproto_class_register(const struct ofproto_class *new_class)
415 for (i = 0; i < n_ofproto_classes; i++) {
416 if (ofproto_classes[i] == new_class) {
421 if (n_ofproto_classes >= allocated_ofproto_classes) {
422 ofproto_classes = x2nrealloc(ofproto_classes,
423 &allocated_ofproto_classes,
424 sizeof *ofproto_classes);
426 ofproto_classes[n_ofproto_classes++] = new_class;
430 /* Unregisters a datapath provider. 'type' must have been previously
431 * registered and not currently be in use by any ofprotos. After
432 * unregistration new datapaths of that type cannot be opened using
433 * ofproto_create(). */
435 ofproto_class_unregister(const struct ofproto_class *class)
439 for (i = 0; i < n_ofproto_classes; i++) {
440 if (ofproto_classes[i] == class) {
441 for (i++; i < n_ofproto_classes; i++) {
442 ofproto_classes[i - 1] = ofproto_classes[i];
448 VLOG_WARN("attempted to unregister an ofproto class that is not "
453 /* Clears 'types' and enumerates all registered ofproto types into it. The
454 * caller must first initialize the sset. */
456 ofproto_enumerate_types(struct sset *types)
461 for (i = 0; i < n_ofproto_classes; i++) {
462 ofproto_classes[i]->enumerate_types(types);
466 /* Returns the fully spelled out name for the given ofproto 'type'.
468 * Normalized type string can be compared with strcmp(). Unnormalized type
469 * string might be the same even if they have different spellings. */
471 ofproto_normalize_type(const char *type)
473 return type && type[0] ? type : "system";
476 /* Clears 'names' and enumerates the names of all known created ofprotos with
477 * the given 'type'. The caller must first initialize the sset. Returns 0 if
478 * successful, otherwise a positive errno value.
480 * Some kinds of datapaths might not be practically enumerable. This is not
481 * considered an error. */
483 ofproto_enumerate_names(const char *type, struct sset *names)
485 const struct ofproto_class *class = ofproto_class_find__(type);
486 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
490 ofproto_bump_tables_version(struct ofproto *ofproto)
492 ++ofproto->tables_version;
493 ofproto->ofproto_class->set_tables_version(ofproto,
494 ofproto->tables_version);
498 ofproto_create(const char *datapath_name, const char *datapath_type,
499 struct ofproto **ofprotop)
501 const struct ofproto_class *class;
502 struct ofproto *ofproto;
508 ofproto_unixctl_init();
510 datapath_type = ofproto_normalize_type(datapath_type);
511 class = ofproto_class_find__(datapath_type);
513 VLOG_WARN("could not create datapath %s of unknown type %s",
514 datapath_name, datapath_type);
518 ofproto = class->alloc();
520 VLOG_ERR("failed to allocate datapath %s of type %s",
521 datapath_name, datapath_type);
526 ovs_mutex_lock(&ofproto_mutex);
527 memset(ofproto, 0, sizeof *ofproto);
528 ofproto->ofproto_class = class;
529 ofproto->name = xstrdup(datapath_name);
530 ofproto->type = xstrdup(datapath_type);
531 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
532 hash_string(ofproto->name, 0));
533 ofproto->datapath_id = 0;
534 ofproto->forward_bpdu = false;
535 ofproto->fallback_dpid = pick_fallback_dpid();
536 ofproto->mfr_desc = NULL;
537 ofproto->hw_desc = NULL;
538 ofproto->sw_desc = NULL;
539 ofproto->serial_desc = NULL;
540 ofproto->dp_desc = NULL;
541 ofproto->frag_handling = OFPC_FRAG_NORMAL;
542 hmap_init(&ofproto->ports);
543 hmap_init(&ofproto->ofport_usage);
544 shash_init(&ofproto->port_by_name);
545 simap_init(&ofproto->ofp_requests);
546 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
547 ofproto->eviction_group_timer = LLONG_MIN;
548 ofproto->tables = NULL;
549 ofproto->n_tables = 0;
550 ofproto->tables_version = CLS_MIN_VERSION;
551 hindex_init(&ofproto->cookies);
552 hmap_init(&ofproto->learned_cookies);
553 list_init(&ofproto->expirable);
554 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
555 guarded_list_init(&ofproto->rule_executes);
556 ofproto->vlan_bitmap = NULL;
557 ofproto->vlans_changed = false;
558 ofproto->min_mtu = INT_MAX;
559 ovs_rwlock_init(&ofproto->groups_rwlock);
560 hmap_init(&ofproto->groups);
561 ovs_mutex_unlock(&ofproto_mutex);
562 ofproto->ogf.types = 0xf;
563 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
564 OFPGFC_SELECT_WEIGHT;
565 for (i = 0; i < 4; i++) {
566 ofproto->ogf.max_groups[i] = OFPG_MAX;
567 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
570 error = ofproto->ofproto_class->construct(ofproto);
572 VLOG_ERR("failed to open datapath %s: %s",
573 datapath_name, ovs_strerror(error));
574 connmgr_destroy(ofproto->connmgr);
575 ofproto_destroy__(ofproto);
579 /* Check that hidden tables, if any, are at the end. */
580 ovs_assert(ofproto->n_tables);
581 for (i = 0; i + 1 < ofproto->n_tables; i++) {
582 enum oftable_flags flags = ofproto->tables[i].flags;
583 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
585 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
588 ofproto->datapath_id = pick_datapath_id(ofproto);
591 /* Initialize meters table. */
592 if (ofproto->ofproto_class->meter_get_features) {
593 ofproto->ofproto_class->meter_get_features(ofproto,
594 &ofproto->meter_features);
596 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
598 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
599 * sizeof(struct meter *));
601 /* Set the initial tables version. */
602 ofproto_bump_tables_version(ofproto);
608 /* Must be called (only) by an ofproto implementation in its constructor
609 * function. See the large comment on 'construct' in struct ofproto_class for
612 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
614 struct oftable *table;
616 ovs_assert(!ofproto->n_tables);
617 ovs_assert(n_tables >= 1 && n_tables <= 255);
619 ofproto->n_tables = n_tables;
620 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
621 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
626 /* To be optionally called (only) by an ofproto implementation in its
627 * constructor function. See the large comment on 'construct' in struct
628 * ofproto_class for details.
630 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
631 * will then ensure that actions passed into the ofproto implementation will
632 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
633 * function is not called, there will be no such restriction.
635 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
636 * the 'max_ports' restriction. */
638 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
640 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
641 ofproto->max_ports = max_ports;
645 ofproto_get_datapath_id(const struct ofproto *ofproto)
647 return ofproto->datapath_id;
651 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
653 uint64_t old_dpid = p->datapath_id;
654 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
655 if (p->datapath_id != old_dpid) {
656 /* Force all active connections to reconnect, since there is no way to
657 * notify a controller that the datapath ID has changed. */
658 ofproto_reconnect_controllers(p);
663 ofproto_set_controllers(struct ofproto *p,
664 const struct ofproto_controller *controllers,
665 size_t n_controllers, uint32_t allowed_versions)
667 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
672 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
674 connmgr_set_fail_mode(p->connmgr, fail_mode);
677 /* Drops the connections between 'ofproto' and all of its controllers, forcing
678 * them to reconnect. */
680 ofproto_reconnect_controllers(struct ofproto *ofproto)
682 connmgr_reconnect(ofproto->connmgr);
685 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
686 * in-band control should guarantee access, in the same way that in-band
687 * control guarantees access to OpenFlow controllers. */
689 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
690 const struct sockaddr_in *extras, size_t n)
692 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
695 /* Sets the OpenFlow queue used by flows set up by in-band control on
696 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
697 * flows will use the default queue. */
699 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
701 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
704 /* Sets the number of flows at which eviction from the kernel flow table
707 ofproto_set_flow_limit(unsigned limit)
709 ofproto_flow_limit = limit;
712 /* Sets the maximum idle time for flows in the datapath before they are
715 ofproto_set_max_idle(unsigned max_idle)
717 ofproto_max_idle = max_idle;
720 /* If forward_bpdu is true, the NORMAL action will forward frames with
721 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
722 * the NORMAL action will drop these frames. */
724 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
726 bool old_val = ofproto->forward_bpdu;
727 ofproto->forward_bpdu = forward_bpdu;
728 if (old_val != ofproto->forward_bpdu) {
729 if (ofproto->ofproto_class->forward_bpdu_changed) {
730 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
735 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
736 * 'idle_time', in seconds, and the maximum number of MAC table entries to
739 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
742 if (ofproto->ofproto_class->set_mac_table_config) {
743 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
748 /* Multicast snooping configuration. */
750 /* Configures multicast snooping on 'ofproto' using the settings
751 * defined in 's'. If 's' is NULL, disables multicast snooping.
753 * Returns 0 if successful, otherwise a positive errno value. */
755 ofproto_set_mcast_snooping(struct ofproto *ofproto,
756 const struct ofproto_mcast_snooping_settings *s)
758 return (ofproto->ofproto_class->set_mcast_snooping
759 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
763 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
765 * Returns 0 if successful, otherwise a positive errno value.*/
767 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
768 const struct ofproto_mcast_snooping_port_settings *s)
770 return (ofproto->ofproto_class->set_mcast_snooping_port
771 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
776 ofproto_set_n_dpdk_rxqs(int n_rxqs)
778 n_dpdk_rxqs = MAX(n_rxqs, 0);
782 ofproto_set_cpu_mask(const char *cmask)
786 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
790 ofproto_set_threads(int n_handlers_, int n_revalidators_)
792 int threads = MAX(count_cpu_cores(), 2);
794 n_revalidators = MAX(n_revalidators_, 0);
795 n_handlers = MAX(n_handlers_, 0);
797 if (!n_revalidators) {
798 n_revalidators = n_handlers
799 ? MAX(threads - (int) n_handlers, 1)
804 n_handlers = MAX(threads - (int) n_revalidators, 1);
809 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
812 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
816 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
818 return connmgr_set_snoops(ofproto->connmgr, snoops);
822 ofproto_set_netflow(struct ofproto *ofproto,
823 const struct netflow_options *nf_options)
825 if (nf_options && sset_is_empty(&nf_options->collectors)) {
829 if (ofproto->ofproto_class->set_netflow) {
830 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
832 return nf_options ? EOPNOTSUPP : 0;
837 ofproto_set_sflow(struct ofproto *ofproto,
838 const struct ofproto_sflow_options *oso)
840 if (oso && sset_is_empty(&oso->targets)) {
844 if (ofproto->ofproto_class->set_sflow) {
845 return ofproto->ofproto_class->set_sflow(ofproto, oso);
847 return oso ? EOPNOTSUPP : 0;
852 ofproto_set_ipfix(struct ofproto *ofproto,
853 const struct ofproto_ipfix_bridge_exporter_options *bo,
854 const struct ofproto_ipfix_flow_exporter_options *fo,
857 if (ofproto->ofproto_class->set_ipfix) {
858 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
860 return (bo || fo) ? EOPNOTSUPP : 0;
865 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
867 flow_restore_wait = flow_restore_wait_db;
871 ofproto_get_flow_restore_wait(void)
873 return flow_restore_wait;
877 /* Spanning Tree Protocol (STP) configuration. */
879 /* Configures STP on 'ofproto' using the settings defined in 's'. If
880 * 's' is NULL, disables STP.
882 * Returns 0 if successful, otherwise a positive errno value. */
884 ofproto_set_stp(struct ofproto *ofproto,
885 const struct ofproto_stp_settings *s)
887 return (ofproto->ofproto_class->set_stp
888 ? ofproto->ofproto_class->set_stp(ofproto, s)
892 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
893 * 'enabled' member of 's' is false, then the other members are not
896 * Returns 0 if successful, otherwise a positive errno value. */
898 ofproto_get_stp_status(struct ofproto *ofproto,
899 struct ofproto_stp_status *s)
901 return (ofproto->ofproto_class->get_stp_status
902 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
906 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
907 * in 's'. The caller is responsible for assigning STP port numbers
908 * (using the 'port_num' member in the range of 1 through 255, inclusive)
909 * and ensuring there are no duplicates. If the 's' is NULL, then STP
910 * is disabled on the port.
912 * Returns 0 if successful, otherwise a positive errno value.*/
914 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
915 const struct ofproto_port_stp_settings *s)
917 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
919 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
920 ofproto->name, ofp_port);
924 return (ofproto->ofproto_class->set_stp_port
925 ? ofproto->ofproto_class->set_stp_port(ofport, s)
929 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
930 * 's'. If the 'enabled' member in 's' is false, then the other members
931 * are not meaningful.
933 * Returns 0 if successful, otherwise a positive errno value.*/
935 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
936 struct ofproto_port_stp_status *s)
938 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
940 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
941 "port %"PRIu16, ofproto->name, ofp_port);
945 return (ofproto->ofproto_class->get_stp_port_status
946 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
950 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
951 * 's'. If the 'enabled' member in 's' is false, then the other members
952 * are not meaningful.
954 * Returns 0 if successful, otherwise a positive errno value.*/
956 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
957 struct ofproto_port_stp_stats *s)
959 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
961 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
962 "port %"PRIu16, ofproto->name, ofp_port);
966 return (ofproto->ofproto_class->get_stp_port_stats
967 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
971 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
973 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
974 * 's' is NULL, disables RSTP.
976 * Returns 0 if successful, otherwise a positive errno value. */
978 ofproto_set_rstp(struct ofproto *ofproto,
979 const struct ofproto_rstp_settings *s)
981 if (!ofproto->ofproto_class->set_rstp) {
984 ofproto->ofproto_class->set_rstp(ofproto, s);
988 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
989 * 'enabled' member of 's' is false, then the other members are not
992 * Returns 0 if successful, otherwise a positive errno value. */
994 ofproto_get_rstp_status(struct ofproto *ofproto,
995 struct ofproto_rstp_status *s)
997 if (!ofproto->ofproto_class->get_rstp_status) {
1000 ofproto->ofproto_class->get_rstp_status(ofproto, s);
1004 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1005 * in 's'. The caller is responsible for assigning RSTP port numbers
1006 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1007 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1008 * is disabled on the port.
1010 * Returns 0 if successful, otherwise a positive errno value.*/
1012 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
1013 const struct ofproto_port_rstp_settings *s)
1015 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1017 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
1018 ofproto->name, ofp_port);
1022 if (!ofproto->ofproto_class->set_rstp_port) {
1025 ofproto->ofproto_class->set_rstp_port(ofport, s);
1029 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1030 * 's'. If the 'enabled' member in 's' is false, then the other members
1031 * are not meaningful.
1033 * Returns 0 if successful, otherwise a positive errno value.*/
1035 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1036 struct ofproto_port_rstp_status *s)
1038 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1040 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1041 "port %"PRIu16, ofproto->name, ofp_port);
1045 if (!ofproto->ofproto_class->get_rstp_port_status) {
1048 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1052 /* Queue DSCP configuration. */
1054 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1055 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1056 * to implement QoS. Instead, it is used to implement features which require
1057 * knowledge of what queues exist on a port, and some basic information about
1060 * Returns 0 if successful, otherwise a positive errno value. */
1062 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1063 const struct ofproto_port_queue *queues,
1066 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1069 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1070 ofproto->name, ofp_port);
1074 return (ofproto->ofproto_class->set_queues
1075 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1079 /* LLDP configuration. */
1081 ofproto_port_set_lldp(struct ofproto *ofproto,
1082 ofp_port_t ofp_port,
1083 const struct smap *cfg)
1085 struct ofport *ofport;
1088 ofport = ofproto_get_port(ofproto, ofp_port);
1090 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1091 ofproto->name, ofp_port);
1094 error = (ofproto->ofproto_class->set_lldp
1095 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1098 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1099 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1100 ovs_strerror(error));
1105 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1106 const struct aa_settings *s)
1108 if (!ofproto->ofproto_class->set_aa) {
1111 ofproto->ofproto_class->set_aa(ofproto, s);
1116 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1117 const struct aa_mapping_settings *s)
1119 if (!ofproto->ofproto_class->aa_mapping_set) {
1122 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1127 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1129 if (!ofproto->ofproto_class->aa_mapping_unset) {
1132 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1137 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1138 struct ovs_list *list)
1140 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1143 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1148 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1150 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1153 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1156 /* Connectivity Fault Management configuration. */
1158 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1160 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1162 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1163 if (ofport && ofproto->ofproto_class->set_cfm) {
1164 ofproto->ofproto_class->set_cfm(ofport, NULL);
1168 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1169 * basic configuration from the configuration members in 'cfm', and the remote
1170 * maintenance point ID from remote_mpid. Ignores the statistics members of
1173 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1175 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1176 const struct cfm_settings *s)
1178 struct ofport *ofport;
1181 ofport = ofproto_get_port(ofproto, ofp_port);
1183 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1184 ofproto->name, ofp_port);
1188 /* XXX: For configuration simplicity, we only support one remote_mpid
1189 * outside of the CFM module. It's not clear if this is the correct long
1190 * term solution or not. */
1191 error = (ofproto->ofproto_class->set_cfm
1192 ? ofproto->ofproto_class->set_cfm(ofport, s)
1195 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1196 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1197 ovs_strerror(error));
1201 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1202 * 'ofproto' does not have a port 'ofp_port'. */
1204 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1205 const struct smap *cfg)
1207 struct ofport *ofport;
1210 ofport = ofproto_get_port(ofproto, ofp_port);
1212 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1213 ofproto->name, ofp_port);
1217 error = (ofproto->ofproto_class->set_bfd
1218 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1221 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1222 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1223 ovs_strerror(error));
1227 /* Checks the status change of BFD on 'ofport'.
1229 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1231 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1233 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1234 return (ofport && ofproto->ofproto_class->bfd_status_changed
1235 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1239 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1240 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1241 * is not an OpenFlow port in 'ofproto'.
1243 * The caller must provide and own '*status'. */
1245 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1246 struct smap *status)
1248 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1249 return (ofport && ofproto->ofproto_class->get_bfd_status
1250 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1254 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1255 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1256 * 0 if LACP partner information is not current (generally indicating a
1257 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1259 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1261 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1262 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1263 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1268 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1270 struct ofproto *ofproto = port->ofproto;
1273 if (ofproto->ofproto_class->port_get_lacp_stats) {
1274 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1284 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1285 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1286 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1287 * configuration plus, if there is more than one slave, a bonding
1290 * If 'aux' is already registered then this function updates its configuration
1291 * to 's'. Otherwise, this function registers a new bundle.
1293 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1296 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1297 const struct ofproto_bundle_settings *s)
1299 return (ofproto->ofproto_class->bundle_set
1300 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1304 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1305 * If no such bundle has been registered, this has no effect. */
1307 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1309 return ofproto_bundle_register(ofproto, aux, NULL);
1313 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1314 * If 'aux' is already registered then this function updates its configuration
1315 * to 's'. Otherwise, this function registers a new mirror. */
1317 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1318 const struct ofproto_mirror_settings *s)
1320 return (ofproto->ofproto_class->mirror_set
1321 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1325 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1326 * If no mirror has been registered, this has no effect. */
1328 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1330 return ofproto_mirror_register(ofproto, aux, NULL);
1333 /* Retrieves statistics from mirror associated with client data pointer
1334 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1335 * 'bytes', respectively. If a particular counters is not supported,
1336 * the appropriate argument is set to UINT64_MAX.
1339 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1340 uint64_t *packets, uint64_t *bytes)
1342 if (!ofproto->ofproto_class->mirror_get_stats) {
1343 *packets = *bytes = UINT64_MAX;
1347 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1351 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1352 * which all packets are flooded, instead of using MAC learning. If
1353 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1355 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1358 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1360 return (ofproto->ofproto_class->set_flood_vlans
1361 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1365 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1366 * output for a mirror. */
1368 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1370 return (ofproto->ofproto_class->is_mirror_output_bundle
1371 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1375 /* Configuration of OpenFlow tables. */
1377 /* Returns the number of OpenFlow tables in 'ofproto'. */
1379 ofproto_get_n_tables(const struct ofproto *ofproto)
1381 return ofproto->n_tables;
1384 /* Returns the number of Controller visible OpenFlow tables
1385 * in 'ofproto'. This number will exclude Hidden tables.
1386 * This funtion's return value should be less or equal to that of
1387 * ofproto_get_n_tables() . */
1389 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1391 uint8_t n = ofproto->n_tables;
1393 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1394 * if present, are always at the end.) */
1395 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1402 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1403 * settings from 's'. 'table_id' must be in the range 0 through the number of
1404 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1406 * For read-only tables, only the name may be configured. */
1408 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1409 const struct ofproto_table_settings *s)
1411 struct oftable *table;
1413 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1414 table = &ofproto->tables[table_id];
1416 oftable_set_name(table, s->name);
1418 if (table->flags & OFTABLE_READONLY) {
1423 oftable_enable_eviction(table, s->groups, s->n_groups);
1425 oftable_disable_eviction(table);
1428 table->max_flows = s->max_flows;
1430 if (classifier_set_prefix_fields(&table->cls,
1431 s->prefix_fields, s->n_prefix_fields)) {
1432 /* XXX: Trigger revalidation. */
1435 ovs_mutex_lock(&ofproto_mutex);
1436 evict_rules_from_table(table, 0);
1437 ovs_mutex_unlock(&ofproto_mutex);
1441 ofproto_has_snoops(const struct ofproto *ofproto)
1443 return connmgr_has_snoops(ofproto->connmgr);
1447 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1449 connmgr_get_snoops(ofproto->connmgr, snoops);
1452 /* Deletes 'rule' from 'ofproto'.
1454 * Within an ofproto implementation, this function allows an ofproto
1455 * implementation to destroy any rules that remain when its ->destruct()
1456 * function is called. This function is not suitable for use elsewhere in an
1457 * ofproto implementation.
1459 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1460 * Cycle" in ofproto-provider.h. */
1462 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1463 OVS_EXCLUDED(ofproto_mutex)
1465 /* This skips the ofmonitor and flow-removed notifications because the
1466 * switch is being deleted and any OpenFlow channels have been or soon will
1468 ovs_mutex_lock(&ofproto_mutex);
1470 if (!rule->removed) {
1471 /* Make sure there is no postponed removal of the rule. */
1472 ovs_assert(cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
1474 if (!classifier_remove(&rule->ofproto->tables[rule->table_id].cls,
1478 ofproto_rule_remove__(rule->ofproto, rule);
1479 ofproto->ofproto_class->rule_delete(rule);
1480 ofproto_rule_unref(rule);
1482 ovs_mutex_unlock(&ofproto_mutex);
1486 ofproto_flush__(struct ofproto *ofproto)
1487 OVS_EXCLUDED(ofproto_mutex)
1489 struct oftable *table;
1491 /* This will flush all datapath flows. */
1492 if (ofproto->ofproto_class->flush) {
1493 ofproto->ofproto_class->flush(ofproto);
1496 /* XXX: There is a small race window here, where new datapath flows can be
1497 * created by upcall handlers based on the existing flow table. We can not
1498 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1499 * as then we could deadlock on syncing with the handler threads waiting on
1500 * the same mutex. */
1502 ovs_mutex_lock(&ofproto_mutex);
1503 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1504 struct rule_collection rules;
1507 if (table->flags & OFTABLE_HIDDEN) {
1511 rule_collection_init(&rules);
1513 CLS_FOR_EACH (rule, cr, &table->cls) {
1514 rule_collection_add(&rules, rule);
1516 delete_flows__(&rules, OFPRR_DELETE, NULL);
1518 /* XXX: Concurrent handler threads may insert new learned flows based on
1519 * learn actions of the now deleted flows right after we release
1520 * 'ofproto_mutex'. */
1521 ovs_mutex_unlock(&ofproto_mutex);
1524 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1527 ofproto_destroy__(struct ofproto *ofproto)
1528 OVS_EXCLUDED(ofproto_mutex)
1530 struct oftable *table;
1532 destroy_rule_executes(ofproto);
1533 delete_group(ofproto, OFPG_ALL);
1535 guarded_list_destroy(&ofproto->rule_executes);
1536 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1537 hmap_destroy(&ofproto->groups);
1539 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1540 free(ofproto->name);
1541 free(ofproto->type);
1542 free(ofproto->mfr_desc);
1543 free(ofproto->hw_desc);
1544 free(ofproto->sw_desc);
1545 free(ofproto->serial_desc);
1546 free(ofproto->dp_desc);
1547 hmap_destroy(&ofproto->ports);
1548 hmap_destroy(&ofproto->ofport_usage);
1549 shash_destroy(&ofproto->port_by_name);
1550 simap_destroy(&ofproto->ofp_requests);
1552 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1553 oftable_destroy(table);
1555 free(ofproto->tables);
1557 ovs_assert(hindex_is_empty(&ofproto->cookies));
1558 hindex_destroy(&ofproto->cookies);
1560 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1561 hmap_destroy(&ofproto->learned_cookies);
1563 free(ofproto->vlan_bitmap);
1565 ofproto->ofproto_class->dealloc(ofproto);
1568 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1569 * - 1st we defer the removal of the rules from the classifier
1570 * - 2nd we defer the actual destruction of the rules. */
1572 ofproto_destroy_defer__(struct ofproto *ofproto)
1573 OVS_EXCLUDED(ofproto_mutex)
1575 ovsrcu_postpone(ofproto_destroy__, ofproto);
1579 ofproto_destroy(struct ofproto *p)
1580 OVS_EXCLUDED(ofproto_mutex)
1582 struct ofport *ofport, *next_ofport;
1583 struct ofport_usage *usage, *next_usage;
1590 meter_delete(p, 1, p->meter_features.max_meters);
1591 p->meter_features.max_meters = 0;
1597 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1598 ofport_destroy(ofport);
1601 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1602 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1606 p->ofproto_class->destruct(p);
1608 /* We should not postpone this because it involves deleting a listening
1609 * socket which we may want to reopen soon. 'connmgr' should not be used
1610 * by other threads */
1611 connmgr_destroy(p->connmgr);
1613 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1614 ovsrcu_postpone(ofproto_destroy_defer__, p);
1617 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1618 * kernel datapath, for example, this destroys the datapath in the kernel, and
1619 * with the netdev-based datapath, it tears down the data structures that
1620 * represent the datapath.
1622 * The datapath should not be currently open as an ofproto. */
1624 ofproto_delete(const char *name, const char *type)
1626 const struct ofproto_class *class = ofproto_class_find__(type);
1627 return (!class ? EAFNOSUPPORT
1628 : !class->del ? EACCES
1629 : class->del(type, name));
1633 process_port_change(struct ofproto *ofproto, int error, char *devname)
1635 if (error == ENOBUFS) {
1636 reinit_ports(ofproto);
1637 } else if (!error) {
1638 update_port(ofproto, devname);
1644 ofproto_type_run(const char *datapath_type)
1646 const struct ofproto_class *class;
1649 datapath_type = ofproto_normalize_type(datapath_type);
1650 class = ofproto_class_find__(datapath_type);
1652 error = class->type_run ? class->type_run(datapath_type) : 0;
1653 if (error && error != EAGAIN) {
1654 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1655 datapath_type, ovs_strerror(error));
1661 ofproto_type_wait(const char *datapath_type)
1663 const struct ofproto_class *class;
1665 datapath_type = ofproto_normalize_type(datapath_type);
1666 class = ofproto_class_find__(datapath_type);
1668 if (class->type_wait) {
1669 class->type_wait(datapath_type);
1674 ofproto_run(struct ofproto *p)
1679 error = p->ofproto_class->run(p);
1680 if (error && error != EAGAIN) {
1681 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1684 run_rule_executes(p);
1686 /* Restore the eviction group heap invariant occasionally. */
1687 if (p->eviction_group_timer < time_msec()) {
1690 p->eviction_group_timer = time_msec() + 1000;
1692 for (i = 0; i < p->n_tables; i++) {
1693 struct oftable *table = &p->tables[i];
1694 struct eviction_group *evg;
1697 if (!table->eviction_fields) {
1701 if (classifier_count(&table->cls) > 100000) {
1702 static struct vlog_rate_limit count_rl =
1703 VLOG_RATE_LIMIT_INIT(1, 1);
1704 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1705 " number of rules: %d", i,
1706 classifier_count(&table->cls));
1709 ovs_mutex_lock(&ofproto_mutex);
1710 CLS_FOR_EACH (rule, cr, &table->cls) {
1711 if (rule->idle_timeout || rule->hard_timeout) {
1712 if (!rule->eviction_group) {
1713 eviction_group_add_rule(rule);
1715 heap_raw_change(&rule->evg_node,
1716 rule_eviction_priority(p, rule));
1721 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1722 heap_rebuild(&evg->rules);
1724 ovs_mutex_unlock(&ofproto_mutex);
1728 if (p->ofproto_class->port_poll) {
1731 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1732 process_port_change(p, error, devname);
1736 new_seq = seq_read(connectivity_seq_get());
1737 if (new_seq != p->change_seq) {
1738 struct sset devnames;
1739 const char *devname;
1740 struct ofport *ofport;
1742 /* Update OpenFlow port status for any port whose netdev has changed.
1744 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1745 * destroyed, so it's not safe to update ports directly from the
1746 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1747 * need this two-phase approach. */
1748 sset_init(&devnames);
1749 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1750 uint64_t port_change_seq;
1752 port_change_seq = netdev_get_change_seq(ofport->netdev);
1753 if (ofport->change_seq != port_change_seq) {
1754 ofport->change_seq = port_change_seq;
1755 sset_add(&devnames, netdev_get_name(ofport->netdev));
1758 SSET_FOR_EACH (devname, &devnames) {
1759 update_port(p, devname);
1761 sset_destroy(&devnames);
1763 p->change_seq = new_seq;
1766 connmgr_run(p->connmgr, handle_openflow);
1772 ofproto_wait(struct ofproto *p)
1774 p->ofproto_class->wait(p);
1775 if (p->ofproto_class->port_poll_wait) {
1776 p->ofproto_class->port_poll_wait(p);
1778 seq_wait(connectivity_seq_get(), p->change_seq);
1779 connmgr_wait(p->connmgr);
1783 ofproto_is_alive(const struct ofproto *p)
1785 return connmgr_has_controllers(p->connmgr);
1788 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1789 * memory_report(). */
1791 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1793 const struct oftable *table;
1794 unsigned int n_rules;
1796 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1799 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1800 n_rules += classifier_count(&table->cls);
1802 simap_increase(usage, "rules", n_rules);
1804 if (ofproto->ofproto_class->get_memory_usage) {
1805 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1808 connmgr_get_memory_usage(ofproto->connmgr, usage);
1812 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1814 const struct ofproto_class *class;
1816 datapath_type = ofproto_normalize_type(datapath_type);
1817 class = ofproto_class_find__(datapath_type);
1819 if (class && class->type_get_memory_usage) {
1820 class->type_get_memory_usage(datapath_type, usage);
1825 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1828 connmgr_get_controller_info(ofproto->connmgr, info);
1832 ofproto_free_ofproto_controller_info(struct shash *info)
1834 connmgr_free_controller_info(info);
1837 /* Makes a deep copy of 'old' into 'port'. */
1839 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1841 port->name = xstrdup(old->name);
1842 port->type = xstrdup(old->type);
1843 port->ofp_port = old->ofp_port;
1846 /* Frees memory allocated to members of 'ofproto_port'.
1848 * Do not call this function on an ofproto_port obtained from
1849 * ofproto_port_dump_next(): that function retains ownership of the data in the
1852 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1854 free(ofproto_port->name);
1855 free(ofproto_port->type);
1858 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1860 * This function provides no status indication. An error status for the entire
1861 * dump operation is provided when it is completed by calling
1862 * ofproto_port_dump_done().
1865 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1866 const struct ofproto *ofproto)
1868 dump->ofproto = ofproto;
1869 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1873 /* Attempts to retrieve another port from 'dump', which must have been created
1874 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1875 * 'port' and returns true. On failure, returns false.
1877 * Failure might indicate an actual error or merely that the last port has been
1878 * dumped. An error status for the entire dump operation is provided when it
1879 * is completed by calling ofproto_port_dump_done().
1881 * The ofproto owns the data stored in 'port'. It will remain valid until at
1882 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1883 * ofproto_port_dump_done(). */
1885 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1886 struct ofproto_port *port)
1888 const struct ofproto *ofproto = dump->ofproto;
1894 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1897 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1903 /* Completes port table dump operation 'dump', which must have been created
1904 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1905 * error-free, otherwise a positive errno value describing the problem. */
1907 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1909 const struct ofproto *ofproto = dump->ofproto;
1911 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1914 return dump->error == EOF ? 0 : dump->error;
1917 /* Returns the type to pass to netdev_open() when a datapath of type
1918 * 'datapath_type' has a port of type 'port_type', for a few special
1919 * cases when a netdev type differs from a port type. For example, when
1920 * using the userspace datapath, a port of type "internal" needs to be
1923 * Returns either 'type' itself or a string literal, which must not be
1926 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1928 const struct ofproto_class *class;
1930 datapath_type = ofproto_normalize_type(datapath_type);
1931 class = ofproto_class_find__(datapath_type);
1936 return (class->port_open_type
1937 ? class->port_open_type(datapath_type, port_type)
1941 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1942 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1943 * the port's OpenFlow port number.
1945 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1946 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1947 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1948 * 'ofp_portp' is non-null). */
1950 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1951 ofp_port_t *ofp_portp)
1953 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1956 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1958 const char *netdev_name = netdev_get_name(netdev);
1960 simap_put(&ofproto->ofp_requests, netdev_name,
1961 ofp_to_u16(ofp_port));
1962 update_port(ofproto, netdev_name);
1965 *ofp_portp = OFPP_NONE;
1967 struct ofproto_port ofproto_port;
1969 error = ofproto_port_query_by_name(ofproto,
1970 netdev_get_name(netdev),
1973 *ofp_portp = ofproto_port.ofp_port;
1974 ofproto_port_destroy(&ofproto_port);
1981 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1982 * initializes '*port' appropriately; on failure, returns a positive errno
1985 * The caller owns the data in 'ofproto_port' and must free it with
1986 * ofproto_port_destroy() when it is no longer needed. */
1988 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1989 struct ofproto_port *port)
1993 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1995 memset(port, 0, sizeof *port);
2000 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
2001 * Returns 0 if successful, otherwise a positive errno. */
2003 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
2005 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2006 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
2007 struct simap_node *ofp_request_node;
2010 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
2011 if (ofp_request_node) {
2012 simap_delete(&ofproto->ofp_requests, ofp_request_node);
2015 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
2016 if (!error && ofport) {
2017 /* 'name' is the netdev's name and update_port() is going to close the
2018 * netdev. Just in case update_port() refers to 'name' after it
2019 * destroys 'ofport', make a copy of it around the update_port()
2021 char *devname = xstrdup(name);
2022 update_port(ofproto, devname);
2029 flow_mod_init(struct ofputil_flow_mod *fm,
2030 const struct match *match, int priority,
2031 const struct ofpact *ofpacts, size_t ofpacts_len,
2032 enum ofp_flow_mod_command command)
2034 memset(fm, 0, sizeof *fm);
2036 fm->priority = priority;
2039 fm->modify_cookie = false;
2041 fm->command = command;
2042 fm->idle_timeout = 0;
2043 fm->hard_timeout = 0;
2045 fm->buffer_id = UINT32_MAX;
2046 fm->out_port = OFPP_ANY;
2047 fm->out_group = OFPG_ANY;
2049 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2050 fm->ofpacts_len = ofpacts_len;
2051 fm->delete_reason = OFPRR_DELETE;
2055 simple_flow_mod(struct ofproto *ofproto,
2056 const struct match *match, int priority,
2057 const struct ofpact *ofpacts, size_t ofpacts_len,
2058 enum ofp_flow_mod_command command)
2060 struct ofputil_flow_mod fm;
2062 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2064 return handle_flow_mod__(ofproto, &fm, NULL);
2067 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2068 * performs the 'n_actions' actions in 'actions'. The new flow will not
2071 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2072 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2073 * controllers; otherwise, it will be hidden.
2075 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2077 * This is a helper function for in-band control and fail-open. */
2079 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2081 const struct ofpact *ofpacts, size_t ofpacts_len)
2082 OVS_EXCLUDED(ofproto_mutex)
2084 const struct rule *rule;
2087 /* First do a cheap check whether the rule we're looking for already exists
2088 * with the actions that we want. If it does, then we're done. */
2089 rule = rule_from_cls_rule(classifier_find_match_exactly(
2090 &ofproto->tables[0].cls, match, priority,
2093 const struct rule_actions *actions = rule_get_actions(rule);
2094 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2095 ofpacts, ofpacts_len);
2100 /* If there's no such rule or the rule doesn't have the actions we want,
2101 * fall back to a executing a full flow mod. We can't optimize this at
2102 * all because we didn't take enough locks above to ensure that the flow
2103 * table didn't already change beneath us. */
2105 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2106 OFPFC_MODIFY_STRICT);
2110 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2111 * an OFPERR_* OpenFlow error code on failure.
2113 * This is a helper function for in-band control and fail-open and the "learn"
2116 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2117 OVS_EXCLUDED(ofproto_mutex)
2119 /* Optimize for the most common case of a repeated learn action.
2120 * If an identical flow already exists we only need to update its
2121 * 'modified' time. */
2122 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2123 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2124 struct oftable *table = &ofproto->tables[fm->table_id];
2128 rule = rule_from_cls_rule(classifier_find_match_exactly(
2129 &table->cls, &fm->match, fm->priority,
2132 /* Reading many of the rule fields and writing on 'modified'
2133 * requires the rule->mutex. Also, rule->actions may change
2134 * if rule->mutex is not held. */
2135 const struct rule_actions *actions;
2137 ovs_mutex_lock(&rule->mutex);
2138 actions = rule_get_actions(rule);
2139 if (rule->idle_timeout == fm->idle_timeout
2140 && rule->hard_timeout == fm->hard_timeout
2141 && rule->importance == fm->importance
2142 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2143 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2144 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2145 actions->ofpacts, actions->ofpacts_len)) {
2146 /* Rule already exists and need not change, only update the
2147 modified timestamp. */
2148 rule->modified = time_msec();
2151 ovs_mutex_unlock(&rule->mutex);
2159 return handle_flow_mod__(ofproto, fm, NULL);
2162 /* Searches for a rule with matching criteria exactly equal to 'target' in
2163 * ofproto's table 0 and, if it finds one, deletes it.
2165 * This is a helper function for in-band control and fail-open. */
2167 ofproto_delete_flow(struct ofproto *ofproto,
2168 const struct match *target, int priority)
2169 OVS_EXCLUDED(ofproto_mutex)
2171 struct classifier *cls = &ofproto->tables[0].cls;
2174 /* First do a cheap check whether the rule we're looking for has already
2175 * been deleted. If so, then we're done. */
2176 rule = rule_from_cls_rule(classifier_find_match_exactly(
2177 cls, target, priority, CLS_MAX_VERSION));
2182 /* Execute a flow mod. We can't optimize this at all because we didn't
2183 * take enough locks above to ensure that the flow table didn't already
2184 * change beneath us. */
2185 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2188 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2189 * the flows required by in-band control and fail-open. */
2191 ofproto_flush_flows(struct ofproto *ofproto)
2193 COVERAGE_INC(ofproto_flush);
2194 ofproto_flush__(ofproto);
2195 connmgr_flushed(ofproto->connmgr);
2199 reinit_ports(struct ofproto *p)
2201 struct ofproto_port_dump dump;
2202 struct sset devnames;
2203 struct ofport *ofport;
2204 struct ofproto_port ofproto_port;
2205 const char *devname;
2207 COVERAGE_INC(ofproto_reinit_ports);
2209 sset_init(&devnames);
2210 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2211 sset_add(&devnames, netdev_get_name(ofport->netdev));
2213 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2214 sset_add(&devnames, ofproto_port.name);
2217 SSET_FOR_EACH (devname, &devnames) {
2218 update_port(p, devname);
2220 sset_destroy(&devnames);
2224 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2228 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2229 port_idx = port_idx ? port_idx : UINT16_MAX;
2231 if (port_idx >= ofproto->max_ports
2232 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2233 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2234 long long int last_used_at, lru = LLONG_MAX;
2236 /* Search for a free OpenFlow port number. We try not to
2237 * immediately reuse them to prevent problems due to old
2240 * We limit the automatically assigned port numbers to the lower half
2241 * of the port range, to reserve the upper half for assignment by
2244 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2245 ofproto->alloc_port_no = 1;
2247 last_used_at = ofport_get_usage(ofproto,
2248 u16_to_ofp(ofproto->alloc_port_no));
2249 if (!last_used_at) {
2250 port_idx = ofproto->alloc_port_no;
2252 } else if ( last_used_at < time_msec() - 60*60*1000) {
2253 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2254 * more than an hour ago, consider it usable. */
2255 ofport_remove_usage(ofproto,
2256 u16_to_ofp(ofproto->alloc_port_no));
2257 port_idx = ofproto->alloc_port_no;
2259 } else if (last_used_at < lru) {
2261 lru_ofport = ofproto->alloc_port_no;
2264 if (ofproto->alloc_port_no == end_port_no) {
2266 port_idx = lru_ofport;
2273 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2274 return u16_to_ofp(port_idx);
2278 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2280 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2281 ofport_set_usage(ofproto, ofp_port, time_msec());
2285 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2286 * pointer if the netdev cannot be opened. On success, also fills in
2288 static struct netdev *
2289 ofport_open(struct ofproto *ofproto,
2290 struct ofproto_port *ofproto_port,
2291 struct ofputil_phy_port *pp)
2293 enum netdev_flags flags;
2294 struct netdev *netdev;
2297 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2299 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2300 "cannot be opened (%s)",
2302 ofproto_port->name, ofproto_port->ofp_port,
2303 ofproto_port->name, ovs_strerror(error));
2307 if (ofproto_port->ofp_port == OFPP_NONE) {
2308 if (!strcmp(ofproto->name, ofproto_port->name)) {
2309 ofproto_port->ofp_port = OFPP_LOCAL;
2311 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2312 ofproto_port->name);
2315 pp->port_no = ofproto_port->ofp_port;
2316 netdev_get_etheraddr(netdev, pp->hw_addr);
2317 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2318 netdev_get_flags(netdev, &flags);
2319 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2320 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2321 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2322 &pp->supported, &pp->peer);
2323 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2324 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2329 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2330 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2333 ofport_equal(const struct ofputil_phy_port *a,
2334 const struct ofputil_phy_port *b)
2336 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2337 && a->state == b->state
2338 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2339 && a->curr == b->curr
2340 && a->advertised == b->advertised
2341 && a->supported == b->supported
2342 && a->peer == b->peer
2343 && a->curr_speed == b->curr_speed
2344 && a->max_speed == b->max_speed);
2347 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2348 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2349 * one with the same name or port number). */
2351 ofport_install(struct ofproto *p,
2352 struct netdev *netdev, const struct ofputil_phy_port *pp)
2354 const char *netdev_name = netdev_get_name(netdev);
2355 struct ofport *ofport;
2358 /* Create ofport. */
2359 ofport = p->ofproto_class->port_alloc();
2364 ofport->ofproto = p;
2365 ofport->netdev = netdev;
2366 ofport->change_seq = netdev_get_change_seq(netdev);
2368 ofport->ofp_port = pp->port_no;
2369 ofport->created = time_msec();
2371 /* Add port to 'p'. */
2372 hmap_insert(&p->ports, &ofport->hmap_node,
2373 hash_ofp_port(ofport->ofp_port));
2374 shash_add(&p->port_by_name, netdev_name, ofport);
2376 update_mtu(p, ofport);
2378 /* Let the ofproto_class initialize its private data. */
2379 error = p->ofproto_class->port_construct(ofport);
2383 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2387 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2388 p->name, netdev_name, ovs_strerror(error));
2390 ofport_destroy__(ofport);
2392 netdev_close(netdev);
2396 /* Removes 'ofport' from 'p' and destroys it. */
2398 ofport_remove(struct ofport *ofport)
2400 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2402 ofport_destroy(ofport);
2405 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2408 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2410 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2412 ofport_remove(port);
2416 /* Updates 'port' with new 'pp' description.
2418 * Does not handle a name or port number change. The caller must implement
2419 * such a change as a delete followed by an add. */
2421 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2423 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2424 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2425 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2426 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2427 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2428 port->pp.curr = pp->curr;
2429 port->pp.advertised = pp->advertised;
2430 port->pp.supported = pp->supported;
2431 port->pp.peer = pp->peer;
2432 port->pp.curr_speed = pp->curr_speed;
2433 port->pp.max_speed = pp->max_speed;
2435 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2436 &port->pp, OFPPR_MODIFY);
2439 /* Update OpenFlow 'state' in 'port' and notify controller. */
2441 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2443 if (port->pp.state != state) {
2444 port->pp.state = state;
2445 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2446 &port->pp, OFPPR_MODIFY);
2451 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2453 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2455 if (port->ofproto->ofproto_class->set_realdev) {
2456 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2458 if (port->ofproto->ofproto_class->set_stp_port) {
2459 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2461 if (port->ofproto->ofproto_class->set_rstp_port) {
2462 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2464 if (port->ofproto->ofproto_class->set_cfm) {
2465 port->ofproto->ofproto_class->set_cfm(port, NULL);
2467 if (port->ofproto->ofproto_class->bundle_remove) {
2468 port->ofproto->ofproto_class->bundle_remove(port);
2474 ofport_destroy__(struct ofport *port)
2476 struct ofproto *ofproto = port->ofproto;
2477 const char *name = netdev_get_name(port->netdev);
2479 hmap_remove(&ofproto->ports, &port->hmap_node);
2480 shash_delete(&ofproto->port_by_name,
2481 shash_find(&ofproto->port_by_name, name));
2483 netdev_close(port->netdev);
2484 ofproto->ofproto_class->port_dealloc(port);
2488 ofport_destroy(struct ofport *port)
2491 dealloc_ofp_port(port->ofproto, port->ofp_port);
2492 port->ofproto->ofproto_class->port_destruct(port);
2493 ofport_destroy__(port);
2498 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2500 struct ofport *port;
2502 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2504 if (port->ofp_port == ofp_port) {
2511 static long long int
2512 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2514 struct ofport_usage *usage;
2516 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2517 &ofproto->ofport_usage) {
2518 if (usage->ofp_port == ofp_port) {
2519 return usage->last_used;
2526 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2527 long long int last_used)
2529 struct ofport_usage *usage;
2530 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2531 &ofproto->ofport_usage) {
2532 if (usage->ofp_port == ofp_port) {
2533 usage->last_used = last_used;
2537 ovs_assert(last_used == LLONG_MAX);
2539 usage = xmalloc(sizeof *usage);
2540 usage->ofp_port = ofp_port;
2541 usage->last_used = last_used;
2542 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2543 hash_ofp_port(ofp_port));
2547 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2549 struct ofport_usage *usage;
2550 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2551 &ofproto->ofport_usage) {
2552 if (usage->ofp_port == ofp_port) {
2553 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2561 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2563 struct ofproto *ofproto = port->ofproto;
2566 if (ofproto->ofproto_class->port_get_stats) {
2567 error = ofproto->ofproto_class->port_get_stats(port, stats);
2576 update_port(struct ofproto *ofproto, const char *name)
2578 struct ofproto_port ofproto_port;
2579 struct ofputil_phy_port pp;
2580 struct netdev *netdev;
2581 struct ofport *port;
2583 COVERAGE_INC(ofproto_update_port);
2585 /* Fetch 'name''s location and properties from the datapath. */
2586 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2587 ? ofport_open(ofproto, &ofproto_port, &pp)
2591 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2592 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2593 struct netdev *old_netdev = port->netdev;
2595 /* 'name' hasn't changed location. Any properties changed? */
2596 if (!ofport_equal(&port->pp, &pp)) {
2597 ofport_modified(port, &pp);
2600 update_mtu(ofproto, port);
2602 /* Install the newly opened netdev in case it has changed.
2603 * Don't close the old netdev yet in case port_modified has to
2604 * remove a retained reference to it.*/
2605 port->netdev = netdev;
2606 port->change_seq = netdev_get_change_seq(netdev);
2608 if (port->ofproto->ofproto_class->port_modified) {
2609 port->ofproto->ofproto_class->port_modified(port);
2612 netdev_close(old_netdev);
2614 /* If 'port' is nonnull then its name differs from 'name' and thus
2615 * we should delete it. If we think there's a port named 'name'
2616 * then its port number must be wrong now so delete it too. */
2618 ofport_remove(port);
2620 ofport_remove_with_name(ofproto, name);
2621 ofport_install(ofproto, netdev, &pp);
2624 /* Any port named 'name' is gone now. */
2625 ofport_remove_with_name(ofproto, name);
2627 ofproto_port_destroy(&ofproto_port);
2631 init_ports(struct ofproto *p)
2633 struct ofproto_port_dump dump;
2634 struct ofproto_port ofproto_port;
2635 struct shash_node *node, *next;
2637 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2638 const char *name = ofproto_port.name;
2640 if (shash_find(&p->port_by_name, name)) {
2641 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2644 struct ofputil_phy_port pp;
2645 struct netdev *netdev;
2647 /* Check if an OpenFlow port number had been requested. */
2648 node = shash_find(&init_ofp_ports, name);
2650 const struct iface_hint *iface_hint = node->data;
2651 simap_put(&p->ofp_requests, name,
2652 ofp_to_u16(iface_hint->ofp_port));
2655 netdev = ofport_open(p, &ofproto_port, &pp);
2657 ofport_install(p, netdev, &pp);
2658 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2659 p->alloc_port_no = MAX(p->alloc_port_no,
2660 ofp_to_u16(ofproto_port.ofp_port));
2666 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2667 struct iface_hint *iface_hint = node->data;
2669 if (!strcmp(iface_hint->br_name, p->name)) {
2670 free(iface_hint->br_name);
2671 free(iface_hint->br_type);
2673 shash_delete(&init_ofp_ports, node);
2680 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2681 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2683 find_min_mtu(struct ofproto *p)
2685 struct ofport *ofport;
2688 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2689 struct netdev *netdev = ofport->netdev;
2692 /* Skip any internal ports, since that's what we're trying to
2694 if (!strcmp(netdev_get_type(netdev), "internal")) {
2698 if (netdev_get_mtu(netdev, &dev_mtu)) {
2701 if (!mtu || dev_mtu < mtu) {
2706 return mtu ? mtu: ETH_PAYLOAD_MAX;
2709 /* Update MTU of all datapath devices on 'p' to the minimum of the
2710 * non-datapath ports in event of 'port' added or changed. */
2712 update_mtu(struct ofproto *p, struct ofport *port)
2714 struct ofport *ofport;
2715 struct netdev *netdev = port->netdev;
2716 int dev_mtu, old_min;
2718 if (netdev_get_mtu(netdev, &dev_mtu)) {
2722 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2723 if (dev_mtu > p->min_mtu) {
2724 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2725 dev_mtu = p->min_mtu;
2728 port->mtu = dev_mtu;
2732 /* For non-internal port find new min mtu. */
2733 old_min = p->min_mtu;
2734 port->mtu = dev_mtu;
2735 p->min_mtu = find_min_mtu(p);
2736 if (p->min_mtu == old_min) {
2740 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2741 struct netdev *netdev = ofport->netdev;
2743 if (!strcmp(netdev_get_type(netdev), "internal")) {
2744 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2745 ofport->mtu = p->min_mtu;
2752 ofproto_rule_destroy__(struct rule *rule)
2753 OVS_NO_THREAD_SAFETY_ANALYSIS
2755 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2756 rule_actions_destroy(rule_get_actions(rule));
2757 ovs_mutex_destroy(&rule->mutex);
2758 rule->ofproto->ofproto_class->rule_dealloc(rule);
2762 rule_destroy_cb(struct rule *rule)
2764 rule->ofproto->ofproto_class->rule_destruct(rule);
2765 ofproto_rule_destroy__(rule);
2769 ofproto_rule_ref(struct rule *rule)
2772 ovs_refcount_ref(&rule->ref_count);
2777 ofproto_rule_try_ref(struct rule *rule)
2780 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2785 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2786 * ref_count reaches 0.
2788 * Use of RCU allows short term use (between RCU quiescent periods) without
2789 * keeping a reference. A reference must be taken if the rule needs to
2790 * stay around accross the RCU quiescent periods. */
2792 ofproto_rule_unref(struct rule *rule)
2794 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2795 ovsrcu_postpone(rule_destroy_cb, rule);
2800 remove_rule_rcu__(struct rule *rule)
2801 OVS_REQUIRES(ofproto_mutex)
2803 struct ofproto *ofproto = rule->ofproto;
2804 struct oftable *table = &ofproto->tables[rule->table_id];
2806 ovs_assert(!cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
2807 if (!classifier_remove(&table->cls, &rule->cr)) {
2810 ofproto->ofproto_class->rule_delete(rule);
2811 ofproto_rule_unref(rule);
2815 remove_rule_rcu(struct rule *rule)
2816 OVS_EXCLUDED(ofproto_mutex)
2818 ovs_mutex_lock(&ofproto_mutex);
2819 remove_rule_rcu__(rule);
2820 ovs_mutex_unlock(&ofproto_mutex);
2823 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2825 remove_rules_rcu(struct rule **rules)
2826 OVS_EXCLUDED(ofproto_mutex)
2828 struct rule **orig_rules = rules;
2831 struct ofproto *ofproto = rules[0]->ofproto;
2832 unsigned long tables[BITMAP_N_LONGS(256)];
2836 memset(tables, 0, sizeof tables);
2838 ovs_mutex_lock(&ofproto_mutex);
2839 while ((rule = *rules++)) {
2840 /* Defer once for each new table. This defers the subtable cleanup
2841 * until later, so that when removing large number of flows the
2842 * operation is faster. */
2843 if (!bitmap_is_set(tables, rule->table_id)) {
2844 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
2846 bitmap_set1(tables, rule->table_id);
2847 classifier_defer(cls);
2849 remove_rule_rcu__(rule);
2852 BITMAP_FOR_EACH_1(table_id, 256, tables) {
2853 struct classifier *cls = &ofproto->tables[table_id].cls;
2855 classifier_publish(cls);
2857 ovs_mutex_unlock(&ofproto_mutex);
2864 ofproto_group_ref(struct ofgroup *group)
2867 ovs_refcount_ref(&group->ref_count);
2872 ofproto_group_unref(struct ofgroup *group)
2874 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2875 group->ofproto->ofproto_class->group_destruct(group);
2876 ofputil_bucket_list_destroy(&group->buckets);
2877 group->ofproto->ofproto_class->group_dealloc(group);
2881 static uint32_t get_provider_meter_id(const struct ofproto *,
2882 uint32_t of_meter_id);
2884 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2885 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2886 const struct rule_actions *
2887 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2889 struct rule_actions *actions;
2891 actions = xmalloc(sizeof *actions + ofpacts_len);
2892 actions->ofpacts_len = ofpacts_len;
2893 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2894 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2896 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2902 /* Free the actions after the RCU quiescent period is reached. */
2904 rule_actions_destroy(const struct rule_actions *actions)
2907 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2911 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2912 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2914 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2915 OVS_REQUIRES(ofproto_mutex)
2917 if (port == OFPP_ANY) {
2920 const struct rule_actions *actions = rule_get_actions(rule);
2921 return ofpacts_output_to_port(actions->ofpacts,
2922 actions->ofpacts_len, port);
2926 /* Returns true if 'rule' has group and equals group_id. */
2928 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2929 OVS_REQUIRES(ofproto_mutex)
2931 if (group_id == OFPG_ANY) {
2934 const struct rule_actions *actions = rule_get_actions(rule);
2935 return ofpacts_output_to_group(actions->ofpacts,
2936 actions->ofpacts_len, group_id);
2941 rule_execute_destroy(struct rule_execute *e)
2943 ofproto_rule_unref(e->rule);
2944 list_remove(&e->list_node);
2948 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2949 * by passing them to the ofproto provider. */
2951 run_rule_executes(struct ofproto *ofproto)
2952 OVS_EXCLUDED(ofproto_mutex)
2954 struct rule_execute *e, *next;
2955 struct ovs_list executes;
2957 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2958 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2961 flow_extract(e->packet, &flow);
2962 flow.in_port.ofp_port = e->in_port;
2963 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2965 rule_execute_destroy(e);
2969 /* Destroys and discards all "rule_execute" operations queued up in
2970 * ofproto->rule_executes. */
2972 destroy_rule_executes(struct ofproto *ofproto)
2974 struct rule_execute *e, *next;
2975 struct ovs_list executes;
2977 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2978 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2979 dp_packet_delete(e->packet);
2980 rule_execute_destroy(e);
2985 rule_is_readonly(const struct rule *rule)
2987 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2988 return (table->flags & OFTABLE_READONLY) != 0;
2992 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2994 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2995 return hash_3words(cookie, cookie >> 32, table_id);
2999 learned_cookies_update_one__(struct ofproto *ofproto,
3000 const struct ofpact_learn *learn,
3001 int delta, struct ovs_list *dead_cookies)
3002 OVS_REQUIRES(ofproto_mutex)
3004 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
3005 struct learned_cookie *c;
3007 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
3008 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
3010 ovs_assert(c->n >= 0);
3013 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
3014 list_push_back(dead_cookies, &c->u.list_node);
3021 ovs_assert(delta > 0);
3022 c = xmalloc(sizeof *c);
3023 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
3024 c->cookie = learn->cookie;
3025 c->table_id = learn->table_id;
3029 static const struct ofpact_learn *
3030 next_learn_with_delete(const struct rule_actions *actions,
3031 const struct ofpact_learn *start)
3033 const struct ofpact *pos;
3035 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
3036 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
3037 pos = ofpact_next(pos)) {
3038 if (pos->type == OFPACT_LEARN) {
3039 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
3040 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3050 learned_cookies_update__(struct ofproto *ofproto,
3051 const struct rule_actions *actions,
3052 int delta, struct ovs_list *dead_cookies)
3053 OVS_REQUIRES(ofproto_mutex)
3055 if (actions->has_learn_with_delete) {
3056 const struct ofpact_learn *learn;
3058 for (learn = next_learn_with_delete(actions, NULL); learn;
3059 learn = next_learn_with_delete(actions, learn)) {
3060 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3066 learned_cookies_inc(struct ofproto *ofproto,
3067 const struct rule_actions *actions)
3068 OVS_REQUIRES(ofproto_mutex)
3070 learned_cookies_update__(ofproto, actions, +1, NULL);
3074 learned_cookies_dec(struct ofproto *ofproto,
3075 const struct rule_actions *actions,
3076 struct ovs_list *dead_cookies)
3077 OVS_REQUIRES(ofproto_mutex)
3079 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3083 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3084 OVS_REQUIRES(ofproto_mutex)
3086 struct learned_cookie *c;
3088 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3089 struct rule_criteria criteria;
3090 struct rule_collection rules;
3093 match_init_catchall(&match);
3094 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3095 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3096 rule_criteria_require_rw(&criteria, false);
3097 collect_rules_loose(ofproto, &criteria, &rules);
3098 rule_criteria_destroy(&criteria);
3099 delete_flows__(&rules, OFPRR_DELETE, NULL);
3106 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3108 ofconn_send_reply(ofconn, make_echo_reply(oh));
3113 query_tables(struct ofproto *ofproto,
3114 struct ofputil_table_features **featuresp,
3115 struct ofputil_table_stats **statsp)
3117 struct mf_bitmap rw_fields = oxm_writable_fields();
3118 struct mf_bitmap match = oxm_matchable_fields();
3119 struct mf_bitmap mask = oxm_maskable_fields();
3121 struct ofputil_table_features *features;
3122 struct ofputil_table_stats *stats;
3125 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3126 for (i = 0; i < ofproto->n_tables; i++) {
3127 struct ofputil_table_features *f = &features[i];
3130 sprintf(f->name, "table%d", i);
3131 f->metadata_match = OVS_BE64_MAX;
3132 f->metadata_write = OVS_BE64_MAX;
3133 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3134 f->max_entries = 1000000;
3136 bool more_tables = false;
3137 for (int j = i + 1; j < ofproto->n_tables; j++) {
3138 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3139 bitmap_set1(f->nonmiss.next, j);
3143 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3145 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3147 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3148 f->nonmiss.write.set_fields = rw_fields;
3149 f->nonmiss.apply = f->nonmiss.write;
3150 f->miss = f->nonmiss;
3154 f->wildcard = match;
3158 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3159 for (i = 0; i < ofproto->n_tables; i++) {
3160 struct ofputil_table_stats *s = &stats[i];
3161 struct classifier *cls = &ofproto->tables[i].cls;
3164 s->active_count = classifier_count(cls);
3166 s->active_count -= connmgr_count_hidden_rules(
3174 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3176 for (i = 0; i < ofproto->n_tables; i++) {
3177 const struct oftable *table = &ofproto->tables[i];
3178 struct ofputil_table_features *f = &features[i];
3181 ovs_strzcpy(f->name, table->name, sizeof f->name);
3184 if (table->max_flows < f->max_entries) {
3185 f->max_entries = table->max_flows;
3191 query_switch_features(struct ofproto *ofproto,
3192 bool *arp_match_ip, uint64_t *ofpacts)
3194 struct ofputil_table_features *features, *f;
3196 *arp_match_ip = false;
3199 query_tables(ofproto, &features, NULL);
3200 for (f = features; f < &features[ofproto->n_tables]; f++) {
3201 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3202 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3203 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3204 *arp_match_ip = true;
3210 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3214 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3216 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3217 struct ofputil_switch_features features;
3218 struct ofport *port;
3222 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3224 features.datapath_id = ofproto->datapath_id;
3225 features.n_buffers = pktbuf_capacity();
3226 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3227 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3228 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3229 OFPUTIL_C_GROUP_STATS);
3231 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3233 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3234 features.auxiliary_id = 0;
3235 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3237 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3238 ofputil_put_switch_features_port(&port->pp, b);
3241 ofconn_send_reply(ofconn, b);
3246 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3248 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3249 struct ofp_switch_config *osc;
3250 enum ofp_config_flags flags;
3254 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3255 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3256 flags = ofproto->frag_handling;
3257 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3258 if (oh->version < OFP13_VERSION
3259 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3260 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3262 osc->flags = htons(flags);
3263 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3264 ofconn_send_reply(ofconn, buf);
3270 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3272 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3273 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3274 uint16_t flags = ntohs(osc->flags);
3276 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3277 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3278 enum ofp_config_flags cur = ofproto->frag_handling;
3279 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3281 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3283 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3284 ofproto->frag_handling = next;
3286 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3288 ofputil_frag_handling_to_string(next));
3292 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3293 ofconn_set_invalid_ttl_to_controller(ofconn,
3294 (oh->version < OFP13_VERSION
3295 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3297 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3302 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3303 * error message code for the caller to propagate upward. Otherwise, returns
3306 * The log message mentions 'msg_type'. */
3308 reject_slave_controller(struct ofconn *ofconn)
3310 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3311 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3312 return OFPERR_OFPBRC_IS_SLAVE;
3318 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3321 * - If they use a meter, then 'ofproto' has that meter configured.
3323 * - If they use any groups, then 'ofproto' has that group configured.
3325 * Returns 0 if successful, otherwise an OpenFlow error. */
3327 ofproto_check_ofpacts(struct ofproto *ofproto,
3328 const struct ofpact ofpacts[], size_t ofpacts_len)
3330 const struct ofpact *a;
3333 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3334 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3335 return OFPERR_OFPMMFC_INVALID_METER;
3338 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3339 if (a->type == OFPACT_GROUP
3340 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3341 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3349 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3351 struct ofproto *p = ofconn_get_ofproto(ofconn);
3352 struct ofputil_packet_out po;
3353 struct dp_packet *payload;
3354 uint64_t ofpacts_stub[1024 / 8];
3355 struct ofpbuf ofpacts;
3359 COVERAGE_INC(ofproto_packet_out);
3361 error = reject_slave_controller(ofconn);
3366 /* Decode message. */
3367 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3368 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3370 goto exit_free_ofpacts;
3372 if (ofp_to_u16(po.in_port) >= p->max_ports
3373 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3374 error = OFPERR_OFPBRC_BAD_PORT;
3375 goto exit_free_ofpacts;
3379 if (po.buffer_id != UINT32_MAX) {
3380 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3381 if (error || !payload) {
3382 goto exit_free_ofpacts;
3385 /* Ensure that the L3 header is 32-bit aligned. */
3386 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3389 /* Verify actions against packet, then send packet if successful. */
3390 flow_extract(payload, &flow);
3391 flow.in_port.ofp_port = po.in_port;
3392 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3394 error = p->ofproto_class->packet_out(p, payload, &flow,
3395 po.ofpacts, po.ofpacts_len);
3397 dp_packet_delete(payload);
3400 ofpbuf_uninit(&ofpacts);
3406 update_port_config(struct ofconn *ofconn, struct ofport *port,
3407 enum ofputil_port_config config,
3408 enum ofputil_port_config mask)
3410 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3412 if (toggle & OFPUTIL_PC_PORT_DOWN
3413 && (config & OFPUTIL_PC_PORT_DOWN
3414 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3415 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3416 /* We tried to bring the port up or down, but it failed, so don't
3417 * update the "down" bit. */
3418 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3422 enum ofputil_port_config old_config = port->pp.config;
3423 port->pp.config ^= toggle;
3424 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3425 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3431 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3433 struct ofproto *p = ofconn_get_ofproto(ofconn);
3434 struct ofputil_port_mod pm;
3435 struct ofport *port;
3438 error = reject_slave_controller(ofconn);
3443 error = ofputil_decode_port_mod(oh, &pm, false);
3448 port = ofproto_get_port(p, pm.port_no);
3450 return OFPERR_OFPPMFC_BAD_PORT;
3451 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3452 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3454 update_port_config(ofconn, port, pm.config, pm.mask);
3456 netdev_set_advertisements(port->netdev, pm.advertise);
3463 handle_desc_stats_request(struct ofconn *ofconn,
3464 const struct ofp_header *request)
3466 static const char *default_mfr_desc = "Nicira, Inc.";
3467 static const char *default_hw_desc = "Open vSwitch";
3468 static const char *default_sw_desc = VERSION;
3469 static const char *default_serial_desc = "None";
3470 static const char *default_dp_desc = "None";
3472 struct ofproto *p = ofconn_get_ofproto(ofconn);
3473 struct ofp_desc_stats *ods;
3476 msg = ofpraw_alloc_stats_reply(request, 0);
3477 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3478 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3479 sizeof ods->mfr_desc);
3480 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3481 sizeof ods->hw_desc);
3482 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3483 sizeof ods->sw_desc);
3484 ovs_strlcpy(ods->serial_num,
3485 p->serial_desc ? p->serial_desc : default_serial_desc,
3486 sizeof ods->serial_num);
3487 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3488 sizeof ods->dp_desc);
3489 ofconn_send_reply(ofconn, msg);
3495 handle_table_stats_request(struct ofconn *ofconn,
3496 const struct ofp_header *request)
3498 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3499 struct ofputil_table_features *features;
3500 struct ofputil_table_stats *stats;
3501 struct ofpbuf *reply;
3504 query_tables(ofproto, &features, &stats);
3506 reply = ofputil_encode_table_stats_reply(request);
3507 for (i = 0; i < ofproto->n_tables; i++) {
3508 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3509 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3512 ofconn_send_reply(ofconn, reply);
3521 handle_table_features_request(struct ofconn *ofconn,
3522 const struct ofp_header *request)
3524 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3525 struct ofputil_table_features *features;
3526 struct ovs_list replies;
3530 ofpbuf_use_const(&msg, request, ntohs(request->length));
3531 ofpraw_pull_assert(&msg);
3532 if (msg.size || ofpmp_more(request)) {
3533 return OFPERR_OFPTFFC_EPERM;
3536 query_tables(ofproto, &features, NULL);
3538 ofpmp_init(&replies, request);
3539 for (i = 0; i < ofproto->n_tables; i++) {
3540 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3541 ofputil_append_table_features_reply(&features[i], &replies);
3544 ofconn_send_replies(ofconn, &replies);
3552 append_port_stat(struct ofport *port, struct ovs_list *replies)
3554 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3556 calc_duration(port->created, time_msec(),
3557 &ops.duration_sec, &ops.duration_nsec);
3559 /* Intentionally ignore return value, since errors will set
3560 * 'stats' to all-1s, which is correct for OpenFlow, and
3561 * netdev_get_stats() will log errors. */
3562 ofproto_port_get_stats(port, &ops.stats);
3564 ofputil_append_port_stat(replies, &ops);
3568 handle_port_request(struct ofconn *ofconn,
3569 const struct ofp_header *request, ofp_port_t port_no,
3570 void (*cb)(struct ofport *, struct ovs_list *replies))
3572 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3573 struct ofport *port;
3574 struct ovs_list replies;
3576 ofpmp_init(&replies, request);
3577 if (port_no != OFPP_ANY) {
3578 port = ofproto_get_port(ofproto, port_no);
3583 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3588 ofconn_send_replies(ofconn, &replies);
3592 handle_port_stats_request(struct ofconn *ofconn,
3593 const struct ofp_header *request)
3598 error = ofputil_decode_port_stats_request(request, &port_no);
3600 handle_port_request(ofconn, request, port_no, append_port_stat);
3606 append_port_desc(struct ofport *port, struct ovs_list *replies)
3608 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3612 handle_port_desc_stats_request(struct ofconn *ofconn,
3613 const struct ofp_header *request)
3618 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3620 handle_port_request(ofconn, request, port_no, append_port_desc);
3626 hash_cookie(ovs_be64 cookie)
3628 return hash_uint64((OVS_FORCE uint64_t)cookie);
3632 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3633 OVS_REQUIRES(ofproto_mutex)
3635 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3636 hash_cookie(rule->flow_cookie));
3640 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3641 OVS_REQUIRES(ofproto_mutex)
3643 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3647 calc_duration(long long int start, long long int now,
3648 uint32_t *sec, uint32_t *nsec)
3650 long long int msecs = now - start;
3651 *sec = msecs / 1000;
3652 *nsec = (msecs % 1000) * (1000 * 1000);
3655 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3656 * true if 'table_id' is OK, false otherwise. */
3658 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3660 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3663 static struct oftable *
3664 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3666 struct oftable *table;
3668 for (table = &ofproto->tables[table_id];
3669 table < &ofproto->tables[ofproto->n_tables];
3671 if (!(table->flags & OFTABLE_HIDDEN)) {
3679 static struct oftable *
3680 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3682 if (table_id == 0xff) {
3683 return next_visible_table(ofproto, 0);
3684 } else if (table_id < ofproto->n_tables) {
3685 return &ofproto->tables[table_id];
3691 static struct oftable *
3692 next_matching_table(const struct ofproto *ofproto,
3693 const struct oftable *table, uint8_t table_id)
3695 return (table_id == 0xff
3696 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3700 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3702 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3703 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3705 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3706 * only once, for that table. (This can be used to access tables marked
3709 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3710 * entered at all. (Perhaps you should have validated TABLE_ID with
3711 * check_table_id().)
3713 * All parameters are evaluated multiple times.
3715 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3716 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3718 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3720 /* Initializes 'criteria' in a straightforward way based on the other
3723 * By default, the criteria include flows that are read-only, on the assumption
3724 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3725 * if flows will be modified.
3727 * For "loose" matching, the 'priority' parameter is unimportant and may be
3730 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3731 const struct match *match, int priority, long long version,
3732 ovs_be64 cookie, ovs_be64 cookie_mask,
3733 ofp_port_t out_port, uint32_t out_group)
3735 criteria->table_id = table_id;
3736 cls_rule_init(&criteria->cr, match, priority, version);
3737 criteria->cookie = cookie;
3738 criteria->cookie_mask = cookie_mask;
3739 criteria->out_port = out_port;
3740 criteria->out_group = out_group;
3742 /* We ordinarily want to skip hidden rules, but there has to be a way for
3743 * code internal to OVS to modify and delete them, so if the criteria
3744 * specify a priority that can only be for a hidden flow, then allow hidden
3745 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3746 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3748 criteria->include_hidden = priority > UINT16_MAX;
3750 /* We assume that the criteria are being used to collect flows for reading
3751 * but not modification. Thus, we should collect read-only flows. */
3752 criteria->include_readonly = true;
3755 /* By default, criteria initialized by rule_criteria_init() will match flows
3756 * that are read-only, on the assumption that the collected flows won't be
3757 * modified. Call this function to match only flows that are be modifiable.
3759 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3760 * caller has special privileges that allow it to modify even "read-only"
3763 rule_criteria_require_rw(struct rule_criteria *criteria,
3764 bool can_write_readonly)
3766 criteria->include_readonly = can_write_readonly;
3770 rule_criteria_destroy(struct rule_criteria *criteria)
3772 cls_rule_destroy(&criteria->cr);
3776 rule_collection_init(struct rule_collection *rules)
3778 rules->rules = rules->stub;
3780 rules->capacity = ARRAY_SIZE(rules->stub);
3784 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3786 if (rules->n >= rules->capacity) {
3787 size_t old_size, new_size;
3789 old_size = rules->capacity * sizeof *rules->rules;
3790 rules->capacity *= 2;
3791 new_size = rules->capacity * sizeof *rules->rules;
3793 if (rules->rules == rules->stub) {
3794 rules->rules = xmalloc(new_size);
3795 memcpy(rules->rules, rules->stub, old_size);
3797 rules->rules = xrealloc(rules->rules, new_size);
3801 rules->rules[rules->n++] = rule;
3805 rule_collection_ref(struct rule_collection *rules)
3806 OVS_REQUIRES(ofproto_mutex)
3810 for (i = 0; i < rules->n; i++) {
3811 ofproto_rule_ref(rules->rules[i]);
3816 rule_collection_unref(struct rule_collection *rules)
3820 for (i = 0; i < rules->n; i++) {
3821 ofproto_rule_unref(rules->rules[i]);
3825 /* Returns a NULL-terminated array of rule pointers,
3826 * destroys 'rules'. */
3827 static struct rule **
3828 rule_collection_detach(struct rule_collection *rules)
3830 struct rule **rule_array;
3832 rule_collection_add(rules, NULL);
3834 if (rules->rules == rules->stub) {
3835 rules->rules = xmemdup(rules->rules, rules->n * sizeof *rules->rules);
3838 rule_array = rules->rules;
3839 rule_collection_init(rules);
3845 rule_collection_destroy(struct rule_collection *rules)
3847 if (rules->rules != rules->stub) {
3851 /* Make repeated destruction harmless. */
3852 rule_collection_init(rules);
3855 /* Schedules postponed removal of rules, destroys 'rules'. */
3857 rule_collection_remove_postponed(struct rule_collection *rules)
3858 OVS_REQUIRES(ofproto_mutex)
3861 if (rules->n == 1) {
3862 ovsrcu_postpone(remove_rule_rcu, rules->rules[0]);
3864 ovsrcu_postpone(remove_rules_rcu, rule_collection_detach(rules));
3869 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3870 * function verifies most of the criteria in 'c' itself, but the caller must
3871 * check 'c->cr' itself.
3873 * Rules that have already been marked for removal are not collected.
3875 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3876 * 'c' only includes modifiable rules). */
3878 collect_rule(struct rule *rule, const struct rule_criteria *c,
3879 struct rule_collection *rules, size_t *n_readonly)
3880 OVS_REQUIRES(ofproto_mutex)
3882 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3883 && ofproto_rule_has_out_port(rule, c->out_port)
3884 && ofproto_rule_has_out_group(rule, c->out_group)
3885 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3886 && (!rule_is_hidden(rule) || c->include_hidden)
3887 && cls_rule_visible_in_version(&rule->cr, c->cr.version)) {
3888 /* Rule matches all the criteria... */
3889 if (!rule_is_readonly(rule) || c->include_readonly) {
3891 rule_collection_add(rules, rule);
3893 /* ...except it's read-only. */
3899 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3900 * on classifiers rules are done in the "loose" way required for OpenFlow
3901 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3904 * Returns 0 on success, otherwise an OpenFlow error code. */
3906 collect_rules_loose(struct ofproto *ofproto,
3907 const struct rule_criteria *criteria,
3908 struct rule_collection *rules)
3909 OVS_REQUIRES(ofproto_mutex)
3911 struct oftable *table;
3912 enum ofperr error = 0;
3913 size_t n_readonly = 0;
3915 rule_collection_init(rules);
3917 if (!check_table_id(ofproto, criteria->table_id)) {
3918 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3922 if (criteria->cookie_mask == OVS_BE64_MAX) {
3925 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3926 hash_cookie(criteria->cookie),
3927 &ofproto->cookies) {
3928 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3929 collect_rule(rule, criteria, rules, &n_readonly);
3933 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3936 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3937 collect_rule(rule, criteria, rules, &n_readonly);
3943 if (!error && !rules->n && n_readonly) {
3944 /* We didn't find any rules to modify. We did find some read-only
3945 * rules that we're not allowed to modify, so report that. */
3946 error = OFPERR_OFPBRC_EPERM;
3949 rule_collection_destroy(rules);
3954 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3955 * on classifiers rules are done in the "strict" way required for OpenFlow
3956 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3957 * rules on list 'rules'.
3959 * Returns 0 on success, otherwise an OpenFlow error code. */
3961 collect_rules_strict(struct ofproto *ofproto,
3962 const struct rule_criteria *criteria,
3963 struct rule_collection *rules)
3964 OVS_REQUIRES(ofproto_mutex)
3966 struct oftable *table;
3967 size_t n_readonly = 0;
3968 enum ofperr error = 0;
3970 rule_collection_init(rules);
3972 if (!check_table_id(ofproto, criteria->table_id)) {
3973 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3977 if (criteria->cookie_mask == OVS_BE64_MAX) {
3980 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3981 hash_cookie(criteria->cookie),
3982 &ofproto->cookies) {
3983 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3984 collect_rule(rule, criteria, rules, &n_readonly);
3988 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3991 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3992 &table->cls, &criteria->cr));
3994 collect_rule(rule, criteria, rules, &n_readonly);
4000 if (!error && !rules->n && n_readonly) {
4001 /* We didn't find any rules to modify. We did find some read-only
4002 * rules that we're not allowed to modify, so report that. */
4003 error = OFPERR_OFPBRC_EPERM;
4006 rule_collection_destroy(rules);
4011 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4012 * forced into the range of a uint16_t. */
4014 age_secs(long long int age_ms)
4016 return (age_ms < 0 ? 0
4017 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
4018 : (unsigned int) age_ms / 1000);
4022 handle_flow_stats_request(struct ofconn *ofconn,
4023 const struct ofp_header *request)
4024 OVS_EXCLUDED(ofproto_mutex)
4026 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4027 struct ofputil_flow_stats_request fsr;
4028 struct rule_criteria criteria;
4029 struct rule_collection rules;
4030 struct ovs_list replies;
4034 error = ofputil_decode_flow_stats_request(&fsr, request);
4039 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
4040 fsr.cookie, fsr.cookie_mask, fsr.out_port,
4043 ovs_mutex_lock(&ofproto_mutex);
4044 error = collect_rules_loose(ofproto, &criteria, &rules);
4045 rule_criteria_destroy(&criteria);
4047 rule_collection_ref(&rules);
4049 ovs_mutex_unlock(&ofproto_mutex);
4055 ofpmp_init(&replies, request);
4056 for (i = 0; i < rules.n; i++) {
4057 struct rule *rule = rules.rules[i];
4058 long long int now = time_msec();
4059 struct ofputil_flow_stats fs;
4060 long long int created, used, modified;
4061 const struct rule_actions *actions;
4062 enum ofputil_flow_mod_flags flags;
4064 ovs_mutex_lock(&rule->mutex);
4065 fs.cookie = rule->flow_cookie;
4066 fs.idle_timeout = rule->idle_timeout;
4067 fs.hard_timeout = rule->hard_timeout;
4068 fs.importance = rule->importance;
4069 created = rule->created;
4070 modified = rule->modified;
4071 actions = rule_get_actions(rule);
4072 flags = rule->flags;
4073 ovs_mutex_unlock(&rule->mutex);
4075 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
4076 &fs.byte_count, &used);
4078 minimatch_expand(&rule->cr.match, &fs.match);
4079 fs.table_id = rule->table_id;
4080 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4081 fs.priority = rule->cr.priority;
4082 fs.idle_age = age_secs(now - used);
4083 fs.hard_age = age_secs(now - modified);
4084 fs.ofpacts = actions->ofpacts;
4085 fs.ofpacts_len = actions->ofpacts_len;
4088 ofputil_append_flow_stats_reply(&fs, &replies);
4091 rule_collection_unref(&rules);
4092 rule_collection_destroy(&rules);
4094 ofconn_send_replies(ofconn, &replies);
4100 flow_stats_ds(struct rule *rule, struct ds *results)
4102 uint64_t packet_count, byte_count;
4103 const struct rule_actions *actions;
4104 long long int created, used;
4106 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4107 &byte_count, &used);
4109 ovs_mutex_lock(&rule->mutex);
4110 actions = rule_get_actions(rule);
4111 created = rule->created;
4112 ovs_mutex_unlock(&rule->mutex);
4114 if (rule->table_id != 0) {
4115 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4117 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4118 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4119 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4120 cls_rule_format(&rule->cr, results);
4121 ds_put_char(results, ',');
4123 ds_put_cstr(results, "actions=");
4124 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4126 ds_put_cstr(results, "\n");
4129 /* Adds a pretty-printed description of all flows to 'results', including
4130 * hidden flows (e.g., set up by in-band control). */
4132 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4134 struct oftable *table;
4136 OFPROTO_FOR_EACH_TABLE (table, p) {
4139 CLS_FOR_EACH (rule, cr, &table->cls) {
4140 flow_stats_ds(rule, results);
4145 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4146 * '*engine_type' and '*engine_id', respectively. */
4148 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4149 uint8_t *engine_type, uint8_t *engine_id)
4151 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4154 /* Checks the status change of CFM on 'ofport'.
4156 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4158 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4160 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4161 return (ofport && ofproto->ofproto_class->cfm_status_changed
4162 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4166 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4167 * Returns 0 if the port's CFM status was successfully stored into
4168 * '*status'. Returns positive errno if the port did not have CFM
4171 * The caller must provide and own '*status', and must free 'status->rmps'.
4172 * '*status' is indeterminate if the return value is non-zero. */
4174 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4175 struct cfm_status *status)
4177 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4178 return (ofport && ofproto->ofproto_class->get_cfm_status
4179 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4184 handle_aggregate_stats_request(struct ofconn *ofconn,
4185 const struct ofp_header *oh)
4186 OVS_EXCLUDED(ofproto_mutex)
4188 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4189 struct ofputil_flow_stats_request request;
4190 struct ofputil_aggregate_stats stats;
4191 bool unknown_packets, unknown_bytes;
4192 struct rule_criteria criteria;
4193 struct rule_collection rules;
4194 struct ofpbuf *reply;
4198 error = ofputil_decode_flow_stats_request(&request, oh);
4203 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4204 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4205 request.out_port, request.out_group);
4207 ovs_mutex_lock(&ofproto_mutex);
4208 error = collect_rules_loose(ofproto, &criteria, &rules);
4209 rule_criteria_destroy(&criteria);
4211 rule_collection_ref(&rules);
4213 ovs_mutex_unlock(&ofproto_mutex);
4219 memset(&stats, 0, sizeof stats);
4220 unknown_packets = unknown_bytes = false;
4221 for (i = 0; i < rules.n; i++) {
4222 struct rule *rule = rules.rules[i];
4223 uint64_t packet_count;
4224 uint64_t byte_count;
4227 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4228 &byte_count, &used);
4230 if (packet_count == UINT64_MAX) {
4231 unknown_packets = true;
4233 stats.packet_count += packet_count;
4236 if (byte_count == UINT64_MAX) {
4237 unknown_bytes = true;
4239 stats.byte_count += byte_count;
4244 if (unknown_packets) {
4245 stats.packet_count = UINT64_MAX;
4247 if (unknown_bytes) {
4248 stats.byte_count = UINT64_MAX;
4251 rule_collection_unref(&rules);
4252 rule_collection_destroy(&rules);
4254 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4255 ofconn_send_reply(ofconn, reply);
4260 struct queue_stats_cbdata {
4261 struct ofport *ofport;
4262 struct ovs_list replies;
4267 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4268 const struct netdev_queue_stats *stats)
4270 struct ofputil_queue_stats oqs;
4272 oqs.port_no = cbdata->ofport->pp.port_no;
4273 oqs.queue_id = queue_id;
4274 oqs.tx_bytes = stats->tx_bytes;
4275 oqs.tx_packets = stats->tx_packets;
4276 oqs.tx_errors = stats->tx_errors;
4277 if (stats->created != LLONG_MIN) {
4278 calc_duration(stats->created, cbdata->now,
4279 &oqs.duration_sec, &oqs.duration_nsec);
4281 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4283 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4287 handle_queue_stats_dump_cb(uint32_t queue_id,
4288 struct netdev_queue_stats *stats,
4291 struct queue_stats_cbdata *cbdata = cbdata_;
4293 put_queue_stats(cbdata, queue_id, stats);
4297 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4298 struct queue_stats_cbdata *cbdata)
4300 cbdata->ofport = port;
4301 if (queue_id == OFPQ_ALL) {
4302 netdev_dump_queue_stats(port->netdev,
4303 handle_queue_stats_dump_cb, cbdata);
4305 struct netdev_queue_stats stats;
4307 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4308 put_queue_stats(cbdata, queue_id, &stats);
4310 return OFPERR_OFPQOFC_BAD_QUEUE;
4317 handle_queue_stats_request(struct ofconn *ofconn,
4318 const struct ofp_header *rq)
4320 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4321 struct queue_stats_cbdata cbdata;
4322 struct ofport *port;
4324 struct ofputil_queue_stats_request oqsr;
4326 COVERAGE_INC(ofproto_queue_req);
4328 ofpmp_init(&cbdata.replies, rq);
4329 cbdata.now = time_msec();
4331 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4336 if (oqsr.port_no == OFPP_ANY) {
4337 error = OFPERR_OFPQOFC_BAD_QUEUE;
4338 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4339 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4344 port = ofproto_get_port(ofproto, oqsr.port_no);
4346 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4347 : OFPERR_OFPQOFC_BAD_PORT);
4350 ofconn_send_replies(ofconn, &cbdata.replies);
4352 ofpbuf_list_delete(&cbdata.replies);
4359 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4360 OVS_REQUIRES(ofproto_mutex)
4362 enum ofperr error = 0;
4363 struct rule_collection rules;
4364 unsigned int count = classifier_count(&table->cls) + extra_space;
4365 unsigned int max_flows = table->max_flows;
4367 rule_collection_init(&rules);
4369 while (count-- > max_flows) {
4372 if (!choose_rule_to_evict(table, &rule)) {
4373 error = OFPERR_OFPFMFC_TABLE_FULL;
4376 eviction_group_remove_rule(rule);
4377 rule_collection_add(&rules, rule);
4380 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4386 is_conjunction(const struct ofpact *ofpacts, size_t ofpacts_len)
4388 return ofpacts_len > 0 && ofpacts->type == OFPACT_CONJUNCTION;
4392 get_conjunctions(const struct ofputil_flow_mod *fm,
4393 struct cls_conjunction **conjsp, size_t *n_conjsp)
4394 OVS_REQUIRES(ofproto_mutex)
4396 struct cls_conjunction *conjs = NULL;
4399 if (is_conjunction(fm->ofpacts, fm->ofpacts_len)) {
4400 const struct ofpact *ofpact;
4404 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4408 conjs = xzalloc(n_conjs * sizeof *conjs);
4410 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4411 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4412 conjs[i].clause = oc->clause;
4413 conjs[i].n_clauses = oc->n_clauses;
4414 conjs[i].id = oc->id;
4420 *n_conjsp = n_conjs;
4423 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4424 * in which no matching flow already exists in the flow table.
4426 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4427 * success, or an OpenFlow error code on failure.
4429 * On successful return the caller must complete the operation either by
4430 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4433 * The caller retains ownership of 'fm->ofpacts'. */
4435 add_flow_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4436 struct rule **old_rule, struct rule **new_rule)
4437 OVS_REQUIRES(ofproto_mutex)
4439 struct oftable *table;
4443 struct cls_conjunction *conjs;
4447 if (!check_table_id(ofproto, fm->table_id)) {
4448 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4453 if (fm->table_id == 0xff) {
4454 if (ofproto->ofproto_class->rule_choose_table) {
4455 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4461 ovs_assert(table_id < ofproto->n_tables);
4465 } else if (fm->table_id < ofproto->n_tables) {
4466 table_id = fm->table_id;
4468 return OFPERR_OFPBRC_BAD_TABLE_ID;
4471 table = &ofproto->tables[table_id];
4472 if (table->flags & OFTABLE_READONLY
4473 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4474 return OFPERR_OFPBRC_EPERM;
4477 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4478 && !match_has_default_hidden_fields(&fm->match)) {
4479 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4480 "non-default values to hidden fields", ofproto->name);
4481 return OFPERR_OFPBRC_EPERM;
4484 cls_rule_init(&cr, &fm->match, fm->priority, ofproto->tables_version + 1);
4486 /* Check for the existence of an identical rule.
4487 * This will not return rules earlier marked for removal. */
4488 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4491 /* Check for overlap, if requested. */
4492 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4493 && classifier_rule_overlaps(&table->cls, &cr)) {
4494 cls_rule_destroy(&cr);
4495 return OFPERR_OFPFMFC_OVERLAP;
4498 /* If necessary, evict an existing rule to clear out space. */
4499 error = evict_rules_from_table(table, 1);
4501 cls_rule_destroy(&cr);
4505 fm->modify_cookie = true;
4508 /* Allocate new rule. */
4509 error = replace_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4515 get_conjunctions(fm, &conjs, &n_conjs);
4516 replace_rule_start(ofproto, rule, *new_rule, conjs, n_conjs);
4522 /* Revert the effects of add_flow_start().
4523 * XXX: evictions cannot be reverted. */
4525 add_flow_revert(struct ofproto *ofproto, struct rule *old_rule,
4526 struct rule *new_rule)
4527 OVS_REQUIRES(ofproto_mutex)
4529 replace_rule_revert(ofproto, old_rule, new_rule);
4532 /* To be called after version bump. */
4534 add_flow_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4535 const struct flow_mod_requester *req,
4536 struct rule *old_rule, struct rule *new_rule)
4537 OVS_REQUIRES(ofproto_mutex)
4539 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4541 replace_rule_finish(ofproto, fm, req, old_rule, new_rule, &dead_cookies);
4542 learned_cookies_flush(ofproto, &dead_cookies);
4545 ovsrcu_postpone(remove_rule_rcu, old_rule);
4547 if (minimask_get_vid_mask(&new_rule->cr.match.mask) == VLAN_VID_MASK) {
4548 if (ofproto->vlan_bitmap) {
4549 uint16_t vid = miniflow_get_vid(&new_rule->cr.match.flow);
4551 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4552 bitmap_set1(ofproto->vlan_bitmap, vid);
4553 ofproto->vlans_changed = true;
4556 ofproto->vlans_changed = true;
4560 ofmonitor_report(ofproto->connmgr, new_rule, NXFME_ADDED, 0,
4561 req ? req->ofconn : NULL,
4562 req ? req->request->xid : 0, NULL);
4565 send_buffered_packet(req, fm->buffer_id, new_rule);
4568 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4570 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4571 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4572 * structures yet. Takes ownership of 'cr'. */
4574 replace_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4575 struct cls_rule *cr, uint8_t table_id,
4576 struct rule *old_rule, struct rule **new_rule)
4581 /* Allocate new rule. */
4582 rule = ofproto->ofproto_class->rule_alloc();
4584 cls_rule_destroy(cr);
4585 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
4586 return OFPERR_OFPFMFC_UNKNOWN;
4589 /* Initialize base state. */
4590 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4591 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
4592 ovs_refcount_init(&rule->ref_count);
4593 rule->flow_cookie = fm->new_cookie;
4594 rule->created = rule->modified = time_msec();
4596 ovs_mutex_init(&rule->mutex);
4597 ovs_mutex_lock(&rule->mutex);
4598 rule->idle_timeout = fm->idle_timeout;
4599 rule->hard_timeout = fm->hard_timeout;
4600 rule->importance = fm->importance;
4602 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
4603 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4604 *CONST_CAST(const struct rule_actions **, &rule->actions)
4605 = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4606 list_init(&rule->meter_list_node);
4607 rule->eviction_group = NULL;
4608 list_init(&rule->expirable);
4609 rule->monitor_flags = 0;
4610 rule->add_seqno = 0;
4611 rule->modify_seqno = 0;
4613 /* Copy values from old rule for modify semantics. */
4615 /* 'fm' says that */
4616 bool change_cookie = (fm->modify_cookie
4617 && fm->new_cookie != OVS_BE64_MAX
4618 && fm->new_cookie != old_rule->flow_cookie);
4620 ovs_mutex_lock(&old_rule->mutex);
4621 if (fm->command != OFPFC_ADD) {
4622 rule->idle_timeout = old_rule->idle_timeout;
4623 rule->hard_timeout = old_rule->hard_timeout;
4624 rule->importance = old_rule->importance;
4625 rule->flags = old_rule->flags;
4626 rule->created = old_rule->created;
4628 if (!change_cookie) {
4629 rule->flow_cookie = old_rule->flow_cookie;
4631 ovs_mutex_unlock(&old_rule->mutex);
4633 ovs_mutex_unlock(&rule->mutex);
4635 /* Construct rule, initializing derived state. */
4636 error = ofproto->ofproto_class->rule_construct(rule);
4638 ofproto_rule_destroy__(rule);
4642 rule->removed = true; /* Not yet in ofproto data structures. */
4649 replace_rule_start(struct ofproto *ofproto,
4650 struct rule *old_rule, struct rule *new_rule,
4651 struct cls_conjunction *conjs, size_t n_conjs)
4653 struct oftable *table = &ofproto->tables[new_rule->table_id];
4656 /* Mark the old rule for removal in the next version. */
4657 cls_rule_make_invisible_in_version(&old_rule->cr,
4658 ofproto->tables_version + 1,
4659 ofproto->tables_version);
4661 /* Insert flow to the classifier, so that later flow_mods may relate
4662 * to it. This is reversible, in case later errors require this to
4664 ofproto_rule_insert__(ofproto, new_rule);
4665 /* Make the new rule visible for classifier lookups only from the next
4667 classifier_insert(&table->cls, &new_rule->cr, conjs, n_conjs);
4670 static void replace_rule_revert(struct ofproto *ofproto,
4671 struct rule *old_rule, struct rule *new_rule)
4673 struct oftable *table = &ofproto->tables[new_rule->table_id];
4675 /* Restore the original visibility of the old rule. */
4677 cls_rule_restore_visibility(&old_rule->cr);
4680 /* Remove the new rule immediately. It was never visible to lookups. */
4681 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4684 ofproto_rule_remove__(ofproto, new_rule);
4685 /* The rule was not inserted to the ofproto provider, so we can
4686 * release it without deleting it from the ofproto provider. */
4687 ofproto_rule_unref(new_rule);
4690 /* Adds the 'new_rule', replacing the 'old_rule'. */
4692 replace_rule_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4693 const struct flow_mod_requester *req,
4694 struct rule *old_rule, struct rule *new_rule,
4695 struct ovs_list *dead_cookies)
4696 OVS_REQUIRES(ofproto_mutex)
4698 bool forward_stats = !(fm->flags & OFPUTIL_FF_RESET_COUNTS);
4700 /* Insert the new flow to the ofproto provider. A non-NULL 'old_rule' is a
4701 * duplicate rule the 'new_rule' is replacing. The provider should link
4702 * the stats from the old rule to the new one if 'forward_stats' is
4703 * 'true'. The 'old_rule' will be deleted right after this call. */
4704 ofproto->ofproto_class->rule_insert(new_rule, old_rule, forward_stats);
4705 learned_cookies_inc(ofproto, rule_get_actions(new_rule));
4708 const struct rule_actions *old_actions = rule_get_actions(old_rule);
4710 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4711 ? NXFME_ADDED : NXFME_MODIFIED;
4713 bool change_cookie = (fm->modify_cookie
4714 && fm->new_cookie != OVS_BE64_MAX
4715 && fm->new_cookie != old_rule->flow_cookie);
4717 bool change_actions = !ofpacts_equal(fm->ofpacts,
4719 old_actions->ofpacts,
4720 old_actions->ofpacts_len);
4722 /* Remove the old rule from data structures. Removal from the
4723 * classifier and the deletion of the rule is RCU postponed by the
4725 ofproto_rule_remove__(ofproto, old_rule);
4726 learned_cookies_dec(ofproto, old_actions, dead_cookies);
4728 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4729 ofmonitor_report(ofproto->connmgr, new_rule, event, 0,
4730 req ? req->ofconn : NULL,
4731 req ? req->request->xid : 0,
4732 change_actions ? old_actions : NULL);
4738 modify_flows_start__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4739 struct rule_collection *old_rules,
4740 struct rule_collection *new_rules)
4741 OVS_REQUIRES(ofproto_mutex)
4745 rule_collection_init(new_rules);
4747 if (old_rules->n > 0) {
4748 struct cls_conjunction *conjs;
4752 /* Create a new 'modified' rule for each old rule. */
4753 for (i = 0; i < old_rules->n; i++) {
4754 struct rule *old_rule = old_rules->rules[i];
4755 struct rule *new_rule;
4758 cls_rule_clone_in_version(&cr, &old_rule->cr,
4759 ofproto->tables_version + 1);
4760 error = replace_rule_create(ofproto, fm, &cr, old_rule->table_id,
4761 old_rule, &new_rule);
4763 rule_collection_add(new_rules, new_rule);
4765 rule_collection_unref(new_rules);
4766 rule_collection_destroy(new_rules);
4770 ovs_assert(new_rules->n == old_rules->n);
4772 get_conjunctions(fm, &conjs, &n_conjs);
4773 for (i = 0; i < old_rules->n; i++) {
4774 replace_rule_start(ofproto, old_rules->rules[i],
4775 new_rules->rules[i], conjs, n_conjs);
4778 } else if (!(fm->cookie_mask != htonll(0)
4779 || fm->new_cookie == OVS_BE64_MAX)) {
4780 /* No match, add a new flow. */
4781 error = add_flow_start(ofproto, fm, &old_rules->rules[0],
4782 &new_rules->rules[0]);
4784 ovs_assert(!old_rules->rules[0]);
4794 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4797 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4800 modify_flows_start_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4801 struct rule_collection *old_rules,
4802 struct rule_collection *new_rules)
4803 OVS_REQUIRES(ofproto_mutex)
4805 struct rule_criteria criteria;
4808 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4809 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4810 rule_criteria_require_rw(&criteria,
4811 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4812 error = collect_rules_loose(ofproto, &criteria, old_rules);
4813 rule_criteria_destroy(&criteria);
4816 error = modify_flows_start__(ofproto, fm, old_rules, new_rules);
4820 rule_collection_destroy(old_rules);
4826 modify_flows_revert(struct ofproto *ofproto, struct rule_collection *old_rules,
4827 struct rule_collection *new_rules)
4828 OVS_REQUIRES(ofproto_mutex)
4830 /* Old rules were not changed yet, only need to revert new rules. */
4831 if (old_rules->n == 0 && new_rules->n == 1) {
4832 add_flow_revert(ofproto, new_rules->rules[0], NULL);
4833 } else if (old_rules->n > 0) {
4834 for (size_t i = 0; i < old_rules->n; i++) {
4835 replace_rule_revert(ofproto, old_rules->rules[i],
4836 new_rules->rules[i]);
4838 rule_collection_destroy(new_rules);
4839 rule_collection_destroy(old_rules);
4844 modify_flows_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4845 const struct flow_mod_requester *req,
4846 struct rule_collection *old_rules,
4847 struct rule_collection *new_rules)
4848 OVS_REQUIRES(ofproto_mutex)
4850 if (old_rules->n == 0 && new_rules->n == 1) {
4851 add_flow_finish(ofproto, fm, req, old_rules->rules[0],
4852 new_rules->rules[0]);
4853 } else if (old_rules->n > 0) {
4854 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4856 ovs_assert(new_rules->n == old_rules->n);
4858 for (size_t i = 0; i < old_rules->n; i++) {
4859 replace_rule_finish(ofproto, fm, req, old_rules->rules[i],
4860 new_rules->rules[i], &dead_cookies);
4862 learned_cookies_flush(ofproto, &dead_cookies);
4863 rule_collection_remove_postponed(old_rules);
4865 send_buffered_packet(req, fm->buffer_id, new_rules->rules[0]);
4866 rule_collection_destroy(new_rules);
4870 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4871 * code on failure. */
4873 modify_flow_start_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4874 struct rule_collection *old_rules,
4875 struct rule_collection *new_rules)
4876 OVS_REQUIRES(ofproto_mutex)
4878 struct rule_criteria criteria;
4881 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4882 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
4884 rule_criteria_require_rw(&criteria,
4885 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4886 error = collect_rules_strict(ofproto, &criteria, old_rules);
4887 rule_criteria_destroy(&criteria);
4890 /* collect_rules_strict() can return max 1 rule. */
4891 error = modify_flows_start__(ofproto, fm, old_rules, new_rules);
4895 rule_collection_destroy(old_rules);
4900 /* OFPFC_DELETE implementation. */
4903 delete_flows_start__(struct ofproto *ofproto,
4904 const struct rule_collection *rules)
4905 OVS_REQUIRES(ofproto_mutex)
4907 for (size_t i = 0; i < rules->n; i++) {
4908 cls_rule_make_invisible_in_version(&rules->rules[i]->cr,
4909 ofproto->tables_version + 1,
4910 ofproto->tables_version);
4915 delete_flows_finish__(struct ofproto *ofproto,
4916 struct rule_collection *rules,
4917 enum ofp_flow_removed_reason reason,
4918 const struct flow_mod_requester *req)
4919 OVS_REQUIRES(ofproto_mutex)
4922 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4924 for (size_t i = 0; i < rules->n; i++) {
4925 struct rule *rule = rules->rules[i];
4927 ofproto_rule_send_removed(rule, reason);
4928 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4929 req ? req->ofconn : NULL,
4930 req ? req->request->xid : 0, NULL);
4931 ofproto_rule_remove__(ofproto, rule);
4932 learned_cookies_dec(ofproto, rule_get_actions(rule),
4935 rule_collection_remove_postponed(rules);
4937 learned_cookies_flush(ofproto, &dead_cookies);
4941 /* Deletes the rules listed in 'rules'.
4942 * The deleted rules will become invisible to the lookups in the next version.
4943 * Destroys 'rules'. */
4945 delete_flows__(struct rule_collection *rules,
4946 enum ofp_flow_removed_reason reason,
4947 const struct flow_mod_requester *req)
4948 OVS_REQUIRES(ofproto_mutex)
4951 struct ofproto *ofproto = rules->rules[0]->ofproto;
4953 delete_flows_start__(ofproto, rules);
4954 ofproto_bump_tables_version(ofproto);
4955 delete_flows_finish__(ofproto, rules, reason, req);
4956 ofmonitor_flush(ofproto->connmgr);
4960 /* Implements OFPFC_DELETE. */
4962 delete_flows_start_loose(struct ofproto *ofproto,
4963 const struct ofputil_flow_mod *fm,
4964 struct rule_collection *rules)
4965 OVS_REQUIRES(ofproto_mutex)
4967 struct rule_criteria criteria;
4970 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4971 fm->cookie, fm->cookie_mask, fm->out_port,
4973 rule_criteria_require_rw(&criteria,
4974 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4975 error = collect_rules_loose(ofproto, &criteria, rules);
4976 rule_criteria_destroy(&criteria);
4979 delete_flows_start__(ofproto, rules);
4986 delete_flows_revert(struct ofproto *ofproto OVS_UNUSED,
4987 struct rule_collection *rules)
4988 OVS_REQUIRES(ofproto_mutex)
4990 for (size_t i = 0; i < rules->n; i++) {
4991 struct rule *rule = rules->rules[i];
4993 /* Restore the original visibility of the rule. */
4994 cls_rule_restore_visibility(&rule->cr);
4996 rule_collection_destroy(rules);
5000 delete_flows_finish(struct ofproto *ofproto,
5001 const struct ofputil_flow_mod *fm,
5002 const struct flow_mod_requester *req,
5003 struct rule_collection *rules)
5004 OVS_REQUIRES(ofproto_mutex)
5006 delete_flows_finish__(ofproto, rules, fm->delete_reason, req);
5009 /* Implements OFPFC_DELETE_STRICT. */
5011 delete_flow_start_strict(struct ofproto *ofproto,
5012 const struct ofputil_flow_mod *fm,
5013 struct rule_collection *rules)
5014 OVS_REQUIRES(ofproto_mutex)
5016 struct rule_criteria criteria;
5019 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5020 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
5021 fm->out_port, fm->out_group);
5022 rule_criteria_require_rw(&criteria,
5023 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5024 error = collect_rules_strict(ofproto, &criteria, rules);
5025 rule_criteria_destroy(&criteria);
5028 delete_flows_start__(ofproto, rules);
5035 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
5036 OVS_REQUIRES(ofproto_mutex)
5038 struct ofputil_flow_removed fr;
5041 if (rule_is_hidden(rule) ||
5042 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
5046 minimatch_expand(&rule->cr.match, &fr.match);
5047 fr.priority = rule->cr.priority;
5048 fr.cookie = rule->flow_cookie;
5050 fr.table_id = rule->table_id;
5051 calc_duration(rule->created, time_msec(),
5052 &fr.duration_sec, &fr.duration_nsec);
5053 ovs_mutex_lock(&rule->mutex);
5054 fr.idle_timeout = rule->idle_timeout;
5055 fr.hard_timeout = rule->hard_timeout;
5056 ovs_mutex_unlock(&rule->mutex);
5057 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
5058 &fr.byte_count, &used);
5060 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
5063 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5064 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5067 * ofproto implementation ->run() functions should use this function to expire
5068 * OpenFlow flows. */
5070 ofproto_rule_expire(struct rule *rule, uint8_t reason)
5071 OVS_REQUIRES(ofproto_mutex)
5073 struct rule_collection rules;
5075 rules.rules = rules.stub;
5077 rules.stub[0] = rule;
5078 delete_flows__(&rules, reason, NULL);
5081 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5082 * means "infinite". */
5084 reduce_timeout(uint16_t max, uint16_t *timeout)
5086 if (max && (!*timeout || *timeout > max)) {
5091 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5092 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5093 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5095 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5097 ofproto_rule_reduce_timeouts(struct rule *rule,
5098 uint16_t idle_timeout, uint16_t hard_timeout)
5099 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5101 if (!idle_timeout && !hard_timeout) {
5105 ovs_mutex_lock(&ofproto_mutex);
5106 if (list_is_empty(&rule->expirable)) {
5107 list_insert(&rule->ofproto->expirable, &rule->expirable);
5109 ovs_mutex_unlock(&ofproto_mutex);
5111 ovs_mutex_lock(&rule->mutex);
5112 reduce_timeout(idle_timeout, &rule->idle_timeout);
5113 reduce_timeout(hard_timeout, &rule->hard_timeout);
5114 ovs_mutex_unlock(&rule->mutex);
5118 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5119 OVS_EXCLUDED(ofproto_mutex)
5121 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5122 struct ofputil_flow_mod fm;
5123 uint64_t ofpacts_stub[1024 / 8];
5124 struct ofpbuf ofpacts;
5127 error = reject_slave_controller(ofconn);
5132 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5133 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
5135 u16_to_ofp(ofproto->max_ports),
5138 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
5141 struct flow_mod_requester req;
5143 req.ofconn = ofconn;
5145 error = handle_flow_mod__(ofproto, &fm, &req);
5148 goto exit_free_ofpacts;
5151 ofconn_report_flow_mod(ofconn, fm.command);
5154 ofpbuf_uninit(&ofpacts);
5160 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
5161 const struct flow_mod_requester *req)
5162 OVS_EXCLUDED(ofproto_mutex)
5164 struct ofp_bundle_entry be;
5167 ovs_mutex_lock(&ofproto_mutex);
5168 error = do_bundle_flow_mod_start(ofproto, fm, &be);
5170 ofproto_bump_tables_version(ofproto);
5171 do_bundle_flow_mod_finish(ofproto, fm, req, &be);
5173 ofmonitor_flush(ofproto->connmgr);
5174 ovs_mutex_unlock(&ofproto_mutex);
5176 run_rule_executes(ofproto);
5181 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5183 struct ofputil_role_request request;
5184 struct ofputil_role_request reply;
5188 error = ofputil_decode_role_message(oh, &request);
5193 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5194 if (request.have_generation_id
5195 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5196 return OFPERR_OFPRRFC_STALE;
5199 ofconn_set_role(ofconn, request.role);
5202 reply.role = ofconn_get_role(ofconn);
5203 reply.have_generation_id = ofconn_get_master_election_id(
5204 ofconn, &reply.generation_id);
5205 buf = ofputil_encode_role_reply(oh, &reply);
5206 ofconn_send_reply(ofconn, buf);
5212 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5213 const struct ofp_header *oh)
5215 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5216 enum ofputil_protocol cur, next;
5218 cur = ofconn_get_protocol(ofconn);
5219 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5220 ofconn_set_protocol(ofconn, next);
5226 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5228 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5229 enum ofputil_protocol cur, next;
5230 enum ofputil_protocol next_base;
5232 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5234 return OFPERR_OFPBRC_EPERM;
5237 cur = ofconn_get_protocol(ofconn);
5238 next = ofputil_protocol_set_base(cur, next_base);
5239 ofconn_set_protocol(ofconn, next);
5245 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5246 const struct ofp_header *oh)
5248 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5251 format = ntohl(msg->format);
5252 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5253 return OFPERR_OFPBRC_EPERM;
5256 ofconn_set_packet_in_format(ofconn, format);
5261 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5263 const struct nx_async_config *msg = ofpmsg_body(oh);
5264 uint32_t master[OAM_N_TYPES];
5265 uint32_t slave[OAM_N_TYPES];
5267 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5268 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5269 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5271 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5272 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5273 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5275 ofconn_set_async_config(ofconn, master, slave);
5276 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5277 !ofconn_get_miss_send_len(ofconn)) {
5278 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5285 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5288 uint32_t master[OAM_N_TYPES];
5289 uint32_t slave[OAM_N_TYPES];
5290 struct nx_async_config *msg;
5292 ofconn_get_async_config(ofconn, master, slave);
5293 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5294 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5296 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5297 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5298 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5300 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5301 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5302 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5304 ofconn_send_reply(ofconn, buf);
5310 handle_nxt_set_controller_id(struct ofconn *ofconn,
5311 const struct ofp_header *oh)
5313 const struct nx_controller_id *nci = ofpmsg_body(oh);
5315 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5316 return OFPERR_NXBRC_MUST_BE_ZERO;
5319 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5324 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5328 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5329 ? OFPRAW_OFPT10_BARRIER_REPLY
5330 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5331 ofconn_send_reply(ofconn, buf);
5336 ofproto_compose_flow_refresh_update(const struct rule *rule,
5337 enum nx_flow_monitor_flags flags,
5338 struct ovs_list *msgs)
5339 OVS_REQUIRES(ofproto_mutex)
5341 const struct rule_actions *actions;
5342 struct ofputil_flow_update fu;
5345 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5346 ? NXFME_ADDED : NXFME_MODIFIED);
5348 ovs_mutex_lock(&rule->mutex);
5349 fu.idle_timeout = rule->idle_timeout;
5350 fu.hard_timeout = rule->hard_timeout;
5351 ovs_mutex_unlock(&rule->mutex);
5352 fu.table_id = rule->table_id;
5353 fu.cookie = rule->flow_cookie;
5354 minimatch_expand(&rule->cr.match, &match);
5356 fu.priority = rule->cr.priority;
5358 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5359 fu.ofpacts = actions ? actions->ofpacts : NULL;
5360 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5362 if (list_is_empty(msgs)) {
5363 ofputil_start_flow_update(msgs);
5365 ofputil_append_flow_update(&fu, msgs);
5369 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5370 struct ovs_list *msgs)
5371 OVS_REQUIRES(ofproto_mutex)
5375 for (i = 0; i < rules->n; i++) {
5376 struct rule *rule = rules->rules[i];
5377 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5378 rule->monitor_flags = 0;
5380 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5385 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5386 struct rule *rule, uint64_t seqno,
5387 struct rule_collection *rules)
5388 OVS_REQUIRES(ofproto_mutex)
5390 enum nx_flow_monitor_flags update;
5392 if (rule_is_hidden(rule)) {
5396 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5401 if (rule->add_seqno > seqno) {
5402 update = NXFMF_ADD | NXFMF_MODIFY;
5403 } else if (rule->modify_seqno > seqno) {
5404 update = NXFMF_MODIFY;
5409 if (!(m->flags & update)) {
5413 update = NXFMF_INITIAL;
5416 if (!rule->monitor_flags) {
5417 rule_collection_add(rules, rule);
5419 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5423 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5425 struct rule_collection *rules)
5426 OVS_REQUIRES(ofproto_mutex)
5428 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5429 const struct oftable *table;
5430 struct cls_rule target;
5432 cls_rule_init_from_minimatch(&target, &m->match, 0, CLS_MAX_VERSION);
5433 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5436 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5437 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5440 cls_rule_destroy(&target);
5444 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5445 struct rule_collection *rules)
5446 OVS_REQUIRES(ofproto_mutex)
5448 if (m->flags & NXFMF_INITIAL) {
5449 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5454 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5455 uint64_t seqno, struct rule_collection *rules)
5456 OVS_REQUIRES(ofproto_mutex)
5458 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5462 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5463 OVS_REQUIRES(ofproto_mutex)
5465 struct ofmonitor *m;
5468 m = ofmonitor_lookup(ofconn, id);
5470 ofmonitor_destroy(m);
5473 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5480 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5481 OVS_EXCLUDED(ofproto_mutex)
5483 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5484 struct ofmonitor **monitors;
5485 size_t n_monitors, allocated_monitors;
5486 struct rule_collection rules;
5487 struct ovs_list replies;
5492 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5494 n_monitors = allocated_monitors = 0;
5496 ovs_mutex_lock(&ofproto_mutex);
5498 struct ofputil_flow_monitor_request request;
5499 struct ofmonitor *m;
5502 retval = ofputil_decode_flow_monitor_request(&request, &b);
5503 if (retval == EOF) {
5505 } else if (retval) {
5510 if (request.table_id != 0xff
5511 && request.table_id >= ofproto->n_tables) {
5512 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5516 error = ofmonitor_create(&request, ofconn, &m);
5521 if (n_monitors >= allocated_monitors) {
5522 monitors = x2nrealloc(monitors, &allocated_monitors,
5525 monitors[n_monitors++] = m;
5528 rule_collection_init(&rules);
5529 for (i = 0; i < n_monitors; i++) {
5530 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5533 ofpmp_init(&replies, oh);
5534 ofmonitor_compose_refresh_updates(&rules, &replies);
5535 ovs_mutex_unlock(&ofproto_mutex);
5537 rule_collection_destroy(&rules);
5539 ofconn_send_replies(ofconn, &replies);
5545 for (i = 0; i < n_monitors; i++) {
5546 ofmonitor_destroy(monitors[i]);
5549 ovs_mutex_unlock(&ofproto_mutex);
5555 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5556 OVS_EXCLUDED(ofproto_mutex)
5561 id = ofputil_decode_flow_monitor_cancel(oh);
5563 ovs_mutex_lock(&ofproto_mutex);
5564 error = flow_monitor_delete(ofconn, id);
5565 ovs_mutex_unlock(&ofproto_mutex);
5570 /* Meters implementation.
5572 * Meter table entry, indexed by the OpenFlow meter_id.
5573 * 'created' is used to compute the duration for meter stats.
5574 * 'list rules' is needed so that we can delete the dependent rules when the
5575 * meter table entry is deleted.
5576 * 'provider_meter_id' is for the provider's private use.
5579 long long int created; /* Time created. */
5580 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5581 ofproto_meter_id provider_meter_id;
5582 uint16_t flags; /* Meter flags. */
5583 uint16_t n_bands; /* Number of meter bands. */
5584 struct ofputil_meter_band *bands;
5588 * This is used in instruction validation at flow set-up time,
5589 * as flows may not use non-existing meters.
5590 * Return value of UINT32_MAX signifies an invalid meter.
5593 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5595 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5596 const struct meter *meter = ofproto->meters[of_meter_id];
5598 return meter->provider_meter_id.uint32;
5604 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5607 meter_insert_rule(struct rule *rule)
5609 const struct rule_actions *a = rule_get_actions(rule);
5610 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5611 struct meter *meter = rule->ofproto->meters[meter_id];
5613 list_insert(&meter->rules, &rule->meter_list_node);
5617 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5621 meter->flags = config->flags;
5622 meter->n_bands = config->n_bands;
5623 meter->bands = xmemdup(config->bands,
5624 config->n_bands * sizeof *meter->bands);
5627 static struct meter *
5628 meter_create(const struct ofputil_meter_config *config,
5629 ofproto_meter_id provider_meter_id)
5631 struct meter *meter;
5633 meter = xzalloc(sizeof *meter);
5634 meter->provider_meter_id = provider_meter_id;
5635 meter->created = time_msec();
5636 list_init(&meter->rules);
5638 meter_update(meter, config);
5644 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5645 OVS_REQUIRES(ofproto_mutex)
5648 for (mid = first; mid <= last; ++mid) {
5649 struct meter *meter = ofproto->meters[mid];
5651 ofproto->meters[mid] = NULL;
5652 ofproto->ofproto_class->meter_del(ofproto,
5653 meter->provider_meter_id);
5661 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5663 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5664 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5668 return OFPERR_OFPMMFC_METER_EXISTS;
5671 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5674 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5675 *meterp = meter_create(&mm->meter, provider_meter_id);
5681 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5683 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5685 uint32_t provider_meter_id;
5688 return OFPERR_OFPMMFC_UNKNOWN_METER;
5691 provider_meter_id = meter->provider_meter_id.uint32;
5692 error = ofproto->ofproto_class->meter_set(ofproto,
5693 &meter->provider_meter_id,
5695 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5697 meter_update(meter, &mm->meter);
5703 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5704 OVS_EXCLUDED(ofproto_mutex)
5706 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5707 uint32_t meter_id = mm->meter.meter_id;
5708 struct rule_collection rules;
5709 enum ofperr error = 0;
5710 uint32_t first, last;
5712 if (meter_id == OFPM13_ALL) {
5714 last = ofproto->meter_features.max_meters;
5716 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5719 first = last = meter_id;
5722 /* First delete the rules that use this meter. If any of those rules are
5723 * currently being modified, postpone the whole operation until later. */
5724 rule_collection_init(&rules);
5725 ovs_mutex_lock(&ofproto_mutex);
5726 for (meter_id = first; meter_id <= last; ++meter_id) {
5727 struct meter *meter = ofproto->meters[meter_id];
5728 if (meter && !list_is_empty(&meter->rules)) {
5731 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5732 rule_collection_add(&rules, rule);
5736 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5738 /* Delete the meters. */
5739 meter_delete(ofproto, first, last);
5741 ovs_mutex_unlock(&ofproto_mutex);
5747 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5749 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5750 struct ofputil_meter_mod mm;
5751 uint64_t bands_stub[256 / 8];
5752 struct ofpbuf bands;
5756 error = reject_slave_controller(ofconn);
5761 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5763 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5765 goto exit_free_bands;
5768 meter_id = mm.meter.meter_id;
5770 if (mm.command != OFPMC13_DELETE) {
5771 /* Fails also when meters are not implemented by the provider. */
5772 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5773 error = OFPERR_OFPMMFC_INVALID_METER;
5774 goto exit_free_bands;
5775 } else if (meter_id > ofproto->meter_features.max_meters) {
5776 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5777 goto exit_free_bands;
5779 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5780 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5781 goto exit_free_bands;
5785 switch (mm.command) {
5787 error = handle_add_meter(ofproto, &mm);
5790 case OFPMC13_MODIFY:
5791 error = handle_modify_meter(ofproto, &mm);
5794 case OFPMC13_DELETE:
5795 error = handle_delete_meter(ofconn, &mm);
5799 error = OFPERR_OFPMMFC_BAD_COMMAND;
5804 ofpbuf_uninit(&bands);
5809 handle_meter_features_request(struct ofconn *ofconn,
5810 const struct ofp_header *request)
5812 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5813 struct ofputil_meter_features features;
5816 if (ofproto->ofproto_class->meter_get_features) {
5817 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5819 memset(&features, 0, sizeof features);
5821 b = ofputil_encode_meter_features_reply(&features, request);
5823 ofconn_send_reply(ofconn, b);
5828 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5831 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5832 struct ovs_list replies;
5833 uint64_t bands_stub[256 / 8];
5834 struct ofpbuf bands;
5835 uint32_t meter_id, first, last;
5837 ofputil_decode_meter_request(request, &meter_id);
5839 if (meter_id == OFPM13_ALL) {
5841 last = ofproto->meter_features.max_meters;
5843 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5844 !ofproto->meters[meter_id]) {
5845 return OFPERR_OFPMMFC_UNKNOWN_METER;
5847 first = last = meter_id;
5850 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5851 ofpmp_init(&replies, request);
5853 for (meter_id = first; meter_id <= last; ++meter_id) {
5854 struct meter *meter = ofproto->meters[meter_id];
5856 continue; /* Skip non-existing meters. */
5858 if (type == OFPTYPE_METER_STATS_REQUEST) {
5859 struct ofputil_meter_stats stats;
5861 stats.meter_id = meter_id;
5863 /* Provider sets the packet and byte counts, we do the rest. */
5864 stats.flow_count = list_size(&meter->rules);
5865 calc_duration(meter->created, time_msec(),
5866 &stats.duration_sec, &stats.duration_nsec);
5867 stats.n_bands = meter->n_bands;
5868 ofpbuf_clear(&bands);
5870 = ofpbuf_put_uninit(&bands,
5871 meter->n_bands * sizeof *stats.bands);
5873 if (!ofproto->ofproto_class->meter_get(ofproto,
5874 meter->provider_meter_id,
5876 ofputil_append_meter_stats(&replies, &stats);
5878 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5879 struct ofputil_meter_config config;
5881 config.meter_id = meter_id;
5882 config.flags = meter->flags;
5883 config.n_bands = meter->n_bands;
5884 config.bands = meter->bands;
5885 ofputil_append_meter_config(&replies, &config);
5889 ofconn_send_replies(ofconn, &replies);
5890 ofpbuf_uninit(&bands);
5895 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5896 struct ofgroup **group)
5897 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5899 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5900 hash_int(group_id, 0), &ofproto->groups) {
5901 if ((*group)->group_id == group_id) {
5909 /* If the group exists, this function increments the groups's reference count.
5911 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5912 * a reference to the group. */
5914 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5915 struct ofgroup **group)
5919 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5920 found = ofproto_group_lookup__(ofproto, group_id, group);
5922 ofproto_group_ref(*group);
5924 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5929 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5930 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5932 struct ofgroup *grp;
5934 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5935 hash_int(group_id, 0), &ofproto->groups) {
5936 if (grp->group_id == group_id) {
5944 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5945 OVS_EXCLUDED(ofproto->groups_rwlock)
5949 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5950 exists = ofproto_group_exists__(ofproto, group_id);
5951 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5957 group_get_ref_count(struct ofgroup *group)
5958 OVS_EXCLUDED(ofproto_mutex)
5960 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5961 struct rule_criteria criteria;
5962 struct rule_collection rules;
5967 match_init_catchall(&match);
5968 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
5969 htonll(0), OFPP_ANY, group->group_id);
5970 ovs_mutex_lock(&ofproto_mutex);
5971 error = collect_rules_loose(ofproto, &criteria, &rules);
5972 ovs_mutex_unlock(&ofproto_mutex);
5973 rule_criteria_destroy(&criteria);
5975 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5977 rule_collection_destroy(&rules);
5982 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
5984 struct ofputil_group_stats ogs;
5985 const struct ofproto *ofproto = group->ofproto;
5986 long long int now = time_msec();
5989 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5991 /* Provider sets the packet and byte counts, we do the rest. */
5992 ogs.ref_count = group_get_ref_count(group);
5993 ogs.n_buckets = group->n_buckets;
5995 error = (ofproto->ofproto_class->group_get_stats
5996 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5999 ogs.packet_count = UINT64_MAX;
6000 ogs.byte_count = UINT64_MAX;
6001 memset(ogs.bucket_stats, 0xff,
6002 ogs.n_buckets * sizeof *ogs.bucket_stats);
6005 ogs.group_id = group->group_id;
6006 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
6008 ofputil_append_group_stats(replies, &ogs);
6010 free(ogs.bucket_stats);
6014 handle_group_request(struct ofconn *ofconn,
6015 const struct ofp_header *request, uint32_t group_id,
6016 void (*cb)(struct ofgroup *, struct ovs_list *replies))
6018 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6019 struct ofgroup *group;
6020 struct ovs_list replies;
6022 ofpmp_init(&replies, request);
6023 if (group_id == OFPG_ALL) {
6024 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6025 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
6026 cb(group, &replies);
6028 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6030 if (ofproto_group_lookup(ofproto, group_id, &group)) {
6031 cb(group, &replies);
6032 ofproto_group_unref(group);
6035 ofconn_send_replies(ofconn, &replies);
6039 handle_group_stats_request(struct ofconn *ofconn,
6040 const struct ofp_header *request)
6045 error = ofputil_decode_group_stats_request(request, &group_id);
6050 handle_group_request(ofconn, request, group_id, append_group_stats);
6055 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
6057 struct ofputil_group_desc gds;
6059 gds.group_id = group->group_id;
6060 gds.type = group->type;
6061 gds.props = group->props;
6063 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
6067 handle_group_desc_stats_request(struct ofconn *ofconn,
6068 const struct ofp_header *request)
6070 handle_group_request(ofconn, request,
6071 ofputil_decode_group_desc_request(request),
6077 handle_group_features_stats_request(struct ofconn *ofconn,
6078 const struct ofp_header *request)
6080 struct ofproto *p = ofconn_get_ofproto(ofconn);
6083 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6085 ofconn_send_reply(ofconn, msg);
6092 handle_queue_get_config_request(struct ofconn *ofconn,
6093 const struct ofp_header *oh)
6095 struct ofproto *p = ofconn_get_ofproto(ofconn);
6096 struct netdev_queue_dump queue_dump;
6097 struct ofport *ofport;
6098 unsigned int queue_id;
6099 struct ofpbuf *reply;
6100 struct smap details;
6104 error = ofputil_decode_queue_get_config_request(oh, &request);
6109 ofport = ofproto_get_port(p, request);
6111 return OFPERR_OFPQOFC_BAD_PORT;
6114 reply = ofputil_encode_queue_get_config_reply(oh);
6116 smap_init(&details);
6117 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6118 struct ofputil_queue_config queue;
6120 /* None of the existing queues have compatible properties, so we
6121 * hard-code omitting min_rate and max_rate. */
6122 queue.queue_id = queue_id;
6123 queue.min_rate = UINT16_MAX;
6124 queue.max_rate = UINT16_MAX;
6125 ofputil_append_queue_get_config_reply(reply, &queue);
6127 smap_destroy(&details);
6129 ofconn_send_reply(ofconn, reply);
6135 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6136 struct ofgroup **ofgroup)
6139 const long long int now = time_msec();
6141 if (gm->group_id > OFPG_MAX) {
6142 return OFPERR_OFPGMFC_INVALID_GROUP;
6144 if (gm->type > OFPGT11_FF) {
6145 return OFPERR_OFPGMFC_BAD_TYPE;
6148 *ofgroup = ofproto->ofproto_class->group_alloc();
6150 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6151 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6154 (*ofgroup)->ofproto = ofproto;
6155 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6156 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6157 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6158 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6159 ovs_refcount_init(&(*ofgroup)->ref_count);
6161 list_move(&(*ofgroup)->buckets, &gm->buckets);
6162 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6163 list_size(&(*ofgroup)->buckets);
6165 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6166 &gm->props, sizeof (struct ofputil_group_props));
6168 /* Construct called BEFORE any locks are held. */
6169 error = ofproto->ofproto_class->group_construct(*ofgroup);
6171 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6172 ofproto->ofproto_class->group_dealloc(*ofgroup);
6177 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6178 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6181 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6183 struct ofgroup *ofgroup;
6186 /* Allocate new group and initialize it. */
6187 error = init_group(ofproto, gm, &ofgroup);
6192 /* We wrlock as late as possible to minimize the time we jam any other
6193 * threads: No visible state changes before acquiring the lock. */
6194 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6196 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6197 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6201 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6202 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6207 /* Insert new group. */
6208 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6209 hash_int(ofgroup->group_id, 0));
6210 ofproto->n_groups[ofgroup->type]++;
6212 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6217 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6218 ofproto->ofproto_class->group_destruct(ofgroup);
6219 ofputil_bucket_list_destroy(&ofgroup->buckets);
6220 ofproto->ofproto_class->group_dealloc(ofgroup);
6225 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6226 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6227 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6228 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6231 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6232 struct ofgroup *new_ofgroup,
6233 uint32_t command_bucket_id)
6235 struct ofputil_bucket *last = NULL;
6237 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6238 /* Check here to ensure that a bucket corresponding to
6239 * command_bucket_id exists in the old bucket list.
6241 * The subsequent search of below of new_ofgroup covers
6242 * both buckets in the old bucket list and buckets added
6243 * by the insert buckets group mod message this function processes. */
6244 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6245 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6248 if (!list_is_empty(&new_ofgroup->buckets)) {
6249 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6253 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6255 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6256 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6257 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6260 /* Rearrange list according to command_bucket_id */
6261 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6262 struct ofputil_bucket *new_first;
6263 const struct ofputil_bucket *first;
6265 first = ofputil_bucket_list_front(&ofgroup->buckets);
6266 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6269 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6270 &new_ofgroup->buckets);
6271 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6272 struct ofputil_bucket *after;
6274 /* Presence of bucket is checked above so after should never be NULL */
6275 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6277 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6278 last->list_node.next);
6284 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6285 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6286 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6287 * and OFPG15_BUCKET_ALL are also honored. */
6289 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6290 struct ofgroup *new_ofgroup,
6291 uint32_t command_bucket_id)
6293 const struct ofputil_bucket *skip = NULL;
6295 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6299 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6300 if (!list_is_empty(&ofgroup->buckets)) {
6301 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6303 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6304 if (!list_is_empty(&ofgroup->buckets)) {
6305 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6308 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6310 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6314 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6319 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6320 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6323 * Note that the group is re-created and then replaces the old group in
6324 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6325 * the xlate module hold a pointer to the group. */
6327 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6329 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6332 error = init_group(ofproto, gm, &new_ofgroup);
6337 retiring = new_ofgroup;
6339 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6340 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6341 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6345 /* Ofproto's group write lock is held now. */
6346 if (ofgroup->type != gm->type
6347 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6348 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6352 /* Manipulate bucket list for bucket commands */
6353 if (gm->command == OFPGC15_INSERT_BUCKET) {
6354 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6355 gm->command_bucket_id);
6356 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6357 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6358 gm->command_bucket_id);
6364 /* The group creation time does not change during modification. */
6365 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6366 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6368 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6374 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6375 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6376 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6377 hash_int(new_ofgroup->group_id, 0));
6378 if (ofgroup->type != new_ofgroup->type) {
6379 ofproto->n_groups[ofgroup->type]--;
6380 ofproto->n_groups[new_ofgroup->type]++;
6384 ofproto_group_unref(retiring);
6385 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6390 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6391 OVS_RELEASES(ofproto->groups_rwlock)
6394 struct ofputil_flow_mod fm;
6396 /* Delete all flow entries containing this group in a group action */
6397 match_init_catchall(&match);
6398 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6399 fm.delete_reason = OFPRR_GROUP_DELETE;
6400 fm.out_group = ofgroup->group_id;
6401 handle_flow_mod__(ofproto, &fm, NULL);
6403 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6404 /* No-one can find this group any more. */
6405 ofproto->n_groups[ofgroup->type]--;
6406 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6407 ofproto_group_unref(ofgroup);
6410 /* Implements OFPGC11_DELETE. */
6412 delete_group(struct ofproto *ofproto, uint32_t group_id)
6414 struct ofgroup *ofgroup;
6416 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6417 if (group_id == OFPG_ALL) {
6419 struct hmap_node *node = hmap_first(&ofproto->groups);
6423 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6424 delete_group__(ofproto, ofgroup);
6425 /* Lock for each node separately, so that we will not jam the
6426 * other threads for too long time. */
6427 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6430 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6431 hash_int(group_id, 0), &ofproto->groups) {
6432 if (ofgroup->group_id == group_id) {
6433 delete_group__(ofproto, ofgroup);
6438 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6442 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6444 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6445 struct ofputil_group_mod gm;
6448 error = reject_slave_controller(ofconn);
6453 error = ofputil_decode_group_mod(oh, &gm);
6458 switch (gm.command) {
6460 return add_group(ofproto, &gm);
6462 case OFPGC11_MODIFY:
6463 return modify_group(ofproto, &gm);
6465 case OFPGC11_DELETE:
6466 delete_group(ofproto, gm.group_id);
6469 case OFPGC15_INSERT_BUCKET:
6470 return modify_group(ofproto, &gm);
6472 case OFPGC15_REMOVE_BUCKET:
6473 return modify_group(ofproto, &gm);
6476 if (gm.command > OFPGC11_DELETE) {
6477 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6478 ofproto->name, gm.command);
6480 return OFPERR_OFPGMFC_BAD_COMMAND;
6484 enum ofputil_table_miss
6485 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6487 enum ofputil_table_miss value;
6489 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6494 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6496 if (!check_table_id(ofproto, tm->table_id)) {
6497 return OFPERR_OFPTMFC_BAD_TABLE;
6498 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6499 if (tm->table_id == OFPTT_ALL) {
6501 for (i = 0; i < ofproto->n_tables; i++) {
6502 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6506 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6514 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6516 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6517 struct ofputil_table_mod tm;
6520 error = reject_slave_controller(ofconn);
6525 error = ofputil_decode_table_mod(oh, &tm);
6530 return table_mod(ofproto, &tm);
6534 do_bundle_flow_mod_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6535 struct ofp_bundle_entry *be)
6536 OVS_REQUIRES(ofproto_mutex)
6538 switch (fm->command) {
6540 return add_flow_start(ofproto, fm, &be->old_rules.stub[0],
6541 &be->new_rules.stub[0]);
6543 return modify_flows_start_loose(ofproto, fm, &be->old_rules,
6545 case OFPFC_MODIFY_STRICT:
6546 return modify_flow_start_strict(ofproto, fm, &be->old_rules,
6549 return delete_flows_start_loose(ofproto, fm, &be->old_rules);
6551 case OFPFC_DELETE_STRICT:
6552 return delete_flow_start_strict(ofproto, fm, &be->old_rules);
6555 return OFPERR_OFPFMFC_BAD_COMMAND;
6559 do_bundle_flow_mod_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6560 struct ofp_bundle_entry *be)
6561 OVS_REQUIRES(ofproto_mutex)
6563 switch (fm->command) {
6565 add_flow_revert(ofproto, be->old_rules.stub[0], be->new_rules.stub[0]);
6569 case OFPFC_MODIFY_STRICT:
6570 modify_flows_revert(ofproto, &be->old_rules, &be->new_rules);
6574 case OFPFC_DELETE_STRICT:
6575 delete_flows_revert(ofproto, &be->old_rules);
6584 do_bundle_flow_mod_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6585 const struct flow_mod_requester *req,
6586 struct ofp_bundle_entry *be)
6587 OVS_REQUIRES(ofproto_mutex)
6589 switch (fm->command) {
6591 add_flow_finish(ofproto, fm, req, be->old_rules.stub[0],
6592 be->new_rules.stub[0]);
6596 case OFPFC_MODIFY_STRICT:
6597 modify_flows_finish(ofproto, fm, req, &be->old_rules, &be->new_rules);
6601 case OFPFC_DELETE_STRICT:
6602 delete_flows_finish(ofproto, fm, req, &be->old_rules);
6610 /* Commit phases (all while locking ofproto_mutex):
6612 * 1. Begin: Gather resources and make changes visible in the next version.
6613 * - Mark affected rules for removal in the next version.
6614 * - Create new replacement rules, make visible in the next
6616 * - Do not send any events or notifications.
6618 * 2. Revert: Fail if any errors are found. After this point no errors are
6619 * possible. No visible changes were made, so rollback is minimal (remove
6620 * added invisible rules, restore visibility of rules marked for removal).
6622 * 3. Bump the version visible to lookups.
6624 * 4. Finish: Insert replacement rules to the ofproto provider. Remove replaced
6625 * and deleted rules from ofproto data structures, and Schedule postponed
6626 * removal of deleted rules from the classifier. Send notifications, buffered
6630 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6632 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6633 struct ofp_bundle *bundle;
6634 struct ofp_bundle_entry *be;
6637 bundle = ofconn_get_bundle(ofconn, id);
6640 return OFPERR_OFPBFC_BAD_ID;
6642 if (bundle->flags != flags) {
6643 error = OFPERR_OFPBFC_BAD_FLAGS;
6646 ovs_mutex_lock(&ofproto_mutex);
6649 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6650 if (be->type == OFPTYPE_PORT_MOD) {
6651 /* Not supported yet. */
6652 error = OFPERR_OFPBFC_MSG_FAILED;
6653 } else if (be->type == OFPTYPE_FLOW_MOD) {
6654 error = do_bundle_flow_mod_start(ofproto, &be->fm, be);
6663 /* Send error referring to the original message. */
6665 ofconn_send_error(ofconn, be->ofp_msg, error);
6666 error = OFPERR_OFPBFC_MSG_FAILED;
6669 /* 2. Revert. Undo all the changes made above. */
6670 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6671 if (be->type == OFPTYPE_FLOW_MOD) {
6672 do_bundle_flow_mod_revert(ofproto, &be->fm, be);
6676 /* 3. Bump the version. This makes all the changes in the bundle
6677 * visible to the lookups at once. For this to work an upcall must
6678 * read the tables_version once at the beginning and keep using the
6679 * same version number for the whole duration of the upcall
6681 ofproto_bump_tables_version(ofproto);
6684 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6685 if (be->type == OFPTYPE_FLOW_MOD) {
6686 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6688 do_bundle_flow_mod_finish(ofproto, &be->fm, &req, be);
6692 ofmonitor_flush(ofproto->connmgr);
6693 ovs_mutex_unlock(&ofproto_mutex);
6695 run_rule_executes(ofproto);
6698 /* The bundle is discarded regardless the outcome. */
6699 ofp_bundle_remove__(ofconn, bundle, !error);
6704 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6706 struct ofputil_bundle_ctrl_msg bctrl;
6707 struct ofputil_bundle_ctrl_msg reply;
6711 error = reject_slave_controller(ofconn);
6716 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6721 reply.bundle_id = bctrl.bundle_id;
6723 switch (bctrl.type) {
6724 case OFPBCT_OPEN_REQUEST:
6725 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6726 reply.type = OFPBCT_OPEN_REPLY;
6728 case OFPBCT_CLOSE_REQUEST:
6729 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6730 reply.type = OFPBCT_CLOSE_REPLY;;
6732 case OFPBCT_COMMIT_REQUEST:
6733 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6734 reply.type = OFPBCT_COMMIT_REPLY;
6736 case OFPBCT_DISCARD_REQUEST:
6737 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6738 reply.type = OFPBCT_DISCARD_REPLY;
6741 case OFPBCT_OPEN_REPLY:
6742 case OFPBCT_CLOSE_REPLY:
6743 case OFPBCT_COMMIT_REPLY:
6744 case OFPBCT_DISCARD_REPLY:
6745 return OFPERR_OFPBFC_BAD_TYPE;
6750 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6751 ofconn_send_reply(ofconn, buf);
6757 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6759 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6761 struct ofputil_bundle_add_msg badd;
6762 struct ofp_bundle_entry *bmsg;
6765 error = reject_slave_controller(ofconn);
6770 error = ofputil_decode_bundle_add(oh, &badd, &type);
6775 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
6777 if (type == OFPTYPE_PORT_MOD) {
6778 error = ofputil_decode_port_mod(badd.msg, &bmsg->pm, false);
6779 } else if (type == OFPTYPE_FLOW_MOD) {
6780 struct ofpbuf ofpacts;
6781 uint64_t ofpacts_stub[1024 / 8];
6783 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6784 error = ofputil_decode_flow_mod(&bmsg->fm, badd.msg,
6785 ofconn_get_protocol(ofconn),
6787 u16_to_ofp(ofproto->max_ports),
6789 /* Move actions to heap. */
6790 bmsg->fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6792 if (!error && bmsg->fm.ofpacts_len) {
6793 error = ofproto_check_ofpacts(ofproto, bmsg->fm.ofpacts,
6794 bmsg->fm.ofpacts_len);
6801 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
6806 ofp_bundle_entry_free(bmsg);
6813 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6814 OVS_EXCLUDED(ofproto_mutex)
6816 const struct ofp_header *oh = msg->data;
6820 error = ofptype_decode(&type, oh);
6824 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6825 && ofpmp_more(oh)) {
6826 /* We have no buffer implementation for multipart requests.
6827 * Report overflow for requests which consists of multiple
6829 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6833 /* OpenFlow requests. */
6834 case OFPTYPE_ECHO_REQUEST:
6835 return handle_echo_request(ofconn, oh);
6837 case OFPTYPE_FEATURES_REQUEST:
6838 return handle_features_request(ofconn, oh);
6840 case OFPTYPE_GET_CONFIG_REQUEST:
6841 return handle_get_config_request(ofconn, oh);
6843 case OFPTYPE_SET_CONFIG:
6844 return handle_set_config(ofconn, oh);
6846 case OFPTYPE_PACKET_OUT:
6847 return handle_packet_out(ofconn, oh);
6849 case OFPTYPE_PORT_MOD:
6850 return handle_port_mod(ofconn, oh);
6852 case OFPTYPE_FLOW_MOD:
6853 return handle_flow_mod(ofconn, oh);
6855 case OFPTYPE_GROUP_MOD:
6856 return handle_group_mod(ofconn, oh);
6858 case OFPTYPE_TABLE_MOD:
6859 return handle_table_mod(ofconn, oh);
6861 case OFPTYPE_METER_MOD:
6862 return handle_meter_mod(ofconn, oh);
6864 case OFPTYPE_BARRIER_REQUEST:
6865 return handle_barrier_request(ofconn, oh);
6867 case OFPTYPE_ROLE_REQUEST:
6868 return handle_role_request(ofconn, oh);
6870 /* OpenFlow replies. */
6871 case OFPTYPE_ECHO_REPLY:
6874 /* Nicira extension requests. */
6875 case OFPTYPE_FLOW_MOD_TABLE_ID:
6876 return handle_nxt_flow_mod_table_id(ofconn, oh);
6878 case OFPTYPE_SET_FLOW_FORMAT:
6879 return handle_nxt_set_flow_format(ofconn, oh);
6881 case OFPTYPE_SET_PACKET_IN_FORMAT:
6882 return handle_nxt_set_packet_in_format(ofconn, oh);
6884 case OFPTYPE_SET_CONTROLLER_ID:
6885 return handle_nxt_set_controller_id(ofconn, oh);
6887 case OFPTYPE_FLOW_AGE:
6888 /* Nothing to do. */
6891 case OFPTYPE_FLOW_MONITOR_CANCEL:
6892 return handle_flow_monitor_cancel(ofconn, oh);
6894 case OFPTYPE_SET_ASYNC_CONFIG:
6895 return handle_nxt_set_async_config(ofconn, oh);
6897 case OFPTYPE_GET_ASYNC_REQUEST:
6898 return handle_nxt_get_async_request(ofconn, oh);
6900 /* Statistics requests. */
6901 case OFPTYPE_DESC_STATS_REQUEST:
6902 return handle_desc_stats_request(ofconn, oh);
6904 case OFPTYPE_FLOW_STATS_REQUEST:
6905 return handle_flow_stats_request(ofconn, oh);
6907 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6908 return handle_aggregate_stats_request(ofconn, oh);
6910 case OFPTYPE_TABLE_STATS_REQUEST:
6911 return handle_table_stats_request(ofconn, oh);
6913 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6914 return handle_table_features_request(ofconn, oh);
6916 case OFPTYPE_PORT_STATS_REQUEST:
6917 return handle_port_stats_request(ofconn, oh);
6919 case OFPTYPE_QUEUE_STATS_REQUEST:
6920 return handle_queue_stats_request(ofconn, oh);
6922 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6923 return handle_port_desc_stats_request(ofconn, oh);
6925 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6926 return handle_flow_monitor_request(ofconn, oh);
6928 case OFPTYPE_METER_STATS_REQUEST:
6929 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6930 return handle_meter_request(ofconn, oh, type);
6932 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6933 return handle_meter_features_request(ofconn, oh);
6935 case OFPTYPE_GROUP_STATS_REQUEST:
6936 return handle_group_stats_request(ofconn, oh);
6938 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6939 return handle_group_desc_stats_request(ofconn, oh);
6941 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6942 return handle_group_features_stats_request(ofconn, oh);
6944 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6945 return handle_queue_get_config_request(ofconn, oh);
6947 case OFPTYPE_BUNDLE_CONTROL:
6948 return handle_bundle_control(ofconn, oh);
6950 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6951 return handle_bundle_add(ofconn, oh);
6955 case OFPTYPE_FEATURES_REPLY:
6956 case OFPTYPE_GET_CONFIG_REPLY:
6957 case OFPTYPE_PACKET_IN:
6958 case OFPTYPE_FLOW_REMOVED:
6959 case OFPTYPE_PORT_STATUS:
6960 case OFPTYPE_BARRIER_REPLY:
6961 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6962 case OFPTYPE_DESC_STATS_REPLY:
6963 case OFPTYPE_FLOW_STATS_REPLY:
6964 case OFPTYPE_QUEUE_STATS_REPLY:
6965 case OFPTYPE_PORT_STATS_REPLY:
6966 case OFPTYPE_TABLE_STATS_REPLY:
6967 case OFPTYPE_AGGREGATE_STATS_REPLY:
6968 case OFPTYPE_PORT_DESC_STATS_REPLY:
6969 case OFPTYPE_ROLE_REPLY:
6970 case OFPTYPE_FLOW_MONITOR_PAUSED:
6971 case OFPTYPE_FLOW_MONITOR_RESUMED:
6972 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6973 case OFPTYPE_GET_ASYNC_REPLY:
6974 case OFPTYPE_GROUP_STATS_REPLY:
6975 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6976 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6977 case OFPTYPE_METER_STATS_REPLY:
6978 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6979 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6980 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6981 case OFPTYPE_ROLE_STATUS:
6983 if (ofpmsg_is_stat_request(oh)) {
6984 return OFPERR_OFPBRC_BAD_STAT;
6986 return OFPERR_OFPBRC_BAD_TYPE;
6992 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6993 OVS_EXCLUDED(ofproto_mutex)
6995 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
6998 ofconn_send_error(ofconn, ofp_msg->data, error);
7000 COVERAGE_INC(ofproto_recv_openflow);
7003 /* Asynchronous operations. */
7006 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
7008 OVS_REQUIRES(ofproto_mutex)
7010 if (req && req->ofconn && buffer_id != UINT32_MAX) {
7011 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
7012 struct dp_packet *packet;
7016 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
7019 struct rule_execute *re;
7021 ofproto_rule_ref(rule);
7023 re = xmalloc(sizeof *re);
7025 re->in_port = in_port;
7026 re->packet = packet;
7028 if (!guarded_list_push_back(&ofproto->rule_executes,
7029 &re->list_node, 1024)) {
7030 ofproto_rule_unref(rule);
7031 dp_packet_delete(re->packet);
7035 ofconn_send_error(req->ofconn, req->request, error);
7041 pick_datapath_id(const struct ofproto *ofproto)
7043 const struct ofport *port;
7045 port = ofproto_get_port(ofproto, OFPP_LOCAL);
7047 uint8_t ea[ETH_ADDR_LEN];
7050 error = netdev_get_etheraddr(port->netdev, ea);
7052 return eth_addr_to_uint64(ea);
7054 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7055 ofproto->name, netdev_get_name(port->netdev),
7056 ovs_strerror(error));
7058 return ofproto->fallback_dpid;
7062 pick_fallback_dpid(void)
7064 uint8_t ea[ETH_ADDR_LEN];
7065 eth_addr_nicira_random(ea);
7066 return eth_addr_to_uint64(ea);
7069 /* Table overflow policy. */
7071 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7072 * to NULL if the table is not configured to evict rules or if the table
7073 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7074 * or with no timeouts are not evictable.) */
7076 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
7077 OVS_REQUIRES(ofproto_mutex)
7079 struct eviction_group *evg;
7082 if (!table->eviction_fields) {
7086 /* In the common case, the outer and inner loops here will each be entered
7089 * - The inner loop normally "return"s in its first iteration. If the
7090 * eviction group has any evictable rules, then it always returns in
7093 * - The outer loop only iterates more than once if the largest eviction
7094 * group has no evictable rules.
7096 * - The outer loop can exit only if table's 'max_flows' is all filled up
7097 * by unevictable rules. */
7098 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7101 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7110 /* Eviction groups. */
7112 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7113 * rules. The priority contains low-order random bits to ensure that eviction
7114 * groups with the same number of rules are prioritized randomly. */
7116 eviction_group_priority(size_t n_rules)
7118 uint16_t size = MIN(UINT16_MAX, n_rules);
7119 return (size << 16) | random_uint16();
7122 /* Updates 'evg', an eviction_group within 'table', following a change that
7123 * adds or removes rules in 'evg'. */
7125 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7126 OVS_REQUIRES(ofproto_mutex)
7128 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7129 eviction_group_priority(heap_count(&evg->rules)));
7132 /* Destroys 'evg', an eviction_group within 'table':
7134 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7135 * rules themselves, just removes them from the eviction group.)
7137 * - Removes 'evg' from 'table'.
7141 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7142 OVS_REQUIRES(ofproto_mutex)
7144 while (!heap_is_empty(&evg->rules)) {
7147 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7148 rule->eviction_group = NULL;
7150 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7151 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7152 heap_destroy(&evg->rules);
7156 /* Removes 'rule' from its eviction group, if any. */
7158 eviction_group_remove_rule(struct rule *rule)
7159 OVS_REQUIRES(ofproto_mutex)
7161 if (rule->eviction_group) {
7162 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7163 struct eviction_group *evg = rule->eviction_group;
7165 rule->eviction_group = NULL;
7166 heap_remove(&evg->rules, &rule->evg_node);
7167 if (heap_is_empty(&evg->rules)) {
7168 eviction_group_destroy(table, evg);
7170 eviction_group_resized(table, evg);
7175 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7176 * returns the hash value. */
7178 eviction_group_hash_rule(struct rule *rule)
7179 OVS_REQUIRES(ofproto_mutex)
7181 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7182 const struct mf_subfield *sf;
7186 hash = table->eviction_group_id_basis;
7187 miniflow_expand(&rule->cr.match.flow, &flow);
7188 for (sf = table->eviction_fields;
7189 sf < &table->eviction_fields[table->n_eviction_fields];
7192 if (mf_are_prereqs_ok(sf->field, &flow)) {
7193 union mf_value value;
7195 mf_get_value(sf->field, &flow, &value);
7197 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7199 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7200 unsigned int start = sf->ofs + sf->n_bits;
7201 bitwise_zero(&value, sf->field->n_bytes, start,
7202 sf->field->n_bytes * 8 - start);
7204 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7206 hash = hash_int(hash, 0);
7213 /* Returns an eviction group within 'table' with the given 'id', creating one
7215 static struct eviction_group *
7216 eviction_group_find(struct oftable *table, uint32_t id)
7217 OVS_REQUIRES(ofproto_mutex)
7219 struct eviction_group *evg;
7221 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7225 evg = xmalloc(sizeof *evg);
7226 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7227 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7228 eviction_group_priority(0));
7229 heap_init(&evg->rules);
7234 /* Returns an eviction priority for 'rule'. The return value should be
7235 * interpreted so that higher priorities make a rule more attractive candidates
7237 * Called only if have a timeout. */
7239 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7240 OVS_REQUIRES(ofproto_mutex)
7242 long long int expiration = LLONG_MAX;
7243 long long int modified;
7244 uint32_t expiration_offset;
7246 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7247 ovs_mutex_lock(&rule->mutex);
7248 modified = rule->modified;
7249 ovs_mutex_unlock(&rule->mutex);
7251 if (rule->hard_timeout) {
7252 expiration = modified + rule->hard_timeout * 1000;
7254 if (rule->idle_timeout) {
7255 uint64_t packets, bytes;
7257 long long int idle_expiration;
7259 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7260 idle_expiration = used + rule->idle_timeout * 1000;
7261 expiration = MIN(expiration, idle_expiration);
7264 if (expiration == LLONG_MAX) {
7268 /* Calculate the time of expiration as a number of (approximate) seconds
7269 * after program startup.
7271 * This should work OK for program runs that last UINT32_MAX seconds or
7272 * less. Therefore, please restart OVS at least once every 136 years. */
7273 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
7275 /* Invert the expiration offset because we're using a max-heap. */
7276 return UINT32_MAX - expiration_offset;
7279 /* Adds 'rule' to an appropriate eviction group for its oftable's
7280 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7281 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7284 * The caller must ensure that 'rule' is not already in an eviction group. */
7286 eviction_group_add_rule(struct rule *rule)
7287 OVS_REQUIRES(ofproto_mutex)
7289 struct ofproto *ofproto = rule->ofproto;
7290 struct oftable *table = &ofproto->tables[rule->table_id];
7293 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7294 * so no additional protection is needed. */
7295 has_timeout = rule->hard_timeout || rule->idle_timeout;
7297 if (table->eviction_fields && has_timeout) {
7298 struct eviction_group *evg;
7300 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7302 rule->eviction_group = evg;
7303 heap_insert(&evg->rules, &rule->evg_node,
7304 rule_eviction_priority(ofproto, rule));
7305 eviction_group_resized(table, evg);
7311 /* Initializes 'table'. */
7313 oftable_init(struct oftable *table)
7315 memset(table, 0, sizeof *table);
7316 classifier_init(&table->cls, flow_segment_u64s);
7317 table->max_flows = UINT_MAX;
7318 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7320 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7321 ARRAY_SIZE(default_prefix_fields));
7323 atomic_init(&table->n_matched, 0);
7324 atomic_init(&table->n_missed, 0);
7327 /* Destroys 'table', including its classifier and eviction groups.
7329 * The caller is responsible for freeing 'table' itself. */
7331 oftable_destroy(struct oftable *table)
7333 ovs_assert(classifier_is_empty(&table->cls));
7334 oftable_disable_eviction(table);
7335 classifier_destroy(&table->cls);
7339 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7340 * string, then 'table' will use its default name.
7342 * This only affects the name exposed for a table exposed through the OpenFlow
7343 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7345 oftable_set_name(struct oftable *table, const char *name)
7347 if (name && name[0]) {
7348 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7349 if (!table->name || strncmp(name, table->name, len)) {
7351 table->name = xmemdup0(name, len);
7359 /* oftables support a choice of two policies when adding a rule would cause the
7360 * number of flows in the table to exceed the configured maximum number: either
7361 * they can refuse to add the new flow or they can evict some existing flow.
7362 * This function configures the former policy on 'table'. */
7364 oftable_disable_eviction(struct oftable *table)
7365 OVS_REQUIRES(ofproto_mutex)
7367 if (table->eviction_fields) {
7368 struct eviction_group *evg, *next;
7370 HMAP_FOR_EACH_SAFE (evg, next, id_node,
7371 &table->eviction_groups_by_id) {
7372 eviction_group_destroy(table, evg);
7374 hmap_destroy(&table->eviction_groups_by_id);
7375 heap_destroy(&table->eviction_groups_by_size);
7377 free(table->eviction_fields);
7378 table->eviction_fields = NULL;
7379 table->n_eviction_fields = 0;
7383 /* oftables support a choice of two policies when adding a rule would cause the
7384 * number of flows in the table to exceed the configured maximum number: either
7385 * they can refuse to add the new flow or they can evict some existing flow.
7386 * This function configures the latter policy on 'table', with fairness based
7387 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7388 * 'n_fields' as 0 disables fairness.) */
7390 oftable_enable_eviction(struct oftable *table,
7391 const struct mf_subfield *fields, size_t n_fields)
7392 OVS_REQUIRES(ofproto_mutex)
7396 if (table->eviction_fields
7397 && n_fields == table->n_eviction_fields
7399 || !memcmp(fields, table->eviction_fields,
7400 n_fields * sizeof *fields))) {
7405 oftable_disable_eviction(table);
7407 table->n_eviction_fields = n_fields;
7408 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
7410 table->eviction_group_id_basis = random_uint32();
7411 hmap_init(&table->eviction_groups_by_id);
7412 heap_init(&table->eviction_groups_by_size);
7414 CLS_FOR_EACH (rule, cr, &table->cls) {
7415 eviction_group_add_rule(rule);
7419 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7420 * it to the classifier. */
7422 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7423 OVS_REQUIRES(ofproto_mutex)
7425 const struct rule_actions *actions = rule_get_actions(rule);
7427 ovs_assert(rule->removed);
7429 if (rule->hard_timeout || rule->idle_timeout) {
7430 list_insert(&ofproto->expirable, &rule->expirable);
7432 cookies_insert(ofproto, rule);
7433 eviction_group_add_rule(rule);
7434 if (actions->has_meter) {
7435 meter_insert_rule(rule);
7437 rule->removed = false;
7440 /* Removes 'rule' from the ofproto data structures. */
7442 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7443 OVS_REQUIRES(ofproto_mutex)
7445 ovs_assert(!rule->removed);
7447 cookies_remove(ofproto, rule);
7449 eviction_group_remove_rule(rule);
7450 if (!list_is_empty(&rule->expirable)) {
7451 list_remove(&rule->expirable);
7453 if (!list_is_empty(&rule->meter_list_node)) {
7454 list_remove(&rule->meter_list_node);
7455 list_init(&rule->meter_list_node);
7458 rule->removed = true;
7461 /* unixctl commands. */
7464 ofproto_lookup(const char *name)
7466 struct ofproto *ofproto;
7468 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7470 if (!strcmp(ofproto->name, name)) {
7478 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7479 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7481 struct ofproto *ofproto;
7485 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7486 ds_put_format(&results, "%s\n", ofproto->name);
7488 unixctl_command_reply(conn, ds_cstr(&results));
7489 ds_destroy(&results);
7493 ofproto_unixctl_init(void)
7495 static bool registered;
7501 unixctl_command_register("ofproto/list", "", 0, 0,
7502 ofproto_unixctl_list, NULL);
7505 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7507 * This is deprecated. It is only for compatibility with broken device drivers
7508 * in old versions of Linux that do not properly support VLANs when VLAN
7509 * devices are not used. When broken device drivers are no longer in
7510 * widespread use, we will delete these interfaces. */
7512 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7513 * (exactly) by an OpenFlow rule in 'ofproto'. */
7515 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7518 struct cls_rule target;
7519 const struct oftable *oftable;
7521 match_init_catchall(&match);
7522 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7523 cls_rule_init(&target, &match, 0, CLS_MAX_VERSION);
7525 free(ofproto->vlan_bitmap);
7526 ofproto->vlan_bitmap = bitmap_allocate(4096);
7527 ofproto->vlans_changed = false;
7529 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7532 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7533 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7534 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7536 bitmap_set1(vlan_bitmap, vid);
7537 bitmap_set1(ofproto->vlan_bitmap, vid);
7542 cls_rule_destroy(&target);
7545 /* Returns true if new VLANs have come into use by the flow table since the
7546 * last call to ofproto_get_vlan_usage().
7548 * We don't track when old VLANs stop being used. */
7550 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7552 return ofproto->vlans_changed;
7555 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7556 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7557 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7558 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7559 * then the VLAN device is un-enslaved. */
7561 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7562 ofp_port_t realdev_ofp_port, int vid)
7564 struct ofport *ofport;
7567 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7569 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7571 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7572 ofproto->name, vlandev_ofp_port);
7576 if (!ofproto->ofproto_class->set_realdev) {
7577 if (!vlandev_ofp_port) {
7580 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7584 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7586 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7587 ofproto->name, vlandev_ofp_port,
7588 netdev_get_name(ofport->netdev), ovs_strerror(error));