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 *, bool del);
222 static int update_port(struct ofproto *, const char *devname);
223 static int init_ports(struct ofproto *);
224 static void reinit_ports(struct ofproto *);
226 static long long int ofport_get_usage(const struct ofproto *,
227 ofp_port_t ofp_port);
228 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
229 long long int last_used);
230 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
234 * Keeps track of the currently used and recently used ofport values and is
235 * used to prevent immediate recycling of ofport values. */
236 struct ofport_usage {
237 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
238 ofp_port_t ofp_port; /* OpenFlow port number. */
239 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
240 represents in-use ofports. */
244 static void ofproto_rule_send_removed(struct rule *)
245 OVS_EXCLUDED(ofproto_mutex);
246 static bool rule_is_readonly(const struct rule *);
247 static void ofproto_rule_insert__(struct ofproto *, struct rule *)
248 OVS_REQUIRES(ofproto_mutex);
249 static void ofproto_rule_remove__(struct ofproto *, struct rule *)
250 OVS_REQUIRES(ofproto_mutex);
252 /* The source of a flow_mod request, in the code that processes flow_mods.
254 * A flow table modification request can be generated externally, via OpenFlow,
255 * or internally through a function call. This structure indicates the source
256 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
257 * meaningful and thus supplied as NULL. */
258 struct flow_mod_requester {
259 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
260 const struct ofp_header *request;
264 static enum ofperr replace_rule_create(struct ofproto *,
265 struct ofputil_flow_mod *,
266 struct cls_rule *cr, uint8_t table_id,
267 struct rule *old_rule,
268 struct rule **new_rule)
269 OVS_REQUIRES(ofproto_mutex);
271 static void replace_rule_start(struct ofproto *, cls_version_t version,
272 struct rule *old_rule, struct rule *new_rule,
273 struct cls_conjunction *, size_t n_conjs)
274 OVS_REQUIRES(ofproto_mutex);
276 static void replace_rule_revert(struct ofproto *, struct rule *old_rule,
277 struct rule *new_rule)
278 OVS_REQUIRES(ofproto_mutex);
280 static void replace_rule_finish(struct ofproto *, struct ofputil_flow_mod *,
281 const struct flow_mod_requester *,
282 struct rule *old_rule, struct rule *new_rule,
283 struct ovs_list *dead_cookies)
284 OVS_REQUIRES(ofproto_mutex);
285 static void delete_flows__(struct rule_collection *,
286 enum ofp_flow_removed_reason,
287 const struct flow_mod_requester *)
288 OVS_REQUIRES(ofproto_mutex);
290 static void send_buffered_packet(const struct flow_mod_requester *,
291 uint32_t buffer_id, struct rule *)
292 OVS_REQUIRES(ofproto_mutex);
294 static bool ofproto_group_exists__(const struct ofproto *ofproto,
296 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
297 static bool ofproto_group_exists(const struct ofproto *ofproto,
299 OVS_EXCLUDED(ofproto->groups_rwlock);
300 static enum ofperr add_group(struct ofproto *,
301 const struct ofputil_group_mod *);
302 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
303 static enum ofperr ofproto_flow_mod_start(struct ofproto *,
304 struct ofproto_flow_mod *)
305 OVS_REQUIRES(ofproto_mutex);
306 static void ofproto_flow_mod_finish(struct ofproto *,
307 struct ofproto_flow_mod *,
308 const struct flow_mod_requester *)
309 OVS_REQUIRES(ofproto_mutex);
310 static enum ofperr handle_flow_mod__(struct ofproto *,
311 struct ofproto_flow_mod *,
312 const struct flow_mod_requester *)
313 OVS_EXCLUDED(ofproto_mutex);
314 static void calc_duration(long long int start, long long int now,
315 uint32_t *sec, uint32_t *nsec);
318 static uint64_t pick_datapath_id(const struct ofproto *);
319 static uint64_t pick_fallback_dpid(void);
320 static void ofproto_destroy__(struct ofproto *);
321 static void update_mtu(struct ofproto *, struct ofport *);
322 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
323 static void meter_insert_rule(struct rule *);
326 static void ofproto_unixctl_init(void);
328 /* All registered ofproto classes, in probe order. */
329 static const struct ofproto_class **ofproto_classes;
330 static size_t n_ofproto_classes;
331 static size_t allocated_ofproto_classes;
333 /* Global lock that protects all flow table operations. */
334 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
336 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
337 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
339 size_t n_handlers, n_revalidators;
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_cpu_mask(const char *cmask)
787 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
791 ofproto_set_threads(int n_handlers_, int n_revalidators_)
793 int threads = MAX(count_cpu_cores(), 2);
795 n_revalidators = MAX(n_revalidators_, 0);
796 n_handlers = MAX(n_handlers_, 0);
798 if (!n_revalidators) {
799 n_revalidators = n_handlers
800 ? MAX(threads - (int) n_handlers, 1)
805 n_handlers = MAX(threads - (int) n_revalidators, 1);
810 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
813 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
817 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
819 return connmgr_set_snoops(ofproto->connmgr, snoops);
823 ofproto_set_netflow(struct ofproto *ofproto,
824 const struct netflow_options *nf_options)
826 if (nf_options && sset_is_empty(&nf_options->collectors)) {
830 if (ofproto->ofproto_class->set_netflow) {
831 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
833 return nf_options ? EOPNOTSUPP : 0;
838 ofproto_set_sflow(struct ofproto *ofproto,
839 const struct ofproto_sflow_options *oso)
841 if (oso && sset_is_empty(&oso->targets)) {
845 if (ofproto->ofproto_class->set_sflow) {
846 return ofproto->ofproto_class->set_sflow(ofproto, oso);
848 return oso ? EOPNOTSUPP : 0;
853 ofproto_set_ipfix(struct ofproto *ofproto,
854 const struct ofproto_ipfix_bridge_exporter_options *bo,
855 const struct ofproto_ipfix_flow_exporter_options *fo,
858 if (ofproto->ofproto_class->set_ipfix) {
859 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
861 return (bo || fo) ? EOPNOTSUPP : 0;
866 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
868 flow_restore_wait = flow_restore_wait_db;
872 ofproto_get_flow_restore_wait(void)
874 return flow_restore_wait;
878 /* Spanning Tree Protocol (STP) configuration. */
880 /* Configures STP on 'ofproto' using the settings defined in 's'. If
881 * 's' is NULL, disables STP.
883 * Returns 0 if successful, otherwise a positive errno value. */
885 ofproto_set_stp(struct ofproto *ofproto,
886 const struct ofproto_stp_settings *s)
888 return (ofproto->ofproto_class->set_stp
889 ? ofproto->ofproto_class->set_stp(ofproto, s)
893 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
894 * 'enabled' member of 's' is false, then the other members are not
897 * Returns 0 if successful, otherwise a positive errno value. */
899 ofproto_get_stp_status(struct ofproto *ofproto,
900 struct ofproto_stp_status *s)
902 return (ofproto->ofproto_class->get_stp_status
903 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
907 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
908 * in 's'. The caller is responsible for assigning STP port numbers
909 * (using the 'port_num' member in the range of 1 through 255, inclusive)
910 * and ensuring there are no duplicates. If the 's' is NULL, then STP
911 * is disabled on the port.
913 * Returns 0 if successful, otherwise a positive errno value.*/
915 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
916 const struct ofproto_port_stp_settings *s)
918 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
920 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
921 ofproto->name, ofp_port);
925 return (ofproto->ofproto_class->set_stp_port
926 ? ofproto->ofproto_class->set_stp_port(ofport, s)
930 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
931 * 's'. If the 'enabled' member in 's' is false, then the other members
932 * are not meaningful.
934 * Returns 0 if successful, otherwise a positive errno value.*/
936 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
937 struct ofproto_port_stp_status *s)
939 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
941 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
942 "port %"PRIu16, ofproto->name, ofp_port);
946 return (ofproto->ofproto_class->get_stp_port_status
947 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
951 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
952 * 's'. If the 'enabled' member in 's' is false, then the other members
953 * are not meaningful.
955 * Returns 0 if successful, otherwise a positive errno value.*/
957 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
958 struct ofproto_port_stp_stats *s)
960 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
962 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
963 "port %"PRIu16, ofproto->name, ofp_port);
967 return (ofproto->ofproto_class->get_stp_port_stats
968 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
972 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
974 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
975 * 's' is NULL, disables RSTP.
977 * Returns 0 if successful, otherwise a positive errno value. */
979 ofproto_set_rstp(struct ofproto *ofproto,
980 const struct ofproto_rstp_settings *s)
982 if (!ofproto->ofproto_class->set_rstp) {
985 ofproto->ofproto_class->set_rstp(ofproto, s);
989 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
990 * 'enabled' member of 's' is false, then the other members are not
993 * Returns 0 if successful, otherwise a positive errno value. */
995 ofproto_get_rstp_status(struct ofproto *ofproto,
996 struct ofproto_rstp_status *s)
998 if (!ofproto->ofproto_class->get_rstp_status) {
1001 ofproto->ofproto_class->get_rstp_status(ofproto, s);
1005 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1006 * in 's'. The caller is responsible for assigning RSTP port numbers
1007 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1008 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1009 * is disabled on the port.
1011 * Returns 0 if successful, otherwise a positive errno value.*/
1013 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
1014 const struct ofproto_port_rstp_settings *s)
1016 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1018 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
1019 ofproto->name, ofp_port);
1023 if (!ofproto->ofproto_class->set_rstp_port) {
1026 ofproto->ofproto_class->set_rstp_port(ofport, s);
1030 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1031 * 's'. If the 'enabled' member in 's' is false, then the other members
1032 * are not meaningful.
1034 * Returns 0 if successful, otherwise a positive errno value.*/
1036 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1037 struct ofproto_port_rstp_status *s)
1039 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1041 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1042 "port %"PRIu16, ofproto->name, ofp_port);
1046 if (!ofproto->ofproto_class->get_rstp_port_status) {
1049 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1053 /* Queue DSCP configuration. */
1055 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1056 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1057 * to implement QoS. Instead, it is used to implement features which require
1058 * knowledge of what queues exist on a port, and some basic information about
1061 * Returns 0 if successful, otherwise a positive errno value. */
1063 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1064 const struct ofproto_port_queue *queues,
1067 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1070 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1071 ofproto->name, ofp_port);
1075 return (ofproto->ofproto_class->set_queues
1076 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1080 /* LLDP configuration. */
1082 ofproto_port_set_lldp(struct ofproto *ofproto,
1083 ofp_port_t ofp_port,
1084 const struct smap *cfg)
1086 struct ofport *ofport;
1089 ofport = ofproto_get_port(ofproto, ofp_port);
1091 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1092 ofproto->name, ofp_port);
1095 error = (ofproto->ofproto_class->set_lldp
1096 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1099 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1100 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1101 ovs_strerror(error));
1106 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1107 const struct aa_settings *s)
1109 if (!ofproto->ofproto_class->set_aa) {
1112 ofproto->ofproto_class->set_aa(ofproto, s);
1117 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1118 const struct aa_mapping_settings *s)
1120 if (!ofproto->ofproto_class->aa_mapping_set) {
1123 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1128 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1130 if (!ofproto->ofproto_class->aa_mapping_unset) {
1133 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1138 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1139 struct ovs_list *list)
1141 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1144 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1149 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1151 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1154 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1157 /* Connectivity Fault Management configuration. */
1159 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1161 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1163 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1164 if (ofport && ofproto->ofproto_class->set_cfm) {
1165 ofproto->ofproto_class->set_cfm(ofport, NULL);
1169 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1170 * basic configuration from the configuration members in 'cfm', and the remote
1171 * maintenance point ID from remote_mpid. Ignores the statistics members of
1174 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1176 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1177 const struct cfm_settings *s)
1179 struct ofport *ofport;
1182 ofport = ofproto_get_port(ofproto, ofp_port);
1184 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1185 ofproto->name, ofp_port);
1189 /* XXX: For configuration simplicity, we only support one remote_mpid
1190 * outside of the CFM module. It's not clear if this is the correct long
1191 * term solution or not. */
1192 error = (ofproto->ofproto_class->set_cfm
1193 ? ofproto->ofproto_class->set_cfm(ofport, s)
1196 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1197 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1198 ovs_strerror(error));
1202 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1203 * 'ofproto' does not have a port 'ofp_port'. */
1205 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1206 const struct smap *cfg)
1208 struct ofport *ofport;
1211 ofport = ofproto_get_port(ofproto, ofp_port);
1213 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1214 ofproto->name, ofp_port);
1218 error = (ofproto->ofproto_class->set_bfd
1219 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1222 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1223 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1224 ovs_strerror(error));
1228 /* Checks the status change of BFD on 'ofport'.
1230 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1232 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1234 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1235 return (ofport && ofproto->ofproto_class->bfd_status_changed
1236 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1240 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1241 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1242 * is not an OpenFlow port in 'ofproto'.
1244 * The caller must provide and own '*status'. */
1246 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1247 struct smap *status)
1249 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1250 return (ofport && ofproto->ofproto_class->get_bfd_status
1251 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1255 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1256 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1257 * 0 if LACP partner information is not current (generally indicating a
1258 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1260 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1262 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1263 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1264 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1269 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1271 struct ofproto *ofproto = port->ofproto;
1274 if (ofproto->ofproto_class->port_get_lacp_stats) {
1275 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1285 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1286 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1287 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1288 * configuration plus, if there is more than one slave, a bonding
1291 * If 'aux' is already registered then this function updates its configuration
1292 * to 's'. Otherwise, this function registers a new bundle.
1294 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1297 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1298 const struct ofproto_bundle_settings *s)
1300 return (ofproto->ofproto_class->bundle_set
1301 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1305 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1306 * If no such bundle has been registered, this has no effect. */
1308 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1310 return ofproto_bundle_register(ofproto, aux, NULL);
1314 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1315 * If 'aux' is already registered then this function updates its configuration
1316 * to 's'. Otherwise, this function registers a new mirror. */
1318 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1319 const struct ofproto_mirror_settings *s)
1321 return (ofproto->ofproto_class->mirror_set
1322 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1326 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1327 * If no mirror has been registered, this has no effect. */
1329 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1331 return ofproto_mirror_register(ofproto, aux, NULL);
1334 /* Retrieves statistics from mirror associated with client data pointer
1335 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1336 * 'bytes', respectively. If a particular counters is not supported,
1337 * the appropriate argument is set to UINT64_MAX.
1340 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1341 uint64_t *packets, uint64_t *bytes)
1343 if (!ofproto->ofproto_class->mirror_get_stats) {
1344 *packets = *bytes = UINT64_MAX;
1348 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1352 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1353 * which all packets are flooded, instead of using MAC learning. If
1354 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1356 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1359 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1361 return (ofproto->ofproto_class->set_flood_vlans
1362 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1366 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1367 * output for a mirror. */
1369 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1371 return (ofproto->ofproto_class->is_mirror_output_bundle
1372 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1376 /* Configuration of OpenFlow tables. */
1378 /* Returns the number of OpenFlow tables in 'ofproto'. */
1380 ofproto_get_n_tables(const struct ofproto *ofproto)
1382 return ofproto->n_tables;
1385 /* Returns the number of Controller visible OpenFlow tables
1386 * in 'ofproto'. This number will exclude Hidden tables.
1387 * This funtion's return value should be less or equal to that of
1388 * ofproto_get_n_tables() . */
1390 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1392 uint8_t n = ofproto->n_tables;
1394 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1395 * if present, are always at the end.) */
1396 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1403 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1404 * settings from 's'. 'table_id' must be in the range 0 through the number of
1405 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1407 * For read-only tables, only the name may be configured. */
1409 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1410 const struct ofproto_table_settings *s)
1412 struct oftable *table;
1414 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1415 table = &ofproto->tables[table_id];
1417 oftable_set_name(table, s->name);
1419 if (table->flags & OFTABLE_READONLY) {
1423 if (classifier_set_prefix_fields(&table->cls,
1424 s->prefix_fields, s->n_prefix_fields)) {
1425 /* XXX: Trigger revalidation. */
1428 ovs_mutex_lock(&ofproto_mutex);
1429 unsigned int new_eviction = (s->enable_eviction
1430 ? table->eviction | EVICTION_CLIENT
1431 : table->eviction & ~EVICTION_CLIENT);
1432 oftable_configure_eviction(table, new_eviction, s->groups, s->n_groups);
1433 table->max_flows = s->max_flows;
1434 evict_rules_from_table(table);
1435 ovs_mutex_unlock(&ofproto_mutex);
1439 ofproto_has_snoops(const struct ofproto *ofproto)
1441 return connmgr_has_snoops(ofproto->connmgr);
1445 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1447 connmgr_get_snoops(ofproto->connmgr, snoops);
1450 /* Deletes 'rule' from 'ofproto'.
1452 * Within an ofproto implementation, this function allows an ofproto
1453 * implementation to destroy any rules that remain when its ->destruct()
1454 * function is called. This function is not suitable for use elsewhere in an
1455 * ofproto implementation.
1457 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1458 * Cycle" in ofproto-provider.h. */
1460 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1461 OVS_EXCLUDED(ofproto_mutex)
1463 /* This skips the ofmonitor and flow-removed notifications because the
1464 * switch is being deleted and any OpenFlow channels have been or soon will
1466 ovs_mutex_lock(&ofproto_mutex);
1468 if (!rule->removed) {
1469 /* Make sure there is no postponed removal of the rule. */
1470 ovs_assert(cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
1472 if (!classifier_remove(&rule->ofproto->tables[rule->table_id].cls,
1476 ofproto_rule_remove__(rule->ofproto, rule);
1477 ofproto->ofproto_class->rule_delete(rule);
1478 ofproto_rule_unref(rule);
1480 ovs_mutex_unlock(&ofproto_mutex);
1484 ofproto_flush__(struct ofproto *ofproto)
1485 OVS_EXCLUDED(ofproto_mutex)
1487 struct oftable *table;
1489 /* This will flush all datapath flows. */
1490 if (ofproto->ofproto_class->flush) {
1491 ofproto->ofproto_class->flush(ofproto);
1494 /* XXX: There is a small race window here, where new datapath flows can be
1495 * created by upcall handlers based on the existing flow table. We can not
1496 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1497 * as then we could deadlock on syncing with the handler threads waiting on
1498 * the same mutex. */
1500 ovs_mutex_lock(&ofproto_mutex);
1501 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1502 struct rule_collection rules;
1505 if (table->flags & OFTABLE_HIDDEN) {
1509 rule_collection_init(&rules);
1511 CLS_FOR_EACH (rule, cr, &table->cls) {
1512 rule_collection_add(&rules, rule);
1514 delete_flows__(&rules, OFPRR_DELETE, NULL);
1516 /* XXX: Concurrent handler threads may insert new learned flows based on
1517 * learn actions of the now deleted flows right after we release
1518 * 'ofproto_mutex'. */
1519 ovs_mutex_unlock(&ofproto_mutex);
1522 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1525 ofproto_destroy__(struct ofproto *ofproto)
1526 OVS_EXCLUDED(ofproto_mutex)
1528 struct oftable *table;
1530 destroy_rule_executes(ofproto);
1532 guarded_list_destroy(&ofproto->rule_executes);
1533 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1534 hmap_destroy(&ofproto->groups);
1536 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1537 free(ofproto->name);
1538 free(ofproto->type);
1539 free(ofproto->mfr_desc);
1540 free(ofproto->hw_desc);
1541 free(ofproto->sw_desc);
1542 free(ofproto->serial_desc);
1543 free(ofproto->dp_desc);
1544 hmap_destroy(&ofproto->ports);
1545 hmap_destroy(&ofproto->ofport_usage);
1546 shash_destroy(&ofproto->port_by_name);
1547 simap_destroy(&ofproto->ofp_requests);
1549 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1550 oftable_destroy(table);
1552 free(ofproto->tables);
1554 ovs_assert(hindex_is_empty(&ofproto->cookies));
1555 hindex_destroy(&ofproto->cookies);
1557 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1558 hmap_destroy(&ofproto->learned_cookies);
1560 free(ofproto->vlan_bitmap);
1562 ofproto->ofproto_class->dealloc(ofproto);
1565 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1566 * - 1st we defer the removal of the rules from the classifier
1567 * - 2nd we defer the actual destruction of the rules. */
1569 ofproto_destroy_defer__(struct ofproto *ofproto)
1570 OVS_EXCLUDED(ofproto_mutex)
1572 ovsrcu_postpone(ofproto_destroy__, ofproto);
1576 ofproto_destroy(struct ofproto *p, bool del)
1577 OVS_EXCLUDED(ofproto_mutex)
1579 struct ofport *ofport, *next_ofport;
1580 struct ofport_usage *usage, *next_usage;
1587 meter_delete(p, 1, p->meter_features.max_meters);
1588 p->meter_features.max_meters = 0;
1594 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1595 ofport_destroy(ofport, del);
1598 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1599 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1603 p->ofproto_class->destruct(p);
1605 /* We should not postpone this because it involves deleting a listening
1606 * socket which we may want to reopen soon. 'connmgr' should not be used
1607 * by other threads */
1608 connmgr_destroy(p->connmgr);
1610 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1611 ovsrcu_postpone(ofproto_destroy_defer__, p);
1614 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1615 * kernel datapath, for example, this destroys the datapath in the kernel, and
1616 * with the netdev-based datapath, it tears down the data structures that
1617 * represent the datapath.
1619 * The datapath should not be currently open as an ofproto. */
1621 ofproto_delete(const char *name, const char *type)
1623 const struct ofproto_class *class = ofproto_class_find__(type);
1624 return (!class ? EAFNOSUPPORT
1625 : !class->del ? EACCES
1626 : class->del(type, name));
1630 process_port_change(struct ofproto *ofproto, int error, char *devname)
1632 if (error == ENOBUFS) {
1633 reinit_ports(ofproto);
1634 } else if (!error) {
1635 update_port(ofproto, devname);
1641 ofproto_type_run(const char *datapath_type)
1643 const struct ofproto_class *class;
1646 datapath_type = ofproto_normalize_type(datapath_type);
1647 class = ofproto_class_find__(datapath_type);
1649 error = class->type_run ? class->type_run(datapath_type) : 0;
1650 if (error && error != EAGAIN) {
1651 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1652 datapath_type, ovs_strerror(error));
1658 ofproto_type_wait(const char *datapath_type)
1660 const struct ofproto_class *class;
1662 datapath_type = ofproto_normalize_type(datapath_type);
1663 class = ofproto_class_find__(datapath_type);
1665 if (class->type_wait) {
1666 class->type_wait(datapath_type);
1671 ofproto_run(struct ofproto *p)
1676 error = p->ofproto_class->run(p);
1677 if (error && error != EAGAIN) {
1678 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1681 run_rule_executes(p);
1683 /* Restore the eviction group heap invariant occasionally. */
1684 if (p->eviction_group_timer < time_msec()) {
1687 p->eviction_group_timer = time_msec() + 1000;
1689 for (i = 0; i < p->n_tables; i++) {
1690 struct oftable *table = &p->tables[i];
1691 struct eviction_group *evg;
1694 if (!table->eviction) {
1698 if (table->n_flows > 100000) {
1699 static struct vlog_rate_limit count_rl =
1700 VLOG_RATE_LIMIT_INIT(1, 1);
1701 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1702 " number of rules: %d", i, table->n_flows);
1705 ovs_mutex_lock(&ofproto_mutex);
1706 CLS_FOR_EACH (rule, cr, &table->cls) {
1707 if (rule->idle_timeout || rule->hard_timeout) {
1708 if (!rule->eviction_group) {
1709 eviction_group_add_rule(rule);
1711 heap_raw_change(&rule->evg_node,
1712 rule_eviction_priority(p, rule));
1717 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1718 heap_rebuild(&evg->rules);
1720 ovs_mutex_unlock(&ofproto_mutex);
1724 if (p->ofproto_class->port_poll) {
1727 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1728 process_port_change(p, error, devname);
1732 new_seq = seq_read(connectivity_seq_get());
1733 if (new_seq != p->change_seq) {
1734 struct sset devnames;
1735 const char *devname;
1736 struct ofport *ofport;
1738 /* Update OpenFlow port status for any port whose netdev has changed.
1740 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1741 * destroyed, so it's not safe to update ports directly from the
1742 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1743 * need this two-phase approach. */
1744 sset_init(&devnames);
1745 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1746 uint64_t port_change_seq;
1748 port_change_seq = netdev_get_change_seq(ofport->netdev);
1749 if (ofport->change_seq != port_change_seq) {
1750 ofport->change_seq = port_change_seq;
1751 sset_add(&devnames, netdev_get_name(ofport->netdev));
1754 SSET_FOR_EACH (devname, &devnames) {
1755 update_port(p, devname);
1757 sset_destroy(&devnames);
1759 p->change_seq = new_seq;
1762 connmgr_run(p->connmgr, handle_openflow);
1768 ofproto_wait(struct ofproto *p)
1770 p->ofproto_class->wait(p);
1771 if (p->ofproto_class->port_poll_wait) {
1772 p->ofproto_class->port_poll_wait(p);
1774 seq_wait(connectivity_seq_get(), p->change_seq);
1775 connmgr_wait(p->connmgr);
1779 ofproto_is_alive(const struct ofproto *p)
1781 return connmgr_has_controllers(p->connmgr);
1784 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1785 * memory_report(). */
1787 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1789 const struct oftable *table;
1790 unsigned int n_rules;
1792 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1795 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1796 n_rules += table->n_flows;
1798 simap_increase(usage, "rules", n_rules);
1800 if (ofproto->ofproto_class->get_memory_usage) {
1801 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1804 connmgr_get_memory_usage(ofproto->connmgr, usage);
1808 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1810 const struct ofproto_class *class;
1812 datapath_type = ofproto_normalize_type(datapath_type);
1813 class = ofproto_class_find__(datapath_type);
1815 if (class && class->type_get_memory_usage) {
1816 class->type_get_memory_usage(datapath_type, usage);
1821 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1824 connmgr_get_controller_info(ofproto->connmgr, info);
1828 ofproto_free_ofproto_controller_info(struct shash *info)
1830 connmgr_free_controller_info(info);
1833 /* Makes a deep copy of 'old' into 'port'. */
1835 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1837 port->name = xstrdup(old->name);
1838 port->type = xstrdup(old->type);
1839 port->ofp_port = old->ofp_port;
1842 /* Frees memory allocated to members of 'ofproto_port'.
1844 * Do not call this function on an ofproto_port obtained from
1845 * ofproto_port_dump_next(): that function retains ownership of the data in the
1848 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1850 free(ofproto_port->name);
1851 free(ofproto_port->type);
1854 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1856 * This function provides no status indication. An error status for the entire
1857 * dump operation is provided when it is completed by calling
1858 * ofproto_port_dump_done().
1861 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1862 const struct ofproto *ofproto)
1864 dump->ofproto = ofproto;
1865 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1869 /* Attempts to retrieve another port from 'dump', which must have been created
1870 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1871 * 'port' and returns true. On failure, returns false.
1873 * Failure might indicate an actual error or merely that the last port has been
1874 * dumped. An error status for the entire dump operation is provided when it
1875 * is completed by calling ofproto_port_dump_done().
1877 * The ofproto owns the data stored in 'port'. It will remain valid until at
1878 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1879 * ofproto_port_dump_done(). */
1881 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1882 struct ofproto_port *port)
1884 const struct ofproto *ofproto = dump->ofproto;
1890 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1893 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1899 /* Completes port table dump operation 'dump', which must have been created
1900 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1901 * error-free, otherwise a positive errno value describing the problem. */
1903 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1905 const struct ofproto *ofproto = dump->ofproto;
1907 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1910 return dump->error == EOF ? 0 : dump->error;
1913 /* Returns the type to pass to netdev_open() when a datapath of type
1914 * 'datapath_type' has a port of type 'port_type', for a few special
1915 * cases when a netdev type differs from a port type. For example, when
1916 * using the userspace datapath, a port of type "internal" needs to be
1919 * Returns either 'type' itself or a string literal, which must not be
1922 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1924 const struct ofproto_class *class;
1926 datapath_type = ofproto_normalize_type(datapath_type);
1927 class = ofproto_class_find__(datapath_type);
1932 return (class->port_open_type
1933 ? class->port_open_type(datapath_type, port_type)
1937 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1938 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1939 * the port's OpenFlow port number.
1941 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1942 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1943 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1944 * 'ofp_portp' is non-null). */
1946 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1947 ofp_port_t *ofp_portp)
1949 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1952 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1954 const char *netdev_name = netdev_get_name(netdev);
1956 simap_put(&ofproto->ofp_requests, netdev_name,
1957 ofp_to_u16(ofp_port));
1958 error = update_port(ofproto, netdev_name);
1961 *ofp_portp = OFPP_NONE;
1963 struct ofproto_port ofproto_port;
1965 error = ofproto_port_query_by_name(ofproto,
1966 netdev_get_name(netdev),
1969 *ofp_portp = ofproto_port.ofp_port;
1970 ofproto_port_destroy(&ofproto_port);
1977 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1978 * initializes '*port' appropriately; on failure, returns a positive errno
1981 * The caller owns the data in 'ofproto_port' and must free it with
1982 * ofproto_port_destroy() when it is no longer needed. */
1984 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1985 struct ofproto_port *port)
1989 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1991 memset(port, 0, sizeof *port);
1996 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1997 * Returns 0 if successful, otherwise a positive errno. */
1999 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
2001 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2002 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
2003 struct simap_node *ofp_request_node;
2006 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
2007 if (ofp_request_node) {
2008 simap_delete(&ofproto->ofp_requests, ofp_request_node);
2011 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
2012 if (!error && ofport) {
2013 /* 'name' is the netdev's name and update_port() is going to close the
2014 * netdev. Just in case update_port() refers to 'name' after it
2015 * destroys 'ofport', make a copy of it around the update_port()
2017 char *devname = xstrdup(name);
2018 update_port(ofproto, devname);
2025 flow_mod_init(struct ofputil_flow_mod *fm,
2026 const struct match *match, int priority,
2027 const struct ofpact *ofpacts, size_t ofpacts_len,
2028 enum ofp_flow_mod_command command)
2030 *fm = (struct ofputil_flow_mod) {
2032 .priority = priority,
2035 .buffer_id = UINT32_MAX,
2036 .out_port = OFPP_ANY,
2037 .out_group = OFPG_ANY,
2038 .ofpacts = CONST_CAST(struct ofpact *, ofpacts),
2039 .ofpacts_len = ofpacts_len,
2040 .delete_reason = OFPRR_DELETE,
2045 simple_flow_mod(struct ofproto *ofproto,
2046 const struct match *match, int priority,
2047 const struct ofpact *ofpacts, size_t ofpacts_len,
2048 enum ofp_flow_mod_command command)
2050 struct ofproto_flow_mod ofm;
2052 flow_mod_init(&ofm.fm, match, priority, ofpacts, ofpacts_len, command);
2054 return handle_flow_mod__(ofproto, &ofm, NULL);
2057 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2058 * performs the 'n_actions' actions in 'actions'. The new flow will not
2061 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2062 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2063 * controllers; otherwise, it will be hidden.
2065 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2067 * This is a helper function for in-band control and fail-open. */
2069 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2071 const struct ofpact *ofpacts, size_t ofpacts_len)
2072 OVS_EXCLUDED(ofproto_mutex)
2074 const struct rule *rule;
2077 /* First do a cheap check whether the rule we're looking for already exists
2078 * with the actions that we want. If it does, then we're done. */
2079 rule = rule_from_cls_rule(classifier_find_match_exactly(
2080 &ofproto->tables[0].cls, match, priority,
2083 const struct rule_actions *actions = rule_get_actions(rule);
2084 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2085 ofpacts, ofpacts_len);
2090 /* If there's no such rule or the rule doesn't have the actions we want,
2091 * fall back to a executing a full flow mod. We can't optimize this at
2092 * all because we didn't take enough locks above to ensure that the flow
2093 * table didn't already change beneath us. */
2095 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2096 OFPFC_MODIFY_STRICT);
2100 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2101 * an OFPERR_* OpenFlow error code on failure.
2103 * This is a helper function for in-band control and fail-open and the "learn"
2106 ofproto_flow_mod(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
2107 OVS_EXCLUDED(ofproto_mutex)
2109 struct ofputil_flow_mod *fm = &ofm->fm;
2111 /* Optimize for the most common case of a repeated learn action.
2112 * If an identical flow already exists we only need to update its
2113 * 'modified' time. */
2114 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2115 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2116 struct oftable *table = &ofproto->tables[fm->table_id];
2120 rule = rule_from_cls_rule(classifier_find_match_exactly(
2121 &table->cls, &fm->match, fm->priority,
2124 /* Reading many of the rule fields and writing on 'modified'
2125 * requires the rule->mutex. Also, rule->actions may change
2126 * if rule->mutex is not held. */
2127 const struct rule_actions *actions;
2129 ovs_mutex_lock(&rule->mutex);
2130 actions = rule_get_actions(rule);
2131 if (rule->idle_timeout == fm->idle_timeout
2132 && rule->hard_timeout == fm->hard_timeout
2133 && rule->importance == fm->importance
2134 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2135 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2136 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2137 actions->ofpacts, actions->ofpacts_len)) {
2138 /* Rule already exists and need not change, only update the
2139 modified timestamp. */
2140 rule->modified = time_msec();
2143 ovs_mutex_unlock(&rule->mutex);
2151 return handle_flow_mod__(ofproto, ofm, NULL);
2154 /* Searches for a rule with matching criteria exactly equal to 'target' in
2155 * ofproto's table 0 and, if it finds one, deletes it.
2157 * This is a helper function for in-band control and fail-open. */
2159 ofproto_delete_flow(struct ofproto *ofproto,
2160 const struct match *target, int priority)
2161 OVS_EXCLUDED(ofproto_mutex)
2163 struct classifier *cls = &ofproto->tables[0].cls;
2166 /* First do a cheap check whether the rule we're looking for has already
2167 * been deleted. If so, then we're done. */
2168 rule = rule_from_cls_rule(classifier_find_match_exactly(
2169 cls, target, priority, CLS_MAX_VERSION));
2174 /* Execute a flow mod. We can't optimize this at all because we didn't
2175 * take enough locks above to ensure that the flow table didn't already
2176 * change beneath us. */
2177 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2180 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2181 * the flows required by in-band control and fail-open. */
2183 ofproto_flush_flows(struct ofproto *ofproto)
2185 COVERAGE_INC(ofproto_flush);
2186 ofproto_flush__(ofproto);
2187 connmgr_flushed(ofproto->connmgr);
2191 reinit_ports(struct ofproto *p)
2193 struct ofproto_port_dump dump;
2194 struct sset devnames;
2195 struct ofport *ofport;
2196 struct ofproto_port ofproto_port;
2197 const char *devname;
2199 COVERAGE_INC(ofproto_reinit_ports);
2201 sset_init(&devnames);
2202 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2203 sset_add(&devnames, netdev_get_name(ofport->netdev));
2205 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2206 sset_add(&devnames, ofproto_port.name);
2209 SSET_FOR_EACH (devname, &devnames) {
2210 update_port(p, devname);
2212 sset_destroy(&devnames);
2216 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2220 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2221 port_idx = port_idx ? port_idx : UINT16_MAX;
2223 if (port_idx >= ofproto->max_ports
2224 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2225 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2226 long long int last_used_at, lru = LLONG_MAX;
2228 /* Search for a free OpenFlow port number. We try not to
2229 * immediately reuse them to prevent problems due to old
2232 * We limit the automatically assigned port numbers to the lower half
2233 * of the port range, to reserve the upper half for assignment by
2236 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2237 ofproto->alloc_port_no = 1;
2239 last_used_at = ofport_get_usage(ofproto,
2240 u16_to_ofp(ofproto->alloc_port_no));
2241 if (!last_used_at) {
2242 port_idx = ofproto->alloc_port_no;
2244 } else if ( last_used_at < time_msec() - 60*60*1000) {
2245 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2246 * more than an hour ago, consider it usable. */
2247 ofport_remove_usage(ofproto,
2248 u16_to_ofp(ofproto->alloc_port_no));
2249 port_idx = ofproto->alloc_port_no;
2251 } else if (last_used_at < lru) {
2253 lru_ofport = ofproto->alloc_port_no;
2256 if (ofproto->alloc_port_no == end_port_no) {
2258 port_idx = lru_ofport;
2265 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2266 return u16_to_ofp(port_idx);
2270 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2272 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2273 ofport_set_usage(ofproto, ofp_port, time_msec());
2277 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2278 * pointer if the netdev cannot be opened. On success, also fills in
2280 static struct netdev *
2281 ofport_open(struct ofproto *ofproto,
2282 struct ofproto_port *ofproto_port,
2283 struct ofputil_phy_port *pp)
2285 enum netdev_flags flags;
2286 struct netdev *netdev;
2289 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2291 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2292 "cannot be opened (%s)",
2294 ofproto_port->name, ofproto_port->ofp_port,
2295 ofproto_port->name, ovs_strerror(error));
2299 if (ofproto_port->ofp_port == OFPP_NONE) {
2300 if (!strcmp(ofproto->name, ofproto_port->name)) {
2301 ofproto_port->ofp_port = OFPP_LOCAL;
2303 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2304 ofproto_port->name);
2307 pp->port_no = ofproto_port->ofp_port;
2308 netdev_get_etheraddr(netdev, &pp->hw_addr);
2309 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2310 netdev_get_flags(netdev, &flags);
2311 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2312 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2313 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2314 &pp->supported, &pp->peer);
2315 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2316 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2321 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2322 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2325 ofport_equal(const struct ofputil_phy_port *a,
2326 const struct ofputil_phy_port *b)
2328 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2329 && a->state == b->state
2330 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2331 && a->curr == b->curr
2332 && a->advertised == b->advertised
2333 && a->supported == b->supported
2334 && a->peer == b->peer
2335 && a->curr_speed == b->curr_speed
2336 && a->max_speed == b->max_speed);
2339 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2340 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2341 * one with the same name or port number). */
2343 ofport_install(struct ofproto *p,
2344 struct netdev *netdev, const struct ofputil_phy_port *pp)
2346 const char *netdev_name = netdev_get_name(netdev);
2347 struct ofport *ofport;
2350 /* Create ofport. */
2351 ofport = p->ofproto_class->port_alloc();
2356 ofport->ofproto = p;
2357 ofport->netdev = netdev;
2358 ofport->change_seq = netdev_get_change_seq(netdev);
2360 ofport->ofp_port = pp->port_no;
2361 ofport->created = time_msec();
2363 /* Add port to 'p'. */
2364 hmap_insert(&p->ports, &ofport->hmap_node,
2365 hash_ofp_port(ofport->ofp_port));
2366 shash_add(&p->port_by_name, netdev_name, ofport);
2368 update_mtu(p, ofport);
2370 /* Let the ofproto_class initialize its private data. */
2371 error = p->ofproto_class->port_construct(ofport);
2375 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2379 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2380 p->name, netdev_name, ovs_strerror(error));
2382 ofport_destroy__(ofport);
2384 netdev_close(netdev);
2389 /* Removes 'ofport' from 'p' and destroys it. */
2391 ofport_remove(struct ofport *ofport)
2393 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2395 ofport_destroy(ofport, true);
2398 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2401 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2403 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2405 ofport_remove(port);
2409 /* Updates 'port' with new 'pp' description.
2411 * Does not handle a name or port number change. The caller must implement
2412 * such a change as a delete followed by an add. */
2414 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2416 port->pp.hw_addr = pp->hw_addr;
2417 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2418 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2419 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2420 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2421 port->pp.curr = pp->curr;
2422 port->pp.advertised = pp->advertised;
2423 port->pp.supported = pp->supported;
2424 port->pp.peer = pp->peer;
2425 port->pp.curr_speed = pp->curr_speed;
2426 port->pp.max_speed = pp->max_speed;
2428 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2429 &port->pp, OFPPR_MODIFY);
2432 /* Update OpenFlow 'state' in 'port' and notify controller. */
2434 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2436 if (port->pp.state != state) {
2437 port->pp.state = state;
2438 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2439 &port->pp, OFPPR_MODIFY);
2444 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2446 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2448 if (port->ofproto->ofproto_class->set_realdev) {
2449 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2451 if (port->ofproto->ofproto_class->set_stp_port) {
2452 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2454 if (port->ofproto->ofproto_class->set_rstp_port) {
2455 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2457 if (port->ofproto->ofproto_class->set_cfm) {
2458 port->ofproto->ofproto_class->set_cfm(port, NULL);
2460 if (port->ofproto->ofproto_class->bundle_remove) {
2461 port->ofproto->ofproto_class->bundle_remove(port);
2467 ofport_destroy__(struct ofport *port)
2469 struct ofproto *ofproto = port->ofproto;
2470 const char *name = netdev_get_name(port->netdev);
2472 hmap_remove(&ofproto->ports, &port->hmap_node);
2473 shash_delete(&ofproto->port_by_name,
2474 shash_find(&ofproto->port_by_name, name));
2476 netdev_close(port->netdev);
2477 ofproto->ofproto_class->port_dealloc(port);
2481 ofport_destroy(struct ofport *port, bool del)
2484 dealloc_ofp_port(port->ofproto, port->ofp_port);
2485 port->ofproto->ofproto_class->port_destruct(port, del);
2486 ofport_destroy__(port);
2491 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2493 struct ofport *port;
2495 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2497 if (port->ofp_port == ofp_port) {
2504 static long long int
2505 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2507 struct ofport_usage *usage;
2509 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2510 &ofproto->ofport_usage) {
2511 if (usage->ofp_port == ofp_port) {
2512 return usage->last_used;
2519 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2520 long long int last_used)
2522 struct ofport_usage *usage;
2523 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2524 &ofproto->ofport_usage) {
2525 if (usage->ofp_port == ofp_port) {
2526 usage->last_used = last_used;
2530 ovs_assert(last_used == LLONG_MAX);
2532 usage = xmalloc(sizeof *usage);
2533 usage->ofp_port = ofp_port;
2534 usage->last_used = last_used;
2535 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2536 hash_ofp_port(ofp_port));
2540 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2542 struct ofport_usage *usage;
2543 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2544 &ofproto->ofport_usage) {
2545 if (usage->ofp_port == ofp_port) {
2546 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2554 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2556 struct ofproto *ofproto = port->ofproto;
2559 if (ofproto->ofproto_class->port_get_stats) {
2560 error = ofproto->ofproto_class->port_get_stats(port, stats);
2569 update_port(struct ofproto *ofproto, const char *name)
2571 struct ofproto_port ofproto_port;
2572 struct ofputil_phy_port pp;
2573 struct netdev *netdev;
2574 struct ofport *port;
2577 COVERAGE_INC(ofproto_update_port);
2579 /* Fetch 'name''s location and properties from the datapath. */
2580 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2581 ? ofport_open(ofproto, &ofproto_port, &pp)
2585 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2586 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2587 struct netdev *old_netdev = port->netdev;
2589 /* 'name' hasn't changed location. Any properties changed? */
2590 if (!ofport_equal(&port->pp, &pp)) {
2591 ofport_modified(port, &pp);
2594 update_mtu(ofproto, port);
2596 /* Install the newly opened netdev in case it has changed.
2597 * Don't close the old netdev yet in case port_modified has to
2598 * remove a retained reference to it.*/
2599 port->netdev = netdev;
2600 port->change_seq = netdev_get_change_seq(netdev);
2602 if (port->ofproto->ofproto_class->port_modified) {
2603 port->ofproto->ofproto_class->port_modified(port);
2606 netdev_close(old_netdev);
2608 /* If 'port' is nonnull then its name differs from 'name' and thus
2609 * we should delete it. If we think there's a port named 'name'
2610 * then its port number must be wrong now so delete it too. */
2612 ofport_remove(port);
2614 ofport_remove_with_name(ofproto, name);
2615 error = ofport_install(ofproto, netdev, &pp);
2618 /* Any port named 'name' is gone now. */
2619 ofport_remove_with_name(ofproto, name);
2621 ofproto_port_destroy(&ofproto_port);
2627 init_ports(struct ofproto *p)
2629 struct ofproto_port_dump dump;
2630 struct ofproto_port ofproto_port;
2631 struct shash_node *node, *next;
2633 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2634 const char *name = ofproto_port.name;
2636 if (shash_find(&p->port_by_name, name)) {
2637 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2640 struct ofputil_phy_port pp;
2641 struct netdev *netdev;
2643 /* Check if an OpenFlow port number had been requested. */
2644 node = shash_find(&init_ofp_ports, name);
2646 const struct iface_hint *iface_hint = node->data;
2647 simap_put(&p->ofp_requests, name,
2648 ofp_to_u16(iface_hint->ofp_port));
2651 netdev = ofport_open(p, &ofproto_port, &pp);
2653 ofport_install(p, netdev, &pp);
2654 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2655 p->alloc_port_no = MAX(p->alloc_port_no,
2656 ofp_to_u16(ofproto_port.ofp_port));
2662 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2663 struct iface_hint *iface_hint = node->data;
2665 if (!strcmp(iface_hint->br_name, p->name)) {
2666 free(iface_hint->br_name);
2667 free(iface_hint->br_type);
2669 shash_delete(&init_ofp_ports, node);
2676 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2677 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2679 find_min_mtu(struct ofproto *p)
2681 struct ofport *ofport;
2684 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2685 struct netdev *netdev = ofport->netdev;
2688 /* Skip any internal ports, since that's what we're trying to
2690 if (!strcmp(netdev_get_type(netdev), "internal")) {
2694 if (netdev_get_mtu(netdev, &dev_mtu)) {
2697 if (!mtu || dev_mtu < mtu) {
2702 return mtu ? mtu: ETH_PAYLOAD_MAX;
2705 /* Update MTU of all datapath devices on 'p' to the minimum of the
2706 * non-datapath ports in event of 'port' added or changed. */
2708 update_mtu(struct ofproto *p, struct ofport *port)
2710 struct ofport *ofport;
2711 struct netdev *netdev = port->netdev;
2712 int dev_mtu, old_min;
2714 if (netdev_get_mtu(netdev, &dev_mtu)) {
2718 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2719 if (dev_mtu > p->min_mtu) {
2720 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2721 dev_mtu = p->min_mtu;
2724 port->mtu = dev_mtu;
2728 /* For non-internal port find new min mtu. */
2729 old_min = p->min_mtu;
2730 port->mtu = dev_mtu;
2731 p->min_mtu = find_min_mtu(p);
2732 if (p->min_mtu == old_min) {
2736 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2737 struct netdev *netdev = ofport->netdev;
2739 if (!strcmp(netdev_get_type(netdev), "internal")) {
2740 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2741 ofport->mtu = p->min_mtu;
2748 ofproto_rule_destroy__(struct rule *rule)
2749 OVS_NO_THREAD_SAFETY_ANALYSIS
2751 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2752 rule_actions_destroy(rule_get_actions(rule));
2753 ovs_mutex_destroy(&rule->mutex);
2754 rule->ofproto->ofproto_class->rule_dealloc(rule);
2758 rule_destroy_cb(struct rule *rule)
2759 OVS_NO_THREAD_SAFETY_ANALYSIS
2761 /* Send rule removed if needed. */
2762 if (rule->flags & OFPUTIL_FF_SEND_FLOW_REM
2763 && rule->removed_reason != OVS_OFPRR_NONE
2764 && !rule_is_hidden(rule)) {
2765 ofproto_rule_send_removed(rule);
2767 rule->ofproto->ofproto_class->rule_destruct(rule);
2768 ofproto_rule_destroy__(rule);
2772 ofproto_rule_ref(struct rule *rule)
2775 ovs_refcount_ref(&rule->ref_count);
2780 ofproto_rule_try_ref(struct rule *rule)
2783 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2788 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2789 * ref_count reaches 0.
2791 * Use of RCU allows short term use (between RCU quiescent periods) without
2792 * keeping a reference. A reference must be taken if the rule needs to
2793 * stay around accross the RCU quiescent periods. */
2795 ofproto_rule_unref(struct rule *rule)
2797 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2798 ovsrcu_postpone(rule_destroy_cb, rule);
2803 remove_rule_rcu__(struct rule *rule)
2804 OVS_REQUIRES(ofproto_mutex)
2806 struct ofproto *ofproto = rule->ofproto;
2807 struct oftable *table = &ofproto->tables[rule->table_id];
2809 ovs_assert(!cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
2810 if (!classifier_remove(&table->cls, &rule->cr)) {
2813 ofproto->ofproto_class->rule_delete(rule);
2814 ofproto_rule_unref(rule);
2818 remove_rule_rcu(struct rule *rule)
2819 OVS_EXCLUDED(ofproto_mutex)
2821 ovs_mutex_lock(&ofproto_mutex);
2822 remove_rule_rcu__(rule);
2823 ovs_mutex_unlock(&ofproto_mutex);
2826 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2828 remove_rules_rcu(struct rule **rules)
2829 OVS_EXCLUDED(ofproto_mutex)
2831 struct rule **orig_rules = rules;
2834 struct ofproto *ofproto = rules[0]->ofproto;
2835 unsigned long tables[BITMAP_N_LONGS(256)];
2839 memset(tables, 0, sizeof tables);
2841 ovs_mutex_lock(&ofproto_mutex);
2842 while ((rule = *rules++)) {
2843 /* Defer once for each new table. This defers the subtable cleanup
2844 * until later, so that when removing large number of flows the
2845 * operation is faster. */
2846 if (!bitmap_is_set(tables, rule->table_id)) {
2847 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
2849 bitmap_set1(tables, rule->table_id);
2850 classifier_defer(cls);
2852 remove_rule_rcu__(rule);
2855 BITMAP_FOR_EACH_1(table_id, 256, tables) {
2856 struct classifier *cls = &ofproto->tables[table_id].cls;
2858 classifier_publish(cls);
2860 ovs_mutex_unlock(&ofproto_mutex);
2867 ofproto_group_ref(struct ofgroup *group)
2870 ovs_refcount_ref(&group->ref_count);
2875 ofproto_group_unref(struct ofgroup *group)
2877 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2878 group->ofproto->ofproto_class->group_destruct(group);
2879 ofputil_bucket_list_destroy(&group->buckets);
2880 group->ofproto->ofproto_class->group_dealloc(group);
2884 static uint32_t get_provider_meter_id(const struct ofproto *,
2885 uint32_t of_meter_id);
2887 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2888 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2889 const struct rule_actions *
2890 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2892 struct rule_actions *actions;
2894 actions = xmalloc(sizeof *actions + ofpacts_len);
2895 actions->ofpacts_len = ofpacts_len;
2896 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2897 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2899 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2905 /* Free the actions after the RCU quiescent period is reached. */
2907 rule_actions_destroy(const struct rule_actions *actions)
2910 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2914 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2915 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2917 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2918 OVS_REQUIRES(ofproto_mutex)
2920 if (port == OFPP_ANY) {
2923 const struct rule_actions *actions = rule_get_actions(rule);
2924 return ofpacts_output_to_port(actions->ofpacts,
2925 actions->ofpacts_len, port);
2929 /* Returns true if 'rule' has group and equals group_id. */
2931 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2932 OVS_REQUIRES(ofproto_mutex)
2934 if (group_id == OFPG_ANY) {
2937 const struct rule_actions *actions = rule_get_actions(rule);
2938 return ofpacts_output_to_group(actions->ofpacts,
2939 actions->ofpacts_len, group_id);
2944 rule_execute_destroy(struct rule_execute *e)
2946 ofproto_rule_unref(e->rule);
2947 list_remove(&e->list_node);
2951 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2952 * by passing them to the ofproto provider. */
2954 run_rule_executes(struct ofproto *ofproto)
2955 OVS_EXCLUDED(ofproto_mutex)
2957 struct rule_execute *e, *next;
2958 struct ovs_list executes;
2960 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2961 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2964 flow_extract(e->packet, &flow);
2965 flow.in_port.ofp_port = e->in_port;
2966 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2968 rule_execute_destroy(e);
2972 /* Destroys and discards all "rule_execute" operations queued up in
2973 * ofproto->rule_executes. */
2975 destroy_rule_executes(struct ofproto *ofproto)
2977 struct rule_execute *e, *next;
2978 struct ovs_list executes;
2980 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2981 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2982 dp_packet_delete(e->packet);
2983 rule_execute_destroy(e);
2988 rule_is_readonly(const struct rule *rule)
2990 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2991 return (table->flags & OFTABLE_READONLY) != 0;
2995 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2997 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2998 return hash_3words(cookie, cookie >> 32, table_id);
3002 learned_cookies_update_one__(struct ofproto *ofproto,
3003 const struct ofpact_learn *learn,
3004 int delta, struct ovs_list *dead_cookies)
3005 OVS_REQUIRES(ofproto_mutex)
3007 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
3008 struct learned_cookie *c;
3010 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
3011 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
3013 ovs_assert(c->n >= 0);
3016 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
3017 list_push_back(dead_cookies, &c->u.list_node);
3024 ovs_assert(delta > 0);
3025 c = xmalloc(sizeof *c);
3026 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
3027 c->cookie = learn->cookie;
3028 c->table_id = learn->table_id;
3032 static const struct ofpact_learn *
3033 next_learn_with_delete(const struct rule_actions *actions,
3034 const struct ofpact_learn *start)
3036 const struct ofpact *pos;
3038 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
3039 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
3040 pos = ofpact_next(pos)) {
3041 if (pos->type == OFPACT_LEARN) {
3042 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
3043 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3053 learned_cookies_update__(struct ofproto *ofproto,
3054 const struct rule_actions *actions,
3055 int delta, struct ovs_list *dead_cookies)
3056 OVS_REQUIRES(ofproto_mutex)
3058 if (actions->has_learn_with_delete) {
3059 const struct ofpact_learn *learn;
3061 for (learn = next_learn_with_delete(actions, NULL); learn;
3062 learn = next_learn_with_delete(actions, learn)) {
3063 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3069 learned_cookies_inc(struct ofproto *ofproto,
3070 const struct rule_actions *actions)
3071 OVS_REQUIRES(ofproto_mutex)
3073 learned_cookies_update__(ofproto, actions, +1, NULL);
3077 learned_cookies_dec(struct ofproto *ofproto,
3078 const struct rule_actions *actions,
3079 struct ovs_list *dead_cookies)
3080 OVS_REQUIRES(ofproto_mutex)
3082 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3086 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3087 OVS_REQUIRES(ofproto_mutex)
3089 struct learned_cookie *c;
3091 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3092 struct rule_criteria criteria;
3093 struct rule_collection rules;
3096 match_init_catchall(&match);
3097 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3098 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3099 rule_criteria_require_rw(&criteria, false);
3100 collect_rules_loose(ofproto, &criteria, &rules);
3101 rule_criteria_destroy(&criteria);
3102 delete_flows__(&rules, OFPRR_DELETE, NULL);
3109 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3111 ofconn_send_reply(ofconn, make_echo_reply(oh));
3116 query_tables(struct ofproto *ofproto,
3117 struct ofputil_table_features **featuresp,
3118 struct ofputil_table_stats **statsp)
3120 struct mf_bitmap rw_fields = oxm_writable_fields();
3121 struct mf_bitmap match = oxm_matchable_fields();
3122 struct mf_bitmap mask = oxm_maskable_fields();
3124 struct ofputil_table_features *features;
3125 struct ofputil_table_stats *stats;
3128 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3129 for (i = 0; i < ofproto->n_tables; i++) {
3130 struct ofputil_table_features *f = &features[i];
3133 sprintf(f->name, "table%d", i);
3134 f->metadata_match = OVS_BE64_MAX;
3135 f->metadata_write = OVS_BE64_MAX;
3136 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3137 f->max_entries = 1000000;
3139 bool more_tables = false;
3140 for (int j = i + 1; j < ofproto->n_tables; j++) {
3141 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3142 bitmap_set1(f->nonmiss.next, j);
3146 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3148 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3150 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3151 f->nonmiss.write.set_fields = rw_fields;
3152 f->nonmiss.apply = f->nonmiss.write;
3153 f->miss = f->nonmiss;
3157 f->wildcard = match;
3161 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3162 for (i = 0; i < ofproto->n_tables; i++) {
3163 struct ofputil_table_stats *s = &stats[i];
3166 s->active_count = ofproto->tables[i].n_flows;
3168 s->active_count -= connmgr_count_hidden_rules(
3176 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3178 for (i = 0; i < ofproto->n_tables; i++) {
3179 const struct oftable *table = &ofproto->tables[i];
3180 struct ofputil_table_features *f = &features[i];
3183 ovs_strzcpy(f->name, table->name, sizeof f->name);
3186 if (table->max_flows < f->max_entries) {
3187 f->max_entries = table->max_flows;
3193 query_switch_features(struct ofproto *ofproto,
3194 bool *arp_match_ip, uint64_t *ofpacts)
3196 struct ofputil_table_features *features, *f;
3198 *arp_match_ip = false;
3201 query_tables(ofproto, &features, NULL);
3202 for (f = features; f < &features[ofproto->n_tables]; f++) {
3203 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3204 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3205 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3206 *arp_match_ip = true;
3212 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3216 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3218 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3219 struct ofputil_switch_features features;
3220 struct ofport *port;
3224 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3226 features.datapath_id = ofproto->datapath_id;
3227 features.n_buffers = pktbuf_capacity();
3228 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3229 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3230 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3231 OFPUTIL_C_GROUP_STATS);
3233 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3235 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3236 features.auxiliary_id = 0;
3237 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3239 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3240 ofputil_put_switch_features_port(&port->pp, b);
3243 ofconn_send_reply(ofconn, b);
3248 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3250 struct ofputil_switch_config config;
3251 config.frag = ofconn_get_ofproto(ofconn)->frag_handling;
3252 config.invalid_ttl_to_controller
3253 = ofconn_get_invalid_ttl_to_controller(ofconn);
3254 config.miss_send_len = ofconn_get_miss_send_len(ofconn);
3256 ofconn_send_reply(ofconn, ofputil_encode_get_config_reply(oh, &config));
3262 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3264 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3265 struct ofputil_switch_config config;
3268 error = ofputil_decode_set_config(oh, &config);
3273 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3274 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3275 enum ofputil_frag_handling cur = ofproto->frag_handling;
3276 enum ofputil_frag_handling next = config.frag;
3279 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3280 ofproto->frag_handling = next;
3282 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3284 ofputil_frag_handling_to_string(next));
3289 if (config.invalid_ttl_to_controller >= 0) {
3290 ofconn_set_invalid_ttl_to_controller(ofconn,
3291 config.invalid_ttl_to_controller);
3294 ofconn_set_miss_send_len(ofconn, config.miss_send_len);
3299 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3300 * error message code for the caller to propagate upward. Otherwise, returns
3303 * The log message mentions 'msg_type'. */
3305 reject_slave_controller(struct ofconn *ofconn)
3307 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3308 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3309 return OFPERR_OFPBRC_IS_SLAVE;
3315 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3318 * - If they use a meter, then 'ofproto' has that meter configured.
3320 * - If they use any groups, then 'ofproto' has that group configured.
3322 * Returns 0 if successful, otherwise an OpenFlow error. */
3324 ofproto_check_ofpacts(struct ofproto *ofproto,
3325 const struct ofpact ofpacts[], size_t ofpacts_len)
3327 const struct ofpact *a;
3330 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3331 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3332 return OFPERR_OFPMMFC_INVALID_METER;
3335 OFPACT_FOR_EACH_FLATTENED (a, ofpacts, ofpacts_len) {
3336 if (a->type == OFPACT_GROUP
3337 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3338 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3346 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3348 struct ofproto *p = ofconn_get_ofproto(ofconn);
3349 struct ofputil_packet_out po;
3350 struct dp_packet *payload;
3351 uint64_t ofpacts_stub[1024 / 8];
3352 struct ofpbuf ofpacts;
3356 COVERAGE_INC(ofproto_packet_out);
3358 error = reject_slave_controller(ofconn);
3363 /* Decode message. */
3364 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3365 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3367 goto exit_free_ofpacts;
3369 if (ofp_to_u16(po.in_port) >= p->max_ports
3370 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3371 error = OFPERR_OFPBRC_BAD_PORT;
3372 goto exit_free_ofpacts;
3376 if (po.buffer_id != UINT32_MAX) {
3377 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3379 goto exit_free_ofpacts;
3382 /* Ensure that the L3 header is 32-bit aligned. */
3383 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3386 /* Verify actions against packet, then send packet if successful. */
3387 flow_extract(payload, &flow);
3388 flow.in_port.ofp_port = po.in_port;
3390 /* Check actions like for flow mods. We pass a 'table_id' of 0 to
3391 * ofproto_check_consistency(), which isn't strictly correct because these
3392 * actions aren't in any table. This is OK as 'table_id' is only used to
3393 * check instructions (e.g., goto-table), which can't appear on the action
3394 * list of a packet-out. */
3395 error = ofpacts_check_consistency(po.ofpacts, po.ofpacts_len,
3396 &flow, u16_to_ofp(p->max_ports),
3398 ofconn_get_protocol(ofconn));
3400 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3402 error = p->ofproto_class->packet_out(p, payload, &flow,
3403 po.ofpacts, po.ofpacts_len);
3406 dp_packet_delete(payload);
3409 ofpbuf_uninit(&ofpacts);
3415 update_port_config(struct ofconn *ofconn, struct ofport *port,
3416 enum ofputil_port_config config,
3417 enum ofputil_port_config mask)
3419 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3421 if (toggle & OFPUTIL_PC_PORT_DOWN
3422 && (config & OFPUTIL_PC_PORT_DOWN
3423 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3424 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3425 /* We tried to bring the port up or down, but it failed, so don't
3426 * update the "down" bit. */
3427 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3431 enum ofputil_port_config old_config = port->pp.config;
3432 port->pp.config ^= toggle;
3433 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3434 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3440 port_mod_start(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3441 struct ofport **port)
3443 struct ofproto *p = ofconn_get_ofproto(ofconn);
3445 *port = ofproto_get_port(p, pm->port_no);
3447 return OFPERR_OFPPMFC_BAD_PORT;
3449 if (!eth_addr_equals((*port)->pp.hw_addr, pm->hw_addr)) {
3450 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3456 port_mod_finish(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3457 struct ofport *port)
3459 update_port_config(ofconn, port, pm->config, pm->mask);
3460 if (pm->advertise) {
3461 netdev_set_advertisements(port->netdev, pm->advertise);
3466 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3468 struct ofputil_port_mod pm;
3469 struct ofport *port;
3472 error = reject_slave_controller(ofconn);
3477 error = ofputil_decode_port_mod(oh, &pm, false);
3482 error = port_mod_start(ofconn, &pm, &port);
3484 port_mod_finish(ofconn, &pm, port);
3490 handle_desc_stats_request(struct ofconn *ofconn,
3491 const struct ofp_header *request)
3493 static const char *default_mfr_desc = "Nicira, Inc.";
3494 static const char *default_hw_desc = "Open vSwitch";
3495 static const char *default_sw_desc = VERSION;
3496 static const char *default_serial_desc = "None";
3497 static const char *default_dp_desc = "None";
3499 struct ofproto *p = ofconn_get_ofproto(ofconn);
3500 struct ofp_desc_stats *ods;
3503 msg = ofpraw_alloc_stats_reply(request, 0);
3504 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3505 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3506 sizeof ods->mfr_desc);
3507 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3508 sizeof ods->hw_desc);
3509 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3510 sizeof ods->sw_desc);
3511 ovs_strlcpy(ods->serial_num,
3512 p->serial_desc ? p->serial_desc : default_serial_desc,
3513 sizeof ods->serial_num);
3514 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3515 sizeof ods->dp_desc);
3516 ofconn_send_reply(ofconn, msg);
3522 handle_table_stats_request(struct ofconn *ofconn,
3523 const struct ofp_header *request)
3525 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3526 struct ofputil_table_features *features;
3527 struct ofputil_table_stats *stats;
3528 struct ofpbuf *reply;
3531 query_tables(ofproto, &features, &stats);
3533 reply = ofputil_encode_table_stats_reply(request);
3534 for (i = 0; i < ofproto->n_tables; i++) {
3535 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3536 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3539 ofconn_send_reply(ofconn, reply);
3548 handle_table_features_request(struct ofconn *ofconn,
3549 const struct ofp_header *request)
3551 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3552 struct ofputil_table_features *features;
3553 struct ovs_list replies;
3557 ofpbuf_use_const(&msg, request, ntohs(request->length));
3558 ofpraw_pull_assert(&msg);
3559 if (msg.size || ofpmp_more(request)) {
3560 return OFPERR_OFPTFFC_EPERM;
3563 query_tables(ofproto, &features, NULL);
3565 ofpmp_init(&replies, request);
3566 for (i = 0; i < ofproto->n_tables; i++) {
3567 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3568 ofputil_append_table_features_reply(&features[i], &replies);
3571 ofconn_send_replies(ofconn, &replies);
3579 query_table_desc__(struct ofputil_table_desc *td,
3580 struct ofproto *ofproto, uint8_t table_id)
3582 unsigned int count = ofproto->tables[table_id].n_flows;
3583 unsigned int max_flows = ofproto->tables[table_id].max_flows;
3585 td->table_id = table_id;
3586 td->eviction = (ofproto->tables[table_id].eviction & EVICTION_OPENFLOW
3587 ? OFPUTIL_TABLE_EVICTION_ON
3588 : OFPUTIL_TABLE_EVICTION_OFF);
3589 td->eviction_flags = OFPROTO_EVICTION_FLAGS;
3590 td->vacancy = (ofproto->tables[table_id].vacancy_enabled
3591 ? OFPUTIL_TABLE_VACANCY_ON
3592 : OFPUTIL_TABLE_VACANCY_OFF);
3593 td->table_vacancy.vacancy_down = ofproto->tables[table_id].vacancy_down;
3594 td->table_vacancy.vacancy_up = ofproto->tables[table_id].vacancy_up;
3595 td->table_vacancy.vacancy = max_flows ? (count * 100) / max_flows : 0;
3598 /* This function queries the database for dumping table-desc. */
3600 query_tables_desc(struct ofproto *ofproto, struct ofputil_table_desc **descp)
3602 struct ofputil_table_desc *table_desc;
3605 table_desc = *descp = xcalloc(ofproto->n_tables, sizeof *table_desc);
3606 for (i = 0; i < ofproto->n_tables; i++) {
3607 struct ofputil_table_desc *td = &table_desc[i];
3608 query_table_desc__(td, ofproto, i);
3612 /* Function to handle dump-table-desc request. */
3614 handle_table_desc_request(struct ofconn *ofconn,
3615 const struct ofp_header *request)
3617 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3618 struct ofputil_table_desc *table_desc;
3619 struct ovs_list replies;
3622 query_tables_desc(ofproto, &table_desc);
3623 ofpmp_init(&replies, request);
3624 for (i = 0; i < ofproto->n_tables; i++) {
3625 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3626 ofputil_append_table_desc_reply(&table_desc[i], &replies,
3630 ofconn_send_replies(ofconn, &replies);
3636 append_port_stat(struct ofport *port, struct ovs_list *replies)
3638 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3640 calc_duration(port->created, time_msec(),
3641 &ops.duration_sec, &ops.duration_nsec);
3643 /* Intentionally ignore return value, since errors will set
3644 * 'stats' to all-1s, which is correct for OpenFlow, and
3645 * netdev_get_stats() will log errors. */
3646 ofproto_port_get_stats(port, &ops.stats);
3648 ofputil_append_port_stat(replies, &ops);
3652 handle_port_request(struct ofconn *ofconn,
3653 const struct ofp_header *request, ofp_port_t port_no,
3654 void (*cb)(struct ofport *, struct ovs_list *replies))
3656 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3657 struct ofport *port;
3658 struct ovs_list replies;
3660 ofpmp_init(&replies, request);
3661 if (port_no != OFPP_ANY) {
3662 port = ofproto_get_port(ofproto, port_no);
3667 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3672 ofconn_send_replies(ofconn, &replies);
3676 handle_port_stats_request(struct ofconn *ofconn,
3677 const struct ofp_header *request)
3682 error = ofputil_decode_port_stats_request(request, &port_no);
3684 handle_port_request(ofconn, request, port_no, append_port_stat);
3690 append_port_desc(struct ofport *port, struct ovs_list *replies)
3692 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3696 handle_port_desc_stats_request(struct ofconn *ofconn,
3697 const struct ofp_header *request)
3702 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3704 handle_port_request(ofconn, request, port_no, append_port_desc);
3710 hash_cookie(ovs_be64 cookie)
3712 return hash_uint64((OVS_FORCE uint64_t)cookie);
3716 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3717 OVS_REQUIRES(ofproto_mutex)
3719 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3720 hash_cookie(rule->flow_cookie));
3724 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3725 OVS_REQUIRES(ofproto_mutex)
3727 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3731 calc_duration(long long int start, long long int now,
3732 uint32_t *sec, uint32_t *nsec)
3734 long long int msecs = now - start;
3735 *sec = msecs / 1000;
3736 *nsec = (msecs % 1000) * (1000 * 1000);
3739 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3740 * true if 'table_id' is OK, false otherwise. */
3742 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3744 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3747 static struct oftable *
3748 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3750 struct oftable *table;
3752 for (table = &ofproto->tables[table_id];
3753 table < &ofproto->tables[ofproto->n_tables];
3755 if (!(table->flags & OFTABLE_HIDDEN)) {
3763 static struct oftable *
3764 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3766 if (table_id == 0xff) {
3767 return next_visible_table(ofproto, 0);
3768 } else if (table_id < ofproto->n_tables) {
3769 return &ofproto->tables[table_id];
3775 static struct oftable *
3776 next_matching_table(const struct ofproto *ofproto,
3777 const struct oftable *table, uint8_t table_id)
3779 return (table_id == 0xff
3780 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3784 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3786 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3787 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3789 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3790 * only once, for that table. (This can be used to access tables marked
3793 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3794 * entered at all. (Perhaps you should have validated TABLE_ID with
3795 * check_table_id().)
3797 * All parameters are evaluated multiple times.
3799 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3800 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3802 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3804 /* Initializes 'criteria' in a straightforward way based on the other
3807 * By default, the criteria include flows that are read-only, on the assumption
3808 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3809 * if flows will be modified.
3811 * For "loose" matching, the 'priority' parameter is unimportant and may be
3814 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3815 const struct match *match, int priority,
3816 cls_version_t version, ovs_be64 cookie,
3817 ovs_be64 cookie_mask, ofp_port_t out_port,
3820 criteria->table_id = table_id;
3821 cls_rule_init(&criteria->cr, match, priority);
3822 criteria->version = version;
3823 criteria->cookie = cookie;
3824 criteria->cookie_mask = cookie_mask;
3825 criteria->out_port = out_port;
3826 criteria->out_group = out_group;
3828 /* We ordinarily want to skip hidden rules, but there has to be a way for
3829 * code internal to OVS to modify and delete them, so if the criteria
3830 * specify a priority that can only be for a hidden flow, then allow hidden
3831 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3832 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3834 criteria->include_hidden = priority > UINT16_MAX;
3836 /* We assume that the criteria are being used to collect flows for reading
3837 * but not modification. Thus, we should collect read-only flows. */
3838 criteria->include_readonly = true;
3841 /* By default, criteria initialized by rule_criteria_init() will match flows
3842 * that are read-only, on the assumption that the collected flows won't be
3843 * modified. Call this function to match only flows that are be modifiable.
3845 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3846 * caller has special privileges that allow it to modify even "read-only"
3849 rule_criteria_require_rw(struct rule_criteria *criteria,
3850 bool can_write_readonly)
3852 criteria->include_readonly = can_write_readonly;
3856 rule_criteria_destroy(struct rule_criteria *criteria)
3858 cls_rule_destroy(&criteria->cr);
3862 rule_collection_init(struct rule_collection *rules)
3864 rules->rules = rules->stub;
3866 rules->capacity = ARRAY_SIZE(rules->stub);
3870 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3872 if (rules->n >= rules->capacity) {
3873 size_t old_size, new_size;
3875 old_size = rules->capacity * sizeof *rules->rules;
3876 rules->capacity *= 2;
3877 new_size = rules->capacity * sizeof *rules->rules;
3879 if (rules->rules == rules->stub) {
3880 rules->rules = xmalloc(new_size);
3881 memcpy(rules->rules, rules->stub, old_size);
3883 rules->rules = xrealloc(rules->rules, new_size);
3887 rules->rules[rules->n++] = rule;
3891 rule_collection_ref(struct rule_collection *rules)
3892 OVS_REQUIRES(ofproto_mutex)
3896 for (i = 0; i < rules->n; i++) {
3897 ofproto_rule_ref(rules->rules[i]);
3902 rule_collection_unref(struct rule_collection *rules)
3906 for (i = 0; i < rules->n; i++) {
3907 ofproto_rule_unref(rules->rules[i]);
3911 /* Returns a NULL-terminated array of rule pointers,
3912 * destroys 'rules'. */
3913 static struct rule **
3914 rule_collection_detach(struct rule_collection *rules)
3916 struct rule **rule_array;
3918 rule_collection_add(rules, NULL);
3920 if (rules->rules == rules->stub) {
3921 rules->rules = xmemdup(rules->rules, rules->n * sizeof *rules->rules);
3924 rule_array = rules->rules;
3925 rule_collection_init(rules);
3931 rule_collection_destroy(struct rule_collection *rules)
3933 if (rules->rules != rules->stub) {
3937 /* Make repeated destruction harmless. */
3938 rule_collection_init(rules);
3941 /* Schedules postponed removal of rules, destroys 'rules'. */
3943 rule_collection_remove_postponed(struct rule_collection *rules)
3944 OVS_REQUIRES(ofproto_mutex)
3947 if (rules->n == 1) {
3948 ovsrcu_postpone(remove_rule_rcu, rules->rules[0]);
3950 ovsrcu_postpone(remove_rules_rcu, rule_collection_detach(rules));
3955 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3956 * function verifies most of the criteria in 'c' itself, but the caller must
3957 * check 'c->cr' itself.
3959 * Rules that have already been marked for removal are not collected.
3961 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3962 * 'c' only includes modifiable rules). */
3964 collect_rule(struct rule *rule, const struct rule_criteria *c,
3965 struct rule_collection *rules, size_t *n_readonly)
3966 OVS_REQUIRES(ofproto_mutex)
3968 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3969 && ofproto_rule_has_out_port(rule, c->out_port)
3970 && ofproto_rule_has_out_group(rule, c->out_group)
3971 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3972 && (!rule_is_hidden(rule) || c->include_hidden)
3973 && cls_rule_visible_in_version(&rule->cr, c->version)) {
3974 /* Rule matches all the criteria... */
3975 if (!rule_is_readonly(rule) || c->include_readonly) {
3977 rule_collection_add(rules, rule);
3979 /* ...except it's read-only. */
3985 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3986 * on classifiers rules are done in the "loose" way required for OpenFlow
3987 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3990 * Returns 0 on success, otherwise an OpenFlow error code. */
3992 collect_rules_loose(struct ofproto *ofproto,
3993 const struct rule_criteria *criteria,
3994 struct rule_collection *rules)
3995 OVS_REQUIRES(ofproto_mutex)
3997 struct oftable *table;
3998 enum ofperr error = 0;
3999 size_t n_readonly = 0;
4001 rule_collection_init(rules);
4003 if (!check_table_id(ofproto, criteria->table_id)) {
4004 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4008 if (criteria->cookie_mask == OVS_BE64_MAX) {
4011 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4012 hash_cookie(criteria->cookie),
4013 &ofproto->cookies) {
4014 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
4015 collect_rule(rule, criteria, rules, &n_readonly);
4019 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4022 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr,
4023 criteria->version) {
4024 collect_rule(rule, criteria, rules, &n_readonly);
4030 if (!error && !rules->n && n_readonly) {
4031 /* We didn't find any rules to modify. We did find some read-only
4032 * rules that we're not allowed to modify, so report that. */
4033 error = OFPERR_OFPBRC_EPERM;
4036 rule_collection_destroy(rules);
4041 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4042 * on classifiers rules are done in the "strict" way required for OpenFlow
4043 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
4044 * rules on list 'rules'.
4046 * Returns 0 on success, otherwise an OpenFlow error code. */
4048 collect_rules_strict(struct ofproto *ofproto,
4049 const struct rule_criteria *criteria,
4050 struct rule_collection *rules)
4051 OVS_REQUIRES(ofproto_mutex)
4053 struct oftable *table;
4054 size_t n_readonly = 0;
4055 enum ofperr error = 0;
4057 rule_collection_init(rules);
4059 if (!check_table_id(ofproto, criteria->table_id)) {
4060 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4064 if (criteria->cookie_mask == OVS_BE64_MAX) {
4067 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4068 hash_cookie(criteria->cookie),
4069 &ofproto->cookies) {
4070 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
4071 collect_rule(rule, criteria, rules, &n_readonly);
4075 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4078 rule = rule_from_cls_rule(classifier_find_rule_exactly(
4079 &table->cls, &criteria->cr,
4080 criteria->version));
4082 collect_rule(rule, criteria, rules, &n_readonly);
4088 if (!error && !rules->n && n_readonly) {
4089 /* We didn't find any rules to modify. We did find some read-only
4090 * rules that we're not allowed to modify, so report that. */
4091 error = OFPERR_OFPBRC_EPERM;
4094 rule_collection_destroy(rules);
4099 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4100 * forced into the range of a uint16_t. */
4102 age_secs(long long int age_ms)
4104 return (age_ms < 0 ? 0
4105 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
4106 : (unsigned int) age_ms / 1000);
4110 handle_flow_stats_request(struct ofconn *ofconn,
4111 const struct ofp_header *request)
4112 OVS_EXCLUDED(ofproto_mutex)
4114 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4115 struct ofputil_flow_stats_request fsr;
4116 struct rule_criteria criteria;
4117 struct rule_collection rules;
4118 struct ovs_list replies;
4122 error = ofputil_decode_flow_stats_request(&fsr, request);
4127 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
4128 fsr.cookie, fsr.cookie_mask, fsr.out_port,
4131 ovs_mutex_lock(&ofproto_mutex);
4132 error = collect_rules_loose(ofproto, &criteria, &rules);
4133 rule_criteria_destroy(&criteria);
4135 rule_collection_ref(&rules);
4137 ovs_mutex_unlock(&ofproto_mutex);
4143 ofpmp_init(&replies, request);
4144 for (i = 0; i < rules.n; i++) {
4145 struct rule *rule = rules.rules[i];
4146 long long int now = time_msec();
4147 struct ofputil_flow_stats fs;
4148 long long int created, used, modified;
4149 const struct rule_actions *actions;
4150 enum ofputil_flow_mod_flags flags;
4152 ovs_mutex_lock(&rule->mutex);
4153 fs.cookie = rule->flow_cookie;
4154 fs.idle_timeout = rule->idle_timeout;
4155 fs.hard_timeout = rule->hard_timeout;
4156 fs.importance = rule->importance;
4157 created = rule->created;
4158 modified = rule->modified;
4159 actions = rule_get_actions(rule);
4160 flags = rule->flags;
4161 ovs_mutex_unlock(&rule->mutex);
4163 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
4164 &fs.byte_count, &used);
4166 minimatch_expand(&rule->cr.match, &fs.match);
4167 fs.table_id = rule->table_id;
4168 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4169 fs.priority = rule->cr.priority;
4170 fs.idle_age = age_secs(now - used);
4171 fs.hard_age = age_secs(now - modified);
4172 fs.ofpacts = actions->ofpacts;
4173 fs.ofpacts_len = actions->ofpacts_len;
4176 ofputil_append_flow_stats_reply(&fs, &replies);
4179 rule_collection_unref(&rules);
4180 rule_collection_destroy(&rules);
4182 ofconn_send_replies(ofconn, &replies);
4188 flow_stats_ds(struct rule *rule, struct ds *results)
4190 uint64_t packet_count, byte_count;
4191 const struct rule_actions *actions;
4192 long long int created, used;
4194 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4195 &byte_count, &used);
4197 ovs_mutex_lock(&rule->mutex);
4198 actions = rule_get_actions(rule);
4199 created = rule->created;
4200 ovs_mutex_unlock(&rule->mutex);
4202 if (rule->table_id != 0) {
4203 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4205 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4206 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4207 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4208 cls_rule_format(&rule->cr, results);
4209 ds_put_char(results, ',');
4211 ds_put_cstr(results, "actions=");
4212 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4214 ds_put_cstr(results, "\n");
4217 /* Adds a pretty-printed description of all flows to 'results', including
4218 * hidden flows (e.g., set up by in-band control). */
4220 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4222 struct oftable *table;
4224 OFPROTO_FOR_EACH_TABLE (table, p) {
4227 CLS_FOR_EACH (rule, cr, &table->cls) {
4228 flow_stats_ds(rule, results);
4233 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4234 * '*engine_type' and '*engine_id', respectively. */
4236 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4237 uint8_t *engine_type, uint8_t *engine_id)
4239 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4242 /* Checks the status change of CFM on 'ofport'.
4244 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4246 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4248 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4249 return (ofport && ofproto->ofproto_class->cfm_status_changed
4250 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4254 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4255 * Returns 0 if the port's CFM status was successfully stored into
4256 * '*status'. Returns positive errno if the port did not have CFM
4259 * The caller must provide and own '*status', and must free 'status->rmps'.
4260 * '*status' is indeterminate if the return value is non-zero. */
4262 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4263 struct cfm_status *status)
4265 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4266 return (ofport && ofproto->ofproto_class->get_cfm_status
4267 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4272 handle_aggregate_stats_request(struct ofconn *ofconn,
4273 const struct ofp_header *oh)
4274 OVS_EXCLUDED(ofproto_mutex)
4276 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4277 struct ofputil_flow_stats_request request;
4278 struct ofputil_aggregate_stats stats;
4279 bool unknown_packets, unknown_bytes;
4280 struct rule_criteria criteria;
4281 struct rule_collection rules;
4282 struct ofpbuf *reply;
4286 error = ofputil_decode_flow_stats_request(&request, oh);
4291 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4292 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4293 request.out_port, request.out_group);
4295 ovs_mutex_lock(&ofproto_mutex);
4296 error = collect_rules_loose(ofproto, &criteria, &rules);
4297 rule_criteria_destroy(&criteria);
4299 rule_collection_ref(&rules);
4301 ovs_mutex_unlock(&ofproto_mutex);
4307 memset(&stats, 0, sizeof stats);
4308 unknown_packets = unknown_bytes = false;
4309 for (i = 0; i < rules.n; i++) {
4310 struct rule *rule = rules.rules[i];
4311 uint64_t packet_count;
4312 uint64_t byte_count;
4315 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4316 &byte_count, &used);
4318 if (packet_count == UINT64_MAX) {
4319 unknown_packets = true;
4321 stats.packet_count += packet_count;
4324 if (byte_count == UINT64_MAX) {
4325 unknown_bytes = true;
4327 stats.byte_count += byte_count;
4332 if (unknown_packets) {
4333 stats.packet_count = UINT64_MAX;
4335 if (unknown_bytes) {
4336 stats.byte_count = UINT64_MAX;
4339 rule_collection_unref(&rules);
4340 rule_collection_destroy(&rules);
4342 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4343 ofconn_send_reply(ofconn, reply);
4348 struct queue_stats_cbdata {
4349 struct ofport *ofport;
4350 struct ovs_list replies;
4355 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4356 const struct netdev_queue_stats *stats)
4358 struct ofputil_queue_stats oqs;
4360 oqs.port_no = cbdata->ofport->pp.port_no;
4361 oqs.queue_id = queue_id;
4362 oqs.tx_bytes = stats->tx_bytes;
4363 oqs.tx_packets = stats->tx_packets;
4364 oqs.tx_errors = stats->tx_errors;
4365 if (stats->created != LLONG_MIN) {
4366 calc_duration(stats->created, cbdata->now,
4367 &oqs.duration_sec, &oqs.duration_nsec);
4369 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4371 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4375 handle_queue_stats_dump_cb(uint32_t queue_id,
4376 struct netdev_queue_stats *stats,
4379 struct queue_stats_cbdata *cbdata = cbdata_;
4381 put_queue_stats(cbdata, queue_id, stats);
4385 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4386 struct queue_stats_cbdata *cbdata)
4388 cbdata->ofport = port;
4389 if (queue_id == OFPQ_ALL) {
4390 netdev_dump_queue_stats(port->netdev,
4391 handle_queue_stats_dump_cb, cbdata);
4393 struct netdev_queue_stats stats;
4395 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4396 put_queue_stats(cbdata, queue_id, &stats);
4398 return OFPERR_OFPQOFC_BAD_QUEUE;
4405 handle_queue_stats_request(struct ofconn *ofconn,
4406 const struct ofp_header *rq)
4408 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4409 struct queue_stats_cbdata cbdata;
4410 struct ofport *port;
4412 struct ofputil_queue_stats_request oqsr;
4414 COVERAGE_INC(ofproto_queue_req);
4416 ofpmp_init(&cbdata.replies, rq);
4417 cbdata.now = time_msec();
4419 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4424 if (oqsr.port_no == OFPP_ANY) {
4425 error = OFPERR_OFPQOFC_BAD_QUEUE;
4426 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4427 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4432 port = ofproto_get_port(ofproto, oqsr.port_no);
4434 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4435 : OFPERR_OFPQOFC_BAD_PORT);
4438 ofconn_send_replies(ofconn, &cbdata.replies);
4440 ofpbuf_list_delete(&cbdata.replies);
4447 evict_rules_from_table(struct oftable *table)
4448 OVS_REQUIRES(ofproto_mutex)
4450 enum ofperr error = 0;
4451 struct rule_collection rules;
4452 unsigned int count = table->n_flows;
4453 unsigned int max_flows = table->max_flows;
4455 rule_collection_init(&rules);
4457 while (count-- > max_flows) {
4460 if (!choose_rule_to_evict(table, &rule)) {
4461 error = OFPERR_OFPFMFC_TABLE_FULL;
4464 eviction_group_remove_rule(rule);
4465 rule_collection_add(&rules, rule);
4468 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4474 get_conjunctions(const struct ofputil_flow_mod *fm,
4475 struct cls_conjunction **conjsp, size_t *n_conjsp)
4476 OVS_REQUIRES(ofproto_mutex)
4478 struct cls_conjunction *conjs = NULL;
4481 const struct ofpact *ofpact;
4482 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4483 if (ofpact->type == OFPACT_CONJUNCTION) {
4485 } else if (ofpact->type != OFPACT_NOTE) {
4486 /* "conjunction" may appear with "note" actions but not with any
4487 * other type of actions. */
4488 ovs_assert(!n_conjs);
4495 conjs = xzalloc(n_conjs * sizeof *conjs);
4496 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4497 if (ofpact->type == OFPACT_CONJUNCTION) {
4498 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4499 conjs[i].clause = oc->clause;
4500 conjs[i].n_clauses = oc->n_clauses;
4501 conjs[i].id = oc->id;
4508 *n_conjsp = n_conjs;
4511 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4512 * in which no matching flow already exists in the flow table.
4514 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4515 * success, or an OpenFlow error code on failure.
4517 * On successful return the caller must complete the operation either by
4518 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4521 * The caller retains ownership of 'fm->ofpacts'. */
4523 add_flow_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4524 OVS_REQUIRES(ofproto_mutex)
4526 struct ofputil_flow_mod *fm = &ofm->fm;
4527 struct rule **old_rule = &ofm->old_rules.stub[0];
4528 struct rule **new_rule = &ofm->new_rules.stub[0];
4529 struct oftable *table;
4533 struct cls_conjunction *conjs;
4537 if (!check_table_id(ofproto, fm->table_id)) {
4538 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4543 if (fm->table_id == 0xff) {
4544 if (ofproto->ofproto_class->rule_choose_table) {
4545 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4551 ovs_assert(table_id < ofproto->n_tables);
4555 } else if (fm->table_id < ofproto->n_tables) {
4556 table_id = fm->table_id;
4558 return OFPERR_OFPBRC_BAD_TABLE_ID;
4561 table = &ofproto->tables[table_id];
4562 if (table->flags & OFTABLE_READONLY
4563 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4564 return OFPERR_OFPBRC_EPERM;
4567 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4568 && !match_has_default_hidden_fields(&fm->match)) {
4569 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4570 "non-default values to hidden fields", ofproto->name);
4571 return OFPERR_OFPBRC_EPERM;
4574 cls_rule_init(&cr, &fm->match, fm->priority);
4576 /* Check for the existence of an identical rule.
4577 * This will not return rules earlier marked for removal. */
4578 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr,
4582 /* Check for overlap, if requested. */
4583 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4584 && classifier_rule_overlaps(&table->cls, &cr, ofm->version)) {
4585 cls_rule_destroy(&cr);
4586 return OFPERR_OFPFMFC_OVERLAP;
4589 /* If necessary, evict an existing rule to clear out space. */
4590 if (table->n_flows >= table->max_flows) {
4591 if (!choose_rule_to_evict(table, &rule)) {
4592 error = OFPERR_OFPFMFC_TABLE_FULL;
4593 cls_rule_destroy(&cr);
4596 eviction_group_remove_rule(rule);
4597 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4599 fm->delete_reason = OFPRR_EVICTION;
4603 fm->modify_cookie = true;
4606 /* Allocate new rule. */
4607 error = replace_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4613 get_conjunctions(fm, &conjs, &n_conjs);
4614 replace_rule_start(ofproto, ofm->version, rule, *new_rule, conjs, n_conjs);
4620 /* Revert the effects of add_flow_start(). */
4622 add_flow_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4623 OVS_REQUIRES(ofproto_mutex)
4625 struct ofputil_flow_mod *fm = &ofm->fm;
4626 struct rule *old_rule = ofm->old_rules.stub[0];
4627 struct rule *new_rule = ofm->new_rules.stub[0];
4629 if (old_rule && fm->delete_reason == OFPRR_EVICTION) {
4630 /* Revert the eviction. */
4631 eviction_group_add_rule(old_rule);
4634 replace_rule_revert(ofproto, old_rule, new_rule);
4637 /* To be called after version bump. */
4639 add_flow_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4640 const struct flow_mod_requester *req)
4641 OVS_REQUIRES(ofproto_mutex)
4643 struct ofputil_flow_mod *fm = &ofm->fm;
4644 struct rule *old_rule = ofm->old_rules.stub[0];
4645 struct rule *new_rule = ofm->new_rules.stub[0];
4646 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4648 replace_rule_finish(ofproto, fm, req, old_rule, new_rule, &dead_cookies);
4649 learned_cookies_flush(ofproto, &dead_cookies);
4652 ovsrcu_postpone(remove_rule_rcu, old_rule);
4654 if (minimask_get_vid_mask(new_rule->cr.match.mask) == VLAN_VID_MASK) {
4655 if (ofproto->vlan_bitmap) {
4656 uint16_t vid = miniflow_get_vid(new_rule->cr.match.flow);
4658 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4659 bitmap_set1(ofproto->vlan_bitmap, vid);
4660 ofproto->vlans_changed = true;
4663 ofproto->vlans_changed = true;
4667 ofmonitor_report(ofproto->connmgr, new_rule, NXFME_ADDED, 0,
4668 req ? req->ofconn : NULL,
4669 req ? req->request->xid : 0, NULL);
4672 send_buffered_packet(req, fm->buffer_id, new_rule);
4675 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4677 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4678 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4679 * structures yet. Takes ownership of 'cr'. */
4681 replace_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4682 struct cls_rule *cr, uint8_t table_id,
4683 struct rule *old_rule, struct rule **new_rule)
4688 /* Allocate new rule. */
4689 rule = ofproto->ofproto_class->rule_alloc();
4691 cls_rule_destroy(cr);
4692 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
4693 return OFPERR_OFPFMFC_UNKNOWN;
4696 /* Initialize base state. */
4697 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4698 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
4699 ovs_refcount_init(&rule->ref_count);
4700 rule->flow_cookie = fm->new_cookie;
4701 rule->created = rule->modified = time_msec();
4703 ovs_mutex_init(&rule->mutex);
4704 ovs_mutex_lock(&rule->mutex);
4705 rule->idle_timeout = fm->idle_timeout;
4706 rule->hard_timeout = fm->hard_timeout;
4707 *CONST_CAST(uint16_t *, &rule->importance) = fm->importance;
4708 rule->removed_reason = OVS_OFPRR_NONE;
4710 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
4711 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4712 *CONST_CAST(const struct rule_actions **, &rule->actions)
4713 = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4714 list_init(&rule->meter_list_node);
4715 rule->eviction_group = NULL;
4716 list_init(&rule->expirable);
4717 rule->monitor_flags = 0;
4718 rule->add_seqno = 0;
4719 rule->modify_seqno = 0;
4721 /* Copy values from old rule for modify semantics. */
4722 if (old_rule && fm->delete_reason != OFPRR_EVICTION) {
4723 bool change_cookie = (fm->modify_cookie
4724 && fm->new_cookie != OVS_BE64_MAX
4725 && fm->new_cookie != old_rule->flow_cookie);
4727 ovs_mutex_lock(&old_rule->mutex);
4728 if (fm->command != OFPFC_ADD) {
4729 rule->idle_timeout = old_rule->idle_timeout;
4730 rule->hard_timeout = old_rule->hard_timeout;
4731 *CONST_CAST(uint16_t *, &rule->importance) = old_rule->importance;
4732 rule->flags = old_rule->flags;
4733 rule->created = old_rule->created;
4735 if (!change_cookie) {
4736 rule->flow_cookie = old_rule->flow_cookie;
4738 ovs_mutex_unlock(&old_rule->mutex);
4740 ovs_mutex_unlock(&rule->mutex);
4742 /* Construct rule, initializing derived state. */
4743 error = ofproto->ofproto_class->rule_construct(rule);
4745 ofproto_rule_destroy__(rule);
4749 rule->removed = true; /* Not yet in ofproto data structures. */
4756 replace_rule_start(struct ofproto *ofproto, cls_version_t version,
4757 struct rule *old_rule, struct rule *new_rule,
4758 struct cls_conjunction *conjs, size_t n_conjs)
4760 struct oftable *table = &ofproto->tables[new_rule->table_id];
4762 /* 'old_rule' may be either an evicted rule or replaced rule. */
4764 /* Mark the old rule for removal in the next version. */
4765 cls_rule_make_invisible_in_version(&old_rule->cr, version);
4769 /* Insert flow to the classifier, so that later flow_mods may relate
4770 * to it. This is reversible, in case later errors require this to
4772 ofproto_rule_insert__(ofproto, new_rule);
4773 /* Make the new rule visible for classifier lookups only from the next
4775 classifier_insert(&table->cls, &new_rule->cr, version, conjs, n_conjs);
4778 static void replace_rule_revert(struct ofproto *ofproto,
4779 struct rule *old_rule, struct rule *new_rule)
4781 struct oftable *table = &ofproto->tables[new_rule->table_id];
4784 /* Restore the original visibility of the old rule. */
4785 cls_rule_restore_visibility(&old_rule->cr);
4787 /* Restore table's rule count. */
4791 /* Remove the new rule immediately. It was never visible to lookups. */
4792 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4795 ofproto_rule_remove__(ofproto, new_rule);
4796 /* The rule was not inserted to the ofproto provider, so we can
4797 * release it without deleting it from the ofproto provider. */
4798 ofproto_rule_unref(new_rule);
4801 /* Adds the 'new_rule', replacing the 'old_rule'. */
4803 replace_rule_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4804 const struct flow_mod_requester *req,
4805 struct rule *old_rule, struct rule *new_rule,
4806 struct ovs_list *dead_cookies)
4807 OVS_REQUIRES(ofproto_mutex)
4809 bool forward_stats = !(fm->flags & OFPUTIL_FF_RESET_COUNTS);
4810 struct rule *replaced_rule;
4812 replaced_rule = fm->delete_reason != OFPRR_EVICTION ? old_rule : NULL;
4814 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4815 * is a duplicate rule the 'new_rule' is replacing. The provider should
4816 * link the stats from the old rule to the new one if 'forward_stats' is
4817 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4818 ofproto->ofproto_class->rule_insert(new_rule, replaced_rule,
4820 learned_cookies_inc(ofproto, rule_get_actions(new_rule));
4823 const struct rule_actions *old_actions = rule_get_actions(old_rule);
4825 /* Remove the old rule from data structures. Removal from the
4826 * classifier and the deletion of the rule is RCU postponed by the
4828 ofproto_rule_remove__(ofproto, old_rule);
4829 learned_cookies_dec(ofproto, old_actions, dead_cookies);
4831 if (replaced_rule) {
4832 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4833 ? NXFME_ADDED : NXFME_MODIFIED;
4835 bool change_cookie = (fm->modify_cookie
4836 && fm->new_cookie != OVS_BE64_MAX
4837 && fm->new_cookie != old_rule->flow_cookie);
4839 bool change_actions = !ofpacts_equal(fm->ofpacts,
4841 old_actions->ofpacts,
4842 old_actions->ofpacts_len);
4844 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4845 ofmonitor_report(ofproto->connmgr, new_rule, event, 0,
4846 req ? req->ofconn : NULL,
4847 req ? req->request->xid : 0,
4848 change_actions ? old_actions : NULL);
4851 /* XXX: This is slight duplication with delete_flows_finish__() */
4853 old_rule->removed_reason = OFPRR_EVICTION;
4855 ofmonitor_report(ofproto->connmgr, old_rule, NXFME_DELETED,
4857 req ? req->ofconn : NULL,
4858 req ? req->request->xid : 0, NULL);
4864 modify_flows_start__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4865 OVS_REQUIRES(ofproto_mutex)
4867 struct ofputil_flow_mod *fm = &ofm->fm;
4868 struct rule_collection *old_rules = &ofm->old_rules;
4869 struct rule_collection *new_rules = &ofm->new_rules;
4872 rule_collection_init(new_rules);
4874 if (old_rules->n > 0) {
4875 struct cls_conjunction *conjs;
4879 /* Create a new 'modified' rule for each old rule. */
4880 for (i = 0; i < old_rules->n; i++) {
4881 struct rule *old_rule = old_rules->rules[i];
4882 struct rule *new_rule;
4885 cls_rule_clone(&cr, &old_rule->cr);
4886 error = replace_rule_create(ofproto, fm, &cr, old_rule->table_id,
4887 old_rule, &new_rule);
4889 rule_collection_add(new_rules, new_rule);
4891 rule_collection_unref(new_rules);
4892 rule_collection_destroy(new_rules);
4896 ovs_assert(new_rules->n == old_rules->n);
4898 get_conjunctions(fm, &conjs, &n_conjs);
4899 for (i = 0; i < old_rules->n; i++) {
4900 replace_rule_start(ofproto, ofm->version, old_rules->rules[i],
4901 new_rules->rules[i], conjs, n_conjs);
4904 } else if (!(fm->cookie_mask != htonll(0)
4905 || fm->new_cookie == OVS_BE64_MAX)) {
4906 /* No match, add a new flow. */
4907 error = add_flow_start(ofproto, ofm);
4909 ovs_assert(fm->delete_reason == OFPRR_EVICTION
4910 || !old_rules->rules[0]);
4920 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4923 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4926 modify_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4927 OVS_REQUIRES(ofproto_mutex)
4929 struct ofputil_flow_mod *fm = &ofm->fm;
4930 struct rule_collection *old_rules = &ofm->old_rules;
4931 struct rule_criteria criteria;
4934 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4935 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG_ANY);
4936 rule_criteria_require_rw(&criteria,
4937 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4938 error = collect_rules_loose(ofproto, &criteria, old_rules);
4939 rule_criteria_destroy(&criteria);
4942 error = modify_flows_start__(ofproto, ofm);
4946 rule_collection_destroy(old_rules);
4952 modify_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4953 OVS_REQUIRES(ofproto_mutex)
4955 struct rule_collection *old_rules = &ofm->old_rules;
4956 struct rule_collection *new_rules = &ofm->new_rules;
4958 /* Old rules were not changed yet, only need to revert new rules. */
4959 if (old_rules->n == 0 && new_rules->n == 1) {
4960 add_flow_revert(ofproto, ofm);
4961 } else if (old_rules->n > 0) {
4962 for (size_t i = 0; i < old_rules->n; i++) {
4963 replace_rule_revert(ofproto, old_rules->rules[i],
4964 new_rules->rules[i]);
4966 rule_collection_destroy(new_rules);
4967 rule_collection_destroy(old_rules);
4972 modify_flows_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4973 const struct flow_mod_requester *req)
4974 OVS_REQUIRES(ofproto_mutex)
4976 struct ofputil_flow_mod *fm = &ofm->fm;
4977 struct rule_collection *old_rules = &ofm->old_rules;
4978 struct rule_collection *new_rules = &ofm->new_rules;
4980 if (old_rules->n == 0 && new_rules->n == 1) {
4981 add_flow_finish(ofproto, ofm, req);
4982 } else if (old_rules->n > 0) {
4983 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4985 ovs_assert(new_rules->n == old_rules->n);
4987 for (size_t i = 0; i < old_rules->n; i++) {
4988 replace_rule_finish(ofproto, fm, req, old_rules->rules[i],
4989 new_rules->rules[i], &dead_cookies);
4991 learned_cookies_flush(ofproto, &dead_cookies);
4992 rule_collection_remove_postponed(old_rules);
4994 send_buffered_packet(req, fm->buffer_id, new_rules->rules[0]);
4995 rule_collection_destroy(new_rules);
4999 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
5000 * code on failure. */
5002 modify_flow_start_strict(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5003 OVS_REQUIRES(ofproto_mutex)
5005 struct ofputil_flow_mod *fm = &ofm->fm;
5006 struct rule_collection *old_rules = &ofm->old_rules;
5007 struct rule_criteria criteria;
5010 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5011 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
5013 rule_criteria_require_rw(&criteria,
5014 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5015 error = collect_rules_strict(ofproto, &criteria, old_rules);
5016 rule_criteria_destroy(&criteria);
5019 /* collect_rules_strict() can return max 1 rule. */
5020 error = modify_flows_start__(ofproto, ofm);
5024 rule_collection_destroy(old_rules);
5029 /* OFPFC_DELETE implementation. */
5032 delete_flows_start__(struct ofproto *ofproto, cls_version_t version,
5033 const struct rule_collection *rules)
5034 OVS_REQUIRES(ofproto_mutex)
5036 for (size_t i = 0; i < rules->n; i++) {
5037 struct rule *rule = rules->rules[i];
5038 struct oftable *table = &ofproto->tables[rule->table_id];
5041 cls_rule_make_invisible_in_version(&rule->cr, version);
5046 delete_flows_finish__(struct ofproto *ofproto,
5047 struct rule_collection *rules,
5048 enum ofp_flow_removed_reason reason,
5049 const struct flow_mod_requester *req)
5050 OVS_REQUIRES(ofproto_mutex)
5053 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
5055 for (size_t i = 0; i < rules->n; i++) {
5056 struct rule *rule = rules->rules[i];
5058 /* This value will be used to send the flow removed message right
5059 * before the rule is actually destroyed. */
5060 rule->removed_reason = reason;
5062 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
5063 req ? req->ofconn : NULL,
5064 req ? req->request->xid : 0, NULL);
5065 ofproto_rule_remove__(ofproto, rule);
5066 learned_cookies_dec(ofproto, rule_get_actions(rule),
5069 rule_collection_remove_postponed(rules);
5071 learned_cookies_flush(ofproto, &dead_cookies);
5075 /* Deletes the rules listed in 'rules'.
5076 * The deleted rules will become invisible to the lookups in the next version.
5077 * Destroys 'rules'. */
5079 delete_flows__(struct rule_collection *rules,
5080 enum ofp_flow_removed_reason reason,
5081 const struct flow_mod_requester *req)
5082 OVS_REQUIRES(ofproto_mutex)
5085 struct ofproto *ofproto = rules->rules[0]->ofproto;
5087 delete_flows_start__(ofproto, ofproto->tables_version + 1, rules);
5088 ofproto_bump_tables_version(ofproto);
5089 delete_flows_finish__(ofproto, rules, reason, req);
5090 ofmonitor_flush(ofproto->connmgr);
5094 /* Implements OFPFC_DELETE. */
5096 delete_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5097 OVS_REQUIRES(ofproto_mutex)
5099 const struct ofputil_flow_mod *fm = &ofm->fm;
5100 struct rule_collection *rules = &ofm->old_rules;
5101 struct rule_criteria criteria;
5104 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
5105 fm->cookie, fm->cookie_mask, fm->out_port,
5107 rule_criteria_require_rw(&criteria,
5108 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5109 error = collect_rules_loose(ofproto, &criteria, rules);
5110 rule_criteria_destroy(&criteria);
5113 delete_flows_start__(ofproto, ofm->version, rules);
5120 delete_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5121 OVS_REQUIRES(ofproto_mutex)
5123 struct rule_collection *rules = &ofm->old_rules;
5125 for (size_t i = 0; i < rules->n; i++) {
5126 struct rule *rule = rules->rules[i];
5127 struct oftable *table = &ofproto->tables[rule->table_id];
5129 /* Restore table's rule count. */
5132 /* Restore the original visibility of the rule. */
5133 cls_rule_restore_visibility(&rule->cr);
5135 rule_collection_destroy(rules);
5139 delete_flows_finish(struct ofproto *ofproto,
5140 struct ofproto_flow_mod *ofm,
5141 const struct flow_mod_requester *req)
5142 OVS_REQUIRES(ofproto_mutex)
5144 delete_flows_finish__(ofproto, &ofm->old_rules, ofm->fm.delete_reason,
5148 /* Implements OFPFC_DELETE_STRICT. */
5150 delete_flow_start_strict(struct ofproto *ofproto,
5151 struct ofproto_flow_mod *ofm)
5152 OVS_REQUIRES(ofproto_mutex)
5154 const struct ofputil_flow_mod *fm = &ofm->fm;
5155 struct rule_collection *rules = &ofm->old_rules;
5156 struct rule_criteria criteria;
5159 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5160 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
5161 fm->out_port, fm->out_group);
5162 rule_criteria_require_rw(&criteria,
5163 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5164 error = collect_rules_strict(ofproto, &criteria, rules);
5165 rule_criteria_destroy(&criteria);
5168 delete_flows_start__(ofproto, ofm->version, rules);
5174 /* This may only be called by rule_destroy_cb()! */
5176 ofproto_rule_send_removed(struct rule *rule)
5177 OVS_EXCLUDED(ofproto_mutex)
5179 struct ofputil_flow_removed fr;
5182 minimatch_expand(&rule->cr.match, &fr.match);
5183 fr.priority = rule->cr.priority;
5185 ovs_mutex_lock(&ofproto_mutex);
5186 fr.cookie = rule->flow_cookie;
5187 fr.reason = rule->removed_reason;
5188 fr.table_id = rule->table_id;
5189 calc_duration(rule->created, time_msec(),
5190 &fr.duration_sec, &fr.duration_nsec);
5191 ovs_mutex_lock(&rule->mutex);
5192 fr.idle_timeout = rule->idle_timeout;
5193 fr.hard_timeout = rule->hard_timeout;
5194 ovs_mutex_unlock(&rule->mutex);
5195 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
5196 &fr.byte_count, &used);
5197 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
5198 ovs_mutex_unlock(&ofproto_mutex);
5201 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5202 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5205 * ofproto implementation ->run() functions should use this function to expire
5206 * OpenFlow flows. */
5208 ofproto_rule_expire(struct rule *rule, uint8_t reason)
5209 OVS_REQUIRES(ofproto_mutex)
5211 struct rule_collection rules;
5213 rules.rules = rules.stub;
5215 rules.stub[0] = rule;
5216 delete_flows__(&rules, reason, NULL);
5219 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5220 * means "infinite". */
5222 reduce_timeout(uint16_t max, uint16_t *timeout)
5224 if (max && (!*timeout || *timeout > max)) {
5229 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5230 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5231 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5233 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5235 ofproto_rule_reduce_timeouts(struct rule *rule,
5236 uint16_t idle_timeout, uint16_t hard_timeout)
5237 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5239 if (!idle_timeout && !hard_timeout) {
5243 ovs_mutex_lock(&ofproto_mutex);
5244 if (list_is_empty(&rule->expirable)) {
5245 list_insert(&rule->ofproto->expirable, &rule->expirable);
5247 ovs_mutex_unlock(&ofproto_mutex);
5249 ovs_mutex_lock(&rule->mutex);
5250 reduce_timeout(idle_timeout, &rule->idle_timeout);
5251 reduce_timeout(hard_timeout, &rule->hard_timeout);
5252 ovs_mutex_unlock(&rule->mutex);
5256 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5257 OVS_EXCLUDED(ofproto_mutex)
5259 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5260 struct ofproto_flow_mod ofm;
5261 uint64_t ofpacts_stub[1024 / 8];
5262 struct ofpbuf ofpacts;
5265 error = reject_slave_controller(ofconn);
5270 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5271 error = ofputil_decode_flow_mod(&ofm.fm, oh, ofconn_get_protocol(ofconn),
5273 u16_to_ofp(ofproto->max_ports),
5276 error = ofproto_check_ofpacts(ofproto, ofm.fm.ofpacts,
5277 ofm.fm.ofpacts_len);
5280 struct flow_mod_requester req;
5282 req.ofconn = ofconn;
5284 error = handle_flow_mod__(ofproto, &ofm, &req);
5287 goto exit_free_ofpacts;
5290 ofconn_report_flow_mod(ofconn, ofm.fm.command);
5293 ofpbuf_uninit(&ofpacts);
5299 handle_flow_mod__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
5300 const struct flow_mod_requester *req)
5301 OVS_EXCLUDED(ofproto_mutex)
5305 ovs_mutex_lock(&ofproto_mutex);
5306 ofm->version = ofproto->tables_version + 1;
5307 error = ofproto_flow_mod_start(ofproto, ofm);
5309 ofproto_bump_tables_version(ofproto);
5310 ofproto_flow_mod_finish(ofproto, ofm, req);
5312 ofmonitor_flush(ofproto->connmgr);
5313 ovs_mutex_unlock(&ofproto_mutex);
5315 run_rule_executes(ofproto);
5320 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5322 struct ofputil_role_request request;
5323 struct ofputil_role_request reply;
5327 error = ofputil_decode_role_message(oh, &request);
5332 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5333 if (request.role != OFPCR12_ROLE_EQUAL
5334 && request.have_generation_id
5335 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5336 return OFPERR_OFPRRFC_STALE;
5339 ofconn_set_role(ofconn, request.role);
5342 reply.role = ofconn_get_role(ofconn);
5343 reply.have_generation_id = ofconn_get_master_election_id(
5344 ofconn, &reply.generation_id);
5345 buf = ofputil_encode_role_reply(oh, &reply);
5346 ofconn_send_reply(ofconn, buf);
5352 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5353 const struct ofp_header *oh)
5355 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5356 enum ofputil_protocol cur, next;
5358 cur = ofconn_get_protocol(ofconn);
5359 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5360 ofconn_set_protocol(ofconn, next);
5366 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5368 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5369 enum ofputil_protocol cur, next;
5370 enum ofputil_protocol next_base;
5372 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5374 return OFPERR_OFPBRC_EPERM;
5377 cur = ofconn_get_protocol(ofconn);
5378 next = ofputil_protocol_set_base(cur, next_base);
5379 ofconn_set_protocol(ofconn, next);
5385 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5386 const struct ofp_header *oh)
5388 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5391 format = ntohl(msg->format);
5392 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5393 return OFPERR_OFPBRC_EPERM;
5396 ofconn_set_packet_in_format(ofconn, format);
5401 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5403 struct ofputil_async_cfg basis = ofconn_get_async_config(ofconn);
5404 struct ofputil_async_cfg ac;
5407 error = ofputil_decode_set_async_config(oh, false, &basis, &ac);
5412 ofconn_set_async_config(ofconn, &ac);
5413 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5414 !ofconn_get_miss_send_len(ofconn)) {
5415 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5422 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5424 struct ofputil_async_cfg ac = ofconn_get_async_config(ofconn);
5425 ofconn_send_reply(ofconn, ofputil_encode_get_async_reply(oh, &ac));
5431 handle_nxt_set_controller_id(struct ofconn *ofconn,
5432 const struct ofp_header *oh)
5434 const struct nx_controller_id *nci = ofpmsg_body(oh);
5436 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5437 return OFPERR_NXBRC_MUST_BE_ZERO;
5440 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5445 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5449 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5450 ? OFPRAW_OFPT10_BARRIER_REPLY
5451 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5452 ofconn_send_reply(ofconn, buf);
5457 ofproto_compose_flow_refresh_update(const struct rule *rule,
5458 enum nx_flow_monitor_flags flags,
5459 struct ovs_list *msgs)
5460 OVS_REQUIRES(ofproto_mutex)
5462 const struct rule_actions *actions;
5463 struct ofputil_flow_update fu;
5466 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5467 ? NXFME_ADDED : NXFME_MODIFIED);
5469 ovs_mutex_lock(&rule->mutex);
5470 fu.idle_timeout = rule->idle_timeout;
5471 fu.hard_timeout = rule->hard_timeout;
5472 ovs_mutex_unlock(&rule->mutex);
5473 fu.table_id = rule->table_id;
5474 fu.cookie = rule->flow_cookie;
5475 minimatch_expand(&rule->cr.match, &match);
5477 fu.priority = rule->cr.priority;
5479 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5480 fu.ofpacts = actions ? actions->ofpacts : NULL;
5481 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5483 if (list_is_empty(msgs)) {
5484 ofputil_start_flow_update(msgs);
5486 ofputil_append_flow_update(&fu, msgs);
5490 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5491 struct ovs_list *msgs)
5492 OVS_REQUIRES(ofproto_mutex)
5496 for (i = 0; i < rules->n; i++) {
5497 struct rule *rule = rules->rules[i];
5498 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5499 rule->monitor_flags = 0;
5501 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5506 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5507 struct rule *rule, uint64_t seqno,
5508 struct rule_collection *rules)
5509 OVS_REQUIRES(ofproto_mutex)
5511 enum nx_flow_monitor_flags update;
5513 if (rule_is_hidden(rule)) {
5517 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5522 if (rule->add_seqno > seqno) {
5523 update = NXFMF_ADD | NXFMF_MODIFY;
5524 } else if (rule->modify_seqno > seqno) {
5525 update = NXFMF_MODIFY;
5530 if (!(m->flags & update)) {
5534 update = NXFMF_INITIAL;
5537 if (!rule->monitor_flags) {
5538 rule_collection_add(rules, rule);
5540 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5544 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5546 struct rule_collection *rules)
5547 OVS_REQUIRES(ofproto_mutex)
5549 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5550 const struct oftable *table;
5551 struct cls_rule target;
5553 cls_rule_init_from_minimatch(&target, &m->match, 0);
5554 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5557 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target, CLS_MAX_VERSION) {
5558 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5561 cls_rule_destroy(&target);
5565 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5566 struct rule_collection *rules)
5567 OVS_REQUIRES(ofproto_mutex)
5569 if (m->flags & NXFMF_INITIAL) {
5570 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5575 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5576 uint64_t seqno, struct rule_collection *rules)
5577 OVS_REQUIRES(ofproto_mutex)
5579 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5583 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5584 OVS_REQUIRES(ofproto_mutex)
5586 struct ofmonitor *m;
5589 m = ofmonitor_lookup(ofconn, id);
5591 ofmonitor_destroy(m);
5594 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5601 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5602 OVS_EXCLUDED(ofproto_mutex)
5604 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5605 struct ofmonitor **monitors;
5606 size_t n_monitors, allocated_monitors;
5607 struct rule_collection rules;
5608 struct ovs_list replies;
5613 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5615 n_monitors = allocated_monitors = 0;
5617 ovs_mutex_lock(&ofproto_mutex);
5619 struct ofputil_flow_monitor_request request;
5620 struct ofmonitor *m;
5623 retval = ofputil_decode_flow_monitor_request(&request, &b);
5624 if (retval == EOF) {
5626 } else if (retval) {
5631 if (request.table_id != 0xff
5632 && request.table_id >= ofproto->n_tables) {
5633 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5637 error = ofmonitor_create(&request, ofconn, &m);
5642 if (n_monitors >= allocated_monitors) {
5643 monitors = x2nrealloc(monitors, &allocated_monitors,
5646 monitors[n_monitors++] = m;
5649 rule_collection_init(&rules);
5650 for (i = 0; i < n_monitors; i++) {
5651 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5654 ofpmp_init(&replies, oh);
5655 ofmonitor_compose_refresh_updates(&rules, &replies);
5656 ovs_mutex_unlock(&ofproto_mutex);
5658 rule_collection_destroy(&rules);
5660 ofconn_send_replies(ofconn, &replies);
5666 for (i = 0; i < n_monitors; i++) {
5667 ofmonitor_destroy(monitors[i]);
5670 ovs_mutex_unlock(&ofproto_mutex);
5676 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5677 OVS_EXCLUDED(ofproto_mutex)
5682 id = ofputil_decode_flow_monitor_cancel(oh);
5684 ovs_mutex_lock(&ofproto_mutex);
5685 error = flow_monitor_delete(ofconn, id);
5686 ovs_mutex_unlock(&ofproto_mutex);
5691 /* Meters implementation.
5693 * Meter table entry, indexed by the OpenFlow meter_id.
5694 * 'created' is used to compute the duration for meter stats.
5695 * 'list rules' is needed so that we can delete the dependent rules when the
5696 * meter table entry is deleted.
5697 * 'provider_meter_id' is for the provider's private use.
5700 long long int created; /* Time created. */
5701 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5702 ofproto_meter_id provider_meter_id;
5703 uint16_t flags; /* Meter flags. */
5704 uint16_t n_bands; /* Number of meter bands. */
5705 struct ofputil_meter_band *bands;
5709 * This is used in instruction validation at flow set-up time,
5710 * as flows may not use non-existing meters.
5711 * Return value of UINT32_MAX signifies an invalid meter.
5714 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5716 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5717 const struct meter *meter = ofproto->meters[of_meter_id];
5719 return meter->provider_meter_id.uint32;
5725 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5728 meter_insert_rule(struct rule *rule)
5730 const struct rule_actions *a = rule_get_actions(rule);
5731 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5732 struct meter *meter = rule->ofproto->meters[meter_id];
5734 list_insert(&meter->rules, &rule->meter_list_node);
5738 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5742 meter->flags = config->flags;
5743 meter->n_bands = config->n_bands;
5744 meter->bands = xmemdup(config->bands,
5745 config->n_bands * sizeof *meter->bands);
5748 static struct meter *
5749 meter_create(const struct ofputil_meter_config *config,
5750 ofproto_meter_id provider_meter_id)
5752 struct meter *meter;
5754 meter = xzalloc(sizeof *meter);
5755 meter->provider_meter_id = provider_meter_id;
5756 meter->created = time_msec();
5757 list_init(&meter->rules);
5759 meter_update(meter, config);
5765 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5766 OVS_REQUIRES(ofproto_mutex)
5769 for (mid = first; mid <= last; ++mid) {
5770 struct meter *meter = ofproto->meters[mid];
5772 ofproto->meters[mid] = NULL;
5773 ofproto->ofproto_class->meter_del(ofproto,
5774 meter->provider_meter_id);
5782 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5784 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5785 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5789 return OFPERR_OFPMMFC_METER_EXISTS;
5792 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5795 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5796 *meterp = meter_create(&mm->meter, provider_meter_id);
5802 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5804 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5806 uint32_t provider_meter_id;
5809 return OFPERR_OFPMMFC_UNKNOWN_METER;
5812 provider_meter_id = meter->provider_meter_id.uint32;
5813 error = ofproto->ofproto_class->meter_set(ofproto,
5814 &meter->provider_meter_id,
5816 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5818 meter_update(meter, &mm->meter);
5824 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5825 OVS_EXCLUDED(ofproto_mutex)
5827 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5828 uint32_t meter_id = mm->meter.meter_id;
5829 struct rule_collection rules;
5830 enum ofperr error = 0;
5831 uint32_t first, last;
5833 if (meter_id == OFPM13_ALL) {
5835 last = ofproto->meter_features.max_meters;
5837 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5840 first = last = meter_id;
5843 /* First delete the rules that use this meter. If any of those rules are
5844 * currently being modified, postpone the whole operation until later. */
5845 rule_collection_init(&rules);
5846 ovs_mutex_lock(&ofproto_mutex);
5847 for (meter_id = first; meter_id <= last; ++meter_id) {
5848 struct meter *meter = ofproto->meters[meter_id];
5849 if (meter && !list_is_empty(&meter->rules)) {
5852 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5853 rule_collection_add(&rules, rule);
5857 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5859 /* Delete the meters. */
5860 meter_delete(ofproto, first, last);
5862 ovs_mutex_unlock(&ofproto_mutex);
5868 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5870 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5871 struct ofputil_meter_mod mm;
5872 uint64_t bands_stub[256 / 8];
5873 struct ofpbuf bands;
5877 error = reject_slave_controller(ofconn);
5882 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5884 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5886 goto exit_free_bands;
5889 meter_id = mm.meter.meter_id;
5891 if (mm.command != OFPMC13_DELETE) {
5892 /* Fails also when meters are not implemented by the provider. */
5893 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5894 error = OFPERR_OFPMMFC_INVALID_METER;
5895 goto exit_free_bands;
5896 } else if (meter_id > ofproto->meter_features.max_meters) {
5897 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5898 goto exit_free_bands;
5900 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5901 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5902 goto exit_free_bands;
5906 switch (mm.command) {
5908 error = handle_add_meter(ofproto, &mm);
5911 case OFPMC13_MODIFY:
5912 error = handle_modify_meter(ofproto, &mm);
5915 case OFPMC13_DELETE:
5916 error = handle_delete_meter(ofconn, &mm);
5920 error = OFPERR_OFPMMFC_BAD_COMMAND;
5925 struct ofputil_requestforward rf;
5927 rf.reason = OFPRFR_METER_MOD;
5929 connmgr_send_requestforward(ofproto->connmgr, ofconn, &rf);
5933 ofpbuf_uninit(&bands);
5938 handle_meter_features_request(struct ofconn *ofconn,
5939 const struct ofp_header *request)
5941 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5942 struct ofputil_meter_features features;
5945 if (ofproto->ofproto_class->meter_get_features) {
5946 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5948 memset(&features, 0, sizeof features);
5950 b = ofputil_encode_meter_features_reply(&features, request);
5952 ofconn_send_reply(ofconn, b);
5957 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5960 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5961 struct ovs_list replies;
5962 uint64_t bands_stub[256 / 8];
5963 struct ofpbuf bands;
5964 uint32_t meter_id, first, last;
5966 ofputil_decode_meter_request(request, &meter_id);
5968 if (meter_id == OFPM13_ALL) {
5970 last = ofproto->meter_features.max_meters;
5972 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5973 !ofproto->meters[meter_id]) {
5974 return OFPERR_OFPMMFC_UNKNOWN_METER;
5976 first = last = meter_id;
5979 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5980 ofpmp_init(&replies, request);
5982 for (meter_id = first; meter_id <= last; ++meter_id) {
5983 struct meter *meter = ofproto->meters[meter_id];
5985 continue; /* Skip non-existing meters. */
5987 if (type == OFPTYPE_METER_STATS_REQUEST) {
5988 struct ofputil_meter_stats stats;
5990 stats.meter_id = meter_id;
5992 /* Provider sets the packet and byte counts, we do the rest. */
5993 stats.flow_count = list_size(&meter->rules);
5994 calc_duration(meter->created, time_msec(),
5995 &stats.duration_sec, &stats.duration_nsec);
5996 stats.n_bands = meter->n_bands;
5997 ofpbuf_clear(&bands);
5999 = ofpbuf_put_uninit(&bands,
6000 meter->n_bands * sizeof *stats.bands);
6002 if (!ofproto->ofproto_class->meter_get(ofproto,
6003 meter->provider_meter_id,
6005 ofputil_append_meter_stats(&replies, &stats);
6007 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
6008 struct ofputil_meter_config config;
6010 config.meter_id = meter_id;
6011 config.flags = meter->flags;
6012 config.n_bands = meter->n_bands;
6013 config.bands = meter->bands;
6014 ofputil_append_meter_config(&replies, &config);
6018 ofconn_send_replies(ofconn, &replies);
6019 ofpbuf_uninit(&bands);
6024 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
6025 struct ofgroup **group)
6026 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6028 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
6029 hash_int(group_id, 0), &ofproto->groups) {
6030 if ((*group)->group_id == group_id) {
6038 /* If the group exists, this function increments the groups's reference count.
6040 * Make sure to call ofproto_group_unref() after no longer needing to maintain
6041 * a reference to the group. */
6043 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
6044 struct ofgroup **group)
6048 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6049 found = ofproto_group_lookup__(ofproto, group_id, group);
6051 ofproto_group_ref(*group);
6053 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6058 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
6059 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6061 struct ofgroup *grp;
6063 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
6064 hash_int(group_id, 0), &ofproto->groups) {
6065 if (grp->group_id == group_id) {
6073 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
6074 OVS_EXCLUDED(ofproto->groups_rwlock)
6078 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6079 exists = ofproto_group_exists__(ofproto, group_id);
6080 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6086 group_get_ref_count(struct ofgroup *group)
6087 OVS_EXCLUDED(ofproto_mutex)
6089 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
6090 struct rule_criteria criteria;
6091 struct rule_collection rules;
6096 match_init_catchall(&match);
6097 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
6098 htonll(0), OFPP_ANY, group->group_id);
6099 ovs_mutex_lock(&ofproto_mutex);
6100 error = collect_rules_loose(ofproto, &criteria, &rules);
6101 ovs_mutex_unlock(&ofproto_mutex);
6102 rule_criteria_destroy(&criteria);
6104 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
6106 rule_collection_destroy(&rules);
6111 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
6113 struct ofputil_group_stats ogs;
6114 const struct ofproto *ofproto = group->ofproto;
6115 long long int now = time_msec();
6118 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
6120 /* Provider sets the packet and byte counts, we do the rest. */
6121 ogs.ref_count = group_get_ref_count(group);
6122 ogs.n_buckets = group->n_buckets;
6124 error = (ofproto->ofproto_class->group_get_stats
6125 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
6128 ogs.packet_count = UINT64_MAX;
6129 ogs.byte_count = UINT64_MAX;
6130 memset(ogs.bucket_stats, 0xff,
6131 ogs.n_buckets * sizeof *ogs.bucket_stats);
6134 ogs.group_id = group->group_id;
6135 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
6137 ofputil_append_group_stats(replies, &ogs);
6139 free(ogs.bucket_stats);
6143 handle_group_request(struct ofconn *ofconn,
6144 const struct ofp_header *request, uint32_t group_id,
6145 void (*cb)(struct ofgroup *, struct ovs_list *replies))
6147 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6148 struct ofgroup *group;
6149 struct ovs_list replies;
6151 ofpmp_init(&replies, request);
6152 if (group_id == OFPG_ALL) {
6153 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6154 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
6155 cb(group, &replies);
6157 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6159 if (ofproto_group_lookup(ofproto, group_id, &group)) {
6160 cb(group, &replies);
6161 ofproto_group_unref(group);
6164 ofconn_send_replies(ofconn, &replies);
6168 handle_group_stats_request(struct ofconn *ofconn,
6169 const struct ofp_header *request)
6174 error = ofputil_decode_group_stats_request(request, &group_id);
6179 handle_group_request(ofconn, request, group_id, append_group_stats);
6184 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
6186 struct ofputil_group_desc gds;
6188 gds.group_id = group->group_id;
6189 gds.type = group->type;
6190 gds.props = group->props;
6192 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
6196 handle_group_desc_stats_request(struct ofconn *ofconn,
6197 const struct ofp_header *request)
6199 handle_group_request(ofconn, request,
6200 ofputil_decode_group_desc_request(request),
6206 handle_group_features_stats_request(struct ofconn *ofconn,
6207 const struct ofp_header *request)
6209 struct ofproto *p = ofconn_get_ofproto(ofconn);
6212 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6214 ofconn_send_reply(ofconn, msg);
6221 put_queue_get_config_reply(struct ofport *port, uint32_t queue,
6222 struct ovs_list *replies)
6224 struct ofputil_queue_config qc;
6226 /* None of the existing queues have compatible properties, so we hard-code
6227 * omitting min_rate and max_rate. */
6228 qc.port = port->ofp_port;
6230 qc.min_rate = UINT16_MAX;
6231 qc.max_rate = UINT16_MAX;
6232 ofputil_append_queue_get_config_reply(&qc, replies);
6236 handle_queue_get_config_request_for_port(struct ofport *port, uint32_t queue,
6237 struct ovs_list *replies)
6239 struct smap details = SMAP_INITIALIZER(&details);
6240 if (queue != OFPQ_ALL) {
6241 int error = netdev_get_queue(port->netdev, queue, &details);
6244 put_queue_get_config_reply(port, queue, replies);
6248 return OFPERR_OFPQOFC_BAD_QUEUE;
6250 return OFPERR_NXQOFC_QUEUE_ERROR;
6253 struct netdev_queue_dump queue_dump;
6256 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump,
6258 put_queue_get_config_reply(port, queue_id, replies);
6261 smap_destroy(&details);
6266 handle_queue_get_config_request(struct ofconn *ofconn,
6267 const struct ofp_header *oh)
6269 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6270 struct ovs_list replies;
6271 struct ofport *port;
6272 ofp_port_t req_port;
6276 error = ofputil_decode_queue_get_config_request(oh, &req_port, &req_queue);
6281 ofputil_start_queue_get_config_reply(oh, &replies);
6282 if (req_port == OFPP_ANY) {
6283 error = OFPERR_OFPQOFC_BAD_QUEUE;
6284 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
6285 if (!handle_queue_get_config_request_for_port(port, req_queue,
6291 port = ofproto_get_port(ofproto, req_port);
6293 ? handle_queue_get_config_request_for_port(port, req_queue,
6295 : OFPERR_OFPQOFC_BAD_PORT);
6298 ofconn_send_replies(ofconn, &replies);
6300 ofpbuf_list_delete(&replies);
6307 init_group(struct ofproto *ofproto, const struct ofputil_group_mod *gm,
6308 struct ofgroup **ofgroup)
6311 const long long int now = time_msec();
6313 if (gm->group_id > OFPG_MAX) {
6314 return OFPERR_OFPGMFC_INVALID_GROUP;
6316 if (gm->type > OFPGT11_FF) {
6317 return OFPERR_OFPGMFC_BAD_TYPE;
6320 *ofgroup = ofproto->ofproto_class->group_alloc();
6322 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6323 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6326 (*ofgroup)->ofproto = ofproto;
6327 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6328 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6329 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6330 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6331 ovs_refcount_init(&(*ofgroup)->ref_count);
6333 list_init(&(*ofgroup)->buckets);
6334 ofputil_bucket_clone_list(&(*ofgroup)->buckets, &gm->buckets, NULL);
6336 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6337 list_size(&(*ofgroup)->buckets);
6339 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6340 &gm->props, sizeof (struct ofputil_group_props));
6342 /* Construct called BEFORE any locks are held. */
6343 error = ofproto->ofproto_class->group_construct(*ofgroup);
6345 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6346 ofproto->ofproto_class->group_dealloc(*ofgroup);
6351 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6352 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6355 add_group(struct ofproto *ofproto, const struct ofputil_group_mod *gm)
6357 struct ofgroup *ofgroup;
6360 /* Allocate new group and initialize it. */
6361 error = init_group(ofproto, gm, &ofgroup);
6366 /* We wrlock as late as possible to minimize the time we jam any other
6367 * threads: No visible state changes before acquiring the lock. */
6368 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6370 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6371 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6375 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6376 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6381 /* Insert new group. */
6382 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6383 hash_int(ofgroup->group_id, 0));
6384 ofproto->n_groups[ofgroup->type]++;
6386 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6391 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6392 ofproto->ofproto_class->group_destruct(ofgroup);
6393 ofputil_bucket_list_destroy(&ofgroup->buckets);
6394 ofproto->ofproto_class->group_dealloc(ofgroup);
6399 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6400 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6401 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6402 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6405 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6406 struct ofgroup *new_ofgroup,
6407 uint32_t command_bucket_id)
6409 struct ofputil_bucket *last = NULL;
6411 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6412 /* Check here to ensure that a bucket corresponding to
6413 * command_bucket_id exists in the old bucket list.
6415 * The subsequent search of below of new_ofgroup covers
6416 * both buckets in the old bucket list and buckets added
6417 * by the insert buckets group mod message this function processes. */
6418 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6419 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6422 if (!list_is_empty(&new_ofgroup->buckets)) {
6423 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6427 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6429 if (ofputil_bucket_check_duplicate_id(&new_ofgroup->buckets)) {
6430 VLOG_INFO_RL(&rl, "Duplicate bucket id");
6431 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6434 /* Rearrange list according to command_bucket_id */
6435 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6436 if (!list_is_empty(&ofgroup->buckets)) {
6437 struct ofputil_bucket *new_first;
6438 const struct ofputil_bucket *first;
6440 first = ofputil_bucket_list_front(&ofgroup->buckets);
6441 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6444 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6445 &new_ofgroup->buckets);
6447 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6448 struct ofputil_bucket *after;
6450 /* Presence of bucket is checked above so after should never be NULL */
6451 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6453 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6454 last->list_node.next);
6460 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6461 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6462 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6463 * and OFPG15_BUCKET_ALL are also honored. */
6465 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6466 struct ofgroup *new_ofgroup,
6467 uint32_t command_bucket_id)
6469 const struct ofputil_bucket *skip = NULL;
6471 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6475 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6476 if (!list_is_empty(&ofgroup->buckets)) {
6477 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6479 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6480 if (!list_is_empty(&ofgroup->buckets)) {
6481 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6484 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6486 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6490 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6495 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6496 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6499 * Note that the group is re-created and then replaces the old group in
6500 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6501 * the xlate module hold a pointer to the group. */
6503 modify_group(struct ofproto *ofproto, const struct ofputil_group_mod *gm)
6505 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6508 error = init_group(ofproto, gm, &new_ofgroup);
6513 retiring = new_ofgroup;
6515 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6516 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6517 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6521 /* Ofproto's group write lock is held now. */
6522 if (ofgroup->type != gm->type
6523 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6524 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6528 /* Manipulate bucket list for bucket commands */
6529 if (gm->command == OFPGC15_INSERT_BUCKET) {
6530 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6531 gm->command_bucket_id);
6532 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6533 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6534 gm->command_bucket_id);
6540 /* The group creation time does not change during modification. */
6541 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6542 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6544 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6550 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6551 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6552 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6553 hash_int(new_ofgroup->group_id, 0));
6554 if (ofgroup->type != new_ofgroup->type) {
6555 ofproto->n_groups[ofgroup->type]--;
6556 ofproto->n_groups[new_ofgroup->type]++;
6560 ofproto_group_unref(retiring);
6561 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6566 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6567 OVS_RELEASES(ofproto->groups_rwlock)
6570 struct ofproto_flow_mod ofm;
6572 /* Delete all flow entries containing this group in a group action */
6573 match_init_catchall(&match);
6574 flow_mod_init(&ofm.fm, &match, 0, NULL, 0, OFPFC_DELETE);
6575 ofm.fm.delete_reason = OFPRR_GROUP_DELETE;
6576 ofm.fm.out_group = ofgroup->group_id;
6577 ofm.fm.table_id = OFPTT_ALL;
6578 handle_flow_mod__(ofproto, &ofm, NULL);
6580 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6581 /* No-one can find this group any more. */
6582 ofproto->n_groups[ofgroup->type]--;
6583 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6584 ofproto_group_unref(ofgroup);
6587 /* Implements OFPGC11_DELETE. */
6589 delete_group(struct ofproto *ofproto, uint32_t group_id)
6591 struct ofgroup *ofgroup;
6593 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6594 if (group_id == OFPG_ALL) {
6596 struct hmap_node *node = hmap_first(&ofproto->groups);
6600 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6601 delete_group__(ofproto, ofgroup);
6602 /* Lock for each node separately, so that we will not jam the
6603 * other threads for too long time. */
6604 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6607 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6608 hash_int(group_id, 0), &ofproto->groups) {
6609 if (ofgroup->group_id == group_id) {
6610 delete_group__(ofproto, ofgroup);
6615 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6618 /* Delete all groups from 'ofproto'.
6620 * This is intended for use within an ofproto provider's 'destruct'
6623 ofproto_group_delete_all(struct ofproto *ofproto)
6625 delete_group(ofproto, OFPG_ALL);
6629 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6631 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6632 struct ofputil_group_mod gm;
6635 error = reject_slave_controller(ofconn);
6640 error = ofputil_decode_group_mod(oh, &gm);
6645 switch (gm.command) {
6647 error = add_group(ofproto, &gm);
6650 case OFPGC11_MODIFY:
6651 error = modify_group(ofproto, &gm);
6654 case OFPGC11_DELETE:
6655 delete_group(ofproto, gm.group_id);
6659 case OFPGC15_INSERT_BUCKET:
6660 error = modify_group(ofproto, &gm);
6663 case OFPGC15_REMOVE_BUCKET:
6664 error = modify_group(ofproto, &gm);
6668 if (gm.command > OFPGC11_DELETE) {
6669 VLOG_INFO_RL(&rl, "%s: Invalid group_mod command type %d",
6670 ofproto->name, gm.command);
6672 error = OFPERR_OFPGMFC_BAD_COMMAND;
6676 struct ofputil_requestforward rf;
6678 rf.reason = OFPRFR_GROUP_MOD;
6680 connmgr_send_requestforward(ofproto->connmgr, ofconn, &rf);
6682 ofputil_bucket_list_destroy(&gm.buckets);
6687 enum ofputil_table_miss
6688 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6690 enum ofputil_table_miss miss;
6692 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &miss);
6697 table_mod__(struct oftable *oftable,
6698 const struct ofputil_table_mod *tm)
6700 if (tm->miss == OFPUTIL_TABLE_MISS_DEFAULT) {
6701 /* This is how an OFPT_TABLE_MOD decodes if it doesn't specify any
6702 * table-miss configuration (because the protocol used doesn't have
6703 * such a concept), so there's nothing to do. */
6705 atomic_store_relaxed(&oftable->miss_config, tm->miss);
6708 unsigned int new_eviction = oftable->eviction;
6709 if (tm->eviction == OFPUTIL_TABLE_EVICTION_ON) {
6710 new_eviction |= EVICTION_OPENFLOW;
6711 } else if (tm->eviction == OFPUTIL_TABLE_EVICTION_OFF) {
6712 new_eviction &= ~EVICTION_OPENFLOW;
6715 if (new_eviction != oftable->eviction) {
6716 ovs_mutex_lock(&ofproto_mutex);
6717 oftable_configure_eviction(oftable, new_eviction,
6718 oftable->eviction_fields,
6719 oftable->n_eviction_fields);
6720 ovs_mutex_unlock(&ofproto_mutex);
6723 if (tm->vacancy != OFPUTIL_TABLE_VACANCY_DEFAULT) {
6724 ovs_mutex_lock(&ofproto_mutex);
6725 oftable->vacancy_enabled = (tm->vacancy == OFPUTIL_TABLE_VACANCY_ON
6726 ? OFPTC14_VACANCY_EVENTS
6728 oftable->vacancy_down = tm->table_vacancy.vacancy_down;
6729 oftable->vacancy_up = tm->table_vacancy.vacancy_up;
6730 ovs_mutex_unlock(&ofproto_mutex);
6735 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6737 if (!check_table_id(ofproto, tm->table_id)) {
6738 return OFPERR_OFPTMFC_BAD_TABLE;
6741 /* Don't allow the eviction flags to be changed (except to the only fixed
6742 * value that OVS supports). OF1.4 says this is normal: "The
6743 * OFPTMPT_EVICTION property usually cannot be modified using a
6744 * OFP_TABLE_MOD request, because the eviction mechanism is switch
6746 if (tm->eviction_flags != UINT32_MAX
6747 && tm->eviction_flags != OFPROTO_EVICTION_FLAGS) {
6748 return OFPERR_OFPTMFC_BAD_CONFIG;
6751 if (tm->table_id == OFPTT_ALL) {
6752 struct oftable *oftable;
6753 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6754 if (!(oftable->flags & (OFTABLE_HIDDEN | OFTABLE_READONLY))) {
6755 table_mod__(oftable, tm);
6759 struct oftable *oftable = &ofproto->tables[tm->table_id];
6760 if (oftable->flags & OFTABLE_READONLY) {
6761 return OFPERR_OFPTMFC_EPERM;
6763 table_mod__(oftable, tm);
6770 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6772 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6773 struct ofputil_table_mod tm;
6776 error = reject_slave_controller(ofconn);
6781 error = ofputil_decode_table_mod(oh, &tm);
6786 return table_mod(ofproto, &tm);
6790 ofproto_flow_mod_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6791 OVS_REQUIRES(ofproto_mutex)
6793 switch (ofm->fm.command) {
6795 return add_flow_start(ofproto, ofm);
6796 /* , &be->old_rules.stub[0],
6797 &be->new_rules.stub[0]); */
6799 return modify_flows_start_loose(ofproto, ofm);
6800 case OFPFC_MODIFY_STRICT:
6801 return modify_flow_start_strict(ofproto, ofm);
6803 return delete_flows_start_loose(ofproto, ofm);
6805 case OFPFC_DELETE_STRICT:
6806 return delete_flow_start_strict(ofproto, ofm);
6809 return OFPERR_OFPFMFC_BAD_COMMAND;
6813 ofproto_flow_mod_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6814 OVS_REQUIRES(ofproto_mutex)
6816 switch (ofm->fm.command) {
6818 add_flow_revert(ofproto, ofm);
6822 case OFPFC_MODIFY_STRICT:
6823 modify_flows_revert(ofproto, ofm);
6827 case OFPFC_DELETE_STRICT:
6828 delete_flows_revert(ofproto, ofm);
6837 ofproto_flow_mod_finish(struct ofproto *ofproto,
6838 struct ofproto_flow_mod *ofm,
6839 const struct flow_mod_requester *req)
6840 OVS_REQUIRES(ofproto_mutex)
6842 switch (ofm->fm.command) {
6844 add_flow_finish(ofproto, ofm, req);
6848 case OFPFC_MODIFY_STRICT:
6849 modify_flows_finish(ofproto, ofm, req);
6853 case OFPFC_DELETE_STRICT:
6854 delete_flows_finish(ofproto, ofm, req);
6862 /* Commit phases (all while locking ofproto_mutex):
6864 * 1. Begin: Gather resources and make changes visible in the next version.
6865 * - Mark affected rules for removal in the next version.
6866 * - Create new replacement rules, make visible in the next
6868 * - Do not send any events or notifications.
6870 * 2. Revert: Fail if any errors are found. After this point no errors are
6871 * possible. No visible changes were made, so rollback is minimal (remove
6872 * added invisible rules, restore visibility of rules marked for removal).
6874 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
6875 * the ofproto provider. Remove replaced and deleted rules from ofproto data
6876 * structures, and Schedule postponed removal of deleted rules from the
6877 * classifier. Send notifications, buffered packets, etc.
6880 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6882 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6883 cls_version_t version = ofproto->tables_version + 1;
6884 struct ofp_bundle *bundle;
6885 struct ofp_bundle_entry *be;
6888 bundle = ofconn_get_bundle(ofconn, id);
6891 return OFPERR_OFPBFC_BAD_ID;
6893 if (bundle->flags != flags) {
6894 error = OFPERR_OFPBFC_BAD_FLAGS;
6896 bool prev_is_port_mod = false;
6899 ovs_mutex_lock(&ofproto_mutex);
6902 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6903 if (be->type == OFPTYPE_PORT_MOD) {
6904 /* Our port mods are not atomic. */
6905 if (flags & OFPBF_ATOMIC) {
6906 error = OFPERR_OFPBFC_MSG_FAILED;
6908 prev_is_port_mod = true;
6909 error = port_mod_start(ofconn, &be->opm.pm, &be->opm.port);
6911 } else if (be->type == OFPTYPE_FLOW_MOD) {
6912 /* Flow mods between port mods are applied as a single
6913 * version, but the versions are published only after
6914 * we know the commit is successful. */
6915 if (prev_is_port_mod) {
6918 prev_is_port_mod = false;
6919 /* Store the version in which the changes should take
6921 be->ofm.version = version;
6922 error = ofproto_flow_mod_start(ofproto, &be->ofm);
6932 /* Send error referring to the original message. */
6934 ofconn_send_error(ofconn, be->ofp_msg, error);
6935 error = OFPERR_OFPBFC_MSG_FAILED;
6938 /* 2. Revert. Undo all the changes made above. */
6939 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6940 if (be->type == OFPTYPE_FLOW_MOD) {
6941 ofproto_flow_mod_revert(ofproto, &be->ofm);
6943 /* Nothing needs to be reverted for a port mod. */
6947 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6948 if (be->type == OFPTYPE_FLOW_MOD) {
6949 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6951 /* Bump the lookup version to the one of the current
6952 * message. This makes all the changes in the bundle at
6953 * this version visible to lookups at once. */
6954 if (ofproto->tables_version < be->ofm.version) {
6955 ofproto->tables_version = be->ofm.version;
6956 ofproto->ofproto_class->set_tables_version(
6957 ofproto, ofproto->tables_version);
6960 ofproto_flow_mod_finish(ofproto, &be->ofm, &req);
6961 } else if (be->type == OFPTYPE_PORT_MOD) {
6962 /* Perform the actual port mod. This is not atomic, i.e.,
6963 * the effects will be immediately seen by upcall
6964 * processing regardless of the lookup version. It should
6965 * be noted that port configuration changes can originate
6966 * also from OVSDB changes asynchronously to all upcall
6968 port_mod_finish(ofconn, &be->opm.pm, be->opm.port);
6973 ofmonitor_flush(ofproto->connmgr);
6974 ovs_mutex_unlock(&ofproto_mutex);
6976 run_rule_executes(ofproto);
6979 /* The bundle is discarded regardless the outcome. */
6980 ofp_bundle_remove__(ofconn, bundle, !error);
6985 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6987 struct ofputil_bundle_ctrl_msg bctrl;
6988 struct ofputil_bundle_ctrl_msg reply;
6992 error = reject_slave_controller(ofconn);
6997 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
7002 reply.bundle_id = bctrl.bundle_id;
7004 switch (bctrl.type) {
7005 case OFPBCT_OPEN_REQUEST:
7006 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
7007 reply.type = OFPBCT_OPEN_REPLY;
7009 case OFPBCT_CLOSE_REQUEST:
7010 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
7011 reply.type = OFPBCT_CLOSE_REPLY;
7013 case OFPBCT_COMMIT_REQUEST:
7014 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
7015 reply.type = OFPBCT_COMMIT_REPLY;
7017 case OFPBCT_DISCARD_REQUEST:
7018 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
7019 reply.type = OFPBCT_DISCARD_REPLY;
7022 case OFPBCT_OPEN_REPLY:
7023 case OFPBCT_CLOSE_REPLY:
7024 case OFPBCT_COMMIT_REPLY:
7025 case OFPBCT_DISCARD_REPLY:
7026 return OFPERR_OFPBFC_BAD_TYPE;
7031 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
7032 ofconn_send_reply(ofconn, buf);
7038 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
7040 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
7042 struct ofputil_bundle_add_msg badd;
7043 struct ofp_bundle_entry *bmsg;
7046 error = reject_slave_controller(ofconn);
7051 error = ofputil_decode_bundle_add(oh, &badd, &type);
7056 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
7058 if (type == OFPTYPE_PORT_MOD) {
7059 error = ofputil_decode_port_mod(badd.msg, &bmsg->opm.pm, false);
7060 } else if (type == OFPTYPE_FLOW_MOD) {
7061 struct ofpbuf ofpacts;
7062 uint64_t ofpacts_stub[1024 / 8];
7064 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
7065 error = ofputil_decode_flow_mod(&bmsg->ofm.fm, badd.msg,
7066 ofconn_get_protocol(ofconn),
7068 u16_to_ofp(ofproto->max_ports),
7070 /* Move actions to heap. */
7071 bmsg->ofm.fm.ofpacts = ofpbuf_steal_data(&ofpacts);
7073 if (!error && bmsg->ofm.fm.ofpacts_len) {
7074 error = ofproto_check_ofpacts(ofproto, bmsg->ofm.fm.ofpacts,
7075 bmsg->ofm.fm.ofpacts_len);
7082 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
7087 ofp_bundle_entry_free(bmsg);
7094 handle_tlv_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
7096 struct ofputil_tlv_table_mod ttm;
7099 error = reject_slave_controller(ofconn);
7104 error = ofputil_decode_tlv_table_mod(oh, &ttm);
7109 error = tun_metadata_table_mod(&ttm);
7111 ofputil_uninit_tlv_table(&ttm.mappings);
7116 handle_tlv_table_request(struct ofconn *ofconn, const struct ofp_header *oh)
7118 struct ofputil_tlv_table_reply ttr;
7121 tun_metadata_table_request(&ttr);
7122 b = ofputil_encode_tlv_table_reply(oh, &ttr);
7123 ofputil_uninit_tlv_table(&ttr.mappings);
7125 ofconn_send_reply(ofconn, b);
7130 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
7131 OVS_EXCLUDED(ofproto_mutex)
7133 const struct ofp_header *oh = msg->data;
7137 error = ofptype_decode(&type, oh);
7141 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
7142 && ofpmp_more(oh)) {
7143 /* We have no buffer implementation for multipart requests.
7144 * Report overflow for requests which consists of multiple
7146 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
7150 /* OpenFlow requests. */
7151 case OFPTYPE_ECHO_REQUEST:
7152 return handle_echo_request(ofconn, oh);
7154 case OFPTYPE_FEATURES_REQUEST:
7155 return handle_features_request(ofconn, oh);
7157 case OFPTYPE_GET_CONFIG_REQUEST:
7158 return handle_get_config_request(ofconn, oh);
7160 case OFPTYPE_SET_CONFIG:
7161 return handle_set_config(ofconn, oh);
7163 case OFPTYPE_PACKET_OUT:
7164 return handle_packet_out(ofconn, oh);
7166 case OFPTYPE_PORT_MOD:
7167 return handle_port_mod(ofconn, oh);
7169 case OFPTYPE_FLOW_MOD:
7170 return handle_flow_mod(ofconn, oh);
7172 case OFPTYPE_GROUP_MOD:
7173 return handle_group_mod(ofconn, oh);
7175 case OFPTYPE_TABLE_MOD:
7176 return handle_table_mod(ofconn, oh);
7178 case OFPTYPE_METER_MOD:
7179 return handle_meter_mod(ofconn, oh);
7181 case OFPTYPE_BARRIER_REQUEST:
7182 return handle_barrier_request(ofconn, oh);
7184 case OFPTYPE_ROLE_REQUEST:
7185 return handle_role_request(ofconn, oh);
7187 /* OpenFlow replies. */
7188 case OFPTYPE_ECHO_REPLY:
7191 /* Nicira extension requests. */
7192 case OFPTYPE_FLOW_MOD_TABLE_ID:
7193 return handle_nxt_flow_mod_table_id(ofconn, oh);
7195 case OFPTYPE_SET_FLOW_FORMAT:
7196 return handle_nxt_set_flow_format(ofconn, oh);
7198 case OFPTYPE_SET_PACKET_IN_FORMAT:
7199 return handle_nxt_set_packet_in_format(ofconn, oh);
7201 case OFPTYPE_SET_CONTROLLER_ID:
7202 return handle_nxt_set_controller_id(ofconn, oh);
7204 case OFPTYPE_FLOW_AGE:
7205 /* Nothing to do. */
7208 case OFPTYPE_FLOW_MONITOR_CANCEL:
7209 return handle_flow_monitor_cancel(ofconn, oh);
7211 case OFPTYPE_SET_ASYNC_CONFIG:
7212 return handle_nxt_set_async_config(ofconn, oh);
7214 case OFPTYPE_GET_ASYNC_REQUEST:
7215 return handle_nxt_get_async_request(ofconn, oh);
7217 /* Statistics requests. */
7218 case OFPTYPE_DESC_STATS_REQUEST:
7219 return handle_desc_stats_request(ofconn, oh);
7221 case OFPTYPE_FLOW_STATS_REQUEST:
7222 return handle_flow_stats_request(ofconn, oh);
7224 case OFPTYPE_AGGREGATE_STATS_REQUEST:
7225 return handle_aggregate_stats_request(ofconn, oh);
7227 case OFPTYPE_TABLE_STATS_REQUEST:
7228 return handle_table_stats_request(ofconn, oh);
7230 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
7231 return handle_table_features_request(ofconn, oh);
7233 case OFPTYPE_TABLE_DESC_REQUEST:
7234 return handle_table_desc_request(ofconn, oh);
7236 case OFPTYPE_PORT_STATS_REQUEST:
7237 return handle_port_stats_request(ofconn, oh);
7239 case OFPTYPE_QUEUE_STATS_REQUEST:
7240 return handle_queue_stats_request(ofconn, oh);
7242 case OFPTYPE_PORT_DESC_STATS_REQUEST:
7243 return handle_port_desc_stats_request(ofconn, oh);
7245 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
7246 return handle_flow_monitor_request(ofconn, oh);
7248 case OFPTYPE_METER_STATS_REQUEST:
7249 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
7250 return handle_meter_request(ofconn, oh, type);
7252 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
7253 return handle_meter_features_request(ofconn, oh);
7255 case OFPTYPE_GROUP_STATS_REQUEST:
7256 return handle_group_stats_request(ofconn, oh);
7258 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
7259 return handle_group_desc_stats_request(ofconn, oh);
7261 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
7262 return handle_group_features_stats_request(ofconn, oh);
7264 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
7265 return handle_queue_get_config_request(ofconn, oh);
7267 case OFPTYPE_BUNDLE_CONTROL:
7268 return handle_bundle_control(ofconn, oh);
7270 case OFPTYPE_BUNDLE_ADD_MESSAGE:
7271 return handle_bundle_add(ofconn, oh);
7273 case OFPTYPE_NXT_TLV_TABLE_MOD:
7274 return handle_tlv_table_mod(ofconn, oh);
7276 case OFPTYPE_NXT_TLV_TABLE_REQUEST:
7277 return handle_tlv_table_request(ofconn, oh);
7281 case OFPTYPE_FEATURES_REPLY:
7282 case OFPTYPE_GET_CONFIG_REPLY:
7283 case OFPTYPE_PACKET_IN:
7284 case OFPTYPE_FLOW_REMOVED:
7285 case OFPTYPE_PORT_STATUS:
7286 case OFPTYPE_BARRIER_REPLY:
7287 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
7288 case OFPTYPE_DESC_STATS_REPLY:
7289 case OFPTYPE_FLOW_STATS_REPLY:
7290 case OFPTYPE_QUEUE_STATS_REPLY:
7291 case OFPTYPE_PORT_STATS_REPLY:
7292 case OFPTYPE_TABLE_STATS_REPLY:
7293 case OFPTYPE_AGGREGATE_STATS_REPLY:
7294 case OFPTYPE_PORT_DESC_STATS_REPLY:
7295 case OFPTYPE_ROLE_REPLY:
7296 case OFPTYPE_FLOW_MONITOR_PAUSED:
7297 case OFPTYPE_FLOW_MONITOR_RESUMED:
7298 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
7299 case OFPTYPE_GET_ASYNC_REPLY:
7300 case OFPTYPE_GROUP_STATS_REPLY:
7301 case OFPTYPE_GROUP_DESC_STATS_REPLY:
7302 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
7303 case OFPTYPE_METER_STATS_REPLY:
7304 case OFPTYPE_METER_CONFIG_STATS_REPLY:
7305 case OFPTYPE_METER_FEATURES_STATS_REPLY:
7306 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
7307 case OFPTYPE_TABLE_DESC_REPLY:
7308 case OFPTYPE_ROLE_STATUS:
7309 case OFPTYPE_REQUESTFORWARD:
7310 case OFPTYPE_NXT_TLV_TABLE_REPLY:
7312 if (ofpmsg_is_stat_request(oh)) {
7313 return OFPERR_OFPBRC_BAD_STAT;
7315 return OFPERR_OFPBRC_BAD_TYPE;
7321 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
7322 OVS_EXCLUDED(ofproto_mutex)
7324 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
7327 ofconn_send_error(ofconn, ofp_msg->data, error);
7329 COVERAGE_INC(ofproto_recv_openflow);
7332 /* Asynchronous operations. */
7335 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
7337 OVS_REQUIRES(ofproto_mutex)
7339 if (req && req->ofconn && buffer_id != UINT32_MAX) {
7340 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
7341 struct dp_packet *packet;
7345 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
7348 struct rule_execute *re;
7350 ofproto_rule_ref(rule);
7352 re = xmalloc(sizeof *re);
7354 re->in_port = in_port;
7355 re->packet = packet;
7357 if (!guarded_list_push_back(&ofproto->rule_executes,
7358 &re->list_node, 1024)) {
7359 ofproto_rule_unref(rule);
7360 dp_packet_delete(re->packet);
7364 ofconn_send_error(req->ofconn, req->request, error);
7370 pick_datapath_id(const struct ofproto *ofproto)
7372 const struct ofport *port;
7374 port = ofproto_get_port(ofproto, OFPP_LOCAL);
7379 error = netdev_get_etheraddr(port->netdev, &ea);
7381 return eth_addr_to_uint64(ea);
7383 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7384 ofproto->name, netdev_get_name(port->netdev),
7385 ovs_strerror(error));
7387 return ofproto->fallback_dpid;
7391 pick_fallback_dpid(void)
7394 eth_addr_nicira_random(&ea);
7395 return eth_addr_to_uint64(ea);
7398 /* Table overflow policy. */
7400 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7401 * to NULL if the table is not configured to evict rules or if the table
7402 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7403 * or with no timeouts are not evictable.) */
7405 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
7406 OVS_REQUIRES(ofproto_mutex)
7408 struct eviction_group *evg;
7411 if (!table->eviction) {
7415 /* In the common case, the outer and inner loops here will each be entered
7418 * - The inner loop normally "return"s in its first iteration. If the
7419 * eviction group has any evictable rules, then it always returns in
7422 * - The outer loop only iterates more than once if the largest eviction
7423 * group has no evictable rules.
7425 * - The outer loop can exit only if table's 'max_flows' is all filled up
7426 * by unevictable rules. */
7427 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7430 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7439 /* Eviction groups. */
7441 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7442 * rules. The priority contains low-order random bits to ensure that eviction
7443 * groups with the same number of rules are prioritized randomly. */
7445 eviction_group_priority(size_t n_rules)
7447 uint16_t size = MIN(UINT16_MAX, n_rules);
7448 return (size << 16) | random_uint16();
7451 /* Updates 'evg', an eviction_group within 'table', following a change that
7452 * adds or removes rules in 'evg'. */
7454 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7455 OVS_REQUIRES(ofproto_mutex)
7457 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7458 eviction_group_priority(heap_count(&evg->rules)));
7461 /* Destroys 'evg', an eviction_group within 'table':
7463 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7464 * rules themselves, just removes them from the eviction group.)
7466 * - Removes 'evg' from 'table'.
7470 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7471 OVS_REQUIRES(ofproto_mutex)
7473 while (!heap_is_empty(&evg->rules)) {
7476 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7477 rule->eviction_group = NULL;
7479 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7480 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7481 heap_destroy(&evg->rules);
7485 /* Removes 'rule' from its eviction group, if any. */
7487 eviction_group_remove_rule(struct rule *rule)
7488 OVS_REQUIRES(ofproto_mutex)
7490 if (rule->eviction_group) {
7491 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7492 struct eviction_group *evg = rule->eviction_group;
7494 rule->eviction_group = NULL;
7495 heap_remove(&evg->rules, &rule->evg_node);
7496 if (heap_is_empty(&evg->rules)) {
7497 eviction_group_destroy(table, evg);
7499 eviction_group_resized(table, evg);
7504 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7505 * returns the hash value. */
7507 eviction_group_hash_rule(struct rule *rule)
7508 OVS_REQUIRES(ofproto_mutex)
7510 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7511 const struct mf_subfield *sf;
7515 hash = table->eviction_group_id_basis;
7516 miniflow_expand(rule->cr.match.flow, &flow);
7517 for (sf = table->eviction_fields;
7518 sf < &table->eviction_fields[table->n_eviction_fields];
7521 if (mf_are_prereqs_ok(sf->field, &flow)) {
7522 union mf_value value;
7524 mf_get_value(sf->field, &flow, &value);
7526 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7528 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7529 unsigned int start = sf->ofs + sf->n_bits;
7530 bitwise_zero(&value, sf->field->n_bytes, start,
7531 sf->field->n_bytes * 8 - start);
7533 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7535 hash = hash_int(hash, 0);
7542 /* Returns an eviction group within 'table' with the given 'id', creating one
7544 static struct eviction_group *
7545 eviction_group_find(struct oftable *table, uint32_t id)
7546 OVS_REQUIRES(ofproto_mutex)
7548 struct eviction_group *evg;
7550 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7554 evg = xmalloc(sizeof *evg);
7555 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7556 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7557 eviction_group_priority(0));
7558 heap_init(&evg->rules);
7563 /* Returns an eviction priority for 'rule'. The return value should be
7564 * interpreted so that higher priorities make a rule a more attractive
7565 * candidate for eviction. */
7567 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7568 OVS_REQUIRES(ofproto_mutex)
7570 /* Calculate absolute time when this flow will expire. If it will never
7571 * expire, then return 0 to make it unevictable. */
7572 long long int expiration = LLONG_MAX;
7573 if (rule->hard_timeout) {
7574 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7575 ovs_mutex_lock(&rule->mutex);
7576 long long int modified = rule->modified;
7577 ovs_mutex_unlock(&rule->mutex);
7579 expiration = modified + rule->hard_timeout * 1000;
7581 if (rule->idle_timeout) {
7582 uint64_t packets, bytes;
7584 long long int idle_expiration;
7586 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7587 idle_expiration = used + rule->idle_timeout * 1000;
7588 expiration = MIN(expiration, idle_expiration);
7590 if (expiration == LLONG_MAX) {
7594 /* Calculate the time of expiration as a number of (approximate) seconds
7595 * after program startup.
7597 * This should work OK for program runs that last UINT32_MAX seconds or
7598 * less. Therefore, please restart OVS at least once every 136 years. */
7599 uint32_t expiration_ofs = (expiration >> 10) - (time_boot_msec() >> 10);
7601 /* Combine expiration time with OpenFlow "importance" to form a single
7602 * priority value. We want flows with relatively low "importance" to be
7603 * evicted before even considering expiration time, so put "importance" in
7604 * the most significant bits and expiration time in the least significant
7607 * Small 'priority' should be evicted before those with large 'priority'.
7608 * The caller expects the opposite convention (a large return value being
7609 * more attractive for eviction) so we invert it before returning. */
7610 uint64_t priority = ((uint64_t) rule->importance << 32) + expiration_ofs;
7611 return UINT64_MAX - priority;
7614 /* Adds 'rule' to an appropriate eviction group for its oftable's
7615 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7616 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7619 * The caller must ensure that 'rule' is not already in an eviction group. */
7621 eviction_group_add_rule(struct rule *rule)
7622 OVS_REQUIRES(ofproto_mutex)
7624 struct ofproto *ofproto = rule->ofproto;
7625 struct oftable *table = &ofproto->tables[rule->table_id];
7628 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7629 * so no additional protection is needed. */
7630 has_timeout = rule->hard_timeout || rule->idle_timeout;
7632 if (table->eviction && has_timeout) {
7633 struct eviction_group *evg;
7635 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7637 rule->eviction_group = evg;
7638 heap_insert(&evg->rules, &rule->evg_node,
7639 rule_eviction_priority(ofproto, rule));
7640 eviction_group_resized(table, evg);
7646 /* Initializes 'table'. */
7648 oftable_init(struct oftable *table)
7650 memset(table, 0, sizeof *table);
7651 classifier_init(&table->cls, flow_segment_u64s);
7652 table->max_flows = UINT_MAX;
7654 hmap_init(&table->eviction_groups_by_id);
7655 heap_init(&table->eviction_groups_by_size);
7656 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7658 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7659 ARRAY_SIZE(default_prefix_fields));
7661 atomic_init(&table->n_matched, 0);
7662 atomic_init(&table->n_missed, 0);
7665 /* Destroys 'table', including its classifier and eviction groups.
7667 * The caller is responsible for freeing 'table' itself. */
7669 oftable_destroy(struct oftable *table)
7671 ovs_assert(classifier_is_empty(&table->cls));
7673 ovs_mutex_lock(&ofproto_mutex);
7674 oftable_configure_eviction(table, 0, NULL, 0);
7675 ovs_mutex_unlock(&ofproto_mutex);
7677 hmap_destroy(&table->eviction_groups_by_id);
7678 heap_destroy(&table->eviction_groups_by_size);
7679 classifier_destroy(&table->cls);
7683 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7684 * string, then 'table' will use its default name.
7686 * This only affects the name exposed for a table exposed through the OpenFlow
7687 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7689 oftable_set_name(struct oftable *table, const char *name)
7691 if (name && name[0]) {
7692 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7693 if (!table->name || strncmp(name, table->name, len)) {
7695 table->name = xmemdup0(name, len);
7703 /* oftables support a choice of two policies when adding a rule would cause the
7704 * number of flows in the table to exceed the configured maximum number: either
7705 * they can refuse to add the new flow or they can evict some existing flow.
7706 * This function configures the latter policy on 'table', with fairness based
7707 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7708 * 'n_fields' as 0 disables fairness.) */
7710 oftable_configure_eviction(struct oftable *table, unsigned int eviction,
7711 const struct mf_subfield *fields, size_t n_fields)
7712 OVS_REQUIRES(ofproto_mutex)
7716 if ((table->eviction != 0) == (eviction != 0)
7717 && n_fields == table->n_eviction_fields
7719 || !memcmp(fields, table->eviction_fields,
7720 n_fields * sizeof *fields))) {
7721 /* The set of eviction fields did not change. If 'eviction' changed,
7722 * it remains nonzero, so that we can just update table->eviction
7723 * without fussing with the eviction groups. */
7724 table->eviction = eviction;
7728 /* Destroy existing eviction groups, then destroy and recreate data
7729 * structures to recover memory. */
7730 struct eviction_group *evg, *next;
7731 HMAP_FOR_EACH_SAFE (evg, next, id_node, &table->eviction_groups_by_id) {
7732 eviction_group_destroy(table, evg);
7734 hmap_destroy(&table->eviction_groups_by_id);
7735 hmap_init(&table->eviction_groups_by_id);
7736 heap_destroy(&table->eviction_groups_by_size);
7737 heap_init(&table->eviction_groups_by_size);
7739 /* Replace eviction groups by the new ones, if there is a change. Free the
7740 * old fields only after allocating the new ones, because 'fields ==
7741 * table->eviction_fields' is possible. */
7742 struct mf_subfield *old_fields = table->eviction_fields;
7743 table->n_eviction_fields = n_fields;
7744 table->eviction_fields = (fields
7745 ? xmemdup(fields, n_fields * sizeof *fields)
7749 /* Add the new eviction groups, if enabled. */
7750 table->eviction = eviction;
7751 if (table->eviction) {
7752 table->eviction_group_id_basis = random_uint32();
7753 CLS_FOR_EACH (rule, cr, &table->cls) {
7754 eviction_group_add_rule(rule);
7759 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7760 * it to the classifier. */
7762 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7763 OVS_REQUIRES(ofproto_mutex)
7765 const struct rule_actions *actions = rule_get_actions(rule);
7767 ovs_assert(rule->removed);
7769 if (rule->hard_timeout || rule->idle_timeout) {
7770 list_insert(&ofproto->expirable, &rule->expirable);
7772 cookies_insert(ofproto, rule);
7773 eviction_group_add_rule(rule);
7774 if (actions->has_meter) {
7775 meter_insert_rule(rule);
7777 rule->removed = false;
7780 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7781 * the removal from the classifier. */
7783 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7784 OVS_REQUIRES(ofproto_mutex)
7786 ovs_assert(!rule->removed);
7788 cookies_remove(ofproto, rule);
7790 eviction_group_remove_rule(rule);
7791 if (!list_is_empty(&rule->expirable)) {
7792 list_remove(&rule->expirable);
7794 if (!list_is_empty(&rule->meter_list_node)) {
7795 list_remove(&rule->meter_list_node);
7796 list_init(&rule->meter_list_node);
7799 rule->removed = true;
7802 /* unixctl commands. */
7805 ofproto_lookup(const char *name)
7807 struct ofproto *ofproto;
7809 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7811 if (!strcmp(ofproto->name, name)) {
7819 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7820 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7822 struct ofproto *ofproto;
7826 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7827 ds_put_format(&results, "%s\n", ofproto->name);
7829 unixctl_command_reply(conn, ds_cstr(&results));
7830 ds_destroy(&results);
7834 ofproto_unixctl_init(void)
7836 static bool registered;
7842 unixctl_command_register("ofproto/list", "", 0, 0,
7843 ofproto_unixctl_list, NULL);
7846 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7848 * This is deprecated. It is only for compatibility with broken device drivers
7849 * in old versions of Linux that do not properly support VLANs when VLAN
7850 * devices are not used. When broken device drivers are no longer in
7851 * widespread use, we will delete these interfaces. */
7853 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7854 * (exactly) by an OpenFlow rule in 'ofproto'. */
7856 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7859 struct cls_rule target;
7860 const struct oftable *oftable;
7862 match_init_catchall(&match);
7863 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7864 cls_rule_init(&target, &match, 0);
7866 free(ofproto->vlan_bitmap);
7867 ofproto->vlan_bitmap = bitmap_allocate(4096);
7868 ofproto->vlans_changed = false;
7870 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7873 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target,
7875 if (minimask_get_vid_mask(rule->cr.match.mask) == VLAN_VID_MASK) {
7876 uint16_t vid = miniflow_get_vid(rule->cr.match.flow);
7878 bitmap_set1(vlan_bitmap, vid);
7879 bitmap_set1(ofproto->vlan_bitmap, vid);
7884 cls_rule_destroy(&target);
7887 /* Returns true if new VLANs have come into use by the flow table since the
7888 * last call to ofproto_get_vlan_usage().
7890 * We don't track when old VLANs stop being used. */
7892 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7894 return ofproto->vlans_changed;
7897 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7898 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7899 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7900 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7901 * then the VLAN device is un-enslaved. */
7903 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7904 ofp_port_t realdev_ofp_port, int vid)
7906 struct ofport *ofport;
7909 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7911 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7913 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7914 ofproto->name, vlandev_ofp_port);
7918 if (!ofproto->ofproto_class->set_realdev) {
7919 if (!vlandev_ofp_port) {
7922 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7926 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7928 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7929 ofproto->name, vlandev_ofp_port,
7930 netdev_get_name(ofport->netdev), ovs_strerror(error));