2 * Copyright (c) 2009-2015 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
47 #include "dp-packet.h"
51 #include "poll-loop.h"
59 #include "tun-metadata.h"
60 #include "unaligned.h"
62 #include "openvswitch/vlog.h"
65 VLOG_DEFINE_THIS_MODULE(ofproto);
67 COVERAGE_DEFINE(ofproto_flush);
68 COVERAGE_DEFINE(ofproto_packet_out);
69 COVERAGE_DEFINE(ofproto_queue_req);
70 COVERAGE_DEFINE(ofproto_recv_openflow);
71 COVERAGE_DEFINE(ofproto_reinit_ports);
72 COVERAGE_DEFINE(ofproto_update_port);
74 /* Default fields to use for prefix tries in each flow table, unless something
75 * else is configured. */
76 const enum mf_field_id default_prefix_fields[2] =
77 { MFF_IPV4_DST, MFF_IPV4_SRC };
80 static void oftable_init(struct oftable *);
81 static void oftable_destroy(struct oftable *);
83 static void oftable_set_name(struct oftable *, const char *name);
85 static enum ofperr evict_rules_from_table(struct oftable *)
86 OVS_REQUIRES(ofproto_mutex);
87 static void oftable_configure_eviction(struct oftable *,
88 unsigned int eviction,
89 const struct mf_subfield *fields,
91 OVS_REQUIRES(ofproto_mutex);
93 /* This is the only combination of OpenFlow eviction flags that OVS supports: a
94 * combination of OF1.4+ importance, the remaining lifetime of the flow, and
95 * fairness based on user-specified fields. */
96 #define OFPROTO_EVICTION_FLAGS \
97 (OFPTMPEF14_OTHER | OFPTMPEF14_IMPORTANCE | OFPTMPEF14_LIFETIME)
99 /* A set of rules within a single OpenFlow table (oftable) that have the same
100 * values for the oftable's eviction_fields. A rule to be evicted, when one is
101 * needed, is taken from the eviction group that contains the greatest number
104 * An oftable owns any number of eviction groups, each of which contains any
107 * Membership in an eviction group is imprecise, based on the hash of the
108 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
109 * That is, if two rules have different eviction_fields, but those
110 * eviction_fields hash to the same value, then they will belong to the same
111 * eviction_group anyway.
113 * (When eviction is not enabled on an oftable, we don't track any eviction
114 * groups, to save time and space.) */
115 struct eviction_group {
116 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
117 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
118 struct heap rules; /* Contains "struct rule"s. */
121 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
122 OVS_REQUIRES(ofproto_mutex);
123 static uint64_t rule_eviction_priority(struct ofproto *ofproto, struct rule *)
124 OVS_REQUIRES(ofproto_mutex);
125 static void eviction_group_add_rule(struct rule *)
126 OVS_REQUIRES(ofproto_mutex);
127 static void eviction_group_remove_rule(struct rule *)
128 OVS_REQUIRES(ofproto_mutex);
130 /* Criteria that flow_mod and other operations use for selecting rules on
131 * which to operate. */
132 struct rule_criteria {
133 /* An OpenFlow table or 255 for all tables. */
136 /* OpenFlow matching criteria. Interpreted different in "loose" way by
137 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
138 * defined in the OpenFlow spec. */
141 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
142 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
143 * The rule will not be selected if M is 1 and B != C. */
145 ovs_be64 cookie_mask;
147 /* Selection based on actions within a rule:
149 * If out_port != OFPP_ANY, selects only rules that output to out_port.
150 * If out_group != OFPG_ALL, select only rules that output to out_group. */
154 /* If true, collects only rules that are modifiable. */
156 bool include_readonly;
159 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
160 const struct match *match, int priority,
161 cls_version_t version,
162 ovs_be64 cookie, ovs_be64 cookie_mask,
163 ofp_port_t out_port, uint32_t out_group);
164 static void rule_criteria_require_rw(struct rule_criteria *,
165 bool can_write_readonly);
166 static void rule_criteria_destroy(struct rule_criteria *);
168 static enum ofperr collect_rules_loose(struct ofproto *,
169 const struct rule_criteria *,
170 struct rule_collection *);
172 /* A packet that needs to be passed to rule_execute().
174 * (We can't do this immediately from ofopgroup_complete() because that holds
175 * ofproto_mutex, which rule_execute() needs released.) */
176 struct rule_execute {
177 struct ovs_list list_node; /* In struct ofproto's "rule_executes" list. */
178 struct rule *rule; /* Owns a reference to the rule. */
180 struct dp_packet *packet; /* Owns the packet. */
183 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
184 static void destroy_rule_executes(struct ofproto *);
186 struct learned_cookie {
188 /* In struct ofproto's 'learned_cookies' hmap. */
189 struct hmap_node hmap_node OVS_GUARDED_BY(ofproto_mutex);
191 /* In 'dead_cookies' list when removed from hmap. */
192 struct ovs_list list_node;
196 ovs_be64 cookie OVS_GUARDED_BY(ofproto_mutex);
197 uint8_t table_id OVS_GUARDED_BY(ofproto_mutex);
199 /* Number of references from "learn" actions.
201 * When this drops to 0, all of the flows in 'table_id' with the specified
202 * 'cookie' are deleted. */
203 int n OVS_GUARDED_BY(ofproto_mutex);
206 static const struct ofpact_learn *next_learn_with_delete(
207 const struct rule_actions *, const struct ofpact_learn *start);
209 static void learned_cookies_inc(struct ofproto *, const struct rule_actions *)
210 OVS_REQUIRES(ofproto_mutex);
211 static void learned_cookies_dec(struct ofproto *, const struct rule_actions *,
212 struct ovs_list *dead_cookies)
213 OVS_REQUIRES(ofproto_mutex);
214 static void learned_cookies_flush(struct ofproto *, struct ovs_list *dead_cookies)
215 OVS_REQUIRES(ofproto_mutex);
218 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
219 static void ofport_destroy(struct ofport *);
221 static void update_port(struct ofproto *, const char *devname);
222 static int init_ports(struct ofproto *);
223 static void reinit_ports(struct ofproto *);
225 static long long int ofport_get_usage(const struct ofproto *,
226 ofp_port_t ofp_port);
227 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
228 long long int last_used);
229 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
233 * Keeps track of the currently used and recently used ofport values and is
234 * used to prevent immediate recycling of ofport values. */
235 struct ofport_usage {
236 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
237 ofp_port_t ofp_port; /* OpenFlow port number. */
238 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
239 represents in-use ofports. */
243 static void ofproto_rule_send_removed(struct rule *)
244 OVS_EXCLUDED(ofproto_mutex);
245 static bool rule_is_readonly(const struct rule *);
246 static void ofproto_rule_insert__(struct ofproto *, struct rule *)
247 OVS_REQUIRES(ofproto_mutex);
248 static void ofproto_rule_remove__(struct ofproto *, struct rule *)
249 OVS_REQUIRES(ofproto_mutex);
251 /* The source of a flow_mod request, in the code that processes flow_mods.
253 * A flow table modification request can be generated externally, via OpenFlow,
254 * or internally through a function call. This structure indicates the source
255 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
256 * meaningful and thus supplied as NULL. */
257 struct flow_mod_requester {
258 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
259 const struct ofp_header *request;
263 static enum ofperr replace_rule_create(struct ofproto *,
264 struct ofputil_flow_mod *,
265 struct cls_rule *cr, uint8_t table_id,
266 struct rule *old_rule,
267 struct rule **new_rule)
268 OVS_REQUIRES(ofproto_mutex);
270 static void replace_rule_start(struct ofproto *,
271 struct rule *old_rule,
272 struct rule *new_rule,
273 struct cls_conjunction *, size_t n_conjs)
274 OVS_REQUIRES(ofproto_mutex);
276 static void replace_rule_revert(struct ofproto *, struct rule *old_rule,
277 struct rule *new_rule)
278 OVS_REQUIRES(ofproto_mutex);
280 static void replace_rule_finish(struct ofproto *, struct ofputil_flow_mod *,
281 const struct flow_mod_requester *,
282 struct rule *old_rule, struct rule *new_rule,
283 struct ovs_list *dead_cookies)
284 OVS_REQUIRES(ofproto_mutex);
285 static void delete_flows__(struct rule_collection *,
286 enum ofp_flow_removed_reason,
287 const struct flow_mod_requester *)
288 OVS_REQUIRES(ofproto_mutex);
290 static void send_buffered_packet(const struct flow_mod_requester *,
291 uint32_t buffer_id, struct rule *)
292 OVS_REQUIRES(ofproto_mutex);
294 static bool ofproto_group_exists__(const struct ofproto *ofproto,
296 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
297 static bool ofproto_group_exists(const struct ofproto *ofproto,
299 OVS_EXCLUDED(ofproto->groups_rwlock);
300 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
301 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
302 static enum ofperr do_bundle_flow_mod_start(struct ofproto *,
303 struct ofputil_flow_mod *,
304 struct ofp_bundle_entry *)
305 OVS_REQUIRES(ofproto_mutex);
306 static void do_bundle_flow_mod_finish(struct ofproto *,
307 struct ofputil_flow_mod *,
308 const struct flow_mod_requester *,
309 struct ofp_bundle_entry *)
310 OVS_REQUIRES(ofproto_mutex);
311 static enum ofperr handle_flow_mod__(struct ofproto *,
312 struct ofputil_flow_mod *,
313 const struct flow_mod_requester *)
314 OVS_EXCLUDED(ofproto_mutex);
315 static void calc_duration(long long int start, long long int now,
316 uint32_t *sec, uint32_t *nsec);
319 static uint64_t pick_datapath_id(const struct ofproto *);
320 static uint64_t pick_fallback_dpid(void);
321 static void ofproto_destroy__(struct ofproto *);
322 static void update_mtu(struct ofproto *, struct ofport *);
323 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
324 static void meter_insert_rule(struct rule *);
327 static void ofproto_unixctl_init(void);
329 /* All registered ofproto classes, in probe order. */
330 static const struct ofproto_class **ofproto_classes;
331 static size_t n_ofproto_classes;
332 static size_t allocated_ofproto_classes;
334 /* Global lock that protects all flow table operations. */
335 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
337 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
338 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
340 size_t n_handlers, n_revalidators;
344 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
345 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
347 /* Initial mappings of port to OpenFlow number mappings. */
348 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
350 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
352 /* The default value of true waits for flow restore. */
353 static bool flow_restore_wait = true;
355 /* Must be called to initialize the ofproto library.
357 * The caller may pass in 'iface_hints', which contains an shash of
358 * "iface_hint" elements indexed by the interface's name. The provider
359 * may use these hints to describe the startup configuration in order to
360 * reinitialize its state. The caller owns the provided data, so a
361 * provider will make copies of anything required. An ofproto provider
362 * will remove any existing state that is not described by the hint, and
363 * may choose to remove it all. */
365 ofproto_init(const struct shash *iface_hints)
367 struct shash_node *node;
370 ofproto_class_register(&ofproto_dpif_class);
372 /* Make a local copy, since we don't own 'iface_hints' elements. */
373 SHASH_FOR_EACH(node, iface_hints) {
374 const struct iface_hint *orig_hint = node->data;
375 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
376 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
378 new_hint->br_name = xstrdup(orig_hint->br_name);
379 new_hint->br_type = xstrdup(br_type);
380 new_hint->ofp_port = orig_hint->ofp_port;
382 shash_add(&init_ofp_ports, node->name, new_hint);
385 for (i = 0; i < n_ofproto_classes; i++) {
386 ofproto_classes[i]->init(&init_ofp_ports);
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 ofproto_unixctl_init();
518 datapath_type = ofproto_normalize_type(datapath_type);
519 class = ofproto_class_find__(datapath_type);
521 VLOG_WARN("could not create datapath %s of unknown type %s",
522 datapath_name, datapath_type);
526 ofproto = class->alloc();
528 VLOG_ERR("failed to allocate datapath %s of type %s",
529 datapath_name, datapath_type);
534 ovs_mutex_lock(&ofproto_mutex);
535 memset(ofproto, 0, sizeof *ofproto);
536 ofproto->ofproto_class = class;
537 ofproto->name = xstrdup(datapath_name);
538 ofproto->type = xstrdup(datapath_type);
539 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
540 hash_string(ofproto->name, 0));
541 ofproto->datapath_id = 0;
542 ofproto->forward_bpdu = false;
543 ofproto->fallback_dpid = pick_fallback_dpid();
544 ofproto->mfr_desc = NULL;
545 ofproto->hw_desc = NULL;
546 ofproto->sw_desc = NULL;
547 ofproto->serial_desc = NULL;
548 ofproto->dp_desc = NULL;
549 ofproto->frag_handling = OFPC_FRAG_NORMAL;
550 hmap_init(&ofproto->ports);
551 hmap_init(&ofproto->ofport_usage);
552 shash_init(&ofproto->port_by_name);
553 simap_init(&ofproto->ofp_requests);
554 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
555 ofproto->eviction_group_timer = LLONG_MIN;
556 ofproto->tables = NULL;
557 ofproto->n_tables = 0;
558 ofproto->tables_version = CLS_MIN_VERSION;
559 hindex_init(&ofproto->cookies);
560 hmap_init(&ofproto->learned_cookies);
561 list_init(&ofproto->expirable);
562 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
563 guarded_list_init(&ofproto->rule_executes);
564 ofproto->vlan_bitmap = NULL;
565 ofproto->vlans_changed = false;
566 ofproto->min_mtu = INT_MAX;
567 ovs_rwlock_init(&ofproto->groups_rwlock);
568 hmap_init(&ofproto->groups);
569 ovs_mutex_unlock(&ofproto_mutex);
570 ofproto->ogf.types = 0xf;
571 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
572 OFPGFC_SELECT_WEIGHT;
573 for (i = 0; i < 4; i++) {
574 ofproto->ogf.max_groups[i] = OFPG_MAX;
575 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
579 error = ofproto->ofproto_class->construct(ofproto);
581 VLOG_ERR("failed to open datapath %s: %s",
582 datapath_name, ovs_strerror(error));
583 connmgr_destroy(ofproto->connmgr);
584 ofproto_destroy__(ofproto);
588 /* Check that hidden tables, if any, are at the end. */
589 ovs_assert(ofproto->n_tables);
590 for (i = 0; i + 1 < ofproto->n_tables; i++) {
591 enum oftable_flags flags = ofproto->tables[i].flags;
592 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
594 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
597 ofproto->datapath_id = pick_datapath_id(ofproto);
600 /* Initialize meters table. */
601 if (ofproto->ofproto_class->meter_get_features) {
602 ofproto->ofproto_class->meter_get_features(ofproto,
603 &ofproto->meter_features);
605 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
607 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
608 * sizeof(struct meter *));
610 /* Set the initial tables version. */
611 ofproto_bump_tables_version(ofproto);
617 /* Must be called (only) by an ofproto implementation in its constructor
618 * function. See the large comment on 'construct' in struct ofproto_class for
621 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
623 struct oftable *table;
625 ovs_assert(!ofproto->n_tables);
626 ovs_assert(n_tables >= 1 && n_tables <= 255);
628 ofproto->n_tables = n_tables;
629 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
630 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
635 /* To be optionally called (only) by an ofproto implementation in its
636 * constructor function. See the large comment on 'construct' in struct
637 * ofproto_class for details.
639 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
640 * will then ensure that actions passed into the ofproto implementation will
641 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
642 * function is not called, there will be no such restriction.
644 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
645 * the 'max_ports' restriction. */
647 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
649 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
650 ofproto->max_ports = max_ports;
654 ofproto_get_datapath_id(const struct ofproto *ofproto)
656 return ofproto->datapath_id;
660 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
662 uint64_t old_dpid = p->datapath_id;
663 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
664 if (p->datapath_id != old_dpid) {
665 /* Force all active connections to reconnect, since there is no way to
666 * notify a controller that the datapath ID has changed. */
667 ofproto_reconnect_controllers(p);
672 ofproto_set_controllers(struct ofproto *p,
673 const struct ofproto_controller *controllers,
674 size_t n_controllers, uint32_t allowed_versions)
676 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
681 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
683 connmgr_set_fail_mode(p->connmgr, fail_mode);
686 /* Drops the connections between 'ofproto' and all of its controllers, forcing
687 * them to reconnect. */
689 ofproto_reconnect_controllers(struct ofproto *ofproto)
691 connmgr_reconnect(ofproto->connmgr);
694 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
695 * in-band control should guarantee access, in the same way that in-band
696 * control guarantees access to OpenFlow controllers. */
698 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
699 const struct sockaddr_in *extras, size_t n)
701 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
704 /* Sets the OpenFlow queue used by flows set up by in-band control on
705 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
706 * flows will use the default queue. */
708 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
710 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
713 /* Sets the number of flows at which eviction from the kernel flow table
716 ofproto_set_flow_limit(unsigned limit)
718 ofproto_flow_limit = limit;
721 /* Sets the maximum idle time for flows in the datapath before they are
724 ofproto_set_max_idle(unsigned max_idle)
726 ofproto_max_idle = max_idle;
729 /* If forward_bpdu is true, the NORMAL action will forward frames with
730 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
731 * the NORMAL action will drop these frames. */
733 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
735 bool old_val = ofproto->forward_bpdu;
736 ofproto->forward_bpdu = forward_bpdu;
737 if (old_val != ofproto->forward_bpdu) {
738 if (ofproto->ofproto_class->forward_bpdu_changed) {
739 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
744 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
745 * 'idle_time', in seconds, and the maximum number of MAC table entries to
748 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
751 if (ofproto->ofproto_class->set_mac_table_config) {
752 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
757 /* Multicast snooping configuration. */
759 /* Configures multicast snooping on 'ofproto' using the settings
760 * defined in 's'. If 's' is NULL, disables multicast snooping.
762 * Returns 0 if successful, otherwise a positive errno value. */
764 ofproto_set_mcast_snooping(struct ofproto *ofproto,
765 const struct ofproto_mcast_snooping_settings *s)
767 return (ofproto->ofproto_class->set_mcast_snooping
768 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
772 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
774 * Returns 0 if successful, otherwise a positive errno value.*/
776 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
777 const struct ofproto_mcast_snooping_port_settings *s)
779 return (ofproto->ofproto_class->set_mcast_snooping_port
780 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
785 ofproto_set_n_dpdk_rxqs(int n_rxqs)
787 n_dpdk_rxqs = MAX(n_rxqs, 0);
791 ofproto_set_cpu_mask(const char *cmask)
795 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
799 ofproto_set_threads(int n_handlers_, int n_revalidators_)
801 int threads = MAX(count_cpu_cores(), 2);
803 n_revalidators = MAX(n_revalidators_, 0);
804 n_handlers = MAX(n_handlers_, 0);
806 if (!n_revalidators) {
807 n_revalidators = n_handlers
808 ? MAX(threads - (int) n_handlers, 1)
813 n_handlers = MAX(threads - (int) n_revalidators, 1);
818 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
821 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
825 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
827 return connmgr_set_snoops(ofproto->connmgr, snoops);
831 ofproto_set_netflow(struct ofproto *ofproto,
832 const struct netflow_options *nf_options)
834 if (nf_options && sset_is_empty(&nf_options->collectors)) {
838 if (ofproto->ofproto_class->set_netflow) {
839 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
841 return nf_options ? EOPNOTSUPP : 0;
846 ofproto_set_sflow(struct ofproto *ofproto,
847 const struct ofproto_sflow_options *oso)
849 if (oso && sset_is_empty(&oso->targets)) {
853 if (ofproto->ofproto_class->set_sflow) {
854 return ofproto->ofproto_class->set_sflow(ofproto, oso);
856 return oso ? EOPNOTSUPP : 0;
861 ofproto_set_ipfix(struct ofproto *ofproto,
862 const struct ofproto_ipfix_bridge_exporter_options *bo,
863 const struct ofproto_ipfix_flow_exporter_options *fo,
866 if (ofproto->ofproto_class->set_ipfix) {
867 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
869 return (bo || fo) ? EOPNOTSUPP : 0;
874 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
876 flow_restore_wait = flow_restore_wait_db;
880 ofproto_get_flow_restore_wait(void)
882 return flow_restore_wait;
886 /* Spanning Tree Protocol (STP) configuration. */
888 /* Configures STP on 'ofproto' using the settings defined in 's'. If
889 * 's' is NULL, disables STP.
891 * Returns 0 if successful, otherwise a positive errno value. */
893 ofproto_set_stp(struct ofproto *ofproto,
894 const struct ofproto_stp_settings *s)
896 return (ofproto->ofproto_class->set_stp
897 ? ofproto->ofproto_class->set_stp(ofproto, s)
901 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
902 * 'enabled' member of 's' is false, then the other members are not
905 * Returns 0 if successful, otherwise a positive errno value. */
907 ofproto_get_stp_status(struct ofproto *ofproto,
908 struct ofproto_stp_status *s)
910 return (ofproto->ofproto_class->get_stp_status
911 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
915 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
916 * in 's'. The caller is responsible for assigning STP port numbers
917 * (using the 'port_num' member in the range of 1 through 255, inclusive)
918 * and ensuring there are no duplicates. If the 's' is NULL, then STP
919 * is disabled on the port.
921 * Returns 0 if successful, otherwise a positive errno value.*/
923 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
924 const struct ofproto_port_stp_settings *s)
926 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
928 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
929 ofproto->name, ofp_port);
933 return (ofproto->ofproto_class->set_stp_port
934 ? ofproto->ofproto_class->set_stp_port(ofport, s)
938 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
939 * 's'. If the 'enabled' member in 's' is false, then the other members
940 * are not meaningful.
942 * Returns 0 if successful, otherwise a positive errno value.*/
944 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
945 struct ofproto_port_stp_status *s)
947 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
949 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
950 "port %"PRIu16, ofproto->name, ofp_port);
954 return (ofproto->ofproto_class->get_stp_port_status
955 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
959 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
960 * 's'. If the 'enabled' member in 's' is false, then the other members
961 * are not meaningful.
963 * Returns 0 if successful, otherwise a positive errno value.*/
965 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
966 struct ofproto_port_stp_stats *s)
968 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
970 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
971 "port %"PRIu16, ofproto->name, ofp_port);
975 return (ofproto->ofproto_class->get_stp_port_stats
976 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
980 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
982 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
983 * 's' is NULL, disables RSTP.
985 * Returns 0 if successful, otherwise a positive errno value. */
987 ofproto_set_rstp(struct ofproto *ofproto,
988 const struct ofproto_rstp_settings *s)
990 if (!ofproto->ofproto_class->set_rstp) {
993 ofproto->ofproto_class->set_rstp(ofproto, s);
997 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
998 * 'enabled' member of 's' is false, then the other members are not
1001 * Returns 0 if successful, otherwise a positive errno value. */
1003 ofproto_get_rstp_status(struct ofproto *ofproto,
1004 struct ofproto_rstp_status *s)
1006 if (!ofproto->ofproto_class->get_rstp_status) {
1009 ofproto->ofproto_class->get_rstp_status(ofproto, s);
1013 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1014 * in 's'. The caller is responsible for assigning RSTP port numbers
1015 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1016 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1017 * is disabled on the port.
1019 * Returns 0 if successful, otherwise a positive errno value.*/
1021 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
1022 const struct ofproto_port_rstp_settings *s)
1024 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1026 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
1027 ofproto->name, ofp_port);
1031 if (!ofproto->ofproto_class->set_rstp_port) {
1034 ofproto->ofproto_class->set_rstp_port(ofport, s);
1038 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1039 * 's'. If the 'enabled' member in 's' is false, then the other members
1040 * are not meaningful.
1042 * Returns 0 if successful, otherwise a positive errno value.*/
1044 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1045 struct ofproto_port_rstp_status *s)
1047 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1049 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1050 "port %"PRIu16, ofproto->name, ofp_port);
1054 if (!ofproto->ofproto_class->get_rstp_port_status) {
1057 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1061 /* Queue DSCP configuration. */
1063 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1064 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1065 * to implement QoS. Instead, it is used to implement features which require
1066 * knowledge of what queues exist on a port, and some basic information about
1069 * Returns 0 if successful, otherwise a positive errno value. */
1071 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1072 const struct ofproto_port_queue *queues,
1075 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1078 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1079 ofproto->name, ofp_port);
1083 return (ofproto->ofproto_class->set_queues
1084 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1088 /* LLDP configuration. */
1090 ofproto_port_set_lldp(struct ofproto *ofproto,
1091 ofp_port_t ofp_port,
1092 const struct smap *cfg)
1094 struct ofport *ofport;
1097 ofport = ofproto_get_port(ofproto, ofp_port);
1099 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1100 ofproto->name, ofp_port);
1103 error = (ofproto->ofproto_class->set_lldp
1104 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1107 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1108 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1109 ovs_strerror(error));
1114 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1115 const struct aa_settings *s)
1117 if (!ofproto->ofproto_class->set_aa) {
1120 ofproto->ofproto_class->set_aa(ofproto, s);
1125 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1126 const struct aa_mapping_settings *s)
1128 if (!ofproto->ofproto_class->aa_mapping_set) {
1131 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1136 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1138 if (!ofproto->ofproto_class->aa_mapping_unset) {
1141 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1146 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1147 struct ovs_list *list)
1149 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1152 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1157 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1159 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1162 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1165 /* Connectivity Fault Management configuration. */
1167 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1169 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1171 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1172 if (ofport && ofproto->ofproto_class->set_cfm) {
1173 ofproto->ofproto_class->set_cfm(ofport, NULL);
1177 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1178 * basic configuration from the configuration members in 'cfm', and the remote
1179 * maintenance point ID from remote_mpid. Ignores the statistics members of
1182 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1184 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1185 const struct cfm_settings *s)
1187 struct ofport *ofport;
1190 ofport = ofproto_get_port(ofproto, ofp_port);
1192 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1193 ofproto->name, ofp_port);
1197 /* XXX: For configuration simplicity, we only support one remote_mpid
1198 * outside of the CFM module. It's not clear if this is the correct long
1199 * term solution or not. */
1200 error = (ofproto->ofproto_class->set_cfm
1201 ? ofproto->ofproto_class->set_cfm(ofport, s)
1204 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1205 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1206 ovs_strerror(error));
1210 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1211 * 'ofproto' does not have a port 'ofp_port'. */
1213 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1214 const struct smap *cfg)
1216 struct ofport *ofport;
1219 ofport = ofproto_get_port(ofproto, ofp_port);
1221 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1222 ofproto->name, ofp_port);
1226 error = (ofproto->ofproto_class->set_bfd
1227 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1230 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1231 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1232 ovs_strerror(error));
1236 /* Checks the status change of BFD on 'ofport'.
1238 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1240 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1242 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1243 return (ofport && ofproto->ofproto_class->bfd_status_changed
1244 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1248 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1249 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1250 * is not an OpenFlow port in 'ofproto'.
1252 * The caller must provide and own '*status'. */
1254 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1255 struct smap *status)
1257 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1258 return (ofport && ofproto->ofproto_class->get_bfd_status
1259 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1263 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1264 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1265 * 0 if LACP partner information is not current (generally indicating a
1266 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1268 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1270 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1271 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1272 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1277 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1279 struct ofproto *ofproto = port->ofproto;
1282 if (ofproto->ofproto_class->port_get_lacp_stats) {
1283 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1293 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1294 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1295 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1296 * configuration plus, if there is more than one slave, a bonding
1299 * If 'aux' is already registered then this function updates its configuration
1300 * to 's'. Otherwise, this function registers a new bundle.
1302 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1305 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1306 const struct ofproto_bundle_settings *s)
1308 return (ofproto->ofproto_class->bundle_set
1309 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1313 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1314 * If no such bundle has been registered, this has no effect. */
1316 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1318 return ofproto_bundle_register(ofproto, aux, NULL);
1322 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1323 * If 'aux' is already registered then this function updates its configuration
1324 * to 's'. Otherwise, this function registers a new mirror. */
1326 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1327 const struct ofproto_mirror_settings *s)
1329 return (ofproto->ofproto_class->mirror_set
1330 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1334 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1335 * If no mirror has been registered, this has no effect. */
1337 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1339 return ofproto_mirror_register(ofproto, aux, NULL);
1342 /* Retrieves statistics from mirror associated with client data pointer
1343 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1344 * 'bytes', respectively. If a particular counters is not supported,
1345 * the appropriate argument is set to UINT64_MAX.
1348 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1349 uint64_t *packets, uint64_t *bytes)
1351 if (!ofproto->ofproto_class->mirror_get_stats) {
1352 *packets = *bytes = UINT64_MAX;
1356 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1360 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1361 * which all packets are flooded, instead of using MAC learning. If
1362 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1364 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1367 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1369 return (ofproto->ofproto_class->set_flood_vlans
1370 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1374 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1375 * output for a mirror. */
1377 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1379 return (ofproto->ofproto_class->is_mirror_output_bundle
1380 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1384 /* Configuration of OpenFlow tables. */
1386 /* Returns the number of OpenFlow tables in 'ofproto'. */
1388 ofproto_get_n_tables(const struct ofproto *ofproto)
1390 return ofproto->n_tables;
1393 /* Returns the number of Controller visible OpenFlow tables
1394 * in 'ofproto'. This number will exclude Hidden tables.
1395 * This funtion's return value should be less or equal to that of
1396 * ofproto_get_n_tables() . */
1398 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1400 uint8_t n = ofproto->n_tables;
1402 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1403 * if present, are always at the end.) */
1404 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1411 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1412 * settings from 's'. 'table_id' must be in the range 0 through the number of
1413 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1415 * For read-only tables, only the name may be configured. */
1417 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1418 const struct ofproto_table_settings *s)
1420 struct oftable *table;
1422 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1423 table = &ofproto->tables[table_id];
1425 oftable_set_name(table, s->name);
1427 if (table->flags & OFTABLE_READONLY) {
1431 if (classifier_set_prefix_fields(&table->cls,
1432 s->prefix_fields, s->n_prefix_fields)) {
1433 /* XXX: Trigger revalidation. */
1436 ovs_mutex_lock(&ofproto_mutex);
1437 unsigned int new_eviction = (s->enable_eviction
1438 ? table->eviction | EVICTION_CLIENT
1439 : table->eviction & ~EVICTION_CLIENT);
1440 oftable_configure_eviction(table, new_eviction, s->groups, s->n_groups);
1441 table->max_flows = s->max_flows;
1442 evict_rules_from_table(table);
1443 ovs_mutex_unlock(&ofproto_mutex);
1447 ofproto_has_snoops(const struct ofproto *ofproto)
1449 return connmgr_has_snoops(ofproto->connmgr);
1453 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1455 connmgr_get_snoops(ofproto->connmgr, snoops);
1458 /* Deletes 'rule' from 'ofproto'.
1460 * Within an ofproto implementation, this function allows an ofproto
1461 * implementation to destroy any rules that remain when its ->destruct()
1462 * function is called. This function is not suitable for use elsewhere in an
1463 * ofproto implementation.
1465 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1466 * Cycle" in ofproto-provider.h. */
1468 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1469 OVS_EXCLUDED(ofproto_mutex)
1471 /* This skips the ofmonitor and flow-removed notifications because the
1472 * switch is being deleted and any OpenFlow channels have been or soon will
1474 ovs_mutex_lock(&ofproto_mutex);
1476 if (!rule->removed) {
1477 /* Make sure there is no postponed removal of the rule. */
1478 ovs_assert(cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
1480 if (!classifier_remove(&rule->ofproto->tables[rule->table_id].cls,
1484 ofproto_rule_remove__(rule->ofproto, rule);
1485 ofproto->ofproto_class->rule_delete(rule);
1486 ofproto_rule_unref(rule);
1488 ovs_mutex_unlock(&ofproto_mutex);
1492 ofproto_flush__(struct ofproto *ofproto)
1493 OVS_EXCLUDED(ofproto_mutex)
1495 struct oftable *table;
1497 /* This will flush all datapath flows. */
1498 if (ofproto->ofproto_class->flush) {
1499 ofproto->ofproto_class->flush(ofproto);
1502 /* XXX: There is a small race window here, where new datapath flows can be
1503 * created by upcall handlers based on the existing flow table. We can not
1504 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1505 * as then we could deadlock on syncing with the handler threads waiting on
1506 * the same mutex. */
1508 ovs_mutex_lock(&ofproto_mutex);
1509 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1510 struct rule_collection rules;
1513 if (table->flags & OFTABLE_HIDDEN) {
1517 rule_collection_init(&rules);
1519 CLS_FOR_EACH (rule, cr, &table->cls) {
1520 rule_collection_add(&rules, rule);
1522 delete_flows__(&rules, OFPRR_DELETE, NULL);
1524 /* XXX: Concurrent handler threads may insert new learned flows based on
1525 * learn actions of the now deleted flows right after we release
1526 * 'ofproto_mutex'. */
1527 ovs_mutex_unlock(&ofproto_mutex);
1530 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1533 ofproto_destroy__(struct ofproto *ofproto)
1534 OVS_EXCLUDED(ofproto_mutex)
1536 struct oftable *table;
1538 destroy_rule_executes(ofproto);
1540 guarded_list_destroy(&ofproto->rule_executes);
1541 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1542 hmap_destroy(&ofproto->groups);
1544 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1545 free(ofproto->name);
1546 free(ofproto->type);
1547 free(ofproto->mfr_desc);
1548 free(ofproto->hw_desc);
1549 free(ofproto->sw_desc);
1550 free(ofproto->serial_desc);
1551 free(ofproto->dp_desc);
1552 hmap_destroy(&ofproto->ports);
1553 hmap_destroy(&ofproto->ofport_usage);
1554 shash_destroy(&ofproto->port_by_name);
1555 simap_destroy(&ofproto->ofp_requests);
1557 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1558 oftable_destroy(table);
1560 free(ofproto->tables);
1562 ovs_assert(hindex_is_empty(&ofproto->cookies));
1563 hindex_destroy(&ofproto->cookies);
1565 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1566 hmap_destroy(&ofproto->learned_cookies);
1568 free(ofproto->vlan_bitmap);
1570 ofproto->ofproto_class->dealloc(ofproto);
1573 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1574 * - 1st we defer the removal of the rules from the classifier
1575 * - 2nd we defer the actual destruction of the rules. */
1577 ofproto_destroy_defer__(struct ofproto *ofproto)
1578 OVS_EXCLUDED(ofproto_mutex)
1580 ovsrcu_postpone(ofproto_destroy__, ofproto);
1584 ofproto_destroy(struct ofproto *p)
1585 OVS_EXCLUDED(ofproto_mutex)
1587 struct ofport *ofport, *next_ofport;
1588 struct ofport_usage *usage, *next_usage;
1595 meter_delete(p, 1, p->meter_features.max_meters);
1596 p->meter_features.max_meters = 0;
1602 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1603 ofport_destroy(ofport);
1606 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1607 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1611 p->ofproto_class->destruct(p);
1613 /* We should not postpone this because it involves deleting a listening
1614 * socket which we may want to reopen soon. 'connmgr' should not be used
1615 * by other threads */
1616 connmgr_destroy(p->connmgr);
1618 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1619 ovsrcu_postpone(ofproto_destroy_defer__, p);
1622 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1623 * kernel datapath, for example, this destroys the datapath in the kernel, and
1624 * with the netdev-based datapath, it tears down the data structures that
1625 * represent the datapath.
1627 * The datapath should not be currently open as an ofproto. */
1629 ofproto_delete(const char *name, const char *type)
1631 const struct ofproto_class *class = ofproto_class_find__(type);
1632 return (!class ? EAFNOSUPPORT
1633 : !class->del ? EACCES
1634 : class->del(type, name));
1638 process_port_change(struct ofproto *ofproto, int error, char *devname)
1640 if (error == ENOBUFS) {
1641 reinit_ports(ofproto);
1642 } else if (!error) {
1643 update_port(ofproto, devname);
1649 ofproto_type_run(const char *datapath_type)
1651 const struct ofproto_class *class;
1654 datapath_type = ofproto_normalize_type(datapath_type);
1655 class = ofproto_class_find__(datapath_type);
1657 error = class->type_run ? class->type_run(datapath_type) : 0;
1658 if (error && error != EAGAIN) {
1659 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1660 datapath_type, ovs_strerror(error));
1666 ofproto_type_wait(const char *datapath_type)
1668 const struct ofproto_class *class;
1670 datapath_type = ofproto_normalize_type(datapath_type);
1671 class = ofproto_class_find__(datapath_type);
1673 if (class->type_wait) {
1674 class->type_wait(datapath_type);
1679 ofproto_run(struct ofproto *p)
1684 error = p->ofproto_class->run(p);
1685 if (error && error != EAGAIN) {
1686 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1689 run_rule_executes(p);
1691 /* Restore the eviction group heap invariant occasionally. */
1692 if (p->eviction_group_timer < time_msec()) {
1695 p->eviction_group_timer = time_msec() + 1000;
1697 for (i = 0; i < p->n_tables; i++) {
1698 struct oftable *table = &p->tables[i];
1699 struct eviction_group *evg;
1702 if (!table->eviction) {
1706 if (table->n_flows > 100000) {
1707 static struct vlog_rate_limit count_rl =
1708 VLOG_RATE_LIMIT_INIT(1, 1);
1709 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1710 " number of rules: %d", i, table->n_flows);
1713 ovs_mutex_lock(&ofproto_mutex);
1714 CLS_FOR_EACH (rule, cr, &table->cls) {
1715 if (rule->idle_timeout || rule->hard_timeout) {
1716 if (!rule->eviction_group) {
1717 eviction_group_add_rule(rule);
1719 heap_raw_change(&rule->evg_node,
1720 rule_eviction_priority(p, rule));
1725 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1726 heap_rebuild(&evg->rules);
1728 ovs_mutex_unlock(&ofproto_mutex);
1732 if (p->ofproto_class->port_poll) {
1735 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1736 process_port_change(p, error, devname);
1740 new_seq = seq_read(connectivity_seq_get());
1741 if (new_seq != p->change_seq) {
1742 struct sset devnames;
1743 const char *devname;
1744 struct ofport *ofport;
1746 /* Update OpenFlow port status for any port whose netdev has changed.
1748 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1749 * destroyed, so it's not safe to update ports directly from the
1750 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1751 * need this two-phase approach. */
1752 sset_init(&devnames);
1753 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1754 uint64_t port_change_seq;
1756 port_change_seq = netdev_get_change_seq(ofport->netdev);
1757 if (ofport->change_seq != port_change_seq) {
1758 ofport->change_seq = port_change_seq;
1759 sset_add(&devnames, netdev_get_name(ofport->netdev));
1762 SSET_FOR_EACH (devname, &devnames) {
1763 update_port(p, devname);
1765 sset_destroy(&devnames);
1767 p->change_seq = new_seq;
1770 connmgr_run(p->connmgr, handle_openflow);
1776 ofproto_wait(struct ofproto *p)
1778 p->ofproto_class->wait(p);
1779 if (p->ofproto_class->port_poll_wait) {
1780 p->ofproto_class->port_poll_wait(p);
1782 seq_wait(connectivity_seq_get(), p->change_seq);
1783 connmgr_wait(p->connmgr);
1787 ofproto_is_alive(const struct ofproto *p)
1789 return connmgr_has_controllers(p->connmgr);
1792 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1793 * memory_report(). */
1795 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1797 const struct oftable *table;
1798 unsigned int n_rules;
1800 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1803 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1804 n_rules += table->n_flows;
1806 simap_increase(usage, "rules", n_rules);
1808 if (ofproto->ofproto_class->get_memory_usage) {
1809 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1812 connmgr_get_memory_usage(ofproto->connmgr, usage);
1816 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1818 const struct ofproto_class *class;
1820 datapath_type = ofproto_normalize_type(datapath_type);
1821 class = ofproto_class_find__(datapath_type);
1823 if (class && class->type_get_memory_usage) {
1824 class->type_get_memory_usage(datapath_type, usage);
1829 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1832 connmgr_get_controller_info(ofproto->connmgr, info);
1836 ofproto_free_ofproto_controller_info(struct shash *info)
1838 connmgr_free_controller_info(info);
1841 /* Makes a deep copy of 'old' into 'port'. */
1843 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1845 port->name = xstrdup(old->name);
1846 port->type = xstrdup(old->type);
1847 port->ofp_port = old->ofp_port;
1850 /* Frees memory allocated to members of 'ofproto_port'.
1852 * Do not call this function on an ofproto_port obtained from
1853 * ofproto_port_dump_next(): that function retains ownership of the data in the
1856 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1858 free(ofproto_port->name);
1859 free(ofproto_port->type);
1862 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1864 * This function provides no status indication. An error status for the entire
1865 * dump operation is provided when it is completed by calling
1866 * ofproto_port_dump_done().
1869 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1870 const struct ofproto *ofproto)
1872 dump->ofproto = ofproto;
1873 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1877 /* Attempts to retrieve another port from 'dump', which must have been created
1878 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1879 * 'port' and returns true. On failure, returns false.
1881 * Failure might indicate an actual error or merely that the last port has been
1882 * dumped. An error status for the entire dump operation is provided when it
1883 * is completed by calling ofproto_port_dump_done().
1885 * The ofproto owns the data stored in 'port'. It will remain valid until at
1886 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1887 * ofproto_port_dump_done(). */
1889 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1890 struct ofproto_port *port)
1892 const struct ofproto *ofproto = dump->ofproto;
1898 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1901 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1907 /* Completes port table dump operation 'dump', which must have been created
1908 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1909 * error-free, otherwise a positive errno value describing the problem. */
1911 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1913 const struct ofproto *ofproto = dump->ofproto;
1915 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1918 return dump->error == EOF ? 0 : dump->error;
1921 /* Returns the type to pass to netdev_open() when a datapath of type
1922 * 'datapath_type' has a port of type 'port_type', for a few special
1923 * cases when a netdev type differs from a port type. For example, when
1924 * using the userspace datapath, a port of type "internal" needs to be
1927 * Returns either 'type' itself or a string literal, which must not be
1930 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1932 const struct ofproto_class *class;
1934 datapath_type = ofproto_normalize_type(datapath_type);
1935 class = ofproto_class_find__(datapath_type);
1940 return (class->port_open_type
1941 ? class->port_open_type(datapath_type, port_type)
1945 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1946 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1947 * the port's OpenFlow port number.
1949 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1950 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1951 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1952 * 'ofp_portp' is non-null). */
1954 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1955 ofp_port_t *ofp_portp)
1957 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1960 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1962 const char *netdev_name = netdev_get_name(netdev);
1964 simap_put(&ofproto->ofp_requests, netdev_name,
1965 ofp_to_u16(ofp_port));
1966 update_port(ofproto, netdev_name);
1969 *ofp_portp = OFPP_NONE;
1971 struct ofproto_port ofproto_port;
1973 error = ofproto_port_query_by_name(ofproto,
1974 netdev_get_name(netdev),
1977 *ofp_portp = ofproto_port.ofp_port;
1978 ofproto_port_destroy(&ofproto_port);
1985 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1986 * initializes '*port' appropriately; on failure, returns a positive errno
1989 * The caller owns the data in 'ofproto_port' and must free it with
1990 * ofproto_port_destroy() when it is no longer needed. */
1992 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1993 struct ofproto_port *port)
1997 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1999 memset(port, 0, sizeof *port);
2004 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
2005 * Returns 0 if successful, otherwise a positive errno. */
2007 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
2009 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2010 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
2011 struct simap_node *ofp_request_node;
2014 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
2015 if (ofp_request_node) {
2016 simap_delete(&ofproto->ofp_requests, ofp_request_node);
2019 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
2020 if (!error && ofport) {
2021 /* 'name' is the netdev's name and update_port() is going to close the
2022 * netdev. Just in case update_port() refers to 'name' after it
2023 * destroys 'ofport', make a copy of it around the update_port()
2025 char *devname = xstrdup(name);
2026 update_port(ofproto, devname);
2033 flow_mod_init(struct ofputil_flow_mod *fm,
2034 const struct match *match, int priority,
2035 const struct ofpact *ofpacts, size_t ofpacts_len,
2036 enum ofp_flow_mod_command command)
2038 memset(fm, 0, sizeof *fm);
2040 fm->priority = priority;
2043 fm->modify_cookie = false;
2045 fm->command = command;
2046 fm->idle_timeout = 0;
2047 fm->hard_timeout = 0;
2049 fm->buffer_id = UINT32_MAX;
2050 fm->out_port = OFPP_ANY;
2051 fm->out_group = OFPG_ANY;
2053 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2054 fm->ofpacts_len = ofpacts_len;
2055 fm->delete_reason = OFPRR_DELETE;
2059 simple_flow_mod(struct ofproto *ofproto,
2060 const struct match *match, int priority,
2061 const struct ofpact *ofpacts, size_t ofpacts_len,
2062 enum ofp_flow_mod_command command)
2064 struct ofputil_flow_mod fm;
2066 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2068 return handle_flow_mod__(ofproto, &fm, NULL);
2071 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2072 * performs the 'n_actions' actions in 'actions'. The new flow will not
2075 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2076 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2077 * controllers; otherwise, it will be hidden.
2079 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2081 * This is a helper function for in-band control and fail-open. */
2083 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2085 const struct ofpact *ofpacts, size_t ofpacts_len)
2086 OVS_EXCLUDED(ofproto_mutex)
2088 const struct rule *rule;
2091 /* First do a cheap check whether the rule we're looking for already exists
2092 * with the actions that we want. If it does, then we're done. */
2093 rule = rule_from_cls_rule(classifier_find_match_exactly(
2094 &ofproto->tables[0].cls, match, priority,
2097 const struct rule_actions *actions = rule_get_actions(rule);
2098 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2099 ofpacts, ofpacts_len);
2104 /* If there's no such rule or the rule doesn't have the actions we want,
2105 * fall back to a executing a full flow mod. We can't optimize this at
2106 * all because we didn't take enough locks above to ensure that the flow
2107 * table didn't already change beneath us. */
2109 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2110 OFPFC_MODIFY_STRICT);
2114 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2115 * an OFPERR_* OpenFlow error code on failure.
2117 * This is a helper function for in-band control and fail-open and the "learn"
2120 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2121 OVS_EXCLUDED(ofproto_mutex)
2123 /* Optimize for the most common case of a repeated learn action.
2124 * If an identical flow already exists we only need to update its
2125 * 'modified' time. */
2126 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2127 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2128 struct oftable *table = &ofproto->tables[fm->table_id];
2132 rule = rule_from_cls_rule(classifier_find_match_exactly(
2133 &table->cls, &fm->match, fm->priority,
2136 /* Reading many of the rule fields and writing on 'modified'
2137 * requires the rule->mutex. Also, rule->actions may change
2138 * if rule->mutex is not held. */
2139 const struct rule_actions *actions;
2141 ovs_mutex_lock(&rule->mutex);
2142 actions = rule_get_actions(rule);
2143 if (rule->idle_timeout == fm->idle_timeout
2144 && rule->hard_timeout == fm->hard_timeout
2145 && rule->importance == fm->importance
2146 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2147 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2148 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2149 actions->ofpacts, actions->ofpacts_len)) {
2150 /* Rule already exists and need not change, only update the
2151 modified timestamp. */
2152 rule->modified = time_msec();
2155 ovs_mutex_unlock(&rule->mutex);
2163 return handle_flow_mod__(ofproto, fm, NULL);
2166 /* Searches for a rule with matching criteria exactly equal to 'target' in
2167 * ofproto's table 0 and, if it finds one, deletes it.
2169 * This is a helper function for in-band control and fail-open. */
2171 ofproto_delete_flow(struct ofproto *ofproto,
2172 const struct match *target, int priority)
2173 OVS_EXCLUDED(ofproto_mutex)
2175 struct classifier *cls = &ofproto->tables[0].cls;
2178 /* First do a cheap check whether the rule we're looking for has already
2179 * been deleted. If so, then we're done. */
2180 rule = rule_from_cls_rule(classifier_find_match_exactly(
2181 cls, target, priority, CLS_MAX_VERSION));
2186 /* Execute a flow mod. We can't optimize this at all because we didn't
2187 * take enough locks above to ensure that the flow table didn't already
2188 * change beneath us. */
2189 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2192 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2193 * the flows required by in-band control and fail-open. */
2195 ofproto_flush_flows(struct ofproto *ofproto)
2197 COVERAGE_INC(ofproto_flush);
2198 ofproto_flush__(ofproto);
2199 connmgr_flushed(ofproto->connmgr);
2203 reinit_ports(struct ofproto *p)
2205 struct ofproto_port_dump dump;
2206 struct sset devnames;
2207 struct ofport *ofport;
2208 struct ofproto_port ofproto_port;
2209 const char *devname;
2211 COVERAGE_INC(ofproto_reinit_ports);
2213 sset_init(&devnames);
2214 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2215 sset_add(&devnames, netdev_get_name(ofport->netdev));
2217 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2218 sset_add(&devnames, ofproto_port.name);
2221 SSET_FOR_EACH (devname, &devnames) {
2222 update_port(p, devname);
2224 sset_destroy(&devnames);
2228 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2232 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2233 port_idx = port_idx ? port_idx : UINT16_MAX;
2235 if (port_idx >= ofproto->max_ports
2236 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2237 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2238 long long int last_used_at, lru = LLONG_MAX;
2240 /* Search for a free OpenFlow port number. We try not to
2241 * immediately reuse them to prevent problems due to old
2244 * We limit the automatically assigned port numbers to the lower half
2245 * of the port range, to reserve the upper half for assignment by
2248 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2249 ofproto->alloc_port_no = 1;
2251 last_used_at = ofport_get_usage(ofproto,
2252 u16_to_ofp(ofproto->alloc_port_no));
2253 if (!last_used_at) {
2254 port_idx = ofproto->alloc_port_no;
2256 } else if ( last_used_at < time_msec() - 60*60*1000) {
2257 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2258 * more than an hour ago, consider it usable. */
2259 ofport_remove_usage(ofproto,
2260 u16_to_ofp(ofproto->alloc_port_no));
2261 port_idx = ofproto->alloc_port_no;
2263 } else if (last_used_at < lru) {
2265 lru_ofport = ofproto->alloc_port_no;
2268 if (ofproto->alloc_port_no == end_port_no) {
2270 port_idx = lru_ofport;
2277 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2278 return u16_to_ofp(port_idx);
2282 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2284 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2285 ofport_set_usage(ofproto, ofp_port, time_msec());
2289 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2290 * pointer if the netdev cannot be opened. On success, also fills in
2292 static struct netdev *
2293 ofport_open(struct ofproto *ofproto,
2294 struct ofproto_port *ofproto_port,
2295 struct ofputil_phy_port *pp)
2297 enum netdev_flags flags;
2298 struct netdev *netdev;
2301 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2303 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2304 "cannot be opened (%s)",
2306 ofproto_port->name, ofproto_port->ofp_port,
2307 ofproto_port->name, ovs_strerror(error));
2311 if (ofproto_port->ofp_port == OFPP_NONE) {
2312 if (!strcmp(ofproto->name, ofproto_port->name)) {
2313 ofproto_port->ofp_port = OFPP_LOCAL;
2315 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2316 ofproto_port->name);
2319 pp->port_no = ofproto_port->ofp_port;
2320 netdev_get_etheraddr(netdev, pp->hw_addr);
2321 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2322 netdev_get_flags(netdev, &flags);
2323 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2324 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2325 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2326 &pp->supported, &pp->peer);
2327 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2328 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2333 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2334 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2337 ofport_equal(const struct ofputil_phy_port *a,
2338 const struct ofputil_phy_port *b)
2340 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2341 && a->state == b->state
2342 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2343 && a->curr == b->curr
2344 && a->advertised == b->advertised
2345 && a->supported == b->supported
2346 && a->peer == b->peer
2347 && a->curr_speed == b->curr_speed
2348 && a->max_speed == b->max_speed);
2351 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2352 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2353 * one with the same name or port number). */
2355 ofport_install(struct ofproto *p,
2356 struct netdev *netdev, const struct ofputil_phy_port *pp)
2358 const char *netdev_name = netdev_get_name(netdev);
2359 struct ofport *ofport;
2362 /* Create ofport. */
2363 ofport = p->ofproto_class->port_alloc();
2368 ofport->ofproto = p;
2369 ofport->netdev = netdev;
2370 ofport->change_seq = netdev_get_change_seq(netdev);
2372 ofport->ofp_port = pp->port_no;
2373 ofport->created = time_msec();
2375 /* Add port to 'p'. */
2376 hmap_insert(&p->ports, &ofport->hmap_node,
2377 hash_ofp_port(ofport->ofp_port));
2378 shash_add(&p->port_by_name, netdev_name, ofport);
2380 update_mtu(p, ofport);
2382 /* Let the ofproto_class initialize its private data. */
2383 error = p->ofproto_class->port_construct(ofport);
2387 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2391 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2392 p->name, netdev_name, ovs_strerror(error));
2394 ofport_destroy__(ofport);
2396 netdev_close(netdev);
2400 /* Removes 'ofport' from 'p' and destroys it. */
2402 ofport_remove(struct ofport *ofport)
2404 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2406 ofport_destroy(ofport);
2409 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2412 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2414 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2416 ofport_remove(port);
2420 /* Updates 'port' with new 'pp' description.
2422 * Does not handle a name or port number change. The caller must implement
2423 * such a change as a delete followed by an add. */
2425 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2427 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2428 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2429 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2430 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2431 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2432 port->pp.curr = pp->curr;
2433 port->pp.advertised = pp->advertised;
2434 port->pp.supported = pp->supported;
2435 port->pp.peer = pp->peer;
2436 port->pp.curr_speed = pp->curr_speed;
2437 port->pp.max_speed = pp->max_speed;
2439 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2440 &port->pp, OFPPR_MODIFY);
2443 /* Update OpenFlow 'state' in 'port' and notify controller. */
2445 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2447 if (port->pp.state != state) {
2448 port->pp.state = state;
2449 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2450 &port->pp, OFPPR_MODIFY);
2455 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2457 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2459 if (port->ofproto->ofproto_class->set_realdev) {
2460 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2462 if (port->ofproto->ofproto_class->set_stp_port) {
2463 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2465 if (port->ofproto->ofproto_class->set_rstp_port) {
2466 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2468 if (port->ofproto->ofproto_class->set_cfm) {
2469 port->ofproto->ofproto_class->set_cfm(port, NULL);
2471 if (port->ofproto->ofproto_class->bundle_remove) {
2472 port->ofproto->ofproto_class->bundle_remove(port);
2478 ofport_destroy__(struct ofport *port)
2480 struct ofproto *ofproto = port->ofproto;
2481 const char *name = netdev_get_name(port->netdev);
2483 hmap_remove(&ofproto->ports, &port->hmap_node);
2484 shash_delete(&ofproto->port_by_name,
2485 shash_find(&ofproto->port_by_name, name));
2487 netdev_close(port->netdev);
2488 ofproto->ofproto_class->port_dealloc(port);
2492 ofport_destroy(struct ofport *port)
2495 dealloc_ofp_port(port->ofproto, port->ofp_port);
2496 port->ofproto->ofproto_class->port_destruct(port);
2497 ofport_destroy__(port);
2502 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2504 struct ofport *port;
2506 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2508 if (port->ofp_port == ofp_port) {
2515 static long long int
2516 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2518 struct ofport_usage *usage;
2520 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2521 &ofproto->ofport_usage) {
2522 if (usage->ofp_port == ofp_port) {
2523 return usage->last_used;
2530 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2531 long long int last_used)
2533 struct ofport_usage *usage;
2534 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2535 &ofproto->ofport_usage) {
2536 if (usage->ofp_port == ofp_port) {
2537 usage->last_used = last_used;
2541 ovs_assert(last_used == LLONG_MAX);
2543 usage = xmalloc(sizeof *usage);
2544 usage->ofp_port = ofp_port;
2545 usage->last_used = last_used;
2546 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2547 hash_ofp_port(ofp_port));
2551 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2553 struct ofport_usage *usage;
2554 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2555 &ofproto->ofport_usage) {
2556 if (usage->ofp_port == ofp_port) {
2557 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2565 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2567 struct ofproto *ofproto = port->ofproto;
2570 if (ofproto->ofproto_class->port_get_stats) {
2571 error = ofproto->ofproto_class->port_get_stats(port, stats);
2580 update_port(struct ofproto *ofproto, const char *name)
2582 struct ofproto_port ofproto_port;
2583 struct ofputil_phy_port pp;
2584 struct netdev *netdev;
2585 struct ofport *port;
2587 COVERAGE_INC(ofproto_update_port);
2589 /* Fetch 'name''s location and properties from the datapath. */
2590 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2591 ? ofport_open(ofproto, &ofproto_port, &pp)
2595 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2596 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2597 struct netdev *old_netdev = port->netdev;
2599 /* 'name' hasn't changed location. Any properties changed? */
2600 if (!ofport_equal(&port->pp, &pp)) {
2601 ofport_modified(port, &pp);
2604 update_mtu(ofproto, port);
2606 /* Install the newly opened netdev in case it has changed.
2607 * Don't close the old netdev yet in case port_modified has to
2608 * remove a retained reference to it.*/
2609 port->netdev = netdev;
2610 port->change_seq = netdev_get_change_seq(netdev);
2612 if (port->ofproto->ofproto_class->port_modified) {
2613 port->ofproto->ofproto_class->port_modified(port);
2616 netdev_close(old_netdev);
2618 /* If 'port' is nonnull then its name differs from 'name' and thus
2619 * we should delete it. If we think there's a port named 'name'
2620 * then its port number must be wrong now so delete it too. */
2622 ofport_remove(port);
2624 ofport_remove_with_name(ofproto, name);
2625 ofport_install(ofproto, netdev, &pp);
2628 /* Any port named 'name' is gone now. */
2629 ofport_remove_with_name(ofproto, name);
2631 ofproto_port_destroy(&ofproto_port);
2635 init_ports(struct ofproto *p)
2637 struct ofproto_port_dump dump;
2638 struct ofproto_port ofproto_port;
2639 struct shash_node *node, *next;
2641 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2642 const char *name = ofproto_port.name;
2644 if (shash_find(&p->port_by_name, name)) {
2645 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2648 struct ofputil_phy_port pp;
2649 struct netdev *netdev;
2651 /* Check if an OpenFlow port number had been requested. */
2652 node = shash_find(&init_ofp_ports, name);
2654 const struct iface_hint *iface_hint = node->data;
2655 simap_put(&p->ofp_requests, name,
2656 ofp_to_u16(iface_hint->ofp_port));
2659 netdev = ofport_open(p, &ofproto_port, &pp);
2661 ofport_install(p, netdev, &pp);
2662 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2663 p->alloc_port_no = MAX(p->alloc_port_no,
2664 ofp_to_u16(ofproto_port.ofp_port));
2670 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2671 struct iface_hint *iface_hint = node->data;
2673 if (!strcmp(iface_hint->br_name, p->name)) {
2674 free(iface_hint->br_name);
2675 free(iface_hint->br_type);
2677 shash_delete(&init_ofp_ports, node);
2684 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2685 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2687 find_min_mtu(struct ofproto *p)
2689 struct ofport *ofport;
2692 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2693 struct netdev *netdev = ofport->netdev;
2696 /* Skip any internal ports, since that's what we're trying to
2698 if (!strcmp(netdev_get_type(netdev), "internal")) {
2702 if (netdev_get_mtu(netdev, &dev_mtu)) {
2705 if (!mtu || dev_mtu < mtu) {
2710 return mtu ? mtu: ETH_PAYLOAD_MAX;
2713 /* Update MTU of all datapath devices on 'p' to the minimum of the
2714 * non-datapath ports in event of 'port' added or changed. */
2716 update_mtu(struct ofproto *p, struct ofport *port)
2718 struct ofport *ofport;
2719 struct netdev *netdev = port->netdev;
2720 int dev_mtu, old_min;
2722 if (netdev_get_mtu(netdev, &dev_mtu)) {
2726 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2727 if (dev_mtu > p->min_mtu) {
2728 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2729 dev_mtu = p->min_mtu;
2732 port->mtu = dev_mtu;
2736 /* For non-internal port find new min mtu. */
2737 old_min = p->min_mtu;
2738 port->mtu = dev_mtu;
2739 p->min_mtu = find_min_mtu(p);
2740 if (p->min_mtu == old_min) {
2744 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2745 struct netdev *netdev = ofport->netdev;
2747 if (!strcmp(netdev_get_type(netdev), "internal")) {
2748 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2749 ofport->mtu = p->min_mtu;
2756 ofproto_rule_destroy__(struct rule *rule)
2757 OVS_NO_THREAD_SAFETY_ANALYSIS
2759 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2760 rule_actions_destroy(rule_get_actions(rule));
2761 ovs_mutex_destroy(&rule->mutex);
2762 rule->ofproto->ofproto_class->rule_dealloc(rule);
2766 rule_destroy_cb(struct rule *rule)
2767 OVS_NO_THREAD_SAFETY_ANALYSIS
2769 /* Send rule removed if needed. */
2770 if (rule->flags & OFPUTIL_FF_SEND_FLOW_REM
2771 && rule->removed_reason != OVS_OFPRR_NONE
2772 && !rule_is_hidden(rule)) {
2773 ofproto_rule_send_removed(rule);
2775 rule->ofproto->ofproto_class->rule_destruct(rule);
2776 ofproto_rule_destroy__(rule);
2780 ofproto_rule_ref(struct rule *rule)
2783 ovs_refcount_ref(&rule->ref_count);
2788 ofproto_rule_try_ref(struct rule *rule)
2791 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2796 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2797 * ref_count reaches 0.
2799 * Use of RCU allows short term use (between RCU quiescent periods) without
2800 * keeping a reference. A reference must be taken if the rule needs to
2801 * stay around accross the RCU quiescent periods. */
2803 ofproto_rule_unref(struct rule *rule)
2805 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2806 ovsrcu_postpone(rule_destroy_cb, rule);
2811 remove_rule_rcu__(struct rule *rule)
2812 OVS_REQUIRES(ofproto_mutex)
2814 struct ofproto *ofproto = rule->ofproto;
2815 struct oftable *table = &ofproto->tables[rule->table_id];
2817 ovs_assert(!cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
2818 if (!classifier_remove(&table->cls, &rule->cr)) {
2821 ofproto->ofproto_class->rule_delete(rule);
2822 ofproto_rule_unref(rule);
2826 remove_rule_rcu(struct rule *rule)
2827 OVS_EXCLUDED(ofproto_mutex)
2829 ovs_mutex_lock(&ofproto_mutex);
2830 remove_rule_rcu__(rule);
2831 ovs_mutex_unlock(&ofproto_mutex);
2834 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2836 remove_rules_rcu(struct rule **rules)
2837 OVS_EXCLUDED(ofproto_mutex)
2839 struct rule **orig_rules = rules;
2842 struct ofproto *ofproto = rules[0]->ofproto;
2843 unsigned long tables[BITMAP_N_LONGS(256)];
2847 memset(tables, 0, sizeof tables);
2849 ovs_mutex_lock(&ofproto_mutex);
2850 while ((rule = *rules++)) {
2851 /* Defer once for each new table. This defers the subtable cleanup
2852 * until later, so that when removing large number of flows the
2853 * operation is faster. */
2854 if (!bitmap_is_set(tables, rule->table_id)) {
2855 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
2857 bitmap_set1(tables, rule->table_id);
2858 classifier_defer(cls);
2860 remove_rule_rcu__(rule);
2863 BITMAP_FOR_EACH_1(table_id, 256, tables) {
2864 struct classifier *cls = &ofproto->tables[table_id].cls;
2866 classifier_publish(cls);
2868 ovs_mutex_unlock(&ofproto_mutex);
2875 ofproto_group_ref(struct ofgroup *group)
2878 ovs_refcount_ref(&group->ref_count);
2883 ofproto_group_unref(struct ofgroup *group)
2885 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2886 group->ofproto->ofproto_class->group_destruct(group);
2887 ofputil_bucket_list_destroy(&group->buckets);
2888 group->ofproto->ofproto_class->group_dealloc(group);
2892 static uint32_t get_provider_meter_id(const struct ofproto *,
2893 uint32_t of_meter_id);
2895 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2896 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2897 const struct rule_actions *
2898 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2900 struct rule_actions *actions;
2902 actions = xmalloc(sizeof *actions + ofpacts_len);
2903 actions->ofpacts_len = ofpacts_len;
2904 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2905 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2907 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2913 /* Free the actions after the RCU quiescent period is reached. */
2915 rule_actions_destroy(const struct rule_actions *actions)
2918 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2922 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2923 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2925 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2926 OVS_REQUIRES(ofproto_mutex)
2928 if (port == OFPP_ANY) {
2931 const struct rule_actions *actions = rule_get_actions(rule);
2932 return ofpacts_output_to_port(actions->ofpacts,
2933 actions->ofpacts_len, port);
2937 /* Returns true if 'rule' has group and equals group_id. */
2939 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2940 OVS_REQUIRES(ofproto_mutex)
2942 if (group_id == OFPG_ANY) {
2945 const struct rule_actions *actions = rule_get_actions(rule);
2946 return ofpacts_output_to_group(actions->ofpacts,
2947 actions->ofpacts_len, group_id);
2952 rule_execute_destroy(struct rule_execute *e)
2954 ofproto_rule_unref(e->rule);
2955 list_remove(&e->list_node);
2959 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2960 * by passing them to the ofproto provider. */
2962 run_rule_executes(struct ofproto *ofproto)
2963 OVS_EXCLUDED(ofproto_mutex)
2965 struct rule_execute *e, *next;
2966 struct ovs_list executes;
2968 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2969 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2972 flow_extract(e->packet, &flow);
2973 flow.in_port.ofp_port = e->in_port;
2974 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2976 rule_execute_destroy(e);
2980 /* Destroys and discards all "rule_execute" operations queued up in
2981 * ofproto->rule_executes. */
2983 destroy_rule_executes(struct ofproto *ofproto)
2985 struct rule_execute *e, *next;
2986 struct ovs_list executes;
2988 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2989 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2990 dp_packet_delete(e->packet);
2991 rule_execute_destroy(e);
2996 rule_is_readonly(const struct rule *rule)
2998 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2999 return (table->flags & OFTABLE_READONLY) != 0;
3003 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
3005 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
3006 return hash_3words(cookie, cookie >> 32, table_id);
3010 learned_cookies_update_one__(struct ofproto *ofproto,
3011 const struct ofpact_learn *learn,
3012 int delta, struct ovs_list *dead_cookies)
3013 OVS_REQUIRES(ofproto_mutex)
3015 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
3016 struct learned_cookie *c;
3018 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
3019 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
3021 ovs_assert(c->n >= 0);
3024 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
3025 list_push_back(dead_cookies, &c->u.list_node);
3032 ovs_assert(delta > 0);
3033 c = xmalloc(sizeof *c);
3034 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
3035 c->cookie = learn->cookie;
3036 c->table_id = learn->table_id;
3040 static const struct ofpact_learn *
3041 next_learn_with_delete(const struct rule_actions *actions,
3042 const struct ofpact_learn *start)
3044 const struct ofpact *pos;
3046 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
3047 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
3048 pos = ofpact_next(pos)) {
3049 if (pos->type == OFPACT_LEARN) {
3050 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
3051 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3061 learned_cookies_update__(struct ofproto *ofproto,
3062 const struct rule_actions *actions,
3063 int delta, struct ovs_list *dead_cookies)
3064 OVS_REQUIRES(ofproto_mutex)
3066 if (actions->has_learn_with_delete) {
3067 const struct ofpact_learn *learn;
3069 for (learn = next_learn_with_delete(actions, NULL); learn;
3070 learn = next_learn_with_delete(actions, learn)) {
3071 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3077 learned_cookies_inc(struct ofproto *ofproto,
3078 const struct rule_actions *actions)
3079 OVS_REQUIRES(ofproto_mutex)
3081 learned_cookies_update__(ofproto, actions, +1, NULL);
3085 learned_cookies_dec(struct ofproto *ofproto,
3086 const struct rule_actions *actions,
3087 struct ovs_list *dead_cookies)
3088 OVS_REQUIRES(ofproto_mutex)
3090 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3094 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3095 OVS_REQUIRES(ofproto_mutex)
3097 struct learned_cookie *c;
3099 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3100 struct rule_criteria criteria;
3101 struct rule_collection rules;
3104 match_init_catchall(&match);
3105 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3106 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3107 rule_criteria_require_rw(&criteria, false);
3108 collect_rules_loose(ofproto, &criteria, &rules);
3109 rule_criteria_destroy(&criteria);
3110 delete_flows__(&rules, OFPRR_DELETE, NULL);
3117 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3119 ofconn_send_reply(ofconn, make_echo_reply(oh));
3124 query_tables(struct ofproto *ofproto,
3125 struct ofputil_table_features **featuresp,
3126 struct ofputil_table_stats **statsp)
3128 struct mf_bitmap rw_fields = oxm_writable_fields();
3129 struct mf_bitmap match = oxm_matchable_fields();
3130 struct mf_bitmap mask = oxm_maskable_fields();
3132 struct ofputil_table_features *features;
3133 struct ofputil_table_stats *stats;
3136 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3137 for (i = 0; i < ofproto->n_tables; i++) {
3138 struct ofputil_table_features *f = &features[i];
3141 sprintf(f->name, "table%d", i);
3142 f->metadata_match = OVS_BE64_MAX;
3143 f->metadata_write = OVS_BE64_MAX;
3144 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3145 f->max_entries = 1000000;
3147 bool more_tables = false;
3148 for (int j = i + 1; j < ofproto->n_tables; j++) {
3149 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3150 bitmap_set1(f->nonmiss.next, j);
3154 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3156 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3158 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3159 f->nonmiss.write.set_fields = rw_fields;
3160 f->nonmiss.apply = f->nonmiss.write;
3161 f->miss = f->nonmiss;
3165 f->wildcard = match;
3169 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3170 for (i = 0; i < ofproto->n_tables; i++) {
3171 struct ofputil_table_stats *s = &stats[i];
3174 s->active_count = ofproto->tables[i].n_flows;
3176 s->active_count -= connmgr_count_hidden_rules(
3184 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3186 for (i = 0; i < ofproto->n_tables; i++) {
3187 const struct oftable *table = &ofproto->tables[i];
3188 struct ofputil_table_features *f = &features[i];
3191 ovs_strzcpy(f->name, table->name, sizeof f->name);
3194 if (table->max_flows < f->max_entries) {
3195 f->max_entries = table->max_flows;
3201 query_switch_features(struct ofproto *ofproto,
3202 bool *arp_match_ip, uint64_t *ofpacts)
3204 struct ofputil_table_features *features, *f;
3206 *arp_match_ip = false;
3209 query_tables(ofproto, &features, NULL);
3210 for (f = features; f < &features[ofproto->n_tables]; f++) {
3211 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3212 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3213 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3214 *arp_match_ip = true;
3220 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3224 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3226 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3227 struct ofputil_switch_features features;
3228 struct ofport *port;
3232 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3234 features.datapath_id = ofproto->datapath_id;
3235 features.n_buffers = pktbuf_capacity();
3236 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3237 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3238 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3239 OFPUTIL_C_GROUP_STATS);
3241 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3243 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3244 features.auxiliary_id = 0;
3245 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3247 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3248 ofputil_put_switch_features_port(&port->pp, b);
3251 ofconn_send_reply(ofconn, b);
3256 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3258 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3259 struct ofp_switch_config *osc;
3260 enum ofp_config_flags flags;
3264 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3265 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3266 flags = ofproto->frag_handling;
3267 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3268 if (oh->version < OFP13_VERSION
3269 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3270 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3272 osc->flags = htons(flags);
3273 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3274 ofconn_send_reply(ofconn, buf);
3280 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3282 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3283 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3284 uint16_t flags = ntohs(osc->flags);
3286 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3287 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3288 enum ofp_config_flags cur = ofproto->frag_handling;
3289 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3291 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3293 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3294 ofproto->frag_handling = next;
3296 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3298 ofputil_frag_handling_to_string(next));
3302 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3303 ofconn_set_invalid_ttl_to_controller(ofconn,
3304 (oh->version < OFP13_VERSION
3305 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3307 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3312 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3313 * error message code for the caller to propagate upward. Otherwise, returns
3316 * The log message mentions 'msg_type'. */
3318 reject_slave_controller(struct ofconn *ofconn)
3320 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3321 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3322 return OFPERR_OFPBRC_IS_SLAVE;
3328 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3331 * - If they use a meter, then 'ofproto' has that meter configured.
3333 * - If they use any groups, then 'ofproto' has that group configured.
3335 * Returns 0 if successful, otherwise an OpenFlow error. */
3337 ofproto_check_ofpacts(struct ofproto *ofproto,
3338 const struct ofpact ofpacts[], size_t ofpacts_len)
3340 const struct ofpact *a;
3343 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3344 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3345 return OFPERR_OFPMMFC_INVALID_METER;
3348 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3349 if (a->type == OFPACT_GROUP
3350 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3351 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3359 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3361 struct ofproto *p = ofconn_get_ofproto(ofconn);
3362 struct ofputil_packet_out po;
3363 struct dp_packet *payload;
3364 uint64_t ofpacts_stub[1024 / 8];
3365 struct ofpbuf ofpacts;
3369 COVERAGE_INC(ofproto_packet_out);
3371 error = reject_slave_controller(ofconn);
3376 /* Decode message. */
3377 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3378 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3380 goto exit_free_ofpacts;
3382 if (ofp_to_u16(po.in_port) >= p->max_ports
3383 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3384 error = OFPERR_OFPBRC_BAD_PORT;
3385 goto exit_free_ofpacts;
3389 if (po.buffer_id != UINT32_MAX) {
3390 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3391 if (error || !payload) {
3392 goto exit_free_ofpacts;
3395 /* Ensure that the L3 header is 32-bit aligned. */
3396 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3399 /* Verify actions against packet, then send packet if successful. */
3400 flow_extract(payload, &flow);
3401 flow.in_port.ofp_port = po.in_port;
3402 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3404 error = p->ofproto_class->packet_out(p, payload, &flow,
3405 po.ofpacts, po.ofpacts_len);
3407 dp_packet_delete(payload);
3410 ofpbuf_uninit(&ofpacts);
3416 update_port_config(struct ofconn *ofconn, struct ofport *port,
3417 enum ofputil_port_config config,
3418 enum ofputil_port_config mask)
3420 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3422 if (toggle & OFPUTIL_PC_PORT_DOWN
3423 && (config & OFPUTIL_PC_PORT_DOWN
3424 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3425 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3426 /* We tried to bring the port up or down, but it failed, so don't
3427 * update the "down" bit. */
3428 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3432 enum ofputil_port_config old_config = port->pp.config;
3433 port->pp.config ^= toggle;
3434 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3435 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3441 port_mod_start(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3442 struct ofport **port)
3444 struct ofproto *p = ofconn_get_ofproto(ofconn);
3446 *port = ofproto_get_port(p, pm->port_no);
3448 return OFPERR_OFPPMFC_BAD_PORT;
3450 if (!eth_addr_equals((*port)->pp.hw_addr, pm->hw_addr)) {
3451 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3457 port_mod_finish(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3458 struct ofport *port)
3460 update_port_config(ofconn, port, pm->config, pm->mask);
3461 if (pm->advertise) {
3462 netdev_set_advertisements(port->netdev, pm->advertise);
3467 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3469 struct ofputil_port_mod pm;
3470 struct ofport *port;
3473 error = reject_slave_controller(ofconn);
3478 error = ofputil_decode_port_mod(oh, &pm, false);
3483 error = port_mod_start(ofconn, &pm, &port);
3485 port_mod_finish(ofconn, &pm, port);
3491 handle_desc_stats_request(struct ofconn *ofconn,
3492 const struct ofp_header *request)
3494 static const char *default_mfr_desc = "Nicira, Inc.";
3495 static const char *default_hw_desc = "Open vSwitch";
3496 static const char *default_sw_desc = VERSION;
3497 static const char *default_serial_desc = "None";
3498 static const char *default_dp_desc = "None";
3500 struct ofproto *p = ofconn_get_ofproto(ofconn);
3501 struct ofp_desc_stats *ods;
3504 msg = ofpraw_alloc_stats_reply(request, 0);
3505 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3506 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3507 sizeof ods->mfr_desc);
3508 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3509 sizeof ods->hw_desc);
3510 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3511 sizeof ods->sw_desc);
3512 ovs_strlcpy(ods->serial_num,
3513 p->serial_desc ? p->serial_desc : default_serial_desc,
3514 sizeof ods->serial_num);
3515 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3516 sizeof ods->dp_desc);
3517 ofconn_send_reply(ofconn, msg);
3523 handle_table_stats_request(struct ofconn *ofconn,
3524 const struct ofp_header *request)
3526 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3527 struct ofputil_table_features *features;
3528 struct ofputil_table_stats *stats;
3529 struct ofpbuf *reply;
3532 query_tables(ofproto, &features, &stats);
3534 reply = ofputil_encode_table_stats_reply(request);
3535 for (i = 0; i < ofproto->n_tables; i++) {
3536 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3537 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3540 ofconn_send_reply(ofconn, reply);
3549 handle_table_features_request(struct ofconn *ofconn,
3550 const struct ofp_header *request)
3552 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3553 struct ofputil_table_features *features;
3554 struct ovs_list replies;
3558 ofpbuf_use_const(&msg, request, ntohs(request->length));
3559 ofpraw_pull_assert(&msg);
3560 if (msg.size || ofpmp_more(request)) {
3561 return OFPERR_OFPTFFC_EPERM;
3564 query_tables(ofproto, &features, NULL);
3566 ofpmp_init(&replies, request);
3567 for (i = 0; i < ofproto->n_tables; i++) {
3568 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3569 ofputil_append_table_features_reply(&features[i], &replies);
3572 ofconn_send_replies(ofconn, &replies);
3580 append_port_stat(struct ofport *port, struct ovs_list *replies)
3582 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3584 calc_duration(port->created, time_msec(),
3585 &ops.duration_sec, &ops.duration_nsec);
3587 /* Intentionally ignore return value, since errors will set
3588 * 'stats' to all-1s, which is correct for OpenFlow, and
3589 * netdev_get_stats() will log errors. */
3590 ofproto_port_get_stats(port, &ops.stats);
3592 ofputil_append_port_stat(replies, &ops);
3596 handle_port_request(struct ofconn *ofconn,
3597 const struct ofp_header *request, ofp_port_t port_no,
3598 void (*cb)(struct ofport *, struct ovs_list *replies))
3600 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3601 struct ofport *port;
3602 struct ovs_list replies;
3604 ofpmp_init(&replies, request);
3605 if (port_no != OFPP_ANY) {
3606 port = ofproto_get_port(ofproto, port_no);
3611 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3616 ofconn_send_replies(ofconn, &replies);
3620 handle_port_stats_request(struct ofconn *ofconn,
3621 const struct ofp_header *request)
3626 error = ofputil_decode_port_stats_request(request, &port_no);
3628 handle_port_request(ofconn, request, port_no, append_port_stat);
3634 append_port_desc(struct ofport *port, struct ovs_list *replies)
3636 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3640 handle_port_desc_stats_request(struct ofconn *ofconn,
3641 const struct ofp_header *request)
3646 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3648 handle_port_request(ofconn, request, port_no, append_port_desc);
3654 hash_cookie(ovs_be64 cookie)
3656 return hash_uint64((OVS_FORCE uint64_t)cookie);
3660 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3661 OVS_REQUIRES(ofproto_mutex)
3663 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3664 hash_cookie(rule->flow_cookie));
3668 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3669 OVS_REQUIRES(ofproto_mutex)
3671 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3675 calc_duration(long long int start, long long int now,
3676 uint32_t *sec, uint32_t *nsec)
3678 long long int msecs = now - start;
3679 *sec = msecs / 1000;
3680 *nsec = (msecs % 1000) * (1000 * 1000);
3683 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3684 * true if 'table_id' is OK, false otherwise. */
3686 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3688 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3691 static struct oftable *
3692 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3694 struct oftable *table;
3696 for (table = &ofproto->tables[table_id];
3697 table < &ofproto->tables[ofproto->n_tables];
3699 if (!(table->flags & OFTABLE_HIDDEN)) {
3707 static struct oftable *
3708 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3710 if (table_id == 0xff) {
3711 return next_visible_table(ofproto, 0);
3712 } else if (table_id < ofproto->n_tables) {
3713 return &ofproto->tables[table_id];
3719 static struct oftable *
3720 next_matching_table(const struct ofproto *ofproto,
3721 const struct oftable *table, uint8_t table_id)
3723 return (table_id == 0xff
3724 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3728 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3730 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3731 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3733 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3734 * only once, for that table. (This can be used to access tables marked
3737 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3738 * entered at all. (Perhaps you should have validated TABLE_ID with
3739 * check_table_id().)
3741 * All parameters are evaluated multiple times.
3743 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3744 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3746 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3748 /* Initializes 'criteria' in a straightforward way based on the other
3751 * By default, the criteria include flows that are read-only, on the assumption
3752 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3753 * if flows will be modified.
3755 * For "loose" matching, the 'priority' parameter is unimportant and may be
3758 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3759 const struct match *match, int priority,
3760 cls_version_t version, ovs_be64 cookie,
3761 ovs_be64 cookie_mask, ofp_port_t out_port,
3764 criteria->table_id = table_id;
3765 cls_rule_init(&criteria->cr, match, priority, version);
3766 criteria->cookie = cookie;
3767 criteria->cookie_mask = cookie_mask;
3768 criteria->out_port = out_port;
3769 criteria->out_group = out_group;
3771 /* We ordinarily want to skip hidden rules, but there has to be a way for
3772 * code internal to OVS to modify and delete them, so if the criteria
3773 * specify a priority that can only be for a hidden flow, then allow hidden
3774 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3775 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3777 criteria->include_hidden = priority > UINT16_MAX;
3779 /* We assume that the criteria are being used to collect flows for reading
3780 * but not modification. Thus, we should collect read-only flows. */
3781 criteria->include_readonly = true;
3784 /* By default, criteria initialized by rule_criteria_init() will match flows
3785 * that are read-only, on the assumption that the collected flows won't be
3786 * modified. Call this function to match only flows that are be modifiable.
3788 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3789 * caller has special privileges that allow it to modify even "read-only"
3792 rule_criteria_require_rw(struct rule_criteria *criteria,
3793 bool can_write_readonly)
3795 criteria->include_readonly = can_write_readonly;
3799 rule_criteria_destroy(struct rule_criteria *criteria)
3801 cls_rule_destroy(&criteria->cr);
3805 rule_collection_init(struct rule_collection *rules)
3807 rules->rules = rules->stub;
3809 rules->capacity = ARRAY_SIZE(rules->stub);
3813 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3815 if (rules->n >= rules->capacity) {
3816 size_t old_size, new_size;
3818 old_size = rules->capacity * sizeof *rules->rules;
3819 rules->capacity *= 2;
3820 new_size = rules->capacity * sizeof *rules->rules;
3822 if (rules->rules == rules->stub) {
3823 rules->rules = xmalloc(new_size);
3824 memcpy(rules->rules, rules->stub, old_size);
3826 rules->rules = xrealloc(rules->rules, new_size);
3830 rules->rules[rules->n++] = rule;
3834 rule_collection_ref(struct rule_collection *rules)
3835 OVS_REQUIRES(ofproto_mutex)
3839 for (i = 0; i < rules->n; i++) {
3840 ofproto_rule_ref(rules->rules[i]);
3845 rule_collection_unref(struct rule_collection *rules)
3849 for (i = 0; i < rules->n; i++) {
3850 ofproto_rule_unref(rules->rules[i]);
3854 /* Returns a NULL-terminated array of rule pointers,
3855 * destroys 'rules'. */
3856 static struct rule **
3857 rule_collection_detach(struct rule_collection *rules)
3859 struct rule **rule_array;
3861 rule_collection_add(rules, NULL);
3863 if (rules->rules == rules->stub) {
3864 rules->rules = xmemdup(rules->rules, rules->n * sizeof *rules->rules);
3867 rule_array = rules->rules;
3868 rule_collection_init(rules);
3874 rule_collection_destroy(struct rule_collection *rules)
3876 if (rules->rules != rules->stub) {
3880 /* Make repeated destruction harmless. */
3881 rule_collection_init(rules);
3884 /* Schedules postponed removal of rules, destroys 'rules'. */
3886 rule_collection_remove_postponed(struct rule_collection *rules)
3887 OVS_REQUIRES(ofproto_mutex)
3890 if (rules->n == 1) {
3891 ovsrcu_postpone(remove_rule_rcu, rules->rules[0]);
3893 ovsrcu_postpone(remove_rules_rcu, rule_collection_detach(rules));
3898 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3899 * function verifies most of the criteria in 'c' itself, but the caller must
3900 * check 'c->cr' itself.
3902 * Rules that have already been marked for removal are not collected.
3904 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3905 * 'c' only includes modifiable rules). */
3907 collect_rule(struct rule *rule, const struct rule_criteria *c,
3908 struct rule_collection *rules, size_t *n_readonly)
3909 OVS_REQUIRES(ofproto_mutex)
3911 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3912 && ofproto_rule_has_out_port(rule, c->out_port)
3913 && ofproto_rule_has_out_group(rule, c->out_group)
3914 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3915 && (!rule_is_hidden(rule) || c->include_hidden)
3916 && cls_rule_visible_in_version(&rule->cr, c->cr.version)) {
3917 /* Rule matches all the criteria... */
3918 if (!rule_is_readonly(rule) || c->include_readonly) {
3920 rule_collection_add(rules, rule);
3922 /* ...except it's read-only. */
3928 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3929 * on classifiers rules are done in the "loose" way required for OpenFlow
3930 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3933 * Returns 0 on success, otherwise an OpenFlow error code. */
3935 collect_rules_loose(struct ofproto *ofproto,
3936 const struct rule_criteria *criteria,
3937 struct rule_collection *rules)
3938 OVS_REQUIRES(ofproto_mutex)
3940 struct oftable *table;
3941 enum ofperr error = 0;
3942 size_t n_readonly = 0;
3944 rule_collection_init(rules);
3946 if (!check_table_id(ofproto, criteria->table_id)) {
3947 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3951 if (criteria->cookie_mask == OVS_BE64_MAX) {
3954 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3955 hash_cookie(criteria->cookie),
3956 &ofproto->cookies) {
3957 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3958 collect_rule(rule, criteria, rules, &n_readonly);
3962 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3965 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3966 collect_rule(rule, criteria, rules, &n_readonly);
3972 if (!error && !rules->n && n_readonly) {
3973 /* We didn't find any rules to modify. We did find some read-only
3974 * rules that we're not allowed to modify, so report that. */
3975 error = OFPERR_OFPBRC_EPERM;
3978 rule_collection_destroy(rules);
3983 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3984 * on classifiers rules are done in the "strict" way required for OpenFlow
3985 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3986 * rules on list 'rules'.
3988 * Returns 0 on success, otherwise an OpenFlow error code. */
3990 collect_rules_strict(struct ofproto *ofproto,
3991 const struct rule_criteria *criteria,
3992 struct rule_collection *rules)
3993 OVS_REQUIRES(ofproto_mutex)
3995 struct oftable *table;
3996 size_t n_readonly = 0;
3997 enum ofperr error = 0;
3999 rule_collection_init(rules);
4001 if (!check_table_id(ofproto, criteria->table_id)) {
4002 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4006 if (criteria->cookie_mask == OVS_BE64_MAX) {
4009 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4010 hash_cookie(criteria->cookie),
4011 &ofproto->cookies) {
4012 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
4013 collect_rule(rule, criteria, rules, &n_readonly);
4017 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4020 rule = rule_from_cls_rule(classifier_find_rule_exactly(
4021 &table->cls, &criteria->cr));
4023 collect_rule(rule, criteria, rules, &n_readonly);
4029 if (!error && !rules->n && n_readonly) {
4030 /* We didn't find any rules to modify. We did find some read-only
4031 * rules that we're not allowed to modify, so report that. */
4032 error = OFPERR_OFPBRC_EPERM;
4035 rule_collection_destroy(rules);
4040 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4041 * forced into the range of a uint16_t. */
4043 age_secs(long long int age_ms)
4045 return (age_ms < 0 ? 0
4046 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
4047 : (unsigned int) age_ms / 1000);
4051 handle_flow_stats_request(struct ofconn *ofconn,
4052 const struct ofp_header *request)
4053 OVS_EXCLUDED(ofproto_mutex)
4055 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4056 struct ofputil_flow_stats_request fsr;
4057 struct rule_criteria criteria;
4058 struct rule_collection rules;
4059 struct ovs_list replies;
4063 error = ofputil_decode_flow_stats_request(&fsr, request);
4068 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
4069 fsr.cookie, fsr.cookie_mask, fsr.out_port,
4072 ovs_mutex_lock(&ofproto_mutex);
4073 error = collect_rules_loose(ofproto, &criteria, &rules);
4074 rule_criteria_destroy(&criteria);
4076 rule_collection_ref(&rules);
4078 ovs_mutex_unlock(&ofproto_mutex);
4084 ofpmp_init(&replies, request);
4085 for (i = 0; i < rules.n; i++) {
4086 struct rule *rule = rules.rules[i];
4087 long long int now = time_msec();
4088 struct ofputil_flow_stats fs;
4089 long long int created, used, modified;
4090 const struct rule_actions *actions;
4091 enum ofputil_flow_mod_flags flags;
4093 ovs_mutex_lock(&rule->mutex);
4094 fs.cookie = rule->flow_cookie;
4095 fs.idle_timeout = rule->idle_timeout;
4096 fs.hard_timeout = rule->hard_timeout;
4097 fs.importance = rule->importance;
4098 created = rule->created;
4099 modified = rule->modified;
4100 actions = rule_get_actions(rule);
4101 flags = rule->flags;
4102 ovs_mutex_unlock(&rule->mutex);
4104 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
4105 &fs.byte_count, &used);
4107 minimatch_expand(&rule->cr.match, &fs.match);
4108 fs.table_id = rule->table_id;
4109 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4110 fs.priority = rule->cr.priority;
4111 fs.idle_age = age_secs(now - used);
4112 fs.hard_age = age_secs(now - modified);
4113 fs.ofpacts = actions->ofpacts;
4114 fs.ofpacts_len = actions->ofpacts_len;
4117 ofputil_append_flow_stats_reply(&fs, &replies);
4120 rule_collection_unref(&rules);
4121 rule_collection_destroy(&rules);
4123 ofconn_send_replies(ofconn, &replies);
4129 flow_stats_ds(struct rule *rule, struct ds *results)
4131 uint64_t packet_count, byte_count;
4132 const struct rule_actions *actions;
4133 long long int created, used;
4135 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4136 &byte_count, &used);
4138 ovs_mutex_lock(&rule->mutex);
4139 actions = rule_get_actions(rule);
4140 created = rule->created;
4141 ovs_mutex_unlock(&rule->mutex);
4143 if (rule->table_id != 0) {
4144 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4146 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4147 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4148 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4149 cls_rule_format(&rule->cr, results);
4150 ds_put_char(results, ',');
4152 ds_put_cstr(results, "actions=");
4153 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4155 ds_put_cstr(results, "\n");
4158 /* Adds a pretty-printed description of all flows to 'results', including
4159 * hidden flows (e.g., set up by in-band control). */
4161 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4163 struct oftable *table;
4165 OFPROTO_FOR_EACH_TABLE (table, p) {
4168 CLS_FOR_EACH (rule, cr, &table->cls) {
4169 flow_stats_ds(rule, results);
4174 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4175 * '*engine_type' and '*engine_id', respectively. */
4177 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4178 uint8_t *engine_type, uint8_t *engine_id)
4180 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4183 /* Checks the status change of CFM on 'ofport'.
4185 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4187 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4189 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4190 return (ofport && ofproto->ofproto_class->cfm_status_changed
4191 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4195 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4196 * Returns 0 if the port's CFM status was successfully stored into
4197 * '*status'. Returns positive errno if the port did not have CFM
4200 * The caller must provide and own '*status', and must free 'status->rmps'.
4201 * '*status' is indeterminate if the return value is non-zero. */
4203 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4204 struct cfm_status *status)
4206 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4207 return (ofport && ofproto->ofproto_class->get_cfm_status
4208 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4213 handle_aggregate_stats_request(struct ofconn *ofconn,
4214 const struct ofp_header *oh)
4215 OVS_EXCLUDED(ofproto_mutex)
4217 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4218 struct ofputil_flow_stats_request request;
4219 struct ofputil_aggregate_stats stats;
4220 bool unknown_packets, unknown_bytes;
4221 struct rule_criteria criteria;
4222 struct rule_collection rules;
4223 struct ofpbuf *reply;
4227 error = ofputil_decode_flow_stats_request(&request, oh);
4232 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4233 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4234 request.out_port, request.out_group);
4236 ovs_mutex_lock(&ofproto_mutex);
4237 error = collect_rules_loose(ofproto, &criteria, &rules);
4238 rule_criteria_destroy(&criteria);
4240 rule_collection_ref(&rules);
4242 ovs_mutex_unlock(&ofproto_mutex);
4248 memset(&stats, 0, sizeof stats);
4249 unknown_packets = unknown_bytes = false;
4250 for (i = 0; i < rules.n; i++) {
4251 struct rule *rule = rules.rules[i];
4252 uint64_t packet_count;
4253 uint64_t byte_count;
4256 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4257 &byte_count, &used);
4259 if (packet_count == UINT64_MAX) {
4260 unknown_packets = true;
4262 stats.packet_count += packet_count;
4265 if (byte_count == UINT64_MAX) {
4266 unknown_bytes = true;
4268 stats.byte_count += byte_count;
4273 if (unknown_packets) {
4274 stats.packet_count = UINT64_MAX;
4276 if (unknown_bytes) {
4277 stats.byte_count = UINT64_MAX;
4280 rule_collection_unref(&rules);
4281 rule_collection_destroy(&rules);
4283 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4284 ofconn_send_reply(ofconn, reply);
4289 struct queue_stats_cbdata {
4290 struct ofport *ofport;
4291 struct ovs_list replies;
4296 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4297 const struct netdev_queue_stats *stats)
4299 struct ofputil_queue_stats oqs;
4301 oqs.port_no = cbdata->ofport->pp.port_no;
4302 oqs.queue_id = queue_id;
4303 oqs.tx_bytes = stats->tx_bytes;
4304 oqs.tx_packets = stats->tx_packets;
4305 oqs.tx_errors = stats->tx_errors;
4306 if (stats->created != LLONG_MIN) {
4307 calc_duration(stats->created, cbdata->now,
4308 &oqs.duration_sec, &oqs.duration_nsec);
4310 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4312 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4316 handle_queue_stats_dump_cb(uint32_t queue_id,
4317 struct netdev_queue_stats *stats,
4320 struct queue_stats_cbdata *cbdata = cbdata_;
4322 put_queue_stats(cbdata, queue_id, stats);
4326 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4327 struct queue_stats_cbdata *cbdata)
4329 cbdata->ofport = port;
4330 if (queue_id == OFPQ_ALL) {
4331 netdev_dump_queue_stats(port->netdev,
4332 handle_queue_stats_dump_cb, cbdata);
4334 struct netdev_queue_stats stats;
4336 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4337 put_queue_stats(cbdata, queue_id, &stats);
4339 return OFPERR_OFPQOFC_BAD_QUEUE;
4346 handle_queue_stats_request(struct ofconn *ofconn,
4347 const struct ofp_header *rq)
4349 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4350 struct queue_stats_cbdata cbdata;
4351 struct ofport *port;
4353 struct ofputil_queue_stats_request oqsr;
4355 COVERAGE_INC(ofproto_queue_req);
4357 ofpmp_init(&cbdata.replies, rq);
4358 cbdata.now = time_msec();
4360 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4365 if (oqsr.port_no == OFPP_ANY) {
4366 error = OFPERR_OFPQOFC_BAD_QUEUE;
4367 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4368 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4373 port = ofproto_get_port(ofproto, oqsr.port_no);
4375 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4376 : OFPERR_OFPQOFC_BAD_PORT);
4379 ofconn_send_replies(ofconn, &cbdata.replies);
4381 ofpbuf_list_delete(&cbdata.replies);
4388 evict_rules_from_table(struct oftable *table)
4389 OVS_REQUIRES(ofproto_mutex)
4391 enum ofperr error = 0;
4392 struct rule_collection rules;
4393 unsigned int count = table->n_flows;
4394 unsigned int max_flows = table->max_flows;
4396 rule_collection_init(&rules);
4398 while (count-- > max_flows) {
4401 if (!choose_rule_to_evict(table, &rule)) {
4402 error = OFPERR_OFPFMFC_TABLE_FULL;
4405 eviction_group_remove_rule(rule);
4406 rule_collection_add(&rules, rule);
4409 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4415 get_conjunctions(const struct ofputil_flow_mod *fm,
4416 struct cls_conjunction **conjsp, size_t *n_conjsp)
4417 OVS_REQUIRES(ofproto_mutex)
4419 struct cls_conjunction *conjs = NULL;
4422 const struct ofpact *ofpact;
4423 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4424 if (ofpact->type == OFPACT_CONJUNCTION) {
4426 } else if (ofpact->type != OFPACT_NOTE) {
4427 /* "conjunction" may appear with "note" actions but not with any
4428 * other type of actions. */
4429 ovs_assert(!n_conjs);
4436 conjs = xzalloc(n_conjs * sizeof *conjs);
4437 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4438 if (ofpact->type == OFPACT_CONJUNCTION) {
4439 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4440 conjs[i].clause = oc->clause;
4441 conjs[i].n_clauses = oc->n_clauses;
4442 conjs[i].id = oc->id;
4449 *n_conjsp = n_conjs;
4452 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4453 * in which no matching flow already exists in the flow table.
4455 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4456 * success, or an OpenFlow error code on failure.
4458 * On successful return the caller must complete the operation either by
4459 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4462 * The caller retains ownership of 'fm->ofpacts'. */
4464 add_flow_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4465 struct rule **old_rule, struct rule **new_rule)
4466 OVS_REQUIRES(ofproto_mutex)
4468 struct oftable *table;
4472 struct cls_conjunction *conjs;
4476 if (!check_table_id(ofproto, fm->table_id)) {
4477 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4482 if (fm->table_id == 0xff) {
4483 if (ofproto->ofproto_class->rule_choose_table) {
4484 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4490 ovs_assert(table_id < ofproto->n_tables);
4494 } else if (fm->table_id < ofproto->n_tables) {
4495 table_id = fm->table_id;
4497 return OFPERR_OFPBRC_BAD_TABLE_ID;
4500 table = &ofproto->tables[table_id];
4501 if (table->flags & OFTABLE_READONLY
4502 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4503 return OFPERR_OFPBRC_EPERM;
4506 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4507 && !match_has_default_hidden_fields(&fm->match)) {
4508 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4509 "non-default values to hidden fields", ofproto->name);
4510 return OFPERR_OFPBRC_EPERM;
4513 cls_rule_init(&cr, &fm->match, fm->priority, ofproto->tables_version + 1);
4515 /* Check for the existence of an identical rule.
4516 * This will not return rules earlier marked for removal. */
4517 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4520 /* Check for overlap, if requested. */
4521 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4522 && classifier_rule_overlaps(&table->cls, &cr)) {
4523 cls_rule_destroy(&cr);
4524 return OFPERR_OFPFMFC_OVERLAP;
4527 /* If necessary, evict an existing rule to clear out space. */
4528 if (table->n_flows >= table->max_flows) {
4529 if (!choose_rule_to_evict(table, &rule)) {
4530 error = OFPERR_OFPFMFC_TABLE_FULL;
4531 cls_rule_destroy(&cr);
4534 eviction_group_remove_rule(rule);
4535 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4537 fm->delete_reason = OFPRR_EVICTION;
4541 fm->modify_cookie = true;
4544 /* Allocate new rule. */
4545 error = replace_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4551 get_conjunctions(fm, &conjs, &n_conjs);
4552 replace_rule_start(ofproto, rule, *new_rule, conjs, n_conjs);
4558 /* Revert the effects of add_flow_start(). */
4560 add_flow_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4561 struct rule *old_rule, struct rule *new_rule)
4562 OVS_REQUIRES(ofproto_mutex)
4564 if (old_rule && fm->delete_reason == OFPRR_EVICTION) {
4565 /* Revert the eviction. */
4566 eviction_group_add_rule(old_rule);
4569 replace_rule_revert(ofproto, old_rule, new_rule);
4572 /* To be called after version bump. */
4574 add_flow_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4575 const struct flow_mod_requester *req,
4576 struct rule *old_rule, struct rule *new_rule)
4577 OVS_REQUIRES(ofproto_mutex)
4579 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4581 replace_rule_finish(ofproto, fm, req, old_rule, new_rule, &dead_cookies);
4582 learned_cookies_flush(ofproto, &dead_cookies);
4585 ovsrcu_postpone(remove_rule_rcu, old_rule);
4587 if (minimask_get_vid_mask(&new_rule->cr.match.mask) == VLAN_VID_MASK) {
4588 if (ofproto->vlan_bitmap) {
4589 uint16_t vid = miniflow_get_vid(&new_rule->cr.match.flow);
4591 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4592 bitmap_set1(ofproto->vlan_bitmap, vid);
4593 ofproto->vlans_changed = true;
4596 ofproto->vlans_changed = true;
4600 ofmonitor_report(ofproto->connmgr, new_rule, NXFME_ADDED, 0,
4601 req ? req->ofconn : NULL,
4602 req ? req->request->xid : 0, NULL);
4605 send_buffered_packet(req, fm->buffer_id, new_rule);
4608 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4610 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4611 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4612 * structures yet. Takes ownership of 'cr'. */
4614 replace_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4615 struct cls_rule *cr, uint8_t table_id,
4616 struct rule *old_rule, struct rule **new_rule)
4621 /* Allocate new rule. */
4622 rule = ofproto->ofproto_class->rule_alloc();
4624 cls_rule_destroy(cr);
4625 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
4626 return OFPERR_OFPFMFC_UNKNOWN;
4629 /* Initialize base state. */
4630 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4631 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
4632 ovs_refcount_init(&rule->ref_count);
4633 rule->flow_cookie = fm->new_cookie;
4634 rule->created = rule->modified = time_msec();
4636 ovs_mutex_init(&rule->mutex);
4637 ovs_mutex_lock(&rule->mutex);
4638 rule->idle_timeout = fm->idle_timeout;
4639 rule->hard_timeout = fm->hard_timeout;
4640 *CONST_CAST(uint16_t *, &rule->importance) = fm->importance;
4641 rule->removed_reason = OVS_OFPRR_NONE;
4643 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
4644 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4645 *CONST_CAST(const struct rule_actions **, &rule->actions)
4646 = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4647 list_init(&rule->meter_list_node);
4648 rule->eviction_group = NULL;
4649 list_init(&rule->expirable);
4650 rule->monitor_flags = 0;
4651 rule->add_seqno = 0;
4652 rule->modify_seqno = 0;
4654 /* Copy values from old rule for modify semantics. */
4655 if (old_rule && fm->delete_reason != OFPRR_EVICTION) {
4656 bool change_cookie = (fm->modify_cookie
4657 && fm->new_cookie != OVS_BE64_MAX
4658 && fm->new_cookie != old_rule->flow_cookie);
4660 ovs_mutex_lock(&old_rule->mutex);
4661 if (fm->command != OFPFC_ADD) {
4662 rule->idle_timeout = old_rule->idle_timeout;
4663 rule->hard_timeout = old_rule->hard_timeout;
4664 *CONST_CAST(uint16_t *, &rule->importance) = old_rule->importance;
4665 rule->flags = old_rule->flags;
4666 rule->created = old_rule->created;
4668 if (!change_cookie) {
4669 rule->flow_cookie = old_rule->flow_cookie;
4671 ovs_mutex_unlock(&old_rule->mutex);
4673 ovs_mutex_unlock(&rule->mutex);
4675 /* Construct rule, initializing derived state. */
4676 error = ofproto->ofproto_class->rule_construct(rule);
4678 ofproto_rule_destroy__(rule);
4682 rule->removed = true; /* Not yet in ofproto data structures. */
4689 replace_rule_start(struct ofproto *ofproto,
4690 struct rule *old_rule, struct rule *new_rule,
4691 struct cls_conjunction *conjs, size_t n_conjs)
4693 struct oftable *table = &ofproto->tables[new_rule->table_id];
4695 /* 'old_rule' may be either an evicted rule or replaced rule. */
4697 /* Mark the old rule for removal in the next version. */
4698 cls_rule_make_invisible_in_version(&old_rule->cr,
4699 ofproto->tables_version + 1);
4703 /* Insert flow to the classifier, so that later flow_mods may relate
4704 * to it. This is reversible, in case later errors require this to
4706 ofproto_rule_insert__(ofproto, new_rule);
4707 /* Make the new rule visible for classifier lookups only from the next
4709 classifier_insert(&table->cls, &new_rule->cr, conjs, n_conjs);
4712 static void replace_rule_revert(struct ofproto *ofproto,
4713 struct rule *old_rule, struct rule *new_rule)
4715 struct oftable *table = &ofproto->tables[new_rule->table_id];
4718 /* Restore the original visibility of the old rule. */
4719 cls_rule_restore_visibility(&old_rule->cr);
4721 /* Restore table's rule count. */
4725 /* Remove the new rule immediately. It was never visible to lookups. */
4726 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4729 ofproto_rule_remove__(ofproto, new_rule);
4730 /* The rule was not inserted to the ofproto provider, so we can
4731 * release it without deleting it from the ofproto provider. */
4732 ofproto_rule_unref(new_rule);
4735 /* Adds the 'new_rule', replacing the 'old_rule'. */
4737 replace_rule_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4738 const struct flow_mod_requester *req,
4739 struct rule *old_rule, struct rule *new_rule,
4740 struct ovs_list *dead_cookies)
4741 OVS_REQUIRES(ofproto_mutex)
4743 bool forward_stats = !(fm->flags & OFPUTIL_FF_RESET_COUNTS);
4744 struct rule *replaced_rule;
4746 replaced_rule = fm->delete_reason != OFPRR_EVICTION ? old_rule : NULL;
4748 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4749 * is a duplicate rule the 'new_rule' is replacing. The provider should
4750 * link the stats from the old rule to the new one if 'forward_stats' is
4751 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4752 ofproto->ofproto_class->rule_insert(new_rule, replaced_rule,
4754 learned_cookies_inc(ofproto, rule_get_actions(new_rule));
4757 const struct rule_actions *old_actions = rule_get_actions(old_rule);
4759 /* Remove the old rule from data structures. Removal from the
4760 * classifier and the deletion of the rule is RCU postponed by the
4762 ofproto_rule_remove__(ofproto, old_rule);
4763 learned_cookies_dec(ofproto, old_actions, dead_cookies);
4765 if (replaced_rule) {
4766 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4767 ? NXFME_ADDED : NXFME_MODIFIED;
4769 bool change_cookie = (fm->modify_cookie
4770 && fm->new_cookie != OVS_BE64_MAX
4771 && fm->new_cookie != old_rule->flow_cookie);
4773 bool change_actions = !ofpacts_equal(fm->ofpacts,
4775 old_actions->ofpacts,
4776 old_actions->ofpacts_len);
4778 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4779 ofmonitor_report(ofproto->connmgr, new_rule, event, 0,
4780 req ? req->ofconn : NULL,
4781 req ? req->request->xid : 0,
4782 change_actions ? old_actions : NULL);
4785 /* XXX: This is slight duplication with delete_flows_finish__() */
4787 old_rule->removed_reason = OFPRR_EVICTION;
4789 ofmonitor_report(ofproto->connmgr, old_rule, NXFME_DELETED,
4791 req ? req->ofconn : NULL,
4792 req ? req->request->xid : 0, NULL);
4798 modify_flows_start__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4799 struct rule_collection *old_rules,
4800 struct rule_collection *new_rules)
4801 OVS_REQUIRES(ofproto_mutex)
4805 rule_collection_init(new_rules);
4807 if (old_rules->n > 0) {
4808 struct cls_conjunction *conjs;
4812 /* Create a new 'modified' rule for each old rule. */
4813 for (i = 0; i < old_rules->n; i++) {
4814 struct rule *old_rule = old_rules->rules[i];
4815 struct rule *new_rule;
4818 cls_rule_clone_in_version(&cr, &old_rule->cr,
4819 ofproto->tables_version + 1);
4820 error = replace_rule_create(ofproto, fm, &cr, old_rule->table_id,
4821 old_rule, &new_rule);
4823 rule_collection_add(new_rules, new_rule);
4825 rule_collection_unref(new_rules);
4826 rule_collection_destroy(new_rules);
4830 ovs_assert(new_rules->n == old_rules->n);
4832 get_conjunctions(fm, &conjs, &n_conjs);
4833 for (i = 0; i < old_rules->n; i++) {
4834 replace_rule_start(ofproto, old_rules->rules[i],
4835 new_rules->rules[i], conjs, n_conjs);
4838 } else if (!(fm->cookie_mask != htonll(0)
4839 || fm->new_cookie == OVS_BE64_MAX)) {
4840 /* No match, add a new flow. */
4841 error = add_flow_start(ofproto, fm, &old_rules->rules[0],
4842 &new_rules->rules[0]);
4844 ovs_assert(fm->delete_reason == OFPRR_EVICTION
4845 || !old_rules->rules[0]);
4855 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4858 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4861 modify_flows_start_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4862 struct rule_collection *old_rules,
4863 struct rule_collection *new_rules)
4864 OVS_REQUIRES(ofproto_mutex)
4866 struct rule_criteria criteria;
4869 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4870 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4871 rule_criteria_require_rw(&criteria,
4872 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4873 error = collect_rules_loose(ofproto, &criteria, old_rules);
4874 rule_criteria_destroy(&criteria);
4877 error = modify_flows_start__(ofproto, fm, old_rules, new_rules);
4881 rule_collection_destroy(old_rules);
4887 modify_flows_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4888 struct rule_collection *old_rules,
4889 struct rule_collection *new_rules)
4890 OVS_REQUIRES(ofproto_mutex)
4892 /* Old rules were not changed yet, only need to revert new rules. */
4893 if (old_rules->n == 0 && new_rules->n == 1) {
4894 add_flow_revert(ofproto, fm, old_rules->rules[0], new_rules->rules[0]);
4895 } else if (old_rules->n > 0) {
4896 for (size_t i = 0; i < old_rules->n; i++) {
4897 replace_rule_revert(ofproto, old_rules->rules[i],
4898 new_rules->rules[i]);
4900 rule_collection_destroy(new_rules);
4901 rule_collection_destroy(old_rules);
4906 modify_flows_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4907 const struct flow_mod_requester *req,
4908 struct rule_collection *old_rules,
4909 struct rule_collection *new_rules)
4910 OVS_REQUIRES(ofproto_mutex)
4912 if (old_rules->n == 0 && new_rules->n == 1) {
4913 add_flow_finish(ofproto, fm, req, old_rules->rules[0],
4914 new_rules->rules[0]);
4915 } else if (old_rules->n > 0) {
4916 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4918 ovs_assert(new_rules->n == old_rules->n);
4920 for (size_t i = 0; i < old_rules->n; i++) {
4921 replace_rule_finish(ofproto, fm, req, old_rules->rules[i],
4922 new_rules->rules[i], &dead_cookies);
4924 learned_cookies_flush(ofproto, &dead_cookies);
4925 rule_collection_remove_postponed(old_rules);
4927 send_buffered_packet(req, fm->buffer_id, new_rules->rules[0]);
4928 rule_collection_destroy(new_rules);
4932 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4933 * code on failure. */
4935 modify_flow_start_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4936 struct rule_collection *old_rules,
4937 struct rule_collection *new_rules)
4938 OVS_REQUIRES(ofproto_mutex)
4940 struct rule_criteria criteria;
4943 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4944 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
4946 rule_criteria_require_rw(&criteria,
4947 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4948 error = collect_rules_strict(ofproto, &criteria, old_rules);
4949 rule_criteria_destroy(&criteria);
4952 /* collect_rules_strict() can return max 1 rule. */
4953 error = modify_flows_start__(ofproto, fm, old_rules, new_rules);
4957 rule_collection_destroy(old_rules);
4962 /* OFPFC_DELETE implementation. */
4965 delete_flows_start__(struct ofproto *ofproto,
4966 const struct rule_collection *rules)
4967 OVS_REQUIRES(ofproto_mutex)
4969 for (size_t i = 0; i < rules->n; i++) {
4970 struct rule *rule = rules->rules[i];
4971 struct oftable *table = &ofproto->tables[rule->table_id];
4974 cls_rule_make_invisible_in_version(&rule->cr,
4975 ofproto->tables_version + 1);
4980 delete_flows_finish__(struct ofproto *ofproto,
4981 struct rule_collection *rules,
4982 enum ofp_flow_removed_reason reason,
4983 const struct flow_mod_requester *req)
4984 OVS_REQUIRES(ofproto_mutex)
4987 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4989 for (size_t i = 0; i < rules->n; i++) {
4990 struct rule *rule = rules->rules[i];
4992 /* This value will be used to send the flow removed message right
4993 * before the rule is actually destroyed. */
4994 rule->removed_reason = reason;
4996 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4997 req ? req->ofconn : NULL,
4998 req ? req->request->xid : 0, NULL);
4999 ofproto_rule_remove__(ofproto, rule);
5000 learned_cookies_dec(ofproto, rule_get_actions(rule),
5003 rule_collection_remove_postponed(rules);
5005 learned_cookies_flush(ofproto, &dead_cookies);
5009 /* Deletes the rules listed in 'rules'.
5010 * The deleted rules will become invisible to the lookups in the next version.
5011 * Destroys 'rules'. */
5013 delete_flows__(struct rule_collection *rules,
5014 enum ofp_flow_removed_reason reason,
5015 const struct flow_mod_requester *req)
5016 OVS_REQUIRES(ofproto_mutex)
5019 struct ofproto *ofproto = rules->rules[0]->ofproto;
5021 delete_flows_start__(ofproto, rules);
5022 ofproto_bump_tables_version(ofproto);
5023 delete_flows_finish__(ofproto, rules, reason, req);
5024 ofmonitor_flush(ofproto->connmgr);
5028 /* Implements OFPFC_DELETE. */
5030 delete_flows_start_loose(struct ofproto *ofproto,
5031 const struct ofputil_flow_mod *fm,
5032 struct rule_collection *rules)
5033 OVS_REQUIRES(ofproto_mutex)
5035 struct rule_criteria criteria;
5038 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
5039 fm->cookie, fm->cookie_mask, fm->out_port,
5041 rule_criteria_require_rw(&criteria,
5042 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5043 error = collect_rules_loose(ofproto, &criteria, rules);
5044 rule_criteria_destroy(&criteria);
5047 delete_flows_start__(ofproto, rules);
5054 delete_flows_revert(struct ofproto *ofproto,
5055 struct rule_collection *rules)
5056 OVS_REQUIRES(ofproto_mutex)
5058 for (size_t i = 0; i < rules->n; i++) {
5059 struct rule *rule = rules->rules[i];
5060 struct oftable *table = &ofproto->tables[rule->table_id];
5062 /* Restore table's rule count. */
5065 /* Restore the original visibility of the rule. */
5066 cls_rule_restore_visibility(&rule->cr);
5068 rule_collection_destroy(rules);
5072 delete_flows_finish(struct ofproto *ofproto,
5073 const struct ofputil_flow_mod *fm,
5074 const struct flow_mod_requester *req,
5075 struct rule_collection *rules)
5076 OVS_REQUIRES(ofproto_mutex)
5078 delete_flows_finish__(ofproto, rules, fm->delete_reason, req);
5081 /* Implements OFPFC_DELETE_STRICT. */
5083 delete_flow_start_strict(struct ofproto *ofproto,
5084 const struct ofputil_flow_mod *fm,
5085 struct rule_collection *rules)
5086 OVS_REQUIRES(ofproto_mutex)
5088 struct rule_criteria criteria;
5091 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5092 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
5093 fm->out_port, fm->out_group);
5094 rule_criteria_require_rw(&criteria,
5095 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5096 error = collect_rules_strict(ofproto, &criteria, rules);
5097 rule_criteria_destroy(&criteria);
5100 delete_flows_start__(ofproto, rules);
5106 /* This may only be called by rule_destroy_cb()! */
5108 ofproto_rule_send_removed(struct rule *rule)
5109 OVS_EXCLUDED(ofproto_mutex)
5111 struct ofputil_flow_removed fr;
5114 minimatch_expand(&rule->cr.match, &fr.match);
5115 fr.priority = rule->cr.priority;
5117 ovs_mutex_lock(&ofproto_mutex);
5118 fr.cookie = rule->flow_cookie;
5119 fr.reason = rule->removed_reason;
5120 fr.table_id = rule->table_id;
5121 calc_duration(rule->created, time_msec(),
5122 &fr.duration_sec, &fr.duration_nsec);
5123 ovs_mutex_lock(&rule->mutex);
5124 fr.idle_timeout = rule->idle_timeout;
5125 fr.hard_timeout = rule->hard_timeout;
5126 ovs_mutex_unlock(&rule->mutex);
5127 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
5128 &fr.byte_count, &used);
5129 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
5130 ovs_mutex_unlock(&ofproto_mutex);
5133 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5134 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5137 * ofproto implementation ->run() functions should use this function to expire
5138 * OpenFlow flows. */
5140 ofproto_rule_expire(struct rule *rule, uint8_t reason)
5141 OVS_REQUIRES(ofproto_mutex)
5143 struct rule_collection rules;
5145 rules.rules = rules.stub;
5147 rules.stub[0] = rule;
5148 delete_flows__(&rules, reason, NULL);
5151 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5152 * means "infinite". */
5154 reduce_timeout(uint16_t max, uint16_t *timeout)
5156 if (max && (!*timeout || *timeout > max)) {
5161 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5162 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5163 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5165 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5167 ofproto_rule_reduce_timeouts(struct rule *rule,
5168 uint16_t idle_timeout, uint16_t hard_timeout)
5169 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5171 if (!idle_timeout && !hard_timeout) {
5175 ovs_mutex_lock(&ofproto_mutex);
5176 if (list_is_empty(&rule->expirable)) {
5177 list_insert(&rule->ofproto->expirable, &rule->expirable);
5179 ovs_mutex_unlock(&ofproto_mutex);
5181 ovs_mutex_lock(&rule->mutex);
5182 reduce_timeout(idle_timeout, &rule->idle_timeout);
5183 reduce_timeout(hard_timeout, &rule->hard_timeout);
5184 ovs_mutex_unlock(&rule->mutex);
5188 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5189 OVS_EXCLUDED(ofproto_mutex)
5191 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5192 struct ofputil_flow_mod fm;
5193 uint64_t ofpacts_stub[1024 / 8];
5194 struct ofpbuf ofpacts;
5197 error = reject_slave_controller(ofconn);
5202 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5203 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
5205 u16_to_ofp(ofproto->max_ports),
5208 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
5211 struct flow_mod_requester req;
5213 req.ofconn = ofconn;
5215 error = handle_flow_mod__(ofproto, &fm, &req);
5218 goto exit_free_ofpacts;
5221 ofconn_report_flow_mod(ofconn, fm.command);
5224 ofpbuf_uninit(&ofpacts);
5230 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
5231 const struct flow_mod_requester *req)
5232 OVS_EXCLUDED(ofproto_mutex)
5234 struct ofp_bundle_entry be;
5237 ovs_mutex_lock(&ofproto_mutex);
5238 error = do_bundle_flow_mod_start(ofproto, fm, &be);
5240 ofproto_bump_tables_version(ofproto);
5241 do_bundle_flow_mod_finish(ofproto, fm, req, &be);
5243 ofmonitor_flush(ofproto->connmgr);
5244 ovs_mutex_unlock(&ofproto_mutex);
5246 run_rule_executes(ofproto);
5251 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5253 struct ofputil_role_request request;
5254 struct ofputil_role_request reply;
5258 error = ofputil_decode_role_message(oh, &request);
5263 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5264 if (request.have_generation_id
5265 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5266 return OFPERR_OFPRRFC_STALE;
5269 ofconn_set_role(ofconn, request.role);
5272 reply.role = ofconn_get_role(ofconn);
5273 reply.have_generation_id = ofconn_get_master_election_id(
5274 ofconn, &reply.generation_id);
5275 buf = ofputil_encode_role_reply(oh, &reply);
5276 ofconn_send_reply(ofconn, buf);
5282 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5283 const struct ofp_header *oh)
5285 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5286 enum ofputil_protocol cur, next;
5288 cur = ofconn_get_protocol(ofconn);
5289 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5290 ofconn_set_protocol(ofconn, next);
5296 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5298 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5299 enum ofputil_protocol cur, next;
5300 enum ofputil_protocol next_base;
5302 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5304 return OFPERR_OFPBRC_EPERM;
5307 cur = ofconn_get_protocol(ofconn);
5308 next = ofputil_protocol_set_base(cur, next_base);
5309 ofconn_set_protocol(ofconn, next);
5315 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5316 const struct ofp_header *oh)
5318 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5321 format = ntohl(msg->format);
5322 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5323 return OFPERR_OFPBRC_EPERM;
5326 ofconn_set_packet_in_format(ofconn, format);
5331 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5333 const struct nx_async_config *msg = ofpmsg_body(oh);
5334 uint32_t master[OAM_N_TYPES];
5335 uint32_t slave[OAM_N_TYPES];
5337 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5338 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5339 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5341 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5342 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5343 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5345 ofconn_set_async_config(ofconn, master, slave);
5346 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5347 !ofconn_get_miss_send_len(ofconn)) {
5348 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5355 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5358 uint32_t master[OAM_N_TYPES];
5359 uint32_t slave[OAM_N_TYPES];
5360 struct nx_async_config *msg;
5362 ofconn_get_async_config(ofconn, master, slave);
5363 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5364 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5366 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5367 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5368 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5370 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5371 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5372 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5374 ofconn_send_reply(ofconn, buf);
5380 handle_nxt_set_controller_id(struct ofconn *ofconn,
5381 const struct ofp_header *oh)
5383 const struct nx_controller_id *nci = ofpmsg_body(oh);
5385 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5386 return OFPERR_NXBRC_MUST_BE_ZERO;
5389 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5394 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5398 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5399 ? OFPRAW_OFPT10_BARRIER_REPLY
5400 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5401 ofconn_send_reply(ofconn, buf);
5406 ofproto_compose_flow_refresh_update(const struct rule *rule,
5407 enum nx_flow_monitor_flags flags,
5408 struct ovs_list *msgs)
5409 OVS_REQUIRES(ofproto_mutex)
5411 const struct rule_actions *actions;
5412 struct ofputil_flow_update fu;
5415 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5416 ? NXFME_ADDED : NXFME_MODIFIED);
5418 ovs_mutex_lock(&rule->mutex);
5419 fu.idle_timeout = rule->idle_timeout;
5420 fu.hard_timeout = rule->hard_timeout;
5421 ovs_mutex_unlock(&rule->mutex);
5422 fu.table_id = rule->table_id;
5423 fu.cookie = rule->flow_cookie;
5424 minimatch_expand(&rule->cr.match, &match);
5426 fu.priority = rule->cr.priority;
5428 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5429 fu.ofpacts = actions ? actions->ofpacts : NULL;
5430 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5432 if (list_is_empty(msgs)) {
5433 ofputil_start_flow_update(msgs);
5435 ofputil_append_flow_update(&fu, msgs);
5439 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5440 struct ovs_list *msgs)
5441 OVS_REQUIRES(ofproto_mutex)
5445 for (i = 0; i < rules->n; i++) {
5446 struct rule *rule = rules->rules[i];
5447 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5448 rule->monitor_flags = 0;
5450 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5455 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5456 struct rule *rule, uint64_t seqno,
5457 struct rule_collection *rules)
5458 OVS_REQUIRES(ofproto_mutex)
5460 enum nx_flow_monitor_flags update;
5462 if (rule_is_hidden(rule)) {
5466 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5471 if (rule->add_seqno > seqno) {
5472 update = NXFMF_ADD | NXFMF_MODIFY;
5473 } else if (rule->modify_seqno > seqno) {
5474 update = NXFMF_MODIFY;
5479 if (!(m->flags & update)) {
5483 update = NXFMF_INITIAL;
5486 if (!rule->monitor_flags) {
5487 rule_collection_add(rules, rule);
5489 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5493 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5495 struct rule_collection *rules)
5496 OVS_REQUIRES(ofproto_mutex)
5498 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5499 const struct oftable *table;
5500 struct cls_rule target;
5502 cls_rule_init_from_minimatch(&target, &m->match, 0, CLS_MAX_VERSION);
5503 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5506 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5507 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5510 cls_rule_destroy(&target);
5514 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5515 struct rule_collection *rules)
5516 OVS_REQUIRES(ofproto_mutex)
5518 if (m->flags & NXFMF_INITIAL) {
5519 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5524 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5525 uint64_t seqno, struct rule_collection *rules)
5526 OVS_REQUIRES(ofproto_mutex)
5528 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5532 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5533 OVS_REQUIRES(ofproto_mutex)
5535 struct ofmonitor *m;
5538 m = ofmonitor_lookup(ofconn, id);
5540 ofmonitor_destroy(m);
5543 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5550 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5551 OVS_EXCLUDED(ofproto_mutex)
5553 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5554 struct ofmonitor **monitors;
5555 size_t n_monitors, allocated_monitors;
5556 struct rule_collection rules;
5557 struct ovs_list replies;
5562 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5564 n_monitors = allocated_monitors = 0;
5566 ovs_mutex_lock(&ofproto_mutex);
5568 struct ofputil_flow_monitor_request request;
5569 struct ofmonitor *m;
5572 retval = ofputil_decode_flow_monitor_request(&request, &b);
5573 if (retval == EOF) {
5575 } else if (retval) {
5580 if (request.table_id != 0xff
5581 && request.table_id >= ofproto->n_tables) {
5582 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5586 error = ofmonitor_create(&request, ofconn, &m);
5591 if (n_monitors >= allocated_monitors) {
5592 monitors = x2nrealloc(monitors, &allocated_monitors,
5595 monitors[n_monitors++] = m;
5598 rule_collection_init(&rules);
5599 for (i = 0; i < n_monitors; i++) {
5600 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5603 ofpmp_init(&replies, oh);
5604 ofmonitor_compose_refresh_updates(&rules, &replies);
5605 ovs_mutex_unlock(&ofproto_mutex);
5607 rule_collection_destroy(&rules);
5609 ofconn_send_replies(ofconn, &replies);
5615 for (i = 0; i < n_monitors; i++) {
5616 ofmonitor_destroy(monitors[i]);
5619 ovs_mutex_unlock(&ofproto_mutex);
5625 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5626 OVS_EXCLUDED(ofproto_mutex)
5631 id = ofputil_decode_flow_monitor_cancel(oh);
5633 ovs_mutex_lock(&ofproto_mutex);
5634 error = flow_monitor_delete(ofconn, id);
5635 ovs_mutex_unlock(&ofproto_mutex);
5640 /* Meters implementation.
5642 * Meter table entry, indexed by the OpenFlow meter_id.
5643 * 'created' is used to compute the duration for meter stats.
5644 * 'list rules' is needed so that we can delete the dependent rules when the
5645 * meter table entry is deleted.
5646 * 'provider_meter_id' is for the provider's private use.
5649 long long int created; /* Time created. */
5650 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5651 ofproto_meter_id provider_meter_id;
5652 uint16_t flags; /* Meter flags. */
5653 uint16_t n_bands; /* Number of meter bands. */
5654 struct ofputil_meter_band *bands;
5658 * This is used in instruction validation at flow set-up time,
5659 * as flows may not use non-existing meters.
5660 * Return value of UINT32_MAX signifies an invalid meter.
5663 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5665 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5666 const struct meter *meter = ofproto->meters[of_meter_id];
5668 return meter->provider_meter_id.uint32;
5674 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5677 meter_insert_rule(struct rule *rule)
5679 const struct rule_actions *a = rule_get_actions(rule);
5680 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5681 struct meter *meter = rule->ofproto->meters[meter_id];
5683 list_insert(&meter->rules, &rule->meter_list_node);
5687 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5691 meter->flags = config->flags;
5692 meter->n_bands = config->n_bands;
5693 meter->bands = xmemdup(config->bands,
5694 config->n_bands * sizeof *meter->bands);
5697 static struct meter *
5698 meter_create(const struct ofputil_meter_config *config,
5699 ofproto_meter_id provider_meter_id)
5701 struct meter *meter;
5703 meter = xzalloc(sizeof *meter);
5704 meter->provider_meter_id = provider_meter_id;
5705 meter->created = time_msec();
5706 list_init(&meter->rules);
5708 meter_update(meter, config);
5714 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5715 OVS_REQUIRES(ofproto_mutex)
5718 for (mid = first; mid <= last; ++mid) {
5719 struct meter *meter = ofproto->meters[mid];
5721 ofproto->meters[mid] = NULL;
5722 ofproto->ofproto_class->meter_del(ofproto,
5723 meter->provider_meter_id);
5731 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5733 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5734 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5738 return OFPERR_OFPMMFC_METER_EXISTS;
5741 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5744 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5745 *meterp = meter_create(&mm->meter, provider_meter_id);
5751 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5753 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5755 uint32_t provider_meter_id;
5758 return OFPERR_OFPMMFC_UNKNOWN_METER;
5761 provider_meter_id = meter->provider_meter_id.uint32;
5762 error = ofproto->ofproto_class->meter_set(ofproto,
5763 &meter->provider_meter_id,
5765 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5767 meter_update(meter, &mm->meter);
5773 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5774 OVS_EXCLUDED(ofproto_mutex)
5776 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5777 uint32_t meter_id = mm->meter.meter_id;
5778 struct rule_collection rules;
5779 enum ofperr error = 0;
5780 uint32_t first, last;
5782 if (meter_id == OFPM13_ALL) {
5784 last = ofproto->meter_features.max_meters;
5786 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5789 first = last = meter_id;
5792 /* First delete the rules that use this meter. If any of those rules are
5793 * currently being modified, postpone the whole operation until later. */
5794 rule_collection_init(&rules);
5795 ovs_mutex_lock(&ofproto_mutex);
5796 for (meter_id = first; meter_id <= last; ++meter_id) {
5797 struct meter *meter = ofproto->meters[meter_id];
5798 if (meter && !list_is_empty(&meter->rules)) {
5801 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5802 rule_collection_add(&rules, rule);
5806 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5808 /* Delete the meters. */
5809 meter_delete(ofproto, first, last);
5811 ovs_mutex_unlock(&ofproto_mutex);
5817 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5819 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5820 struct ofputil_meter_mod mm;
5821 uint64_t bands_stub[256 / 8];
5822 struct ofpbuf bands;
5826 error = reject_slave_controller(ofconn);
5831 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5833 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5835 goto exit_free_bands;
5838 meter_id = mm.meter.meter_id;
5840 if (mm.command != OFPMC13_DELETE) {
5841 /* Fails also when meters are not implemented by the provider. */
5842 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5843 error = OFPERR_OFPMMFC_INVALID_METER;
5844 goto exit_free_bands;
5845 } else if (meter_id > ofproto->meter_features.max_meters) {
5846 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5847 goto exit_free_bands;
5849 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5850 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5851 goto exit_free_bands;
5855 switch (mm.command) {
5857 error = handle_add_meter(ofproto, &mm);
5860 case OFPMC13_MODIFY:
5861 error = handle_modify_meter(ofproto, &mm);
5864 case OFPMC13_DELETE:
5865 error = handle_delete_meter(ofconn, &mm);
5869 error = OFPERR_OFPMMFC_BAD_COMMAND;
5874 ofpbuf_uninit(&bands);
5879 handle_meter_features_request(struct ofconn *ofconn,
5880 const struct ofp_header *request)
5882 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5883 struct ofputil_meter_features features;
5886 if (ofproto->ofproto_class->meter_get_features) {
5887 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5889 memset(&features, 0, sizeof features);
5891 b = ofputil_encode_meter_features_reply(&features, request);
5893 ofconn_send_reply(ofconn, b);
5898 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5901 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5902 struct ovs_list replies;
5903 uint64_t bands_stub[256 / 8];
5904 struct ofpbuf bands;
5905 uint32_t meter_id, first, last;
5907 ofputil_decode_meter_request(request, &meter_id);
5909 if (meter_id == OFPM13_ALL) {
5911 last = ofproto->meter_features.max_meters;
5913 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5914 !ofproto->meters[meter_id]) {
5915 return OFPERR_OFPMMFC_UNKNOWN_METER;
5917 first = last = meter_id;
5920 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5921 ofpmp_init(&replies, request);
5923 for (meter_id = first; meter_id <= last; ++meter_id) {
5924 struct meter *meter = ofproto->meters[meter_id];
5926 continue; /* Skip non-existing meters. */
5928 if (type == OFPTYPE_METER_STATS_REQUEST) {
5929 struct ofputil_meter_stats stats;
5931 stats.meter_id = meter_id;
5933 /* Provider sets the packet and byte counts, we do the rest. */
5934 stats.flow_count = list_size(&meter->rules);
5935 calc_duration(meter->created, time_msec(),
5936 &stats.duration_sec, &stats.duration_nsec);
5937 stats.n_bands = meter->n_bands;
5938 ofpbuf_clear(&bands);
5940 = ofpbuf_put_uninit(&bands,
5941 meter->n_bands * sizeof *stats.bands);
5943 if (!ofproto->ofproto_class->meter_get(ofproto,
5944 meter->provider_meter_id,
5946 ofputil_append_meter_stats(&replies, &stats);
5948 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5949 struct ofputil_meter_config config;
5951 config.meter_id = meter_id;
5952 config.flags = meter->flags;
5953 config.n_bands = meter->n_bands;
5954 config.bands = meter->bands;
5955 ofputil_append_meter_config(&replies, &config);
5959 ofconn_send_replies(ofconn, &replies);
5960 ofpbuf_uninit(&bands);
5965 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5966 struct ofgroup **group)
5967 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5969 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5970 hash_int(group_id, 0), &ofproto->groups) {
5971 if ((*group)->group_id == group_id) {
5979 /* If the group exists, this function increments the groups's reference count.
5981 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5982 * a reference to the group. */
5984 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5985 struct ofgroup **group)
5989 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5990 found = ofproto_group_lookup__(ofproto, group_id, group);
5992 ofproto_group_ref(*group);
5994 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5999 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
6000 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6002 struct ofgroup *grp;
6004 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
6005 hash_int(group_id, 0), &ofproto->groups) {
6006 if (grp->group_id == group_id) {
6014 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
6015 OVS_EXCLUDED(ofproto->groups_rwlock)
6019 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6020 exists = ofproto_group_exists__(ofproto, group_id);
6021 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6027 group_get_ref_count(struct ofgroup *group)
6028 OVS_EXCLUDED(ofproto_mutex)
6030 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
6031 struct rule_criteria criteria;
6032 struct rule_collection rules;
6037 match_init_catchall(&match);
6038 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
6039 htonll(0), OFPP_ANY, group->group_id);
6040 ovs_mutex_lock(&ofproto_mutex);
6041 error = collect_rules_loose(ofproto, &criteria, &rules);
6042 ovs_mutex_unlock(&ofproto_mutex);
6043 rule_criteria_destroy(&criteria);
6045 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
6047 rule_collection_destroy(&rules);
6052 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
6054 struct ofputil_group_stats ogs;
6055 const struct ofproto *ofproto = group->ofproto;
6056 long long int now = time_msec();
6059 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
6061 /* Provider sets the packet and byte counts, we do the rest. */
6062 ogs.ref_count = group_get_ref_count(group);
6063 ogs.n_buckets = group->n_buckets;
6065 error = (ofproto->ofproto_class->group_get_stats
6066 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
6069 ogs.packet_count = UINT64_MAX;
6070 ogs.byte_count = UINT64_MAX;
6071 memset(ogs.bucket_stats, 0xff,
6072 ogs.n_buckets * sizeof *ogs.bucket_stats);
6075 ogs.group_id = group->group_id;
6076 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
6078 ofputil_append_group_stats(replies, &ogs);
6080 free(ogs.bucket_stats);
6084 handle_group_request(struct ofconn *ofconn,
6085 const struct ofp_header *request, uint32_t group_id,
6086 void (*cb)(struct ofgroup *, struct ovs_list *replies))
6088 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6089 struct ofgroup *group;
6090 struct ovs_list replies;
6092 ofpmp_init(&replies, request);
6093 if (group_id == OFPG_ALL) {
6094 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6095 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
6096 cb(group, &replies);
6098 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6100 if (ofproto_group_lookup(ofproto, group_id, &group)) {
6101 cb(group, &replies);
6102 ofproto_group_unref(group);
6105 ofconn_send_replies(ofconn, &replies);
6109 handle_group_stats_request(struct ofconn *ofconn,
6110 const struct ofp_header *request)
6115 error = ofputil_decode_group_stats_request(request, &group_id);
6120 handle_group_request(ofconn, request, group_id, append_group_stats);
6125 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
6127 struct ofputil_group_desc gds;
6129 gds.group_id = group->group_id;
6130 gds.type = group->type;
6131 gds.props = group->props;
6133 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
6137 handle_group_desc_stats_request(struct ofconn *ofconn,
6138 const struct ofp_header *request)
6140 handle_group_request(ofconn, request,
6141 ofputil_decode_group_desc_request(request),
6147 handle_group_features_stats_request(struct ofconn *ofconn,
6148 const struct ofp_header *request)
6150 struct ofproto *p = ofconn_get_ofproto(ofconn);
6153 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6155 ofconn_send_reply(ofconn, msg);
6162 handle_queue_get_config_request(struct ofconn *ofconn,
6163 const struct ofp_header *oh)
6165 struct ofproto *p = ofconn_get_ofproto(ofconn);
6166 struct netdev_queue_dump queue_dump;
6167 struct ofport *ofport;
6168 unsigned int queue_id;
6169 struct ofpbuf *reply;
6170 struct smap details;
6174 error = ofputil_decode_queue_get_config_request(oh, &request);
6179 ofport = ofproto_get_port(p, request);
6181 return OFPERR_OFPQOFC_BAD_PORT;
6184 reply = ofputil_encode_queue_get_config_reply(oh);
6186 smap_init(&details);
6187 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6188 struct ofputil_queue_config queue;
6190 /* None of the existing queues have compatible properties, so we
6191 * hard-code omitting min_rate and max_rate. */
6192 queue.queue_id = queue_id;
6193 queue.min_rate = UINT16_MAX;
6194 queue.max_rate = UINT16_MAX;
6195 ofputil_append_queue_get_config_reply(reply, &queue);
6197 smap_destroy(&details);
6199 ofconn_send_reply(ofconn, reply);
6205 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6206 struct ofgroup **ofgroup)
6209 const long long int now = time_msec();
6211 if (gm->group_id > OFPG_MAX) {
6212 return OFPERR_OFPGMFC_INVALID_GROUP;
6214 if (gm->type > OFPGT11_FF) {
6215 return OFPERR_OFPGMFC_BAD_TYPE;
6218 *ofgroup = ofproto->ofproto_class->group_alloc();
6220 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6221 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6224 (*ofgroup)->ofproto = ofproto;
6225 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6226 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6227 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6228 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6229 ovs_refcount_init(&(*ofgroup)->ref_count);
6231 list_move(&(*ofgroup)->buckets, &gm->buckets);
6232 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6233 list_size(&(*ofgroup)->buckets);
6235 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6236 &gm->props, sizeof (struct ofputil_group_props));
6238 /* Construct called BEFORE any locks are held. */
6239 error = ofproto->ofproto_class->group_construct(*ofgroup);
6241 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6242 ofproto->ofproto_class->group_dealloc(*ofgroup);
6247 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6248 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6251 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6253 struct ofgroup *ofgroup;
6256 /* Allocate new group and initialize it. */
6257 error = init_group(ofproto, gm, &ofgroup);
6262 /* We wrlock as late as possible to minimize the time we jam any other
6263 * threads: No visible state changes before acquiring the lock. */
6264 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6266 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6267 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6271 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6272 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6277 /* Insert new group. */
6278 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6279 hash_int(ofgroup->group_id, 0));
6280 ofproto->n_groups[ofgroup->type]++;
6282 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6287 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6288 ofproto->ofproto_class->group_destruct(ofgroup);
6289 ofputil_bucket_list_destroy(&ofgroup->buckets);
6290 ofproto->ofproto_class->group_dealloc(ofgroup);
6295 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6296 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6297 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6298 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6301 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6302 struct ofgroup *new_ofgroup,
6303 uint32_t command_bucket_id)
6305 struct ofputil_bucket *last = NULL;
6307 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6308 /* Check here to ensure that a bucket corresponding to
6309 * command_bucket_id exists in the old bucket list.
6311 * The subsequent search of below of new_ofgroup covers
6312 * both buckets in the old bucket list and buckets added
6313 * by the insert buckets group mod message this function processes. */
6314 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6315 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6318 if (!list_is_empty(&new_ofgroup->buckets)) {
6319 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6323 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6325 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6326 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6327 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6330 /* Rearrange list according to command_bucket_id */
6331 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6332 struct ofputil_bucket *new_first;
6333 const struct ofputil_bucket *first;
6335 first = ofputil_bucket_list_front(&ofgroup->buckets);
6336 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6339 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6340 &new_ofgroup->buckets);
6341 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6342 struct ofputil_bucket *after;
6344 /* Presence of bucket is checked above so after should never be NULL */
6345 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6347 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6348 last->list_node.next);
6354 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6355 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6356 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6357 * and OFPG15_BUCKET_ALL are also honored. */
6359 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6360 struct ofgroup *new_ofgroup,
6361 uint32_t command_bucket_id)
6363 const struct ofputil_bucket *skip = NULL;
6365 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6369 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6370 if (!list_is_empty(&ofgroup->buckets)) {
6371 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6373 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6374 if (!list_is_empty(&ofgroup->buckets)) {
6375 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6378 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6380 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6384 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6389 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6390 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6393 * Note that the group is re-created and then replaces the old group in
6394 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6395 * the xlate module hold a pointer to the group. */
6397 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6399 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6402 error = init_group(ofproto, gm, &new_ofgroup);
6407 retiring = new_ofgroup;
6409 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6410 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6411 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6415 /* Ofproto's group write lock is held now. */
6416 if (ofgroup->type != gm->type
6417 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6418 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6422 /* Manipulate bucket list for bucket commands */
6423 if (gm->command == OFPGC15_INSERT_BUCKET) {
6424 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6425 gm->command_bucket_id);
6426 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6427 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6428 gm->command_bucket_id);
6434 /* The group creation time does not change during modification. */
6435 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6436 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6438 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6444 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6445 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6446 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6447 hash_int(new_ofgroup->group_id, 0));
6448 if (ofgroup->type != new_ofgroup->type) {
6449 ofproto->n_groups[ofgroup->type]--;
6450 ofproto->n_groups[new_ofgroup->type]++;
6454 ofproto_group_unref(retiring);
6455 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6460 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6461 OVS_RELEASES(ofproto->groups_rwlock)
6464 struct ofputil_flow_mod fm;
6466 /* Delete all flow entries containing this group in a group action */
6467 match_init_catchall(&match);
6468 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6469 fm.delete_reason = OFPRR_GROUP_DELETE;
6470 fm.out_group = ofgroup->group_id;
6471 handle_flow_mod__(ofproto, &fm, NULL);
6473 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6474 /* No-one can find this group any more. */
6475 ofproto->n_groups[ofgroup->type]--;
6476 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6477 ofproto_group_unref(ofgroup);
6480 /* Implements OFPGC11_DELETE. */
6482 delete_group(struct ofproto *ofproto, uint32_t group_id)
6484 struct ofgroup *ofgroup;
6486 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6487 if (group_id == OFPG_ALL) {
6489 struct hmap_node *node = hmap_first(&ofproto->groups);
6493 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6494 delete_group__(ofproto, ofgroup);
6495 /* Lock for each node separately, so that we will not jam the
6496 * other threads for too long time. */
6497 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6500 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6501 hash_int(group_id, 0), &ofproto->groups) {
6502 if (ofgroup->group_id == group_id) {
6503 delete_group__(ofproto, ofgroup);
6508 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6511 /* Delete all groups from 'ofproto'.
6513 * This is intended for use within an ofproto provider's 'destruct'
6516 ofproto_group_delete_all(struct ofproto *ofproto)
6518 delete_group(ofproto, OFPG_ALL);
6522 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6524 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6525 struct ofputil_group_mod gm;
6528 error = reject_slave_controller(ofconn);
6533 error = ofputil_decode_group_mod(oh, &gm);
6538 switch (gm.command) {
6540 return add_group(ofproto, &gm);
6542 case OFPGC11_MODIFY:
6543 return modify_group(ofproto, &gm);
6545 case OFPGC11_DELETE:
6546 delete_group(ofproto, gm.group_id);
6549 case OFPGC15_INSERT_BUCKET:
6550 return modify_group(ofproto, &gm);
6552 case OFPGC15_REMOVE_BUCKET:
6553 return modify_group(ofproto, &gm);
6556 if (gm.command > OFPGC11_DELETE) {
6557 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6558 ofproto->name, gm.command);
6560 return OFPERR_OFPGMFC_BAD_COMMAND;
6564 enum ofputil_table_miss
6565 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6567 enum ofputil_table_miss miss;
6569 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &miss);
6574 table_mod__(struct oftable *oftable,
6575 enum ofputil_table_miss miss, enum ofputil_table_eviction eviction)
6577 if (miss == OFPUTIL_TABLE_MISS_DEFAULT) {
6578 /* This is how an OFPT_TABLE_MOD decodes if it doesn't specify any
6579 * table-miss configuration (because the protocol used doesn't have
6580 * such a concept), so there's nothing to do. */
6582 atomic_store_relaxed(&oftable->miss_config, miss);
6585 unsigned int new_eviction = oftable->eviction;
6586 if (eviction == OFPUTIL_TABLE_EVICTION_ON) {
6587 new_eviction |= EVICTION_OPENFLOW;
6588 } else if (eviction == OFPUTIL_TABLE_EVICTION_OFF) {
6589 new_eviction &= ~EVICTION_OPENFLOW;
6592 if (new_eviction != oftable->eviction) {
6593 ovs_mutex_lock(&ofproto_mutex);
6594 oftable_configure_eviction(oftable, new_eviction,
6595 oftable->eviction_fields,
6596 oftable->n_eviction_fields);
6597 ovs_mutex_unlock(&ofproto_mutex);
6602 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6604 if (!check_table_id(ofproto, tm->table_id)) {
6605 return OFPERR_OFPTMFC_BAD_TABLE;
6608 /* Don't allow the eviction flags to be changed (except to the only fixed
6609 * value that OVS supports). OF1.4 says this is normal: "The
6610 * OFPTMPT_EVICTION property usually cannot be modified using a
6611 * OFP_TABLE_MOD request, because the eviction mechanism is switch
6613 if (tm->eviction_flags != UINT32_MAX
6614 && tm->eviction_flags != OFPROTO_EVICTION_FLAGS) {
6615 return OFPERR_OFPTMFC_BAD_CONFIG;
6618 if (tm->table_id == OFPTT_ALL) {
6619 struct oftable *oftable;
6620 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6621 if (!(oftable->flags & (OFTABLE_HIDDEN | OFTABLE_READONLY))) {
6622 table_mod__(oftable, tm->miss, tm->eviction);
6626 struct oftable *oftable = &ofproto->tables[tm->table_id];
6627 if (oftable->flags & OFTABLE_READONLY) {
6628 return OFPERR_OFPTMFC_EPERM;
6630 table_mod__(oftable, tm->miss, tm->eviction);
6637 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6639 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6640 struct ofputil_table_mod tm;
6643 error = reject_slave_controller(ofconn);
6648 error = ofputil_decode_table_mod(oh, &tm);
6653 return table_mod(ofproto, &tm);
6657 do_bundle_flow_mod_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6658 struct ofp_bundle_entry *be)
6659 OVS_REQUIRES(ofproto_mutex)
6661 switch (fm->command) {
6663 return add_flow_start(ofproto, fm, &be->old_rules.stub[0],
6664 &be->new_rules.stub[0]);
6666 return modify_flows_start_loose(ofproto, fm, &be->old_rules,
6668 case OFPFC_MODIFY_STRICT:
6669 return modify_flow_start_strict(ofproto, fm, &be->old_rules,
6672 return delete_flows_start_loose(ofproto, fm, &be->old_rules);
6674 case OFPFC_DELETE_STRICT:
6675 return delete_flow_start_strict(ofproto, fm, &be->old_rules);
6678 return OFPERR_OFPFMFC_BAD_COMMAND;
6682 do_bundle_flow_mod_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6683 struct ofp_bundle_entry *be)
6684 OVS_REQUIRES(ofproto_mutex)
6686 switch (fm->command) {
6688 add_flow_revert(ofproto, fm, be->old_rules.stub[0],
6689 be->new_rules.stub[0]);
6693 case OFPFC_MODIFY_STRICT:
6694 modify_flows_revert(ofproto, fm, &be->old_rules, &be->new_rules);
6698 case OFPFC_DELETE_STRICT:
6699 delete_flows_revert(ofproto, &be->old_rules);
6708 do_bundle_flow_mod_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6709 const struct flow_mod_requester *req,
6710 struct ofp_bundle_entry *be)
6711 OVS_REQUIRES(ofproto_mutex)
6713 switch (fm->command) {
6715 add_flow_finish(ofproto, fm, req, be->old_rules.stub[0],
6716 be->new_rules.stub[0]);
6720 case OFPFC_MODIFY_STRICT:
6721 modify_flows_finish(ofproto, fm, req, &be->old_rules, &be->new_rules);
6725 case OFPFC_DELETE_STRICT:
6726 delete_flows_finish(ofproto, fm, req, &be->old_rules);
6734 /* Commit phases (all while locking ofproto_mutex):
6736 * 1. Begin: Gather resources and make changes visible in the next version.
6737 * - Mark affected rules for removal in the next version.
6738 * - Create new replacement rules, make visible in the next
6740 * - Do not send any events or notifications.
6742 * 2. Revert: Fail if any errors are found. After this point no errors are
6743 * possible. No visible changes were made, so rollback is minimal (remove
6744 * added invisible rules, restore visibility of rules marked for removal).
6746 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
6747 * the ofproto provider. Remove replaced and deleted rules from ofproto data
6748 * structures, and Schedule postponed removal of deleted rules from the
6749 * classifier. Send notifications, buffered packets, etc.
6752 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6754 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6755 cls_version_t visible_version = ofproto->tables_version;
6756 struct ofp_bundle *bundle;
6757 struct ofp_bundle_entry *be;
6760 bundle = ofconn_get_bundle(ofconn, id);
6763 return OFPERR_OFPBFC_BAD_ID;
6765 if (bundle->flags != flags) {
6766 error = OFPERR_OFPBFC_BAD_FLAGS;
6768 bool prev_is_port_mod = false;
6771 ovs_mutex_lock(&ofproto_mutex);
6774 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6775 if (be->type == OFPTYPE_PORT_MOD) {
6776 /* Our port mods are not atomic. */
6777 if (flags & OFPBF_ATOMIC) {
6778 error = OFPERR_OFPBFC_MSG_FAILED;
6780 prev_is_port_mod = true;
6781 error = port_mod_start(ofconn, &be->pm, &be->port);
6783 } else if (be->type == OFPTYPE_FLOW_MOD) {
6784 /* Flow mods between port mods are applied as a single
6785 * version, but the versions are published only after
6786 * we know the commit is successful. */
6787 if (prev_is_port_mod) {
6788 ++ofproto->tables_version;
6790 prev_is_port_mod = false;
6791 error = do_bundle_flow_mod_start(ofproto, &be->fm, be);
6798 /* Store the version in which the changes should take
6800 be->version = ofproto->tables_version + 1;
6805 /* Send error referring to the original message. */
6807 ofconn_send_error(ofconn, be->ofp_msg, error);
6808 error = OFPERR_OFPBFC_MSG_FAILED;
6811 /* 2. Revert. Undo all the changes made above. */
6812 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6813 if (be->type == OFPTYPE_FLOW_MOD) {
6814 do_bundle_flow_mod_revert(ofproto, &be->fm, be);
6816 /* Nothing needs to be reverted for a port mod. */
6820 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6821 /* Bump the lookup version to the one of the current message.
6822 * This makes all the changes in the bundle at this version
6823 * visible to lookups at once. */
6824 if (visible_version < be->version) {
6825 visible_version = be->version;
6826 ofproto->ofproto_class->set_tables_version(
6827 ofproto, visible_version);
6829 if (be->type == OFPTYPE_FLOW_MOD) {
6830 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6832 do_bundle_flow_mod_finish(ofproto, &be->fm, &req, be);
6833 } else if (be->type == OFPTYPE_PORT_MOD) {
6834 /* Perform the actual port mod. This is not atomic, i.e.,
6835 * the effects will be immediately seen by upcall
6836 * processing regardless of the lookup version. It should
6837 * be noted that port configuration changes can originate
6838 * also from OVSDB changes asynchronously to all upcall
6840 port_mod_finish(ofconn, &be->pm, be->port);
6845 /* Reset the tables_version. */
6846 ofproto->tables_version = visible_version;
6848 ofmonitor_flush(ofproto->connmgr);
6849 ovs_mutex_unlock(&ofproto_mutex);
6851 run_rule_executes(ofproto);
6854 /* The bundle is discarded regardless the outcome. */
6855 ofp_bundle_remove__(ofconn, bundle, !error);
6860 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6862 struct ofputil_bundle_ctrl_msg bctrl;
6863 struct ofputil_bundle_ctrl_msg reply;
6867 error = reject_slave_controller(ofconn);
6872 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6877 reply.bundle_id = bctrl.bundle_id;
6879 switch (bctrl.type) {
6880 case OFPBCT_OPEN_REQUEST:
6881 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6882 reply.type = OFPBCT_OPEN_REPLY;
6884 case OFPBCT_CLOSE_REQUEST:
6885 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6886 reply.type = OFPBCT_CLOSE_REPLY;;
6888 case OFPBCT_COMMIT_REQUEST:
6889 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6890 reply.type = OFPBCT_COMMIT_REPLY;
6892 case OFPBCT_DISCARD_REQUEST:
6893 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6894 reply.type = OFPBCT_DISCARD_REPLY;
6897 case OFPBCT_OPEN_REPLY:
6898 case OFPBCT_CLOSE_REPLY:
6899 case OFPBCT_COMMIT_REPLY:
6900 case OFPBCT_DISCARD_REPLY:
6901 return OFPERR_OFPBFC_BAD_TYPE;
6906 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6907 ofconn_send_reply(ofconn, buf);
6913 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6915 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6917 struct ofputil_bundle_add_msg badd;
6918 struct ofp_bundle_entry *bmsg;
6921 error = reject_slave_controller(ofconn);
6926 error = ofputil_decode_bundle_add(oh, &badd, &type);
6931 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
6933 if (type == OFPTYPE_PORT_MOD) {
6934 error = ofputil_decode_port_mod(badd.msg, &bmsg->pm, false);
6935 } else if (type == OFPTYPE_FLOW_MOD) {
6936 struct ofpbuf ofpacts;
6937 uint64_t ofpacts_stub[1024 / 8];
6939 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6940 error = ofputil_decode_flow_mod(&bmsg->fm, badd.msg,
6941 ofconn_get_protocol(ofconn),
6943 u16_to_ofp(ofproto->max_ports),
6945 /* Move actions to heap. */
6946 bmsg->fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6948 if (!error && bmsg->fm.ofpacts_len) {
6949 error = ofproto_check_ofpacts(ofproto, bmsg->fm.ofpacts,
6950 bmsg->fm.ofpacts_len);
6957 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
6962 ofp_bundle_entry_free(bmsg);
6969 handle_geneve_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6971 struct ofputil_geneve_table_mod gtm;
6974 error = reject_slave_controller(ofconn);
6979 error = ofputil_decode_geneve_table_mod(oh, >m);
6984 error = tun_metadata_table_mod(>m);
6986 ofputil_uninit_geneve_table(>m.mappings);
6991 handle_geneve_table_request(struct ofconn *ofconn, const struct ofp_header *oh)
6993 struct ofputil_geneve_table_reply gtr;
6996 tun_metadata_table_request(>r);
6997 b = ofputil_encode_geneve_table_reply(oh, >r);
6998 ofputil_uninit_geneve_table(>r.mappings);
7000 ofconn_send_reply(ofconn, b);
7005 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
7006 OVS_EXCLUDED(ofproto_mutex)
7008 const struct ofp_header *oh = msg->data;
7012 error = ofptype_decode(&type, oh);
7016 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
7017 && ofpmp_more(oh)) {
7018 /* We have no buffer implementation for multipart requests.
7019 * Report overflow for requests which consists of multiple
7021 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
7025 /* OpenFlow requests. */
7026 case OFPTYPE_ECHO_REQUEST:
7027 return handle_echo_request(ofconn, oh);
7029 case OFPTYPE_FEATURES_REQUEST:
7030 return handle_features_request(ofconn, oh);
7032 case OFPTYPE_GET_CONFIG_REQUEST:
7033 return handle_get_config_request(ofconn, oh);
7035 case OFPTYPE_SET_CONFIG:
7036 return handle_set_config(ofconn, oh);
7038 case OFPTYPE_PACKET_OUT:
7039 return handle_packet_out(ofconn, oh);
7041 case OFPTYPE_PORT_MOD:
7042 return handle_port_mod(ofconn, oh);
7044 case OFPTYPE_FLOW_MOD:
7045 return handle_flow_mod(ofconn, oh);
7047 case OFPTYPE_GROUP_MOD:
7048 return handle_group_mod(ofconn, oh);
7050 case OFPTYPE_TABLE_MOD:
7051 return handle_table_mod(ofconn, oh);
7053 case OFPTYPE_METER_MOD:
7054 return handle_meter_mod(ofconn, oh);
7056 case OFPTYPE_BARRIER_REQUEST:
7057 return handle_barrier_request(ofconn, oh);
7059 case OFPTYPE_ROLE_REQUEST:
7060 return handle_role_request(ofconn, oh);
7062 /* OpenFlow replies. */
7063 case OFPTYPE_ECHO_REPLY:
7066 /* Nicira extension requests. */
7067 case OFPTYPE_FLOW_MOD_TABLE_ID:
7068 return handle_nxt_flow_mod_table_id(ofconn, oh);
7070 case OFPTYPE_SET_FLOW_FORMAT:
7071 return handle_nxt_set_flow_format(ofconn, oh);
7073 case OFPTYPE_SET_PACKET_IN_FORMAT:
7074 return handle_nxt_set_packet_in_format(ofconn, oh);
7076 case OFPTYPE_SET_CONTROLLER_ID:
7077 return handle_nxt_set_controller_id(ofconn, oh);
7079 case OFPTYPE_FLOW_AGE:
7080 /* Nothing to do. */
7083 case OFPTYPE_FLOW_MONITOR_CANCEL:
7084 return handle_flow_monitor_cancel(ofconn, oh);
7086 case OFPTYPE_SET_ASYNC_CONFIG:
7087 return handle_nxt_set_async_config(ofconn, oh);
7089 case OFPTYPE_GET_ASYNC_REQUEST:
7090 return handle_nxt_get_async_request(ofconn, oh);
7092 /* Statistics requests. */
7093 case OFPTYPE_DESC_STATS_REQUEST:
7094 return handle_desc_stats_request(ofconn, oh);
7096 case OFPTYPE_FLOW_STATS_REQUEST:
7097 return handle_flow_stats_request(ofconn, oh);
7099 case OFPTYPE_AGGREGATE_STATS_REQUEST:
7100 return handle_aggregate_stats_request(ofconn, oh);
7102 case OFPTYPE_TABLE_STATS_REQUEST:
7103 return handle_table_stats_request(ofconn, oh);
7105 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
7106 return handle_table_features_request(ofconn, oh);
7108 case OFPTYPE_PORT_STATS_REQUEST:
7109 return handle_port_stats_request(ofconn, oh);
7111 case OFPTYPE_QUEUE_STATS_REQUEST:
7112 return handle_queue_stats_request(ofconn, oh);
7114 case OFPTYPE_PORT_DESC_STATS_REQUEST:
7115 return handle_port_desc_stats_request(ofconn, oh);
7117 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
7118 return handle_flow_monitor_request(ofconn, oh);
7120 case OFPTYPE_METER_STATS_REQUEST:
7121 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
7122 return handle_meter_request(ofconn, oh, type);
7124 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
7125 return handle_meter_features_request(ofconn, oh);
7127 case OFPTYPE_GROUP_STATS_REQUEST:
7128 return handle_group_stats_request(ofconn, oh);
7130 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
7131 return handle_group_desc_stats_request(ofconn, oh);
7133 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
7134 return handle_group_features_stats_request(ofconn, oh);
7136 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
7137 return handle_queue_get_config_request(ofconn, oh);
7139 case OFPTYPE_BUNDLE_CONTROL:
7140 return handle_bundle_control(ofconn, oh);
7142 case OFPTYPE_BUNDLE_ADD_MESSAGE:
7143 return handle_bundle_add(ofconn, oh);
7145 case OFPTYPE_NXT_GENEVE_TABLE_MOD:
7146 return handle_geneve_table_mod(ofconn, oh);
7148 case OFPTYPE_NXT_GENEVE_TABLE_REQUEST:
7149 return handle_geneve_table_request(ofconn, oh);
7153 case OFPTYPE_FEATURES_REPLY:
7154 case OFPTYPE_GET_CONFIG_REPLY:
7155 case OFPTYPE_PACKET_IN:
7156 case OFPTYPE_FLOW_REMOVED:
7157 case OFPTYPE_PORT_STATUS:
7158 case OFPTYPE_BARRIER_REPLY:
7159 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
7160 case OFPTYPE_DESC_STATS_REPLY:
7161 case OFPTYPE_FLOW_STATS_REPLY:
7162 case OFPTYPE_QUEUE_STATS_REPLY:
7163 case OFPTYPE_PORT_STATS_REPLY:
7164 case OFPTYPE_TABLE_STATS_REPLY:
7165 case OFPTYPE_AGGREGATE_STATS_REPLY:
7166 case OFPTYPE_PORT_DESC_STATS_REPLY:
7167 case OFPTYPE_ROLE_REPLY:
7168 case OFPTYPE_FLOW_MONITOR_PAUSED:
7169 case OFPTYPE_FLOW_MONITOR_RESUMED:
7170 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
7171 case OFPTYPE_GET_ASYNC_REPLY:
7172 case OFPTYPE_GROUP_STATS_REPLY:
7173 case OFPTYPE_GROUP_DESC_STATS_REPLY:
7174 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
7175 case OFPTYPE_METER_STATS_REPLY:
7176 case OFPTYPE_METER_CONFIG_STATS_REPLY:
7177 case OFPTYPE_METER_FEATURES_STATS_REPLY:
7178 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
7179 case OFPTYPE_ROLE_STATUS:
7180 case OFPTYPE_NXT_GENEVE_TABLE_REPLY:
7182 if (ofpmsg_is_stat_request(oh)) {
7183 return OFPERR_OFPBRC_BAD_STAT;
7185 return OFPERR_OFPBRC_BAD_TYPE;
7191 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
7192 OVS_EXCLUDED(ofproto_mutex)
7194 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
7197 ofconn_send_error(ofconn, ofp_msg->data, error);
7199 COVERAGE_INC(ofproto_recv_openflow);
7202 /* Asynchronous operations. */
7205 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
7207 OVS_REQUIRES(ofproto_mutex)
7209 if (req && req->ofconn && buffer_id != UINT32_MAX) {
7210 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
7211 struct dp_packet *packet;
7215 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
7218 struct rule_execute *re;
7220 ofproto_rule_ref(rule);
7222 re = xmalloc(sizeof *re);
7224 re->in_port = in_port;
7225 re->packet = packet;
7227 if (!guarded_list_push_back(&ofproto->rule_executes,
7228 &re->list_node, 1024)) {
7229 ofproto_rule_unref(rule);
7230 dp_packet_delete(re->packet);
7234 ofconn_send_error(req->ofconn, req->request, error);
7240 pick_datapath_id(const struct ofproto *ofproto)
7242 const struct ofport *port;
7244 port = ofproto_get_port(ofproto, OFPP_LOCAL);
7246 uint8_t ea[ETH_ADDR_LEN];
7249 error = netdev_get_etheraddr(port->netdev, ea);
7251 return eth_addr_to_uint64(ea);
7253 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7254 ofproto->name, netdev_get_name(port->netdev),
7255 ovs_strerror(error));
7257 return ofproto->fallback_dpid;
7261 pick_fallback_dpid(void)
7263 uint8_t ea[ETH_ADDR_LEN];
7264 eth_addr_nicira_random(ea);
7265 return eth_addr_to_uint64(ea);
7268 /* Table overflow policy. */
7270 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7271 * to NULL if the table is not configured to evict rules or if the table
7272 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7273 * or with no timeouts are not evictable.) */
7275 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
7276 OVS_REQUIRES(ofproto_mutex)
7278 struct eviction_group *evg;
7281 if (!table->eviction) {
7285 /* In the common case, the outer and inner loops here will each be entered
7288 * - The inner loop normally "return"s in its first iteration. If the
7289 * eviction group has any evictable rules, then it always returns in
7292 * - The outer loop only iterates more than once if the largest eviction
7293 * group has no evictable rules.
7295 * - The outer loop can exit only if table's 'max_flows' is all filled up
7296 * by unevictable rules. */
7297 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7300 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7309 /* Eviction groups. */
7311 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7312 * rules. The priority contains low-order random bits to ensure that eviction
7313 * groups with the same number of rules are prioritized randomly. */
7315 eviction_group_priority(size_t n_rules)
7317 uint16_t size = MIN(UINT16_MAX, n_rules);
7318 return (size << 16) | random_uint16();
7321 /* Updates 'evg', an eviction_group within 'table', following a change that
7322 * adds or removes rules in 'evg'. */
7324 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7325 OVS_REQUIRES(ofproto_mutex)
7327 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7328 eviction_group_priority(heap_count(&evg->rules)));
7331 /* Destroys 'evg', an eviction_group within 'table':
7333 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7334 * rules themselves, just removes them from the eviction group.)
7336 * - Removes 'evg' from 'table'.
7340 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7341 OVS_REQUIRES(ofproto_mutex)
7343 while (!heap_is_empty(&evg->rules)) {
7346 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7347 rule->eviction_group = NULL;
7349 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7350 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7351 heap_destroy(&evg->rules);
7355 /* Removes 'rule' from its eviction group, if any. */
7357 eviction_group_remove_rule(struct rule *rule)
7358 OVS_REQUIRES(ofproto_mutex)
7360 if (rule->eviction_group) {
7361 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7362 struct eviction_group *evg = rule->eviction_group;
7364 rule->eviction_group = NULL;
7365 heap_remove(&evg->rules, &rule->evg_node);
7366 if (heap_is_empty(&evg->rules)) {
7367 eviction_group_destroy(table, evg);
7369 eviction_group_resized(table, evg);
7374 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7375 * returns the hash value. */
7377 eviction_group_hash_rule(struct rule *rule)
7378 OVS_REQUIRES(ofproto_mutex)
7380 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7381 const struct mf_subfield *sf;
7385 hash = table->eviction_group_id_basis;
7386 miniflow_expand(&rule->cr.match.flow, &flow);
7387 for (sf = table->eviction_fields;
7388 sf < &table->eviction_fields[table->n_eviction_fields];
7391 if (mf_are_prereqs_ok(sf->field, &flow)) {
7392 union mf_value value;
7394 mf_get_value(sf->field, &flow, &value);
7396 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7398 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7399 unsigned int start = sf->ofs + sf->n_bits;
7400 bitwise_zero(&value, sf->field->n_bytes, start,
7401 sf->field->n_bytes * 8 - start);
7403 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7405 hash = hash_int(hash, 0);
7412 /* Returns an eviction group within 'table' with the given 'id', creating one
7414 static struct eviction_group *
7415 eviction_group_find(struct oftable *table, uint32_t id)
7416 OVS_REQUIRES(ofproto_mutex)
7418 struct eviction_group *evg;
7420 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7424 evg = xmalloc(sizeof *evg);
7425 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7426 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7427 eviction_group_priority(0));
7428 heap_init(&evg->rules);
7433 /* Returns an eviction priority for 'rule'. The return value should be
7434 * interpreted so that higher priorities make a rule a more attractive
7435 * candidate for eviction. */
7437 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7438 OVS_REQUIRES(ofproto_mutex)
7440 /* Calculate absolute time when this flow will expire. If it will never
7441 * expire, then return 0 to make it unevictable. */
7442 long long int expiration = LLONG_MAX;
7443 if (rule->hard_timeout) {
7444 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7445 ovs_mutex_lock(&rule->mutex);
7446 long long int modified = rule->modified;
7447 ovs_mutex_unlock(&rule->mutex);
7449 expiration = modified + rule->hard_timeout * 1000;
7451 if (rule->idle_timeout) {
7452 uint64_t packets, bytes;
7454 long long int idle_expiration;
7456 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7457 idle_expiration = used + rule->idle_timeout * 1000;
7458 expiration = MIN(expiration, idle_expiration);
7460 if (expiration == LLONG_MAX) {
7464 /* Calculate the time of expiration as a number of (approximate) seconds
7465 * after program startup.
7467 * This should work OK for program runs that last UINT32_MAX seconds or
7468 * less. Therefore, please restart OVS at least once every 136 years. */
7469 uint32_t expiration_ofs = (expiration >> 10) - (time_boot_msec() >> 10);
7471 /* Combine expiration time with OpenFlow "importance" to form a single
7472 * priority value. We want flows with relatively low "importance" to be
7473 * evicted before even considering expiration time, so put "importance" in
7474 * the most significant bits and expiration time in the least significant
7477 * Small 'priority' should be evicted before those with large 'priority'.
7478 * The caller expects the opposite convention (a large return value being
7479 * more attractive for eviction) so we invert it before returning. */
7480 uint64_t priority = ((uint64_t) rule->importance << 32) + expiration_ofs;
7481 return UINT64_MAX - priority;
7484 /* Adds 'rule' to an appropriate eviction group for its oftable's
7485 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7486 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7489 * The caller must ensure that 'rule' is not already in an eviction group. */
7491 eviction_group_add_rule(struct rule *rule)
7492 OVS_REQUIRES(ofproto_mutex)
7494 struct ofproto *ofproto = rule->ofproto;
7495 struct oftable *table = &ofproto->tables[rule->table_id];
7498 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7499 * so no additional protection is needed. */
7500 has_timeout = rule->hard_timeout || rule->idle_timeout;
7502 if (table->eviction && has_timeout) {
7503 struct eviction_group *evg;
7505 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7507 rule->eviction_group = evg;
7508 heap_insert(&evg->rules, &rule->evg_node,
7509 rule_eviction_priority(ofproto, rule));
7510 eviction_group_resized(table, evg);
7516 /* Initializes 'table'. */
7518 oftable_init(struct oftable *table)
7520 memset(table, 0, sizeof *table);
7521 classifier_init(&table->cls, flow_segment_u64s);
7522 table->max_flows = UINT_MAX;
7524 hmap_init(&table->eviction_groups_by_id);
7525 heap_init(&table->eviction_groups_by_size);
7526 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7528 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7529 ARRAY_SIZE(default_prefix_fields));
7531 atomic_init(&table->n_matched, 0);
7532 atomic_init(&table->n_missed, 0);
7535 /* Destroys 'table', including its classifier and eviction groups.
7537 * The caller is responsible for freeing 'table' itself. */
7539 oftable_destroy(struct oftable *table)
7541 ovs_assert(classifier_is_empty(&table->cls));
7543 ovs_mutex_lock(&ofproto_mutex);
7544 oftable_configure_eviction(table, 0, NULL, 0);
7545 ovs_mutex_unlock(&ofproto_mutex);
7547 hmap_destroy(&table->eviction_groups_by_id);
7548 heap_destroy(&table->eviction_groups_by_size);
7549 classifier_destroy(&table->cls);
7553 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7554 * string, then 'table' will use its default name.
7556 * This only affects the name exposed for a table exposed through the OpenFlow
7557 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7559 oftable_set_name(struct oftable *table, const char *name)
7561 if (name && name[0]) {
7562 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7563 if (!table->name || strncmp(name, table->name, len)) {
7565 table->name = xmemdup0(name, len);
7573 /* oftables support a choice of two policies when adding a rule would cause the
7574 * number of flows in the table to exceed the configured maximum number: either
7575 * they can refuse to add the new flow or they can evict some existing flow.
7576 * This function configures the latter policy on 'table', with fairness based
7577 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7578 * 'n_fields' as 0 disables fairness.) */
7580 oftable_configure_eviction(struct oftable *table, unsigned int eviction,
7581 const struct mf_subfield *fields, size_t n_fields)
7582 OVS_REQUIRES(ofproto_mutex)
7586 if ((table->eviction != 0) == (eviction != 0)
7587 && n_fields == table->n_eviction_fields
7589 || !memcmp(fields, table->eviction_fields,
7590 n_fields * sizeof *fields))) {
7591 /* The set of eviction fields did not change. If 'eviction' changed,
7592 * it remains nonzero, so that we can just update table->eviction
7593 * without fussing with the eviction groups. */
7594 table->eviction = eviction;
7598 /* Destroy existing eviction groups, then destroy and recreate data
7599 * structures to recover memory. */
7600 struct eviction_group *evg, *next;
7601 HMAP_FOR_EACH_SAFE (evg, next, id_node, &table->eviction_groups_by_id) {
7602 eviction_group_destroy(table, evg);
7604 hmap_destroy(&table->eviction_groups_by_id);
7605 hmap_init(&table->eviction_groups_by_id);
7606 heap_destroy(&table->eviction_groups_by_size);
7607 heap_init(&table->eviction_groups_by_size);
7609 /* Replace eviction groups by the new ones, if there is a change. Free the
7610 * old fields only after allocating the new ones, because 'fields ==
7611 * table->eviction_fields' is possible. */
7612 struct mf_subfield *old_fields = table->eviction_fields;
7613 table->n_eviction_fields = n_fields;
7614 table->eviction_fields = (fields
7615 ? xmemdup(fields, n_fields * sizeof *fields)
7619 /* Add the new eviction groups, if enabled. */
7620 table->eviction = eviction;
7621 if (table->eviction) {
7622 table->eviction_group_id_basis = random_uint32();
7623 CLS_FOR_EACH (rule, cr, &table->cls) {
7624 eviction_group_add_rule(rule);
7629 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7630 * it to the classifier. */
7632 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7633 OVS_REQUIRES(ofproto_mutex)
7635 const struct rule_actions *actions = rule_get_actions(rule);
7637 ovs_assert(rule->removed);
7639 if (rule->hard_timeout || rule->idle_timeout) {
7640 list_insert(&ofproto->expirable, &rule->expirable);
7642 cookies_insert(ofproto, rule);
7643 eviction_group_add_rule(rule);
7644 if (actions->has_meter) {
7645 meter_insert_rule(rule);
7647 rule->removed = false;
7650 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7651 * the removal from the classifier. */
7653 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7654 OVS_REQUIRES(ofproto_mutex)
7656 ovs_assert(!rule->removed);
7658 cookies_remove(ofproto, rule);
7660 eviction_group_remove_rule(rule);
7661 if (!list_is_empty(&rule->expirable)) {
7662 list_remove(&rule->expirable);
7664 if (!list_is_empty(&rule->meter_list_node)) {
7665 list_remove(&rule->meter_list_node);
7666 list_init(&rule->meter_list_node);
7669 rule->removed = true;
7672 /* unixctl commands. */
7675 ofproto_lookup(const char *name)
7677 struct ofproto *ofproto;
7679 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7681 if (!strcmp(ofproto->name, name)) {
7689 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7690 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7692 struct ofproto *ofproto;
7696 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7697 ds_put_format(&results, "%s\n", ofproto->name);
7699 unixctl_command_reply(conn, ds_cstr(&results));
7700 ds_destroy(&results);
7704 ofproto_unixctl_init(void)
7706 static bool registered;
7712 unixctl_command_register("ofproto/list", "", 0, 0,
7713 ofproto_unixctl_list, NULL);
7716 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7718 * This is deprecated. It is only for compatibility with broken device drivers
7719 * in old versions of Linux that do not properly support VLANs when VLAN
7720 * devices are not used. When broken device drivers are no longer in
7721 * widespread use, we will delete these interfaces. */
7723 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7724 * (exactly) by an OpenFlow rule in 'ofproto'. */
7726 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7729 struct cls_rule target;
7730 const struct oftable *oftable;
7732 match_init_catchall(&match);
7733 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7734 cls_rule_init(&target, &match, 0, CLS_MAX_VERSION);
7736 free(ofproto->vlan_bitmap);
7737 ofproto->vlan_bitmap = bitmap_allocate(4096);
7738 ofproto->vlans_changed = false;
7740 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7743 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7744 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7745 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7747 bitmap_set1(vlan_bitmap, vid);
7748 bitmap_set1(ofproto->vlan_bitmap, vid);
7753 cls_rule_destroy(&target);
7756 /* Returns true if new VLANs have come into use by the flow table since the
7757 * last call to ofproto_get_vlan_usage().
7759 * We don't track when old VLANs stop being used. */
7761 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7763 return ofproto->vlans_changed;
7766 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7767 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7768 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7769 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7770 * then the VLAN device is un-enslaved. */
7772 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7773 ofp_port_t realdev_ofp_port, int vid)
7775 struct ofport *ofport;
7778 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7780 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7782 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7783 ofproto->name, vlandev_ofp_port);
7787 if (!ofproto->ofproto_class->set_realdev) {
7788 if (!vlandev_ofp_port) {
7791 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7795 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7797 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7798 ofproto->name, vlandev_ofp_port,
7799 netdev_get_name(ofport->netdev), ovs_strerror(error));