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 void 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 *, struct ofputil_group_mod *);
301 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
302 static enum ofperr ofproto_flow_mod_start(struct ofproto *,
303 struct ofproto_flow_mod *)
304 OVS_REQUIRES(ofproto_mutex);
305 static void ofproto_flow_mod_finish(struct ofproto *,
306 struct ofproto_flow_mod *,
307 const struct flow_mod_requester *)
308 OVS_REQUIRES(ofproto_mutex);
309 static enum ofperr handle_flow_mod__(struct ofproto *,
310 struct ofproto_flow_mod *,
311 const struct flow_mod_requester *)
312 OVS_EXCLUDED(ofproto_mutex);
313 static void calc_duration(long long int start, long long int now,
314 uint32_t *sec, uint32_t *nsec);
317 static uint64_t pick_datapath_id(const struct ofproto *);
318 static uint64_t pick_fallback_dpid(void);
319 static void ofproto_destroy__(struct ofproto *);
320 static void update_mtu(struct ofproto *, struct ofport *);
321 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
322 static void meter_insert_rule(struct rule *);
325 static void ofproto_unixctl_init(void);
327 /* All registered ofproto classes, in probe order. */
328 static const struct ofproto_class **ofproto_classes;
329 static size_t n_ofproto_classes;
330 static size_t allocated_ofproto_classes;
332 /* Global lock that protects all flow table operations. */
333 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
335 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
336 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
338 size_t n_handlers, n_revalidators;
342 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
343 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
345 /* Initial mappings of port to OpenFlow number mappings. */
346 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
348 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
350 /* The default value of true waits for flow restore. */
351 static bool flow_restore_wait = true;
353 /* Must be called to initialize the ofproto library.
355 * The caller may pass in 'iface_hints', which contains an shash of
356 * "iface_hint" elements indexed by the interface's name. The provider
357 * may use these hints to describe the startup configuration in order to
358 * reinitialize its state. The caller owns the provided data, so a
359 * provider will make copies of anything required. An ofproto provider
360 * will remove any existing state that is not described by the hint, and
361 * may choose to remove it all. */
363 ofproto_init(const struct shash *iface_hints)
365 struct shash_node *node;
368 ofproto_class_register(&ofproto_dpif_class);
370 /* Make a local copy, since we don't own 'iface_hints' elements. */
371 SHASH_FOR_EACH(node, iface_hints) {
372 const struct iface_hint *orig_hint = node->data;
373 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
374 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
376 new_hint->br_name = xstrdup(orig_hint->br_name);
377 new_hint->br_type = xstrdup(br_type);
378 new_hint->ofp_port = orig_hint->ofp_port;
380 shash_add(&init_ofp_ports, node->name, new_hint);
383 for (i = 0; i < n_ofproto_classes; i++) {
384 ofproto_classes[i]->init(&init_ofp_ports);
387 ofproto_unixctl_init();
390 /* 'type' should be a normalized datapath type, as returned by
391 * ofproto_normalize_type(). Returns the corresponding ofproto_class
392 * structure, or a null pointer if there is none registered for 'type'. */
393 static const struct ofproto_class *
394 ofproto_class_find__(const char *type)
398 for (i = 0; i < n_ofproto_classes; i++) {
399 const struct ofproto_class *class = ofproto_classes[i];
404 class->enumerate_types(&types);
405 found = sset_contains(&types, type);
406 sset_destroy(&types);
412 VLOG_WARN("unknown datapath type %s", type);
416 /* Registers a new ofproto class. After successful registration, new ofprotos
417 * of that type can be created using ofproto_create(). */
419 ofproto_class_register(const struct ofproto_class *new_class)
423 for (i = 0; i < n_ofproto_classes; i++) {
424 if (ofproto_classes[i] == new_class) {
429 if (n_ofproto_classes >= allocated_ofproto_classes) {
430 ofproto_classes = x2nrealloc(ofproto_classes,
431 &allocated_ofproto_classes,
432 sizeof *ofproto_classes);
434 ofproto_classes[n_ofproto_classes++] = new_class;
438 /* Unregisters a datapath provider. 'type' must have been previously
439 * registered and not currently be in use by any ofprotos. After
440 * unregistration new datapaths of that type cannot be opened using
441 * ofproto_create(). */
443 ofproto_class_unregister(const struct ofproto_class *class)
447 for (i = 0; i < n_ofproto_classes; i++) {
448 if (ofproto_classes[i] == class) {
449 for (i++; i < n_ofproto_classes; i++) {
450 ofproto_classes[i - 1] = ofproto_classes[i];
456 VLOG_WARN("attempted to unregister an ofproto class that is not "
461 /* Clears 'types' and enumerates all registered ofproto types into it. The
462 * caller must first initialize the sset. */
464 ofproto_enumerate_types(struct sset *types)
469 for (i = 0; i < n_ofproto_classes; i++) {
470 ofproto_classes[i]->enumerate_types(types);
474 /* Returns the fully spelled out name for the given ofproto 'type'.
476 * Normalized type string can be compared with strcmp(). Unnormalized type
477 * string might be the same even if they have different spellings. */
479 ofproto_normalize_type(const char *type)
481 return type && type[0] ? type : "system";
484 /* Clears 'names' and enumerates the names of all known created ofprotos with
485 * the given 'type'. The caller must first initialize the sset. Returns 0 if
486 * successful, otherwise a positive errno value.
488 * Some kinds of datapaths might not be practically enumerable. This is not
489 * considered an error. */
491 ofproto_enumerate_names(const char *type, struct sset *names)
493 const struct ofproto_class *class = ofproto_class_find__(type);
494 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
498 ofproto_bump_tables_version(struct ofproto *ofproto)
500 ++ofproto->tables_version;
501 ofproto->ofproto_class->set_tables_version(ofproto,
502 ofproto->tables_version);
506 ofproto_create(const char *datapath_name, const char *datapath_type,
507 struct ofproto **ofprotop)
509 const struct ofproto_class *class;
510 struct ofproto *ofproto;
516 datapath_type = ofproto_normalize_type(datapath_type);
517 class = ofproto_class_find__(datapath_type);
519 VLOG_WARN("could not create datapath %s of unknown type %s",
520 datapath_name, datapath_type);
524 ofproto = class->alloc();
526 VLOG_ERR("failed to allocate datapath %s of type %s",
527 datapath_name, datapath_type);
532 ovs_mutex_lock(&ofproto_mutex);
533 memset(ofproto, 0, sizeof *ofproto);
534 ofproto->ofproto_class = class;
535 ofproto->name = xstrdup(datapath_name);
536 ofproto->type = xstrdup(datapath_type);
537 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
538 hash_string(ofproto->name, 0));
539 ofproto->datapath_id = 0;
540 ofproto->forward_bpdu = false;
541 ofproto->fallback_dpid = pick_fallback_dpid();
542 ofproto->mfr_desc = NULL;
543 ofproto->hw_desc = NULL;
544 ofproto->sw_desc = NULL;
545 ofproto->serial_desc = NULL;
546 ofproto->dp_desc = NULL;
547 ofproto->frag_handling = OFPC_FRAG_NORMAL;
548 hmap_init(&ofproto->ports);
549 hmap_init(&ofproto->ofport_usage);
550 shash_init(&ofproto->port_by_name);
551 simap_init(&ofproto->ofp_requests);
552 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
553 ofproto->eviction_group_timer = LLONG_MIN;
554 ofproto->tables = NULL;
555 ofproto->n_tables = 0;
556 ofproto->tables_version = CLS_MIN_VERSION;
557 hindex_init(&ofproto->cookies);
558 hmap_init(&ofproto->learned_cookies);
559 list_init(&ofproto->expirable);
560 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
561 guarded_list_init(&ofproto->rule_executes);
562 ofproto->vlan_bitmap = NULL;
563 ofproto->vlans_changed = false;
564 ofproto->min_mtu = INT_MAX;
565 ovs_rwlock_init(&ofproto->groups_rwlock);
566 hmap_init(&ofproto->groups);
567 ovs_mutex_unlock(&ofproto_mutex);
568 ofproto->ogf.types = 0xf;
569 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
570 OFPGFC_SELECT_WEIGHT;
571 for (i = 0; i < 4; i++) {
572 ofproto->ogf.max_groups[i] = OFPG_MAX;
573 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
577 error = ofproto->ofproto_class->construct(ofproto);
579 VLOG_ERR("failed to open datapath %s: %s",
580 datapath_name, ovs_strerror(error));
581 connmgr_destroy(ofproto->connmgr);
582 ofproto_destroy__(ofproto);
586 /* Check that hidden tables, if any, are at the end. */
587 ovs_assert(ofproto->n_tables);
588 for (i = 0; i + 1 < ofproto->n_tables; i++) {
589 enum oftable_flags flags = ofproto->tables[i].flags;
590 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
592 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
595 ofproto->datapath_id = pick_datapath_id(ofproto);
598 /* Initialize meters table. */
599 if (ofproto->ofproto_class->meter_get_features) {
600 ofproto->ofproto_class->meter_get_features(ofproto,
601 &ofproto->meter_features);
603 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
605 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
606 * sizeof(struct meter *));
608 /* Set the initial tables version. */
609 ofproto_bump_tables_version(ofproto);
615 /* Must be called (only) by an ofproto implementation in its constructor
616 * function. See the large comment on 'construct' in struct ofproto_class for
619 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
621 struct oftable *table;
623 ovs_assert(!ofproto->n_tables);
624 ovs_assert(n_tables >= 1 && n_tables <= 255);
626 ofproto->n_tables = n_tables;
627 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
628 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
633 /* To be optionally called (only) by an ofproto implementation in its
634 * constructor function. See the large comment on 'construct' in struct
635 * ofproto_class for details.
637 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
638 * will then ensure that actions passed into the ofproto implementation will
639 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
640 * function is not called, there will be no such restriction.
642 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
643 * the 'max_ports' restriction. */
645 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
647 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
648 ofproto->max_ports = max_ports;
652 ofproto_get_datapath_id(const struct ofproto *ofproto)
654 return ofproto->datapath_id;
658 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
660 uint64_t old_dpid = p->datapath_id;
661 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
662 if (p->datapath_id != old_dpid) {
663 /* Force all active connections to reconnect, since there is no way to
664 * notify a controller that the datapath ID has changed. */
665 ofproto_reconnect_controllers(p);
670 ofproto_set_controllers(struct ofproto *p,
671 const struct ofproto_controller *controllers,
672 size_t n_controllers, uint32_t allowed_versions)
674 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
679 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
681 connmgr_set_fail_mode(p->connmgr, fail_mode);
684 /* Drops the connections between 'ofproto' and all of its controllers, forcing
685 * them to reconnect. */
687 ofproto_reconnect_controllers(struct ofproto *ofproto)
689 connmgr_reconnect(ofproto->connmgr);
692 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
693 * in-band control should guarantee access, in the same way that in-band
694 * control guarantees access to OpenFlow controllers. */
696 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
697 const struct sockaddr_in *extras, size_t n)
699 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
702 /* Sets the OpenFlow queue used by flows set up by in-band control on
703 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
704 * flows will use the default queue. */
706 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
708 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
711 /* Sets the number of flows at which eviction from the kernel flow table
714 ofproto_set_flow_limit(unsigned limit)
716 ofproto_flow_limit = limit;
719 /* Sets the maximum idle time for flows in the datapath before they are
722 ofproto_set_max_idle(unsigned max_idle)
724 ofproto_max_idle = max_idle;
727 /* If forward_bpdu is true, the NORMAL action will forward frames with
728 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
729 * the NORMAL action will drop these frames. */
731 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
733 bool old_val = ofproto->forward_bpdu;
734 ofproto->forward_bpdu = forward_bpdu;
735 if (old_val != ofproto->forward_bpdu) {
736 if (ofproto->ofproto_class->forward_bpdu_changed) {
737 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
742 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
743 * 'idle_time', in seconds, and the maximum number of MAC table entries to
746 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
749 if (ofproto->ofproto_class->set_mac_table_config) {
750 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
755 /* Multicast snooping configuration. */
757 /* Configures multicast snooping on 'ofproto' using the settings
758 * defined in 's'. If 's' is NULL, disables multicast snooping.
760 * Returns 0 if successful, otherwise a positive errno value. */
762 ofproto_set_mcast_snooping(struct ofproto *ofproto,
763 const struct ofproto_mcast_snooping_settings *s)
765 return (ofproto->ofproto_class->set_mcast_snooping
766 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
770 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
772 * Returns 0 if successful, otherwise a positive errno value.*/
774 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
775 const struct ofproto_mcast_snooping_port_settings *s)
777 return (ofproto->ofproto_class->set_mcast_snooping_port
778 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
783 ofproto_set_n_dpdk_rxqs(int n_rxqs)
785 n_dpdk_rxqs = MAX(n_rxqs, 0);
789 ofproto_set_cpu_mask(const char *cmask)
793 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
797 ofproto_set_threads(int n_handlers_, int n_revalidators_)
799 int threads = MAX(count_cpu_cores(), 2);
801 n_revalidators = MAX(n_revalidators_, 0);
802 n_handlers = MAX(n_handlers_, 0);
804 if (!n_revalidators) {
805 n_revalidators = n_handlers
806 ? MAX(threads - (int) n_handlers, 1)
811 n_handlers = MAX(threads - (int) n_revalidators, 1);
816 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
819 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
823 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
825 return connmgr_set_snoops(ofproto->connmgr, snoops);
829 ofproto_set_netflow(struct ofproto *ofproto,
830 const struct netflow_options *nf_options)
832 if (nf_options && sset_is_empty(&nf_options->collectors)) {
836 if (ofproto->ofproto_class->set_netflow) {
837 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
839 return nf_options ? EOPNOTSUPP : 0;
844 ofproto_set_sflow(struct ofproto *ofproto,
845 const struct ofproto_sflow_options *oso)
847 if (oso && sset_is_empty(&oso->targets)) {
851 if (ofproto->ofproto_class->set_sflow) {
852 return ofproto->ofproto_class->set_sflow(ofproto, oso);
854 return oso ? EOPNOTSUPP : 0;
859 ofproto_set_ipfix(struct ofproto *ofproto,
860 const struct ofproto_ipfix_bridge_exporter_options *bo,
861 const struct ofproto_ipfix_flow_exporter_options *fo,
864 if (ofproto->ofproto_class->set_ipfix) {
865 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
867 return (bo || fo) ? EOPNOTSUPP : 0;
872 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
874 flow_restore_wait = flow_restore_wait_db;
878 ofproto_get_flow_restore_wait(void)
880 return flow_restore_wait;
884 /* Spanning Tree Protocol (STP) configuration. */
886 /* Configures STP on 'ofproto' using the settings defined in 's'. If
887 * 's' is NULL, disables STP.
889 * Returns 0 if successful, otherwise a positive errno value. */
891 ofproto_set_stp(struct ofproto *ofproto,
892 const struct ofproto_stp_settings *s)
894 return (ofproto->ofproto_class->set_stp
895 ? ofproto->ofproto_class->set_stp(ofproto, s)
899 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
900 * 'enabled' member of 's' is false, then the other members are not
903 * Returns 0 if successful, otherwise a positive errno value. */
905 ofproto_get_stp_status(struct ofproto *ofproto,
906 struct ofproto_stp_status *s)
908 return (ofproto->ofproto_class->get_stp_status
909 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
913 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
914 * in 's'. The caller is responsible for assigning STP port numbers
915 * (using the 'port_num' member in the range of 1 through 255, inclusive)
916 * and ensuring there are no duplicates. If the 's' is NULL, then STP
917 * is disabled on the port.
919 * Returns 0 if successful, otherwise a positive errno value.*/
921 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
922 const struct ofproto_port_stp_settings *s)
924 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
926 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
927 ofproto->name, ofp_port);
931 return (ofproto->ofproto_class->set_stp_port
932 ? ofproto->ofproto_class->set_stp_port(ofport, s)
936 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
937 * 's'. If the 'enabled' member in 's' is false, then the other members
938 * are not meaningful.
940 * Returns 0 if successful, otherwise a positive errno value.*/
942 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
943 struct ofproto_port_stp_status *s)
945 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
947 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
948 "port %"PRIu16, ofproto->name, ofp_port);
952 return (ofproto->ofproto_class->get_stp_port_status
953 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
957 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
958 * 's'. If the 'enabled' member in 's' is false, then the other members
959 * are not meaningful.
961 * Returns 0 if successful, otherwise a positive errno value.*/
963 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
964 struct ofproto_port_stp_stats *s)
966 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
968 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
969 "port %"PRIu16, ofproto->name, ofp_port);
973 return (ofproto->ofproto_class->get_stp_port_stats
974 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
978 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
980 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
981 * 's' is NULL, disables RSTP.
983 * Returns 0 if successful, otherwise a positive errno value. */
985 ofproto_set_rstp(struct ofproto *ofproto,
986 const struct ofproto_rstp_settings *s)
988 if (!ofproto->ofproto_class->set_rstp) {
991 ofproto->ofproto_class->set_rstp(ofproto, s);
995 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
996 * 'enabled' member of 's' is false, then the other members are not
999 * Returns 0 if successful, otherwise a positive errno value. */
1001 ofproto_get_rstp_status(struct ofproto *ofproto,
1002 struct ofproto_rstp_status *s)
1004 if (!ofproto->ofproto_class->get_rstp_status) {
1007 ofproto->ofproto_class->get_rstp_status(ofproto, s);
1011 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1012 * in 's'. The caller is responsible for assigning RSTP port numbers
1013 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1014 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1015 * is disabled on the port.
1017 * Returns 0 if successful, otherwise a positive errno value.*/
1019 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
1020 const struct ofproto_port_rstp_settings *s)
1022 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1024 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
1025 ofproto->name, ofp_port);
1029 if (!ofproto->ofproto_class->set_rstp_port) {
1032 ofproto->ofproto_class->set_rstp_port(ofport, s);
1036 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1037 * 's'. If the 'enabled' member in 's' is false, then the other members
1038 * are not meaningful.
1040 * Returns 0 if successful, otherwise a positive errno value.*/
1042 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1043 struct ofproto_port_rstp_status *s)
1045 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1047 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1048 "port %"PRIu16, ofproto->name, ofp_port);
1052 if (!ofproto->ofproto_class->get_rstp_port_status) {
1055 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1059 /* Queue DSCP configuration. */
1061 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1062 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1063 * to implement QoS. Instead, it is used to implement features which require
1064 * knowledge of what queues exist on a port, and some basic information about
1067 * Returns 0 if successful, otherwise a positive errno value. */
1069 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1070 const struct ofproto_port_queue *queues,
1073 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1076 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1077 ofproto->name, ofp_port);
1081 return (ofproto->ofproto_class->set_queues
1082 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1086 /* LLDP configuration. */
1088 ofproto_port_set_lldp(struct ofproto *ofproto,
1089 ofp_port_t ofp_port,
1090 const struct smap *cfg)
1092 struct ofport *ofport;
1095 ofport = ofproto_get_port(ofproto, ofp_port);
1097 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1098 ofproto->name, ofp_port);
1101 error = (ofproto->ofproto_class->set_lldp
1102 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1105 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1106 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1107 ovs_strerror(error));
1112 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1113 const struct aa_settings *s)
1115 if (!ofproto->ofproto_class->set_aa) {
1118 ofproto->ofproto_class->set_aa(ofproto, s);
1123 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1124 const struct aa_mapping_settings *s)
1126 if (!ofproto->ofproto_class->aa_mapping_set) {
1129 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1134 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1136 if (!ofproto->ofproto_class->aa_mapping_unset) {
1139 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1144 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1145 struct ovs_list *list)
1147 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1150 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1155 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1157 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1160 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1163 /* Connectivity Fault Management configuration. */
1165 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1167 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1169 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1170 if (ofport && ofproto->ofproto_class->set_cfm) {
1171 ofproto->ofproto_class->set_cfm(ofport, NULL);
1175 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1176 * basic configuration from the configuration members in 'cfm', and the remote
1177 * maintenance point ID from remote_mpid. Ignores the statistics members of
1180 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1182 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1183 const struct cfm_settings *s)
1185 struct ofport *ofport;
1188 ofport = ofproto_get_port(ofproto, ofp_port);
1190 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1191 ofproto->name, ofp_port);
1195 /* XXX: For configuration simplicity, we only support one remote_mpid
1196 * outside of the CFM module. It's not clear if this is the correct long
1197 * term solution or not. */
1198 error = (ofproto->ofproto_class->set_cfm
1199 ? ofproto->ofproto_class->set_cfm(ofport, s)
1202 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1203 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1204 ovs_strerror(error));
1208 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1209 * 'ofproto' does not have a port 'ofp_port'. */
1211 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1212 const struct smap *cfg)
1214 struct ofport *ofport;
1217 ofport = ofproto_get_port(ofproto, ofp_port);
1219 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1220 ofproto->name, ofp_port);
1224 error = (ofproto->ofproto_class->set_bfd
1225 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1228 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1229 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1230 ovs_strerror(error));
1234 /* Checks the status change of BFD on 'ofport'.
1236 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1238 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1240 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1241 return (ofport && ofproto->ofproto_class->bfd_status_changed
1242 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1246 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1247 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1248 * is not an OpenFlow port in 'ofproto'.
1250 * The caller must provide and own '*status'. */
1252 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1253 struct smap *status)
1255 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1256 return (ofport && ofproto->ofproto_class->get_bfd_status
1257 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1261 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1262 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1263 * 0 if LACP partner information is not current (generally indicating a
1264 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1266 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1268 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1269 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1270 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1275 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1277 struct ofproto *ofproto = port->ofproto;
1280 if (ofproto->ofproto_class->port_get_lacp_stats) {
1281 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1291 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1292 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1293 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1294 * configuration plus, if there is more than one slave, a bonding
1297 * If 'aux' is already registered then this function updates its configuration
1298 * to 's'. Otherwise, this function registers a new bundle.
1300 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1303 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1304 const struct ofproto_bundle_settings *s)
1306 return (ofproto->ofproto_class->bundle_set
1307 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1311 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1312 * If no such bundle has been registered, this has no effect. */
1314 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1316 return ofproto_bundle_register(ofproto, aux, NULL);
1320 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1321 * If 'aux' is already registered then this function updates its configuration
1322 * to 's'. Otherwise, this function registers a new mirror. */
1324 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1325 const struct ofproto_mirror_settings *s)
1327 return (ofproto->ofproto_class->mirror_set
1328 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1332 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1333 * If no mirror has been registered, this has no effect. */
1335 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1337 return ofproto_mirror_register(ofproto, aux, NULL);
1340 /* Retrieves statistics from mirror associated with client data pointer
1341 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1342 * 'bytes', respectively. If a particular counters is not supported,
1343 * the appropriate argument is set to UINT64_MAX.
1346 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1347 uint64_t *packets, uint64_t *bytes)
1349 if (!ofproto->ofproto_class->mirror_get_stats) {
1350 *packets = *bytes = UINT64_MAX;
1354 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1358 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1359 * which all packets are flooded, instead of using MAC learning. If
1360 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1362 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1365 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1367 return (ofproto->ofproto_class->set_flood_vlans
1368 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1372 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1373 * output for a mirror. */
1375 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1377 return (ofproto->ofproto_class->is_mirror_output_bundle
1378 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1382 /* Configuration of OpenFlow tables. */
1384 /* Returns the number of OpenFlow tables in 'ofproto'. */
1386 ofproto_get_n_tables(const struct ofproto *ofproto)
1388 return ofproto->n_tables;
1391 /* Returns the number of Controller visible OpenFlow tables
1392 * in 'ofproto'. This number will exclude Hidden tables.
1393 * This funtion's return value should be less or equal to that of
1394 * ofproto_get_n_tables() . */
1396 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1398 uint8_t n = ofproto->n_tables;
1400 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1401 * if present, are always at the end.) */
1402 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1409 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1410 * settings from 's'. 'table_id' must be in the range 0 through the number of
1411 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1413 * For read-only tables, only the name may be configured. */
1415 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1416 const struct ofproto_table_settings *s)
1418 struct oftable *table;
1420 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1421 table = &ofproto->tables[table_id];
1423 oftable_set_name(table, s->name);
1425 if (table->flags & OFTABLE_READONLY) {
1429 if (classifier_set_prefix_fields(&table->cls,
1430 s->prefix_fields, s->n_prefix_fields)) {
1431 /* XXX: Trigger revalidation. */
1434 ovs_mutex_lock(&ofproto_mutex);
1435 unsigned int new_eviction = (s->enable_eviction
1436 ? table->eviction | EVICTION_CLIENT
1437 : table->eviction & ~EVICTION_CLIENT);
1438 oftable_configure_eviction(table, new_eviction, s->groups, s->n_groups);
1439 table->max_flows = s->max_flows;
1440 evict_rules_from_table(table);
1441 ovs_mutex_unlock(&ofproto_mutex);
1445 ofproto_has_snoops(const struct ofproto *ofproto)
1447 return connmgr_has_snoops(ofproto->connmgr);
1451 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1453 connmgr_get_snoops(ofproto->connmgr, snoops);
1456 /* Deletes 'rule' from 'ofproto'.
1458 * Within an ofproto implementation, this function allows an ofproto
1459 * implementation to destroy any rules that remain when its ->destruct()
1460 * function is called. This function is not suitable for use elsewhere in an
1461 * ofproto implementation.
1463 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1464 * Cycle" in ofproto-provider.h. */
1466 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1467 OVS_EXCLUDED(ofproto_mutex)
1469 /* This skips the ofmonitor and flow-removed notifications because the
1470 * switch is being deleted and any OpenFlow channels have been or soon will
1472 ovs_mutex_lock(&ofproto_mutex);
1474 if (!rule->removed) {
1475 /* Make sure there is no postponed removal of the rule. */
1476 ovs_assert(cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
1478 if (!classifier_remove(&rule->ofproto->tables[rule->table_id].cls,
1482 ofproto_rule_remove__(rule->ofproto, rule);
1483 ofproto->ofproto_class->rule_delete(rule);
1484 ofproto_rule_unref(rule);
1486 ovs_mutex_unlock(&ofproto_mutex);
1490 ofproto_flush__(struct ofproto *ofproto)
1491 OVS_EXCLUDED(ofproto_mutex)
1493 struct oftable *table;
1495 /* This will flush all datapath flows. */
1496 if (ofproto->ofproto_class->flush) {
1497 ofproto->ofproto_class->flush(ofproto);
1500 /* XXX: There is a small race window here, where new datapath flows can be
1501 * created by upcall handlers based on the existing flow table. We can not
1502 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1503 * as then we could deadlock on syncing with the handler threads waiting on
1504 * the same mutex. */
1506 ovs_mutex_lock(&ofproto_mutex);
1507 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1508 struct rule_collection rules;
1511 if (table->flags & OFTABLE_HIDDEN) {
1515 rule_collection_init(&rules);
1517 CLS_FOR_EACH (rule, cr, &table->cls) {
1518 rule_collection_add(&rules, rule);
1520 delete_flows__(&rules, OFPRR_DELETE, NULL);
1522 /* XXX: Concurrent handler threads may insert new learned flows based on
1523 * learn actions of the now deleted flows right after we release
1524 * 'ofproto_mutex'. */
1525 ovs_mutex_unlock(&ofproto_mutex);
1528 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1531 ofproto_destroy__(struct ofproto *ofproto)
1532 OVS_EXCLUDED(ofproto_mutex)
1534 struct oftable *table;
1536 destroy_rule_executes(ofproto);
1538 guarded_list_destroy(&ofproto->rule_executes);
1539 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1540 hmap_destroy(&ofproto->groups);
1542 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1543 free(ofproto->name);
1544 free(ofproto->type);
1545 free(ofproto->mfr_desc);
1546 free(ofproto->hw_desc);
1547 free(ofproto->sw_desc);
1548 free(ofproto->serial_desc);
1549 free(ofproto->dp_desc);
1550 hmap_destroy(&ofproto->ports);
1551 hmap_destroy(&ofproto->ofport_usage);
1552 shash_destroy(&ofproto->port_by_name);
1553 simap_destroy(&ofproto->ofp_requests);
1555 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1556 oftable_destroy(table);
1558 free(ofproto->tables);
1560 ovs_assert(hindex_is_empty(&ofproto->cookies));
1561 hindex_destroy(&ofproto->cookies);
1563 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1564 hmap_destroy(&ofproto->learned_cookies);
1566 free(ofproto->vlan_bitmap);
1568 ofproto->ofproto_class->dealloc(ofproto);
1571 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1572 * - 1st we defer the removal of the rules from the classifier
1573 * - 2nd we defer the actual destruction of the rules. */
1575 ofproto_destroy_defer__(struct ofproto *ofproto)
1576 OVS_EXCLUDED(ofproto_mutex)
1578 ovsrcu_postpone(ofproto_destroy__, ofproto);
1582 ofproto_destroy(struct ofproto *p)
1583 OVS_EXCLUDED(ofproto_mutex)
1585 struct ofport *ofport, *next_ofport;
1586 struct ofport_usage *usage, *next_usage;
1593 meter_delete(p, 1, p->meter_features.max_meters);
1594 p->meter_features.max_meters = 0;
1600 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1601 ofport_destroy(ofport);
1604 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1605 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1609 p->ofproto_class->destruct(p);
1611 /* We should not postpone this because it involves deleting a listening
1612 * socket which we may want to reopen soon. 'connmgr' should not be used
1613 * by other threads */
1614 connmgr_destroy(p->connmgr);
1616 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1617 ovsrcu_postpone(ofproto_destroy_defer__, p);
1620 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1621 * kernel datapath, for example, this destroys the datapath in the kernel, and
1622 * with the netdev-based datapath, it tears down the data structures that
1623 * represent the datapath.
1625 * The datapath should not be currently open as an ofproto. */
1627 ofproto_delete(const char *name, const char *type)
1629 const struct ofproto_class *class = ofproto_class_find__(type);
1630 return (!class ? EAFNOSUPPORT
1631 : !class->del ? EACCES
1632 : class->del(type, name));
1636 process_port_change(struct ofproto *ofproto, int error, char *devname)
1638 if (error == ENOBUFS) {
1639 reinit_ports(ofproto);
1640 } else if (!error) {
1641 update_port(ofproto, devname);
1647 ofproto_type_run(const char *datapath_type)
1649 const struct ofproto_class *class;
1652 datapath_type = ofproto_normalize_type(datapath_type);
1653 class = ofproto_class_find__(datapath_type);
1655 error = class->type_run ? class->type_run(datapath_type) : 0;
1656 if (error && error != EAGAIN) {
1657 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1658 datapath_type, ovs_strerror(error));
1664 ofproto_type_wait(const char *datapath_type)
1666 const struct ofproto_class *class;
1668 datapath_type = ofproto_normalize_type(datapath_type);
1669 class = ofproto_class_find__(datapath_type);
1671 if (class->type_wait) {
1672 class->type_wait(datapath_type);
1677 ofproto_run(struct ofproto *p)
1682 error = p->ofproto_class->run(p);
1683 if (error && error != EAGAIN) {
1684 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1687 run_rule_executes(p);
1689 /* Restore the eviction group heap invariant occasionally. */
1690 if (p->eviction_group_timer < time_msec()) {
1693 p->eviction_group_timer = time_msec() + 1000;
1695 for (i = 0; i < p->n_tables; i++) {
1696 struct oftable *table = &p->tables[i];
1697 struct eviction_group *evg;
1700 if (!table->eviction) {
1704 if (table->n_flows > 100000) {
1705 static struct vlog_rate_limit count_rl =
1706 VLOG_RATE_LIMIT_INIT(1, 1);
1707 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1708 " number of rules: %d", i, table->n_flows);
1711 ovs_mutex_lock(&ofproto_mutex);
1712 CLS_FOR_EACH (rule, cr, &table->cls) {
1713 if (rule->idle_timeout || rule->hard_timeout) {
1714 if (!rule->eviction_group) {
1715 eviction_group_add_rule(rule);
1717 heap_raw_change(&rule->evg_node,
1718 rule_eviction_priority(p, rule));
1723 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1724 heap_rebuild(&evg->rules);
1726 ovs_mutex_unlock(&ofproto_mutex);
1730 if (p->ofproto_class->port_poll) {
1733 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1734 process_port_change(p, error, devname);
1738 new_seq = seq_read(connectivity_seq_get());
1739 if (new_seq != p->change_seq) {
1740 struct sset devnames;
1741 const char *devname;
1742 struct ofport *ofport;
1744 /* Update OpenFlow port status for any port whose netdev has changed.
1746 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1747 * destroyed, so it's not safe to update ports directly from the
1748 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1749 * need this two-phase approach. */
1750 sset_init(&devnames);
1751 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1752 uint64_t port_change_seq;
1754 port_change_seq = netdev_get_change_seq(ofport->netdev);
1755 if (ofport->change_seq != port_change_seq) {
1756 ofport->change_seq = port_change_seq;
1757 sset_add(&devnames, netdev_get_name(ofport->netdev));
1760 SSET_FOR_EACH (devname, &devnames) {
1761 update_port(p, devname);
1763 sset_destroy(&devnames);
1765 p->change_seq = new_seq;
1768 connmgr_run(p->connmgr, handle_openflow);
1774 ofproto_wait(struct ofproto *p)
1776 p->ofproto_class->wait(p);
1777 if (p->ofproto_class->port_poll_wait) {
1778 p->ofproto_class->port_poll_wait(p);
1780 seq_wait(connectivity_seq_get(), p->change_seq);
1781 connmgr_wait(p->connmgr);
1785 ofproto_is_alive(const struct ofproto *p)
1787 return connmgr_has_controllers(p->connmgr);
1790 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1791 * memory_report(). */
1793 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1795 const struct oftable *table;
1796 unsigned int n_rules;
1798 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1801 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1802 n_rules += table->n_flows;
1804 simap_increase(usage, "rules", n_rules);
1806 if (ofproto->ofproto_class->get_memory_usage) {
1807 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1810 connmgr_get_memory_usage(ofproto->connmgr, usage);
1814 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1816 const struct ofproto_class *class;
1818 datapath_type = ofproto_normalize_type(datapath_type);
1819 class = ofproto_class_find__(datapath_type);
1821 if (class && class->type_get_memory_usage) {
1822 class->type_get_memory_usage(datapath_type, usage);
1827 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1830 connmgr_get_controller_info(ofproto->connmgr, info);
1834 ofproto_free_ofproto_controller_info(struct shash *info)
1836 connmgr_free_controller_info(info);
1839 /* Makes a deep copy of 'old' into 'port'. */
1841 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1843 port->name = xstrdup(old->name);
1844 port->type = xstrdup(old->type);
1845 port->ofp_port = old->ofp_port;
1848 /* Frees memory allocated to members of 'ofproto_port'.
1850 * Do not call this function on an ofproto_port obtained from
1851 * ofproto_port_dump_next(): that function retains ownership of the data in the
1854 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1856 free(ofproto_port->name);
1857 free(ofproto_port->type);
1860 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1862 * This function provides no status indication. An error status for the entire
1863 * dump operation is provided when it is completed by calling
1864 * ofproto_port_dump_done().
1867 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1868 const struct ofproto *ofproto)
1870 dump->ofproto = ofproto;
1871 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1875 /* Attempts to retrieve another port from 'dump', which must have been created
1876 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1877 * 'port' and returns true. On failure, returns false.
1879 * Failure might indicate an actual error or merely that the last port has been
1880 * dumped. An error status for the entire dump operation is provided when it
1881 * is completed by calling ofproto_port_dump_done().
1883 * The ofproto owns the data stored in 'port'. It will remain valid until at
1884 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1885 * ofproto_port_dump_done(). */
1887 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1888 struct ofproto_port *port)
1890 const struct ofproto *ofproto = dump->ofproto;
1896 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1899 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1905 /* Completes port table dump operation 'dump', which must have been created
1906 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1907 * error-free, otherwise a positive errno value describing the problem. */
1909 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1911 const struct ofproto *ofproto = dump->ofproto;
1913 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1916 return dump->error == EOF ? 0 : dump->error;
1919 /* Returns the type to pass to netdev_open() when a datapath of type
1920 * 'datapath_type' has a port of type 'port_type', for a few special
1921 * cases when a netdev type differs from a port type. For example, when
1922 * using the userspace datapath, a port of type "internal" needs to be
1925 * Returns either 'type' itself or a string literal, which must not be
1928 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1930 const struct ofproto_class *class;
1932 datapath_type = ofproto_normalize_type(datapath_type);
1933 class = ofproto_class_find__(datapath_type);
1938 return (class->port_open_type
1939 ? class->port_open_type(datapath_type, port_type)
1943 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1944 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1945 * the port's OpenFlow port number.
1947 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1948 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1949 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1950 * 'ofp_portp' is non-null). */
1952 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1953 ofp_port_t *ofp_portp)
1955 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1958 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1960 const char *netdev_name = netdev_get_name(netdev);
1962 simap_put(&ofproto->ofp_requests, netdev_name,
1963 ofp_to_u16(ofp_port));
1964 update_port(ofproto, netdev_name);
1967 *ofp_portp = OFPP_NONE;
1969 struct ofproto_port ofproto_port;
1971 error = ofproto_port_query_by_name(ofproto,
1972 netdev_get_name(netdev),
1975 *ofp_portp = ofproto_port.ofp_port;
1976 ofproto_port_destroy(&ofproto_port);
1983 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1984 * initializes '*port' appropriately; on failure, returns a positive errno
1987 * The caller owns the data in 'ofproto_port' and must free it with
1988 * ofproto_port_destroy() when it is no longer needed. */
1990 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1991 struct ofproto_port *port)
1995 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1997 memset(port, 0, sizeof *port);
2002 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
2003 * Returns 0 if successful, otherwise a positive errno. */
2005 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
2007 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2008 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
2009 struct simap_node *ofp_request_node;
2012 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
2013 if (ofp_request_node) {
2014 simap_delete(&ofproto->ofp_requests, ofp_request_node);
2017 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
2018 if (!error && ofport) {
2019 /* 'name' is the netdev's name and update_port() is going to close the
2020 * netdev. Just in case update_port() refers to 'name' after it
2021 * destroys 'ofport', make a copy of it around the update_port()
2023 char *devname = xstrdup(name);
2024 update_port(ofproto, devname);
2031 flow_mod_init(struct ofputil_flow_mod *fm,
2032 const struct match *match, int priority,
2033 const struct ofpact *ofpacts, size_t ofpacts_len,
2034 enum ofp_flow_mod_command command)
2036 memset(fm, 0, sizeof *fm);
2038 fm->priority = priority;
2041 fm->modify_cookie = false;
2043 fm->command = command;
2044 fm->idle_timeout = 0;
2045 fm->hard_timeout = 0;
2047 fm->buffer_id = UINT32_MAX;
2048 fm->out_port = OFPP_ANY;
2049 fm->out_group = OFPG_ANY;
2051 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2052 fm->ofpacts_len = ofpacts_len;
2053 fm->delete_reason = OFPRR_DELETE;
2057 simple_flow_mod(struct ofproto *ofproto,
2058 const struct match *match, int priority,
2059 const struct ofpact *ofpacts, size_t ofpacts_len,
2060 enum ofp_flow_mod_command command)
2062 struct ofproto_flow_mod ofm;
2064 flow_mod_init(&ofm.fm, match, priority, ofpacts, ofpacts_len, command);
2066 return handle_flow_mod__(ofproto, &ofm, NULL);
2069 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2070 * performs the 'n_actions' actions in 'actions'. The new flow will not
2073 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2074 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2075 * controllers; otherwise, it will be hidden.
2077 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2079 * This is a helper function for in-band control and fail-open. */
2081 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2083 const struct ofpact *ofpacts, size_t ofpacts_len)
2084 OVS_EXCLUDED(ofproto_mutex)
2086 const struct rule *rule;
2089 /* First do a cheap check whether the rule we're looking for already exists
2090 * with the actions that we want. If it does, then we're done. */
2091 rule = rule_from_cls_rule(classifier_find_match_exactly(
2092 &ofproto->tables[0].cls, match, priority,
2095 const struct rule_actions *actions = rule_get_actions(rule);
2096 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2097 ofpacts, ofpacts_len);
2102 /* If there's no such rule or the rule doesn't have the actions we want,
2103 * fall back to a executing a full flow mod. We can't optimize this at
2104 * all because we didn't take enough locks above to ensure that the flow
2105 * table didn't already change beneath us. */
2107 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2108 OFPFC_MODIFY_STRICT);
2112 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2113 * an OFPERR_* OpenFlow error code on failure.
2115 * This is a helper function for in-band control and fail-open and the "learn"
2118 ofproto_flow_mod(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
2119 OVS_EXCLUDED(ofproto_mutex)
2121 struct ofputil_flow_mod *fm = &ofm->fm;
2123 /* Optimize for the most common case of a repeated learn action.
2124 * If an identical flow already exists we only need to update its
2125 * 'modified' time. */
2126 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2127 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2128 struct oftable *table = &ofproto->tables[fm->table_id];
2132 rule = rule_from_cls_rule(classifier_find_match_exactly(
2133 &table->cls, &fm->match, fm->priority,
2136 /* Reading many of the rule fields and writing on 'modified'
2137 * requires the rule->mutex. Also, rule->actions may change
2138 * if rule->mutex is not held. */
2139 const struct rule_actions *actions;
2141 ovs_mutex_lock(&rule->mutex);
2142 actions = rule_get_actions(rule);
2143 if (rule->idle_timeout == fm->idle_timeout
2144 && rule->hard_timeout == fm->hard_timeout
2145 && rule->importance == fm->importance
2146 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2147 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2148 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2149 actions->ofpacts, actions->ofpacts_len)) {
2150 /* Rule already exists and need not change, only update the
2151 modified timestamp. */
2152 rule->modified = time_msec();
2155 ovs_mutex_unlock(&rule->mutex);
2163 return handle_flow_mod__(ofproto, ofm, NULL);
2166 /* Searches for a rule with matching criteria exactly equal to 'target' in
2167 * ofproto's table 0 and, if it finds one, deletes it.
2169 * This is a helper function for in-band control and fail-open. */
2171 ofproto_delete_flow(struct ofproto *ofproto,
2172 const struct match *target, int priority)
2173 OVS_EXCLUDED(ofproto_mutex)
2175 struct classifier *cls = &ofproto->tables[0].cls;
2178 /* First do a cheap check whether the rule we're looking for has already
2179 * been deleted. If so, then we're done. */
2180 rule = rule_from_cls_rule(classifier_find_match_exactly(
2181 cls, target, priority, CLS_MAX_VERSION));
2186 /* Execute a flow mod. We can't optimize this at all because we didn't
2187 * take enough locks above to ensure that the flow table didn't already
2188 * change beneath us. */
2189 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2192 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2193 * the flows required by in-band control and fail-open. */
2195 ofproto_flush_flows(struct ofproto *ofproto)
2197 COVERAGE_INC(ofproto_flush);
2198 ofproto_flush__(ofproto);
2199 connmgr_flushed(ofproto->connmgr);
2203 reinit_ports(struct ofproto *p)
2205 struct ofproto_port_dump dump;
2206 struct sset devnames;
2207 struct ofport *ofport;
2208 struct ofproto_port ofproto_port;
2209 const char *devname;
2211 COVERAGE_INC(ofproto_reinit_ports);
2213 sset_init(&devnames);
2214 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2215 sset_add(&devnames, netdev_get_name(ofport->netdev));
2217 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2218 sset_add(&devnames, ofproto_port.name);
2221 SSET_FOR_EACH (devname, &devnames) {
2222 update_port(p, devname);
2224 sset_destroy(&devnames);
2228 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2232 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2233 port_idx = port_idx ? port_idx : UINT16_MAX;
2235 if (port_idx >= ofproto->max_ports
2236 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2237 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2238 long long int last_used_at, lru = LLONG_MAX;
2240 /* Search for a free OpenFlow port number. We try not to
2241 * immediately reuse them to prevent problems due to old
2244 * We limit the automatically assigned port numbers to the lower half
2245 * of the port range, to reserve the upper half for assignment by
2248 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2249 ofproto->alloc_port_no = 1;
2251 last_used_at = ofport_get_usage(ofproto,
2252 u16_to_ofp(ofproto->alloc_port_no));
2253 if (!last_used_at) {
2254 port_idx = ofproto->alloc_port_no;
2256 } else if ( last_used_at < time_msec() - 60*60*1000) {
2257 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2258 * more than an hour ago, consider it usable. */
2259 ofport_remove_usage(ofproto,
2260 u16_to_ofp(ofproto->alloc_port_no));
2261 port_idx = ofproto->alloc_port_no;
2263 } else if (last_used_at < lru) {
2265 lru_ofport = ofproto->alloc_port_no;
2268 if (ofproto->alloc_port_no == end_port_no) {
2270 port_idx = lru_ofport;
2277 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2278 return u16_to_ofp(port_idx);
2282 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2284 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2285 ofport_set_usage(ofproto, ofp_port, time_msec());
2289 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2290 * pointer if the netdev cannot be opened. On success, also fills in
2292 static struct netdev *
2293 ofport_open(struct ofproto *ofproto,
2294 struct ofproto_port *ofproto_port,
2295 struct ofputil_phy_port *pp)
2297 enum netdev_flags flags;
2298 struct netdev *netdev;
2301 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2303 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2304 "cannot be opened (%s)",
2306 ofproto_port->name, ofproto_port->ofp_port,
2307 ofproto_port->name, ovs_strerror(error));
2311 if (ofproto_port->ofp_port == OFPP_NONE) {
2312 if (!strcmp(ofproto->name, ofproto_port->name)) {
2313 ofproto_port->ofp_port = OFPP_LOCAL;
2315 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2316 ofproto_port->name);
2319 pp->port_no = ofproto_port->ofp_port;
2320 netdev_get_etheraddr(netdev, &pp->hw_addr);
2321 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2322 netdev_get_flags(netdev, &flags);
2323 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2324 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2325 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2326 &pp->supported, &pp->peer);
2327 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2328 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2333 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2334 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2337 ofport_equal(const struct ofputil_phy_port *a,
2338 const struct ofputil_phy_port *b)
2340 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2341 && a->state == b->state
2342 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2343 && a->curr == b->curr
2344 && a->advertised == b->advertised
2345 && a->supported == b->supported
2346 && a->peer == b->peer
2347 && a->curr_speed == b->curr_speed
2348 && a->max_speed == b->max_speed);
2351 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2352 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2353 * one with the same name or port number). */
2355 ofport_install(struct ofproto *p,
2356 struct netdev *netdev, const struct ofputil_phy_port *pp)
2358 const char *netdev_name = netdev_get_name(netdev);
2359 struct ofport *ofport;
2362 /* Create ofport. */
2363 ofport = p->ofproto_class->port_alloc();
2368 ofport->ofproto = p;
2369 ofport->netdev = netdev;
2370 ofport->change_seq = netdev_get_change_seq(netdev);
2372 ofport->ofp_port = pp->port_no;
2373 ofport->created = time_msec();
2375 /* Add port to 'p'. */
2376 hmap_insert(&p->ports, &ofport->hmap_node,
2377 hash_ofp_port(ofport->ofp_port));
2378 shash_add(&p->port_by_name, netdev_name, ofport);
2380 update_mtu(p, ofport);
2382 /* Let the ofproto_class initialize its private data. */
2383 error = p->ofproto_class->port_construct(ofport);
2387 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2391 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2392 p->name, netdev_name, ovs_strerror(error));
2394 ofport_destroy__(ofport);
2396 netdev_close(netdev);
2400 /* Removes 'ofport' from 'p' and destroys it. */
2402 ofport_remove(struct ofport *ofport)
2404 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2406 ofport_destroy(ofport);
2409 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2412 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2414 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2416 ofport_remove(port);
2420 /* Updates 'port' with new 'pp' description.
2422 * Does not handle a name or port number change. The caller must implement
2423 * such a change as a delete followed by an add. */
2425 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2427 port->pp.hw_addr = pp->hw_addr;
2428 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2429 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2430 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2431 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2432 port->pp.curr = pp->curr;
2433 port->pp.advertised = pp->advertised;
2434 port->pp.supported = pp->supported;
2435 port->pp.peer = pp->peer;
2436 port->pp.curr_speed = pp->curr_speed;
2437 port->pp.max_speed = pp->max_speed;
2439 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2440 &port->pp, OFPPR_MODIFY);
2443 /* Update OpenFlow 'state' in 'port' and notify controller. */
2445 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2447 if (port->pp.state != state) {
2448 port->pp.state = state;
2449 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2450 &port->pp, OFPPR_MODIFY);
2455 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2457 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2459 if (port->ofproto->ofproto_class->set_realdev) {
2460 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2462 if (port->ofproto->ofproto_class->set_stp_port) {
2463 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2465 if (port->ofproto->ofproto_class->set_rstp_port) {
2466 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2468 if (port->ofproto->ofproto_class->set_cfm) {
2469 port->ofproto->ofproto_class->set_cfm(port, NULL);
2471 if (port->ofproto->ofproto_class->bundle_remove) {
2472 port->ofproto->ofproto_class->bundle_remove(port);
2478 ofport_destroy__(struct ofport *port)
2480 struct ofproto *ofproto = port->ofproto;
2481 const char *name = netdev_get_name(port->netdev);
2483 hmap_remove(&ofproto->ports, &port->hmap_node);
2484 shash_delete(&ofproto->port_by_name,
2485 shash_find(&ofproto->port_by_name, name));
2487 netdev_close(port->netdev);
2488 ofproto->ofproto_class->port_dealloc(port);
2492 ofport_destroy(struct ofport *port)
2495 dealloc_ofp_port(port->ofproto, port->ofp_port);
2496 port->ofproto->ofproto_class->port_destruct(port);
2497 ofport_destroy__(port);
2502 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2504 struct ofport *port;
2506 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2508 if (port->ofp_port == ofp_port) {
2515 static long long int
2516 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2518 struct ofport_usage *usage;
2520 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2521 &ofproto->ofport_usage) {
2522 if (usage->ofp_port == ofp_port) {
2523 return usage->last_used;
2530 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2531 long long int last_used)
2533 struct ofport_usage *usage;
2534 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2535 &ofproto->ofport_usage) {
2536 if (usage->ofp_port == ofp_port) {
2537 usage->last_used = last_used;
2541 ovs_assert(last_used == LLONG_MAX);
2543 usage = xmalloc(sizeof *usage);
2544 usage->ofp_port = ofp_port;
2545 usage->last_used = last_used;
2546 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2547 hash_ofp_port(ofp_port));
2551 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2553 struct ofport_usage *usage;
2554 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2555 &ofproto->ofport_usage) {
2556 if (usage->ofp_port == ofp_port) {
2557 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2565 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2567 struct ofproto *ofproto = port->ofproto;
2570 if (ofproto->ofproto_class->port_get_stats) {
2571 error = ofproto->ofproto_class->port_get_stats(port, stats);
2580 update_port(struct ofproto *ofproto, const char *name)
2582 struct ofproto_port ofproto_port;
2583 struct ofputil_phy_port pp;
2584 struct netdev *netdev;
2585 struct ofport *port;
2587 COVERAGE_INC(ofproto_update_port);
2589 /* Fetch 'name''s location and properties from the datapath. */
2590 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2591 ? ofport_open(ofproto, &ofproto_port, &pp)
2595 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2596 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2597 struct netdev *old_netdev = port->netdev;
2599 /* 'name' hasn't changed location. Any properties changed? */
2600 if (!ofport_equal(&port->pp, &pp)) {
2601 ofport_modified(port, &pp);
2604 update_mtu(ofproto, port);
2606 /* Install the newly opened netdev in case it has changed.
2607 * Don't close the old netdev yet in case port_modified has to
2608 * remove a retained reference to it.*/
2609 port->netdev = netdev;
2610 port->change_seq = netdev_get_change_seq(netdev);
2612 if (port->ofproto->ofproto_class->port_modified) {
2613 port->ofproto->ofproto_class->port_modified(port);
2616 netdev_close(old_netdev);
2618 /* If 'port' is nonnull then its name differs from 'name' and thus
2619 * we should delete it. If we think there's a port named 'name'
2620 * then its port number must be wrong now so delete it too. */
2622 ofport_remove(port);
2624 ofport_remove_with_name(ofproto, name);
2625 ofport_install(ofproto, netdev, &pp);
2628 /* Any port named 'name' is gone now. */
2629 ofport_remove_with_name(ofproto, name);
2631 ofproto_port_destroy(&ofproto_port);
2635 init_ports(struct ofproto *p)
2637 struct ofproto_port_dump dump;
2638 struct ofproto_port ofproto_port;
2639 struct shash_node *node, *next;
2641 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2642 const char *name = ofproto_port.name;
2644 if (shash_find(&p->port_by_name, name)) {
2645 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2648 struct ofputil_phy_port pp;
2649 struct netdev *netdev;
2651 /* Check if an OpenFlow port number had been requested. */
2652 node = shash_find(&init_ofp_ports, name);
2654 const struct iface_hint *iface_hint = node->data;
2655 simap_put(&p->ofp_requests, name,
2656 ofp_to_u16(iface_hint->ofp_port));
2659 netdev = ofport_open(p, &ofproto_port, &pp);
2661 ofport_install(p, netdev, &pp);
2662 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2663 p->alloc_port_no = MAX(p->alloc_port_no,
2664 ofp_to_u16(ofproto_port.ofp_port));
2670 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2671 struct iface_hint *iface_hint = node->data;
2673 if (!strcmp(iface_hint->br_name, p->name)) {
2674 free(iface_hint->br_name);
2675 free(iface_hint->br_type);
2677 shash_delete(&init_ofp_ports, node);
2684 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2685 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2687 find_min_mtu(struct ofproto *p)
2689 struct ofport *ofport;
2692 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2693 struct netdev *netdev = ofport->netdev;
2696 /* Skip any internal ports, since that's what we're trying to
2698 if (!strcmp(netdev_get_type(netdev), "internal")) {
2702 if (netdev_get_mtu(netdev, &dev_mtu)) {
2705 if (!mtu || dev_mtu < mtu) {
2710 return mtu ? mtu: ETH_PAYLOAD_MAX;
2713 /* Update MTU of all datapath devices on 'p' to the minimum of the
2714 * non-datapath ports in event of 'port' added or changed. */
2716 update_mtu(struct ofproto *p, struct ofport *port)
2718 struct ofport *ofport;
2719 struct netdev *netdev = port->netdev;
2720 int dev_mtu, old_min;
2722 if (netdev_get_mtu(netdev, &dev_mtu)) {
2726 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2727 if (dev_mtu > p->min_mtu) {
2728 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2729 dev_mtu = p->min_mtu;
2732 port->mtu = dev_mtu;
2736 /* For non-internal port find new min mtu. */
2737 old_min = p->min_mtu;
2738 port->mtu = dev_mtu;
2739 p->min_mtu = find_min_mtu(p);
2740 if (p->min_mtu == old_min) {
2744 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2745 struct netdev *netdev = ofport->netdev;
2747 if (!strcmp(netdev_get_type(netdev), "internal")) {
2748 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2749 ofport->mtu = p->min_mtu;
2756 ofproto_rule_destroy__(struct rule *rule)
2757 OVS_NO_THREAD_SAFETY_ANALYSIS
2759 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2760 rule_actions_destroy(rule_get_actions(rule));
2761 ovs_mutex_destroy(&rule->mutex);
2762 rule->ofproto->ofproto_class->rule_dealloc(rule);
2766 rule_destroy_cb(struct rule *rule)
2767 OVS_NO_THREAD_SAFETY_ANALYSIS
2769 /* Send rule removed if needed. */
2770 if (rule->flags & OFPUTIL_FF_SEND_FLOW_REM
2771 && rule->removed_reason != OVS_OFPRR_NONE
2772 && !rule_is_hidden(rule)) {
2773 ofproto_rule_send_removed(rule);
2775 rule->ofproto->ofproto_class->rule_destruct(rule);
2776 ofproto_rule_destroy__(rule);
2780 ofproto_rule_ref(struct rule *rule)
2783 ovs_refcount_ref(&rule->ref_count);
2788 ofproto_rule_try_ref(struct rule *rule)
2791 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2796 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2797 * ref_count reaches 0.
2799 * Use of RCU allows short term use (between RCU quiescent periods) without
2800 * keeping a reference. A reference must be taken if the rule needs to
2801 * stay around accross the RCU quiescent periods. */
2803 ofproto_rule_unref(struct rule *rule)
2805 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2806 ovsrcu_postpone(rule_destroy_cb, rule);
2811 remove_rule_rcu__(struct rule *rule)
2812 OVS_REQUIRES(ofproto_mutex)
2814 struct ofproto *ofproto = rule->ofproto;
2815 struct oftable *table = &ofproto->tables[rule->table_id];
2817 ovs_assert(!cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
2818 if (!classifier_remove(&table->cls, &rule->cr)) {
2821 ofproto->ofproto_class->rule_delete(rule);
2822 ofproto_rule_unref(rule);
2826 remove_rule_rcu(struct rule *rule)
2827 OVS_EXCLUDED(ofproto_mutex)
2829 ovs_mutex_lock(&ofproto_mutex);
2830 remove_rule_rcu__(rule);
2831 ovs_mutex_unlock(&ofproto_mutex);
2834 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2836 remove_rules_rcu(struct rule **rules)
2837 OVS_EXCLUDED(ofproto_mutex)
2839 struct rule **orig_rules = rules;
2842 struct ofproto *ofproto = rules[0]->ofproto;
2843 unsigned long tables[BITMAP_N_LONGS(256)];
2847 memset(tables, 0, sizeof tables);
2849 ovs_mutex_lock(&ofproto_mutex);
2850 while ((rule = *rules++)) {
2851 /* Defer once for each new table. This defers the subtable cleanup
2852 * until later, so that when removing large number of flows the
2853 * operation is faster. */
2854 if (!bitmap_is_set(tables, rule->table_id)) {
2855 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
2857 bitmap_set1(tables, rule->table_id);
2858 classifier_defer(cls);
2860 remove_rule_rcu__(rule);
2863 BITMAP_FOR_EACH_1(table_id, 256, tables) {
2864 struct classifier *cls = &ofproto->tables[table_id].cls;
2866 classifier_publish(cls);
2868 ovs_mutex_unlock(&ofproto_mutex);
2875 ofproto_group_ref(struct ofgroup *group)
2878 ovs_refcount_ref(&group->ref_count);
2883 ofproto_group_unref(struct ofgroup *group)
2885 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2886 group->ofproto->ofproto_class->group_destruct(group);
2887 ofputil_bucket_list_destroy(&group->buckets);
2888 group->ofproto->ofproto_class->group_dealloc(group);
2892 static uint32_t get_provider_meter_id(const struct ofproto *,
2893 uint32_t of_meter_id);
2895 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2896 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2897 const struct rule_actions *
2898 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2900 struct rule_actions *actions;
2902 actions = xmalloc(sizeof *actions + ofpacts_len);
2903 actions->ofpacts_len = ofpacts_len;
2904 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2905 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2907 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2913 /* Free the actions after the RCU quiescent period is reached. */
2915 rule_actions_destroy(const struct rule_actions *actions)
2918 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2922 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2923 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2925 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2926 OVS_REQUIRES(ofproto_mutex)
2928 if (port == OFPP_ANY) {
2931 const struct rule_actions *actions = rule_get_actions(rule);
2932 return ofpacts_output_to_port(actions->ofpacts,
2933 actions->ofpacts_len, port);
2937 /* Returns true if 'rule' has group and equals group_id. */
2939 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2940 OVS_REQUIRES(ofproto_mutex)
2942 if (group_id == OFPG_ANY) {
2945 const struct rule_actions *actions = rule_get_actions(rule);
2946 return ofpacts_output_to_group(actions->ofpacts,
2947 actions->ofpacts_len, group_id);
2952 rule_execute_destroy(struct rule_execute *e)
2954 ofproto_rule_unref(e->rule);
2955 list_remove(&e->list_node);
2959 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2960 * by passing them to the ofproto provider. */
2962 run_rule_executes(struct ofproto *ofproto)
2963 OVS_EXCLUDED(ofproto_mutex)
2965 struct rule_execute *e, *next;
2966 struct ovs_list executes;
2968 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2969 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2972 flow_extract(e->packet, &flow);
2973 flow.in_port.ofp_port = e->in_port;
2974 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2976 rule_execute_destroy(e);
2980 /* Destroys and discards all "rule_execute" operations queued up in
2981 * ofproto->rule_executes. */
2983 destroy_rule_executes(struct ofproto *ofproto)
2985 struct rule_execute *e, *next;
2986 struct ovs_list executes;
2988 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2989 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2990 dp_packet_delete(e->packet);
2991 rule_execute_destroy(e);
2996 rule_is_readonly(const struct rule *rule)
2998 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2999 return (table->flags & OFTABLE_READONLY) != 0;
3003 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
3005 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
3006 return hash_3words(cookie, cookie >> 32, table_id);
3010 learned_cookies_update_one__(struct ofproto *ofproto,
3011 const struct ofpact_learn *learn,
3012 int delta, struct ovs_list *dead_cookies)
3013 OVS_REQUIRES(ofproto_mutex)
3015 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
3016 struct learned_cookie *c;
3018 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
3019 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
3021 ovs_assert(c->n >= 0);
3024 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
3025 list_push_back(dead_cookies, &c->u.list_node);
3032 ovs_assert(delta > 0);
3033 c = xmalloc(sizeof *c);
3034 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
3035 c->cookie = learn->cookie;
3036 c->table_id = learn->table_id;
3040 static const struct ofpact_learn *
3041 next_learn_with_delete(const struct rule_actions *actions,
3042 const struct ofpact_learn *start)
3044 const struct ofpact *pos;
3046 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
3047 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
3048 pos = ofpact_next(pos)) {
3049 if (pos->type == OFPACT_LEARN) {
3050 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
3051 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3061 learned_cookies_update__(struct ofproto *ofproto,
3062 const struct rule_actions *actions,
3063 int delta, struct ovs_list *dead_cookies)
3064 OVS_REQUIRES(ofproto_mutex)
3066 if (actions->has_learn_with_delete) {
3067 const struct ofpact_learn *learn;
3069 for (learn = next_learn_with_delete(actions, NULL); learn;
3070 learn = next_learn_with_delete(actions, learn)) {
3071 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3077 learned_cookies_inc(struct ofproto *ofproto,
3078 const struct rule_actions *actions)
3079 OVS_REQUIRES(ofproto_mutex)
3081 learned_cookies_update__(ofproto, actions, +1, NULL);
3085 learned_cookies_dec(struct ofproto *ofproto,
3086 const struct rule_actions *actions,
3087 struct ovs_list *dead_cookies)
3088 OVS_REQUIRES(ofproto_mutex)
3090 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3094 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3095 OVS_REQUIRES(ofproto_mutex)
3097 struct learned_cookie *c;
3099 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3100 struct rule_criteria criteria;
3101 struct rule_collection rules;
3104 match_init_catchall(&match);
3105 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3106 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3107 rule_criteria_require_rw(&criteria, false);
3108 collect_rules_loose(ofproto, &criteria, &rules);
3109 rule_criteria_destroy(&criteria);
3110 delete_flows__(&rules, OFPRR_DELETE, NULL);
3117 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3119 ofconn_send_reply(ofconn, make_echo_reply(oh));
3124 query_tables(struct ofproto *ofproto,
3125 struct ofputil_table_features **featuresp,
3126 struct ofputil_table_stats **statsp)
3128 struct mf_bitmap rw_fields = oxm_writable_fields();
3129 struct mf_bitmap match = oxm_matchable_fields();
3130 struct mf_bitmap mask = oxm_maskable_fields();
3132 struct ofputil_table_features *features;
3133 struct ofputil_table_stats *stats;
3136 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3137 for (i = 0; i < ofproto->n_tables; i++) {
3138 struct ofputil_table_features *f = &features[i];
3141 sprintf(f->name, "table%d", i);
3142 f->metadata_match = OVS_BE64_MAX;
3143 f->metadata_write = OVS_BE64_MAX;
3144 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3145 f->max_entries = 1000000;
3147 bool more_tables = false;
3148 for (int j = i + 1; j < ofproto->n_tables; j++) {
3149 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3150 bitmap_set1(f->nonmiss.next, j);
3154 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3156 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3158 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3159 f->nonmiss.write.set_fields = rw_fields;
3160 f->nonmiss.apply = f->nonmiss.write;
3161 f->miss = f->nonmiss;
3165 f->wildcard = match;
3169 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3170 for (i = 0; i < ofproto->n_tables; i++) {
3171 struct ofputil_table_stats *s = &stats[i];
3174 s->active_count = ofproto->tables[i].n_flows;
3176 s->active_count -= connmgr_count_hidden_rules(
3184 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3186 for (i = 0; i < ofproto->n_tables; i++) {
3187 const struct oftable *table = &ofproto->tables[i];
3188 struct ofputil_table_features *f = &features[i];
3191 ovs_strzcpy(f->name, table->name, sizeof f->name);
3194 if (table->max_flows < f->max_entries) {
3195 f->max_entries = table->max_flows;
3201 query_switch_features(struct ofproto *ofproto,
3202 bool *arp_match_ip, uint64_t *ofpacts)
3204 struct ofputil_table_features *features, *f;
3206 *arp_match_ip = false;
3209 query_tables(ofproto, &features, NULL);
3210 for (f = features; f < &features[ofproto->n_tables]; f++) {
3211 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3212 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3213 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3214 *arp_match_ip = true;
3220 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3224 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3226 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3227 struct ofputil_switch_features features;
3228 struct ofport *port;
3232 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3234 features.datapath_id = ofproto->datapath_id;
3235 features.n_buffers = pktbuf_capacity();
3236 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3237 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3238 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3239 OFPUTIL_C_GROUP_STATS);
3241 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3243 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3244 features.auxiliary_id = 0;
3245 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3247 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3248 ofputil_put_switch_features_port(&port->pp, b);
3251 ofconn_send_reply(ofconn, b);
3256 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3258 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3259 struct ofp_switch_config *osc;
3260 enum ofp_config_flags flags;
3264 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3265 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3266 flags = ofproto->frag_handling;
3267 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3268 if (oh->version < OFP13_VERSION
3269 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3270 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3272 osc->flags = htons(flags);
3273 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3274 ofconn_send_reply(ofconn, buf);
3280 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3282 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3283 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3284 uint16_t flags = ntohs(osc->flags);
3286 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3287 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3288 enum ofp_config_flags cur = ofproto->frag_handling;
3289 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3291 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3293 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3294 ofproto->frag_handling = next;
3296 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3298 ofputil_frag_handling_to_string(next));
3302 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3303 ofconn_set_invalid_ttl_to_controller(ofconn,
3304 (oh->version < OFP13_VERSION
3305 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3307 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3312 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3313 * error message code for the caller to propagate upward. Otherwise, returns
3316 * The log message mentions 'msg_type'. */
3318 reject_slave_controller(struct ofconn *ofconn)
3320 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3321 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3322 return OFPERR_OFPBRC_IS_SLAVE;
3328 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3331 * - If they use a meter, then 'ofproto' has that meter configured.
3333 * - If they use any groups, then 'ofproto' has that group configured.
3335 * Returns 0 if successful, otherwise an OpenFlow error. */
3337 ofproto_check_ofpacts(struct ofproto *ofproto,
3338 const struct ofpact ofpacts[], size_t ofpacts_len)
3340 const struct ofpact *a;
3343 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3344 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3345 return OFPERR_OFPMMFC_INVALID_METER;
3348 OFPACT_FOR_EACH_FLATTENED (a, ofpacts, ofpacts_len) {
3349 if (a->type == OFPACT_GROUP
3350 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3351 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3359 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3361 struct ofproto *p = ofconn_get_ofproto(ofconn);
3362 struct ofputil_packet_out po;
3363 struct dp_packet *payload;
3364 uint64_t ofpacts_stub[1024 / 8];
3365 struct ofpbuf ofpacts;
3369 COVERAGE_INC(ofproto_packet_out);
3371 error = reject_slave_controller(ofconn);
3376 /* Decode message. */
3377 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3378 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3380 goto exit_free_ofpacts;
3382 if (ofp_to_u16(po.in_port) >= p->max_ports
3383 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3384 error = OFPERR_OFPBRC_BAD_PORT;
3385 goto exit_free_ofpacts;
3389 if (po.buffer_id != UINT32_MAX) {
3390 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3391 if (error || !payload) {
3392 goto exit_free_ofpacts;
3395 /* Ensure that the L3 header is 32-bit aligned. */
3396 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3399 /* Verify actions against packet, then send packet if successful. */
3400 flow_extract(payload, &flow);
3401 flow.in_port.ofp_port = po.in_port;
3403 /* Check actions like for flow mods. We pass a 'table_id' of 0 to
3404 * ofproto_check_consistency(), which isn't strictly correct because these
3405 * actions aren't in any table. This is OK as 'table_id' is only used to
3406 * check instructions (e.g., goto-table), which can't appear on the action
3407 * list of a packet-out. */
3408 error = ofpacts_check_consistency(po.ofpacts, po.ofpacts_len,
3409 &flow, u16_to_ofp(p->max_ports),
3411 ofconn_get_protocol(ofconn));
3413 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3415 error = p->ofproto_class->packet_out(p, payload, &flow,
3416 po.ofpacts, po.ofpacts_len);
3419 dp_packet_delete(payload);
3422 ofpbuf_uninit(&ofpacts);
3428 update_port_config(struct ofconn *ofconn, struct ofport *port,
3429 enum ofputil_port_config config,
3430 enum ofputil_port_config mask)
3432 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3434 if (toggle & OFPUTIL_PC_PORT_DOWN
3435 && (config & OFPUTIL_PC_PORT_DOWN
3436 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3437 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3438 /* We tried to bring the port up or down, but it failed, so don't
3439 * update the "down" bit. */
3440 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3444 enum ofputil_port_config old_config = port->pp.config;
3445 port->pp.config ^= toggle;
3446 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3447 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3453 port_mod_start(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3454 struct ofport **port)
3456 struct ofproto *p = ofconn_get_ofproto(ofconn);
3458 *port = ofproto_get_port(p, pm->port_no);
3460 return OFPERR_OFPPMFC_BAD_PORT;
3462 if (!eth_addr_equals((*port)->pp.hw_addr, pm->hw_addr)) {
3463 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3469 port_mod_finish(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3470 struct ofport *port)
3472 update_port_config(ofconn, port, pm->config, pm->mask);
3473 if (pm->advertise) {
3474 netdev_set_advertisements(port->netdev, pm->advertise);
3479 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3481 struct ofputil_port_mod pm;
3482 struct ofport *port;
3485 error = reject_slave_controller(ofconn);
3490 error = ofputil_decode_port_mod(oh, &pm, false);
3495 error = port_mod_start(ofconn, &pm, &port);
3497 port_mod_finish(ofconn, &pm, port);
3503 handle_desc_stats_request(struct ofconn *ofconn,
3504 const struct ofp_header *request)
3506 static const char *default_mfr_desc = "Nicira, Inc.";
3507 static const char *default_hw_desc = "Open vSwitch";
3508 static const char *default_sw_desc = VERSION;
3509 static const char *default_serial_desc = "None";
3510 static const char *default_dp_desc = "None";
3512 struct ofproto *p = ofconn_get_ofproto(ofconn);
3513 struct ofp_desc_stats *ods;
3516 msg = ofpraw_alloc_stats_reply(request, 0);
3517 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3518 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3519 sizeof ods->mfr_desc);
3520 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3521 sizeof ods->hw_desc);
3522 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3523 sizeof ods->sw_desc);
3524 ovs_strlcpy(ods->serial_num,
3525 p->serial_desc ? p->serial_desc : default_serial_desc,
3526 sizeof ods->serial_num);
3527 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3528 sizeof ods->dp_desc);
3529 ofconn_send_reply(ofconn, msg);
3535 handle_table_stats_request(struct ofconn *ofconn,
3536 const struct ofp_header *request)
3538 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3539 struct ofputil_table_features *features;
3540 struct ofputil_table_stats *stats;
3541 struct ofpbuf *reply;
3544 query_tables(ofproto, &features, &stats);
3546 reply = ofputil_encode_table_stats_reply(request);
3547 for (i = 0; i < ofproto->n_tables; i++) {
3548 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3549 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3552 ofconn_send_reply(ofconn, reply);
3561 handle_table_features_request(struct ofconn *ofconn,
3562 const struct ofp_header *request)
3564 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3565 struct ofputil_table_features *features;
3566 struct ovs_list replies;
3570 ofpbuf_use_const(&msg, request, ntohs(request->length));
3571 ofpraw_pull_assert(&msg);
3572 if (msg.size || ofpmp_more(request)) {
3573 return OFPERR_OFPTFFC_EPERM;
3576 query_tables(ofproto, &features, NULL);
3578 ofpmp_init(&replies, request);
3579 for (i = 0; i < ofproto->n_tables; i++) {
3580 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3581 ofputil_append_table_features_reply(&features[i], &replies);
3584 ofconn_send_replies(ofconn, &replies);
3591 /* This function queries the database for dumping table-desc. */
3593 query_tables_desc(struct ofproto *ofproto, struct ofputil_table_desc **descp)
3595 struct ofputil_table_desc *table_desc;
3598 table_desc = *descp = xcalloc(ofproto->n_tables, sizeof *table_desc);
3599 for (i = 0; i < ofproto->n_tables; i++) {
3600 struct ofputil_table_desc *td = &table_desc[i];
3602 td->eviction = (ofproto->tables[i].eviction & EVICTION_OPENFLOW
3603 ? OFPUTIL_TABLE_EVICTION_ON
3604 : OFPUTIL_TABLE_EVICTION_OFF);
3605 td->eviction_flags = OFPROTO_EVICTION_FLAGS;
3609 /* Function to handle dump-table-desc request. */
3611 handle_table_desc_request(struct ofconn *ofconn,
3612 const struct ofp_header *request)
3614 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3615 struct ofputil_table_desc *table_desc;
3616 struct ovs_list replies;
3619 query_tables_desc(ofproto, &table_desc);
3620 ofpmp_init(&replies, request);
3621 for (i = 0; i < ofproto->n_tables; i++) {
3622 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3623 ofputil_append_table_desc_reply(&table_desc[i], &replies,
3627 ofconn_send_replies(ofconn, &replies);
3633 append_port_stat(struct ofport *port, struct ovs_list *replies)
3635 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3637 calc_duration(port->created, time_msec(),
3638 &ops.duration_sec, &ops.duration_nsec);
3640 /* Intentionally ignore return value, since errors will set
3641 * 'stats' to all-1s, which is correct for OpenFlow, and
3642 * netdev_get_stats() will log errors. */
3643 ofproto_port_get_stats(port, &ops.stats);
3645 ofputil_append_port_stat(replies, &ops);
3649 handle_port_request(struct ofconn *ofconn,
3650 const struct ofp_header *request, ofp_port_t port_no,
3651 void (*cb)(struct ofport *, struct ovs_list *replies))
3653 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3654 struct ofport *port;
3655 struct ovs_list replies;
3657 ofpmp_init(&replies, request);
3658 if (port_no != OFPP_ANY) {
3659 port = ofproto_get_port(ofproto, port_no);
3664 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3669 ofconn_send_replies(ofconn, &replies);
3673 handle_port_stats_request(struct ofconn *ofconn,
3674 const struct ofp_header *request)
3679 error = ofputil_decode_port_stats_request(request, &port_no);
3681 handle_port_request(ofconn, request, port_no, append_port_stat);
3687 append_port_desc(struct ofport *port, struct ovs_list *replies)
3689 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3693 handle_port_desc_stats_request(struct ofconn *ofconn,
3694 const struct ofp_header *request)
3699 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3701 handle_port_request(ofconn, request, port_no, append_port_desc);
3707 hash_cookie(ovs_be64 cookie)
3709 return hash_uint64((OVS_FORCE uint64_t)cookie);
3713 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3714 OVS_REQUIRES(ofproto_mutex)
3716 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3717 hash_cookie(rule->flow_cookie));
3721 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3722 OVS_REQUIRES(ofproto_mutex)
3724 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3728 calc_duration(long long int start, long long int now,
3729 uint32_t *sec, uint32_t *nsec)
3731 long long int msecs = now - start;
3732 *sec = msecs / 1000;
3733 *nsec = (msecs % 1000) * (1000 * 1000);
3736 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3737 * true if 'table_id' is OK, false otherwise. */
3739 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3741 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3744 static struct oftable *
3745 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3747 struct oftable *table;
3749 for (table = &ofproto->tables[table_id];
3750 table < &ofproto->tables[ofproto->n_tables];
3752 if (!(table->flags & OFTABLE_HIDDEN)) {
3760 static struct oftable *
3761 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3763 if (table_id == 0xff) {
3764 return next_visible_table(ofproto, 0);
3765 } else if (table_id < ofproto->n_tables) {
3766 return &ofproto->tables[table_id];
3772 static struct oftable *
3773 next_matching_table(const struct ofproto *ofproto,
3774 const struct oftable *table, uint8_t table_id)
3776 return (table_id == 0xff
3777 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3781 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3783 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3784 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3786 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3787 * only once, for that table. (This can be used to access tables marked
3790 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3791 * entered at all. (Perhaps you should have validated TABLE_ID with
3792 * check_table_id().)
3794 * All parameters are evaluated multiple times.
3796 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3797 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3799 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3801 /* Initializes 'criteria' in a straightforward way based on the other
3804 * By default, the criteria include flows that are read-only, on the assumption
3805 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3806 * if flows will be modified.
3808 * For "loose" matching, the 'priority' parameter is unimportant and may be
3811 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3812 const struct match *match, int priority,
3813 cls_version_t version, ovs_be64 cookie,
3814 ovs_be64 cookie_mask, ofp_port_t out_port,
3817 criteria->table_id = table_id;
3818 cls_rule_init(&criteria->cr, match, priority);
3819 criteria->version = version;
3820 criteria->cookie = cookie;
3821 criteria->cookie_mask = cookie_mask;
3822 criteria->out_port = out_port;
3823 criteria->out_group = out_group;
3825 /* We ordinarily want to skip hidden rules, but there has to be a way for
3826 * code internal to OVS to modify and delete them, so if the criteria
3827 * specify a priority that can only be for a hidden flow, then allow hidden
3828 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3829 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3831 criteria->include_hidden = priority > UINT16_MAX;
3833 /* We assume that the criteria are being used to collect flows for reading
3834 * but not modification. Thus, we should collect read-only flows. */
3835 criteria->include_readonly = true;
3838 /* By default, criteria initialized by rule_criteria_init() will match flows
3839 * that are read-only, on the assumption that the collected flows won't be
3840 * modified. Call this function to match only flows that are be modifiable.
3842 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3843 * caller has special privileges that allow it to modify even "read-only"
3846 rule_criteria_require_rw(struct rule_criteria *criteria,
3847 bool can_write_readonly)
3849 criteria->include_readonly = can_write_readonly;
3853 rule_criteria_destroy(struct rule_criteria *criteria)
3855 cls_rule_destroy(&criteria->cr);
3859 rule_collection_init(struct rule_collection *rules)
3861 rules->rules = rules->stub;
3863 rules->capacity = ARRAY_SIZE(rules->stub);
3867 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3869 if (rules->n >= rules->capacity) {
3870 size_t old_size, new_size;
3872 old_size = rules->capacity * sizeof *rules->rules;
3873 rules->capacity *= 2;
3874 new_size = rules->capacity * sizeof *rules->rules;
3876 if (rules->rules == rules->stub) {
3877 rules->rules = xmalloc(new_size);
3878 memcpy(rules->rules, rules->stub, old_size);
3880 rules->rules = xrealloc(rules->rules, new_size);
3884 rules->rules[rules->n++] = rule;
3888 rule_collection_ref(struct rule_collection *rules)
3889 OVS_REQUIRES(ofproto_mutex)
3893 for (i = 0; i < rules->n; i++) {
3894 ofproto_rule_ref(rules->rules[i]);
3899 rule_collection_unref(struct rule_collection *rules)
3903 for (i = 0; i < rules->n; i++) {
3904 ofproto_rule_unref(rules->rules[i]);
3908 /* Returns a NULL-terminated array of rule pointers,
3909 * destroys 'rules'. */
3910 static struct rule **
3911 rule_collection_detach(struct rule_collection *rules)
3913 struct rule **rule_array;
3915 rule_collection_add(rules, NULL);
3917 if (rules->rules == rules->stub) {
3918 rules->rules = xmemdup(rules->rules, rules->n * sizeof *rules->rules);
3921 rule_array = rules->rules;
3922 rule_collection_init(rules);
3928 rule_collection_destroy(struct rule_collection *rules)
3930 if (rules->rules != rules->stub) {
3934 /* Make repeated destruction harmless. */
3935 rule_collection_init(rules);
3938 /* Schedules postponed removal of rules, destroys 'rules'. */
3940 rule_collection_remove_postponed(struct rule_collection *rules)
3941 OVS_REQUIRES(ofproto_mutex)
3944 if (rules->n == 1) {
3945 ovsrcu_postpone(remove_rule_rcu, rules->rules[0]);
3947 ovsrcu_postpone(remove_rules_rcu, rule_collection_detach(rules));
3952 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3953 * function verifies most of the criteria in 'c' itself, but the caller must
3954 * check 'c->cr' itself.
3956 * Rules that have already been marked for removal are not collected.
3958 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3959 * 'c' only includes modifiable rules). */
3961 collect_rule(struct rule *rule, const struct rule_criteria *c,
3962 struct rule_collection *rules, size_t *n_readonly)
3963 OVS_REQUIRES(ofproto_mutex)
3965 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3966 && ofproto_rule_has_out_port(rule, c->out_port)
3967 && ofproto_rule_has_out_group(rule, c->out_group)
3968 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3969 && (!rule_is_hidden(rule) || c->include_hidden)
3970 && cls_rule_visible_in_version(&rule->cr, c->version)) {
3971 /* Rule matches all the criteria... */
3972 if (!rule_is_readonly(rule) || c->include_readonly) {
3974 rule_collection_add(rules, rule);
3976 /* ...except it's read-only. */
3982 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3983 * on classifiers rules are done in the "loose" way required for OpenFlow
3984 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3987 * Returns 0 on success, otherwise an OpenFlow error code. */
3989 collect_rules_loose(struct ofproto *ofproto,
3990 const struct rule_criteria *criteria,
3991 struct rule_collection *rules)
3992 OVS_REQUIRES(ofproto_mutex)
3994 struct oftable *table;
3995 enum ofperr error = 0;
3996 size_t n_readonly = 0;
3998 rule_collection_init(rules);
4000 if (!check_table_id(ofproto, criteria->table_id)) {
4001 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4005 if (criteria->cookie_mask == OVS_BE64_MAX) {
4008 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4009 hash_cookie(criteria->cookie),
4010 &ofproto->cookies) {
4011 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
4012 collect_rule(rule, criteria, rules, &n_readonly);
4016 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4019 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr,
4020 criteria->version) {
4021 collect_rule(rule, criteria, rules, &n_readonly);
4027 if (!error && !rules->n && n_readonly) {
4028 /* We didn't find any rules to modify. We did find some read-only
4029 * rules that we're not allowed to modify, so report that. */
4030 error = OFPERR_OFPBRC_EPERM;
4033 rule_collection_destroy(rules);
4038 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4039 * on classifiers rules are done in the "strict" way required for OpenFlow
4040 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
4041 * rules on list 'rules'.
4043 * Returns 0 on success, otherwise an OpenFlow error code. */
4045 collect_rules_strict(struct ofproto *ofproto,
4046 const struct rule_criteria *criteria,
4047 struct rule_collection *rules)
4048 OVS_REQUIRES(ofproto_mutex)
4050 struct oftable *table;
4051 size_t n_readonly = 0;
4052 enum ofperr error = 0;
4054 rule_collection_init(rules);
4056 if (!check_table_id(ofproto, criteria->table_id)) {
4057 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4061 if (criteria->cookie_mask == OVS_BE64_MAX) {
4064 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4065 hash_cookie(criteria->cookie),
4066 &ofproto->cookies) {
4067 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
4068 collect_rule(rule, criteria, rules, &n_readonly);
4072 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4075 rule = rule_from_cls_rule(classifier_find_rule_exactly(
4076 &table->cls, &criteria->cr,
4077 criteria->version));
4079 collect_rule(rule, criteria, rules, &n_readonly);
4085 if (!error && !rules->n && n_readonly) {
4086 /* We didn't find any rules to modify. We did find some read-only
4087 * rules that we're not allowed to modify, so report that. */
4088 error = OFPERR_OFPBRC_EPERM;
4091 rule_collection_destroy(rules);
4096 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4097 * forced into the range of a uint16_t. */
4099 age_secs(long long int age_ms)
4101 return (age_ms < 0 ? 0
4102 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
4103 : (unsigned int) age_ms / 1000);
4107 handle_flow_stats_request(struct ofconn *ofconn,
4108 const struct ofp_header *request)
4109 OVS_EXCLUDED(ofproto_mutex)
4111 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4112 struct ofputil_flow_stats_request fsr;
4113 struct rule_criteria criteria;
4114 struct rule_collection rules;
4115 struct ovs_list replies;
4119 error = ofputil_decode_flow_stats_request(&fsr, request);
4124 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
4125 fsr.cookie, fsr.cookie_mask, fsr.out_port,
4128 ovs_mutex_lock(&ofproto_mutex);
4129 error = collect_rules_loose(ofproto, &criteria, &rules);
4130 rule_criteria_destroy(&criteria);
4132 rule_collection_ref(&rules);
4134 ovs_mutex_unlock(&ofproto_mutex);
4140 ofpmp_init(&replies, request);
4141 for (i = 0; i < rules.n; i++) {
4142 struct rule *rule = rules.rules[i];
4143 long long int now = time_msec();
4144 struct ofputil_flow_stats fs;
4145 long long int created, used, modified;
4146 const struct rule_actions *actions;
4147 enum ofputil_flow_mod_flags flags;
4149 ovs_mutex_lock(&rule->mutex);
4150 fs.cookie = rule->flow_cookie;
4151 fs.idle_timeout = rule->idle_timeout;
4152 fs.hard_timeout = rule->hard_timeout;
4153 fs.importance = rule->importance;
4154 created = rule->created;
4155 modified = rule->modified;
4156 actions = rule_get_actions(rule);
4157 flags = rule->flags;
4158 ovs_mutex_unlock(&rule->mutex);
4160 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
4161 &fs.byte_count, &used);
4163 minimatch_expand(&rule->cr.match, &fs.match);
4164 fs.table_id = rule->table_id;
4165 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4166 fs.priority = rule->cr.priority;
4167 fs.idle_age = age_secs(now - used);
4168 fs.hard_age = age_secs(now - modified);
4169 fs.ofpacts = actions->ofpacts;
4170 fs.ofpacts_len = actions->ofpacts_len;
4173 ofputil_append_flow_stats_reply(&fs, &replies);
4176 rule_collection_unref(&rules);
4177 rule_collection_destroy(&rules);
4179 ofconn_send_replies(ofconn, &replies);
4185 flow_stats_ds(struct rule *rule, struct ds *results)
4187 uint64_t packet_count, byte_count;
4188 const struct rule_actions *actions;
4189 long long int created, used;
4191 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4192 &byte_count, &used);
4194 ovs_mutex_lock(&rule->mutex);
4195 actions = rule_get_actions(rule);
4196 created = rule->created;
4197 ovs_mutex_unlock(&rule->mutex);
4199 if (rule->table_id != 0) {
4200 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4202 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4203 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4204 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4205 cls_rule_format(&rule->cr, results);
4206 ds_put_char(results, ',');
4208 ds_put_cstr(results, "actions=");
4209 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4211 ds_put_cstr(results, "\n");
4214 /* Adds a pretty-printed description of all flows to 'results', including
4215 * hidden flows (e.g., set up by in-band control). */
4217 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4219 struct oftable *table;
4221 OFPROTO_FOR_EACH_TABLE (table, p) {
4224 CLS_FOR_EACH (rule, cr, &table->cls) {
4225 flow_stats_ds(rule, results);
4230 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4231 * '*engine_type' and '*engine_id', respectively. */
4233 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4234 uint8_t *engine_type, uint8_t *engine_id)
4236 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4239 /* Checks the status change of CFM on 'ofport'.
4241 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4243 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4245 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4246 return (ofport && ofproto->ofproto_class->cfm_status_changed
4247 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4251 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4252 * Returns 0 if the port's CFM status was successfully stored into
4253 * '*status'. Returns positive errno if the port did not have CFM
4256 * The caller must provide and own '*status', and must free 'status->rmps'.
4257 * '*status' is indeterminate if the return value is non-zero. */
4259 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4260 struct cfm_status *status)
4262 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4263 return (ofport && ofproto->ofproto_class->get_cfm_status
4264 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4269 handle_aggregate_stats_request(struct ofconn *ofconn,
4270 const struct ofp_header *oh)
4271 OVS_EXCLUDED(ofproto_mutex)
4273 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4274 struct ofputil_flow_stats_request request;
4275 struct ofputil_aggregate_stats stats;
4276 bool unknown_packets, unknown_bytes;
4277 struct rule_criteria criteria;
4278 struct rule_collection rules;
4279 struct ofpbuf *reply;
4283 error = ofputil_decode_flow_stats_request(&request, oh);
4288 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4289 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4290 request.out_port, request.out_group);
4292 ovs_mutex_lock(&ofproto_mutex);
4293 error = collect_rules_loose(ofproto, &criteria, &rules);
4294 rule_criteria_destroy(&criteria);
4296 rule_collection_ref(&rules);
4298 ovs_mutex_unlock(&ofproto_mutex);
4304 memset(&stats, 0, sizeof stats);
4305 unknown_packets = unknown_bytes = false;
4306 for (i = 0; i < rules.n; i++) {
4307 struct rule *rule = rules.rules[i];
4308 uint64_t packet_count;
4309 uint64_t byte_count;
4312 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4313 &byte_count, &used);
4315 if (packet_count == UINT64_MAX) {
4316 unknown_packets = true;
4318 stats.packet_count += packet_count;
4321 if (byte_count == UINT64_MAX) {
4322 unknown_bytes = true;
4324 stats.byte_count += byte_count;
4329 if (unknown_packets) {
4330 stats.packet_count = UINT64_MAX;
4332 if (unknown_bytes) {
4333 stats.byte_count = UINT64_MAX;
4336 rule_collection_unref(&rules);
4337 rule_collection_destroy(&rules);
4339 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4340 ofconn_send_reply(ofconn, reply);
4345 struct queue_stats_cbdata {
4346 struct ofport *ofport;
4347 struct ovs_list replies;
4352 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4353 const struct netdev_queue_stats *stats)
4355 struct ofputil_queue_stats oqs;
4357 oqs.port_no = cbdata->ofport->pp.port_no;
4358 oqs.queue_id = queue_id;
4359 oqs.tx_bytes = stats->tx_bytes;
4360 oqs.tx_packets = stats->tx_packets;
4361 oqs.tx_errors = stats->tx_errors;
4362 if (stats->created != LLONG_MIN) {
4363 calc_duration(stats->created, cbdata->now,
4364 &oqs.duration_sec, &oqs.duration_nsec);
4366 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4368 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4372 handle_queue_stats_dump_cb(uint32_t queue_id,
4373 struct netdev_queue_stats *stats,
4376 struct queue_stats_cbdata *cbdata = cbdata_;
4378 put_queue_stats(cbdata, queue_id, stats);
4382 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4383 struct queue_stats_cbdata *cbdata)
4385 cbdata->ofport = port;
4386 if (queue_id == OFPQ_ALL) {
4387 netdev_dump_queue_stats(port->netdev,
4388 handle_queue_stats_dump_cb, cbdata);
4390 struct netdev_queue_stats stats;
4392 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4393 put_queue_stats(cbdata, queue_id, &stats);
4395 return OFPERR_OFPQOFC_BAD_QUEUE;
4402 handle_queue_stats_request(struct ofconn *ofconn,
4403 const struct ofp_header *rq)
4405 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4406 struct queue_stats_cbdata cbdata;
4407 struct ofport *port;
4409 struct ofputil_queue_stats_request oqsr;
4411 COVERAGE_INC(ofproto_queue_req);
4413 ofpmp_init(&cbdata.replies, rq);
4414 cbdata.now = time_msec();
4416 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4421 if (oqsr.port_no == OFPP_ANY) {
4422 error = OFPERR_OFPQOFC_BAD_QUEUE;
4423 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4424 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4429 port = ofproto_get_port(ofproto, oqsr.port_no);
4431 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4432 : OFPERR_OFPQOFC_BAD_PORT);
4435 ofconn_send_replies(ofconn, &cbdata.replies);
4437 ofpbuf_list_delete(&cbdata.replies);
4444 evict_rules_from_table(struct oftable *table)
4445 OVS_REQUIRES(ofproto_mutex)
4447 enum ofperr error = 0;
4448 struct rule_collection rules;
4449 unsigned int count = table->n_flows;
4450 unsigned int max_flows = table->max_flows;
4452 rule_collection_init(&rules);
4454 while (count-- > max_flows) {
4457 if (!choose_rule_to_evict(table, &rule)) {
4458 error = OFPERR_OFPFMFC_TABLE_FULL;
4461 eviction_group_remove_rule(rule);
4462 rule_collection_add(&rules, rule);
4465 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4471 get_conjunctions(const struct ofputil_flow_mod *fm,
4472 struct cls_conjunction **conjsp, size_t *n_conjsp)
4473 OVS_REQUIRES(ofproto_mutex)
4475 struct cls_conjunction *conjs = NULL;
4478 const struct ofpact *ofpact;
4479 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4480 if (ofpact->type == OFPACT_CONJUNCTION) {
4482 } else if (ofpact->type != OFPACT_NOTE) {
4483 /* "conjunction" may appear with "note" actions but not with any
4484 * other type of actions. */
4485 ovs_assert(!n_conjs);
4492 conjs = xzalloc(n_conjs * sizeof *conjs);
4493 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4494 if (ofpact->type == OFPACT_CONJUNCTION) {
4495 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4496 conjs[i].clause = oc->clause;
4497 conjs[i].n_clauses = oc->n_clauses;
4498 conjs[i].id = oc->id;
4505 *n_conjsp = n_conjs;
4508 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4509 * in which no matching flow already exists in the flow table.
4511 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4512 * success, or an OpenFlow error code on failure.
4514 * On successful return the caller must complete the operation either by
4515 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4518 * The caller retains ownership of 'fm->ofpacts'. */
4520 add_flow_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4521 OVS_REQUIRES(ofproto_mutex)
4523 struct ofputil_flow_mod *fm = &ofm->fm;
4524 struct rule **old_rule = &ofm->old_rules.stub[0];
4525 struct rule **new_rule = &ofm->new_rules.stub[0];
4526 struct oftable *table;
4530 struct cls_conjunction *conjs;
4534 if (!check_table_id(ofproto, fm->table_id)) {
4535 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4540 if (fm->table_id == 0xff) {
4541 if (ofproto->ofproto_class->rule_choose_table) {
4542 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4548 ovs_assert(table_id < ofproto->n_tables);
4552 } else if (fm->table_id < ofproto->n_tables) {
4553 table_id = fm->table_id;
4555 return OFPERR_OFPBRC_BAD_TABLE_ID;
4558 table = &ofproto->tables[table_id];
4559 if (table->flags & OFTABLE_READONLY
4560 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4561 return OFPERR_OFPBRC_EPERM;
4564 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4565 && !match_has_default_hidden_fields(&fm->match)) {
4566 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4567 "non-default values to hidden fields", ofproto->name);
4568 return OFPERR_OFPBRC_EPERM;
4571 cls_rule_init(&cr, &fm->match, fm->priority);
4573 /* Check for the existence of an identical rule.
4574 * This will not return rules earlier marked for removal. */
4575 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr,
4579 /* Check for overlap, if requested. */
4580 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4581 && classifier_rule_overlaps(&table->cls, &cr, ofm->version)) {
4582 cls_rule_destroy(&cr);
4583 return OFPERR_OFPFMFC_OVERLAP;
4586 /* If necessary, evict an existing rule to clear out space. */
4587 if (table->n_flows >= table->max_flows) {
4588 if (!choose_rule_to_evict(table, &rule)) {
4589 error = OFPERR_OFPFMFC_TABLE_FULL;
4590 cls_rule_destroy(&cr);
4593 eviction_group_remove_rule(rule);
4594 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4596 fm->delete_reason = OFPRR_EVICTION;
4600 fm->modify_cookie = true;
4603 /* Allocate new rule. */
4604 error = replace_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4610 get_conjunctions(fm, &conjs, &n_conjs);
4611 replace_rule_start(ofproto, ofm->version, rule, *new_rule, conjs, n_conjs);
4617 /* Revert the effects of add_flow_start(). */
4619 add_flow_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4620 OVS_REQUIRES(ofproto_mutex)
4622 struct ofputil_flow_mod *fm = &ofm->fm;
4623 struct rule *old_rule = ofm->old_rules.stub[0];
4624 struct rule *new_rule = ofm->new_rules.stub[0];
4626 if (old_rule && fm->delete_reason == OFPRR_EVICTION) {
4627 /* Revert the eviction. */
4628 eviction_group_add_rule(old_rule);
4631 replace_rule_revert(ofproto, old_rule, new_rule);
4634 /* To be called after version bump. */
4636 add_flow_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4637 const struct flow_mod_requester *req)
4638 OVS_REQUIRES(ofproto_mutex)
4640 struct ofputil_flow_mod *fm = &ofm->fm;
4641 struct rule *old_rule = ofm->old_rules.stub[0];
4642 struct rule *new_rule = ofm->new_rules.stub[0];
4643 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4645 replace_rule_finish(ofproto, fm, req, old_rule, new_rule, &dead_cookies);
4646 learned_cookies_flush(ofproto, &dead_cookies);
4649 ovsrcu_postpone(remove_rule_rcu, old_rule);
4651 if (minimask_get_vid_mask(new_rule->cr.match.mask) == VLAN_VID_MASK) {
4652 if (ofproto->vlan_bitmap) {
4653 uint16_t vid = miniflow_get_vid(new_rule->cr.match.flow);
4655 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4656 bitmap_set1(ofproto->vlan_bitmap, vid);
4657 ofproto->vlans_changed = true;
4660 ofproto->vlans_changed = true;
4664 ofmonitor_report(ofproto->connmgr, new_rule, NXFME_ADDED, 0,
4665 req ? req->ofconn : NULL,
4666 req ? req->request->xid : 0, NULL);
4669 send_buffered_packet(req, fm->buffer_id, new_rule);
4672 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4674 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4675 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4676 * structures yet. Takes ownership of 'cr'. */
4678 replace_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4679 struct cls_rule *cr, uint8_t table_id,
4680 struct rule *old_rule, struct rule **new_rule)
4685 /* Allocate new rule. */
4686 rule = ofproto->ofproto_class->rule_alloc();
4688 cls_rule_destroy(cr);
4689 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
4690 return OFPERR_OFPFMFC_UNKNOWN;
4693 /* Initialize base state. */
4694 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4695 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
4696 ovs_refcount_init(&rule->ref_count);
4697 rule->flow_cookie = fm->new_cookie;
4698 rule->created = rule->modified = time_msec();
4700 ovs_mutex_init(&rule->mutex);
4701 ovs_mutex_lock(&rule->mutex);
4702 rule->idle_timeout = fm->idle_timeout;
4703 rule->hard_timeout = fm->hard_timeout;
4704 *CONST_CAST(uint16_t *, &rule->importance) = fm->importance;
4705 rule->removed_reason = OVS_OFPRR_NONE;
4707 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
4708 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4709 *CONST_CAST(const struct rule_actions **, &rule->actions)
4710 = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4711 list_init(&rule->meter_list_node);
4712 rule->eviction_group = NULL;
4713 list_init(&rule->expirable);
4714 rule->monitor_flags = 0;
4715 rule->add_seqno = 0;
4716 rule->modify_seqno = 0;
4718 /* Copy values from old rule for modify semantics. */
4719 if (old_rule && fm->delete_reason != OFPRR_EVICTION) {
4720 bool change_cookie = (fm->modify_cookie
4721 && fm->new_cookie != OVS_BE64_MAX
4722 && fm->new_cookie != old_rule->flow_cookie);
4724 ovs_mutex_lock(&old_rule->mutex);
4725 if (fm->command != OFPFC_ADD) {
4726 rule->idle_timeout = old_rule->idle_timeout;
4727 rule->hard_timeout = old_rule->hard_timeout;
4728 *CONST_CAST(uint16_t *, &rule->importance) = old_rule->importance;
4729 rule->flags = old_rule->flags;
4730 rule->created = old_rule->created;
4732 if (!change_cookie) {
4733 rule->flow_cookie = old_rule->flow_cookie;
4735 ovs_mutex_unlock(&old_rule->mutex);
4737 ovs_mutex_unlock(&rule->mutex);
4739 /* Construct rule, initializing derived state. */
4740 error = ofproto->ofproto_class->rule_construct(rule);
4742 ofproto_rule_destroy__(rule);
4746 rule->removed = true; /* Not yet in ofproto data structures. */
4753 replace_rule_start(struct ofproto *ofproto, cls_version_t version,
4754 struct rule *old_rule, struct rule *new_rule,
4755 struct cls_conjunction *conjs, size_t n_conjs)
4757 struct oftable *table = &ofproto->tables[new_rule->table_id];
4759 /* 'old_rule' may be either an evicted rule or replaced rule. */
4761 /* Mark the old rule for removal in the next version. */
4762 cls_rule_make_invisible_in_version(&old_rule->cr, version);
4766 /* Insert flow to the classifier, so that later flow_mods may relate
4767 * to it. This is reversible, in case later errors require this to
4769 ofproto_rule_insert__(ofproto, new_rule);
4770 /* Make the new rule visible for classifier lookups only from the next
4772 classifier_insert(&table->cls, &new_rule->cr, version, conjs, n_conjs);
4775 static void replace_rule_revert(struct ofproto *ofproto,
4776 struct rule *old_rule, struct rule *new_rule)
4778 struct oftable *table = &ofproto->tables[new_rule->table_id];
4781 /* Restore the original visibility of the old rule. */
4782 cls_rule_restore_visibility(&old_rule->cr);
4784 /* Restore table's rule count. */
4788 /* Remove the new rule immediately. It was never visible to lookups. */
4789 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4792 ofproto_rule_remove__(ofproto, new_rule);
4793 /* The rule was not inserted to the ofproto provider, so we can
4794 * release it without deleting it from the ofproto provider. */
4795 ofproto_rule_unref(new_rule);
4798 /* Adds the 'new_rule', replacing the 'old_rule'. */
4800 replace_rule_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4801 const struct flow_mod_requester *req,
4802 struct rule *old_rule, struct rule *new_rule,
4803 struct ovs_list *dead_cookies)
4804 OVS_REQUIRES(ofproto_mutex)
4806 bool forward_stats = !(fm->flags & OFPUTIL_FF_RESET_COUNTS);
4807 struct rule *replaced_rule;
4809 replaced_rule = fm->delete_reason != OFPRR_EVICTION ? old_rule : NULL;
4811 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4812 * is a duplicate rule the 'new_rule' is replacing. The provider should
4813 * link the stats from the old rule to the new one if 'forward_stats' is
4814 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4815 ofproto->ofproto_class->rule_insert(new_rule, replaced_rule,
4817 learned_cookies_inc(ofproto, rule_get_actions(new_rule));
4820 const struct rule_actions *old_actions = rule_get_actions(old_rule);
4822 /* Remove the old rule from data structures. Removal from the
4823 * classifier and the deletion of the rule is RCU postponed by the
4825 ofproto_rule_remove__(ofproto, old_rule);
4826 learned_cookies_dec(ofproto, old_actions, dead_cookies);
4828 if (replaced_rule) {
4829 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4830 ? NXFME_ADDED : NXFME_MODIFIED;
4832 bool change_cookie = (fm->modify_cookie
4833 && fm->new_cookie != OVS_BE64_MAX
4834 && fm->new_cookie != old_rule->flow_cookie);
4836 bool change_actions = !ofpacts_equal(fm->ofpacts,
4838 old_actions->ofpacts,
4839 old_actions->ofpacts_len);
4841 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4842 ofmonitor_report(ofproto->connmgr, new_rule, event, 0,
4843 req ? req->ofconn : NULL,
4844 req ? req->request->xid : 0,
4845 change_actions ? old_actions : NULL);
4848 /* XXX: This is slight duplication with delete_flows_finish__() */
4850 old_rule->removed_reason = OFPRR_EVICTION;
4852 ofmonitor_report(ofproto->connmgr, old_rule, NXFME_DELETED,
4854 req ? req->ofconn : NULL,
4855 req ? req->request->xid : 0, NULL);
4861 modify_flows_start__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4862 OVS_REQUIRES(ofproto_mutex)
4864 struct ofputil_flow_mod *fm = &ofm->fm;
4865 struct rule_collection *old_rules = &ofm->old_rules;
4866 struct rule_collection *new_rules = &ofm->new_rules;
4869 rule_collection_init(new_rules);
4871 if (old_rules->n > 0) {
4872 struct cls_conjunction *conjs;
4876 /* Create a new 'modified' rule for each old rule. */
4877 for (i = 0; i < old_rules->n; i++) {
4878 struct rule *old_rule = old_rules->rules[i];
4879 struct rule *new_rule;
4882 cls_rule_clone(&cr, &old_rule->cr);
4883 error = replace_rule_create(ofproto, fm, &cr, old_rule->table_id,
4884 old_rule, &new_rule);
4886 rule_collection_add(new_rules, new_rule);
4888 rule_collection_unref(new_rules);
4889 rule_collection_destroy(new_rules);
4893 ovs_assert(new_rules->n == old_rules->n);
4895 get_conjunctions(fm, &conjs, &n_conjs);
4896 for (i = 0; i < old_rules->n; i++) {
4897 replace_rule_start(ofproto, ofm->version, old_rules->rules[i],
4898 new_rules->rules[i], conjs, n_conjs);
4901 } else if (!(fm->cookie_mask != htonll(0)
4902 || fm->new_cookie == OVS_BE64_MAX)) {
4903 /* No match, add a new flow. */
4904 error = add_flow_start(ofproto, ofm);
4906 ovs_assert(fm->delete_reason == OFPRR_EVICTION
4907 || !old_rules->rules[0]);
4917 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4920 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4923 modify_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4924 OVS_REQUIRES(ofproto_mutex)
4926 struct ofputil_flow_mod *fm = &ofm->fm;
4927 struct rule_collection *old_rules = &ofm->old_rules;
4928 struct rule_criteria criteria;
4931 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4932 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG_ANY);
4933 rule_criteria_require_rw(&criteria,
4934 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4935 error = collect_rules_loose(ofproto, &criteria, old_rules);
4936 rule_criteria_destroy(&criteria);
4939 error = modify_flows_start__(ofproto, ofm);
4943 rule_collection_destroy(old_rules);
4949 modify_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4950 OVS_REQUIRES(ofproto_mutex)
4952 struct rule_collection *old_rules = &ofm->old_rules;
4953 struct rule_collection *new_rules = &ofm->new_rules;
4955 /* Old rules were not changed yet, only need to revert new rules. */
4956 if (old_rules->n == 0 && new_rules->n == 1) {
4957 add_flow_revert(ofproto, ofm);
4958 } else if (old_rules->n > 0) {
4959 for (size_t i = 0; i < old_rules->n; i++) {
4960 replace_rule_revert(ofproto, old_rules->rules[i],
4961 new_rules->rules[i]);
4963 rule_collection_destroy(new_rules);
4964 rule_collection_destroy(old_rules);
4969 modify_flows_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4970 const struct flow_mod_requester *req)
4971 OVS_REQUIRES(ofproto_mutex)
4973 struct ofputil_flow_mod *fm = &ofm->fm;
4974 struct rule_collection *old_rules = &ofm->old_rules;
4975 struct rule_collection *new_rules = &ofm->new_rules;
4977 if (old_rules->n == 0 && new_rules->n == 1) {
4978 add_flow_finish(ofproto, ofm, req);
4979 } else if (old_rules->n > 0) {
4980 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4982 ovs_assert(new_rules->n == old_rules->n);
4984 for (size_t i = 0; i < old_rules->n; i++) {
4985 replace_rule_finish(ofproto, fm, req, old_rules->rules[i],
4986 new_rules->rules[i], &dead_cookies);
4988 learned_cookies_flush(ofproto, &dead_cookies);
4989 rule_collection_remove_postponed(old_rules);
4991 send_buffered_packet(req, fm->buffer_id, new_rules->rules[0]);
4992 rule_collection_destroy(new_rules);
4996 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4997 * code on failure. */
4999 modify_flow_start_strict(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5000 OVS_REQUIRES(ofproto_mutex)
5002 struct ofputil_flow_mod *fm = &ofm->fm;
5003 struct rule_collection *old_rules = &ofm->old_rules;
5004 struct rule_criteria criteria;
5007 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5008 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
5010 rule_criteria_require_rw(&criteria,
5011 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5012 error = collect_rules_strict(ofproto, &criteria, old_rules);
5013 rule_criteria_destroy(&criteria);
5016 /* collect_rules_strict() can return max 1 rule. */
5017 error = modify_flows_start__(ofproto, ofm);
5021 rule_collection_destroy(old_rules);
5026 /* OFPFC_DELETE implementation. */
5029 delete_flows_start__(struct ofproto *ofproto, cls_version_t version,
5030 const struct rule_collection *rules)
5031 OVS_REQUIRES(ofproto_mutex)
5033 for (size_t i = 0; i < rules->n; i++) {
5034 struct rule *rule = rules->rules[i];
5035 struct oftable *table = &ofproto->tables[rule->table_id];
5038 cls_rule_make_invisible_in_version(&rule->cr, version);
5043 delete_flows_finish__(struct ofproto *ofproto,
5044 struct rule_collection *rules,
5045 enum ofp_flow_removed_reason reason,
5046 const struct flow_mod_requester *req)
5047 OVS_REQUIRES(ofproto_mutex)
5050 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
5052 for (size_t i = 0; i < rules->n; i++) {
5053 struct rule *rule = rules->rules[i];
5055 /* This value will be used to send the flow removed message right
5056 * before the rule is actually destroyed. */
5057 rule->removed_reason = reason;
5059 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
5060 req ? req->ofconn : NULL,
5061 req ? req->request->xid : 0, NULL);
5062 ofproto_rule_remove__(ofproto, rule);
5063 learned_cookies_dec(ofproto, rule_get_actions(rule),
5066 rule_collection_remove_postponed(rules);
5068 learned_cookies_flush(ofproto, &dead_cookies);
5072 /* Deletes the rules listed in 'rules'.
5073 * The deleted rules will become invisible to the lookups in the next version.
5074 * Destroys 'rules'. */
5076 delete_flows__(struct rule_collection *rules,
5077 enum ofp_flow_removed_reason reason,
5078 const struct flow_mod_requester *req)
5079 OVS_REQUIRES(ofproto_mutex)
5082 struct ofproto *ofproto = rules->rules[0]->ofproto;
5084 delete_flows_start__(ofproto, ofproto->tables_version + 1, rules);
5085 ofproto_bump_tables_version(ofproto);
5086 delete_flows_finish__(ofproto, rules, reason, req);
5087 ofmonitor_flush(ofproto->connmgr);
5091 /* Implements OFPFC_DELETE. */
5093 delete_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5094 OVS_REQUIRES(ofproto_mutex)
5096 const struct ofputil_flow_mod *fm = &ofm->fm;
5097 struct rule_collection *rules = &ofm->old_rules;
5098 struct rule_criteria criteria;
5101 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
5102 fm->cookie, fm->cookie_mask, fm->out_port,
5104 rule_criteria_require_rw(&criteria,
5105 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5106 error = collect_rules_loose(ofproto, &criteria, rules);
5107 rule_criteria_destroy(&criteria);
5110 delete_flows_start__(ofproto, ofm->version, rules);
5117 delete_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5118 OVS_REQUIRES(ofproto_mutex)
5120 struct rule_collection *rules = &ofm->old_rules;
5122 for (size_t i = 0; i < rules->n; i++) {
5123 struct rule *rule = rules->rules[i];
5124 struct oftable *table = &ofproto->tables[rule->table_id];
5126 /* Restore table's rule count. */
5129 /* Restore the original visibility of the rule. */
5130 cls_rule_restore_visibility(&rule->cr);
5132 rule_collection_destroy(rules);
5136 delete_flows_finish(struct ofproto *ofproto,
5137 struct ofproto_flow_mod *ofm,
5138 const struct flow_mod_requester *req)
5139 OVS_REQUIRES(ofproto_mutex)
5141 delete_flows_finish__(ofproto, &ofm->old_rules, ofm->fm.delete_reason,
5145 /* Implements OFPFC_DELETE_STRICT. */
5147 delete_flow_start_strict(struct ofproto *ofproto,
5148 struct ofproto_flow_mod *ofm)
5149 OVS_REQUIRES(ofproto_mutex)
5151 const struct ofputil_flow_mod *fm = &ofm->fm;
5152 struct rule_collection *rules = &ofm->old_rules;
5153 struct rule_criteria criteria;
5156 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5157 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
5158 fm->out_port, fm->out_group);
5159 rule_criteria_require_rw(&criteria,
5160 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5161 error = collect_rules_strict(ofproto, &criteria, rules);
5162 rule_criteria_destroy(&criteria);
5165 delete_flows_start__(ofproto, ofm->version, rules);
5171 /* This may only be called by rule_destroy_cb()! */
5173 ofproto_rule_send_removed(struct rule *rule)
5174 OVS_EXCLUDED(ofproto_mutex)
5176 struct ofputil_flow_removed fr;
5179 minimatch_expand(&rule->cr.match, &fr.match);
5180 fr.priority = rule->cr.priority;
5182 ovs_mutex_lock(&ofproto_mutex);
5183 fr.cookie = rule->flow_cookie;
5184 fr.reason = rule->removed_reason;
5185 fr.table_id = rule->table_id;
5186 calc_duration(rule->created, time_msec(),
5187 &fr.duration_sec, &fr.duration_nsec);
5188 ovs_mutex_lock(&rule->mutex);
5189 fr.idle_timeout = rule->idle_timeout;
5190 fr.hard_timeout = rule->hard_timeout;
5191 ovs_mutex_unlock(&rule->mutex);
5192 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
5193 &fr.byte_count, &used);
5194 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
5195 ovs_mutex_unlock(&ofproto_mutex);
5198 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5199 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5202 * ofproto implementation ->run() functions should use this function to expire
5203 * OpenFlow flows. */
5205 ofproto_rule_expire(struct rule *rule, uint8_t reason)
5206 OVS_REQUIRES(ofproto_mutex)
5208 struct rule_collection rules;
5210 rules.rules = rules.stub;
5212 rules.stub[0] = rule;
5213 delete_flows__(&rules, reason, NULL);
5216 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5217 * means "infinite". */
5219 reduce_timeout(uint16_t max, uint16_t *timeout)
5221 if (max && (!*timeout || *timeout > max)) {
5226 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5227 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5228 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5230 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5232 ofproto_rule_reduce_timeouts(struct rule *rule,
5233 uint16_t idle_timeout, uint16_t hard_timeout)
5234 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5236 if (!idle_timeout && !hard_timeout) {
5240 ovs_mutex_lock(&ofproto_mutex);
5241 if (list_is_empty(&rule->expirable)) {
5242 list_insert(&rule->ofproto->expirable, &rule->expirable);
5244 ovs_mutex_unlock(&ofproto_mutex);
5246 ovs_mutex_lock(&rule->mutex);
5247 reduce_timeout(idle_timeout, &rule->idle_timeout);
5248 reduce_timeout(hard_timeout, &rule->hard_timeout);
5249 ovs_mutex_unlock(&rule->mutex);
5253 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5254 OVS_EXCLUDED(ofproto_mutex)
5256 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5257 struct ofproto_flow_mod ofm;
5258 uint64_t ofpacts_stub[1024 / 8];
5259 struct ofpbuf ofpacts;
5262 error = reject_slave_controller(ofconn);
5267 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5268 error = ofputil_decode_flow_mod(&ofm.fm, oh, ofconn_get_protocol(ofconn),
5270 u16_to_ofp(ofproto->max_ports),
5273 error = ofproto_check_ofpacts(ofproto, ofm.fm.ofpacts,
5274 ofm.fm.ofpacts_len);
5277 struct flow_mod_requester req;
5279 req.ofconn = ofconn;
5281 error = handle_flow_mod__(ofproto, &ofm, &req);
5284 goto exit_free_ofpacts;
5287 ofconn_report_flow_mod(ofconn, ofm.fm.command);
5290 ofpbuf_uninit(&ofpacts);
5296 handle_flow_mod__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
5297 const struct flow_mod_requester *req)
5298 OVS_EXCLUDED(ofproto_mutex)
5302 ovs_mutex_lock(&ofproto_mutex);
5303 ofm->version = ofproto->tables_version + 1;
5304 error = ofproto_flow_mod_start(ofproto, ofm);
5306 ofproto_bump_tables_version(ofproto);
5307 ofproto_flow_mod_finish(ofproto, ofm, req);
5309 ofmonitor_flush(ofproto->connmgr);
5310 ovs_mutex_unlock(&ofproto_mutex);
5312 run_rule_executes(ofproto);
5317 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5319 struct ofputil_role_request request;
5320 struct ofputil_role_request reply;
5324 error = ofputil_decode_role_message(oh, &request);
5329 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5330 if (request.role != OFPCR12_ROLE_EQUAL
5331 && request.have_generation_id
5332 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5333 return OFPERR_OFPRRFC_STALE;
5336 ofconn_set_role(ofconn, request.role);
5339 reply.role = ofconn_get_role(ofconn);
5340 reply.have_generation_id = ofconn_get_master_election_id(
5341 ofconn, &reply.generation_id);
5342 buf = ofputil_encode_role_reply(oh, &reply);
5343 ofconn_send_reply(ofconn, buf);
5349 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5350 const struct ofp_header *oh)
5352 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5353 enum ofputil_protocol cur, next;
5355 cur = ofconn_get_protocol(ofconn);
5356 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5357 ofconn_set_protocol(ofconn, next);
5363 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5365 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5366 enum ofputil_protocol cur, next;
5367 enum ofputil_protocol next_base;
5369 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5371 return OFPERR_OFPBRC_EPERM;
5374 cur = ofconn_get_protocol(ofconn);
5375 next = ofputil_protocol_set_base(cur, next_base);
5376 ofconn_set_protocol(ofconn, next);
5382 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5383 const struct ofp_header *oh)
5385 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5388 format = ntohl(msg->format);
5389 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5390 return OFPERR_OFPBRC_EPERM;
5393 ofconn_set_packet_in_format(ofconn, format);
5398 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5400 uint32_t master[OAM_N_TYPES] = {0};
5401 uint32_t slave[OAM_N_TYPES] = {0};
5403 ofputil_decode_set_async_config(oh, master, slave, false);
5405 ofconn_set_async_config(ofconn, master, slave);
5406 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5407 !ofconn_get_miss_send_len(ofconn)) {
5408 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5415 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5418 uint32_t master[OAM_N_TYPES];
5419 uint32_t slave[OAM_N_TYPES];
5421 ofconn_get_async_config(ofconn, master, slave);
5423 buf = ofputil_encode_get_async_config(oh, master, slave);
5424 ofconn_send_reply(ofconn, buf);
5430 handle_nxt_set_controller_id(struct ofconn *ofconn,
5431 const struct ofp_header *oh)
5433 const struct nx_controller_id *nci = ofpmsg_body(oh);
5435 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5436 return OFPERR_NXBRC_MUST_BE_ZERO;
5439 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5444 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5448 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5449 ? OFPRAW_OFPT10_BARRIER_REPLY
5450 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5451 ofconn_send_reply(ofconn, buf);
5456 ofproto_compose_flow_refresh_update(const struct rule *rule,
5457 enum nx_flow_monitor_flags flags,
5458 struct ovs_list *msgs)
5459 OVS_REQUIRES(ofproto_mutex)
5461 const struct rule_actions *actions;
5462 struct ofputil_flow_update fu;
5465 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5466 ? NXFME_ADDED : NXFME_MODIFIED);
5468 ovs_mutex_lock(&rule->mutex);
5469 fu.idle_timeout = rule->idle_timeout;
5470 fu.hard_timeout = rule->hard_timeout;
5471 ovs_mutex_unlock(&rule->mutex);
5472 fu.table_id = rule->table_id;
5473 fu.cookie = rule->flow_cookie;
5474 minimatch_expand(&rule->cr.match, &match);
5476 fu.priority = rule->cr.priority;
5478 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5479 fu.ofpacts = actions ? actions->ofpacts : NULL;
5480 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5482 if (list_is_empty(msgs)) {
5483 ofputil_start_flow_update(msgs);
5485 ofputil_append_flow_update(&fu, msgs);
5489 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5490 struct ovs_list *msgs)
5491 OVS_REQUIRES(ofproto_mutex)
5495 for (i = 0; i < rules->n; i++) {
5496 struct rule *rule = rules->rules[i];
5497 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5498 rule->monitor_flags = 0;
5500 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5505 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5506 struct rule *rule, uint64_t seqno,
5507 struct rule_collection *rules)
5508 OVS_REQUIRES(ofproto_mutex)
5510 enum nx_flow_monitor_flags update;
5512 if (rule_is_hidden(rule)) {
5516 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5521 if (rule->add_seqno > seqno) {
5522 update = NXFMF_ADD | NXFMF_MODIFY;
5523 } else if (rule->modify_seqno > seqno) {
5524 update = NXFMF_MODIFY;
5529 if (!(m->flags & update)) {
5533 update = NXFMF_INITIAL;
5536 if (!rule->monitor_flags) {
5537 rule_collection_add(rules, rule);
5539 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5543 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5545 struct rule_collection *rules)
5546 OVS_REQUIRES(ofproto_mutex)
5548 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5549 const struct oftable *table;
5550 struct cls_rule target;
5552 cls_rule_init_from_minimatch(&target, &m->match, 0);
5553 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5556 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target, CLS_MAX_VERSION) {
5557 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5560 cls_rule_destroy(&target);
5564 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5565 struct rule_collection *rules)
5566 OVS_REQUIRES(ofproto_mutex)
5568 if (m->flags & NXFMF_INITIAL) {
5569 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5574 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5575 uint64_t seqno, struct rule_collection *rules)
5576 OVS_REQUIRES(ofproto_mutex)
5578 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5582 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5583 OVS_REQUIRES(ofproto_mutex)
5585 struct ofmonitor *m;
5588 m = ofmonitor_lookup(ofconn, id);
5590 ofmonitor_destroy(m);
5593 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5600 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5601 OVS_EXCLUDED(ofproto_mutex)
5603 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5604 struct ofmonitor **monitors;
5605 size_t n_monitors, allocated_monitors;
5606 struct rule_collection rules;
5607 struct ovs_list replies;
5612 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5614 n_monitors = allocated_monitors = 0;
5616 ovs_mutex_lock(&ofproto_mutex);
5618 struct ofputil_flow_monitor_request request;
5619 struct ofmonitor *m;
5622 retval = ofputil_decode_flow_monitor_request(&request, &b);
5623 if (retval == EOF) {
5625 } else if (retval) {
5630 if (request.table_id != 0xff
5631 && request.table_id >= ofproto->n_tables) {
5632 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5636 error = ofmonitor_create(&request, ofconn, &m);
5641 if (n_monitors >= allocated_monitors) {
5642 monitors = x2nrealloc(monitors, &allocated_monitors,
5645 monitors[n_monitors++] = m;
5648 rule_collection_init(&rules);
5649 for (i = 0; i < n_monitors; i++) {
5650 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5653 ofpmp_init(&replies, oh);
5654 ofmonitor_compose_refresh_updates(&rules, &replies);
5655 ovs_mutex_unlock(&ofproto_mutex);
5657 rule_collection_destroy(&rules);
5659 ofconn_send_replies(ofconn, &replies);
5665 for (i = 0; i < n_monitors; i++) {
5666 ofmonitor_destroy(monitors[i]);
5669 ovs_mutex_unlock(&ofproto_mutex);
5675 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5676 OVS_EXCLUDED(ofproto_mutex)
5681 id = ofputil_decode_flow_monitor_cancel(oh);
5683 ovs_mutex_lock(&ofproto_mutex);
5684 error = flow_monitor_delete(ofconn, id);
5685 ovs_mutex_unlock(&ofproto_mutex);
5690 /* Meters implementation.
5692 * Meter table entry, indexed by the OpenFlow meter_id.
5693 * 'created' is used to compute the duration for meter stats.
5694 * 'list rules' is needed so that we can delete the dependent rules when the
5695 * meter table entry is deleted.
5696 * 'provider_meter_id' is for the provider's private use.
5699 long long int created; /* Time created. */
5700 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5701 ofproto_meter_id provider_meter_id;
5702 uint16_t flags; /* Meter flags. */
5703 uint16_t n_bands; /* Number of meter bands. */
5704 struct ofputil_meter_band *bands;
5708 * This is used in instruction validation at flow set-up time,
5709 * as flows may not use non-existing meters.
5710 * Return value of UINT32_MAX signifies an invalid meter.
5713 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5715 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5716 const struct meter *meter = ofproto->meters[of_meter_id];
5718 return meter->provider_meter_id.uint32;
5724 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5727 meter_insert_rule(struct rule *rule)
5729 const struct rule_actions *a = rule_get_actions(rule);
5730 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5731 struct meter *meter = rule->ofproto->meters[meter_id];
5733 list_insert(&meter->rules, &rule->meter_list_node);
5737 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5741 meter->flags = config->flags;
5742 meter->n_bands = config->n_bands;
5743 meter->bands = xmemdup(config->bands,
5744 config->n_bands * sizeof *meter->bands);
5747 static struct meter *
5748 meter_create(const struct ofputil_meter_config *config,
5749 ofproto_meter_id provider_meter_id)
5751 struct meter *meter;
5753 meter = xzalloc(sizeof *meter);
5754 meter->provider_meter_id = provider_meter_id;
5755 meter->created = time_msec();
5756 list_init(&meter->rules);
5758 meter_update(meter, config);
5764 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5765 OVS_REQUIRES(ofproto_mutex)
5768 for (mid = first; mid <= last; ++mid) {
5769 struct meter *meter = ofproto->meters[mid];
5771 ofproto->meters[mid] = NULL;
5772 ofproto->ofproto_class->meter_del(ofproto,
5773 meter->provider_meter_id);
5781 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5783 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5784 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5788 return OFPERR_OFPMMFC_METER_EXISTS;
5791 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5794 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5795 *meterp = meter_create(&mm->meter, provider_meter_id);
5801 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5803 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5805 uint32_t provider_meter_id;
5808 return OFPERR_OFPMMFC_UNKNOWN_METER;
5811 provider_meter_id = meter->provider_meter_id.uint32;
5812 error = ofproto->ofproto_class->meter_set(ofproto,
5813 &meter->provider_meter_id,
5815 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5817 meter_update(meter, &mm->meter);
5823 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5824 OVS_EXCLUDED(ofproto_mutex)
5826 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5827 uint32_t meter_id = mm->meter.meter_id;
5828 struct rule_collection rules;
5829 enum ofperr error = 0;
5830 uint32_t first, last;
5832 if (meter_id == OFPM13_ALL) {
5834 last = ofproto->meter_features.max_meters;
5836 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5839 first = last = meter_id;
5842 /* First delete the rules that use this meter. If any of those rules are
5843 * currently being modified, postpone the whole operation until later. */
5844 rule_collection_init(&rules);
5845 ovs_mutex_lock(&ofproto_mutex);
5846 for (meter_id = first; meter_id <= last; ++meter_id) {
5847 struct meter *meter = ofproto->meters[meter_id];
5848 if (meter && !list_is_empty(&meter->rules)) {
5851 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5852 rule_collection_add(&rules, rule);
5856 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5858 /* Delete the meters. */
5859 meter_delete(ofproto, first, last);
5861 ovs_mutex_unlock(&ofproto_mutex);
5867 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5869 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5870 struct ofputil_meter_mod mm;
5871 uint64_t bands_stub[256 / 8];
5872 struct ofpbuf bands;
5876 error = reject_slave_controller(ofconn);
5881 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5883 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5885 goto exit_free_bands;
5888 meter_id = mm.meter.meter_id;
5890 if (mm.command != OFPMC13_DELETE) {
5891 /* Fails also when meters are not implemented by the provider. */
5892 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5893 error = OFPERR_OFPMMFC_INVALID_METER;
5894 goto exit_free_bands;
5895 } else if (meter_id > ofproto->meter_features.max_meters) {
5896 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5897 goto exit_free_bands;
5899 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5900 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5901 goto exit_free_bands;
5905 switch (mm.command) {
5907 error = handle_add_meter(ofproto, &mm);
5910 case OFPMC13_MODIFY:
5911 error = handle_modify_meter(ofproto, &mm);
5914 case OFPMC13_DELETE:
5915 error = handle_delete_meter(ofconn, &mm);
5919 error = OFPERR_OFPMMFC_BAD_COMMAND;
5924 struct ofputil_requestforward rf;
5926 rf.reason = OFPRFR_METER_MOD;
5928 connmgr_send_requestforward(ofproto->connmgr, ofconn, &rf);
5932 ofpbuf_uninit(&bands);
5937 handle_meter_features_request(struct ofconn *ofconn,
5938 const struct ofp_header *request)
5940 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5941 struct ofputil_meter_features features;
5944 if (ofproto->ofproto_class->meter_get_features) {
5945 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5947 memset(&features, 0, sizeof features);
5949 b = ofputil_encode_meter_features_reply(&features, request);
5951 ofconn_send_reply(ofconn, b);
5956 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5959 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5960 struct ovs_list replies;
5961 uint64_t bands_stub[256 / 8];
5962 struct ofpbuf bands;
5963 uint32_t meter_id, first, last;
5965 ofputil_decode_meter_request(request, &meter_id);
5967 if (meter_id == OFPM13_ALL) {
5969 last = ofproto->meter_features.max_meters;
5971 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5972 !ofproto->meters[meter_id]) {
5973 return OFPERR_OFPMMFC_UNKNOWN_METER;
5975 first = last = meter_id;
5978 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5979 ofpmp_init(&replies, request);
5981 for (meter_id = first; meter_id <= last; ++meter_id) {
5982 struct meter *meter = ofproto->meters[meter_id];
5984 continue; /* Skip non-existing meters. */
5986 if (type == OFPTYPE_METER_STATS_REQUEST) {
5987 struct ofputil_meter_stats stats;
5989 stats.meter_id = meter_id;
5991 /* Provider sets the packet and byte counts, we do the rest. */
5992 stats.flow_count = list_size(&meter->rules);
5993 calc_duration(meter->created, time_msec(),
5994 &stats.duration_sec, &stats.duration_nsec);
5995 stats.n_bands = meter->n_bands;
5996 ofpbuf_clear(&bands);
5998 = ofpbuf_put_uninit(&bands,
5999 meter->n_bands * sizeof *stats.bands);
6001 if (!ofproto->ofproto_class->meter_get(ofproto,
6002 meter->provider_meter_id,
6004 ofputil_append_meter_stats(&replies, &stats);
6006 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
6007 struct ofputil_meter_config config;
6009 config.meter_id = meter_id;
6010 config.flags = meter->flags;
6011 config.n_bands = meter->n_bands;
6012 config.bands = meter->bands;
6013 ofputil_append_meter_config(&replies, &config);
6017 ofconn_send_replies(ofconn, &replies);
6018 ofpbuf_uninit(&bands);
6023 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
6024 struct ofgroup **group)
6025 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6027 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
6028 hash_int(group_id, 0), &ofproto->groups) {
6029 if ((*group)->group_id == group_id) {
6037 /* If the group exists, this function increments the groups's reference count.
6039 * Make sure to call ofproto_group_unref() after no longer needing to maintain
6040 * a reference to the group. */
6042 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
6043 struct ofgroup **group)
6047 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6048 found = ofproto_group_lookup__(ofproto, group_id, group);
6050 ofproto_group_ref(*group);
6052 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6057 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
6058 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6060 struct ofgroup *grp;
6062 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
6063 hash_int(group_id, 0), &ofproto->groups) {
6064 if (grp->group_id == group_id) {
6072 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
6073 OVS_EXCLUDED(ofproto->groups_rwlock)
6077 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6078 exists = ofproto_group_exists__(ofproto, group_id);
6079 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6085 group_get_ref_count(struct ofgroup *group)
6086 OVS_EXCLUDED(ofproto_mutex)
6088 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
6089 struct rule_criteria criteria;
6090 struct rule_collection rules;
6095 match_init_catchall(&match);
6096 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
6097 htonll(0), OFPP_ANY, group->group_id);
6098 ovs_mutex_lock(&ofproto_mutex);
6099 error = collect_rules_loose(ofproto, &criteria, &rules);
6100 ovs_mutex_unlock(&ofproto_mutex);
6101 rule_criteria_destroy(&criteria);
6103 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
6105 rule_collection_destroy(&rules);
6110 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
6112 struct ofputil_group_stats ogs;
6113 const struct ofproto *ofproto = group->ofproto;
6114 long long int now = time_msec();
6117 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
6119 /* Provider sets the packet and byte counts, we do the rest. */
6120 ogs.ref_count = group_get_ref_count(group);
6121 ogs.n_buckets = group->n_buckets;
6123 error = (ofproto->ofproto_class->group_get_stats
6124 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
6127 ogs.packet_count = UINT64_MAX;
6128 ogs.byte_count = UINT64_MAX;
6129 memset(ogs.bucket_stats, 0xff,
6130 ogs.n_buckets * sizeof *ogs.bucket_stats);
6133 ogs.group_id = group->group_id;
6134 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
6136 ofputil_append_group_stats(replies, &ogs);
6138 free(ogs.bucket_stats);
6142 handle_group_request(struct ofconn *ofconn,
6143 const struct ofp_header *request, uint32_t group_id,
6144 void (*cb)(struct ofgroup *, struct ovs_list *replies))
6146 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6147 struct ofgroup *group;
6148 struct ovs_list replies;
6150 ofpmp_init(&replies, request);
6151 if (group_id == OFPG_ALL) {
6152 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6153 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
6154 cb(group, &replies);
6156 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6158 if (ofproto_group_lookup(ofproto, group_id, &group)) {
6159 cb(group, &replies);
6160 ofproto_group_unref(group);
6163 ofconn_send_replies(ofconn, &replies);
6167 handle_group_stats_request(struct ofconn *ofconn,
6168 const struct ofp_header *request)
6173 error = ofputil_decode_group_stats_request(request, &group_id);
6178 handle_group_request(ofconn, request, group_id, append_group_stats);
6183 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
6185 struct ofputil_group_desc gds;
6187 gds.group_id = group->group_id;
6188 gds.type = group->type;
6189 gds.props = group->props;
6191 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
6195 handle_group_desc_stats_request(struct ofconn *ofconn,
6196 const struct ofp_header *request)
6198 handle_group_request(ofconn, request,
6199 ofputil_decode_group_desc_request(request),
6205 handle_group_features_stats_request(struct ofconn *ofconn,
6206 const struct ofp_header *request)
6208 struct ofproto *p = ofconn_get_ofproto(ofconn);
6211 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6213 ofconn_send_reply(ofconn, msg);
6220 handle_queue_get_config_request(struct ofconn *ofconn,
6221 const struct ofp_header *oh)
6223 struct ofproto *p = ofconn_get_ofproto(ofconn);
6224 struct netdev_queue_dump queue_dump;
6225 struct ofport *ofport;
6226 unsigned int queue_id;
6227 struct ofpbuf *reply;
6228 struct smap details;
6232 error = ofputil_decode_queue_get_config_request(oh, &request);
6237 ofport = ofproto_get_port(p, request);
6239 return OFPERR_OFPQOFC_BAD_PORT;
6242 reply = ofputil_encode_queue_get_config_reply(oh);
6244 smap_init(&details);
6245 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6246 struct ofputil_queue_config queue;
6248 /* None of the existing queues have compatible properties, so we
6249 * hard-code omitting min_rate and max_rate. */
6250 queue.queue_id = queue_id;
6251 queue.min_rate = UINT16_MAX;
6252 queue.max_rate = UINT16_MAX;
6253 ofputil_append_queue_get_config_reply(reply, &queue);
6255 smap_destroy(&details);
6257 ofconn_send_reply(ofconn, reply);
6263 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6264 struct ofgroup **ofgroup)
6267 const long long int now = time_msec();
6269 if (gm->group_id > OFPG_MAX) {
6270 return OFPERR_OFPGMFC_INVALID_GROUP;
6272 if (gm->type > OFPGT11_FF) {
6273 return OFPERR_OFPGMFC_BAD_TYPE;
6276 *ofgroup = ofproto->ofproto_class->group_alloc();
6278 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6279 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6282 (*ofgroup)->ofproto = ofproto;
6283 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6284 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6285 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6286 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6287 ovs_refcount_init(&(*ofgroup)->ref_count);
6289 list_move(&(*ofgroup)->buckets, &gm->buckets);
6290 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6291 list_size(&(*ofgroup)->buckets);
6293 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6294 &gm->props, sizeof (struct ofputil_group_props));
6296 /* Construct called BEFORE any locks are held. */
6297 error = ofproto->ofproto_class->group_construct(*ofgroup);
6299 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6300 ofproto->ofproto_class->group_dealloc(*ofgroup);
6305 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6306 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6309 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6311 struct ofgroup *ofgroup;
6314 /* Allocate new group and initialize it. */
6315 error = init_group(ofproto, gm, &ofgroup);
6320 /* We wrlock as late as possible to minimize the time we jam any other
6321 * threads: No visible state changes before acquiring the lock. */
6322 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6324 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6325 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6329 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6330 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6335 /* Insert new group. */
6336 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6337 hash_int(ofgroup->group_id, 0));
6338 ofproto->n_groups[ofgroup->type]++;
6340 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6345 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6346 ofproto->ofproto_class->group_destruct(ofgroup);
6347 ofputil_bucket_list_destroy(&ofgroup->buckets);
6348 ofproto->ofproto_class->group_dealloc(ofgroup);
6353 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6354 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6355 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6356 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6359 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6360 struct ofgroup *new_ofgroup,
6361 uint32_t command_bucket_id)
6363 struct ofputil_bucket *last = NULL;
6365 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6366 /* Check here to ensure that a bucket corresponding to
6367 * command_bucket_id exists in the old bucket list.
6369 * The subsequent search of below of new_ofgroup covers
6370 * both buckets in the old bucket list and buckets added
6371 * by the insert buckets group mod message this function processes. */
6372 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6373 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6376 if (!list_is_empty(&new_ofgroup->buckets)) {
6377 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6381 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6383 if (ofputil_bucket_check_duplicate_id(&new_ofgroup->buckets)) {
6384 VLOG_INFO_RL(&rl, "Duplicate bucket id");
6385 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6388 /* Rearrange list according to command_bucket_id */
6389 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6390 if (!list_is_empty(&ofgroup->buckets)) {
6391 struct ofputil_bucket *new_first;
6392 const struct ofputil_bucket *first;
6394 first = ofputil_bucket_list_front(&ofgroup->buckets);
6395 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6398 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6399 &new_ofgroup->buckets);
6401 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6402 struct ofputil_bucket *after;
6404 /* Presence of bucket is checked above so after should never be NULL */
6405 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6407 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6408 last->list_node.next);
6414 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6415 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6416 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6417 * and OFPG15_BUCKET_ALL are also honored. */
6419 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6420 struct ofgroup *new_ofgroup,
6421 uint32_t command_bucket_id)
6423 const struct ofputil_bucket *skip = NULL;
6425 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6429 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6430 if (!list_is_empty(&ofgroup->buckets)) {
6431 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6433 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6434 if (!list_is_empty(&ofgroup->buckets)) {
6435 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6438 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6440 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6444 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6449 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6450 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6453 * Note that the group is re-created and then replaces the old group in
6454 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6455 * the xlate module hold a pointer to the group. */
6457 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6459 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6462 error = init_group(ofproto, gm, &new_ofgroup);
6467 retiring = new_ofgroup;
6469 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6470 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6471 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6475 /* Ofproto's group write lock is held now. */
6476 if (ofgroup->type != gm->type
6477 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6478 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6482 /* Manipulate bucket list for bucket commands */
6483 if (gm->command == OFPGC15_INSERT_BUCKET) {
6484 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6485 gm->command_bucket_id);
6486 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6487 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6488 gm->command_bucket_id);
6494 /* The group creation time does not change during modification. */
6495 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6496 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6498 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6504 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6505 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6506 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6507 hash_int(new_ofgroup->group_id, 0));
6508 if (ofgroup->type != new_ofgroup->type) {
6509 ofproto->n_groups[ofgroup->type]--;
6510 ofproto->n_groups[new_ofgroup->type]++;
6514 ofproto_group_unref(retiring);
6515 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6520 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6521 OVS_RELEASES(ofproto->groups_rwlock)
6524 struct ofproto_flow_mod ofm;
6526 /* Delete all flow entries containing this group in a group action */
6527 match_init_catchall(&match);
6528 flow_mod_init(&ofm.fm, &match, 0, NULL, 0, OFPFC_DELETE);
6529 ofm.fm.delete_reason = OFPRR_GROUP_DELETE;
6530 ofm.fm.out_group = ofgroup->group_id;
6531 handle_flow_mod__(ofproto, &ofm, NULL);
6533 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6534 /* No-one can find this group any more. */
6535 ofproto->n_groups[ofgroup->type]--;
6536 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6537 ofproto_group_unref(ofgroup);
6540 /* Implements OFPGC11_DELETE. */
6542 delete_group(struct ofproto *ofproto, uint32_t group_id)
6544 struct ofgroup *ofgroup;
6546 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6547 if (group_id == OFPG_ALL) {
6549 struct hmap_node *node = hmap_first(&ofproto->groups);
6553 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6554 delete_group__(ofproto, ofgroup);
6555 /* Lock for each node separately, so that we will not jam the
6556 * other threads for too long time. */
6557 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6560 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6561 hash_int(group_id, 0), &ofproto->groups) {
6562 if (ofgroup->group_id == group_id) {
6563 delete_group__(ofproto, ofgroup);
6568 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6571 /* Delete all groups from 'ofproto'.
6573 * This is intended for use within an ofproto provider's 'destruct'
6576 ofproto_group_delete_all(struct ofproto *ofproto)
6578 delete_group(ofproto, OFPG_ALL);
6582 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6584 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6585 struct ofputil_group_mod gm;
6588 error = reject_slave_controller(ofconn);
6593 error = ofputil_decode_group_mod(oh, &gm);
6598 switch (gm.command) {
6600 error = add_group(ofproto, &gm);
6603 case OFPGC11_MODIFY:
6604 error = modify_group(ofproto, &gm);
6607 case OFPGC11_DELETE:
6608 delete_group(ofproto, gm.group_id);
6612 case OFPGC15_INSERT_BUCKET:
6613 error = modify_group(ofproto, &gm);
6616 case OFPGC15_REMOVE_BUCKET:
6617 error = modify_group(ofproto, &gm);
6621 if (gm.command > OFPGC11_DELETE) {
6622 VLOG_INFO_RL(&rl, "%s: Invalid group_mod command type %d",
6623 ofproto->name, gm.command);
6625 return OFPERR_OFPGMFC_BAD_COMMAND;
6629 struct ofputil_requestforward rf;
6631 rf.reason = OFPRFR_GROUP_MOD;
6633 connmgr_send_requestforward(ofproto->connmgr, ofconn, &rf);
6638 enum ofputil_table_miss
6639 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6641 enum ofputil_table_miss miss;
6643 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &miss);
6648 table_mod__(struct oftable *oftable,
6649 const struct ofputil_table_mod *tm)
6651 if (tm->miss == OFPUTIL_TABLE_MISS_DEFAULT) {
6652 /* This is how an OFPT_TABLE_MOD decodes if it doesn't specify any
6653 * table-miss configuration (because the protocol used doesn't have
6654 * such a concept), so there's nothing to do. */
6656 atomic_store_relaxed(&oftable->miss_config, tm->miss);
6659 unsigned int new_eviction = oftable->eviction;
6660 if (tm->eviction == OFPUTIL_TABLE_EVICTION_ON) {
6661 new_eviction |= EVICTION_OPENFLOW;
6662 } else if (tm->eviction == OFPUTIL_TABLE_EVICTION_OFF) {
6663 new_eviction &= ~EVICTION_OPENFLOW;
6666 if (new_eviction != oftable->eviction) {
6667 ovs_mutex_lock(&ofproto_mutex);
6668 oftable_configure_eviction(oftable, new_eviction,
6669 oftable->eviction_fields,
6670 oftable->n_eviction_fields);
6671 ovs_mutex_unlock(&ofproto_mutex);
6674 if (tm->vacancy != OFPUTIL_TABLE_VACANCY_DEFAULT) {
6675 ovs_mutex_lock(&ofproto_mutex);
6676 oftable->vacancy_enabled = (tm->vacancy == OFPUTIL_TABLE_VACANCY_ON
6677 ? OFPTC14_VACANCY_EVENTS
6679 oftable->vacancy_down = tm->table_vacancy.vacancy_down;
6680 oftable->vacancy_up = tm->table_vacancy.vacancy_up;
6681 ovs_mutex_unlock(&ofproto_mutex);
6686 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6688 if (!check_table_id(ofproto, tm->table_id)) {
6689 return OFPERR_OFPTMFC_BAD_TABLE;
6692 /* Don't allow the eviction flags to be changed (except to the only fixed
6693 * value that OVS supports). OF1.4 says this is normal: "The
6694 * OFPTMPT_EVICTION property usually cannot be modified using a
6695 * OFP_TABLE_MOD request, because the eviction mechanism is switch
6697 if (tm->eviction_flags != UINT32_MAX
6698 && tm->eviction_flags != OFPROTO_EVICTION_FLAGS) {
6699 return OFPERR_OFPTMFC_BAD_CONFIG;
6702 if (tm->table_id == OFPTT_ALL) {
6703 struct oftable *oftable;
6704 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6705 if (!(oftable->flags & (OFTABLE_HIDDEN | OFTABLE_READONLY))) {
6706 table_mod__(oftable, tm);
6710 struct oftable *oftable = &ofproto->tables[tm->table_id];
6711 if (oftable->flags & OFTABLE_READONLY) {
6712 return OFPERR_OFPTMFC_EPERM;
6714 table_mod__(oftable, tm);
6721 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6723 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6724 struct ofputil_table_mod tm;
6727 error = reject_slave_controller(ofconn);
6732 error = ofputil_decode_table_mod(oh, &tm);
6737 return table_mod(ofproto, &tm);
6741 ofproto_flow_mod_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6742 OVS_REQUIRES(ofproto_mutex)
6744 switch (ofm->fm.command) {
6746 return add_flow_start(ofproto, ofm);
6747 /* , &be->old_rules.stub[0],
6748 &be->new_rules.stub[0]); */
6750 return modify_flows_start_loose(ofproto, ofm);
6751 case OFPFC_MODIFY_STRICT:
6752 return modify_flow_start_strict(ofproto, ofm);
6754 return delete_flows_start_loose(ofproto, ofm);
6756 case OFPFC_DELETE_STRICT:
6757 return delete_flow_start_strict(ofproto, ofm);
6760 return OFPERR_OFPFMFC_BAD_COMMAND;
6764 ofproto_flow_mod_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6765 OVS_REQUIRES(ofproto_mutex)
6767 switch (ofm->fm.command) {
6769 add_flow_revert(ofproto, ofm);
6773 case OFPFC_MODIFY_STRICT:
6774 modify_flows_revert(ofproto, ofm);
6778 case OFPFC_DELETE_STRICT:
6779 delete_flows_revert(ofproto, ofm);
6788 ofproto_flow_mod_finish(struct ofproto *ofproto,
6789 struct ofproto_flow_mod *ofm,
6790 const struct flow_mod_requester *req)
6791 OVS_REQUIRES(ofproto_mutex)
6793 switch (ofm->fm.command) {
6795 add_flow_finish(ofproto, ofm, req);
6799 case OFPFC_MODIFY_STRICT:
6800 modify_flows_finish(ofproto, ofm, req);
6804 case OFPFC_DELETE_STRICT:
6805 delete_flows_finish(ofproto, ofm, req);
6813 /* Commit phases (all while locking ofproto_mutex):
6815 * 1. Begin: Gather resources and make changes visible in the next version.
6816 * - Mark affected rules for removal in the next version.
6817 * - Create new replacement rules, make visible in the next
6819 * - Do not send any events or notifications.
6821 * 2. Revert: Fail if any errors are found. After this point no errors are
6822 * possible. No visible changes were made, so rollback is minimal (remove
6823 * added invisible rules, restore visibility of rules marked for removal).
6825 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
6826 * the ofproto provider. Remove replaced and deleted rules from ofproto data
6827 * structures, and Schedule postponed removal of deleted rules from the
6828 * classifier. Send notifications, buffered packets, etc.
6831 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6833 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6834 cls_version_t version = ofproto->tables_version + 1;
6835 struct ofp_bundle *bundle;
6836 struct ofp_bundle_entry *be;
6839 bundle = ofconn_get_bundle(ofconn, id);
6842 return OFPERR_OFPBFC_BAD_ID;
6844 if (bundle->flags != flags) {
6845 error = OFPERR_OFPBFC_BAD_FLAGS;
6847 bool prev_is_port_mod = false;
6850 ovs_mutex_lock(&ofproto_mutex);
6853 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6854 if (be->type == OFPTYPE_PORT_MOD) {
6855 /* Our port mods are not atomic. */
6856 if (flags & OFPBF_ATOMIC) {
6857 error = OFPERR_OFPBFC_MSG_FAILED;
6859 prev_is_port_mod = true;
6860 error = port_mod_start(ofconn, &be->opm.pm, &be->opm.port);
6862 } else if (be->type == OFPTYPE_FLOW_MOD) {
6863 /* Flow mods between port mods are applied as a single
6864 * version, but the versions are published only after
6865 * we know the commit is successful. */
6866 if (prev_is_port_mod) {
6869 prev_is_port_mod = false;
6870 /* Store the version in which the changes should take
6872 be->ofm.version = version;
6873 error = ofproto_flow_mod_start(ofproto, &be->ofm);
6883 /* Send error referring to the original message. */
6885 ofconn_send_error(ofconn, be->ofp_msg, error);
6886 error = OFPERR_OFPBFC_MSG_FAILED;
6889 /* 2. Revert. Undo all the changes made above. */
6890 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6891 if (be->type == OFPTYPE_FLOW_MOD) {
6892 ofproto_flow_mod_revert(ofproto, &be->ofm);
6894 /* Nothing needs to be reverted for a port mod. */
6898 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6899 if (be->type == OFPTYPE_FLOW_MOD) {
6900 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6902 /* Bump the lookup version to the one of the current
6903 * message. This makes all the changes in the bundle at
6904 * this version visible to lookups at once. */
6905 if (ofproto->tables_version < be->ofm.version) {
6906 ofproto->tables_version = be->ofm.version;
6907 ofproto->ofproto_class->set_tables_version(
6908 ofproto, ofproto->tables_version);
6911 ofproto_flow_mod_finish(ofproto, &be->ofm, &req);
6912 } else if (be->type == OFPTYPE_PORT_MOD) {
6913 /* Perform the actual port mod. This is not atomic, i.e.,
6914 * the effects will be immediately seen by upcall
6915 * processing regardless of the lookup version. It should
6916 * be noted that port configuration changes can originate
6917 * also from OVSDB changes asynchronously to all upcall
6919 port_mod_finish(ofconn, &be->opm.pm, be->opm.port);
6924 ofmonitor_flush(ofproto->connmgr);
6925 ovs_mutex_unlock(&ofproto_mutex);
6927 run_rule_executes(ofproto);
6930 /* The bundle is discarded regardless the outcome. */
6931 ofp_bundle_remove__(ofconn, bundle, !error);
6936 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6938 struct ofputil_bundle_ctrl_msg bctrl;
6939 struct ofputil_bundle_ctrl_msg reply;
6943 error = reject_slave_controller(ofconn);
6948 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6953 reply.bundle_id = bctrl.bundle_id;
6955 switch (bctrl.type) {
6956 case OFPBCT_OPEN_REQUEST:
6957 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6958 reply.type = OFPBCT_OPEN_REPLY;
6960 case OFPBCT_CLOSE_REQUEST:
6961 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6962 reply.type = OFPBCT_CLOSE_REPLY;
6964 case OFPBCT_COMMIT_REQUEST:
6965 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6966 reply.type = OFPBCT_COMMIT_REPLY;
6968 case OFPBCT_DISCARD_REQUEST:
6969 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6970 reply.type = OFPBCT_DISCARD_REPLY;
6973 case OFPBCT_OPEN_REPLY:
6974 case OFPBCT_CLOSE_REPLY:
6975 case OFPBCT_COMMIT_REPLY:
6976 case OFPBCT_DISCARD_REPLY:
6977 return OFPERR_OFPBFC_BAD_TYPE;
6982 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6983 ofconn_send_reply(ofconn, buf);
6989 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6991 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6993 struct ofputil_bundle_add_msg badd;
6994 struct ofp_bundle_entry *bmsg;
6997 error = reject_slave_controller(ofconn);
7002 error = ofputil_decode_bundle_add(oh, &badd, &type);
7007 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
7009 if (type == OFPTYPE_PORT_MOD) {
7010 error = ofputil_decode_port_mod(badd.msg, &bmsg->opm.pm, false);
7011 } else if (type == OFPTYPE_FLOW_MOD) {
7012 struct ofpbuf ofpacts;
7013 uint64_t ofpacts_stub[1024 / 8];
7015 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
7016 error = ofputil_decode_flow_mod(&bmsg->ofm.fm, badd.msg,
7017 ofconn_get_protocol(ofconn),
7019 u16_to_ofp(ofproto->max_ports),
7021 /* Move actions to heap. */
7022 bmsg->ofm.fm.ofpacts = ofpbuf_steal_data(&ofpacts);
7024 if (!error && bmsg->ofm.fm.ofpacts_len) {
7025 error = ofproto_check_ofpacts(ofproto, bmsg->ofm.fm.ofpacts,
7026 bmsg->ofm.fm.ofpacts_len);
7033 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
7038 ofp_bundle_entry_free(bmsg);
7045 handle_geneve_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
7047 struct ofputil_geneve_table_mod gtm;
7050 error = reject_slave_controller(ofconn);
7055 error = ofputil_decode_geneve_table_mod(oh, >m);
7060 error = tun_metadata_table_mod(>m);
7062 ofputil_uninit_geneve_table(>m.mappings);
7067 handle_geneve_table_request(struct ofconn *ofconn, const struct ofp_header *oh)
7069 struct ofputil_geneve_table_reply gtr;
7072 tun_metadata_table_request(>r);
7073 b = ofputil_encode_geneve_table_reply(oh, >r);
7074 ofputil_uninit_geneve_table(>r.mappings);
7076 ofconn_send_reply(ofconn, b);
7081 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
7082 OVS_EXCLUDED(ofproto_mutex)
7084 const struct ofp_header *oh = msg->data;
7088 error = ofptype_decode(&type, oh);
7092 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
7093 && ofpmp_more(oh)) {
7094 /* We have no buffer implementation for multipart requests.
7095 * Report overflow for requests which consists of multiple
7097 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
7101 /* OpenFlow requests. */
7102 case OFPTYPE_ECHO_REQUEST:
7103 return handle_echo_request(ofconn, oh);
7105 case OFPTYPE_FEATURES_REQUEST:
7106 return handle_features_request(ofconn, oh);
7108 case OFPTYPE_GET_CONFIG_REQUEST:
7109 return handle_get_config_request(ofconn, oh);
7111 case OFPTYPE_SET_CONFIG:
7112 return handle_set_config(ofconn, oh);
7114 case OFPTYPE_PACKET_OUT:
7115 return handle_packet_out(ofconn, oh);
7117 case OFPTYPE_PORT_MOD:
7118 return handle_port_mod(ofconn, oh);
7120 case OFPTYPE_FLOW_MOD:
7121 return handle_flow_mod(ofconn, oh);
7123 case OFPTYPE_GROUP_MOD:
7124 return handle_group_mod(ofconn, oh);
7126 case OFPTYPE_TABLE_MOD:
7127 return handle_table_mod(ofconn, oh);
7129 case OFPTYPE_METER_MOD:
7130 return handle_meter_mod(ofconn, oh);
7132 case OFPTYPE_BARRIER_REQUEST:
7133 return handle_barrier_request(ofconn, oh);
7135 case OFPTYPE_ROLE_REQUEST:
7136 return handle_role_request(ofconn, oh);
7138 /* OpenFlow replies. */
7139 case OFPTYPE_ECHO_REPLY:
7142 /* Nicira extension requests. */
7143 case OFPTYPE_FLOW_MOD_TABLE_ID:
7144 return handle_nxt_flow_mod_table_id(ofconn, oh);
7146 case OFPTYPE_SET_FLOW_FORMAT:
7147 return handle_nxt_set_flow_format(ofconn, oh);
7149 case OFPTYPE_SET_PACKET_IN_FORMAT:
7150 return handle_nxt_set_packet_in_format(ofconn, oh);
7152 case OFPTYPE_SET_CONTROLLER_ID:
7153 return handle_nxt_set_controller_id(ofconn, oh);
7155 case OFPTYPE_FLOW_AGE:
7156 /* Nothing to do. */
7159 case OFPTYPE_FLOW_MONITOR_CANCEL:
7160 return handle_flow_monitor_cancel(ofconn, oh);
7162 case OFPTYPE_SET_ASYNC_CONFIG:
7163 return handle_nxt_set_async_config(ofconn, oh);
7165 case OFPTYPE_GET_ASYNC_REQUEST:
7166 return handle_nxt_get_async_request(ofconn, oh);
7168 /* Statistics requests. */
7169 case OFPTYPE_DESC_STATS_REQUEST:
7170 return handle_desc_stats_request(ofconn, oh);
7172 case OFPTYPE_FLOW_STATS_REQUEST:
7173 return handle_flow_stats_request(ofconn, oh);
7175 case OFPTYPE_AGGREGATE_STATS_REQUEST:
7176 return handle_aggregate_stats_request(ofconn, oh);
7178 case OFPTYPE_TABLE_STATS_REQUEST:
7179 return handle_table_stats_request(ofconn, oh);
7181 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
7182 return handle_table_features_request(ofconn, oh);
7184 case OFPTYPE_TABLE_DESC_REQUEST:
7185 return handle_table_desc_request(ofconn, oh);
7187 case OFPTYPE_PORT_STATS_REQUEST:
7188 return handle_port_stats_request(ofconn, oh);
7190 case OFPTYPE_QUEUE_STATS_REQUEST:
7191 return handle_queue_stats_request(ofconn, oh);
7193 case OFPTYPE_PORT_DESC_STATS_REQUEST:
7194 return handle_port_desc_stats_request(ofconn, oh);
7196 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
7197 return handle_flow_monitor_request(ofconn, oh);
7199 case OFPTYPE_METER_STATS_REQUEST:
7200 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
7201 return handle_meter_request(ofconn, oh, type);
7203 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
7204 return handle_meter_features_request(ofconn, oh);
7206 case OFPTYPE_GROUP_STATS_REQUEST:
7207 return handle_group_stats_request(ofconn, oh);
7209 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
7210 return handle_group_desc_stats_request(ofconn, oh);
7212 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
7213 return handle_group_features_stats_request(ofconn, oh);
7215 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
7216 return handle_queue_get_config_request(ofconn, oh);
7218 case OFPTYPE_BUNDLE_CONTROL:
7219 return handle_bundle_control(ofconn, oh);
7221 case OFPTYPE_BUNDLE_ADD_MESSAGE:
7222 return handle_bundle_add(ofconn, oh);
7224 case OFPTYPE_NXT_GENEVE_TABLE_MOD:
7225 return handle_geneve_table_mod(ofconn, oh);
7227 case OFPTYPE_NXT_GENEVE_TABLE_REQUEST:
7228 return handle_geneve_table_request(ofconn, oh);
7232 case OFPTYPE_FEATURES_REPLY:
7233 case OFPTYPE_GET_CONFIG_REPLY:
7234 case OFPTYPE_PACKET_IN:
7235 case OFPTYPE_FLOW_REMOVED:
7236 case OFPTYPE_PORT_STATUS:
7237 case OFPTYPE_BARRIER_REPLY:
7238 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
7239 case OFPTYPE_DESC_STATS_REPLY:
7240 case OFPTYPE_FLOW_STATS_REPLY:
7241 case OFPTYPE_QUEUE_STATS_REPLY:
7242 case OFPTYPE_PORT_STATS_REPLY:
7243 case OFPTYPE_TABLE_STATS_REPLY:
7244 case OFPTYPE_AGGREGATE_STATS_REPLY:
7245 case OFPTYPE_PORT_DESC_STATS_REPLY:
7246 case OFPTYPE_ROLE_REPLY:
7247 case OFPTYPE_FLOW_MONITOR_PAUSED:
7248 case OFPTYPE_FLOW_MONITOR_RESUMED:
7249 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
7250 case OFPTYPE_GET_ASYNC_REPLY:
7251 case OFPTYPE_GROUP_STATS_REPLY:
7252 case OFPTYPE_GROUP_DESC_STATS_REPLY:
7253 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
7254 case OFPTYPE_METER_STATS_REPLY:
7255 case OFPTYPE_METER_CONFIG_STATS_REPLY:
7256 case OFPTYPE_METER_FEATURES_STATS_REPLY:
7257 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
7258 case OFPTYPE_TABLE_DESC_REPLY:
7259 case OFPTYPE_ROLE_STATUS:
7260 case OFPTYPE_REQUESTFORWARD:
7261 case OFPTYPE_NXT_GENEVE_TABLE_REPLY:
7263 if (ofpmsg_is_stat_request(oh)) {
7264 return OFPERR_OFPBRC_BAD_STAT;
7266 return OFPERR_OFPBRC_BAD_TYPE;
7272 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
7273 OVS_EXCLUDED(ofproto_mutex)
7275 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
7278 ofconn_send_error(ofconn, ofp_msg->data, error);
7280 COVERAGE_INC(ofproto_recv_openflow);
7283 /* Asynchronous operations. */
7286 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
7288 OVS_REQUIRES(ofproto_mutex)
7290 if (req && req->ofconn && buffer_id != UINT32_MAX) {
7291 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
7292 struct dp_packet *packet;
7296 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
7299 struct rule_execute *re;
7301 ofproto_rule_ref(rule);
7303 re = xmalloc(sizeof *re);
7305 re->in_port = in_port;
7306 re->packet = packet;
7308 if (!guarded_list_push_back(&ofproto->rule_executes,
7309 &re->list_node, 1024)) {
7310 ofproto_rule_unref(rule);
7311 dp_packet_delete(re->packet);
7315 ofconn_send_error(req->ofconn, req->request, error);
7321 pick_datapath_id(const struct ofproto *ofproto)
7323 const struct ofport *port;
7325 port = ofproto_get_port(ofproto, OFPP_LOCAL);
7330 error = netdev_get_etheraddr(port->netdev, &ea);
7332 return eth_addr_to_uint64(ea);
7334 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7335 ofproto->name, netdev_get_name(port->netdev),
7336 ovs_strerror(error));
7338 return ofproto->fallback_dpid;
7342 pick_fallback_dpid(void)
7345 eth_addr_nicira_random(&ea);
7346 return eth_addr_to_uint64(ea);
7349 /* Table overflow policy. */
7351 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7352 * to NULL if the table is not configured to evict rules or if the table
7353 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7354 * or with no timeouts are not evictable.) */
7356 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
7357 OVS_REQUIRES(ofproto_mutex)
7359 struct eviction_group *evg;
7362 if (!table->eviction) {
7366 /* In the common case, the outer and inner loops here will each be entered
7369 * - The inner loop normally "return"s in its first iteration. If the
7370 * eviction group has any evictable rules, then it always returns in
7373 * - The outer loop only iterates more than once if the largest eviction
7374 * group has no evictable rules.
7376 * - The outer loop can exit only if table's 'max_flows' is all filled up
7377 * by unevictable rules. */
7378 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7381 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7390 /* Eviction groups. */
7392 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7393 * rules. The priority contains low-order random bits to ensure that eviction
7394 * groups with the same number of rules are prioritized randomly. */
7396 eviction_group_priority(size_t n_rules)
7398 uint16_t size = MIN(UINT16_MAX, n_rules);
7399 return (size << 16) | random_uint16();
7402 /* Updates 'evg', an eviction_group within 'table', following a change that
7403 * adds or removes rules in 'evg'. */
7405 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7406 OVS_REQUIRES(ofproto_mutex)
7408 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7409 eviction_group_priority(heap_count(&evg->rules)));
7412 /* Destroys 'evg', an eviction_group within 'table':
7414 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7415 * rules themselves, just removes them from the eviction group.)
7417 * - Removes 'evg' from 'table'.
7421 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7422 OVS_REQUIRES(ofproto_mutex)
7424 while (!heap_is_empty(&evg->rules)) {
7427 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7428 rule->eviction_group = NULL;
7430 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7431 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7432 heap_destroy(&evg->rules);
7436 /* Removes 'rule' from its eviction group, if any. */
7438 eviction_group_remove_rule(struct rule *rule)
7439 OVS_REQUIRES(ofproto_mutex)
7441 if (rule->eviction_group) {
7442 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7443 struct eviction_group *evg = rule->eviction_group;
7445 rule->eviction_group = NULL;
7446 heap_remove(&evg->rules, &rule->evg_node);
7447 if (heap_is_empty(&evg->rules)) {
7448 eviction_group_destroy(table, evg);
7450 eviction_group_resized(table, evg);
7455 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7456 * returns the hash value. */
7458 eviction_group_hash_rule(struct rule *rule)
7459 OVS_REQUIRES(ofproto_mutex)
7461 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7462 const struct mf_subfield *sf;
7466 hash = table->eviction_group_id_basis;
7467 miniflow_expand(rule->cr.match.flow, &flow);
7468 for (sf = table->eviction_fields;
7469 sf < &table->eviction_fields[table->n_eviction_fields];
7472 if (mf_are_prereqs_ok(sf->field, &flow)) {
7473 union mf_value value;
7475 mf_get_value(sf->field, &flow, &value);
7477 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7479 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7480 unsigned int start = sf->ofs + sf->n_bits;
7481 bitwise_zero(&value, sf->field->n_bytes, start,
7482 sf->field->n_bytes * 8 - start);
7484 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7486 hash = hash_int(hash, 0);
7493 /* Returns an eviction group within 'table' with the given 'id', creating one
7495 static struct eviction_group *
7496 eviction_group_find(struct oftable *table, uint32_t id)
7497 OVS_REQUIRES(ofproto_mutex)
7499 struct eviction_group *evg;
7501 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7505 evg = xmalloc(sizeof *evg);
7506 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7507 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7508 eviction_group_priority(0));
7509 heap_init(&evg->rules);
7514 /* Returns an eviction priority for 'rule'. The return value should be
7515 * interpreted so that higher priorities make a rule a more attractive
7516 * candidate for eviction. */
7518 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7519 OVS_REQUIRES(ofproto_mutex)
7521 /* Calculate absolute time when this flow will expire. If it will never
7522 * expire, then return 0 to make it unevictable. */
7523 long long int expiration = LLONG_MAX;
7524 if (rule->hard_timeout) {
7525 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7526 ovs_mutex_lock(&rule->mutex);
7527 long long int modified = rule->modified;
7528 ovs_mutex_unlock(&rule->mutex);
7530 expiration = modified + rule->hard_timeout * 1000;
7532 if (rule->idle_timeout) {
7533 uint64_t packets, bytes;
7535 long long int idle_expiration;
7537 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7538 idle_expiration = used + rule->idle_timeout * 1000;
7539 expiration = MIN(expiration, idle_expiration);
7541 if (expiration == LLONG_MAX) {
7545 /* Calculate the time of expiration as a number of (approximate) seconds
7546 * after program startup.
7548 * This should work OK for program runs that last UINT32_MAX seconds or
7549 * less. Therefore, please restart OVS at least once every 136 years. */
7550 uint32_t expiration_ofs = (expiration >> 10) - (time_boot_msec() >> 10);
7552 /* Combine expiration time with OpenFlow "importance" to form a single
7553 * priority value. We want flows with relatively low "importance" to be
7554 * evicted before even considering expiration time, so put "importance" in
7555 * the most significant bits and expiration time in the least significant
7558 * Small 'priority' should be evicted before those with large 'priority'.
7559 * The caller expects the opposite convention (a large return value being
7560 * more attractive for eviction) so we invert it before returning. */
7561 uint64_t priority = ((uint64_t) rule->importance << 32) + expiration_ofs;
7562 return UINT64_MAX - priority;
7565 /* Adds 'rule' to an appropriate eviction group for its oftable's
7566 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7567 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7570 * The caller must ensure that 'rule' is not already in an eviction group. */
7572 eviction_group_add_rule(struct rule *rule)
7573 OVS_REQUIRES(ofproto_mutex)
7575 struct ofproto *ofproto = rule->ofproto;
7576 struct oftable *table = &ofproto->tables[rule->table_id];
7579 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7580 * so no additional protection is needed. */
7581 has_timeout = rule->hard_timeout || rule->idle_timeout;
7583 if (table->eviction && has_timeout) {
7584 struct eviction_group *evg;
7586 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7588 rule->eviction_group = evg;
7589 heap_insert(&evg->rules, &rule->evg_node,
7590 rule_eviction_priority(ofproto, rule));
7591 eviction_group_resized(table, evg);
7597 /* Initializes 'table'. */
7599 oftable_init(struct oftable *table)
7601 memset(table, 0, sizeof *table);
7602 classifier_init(&table->cls, flow_segment_u64s);
7603 table->max_flows = UINT_MAX;
7605 hmap_init(&table->eviction_groups_by_id);
7606 heap_init(&table->eviction_groups_by_size);
7607 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7609 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7610 ARRAY_SIZE(default_prefix_fields));
7612 atomic_init(&table->n_matched, 0);
7613 atomic_init(&table->n_missed, 0);
7616 /* Destroys 'table', including its classifier and eviction groups.
7618 * The caller is responsible for freeing 'table' itself. */
7620 oftable_destroy(struct oftable *table)
7622 ovs_assert(classifier_is_empty(&table->cls));
7624 ovs_mutex_lock(&ofproto_mutex);
7625 oftable_configure_eviction(table, 0, NULL, 0);
7626 ovs_mutex_unlock(&ofproto_mutex);
7628 hmap_destroy(&table->eviction_groups_by_id);
7629 heap_destroy(&table->eviction_groups_by_size);
7630 classifier_destroy(&table->cls);
7634 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7635 * string, then 'table' will use its default name.
7637 * This only affects the name exposed for a table exposed through the OpenFlow
7638 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7640 oftable_set_name(struct oftable *table, const char *name)
7642 if (name && name[0]) {
7643 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7644 if (!table->name || strncmp(name, table->name, len)) {
7646 table->name = xmemdup0(name, len);
7654 /* oftables support a choice of two policies when adding a rule would cause the
7655 * number of flows in the table to exceed the configured maximum number: either
7656 * they can refuse to add the new flow or they can evict some existing flow.
7657 * This function configures the latter policy on 'table', with fairness based
7658 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7659 * 'n_fields' as 0 disables fairness.) */
7661 oftable_configure_eviction(struct oftable *table, unsigned int eviction,
7662 const struct mf_subfield *fields, size_t n_fields)
7663 OVS_REQUIRES(ofproto_mutex)
7667 if ((table->eviction != 0) == (eviction != 0)
7668 && n_fields == table->n_eviction_fields
7670 || !memcmp(fields, table->eviction_fields,
7671 n_fields * sizeof *fields))) {
7672 /* The set of eviction fields did not change. If 'eviction' changed,
7673 * it remains nonzero, so that we can just update table->eviction
7674 * without fussing with the eviction groups. */
7675 table->eviction = eviction;
7679 /* Destroy existing eviction groups, then destroy and recreate data
7680 * structures to recover memory. */
7681 struct eviction_group *evg, *next;
7682 HMAP_FOR_EACH_SAFE (evg, next, id_node, &table->eviction_groups_by_id) {
7683 eviction_group_destroy(table, evg);
7685 hmap_destroy(&table->eviction_groups_by_id);
7686 hmap_init(&table->eviction_groups_by_id);
7687 heap_destroy(&table->eviction_groups_by_size);
7688 heap_init(&table->eviction_groups_by_size);
7690 /* Replace eviction groups by the new ones, if there is a change. Free the
7691 * old fields only after allocating the new ones, because 'fields ==
7692 * table->eviction_fields' is possible. */
7693 struct mf_subfield *old_fields = table->eviction_fields;
7694 table->n_eviction_fields = n_fields;
7695 table->eviction_fields = (fields
7696 ? xmemdup(fields, n_fields * sizeof *fields)
7700 /* Add the new eviction groups, if enabled. */
7701 table->eviction = eviction;
7702 if (table->eviction) {
7703 table->eviction_group_id_basis = random_uint32();
7704 CLS_FOR_EACH (rule, cr, &table->cls) {
7705 eviction_group_add_rule(rule);
7710 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7711 * it to the classifier. */
7713 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7714 OVS_REQUIRES(ofproto_mutex)
7716 const struct rule_actions *actions = rule_get_actions(rule);
7718 ovs_assert(rule->removed);
7720 if (rule->hard_timeout || rule->idle_timeout) {
7721 list_insert(&ofproto->expirable, &rule->expirable);
7723 cookies_insert(ofproto, rule);
7724 eviction_group_add_rule(rule);
7725 if (actions->has_meter) {
7726 meter_insert_rule(rule);
7728 rule->removed = false;
7731 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7732 * the removal from the classifier. */
7734 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7735 OVS_REQUIRES(ofproto_mutex)
7737 ovs_assert(!rule->removed);
7739 cookies_remove(ofproto, rule);
7741 eviction_group_remove_rule(rule);
7742 if (!list_is_empty(&rule->expirable)) {
7743 list_remove(&rule->expirable);
7745 if (!list_is_empty(&rule->meter_list_node)) {
7746 list_remove(&rule->meter_list_node);
7747 list_init(&rule->meter_list_node);
7750 rule->removed = true;
7753 /* unixctl commands. */
7756 ofproto_lookup(const char *name)
7758 struct ofproto *ofproto;
7760 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7762 if (!strcmp(ofproto->name, name)) {
7770 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7771 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7773 struct ofproto *ofproto;
7777 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7778 ds_put_format(&results, "%s\n", ofproto->name);
7780 unixctl_command_reply(conn, ds_cstr(&results));
7781 ds_destroy(&results);
7785 ofproto_unixctl_init(void)
7787 static bool registered;
7793 unixctl_command_register("ofproto/list", "", 0, 0,
7794 ofproto_unixctl_list, NULL);
7797 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7799 * This is deprecated. It is only for compatibility with broken device drivers
7800 * in old versions of Linux that do not properly support VLANs when VLAN
7801 * devices are not used. When broken device drivers are no longer in
7802 * widespread use, we will delete these interfaces. */
7804 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7805 * (exactly) by an OpenFlow rule in 'ofproto'. */
7807 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7810 struct cls_rule target;
7811 const struct oftable *oftable;
7813 match_init_catchall(&match);
7814 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7815 cls_rule_init(&target, &match, 0);
7817 free(ofproto->vlan_bitmap);
7818 ofproto->vlan_bitmap = bitmap_allocate(4096);
7819 ofproto->vlans_changed = false;
7821 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7824 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target,
7826 if (minimask_get_vid_mask(rule->cr.match.mask) == VLAN_VID_MASK) {
7827 uint16_t vid = miniflow_get_vid(rule->cr.match.flow);
7829 bitmap_set1(vlan_bitmap, vid);
7830 bitmap_set1(ofproto->vlan_bitmap, vid);
7835 cls_rule_destroy(&target);
7838 /* Returns true if new VLANs have come into use by the flow table since the
7839 * last call to ofproto_get_vlan_usage().
7841 * We don't track when old VLANs stop being used. */
7843 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7845 return ofproto->vlans_changed;
7848 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7849 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7850 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7851 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7852 * then the VLAN device is un-enslaved. */
7854 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7855 ofp_port_t realdev_ofp_port, int vid)
7857 struct ofport *ofport;
7860 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7862 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7864 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7865 ofproto->name, vlandev_ofp_port);
7869 if (!ofproto->ofproto_class->set_realdev) {
7870 if (!vlandev_ofp_port) {
7873 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7877 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7879 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7880 ofproto->name, vlandev_ofp_port,
7881 netdev_get_name(ofport->netdev), ovs_strerror(error));