2 * Copyright (c) 2009-2015 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
47 #include "dp-packet.h"
51 #include "poll-loop.h"
59 #include "tun-metadata.h"
60 #include "unaligned.h"
62 #include "openvswitch/vlog.h"
65 VLOG_DEFINE_THIS_MODULE(ofproto);
67 COVERAGE_DEFINE(ofproto_flush);
68 COVERAGE_DEFINE(ofproto_packet_out);
69 COVERAGE_DEFINE(ofproto_queue_req);
70 COVERAGE_DEFINE(ofproto_recv_openflow);
71 COVERAGE_DEFINE(ofproto_reinit_ports);
72 COVERAGE_DEFINE(ofproto_update_port);
74 /* Default fields to use for prefix tries in each flow table, unless something
75 * else is configured. */
76 const enum mf_field_id default_prefix_fields[2] =
77 { MFF_IPV4_DST, MFF_IPV4_SRC };
80 static void oftable_init(struct oftable *);
81 static void oftable_destroy(struct oftable *);
83 static void oftable_set_name(struct oftable *, const char *name);
85 static enum ofperr evict_rules_from_table(struct oftable *)
86 OVS_REQUIRES(ofproto_mutex);
87 static void oftable_configure_eviction(struct oftable *,
88 unsigned int eviction,
89 const struct mf_subfield *fields,
91 OVS_REQUIRES(ofproto_mutex);
93 /* This is the only combination of OpenFlow eviction flags that OVS supports: a
94 * combination of OF1.4+ importance, the remaining lifetime of the flow, and
95 * fairness based on user-specified fields. */
96 #define OFPROTO_EVICTION_FLAGS \
97 (OFPTMPEF14_OTHER | OFPTMPEF14_IMPORTANCE | OFPTMPEF14_LIFETIME)
99 /* A set of rules within a single OpenFlow table (oftable) that have the same
100 * values for the oftable's eviction_fields. A rule to be evicted, when one is
101 * needed, is taken from the eviction group that contains the greatest number
104 * An oftable owns any number of eviction groups, each of which contains any
107 * Membership in an eviction group is imprecise, based on the hash of the
108 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
109 * That is, if two rules have different eviction_fields, but those
110 * eviction_fields hash to the same value, then they will belong to the same
111 * eviction_group anyway.
113 * (When eviction is not enabled on an oftable, we don't track any eviction
114 * groups, to save time and space.) */
115 struct eviction_group {
116 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
117 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
118 struct heap rules; /* Contains "struct rule"s. */
121 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
122 OVS_REQUIRES(ofproto_mutex);
123 static uint64_t rule_eviction_priority(struct ofproto *ofproto, struct rule *)
124 OVS_REQUIRES(ofproto_mutex);
125 static void eviction_group_add_rule(struct rule *)
126 OVS_REQUIRES(ofproto_mutex);
127 static void eviction_group_remove_rule(struct rule *)
128 OVS_REQUIRES(ofproto_mutex);
130 /* Criteria that flow_mod and other operations use for selecting rules on
131 * which to operate. */
132 struct rule_criteria {
133 /* An OpenFlow table or 255 for all tables. */
136 /* OpenFlow matching criteria. Interpreted different in "loose" way by
137 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
138 * defined in the OpenFlow spec. */
140 cls_version_t version;
142 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
143 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
144 * The rule will not be selected if M is 1 and B != C. */
146 ovs_be64 cookie_mask;
148 /* Selection based on actions within a rule:
150 * If out_port != OFPP_ANY, selects only rules that output to out_port.
151 * If out_group != OFPG_ALL, select only rules that output to out_group. */
155 /* If true, collects only rules that are modifiable. */
157 bool include_readonly;
160 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
161 const struct match *match, int priority,
162 cls_version_t version,
163 ovs_be64 cookie, ovs_be64 cookie_mask,
164 ofp_port_t out_port, uint32_t out_group);
165 static void rule_criteria_require_rw(struct rule_criteria *,
166 bool can_write_readonly);
167 static void rule_criteria_destroy(struct rule_criteria *);
169 static enum ofperr collect_rules_loose(struct ofproto *,
170 const struct rule_criteria *,
171 struct rule_collection *);
173 /* A packet that needs to be passed to rule_execute().
175 * (We can't do this immediately from ofopgroup_complete() because that holds
176 * ofproto_mutex, which rule_execute() needs released.) */
177 struct rule_execute {
178 struct ovs_list list_node; /* In struct ofproto's "rule_executes" list. */
179 struct rule *rule; /* Owns a reference to the rule. */
181 struct dp_packet *packet; /* Owns the packet. */
184 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
185 static void destroy_rule_executes(struct ofproto *);
187 struct learned_cookie {
189 /* In struct ofproto's 'learned_cookies' hmap. */
190 struct hmap_node hmap_node OVS_GUARDED_BY(ofproto_mutex);
192 /* In 'dead_cookies' list when removed from hmap. */
193 struct ovs_list list_node;
197 ovs_be64 cookie OVS_GUARDED_BY(ofproto_mutex);
198 uint8_t table_id OVS_GUARDED_BY(ofproto_mutex);
200 /* Number of references from "learn" actions.
202 * When this drops to 0, all of the flows in 'table_id' with the specified
203 * 'cookie' are deleted. */
204 int n OVS_GUARDED_BY(ofproto_mutex);
207 static const struct ofpact_learn *next_learn_with_delete(
208 const struct rule_actions *, const struct ofpact_learn *start);
210 static void learned_cookies_inc(struct ofproto *, const struct rule_actions *)
211 OVS_REQUIRES(ofproto_mutex);
212 static void learned_cookies_dec(struct ofproto *, const struct rule_actions *,
213 struct ovs_list *dead_cookies)
214 OVS_REQUIRES(ofproto_mutex);
215 static void learned_cookies_flush(struct ofproto *, struct ovs_list *dead_cookies)
216 OVS_REQUIRES(ofproto_mutex);
219 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
220 static void ofport_destroy(struct ofport *);
222 static int update_port(struct ofproto *, const char *devname);
223 static int init_ports(struct ofproto *);
224 static void reinit_ports(struct ofproto *);
226 static long long int ofport_get_usage(const struct ofproto *,
227 ofp_port_t ofp_port);
228 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
229 long long int last_used);
230 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
234 * Keeps track of the currently used and recently used ofport values and is
235 * used to prevent immediate recycling of ofport values. */
236 struct ofport_usage {
237 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
238 ofp_port_t ofp_port; /* OpenFlow port number. */
239 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
240 represents in-use ofports. */
244 static void ofproto_rule_send_removed(struct rule *)
245 OVS_EXCLUDED(ofproto_mutex);
246 static bool rule_is_readonly(const struct rule *);
247 static void ofproto_rule_insert__(struct ofproto *, struct rule *)
248 OVS_REQUIRES(ofproto_mutex);
249 static void ofproto_rule_remove__(struct ofproto *, struct rule *)
250 OVS_REQUIRES(ofproto_mutex);
252 /* The source of a flow_mod request, in the code that processes flow_mods.
254 * A flow table modification request can be generated externally, via OpenFlow,
255 * or internally through a function call. This structure indicates the source
256 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
257 * meaningful and thus supplied as NULL. */
258 struct flow_mod_requester {
259 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
260 const struct ofp_header *request;
264 static enum ofperr replace_rule_create(struct ofproto *,
265 struct ofputil_flow_mod *,
266 struct cls_rule *cr, uint8_t table_id,
267 struct rule *old_rule,
268 struct rule **new_rule)
269 OVS_REQUIRES(ofproto_mutex);
271 static void replace_rule_start(struct ofproto *, cls_version_t version,
272 struct rule *old_rule, struct rule *new_rule,
273 struct cls_conjunction *, size_t n_conjs)
274 OVS_REQUIRES(ofproto_mutex);
276 static void replace_rule_revert(struct ofproto *, struct rule *old_rule,
277 struct rule *new_rule)
278 OVS_REQUIRES(ofproto_mutex);
280 static void replace_rule_finish(struct ofproto *, struct ofputil_flow_mod *,
281 const struct flow_mod_requester *,
282 struct rule *old_rule, struct rule *new_rule,
283 struct ovs_list *dead_cookies)
284 OVS_REQUIRES(ofproto_mutex);
285 static void delete_flows__(struct rule_collection *,
286 enum ofp_flow_removed_reason,
287 const struct flow_mod_requester *)
288 OVS_REQUIRES(ofproto_mutex);
290 static void send_buffered_packet(const struct flow_mod_requester *,
291 uint32_t buffer_id, struct rule *)
292 OVS_REQUIRES(ofproto_mutex);
294 static bool ofproto_group_exists__(const struct ofproto *ofproto,
296 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
297 static bool ofproto_group_exists(const struct ofproto *ofproto,
299 OVS_EXCLUDED(ofproto->groups_rwlock);
300 static enum ofperr add_group(struct ofproto *,
301 const struct ofputil_group_mod *);
302 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
303 static enum ofperr ofproto_flow_mod_start(struct ofproto *,
304 struct ofproto_flow_mod *)
305 OVS_REQUIRES(ofproto_mutex);
306 static void ofproto_flow_mod_finish(struct ofproto *,
307 struct ofproto_flow_mod *,
308 const struct flow_mod_requester *)
309 OVS_REQUIRES(ofproto_mutex);
310 static enum ofperr handle_flow_mod__(struct ofproto *,
311 struct ofproto_flow_mod *,
312 const struct flow_mod_requester *)
313 OVS_EXCLUDED(ofproto_mutex);
314 static void calc_duration(long long int start, long long int now,
315 uint32_t *sec, uint32_t *nsec);
318 static uint64_t pick_datapath_id(const struct ofproto *);
319 static uint64_t pick_fallback_dpid(void);
320 static void ofproto_destroy__(struct ofproto *);
321 static void update_mtu(struct ofproto *, struct ofport *);
322 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
323 static void meter_insert_rule(struct rule *);
326 static void ofproto_unixctl_init(void);
328 /* All registered ofproto classes, in probe order. */
329 static const struct ofproto_class **ofproto_classes;
330 static size_t n_ofproto_classes;
331 static size_t allocated_ofproto_classes;
333 /* Global lock that protects all flow table operations. */
334 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
336 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
337 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
339 size_t n_handlers, n_revalidators;
343 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
344 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
346 /* Initial mappings of port to OpenFlow number mappings. */
347 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
349 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
351 /* The default value of true waits for flow restore. */
352 static bool flow_restore_wait = true;
354 /* Must be called to initialize the ofproto library.
356 * The caller may pass in 'iface_hints', which contains an shash of
357 * "iface_hint" elements indexed by the interface's name. The provider
358 * may use these hints to describe the startup configuration in order to
359 * reinitialize its state. The caller owns the provided data, so a
360 * provider will make copies of anything required. An ofproto provider
361 * will remove any existing state that is not described by the hint, and
362 * may choose to remove it all. */
364 ofproto_init(const struct shash *iface_hints)
366 struct shash_node *node;
369 ofproto_class_register(&ofproto_dpif_class);
371 /* Make a local copy, since we don't own 'iface_hints' elements. */
372 SHASH_FOR_EACH(node, iface_hints) {
373 const struct iface_hint *orig_hint = node->data;
374 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
375 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
377 new_hint->br_name = xstrdup(orig_hint->br_name);
378 new_hint->br_type = xstrdup(br_type);
379 new_hint->ofp_port = orig_hint->ofp_port;
381 shash_add(&init_ofp_ports, node->name, new_hint);
384 for (i = 0; i < n_ofproto_classes; i++) {
385 ofproto_classes[i]->init(&init_ofp_ports);
388 ofproto_unixctl_init();
391 /* 'type' should be a normalized datapath type, as returned by
392 * ofproto_normalize_type(). Returns the corresponding ofproto_class
393 * structure, or a null pointer if there is none registered for 'type'. */
394 static const struct ofproto_class *
395 ofproto_class_find__(const char *type)
399 for (i = 0; i < n_ofproto_classes; i++) {
400 const struct ofproto_class *class = ofproto_classes[i];
405 class->enumerate_types(&types);
406 found = sset_contains(&types, type);
407 sset_destroy(&types);
413 VLOG_WARN("unknown datapath type %s", type);
417 /* Registers a new ofproto class. After successful registration, new ofprotos
418 * of that type can be created using ofproto_create(). */
420 ofproto_class_register(const struct ofproto_class *new_class)
424 for (i = 0; i < n_ofproto_classes; i++) {
425 if (ofproto_classes[i] == new_class) {
430 if (n_ofproto_classes >= allocated_ofproto_classes) {
431 ofproto_classes = x2nrealloc(ofproto_classes,
432 &allocated_ofproto_classes,
433 sizeof *ofproto_classes);
435 ofproto_classes[n_ofproto_classes++] = new_class;
439 /* Unregisters a datapath provider. 'type' must have been previously
440 * registered and not currently be in use by any ofprotos. After
441 * unregistration new datapaths of that type cannot be opened using
442 * ofproto_create(). */
444 ofproto_class_unregister(const struct ofproto_class *class)
448 for (i = 0; i < n_ofproto_classes; i++) {
449 if (ofproto_classes[i] == class) {
450 for (i++; i < n_ofproto_classes; i++) {
451 ofproto_classes[i - 1] = ofproto_classes[i];
457 VLOG_WARN("attempted to unregister an ofproto class that is not "
462 /* Clears 'types' and enumerates all registered ofproto types into it. The
463 * caller must first initialize the sset. */
465 ofproto_enumerate_types(struct sset *types)
470 for (i = 0; i < n_ofproto_classes; i++) {
471 ofproto_classes[i]->enumerate_types(types);
475 /* Returns the fully spelled out name for the given ofproto 'type'.
477 * Normalized type string can be compared with strcmp(). Unnormalized type
478 * string might be the same even if they have different spellings. */
480 ofproto_normalize_type(const char *type)
482 return type && type[0] ? type : "system";
485 /* Clears 'names' and enumerates the names of all known created ofprotos with
486 * the given 'type'. The caller must first initialize the sset. Returns 0 if
487 * successful, otherwise a positive errno value.
489 * Some kinds of datapaths might not be practically enumerable. This is not
490 * considered an error. */
492 ofproto_enumerate_names(const char *type, struct sset *names)
494 const struct ofproto_class *class = ofproto_class_find__(type);
495 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
499 ofproto_bump_tables_version(struct ofproto *ofproto)
501 ++ofproto->tables_version;
502 ofproto->ofproto_class->set_tables_version(ofproto,
503 ofproto->tables_version);
507 ofproto_create(const char *datapath_name, const char *datapath_type,
508 struct ofproto **ofprotop)
510 const struct ofproto_class *class;
511 struct ofproto *ofproto;
517 datapath_type = ofproto_normalize_type(datapath_type);
518 class = ofproto_class_find__(datapath_type);
520 VLOG_WARN("could not create datapath %s of unknown type %s",
521 datapath_name, datapath_type);
525 ofproto = class->alloc();
527 VLOG_ERR("failed to allocate datapath %s of type %s",
528 datapath_name, datapath_type);
533 ovs_mutex_lock(&ofproto_mutex);
534 memset(ofproto, 0, sizeof *ofproto);
535 ofproto->ofproto_class = class;
536 ofproto->name = xstrdup(datapath_name);
537 ofproto->type = xstrdup(datapath_type);
538 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
539 hash_string(ofproto->name, 0));
540 ofproto->datapath_id = 0;
541 ofproto->forward_bpdu = false;
542 ofproto->fallback_dpid = pick_fallback_dpid();
543 ofproto->mfr_desc = NULL;
544 ofproto->hw_desc = NULL;
545 ofproto->sw_desc = NULL;
546 ofproto->serial_desc = NULL;
547 ofproto->dp_desc = NULL;
548 ofproto->frag_handling = OFPC_FRAG_NORMAL;
549 hmap_init(&ofproto->ports);
550 hmap_init(&ofproto->ofport_usage);
551 shash_init(&ofproto->port_by_name);
552 simap_init(&ofproto->ofp_requests);
553 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
554 ofproto->eviction_group_timer = LLONG_MIN;
555 ofproto->tables = NULL;
556 ofproto->n_tables = 0;
557 ofproto->tables_version = CLS_MIN_VERSION;
558 hindex_init(&ofproto->cookies);
559 hmap_init(&ofproto->learned_cookies);
560 list_init(&ofproto->expirable);
561 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
562 guarded_list_init(&ofproto->rule_executes);
563 ofproto->vlan_bitmap = NULL;
564 ofproto->vlans_changed = false;
565 ofproto->min_mtu = INT_MAX;
566 ovs_rwlock_init(&ofproto->groups_rwlock);
567 hmap_init(&ofproto->groups);
568 ovs_mutex_unlock(&ofproto_mutex);
569 ofproto->ogf.types = 0xf;
570 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
571 OFPGFC_SELECT_WEIGHT;
572 for (i = 0; i < 4; i++) {
573 ofproto->ogf.max_groups[i] = OFPG_MAX;
574 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
578 error = ofproto->ofproto_class->construct(ofproto);
580 VLOG_ERR("failed to open datapath %s: %s",
581 datapath_name, ovs_strerror(error));
582 connmgr_destroy(ofproto->connmgr);
583 ofproto_destroy__(ofproto);
587 /* Check that hidden tables, if any, are at the end. */
588 ovs_assert(ofproto->n_tables);
589 for (i = 0; i + 1 < ofproto->n_tables; i++) {
590 enum oftable_flags flags = ofproto->tables[i].flags;
591 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
593 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
596 ofproto->datapath_id = pick_datapath_id(ofproto);
599 /* Initialize meters table. */
600 if (ofproto->ofproto_class->meter_get_features) {
601 ofproto->ofproto_class->meter_get_features(ofproto,
602 &ofproto->meter_features);
604 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
606 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
607 * sizeof(struct meter *));
609 /* Set the initial tables version. */
610 ofproto_bump_tables_version(ofproto);
616 /* Must be called (only) by an ofproto implementation in its constructor
617 * function. See the large comment on 'construct' in struct ofproto_class for
620 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
622 struct oftable *table;
624 ovs_assert(!ofproto->n_tables);
625 ovs_assert(n_tables >= 1 && n_tables <= 255);
627 ofproto->n_tables = n_tables;
628 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
629 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
634 /* To be optionally called (only) by an ofproto implementation in its
635 * constructor function. See the large comment on 'construct' in struct
636 * ofproto_class for details.
638 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
639 * will then ensure that actions passed into the ofproto implementation will
640 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
641 * function is not called, there will be no such restriction.
643 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
644 * the 'max_ports' restriction. */
646 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
648 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
649 ofproto->max_ports = max_ports;
653 ofproto_get_datapath_id(const struct ofproto *ofproto)
655 return ofproto->datapath_id;
659 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
661 uint64_t old_dpid = p->datapath_id;
662 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
663 if (p->datapath_id != old_dpid) {
664 /* Force all active connections to reconnect, since there is no way to
665 * notify a controller that the datapath ID has changed. */
666 ofproto_reconnect_controllers(p);
671 ofproto_set_controllers(struct ofproto *p,
672 const struct ofproto_controller *controllers,
673 size_t n_controllers, uint32_t allowed_versions)
675 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
680 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
682 connmgr_set_fail_mode(p->connmgr, fail_mode);
685 /* Drops the connections between 'ofproto' and all of its controllers, forcing
686 * them to reconnect. */
688 ofproto_reconnect_controllers(struct ofproto *ofproto)
690 connmgr_reconnect(ofproto->connmgr);
693 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
694 * in-band control should guarantee access, in the same way that in-band
695 * control guarantees access to OpenFlow controllers. */
697 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
698 const struct sockaddr_in *extras, size_t n)
700 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
703 /* Sets the OpenFlow queue used by flows set up by in-band control on
704 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
705 * flows will use the default queue. */
707 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
709 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
712 /* Sets the number of flows at which eviction from the kernel flow table
715 ofproto_set_flow_limit(unsigned limit)
717 ofproto_flow_limit = limit;
720 /* Sets the maximum idle time for flows in the datapath before they are
723 ofproto_set_max_idle(unsigned max_idle)
725 ofproto_max_idle = max_idle;
728 /* If forward_bpdu is true, the NORMAL action will forward frames with
729 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
730 * the NORMAL action will drop these frames. */
732 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
734 bool old_val = ofproto->forward_bpdu;
735 ofproto->forward_bpdu = forward_bpdu;
736 if (old_val != ofproto->forward_bpdu) {
737 if (ofproto->ofproto_class->forward_bpdu_changed) {
738 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
743 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
744 * 'idle_time', in seconds, and the maximum number of MAC table entries to
747 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
750 if (ofproto->ofproto_class->set_mac_table_config) {
751 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
756 /* Multicast snooping configuration. */
758 /* Configures multicast snooping on 'ofproto' using the settings
759 * defined in 's'. If 's' is NULL, disables multicast snooping.
761 * Returns 0 if successful, otherwise a positive errno value. */
763 ofproto_set_mcast_snooping(struct ofproto *ofproto,
764 const struct ofproto_mcast_snooping_settings *s)
766 return (ofproto->ofproto_class->set_mcast_snooping
767 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
771 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
773 * Returns 0 if successful, otherwise a positive errno value.*/
775 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
776 const struct ofproto_mcast_snooping_port_settings *s)
778 return (ofproto->ofproto_class->set_mcast_snooping_port
779 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
784 ofproto_set_n_dpdk_rxqs(int n_rxqs)
786 n_dpdk_rxqs = MAX(n_rxqs, 0);
790 ofproto_set_cpu_mask(const char *cmask)
794 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
798 ofproto_set_threads(int n_handlers_, int n_revalidators_)
800 int threads = MAX(count_cpu_cores(), 2);
802 n_revalidators = MAX(n_revalidators_, 0);
803 n_handlers = MAX(n_handlers_, 0);
805 if (!n_revalidators) {
806 n_revalidators = n_handlers
807 ? MAX(threads - (int) n_handlers, 1)
812 n_handlers = MAX(threads - (int) n_revalidators, 1);
817 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
820 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
824 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
826 return connmgr_set_snoops(ofproto->connmgr, snoops);
830 ofproto_set_netflow(struct ofproto *ofproto,
831 const struct netflow_options *nf_options)
833 if (nf_options && sset_is_empty(&nf_options->collectors)) {
837 if (ofproto->ofproto_class->set_netflow) {
838 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
840 return nf_options ? EOPNOTSUPP : 0;
845 ofproto_set_sflow(struct ofproto *ofproto,
846 const struct ofproto_sflow_options *oso)
848 if (oso && sset_is_empty(&oso->targets)) {
852 if (ofproto->ofproto_class->set_sflow) {
853 return ofproto->ofproto_class->set_sflow(ofproto, oso);
855 return oso ? EOPNOTSUPP : 0;
860 ofproto_set_ipfix(struct ofproto *ofproto,
861 const struct ofproto_ipfix_bridge_exporter_options *bo,
862 const struct ofproto_ipfix_flow_exporter_options *fo,
865 if (ofproto->ofproto_class->set_ipfix) {
866 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
868 return (bo || fo) ? EOPNOTSUPP : 0;
873 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
875 flow_restore_wait = flow_restore_wait_db;
879 ofproto_get_flow_restore_wait(void)
881 return flow_restore_wait;
885 /* Spanning Tree Protocol (STP) configuration. */
887 /* Configures STP on 'ofproto' using the settings defined in 's'. If
888 * 's' is NULL, disables STP.
890 * Returns 0 if successful, otherwise a positive errno value. */
892 ofproto_set_stp(struct ofproto *ofproto,
893 const struct ofproto_stp_settings *s)
895 return (ofproto->ofproto_class->set_stp
896 ? ofproto->ofproto_class->set_stp(ofproto, s)
900 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
901 * 'enabled' member of 's' is false, then the other members are not
904 * Returns 0 if successful, otherwise a positive errno value. */
906 ofproto_get_stp_status(struct ofproto *ofproto,
907 struct ofproto_stp_status *s)
909 return (ofproto->ofproto_class->get_stp_status
910 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
914 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
915 * in 's'. The caller is responsible for assigning STP port numbers
916 * (using the 'port_num' member in the range of 1 through 255, inclusive)
917 * and ensuring there are no duplicates. If the 's' is NULL, then STP
918 * is disabled on the port.
920 * Returns 0 if successful, otherwise a positive errno value.*/
922 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
923 const struct ofproto_port_stp_settings *s)
925 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
927 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
928 ofproto->name, ofp_port);
932 return (ofproto->ofproto_class->set_stp_port
933 ? ofproto->ofproto_class->set_stp_port(ofport, s)
937 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
938 * 's'. If the 'enabled' member in 's' is false, then the other members
939 * are not meaningful.
941 * Returns 0 if successful, otherwise a positive errno value.*/
943 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
944 struct ofproto_port_stp_status *s)
946 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
948 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
949 "port %"PRIu16, ofproto->name, ofp_port);
953 return (ofproto->ofproto_class->get_stp_port_status
954 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
958 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
959 * 's'. If the 'enabled' member in 's' is false, then the other members
960 * are not meaningful.
962 * Returns 0 if successful, otherwise a positive errno value.*/
964 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
965 struct ofproto_port_stp_stats *s)
967 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
969 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
970 "port %"PRIu16, ofproto->name, ofp_port);
974 return (ofproto->ofproto_class->get_stp_port_stats
975 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
979 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
981 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
982 * 's' is NULL, disables RSTP.
984 * Returns 0 if successful, otherwise a positive errno value. */
986 ofproto_set_rstp(struct ofproto *ofproto,
987 const struct ofproto_rstp_settings *s)
989 if (!ofproto->ofproto_class->set_rstp) {
992 ofproto->ofproto_class->set_rstp(ofproto, s);
996 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
997 * 'enabled' member of 's' is false, then the other members are not
1000 * Returns 0 if successful, otherwise a positive errno value. */
1002 ofproto_get_rstp_status(struct ofproto *ofproto,
1003 struct ofproto_rstp_status *s)
1005 if (!ofproto->ofproto_class->get_rstp_status) {
1008 ofproto->ofproto_class->get_rstp_status(ofproto, s);
1012 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1013 * in 's'. The caller is responsible for assigning RSTP port numbers
1014 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1015 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1016 * is disabled on the port.
1018 * Returns 0 if successful, otherwise a positive errno value.*/
1020 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
1021 const struct ofproto_port_rstp_settings *s)
1023 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1025 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
1026 ofproto->name, ofp_port);
1030 if (!ofproto->ofproto_class->set_rstp_port) {
1033 ofproto->ofproto_class->set_rstp_port(ofport, s);
1037 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1038 * 's'. If the 'enabled' member in 's' is false, then the other members
1039 * are not meaningful.
1041 * Returns 0 if successful, otherwise a positive errno value.*/
1043 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1044 struct ofproto_port_rstp_status *s)
1046 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1048 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1049 "port %"PRIu16, ofproto->name, ofp_port);
1053 if (!ofproto->ofproto_class->get_rstp_port_status) {
1056 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1060 /* Queue DSCP configuration. */
1062 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1063 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1064 * to implement QoS. Instead, it is used to implement features which require
1065 * knowledge of what queues exist on a port, and some basic information about
1068 * Returns 0 if successful, otherwise a positive errno value. */
1070 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1071 const struct ofproto_port_queue *queues,
1074 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1077 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1078 ofproto->name, ofp_port);
1082 return (ofproto->ofproto_class->set_queues
1083 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1087 /* LLDP configuration. */
1089 ofproto_port_set_lldp(struct ofproto *ofproto,
1090 ofp_port_t ofp_port,
1091 const struct smap *cfg)
1093 struct ofport *ofport;
1096 ofport = ofproto_get_port(ofproto, ofp_port);
1098 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1099 ofproto->name, ofp_port);
1102 error = (ofproto->ofproto_class->set_lldp
1103 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1106 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1107 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1108 ovs_strerror(error));
1113 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1114 const struct aa_settings *s)
1116 if (!ofproto->ofproto_class->set_aa) {
1119 ofproto->ofproto_class->set_aa(ofproto, s);
1124 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1125 const struct aa_mapping_settings *s)
1127 if (!ofproto->ofproto_class->aa_mapping_set) {
1130 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1135 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1137 if (!ofproto->ofproto_class->aa_mapping_unset) {
1140 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1145 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1146 struct ovs_list *list)
1148 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1151 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1156 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1158 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1161 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1164 /* Connectivity Fault Management configuration. */
1166 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1168 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1170 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1171 if (ofport && ofproto->ofproto_class->set_cfm) {
1172 ofproto->ofproto_class->set_cfm(ofport, NULL);
1176 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1177 * basic configuration from the configuration members in 'cfm', and the remote
1178 * maintenance point ID from remote_mpid. Ignores the statistics members of
1181 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1183 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1184 const struct cfm_settings *s)
1186 struct ofport *ofport;
1189 ofport = ofproto_get_port(ofproto, ofp_port);
1191 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1192 ofproto->name, ofp_port);
1196 /* XXX: For configuration simplicity, we only support one remote_mpid
1197 * outside of the CFM module. It's not clear if this is the correct long
1198 * term solution or not. */
1199 error = (ofproto->ofproto_class->set_cfm
1200 ? ofproto->ofproto_class->set_cfm(ofport, s)
1203 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1204 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1205 ovs_strerror(error));
1209 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1210 * 'ofproto' does not have a port 'ofp_port'. */
1212 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1213 const struct smap *cfg)
1215 struct ofport *ofport;
1218 ofport = ofproto_get_port(ofproto, ofp_port);
1220 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1221 ofproto->name, ofp_port);
1225 error = (ofproto->ofproto_class->set_bfd
1226 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1229 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1230 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1231 ovs_strerror(error));
1235 /* Checks the status change of BFD on 'ofport'.
1237 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1239 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1241 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1242 return (ofport && ofproto->ofproto_class->bfd_status_changed
1243 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1247 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1248 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1249 * is not an OpenFlow port in 'ofproto'.
1251 * The caller must provide and own '*status'. */
1253 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1254 struct smap *status)
1256 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1257 return (ofport && ofproto->ofproto_class->get_bfd_status
1258 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1262 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1263 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1264 * 0 if LACP partner information is not current (generally indicating a
1265 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1267 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1269 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1270 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1271 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1276 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1278 struct ofproto *ofproto = port->ofproto;
1281 if (ofproto->ofproto_class->port_get_lacp_stats) {
1282 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1292 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1293 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1294 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1295 * configuration plus, if there is more than one slave, a bonding
1298 * If 'aux' is already registered then this function updates its configuration
1299 * to 's'. Otherwise, this function registers a new bundle.
1301 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1304 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1305 const struct ofproto_bundle_settings *s)
1307 return (ofproto->ofproto_class->bundle_set
1308 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1312 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1313 * If no such bundle has been registered, this has no effect. */
1315 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1317 return ofproto_bundle_register(ofproto, aux, NULL);
1321 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1322 * If 'aux' is already registered then this function updates its configuration
1323 * to 's'. Otherwise, this function registers a new mirror. */
1325 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1326 const struct ofproto_mirror_settings *s)
1328 return (ofproto->ofproto_class->mirror_set
1329 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1333 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1334 * If no mirror has been registered, this has no effect. */
1336 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1338 return ofproto_mirror_register(ofproto, aux, NULL);
1341 /* Retrieves statistics from mirror associated with client data pointer
1342 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1343 * 'bytes', respectively. If a particular counters is not supported,
1344 * the appropriate argument is set to UINT64_MAX.
1347 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1348 uint64_t *packets, uint64_t *bytes)
1350 if (!ofproto->ofproto_class->mirror_get_stats) {
1351 *packets = *bytes = UINT64_MAX;
1355 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1359 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1360 * which all packets are flooded, instead of using MAC learning. If
1361 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1363 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1366 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1368 return (ofproto->ofproto_class->set_flood_vlans
1369 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1373 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1374 * output for a mirror. */
1376 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1378 return (ofproto->ofproto_class->is_mirror_output_bundle
1379 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1383 /* Configuration of OpenFlow tables. */
1385 /* Returns the number of OpenFlow tables in 'ofproto'. */
1387 ofproto_get_n_tables(const struct ofproto *ofproto)
1389 return ofproto->n_tables;
1392 /* Returns the number of Controller visible OpenFlow tables
1393 * in 'ofproto'. This number will exclude Hidden tables.
1394 * This funtion's return value should be less or equal to that of
1395 * ofproto_get_n_tables() . */
1397 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1399 uint8_t n = ofproto->n_tables;
1401 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1402 * if present, are always at the end.) */
1403 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1410 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1411 * settings from 's'. 'table_id' must be in the range 0 through the number of
1412 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1414 * For read-only tables, only the name may be configured. */
1416 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1417 const struct ofproto_table_settings *s)
1419 struct oftable *table;
1421 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1422 table = &ofproto->tables[table_id];
1424 oftable_set_name(table, s->name);
1426 if (table->flags & OFTABLE_READONLY) {
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 unsigned int new_eviction = (s->enable_eviction
1437 ? table->eviction | EVICTION_CLIENT
1438 : table->eviction & ~EVICTION_CLIENT);
1439 oftable_configure_eviction(table, new_eviction, s->groups, s->n_groups);
1440 table->max_flows = s->max_flows;
1441 evict_rules_from_table(table);
1442 ovs_mutex_unlock(&ofproto_mutex);
1446 ofproto_has_snoops(const struct ofproto *ofproto)
1448 return connmgr_has_snoops(ofproto->connmgr);
1452 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1454 connmgr_get_snoops(ofproto->connmgr, snoops);
1457 /* Deletes 'rule' from 'ofproto'.
1459 * Within an ofproto implementation, this function allows an ofproto
1460 * implementation to destroy any rules that remain when its ->destruct()
1461 * function is called. This function is not suitable for use elsewhere in an
1462 * ofproto implementation.
1464 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1465 * Cycle" in ofproto-provider.h. */
1467 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1468 OVS_EXCLUDED(ofproto_mutex)
1470 /* This skips the ofmonitor and flow-removed notifications because the
1471 * switch is being deleted and any OpenFlow channels have been or soon will
1473 ovs_mutex_lock(&ofproto_mutex);
1475 if (!rule->removed) {
1476 /* Make sure there is no postponed removal of the rule. */
1477 ovs_assert(cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
1479 if (!classifier_remove(&rule->ofproto->tables[rule->table_id].cls,
1483 ofproto_rule_remove__(rule->ofproto, rule);
1484 ofproto->ofproto_class->rule_delete(rule);
1485 ofproto_rule_unref(rule);
1487 ovs_mutex_unlock(&ofproto_mutex);
1491 ofproto_flush__(struct ofproto *ofproto)
1492 OVS_EXCLUDED(ofproto_mutex)
1494 struct oftable *table;
1496 /* This will flush all datapath flows. */
1497 if (ofproto->ofproto_class->flush) {
1498 ofproto->ofproto_class->flush(ofproto);
1501 /* XXX: There is a small race window here, where new datapath flows can be
1502 * created by upcall handlers based on the existing flow table. We can not
1503 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1504 * as then we could deadlock on syncing with the handler threads waiting on
1505 * the same mutex. */
1507 ovs_mutex_lock(&ofproto_mutex);
1508 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1509 struct rule_collection rules;
1512 if (table->flags & OFTABLE_HIDDEN) {
1516 rule_collection_init(&rules);
1518 CLS_FOR_EACH (rule, cr, &table->cls) {
1519 rule_collection_add(&rules, rule);
1521 delete_flows__(&rules, OFPRR_DELETE, NULL);
1523 /* XXX: Concurrent handler threads may insert new learned flows based on
1524 * learn actions of the now deleted flows right after we release
1525 * 'ofproto_mutex'. */
1526 ovs_mutex_unlock(&ofproto_mutex);
1529 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1532 ofproto_destroy__(struct ofproto *ofproto)
1533 OVS_EXCLUDED(ofproto_mutex)
1535 struct oftable *table;
1537 destroy_rule_executes(ofproto);
1539 guarded_list_destroy(&ofproto->rule_executes);
1540 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1541 hmap_destroy(&ofproto->groups);
1543 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1544 free(ofproto->name);
1545 free(ofproto->type);
1546 free(ofproto->mfr_desc);
1547 free(ofproto->hw_desc);
1548 free(ofproto->sw_desc);
1549 free(ofproto->serial_desc);
1550 free(ofproto->dp_desc);
1551 hmap_destroy(&ofproto->ports);
1552 hmap_destroy(&ofproto->ofport_usage);
1553 shash_destroy(&ofproto->port_by_name);
1554 simap_destroy(&ofproto->ofp_requests);
1556 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1557 oftable_destroy(table);
1559 free(ofproto->tables);
1561 ovs_assert(hindex_is_empty(&ofproto->cookies));
1562 hindex_destroy(&ofproto->cookies);
1564 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1565 hmap_destroy(&ofproto->learned_cookies);
1567 free(ofproto->vlan_bitmap);
1569 ofproto->ofproto_class->dealloc(ofproto);
1572 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1573 * - 1st we defer the removal of the rules from the classifier
1574 * - 2nd we defer the actual destruction of the rules. */
1576 ofproto_destroy_defer__(struct ofproto *ofproto)
1577 OVS_EXCLUDED(ofproto_mutex)
1579 ovsrcu_postpone(ofproto_destroy__, ofproto);
1583 ofproto_destroy(struct ofproto *p)
1584 OVS_EXCLUDED(ofproto_mutex)
1586 struct ofport *ofport, *next_ofport;
1587 struct ofport_usage *usage, *next_usage;
1594 meter_delete(p, 1, p->meter_features.max_meters);
1595 p->meter_features.max_meters = 0;
1601 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1602 ofport_destroy(ofport);
1605 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1606 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1610 p->ofproto_class->destruct(p);
1612 /* We should not postpone this because it involves deleting a listening
1613 * socket which we may want to reopen soon. 'connmgr' should not be used
1614 * by other threads */
1615 connmgr_destroy(p->connmgr);
1617 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1618 ovsrcu_postpone(ofproto_destroy_defer__, p);
1621 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1622 * kernel datapath, for example, this destroys the datapath in the kernel, and
1623 * with the netdev-based datapath, it tears down the data structures that
1624 * represent the datapath.
1626 * The datapath should not be currently open as an ofproto. */
1628 ofproto_delete(const char *name, const char *type)
1630 const struct ofproto_class *class = ofproto_class_find__(type);
1631 return (!class ? EAFNOSUPPORT
1632 : !class->del ? EACCES
1633 : class->del(type, name));
1637 process_port_change(struct ofproto *ofproto, int error, char *devname)
1639 if (error == ENOBUFS) {
1640 reinit_ports(ofproto);
1641 } else if (!error) {
1642 update_port(ofproto, devname);
1648 ofproto_type_run(const char *datapath_type)
1650 const struct ofproto_class *class;
1653 datapath_type = ofproto_normalize_type(datapath_type);
1654 class = ofproto_class_find__(datapath_type);
1656 error = class->type_run ? class->type_run(datapath_type) : 0;
1657 if (error && error != EAGAIN) {
1658 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1659 datapath_type, ovs_strerror(error));
1665 ofproto_type_wait(const char *datapath_type)
1667 const struct ofproto_class *class;
1669 datapath_type = ofproto_normalize_type(datapath_type);
1670 class = ofproto_class_find__(datapath_type);
1672 if (class->type_wait) {
1673 class->type_wait(datapath_type);
1678 ofproto_run(struct ofproto *p)
1683 error = p->ofproto_class->run(p);
1684 if (error && error != EAGAIN) {
1685 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1688 run_rule_executes(p);
1690 /* Restore the eviction group heap invariant occasionally. */
1691 if (p->eviction_group_timer < time_msec()) {
1694 p->eviction_group_timer = time_msec() + 1000;
1696 for (i = 0; i < p->n_tables; i++) {
1697 struct oftable *table = &p->tables[i];
1698 struct eviction_group *evg;
1701 if (!table->eviction) {
1705 if (table->n_flows > 100000) {
1706 static struct vlog_rate_limit count_rl =
1707 VLOG_RATE_LIMIT_INIT(1, 1);
1708 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1709 " number of rules: %d", i, table->n_flows);
1712 ovs_mutex_lock(&ofproto_mutex);
1713 CLS_FOR_EACH (rule, cr, &table->cls) {
1714 if (rule->idle_timeout || rule->hard_timeout) {
1715 if (!rule->eviction_group) {
1716 eviction_group_add_rule(rule);
1718 heap_raw_change(&rule->evg_node,
1719 rule_eviction_priority(p, rule));
1724 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1725 heap_rebuild(&evg->rules);
1727 ovs_mutex_unlock(&ofproto_mutex);
1731 if (p->ofproto_class->port_poll) {
1734 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1735 process_port_change(p, error, devname);
1739 new_seq = seq_read(connectivity_seq_get());
1740 if (new_seq != p->change_seq) {
1741 struct sset devnames;
1742 const char *devname;
1743 struct ofport *ofport;
1745 /* Update OpenFlow port status for any port whose netdev has changed.
1747 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1748 * destroyed, so it's not safe to update ports directly from the
1749 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1750 * need this two-phase approach. */
1751 sset_init(&devnames);
1752 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1753 uint64_t port_change_seq;
1755 port_change_seq = netdev_get_change_seq(ofport->netdev);
1756 if (ofport->change_seq != port_change_seq) {
1757 ofport->change_seq = port_change_seq;
1758 sset_add(&devnames, netdev_get_name(ofport->netdev));
1761 SSET_FOR_EACH (devname, &devnames) {
1762 update_port(p, devname);
1764 sset_destroy(&devnames);
1766 p->change_seq = new_seq;
1769 connmgr_run(p->connmgr, handle_openflow);
1775 ofproto_wait(struct ofproto *p)
1777 p->ofproto_class->wait(p);
1778 if (p->ofproto_class->port_poll_wait) {
1779 p->ofproto_class->port_poll_wait(p);
1781 seq_wait(connectivity_seq_get(), p->change_seq);
1782 connmgr_wait(p->connmgr);
1786 ofproto_is_alive(const struct ofproto *p)
1788 return connmgr_has_controllers(p->connmgr);
1791 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1792 * memory_report(). */
1794 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1796 const struct oftable *table;
1797 unsigned int n_rules;
1799 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1802 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1803 n_rules += table->n_flows;
1805 simap_increase(usage, "rules", n_rules);
1807 if (ofproto->ofproto_class->get_memory_usage) {
1808 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1811 connmgr_get_memory_usage(ofproto->connmgr, usage);
1815 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1817 const struct ofproto_class *class;
1819 datapath_type = ofproto_normalize_type(datapath_type);
1820 class = ofproto_class_find__(datapath_type);
1822 if (class && class->type_get_memory_usage) {
1823 class->type_get_memory_usage(datapath_type, usage);
1828 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1831 connmgr_get_controller_info(ofproto->connmgr, info);
1835 ofproto_free_ofproto_controller_info(struct shash *info)
1837 connmgr_free_controller_info(info);
1840 /* Makes a deep copy of 'old' into 'port'. */
1842 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1844 port->name = xstrdup(old->name);
1845 port->type = xstrdup(old->type);
1846 port->ofp_port = old->ofp_port;
1849 /* Frees memory allocated to members of 'ofproto_port'.
1851 * Do not call this function on an ofproto_port obtained from
1852 * ofproto_port_dump_next(): that function retains ownership of the data in the
1855 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1857 free(ofproto_port->name);
1858 free(ofproto_port->type);
1861 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1863 * This function provides no status indication. An error status for the entire
1864 * dump operation is provided when it is completed by calling
1865 * ofproto_port_dump_done().
1868 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1869 const struct ofproto *ofproto)
1871 dump->ofproto = ofproto;
1872 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1876 /* Attempts to retrieve another port from 'dump', which must have been created
1877 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1878 * 'port' and returns true. On failure, returns false.
1880 * Failure might indicate an actual error or merely that the last port has been
1881 * dumped. An error status for the entire dump operation is provided when it
1882 * is completed by calling ofproto_port_dump_done().
1884 * The ofproto owns the data stored in 'port'. It will remain valid until at
1885 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1886 * ofproto_port_dump_done(). */
1888 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1889 struct ofproto_port *port)
1891 const struct ofproto *ofproto = dump->ofproto;
1897 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1900 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1906 /* Completes port table dump operation 'dump', which must have been created
1907 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1908 * error-free, otherwise a positive errno value describing the problem. */
1910 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1912 const struct ofproto *ofproto = dump->ofproto;
1914 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1917 return dump->error == EOF ? 0 : dump->error;
1920 /* Returns the type to pass to netdev_open() when a datapath of type
1921 * 'datapath_type' has a port of type 'port_type', for a few special
1922 * cases when a netdev type differs from a port type. For example, when
1923 * using the userspace datapath, a port of type "internal" needs to be
1926 * Returns either 'type' itself or a string literal, which must not be
1929 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1931 const struct ofproto_class *class;
1933 datapath_type = ofproto_normalize_type(datapath_type);
1934 class = ofproto_class_find__(datapath_type);
1939 return (class->port_open_type
1940 ? class->port_open_type(datapath_type, port_type)
1944 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1945 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1946 * the port's OpenFlow port number.
1948 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1949 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1950 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1951 * 'ofp_portp' is non-null). */
1953 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1954 ofp_port_t *ofp_portp)
1956 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1959 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1961 const char *netdev_name = netdev_get_name(netdev);
1963 simap_put(&ofproto->ofp_requests, netdev_name,
1964 ofp_to_u16(ofp_port));
1965 error = update_port(ofproto, netdev_name);
1968 *ofp_portp = OFPP_NONE;
1970 struct ofproto_port ofproto_port;
1972 error = ofproto_port_query_by_name(ofproto,
1973 netdev_get_name(netdev),
1976 *ofp_portp = ofproto_port.ofp_port;
1977 ofproto_port_destroy(&ofproto_port);
1984 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1985 * initializes '*port' appropriately; on failure, returns a positive errno
1988 * The caller owns the data in 'ofproto_port' and must free it with
1989 * ofproto_port_destroy() when it is no longer needed. */
1991 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1992 struct ofproto_port *port)
1996 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1998 memset(port, 0, sizeof *port);
2003 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
2004 * Returns 0 if successful, otherwise a positive errno. */
2006 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
2008 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2009 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
2010 struct simap_node *ofp_request_node;
2013 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
2014 if (ofp_request_node) {
2015 simap_delete(&ofproto->ofp_requests, ofp_request_node);
2018 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
2019 if (!error && ofport) {
2020 /* 'name' is the netdev's name and update_port() is going to close the
2021 * netdev. Just in case update_port() refers to 'name' after it
2022 * destroys 'ofport', make a copy of it around the update_port()
2024 char *devname = xstrdup(name);
2025 update_port(ofproto, devname);
2032 flow_mod_init(struct ofputil_flow_mod *fm,
2033 const struct match *match, int priority,
2034 const struct ofpact *ofpacts, size_t ofpacts_len,
2035 enum ofp_flow_mod_command command)
2037 memset(fm, 0, sizeof *fm);
2039 fm->priority = priority;
2042 fm->modify_cookie = false;
2044 fm->command = command;
2045 fm->idle_timeout = 0;
2046 fm->hard_timeout = 0;
2048 fm->buffer_id = UINT32_MAX;
2049 fm->out_port = OFPP_ANY;
2050 fm->out_group = OFPG_ANY;
2052 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2053 fm->ofpacts_len = ofpacts_len;
2054 fm->delete_reason = OFPRR_DELETE;
2058 simple_flow_mod(struct ofproto *ofproto,
2059 const struct match *match, int priority,
2060 const struct ofpact *ofpacts, size_t ofpacts_len,
2061 enum ofp_flow_mod_command command)
2063 struct ofproto_flow_mod ofm;
2065 flow_mod_init(&ofm.fm, match, priority, ofpacts, ofpacts_len, command);
2067 return handle_flow_mod__(ofproto, &ofm, NULL);
2070 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2071 * performs the 'n_actions' actions in 'actions'. The new flow will not
2074 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2075 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2076 * controllers; otherwise, it will be hidden.
2078 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2080 * This is a helper function for in-band control and fail-open. */
2082 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2084 const struct ofpact *ofpacts, size_t ofpacts_len)
2085 OVS_EXCLUDED(ofproto_mutex)
2087 const struct rule *rule;
2090 /* First do a cheap check whether the rule we're looking for already exists
2091 * with the actions that we want. If it does, then we're done. */
2092 rule = rule_from_cls_rule(classifier_find_match_exactly(
2093 &ofproto->tables[0].cls, match, priority,
2096 const struct rule_actions *actions = rule_get_actions(rule);
2097 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2098 ofpacts, ofpacts_len);
2103 /* If there's no such rule or the rule doesn't have the actions we want,
2104 * fall back to a executing a full flow mod. We can't optimize this at
2105 * all because we didn't take enough locks above to ensure that the flow
2106 * table didn't already change beneath us. */
2108 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2109 OFPFC_MODIFY_STRICT);
2113 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2114 * an OFPERR_* OpenFlow error code on failure.
2116 * This is a helper function for in-band control and fail-open and the "learn"
2119 ofproto_flow_mod(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
2120 OVS_EXCLUDED(ofproto_mutex)
2122 struct ofputil_flow_mod *fm = &ofm->fm;
2124 /* Optimize for the most common case of a repeated learn action.
2125 * If an identical flow already exists we only need to update its
2126 * 'modified' time. */
2127 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2128 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2129 struct oftable *table = &ofproto->tables[fm->table_id];
2133 rule = rule_from_cls_rule(classifier_find_match_exactly(
2134 &table->cls, &fm->match, fm->priority,
2137 /* Reading many of the rule fields and writing on 'modified'
2138 * requires the rule->mutex. Also, rule->actions may change
2139 * if rule->mutex is not held. */
2140 const struct rule_actions *actions;
2142 ovs_mutex_lock(&rule->mutex);
2143 actions = rule_get_actions(rule);
2144 if (rule->idle_timeout == fm->idle_timeout
2145 && rule->hard_timeout == fm->hard_timeout
2146 && rule->importance == fm->importance
2147 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2148 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2149 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2150 actions->ofpacts, actions->ofpacts_len)) {
2151 /* Rule already exists and need not change, only update the
2152 modified timestamp. */
2153 rule->modified = time_msec();
2156 ovs_mutex_unlock(&rule->mutex);
2164 return handle_flow_mod__(ofproto, ofm, NULL);
2167 /* Searches for a rule with matching criteria exactly equal to 'target' in
2168 * ofproto's table 0 and, if it finds one, deletes it.
2170 * This is a helper function for in-band control and fail-open. */
2172 ofproto_delete_flow(struct ofproto *ofproto,
2173 const struct match *target, int priority)
2174 OVS_EXCLUDED(ofproto_mutex)
2176 struct classifier *cls = &ofproto->tables[0].cls;
2179 /* First do a cheap check whether the rule we're looking for has already
2180 * been deleted. If so, then we're done. */
2181 rule = rule_from_cls_rule(classifier_find_match_exactly(
2182 cls, target, priority, CLS_MAX_VERSION));
2187 /* Execute a flow mod. We can't optimize this at all because we didn't
2188 * take enough locks above to ensure that the flow table didn't already
2189 * change beneath us. */
2190 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2193 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2194 * the flows required by in-band control and fail-open. */
2196 ofproto_flush_flows(struct ofproto *ofproto)
2198 COVERAGE_INC(ofproto_flush);
2199 ofproto_flush__(ofproto);
2200 connmgr_flushed(ofproto->connmgr);
2204 reinit_ports(struct ofproto *p)
2206 struct ofproto_port_dump dump;
2207 struct sset devnames;
2208 struct ofport *ofport;
2209 struct ofproto_port ofproto_port;
2210 const char *devname;
2212 COVERAGE_INC(ofproto_reinit_ports);
2214 sset_init(&devnames);
2215 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2216 sset_add(&devnames, netdev_get_name(ofport->netdev));
2218 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2219 sset_add(&devnames, ofproto_port.name);
2222 SSET_FOR_EACH (devname, &devnames) {
2223 update_port(p, devname);
2225 sset_destroy(&devnames);
2229 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2233 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2234 port_idx = port_idx ? port_idx : UINT16_MAX;
2236 if (port_idx >= ofproto->max_ports
2237 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2238 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2239 long long int last_used_at, lru = LLONG_MAX;
2241 /* Search for a free OpenFlow port number. We try not to
2242 * immediately reuse them to prevent problems due to old
2245 * We limit the automatically assigned port numbers to the lower half
2246 * of the port range, to reserve the upper half for assignment by
2249 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2250 ofproto->alloc_port_no = 1;
2252 last_used_at = ofport_get_usage(ofproto,
2253 u16_to_ofp(ofproto->alloc_port_no));
2254 if (!last_used_at) {
2255 port_idx = ofproto->alloc_port_no;
2257 } else if ( last_used_at < time_msec() - 60*60*1000) {
2258 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2259 * more than an hour ago, consider it usable. */
2260 ofport_remove_usage(ofproto,
2261 u16_to_ofp(ofproto->alloc_port_no));
2262 port_idx = ofproto->alloc_port_no;
2264 } else if (last_used_at < lru) {
2266 lru_ofport = ofproto->alloc_port_no;
2269 if (ofproto->alloc_port_no == end_port_no) {
2271 port_idx = lru_ofport;
2278 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2279 return u16_to_ofp(port_idx);
2283 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2285 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2286 ofport_set_usage(ofproto, ofp_port, time_msec());
2290 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2291 * pointer if the netdev cannot be opened. On success, also fills in
2293 static struct netdev *
2294 ofport_open(struct ofproto *ofproto,
2295 struct ofproto_port *ofproto_port,
2296 struct ofputil_phy_port *pp)
2298 enum netdev_flags flags;
2299 struct netdev *netdev;
2302 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2304 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2305 "cannot be opened (%s)",
2307 ofproto_port->name, ofproto_port->ofp_port,
2308 ofproto_port->name, ovs_strerror(error));
2312 if (ofproto_port->ofp_port == OFPP_NONE) {
2313 if (!strcmp(ofproto->name, ofproto_port->name)) {
2314 ofproto_port->ofp_port = OFPP_LOCAL;
2316 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2317 ofproto_port->name);
2320 pp->port_no = ofproto_port->ofp_port;
2321 netdev_get_etheraddr(netdev, &pp->hw_addr);
2322 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2323 netdev_get_flags(netdev, &flags);
2324 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2325 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2326 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2327 &pp->supported, &pp->peer);
2328 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2329 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2334 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2335 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2338 ofport_equal(const struct ofputil_phy_port *a,
2339 const struct ofputil_phy_port *b)
2341 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2342 && a->state == b->state
2343 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2344 && a->curr == b->curr
2345 && a->advertised == b->advertised
2346 && a->supported == b->supported
2347 && a->peer == b->peer
2348 && a->curr_speed == b->curr_speed
2349 && a->max_speed == b->max_speed);
2352 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2353 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2354 * one with the same name or port number). */
2356 ofport_install(struct ofproto *p,
2357 struct netdev *netdev, const struct ofputil_phy_port *pp)
2359 const char *netdev_name = netdev_get_name(netdev);
2360 struct ofport *ofport;
2363 /* Create ofport. */
2364 ofport = p->ofproto_class->port_alloc();
2369 ofport->ofproto = p;
2370 ofport->netdev = netdev;
2371 ofport->change_seq = netdev_get_change_seq(netdev);
2373 ofport->ofp_port = pp->port_no;
2374 ofport->created = time_msec();
2376 /* Add port to 'p'. */
2377 hmap_insert(&p->ports, &ofport->hmap_node,
2378 hash_ofp_port(ofport->ofp_port));
2379 shash_add(&p->port_by_name, netdev_name, ofport);
2381 update_mtu(p, ofport);
2383 /* Let the ofproto_class initialize its private data. */
2384 error = p->ofproto_class->port_construct(ofport);
2388 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2392 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2393 p->name, netdev_name, ovs_strerror(error));
2395 ofport_destroy__(ofport);
2397 netdev_close(netdev);
2402 /* Removes 'ofport' from 'p' and destroys it. */
2404 ofport_remove(struct ofport *ofport)
2406 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2408 ofport_destroy(ofport);
2411 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2414 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2416 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2418 ofport_remove(port);
2422 /* Updates 'port' with new 'pp' description.
2424 * Does not handle a name or port number change. The caller must implement
2425 * such a change as a delete followed by an add. */
2427 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2429 port->pp.hw_addr = pp->hw_addr;
2430 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2431 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2432 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2433 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2434 port->pp.curr = pp->curr;
2435 port->pp.advertised = pp->advertised;
2436 port->pp.supported = pp->supported;
2437 port->pp.peer = pp->peer;
2438 port->pp.curr_speed = pp->curr_speed;
2439 port->pp.max_speed = pp->max_speed;
2441 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2442 &port->pp, OFPPR_MODIFY);
2445 /* Update OpenFlow 'state' in 'port' and notify controller. */
2447 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2449 if (port->pp.state != state) {
2450 port->pp.state = state;
2451 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2452 &port->pp, OFPPR_MODIFY);
2457 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2459 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2461 if (port->ofproto->ofproto_class->set_realdev) {
2462 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2464 if (port->ofproto->ofproto_class->set_stp_port) {
2465 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2467 if (port->ofproto->ofproto_class->set_rstp_port) {
2468 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2470 if (port->ofproto->ofproto_class->set_cfm) {
2471 port->ofproto->ofproto_class->set_cfm(port, NULL);
2473 if (port->ofproto->ofproto_class->bundle_remove) {
2474 port->ofproto->ofproto_class->bundle_remove(port);
2480 ofport_destroy__(struct ofport *port)
2482 struct ofproto *ofproto = port->ofproto;
2483 const char *name = netdev_get_name(port->netdev);
2485 hmap_remove(&ofproto->ports, &port->hmap_node);
2486 shash_delete(&ofproto->port_by_name,
2487 shash_find(&ofproto->port_by_name, name));
2489 netdev_close(port->netdev);
2490 ofproto->ofproto_class->port_dealloc(port);
2494 ofport_destroy(struct ofport *port)
2497 dealloc_ofp_port(port->ofproto, port->ofp_port);
2498 port->ofproto->ofproto_class->port_destruct(port);
2499 ofport_destroy__(port);
2504 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2506 struct ofport *port;
2508 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2510 if (port->ofp_port == ofp_port) {
2517 static long long int
2518 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2520 struct ofport_usage *usage;
2522 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2523 &ofproto->ofport_usage) {
2524 if (usage->ofp_port == ofp_port) {
2525 return usage->last_used;
2532 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2533 long long int last_used)
2535 struct ofport_usage *usage;
2536 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2537 &ofproto->ofport_usage) {
2538 if (usage->ofp_port == ofp_port) {
2539 usage->last_used = last_used;
2543 ovs_assert(last_used == LLONG_MAX);
2545 usage = xmalloc(sizeof *usage);
2546 usage->ofp_port = ofp_port;
2547 usage->last_used = last_used;
2548 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2549 hash_ofp_port(ofp_port));
2553 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2555 struct ofport_usage *usage;
2556 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2557 &ofproto->ofport_usage) {
2558 if (usage->ofp_port == ofp_port) {
2559 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2567 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2569 struct ofproto *ofproto = port->ofproto;
2572 if (ofproto->ofproto_class->port_get_stats) {
2573 error = ofproto->ofproto_class->port_get_stats(port, stats);
2582 update_port(struct ofproto *ofproto, const char *name)
2584 struct ofproto_port ofproto_port;
2585 struct ofputil_phy_port pp;
2586 struct netdev *netdev;
2587 struct ofport *port;
2590 COVERAGE_INC(ofproto_update_port);
2592 /* Fetch 'name''s location and properties from the datapath. */
2593 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2594 ? ofport_open(ofproto, &ofproto_port, &pp)
2598 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2599 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2600 struct netdev *old_netdev = port->netdev;
2602 /* 'name' hasn't changed location. Any properties changed? */
2603 if (!ofport_equal(&port->pp, &pp)) {
2604 ofport_modified(port, &pp);
2607 update_mtu(ofproto, port);
2609 /* Install the newly opened netdev in case it has changed.
2610 * Don't close the old netdev yet in case port_modified has to
2611 * remove a retained reference to it.*/
2612 port->netdev = netdev;
2613 port->change_seq = netdev_get_change_seq(netdev);
2615 if (port->ofproto->ofproto_class->port_modified) {
2616 port->ofproto->ofproto_class->port_modified(port);
2619 netdev_close(old_netdev);
2621 /* If 'port' is nonnull then its name differs from 'name' and thus
2622 * we should delete it. If we think there's a port named 'name'
2623 * then its port number must be wrong now so delete it too. */
2625 ofport_remove(port);
2627 ofport_remove_with_name(ofproto, name);
2628 error = ofport_install(ofproto, netdev, &pp);
2631 /* Any port named 'name' is gone now. */
2632 ofport_remove_with_name(ofproto, name);
2634 ofproto_port_destroy(&ofproto_port);
2640 init_ports(struct ofproto *p)
2642 struct ofproto_port_dump dump;
2643 struct ofproto_port ofproto_port;
2644 struct shash_node *node, *next;
2646 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2647 const char *name = ofproto_port.name;
2649 if (shash_find(&p->port_by_name, name)) {
2650 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2653 struct ofputil_phy_port pp;
2654 struct netdev *netdev;
2656 /* Check if an OpenFlow port number had been requested. */
2657 node = shash_find(&init_ofp_ports, name);
2659 const struct iface_hint *iface_hint = node->data;
2660 simap_put(&p->ofp_requests, name,
2661 ofp_to_u16(iface_hint->ofp_port));
2664 netdev = ofport_open(p, &ofproto_port, &pp);
2666 ofport_install(p, netdev, &pp);
2667 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2668 p->alloc_port_no = MAX(p->alloc_port_no,
2669 ofp_to_u16(ofproto_port.ofp_port));
2675 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2676 struct iface_hint *iface_hint = node->data;
2678 if (!strcmp(iface_hint->br_name, p->name)) {
2679 free(iface_hint->br_name);
2680 free(iface_hint->br_type);
2682 shash_delete(&init_ofp_ports, node);
2689 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2690 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2692 find_min_mtu(struct ofproto *p)
2694 struct ofport *ofport;
2697 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2698 struct netdev *netdev = ofport->netdev;
2701 /* Skip any internal ports, since that's what we're trying to
2703 if (!strcmp(netdev_get_type(netdev), "internal")) {
2707 if (netdev_get_mtu(netdev, &dev_mtu)) {
2710 if (!mtu || dev_mtu < mtu) {
2715 return mtu ? mtu: ETH_PAYLOAD_MAX;
2718 /* Update MTU of all datapath devices on 'p' to the minimum of the
2719 * non-datapath ports in event of 'port' added or changed. */
2721 update_mtu(struct ofproto *p, struct ofport *port)
2723 struct ofport *ofport;
2724 struct netdev *netdev = port->netdev;
2725 int dev_mtu, old_min;
2727 if (netdev_get_mtu(netdev, &dev_mtu)) {
2731 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2732 if (dev_mtu > p->min_mtu) {
2733 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2734 dev_mtu = p->min_mtu;
2737 port->mtu = dev_mtu;
2741 /* For non-internal port find new min mtu. */
2742 old_min = p->min_mtu;
2743 port->mtu = dev_mtu;
2744 p->min_mtu = find_min_mtu(p);
2745 if (p->min_mtu == old_min) {
2749 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2750 struct netdev *netdev = ofport->netdev;
2752 if (!strcmp(netdev_get_type(netdev), "internal")) {
2753 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2754 ofport->mtu = p->min_mtu;
2761 ofproto_rule_destroy__(struct rule *rule)
2762 OVS_NO_THREAD_SAFETY_ANALYSIS
2764 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2765 rule_actions_destroy(rule_get_actions(rule));
2766 ovs_mutex_destroy(&rule->mutex);
2767 rule->ofproto->ofproto_class->rule_dealloc(rule);
2771 rule_destroy_cb(struct rule *rule)
2772 OVS_NO_THREAD_SAFETY_ANALYSIS
2774 /* Send rule removed if needed. */
2775 if (rule->flags & OFPUTIL_FF_SEND_FLOW_REM
2776 && rule->removed_reason != OVS_OFPRR_NONE
2777 && !rule_is_hidden(rule)) {
2778 ofproto_rule_send_removed(rule);
2780 rule->ofproto->ofproto_class->rule_destruct(rule);
2781 ofproto_rule_destroy__(rule);
2785 ofproto_rule_ref(struct rule *rule)
2788 ovs_refcount_ref(&rule->ref_count);
2793 ofproto_rule_try_ref(struct rule *rule)
2796 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2801 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2802 * ref_count reaches 0.
2804 * Use of RCU allows short term use (between RCU quiescent periods) without
2805 * keeping a reference. A reference must be taken if the rule needs to
2806 * stay around accross the RCU quiescent periods. */
2808 ofproto_rule_unref(struct rule *rule)
2810 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2811 ovsrcu_postpone(rule_destroy_cb, rule);
2816 remove_rule_rcu__(struct rule *rule)
2817 OVS_REQUIRES(ofproto_mutex)
2819 struct ofproto *ofproto = rule->ofproto;
2820 struct oftable *table = &ofproto->tables[rule->table_id];
2822 ovs_assert(!cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
2823 if (!classifier_remove(&table->cls, &rule->cr)) {
2826 ofproto->ofproto_class->rule_delete(rule);
2827 ofproto_rule_unref(rule);
2831 remove_rule_rcu(struct rule *rule)
2832 OVS_EXCLUDED(ofproto_mutex)
2834 ovs_mutex_lock(&ofproto_mutex);
2835 remove_rule_rcu__(rule);
2836 ovs_mutex_unlock(&ofproto_mutex);
2839 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2841 remove_rules_rcu(struct rule **rules)
2842 OVS_EXCLUDED(ofproto_mutex)
2844 struct rule **orig_rules = rules;
2847 struct ofproto *ofproto = rules[0]->ofproto;
2848 unsigned long tables[BITMAP_N_LONGS(256)];
2852 memset(tables, 0, sizeof tables);
2854 ovs_mutex_lock(&ofproto_mutex);
2855 while ((rule = *rules++)) {
2856 /* Defer once for each new table. This defers the subtable cleanup
2857 * until later, so that when removing large number of flows the
2858 * operation is faster. */
2859 if (!bitmap_is_set(tables, rule->table_id)) {
2860 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
2862 bitmap_set1(tables, rule->table_id);
2863 classifier_defer(cls);
2865 remove_rule_rcu__(rule);
2868 BITMAP_FOR_EACH_1(table_id, 256, tables) {
2869 struct classifier *cls = &ofproto->tables[table_id].cls;
2871 classifier_publish(cls);
2873 ovs_mutex_unlock(&ofproto_mutex);
2880 ofproto_group_ref(struct ofgroup *group)
2883 ovs_refcount_ref(&group->ref_count);
2888 ofproto_group_unref(struct ofgroup *group)
2890 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2891 group->ofproto->ofproto_class->group_destruct(group);
2892 ofputil_bucket_list_destroy(&group->buckets);
2893 group->ofproto->ofproto_class->group_dealloc(group);
2897 static uint32_t get_provider_meter_id(const struct ofproto *,
2898 uint32_t of_meter_id);
2900 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2901 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2902 const struct rule_actions *
2903 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2905 struct rule_actions *actions;
2907 actions = xmalloc(sizeof *actions + ofpacts_len);
2908 actions->ofpacts_len = ofpacts_len;
2909 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2910 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2912 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2918 /* Free the actions after the RCU quiescent period is reached. */
2920 rule_actions_destroy(const struct rule_actions *actions)
2923 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2927 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2928 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2930 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2931 OVS_REQUIRES(ofproto_mutex)
2933 if (port == OFPP_ANY) {
2936 const struct rule_actions *actions = rule_get_actions(rule);
2937 return ofpacts_output_to_port(actions->ofpacts,
2938 actions->ofpacts_len, port);
2942 /* Returns true if 'rule' has group and equals group_id. */
2944 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2945 OVS_REQUIRES(ofproto_mutex)
2947 if (group_id == OFPG_ANY) {
2950 const struct rule_actions *actions = rule_get_actions(rule);
2951 return ofpacts_output_to_group(actions->ofpacts,
2952 actions->ofpacts_len, group_id);
2957 rule_execute_destroy(struct rule_execute *e)
2959 ofproto_rule_unref(e->rule);
2960 list_remove(&e->list_node);
2964 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2965 * by passing them to the ofproto provider. */
2967 run_rule_executes(struct ofproto *ofproto)
2968 OVS_EXCLUDED(ofproto_mutex)
2970 struct rule_execute *e, *next;
2971 struct ovs_list executes;
2973 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2974 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2977 flow_extract(e->packet, &flow);
2978 flow.in_port.ofp_port = e->in_port;
2979 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2981 rule_execute_destroy(e);
2985 /* Destroys and discards all "rule_execute" operations queued up in
2986 * ofproto->rule_executes. */
2988 destroy_rule_executes(struct ofproto *ofproto)
2990 struct rule_execute *e, *next;
2991 struct ovs_list executes;
2993 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2994 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2995 dp_packet_delete(e->packet);
2996 rule_execute_destroy(e);
3001 rule_is_readonly(const struct rule *rule)
3003 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
3004 return (table->flags & OFTABLE_READONLY) != 0;
3008 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
3010 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
3011 return hash_3words(cookie, cookie >> 32, table_id);
3015 learned_cookies_update_one__(struct ofproto *ofproto,
3016 const struct ofpact_learn *learn,
3017 int delta, struct ovs_list *dead_cookies)
3018 OVS_REQUIRES(ofproto_mutex)
3020 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
3021 struct learned_cookie *c;
3023 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
3024 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
3026 ovs_assert(c->n >= 0);
3029 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
3030 list_push_back(dead_cookies, &c->u.list_node);
3037 ovs_assert(delta > 0);
3038 c = xmalloc(sizeof *c);
3039 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
3040 c->cookie = learn->cookie;
3041 c->table_id = learn->table_id;
3045 static const struct ofpact_learn *
3046 next_learn_with_delete(const struct rule_actions *actions,
3047 const struct ofpact_learn *start)
3049 const struct ofpact *pos;
3051 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
3052 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
3053 pos = ofpact_next(pos)) {
3054 if (pos->type == OFPACT_LEARN) {
3055 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
3056 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3066 learned_cookies_update__(struct ofproto *ofproto,
3067 const struct rule_actions *actions,
3068 int delta, struct ovs_list *dead_cookies)
3069 OVS_REQUIRES(ofproto_mutex)
3071 if (actions->has_learn_with_delete) {
3072 const struct ofpact_learn *learn;
3074 for (learn = next_learn_with_delete(actions, NULL); learn;
3075 learn = next_learn_with_delete(actions, learn)) {
3076 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3082 learned_cookies_inc(struct ofproto *ofproto,
3083 const struct rule_actions *actions)
3084 OVS_REQUIRES(ofproto_mutex)
3086 learned_cookies_update__(ofproto, actions, +1, NULL);
3090 learned_cookies_dec(struct ofproto *ofproto,
3091 const struct rule_actions *actions,
3092 struct ovs_list *dead_cookies)
3093 OVS_REQUIRES(ofproto_mutex)
3095 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3099 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3100 OVS_REQUIRES(ofproto_mutex)
3102 struct learned_cookie *c;
3104 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3105 struct rule_criteria criteria;
3106 struct rule_collection rules;
3109 match_init_catchall(&match);
3110 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3111 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3112 rule_criteria_require_rw(&criteria, false);
3113 collect_rules_loose(ofproto, &criteria, &rules);
3114 rule_criteria_destroy(&criteria);
3115 delete_flows__(&rules, OFPRR_DELETE, NULL);
3122 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3124 ofconn_send_reply(ofconn, make_echo_reply(oh));
3129 query_tables(struct ofproto *ofproto,
3130 struct ofputil_table_features **featuresp,
3131 struct ofputil_table_stats **statsp)
3133 struct mf_bitmap rw_fields = oxm_writable_fields();
3134 struct mf_bitmap match = oxm_matchable_fields();
3135 struct mf_bitmap mask = oxm_maskable_fields();
3137 struct ofputil_table_features *features;
3138 struct ofputil_table_stats *stats;
3141 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3142 for (i = 0; i < ofproto->n_tables; i++) {
3143 struct ofputil_table_features *f = &features[i];
3146 sprintf(f->name, "table%d", i);
3147 f->metadata_match = OVS_BE64_MAX;
3148 f->metadata_write = OVS_BE64_MAX;
3149 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3150 f->max_entries = 1000000;
3152 bool more_tables = false;
3153 for (int j = i + 1; j < ofproto->n_tables; j++) {
3154 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3155 bitmap_set1(f->nonmiss.next, j);
3159 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3161 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3163 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3164 f->nonmiss.write.set_fields = rw_fields;
3165 f->nonmiss.apply = f->nonmiss.write;
3166 f->miss = f->nonmiss;
3170 f->wildcard = match;
3174 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3175 for (i = 0; i < ofproto->n_tables; i++) {
3176 struct ofputil_table_stats *s = &stats[i];
3179 s->active_count = ofproto->tables[i].n_flows;
3181 s->active_count -= connmgr_count_hidden_rules(
3189 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3191 for (i = 0; i < ofproto->n_tables; i++) {
3192 const struct oftable *table = &ofproto->tables[i];
3193 struct ofputil_table_features *f = &features[i];
3196 ovs_strzcpy(f->name, table->name, sizeof f->name);
3199 if (table->max_flows < f->max_entries) {
3200 f->max_entries = table->max_flows;
3206 query_switch_features(struct ofproto *ofproto,
3207 bool *arp_match_ip, uint64_t *ofpacts)
3209 struct ofputil_table_features *features, *f;
3211 *arp_match_ip = false;
3214 query_tables(ofproto, &features, NULL);
3215 for (f = features; f < &features[ofproto->n_tables]; f++) {
3216 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3217 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3218 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3219 *arp_match_ip = true;
3225 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3229 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3231 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3232 struct ofputil_switch_features features;
3233 struct ofport *port;
3237 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3239 features.datapath_id = ofproto->datapath_id;
3240 features.n_buffers = pktbuf_capacity();
3241 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3242 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3243 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3244 OFPUTIL_C_GROUP_STATS);
3246 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3248 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3249 features.auxiliary_id = 0;
3250 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3252 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3253 ofputil_put_switch_features_port(&port->pp, b);
3256 ofconn_send_reply(ofconn, b);
3261 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3263 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3264 struct ofp_switch_config *osc;
3265 enum ofp_config_flags flags;
3269 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3270 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3271 flags = ofproto->frag_handling;
3272 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3273 if (oh->version < OFP13_VERSION
3274 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3275 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3277 osc->flags = htons(flags);
3278 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3279 ofconn_send_reply(ofconn, buf);
3285 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3287 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3288 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3289 uint16_t flags = ntohs(osc->flags);
3291 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3292 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3293 enum ofp_config_flags cur = ofproto->frag_handling;
3294 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3296 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3298 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3299 ofproto->frag_handling = next;
3301 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3303 ofputil_frag_handling_to_string(next));
3307 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3308 ofconn_set_invalid_ttl_to_controller(ofconn,
3309 (oh->version < OFP13_VERSION
3310 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3312 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3317 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3318 * error message code for the caller to propagate upward. Otherwise, returns
3321 * The log message mentions 'msg_type'. */
3323 reject_slave_controller(struct ofconn *ofconn)
3325 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3326 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3327 return OFPERR_OFPBRC_IS_SLAVE;
3333 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3336 * - If they use a meter, then 'ofproto' has that meter configured.
3338 * - If they use any groups, then 'ofproto' has that group configured.
3340 * Returns 0 if successful, otherwise an OpenFlow error. */
3342 ofproto_check_ofpacts(struct ofproto *ofproto,
3343 const struct ofpact ofpacts[], size_t ofpacts_len)
3345 const struct ofpact *a;
3348 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3349 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3350 return OFPERR_OFPMMFC_INVALID_METER;
3353 OFPACT_FOR_EACH_FLATTENED (a, ofpacts, ofpacts_len) {
3354 if (a->type == OFPACT_GROUP
3355 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3356 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3364 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3366 struct ofproto *p = ofconn_get_ofproto(ofconn);
3367 struct ofputil_packet_out po;
3368 struct dp_packet *payload;
3369 uint64_t ofpacts_stub[1024 / 8];
3370 struct ofpbuf ofpacts;
3374 COVERAGE_INC(ofproto_packet_out);
3376 error = reject_slave_controller(ofconn);
3381 /* Decode message. */
3382 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3383 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3385 goto exit_free_ofpacts;
3387 if (ofp_to_u16(po.in_port) >= p->max_ports
3388 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3389 error = OFPERR_OFPBRC_BAD_PORT;
3390 goto exit_free_ofpacts;
3394 if (po.buffer_id != UINT32_MAX) {
3395 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3396 if (error || !payload) {
3397 goto exit_free_ofpacts;
3400 /* Ensure that the L3 header is 32-bit aligned. */
3401 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3404 /* Verify actions against packet, then send packet if successful. */
3405 flow_extract(payload, &flow);
3406 flow.in_port.ofp_port = po.in_port;
3408 /* Check actions like for flow mods. We pass a 'table_id' of 0 to
3409 * ofproto_check_consistency(), which isn't strictly correct because these
3410 * actions aren't in any table. This is OK as 'table_id' is only used to
3411 * check instructions (e.g., goto-table), which can't appear on the action
3412 * list of a packet-out. */
3413 error = ofpacts_check_consistency(po.ofpacts, po.ofpacts_len,
3414 &flow, u16_to_ofp(p->max_ports),
3416 ofconn_get_protocol(ofconn));
3418 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3420 error = p->ofproto_class->packet_out(p, payload, &flow,
3421 po.ofpacts, po.ofpacts_len);
3424 dp_packet_delete(payload);
3427 ofpbuf_uninit(&ofpacts);
3433 update_port_config(struct ofconn *ofconn, struct ofport *port,
3434 enum ofputil_port_config config,
3435 enum ofputil_port_config mask)
3437 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3439 if (toggle & OFPUTIL_PC_PORT_DOWN
3440 && (config & OFPUTIL_PC_PORT_DOWN
3441 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3442 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3443 /* We tried to bring the port up or down, but it failed, so don't
3444 * update the "down" bit. */
3445 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3449 enum ofputil_port_config old_config = port->pp.config;
3450 port->pp.config ^= toggle;
3451 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3452 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3458 port_mod_start(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3459 struct ofport **port)
3461 struct ofproto *p = ofconn_get_ofproto(ofconn);
3463 *port = ofproto_get_port(p, pm->port_no);
3465 return OFPERR_OFPPMFC_BAD_PORT;
3467 if (!eth_addr_equals((*port)->pp.hw_addr, pm->hw_addr)) {
3468 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3474 port_mod_finish(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3475 struct ofport *port)
3477 update_port_config(ofconn, port, pm->config, pm->mask);
3478 if (pm->advertise) {
3479 netdev_set_advertisements(port->netdev, pm->advertise);
3484 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3486 struct ofputil_port_mod pm;
3487 struct ofport *port;
3490 error = reject_slave_controller(ofconn);
3495 error = ofputil_decode_port_mod(oh, &pm, false);
3500 error = port_mod_start(ofconn, &pm, &port);
3502 port_mod_finish(ofconn, &pm, port);
3508 handle_desc_stats_request(struct ofconn *ofconn,
3509 const struct ofp_header *request)
3511 static const char *default_mfr_desc = "Nicira, Inc.";
3512 static const char *default_hw_desc = "Open vSwitch";
3513 static const char *default_sw_desc = VERSION;
3514 static const char *default_serial_desc = "None";
3515 static const char *default_dp_desc = "None";
3517 struct ofproto *p = ofconn_get_ofproto(ofconn);
3518 struct ofp_desc_stats *ods;
3521 msg = ofpraw_alloc_stats_reply(request, 0);
3522 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3523 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3524 sizeof ods->mfr_desc);
3525 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3526 sizeof ods->hw_desc);
3527 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3528 sizeof ods->sw_desc);
3529 ovs_strlcpy(ods->serial_num,
3530 p->serial_desc ? p->serial_desc : default_serial_desc,
3531 sizeof ods->serial_num);
3532 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3533 sizeof ods->dp_desc);
3534 ofconn_send_reply(ofconn, msg);
3540 handle_table_stats_request(struct ofconn *ofconn,
3541 const struct ofp_header *request)
3543 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3544 struct ofputil_table_features *features;
3545 struct ofputil_table_stats *stats;
3546 struct ofpbuf *reply;
3549 query_tables(ofproto, &features, &stats);
3551 reply = ofputil_encode_table_stats_reply(request);
3552 for (i = 0; i < ofproto->n_tables; i++) {
3553 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3554 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3557 ofconn_send_reply(ofconn, reply);
3566 handle_table_features_request(struct ofconn *ofconn,
3567 const struct ofp_header *request)
3569 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3570 struct ofputil_table_features *features;
3571 struct ovs_list replies;
3575 ofpbuf_use_const(&msg, request, ntohs(request->length));
3576 ofpraw_pull_assert(&msg);
3577 if (msg.size || ofpmp_more(request)) {
3578 return OFPERR_OFPTFFC_EPERM;
3581 query_tables(ofproto, &features, NULL);
3583 ofpmp_init(&replies, request);
3584 for (i = 0; i < ofproto->n_tables; i++) {
3585 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3586 ofputil_append_table_features_reply(&features[i], &replies);
3589 ofconn_send_replies(ofconn, &replies);
3597 query_table_desc__(struct ofputil_table_desc *td,
3598 struct ofproto *ofproto, uint8_t table_id)
3600 unsigned int count = ofproto->tables[table_id].n_flows;
3601 unsigned int max_flows = ofproto->tables[table_id].max_flows;
3603 td->table_id = table_id;
3604 td->eviction = (ofproto->tables[table_id].eviction & EVICTION_OPENFLOW
3605 ? OFPUTIL_TABLE_EVICTION_ON
3606 : OFPUTIL_TABLE_EVICTION_OFF);
3607 td->eviction_flags = OFPROTO_EVICTION_FLAGS;
3608 td->vacancy = (ofproto->tables[table_id].vacancy_enabled
3609 ? OFPUTIL_TABLE_VACANCY_ON
3610 : OFPUTIL_TABLE_VACANCY_OFF);
3611 td->table_vacancy.vacancy_down = ofproto->tables[table_id].vacancy_down;
3612 td->table_vacancy.vacancy_up = ofproto->tables[table_id].vacancy_up;
3613 td->table_vacancy.vacancy = max_flows ? (count * 100) / max_flows : 0;
3616 /* This function queries the database for dumping table-desc. */
3618 query_tables_desc(struct ofproto *ofproto, struct ofputil_table_desc **descp)
3620 struct ofputil_table_desc *table_desc;
3623 table_desc = *descp = xcalloc(ofproto->n_tables, sizeof *table_desc);
3624 for (i = 0; i < ofproto->n_tables; i++) {
3625 struct ofputil_table_desc *td = &table_desc[i];
3626 query_table_desc__(td, ofproto, i);
3630 /* Function to handle dump-table-desc request. */
3632 handle_table_desc_request(struct ofconn *ofconn,
3633 const struct ofp_header *request)
3635 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3636 struct ofputil_table_desc *table_desc;
3637 struct ovs_list replies;
3640 query_tables_desc(ofproto, &table_desc);
3641 ofpmp_init(&replies, request);
3642 for (i = 0; i < ofproto->n_tables; i++) {
3643 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3644 ofputil_append_table_desc_reply(&table_desc[i], &replies,
3648 ofconn_send_replies(ofconn, &replies);
3654 append_port_stat(struct ofport *port, struct ovs_list *replies)
3656 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3658 calc_duration(port->created, time_msec(),
3659 &ops.duration_sec, &ops.duration_nsec);
3661 /* Intentionally ignore return value, since errors will set
3662 * 'stats' to all-1s, which is correct for OpenFlow, and
3663 * netdev_get_stats() will log errors. */
3664 ofproto_port_get_stats(port, &ops.stats);
3666 ofputil_append_port_stat(replies, &ops);
3670 handle_port_request(struct ofconn *ofconn,
3671 const struct ofp_header *request, ofp_port_t port_no,
3672 void (*cb)(struct ofport *, struct ovs_list *replies))
3674 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3675 struct ofport *port;
3676 struct ovs_list replies;
3678 ofpmp_init(&replies, request);
3679 if (port_no != OFPP_ANY) {
3680 port = ofproto_get_port(ofproto, port_no);
3685 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3690 ofconn_send_replies(ofconn, &replies);
3694 handle_port_stats_request(struct ofconn *ofconn,
3695 const struct ofp_header *request)
3700 error = ofputil_decode_port_stats_request(request, &port_no);
3702 handle_port_request(ofconn, request, port_no, append_port_stat);
3708 append_port_desc(struct ofport *port, struct ovs_list *replies)
3710 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3714 handle_port_desc_stats_request(struct ofconn *ofconn,
3715 const struct ofp_header *request)
3720 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3722 handle_port_request(ofconn, request, port_no, append_port_desc);
3728 hash_cookie(ovs_be64 cookie)
3730 return hash_uint64((OVS_FORCE uint64_t)cookie);
3734 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3735 OVS_REQUIRES(ofproto_mutex)
3737 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3738 hash_cookie(rule->flow_cookie));
3742 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3743 OVS_REQUIRES(ofproto_mutex)
3745 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3749 calc_duration(long long int start, long long int now,
3750 uint32_t *sec, uint32_t *nsec)
3752 long long int msecs = now - start;
3753 *sec = msecs / 1000;
3754 *nsec = (msecs % 1000) * (1000 * 1000);
3757 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3758 * true if 'table_id' is OK, false otherwise. */
3760 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3762 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3765 static struct oftable *
3766 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3768 struct oftable *table;
3770 for (table = &ofproto->tables[table_id];
3771 table < &ofproto->tables[ofproto->n_tables];
3773 if (!(table->flags & OFTABLE_HIDDEN)) {
3781 static struct oftable *
3782 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3784 if (table_id == 0xff) {
3785 return next_visible_table(ofproto, 0);
3786 } else if (table_id < ofproto->n_tables) {
3787 return &ofproto->tables[table_id];
3793 static struct oftable *
3794 next_matching_table(const struct ofproto *ofproto,
3795 const struct oftable *table, uint8_t table_id)
3797 return (table_id == 0xff
3798 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3802 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3804 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3805 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3807 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3808 * only once, for that table. (This can be used to access tables marked
3811 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3812 * entered at all. (Perhaps you should have validated TABLE_ID with
3813 * check_table_id().)
3815 * All parameters are evaluated multiple times.
3817 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3818 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3820 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3822 /* Initializes 'criteria' in a straightforward way based on the other
3825 * By default, the criteria include flows that are read-only, on the assumption
3826 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3827 * if flows will be modified.
3829 * For "loose" matching, the 'priority' parameter is unimportant and may be
3832 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3833 const struct match *match, int priority,
3834 cls_version_t version, ovs_be64 cookie,
3835 ovs_be64 cookie_mask, ofp_port_t out_port,
3838 criteria->table_id = table_id;
3839 cls_rule_init(&criteria->cr, match, priority);
3840 criteria->version = version;
3841 criteria->cookie = cookie;
3842 criteria->cookie_mask = cookie_mask;
3843 criteria->out_port = out_port;
3844 criteria->out_group = out_group;
3846 /* We ordinarily want to skip hidden rules, but there has to be a way for
3847 * code internal to OVS to modify and delete them, so if the criteria
3848 * specify a priority that can only be for a hidden flow, then allow hidden
3849 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3850 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3852 criteria->include_hidden = priority > UINT16_MAX;
3854 /* We assume that the criteria are being used to collect flows for reading
3855 * but not modification. Thus, we should collect read-only flows. */
3856 criteria->include_readonly = true;
3859 /* By default, criteria initialized by rule_criteria_init() will match flows
3860 * that are read-only, on the assumption that the collected flows won't be
3861 * modified. Call this function to match only flows that are be modifiable.
3863 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3864 * caller has special privileges that allow it to modify even "read-only"
3867 rule_criteria_require_rw(struct rule_criteria *criteria,
3868 bool can_write_readonly)
3870 criteria->include_readonly = can_write_readonly;
3874 rule_criteria_destroy(struct rule_criteria *criteria)
3876 cls_rule_destroy(&criteria->cr);
3880 rule_collection_init(struct rule_collection *rules)
3882 rules->rules = rules->stub;
3884 rules->capacity = ARRAY_SIZE(rules->stub);
3888 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3890 if (rules->n >= rules->capacity) {
3891 size_t old_size, new_size;
3893 old_size = rules->capacity * sizeof *rules->rules;
3894 rules->capacity *= 2;
3895 new_size = rules->capacity * sizeof *rules->rules;
3897 if (rules->rules == rules->stub) {
3898 rules->rules = xmalloc(new_size);
3899 memcpy(rules->rules, rules->stub, old_size);
3901 rules->rules = xrealloc(rules->rules, new_size);
3905 rules->rules[rules->n++] = rule;
3909 rule_collection_ref(struct rule_collection *rules)
3910 OVS_REQUIRES(ofproto_mutex)
3914 for (i = 0; i < rules->n; i++) {
3915 ofproto_rule_ref(rules->rules[i]);
3920 rule_collection_unref(struct rule_collection *rules)
3924 for (i = 0; i < rules->n; i++) {
3925 ofproto_rule_unref(rules->rules[i]);
3929 /* Returns a NULL-terminated array of rule pointers,
3930 * destroys 'rules'. */
3931 static struct rule **
3932 rule_collection_detach(struct rule_collection *rules)
3934 struct rule **rule_array;
3936 rule_collection_add(rules, NULL);
3938 if (rules->rules == rules->stub) {
3939 rules->rules = xmemdup(rules->rules, rules->n * sizeof *rules->rules);
3942 rule_array = rules->rules;
3943 rule_collection_init(rules);
3949 rule_collection_destroy(struct rule_collection *rules)
3951 if (rules->rules != rules->stub) {
3955 /* Make repeated destruction harmless. */
3956 rule_collection_init(rules);
3959 /* Schedules postponed removal of rules, destroys 'rules'. */
3961 rule_collection_remove_postponed(struct rule_collection *rules)
3962 OVS_REQUIRES(ofproto_mutex)
3965 if (rules->n == 1) {
3966 ovsrcu_postpone(remove_rule_rcu, rules->rules[0]);
3968 ovsrcu_postpone(remove_rules_rcu, rule_collection_detach(rules));
3973 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3974 * function verifies most of the criteria in 'c' itself, but the caller must
3975 * check 'c->cr' itself.
3977 * Rules that have already been marked for removal are not collected.
3979 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3980 * 'c' only includes modifiable rules). */
3982 collect_rule(struct rule *rule, const struct rule_criteria *c,
3983 struct rule_collection *rules, size_t *n_readonly)
3984 OVS_REQUIRES(ofproto_mutex)
3986 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3987 && ofproto_rule_has_out_port(rule, c->out_port)
3988 && ofproto_rule_has_out_group(rule, c->out_group)
3989 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3990 && (!rule_is_hidden(rule) || c->include_hidden)
3991 && cls_rule_visible_in_version(&rule->cr, c->version)) {
3992 /* Rule matches all the criteria... */
3993 if (!rule_is_readonly(rule) || c->include_readonly) {
3995 rule_collection_add(rules, rule);
3997 /* ...except it's read-only. */
4003 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4004 * on classifiers rules are done in the "loose" way required for OpenFlow
4005 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
4008 * Returns 0 on success, otherwise an OpenFlow error code. */
4010 collect_rules_loose(struct ofproto *ofproto,
4011 const struct rule_criteria *criteria,
4012 struct rule_collection *rules)
4013 OVS_REQUIRES(ofproto_mutex)
4015 struct oftable *table;
4016 enum ofperr error = 0;
4017 size_t n_readonly = 0;
4019 rule_collection_init(rules);
4021 if (!check_table_id(ofproto, criteria->table_id)) {
4022 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4026 if (criteria->cookie_mask == OVS_BE64_MAX) {
4029 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4030 hash_cookie(criteria->cookie),
4031 &ofproto->cookies) {
4032 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
4033 collect_rule(rule, criteria, rules, &n_readonly);
4037 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4040 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr,
4041 criteria->version) {
4042 collect_rule(rule, criteria, rules, &n_readonly);
4048 if (!error && !rules->n && n_readonly) {
4049 /* We didn't find any rules to modify. We did find some read-only
4050 * rules that we're not allowed to modify, so report that. */
4051 error = OFPERR_OFPBRC_EPERM;
4054 rule_collection_destroy(rules);
4059 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4060 * on classifiers rules are done in the "strict" way required for OpenFlow
4061 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
4062 * rules on list 'rules'.
4064 * Returns 0 on success, otherwise an OpenFlow error code. */
4066 collect_rules_strict(struct ofproto *ofproto,
4067 const struct rule_criteria *criteria,
4068 struct rule_collection *rules)
4069 OVS_REQUIRES(ofproto_mutex)
4071 struct oftable *table;
4072 size_t n_readonly = 0;
4073 enum ofperr error = 0;
4075 rule_collection_init(rules);
4077 if (!check_table_id(ofproto, criteria->table_id)) {
4078 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4082 if (criteria->cookie_mask == OVS_BE64_MAX) {
4085 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4086 hash_cookie(criteria->cookie),
4087 &ofproto->cookies) {
4088 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
4089 collect_rule(rule, criteria, rules, &n_readonly);
4093 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4096 rule = rule_from_cls_rule(classifier_find_rule_exactly(
4097 &table->cls, &criteria->cr,
4098 criteria->version));
4100 collect_rule(rule, criteria, rules, &n_readonly);
4106 if (!error && !rules->n && n_readonly) {
4107 /* We didn't find any rules to modify. We did find some read-only
4108 * rules that we're not allowed to modify, so report that. */
4109 error = OFPERR_OFPBRC_EPERM;
4112 rule_collection_destroy(rules);
4117 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4118 * forced into the range of a uint16_t. */
4120 age_secs(long long int age_ms)
4122 return (age_ms < 0 ? 0
4123 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
4124 : (unsigned int) age_ms / 1000);
4128 handle_flow_stats_request(struct ofconn *ofconn,
4129 const struct ofp_header *request)
4130 OVS_EXCLUDED(ofproto_mutex)
4132 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4133 struct ofputil_flow_stats_request fsr;
4134 struct rule_criteria criteria;
4135 struct rule_collection rules;
4136 struct ovs_list replies;
4140 error = ofputil_decode_flow_stats_request(&fsr, request);
4145 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
4146 fsr.cookie, fsr.cookie_mask, fsr.out_port,
4149 ovs_mutex_lock(&ofproto_mutex);
4150 error = collect_rules_loose(ofproto, &criteria, &rules);
4151 rule_criteria_destroy(&criteria);
4153 rule_collection_ref(&rules);
4155 ovs_mutex_unlock(&ofproto_mutex);
4161 ofpmp_init(&replies, request);
4162 for (i = 0; i < rules.n; i++) {
4163 struct rule *rule = rules.rules[i];
4164 long long int now = time_msec();
4165 struct ofputil_flow_stats fs;
4166 long long int created, used, modified;
4167 const struct rule_actions *actions;
4168 enum ofputil_flow_mod_flags flags;
4170 ovs_mutex_lock(&rule->mutex);
4171 fs.cookie = rule->flow_cookie;
4172 fs.idle_timeout = rule->idle_timeout;
4173 fs.hard_timeout = rule->hard_timeout;
4174 fs.importance = rule->importance;
4175 created = rule->created;
4176 modified = rule->modified;
4177 actions = rule_get_actions(rule);
4178 flags = rule->flags;
4179 ovs_mutex_unlock(&rule->mutex);
4181 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
4182 &fs.byte_count, &used);
4184 minimatch_expand(&rule->cr.match, &fs.match);
4185 fs.table_id = rule->table_id;
4186 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4187 fs.priority = rule->cr.priority;
4188 fs.idle_age = age_secs(now - used);
4189 fs.hard_age = age_secs(now - modified);
4190 fs.ofpacts = actions->ofpacts;
4191 fs.ofpacts_len = actions->ofpacts_len;
4194 ofputil_append_flow_stats_reply(&fs, &replies);
4197 rule_collection_unref(&rules);
4198 rule_collection_destroy(&rules);
4200 ofconn_send_replies(ofconn, &replies);
4206 flow_stats_ds(struct rule *rule, struct ds *results)
4208 uint64_t packet_count, byte_count;
4209 const struct rule_actions *actions;
4210 long long int created, used;
4212 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4213 &byte_count, &used);
4215 ovs_mutex_lock(&rule->mutex);
4216 actions = rule_get_actions(rule);
4217 created = rule->created;
4218 ovs_mutex_unlock(&rule->mutex);
4220 if (rule->table_id != 0) {
4221 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4223 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4224 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4225 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4226 cls_rule_format(&rule->cr, results);
4227 ds_put_char(results, ',');
4229 ds_put_cstr(results, "actions=");
4230 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4232 ds_put_cstr(results, "\n");
4235 /* Adds a pretty-printed description of all flows to 'results', including
4236 * hidden flows (e.g., set up by in-band control). */
4238 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4240 struct oftable *table;
4242 OFPROTO_FOR_EACH_TABLE (table, p) {
4245 CLS_FOR_EACH (rule, cr, &table->cls) {
4246 flow_stats_ds(rule, results);
4251 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4252 * '*engine_type' and '*engine_id', respectively. */
4254 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4255 uint8_t *engine_type, uint8_t *engine_id)
4257 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4260 /* Checks the status change of CFM on 'ofport'.
4262 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4264 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4266 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4267 return (ofport && ofproto->ofproto_class->cfm_status_changed
4268 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4272 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4273 * Returns 0 if the port's CFM status was successfully stored into
4274 * '*status'. Returns positive errno if the port did not have CFM
4277 * The caller must provide and own '*status', and must free 'status->rmps'.
4278 * '*status' is indeterminate if the return value is non-zero. */
4280 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4281 struct cfm_status *status)
4283 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4284 return (ofport && ofproto->ofproto_class->get_cfm_status
4285 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4290 handle_aggregate_stats_request(struct ofconn *ofconn,
4291 const struct ofp_header *oh)
4292 OVS_EXCLUDED(ofproto_mutex)
4294 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4295 struct ofputil_flow_stats_request request;
4296 struct ofputil_aggregate_stats stats;
4297 bool unknown_packets, unknown_bytes;
4298 struct rule_criteria criteria;
4299 struct rule_collection rules;
4300 struct ofpbuf *reply;
4304 error = ofputil_decode_flow_stats_request(&request, oh);
4309 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4310 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4311 request.out_port, request.out_group);
4313 ovs_mutex_lock(&ofproto_mutex);
4314 error = collect_rules_loose(ofproto, &criteria, &rules);
4315 rule_criteria_destroy(&criteria);
4317 rule_collection_ref(&rules);
4319 ovs_mutex_unlock(&ofproto_mutex);
4325 memset(&stats, 0, sizeof stats);
4326 unknown_packets = unknown_bytes = false;
4327 for (i = 0; i < rules.n; i++) {
4328 struct rule *rule = rules.rules[i];
4329 uint64_t packet_count;
4330 uint64_t byte_count;
4333 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4334 &byte_count, &used);
4336 if (packet_count == UINT64_MAX) {
4337 unknown_packets = true;
4339 stats.packet_count += packet_count;
4342 if (byte_count == UINT64_MAX) {
4343 unknown_bytes = true;
4345 stats.byte_count += byte_count;
4350 if (unknown_packets) {
4351 stats.packet_count = UINT64_MAX;
4353 if (unknown_bytes) {
4354 stats.byte_count = UINT64_MAX;
4357 rule_collection_unref(&rules);
4358 rule_collection_destroy(&rules);
4360 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4361 ofconn_send_reply(ofconn, reply);
4366 struct queue_stats_cbdata {
4367 struct ofport *ofport;
4368 struct ovs_list replies;
4373 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4374 const struct netdev_queue_stats *stats)
4376 struct ofputil_queue_stats oqs;
4378 oqs.port_no = cbdata->ofport->pp.port_no;
4379 oqs.queue_id = queue_id;
4380 oqs.tx_bytes = stats->tx_bytes;
4381 oqs.tx_packets = stats->tx_packets;
4382 oqs.tx_errors = stats->tx_errors;
4383 if (stats->created != LLONG_MIN) {
4384 calc_duration(stats->created, cbdata->now,
4385 &oqs.duration_sec, &oqs.duration_nsec);
4387 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4389 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4393 handle_queue_stats_dump_cb(uint32_t queue_id,
4394 struct netdev_queue_stats *stats,
4397 struct queue_stats_cbdata *cbdata = cbdata_;
4399 put_queue_stats(cbdata, queue_id, stats);
4403 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4404 struct queue_stats_cbdata *cbdata)
4406 cbdata->ofport = port;
4407 if (queue_id == OFPQ_ALL) {
4408 netdev_dump_queue_stats(port->netdev,
4409 handle_queue_stats_dump_cb, cbdata);
4411 struct netdev_queue_stats stats;
4413 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4414 put_queue_stats(cbdata, queue_id, &stats);
4416 return OFPERR_OFPQOFC_BAD_QUEUE;
4423 handle_queue_stats_request(struct ofconn *ofconn,
4424 const struct ofp_header *rq)
4426 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4427 struct queue_stats_cbdata cbdata;
4428 struct ofport *port;
4430 struct ofputil_queue_stats_request oqsr;
4432 COVERAGE_INC(ofproto_queue_req);
4434 ofpmp_init(&cbdata.replies, rq);
4435 cbdata.now = time_msec();
4437 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4442 if (oqsr.port_no == OFPP_ANY) {
4443 error = OFPERR_OFPQOFC_BAD_QUEUE;
4444 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4445 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4450 port = ofproto_get_port(ofproto, oqsr.port_no);
4452 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4453 : OFPERR_OFPQOFC_BAD_PORT);
4456 ofconn_send_replies(ofconn, &cbdata.replies);
4458 ofpbuf_list_delete(&cbdata.replies);
4465 evict_rules_from_table(struct oftable *table)
4466 OVS_REQUIRES(ofproto_mutex)
4468 enum ofperr error = 0;
4469 struct rule_collection rules;
4470 unsigned int count = table->n_flows;
4471 unsigned int max_flows = table->max_flows;
4473 rule_collection_init(&rules);
4475 while (count-- > max_flows) {
4478 if (!choose_rule_to_evict(table, &rule)) {
4479 error = OFPERR_OFPFMFC_TABLE_FULL;
4482 eviction_group_remove_rule(rule);
4483 rule_collection_add(&rules, rule);
4486 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4492 get_conjunctions(const struct ofputil_flow_mod *fm,
4493 struct cls_conjunction **conjsp, size_t *n_conjsp)
4494 OVS_REQUIRES(ofproto_mutex)
4496 struct cls_conjunction *conjs = NULL;
4499 const struct ofpact *ofpact;
4500 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4501 if (ofpact->type == OFPACT_CONJUNCTION) {
4503 } else if (ofpact->type != OFPACT_NOTE) {
4504 /* "conjunction" may appear with "note" actions but not with any
4505 * other type of actions. */
4506 ovs_assert(!n_conjs);
4513 conjs = xzalloc(n_conjs * sizeof *conjs);
4514 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4515 if (ofpact->type == OFPACT_CONJUNCTION) {
4516 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4517 conjs[i].clause = oc->clause;
4518 conjs[i].n_clauses = oc->n_clauses;
4519 conjs[i].id = oc->id;
4526 *n_conjsp = n_conjs;
4529 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4530 * in which no matching flow already exists in the flow table.
4532 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4533 * success, or an OpenFlow error code on failure.
4535 * On successful return the caller must complete the operation either by
4536 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4539 * The caller retains ownership of 'fm->ofpacts'. */
4541 add_flow_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4542 OVS_REQUIRES(ofproto_mutex)
4544 struct ofputil_flow_mod *fm = &ofm->fm;
4545 struct rule **old_rule = &ofm->old_rules.stub[0];
4546 struct rule **new_rule = &ofm->new_rules.stub[0];
4547 struct oftable *table;
4551 struct cls_conjunction *conjs;
4555 if (!check_table_id(ofproto, fm->table_id)) {
4556 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4561 if (fm->table_id == 0xff) {
4562 if (ofproto->ofproto_class->rule_choose_table) {
4563 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4569 ovs_assert(table_id < ofproto->n_tables);
4573 } else if (fm->table_id < ofproto->n_tables) {
4574 table_id = fm->table_id;
4576 return OFPERR_OFPBRC_BAD_TABLE_ID;
4579 table = &ofproto->tables[table_id];
4580 if (table->flags & OFTABLE_READONLY
4581 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4582 return OFPERR_OFPBRC_EPERM;
4585 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4586 && !match_has_default_hidden_fields(&fm->match)) {
4587 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4588 "non-default values to hidden fields", ofproto->name);
4589 return OFPERR_OFPBRC_EPERM;
4592 cls_rule_init(&cr, &fm->match, fm->priority);
4594 /* Check for the existence of an identical rule.
4595 * This will not return rules earlier marked for removal. */
4596 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr,
4600 /* Check for overlap, if requested. */
4601 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4602 && classifier_rule_overlaps(&table->cls, &cr, ofm->version)) {
4603 cls_rule_destroy(&cr);
4604 return OFPERR_OFPFMFC_OVERLAP;
4607 /* If necessary, evict an existing rule to clear out space. */
4608 if (table->n_flows >= table->max_flows) {
4609 if (!choose_rule_to_evict(table, &rule)) {
4610 error = OFPERR_OFPFMFC_TABLE_FULL;
4611 cls_rule_destroy(&cr);
4614 eviction_group_remove_rule(rule);
4615 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4617 fm->delete_reason = OFPRR_EVICTION;
4621 fm->modify_cookie = true;
4624 /* Allocate new rule. */
4625 error = replace_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4631 get_conjunctions(fm, &conjs, &n_conjs);
4632 replace_rule_start(ofproto, ofm->version, rule, *new_rule, conjs, n_conjs);
4638 /* Revert the effects of add_flow_start(). */
4640 add_flow_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4641 OVS_REQUIRES(ofproto_mutex)
4643 struct ofputil_flow_mod *fm = &ofm->fm;
4644 struct rule *old_rule = ofm->old_rules.stub[0];
4645 struct rule *new_rule = ofm->new_rules.stub[0];
4647 if (old_rule && fm->delete_reason == OFPRR_EVICTION) {
4648 /* Revert the eviction. */
4649 eviction_group_add_rule(old_rule);
4652 replace_rule_revert(ofproto, old_rule, new_rule);
4655 /* To be called after version bump. */
4657 add_flow_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4658 const struct flow_mod_requester *req)
4659 OVS_REQUIRES(ofproto_mutex)
4661 struct ofputil_flow_mod *fm = &ofm->fm;
4662 struct rule *old_rule = ofm->old_rules.stub[0];
4663 struct rule *new_rule = ofm->new_rules.stub[0];
4664 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4666 replace_rule_finish(ofproto, fm, req, old_rule, new_rule, &dead_cookies);
4667 learned_cookies_flush(ofproto, &dead_cookies);
4670 ovsrcu_postpone(remove_rule_rcu, old_rule);
4672 if (minimask_get_vid_mask(new_rule->cr.match.mask) == VLAN_VID_MASK) {
4673 if (ofproto->vlan_bitmap) {
4674 uint16_t vid = miniflow_get_vid(new_rule->cr.match.flow);
4676 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4677 bitmap_set1(ofproto->vlan_bitmap, vid);
4678 ofproto->vlans_changed = true;
4681 ofproto->vlans_changed = true;
4685 ofmonitor_report(ofproto->connmgr, new_rule, NXFME_ADDED, 0,
4686 req ? req->ofconn : NULL,
4687 req ? req->request->xid : 0, NULL);
4690 send_buffered_packet(req, fm->buffer_id, new_rule);
4693 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4695 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4696 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4697 * structures yet. Takes ownership of 'cr'. */
4699 replace_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4700 struct cls_rule *cr, uint8_t table_id,
4701 struct rule *old_rule, struct rule **new_rule)
4706 /* Allocate new rule. */
4707 rule = ofproto->ofproto_class->rule_alloc();
4709 cls_rule_destroy(cr);
4710 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
4711 return OFPERR_OFPFMFC_UNKNOWN;
4714 /* Initialize base state. */
4715 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4716 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
4717 ovs_refcount_init(&rule->ref_count);
4718 rule->flow_cookie = fm->new_cookie;
4719 rule->created = rule->modified = time_msec();
4721 ovs_mutex_init(&rule->mutex);
4722 ovs_mutex_lock(&rule->mutex);
4723 rule->idle_timeout = fm->idle_timeout;
4724 rule->hard_timeout = fm->hard_timeout;
4725 *CONST_CAST(uint16_t *, &rule->importance) = fm->importance;
4726 rule->removed_reason = OVS_OFPRR_NONE;
4728 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
4729 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4730 *CONST_CAST(const struct rule_actions **, &rule->actions)
4731 = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4732 list_init(&rule->meter_list_node);
4733 rule->eviction_group = NULL;
4734 list_init(&rule->expirable);
4735 rule->monitor_flags = 0;
4736 rule->add_seqno = 0;
4737 rule->modify_seqno = 0;
4739 /* Copy values from old rule for modify semantics. */
4740 if (old_rule && fm->delete_reason != OFPRR_EVICTION) {
4741 bool change_cookie = (fm->modify_cookie
4742 && fm->new_cookie != OVS_BE64_MAX
4743 && fm->new_cookie != old_rule->flow_cookie);
4745 ovs_mutex_lock(&old_rule->mutex);
4746 if (fm->command != OFPFC_ADD) {
4747 rule->idle_timeout = old_rule->idle_timeout;
4748 rule->hard_timeout = old_rule->hard_timeout;
4749 *CONST_CAST(uint16_t *, &rule->importance) = old_rule->importance;
4750 rule->flags = old_rule->flags;
4751 rule->created = old_rule->created;
4753 if (!change_cookie) {
4754 rule->flow_cookie = old_rule->flow_cookie;
4756 ovs_mutex_unlock(&old_rule->mutex);
4758 ovs_mutex_unlock(&rule->mutex);
4760 /* Construct rule, initializing derived state. */
4761 error = ofproto->ofproto_class->rule_construct(rule);
4763 ofproto_rule_destroy__(rule);
4767 rule->removed = true; /* Not yet in ofproto data structures. */
4774 replace_rule_start(struct ofproto *ofproto, cls_version_t version,
4775 struct rule *old_rule, struct rule *new_rule,
4776 struct cls_conjunction *conjs, size_t n_conjs)
4778 struct oftable *table = &ofproto->tables[new_rule->table_id];
4780 /* 'old_rule' may be either an evicted rule or replaced rule. */
4782 /* Mark the old rule for removal in the next version. */
4783 cls_rule_make_invisible_in_version(&old_rule->cr, version);
4787 /* Insert flow to the classifier, so that later flow_mods may relate
4788 * to it. This is reversible, in case later errors require this to
4790 ofproto_rule_insert__(ofproto, new_rule);
4791 /* Make the new rule visible for classifier lookups only from the next
4793 classifier_insert(&table->cls, &new_rule->cr, version, conjs, n_conjs);
4796 static void replace_rule_revert(struct ofproto *ofproto,
4797 struct rule *old_rule, struct rule *new_rule)
4799 struct oftable *table = &ofproto->tables[new_rule->table_id];
4802 /* Restore the original visibility of the old rule. */
4803 cls_rule_restore_visibility(&old_rule->cr);
4805 /* Restore table's rule count. */
4809 /* Remove the new rule immediately. It was never visible to lookups. */
4810 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4813 ofproto_rule_remove__(ofproto, new_rule);
4814 /* The rule was not inserted to the ofproto provider, so we can
4815 * release it without deleting it from the ofproto provider. */
4816 ofproto_rule_unref(new_rule);
4819 /* Adds the 'new_rule', replacing the 'old_rule'. */
4821 replace_rule_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4822 const struct flow_mod_requester *req,
4823 struct rule *old_rule, struct rule *new_rule,
4824 struct ovs_list *dead_cookies)
4825 OVS_REQUIRES(ofproto_mutex)
4827 bool forward_stats = !(fm->flags & OFPUTIL_FF_RESET_COUNTS);
4828 struct rule *replaced_rule;
4830 replaced_rule = fm->delete_reason != OFPRR_EVICTION ? old_rule : NULL;
4832 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4833 * is a duplicate rule the 'new_rule' is replacing. The provider should
4834 * link the stats from the old rule to the new one if 'forward_stats' is
4835 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4836 ofproto->ofproto_class->rule_insert(new_rule, replaced_rule,
4838 learned_cookies_inc(ofproto, rule_get_actions(new_rule));
4841 const struct rule_actions *old_actions = rule_get_actions(old_rule);
4843 /* Remove the old rule from data structures. Removal from the
4844 * classifier and the deletion of the rule is RCU postponed by the
4846 ofproto_rule_remove__(ofproto, old_rule);
4847 learned_cookies_dec(ofproto, old_actions, dead_cookies);
4849 if (replaced_rule) {
4850 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4851 ? NXFME_ADDED : NXFME_MODIFIED;
4853 bool change_cookie = (fm->modify_cookie
4854 && fm->new_cookie != OVS_BE64_MAX
4855 && fm->new_cookie != old_rule->flow_cookie);
4857 bool change_actions = !ofpacts_equal(fm->ofpacts,
4859 old_actions->ofpacts,
4860 old_actions->ofpacts_len);
4862 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4863 ofmonitor_report(ofproto->connmgr, new_rule, event, 0,
4864 req ? req->ofconn : NULL,
4865 req ? req->request->xid : 0,
4866 change_actions ? old_actions : NULL);
4869 /* XXX: This is slight duplication with delete_flows_finish__() */
4871 old_rule->removed_reason = OFPRR_EVICTION;
4873 ofmonitor_report(ofproto->connmgr, old_rule, NXFME_DELETED,
4875 req ? req->ofconn : NULL,
4876 req ? req->request->xid : 0, NULL);
4882 modify_flows_start__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4883 OVS_REQUIRES(ofproto_mutex)
4885 struct ofputil_flow_mod *fm = &ofm->fm;
4886 struct rule_collection *old_rules = &ofm->old_rules;
4887 struct rule_collection *new_rules = &ofm->new_rules;
4890 rule_collection_init(new_rules);
4892 if (old_rules->n > 0) {
4893 struct cls_conjunction *conjs;
4897 /* Create a new 'modified' rule for each old rule. */
4898 for (i = 0; i < old_rules->n; i++) {
4899 struct rule *old_rule = old_rules->rules[i];
4900 struct rule *new_rule;
4903 cls_rule_clone(&cr, &old_rule->cr);
4904 error = replace_rule_create(ofproto, fm, &cr, old_rule->table_id,
4905 old_rule, &new_rule);
4907 rule_collection_add(new_rules, new_rule);
4909 rule_collection_unref(new_rules);
4910 rule_collection_destroy(new_rules);
4914 ovs_assert(new_rules->n == old_rules->n);
4916 get_conjunctions(fm, &conjs, &n_conjs);
4917 for (i = 0; i < old_rules->n; i++) {
4918 replace_rule_start(ofproto, ofm->version, old_rules->rules[i],
4919 new_rules->rules[i], conjs, n_conjs);
4922 } else if (!(fm->cookie_mask != htonll(0)
4923 || fm->new_cookie == OVS_BE64_MAX)) {
4924 /* No match, add a new flow. */
4925 error = add_flow_start(ofproto, ofm);
4927 ovs_assert(fm->delete_reason == OFPRR_EVICTION
4928 || !old_rules->rules[0]);
4938 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4941 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4944 modify_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4945 OVS_REQUIRES(ofproto_mutex)
4947 struct ofputil_flow_mod *fm = &ofm->fm;
4948 struct rule_collection *old_rules = &ofm->old_rules;
4949 struct rule_criteria criteria;
4952 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4953 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG_ANY);
4954 rule_criteria_require_rw(&criteria,
4955 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4956 error = collect_rules_loose(ofproto, &criteria, old_rules);
4957 rule_criteria_destroy(&criteria);
4960 error = modify_flows_start__(ofproto, ofm);
4964 rule_collection_destroy(old_rules);
4970 modify_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4971 OVS_REQUIRES(ofproto_mutex)
4973 struct rule_collection *old_rules = &ofm->old_rules;
4974 struct rule_collection *new_rules = &ofm->new_rules;
4976 /* Old rules were not changed yet, only need to revert new rules. */
4977 if (old_rules->n == 0 && new_rules->n == 1) {
4978 add_flow_revert(ofproto, ofm);
4979 } else if (old_rules->n > 0) {
4980 for (size_t i = 0; i < old_rules->n; i++) {
4981 replace_rule_revert(ofproto, old_rules->rules[i],
4982 new_rules->rules[i]);
4984 rule_collection_destroy(new_rules);
4985 rule_collection_destroy(old_rules);
4990 modify_flows_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4991 const struct flow_mod_requester *req)
4992 OVS_REQUIRES(ofproto_mutex)
4994 struct ofputil_flow_mod *fm = &ofm->fm;
4995 struct rule_collection *old_rules = &ofm->old_rules;
4996 struct rule_collection *new_rules = &ofm->new_rules;
4998 if (old_rules->n == 0 && new_rules->n == 1) {
4999 add_flow_finish(ofproto, ofm, req);
5000 } else if (old_rules->n > 0) {
5001 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
5003 ovs_assert(new_rules->n == old_rules->n);
5005 for (size_t i = 0; i < old_rules->n; i++) {
5006 replace_rule_finish(ofproto, fm, req, old_rules->rules[i],
5007 new_rules->rules[i], &dead_cookies);
5009 learned_cookies_flush(ofproto, &dead_cookies);
5010 rule_collection_remove_postponed(old_rules);
5012 send_buffered_packet(req, fm->buffer_id, new_rules->rules[0]);
5013 rule_collection_destroy(new_rules);
5017 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
5018 * code on failure. */
5020 modify_flow_start_strict(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5021 OVS_REQUIRES(ofproto_mutex)
5023 struct ofputil_flow_mod *fm = &ofm->fm;
5024 struct rule_collection *old_rules = &ofm->old_rules;
5025 struct rule_criteria criteria;
5028 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5029 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
5031 rule_criteria_require_rw(&criteria,
5032 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5033 error = collect_rules_strict(ofproto, &criteria, old_rules);
5034 rule_criteria_destroy(&criteria);
5037 /* collect_rules_strict() can return max 1 rule. */
5038 error = modify_flows_start__(ofproto, ofm);
5042 rule_collection_destroy(old_rules);
5047 /* OFPFC_DELETE implementation. */
5050 delete_flows_start__(struct ofproto *ofproto, cls_version_t version,
5051 const struct rule_collection *rules)
5052 OVS_REQUIRES(ofproto_mutex)
5054 for (size_t i = 0; i < rules->n; i++) {
5055 struct rule *rule = rules->rules[i];
5056 struct oftable *table = &ofproto->tables[rule->table_id];
5059 cls_rule_make_invisible_in_version(&rule->cr, version);
5064 delete_flows_finish__(struct ofproto *ofproto,
5065 struct rule_collection *rules,
5066 enum ofp_flow_removed_reason reason,
5067 const struct flow_mod_requester *req)
5068 OVS_REQUIRES(ofproto_mutex)
5071 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
5073 for (size_t i = 0; i < rules->n; i++) {
5074 struct rule *rule = rules->rules[i];
5076 /* This value will be used to send the flow removed message right
5077 * before the rule is actually destroyed. */
5078 rule->removed_reason = reason;
5080 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
5081 req ? req->ofconn : NULL,
5082 req ? req->request->xid : 0, NULL);
5083 ofproto_rule_remove__(ofproto, rule);
5084 learned_cookies_dec(ofproto, rule_get_actions(rule),
5087 rule_collection_remove_postponed(rules);
5089 learned_cookies_flush(ofproto, &dead_cookies);
5093 /* Deletes the rules listed in 'rules'.
5094 * The deleted rules will become invisible to the lookups in the next version.
5095 * Destroys 'rules'. */
5097 delete_flows__(struct rule_collection *rules,
5098 enum ofp_flow_removed_reason reason,
5099 const struct flow_mod_requester *req)
5100 OVS_REQUIRES(ofproto_mutex)
5103 struct ofproto *ofproto = rules->rules[0]->ofproto;
5105 delete_flows_start__(ofproto, ofproto->tables_version + 1, rules);
5106 ofproto_bump_tables_version(ofproto);
5107 delete_flows_finish__(ofproto, rules, reason, req);
5108 ofmonitor_flush(ofproto->connmgr);
5112 /* Implements OFPFC_DELETE. */
5114 delete_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5115 OVS_REQUIRES(ofproto_mutex)
5117 const struct ofputil_flow_mod *fm = &ofm->fm;
5118 struct rule_collection *rules = &ofm->old_rules;
5119 struct rule_criteria criteria;
5122 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
5123 fm->cookie, fm->cookie_mask, fm->out_port,
5125 rule_criteria_require_rw(&criteria,
5126 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5127 error = collect_rules_loose(ofproto, &criteria, rules);
5128 rule_criteria_destroy(&criteria);
5131 delete_flows_start__(ofproto, ofm->version, rules);
5138 delete_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5139 OVS_REQUIRES(ofproto_mutex)
5141 struct rule_collection *rules = &ofm->old_rules;
5143 for (size_t i = 0; i < rules->n; i++) {
5144 struct rule *rule = rules->rules[i];
5145 struct oftable *table = &ofproto->tables[rule->table_id];
5147 /* Restore table's rule count. */
5150 /* Restore the original visibility of the rule. */
5151 cls_rule_restore_visibility(&rule->cr);
5153 rule_collection_destroy(rules);
5157 delete_flows_finish(struct ofproto *ofproto,
5158 struct ofproto_flow_mod *ofm,
5159 const struct flow_mod_requester *req)
5160 OVS_REQUIRES(ofproto_mutex)
5162 delete_flows_finish__(ofproto, &ofm->old_rules, ofm->fm.delete_reason,
5166 /* Implements OFPFC_DELETE_STRICT. */
5168 delete_flow_start_strict(struct ofproto *ofproto,
5169 struct ofproto_flow_mod *ofm)
5170 OVS_REQUIRES(ofproto_mutex)
5172 const struct ofputil_flow_mod *fm = &ofm->fm;
5173 struct rule_collection *rules = &ofm->old_rules;
5174 struct rule_criteria criteria;
5177 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5178 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
5179 fm->out_port, fm->out_group);
5180 rule_criteria_require_rw(&criteria,
5181 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5182 error = collect_rules_strict(ofproto, &criteria, rules);
5183 rule_criteria_destroy(&criteria);
5186 delete_flows_start__(ofproto, ofm->version, rules);
5192 /* This may only be called by rule_destroy_cb()! */
5194 ofproto_rule_send_removed(struct rule *rule)
5195 OVS_EXCLUDED(ofproto_mutex)
5197 struct ofputil_flow_removed fr;
5200 minimatch_expand(&rule->cr.match, &fr.match);
5201 fr.priority = rule->cr.priority;
5203 ovs_mutex_lock(&ofproto_mutex);
5204 fr.cookie = rule->flow_cookie;
5205 fr.reason = rule->removed_reason;
5206 fr.table_id = rule->table_id;
5207 calc_duration(rule->created, time_msec(),
5208 &fr.duration_sec, &fr.duration_nsec);
5209 ovs_mutex_lock(&rule->mutex);
5210 fr.idle_timeout = rule->idle_timeout;
5211 fr.hard_timeout = rule->hard_timeout;
5212 ovs_mutex_unlock(&rule->mutex);
5213 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
5214 &fr.byte_count, &used);
5215 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
5216 ovs_mutex_unlock(&ofproto_mutex);
5219 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5220 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5223 * ofproto implementation ->run() functions should use this function to expire
5224 * OpenFlow flows. */
5226 ofproto_rule_expire(struct rule *rule, uint8_t reason)
5227 OVS_REQUIRES(ofproto_mutex)
5229 struct rule_collection rules;
5231 rules.rules = rules.stub;
5233 rules.stub[0] = rule;
5234 delete_flows__(&rules, reason, NULL);
5237 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5238 * means "infinite". */
5240 reduce_timeout(uint16_t max, uint16_t *timeout)
5242 if (max && (!*timeout || *timeout > max)) {
5247 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5248 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5249 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5251 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5253 ofproto_rule_reduce_timeouts(struct rule *rule,
5254 uint16_t idle_timeout, uint16_t hard_timeout)
5255 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5257 if (!idle_timeout && !hard_timeout) {
5261 ovs_mutex_lock(&ofproto_mutex);
5262 if (list_is_empty(&rule->expirable)) {
5263 list_insert(&rule->ofproto->expirable, &rule->expirable);
5265 ovs_mutex_unlock(&ofproto_mutex);
5267 ovs_mutex_lock(&rule->mutex);
5268 reduce_timeout(idle_timeout, &rule->idle_timeout);
5269 reduce_timeout(hard_timeout, &rule->hard_timeout);
5270 ovs_mutex_unlock(&rule->mutex);
5274 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5275 OVS_EXCLUDED(ofproto_mutex)
5277 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5278 struct ofproto_flow_mod ofm;
5279 uint64_t ofpacts_stub[1024 / 8];
5280 struct ofpbuf ofpacts;
5283 error = reject_slave_controller(ofconn);
5288 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5289 error = ofputil_decode_flow_mod(&ofm.fm, oh, ofconn_get_protocol(ofconn),
5291 u16_to_ofp(ofproto->max_ports),
5294 error = ofproto_check_ofpacts(ofproto, ofm.fm.ofpacts,
5295 ofm.fm.ofpacts_len);
5298 struct flow_mod_requester req;
5300 req.ofconn = ofconn;
5302 error = handle_flow_mod__(ofproto, &ofm, &req);
5305 goto exit_free_ofpacts;
5308 ofconn_report_flow_mod(ofconn, ofm.fm.command);
5311 ofpbuf_uninit(&ofpacts);
5317 handle_flow_mod__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
5318 const struct flow_mod_requester *req)
5319 OVS_EXCLUDED(ofproto_mutex)
5323 ovs_mutex_lock(&ofproto_mutex);
5324 ofm->version = ofproto->tables_version + 1;
5325 error = ofproto_flow_mod_start(ofproto, ofm);
5327 ofproto_bump_tables_version(ofproto);
5328 ofproto_flow_mod_finish(ofproto, ofm, req);
5330 ofmonitor_flush(ofproto->connmgr);
5331 ovs_mutex_unlock(&ofproto_mutex);
5333 run_rule_executes(ofproto);
5338 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5340 struct ofputil_role_request request;
5341 struct ofputil_role_request reply;
5345 error = ofputil_decode_role_message(oh, &request);
5350 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5351 if (request.role != OFPCR12_ROLE_EQUAL
5352 && request.have_generation_id
5353 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5354 return OFPERR_OFPRRFC_STALE;
5357 ofconn_set_role(ofconn, request.role);
5360 reply.role = ofconn_get_role(ofconn);
5361 reply.have_generation_id = ofconn_get_master_election_id(
5362 ofconn, &reply.generation_id);
5363 buf = ofputil_encode_role_reply(oh, &reply);
5364 ofconn_send_reply(ofconn, buf);
5370 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5371 const struct ofp_header *oh)
5373 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5374 enum ofputil_protocol cur, next;
5376 cur = ofconn_get_protocol(ofconn);
5377 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5378 ofconn_set_protocol(ofconn, next);
5384 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5386 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5387 enum ofputil_protocol cur, next;
5388 enum ofputil_protocol next_base;
5390 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5392 return OFPERR_OFPBRC_EPERM;
5395 cur = ofconn_get_protocol(ofconn);
5396 next = ofputil_protocol_set_base(cur, next_base);
5397 ofconn_set_protocol(ofconn, next);
5403 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5404 const struct ofp_header *oh)
5406 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5409 format = ntohl(msg->format);
5410 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5411 return OFPERR_OFPBRC_EPERM;
5414 ofconn_set_packet_in_format(ofconn, format);
5419 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5422 uint32_t master[OAM_N_TYPES] = {0};
5423 uint32_t slave[OAM_N_TYPES] = {0};
5425 error = ofputil_decode_set_async_config(oh, master, slave, false);
5430 ofconn_set_async_config(ofconn, master, slave);
5431 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5432 !ofconn_get_miss_send_len(ofconn)) {
5433 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5440 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5443 uint32_t master[OAM_N_TYPES];
5444 uint32_t slave[OAM_N_TYPES];
5446 ofconn_get_async_config(ofconn, master, slave);
5448 buf = ofputil_encode_get_async_config(oh, master, slave);
5449 ofconn_send_reply(ofconn, buf);
5455 handle_nxt_set_controller_id(struct ofconn *ofconn,
5456 const struct ofp_header *oh)
5458 const struct nx_controller_id *nci = ofpmsg_body(oh);
5460 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5461 return OFPERR_NXBRC_MUST_BE_ZERO;
5464 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5469 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5473 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5474 ? OFPRAW_OFPT10_BARRIER_REPLY
5475 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5476 ofconn_send_reply(ofconn, buf);
5481 ofproto_compose_flow_refresh_update(const struct rule *rule,
5482 enum nx_flow_monitor_flags flags,
5483 struct ovs_list *msgs)
5484 OVS_REQUIRES(ofproto_mutex)
5486 const struct rule_actions *actions;
5487 struct ofputil_flow_update fu;
5490 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5491 ? NXFME_ADDED : NXFME_MODIFIED);
5493 ovs_mutex_lock(&rule->mutex);
5494 fu.idle_timeout = rule->idle_timeout;
5495 fu.hard_timeout = rule->hard_timeout;
5496 ovs_mutex_unlock(&rule->mutex);
5497 fu.table_id = rule->table_id;
5498 fu.cookie = rule->flow_cookie;
5499 minimatch_expand(&rule->cr.match, &match);
5501 fu.priority = rule->cr.priority;
5503 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5504 fu.ofpacts = actions ? actions->ofpacts : NULL;
5505 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5507 if (list_is_empty(msgs)) {
5508 ofputil_start_flow_update(msgs);
5510 ofputil_append_flow_update(&fu, msgs);
5514 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5515 struct ovs_list *msgs)
5516 OVS_REQUIRES(ofproto_mutex)
5520 for (i = 0; i < rules->n; i++) {
5521 struct rule *rule = rules->rules[i];
5522 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5523 rule->monitor_flags = 0;
5525 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5530 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5531 struct rule *rule, uint64_t seqno,
5532 struct rule_collection *rules)
5533 OVS_REQUIRES(ofproto_mutex)
5535 enum nx_flow_monitor_flags update;
5537 if (rule_is_hidden(rule)) {
5541 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5546 if (rule->add_seqno > seqno) {
5547 update = NXFMF_ADD | NXFMF_MODIFY;
5548 } else if (rule->modify_seqno > seqno) {
5549 update = NXFMF_MODIFY;
5554 if (!(m->flags & update)) {
5558 update = NXFMF_INITIAL;
5561 if (!rule->monitor_flags) {
5562 rule_collection_add(rules, rule);
5564 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5568 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5570 struct rule_collection *rules)
5571 OVS_REQUIRES(ofproto_mutex)
5573 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5574 const struct oftable *table;
5575 struct cls_rule target;
5577 cls_rule_init_from_minimatch(&target, &m->match, 0);
5578 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5581 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target, CLS_MAX_VERSION) {
5582 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5585 cls_rule_destroy(&target);
5589 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5590 struct rule_collection *rules)
5591 OVS_REQUIRES(ofproto_mutex)
5593 if (m->flags & NXFMF_INITIAL) {
5594 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5599 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5600 uint64_t seqno, struct rule_collection *rules)
5601 OVS_REQUIRES(ofproto_mutex)
5603 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5607 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5608 OVS_REQUIRES(ofproto_mutex)
5610 struct ofmonitor *m;
5613 m = ofmonitor_lookup(ofconn, id);
5615 ofmonitor_destroy(m);
5618 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5625 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5626 OVS_EXCLUDED(ofproto_mutex)
5628 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5629 struct ofmonitor **monitors;
5630 size_t n_monitors, allocated_monitors;
5631 struct rule_collection rules;
5632 struct ovs_list replies;
5637 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5639 n_monitors = allocated_monitors = 0;
5641 ovs_mutex_lock(&ofproto_mutex);
5643 struct ofputil_flow_monitor_request request;
5644 struct ofmonitor *m;
5647 retval = ofputil_decode_flow_monitor_request(&request, &b);
5648 if (retval == EOF) {
5650 } else if (retval) {
5655 if (request.table_id != 0xff
5656 && request.table_id >= ofproto->n_tables) {
5657 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5661 error = ofmonitor_create(&request, ofconn, &m);
5666 if (n_monitors >= allocated_monitors) {
5667 monitors = x2nrealloc(monitors, &allocated_monitors,
5670 monitors[n_monitors++] = m;
5673 rule_collection_init(&rules);
5674 for (i = 0; i < n_monitors; i++) {
5675 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5678 ofpmp_init(&replies, oh);
5679 ofmonitor_compose_refresh_updates(&rules, &replies);
5680 ovs_mutex_unlock(&ofproto_mutex);
5682 rule_collection_destroy(&rules);
5684 ofconn_send_replies(ofconn, &replies);
5690 for (i = 0; i < n_monitors; i++) {
5691 ofmonitor_destroy(monitors[i]);
5694 ovs_mutex_unlock(&ofproto_mutex);
5700 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5701 OVS_EXCLUDED(ofproto_mutex)
5706 id = ofputil_decode_flow_monitor_cancel(oh);
5708 ovs_mutex_lock(&ofproto_mutex);
5709 error = flow_monitor_delete(ofconn, id);
5710 ovs_mutex_unlock(&ofproto_mutex);
5715 /* Meters implementation.
5717 * Meter table entry, indexed by the OpenFlow meter_id.
5718 * 'created' is used to compute the duration for meter stats.
5719 * 'list rules' is needed so that we can delete the dependent rules when the
5720 * meter table entry is deleted.
5721 * 'provider_meter_id' is for the provider's private use.
5724 long long int created; /* Time created. */
5725 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5726 ofproto_meter_id provider_meter_id;
5727 uint16_t flags; /* Meter flags. */
5728 uint16_t n_bands; /* Number of meter bands. */
5729 struct ofputil_meter_band *bands;
5733 * This is used in instruction validation at flow set-up time,
5734 * as flows may not use non-existing meters.
5735 * Return value of UINT32_MAX signifies an invalid meter.
5738 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5740 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5741 const struct meter *meter = ofproto->meters[of_meter_id];
5743 return meter->provider_meter_id.uint32;
5749 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5752 meter_insert_rule(struct rule *rule)
5754 const struct rule_actions *a = rule_get_actions(rule);
5755 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5756 struct meter *meter = rule->ofproto->meters[meter_id];
5758 list_insert(&meter->rules, &rule->meter_list_node);
5762 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5766 meter->flags = config->flags;
5767 meter->n_bands = config->n_bands;
5768 meter->bands = xmemdup(config->bands,
5769 config->n_bands * sizeof *meter->bands);
5772 static struct meter *
5773 meter_create(const struct ofputil_meter_config *config,
5774 ofproto_meter_id provider_meter_id)
5776 struct meter *meter;
5778 meter = xzalloc(sizeof *meter);
5779 meter->provider_meter_id = provider_meter_id;
5780 meter->created = time_msec();
5781 list_init(&meter->rules);
5783 meter_update(meter, config);
5789 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5790 OVS_REQUIRES(ofproto_mutex)
5793 for (mid = first; mid <= last; ++mid) {
5794 struct meter *meter = ofproto->meters[mid];
5796 ofproto->meters[mid] = NULL;
5797 ofproto->ofproto_class->meter_del(ofproto,
5798 meter->provider_meter_id);
5806 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5808 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5809 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5813 return OFPERR_OFPMMFC_METER_EXISTS;
5816 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5819 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5820 *meterp = meter_create(&mm->meter, provider_meter_id);
5826 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5828 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5830 uint32_t provider_meter_id;
5833 return OFPERR_OFPMMFC_UNKNOWN_METER;
5836 provider_meter_id = meter->provider_meter_id.uint32;
5837 error = ofproto->ofproto_class->meter_set(ofproto,
5838 &meter->provider_meter_id,
5840 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5842 meter_update(meter, &mm->meter);
5848 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5849 OVS_EXCLUDED(ofproto_mutex)
5851 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5852 uint32_t meter_id = mm->meter.meter_id;
5853 struct rule_collection rules;
5854 enum ofperr error = 0;
5855 uint32_t first, last;
5857 if (meter_id == OFPM13_ALL) {
5859 last = ofproto->meter_features.max_meters;
5861 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5864 first = last = meter_id;
5867 /* First delete the rules that use this meter. If any of those rules are
5868 * currently being modified, postpone the whole operation until later. */
5869 rule_collection_init(&rules);
5870 ovs_mutex_lock(&ofproto_mutex);
5871 for (meter_id = first; meter_id <= last; ++meter_id) {
5872 struct meter *meter = ofproto->meters[meter_id];
5873 if (meter && !list_is_empty(&meter->rules)) {
5876 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5877 rule_collection_add(&rules, rule);
5881 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5883 /* Delete the meters. */
5884 meter_delete(ofproto, first, last);
5886 ovs_mutex_unlock(&ofproto_mutex);
5892 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5894 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5895 struct ofputil_meter_mod mm;
5896 uint64_t bands_stub[256 / 8];
5897 struct ofpbuf bands;
5901 error = reject_slave_controller(ofconn);
5906 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5908 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5910 goto exit_free_bands;
5913 meter_id = mm.meter.meter_id;
5915 if (mm.command != OFPMC13_DELETE) {
5916 /* Fails also when meters are not implemented by the provider. */
5917 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5918 error = OFPERR_OFPMMFC_INVALID_METER;
5919 goto exit_free_bands;
5920 } else if (meter_id > ofproto->meter_features.max_meters) {
5921 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5922 goto exit_free_bands;
5924 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5925 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5926 goto exit_free_bands;
5930 switch (mm.command) {
5932 error = handle_add_meter(ofproto, &mm);
5935 case OFPMC13_MODIFY:
5936 error = handle_modify_meter(ofproto, &mm);
5939 case OFPMC13_DELETE:
5940 error = handle_delete_meter(ofconn, &mm);
5944 error = OFPERR_OFPMMFC_BAD_COMMAND;
5949 struct ofputil_requestforward rf;
5951 rf.reason = OFPRFR_METER_MOD;
5953 connmgr_send_requestforward(ofproto->connmgr, ofconn, &rf);
5957 ofpbuf_uninit(&bands);
5962 handle_meter_features_request(struct ofconn *ofconn,
5963 const struct ofp_header *request)
5965 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5966 struct ofputil_meter_features features;
5969 if (ofproto->ofproto_class->meter_get_features) {
5970 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5972 memset(&features, 0, sizeof features);
5974 b = ofputil_encode_meter_features_reply(&features, request);
5976 ofconn_send_reply(ofconn, b);
5981 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5984 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5985 struct ovs_list replies;
5986 uint64_t bands_stub[256 / 8];
5987 struct ofpbuf bands;
5988 uint32_t meter_id, first, last;
5990 ofputil_decode_meter_request(request, &meter_id);
5992 if (meter_id == OFPM13_ALL) {
5994 last = ofproto->meter_features.max_meters;
5996 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5997 !ofproto->meters[meter_id]) {
5998 return OFPERR_OFPMMFC_UNKNOWN_METER;
6000 first = last = meter_id;
6003 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
6004 ofpmp_init(&replies, request);
6006 for (meter_id = first; meter_id <= last; ++meter_id) {
6007 struct meter *meter = ofproto->meters[meter_id];
6009 continue; /* Skip non-existing meters. */
6011 if (type == OFPTYPE_METER_STATS_REQUEST) {
6012 struct ofputil_meter_stats stats;
6014 stats.meter_id = meter_id;
6016 /* Provider sets the packet and byte counts, we do the rest. */
6017 stats.flow_count = list_size(&meter->rules);
6018 calc_duration(meter->created, time_msec(),
6019 &stats.duration_sec, &stats.duration_nsec);
6020 stats.n_bands = meter->n_bands;
6021 ofpbuf_clear(&bands);
6023 = ofpbuf_put_uninit(&bands,
6024 meter->n_bands * sizeof *stats.bands);
6026 if (!ofproto->ofproto_class->meter_get(ofproto,
6027 meter->provider_meter_id,
6029 ofputil_append_meter_stats(&replies, &stats);
6031 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
6032 struct ofputil_meter_config config;
6034 config.meter_id = meter_id;
6035 config.flags = meter->flags;
6036 config.n_bands = meter->n_bands;
6037 config.bands = meter->bands;
6038 ofputil_append_meter_config(&replies, &config);
6042 ofconn_send_replies(ofconn, &replies);
6043 ofpbuf_uninit(&bands);
6048 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
6049 struct ofgroup **group)
6050 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6052 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
6053 hash_int(group_id, 0), &ofproto->groups) {
6054 if ((*group)->group_id == group_id) {
6062 /* If the group exists, this function increments the groups's reference count.
6064 * Make sure to call ofproto_group_unref() after no longer needing to maintain
6065 * a reference to the group. */
6067 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
6068 struct ofgroup **group)
6072 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6073 found = ofproto_group_lookup__(ofproto, group_id, group);
6075 ofproto_group_ref(*group);
6077 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6082 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
6083 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6085 struct ofgroup *grp;
6087 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
6088 hash_int(group_id, 0), &ofproto->groups) {
6089 if (grp->group_id == group_id) {
6097 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
6098 OVS_EXCLUDED(ofproto->groups_rwlock)
6102 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6103 exists = ofproto_group_exists__(ofproto, group_id);
6104 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6110 group_get_ref_count(struct ofgroup *group)
6111 OVS_EXCLUDED(ofproto_mutex)
6113 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
6114 struct rule_criteria criteria;
6115 struct rule_collection rules;
6120 match_init_catchall(&match);
6121 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
6122 htonll(0), OFPP_ANY, group->group_id);
6123 ovs_mutex_lock(&ofproto_mutex);
6124 error = collect_rules_loose(ofproto, &criteria, &rules);
6125 ovs_mutex_unlock(&ofproto_mutex);
6126 rule_criteria_destroy(&criteria);
6128 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
6130 rule_collection_destroy(&rules);
6135 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
6137 struct ofputil_group_stats ogs;
6138 const struct ofproto *ofproto = group->ofproto;
6139 long long int now = time_msec();
6142 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
6144 /* Provider sets the packet and byte counts, we do the rest. */
6145 ogs.ref_count = group_get_ref_count(group);
6146 ogs.n_buckets = group->n_buckets;
6148 error = (ofproto->ofproto_class->group_get_stats
6149 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
6152 ogs.packet_count = UINT64_MAX;
6153 ogs.byte_count = UINT64_MAX;
6154 memset(ogs.bucket_stats, 0xff,
6155 ogs.n_buckets * sizeof *ogs.bucket_stats);
6158 ogs.group_id = group->group_id;
6159 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
6161 ofputil_append_group_stats(replies, &ogs);
6163 free(ogs.bucket_stats);
6167 handle_group_request(struct ofconn *ofconn,
6168 const struct ofp_header *request, uint32_t group_id,
6169 void (*cb)(struct ofgroup *, struct ovs_list *replies))
6171 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6172 struct ofgroup *group;
6173 struct ovs_list replies;
6175 ofpmp_init(&replies, request);
6176 if (group_id == OFPG_ALL) {
6177 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6178 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
6179 cb(group, &replies);
6181 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6183 if (ofproto_group_lookup(ofproto, group_id, &group)) {
6184 cb(group, &replies);
6185 ofproto_group_unref(group);
6188 ofconn_send_replies(ofconn, &replies);
6192 handle_group_stats_request(struct ofconn *ofconn,
6193 const struct ofp_header *request)
6198 error = ofputil_decode_group_stats_request(request, &group_id);
6203 handle_group_request(ofconn, request, group_id, append_group_stats);
6208 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
6210 struct ofputil_group_desc gds;
6212 gds.group_id = group->group_id;
6213 gds.type = group->type;
6214 gds.props = group->props;
6216 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
6220 handle_group_desc_stats_request(struct ofconn *ofconn,
6221 const struct ofp_header *request)
6223 handle_group_request(ofconn, request,
6224 ofputil_decode_group_desc_request(request),
6230 handle_group_features_stats_request(struct ofconn *ofconn,
6231 const struct ofp_header *request)
6233 struct ofproto *p = ofconn_get_ofproto(ofconn);
6236 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6238 ofconn_send_reply(ofconn, msg);
6245 handle_queue_get_config_request(struct ofconn *ofconn,
6246 const struct ofp_header *oh)
6248 struct ofproto *p = ofconn_get_ofproto(ofconn);
6249 struct netdev_queue_dump queue_dump;
6250 struct ofport *ofport;
6251 unsigned int queue_id;
6252 struct ofpbuf *reply;
6253 struct smap details;
6257 error = ofputil_decode_queue_get_config_request(oh, &request);
6262 ofport = ofproto_get_port(p, request);
6264 return OFPERR_OFPQOFC_BAD_PORT;
6267 reply = ofputil_encode_queue_get_config_reply(oh);
6269 smap_init(&details);
6270 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6271 struct ofputil_queue_config queue;
6273 /* None of the existing queues have compatible properties, so we
6274 * hard-code omitting min_rate and max_rate. */
6275 queue.queue_id = queue_id;
6276 queue.min_rate = UINT16_MAX;
6277 queue.max_rate = UINT16_MAX;
6278 ofputil_append_queue_get_config_reply(reply, &queue);
6280 smap_destroy(&details);
6282 ofconn_send_reply(ofconn, reply);
6288 init_group(struct ofproto *ofproto, const struct ofputil_group_mod *gm,
6289 struct ofgroup **ofgroup)
6292 const long long int now = time_msec();
6294 if (gm->group_id > OFPG_MAX) {
6295 return OFPERR_OFPGMFC_INVALID_GROUP;
6297 if (gm->type > OFPGT11_FF) {
6298 return OFPERR_OFPGMFC_BAD_TYPE;
6301 *ofgroup = ofproto->ofproto_class->group_alloc();
6303 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6304 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6307 (*ofgroup)->ofproto = ofproto;
6308 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6309 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6310 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6311 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6312 ovs_refcount_init(&(*ofgroup)->ref_count);
6314 list_init(&(*ofgroup)->buckets);
6315 ofputil_bucket_clone_list(&(*ofgroup)->buckets, &gm->buckets, NULL);
6317 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6318 list_size(&(*ofgroup)->buckets);
6320 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6321 &gm->props, sizeof (struct ofputil_group_props));
6323 /* Construct called BEFORE any locks are held. */
6324 error = ofproto->ofproto_class->group_construct(*ofgroup);
6326 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6327 ofproto->ofproto_class->group_dealloc(*ofgroup);
6332 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6333 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6336 add_group(struct ofproto *ofproto, const struct ofputil_group_mod *gm)
6338 struct ofgroup *ofgroup;
6341 /* Allocate new group and initialize it. */
6342 error = init_group(ofproto, gm, &ofgroup);
6347 /* We wrlock as late as possible to minimize the time we jam any other
6348 * threads: No visible state changes before acquiring the lock. */
6349 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6351 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6352 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6356 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6357 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6362 /* Insert new group. */
6363 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6364 hash_int(ofgroup->group_id, 0));
6365 ofproto->n_groups[ofgroup->type]++;
6367 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6372 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6373 ofproto->ofproto_class->group_destruct(ofgroup);
6374 ofputil_bucket_list_destroy(&ofgroup->buckets);
6375 ofproto->ofproto_class->group_dealloc(ofgroup);
6380 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6381 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6382 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6383 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6386 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6387 struct ofgroup *new_ofgroup,
6388 uint32_t command_bucket_id)
6390 struct ofputil_bucket *last = NULL;
6392 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6393 /* Check here to ensure that a bucket corresponding to
6394 * command_bucket_id exists in the old bucket list.
6396 * The subsequent search of below of new_ofgroup covers
6397 * both buckets in the old bucket list and buckets added
6398 * by the insert buckets group mod message this function processes. */
6399 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6400 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6403 if (!list_is_empty(&new_ofgroup->buckets)) {
6404 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6408 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6410 if (ofputil_bucket_check_duplicate_id(&new_ofgroup->buckets)) {
6411 VLOG_INFO_RL(&rl, "Duplicate bucket id");
6412 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6415 /* Rearrange list according to command_bucket_id */
6416 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6417 if (!list_is_empty(&ofgroup->buckets)) {
6418 struct ofputil_bucket *new_first;
6419 const struct ofputil_bucket *first;
6421 first = ofputil_bucket_list_front(&ofgroup->buckets);
6422 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6425 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6426 &new_ofgroup->buckets);
6428 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6429 struct ofputil_bucket *after;
6431 /* Presence of bucket is checked above so after should never be NULL */
6432 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6434 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6435 last->list_node.next);
6441 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6442 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6443 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6444 * and OFPG15_BUCKET_ALL are also honored. */
6446 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6447 struct ofgroup *new_ofgroup,
6448 uint32_t command_bucket_id)
6450 const struct ofputil_bucket *skip = NULL;
6452 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6456 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6457 if (!list_is_empty(&ofgroup->buckets)) {
6458 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6460 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6461 if (!list_is_empty(&ofgroup->buckets)) {
6462 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6465 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6467 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6471 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6476 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6477 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6480 * Note that the group is re-created and then replaces the old group in
6481 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6482 * the xlate module hold a pointer to the group. */
6484 modify_group(struct ofproto *ofproto, const struct ofputil_group_mod *gm)
6486 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6489 error = init_group(ofproto, gm, &new_ofgroup);
6494 retiring = new_ofgroup;
6496 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6497 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6498 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6502 /* Ofproto's group write lock is held now. */
6503 if (ofgroup->type != gm->type
6504 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6505 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6509 /* Manipulate bucket list for bucket commands */
6510 if (gm->command == OFPGC15_INSERT_BUCKET) {
6511 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6512 gm->command_bucket_id);
6513 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6514 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6515 gm->command_bucket_id);
6521 /* The group creation time does not change during modification. */
6522 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6523 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6525 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6531 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6532 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6533 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6534 hash_int(new_ofgroup->group_id, 0));
6535 if (ofgroup->type != new_ofgroup->type) {
6536 ofproto->n_groups[ofgroup->type]--;
6537 ofproto->n_groups[new_ofgroup->type]++;
6541 ofproto_group_unref(retiring);
6542 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6547 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6548 OVS_RELEASES(ofproto->groups_rwlock)
6551 struct ofproto_flow_mod ofm;
6553 /* Delete all flow entries containing this group in a group action */
6554 match_init_catchall(&match);
6555 flow_mod_init(&ofm.fm, &match, 0, NULL, 0, OFPFC_DELETE);
6556 ofm.fm.delete_reason = OFPRR_GROUP_DELETE;
6557 ofm.fm.out_group = ofgroup->group_id;
6558 ofm.fm.table_id = OFPTT_ALL;
6559 handle_flow_mod__(ofproto, &ofm, NULL);
6561 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6562 /* No-one can find this group any more. */
6563 ofproto->n_groups[ofgroup->type]--;
6564 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6565 ofproto_group_unref(ofgroup);
6568 /* Implements OFPGC11_DELETE. */
6570 delete_group(struct ofproto *ofproto, uint32_t group_id)
6572 struct ofgroup *ofgroup;
6574 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6575 if (group_id == OFPG_ALL) {
6577 struct hmap_node *node = hmap_first(&ofproto->groups);
6581 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6582 delete_group__(ofproto, ofgroup);
6583 /* Lock for each node separately, so that we will not jam the
6584 * other threads for too long time. */
6585 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6588 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6589 hash_int(group_id, 0), &ofproto->groups) {
6590 if (ofgroup->group_id == group_id) {
6591 delete_group__(ofproto, ofgroup);
6596 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6599 /* Delete all groups from 'ofproto'.
6601 * This is intended for use within an ofproto provider's 'destruct'
6604 ofproto_group_delete_all(struct ofproto *ofproto)
6606 delete_group(ofproto, OFPG_ALL);
6610 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6612 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6613 struct ofputil_group_mod gm;
6616 error = reject_slave_controller(ofconn);
6621 error = ofputil_decode_group_mod(oh, &gm);
6626 switch (gm.command) {
6628 error = add_group(ofproto, &gm);
6631 case OFPGC11_MODIFY:
6632 error = modify_group(ofproto, &gm);
6635 case OFPGC11_DELETE:
6636 delete_group(ofproto, gm.group_id);
6640 case OFPGC15_INSERT_BUCKET:
6641 error = modify_group(ofproto, &gm);
6644 case OFPGC15_REMOVE_BUCKET:
6645 error = modify_group(ofproto, &gm);
6649 if (gm.command > OFPGC11_DELETE) {
6650 VLOG_INFO_RL(&rl, "%s: Invalid group_mod command type %d",
6651 ofproto->name, gm.command);
6653 error = OFPERR_OFPGMFC_BAD_COMMAND;
6657 struct ofputil_requestforward rf;
6659 rf.reason = OFPRFR_GROUP_MOD;
6661 connmgr_send_requestforward(ofproto->connmgr, ofconn, &rf);
6663 ofputil_bucket_list_destroy(&gm.buckets);
6668 enum ofputil_table_miss
6669 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6671 enum ofputil_table_miss miss;
6673 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &miss);
6678 table_mod__(struct oftable *oftable,
6679 const struct ofputil_table_mod *tm)
6681 if (tm->miss == OFPUTIL_TABLE_MISS_DEFAULT) {
6682 /* This is how an OFPT_TABLE_MOD decodes if it doesn't specify any
6683 * table-miss configuration (because the protocol used doesn't have
6684 * such a concept), so there's nothing to do. */
6686 atomic_store_relaxed(&oftable->miss_config, tm->miss);
6689 unsigned int new_eviction = oftable->eviction;
6690 if (tm->eviction == OFPUTIL_TABLE_EVICTION_ON) {
6691 new_eviction |= EVICTION_OPENFLOW;
6692 } else if (tm->eviction == OFPUTIL_TABLE_EVICTION_OFF) {
6693 new_eviction &= ~EVICTION_OPENFLOW;
6696 if (new_eviction != oftable->eviction) {
6697 ovs_mutex_lock(&ofproto_mutex);
6698 oftable_configure_eviction(oftable, new_eviction,
6699 oftable->eviction_fields,
6700 oftable->n_eviction_fields);
6701 ovs_mutex_unlock(&ofproto_mutex);
6704 if (tm->vacancy != OFPUTIL_TABLE_VACANCY_DEFAULT) {
6705 ovs_mutex_lock(&ofproto_mutex);
6706 oftable->vacancy_enabled = (tm->vacancy == OFPUTIL_TABLE_VACANCY_ON
6707 ? OFPTC14_VACANCY_EVENTS
6709 oftable->vacancy_down = tm->table_vacancy.vacancy_down;
6710 oftable->vacancy_up = tm->table_vacancy.vacancy_up;
6711 ovs_mutex_unlock(&ofproto_mutex);
6716 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6718 if (!check_table_id(ofproto, tm->table_id)) {
6719 return OFPERR_OFPTMFC_BAD_TABLE;
6722 /* Don't allow the eviction flags to be changed (except to the only fixed
6723 * value that OVS supports). OF1.4 says this is normal: "The
6724 * OFPTMPT_EVICTION property usually cannot be modified using a
6725 * OFP_TABLE_MOD request, because the eviction mechanism is switch
6727 if (tm->eviction_flags != UINT32_MAX
6728 && tm->eviction_flags != OFPROTO_EVICTION_FLAGS) {
6729 return OFPERR_OFPTMFC_BAD_CONFIG;
6732 if (tm->table_id == OFPTT_ALL) {
6733 struct oftable *oftable;
6734 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6735 if (!(oftable->flags & (OFTABLE_HIDDEN | OFTABLE_READONLY))) {
6736 table_mod__(oftable, tm);
6740 struct oftable *oftable = &ofproto->tables[tm->table_id];
6741 if (oftable->flags & OFTABLE_READONLY) {
6742 return OFPERR_OFPTMFC_EPERM;
6744 table_mod__(oftable, tm);
6751 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6753 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6754 struct ofputil_table_mod tm;
6757 error = reject_slave_controller(ofconn);
6762 error = ofputil_decode_table_mod(oh, &tm);
6767 return table_mod(ofproto, &tm);
6771 ofproto_flow_mod_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6772 OVS_REQUIRES(ofproto_mutex)
6774 switch (ofm->fm.command) {
6776 return add_flow_start(ofproto, ofm);
6777 /* , &be->old_rules.stub[0],
6778 &be->new_rules.stub[0]); */
6780 return modify_flows_start_loose(ofproto, ofm);
6781 case OFPFC_MODIFY_STRICT:
6782 return modify_flow_start_strict(ofproto, ofm);
6784 return delete_flows_start_loose(ofproto, ofm);
6786 case OFPFC_DELETE_STRICT:
6787 return delete_flow_start_strict(ofproto, ofm);
6790 return OFPERR_OFPFMFC_BAD_COMMAND;
6794 ofproto_flow_mod_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6795 OVS_REQUIRES(ofproto_mutex)
6797 switch (ofm->fm.command) {
6799 add_flow_revert(ofproto, ofm);
6803 case OFPFC_MODIFY_STRICT:
6804 modify_flows_revert(ofproto, ofm);
6808 case OFPFC_DELETE_STRICT:
6809 delete_flows_revert(ofproto, ofm);
6818 ofproto_flow_mod_finish(struct ofproto *ofproto,
6819 struct ofproto_flow_mod *ofm,
6820 const struct flow_mod_requester *req)
6821 OVS_REQUIRES(ofproto_mutex)
6823 switch (ofm->fm.command) {
6825 add_flow_finish(ofproto, ofm, req);
6829 case OFPFC_MODIFY_STRICT:
6830 modify_flows_finish(ofproto, ofm, req);
6834 case OFPFC_DELETE_STRICT:
6835 delete_flows_finish(ofproto, ofm, req);
6843 /* Commit phases (all while locking ofproto_mutex):
6845 * 1. Begin: Gather resources and make changes visible in the next version.
6846 * - Mark affected rules for removal in the next version.
6847 * - Create new replacement rules, make visible in the next
6849 * - Do not send any events or notifications.
6851 * 2. Revert: Fail if any errors are found. After this point no errors are
6852 * possible. No visible changes were made, so rollback is minimal (remove
6853 * added invisible rules, restore visibility of rules marked for removal).
6855 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
6856 * the ofproto provider. Remove replaced and deleted rules from ofproto data
6857 * structures, and Schedule postponed removal of deleted rules from the
6858 * classifier. Send notifications, buffered packets, etc.
6861 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6863 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6864 cls_version_t version = ofproto->tables_version + 1;
6865 struct ofp_bundle *bundle;
6866 struct ofp_bundle_entry *be;
6869 bundle = ofconn_get_bundle(ofconn, id);
6872 return OFPERR_OFPBFC_BAD_ID;
6874 if (bundle->flags != flags) {
6875 error = OFPERR_OFPBFC_BAD_FLAGS;
6877 bool prev_is_port_mod = false;
6880 ovs_mutex_lock(&ofproto_mutex);
6883 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6884 if (be->type == OFPTYPE_PORT_MOD) {
6885 /* Our port mods are not atomic. */
6886 if (flags & OFPBF_ATOMIC) {
6887 error = OFPERR_OFPBFC_MSG_FAILED;
6889 prev_is_port_mod = true;
6890 error = port_mod_start(ofconn, &be->opm.pm, &be->opm.port);
6892 } else if (be->type == OFPTYPE_FLOW_MOD) {
6893 /* Flow mods between port mods are applied as a single
6894 * version, but the versions are published only after
6895 * we know the commit is successful. */
6896 if (prev_is_port_mod) {
6899 prev_is_port_mod = false;
6900 /* Store the version in which the changes should take
6902 be->ofm.version = version;
6903 error = ofproto_flow_mod_start(ofproto, &be->ofm);
6913 /* Send error referring to the original message. */
6915 ofconn_send_error(ofconn, be->ofp_msg, error);
6916 error = OFPERR_OFPBFC_MSG_FAILED;
6919 /* 2. Revert. Undo all the changes made above. */
6920 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6921 if (be->type == OFPTYPE_FLOW_MOD) {
6922 ofproto_flow_mod_revert(ofproto, &be->ofm);
6924 /* Nothing needs to be reverted for a port mod. */
6928 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6929 if (be->type == OFPTYPE_FLOW_MOD) {
6930 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6932 /* Bump the lookup version to the one of the current
6933 * message. This makes all the changes in the bundle at
6934 * this version visible to lookups at once. */
6935 if (ofproto->tables_version < be->ofm.version) {
6936 ofproto->tables_version = be->ofm.version;
6937 ofproto->ofproto_class->set_tables_version(
6938 ofproto, ofproto->tables_version);
6941 ofproto_flow_mod_finish(ofproto, &be->ofm, &req);
6942 } else if (be->type == OFPTYPE_PORT_MOD) {
6943 /* Perform the actual port mod. This is not atomic, i.e.,
6944 * the effects will be immediately seen by upcall
6945 * processing regardless of the lookup version. It should
6946 * be noted that port configuration changes can originate
6947 * also from OVSDB changes asynchronously to all upcall
6949 port_mod_finish(ofconn, &be->opm.pm, be->opm.port);
6954 ofmonitor_flush(ofproto->connmgr);
6955 ovs_mutex_unlock(&ofproto_mutex);
6957 run_rule_executes(ofproto);
6960 /* The bundle is discarded regardless the outcome. */
6961 ofp_bundle_remove__(ofconn, bundle, !error);
6966 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6968 struct ofputil_bundle_ctrl_msg bctrl;
6969 struct ofputil_bundle_ctrl_msg reply;
6973 error = reject_slave_controller(ofconn);
6978 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6983 reply.bundle_id = bctrl.bundle_id;
6985 switch (bctrl.type) {
6986 case OFPBCT_OPEN_REQUEST:
6987 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6988 reply.type = OFPBCT_OPEN_REPLY;
6990 case OFPBCT_CLOSE_REQUEST:
6991 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6992 reply.type = OFPBCT_CLOSE_REPLY;
6994 case OFPBCT_COMMIT_REQUEST:
6995 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6996 reply.type = OFPBCT_COMMIT_REPLY;
6998 case OFPBCT_DISCARD_REQUEST:
6999 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
7000 reply.type = OFPBCT_DISCARD_REPLY;
7003 case OFPBCT_OPEN_REPLY:
7004 case OFPBCT_CLOSE_REPLY:
7005 case OFPBCT_COMMIT_REPLY:
7006 case OFPBCT_DISCARD_REPLY:
7007 return OFPERR_OFPBFC_BAD_TYPE;
7012 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
7013 ofconn_send_reply(ofconn, buf);
7019 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
7021 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
7023 struct ofputil_bundle_add_msg badd;
7024 struct ofp_bundle_entry *bmsg;
7027 error = reject_slave_controller(ofconn);
7032 error = ofputil_decode_bundle_add(oh, &badd, &type);
7037 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
7039 if (type == OFPTYPE_PORT_MOD) {
7040 error = ofputil_decode_port_mod(badd.msg, &bmsg->opm.pm, false);
7041 } else if (type == OFPTYPE_FLOW_MOD) {
7042 struct ofpbuf ofpacts;
7043 uint64_t ofpacts_stub[1024 / 8];
7045 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
7046 error = ofputil_decode_flow_mod(&bmsg->ofm.fm, badd.msg,
7047 ofconn_get_protocol(ofconn),
7049 u16_to_ofp(ofproto->max_ports),
7051 /* Move actions to heap. */
7052 bmsg->ofm.fm.ofpacts = ofpbuf_steal_data(&ofpacts);
7054 if (!error && bmsg->ofm.fm.ofpacts_len) {
7055 error = ofproto_check_ofpacts(ofproto, bmsg->ofm.fm.ofpacts,
7056 bmsg->ofm.fm.ofpacts_len);
7063 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
7068 ofp_bundle_entry_free(bmsg);
7075 handle_tlv_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
7077 struct ofputil_tlv_table_mod ttm;
7080 error = reject_slave_controller(ofconn);
7085 error = ofputil_decode_tlv_table_mod(oh, &ttm);
7090 error = tun_metadata_table_mod(&ttm);
7092 ofputil_uninit_tlv_table(&ttm.mappings);
7097 handle_tlv_table_request(struct ofconn *ofconn, const struct ofp_header *oh)
7099 struct ofputil_tlv_table_reply ttr;
7102 tun_metadata_table_request(&ttr);
7103 b = ofputil_encode_tlv_table_reply(oh, &ttr);
7104 ofputil_uninit_tlv_table(&ttr.mappings);
7106 ofconn_send_reply(ofconn, b);
7111 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
7112 OVS_EXCLUDED(ofproto_mutex)
7114 const struct ofp_header *oh = msg->data;
7118 error = ofptype_decode(&type, oh);
7122 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
7123 && ofpmp_more(oh)) {
7124 /* We have no buffer implementation for multipart requests.
7125 * Report overflow for requests which consists of multiple
7127 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
7131 /* OpenFlow requests. */
7132 case OFPTYPE_ECHO_REQUEST:
7133 return handle_echo_request(ofconn, oh);
7135 case OFPTYPE_FEATURES_REQUEST:
7136 return handle_features_request(ofconn, oh);
7138 case OFPTYPE_GET_CONFIG_REQUEST:
7139 return handle_get_config_request(ofconn, oh);
7141 case OFPTYPE_SET_CONFIG:
7142 return handle_set_config(ofconn, oh);
7144 case OFPTYPE_PACKET_OUT:
7145 return handle_packet_out(ofconn, oh);
7147 case OFPTYPE_PORT_MOD:
7148 return handle_port_mod(ofconn, oh);
7150 case OFPTYPE_FLOW_MOD:
7151 return handle_flow_mod(ofconn, oh);
7153 case OFPTYPE_GROUP_MOD:
7154 return handle_group_mod(ofconn, oh);
7156 case OFPTYPE_TABLE_MOD:
7157 return handle_table_mod(ofconn, oh);
7159 case OFPTYPE_METER_MOD:
7160 return handle_meter_mod(ofconn, oh);
7162 case OFPTYPE_BARRIER_REQUEST:
7163 return handle_barrier_request(ofconn, oh);
7165 case OFPTYPE_ROLE_REQUEST:
7166 return handle_role_request(ofconn, oh);
7168 /* OpenFlow replies. */
7169 case OFPTYPE_ECHO_REPLY:
7172 /* Nicira extension requests. */
7173 case OFPTYPE_FLOW_MOD_TABLE_ID:
7174 return handle_nxt_flow_mod_table_id(ofconn, oh);
7176 case OFPTYPE_SET_FLOW_FORMAT:
7177 return handle_nxt_set_flow_format(ofconn, oh);
7179 case OFPTYPE_SET_PACKET_IN_FORMAT:
7180 return handle_nxt_set_packet_in_format(ofconn, oh);
7182 case OFPTYPE_SET_CONTROLLER_ID:
7183 return handle_nxt_set_controller_id(ofconn, oh);
7185 case OFPTYPE_FLOW_AGE:
7186 /* Nothing to do. */
7189 case OFPTYPE_FLOW_MONITOR_CANCEL:
7190 return handle_flow_monitor_cancel(ofconn, oh);
7192 case OFPTYPE_SET_ASYNC_CONFIG:
7193 return handle_nxt_set_async_config(ofconn, oh);
7195 case OFPTYPE_GET_ASYNC_REQUEST:
7196 return handle_nxt_get_async_request(ofconn, oh);
7198 /* Statistics requests. */
7199 case OFPTYPE_DESC_STATS_REQUEST:
7200 return handle_desc_stats_request(ofconn, oh);
7202 case OFPTYPE_FLOW_STATS_REQUEST:
7203 return handle_flow_stats_request(ofconn, oh);
7205 case OFPTYPE_AGGREGATE_STATS_REQUEST:
7206 return handle_aggregate_stats_request(ofconn, oh);
7208 case OFPTYPE_TABLE_STATS_REQUEST:
7209 return handle_table_stats_request(ofconn, oh);
7211 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
7212 return handle_table_features_request(ofconn, oh);
7214 case OFPTYPE_TABLE_DESC_REQUEST:
7215 return handle_table_desc_request(ofconn, oh);
7217 case OFPTYPE_PORT_STATS_REQUEST:
7218 return handle_port_stats_request(ofconn, oh);
7220 case OFPTYPE_QUEUE_STATS_REQUEST:
7221 return handle_queue_stats_request(ofconn, oh);
7223 case OFPTYPE_PORT_DESC_STATS_REQUEST:
7224 return handle_port_desc_stats_request(ofconn, oh);
7226 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
7227 return handle_flow_monitor_request(ofconn, oh);
7229 case OFPTYPE_METER_STATS_REQUEST:
7230 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
7231 return handle_meter_request(ofconn, oh, type);
7233 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
7234 return handle_meter_features_request(ofconn, oh);
7236 case OFPTYPE_GROUP_STATS_REQUEST:
7237 return handle_group_stats_request(ofconn, oh);
7239 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
7240 return handle_group_desc_stats_request(ofconn, oh);
7242 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
7243 return handle_group_features_stats_request(ofconn, oh);
7245 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
7246 return handle_queue_get_config_request(ofconn, oh);
7248 case OFPTYPE_BUNDLE_CONTROL:
7249 return handle_bundle_control(ofconn, oh);
7251 case OFPTYPE_BUNDLE_ADD_MESSAGE:
7252 return handle_bundle_add(ofconn, oh);
7254 case OFPTYPE_NXT_TLV_TABLE_MOD:
7255 return handle_tlv_table_mod(ofconn, oh);
7257 case OFPTYPE_NXT_TLV_TABLE_REQUEST:
7258 return handle_tlv_table_request(ofconn, oh);
7262 case OFPTYPE_FEATURES_REPLY:
7263 case OFPTYPE_GET_CONFIG_REPLY:
7264 case OFPTYPE_PACKET_IN:
7265 case OFPTYPE_FLOW_REMOVED:
7266 case OFPTYPE_PORT_STATUS:
7267 case OFPTYPE_BARRIER_REPLY:
7268 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
7269 case OFPTYPE_DESC_STATS_REPLY:
7270 case OFPTYPE_FLOW_STATS_REPLY:
7271 case OFPTYPE_QUEUE_STATS_REPLY:
7272 case OFPTYPE_PORT_STATS_REPLY:
7273 case OFPTYPE_TABLE_STATS_REPLY:
7274 case OFPTYPE_AGGREGATE_STATS_REPLY:
7275 case OFPTYPE_PORT_DESC_STATS_REPLY:
7276 case OFPTYPE_ROLE_REPLY:
7277 case OFPTYPE_FLOW_MONITOR_PAUSED:
7278 case OFPTYPE_FLOW_MONITOR_RESUMED:
7279 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
7280 case OFPTYPE_GET_ASYNC_REPLY:
7281 case OFPTYPE_GROUP_STATS_REPLY:
7282 case OFPTYPE_GROUP_DESC_STATS_REPLY:
7283 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
7284 case OFPTYPE_METER_STATS_REPLY:
7285 case OFPTYPE_METER_CONFIG_STATS_REPLY:
7286 case OFPTYPE_METER_FEATURES_STATS_REPLY:
7287 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
7288 case OFPTYPE_TABLE_DESC_REPLY:
7289 case OFPTYPE_ROLE_STATUS:
7290 case OFPTYPE_REQUESTFORWARD:
7291 case OFPTYPE_NXT_TLV_TABLE_REPLY:
7293 if (ofpmsg_is_stat_request(oh)) {
7294 return OFPERR_OFPBRC_BAD_STAT;
7296 return OFPERR_OFPBRC_BAD_TYPE;
7302 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
7303 OVS_EXCLUDED(ofproto_mutex)
7305 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
7308 ofconn_send_error(ofconn, ofp_msg->data, error);
7310 COVERAGE_INC(ofproto_recv_openflow);
7313 /* Asynchronous operations. */
7316 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
7318 OVS_REQUIRES(ofproto_mutex)
7320 if (req && req->ofconn && buffer_id != UINT32_MAX) {
7321 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
7322 struct dp_packet *packet;
7326 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
7329 struct rule_execute *re;
7331 ofproto_rule_ref(rule);
7333 re = xmalloc(sizeof *re);
7335 re->in_port = in_port;
7336 re->packet = packet;
7338 if (!guarded_list_push_back(&ofproto->rule_executes,
7339 &re->list_node, 1024)) {
7340 ofproto_rule_unref(rule);
7341 dp_packet_delete(re->packet);
7345 ofconn_send_error(req->ofconn, req->request, error);
7351 pick_datapath_id(const struct ofproto *ofproto)
7353 const struct ofport *port;
7355 port = ofproto_get_port(ofproto, OFPP_LOCAL);
7360 error = netdev_get_etheraddr(port->netdev, &ea);
7362 return eth_addr_to_uint64(ea);
7364 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7365 ofproto->name, netdev_get_name(port->netdev),
7366 ovs_strerror(error));
7368 return ofproto->fallback_dpid;
7372 pick_fallback_dpid(void)
7375 eth_addr_nicira_random(&ea);
7376 return eth_addr_to_uint64(ea);
7379 /* Table overflow policy. */
7381 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7382 * to NULL if the table is not configured to evict rules or if the table
7383 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7384 * or with no timeouts are not evictable.) */
7386 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
7387 OVS_REQUIRES(ofproto_mutex)
7389 struct eviction_group *evg;
7392 if (!table->eviction) {
7396 /* In the common case, the outer and inner loops here will each be entered
7399 * - The inner loop normally "return"s in its first iteration. If the
7400 * eviction group has any evictable rules, then it always returns in
7403 * - The outer loop only iterates more than once if the largest eviction
7404 * group has no evictable rules.
7406 * - The outer loop can exit only if table's 'max_flows' is all filled up
7407 * by unevictable rules. */
7408 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7411 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7420 /* Eviction groups. */
7422 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7423 * rules. The priority contains low-order random bits to ensure that eviction
7424 * groups with the same number of rules are prioritized randomly. */
7426 eviction_group_priority(size_t n_rules)
7428 uint16_t size = MIN(UINT16_MAX, n_rules);
7429 return (size << 16) | random_uint16();
7432 /* Updates 'evg', an eviction_group within 'table', following a change that
7433 * adds or removes rules in 'evg'. */
7435 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7436 OVS_REQUIRES(ofproto_mutex)
7438 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7439 eviction_group_priority(heap_count(&evg->rules)));
7442 /* Destroys 'evg', an eviction_group within 'table':
7444 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7445 * rules themselves, just removes them from the eviction group.)
7447 * - Removes 'evg' from 'table'.
7451 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7452 OVS_REQUIRES(ofproto_mutex)
7454 while (!heap_is_empty(&evg->rules)) {
7457 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7458 rule->eviction_group = NULL;
7460 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7461 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7462 heap_destroy(&evg->rules);
7466 /* Removes 'rule' from its eviction group, if any. */
7468 eviction_group_remove_rule(struct rule *rule)
7469 OVS_REQUIRES(ofproto_mutex)
7471 if (rule->eviction_group) {
7472 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7473 struct eviction_group *evg = rule->eviction_group;
7475 rule->eviction_group = NULL;
7476 heap_remove(&evg->rules, &rule->evg_node);
7477 if (heap_is_empty(&evg->rules)) {
7478 eviction_group_destroy(table, evg);
7480 eviction_group_resized(table, evg);
7485 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7486 * returns the hash value. */
7488 eviction_group_hash_rule(struct rule *rule)
7489 OVS_REQUIRES(ofproto_mutex)
7491 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7492 const struct mf_subfield *sf;
7496 hash = table->eviction_group_id_basis;
7497 miniflow_expand(rule->cr.match.flow, &flow);
7498 for (sf = table->eviction_fields;
7499 sf < &table->eviction_fields[table->n_eviction_fields];
7502 if (mf_are_prereqs_ok(sf->field, &flow)) {
7503 union mf_value value;
7505 mf_get_value(sf->field, &flow, &value);
7507 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7509 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7510 unsigned int start = sf->ofs + sf->n_bits;
7511 bitwise_zero(&value, sf->field->n_bytes, start,
7512 sf->field->n_bytes * 8 - start);
7514 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7516 hash = hash_int(hash, 0);
7523 /* Returns an eviction group within 'table' with the given 'id', creating one
7525 static struct eviction_group *
7526 eviction_group_find(struct oftable *table, uint32_t id)
7527 OVS_REQUIRES(ofproto_mutex)
7529 struct eviction_group *evg;
7531 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7535 evg = xmalloc(sizeof *evg);
7536 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7537 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7538 eviction_group_priority(0));
7539 heap_init(&evg->rules);
7544 /* Returns an eviction priority for 'rule'. The return value should be
7545 * interpreted so that higher priorities make a rule a more attractive
7546 * candidate for eviction. */
7548 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7549 OVS_REQUIRES(ofproto_mutex)
7551 /* Calculate absolute time when this flow will expire. If it will never
7552 * expire, then return 0 to make it unevictable. */
7553 long long int expiration = LLONG_MAX;
7554 if (rule->hard_timeout) {
7555 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7556 ovs_mutex_lock(&rule->mutex);
7557 long long int modified = rule->modified;
7558 ovs_mutex_unlock(&rule->mutex);
7560 expiration = modified + rule->hard_timeout * 1000;
7562 if (rule->idle_timeout) {
7563 uint64_t packets, bytes;
7565 long long int idle_expiration;
7567 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7568 idle_expiration = used + rule->idle_timeout * 1000;
7569 expiration = MIN(expiration, idle_expiration);
7571 if (expiration == LLONG_MAX) {
7575 /* Calculate the time of expiration as a number of (approximate) seconds
7576 * after program startup.
7578 * This should work OK for program runs that last UINT32_MAX seconds or
7579 * less. Therefore, please restart OVS at least once every 136 years. */
7580 uint32_t expiration_ofs = (expiration >> 10) - (time_boot_msec() >> 10);
7582 /* Combine expiration time with OpenFlow "importance" to form a single
7583 * priority value. We want flows with relatively low "importance" to be
7584 * evicted before even considering expiration time, so put "importance" in
7585 * the most significant bits and expiration time in the least significant
7588 * Small 'priority' should be evicted before those with large 'priority'.
7589 * The caller expects the opposite convention (a large return value being
7590 * more attractive for eviction) so we invert it before returning. */
7591 uint64_t priority = ((uint64_t) rule->importance << 32) + expiration_ofs;
7592 return UINT64_MAX - priority;
7595 /* Adds 'rule' to an appropriate eviction group for its oftable's
7596 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7597 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7600 * The caller must ensure that 'rule' is not already in an eviction group. */
7602 eviction_group_add_rule(struct rule *rule)
7603 OVS_REQUIRES(ofproto_mutex)
7605 struct ofproto *ofproto = rule->ofproto;
7606 struct oftable *table = &ofproto->tables[rule->table_id];
7609 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7610 * so no additional protection is needed. */
7611 has_timeout = rule->hard_timeout || rule->idle_timeout;
7613 if (table->eviction && has_timeout) {
7614 struct eviction_group *evg;
7616 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7618 rule->eviction_group = evg;
7619 heap_insert(&evg->rules, &rule->evg_node,
7620 rule_eviction_priority(ofproto, rule));
7621 eviction_group_resized(table, evg);
7627 /* Initializes 'table'. */
7629 oftable_init(struct oftable *table)
7631 memset(table, 0, sizeof *table);
7632 classifier_init(&table->cls, flow_segment_u64s);
7633 table->max_flows = UINT_MAX;
7635 hmap_init(&table->eviction_groups_by_id);
7636 heap_init(&table->eviction_groups_by_size);
7637 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7639 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7640 ARRAY_SIZE(default_prefix_fields));
7642 atomic_init(&table->n_matched, 0);
7643 atomic_init(&table->n_missed, 0);
7646 /* Destroys 'table', including its classifier and eviction groups.
7648 * The caller is responsible for freeing 'table' itself. */
7650 oftable_destroy(struct oftable *table)
7652 ovs_assert(classifier_is_empty(&table->cls));
7654 ovs_mutex_lock(&ofproto_mutex);
7655 oftable_configure_eviction(table, 0, NULL, 0);
7656 ovs_mutex_unlock(&ofproto_mutex);
7658 hmap_destroy(&table->eviction_groups_by_id);
7659 heap_destroy(&table->eviction_groups_by_size);
7660 classifier_destroy(&table->cls);
7664 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7665 * string, then 'table' will use its default name.
7667 * This only affects the name exposed for a table exposed through the OpenFlow
7668 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7670 oftable_set_name(struct oftable *table, const char *name)
7672 if (name && name[0]) {
7673 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7674 if (!table->name || strncmp(name, table->name, len)) {
7676 table->name = xmemdup0(name, len);
7684 /* oftables support a choice of two policies when adding a rule would cause the
7685 * number of flows in the table to exceed the configured maximum number: either
7686 * they can refuse to add the new flow or they can evict some existing flow.
7687 * This function configures the latter policy on 'table', with fairness based
7688 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7689 * 'n_fields' as 0 disables fairness.) */
7691 oftable_configure_eviction(struct oftable *table, unsigned int eviction,
7692 const struct mf_subfield *fields, size_t n_fields)
7693 OVS_REQUIRES(ofproto_mutex)
7697 if ((table->eviction != 0) == (eviction != 0)
7698 && n_fields == table->n_eviction_fields
7700 || !memcmp(fields, table->eviction_fields,
7701 n_fields * sizeof *fields))) {
7702 /* The set of eviction fields did not change. If 'eviction' changed,
7703 * it remains nonzero, so that we can just update table->eviction
7704 * without fussing with the eviction groups. */
7705 table->eviction = eviction;
7709 /* Destroy existing eviction groups, then destroy and recreate data
7710 * structures to recover memory. */
7711 struct eviction_group *evg, *next;
7712 HMAP_FOR_EACH_SAFE (evg, next, id_node, &table->eviction_groups_by_id) {
7713 eviction_group_destroy(table, evg);
7715 hmap_destroy(&table->eviction_groups_by_id);
7716 hmap_init(&table->eviction_groups_by_id);
7717 heap_destroy(&table->eviction_groups_by_size);
7718 heap_init(&table->eviction_groups_by_size);
7720 /* Replace eviction groups by the new ones, if there is a change. Free the
7721 * old fields only after allocating the new ones, because 'fields ==
7722 * table->eviction_fields' is possible. */
7723 struct mf_subfield *old_fields = table->eviction_fields;
7724 table->n_eviction_fields = n_fields;
7725 table->eviction_fields = (fields
7726 ? xmemdup(fields, n_fields * sizeof *fields)
7730 /* Add the new eviction groups, if enabled. */
7731 table->eviction = eviction;
7732 if (table->eviction) {
7733 table->eviction_group_id_basis = random_uint32();
7734 CLS_FOR_EACH (rule, cr, &table->cls) {
7735 eviction_group_add_rule(rule);
7740 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7741 * it to the classifier. */
7743 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7744 OVS_REQUIRES(ofproto_mutex)
7746 const struct rule_actions *actions = rule_get_actions(rule);
7748 ovs_assert(rule->removed);
7750 if (rule->hard_timeout || rule->idle_timeout) {
7751 list_insert(&ofproto->expirable, &rule->expirable);
7753 cookies_insert(ofproto, rule);
7754 eviction_group_add_rule(rule);
7755 if (actions->has_meter) {
7756 meter_insert_rule(rule);
7758 rule->removed = false;
7761 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7762 * the removal from the classifier. */
7764 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7765 OVS_REQUIRES(ofproto_mutex)
7767 ovs_assert(!rule->removed);
7769 cookies_remove(ofproto, rule);
7771 eviction_group_remove_rule(rule);
7772 if (!list_is_empty(&rule->expirable)) {
7773 list_remove(&rule->expirable);
7775 if (!list_is_empty(&rule->meter_list_node)) {
7776 list_remove(&rule->meter_list_node);
7777 list_init(&rule->meter_list_node);
7780 rule->removed = true;
7783 /* unixctl commands. */
7786 ofproto_lookup(const char *name)
7788 struct ofproto *ofproto;
7790 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7792 if (!strcmp(ofproto->name, name)) {
7800 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7801 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7803 struct ofproto *ofproto;
7807 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7808 ds_put_format(&results, "%s\n", ofproto->name);
7810 unixctl_command_reply(conn, ds_cstr(&results));
7811 ds_destroy(&results);
7815 ofproto_unixctl_init(void)
7817 static bool registered;
7823 unixctl_command_register("ofproto/list", "", 0, 0,
7824 ofproto_unixctl_list, NULL);
7827 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7829 * This is deprecated. It is only for compatibility with broken device drivers
7830 * in old versions of Linux that do not properly support VLANs when VLAN
7831 * devices are not used. When broken device drivers are no longer in
7832 * widespread use, we will delete these interfaces. */
7834 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7835 * (exactly) by an OpenFlow rule in 'ofproto'. */
7837 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7840 struct cls_rule target;
7841 const struct oftable *oftable;
7843 match_init_catchall(&match);
7844 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7845 cls_rule_init(&target, &match, 0);
7847 free(ofproto->vlan_bitmap);
7848 ofproto->vlan_bitmap = bitmap_allocate(4096);
7849 ofproto->vlans_changed = false;
7851 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7854 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target,
7856 if (minimask_get_vid_mask(rule->cr.match.mask) == VLAN_VID_MASK) {
7857 uint16_t vid = miniflow_get_vid(rule->cr.match.flow);
7859 bitmap_set1(vlan_bitmap, vid);
7860 bitmap_set1(ofproto->vlan_bitmap, vid);
7865 cls_rule_destroy(&target);
7868 /* Returns true if new VLANs have come into use by the flow table since the
7869 * last call to ofproto_get_vlan_usage().
7871 * We don't track when old VLANs stop being used. */
7873 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7875 return ofproto->vlans_changed;
7878 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7879 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7880 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7881 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7882 * then the VLAN device is un-enslaved. */
7884 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7885 ofp_port_t realdev_ofp_port, int vid)
7887 struct ofport *ofport;
7890 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7892 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7894 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7895 ofproto->name, vlandev_ofp_port);
7899 if (!ofproto->ofproto_class->set_realdev) {
7900 if (!vlandev_ofp_port) {
7903 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7907 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7909 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7910 ofproto->name, vlandev_ofp_port,
7911 netdev_get_name(ofport->netdev), ovs_strerror(error));