2 * Copyright (c) 2009-2016 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 = OFPUTIL_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 *fm = (struct ofputil_flow_mod) {
2038 .priority = priority,
2041 .buffer_id = UINT32_MAX,
2042 .out_port = OFPP_ANY,
2043 .out_group = OFPG_ANY,
2044 .ofpacts = CONST_CAST(struct ofpact *, ofpacts),
2045 .ofpacts_len = ofpacts_len,
2046 .delete_reason = OFPRR_DELETE,
2051 simple_flow_mod(struct ofproto *ofproto,
2052 const struct match *match, int priority,
2053 const struct ofpact *ofpacts, size_t ofpacts_len,
2054 enum ofp_flow_mod_command command)
2056 struct ofproto_flow_mod ofm;
2058 flow_mod_init(&ofm.fm, match, priority, ofpacts, ofpacts_len, command);
2060 return handle_flow_mod__(ofproto, &ofm, NULL);
2063 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2064 * performs the 'n_actions' actions in 'actions'. The new flow will not
2067 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2068 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2069 * controllers; otherwise, it will be hidden.
2071 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2073 * This is a helper function for in-band control and fail-open. */
2075 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2077 const struct ofpact *ofpacts, size_t ofpacts_len)
2078 OVS_EXCLUDED(ofproto_mutex)
2080 const struct rule *rule;
2083 /* First do a cheap check whether the rule we're looking for already exists
2084 * with the actions that we want. If it does, then we're done. */
2085 rule = rule_from_cls_rule(classifier_find_match_exactly(
2086 &ofproto->tables[0].cls, match, priority,
2089 const struct rule_actions *actions = rule_get_actions(rule);
2090 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2091 ofpacts, ofpacts_len);
2096 /* If there's no such rule or the rule doesn't have the actions we want,
2097 * fall back to a executing a full flow mod. We can't optimize this at
2098 * all because we didn't take enough locks above to ensure that the flow
2099 * table didn't already change beneath us. */
2101 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2102 OFPFC_MODIFY_STRICT);
2106 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2107 * an OFPERR_* OpenFlow error code on failure.
2109 * This is a helper function for in-band control and fail-open and the "learn"
2112 ofproto_flow_mod(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
2113 OVS_EXCLUDED(ofproto_mutex)
2115 struct ofputil_flow_mod *fm = &ofm->fm;
2117 /* Optimize for the most common case of a repeated learn action.
2118 * If an identical flow already exists we only need to update its
2119 * 'modified' time. */
2120 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2121 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2122 struct oftable *table = &ofproto->tables[fm->table_id];
2126 rule = rule_from_cls_rule(classifier_find_match_exactly(
2127 &table->cls, &fm->match, fm->priority,
2130 /* Reading many of the rule fields and writing on 'modified'
2131 * requires the rule->mutex. Also, rule->actions may change
2132 * if rule->mutex is not held. */
2133 const struct rule_actions *actions;
2135 ovs_mutex_lock(&rule->mutex);
2136 actions = rule_get_actions(rule);
2137 if (rule->idle_timeout == fm->idle_timeout
2138 && rule->hard_timeout == fm->hard_timeout
2139 && rule->importance == fm->importance
2140 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2141 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2142 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2143 actions->ofpacts, actions->ofpacts_len)) {
2144 /* Rule already exists and need not change, only update the
2145 modified timestamp. */
2146 rule->modified = time_msec();
2149 ovs_mutex_unlock(&rule->mutex);
2157 return handle_flow_mod__(ofproto, ofm, NULL);
2160 /* Searches for a rule with matching criteria exactly equal to 'target' in
2161 * ofproto's table 0 and, if it finds one, deletes it.
2163 * This is a helper function for in-band control and fail-open. */
2165 ofproto_delete_flow(struct ofproto *ofproto,
2166 const struct match *target, int priority)
2167 OVS_EXCLUDED(ofproto_mutex)
2169 struct classifier *cls = &ofproto->tables[0].cls;
2172 /* First do a cheap check whether the rule we're looking for has already
2173 * been deleted. If so, then we're done. */
2174 rule = rule_from_cls_rule(classifier_find_match_exactly(
2175 cls, target, priority, CLS_MAX_VERSION));
2180 /* Execute a flow mod. We can't optimize this at all because we didn't
2181 * take enough locks above to ensure that the flow table didn't already
2182 * change beneath us. */
2183 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2186 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2187 * the flows required by in-band control and fail-open. */
2189 ofproto_flush_flows(struct ofproto *ofproto)
2191 COVERAGE_INC(ofproto_flush);
2192 ofproto_flush__(ofproto);
2193 connmgr_flushed(ofproto->connmgr);
2197 reinit_ports(struct ofproto *p)
2199 struct ofproto_port_dump dump;
2200 struct sset devnames;
2201 struct ofport *ofport;
2202 struct ofproto_port ofproto_port;
2203 const char *devname;
2205 COVERAGE_INC(ofproto_reinit_ports);
2207 sset_init(&devnames);
2208 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2209 sset_add(&devnames, netdev_get_name(ofport->netdev));
2211 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2212 sset_add(&devnames, ofproto_port.name);
2215 SSET_FOR_EACH (devname, &devnames) {
2216 update_port(p, devname);
2218 sset_destroy(&devnames);
2222 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2226 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2227 port_idx = port_idx ? port_idx : UINT16_MAX;
2229 if (port_idx >= ofproto->max_ports
2230 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2231 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2232 long long int last_used_at, lru = LLONG_MAX;
2234 /* Search for a free OpenFlow port number. We try not to
2235 * immediately reuse them to prevent problems due to old
2238 * We limit the automatically assigned port numbers to the lower half
2239 * of the port range, to reserve the upper half for assignment by
2242 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2243 ofproto->alloc_port_no = 1;
2245 last_used_at = ofport_get_usage(ofproto,
2246 u16_to_ofp(ofproto->alloc_port_no));
2247 if (!last_used_at) {
2248 port_idx = ofproto->alloc_port_no;
2250 } else if ( last_used_at < time_msec() - 60*60*1000) {
2251 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2252 * more than an hour ago, consider it usable. */
2253 ofport_remove_usage(ofproto,
2254 u16_to_ofp(ofproto->alloc_port_no));
2255 port_idx = ofproto->alloc_port_no;
2257 } else if (last_used_at < lru) {
2259 lru_ofport = ofproto->alloc_port_no;
2262 if (ofproto->alloc_port_no == end_port_no) {
2264 port_idx = lru_ofport;
2271 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2272 return u16_to_ofp(port_idx);
2276 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2278 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2279 ofport_set_usage(ofproto, ofp_port, time_msec());
2283 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2284 * pointer if the netdev cannot be opened. On success, also fills in
2286 static struct netdev *
2287 ofport_open(struct ofproto *ofproto,
2288 struct ofproto_port *ofproto_port,
2289 struct ofputil_phy_port *pp)
2291 enum netdev_flags flags;
2292 struct netdev *netdev;
2295 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2297 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2298 "cannot be opened (%s)",
2300 ofproto_port->name, ofproto_port->ofp_port,
2301 ofproto_port->name, ovs_strerror(error));
2305 if (ofproto_port->ofp_port == OFPP_NONE) {
2306 if (!strcmp(ofproto->name, ofproto_port->name)) {
2307 ofproto_port->ofp_port = OFPP_LOCAL;
2309 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2310 ofproto_port->name);
2313 pp->port_no = ofproto_port->ofp_port;
2314 netdev_get_etheraddr(netdev, &pp->hw_addr);
2315 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2316 netdev_get_flags(netdev, &flags);
2317 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2318 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2319 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2320 &pp->supported, &pp->peer);
2321 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2322 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2327 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2328 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2331 ofport_equal(const struct ofputil_phy_port *a,
2332 const struct ofputil_phy_port *b)
2334 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2335 && a->state == b->state
2336 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2337 && a->curr == b->curr
2338 && a->advertised == b->advertised
2339 && a->supported == b->supported
2340 && a->peer == b->peer
2341 && a->curr_speed == b->curr_speed
2342 && a->max_speed == b->max_speed);
2345 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2346 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2347 * one with the same name or port number). */
2349 ofport_install(struct ofproto *p,
2350 struct netdev *netdev, const struct ofputil_phy_port *pp)
2352 const char *netdev_name = netdev_get_name(netdev);
2353 struct ofport *ofport;
2356 /* Create ofport. */
2357 ofport = p->ofproto_class->port_alloc();
2362 ofport->ofproto = p;
2363 ofport->netdev = netdev;
2364 ofport->change_seq = netdev_get_change_seq(netdev);
2366 ofport->ofp_port = pp->port_no;
2367 ofport->created = time_msec();
2369 /* Add port to 'p'. */
2370 hmap_insert(&p->ports, &ofport->hmap_node,
2371 hash_ofp_port(ofport->ofp_port));
2372 shash_add(&p->port_by_name, netdev_name, ofport);
2374 update_mtu(p, ofport);
2376 /* Let the ofproto_class initialize its private data. */
2377 error = p->ofproto_class->port_construct(ofport);
2381 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2385 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2386 p->name, netdev_name, ovs_strerror(error));
2388 ofport_destroy__(ofport);
2390 netdev_close(netdev);
2394 /* Removes 'ofport' from 'p' and destroys it. */
2396 ofport_remove(struct ofport *ofport)
2398 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2400 ofport_destroy(ofport);
2403 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2406 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2408 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2410 ofport_remove(port);
2414 /* Updates 'port' with new 'pp' description.
2416 * Does not handle a name or port number change. The caller must implement
2417 * such a change as a delete followed by an add. */
2419 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2421 port->pp.hw_addr = pp->hw_addr;
2422 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2423 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2424 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2425 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2426 port->pp.curr = pp->curr;
2427 port->pp.advertised = pp->advertised;
2428 port->pp.supported = pp->supported;
2429 port->pp.peer = pp->peer;
2430 port->pp.curr_speed = pp->curr_speed;
2431 port->pp.max_speed = pp->max_speed;
2433 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2434 &port->pp, OFPPR_MODIFY);
2437 /* Update OpenFlow 'state' in 'port' and notify controller. */
2439 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2441 if (port->pp.state != state) {
2442 port->pp.state = state;
2443 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2444 &port->pp, OFPPR_MODIFY);
2449 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2451 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2453 if (port->ofproto->ofproto_class->set_realdev) {
2454 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2456 if (port->ofproto->ofproto_class->set_stp_port) {
2457 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2459 if (port->ofproto->ofproto_class->set_rstp_port) {
2460 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2462 if (port->ofproto->ofproto_class->set_cfm) {
2463 port->ofproto->ofproto_class->set_cfm(port, NULL);
2465 if (port->ofproto->ofproto_class->bundle_remove) {
2466 port->ofproto->ofproto_class->bundle_remove(port);
2472 ofport_destroy__(struct ofport *port)
2474 struct ofproto *ofproto = port->ofproto;
2475 const char *name = netdev_get_name(port->netdev);
2477 hmap_remove(&ofproto->ports, &port->hmap_node);
2478 shash_delete(&ofproto->port_by_name,
2479 shash_find(&ofproto->port_by_name, name));
2481 netdev_close(port->netdev);
2482 ofproto->ofproto_class->port_dealloc(port);
2486 ofport_destroy(struct ofport *port)
2489 dealloc_ofp_port(port->ofproto, port->ofp_port);
2490 port->ofproto->ofproto_class->port_destruct(port);
2491 ofport_destroy__(port);
2496 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2498 struct ofport *port;
2500 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2502 if (port->ofp_port == ofp_port) {
2509 static long long int
2510 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2512 struct ofport_usage *usage;
2514 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2515 &ofproto->ofport_usage) {
2516 if (usage->ofp_port == ofp_port) {
2517 return usage->last_used;
2524 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2525 long long int last_used)
2527 struct ofport_usage *usage;
2528 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2529 &ofproto->ofport_usage) {
2530 if (usage->ofp_port == ofp_port) {
2531 usage->last_used = last_used;
2535 ovs_assert(last_used == LLONG_MAX);
2537 usage = xmalloc(sizeof *usage);
2538 usage->ofp_port = ofp_port;
2539 usage->last_used = last_used;
2540 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2541 hash_ofp_port(ofp_port));
2545 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2547 struct ofport_usage *usage;
2548 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2549 &ofproto->ofport_usage) {
2550 if (usage->ofp_port == ofp_port) {
2551 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2559 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2561 struct ofproto *ofproto = port->ofproto;
2564 if (ofproto->ofproto_class->port_get_stats) {
2565 error = ofproto->ofproto_class->port_get_stats(port, stats);
2574 update_port(struct ofproto *ofproto, const char *name)
2576 struct ofproto_port ofproto_port;
2577 struct ofputil_phy_port pp;
2578 struct netdev *netdev;
2579 struct ofport *port;
2581 COVERAGE_INC(ofproto_update_port);
2583 /* Fetch 'name''s location and properties from the datapath. */
2584 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2585 ? ofport_open(ofproto, &ofproto_port, &pp)
2589 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2590 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2591 struct netdev *old_netdev = port->netdev;
2593 /* 'name' hasn't changed location. Any properties changed? */
2594 if (!ofport_equal(&port->pp, &pp)) {
2595 ofport_modified(port, &pp);
2598 update_mtu(ofproto, port);
2600 /* Install the newly opened netdev in case it has changed.
2601 * Don't close the old netdev yet in case port_modified has to
2602 * remove a retained reference to it.*/
2603 port->netdev = netdev;
2604 port->change_seq = netdev_get_change_seq(netdev);
2606 if (port->ofproto->ofproto_class->port_modified) {
2607 port->ofproto->ofproto_class->port_modified(port);
2610 netdev_close(old_netdev);
2612 /* If 'port' is nonnull then its name differs from 'name' and thus
2613 * we should delete it. If we think there's a port named 'name'
2614 * then its port number must be wrong now so delete it too. */
2616 ofport_remove(port);
2618 ofport_remove_with_name(ofproto, name);
2619 ofport_install(ofproto, netdev, &pp);
2622 /* Any port named 'name' is gone now. */
2623 ofport_remove_with_name(ofproto, name);
2625 ofproto_port_destroy(&ofproto_port);
2629 init_ports(struct ofproto *p)
2631 struct ofproto_port_dump dump;
2632 struct ofproto_port ofproto_port;
2633 struct shash_node *node, *next;
2635 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2636 const char *name = ofproto_port.name;
2638 if (shash_find(&p->port_by_name, name)) {
2639 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2642 struct ofputil_phy_port pp;
2643 struct netdev *netdev;
2645 /* Check if an OpenFlow port number had been requested. */
2646 node = shash_find(&init_ofp_ports, name);
2648 const struct iface_hint *iface_hint = node->data;
2649 simap_put(&p->ofp_requests, name,
2650 ofp_to_u16(iface_hint->ofp_port));
2653 netdev = ofport_open(p, &ofproto_port, &pp);
2655 ofport_install(p, netdev, &pp);
2656 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2657 p->alloc_port_no = MAX(p->alloc_port_no,
2658 ofp_to_u16(ofproto_port.ofp_port));
2664 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2665 struct iface_hint *iface_hint = node->data;
2667 if (!strcmp(iface_hint->br_name, p->name)) {
2668 free(iface_hint->br_name);
2669 free(iface_hint->br_type);
2671 shash_delete(&init_ofp_ports, node);
2678 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2679 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2681 find_min_mtu(struct ofproto *p)
2683 struct ofport *ofport;
2686 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2687 struct netdev *netdev = ofport->netdev;
2690 /* Skip any internal ports, since that's what we're trying to
2692 if (!strcmp(netdev_get_type(netdev), "internal")) {
2696 if (netdev_get_mtu(netdev, &dev_mtu)) {
2699 if (!mtu || dev_mtu < mtu) {
2704 return mtu ? mtu: ETH_PAYLOAD_MAX;
2707 /* Update MTU of all datapath devices on 'p' to the minimum of the
2708 * non-datapath ports in event of 'port' added or changed. */
2710 update_mtu(struct ofproto *p, struct ofport *port)
2712 struct ofport *ofport;
2713 struct netdev *netdev = port->netdev;
2714 int dev_mtu, old_min;
2716 if (netdev_get_mtu(netdev, &dev_mtu)) {
2720 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2721 if (dev_mtu > p->min_mtu) {
2722 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2723 dev_mtu = p->min_mtu;
2726 port->mtu = dev_mtu;
2730 /* For non-internal port find new min mtu. */
2731 old_min = p->min_mtu;
2732 port->mtu = dev_mtu;
2733 p->min_mtu = find_min_mtu(p);
2734 if (p->min_mtu == old_min) {
2738 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2739 struct netdev *netdev = ofport->netdev;
2741 if (!strcmp(netdev_get_type(netdev), "internal")) {
2742 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2743 ofport->mtu = p->min_mtu;
2750 ofproto_rule_destroy__(struct rule *rule)
2751 OVS_NO_THREAD_SAFETY_ANALYSIS
2753 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2754 rule_actions_destroy(rule_get_actions(rule));
2755 ovs_mutex_destroy(&rule->mutex);
2756 rule->ofproto->ofproto_class->rule_dealloc(rule);
2760 rule_destroy_cb(struct rule *rule)
2761 OVS_NO_THREAD_SAFETY_ANALYSIS
2763 /* Send rule removed if needed. */
2764 if (rule->flags & OFPUTIL_FF_SEND_FLOW_REM
2765 && rule->removed_reason != OVS_OFPRR_NONE
2766 && !rule_is_hidden(rule)) {
2767 ofproto_rule_send_removed(rule);
2769 rule->ofproto->ofproto_class->rule_destruct(rule);
2770 ofproto_rule_destroy__(rule);
2774 ofproto_rule_ref(struct rule *rule)
2777 ovs_refcount_ref(&rule->ref_count);
2782 ofproto_rule_try_ref(struct rule *rule)
2785 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2790 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2791 * ref_count reaches 0.
2793 * Use of RCU allows short term use (between RCU quiescent periods) without
2794 * keeping a reference. A reference must be taken if the rule needs to
2795 * stay around accross the RCU quiescent periods. */
2797 ofproto_rule_unref(struct rule *rule)
2799 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2800 ovsrcu_postpone(rule_destroy_cb, rule);
2805 remove_rule_rcu__(struct rule *rule)
2806 OVS_REQUIRES(ofproto_mutex)
2808 struct ofproto *ofproto = rule->ofproto;
2809 struct oftable *table = &ofproto->tables[rule->table_id];
2811 ovs_assert(!cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
2812 if (!classifier_remove(&table->cls, &rule->cr)) {
2815 ofproto->ofproto_class->rule_delete(rule);
2816 ofproto_rule_unref(rule);
2820 remove_rule_rcu(struct rule *rule)
2821 OVS_EXCLUDED(ofproto_mutex)
2823 ovs_mutex_lock(&ofproto_mutex);
2824 remove_rule_rcu__(rule);
2825 ovs_mutex_unlock(&ofproto_mutex);
2828 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2830 remove_rules_rcu(struct rule **rules)
2831 OVS_EXCLUDED(ofproto_mutex)
2833 struct rule **orig_rules = rules;
2836 struct ofproto *ofproto = rules[0]->ofproto;
2837 unsigned long tables[BITMAP_N_LONGS(256)];
2841 memset(tables, 0, sizeof tables);
2843 ovs_mutex_lock(&ofproto_mutex);
2844 while ((rule = *rules++)) {
2845 /* Defer once for each new table. This defers the subtable cleanup
2846 * until later, so that when removing large number of flows the
2847 * operation is faster. */
2848 if (!bitmap_is_set(tables, rule->table_id)) {
2849 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
2851 bitmap_set1(tables, rule->table_id);
2852 classifier_defer(cls);
2854 remove_rule_rcu__(rule);
2857 BITMAP_FOR_EACH_1(table_id, 256, tables) {
2858 struct classifier *cls = &ofproto->tables[table_id].cls;
2860 classifier_publish(cls);
2862 ovs_mutex_unlock(&ofproto_mutex);
2869 ofproto_group_ref(struct ofgroup *group)
2872 ovs_refcount_ref(&group->ref_count);
2877 ofproto_group_unref(struct ofgroup *group)
2879 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2880 group->ofproto->ofproto_class->group_destruct(group);
2881 ofputil_bucket_list_destroy(&group->buckets);
2882 group->ofproto->ofproto_class->group_dealloc(group);
2886 static uint32_t get_provider_meter_id(const struct ofproto *,
2887 uint32_t of_meter_id);
2889 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2890 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2891 const struct rule_actions *
2892 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2894 struct rule_actions *actions;
2896 actions = xmalloc(sizeof *actions + ofpacts_len);
2897 actions->ofpacts_len = ofpacts_len;
2898 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2899 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2901 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2907 /* Free the actions after the RCU quiescent period is reached. */
2909 rule_actions_destroy(const struct rule_actions *actions)
2912 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2916 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2917 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2919 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2920 OVS_REQUIRES(ofproto_mutex)
2922 if (port == OFPP_ANY) {
2925 const struct rule_actions *actions = rule_get_actions(rule);
2926 return ofpacts_output_to_port(actions->ofpacts,
2927 actions->ofpacts_len, port);
2931 /* Returns true if 'rule' has group and equals group_id. */
2933 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2934 OVS_REQUIRES(ofproto_mutex)
2936 if (group_id == OFPG_ANY) {
2939 const struct rule_actions *actions = rule_get_actions(rule);
2940 return ofpacts_output_to_group(actions->ofpacts,
2941 actions->ofpacts_len, group_id);
2946 rule_execute_destroy(struct rule_execute *e)
2948 ofproto_rule_unref(e->rule);
2949 list_remove(&e->list_node);
2953 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2954 * by passing them to the ofproto provider. */
2956 run_rule_executes(struct ofproto *ofproto)
2957 OVS_EXCLUDED(ofproto_mutex)
2959 struct rule_execute *e, *next;
2960 struct ovs_list executes;
2962 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2963 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2966 flow_extract(e->packet, &flow);
2967 flow.in_port.ofp_port = e->in_port;
2968 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2970 rule_execute_destroy(e);
2974 /* Destroys and discards all "rule_execute" operations queued up in
2975 * ofproto->rule_executes. */
2977 destroy_rule_executes(struct ofproto *ofproto)
2979 struct rule_execute *e, *next;
2980 struct ovs_list executes;
2982 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2983 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2984 dp_packet_delete(e->packet);
2985 rule_execute_destroy(e);
2990 rule_is_readonly(const struct rule *rule)
2992 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2993 return (table->flags & OFTABLE_READONLY) != 0;
2997 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2999 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
3000 return hash_3words(cookie, cookie >> 32, table_id);
3004 learned_cookies_update_one__(struct ofproto *ofproto,
3005 const struct ofpact_learn *learn,
3006 int delta, struct ovs_list *dead_cookies)
3007 OVS_REQUIRES(ofproto_mutex)
3009 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
3010 struct learned_cookie *c;
3012 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
3013 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
3015 ovs_assert(c->n >= 0);
3018 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
3019 list_push_back(dead_cookies, &c->u.list_node);
3026 ovs_assert(delta > 0);
3027 c = xmalloc(sizeof *c);
3028 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
3029 c->cookie = learn->cookie;
3030 c->table_id = learn->table_id;
3034 static const struct ofpact_learn *
3035 next_learn_with_delete(const struct rule_actions *actions,
3036 const struct ofpact_learn *start)
3038 const struct ofpact *pos;
3040 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
3041 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
3042 pos = ofpact_next(pos)) {
3043 if (pos->type == OFPACT_LEARN) {
3044 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
3045 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3055 learned_cookies_update__(struct ofproto *ofproto,
3056 const struct rule_actions *actions,
3057 int delta, struct ovs_list *dead_cookies)
3058 OVS_REQUIRES(ofproto_mutex)
3060 if (actions->has_learn_with_delete) {
3061 const struct ofpact_learn *learn;
3063 for (learn = next_learn_with_delete(actions, NULL); learn;
3064 learn = next_learn_with_delete(actions, learn)) {
3065 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3071 learned_cookies_inc(struct ofproto *ofproto,
3072 const struct rule_actions *actions)
3073 OVS_REQUIRES(ofproto_mutex)
3075 learned_cookies_update__(ofproto, actions, +1, NULL);
3079 learned_cookies_dec(struct ofproto *ofproto,
3080 const struct rule_actions *actions,
3081 struct ovs_list *dead_cookies)
3082 OVS_REQUIRES(ofproto_mutex)
3084 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3088 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3089 OVS_REQUIRES(ofproto_mutex)
3091 struct learned_cookie *c;
3093 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3094 struct rule_criteria criteria;
3095 struct rule_collection rules;
3098 match_init_catchall(&match);
3099 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3100 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3101 rule_criteria_require_rw(&criteria, false);
3102 collect_rules_loose(ofproto, &criteria, &rules);
3103 rule_criteria_destroy(&criteria);
3104 delete_flows__(&rules, OFPRR_DELETE, NULL);
3111 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3113 ofconn_send_reply(ofconn, make_echo_reply(oh));
3118 query_tables(struct ofproto *ofproto,
3119 struct ofputil_table_features **featuresp,
3120 struct ofputil_table_stats **statsp)
3122 struct mf_bitmap rw_fields = oxm_writable_fields();
3123 struct mf_bitmap match = oxm_matchable_fields();
3124 struct mf_bitmap mask = oxm_maskable_fields();
3126 struct ofputil_table_features *features;
3127 struct ofputil_table_stats *stats;
3130 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3131 for (i = 0; i < ofproto->n_tables; i++) {
3132 struct ofputil_table_features *f = &features[i];
3135 sprintf(f->name, "table%d", i);
3136 f->metadata_match = OVS_BE64_MAX;
3137 f->metadata_write = OVS_BE64_MAX;
3138 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3139 f->max_entries = 1000000;
3141 bool more_tables = false;
3142 for (int j = i + 1; j < ofproto->n_tables; j++) {
3143 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3144 bitmap_set1(f->nonmiss.next, j);
3148 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3150 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3152 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3153 f->nonmiss.write.set_fields = rw_fields;
3154 f->nonmiss.apply = f->nonmiss.write;
3155 f->miss = f->nonmiss;
3159 f->wildcard = match;
3163 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3164 for (i = 0; i < ofproto->n_tables; i++) {
3165 struct ofputil_table_stats *s = &stats[i];
3168 s->active_count = ofproto->tables[i].n_flows;
3170 s->active_count -= connmgr_count_hidden_rules(
3178 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3180 for (i = 0; i < ofproto->n_tables; i++) {
3181 const struct oftable *table = &ofproto->tables[i];
3182 struct ofputil_table_features *f = &features[i];
3185 ovs_strzcpy(f->name, table->name, sizeof f->name);
3188 if (table->max_flows < f->max_entries) {
3189 f->max_entries = table->max_flows;
3195 query_switch_features(struct ofproto *ofproto,
3196 bool *arp_match_ip, uint64_t *ofpacts)
3198 struct ofputil_table_features *features, *f;
3200 *arp_match_ip = false;
3203 query_tables(ofproto, &features, NULL);
3204 for (f = features; f < &features[ofproto->n_tables]; f++) {
3205 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3206 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3207 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3208 *arp_match_ip = true;
3214 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3218 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3220 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3221 struct ofputil_switch_features features;
3222 struct ofport *port;
3226 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3228 features.datapath_id = ofproto->datapath_id;
3229 features.n_buffers = pktbuf_capacity();
3230 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3231 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3232 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3233 OFPUTIL_C_GROUP_STATS);
3235 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3237 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3238 features.auxiliary_id = 0;
3239 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3241 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3242 ofputil_put_switch_features_port(&port->pp, b);
3245 ofconn_send_reply(ofconn, b);
3250 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3252 struct ofputil_switch_config config;
3253 config.frag = ofconn_get_ofproto(ofconn)->frag_handling;
3254 config.invalid_ttl_to_controller
3255 = ofconn_get_invalid_ttl_to_controller(ofconn);
3256 config.miss_send_len = ofconn_get_miss_send_len(ofconn);
3258 ofconn_send_reply(ofconn, ofputil_encode_get_config_reply(oh, &config));
3264 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3266 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3267 struct ofputil_switch_config config;
3270 error = ofputil_decode_set_config(oh, &config);
3275 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3276 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3277 enum ofputil_frag_handling cur = ofproto->frag_handling;
3278 enum ofputil_frag_handling next = config.frag;
3281 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3282 ofproto->frag_handling = next;
3284 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3286 ofputil_frag_handling_to_string(next));
3291 if (config.invalid_ttl_to_controller >= 0) {
3292 ofconn_set_invalid_ttl_to_controller(ofconn,
3293 config.invalid_ttl_to_controller);
3296 ofconn_set_miss_send_len(ofconn, config.miss_send_len);
3301 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3302 * error message code for the caller to propagate upward. Otherwise, returns
3305 * The log message mentions 'msg_type'. */
3307 reject_slave_controller(struct ofconn *ofconn)
3309 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3310 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3311 return OFPERR_OFPBRC_IS_SLAVE;
3317 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3320 * - If they use a meter, then 'ofproto' has that meter configured.
3322 * - If they use any groups, then 'ofproto' has that group configured.
3324 * Returns 0 if successful, otherwise an OpenFlow error. */
3326 ofproto_check_ofpacts(struct ofproto *ofproto,
3327 const struct ofpact ofpacts[], size_t ofpacts_len)
3329 const struct ofpact *a;
3332 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3333 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3334 return OFPERR_OFPMMFC_INVALID_METER;
3337 OFPACT_FOR_EACH_FLATTENED (a, ofpacts, ofpacts_len) {
3338 if (a->type == OFPACT_GROUP
3339 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3340 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3348 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3350 struct ofproto *p = ofconn_get_ofproto(ofconn);
3351 struct ofputil_packet_out po;
3352 struct dp_packet *payload;
3353 uint64_t ofpacts_stub[1024 / 8];
3354 struct ofpbuf ofpacts;
3358 COVERAGE_INC(ofproto_packet_out);
3360 error = reject_slave_controller(ofconn);
3365 /* Decode message. */
3366 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3367 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3369 goto exit_free_ofpacts;
3371 if (ofp_to_u16(po.in_port) >= p->max_ports
3372 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3373 error = OFPERR_OFPBRC_BAD_PORT;
3374 goto exit_free_ofpacts;
3378 if (po.buffer_id != UINT32_MAX) {
3379 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3380 if (error || !payload) {
3381 goto exit_free_ofpacts;
3384 /* Ensure that the L3 header is 32-bit aligned. */
3385 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3388 /* Verify actions against packet, then send packet if successful. */
3389 flow_extract(payload, &flow);
3390 flow.in_port.ofp_port = po.in_port;
3392 /* Check actions like for flow mods. We pass a 'table_id' of 0 to
3393 * ofproto_check_consistency(), which isn't strictly correct because these
3394 * actions aren't in any table. This is OK as 'table_id' is only used to
3395 * check instructions (e.g., goto-table), which can't appear on the action
3396 * list of a packet-out. */
3397 error = ofpacts_check_consistency(po.ofpacts, po.ofpacts_len,
3398 &flow, u16_to_ofp(p->max_ports),
3400 ofconn_get_protocol(ofconn));
3402 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3404 error = p->ofproto_class->packet_out(p, payload, &flow,
3405 po.ofpacts, po.ofpacts_len);
3408 dp_packet_delete(payload);
3411 ofpbuf_uninit(&ofpacts);
3417 update_port_config(struct ofconn *ofconn, struct ofport *port,
3418 enum ofputil_port_config config,
3419 enum ofputil_port_config mask)
3421 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3423 if (toggle & OFPUTIL_PC_PORT_DOWN
3424 && (config & OFPUTIL_PC_PORT_DOWN
3425 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3426 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3427 /* We tried to bring the port up or down, but it failed, so don't
3428 * update the "down" bit. */
3429 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3433 enum ofputil_port_config old_config = port->pp.config;
3434 port->pp.config ^= toggle;
3435 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3436 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3442 port_mod_start(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3443 struct ofport **port)
3445 struct ofproto *p = ofconn_get_ofproto(ofconn);
3447 *port = ofproto_get_port(p, pm->port_no);
3449 return OFPERR_OFPPMFC_BAD_PORT;
3451 if (!eth_addr_equals((*port)->pp.hw_addr, pm->hw_addr)) {
3452 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3458 port_mod_finish(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3459 struct ofport *port)
3461 update_port_config(ofconn, port, pm->config, pm->mask);
3462 if (pm->advertise) {
3463 netdev_set_advertisements(port->netdev, pm->advertise);
3468 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3470 struct ofputil_port_mod pm;
3471 struct ofport *port;
3474 error = reject_slave_controller(ofconn);
3479 error = ofputil_decode_port_mod(oh, &pm, false);
3484 error = port_mod_start(ofconn, &pm, &port);
3486 port_mod_finish(ofconn, &pm, port);
3492 handle_desc_stats_request(struct ofconn *ofconn,
3493 const struct ofp_header *request)
3495 static const char *default_mfr_desc = "Nicira, Inc.";
3496 static const char *default_hw_desc = "Open vSwitch";
3497 static const char *default_sw_desc = VERSION;
3498 static const char *default_serial_desc = "None";
3499 static const char *default_dp_desc = "None";
3501 struct ofproto *p = ofconn_get_ofproto(ofconn);
3502 struct ofp_desc_stats *ods;
3505 msg = ofpraw_alloc_stats_reply(request, 0);
3506 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3507 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3508 sizeof ods->mfr_desc);
3509 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3510 sizeof ods->hw_desc);
3511 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3512 sizeof ods->sw_desc);
3513 ovs_strlcpy(ods->serial_num,
3514 p->serial_desc ? p->serial_desc : default_serial_desc,
3515 sizeof ods->serial_num);
3516 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3517 sizeof ods->dp_desc);
3518 ofconn_send_reply(ofconn, msg);
3524 handle_table_stats_request(struct ofconn *ofconn,
3525 const struct ofp_header *request)
3527 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3528 struct ofputil_table_features *features;
3529 struct ofputil_table_stats *stats;
3530 struct ofpbuf *reply;
3533 query_tables(ofproto, &features, &stats);
3535 reply = ofputil_encode_table_stats_reply(request);
3536 for (i = 0; i < ofproto->n_tables; i++) {
3537 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3538 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3541 ofconn_send_reply(ofconn, reply);
3550 handle_table_features_request(struct ofconn *ofconn,
3551 const struct ofp_header *request)
3553 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3554 struct ofputil_table_features *features;
3555 struct ovs_list replies;
3559 ofpbuf_use_const(&msg, request, ntohs(request->length));
3560 ofpraw_pull_assert(&msg);
3561 if (msg.size || ofpmp_more(request)) {
3562 return OFPERR_OFPTFFC_EPERM;
3565 query_tables(ofproto, &features, NULL);
3567 ofpmp_init(&replies, request);
3568 for (i = 0; i < ofproto->n_tables; i++) {
3569 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3570 ofputil_append_table_features_reply(&features[i], &replies);
3573 ofconn_send_replies(ofconn, &replies);
3581 query_table_desc__(struct ofputil_table_desc *td,
3582 struct ofproto *ofproto, uint8_t table_id)
3584 unsigned int count = ofproto->tables[table_id].n_flows;
3585 unsigned int max_flows = ofproto->tables[table_id].max_flows;
3587 td->table_id = table_id;
3588 td->eviction = (ofproto->tables[table_id].eviction & EVICTION_OPENFLOW
3589 ? OFPUTIL_TABLE_EVICTION_ON
3590 : OFPUTIL_TABLE_EVICTION_OFF);
3591 td->eviction_flags = OFPROTO_EVICTION_FLAGS;
3592 td->vacancy = (ofproto->tables[table_id].vacancy_enabled
3593 ? OFPUTIL_TABLE_VACANCY_ON
3594 : OFPUTIL_TABLE_VACANCY_OFF);
3595 td->table_vacancy.vacancy_down = ofproto->tables[table_id].vacancy_down;
3596 td->table_vacancy.vacancy_up = ofproto->tables[table_id].vacancy_up;
3597 td->table_vacancy.vacancy = max_flows ? (count * 100) / max_flows : 0;
3600 /* This function queries the database for dumping table-desc. */
3602 query_tables_desc(struct ofproto *ofproto, struct ofputil_table_desc **descp)
3604 struct ofputil_table_desc *table_desc;
3607 table_desc = *descp = xcalloc(ofproto->n_tables, sizeof *table_desc);
3608 for (i = 0; i < ofproto->n_tables; i++) {
3609 struct ofputil_table_desc *td = &table_desc[i];
3610 query_table_desc__(td, ofproto, i);
3614 /* Function to handle dump-table-desc request. */
3616 handle_table_desc_request(struct ofconn *ofconn,
3617 const struct ofp_header *request)
3619 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3620 struct ofputil_table_desc *table_desc;
3621 struct ovs_list replies;
3624 query_tables_desc(ofproto, &table_desc);
3625 ofpmp_init(&replies, request);
3626 for (i = 0; i < ofproto->n_tables; i++) {
3627 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3628 ofputil_append_table_desc_reply(&table_desc[i], &replies,
3632 ofconn_send_replies(ofconn, &replies);
3638 append_port_stat(struct ofport *port, struct ovs_list *replies)
3640 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3642 calc_duration(port->created, time_msec(),
3643 &ops.duration_sec, &ops.duration_nsec);
3645 /* Intentionally ignore return value, since errors will set
3646 * 'stats' to all-1s, which is correct for OpenFlow, and
3647 * netdev_get_stats() will log errors. */
3648 ofproto_port_get_stats(port, &ops.stats);
3650 ofputil_append_port_stat(replies, &ops);
3654 handle_port_request(struct ofconn *ofconn,
3655 const struct ofp_header *request, ofp_port_t port_no,
3656 void (*cb)(struct ofport *, struct ovs_list *replies))
3658 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3659 struct ofport *port;
3660 struct ovs_list replies;
3662 ofpmp_init(&replies, request);
3663 if (port_no != OFPP_ANY) {
3664 port = ofproto_get_port(ofproto, port_no);
3669 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3674 ofconn_send_replies(ofconn, &replies);
3678 handle_port_stats_request(struct ofconn *ofconn,
3679 const struct ofp_header *request)
3684 error = ofputil_decode_port_stats_request(request, &port_no);
3686 handle_port_request(ofconn, request, port_no, append_port_stat);
3692 append_port_desc(struct ofport *port, struct ovs_list *replies)
3694 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3698 handle_port_desc_stats_request(struct ofconn *ofconn,
3699 const struct ofp_header *request)
3704 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3706 handle_port_request(ofconn, request, port_no, append_port_desc);
3712 hash_cookie(ovs_be64 cookie)
3714 return hash_uint64((OVS_FORCE uint64_t)cookie);
3718 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3719 OVS_REQUIRES(ofproto_mutex)
3721 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3722 hash_cookie(rule->flow_cookie));
3726 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3727 OVS_REQUIRES(ofproto_mutex)
3729 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3733 calc_duration(long long int start, long long int now,
3734 uint32_t *sec, uint32_t *nsec)
3736 long long int msecs = now - start;
3737 *sec = msecs / 1000;
3738 *nsec = (msecs % 1000) * (1000 * 1000);
3741 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3742 * true if 'table_id' is OK, false otherwise. */
3744 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3746 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3749 static struct oftable *
3750 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3752 struct oftable *table;
3754 for (table = &ofproto->tables[table_id];
3755 table < &ofproto->tables[ofproto->n_tables];
3757 if (!(table->flags & OFTABLE_HIDDEN)) {
3765 static struct oftable *
3766 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3768 if (table_id == 0xff) {
3769 return next_visible_table(ofproto, 0);
3770 } else if (table_id < ofproto->n_tables) {
3771 return &ofproto->tables[table_id];
3777 static struct oftable *
3778 next_matching_table(const struct ofproto *ofproto,
3779 const struct oftable *table, uint8_t table_id)
3781 return (table_id == 0xff
3782 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3786 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3788 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3789 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3791 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3792 * only once, for that table. (This can be used to access tables marked
3795 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3796 * entered at all. (Perhaps you should have validated TABLE_ID with
3797 * check_table_id().)
3799 * All parameters are evaluated multiple times.
3801 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3802 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3804 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3806 /* Initializes 'criteria' in a straightforward way based on the other
3809 * By default, the criteria include flows that are read-only, on the assumption
3810 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3811 * if flows will be modified.
3813 * For "loose" matching, the 'priority' parameter is unimportant and may be
3816 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3817 const struct match *match, int priority,
3818 cls_version_t version, ovs_be64 cookie,
3819 ovs_be64 cookie_mask, ofp_port_t out_port,
3822 criteria->table_id = table_id;
3823 cls_rule_init(&criteria->cr, match, priority);
3824 criteria->version = version;
3825 criteria->cookie = cookie;
3826 criteria->cookie_mask = cookie_mask;
3827 criteria->out_port = out_port;
3828 criteria->out_group = out_group;
3830 /* We ordinarily want to skip hidden rules, but there has to be a way for
3831 * code internal to OVS to modify and delete them, so if the criteria
3832 * specify a priority that can only be for a hidden flow, then allow hidden
3833 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3834 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3836 criteria->include_hidden = priority > UINT16_MAX;
3838 /* We assume that the criteria are being used to collect flows for reading
3839 * but not modification. Thus, we should collect read-only flows. */
3840 criteria->include_readonly = true;
3843 /* By default, criteria initialized by rule_criteria_init() will match flows
3844 * that are read-only, on the assumption that the collected flows won't be
3845 * modified. Call this function to match only flows that are be modifiable.
3847 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3848 * caller has special privileges that allow it to modify even "read-only"
3851 rule_criteria_require_rw(struct rule_criteria *criteria,
3852 bool can_write_readonly)
3854 criteria->include_readonly = can_write_readonly;
3858 rule_criteria_destroy(struct rule_criteria *criteria)
3860 cls_rule_destroy(&criteria->cr);
3864 rule_collection_init(struct rule_collection *rules)
3866 rules->rules = rules->stub;
3868 rules->capacity = ARRAY_SIZE(rules->stub);
3872 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3874 if (rules->n >= rules->capacity) {
3875 size_t old_size, new_size;
3877 old_size = rules->capacity * sizeof *rules->rules;
3878 rules->capacity *= 2;
3879 new_size = rules->capacity * sizeof *rules->rules;
3881 if (rules->rules == rules->stub) {
3882 rules->rules = xmalloc(new_size);
3883 memcpy(rules->rules, rules->stub, old_size);
3885 rules->rules = xrealloc(rules->rules, new_size);
3889 rules->rules[rules->n++] = rule;
3893 rule_collection_ref(struct rule_collection *rules)
3894 OVS_REQUIRES(ofproto_mutex)
3898 for (i = 0; i < rules->n; i++) {
3899 ofproto_rule_ref(rules->rules[i]);
3904 rule_collection_unref(struct rule_collection *rules)
3908 for (i = 0; i < rules->n; i++) {
3909 ofproto_rule_unref(rules->rules[i]);
3913 /* Returns a NULL-terminated array of rule pointers,
3914 * destroys 'rules'. */
3915 static struct rule **
3916 rule_collection_detach(struct rule_collection *rules)
3918 struct rule **rule_array;
3920 rule_collection_add(rules, NULL);
3922 if (rules->rules == rules->stub) {
3923 rules->rules = xmemdup(rules->rules, rules->n * sizeof *rules->rules);
3926 rule_array = rules->rules;
3927 rule_collection_init(rules);
3933 rule_collection_destroy(struct rule_collection *rules)
3935 if (rules->rules != rules->stub) {
3939 /* Make repeated destruction harmless. */
3940 rule_collection_init(rules);
3943 /* Schedules postponed removal of rules, destroys 'rules'. */
3945 rule_collection_remove_postponed(struct rule_collection *rules)
3946 OVS_REQUIRES(ofproto_mutex)
3949 if (rules->n == 1) {
3950 ovsrcu_postpone(remove_rule_rcu, rules->rules[0]);
3952 ovsrcu_postpone(remove_rules_rcu, rule_collection_detach(rules));
3957 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3958 * function verifies most of the criteria in 'c' itself, but the caller must
3959 * check 'c->cr' itself.
3961 * Rules that have already been marked for removal are not collected.
3963 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3964 * 'c' only includes modifiable rules). */
3966 collect_rule(struct rule *rule, const struct rule_criteria *c,
3967 struct rule_collection *rules, size_t *n_readonly)
3968 OVS_REQUIRES(ofproto_mutex)
3970 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3971 && ofproto_rule_has_out_port(rule, c->out_port)
3972 && ofproto_rule_has_out_group(rule, c->out_group)
3973 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3974 && (!rule_is_hidden(rule) || c->include_hidden)
3975 && cls_rule_visible_in_version(&rule->cr, c->version)) {
3976 /* Rule matches all the criteria... */
3977 if (!rule_is_readonly(rule) || c->include_readonly) {
3979 rule_collection_add(rules, rule);
3981 /* ...except it's read-only. */
3987 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3988 * on classifiers rules are done in the "loose" way required for OpenFlow
3989 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3992 * Returns 0 on success, otherwise an OpenFlow error code. */
3994 collect_rules_loose(struct ofproto *ofproto,
3995 const struct rule_criteria *criteria,
3996 struct rule_collection *rules)
3997 OVS_REQUIRES(ofproto_mutex)
3999 struct oftable *table;
4000 enum ofperr error = 0;
4001 size_t n_readonly = 0;
4003 rule_collection_init(rules);
4005 if (!check_table_id(ofproto, criteria->table_id)) {
4006 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4010 if (criteria->cookie_mask == OVS_BE64_MAX) {
4013 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4014 hash_cookie(criteria->cookie),
4015 &ofproto->cookies) {
4016 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
4017 collect_rule(rule, criteria, rules, &n_readonly);
4021 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4024 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr,
4025 criteria->version) {
4026 collect_rule(rule, criteria, rules, &n_readonly);
4032 if (!error && !rules->n && n_readonly) {
4033 /* We didn't find any rules to modify. We did find some read-only
4034 * rules that we're not allowed to modify, so report that. */
4035 error = OFPERR_OFPBRC_EPERM;
4038 rule_collection_destroy(rules);
4043 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4044 * on classifiers rules are done in the "strict" way required for OpenFlow
4045 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
4046 * rules on list 'rules'.
4048 * Returns 0 on success, otherwise an OpenFlow error code. */
4050 collect_rules_strict(struct ofproto *ofproto,
4051 const struct rule_criteria *criteria,
4052 struct rule_collection *rules)
4053 OVS_REQUIRES(ofproto_mutex)
4055 struct oftable *table;
4056 size_t n_readonly = 0;
4057 enum ofperr error = 0;
4059 rule_collection_init(rules);
4061 if (!check_table_id(ofproto, criteria->table_id)) {
4062 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4066 if (criteria->cookie_mask == OVS_BE64_MAX) {
4069 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4070 hash_cookie(criteria->cookie),
4071 &ofproto->cookies) {
4072 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
4073 collect_rule(rule, criteria, rules, &n_readonly);
4077 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4080 rule = rule_from_cls_rule(classifier_find_rule_exactly(
4081 &table->cls, &criteria->cr,
4082 criteria->version));
4084 collect_rule(rule, criteria, rules, &n_readonly);
4090 if (!error && !rules->n && n_readonly) {
4091 /* We didn't find any rules to modify. We did find some read-only
4092 * rules that we're not allowed to modify, so report that. */
4093 error = OFPERR_OFPBRC_EPERM;
4096 rule_collection_destroy(rules);
4101 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4102 * forced into the range of a uint16_t. */
4104 age_secs(long long int age_ms)
4106 return (age_ms < 0 ? 0
4107 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
4108 : (unsigned int) age_ms / 1000);
4112 handle_flow_stats_request(struct ofconn *ofconn,
4113 const struct ofp_header *request)
4114 OVS_EXCLUDED(ofproto_mutex)
4116 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4117 struct ofputil_flow_stats_request fsr;
4118 struct rule_criteria criteria;
4119 struct rule_collection rules;
4120 struct ovs_list replies;
4124 error = ofputil_decode_flow_stats_request(&fsr, request);
4129 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
4130 fsr.cookie, fsr.cookie_mask, fsr.out_port,
4133 ovs_mutex_lock(&ofproto_mutex);
4134 error = collect_rules_loose(ofproto, &criteria, &rules);
4135 rule_criteria_destroy(&criteria);
4137 rule_collection_ref(&rules);
4139 ovs_mutex_unlock(&ofproto_mutex);
4145 ofpmp_init(&replies, request);
4146 for (i = 0; i < rules.n; i++) {
4147 struct rule *rule = rules.rules[i];
4148 long long int now = time_msec();
4149 struct ofputil_flow_stats fs;
4150 long long int created, used, modified;
4151 const struct rule_actions *actions;
4152 enum ofputil_flow_mod_flags flags;
4154 ovs_mutex_lock(&rule->mutex);
4155 fs.cookie = rule->flow_cookie;
4156 fs.idle_timeout = rule->idle_timeout;
4157 fs.hard_timeout = rule->hard_timeout;
4158 fs.importance = rule->importance;
4159 created = rule->created;
4160 modified = rule->modified;
4161 actions = rule_get_actions(rule);
4162 flags = rule->flags;
4163 ovs_mutex_unlock(&rule->mutex);
4165 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
4166 &fs.byte_count, &used);
4168 minimatch_expand(&rule->cr.match, &fs.match);
4169 fs.table_id = rule->table_id;
4170 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4171 fs.priority = rule->cr.priority;
4172 fs.idle_age = age_secs(now - used);
4173 fs.hard_age = age_secs(now - modified);
4174 fs.ofpacts = actions->ofpacts;
4175 fs.ofpacts_len = actions->ofpacts_len;
4178 ofputil_append_flow_stats_reply(&fs, &replies);
4181 rule_collection_unref(&rules);
4182 rule_collection_destroy(&rules);
4184 ofconn_send_replies(ofconn, &replies);
4190 flow_stats_ds(struct rule *rule, struct ds *results)
4192 uint64_t packet_count, byte_count;
4193 const struct rule_actions *actions;
4194 long long int created, used;
4196 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4197 &byte_count, &used);
4199 ovs_mutex_lock(&rule->mutex);
4200 actions = rule_get_actions(rule);
4201 created = rule->created;
4202 ovs_mutex_unlock(&rule->mutex);
4204 if (rule->table_id != 0) {
4205 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4207 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4208 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4209 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4210 cls_rule_format(&rule->cr, results);
4211 ds_put_char(results, ',');
4213 ds_put_cstr(results, "actions=");
4214 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4216 ds_put_cstr(results, "\n");
4219 /* Adds a pretty-printed description of all flows to 'results', including
4220 * hidden flows (e.g., set up by in-band control). */
4222 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4224 struct oftable *table;
4226 OFPROTO_FOR_EACH_TABLE (table, p) {
4229 CLS_FOR_EACH (rule, cr, &table->cls) {
4230 flow_stats_ds(rule, results);
4235 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4236 * '*engine_type' and '*engine_id', respectively. */
4238 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4239 uint8_t *engine_type, uint8_t *engine_id)
4241 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4244 /* Checks the status change of CFM on 'ofport'.
4246 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4248 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4250 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4251 return (ofport && ofproto->ofproto_class->cfm_status_changed
4252 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4256 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4257 * Returns 0 if the port's CFM status was successfully stored into
4258 * '*status'. Returns positive errno if the port did not have CFM
4261 * The caller must provide and own '*status', and must free 'status->rmps'.
4262 * '*status' is indeterminate if the return value is non-zero. */
4264 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4265 struct cfm_status *status)
4267 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4268 return (ofport && ofproto->ofproto_class->get_cfm_status
4269 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4274 handle_aggregate_stats_request(struct ofconn *ofconn,
4275 const struct ofp_header *oh)
4276 OVS_EXCLUDED(ofproto_mutex)
4278 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4279 struct ofputil_flow_stats_request request;
4280 struct ofputil_aggregate_stats stats;
4281 bool unknown_packets, unknown_bytes;
4282 struct rule_criteria criteria;
4283 struct rule_collection rules;
4284 struct ofpbuf *reply;
4288 error = ofputil_decode_flow_stats_request(&request, oh);
4293 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4294 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4295 request.out_port, request.out_group);
4297 ovs_mutex_lock(&ofproto_mutex);
4298 error = collect_rules_loose(ofproto, &criteria, &rules);
4299 rule_criteria_destroy(&criteria);
4301 rule_collection_ref(&rules);
4303 ovs_mutex_unlock(&ofproto_mutex);
4309 memset(&stats, 0, sizeof stats);
4310 unknown_packets = unknown_bytes = false;
4311 for (i = 0; i < rules.n; i++) {
4312 struct rule *rule = rules.rules[i];
4313 uint64_t packet_count;
4314 uint64_t byte_count;
4317 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4318 &byte_count, &used);
4320 if (packet_count == UINT64_MAX) {
4321 unknown_packets = true;
4323 stats.packet_count += packet_count;
4326 if (byte_count == UINT64_MAX) {
4327 unknown_bytes = true;
4329 stats.byte_count += byte_count;
4334 if (unknown_packets) {
4335 stats.packet_count = UINT64_MAX;
4337 if (unknown_bytes) {
4338 stats.byte_count = UINT64_MAX;
4341 rule_collection_unref(&rules);
4342 rule_collection_destroy(&rules);
4344 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4345 ofconn_send_reply(ofconn, reply);
4350 struct queue_stats_cbdata {
4351 struct ofport *ofport;
4352 struct ovs_list replies;
4357 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4358 const struct netdev_queue_stats *stats)
4360 struct ofputil_queue_stats oqs;
4362 oqs.port_no = cbdata->ofport->pp.port_no;
4363 oqs.queue_id = queue_id;
4364 oqs.tx_bytes = stats->tx_bytes;
4365 oqs.tx_packets = stats->tx_packets;
4366 oqs.tx_errors = stats->tx_errors;
4367 if (stats->created != LLONG_MIN) {
4368 calc_duration(stats->created, cbdata->now,
4369 &oqs.duration_sec, &oqs.duration_nsec);
4371 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4373 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4377 handle_queue_stats_dump_cb(uint32_t queue_id,
4378 struct netdev_queue_stats *stats,
4381 struct queue_stats_cbdata *cbdata = cbdata_;
4383 put_queue_stats(cbdata, queue_id, stats);
4387 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4388 struct queue_stats_cbdata *cbdata)
4390 cbdata->ofport = port;
4391 if (queue_id == OFPQ_ALL) {
4392 netdev_dump_queue_stats(port->netdev,
4393 handle_queue_stats_dump_cb, cbdata);
4395 struct netdev_queue_stats stats;
4397 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4398 put_queue_stats(cbdata, queue_id, &stats);
4400 return OFPERR_OFPQOFC_BAD_QUEUE;
4407 handle_queue_stats_request(struct ofconn *ofconn,
4408 const struct ofp_header *rq)
4410 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4411 struct queue_stats_cbdata cbdata;
4412 struct ofport *port;
4414 struct ofputil_queue_stats_request oqsr;
4416 COVERAGE_INC(ofproto_queue_req);
4418 ofpmp_init(&cbdata.replies, rq);
4419 cbdata.now = time_msec();
4421 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4426 if (oqsr.port_no == OFPP_ANY) {
4427 error = OFPERR_OFPQOFC_BAD_QUEUE;
4428 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4429 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4434 port = ofproto_get_port(ofproto, oqsr.port_no);
4436 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4437 : OFPERR_OFPQOFC_BAD_PORT);
4440 ofconn_send_replies(ofconn, &cbdata.replies);
4442 ofpbuf_list_delete(&cbdata.replies);
4449 evict_rules_from_table(struct oftable *table)
4450 OVS_REQUIRES(ofproto_mutex)
4452 enum ofperr error = 0;
4453 struct rule_collection rules;
4454 unsigned int count = table->n_flows;
4455 unsigned int max_flows = table->max_flows;
4457 rule_collection_init(&rules);
4459 while (count-- > max_flows) {
4462 if (!choose_rule_to_evict(table, &rule)) {
4463 error = OFPERR_OFPFMFC_TABLE_FULL;
4466 eviction_group_remove_rule(rule);
4467 rule_collection_add(&rules, rule);
4470 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4476 get_conjunctions(const struct ofputil_flow_mod *fm,
4477 struct cls_conjunction **conjsp, size_t *n_conjsp)
4478 OVS_REQUIRES(ofproto_mutex)
4480 struct cls_conjunction *conjs = NULL;
4483 const struct ofpact *ofpact;
4484 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4485 if (ofpact->type == OFPACT_CONJUNCTION) {
4487 } else if (ofpact->type != OFPACT_NOTE) {
4488 /* "conjunction" may appear with "note" actions but not with any
4489 * other type of actions. */
4490 ovs_assert(!n_conjs);
4497 conjs = xzalloc(n_conjs * sizeof *conjs);
4498 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4499 if (ofpact->type == OFPACT_CONJUNCTION) {
4500 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4501 conjs[i].clause = oc->clause;
4502 conjs[i].n_clauses = oc->n_clauses;
4503 conjs[i].id = oc->id;
4510 *n_conjsp = n_conjs;
4513 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4514 * in which no matching flow already exists in the flow table.
4516 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4517 * success, or an OpenFlow error code on failure.
4519 * On successful return the caller must complete the operation either by
4520 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4523 * The caller retains ownership of 'fm->ofpacts'. */
4525 add_flow_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4526 OVS_REQUIRES(ofproto_mutex)
4528 struct ofputil_flow_mod *fm = &ofm->fm;
4529 struct rule **old_rule = &ofm->old_rules.stub[0];
4530 struct rule **new_rule = &ofm->new_rules.stub[0];
4531 struct oftable *table;
4535 struct cls_conjunction *conjs;
4539 if (!check_table_id(ofproto, fm->table_id)) {
4540 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4545 if (fm->table_id == 0xff) {
4546 if (ofproto->ofproto_class->rule_choose_table) {
4547 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4553 ovs_assert(table_id < ofproto->n_tables);
4557 } else if (fm->table_id < ofproto->n_tables) {
4558 table_id = fm->table_id;
4560 return OFPERR_OFPBRC_BAD_TABLE_ID;
4563 table = &ofproto->tables[table_id];
4564 if (table->flags & OFTABLE_READONLY
4565 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4566 return OFPERR_OFPBRC_EPERM;
4569 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4570 && !match_has_default_hidden_fields(&fm->match)) {
4571 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4572 "non-default values to hidden fields", ofproto->name);
4573 return OFPERR_OFPBRC_EPERM;
4576 cls_rule_init(&cr, &fm->match, fm->priority);
4578 /* Check for the existence of an identical rule.
4579 * This will not return rules earlier marked for removal. */
4580 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr,
4584 /* Check for overlap, if requested. */
4585 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4586 && classifier_rule_overlaps(&table->cls, &cr, ofm->version)) {
4587 cls_rule_destroy(&cr);
4588 return OFPERR_OFPFMFC_OVERLAP;
4591 /* If necessary, evict an existing rule to clear out space. */
4592 if (table->n_flows >= table->max_flows) {
4593 if (!choose_rule_to_evict(table, &rule)) {
4594 error = OFPERR_OFPFMFC_TABLE_FULL;
4595 cls_rule_destroy(&cr);
4598 eviction_group_remove_rule(rule);
4599 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4601 fm->delete_reason = OFPRR_EVICTION;
4605 fm->modify_cookie = true;
4608 /* Allocate new rule. */
4609 error = replace_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4615 get_conjunctions(fm, &conjs, &n_conjs);
4616 replace_rule_start(ofproto, ofm->version, rule, *new_rule, conjs, n_conjs);
4622 /* Revert the effects of add_flow_start(). */
4624 add_flow_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4625 OVS_REQUIRES(ofproto_mutex)
4627 struct ofputil_flow_mod *fm = &ofm->fm;
4628 struct rule *old_rule = ofm->old_rules.stub[0];
4629 struct rule *new_rule = ofm->new_rules.stub[0];
4631 if (old_rule && fm->delete_reason == OFPRR_EVICTION) {
4632 /* Revert the eviction. */
4633 eviction_group_add_rule(old_rule);
4636 replace_rule_revert(ofproto, old_rule, new_rule);
4639 /* To be called after version bump. */
4641 add_flow_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4642 const struct flow_mod_requester *req)
4643 OVS_REQUIRES(ofproto_mutex)
4645 struct ofputil_flow_mod *fm = &ofm->fm;
4646 struct rule *old_rule = ofm->old_rules.stub[0];
4647 struct rule *new_rule = ofm->new_rules.stub[0];
4648 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4650 replace_rule_finish(ofproto, fm, req, old_rule, new_rule, &dead_cookies);
4651 learned_cookies_flush(ofproto, &dead_cookies);
4654 ovsrcu_postpone(remove_rule_rcu, old_rule);
4656 if (minimask_get_vid_mask(new_rule->cr.match.mask) == VLAN_VID_MASK) {
4657 if (ofproto->vlan_bitmap) {
4658 uint16_t vid = miniflow_get_vid(new_rule->cr.match.flow);
4660 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4661 bitmap_set1(ofproto->vlan_bitmap, vid);
4662 ofproto->vlans_changed = true;
4665 ofproto->vlans_changed = true;
4669 ofmonitor_report(ofproto->connmgr, new_rule, NXFME_ADDED, 0,
4670 req ? req->ofconn : NULL,
4671 req ? req->request->xid : 0, NULL);
4674 send_buffered_packet(req, fm->buffer_id, new_rule);
4677 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4679 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4680 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4681 * structures yet. Takes ownership of 'cr'. */
4683 replace_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4684 struct cls_rule *cr, uint8_t table_id,
4685 struct rule *old_rule, struct rule **new_rule)
4690 /* Allocate new rule. */
4691 rule = ofproto->ofproto_class->rule_alloc();
4693 cls_rule_destroy(cr);
4694 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
4695 return OFPERR_OFPFMFC_UNKNOWN;
4698 /* Initialize base state. */
4699 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4700 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
4701 ovs_refcount_init(&rule->ref_count);
4702 rule->flow_cookie = fm->new_cookie;
4703 rule->created = rule->modified = time_msec();
4705 ovs_mutex_init(&rule->mutex);
4706 ovs_mutex_lock(&rule->mutex);
4707 rule->idle_timeout = fm->idle_timeout;
4708 rule->hard_timeout = fm->hard_timeout;
4709 *CONST_CAST(uint16_t *, &rule->importance) = fm->importance;
4710 rule->removed_reason = OVS_OFPRR_NONE;
4712 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
4713 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4714 *CONST_CAST(const struct rule_actions **, &rule->actions)
4715 = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4716 list_init(&rule->meter_list_node);
4717 rule->eviction_group = NULL;
4718 list_init(&rule->expirable);
4719 rule->monitor_flags = 0;
4720 rule->add_seqno = 0;
4721 rule->modify_seqno = 0;
4723 /* Copy values from old rule for modify semantics. */
4724 if (old_rule && fm->delete_reason != OFPRR_EVICTION) {
4725 bool change_cookie = (fm->modify_cookie
4726 && fm->new_cookie != OVS_BE64_MAX
4727 && fm->new_cookie != old_rule->flow_cookie);
4729 ovs_mutex_lock(&old_rule->mutex);
4730 if (fm->command != OFPFC_ADD) {
4731 rule->idle_timeout = old_rule->idle_timeout;
4732 rule->hard_timeout = old_rule->hard_timeout;
4733 *CONST_CAST(uint16_t *, &rule->importance) = old_rule->importance;
4734 rule->flags = old_rule->flags;
4735 rule->created = old_rule->created;
4737 if (!change_cookie) {
4738 rule->flow_cookie = old_rule->flow_cookie;
4740 ovs_mutex_unlock(&old_rule->mutex);
4742 ovs_mutex_unlock(&rule->mutex);
4744 /* Construct rule, initializing derived state. */
4745 error = ofproto->ofproto_class->rule_construct(rule);
4747 ofproto_rule_destroy__(rule);
4751 rule->removed = true; /* Not yet in ofproto data structures. */
4758 replace_rule_start(struct ofproto *ofproto, cls_version_t version,
4759 struct rule *old_rule, struct rule *new_rule,
4760 struct cls_conjunction *conjs, size_t n_conjs)
4762 struct oftable *table = &ofproto->tables[new_rule->table_id];
4764 /* 'old_rule' may be either an evicted rule or replaced rule. */
4766 /* Mark the old rule for removal in the next version. */
4767 cls_rule_make_invisible_in_version(&old_rule->cr, version);
4771 /* Insert flow to the classifier, so that later flow_mods may relate
4772 * to it. This is reversible, in case later errors require this to
4774 ofproto_rule_insert__(ofproto, new_rule);
4775 /* Make the new rule visible for classifier lookups only from the next
4777 classifier_insert(&table->cls, &new_rule->cr, version, conjs, n_conjs);
4780 static void replace_rule_revert(struct ofproto *ofproto,
4781 struct rule *old_rule, struct rule *new_rule)
4783 struct oftable *table = &ofproto->tables[new_rule->table_id];
4786 /* Restore the original visibility of the old rule. */
4787 cls_rule_restore_visibility(&old_rule->cr);
4789 /* Restore table's rule count. */
4793 /* Remove the new rule immediately. It was never visible to lookups. */
4794 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4797 ofproto_rule_remove__(ofproto, new_rule);
4798 /* The rule was not inserted to the ofproto provider, so we can
4799 * release it without deleting it from the ofproto provider. */
4800 ofproto_rule_unref(new_rule);
4803 /* Adds the 'new_rule', replacing the 'old_rule'. */
4805 replace_rule_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4806 const struct flow_mod_requester *req,
4807 struct rule *old_rule, struct rule *new_rule,
4808 struct ovs_list *dead_cookies)
4809 OVS_REQUIRES(ofproto_mutex)
4811 bool forward_stats = !(fm->flags & OFPUTIL_FF_RESET_COUNTS);
4812 struct rule *replaced_rule;
4814 replaced_rule = fm->delete_reason != OFPRR_EVICTION ? old_rule : NULL;
4816 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4817 * is a duplicate rule the 'new_rule' is replacing. The provider should
4818 * link the stats from the old rule to the new one if 'forward_stats' is
4819 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4820 ofproto->ofproto_class->rule_insert(new_rule, replaced_rule,
4822 learned_cookies_inc(ofproto, rule_get_actions(new_rule));
4825 const struct rule_actions *old_actions = rule_get_actions(old_rule);
4827 /* Remove the old rule from data structures. Removal from the
4828 * classifier and the deletion of the rule is RCU postponed by the
4830 ofproto_rule_remove__(ofproto, old_rule);
4831 learned_cookies_dec(ofproto, old_actions, dead_cookies);
4833 if (replaced_rule) {
4834 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4835 ? NXFME_ADDED : NXFME_MODIFIED;
4837 bool change_cookie = (fm->modify_cookie
4838 && fm->new_cookie != OVS_BE64_MAX
4839 && fm->new_cookie != old_rule->flow_cookie);
4841 bool change_actions = !ofpacts_equal(fm->ofpacts,
4843 old_actions->ofpacts,
4844 old_actions->ofpacts_len);
4846 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4847 ofmonitor_report(ofproto->connmgr, new_rule, event, 0,
4848 req ? req->ofconn : NULL,
4849 req ? req->request->xid : 0,
4850 change_actions ? old_actions : NULL);
4853 /* XXX: This is slight duplication with delete_flows_finish__() */
4855 old_rule->removed_reason = OFPRR_EVICTION;
4857 ofmonitor_report(ofproto->connmgr, old_rule, NXFME_DELETED,
4859 req ? req->ofconn : NULL,
4860 req ? req->request->xid : 0, NULL);
4866 modify_flows_start__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4867 OVS_REQUIRES(ofproto_mutex)
4869 struct ofputil_flow_mod *fm = &ofm->fm;
4870 struct rule_collection *old_rules = &ofm->old_rules;
4871 struct rule_collection *new_rules = &ofm->new_rules;
4874 rule_collection_init(new_rules);
4876 if (old_rules->n > 0) {
4877 struct cls_conjunction *conjs;
4881 /* Create a new 'modified' rule for each old rule. */
4882 for (i = 0; i < old_rules->n; i++) {
4883 struct rule *old_rule = old_rules->rules[i];
4884 struct rule *new_rule;
4887 cls_rule_clone(&cr, &old_rule->cr);
4888 error = replace_rule_create(ofproto, fm, &cr, old_rule->table_id,
4889 old_rule, &new_rule);
4891 rule_collection_add(new_rules, new_rule);
4893 rule_collection_unref(new_rules);
4894 rule_collection_destroy(new_rules);
4898 ovs_assert(new_rules->n == old_rules->n);
4900 get_conjunctions(fm, &conjs, &n_conjs);
4901 for (i = 0; i < old_rules->n; i++) {
4902 replace_rule_start(ofproto, ofm->version, old_rules->rules[i],
4903 new_rules->rules[i], conjs, n_conjs);
4906 } else if (!(fm->cookie_mask != htonll(0)
4907 || fm->new_cookie == OVS_BE64_MAX)) {
4908 /* No match, add a new flow. */
4909 error = add_flow_start(ofproto, ofm);
4911 ovs_assert(fm->delete_reason == OFPRR_EVICTION
4912 || !old_rules->rules[0]);
4922 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4925 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4928 modify_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4929 OVS_REQUIRES(ofproto_mutex)
4931 struct ofputil_flow_mod *fm = &ofm->fm;
4932 struct rule_collection *old_rules = &ofm->old_rules;
4933 struct rule_criteria criteria;
4936 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4937 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG_ANY);
4938 rule_criteria_require_rw(&criteria,
4939 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4940 error = collect_rules_loose(ofproto, &criteria, old_rules);
4941 rule_criteria_destroy(&criteria);
4944 error = modify_flows_start__(ofproto, ofm);
4948 rule_collection_destroy(old_rules);
4954 modify_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4955 OVS_REQUIRES(ofproto_mutex)
4957 struct rule_collection *old_rules = &ofm->old_rules;
4958 struct rule_collection *new_rules = &ofm->new_rules;
4960 /* Old rules were not changed yet, only need to revert new rules. */
4961 if (old_rules->n == 0 && new_rules->n == 1) {
4962 add_flow_revert(ofproto, ofm);
4963 } else if (old_rules->n > 0) {
4964 for (size_t i = 0; i < old_rules->n; i++) {
4965 replace_rule_revert(ofproto, old_rules->rules[i],
4966 new_rules->rules[i]);
4968 rule_collection_destroy(new_rules);
4969 rule_collection_destroy(old_rules);
4974 modify_flows_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4975 const struct flow_mod_requester *req)
4976 OVS_REQUIRES(ofproto_mutex)
4978 struct ofputil_flow_mod *fm = &ofm->fm;
4979 struct rule_collection *old_rules = &ofm->old_rules;
4980 struct rule_collection *new_rules = &ofm->new_rules;
4982 if (old_rules->n == 0 && new_rules->n == 1) {
4983 add_flow_finish(ofproto, ofm, req);
4984 } else if (old_rules->n > 0) {
4985 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4987 ovs_assert(new_rules->n == old_rules->n);
4989 for (size_t i = 0; i < old_rules->n; i++) {
4990 replace_rule_finish(ofproto, fm, req, old_rules->rules[i],
4991 new_rules->rules[i], &dead_cookies);
4993 learned_cookies_flush(ofproto, &dead_cookies);
4994 rule_collection_remove_postponed(old_rules);
4996 send_buffered_packet(req, fm->buffer_id, new_rules->rules[0]);
4997 rule_collection_destroy(new_rules);
5001 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
5002 * code on failure. */
5004 modify_flow_start_strict(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5005 OVS_REQUIRES(ofproto_mutex)
5007 struct ofputil_flow_mod *fm = &ofm->fm;
5008 struct rule_collection *old_rules = &ofm->old_rules;
5009 struct rule_criteria criteria;
5012 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5013 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
5015 rule_criteria_require_rw(&criteria,
5016 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5017 error = collect_rules_strict(ofproto, &criteria, old_rules);
5018 rule_criteria_destroy(&criteria);
5021 /* collect_rules_strict() can return max 1 rule. */
5022 error = modify_flows_start__(ofproto, ofm);
5026 rule_collection_destroy(old_rules);
5031 /* OFPFC_DELETE implementation. */
5034 delete_flows_start__(struct ofproto *ofproto, cls_version_t version,
5035 const struct rule_collection *rules)
5036 OVS_REQUIRES(ofproto_mutex)
5038 for (size_t i = 0; i < rules->n; i++) {
5039 struct rule *rule = rules->rules[i];
5040 struct oftable *table = &ofproto->tables[rule->table_id];
5043 cls_rule_make_invisible_in_version(&rule->cr, version);
5048 delete_flows_finish__(struct ofproto *ofproto,
5049 struct rule_collection *rules,
5050 enum ofp_flow_removed_reason reason,
5051 const struct flow_mod_requester *req)
5052 OVS_REQUIRES(ofproto_mutex)
5055 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
5057 for (size_t i = 0; i < rules->n; i++) {
5058 struct rule *rule = rules->rules[i];
5060 /* This value will be used to send the flow removed message right
5061 * before the rule is actually destroyed. */
5062 rule->removed_reason = reason;
5064 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
5065 req ? req->ofconn : NULL,
5066 req ? req->request->xid : 0, NULL);
5067 ofproto_rule_remove__(ofproto, rule);
5068 learned_cookies_dec(ofproto, rule_get_actions(rule),
5071 rule_collection_remove_postponed(rules);
5073 learned_cookies_flush(ofproto, &dead_cookies);
5077 /* Deletes the rules listed in 'rules'.
5078 * The deleted rules will become invisible to the lookups in the next version.
5079 * Destroys 'rules'. */
5081 delete_flows__(struct rule_collection *rules,
5082 enum ofp_flow_removed_reason reason,
5083 const struct flow_mod_requester *req)
5084 OVS_REQUIRES(ofproto_mutex)
5087 struct ofproto *ofproto = rules->rules[0]->ofproto;
5089 delete_flows_start__(ofproto, ofproto->tables_version + 1, rules);
5090 ofproto_bump_tables_version(ofproto);
5091 delete_flows_finish__(ofproto, rules, reason, req);
5092 ofmonitor_flush(ofproto->connmgr);
5096 /* Implements OFPFC_DELETE. */
5098 delete_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5099 OVS_REQUIRES(ofproto_mutex)
5101 const struct ofputil_flow_mod *fm = &ofm->fm;
5102 struct rule_collection *rules = &ofm->old_rules;
5103 struct rule_criteria criteria;
5106 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
5107 fm->cookie, fm->cookie_mask, fm->out_port,
5109 rule_criteria_require_rw(&criteria,
5110 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5111 error = collect_rules_loose(ofproto, &criteria, rules);
5112 rule_criteria_destroy(&criteria);
5115 delete_flows_start__(ofproto, ofm->version, rules);
5122 delete_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5123 OVS_REQUIRES(ofproto_mutex)
5125 struct rule_collection *rules = &ofm->old_rules;
5127 for (size_t i = 0; i < rules->n; i++) {
5128 struct rule *rule = rules->rules[i];
5129 struct oftable *table = &ofproto->tables[rule->table_id];
5131 /* Restore table's rule count. */
5134 /* Restore the original visibility of the rule. */
5135 cls_rule_restore_visibility(&rule->cr);
5137 rule_collection_destroy(rules);
5141 delete_flows_finish(struct ofproto *ofproto,
5142 struct ofproto_flow_mod *ofm,
5143 const struct flow_mod_requester *req)
5144 OVS_REQUIRES(ofproto_mutex)
5146 delete_flows_finish__(ofproto, &ofm->old_rules, ofm->fm.delete_reason,
5150 /* Implements OFPFC_DELETE_STRICT. */
5152 delete_flow_start_strict(struct ofproto *ofproto,
5153 struct ofproto_flow_mod *ofm)
5154 OVS_REQUIRES(ofproto_mutex)
5156 const struct ofputil_flow_mod *fm = &ofm->fm;
5157 struct rule_collection *rules = &ofm->old_rules;
5158 struct rule_criteria criteria;
5161 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5162 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
5163 fm->out_port, fm->out_group);
5164 rule_criteria_require_rw(&criteria,
5165 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5166 error = collect_rules_strict(ofproto, &criteria, rules);
5167 rule_criteria_destroy(&criteria);
5170 delete_flows_start__(ofproto, ofm->version, rules);
5176 /* This may only be called by rule_destroy_cb()! */
5178 ofproto_rule_send_removed(struct rule *rule)
5179 OVS_EXCLUDED(ofproto_mutex)
5181 struct ofputil_flow_removed fr;
5184 minimatch_expand(&rule->cr.match, &fr.match);
5185 fr.priority = rule->cr.priority;
5187 ovs_mutex_lock(&ofproto_mutex);
5188 fr.cookie = rule->flow_cookie;
5189 fr.reason = rule->removed_reason;
5190 fr.table_id = rule->table_id;
5191 calc_duration(rule->created, time_msec(),
5192 &fr.duration_sec, &fr.duration_nsec);
5193 ovs_mutex_lock(&rule->mutex);
5194 fr.idle_timeout = rule->idle_timeout;
5195 fr.hard_timeout = rule->hard_timeout;
5196 ovs_mutex_unlock(&rule->mutex);
5197 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
5198 &fr.byte_count, &used);
5199 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
5200 ovs_mutex_unlock(&ofproto_mutex);
5203 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5204 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5207 * ofproto implementation ->run() functions should use this function to expire
5208 * OpenFlow flows. */
5210 ofproto_rule_expire(struct rule *rule, uint8_t reason)
5211 OVS_REQUIRES(ofproto_mutex)
5213 struct rule_collection rules;
5215 rules.rules = rules.stub;
5217 rules.stub[0] = rule;
5218 delete_flows__(&rules, reason, NULL);
5221 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5222 * means "infinite". */
5224 reduce_timeout(uint16_t max, uint16_t *timeout)
5226 if (max && (!*timeout || *timeout > max)) {
5231 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5232 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5233 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5235 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5237 ofproto_rule_reduce_timeouts(struct rule *rule,
5238 uint16_t idle_timeout, uint16_t hard_timeout)
5239 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5241 if (!idle_timeout && !hard_timeout) {
5245 ovs_mutex_lock(&ofproto_mutex);
5246 if (list_is_empty(&rule->expirable)) {
5247 list_insert(&rule->ofproto->expirable, &rule->expirable);
5249 ovs_mutex_unlock(&ofproto_mutex);
5251 ovs_mutex_lock(&rule->mutex);
5252 reduce_timeout(idle_timeout, &rule->idle_timeout);
5253 reduce_timeout(hard_timeout, &rule->hard_timeout);
5254 ovs_mutex_unlock(&rule->mutex);
5258 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5259 OVS_EXCLUDED(ofproto_mutex)
5261 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5262 struct ofproto_flow_mod ofm;
5263 uint64_t ofpacts_stub[1024 / 8];
5264 struct ofpbuf ofpacts;
5267 error = reject_slave_controller(ofconn);
5272 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5273 error = ofputil_decode_flow_mod(&ofm.fm, oh, ofconn_get_protocol(ofconn),
5275 u16_to_ofp(ofproto->max_ports),
5278 error = ofproto_check_ofpacts(ofproto, ofm.fm.ofpacts,
5279 ofm.fm.ofpacts_len);
5282 struct flow_mod_requester req;
5284 req.ofconn = ofconn;
5286 error = handle_flow_mod__(ofproto, &ofm, &req);
5289 goto exit_free_ofpacts;
5292 ofconn_report_flow_mod(ofconn, ofm.fm.command);
5295 ofpbuf_uninit(&ofpacts);
5301 handle_flow_mod__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
5302 const struct flow_mod_requester *req)
5303 OVS_EXCLUDED(ofproto_mutex)
5307 ovs_mutex_lock(&ofproto_mutex);
5308 ofm->version = ofproto->tables_version + 1;
5309 error = ofproto_flow_mod_start(ofproto, ofm);
5311 ofproto_bump_tables_version(ofproto);
5312 ofproto_flow_mod_finish(ofproto, ofm, req);
5314 ofmonitor_flush(ofproto->connmgr);
5315 ovs_mutex_unlock(&ofproto_mutex);
5317 run_rule_executes(ofproto);
5322 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5324 struct ofputil_role_request request;
5325 struct ofputil_role_request reply;
5329 error = ofputil_decode_role_message(oh, &request);
5334 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5335 if (request.role != OFPCR12_ROLE_EQUAL
5336 && request.have_generation_id
5337 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5338 return OFPERR_OFPRRFC_STALE;
5341 ofconn_set_role(ofconn, request.role);
5344 reply.role = ofconn_get_role(ofconn);
5345 reply.have_generation_id = ofconn_get_master_election_id(
5346 ofconn, &reply.generation_id);
5347 buf = ofputil_encode_role_reply(oh, &reply);
5348 ofconn_send_reply(ofconn, buf);
5354 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5355 const struct ofp_header *oh)
5357 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5358 enum ofputil_protocol cur, next;
5360 cur = ofconn_get_protocol(ofconn);
5361 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5362 ofconn_set_protocol(ofconn, next);
5368 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5370 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5371 enum ofputil_protocol cur, next;
5372 enum ofputil_protocol next_base;
5374 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5376 return OFPERR_OFPBRC_EPERM;
5379 cur = ofconn_get_protocol(ofconn);
5380 next = ofputil_protocol_set_base(cur, next_base);
5381 ofconn_set_protocol(ofconn, next);
5387 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5388 const struct ofp_header *oh)
5390 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5393 format = ntohl(msg->format);
5394 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5395 return OFPERR_OFPBRC_EPERM;
5398 ofconn_set_packet_in_format(ofconn, format);
5403 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5406 uint32_t master[OAM_N_TYPES] = {0};
5407 uint32_t slave[OAM_N_TYPES] = {0};
5409 error = ofputil_decode_set_async_config(oh, master, slave, false);
5414 ofconn_set_async_config(ofconn, master, slave);
5415 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5416 !ofconn_get_miss_send_len(ofconn)) {
5417 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5424 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5427 uint32_t master[OAM_N_TYPES];
5428 uint32_t slave[OAM_N_TYPES];
5430 ofconn_get_async_config(ofconn, master, slave);
5432 buf = ofputil_encode_get_async_config(oh, master, slave);
5433 ofconn_send_reply(ofconn, buf);
5439 handle_nxt_set_controller_id(struct ofconn *ofconn,
5440 const struct ofp_header *oh)
5442 const struct nx_controller_id *nci = ofpmsg_body(oh);
5444 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5445 return OFPERR_NXBRC_MUST_BE_ZERO;
5448 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5453 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5457 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5458 ? OFPRAW_OFPT10_BARRIER_REPLY
5459 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5460 ofconn_send_reply(ofconn, buf);
5465 ofproto_compose_flow_refresh_update(const struct rule *rule,
5466 enum nx_flow_monitor_flags flags,
5467 struct ovs_list *msgs)
5468 OVS_REQUIRES(ofproto_mutex)
5470 const struct rule_actions *actions;
5471 struct ofputil_flow_update fu;
5474 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5475 ? NXFME_ADDED : NXFME_MODIFIED);
5477 ovs_mutex_lock(&rule->mutex);
5478 fu.idle_timeout = rule->idle_timeout;
5479 fu.hard_timeout = rule->hard_timeout;
5480 ovs_mutex_unlock(&rule->mutex);
5481 fu.table_id = rule->table_id;
5482 fu.cookie = rule->flow_cookie;
5483 minimatch_expand(&rule->cr.match, &match);
5485 fu.priority = rule->cr.priority;
5487 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5488 fu.ofpacts = actions ? actions->ofpacts : NULL;
5489 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5491 if (list_is_empty(msgs)) {
5492 ofputil_start_flow_update(msgs);
5494 ofputil_append_flow_update(&fu, msgs);
5498 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5499 struct ovs_list *msgs)
5500 OVS_REQUIRES(ofproto_mutex)
5504 for (i = 0; i < rules->n; i++) {
5505 struct rule *rule = rules->rules[i];
5506 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5507 rule->monitor_flags = 0;
5509 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5514 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5515 struct rule *rule, uint64_t seqno,
5516 struct rule_collection *rules)
5517 OVS_REQUIRES(ofproto_mutex)
5519 enum nx_flow_monitor_flags update;
5521 if (rule_is_hidden(rule)) {
5525 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5530 if (rule->add_seqno > seqno) {
5531 update = NXFMF_ADD | NXFMF_MODIFY;
5532 } else if (rule->modify_seqno > seqno) {
5533 update = NXFMF_MODIFY;
5538 if (!(m->flags & update)) {
5542 update = NXFMF_INITIAL;
5545 if (!rule->monitor_flags) {
5546 rule_collection_add(rules, rule);
5548 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5552 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5554 struct rule_collection *rules)
5555 OVS_REQUIRES(ofproto_mutex)
5557 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5558 const struct oftable *table;
5559 struct cls_rule target;
5561 cls_rule_init_from_minimatch(&target, &m->match, 0);
5562 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5565 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target, CLS_MAX_VERSION) {
5566 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5569 cls_rule_destroy(&target);
5573 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5574 struct rule_collection *rules)
5575 OVS_REQUIRES(ofproto_mutex)
5577 if (m->flags & NXFMF_INITIAL) {
5578 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5583 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5584 uint64_t seqno, struct rule_collection *rules)
5585 OVS_REQUIRES(ofproto_mutex)
5587 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5591 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5592 OVS_REQUIRES(ofproto_mutex)
5594 struct ofmonitor *m;
5597 m = ofmonitor_lookup(ofconn, id);
5599 ofmonitor_destroy(m);
5602 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5609 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5610 OVS_EXCLUDED(ofproto_mutex)
5612 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5613 struct ofmonitor **monitors;
5614 size_t n_monitors, allocated_monitors;
5615 struct rule_collection rules;
5616 struct ovs_list replies;
5621 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5623 n_monitors = allocated_monitors = 0;
5625 ovs_mutex_lock(&ofproto_mutex);
5627 struct ofputil_flow_monitor_request request;
5628 struct ofmonitor *m;
5631 retval = ofputil_decode_flow_monitor_request(&request, &b);
5632 if (retval == EOF) {
5634 } else if (retval) {
5639 if (request.table_id != 0xff
5640 && request.table_id >= ofproto->n_tables) {
5641 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5645 error = ofmonitor_create(&request, ofconn, &m);
5650 if (n_monitors >= allocated_monitors) {
5651 monitors = x2nrealloc(monitors, &allocated_monitors,
5654 monitors[n_monitors++] = m;
5657 rule_collection_init(&rules);
5658 for (i = 0; i < n_monitors; i++) {
5659 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5662 ofpmp_init(&replies, oh);
5663 ofmonitor_compose_refresh_updates(&rules, &replies);
5664 ovs_mutex_unlock(&ofproto_mutex);
5666 rule_collection_destroy(&rules);
5668 ofconn_send_replies(ofconn, &replies);
5674 for (i = 0; i < n_monitors; i++) {
5675 ofmonitor_destroy(monitors[i]);
5678 ovs_mutex_unlock(&ofproto_mutex);
5684 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5685 OVS_EXCLUDED(ofproto_mutex)
5690 id = ofputil_decode_flow_monitor_cancel(oh);
5692 ovs_mutex_lock(&ofproto_mutex);
5693 error = flow_monitor_delete(ofconn, id);
5694 ovs_mutex_unlock(&ofproto_mutex);
5699 /* Meters implementation.
5701 * Meter table entry, indexed by the OpenFlow meter_id.
5702 * 'created' is used to compute the duration for meter stats.
5703 * 'list rules' is needed so that we can delete the dependent rules when the
5704 * meter table entry is deleted.
5705 * 'provider_meter_id' is for the provider's private use.
5708 long long int created; /* Time created. */
5709 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5710 ofproto_meter_id provider_meter_id;
5711 uint16_t flags; /* Meter flags. */
5712 uint16_t n_bands; /* Number of meter bands. */
5713 struct ofputil_meter_band *bands;
5717 * This is used in instruction validation at flow set-up time,
5718 * as flows may not use non-existing meters.
5719 * Return value of UINT32_MAX signifies an invalid meter.
5722 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5724 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5725 const struct meter *meter = ofproto->meters[of_meter_id];
5727 return meter->provider_meter_id.uint32;
5733 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5736 meter_insert_rule(struct rule *rule)
5738 const struct rule_actions *a = rule_get_actions(rule);
5739 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5740 struct meter *meter = rule->ofproto->meters[meter_id];
5742 list_insert(&meter->rules, &rule->meter_list_node);
5746 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5750 meter->flags = config->flags;
5751 meter->n_bands = config->n_bands;
5752 meter->bands = xmemdup(config->bands,
5753 config->n_bands * sizeof *meter->bands);
5756 static struct meter *
5757 meter_create(const struct ofputil_meter_config *config,
5758 ofproto_meter_id provider_meter_id)
5760 struct meter *meter;
5762 meter = xzalloc(sizeof *meter);
5763 meter->provider_meter_id = provider_meter_id;
5764 meter->created = time_msec();
5765 list_init(&meter->rules);
5767 meter_update(meter, config);
5773 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5774 OVS_REQUIRES(ofproto_mutex)
5777 for (mid = first; mid <= last; ++mid) {
5778 struct meter *meter = ofproto->meters[mid];
5780 ofproto->meters[mid] = NULL;
5781 ofproto->ofproto_class->meter_del(ofproto,
5782 meter->provider_meter_id);
5790 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5792 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5793 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5797 return OFPERR_OFPMMFC_METER_EXISTS;
5800 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5803 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5804 *meterp = meter_create(&mm->meter, provider_meter_id);
5810 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5812 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5814 uint32_t provider_meter_id;
5817 return OFPERR_OFPMMFC_UNKNOWN_METER;
5820 provider_meter_id = meter->provider_meter_id.uint32;
5821 error = ofproto->ofproto_class->meter_set(ofproto,
5822 &meter->provider_meter_id,
5824 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5826 meter_update(meter, &mm->meter);
5832 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5833 OVS_EXCLUDED(ofproto_mutex)
5835 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5836 uint32_t meter_id = mm->meter.meter_id;
5837 struct rule_collection rules;
5838 enum ofperr error = 0;
5839 uint32_t first, last;
5841 if (meter_id == OFPM13_ALL) {
5843 last = ofproto->meter_features.max_meters;
5845 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5848 first = last = meter_id;
5851 /* First delete the rules that use this meter. If any of those rules are
5852 * currently being modified, postpone the whole operation until later. */
5853 rule_collection_init(&rules);
5854 ovs_mutex_lock(&ofproto_mutex);
5855 for (meter_id = first; meter_id <= last; ++meter_id) {
5856 struct meter *meter = ofproto->meters[meter_id];
5857 if (meter && !list_is_empty(&meter->rules)) {
5860 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5861 rule_collection_add(&rules, rule);
5865 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5867 /* Delete the meters. */
5868 meter_delete(ofproto, first, last);
5870 ovs_mutex_unlock(&ofproto_mutex);
5876 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5878 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5879 struct ofputil_meter_mod mm;
5880 uint64_t bands_stub[256 / 8];
5881 struct ofpbuf bands;
5885 error = reject_slave_controller(ofconn);
5890 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5892 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5894 goto exit_free_bands;
5897 meter_id = mm.meter.meter_id;
5899 if (mm.command != OFPMC13_DELETE) {
5900 /* Fails also when meters are not implemented by the provider. */
5901 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5902 error = OFPERR_OFPMMFC_INVALID_METER;
5903 goto exit_free_bands;
5904 } else if (meter_id > ofproto->meter_features.max_meters) {
5905 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5906 goto exit_free_bands;
5908 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5909 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5910 goto exit_free_bands;
5914 switch (mm.command) {
5916 error = handle_add_meter(ofproto, &mm);
5919 case OFPMC13_MODIFY:
5920 error = handle_modify_meter(ofproto, &mm);
5923 case OFPMC13_DELETE:
5924 error = handle_delete_meter(ofconn, &mm);
5928 error = OFPERR_OFPMMFC_BAD_COMMAND;
5933 struct ofputil_requestforward rf;
5935 rf.reason = OFPRFR_METER_MOD;
5937 connmgr_send_requestforward(ofproto->connmgr, ofconn, &rf);
5941 ofpbuf_uninit(&bands);
5946 handle_meter_features_request(struct ofconn *ofconn,
5947 const struct ofp_header *request)
5949 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5950 struct ofputil_meter_features features;
5953 if (ofproto->ofproto_class->meter_get_features) {
5954 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5956 memset(&features, 0, sizeof features);
5958 b = ofputil_encode_meter_features_reply(&features, request);
5960 ofconn_send_reply(ofconn, b);
5965 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5968 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5969 struct ovs_list replies;
5970 uint64_t bands_stub[256 / 8];
5971 struct ofpbuf bands;
5972 uint32_t meter_id, first, last;
5974 ofputil_decode_meter_request(request, &meter_id);
5976 if (meter_id == OFPM13_ALL) {
5978 last = ofproto->meter_features.max_meters;
5980 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5981 !ofproto->meters[meter_id]) {
5982 return OFPERR_OFPMMFC_UNKNOWN_METER;
5984 first = last = meter_id;
5987 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5988 ofpmp_init(&replies, request);
5990 for (meter_id = first; meter_id <= last; ++meter_id) {
5991 struct meter *meter = ofproto->meters[meter_id];
5993 continue; /* Skip non-existing meters. */
5995 if (type == OFPTYPE_METER_STATS_REQUEST) {
5996 struct ofputil_meter_stats stats;
5998 stats.meter_id = meter_id;
6000 /* Provider sets the packet and byte counts, we do the rest. */
6001 stats.flow_count = list_size(&meter->rules);
6002 calc_duration(meter->created, time_msec(),
6003 &stats.duration_sec, &stats.duration_nsec);
6004 stats.n_bands = meter->n_bands;
6005 ofpbuf_clear(&bands);
6007 = ofpbuf_put_uninit(&bands,
6008 meter->n_bands * sizeof *stats.bands);
6010 if (!ofproto->ofproto_class->meter_get(ofproto,
6011 meter->provider_meter_id,
6013 ofputil_append_meter_stats(&replies, &stats);
6015 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
6016 struct ofputil_meter_config config;
6018 config.meter_id = meter_id;
6019 config.flags = meter->flags;
6020 config.n_bands = meter->n_bands;
6021 config.bands = meter->bands;
6022 ofputil_append_meter_config(&replies, &config);
6026 ofconn_send_replies(ofconn, &replies);
6027 ofpbuf_uninit(&bands);
6032 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
6033 struct ofgroup **group)
6034 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6036 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
6037 hash_int(group_id, 0), &ofproto->groups) {
6038 if ((*group)->group_id == group_id) {
6046 /* If the group exists, this function increments the groups's reference count.
6048 * Make sure to call ofproto_group_unref() after no longer needing to maintain
6049 * a reference to the group. */
6051 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
6052 struct ofgroup **group)
6056 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6057 found = ofproto_group_lookup__(ofproto, group_id, group);
6059 ofproto_group_ref(*group);
6061 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6066 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
6067 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6069 struct ofgroup *grp;
6071 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
6072 hash_int(group_id, 0), &ofproto->groups) {
6073 if (grp->group_id == group_id) {
6081 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
6082 OVS_EXCLUDED(ofproto->groups_rwlock)
6086 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6087 exists = ofproto_group_exists__(ofproto, group_id);
6088 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6094 group_get_ref_count(struct ofgroup *group)
6095 OVS_EXCLUDED(ofproto_mutex)
6097 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
6098 struct rule_criteria criteria;
6099 struct rule_collection rules;
6104 match_init_catchall(&match);
6105 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
6106 htonll(0), OFPP_ANY, group->group_id);
6107 ovs_mutex_lock(&ofproto_mutex);
6108 error = collect_rules_loose(ofproto, &criteria, &rules);
6109 ovs_mutex_unlock(&ofproto_mutex);
6110 rule_criteria_destroy(&criteria);
6112 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
6114 rule_collection_destroy(&rules);
6119 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
6121 struct ofputil_group_stats ogs;
6122 const struct ofproto *ofproto = group->ofproto;
6123 long long int now = time_msec();
6126 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
6128 /* Provider sets the packet and byte counts, we do the rest. */
6129 ogs.ref_count = group_get_ref_count(group);
6130 ogs.n_buckets = group->n_buckets;
6132 error = (ofproto->ofproto_class->group_get_stats
6133 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
6136 ogs.packet_count = UINT64_MAX;
6137 ogs.byte_count = UINT64_MAX;
6138 memset(ogs.bucket_stats, 0xff,
6139 ogs.n_buckets * sizeof *ogs.bucket_stats);
6142 ogs.group_id = group->group_id;
6143 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
6145 ofputil_append_group_stats(replies, &ogs);
6147 free(ogs.bucket_stats);
6151 handle_group_request(struct ofconn *ofconn,
6152 const struct ofp_header *request, uint32_t group_id,
6153 void (*cb)(struct ofgroup *, struct ovs_list *replies))
6155 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6156 struct ofgroup *group;
6157 struct ovs_list replies;
6159 ofpmp_init(&replies, request);
6160 if (group_id == OFPG_ALL) {
6161 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6162 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
6163 cb(group, &replies);
6165 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6167 if (ofproto_group_lookup(ofproto, group_id, &group)) {
6168 cb(group, &replies);
6169 ofproto_group_unref(group);
6172 ofconn_send_replies(ofconn, &replies);
6176 handle_group_stats_request(struct ofconn *ofconn,
6177 const struct ofp_header *request)
6182 error = ofputil_decode_group_stats_request(request, &group_id);
6187 handle_group_request(ofconn, request, group_id, append_group_stats);
6192 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
6194 struct ofputil_group_desc gds;
6196 gds.group_id = group->group_id;
6197 gds.type = group->type;
6198 gds.props = group->props;
6200 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
6204 handle_group_desc_stats_request(struct ofconn *ofconn,
6205 const struct ofp_header *request)
6207 handle_group_request(ofconn, request,
6208 ofputil_decode_group_desc_request(request),
6214 handle_group_features_stats_request(struct ofconn *ofconn,
6215 const struct ofp_header *request)
6217 struct ofproto *p = ofconn_get_ofproto(ofconn);
6220 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6222 ofconn_send_reply(ofconn, msg);
6229 put_queue_config(struct ofport *ofport, struct ofpbuf *reply)
6231 struct netdev_queue_dump queue_dump;
6232 unsigned int queue_id;
6233 struct smap details;
6235 smap_init(&details);
6236 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6237 struct ofputil_queue_config queue;
6239 /* None of the existing queues have compatible properties, so we
6240 * hard-code omitting min_rate and max_rate. */
6241 queue.port = ofport->ofp_port;
6242 queue.queue_id = queue_id;
6243 queue.min_rate = UINT16_MAX;
6244 queue.max_rate = UINT16_MAX;
6245 ofputil_append_queue_get_config_reply(reply, &queue);
6247 smap_destroy(&details);
6251 handle_queue_get_config_request(struct ofconn *ofconn,
6252 const struct ofp_header *oh)
6254 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6258 error = ofputil_decode_queue_get_config_request(oh, &port);
6263 struct ofpbuf *reply = ofputil_encode_queue_get_config_reply(oh);
6264 struct ofport *ofport;
6265 if (port == OFPP_ANY) {
6266 HMAP_FOR_EACH (ofport, hmap_node, &ofproto->ports) {
6267 put_queue_config(ofport, reply);
6270 ofport = ofproto_get_port(ofproto, port);
6272 ofpbuf_delete(reply);
6273 return OFPERR_OFPQOFC_BAD_PORT;
6275 put_queue_config(ofport, reply);
6277 ofconn_send_reply(ofconn, reply);
6283 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6284 struct ofgroup **ofgroup)
6287 const long long int now = time_msec();
6289 if (gm->group_id > OFPG_MAX) {
6290 return OFPERR_OFPGMFC_INVALID_GROUP;
6292 if (gm->type > OFPGT11_FF) {
6293 return OFPERR_OFPGMFC_BAD_TYPE;
6296 *ofgroup = ofproto->ofproto_class->group_alloc();
6298 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6299 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6302 (*ofgroup)->ofproto = ofproto;
6303 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6304 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6305 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6306 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6307 ovs_refcount_init(&(*ofgroup)->ref_count);
6309 list_move(&(*ofgroup)->buckets, &gm->buckets);
6310 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6311 list_size(&(*ofgroup)->buckets);
6313 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6314 &gm->props, sizeof (struct ofputil_group_props));
6316 /* Construct called BEFORE any locks are held. */
6317 error = ofproto->ofproto_class->group_construct(*ofgroup);
6319 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6320 ofproto->ofproto_class->group_dealloc(*ofgroup);
6325 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6326 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6329 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6331 struct ofgroup *ofgroup;
6334 /* Allocate new group and initialize it. */
6335 error = init_group(ofproto, gm, &ofgroup);
6340 /* We wrlock as late as possible to minimize the time we jam any other
6341 * threads: No visible state changes before acquiring the lock. */
6342 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6344 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6345 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6349 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6350 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6355 /* Insert new group. */
6356 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6357 hash_int(ofgroup->group_id, 0));
6358 ofproto->n_groups[ofgroup->type]++;
6360 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6365 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6366 ofproto->ofproto_class->group_destruct(ofgroup);
6367 ofputil_bucket_list_destroy(&ofgroup->buckets);
6368 ofproto->ofproto_class->group_dealloc(ofgroup);
6373 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6374 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6375 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6376 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6379 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6380 struct ofgroup *new_ofgroup,
6381 uint32_t command_bucket_id)
6383 struct ofputil_bucket *last = NULL;
6385 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6386 /* Check here to ensure that a bucket corresponding to
6387 * command_bucket_id exists in the old bucket list.
6389 * The subsequent search of below of new_ofgroup covers
6390 * both buckets in the old bucket list and buckets added
6391 * by the insert buckets group mod message this function processes. */
6392 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6393 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6396 if (!list_is_empty(&new_ofgroup->buckets)) {
6397 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6401 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6403 if (ofputil_bucket_check_duplicate_id(&new_ofgroup->buckets)) {
6404 VLOG_INFO_RL(&rl, "Duplicate bucket id");
6405 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6408 /* Rearrange list according to command_bucket_id */
6409 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6410 if (!list_is_empty(&ofgroup->buckets)) {
6411 struct ofputil_bucket *new_first;
6412 const struct ofputil_bucket *first;
6414 first = ofputil_bucket_list_front(&ofgroup->buckets);
6415 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6418 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6419 &new_ofgroup->buckets);
6421 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6422 struct ofputil_bucket *after;
6424 /* Presence of bucket is checked above so after should never be NULL */
6425 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6427 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6428 last->list_node.next);
6434 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6435 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6436 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6437 * and OFPG15_BUCKET_ALL are also honored. */
6439 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6440 struct ofgroup *new_ofgroup,
6441 uint32_t command_bucket_id)
6443 const struct ofputil_bucket *skip = NULL;
6445 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6449 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6450 if (!list_is_empty(&ofgroup->buckets)) {
6451 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6453 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6454 if (!list_is_empty(&ofgroup->buckets)) {
6455 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6458 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6460 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6464 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6469 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6470 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6473 * Note that the group is re-created and then replaces the old group in
6474 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6475 * the xlate module hold a pointer to the group. */
6477 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6479 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6482 error = init_group(ofproto, gm, &new_ofgroup);
6487 retiring = new_ofgroup;
6489 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6490 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6491 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6495 /* Ofproto's group write lock is held now. */
6496 if (ofgroup->type != gm->type
6497 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6498 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6502 /* Manipulate bucket list for bucket commands */
6503 if (gm->command == OFPGC15_INSERT_BUCKET) {
6504 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6505 gm->command_bucket_id);
6506 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6507 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6508 gm->command_bucket_id);
6514 /* The group creation time does not change during modification. */
6515 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6516 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6518 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6524 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6525 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6526 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6527 hash_int(new_ofgroup->group_id, 0));
6528 if (ofgroup->type != new_ofgroup->type) {
6529 ofproto->n_groups[ofgroup->type]--;
6530 ofproto->n_groups[new_ofgroup->type]++;
6534 ofproto_group_unref(retiring);
6535 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6540 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6541 OVS_RELEASES(ofproto->groups_rwlock)
6544 struct ofproto_flow_mod ofm;
6546 /* Delete all flow entries containing this group in a group action */
6547 match_init_catchall(&match);
6548 flow_mod_init(&ofm.fm, &match, 0, NULL, 0, OFPFC_DELETE);
6549 ofm.fm.delete_reason = OFPRR_GROUP_DELETE;
6550 ofm.fm.out_group = ofgroup->group_id;
6551 ofm.fm.table_id = OFPTT_ALL;
6552 handle_flow_mod__(ofproto, &ofm, NULL);
6554 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6555 /* No-one can find this group any more. */
6556 ofproto->n_groups[ofgroup->type]--;
6557 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6558 ofproto_group_unref(ofgroup);
6561 /* Implements OFPGC11_DELETE. */
6563 delete_group(struct ofproto *ofproto, uint32_t group_id)
6565 struct ofgroup *ofgroup;
6567 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6568 if (group_id == OFPG_ALL) {
6570 struct hmap_node *node = hmap_first(&ofproto->groups);
6574 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6575 delete_group__(ofproto, ofgroup);
6576 /* Lock for each node separately, so that we will not jam the
6577 * other threads for too long time. */
6578 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6581 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6582 hash_int(group_id, 0), &ofproto->groups) {
6583 if (ofgroup->group_id == group_id) {
6584 delete_group__(ofproto, ofgroup);
6589 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6592 /* Delete all groups from 'ofproto'.
6594 * This is intended for use within an ofproto provider's 'destruct'
6597 ofproto_group_delete_all(struct ofproto *ofproto)
6599 delete_group(ofproto, OFPG_ALL);
6603 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6605 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6606 struct ofputil_group_mod gm;
6609 error = reject_slave_controller(ofconn);
6614 error = ofputil_decode_group_mod(oh, &gm);
6619 switch (gm.command) {
6621 error = add_group(ofproto, &gm);
6624 case OFPGC11_MODIFY:
6625 error = modify_group(ofproto, &gm);
6628 case OFPGC11_DELETE:
6629 delete_group(ofproto, gm.group_id);
6633 case OFPGC15_INSERT_BUCKET:
6634 error = modify_group(ofproto, &gm);
6637 case OFPGC15_REMOVE_BUCKET:
6638 error = modify_group(ofproto, &gm);
6642 if (gm.command > OFPGC11_DELETE) {
6643 VLOG_INFO_RL(&rl, "%s: Invalid group_mod command type %d",
6644 ofproto->name, gm.command);
6646 return OFPERR_OFPGMFC_BAD_COMMAND;
6650 struct ofputil_requestforward rf;
6652 rf.reason = OFPRFR_GROUP_MOD;
6654 connmgr_send_requestforward(ofproto->connmgr, ofconn, &rf);
6659 enum ofputil_table_miss
6660 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6662 enum ofputil_table_miss miss;
6664 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &miss);
6669 table_mod__(struct oftable *oftable,
6670 const struct ofputil_table_mod *tm)
6672 if (tm->miss == OFPUTIL_TABLE_MISS_DEFAULT) {
6673 /* This is how an OFPT_TABLE_MOD decodes if it doesn't specify any
6674 * table-miss configuration (because the protocol used doesn't have
6675 * such a concept), so there's nothing to do. */
6677 atomic_store_relaxed(&oftable->miss_config, tm->miss);
6680 unsigned int new_eviction = oftable->eviction;
6681 if (tm->eviction == OFPUTIL_TABLE_EVICTION_ON) {
6682 new_eviction |= EVICTION_OPENFLOW;
6683 } else if (tm->eviction == OFPUTIL_TABLE_EVICTION_OFF) {
6684 new_eviction &= ~EVICTION_OPENFLOW;
6687 if (new_eviction != oftable->eviction) {
6688 ovs_mutex_lock(&ofproto_mutex);
6689 oftable_configure_eviction(oftable, new_eviction,
6690 oftable->eviction_fields,
6691 oftable->n_eviction_fields);
6692 ovs_mutex_unlock(&ofproto_mutex);
6695 if (tm->vacancy != OFPUTIL_TABLE_VACANCY_DEFAULT) {
6696 ovs_mutex_lock(&ofproto_mutex);
6697 oftable->vacancy_enabled = (tm->vacancy == OFPUTIL_TABLE_VACANCY_ON
6698 ? OFPTC14_VACANCY_EVENTS
6700 oftable->vacancy_down = tm->table_vacancy.vacancy_down;
6701 oftable->vacancy_up = tm->table_vacancy.vacancy_up;
6702 ovs_mutex_unlock(&ofproto_mutex);
6707 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6709 if (!check_table_id(ofproto, tm->table_id)) {
6710 return OFPERR_OFPTMFC_BAD_TABLE;
6713 /* Don't allow the eviction flags to be changed (except to the only fixed
6714 * value that OVS supports). OF1.4 says this is normal: "The
6715 * OFPTMPT_EVICTION property usually cannot be modified using a
6716 * OFP_TABLE_MOD request, because the eviction mechanism is switch
6718 if (tm->eviction_flags != UINT32_MAX
6719 && tm->eviction_flags != OFPROTO_EVICTION_FLAGS) {
6720 return OFPERR_OFPTMFC_BAD_CONFIG;
6723 if (tm->table_id == OFPTT_ALL) {
6724 struct oftable *oftable;
6725 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6726 if (!(oftable->flags & (OFTABLE_HIDDEN | OFTABLE_READONLY))) {
6727 table_mod__(oftable, tm);
6731 struct oftable *oftable = &ofproto->tables[tm->table_id];
6732 if (oftable->flags & OFTABLE_READONLY) {
6733 return OFPERR_OFPTMFC_EPERM;
6735 table_mod__(oftable, tm);
6742 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6744 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6745 struct ofputil_table_mod tm;
6748 error = reject_slave_controller(ofconn);
6753 error = ofputil_decode_table_mod(oh, &tm);
6758 return table_mod(ofproto, &tm);
6762 ofproto_flow_mod_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6763 OVS_REQUIRES(ofproto_mutex)
6765 switch (ofm->fm.command) {
6767 return add_flow_start(ofproto, ofm);
6768 /* , &be->old_rules.stub[0],
6769 &be->new_rules.stub[0]); */
6771 return modify_flows_start_loose(ofproto, ofm);
6772 case OFPFC_MODIFY_STRICT:
6773 return modify_flow_start_strict(ofproto, ofm);
6775 return delete_flows_start_loose(ofproto, ofm);
6777 case OFPFC_DELETE_STRICT:
6778 return delete_flow_start_strict(ofproto, ofm);
6781 return OFPERR_OFPFMFC_BAD_COMMAND;
6785 ofproto_flow_mod_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6786 OVS_REQUIRES(ofproto_mutex)
6788 switch (ofm->fm.command) {
6790 add_flow_revert(ofproto, ofm);
6794 case OFPFC_MODIFY_STRICT:
6795 modify_flows_revert(ofproto, ofm);
6799 case OFPFC_DELETE_STRICT:
6800 delete_flows_revert(ofproto, ofm);
6809 ofproto_flow_mod_finish(struct ofproto *ofproto,
6810 struct ofproto_flow_mod *ofm,
6811 const struct flow_mod_requester *req)
6812 OVS_REQUIRES(ofproto_mutex)
6814 switch (ofm->fm.command) {
6816 add_flow_finish(ofproto, ofm, req);
6820 case OFPFC_MODIFY_STRICT:
6821 modify_flows_finish(ofproto, ofm, req);
6825 case OFPFC_DELETE_STRICT:
6826 delete_flows_finish(ofproto, ofm, req);
6834 /* Commit phases (all while locking ofproto_mutex):
6836 * 1. Begin: Gather resources and make changes visible in the next version.
6837 * - Mark affected rules for removal in the next version.
6838 * - Create new replacement rules, make visible in the next
6840 * - Do not send any events or notifications.
6842 * 2. Revert: Fail if any errors are found. After this point no errors are
6843 * possible. No visible changes were made, so rollback is minimal (remove
6844 * added invisible rules, restore visibility of rules marked for removal).
6846 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
6847 * the ofproto provider. Remove replaced and deleted rules from ofproto data
6848 * structures, and Schedule postponed removal of deleted rules from the
6849 * classifier. Send notifications, buffered packets, etc.
6852 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6854 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6855 cls_version_t version = ofproto->tables_version + 1;
6856 struct ofp_bundle *bundle;
6857 struct ofp_bundle_entry *be;
6860 bundle = ofconn_get_bundle(ofconn, id);
6863 return OFPERR_OFPBFC_BAD_ID;
6865 if (bundle->flags != flags) {
6866 error = OFPERR_OFPBFC_BAD_FLAGS;
6868 bool prev_is_port_mod = false;
6871 ovs_mutex_lock(&ofproto_mutex);
6874 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6875 if (be->type == OFPTYPE_PORT_MOD) {
6876 /* Our port mods are not atomic. */
6877 if (flags & OFPBF_ATOMIC) {
6878 error = OFPERR_OFPBFC_MSG_FAILED;
6880 prev_is_port_mod = true;
6881 error = port_mod_start(ofconn, &be->opm.pm, &be->opm.port);
6883 } else if (be->type == OFPTYPE_FLOW_MOD) {
6884 /* Flow mods between port mods are applied as a single
6885 * version, but the versions are published only after
6886 * we know the commit is successful. */
6887 if (prev_is_port_mod) {
6890 prev_is_port_mod = false;
6891 /* Store the version in which the changes should take
6893 be->ofm.version = version;
6894 error = ofproto_flow_mod_start(ofproto, &be->ofm);
6904 /* Send error referring to the original message. */
6906 ofconn_send_error(ofconn, be->ofp_msg, error);
6907 error = OFPERR_OFPBFC_MSG_FAILED;
6910 /* 2. Revert. Undo all the changes made above. */
6911 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6912 if (be->type == OFPTYPE_FLOW_MOD) {
6913 ofproto_flow_mod_revert(ofproto, &be->ofm);
6915 /* Nothing needs to be reverted for a port mod. */
6919 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6920 if (be->type == OFPTYPE_FLOW_MOD) {
6921 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6923 /* Bump the lookup version to the one of the current
6924 * message. This makes all the changes in the bundle at
6925 * this version visible to lookups at once. */
6926 if (ofproto->tables_version < be->ofm.version) {
6927 ofproto->tables_version = be->ofm.version;
6928 ofproto->ofproto_class->set_tables_version(
6929 ofproto, ofproto->tables_version);
6932 ofproto_flow_mod_finish(ofproto, &be->ofm, &req);
6933 } else if (be->type == OFPTYPE_PORT_MOD) {
6934 /* Perform the actual port mod. This is not atomic, i.e.,
6935 * the effects will be immediately seen by upcall
6936 * processing regardless of the lookup version. It should
6937 * be noted that port configuration changes can originate
6938 * also from OVSDB changes asynchronously to all upcall
6940 port_mod_finish(ofconn, &be->opm.pm, be->opm.port);
6945 ofmonitor_flush(ofproto->connmgr);
6946 ovs_mutex_unlock(&ofproto_mutex);
6948 run_rule_executes(ofproto);
6951 /* The bundle is discarded regardless the outcome. */
6952 ofp_bundle_remove__(ofconn, bundle, !error);
6957 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6959 struct ofputil_bundle_ctrl_msg bctrl;
6960 struct ofputil_bundle_ctrl_msg reply;
6964 error = reject_slave_controller(ofconn);
6969 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6974 reply.bundle_id = bctrl.bundle_id;
6976 switch (bctrl.type) {
6977 case OFPBCT_OPEN_REQUEST:
6978 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6979 reply.type = OFPBCT_OPEN_REPLY;
6981 case OFPBCT_CLOSE_REQUEST:
6982 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6983 reply.type = OFPBCT_CLOSE_REPLY;
6985 case OFPBCT_COMMIT_REQUEST:
6986 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6987 reply.type = OFPBCT_COMMIT_REPLY;
6989 case OFPBCT_DISCARD_REQUEST:
6990 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6991 reply.type = OFPBCT_DISCARD_REPLY;
6994 case OFPBCT_OPEN_REPLY:
6995 case OFPBCT_CLOSE_REPLY:
6996 case OFPBCT_COMMIT_REPLY:
6997 case OFPBCT_DISCARD_REPLY:
6998 return OFPERR_OFPBFC_BAD_TYPE;
7003 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
7004 ofconn_send_reply(ofconn, buf);
7010 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
7012 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
7014 struct ofputil_bundle_add_msg badd;
7015 struct ofp_bundle_entry *bmsg;
7018 error = reject_slave_controller(ofconn);
7023 error = ofputil_decode_bundle_add(oh, &badd, &type);
7028 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
7030 if (type == OFPTYPE_PORT_MOD) {
7031 error = ofputil_decode_port_mod(badd.msg, &bmsg->opm.pm, false);
7032 } else if (type == OFPTYPE_FLOW_MOD) {
7033 struct ofpbuf ofpacts;
7034 uint64_t ofpacts_stub[1024 / 8];
7036 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
7037 error = ofputil_decode_flow_mod(&bmsg->ofm.fm, badd.msg,
7038 ofconn_get_protocol(ofconn),
7040 u16_to_ofp(ofproto->max_ports),
7042 /* Move actions to heap. */
7043 bmsg->ofm.fm.ofpacts = ofpbuf_steal_data(&ofpacts);
7045 if (!error && bmsg->ofm.fm.ofpacts_len) {
7046 error = ofproto_check_ofpacts(ofproto, bmsg->ofm.fm.ofpacts,
7047 bmsg->ofm.fm.ofpacts_len);
7054 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
7059 ofp_bundle_entry_free(bmsg);
7066 handle_tlv_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
7068 struct ofputil_tlv_table_mod ttm;
7071 error = reject_slave_controller(ofconn);
7076 error = ofputil_decode_tlv_table_mod(oh, &ttm);
7081 error = tun_metadata_table_mod(&ttm);
7083 ofputil_uninit_tlv_table(&ttm.mappings);
7088 handle_tlv_table_request(struct ofconn *ofconn, const struct ofp_header *oh)
7090 struct ofputil_tlv_table_reply ttr;
7093 tun_metadata_table_request(&ttr);
7094 b = ofputil_encode_tlv_table_reply(oh, &ttr);
7095 ofputil_uninit_tlv_table(&ttr.mappings);
7097 ofconn_send_reply(ofconn, b);
7102 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
7103 OVS_EXCLUDED(ofproto_mutex)
7105 const struct ofp_header *oh = msg->data;
7109 error = ofptype_decode(&type, oh);
7113 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
7114 && ofpmp_more(oh)) {
7115 /* We have no buffer implementation for multipart requests.
7116 * Report overflow for requests which consists of multiple
7118 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
7122 /* OpenFlow requests. */
7123 case OFPTYPE_ECHO_REQUEST:
7124 return handle_echo_request(ofconn, oh);
7126 case OFPTYPE_FEATURES_REQUEST:
7127 return handle_features_request(ofconn, oh);
7129 case OFPTYPE_GET_CONFIG_REQUEST:
7130 return handle_get_config_request(ofconn, oh);
7132 case OFPTYPE_SET_CONFIG:
7133 return handle_set_config(ofconn, oh);
7135 case OFPTYPE_PACKET_OUT:
7136 return handle_packet_out(ofconn, oh);
7138 case OFPTYPE_PORT_MOD:
7139 return handle_port_mod(ofconn, oh);
7141 case OFPTYPE_FLOW_MOD:
7142 return handle_flow_mod(ofconn, oh);
7144 case OFPTYPE_GROUP_MOD:
7145 return handle_group_mod(ofconn, oh);
7147 case OFPTYPE_TABLE_MOD:
7148 return handle_table_mod(ofconn, oh);
7150 case OFPTYPE_METER_MOD:
7151 return handle_meter_mod(ofconn, oh);
7153 case OFPTYPE_BARRIER_REQUEST:
7154 return handle_barrier_request(ofconn, oh);
7156 case OFPTYPE_ROLE_REQUEST:
7157 return handle_role_request(ofconn, oh);
7159 /* OpenFlow replies. */
7160 case OFPTYPE_ECHO_REPLY:
7163 /* Nicira extension requests. */
7164 case OFPTYPE_FLOW_MOD_TABLE_ID:
7165 return handle_nxt_flow_mod_table_id(ofconn, oh);
7167 case OFPTYPE_SET_FLOW_FORMAT:
7168 return handle_nxt_set_flow_format(ofconn, oh);
7170 case OFPTYPE_SET_PACKET_IN_FORMAT:
7171 return handle_nxt_set_packet_in_format(ofconn, oh);
7173 case OFPTYPE_SET_CONTROLLER_ID:
7174 return handle_nxt_set_controller_id(ofconn, oh);
7176 case OFPTYPE_FLOW_AGE:
7177 /* Nothing to do. */
7180 case OFPTYPE_FLOW_MONITOR_CANCEL:
7181 return handle_flow_monitor_cancel(ofconn, oh);
7183 case OFPTYPE_SET_ASYNC_CONFIG:
7184 return handle_nxt_set_async_config(ofconn, oh);
7186 case OFPTYPE_GET_ASYNC_REQUEST:
7187 return handle_nxt_get_async_request(ofconn, oh);
7189 /* Statistics requests. */
7190 case OFPTYPE_DESC_STATS_REQUEST:
7191 return handle_desc_stats_request(ofconn, oh);
7193 case OFPTYPE_FLOW_STATS_REQUEST:
7194 return handle_flow_stats_request(ofconn, oh);
7196 case OFPTYPE_AGGREGATE_STATS_REQUEST:
7197 return handle_aggregate_stats_request(ofconn, oh);
7199 case OFPTYPE_TABLE_STATS_REQUEST:
7200 return handle_table_stats_request(ofconn, oh);
7202 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
7203 return handle_table_features_request(ofconn, oh);
7205 case OFPTYPE_TABLE_DESC_REQUEST:
7206 return handle_table_desc_request(ofconn, oh);
7208 case OFPTYPE_PORT_STATS_REQUEST:
7209 return handle_port_stats_request(ofconn, oh);
7211 case OFPTYPE_QUEUE_STATS_REQUEST:
7212 return handle_queue_stats_request(ofconn, oh);
7214 case OFPTYPE_PORT_DESC_STATS_REQUEST:
7215 return handle_port_desc_stats_request(ofconn, oh);
7217 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
7218 return handle_flow_monitor_request(ofconn, oh);
7220 case OFPTYPE_METER_STATS_REQUEST:
7221 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
7222 return handle_meter_request(ofconn, oh, type);
7224 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
7225 return handle_meter_features_request(ofconn, oh);
7227 case OFPTYPE_GROUP_STATS_REQUEST:
7228 return handle_group_stats_request(ofconn, oh);
7230 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
7231 return handle_group_desc_stats_request(ofconn, oh);
7233 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
7234 return handle_group_features_stats_request(ofconn, oh);
7236 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
7237 return handle_queue_get_config_request(ofconn, oh);
7239 case OFPTYPE_BUNDLE_CONTROL:
7240 return handle_bundle_control(ofconn, oh);
7242 case OFPTYPE_BUNDLE_ADD_MESSAGE:
7243 return handle_bundle_add(ofconn, oh);
7245 case OFPTYPE_NXT_TLV_TABLE_MOD:
7246 return handle_tlv_table_mod(ofconn, oh);
7248 case OFPTYPE_NXT_TLV_TABLE_REQUEST:
7249 return handle_tlv_table_request(ofconn, oh);
7253 case OFPTYPE_FEATURES_REPLY:
7254 case OFPTYPE_GET_CONFIG_REPLY:
7255 case OFPTYPE_PACKET_IN:
7256 case OFPTYPE_FLOW_REMOVED:
7257 case OFPTYPE_PORT_STATUS:
7258 case OFPTYPE_BARRIER_REPLY:
7259 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
7260 case OFPTYPE_DESC_STATS_REPLY:
7261 case OFPTYPE_FLOW_STATS_REPLY:
7262 case OFPTYPE_QUEUE_STATS_REPLY:
7263 case OFPTYPE_PORT_STATS_REPLY:
7264 case OFPTYPE_TABLE_STATS_REPLY:
7265 case OFPTYPE_AGGREGATE_STATS_REPLY:
7266 case OFPTYPE_PORT_DESC_STATS_REPLY:
7267 case OFPTYPE_ROLE_REPLY:
7268 case OFPTYPE_FLOW_MONITOR_PAUSED:
7269 case OFPTYPE_FLOW_MONITOR_RESUMED:
7270 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
7271 case OFPTYPE_GET_ASYNC_REPLY:
7272 case OFPTYPE_GROUP_STATS_REPLY:
7273 case OFPTYPE_GROUP_DESC_STATS_REPLY:
7274 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
7275 case OFPTYPE_METER_STATS_REPLY:
7276 case OFPTYPE_METER_CONFIG_STATS_REPLY:
7277 case OFPTYPE_METER_FEATURES_STATS_REPLY:
7278 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
7279 case OFPTYPE_TABLE_DESC_REPLY:
7280 case OFPTYPE_ROLE_STATUS:
7281 case OFPTYPE_REQUESTFORWARD:
7282 case OFPTYPE_NXT_TLV_TABLE_REPLY:
7284 if (ofpmsg_is_stat_request(oh)) {
7285 return OFPERR_OFPBRC_BAD_STAT;
7287 return OFPERR_OFPBRC_BAD_TYPE;
7293 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
7294 OVS_EXCLUDED(ofproto_mutex)
7296 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
7299 ofconn_send_error(ofconn, ofp_msg->data, error);
7301 COVERAGE_INC(ofproto_recv_openflow);
7304 /* Asynchronous operations. */
7307 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
7309 OVS_REQUIRES(ofproto_mutex)
7311 if (req && req->ofconn && buffer_id != UINT32_MAX) {
7312 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
7313 struct dp_packet *packet;
7317 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
7320 struct rule_execute *re;
7322 ofproto_rule_ref(rule);
7324 re = xmalloc(sizeof *re);
7326 re->in_port = in_port;
7327 re->packet = packet;
7329 if (!guarded_list_push_back(&ofproto->rule_executes,
7330 &re->list_node, 1024)) {
7331 ofproto_rule_unref(rule);
7332 dp_packet_delete(re->packet);
7336 ofconn_send_error(req->ofconn, req->request, error);
7342 pick_datapath_id(const struct ofproto *ofproto)
7344 const struct ofport *port;
7346 port = ofproto_get_port(ofproto, OFPP_LOCAL);
7351 error = netdev_get_etheraddr(port->netdev, &ea);
7353 return eth_addr_to_uint64(ea);
7355 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7356 ofproto->name, netdev_get_name(port->netdev),
7357 ovs_strerror(error));
7359 return ofproto->fallback_dpid;
7363 pick_fallback_dpid(void)
7366 eth_addr_nicira_random(&ea);
7367 return eth_addr_to_uint64(ea);
7370 /* Table overflow policy. */
7372 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7373 * to NULL if the table is not configured to evict rules or if the table
7374 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7375 * or with no timeouts are not evictable.) */
7377 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
7378 OVS_REQUIRES(ofproto_mutex)
7380 struct eviction_group *evg;
7383 if (!table->eviction) {
7387 /* In the common case, the outer and inner loops here will each be entered
7390 * - The inner loop normally "return"s in its first iteration. If the
7391 * eviction group has any evictable rules, then it always returns in
7394 * - The outer loop only iterates more than once if the largest eviction
7395 * group has no evictable rules.
7397 * - The outer loop can exit only if table's 'max_flows' is all filled up
7398 * by unevictable rules. */
7399 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7402 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7411 /* Eviction groups. */
7413 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7414 * rules. The priority contains low-order random bits to ensure that eviction
7415 * groups with the same number of rules are prioritized randomly. */
7417 eviction_group_priority(size_t n_rules)
7419 uint16_t size = MIN(UINT16_MAX, n_rules);
7420 return (size << 16) | random_uint16();
7423 /* Updates 'evg', an eviction_group within 'table', following a change that
7424 * adds or removes rules in 'evg'. */
7426 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7427 OVS_REQUIRES(ofproto_mutex)
7429 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7430 eviction_group_priority(heap_count(&evg->rules)));
7433 /* Destroys 'evg', an eviction_group within 'table':
7435 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7436 * rules themselves, just removes them from the eviction group.)
7438 * - Removes 'evg' from 'table'.
7442 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7443 OVS_REQUIRES(ofproto_mutex)
7445 while (!heap_is_empty(&evg->rules)) {
7448 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7449 rule->eviction_group = NULL;
7451 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7452 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7453 heap_destroy(&evg->rules);
7457 /* Removes 'rule' from its eviction group, if any. */
7459 eviction_group_remove_rule(struct rule *rule)
7460 OVS_REQUIRES(ofproto_mutex)
7462 if (rule->eviction_group) {
7463 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7464 struct eviction_group *evg = rule->eviction_group;
7466 rule->eviction_group = NULL;
7467 heap_remove(&evg->rules, &rule->evg_node);
7468 if (heap_is_empty(&evg->rules)) {
7469 eviction_group_destroy(table, evg);
7471 eviction_group_resized(table, evg);
7476 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7477 * returns the hash value. */
7479 eviction_group_hash_rule(struct rule *rule)
7480 OVS_REQUIRES(ofproto_mutex)
7482 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7483 const struct mf_subfield *sf;
7487 hash = table->eviction_group_id_basis;
7488 miniflow_expand(rule->cr.match.flow, &flow);
7489 for (sf = table->eviction_fields;
7490 sf < &table->eviction_fields[table->n_eviction_fields];
7493 if (mf_are_prereqs_ok(sf->field, &flow)) {
7494 union mf_value value;
7496 mf_get_value(sf->field, &flow, &value);
7498 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7500 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7501 unsigned int start = sf->ofs + sf->n_bits;
7502 bitwise_zero(&value, sf->field->n_bytes, start,
7503 sf->field->n_bytes * 8 - start);
7505 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7507 hash = hash_int(hash, 0);
7514 /* Returns an eviction group within 'table' with the given 'id', creating one
7516 static struct eviction_group *
7517 eviction_group_find(struct oftable *table, uint32_t id)
7518 OVS_REQUIRES(ofproto_mutex)
7520 struct eviction_group *evg;
7522 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7526 evg = xmalloc(sizeof *evg);
7527 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7528 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7529 eviction_group_priority(0));
7530 heap_init(&evg->rules);
7535 /* Returns an eviction priority for 'rule'. The return value should be
7536 * interpreted so that higher priorities make a rule a more attractive
7537 * candidate for eviction. */
7539 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7540 OVS_REQUIRES(ofproto_mutex)
7542 /* Calculate absolute time when this flow will expire. If it will never
7543 * expire, then return 0 to make it unevictable. */
7544 long long int expiration = LLONG_MAX;
7545 if (rule->hard_timeout) {
7546 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7547 ovs_mutex_lock(&rule->mutex);
7548 long long int modified = rule->modified;
7549 ovs_mutex_unlock(&rule->mutex);
7551 expiration = modified + rule->hard_timeout * 1000;
7553 if (rule->idle_timeout) {
7554 uint64_t packets, bytes;
7556 long long int idle_expiration;
7558 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7559 idle_expiration = used + rule->idle_timeout * 1000;
7560 expiration = MIN(expiration, idle_expiration);
7562 if (expiration == LLONG_MAX) {
7566 /* Calculate the time of expiration as a number of (approximate) seconds
7567 * after program startup.
7569 * This should work OK for program runs that last UINT32_MAX seconds or
7570 * less. Therefore, please restart OVS at least once every 136 years. */
7571 uint32_t expiration_ofs = (expiration >> 10) - (time_boot_msec() >> 10);
7573 /* Combine expiration time with OpenFlow "importance" to form a single
7574 * priority value. We want flows with relatively low "importance" to be
7575 * evicted before even considering expiration time, so put "importance" in
7576 * the most significant bits and expiration time in the least significant
7579 * Small 'priority' should be evicted before those with large 'priority'.
7580 * The caller expects the opposite convention (a large return value being
7581 * more attractive for eviction) so we invert it before returning. */
7582 uint64_t priority = ((uint64_t) rule->importance << 32) + expiration_ofs;
7583 return UINT64_MAX - priority;
7586 /* Adds 'rule' to an appropriate eviction group for its oftable's
7587 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7588 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7591 * The caller must ensure that 'rule' is not already in an eviction group. */
7593 eviction_group_add_rule(struct rule *rule)
7594 OVS_REQUIRES(ofproto_mutex)
7596 struct ofproto *ofproto = rule->ofproto;
7597 struct oftable *table = &ofproto->tables[rule->table_id];
7600 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7601 * so no additional protection is needed. */
7602 has_timeout = rule->hard_timeout || rule->idle_timeout;
7604 if (table->eviction && has_timeout) {
7605 struct eviction_group *evg;
7607 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7609 rule->eviction_group = evg;
7610 heap_insert(&evg->rules, &rule->evg_node,
7611 rule_eviction_priority(ofproto, rule));
7612 eviction_group_resized(table, evg);
7618 /* Initializes 'table'. */
7620 oftable_init(struct oftable *table)
7622 memset(table, 0, sizeof *table);
7623 classifier_init(&table->cls, flow_segment_u64s);
7624 table->max_flows = UINT_MAX;
7626 hmap_init(&table->eviction_groups_by_id);
7627 heap_init(&table->eviction_groups_by_size);
7628 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7630 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7631 ARRAY_SIZE(default_prefix_fields));
7633 atomic_init(&table->n_matched, 0);
7634 atomic_init(&table->n_missed, 0);
7637 /* Destroys 'table', including its classifier and eviction groups.
7639 * The caller is responsible for freeing 'table' itself. */
7641 oftable_destroy(struct oftable *table)
7643 ovs_assert(classifier_is_empty(&table->cls));
7645 ovs_mutex_lock(&ofproto_mutex);
7646 oftable_configure_eviction(table, 0, NULL, 0);
7647 ovs_mutex_unlock(&ofproto_mutex);
7649 hmap_destroy(&table->eviction_groups_by_id);
7650 heap_destroy(&table->eviction_groups_by_size);
7651 classifier_destroy(&table->cls);
7655 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7656 * string, then 'table' will use its default name.
7658 * This only affects the name exposed for a table exposed through the OpenFlow
7659 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7661 oftable_set_name(struct oftable *table, const char *name)
7663 if (name && name[0]) {
7664 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7665 if (!table->name || strncmp(name, table->name, len)) {
7667 table->name = xmemdup0(name, len);
7675 /* oftables support a choice of two policies when adding a rule would cause the
7676 * number of flows in the table to exceed the configured maximum number: either
7677 * they can refuse to add the new flow or they can evict some existing flow.
7678 * This function configures the latter policy on 'table', with fairness based
7679 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7680 * 'n_fields' as 0 disables fairness.) */
7682 oftable_configure_eviction(struct oftable *table, unsigned int eviction,
7683 const struct mf_subfield *fields, size_t n_fields)
7684 OVS_REQUIRES(ofproto_mutex)
7688 if ((table->eviction != 0) == (eviction != 0)
7689 && n_fields == table->n_eviction_fields
7691 || !memcmp(fields, table->eviction_fields,
7692 n_fields * sizeof *fields))) {
7693 /* The set of eviction fields did not change. If 'eviction' changed,
7694 * it remains nonzero, so that we can just update table->eviction
7695 * without fussing with the eviction groups. */
7696 table->eviction = eviction;
7700 /* Destroy existing eviction groups, then destroy and recreate data
7701 * structures to recover memory. */
7702 struct eviction_group *evg, *next;
7703 HMAP_FOR_EACH_SAFE (evg, next, id_node, &table->eviction_groups_by_id) {
7704 eviction_group_destroy(table, evg);
7706 hmap_destroy(&table->eviction_groups_by_id);
7707 hmap_init(&table->eviction_groups_by_id);
7708 heap_destroy(&table->eviction_groups_by_size);
7709 heap_init(&table->eviction_groups_by_size);
7711 /* Replace eviction groups by the new ones, if there is a change. Free the
7712 * old fields only after allocating the new ones, because 'fields ==
7713 * table->eviction_fields' is possible. */
7714 struct mf_subfield *old_fields = table->eviction_fields;
7715 table->n_eviction_fields = n_fields;
7716 table->eviction_fields = (fields
7717 ? xmemdup(fields, n_fields * sizeof *fields)
7721 /* Add the new eviction groups, if enabled. */
7722 table->eviction = eviction;
7723 if (table->eviction) {
7724 table->eviction_group_id_basis = random_uint32();
7725 CLS_FOR_EACH (rule, cr, &table->cls) {
7726 eviction_group_add_rule(rule);
7731 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7732 * it to the classifier. */
7734 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7735 OVS_REQUIRES(ofproto_mutex)
7737 const struct rule_actions *actions = rule_get_actions(rule);
7739 ovs_assert(rule->removed);
7741 if (rule->hard_timeout || rule->idle_timeout) {
7742 list_insert(&ofproto->expirable, &rule->expirable);
7744 cookies_insert(ofproto, rule);
7745 eviction_group_add_rule(rule);
7746 if (actions->has_meter) {
7747 meter_insert_rule(rule);
7749 rule->removed = false;
7752 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7753 * the removal from the classifier. */
7755 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7756 OVS_REQUIRES(ofproto_mutex)
7758 ovs_assert(!rule->removed);
7760 cookies_remove(ofproto, rule);
7762 eviction_group_remove_rule(rule);
7763 if (!list_is_empty(&rule->expirable)) {
7764 list_remove(&rule->expirable);
7766 if (!list_is_empty(&rule->meter_list_node)) {
7767 list_remove(&rule->meter_list_node);
7768 list_init(&rule->meter_list_node);
7771 rule->removed = true;
7774 /* unixctl commands. */
7777 ofproto_lookup(const char *name)
7779 struct ofproto *ofproto;
7781 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7783 if (!strcmp(ofproto->name, name)) {
7791 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7792 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7794 struct ofproto *ofproto;
7798 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7799 ds_put_format(&results, "%s\n", ofproto->name);
7801 unixctl_command_reply(conn, ds_cstr(&results));
7802 ds_destroy(&results);
7806 ofproto_unixctl_init(void)
7808 static bool registered;
7814 unixctl_command_register("ofproto/list", "", 0, 0,
7815 ofproto_unixctl_list, NULL);
7818 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7820 * This is deprecated. It is only for compatibility with broken device drivers
7821 * in old versions of Linux that do not properly support VLANs when VLAN
7822 * devices are not used. When broken device drivers are no longer in
7823 * widespread use, we will delete these interfaces. */
7825 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7826 * (exactly) by an OpenFlow rule in 'ofproto'. */
7828 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7831 struct cls_rule target;
7832 const struct oftable *oftable;
7834 match_init_catchall(&match);
7835 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7836 cls_rule_init(&target, &match, 0);
7838 free(ofproto->vlan_bitmap);
7839 ofproto->vlan_bitmap = bitmap_allocate(4096);
7840 ofproto->vlans_changed = false;
7842 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7845 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target,
7847 if (minimask_get_vid_mask(rule->cr.match.mask) == VLAN_VID_MASK) {
7848 uint16_t vid = miniflow_get_vid(rule->cr.match.flow);
7850 bitmap_set1(vlan_bitmap, vid);
7851 bitmap_set1(ofproto->vlan_bitmap, vid);
7856 cls_rule_destroy(&target);
7859 /* Returns true if new VLANs have come into use by the flow table since the
7860 * last call to ofproto_get_vlan_usage().
7862 * We don't track when old VLANs stop being used. */
7864 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7866 return ofproto->vlans_changed;
7869 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7870 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7871 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7872 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7873 * then the VLAN device is un-enslaved. */
7875 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7876 ofp_port_t realdev_ofp_port, int vid)
7878 struct ofport *ofport;
7881 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7883 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7885 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7886 ofproto->name, vlandev_ofp_port);
7890 if (!ofproto->ofproto_class->set_realdev) {
7891 if (!vlandev_ofp_port) {
7894 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7898 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7900 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7901 ofproto->name, vlandev_ofp_port,
7902 netdev_get_name(ofport->netdev), ovs_strerror(error));