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 *, cls_version_t version,
271 struct rule *old_rule, struct rule *new_rule,
272 struct cls_conjunction *, size_t n_conjs)
273 OVS_REQUIRES(ofproto_mutex);
275 static void replace_rule_revert(struct ofproto *, struct rule *old_rule,
276 struct rule *new_rule)
277 OVS_REQUIRES(ofproto_mutex);
279 static void replace_rule_finish(struct ofproto *, struct ofputil_flow_mod *,
280 const struct flow_mod_requester *,
281 struct rule *old_rule, struct rule *new_rule,
282 struct ovs_list *dead_cookies)
283 OVS_REQUIRES(ofproto_mutex);
284 static void delete_flows__(struct rule_collection *,
285 enum ofp_flow_removed_reason,
286 const struct flow_mod_requester *)
287 OVS_REQUIRES(ofproto_mutex);
289 static void send_buffered_packet(const struct flow_mod_requester *,
290 uint32_t buffer_id, struct rule *)
291 OVS_REQUIRES(ofproto_mutex);
293 static bool ofproto_group_exists__(const struct ofproto *ofproto,
295 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
296 static bool ofproto_group_exists(const struct ofproto *ofproto,
298 OVS_EXCLUDED(ofproto->groups_rwlock);
299 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
300 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
301 static enum ofperr ofproto_flow_mod_start(struct ofproto *,
302 struct ofproto_flow_mod *)
303 OVS_REQUIRES(ofproto_mutex);
304 static void ofproto_flow_mod_finish(struct ofproto *,
305 struct ofproto_flow_mod *,
306 const struct flow_mod_requester *)
307 OVS_REQUIRES(ofproto_mutex);
308 static enum ofperr handle_flow_mod__(struct ofproto *,
309 struct ofproto_flow_mod *,
310 const struct flow_mod_requester *)
311 OVS_EXCLUDED(ofproto_mutex);
312 static void calc_duration(long long int start, long long int now,
313 uint32_t *sec, uint32_t *nsec);
316 static uint64_t pick_datapath_id(const struct ofproto *);
317 static uint64_t pick_fallback_dpid(void);
318 static void ofproto_destroy__(struct ofproto *);
319 static void update_mtu(struct ofproto *, struct ofport *);
320 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
321 static void meter_insert_rule(struct rule *);
324 static void ofproto_unixctl_init(void);
326 /* All registered ofproto classes, in probe order. */
327 static const struct ofproto_class **ofproto_classes;
328 static size_t n_ofproto_classes;
329 static size_t allocated_ofproto_classes;
331 /* Global lock that protects all flow table operations. */
332 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
334 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
335 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
337 size_t n_handlers, n_revalidators;
341 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
342 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
344 /* Initial mappings of port to OpenFlow number mappings. */
345 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
347 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
349 /* The default value of true waits for flow restore. */
350 static bool flow_restore_wait = true;
352 /* Must be called to initialize the ofproto library.
354 * The caller may pass in 'iface_hints', which contains an shash of
355 * "iface_hint" elements indexed by the interface's name. The provider
356 * may use these hints to describe the startup configuration in order to
357 * reinitialize its state. The caller owns the provided data, so a
358 * provider will make copies of anything required. An ofproto provider
359 * will remove any existing state that is not described by the hint, and
360 * may choose to remove it all. */
362 ofproto_init(const struct shash *iface_hints)
364 struct shash_node *node;
367 ofproto_class_register(&ofproto_dpif_class);
369 /* Make a local copy, since we don't own 'iface_hints' elements. */
370 SHASH_FOR_EACH(node, iface_hints) {
371 const struct iface_hint *orig_hint = node->data;
372 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
373 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
375 new_hint->br_name = xstrdup(orig_hint->br_name);
376 new_hint->br_type = xstrdup(br_type);
377 new_hint->ofp_port = orig_hint->ofp_port;
379 shash_add(&init_ofp_ports, node->name, new_hint);
382 for (i = 0; i < n_ofproto_classes; i++) {
383 ofproto_classes[i]->init(&init_ofp_ports);
387 /* 'type' should be a normalized datapath type, as returned by
388 * ofproto_normalize_type(). Returns the corresponding ofproto_class
389 * structure, or a null pointer if there is none registered for 'type'. */
390 static const struct ofproto_class *
391 ofproto_class_find__(const char *type)
395 for (i = 0; i < n_ofproto_classes; i++) {
396 const struct ofproto_class *class = ofproto_classes[i];
401 class->enumerate_types(&types);
402 found = sset_contains(&types, type);
403 sset_destroy(&types);
409 VLOG_WARN("unknown datapath type %s", type);
413 /* Registers a new ofproto class. After successful registration, new ofprotos
414 * of that type can be created using ofproto_create(). */
416 ofproto_class_register(const struct ofproto_class *new_class)
420 for (i = 0; i < n_ofproto_classes; i++) {
421 if (ofproto_classes[i] == new_class) {
426 if (n_ofproto_classes >= allocated_ofproto_classes) {
427 ofproto_classes = x2nrealloc(ofproto_classes,
428 &allocated_ofproto_classes,
429 sizeof *ofproto_classes);
431 ofproto_classes[n_ofproto_classes++] = new_class;
435 /* Unregisters a datapath provider. 'type' must have been previously
436 * registered and not currently be in use by any ofprotos. After
437 * unregistration new datapaths of that type cannot be opened using
438 * ofproto_create(). */
440 ofproto_class_unregister(const struct ofproto_class *class)
444 for (i = 0; i < n_ofproto_classes; i++) {
445 if (ofproto_classes[i] == class) {
446 for (i++; i < n_ofproto_classes; i++) {
447 ofproto_classes[i - 1] = ofproto_classes[i];
453 VLOG_WARN("attempted to unregister an ofproto class that is not "
458 /* Clears 'types' and enumerates all registered ofproto types into it. The
459 * caller must first initialize the sset. */
461 ofproto_enumerate_types(struct sset *types)
466 for (i = 0; i < n_ofproto_classes; i++) {
467 ofproto_classes[i]->enumerate_types(types);
471 /* Returns the fully spelled out name for the given ofproto 'type'.
473 * Normalized type string can be compared with strcmp(). Unnormalized type
474 * string might be the same even if they have different spellings. */
476 ofproto_normalize_type(const char *type)
478 return type && type[0] ? type : "system";
481 /* Clears 'names' and enumerates the names of all known created ofprotos with
482 * the given 'type'. The caller must first initialize the sset. Returns 0 if
483 * successful, otherwise a positive errno value.
485 * Some kinds of datapaths might not be practically enumerable. This is not
486 * considered an error. */
488 ofproto_enumerate_names(const char *type, struct sset *names)
490 const struct ofproto_class *class = ofproto_class_find__(type);
491 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
495 ofproto_bump_tables_version(struct ofproto *ofproto)
497 ++ofproto->tables_version;
498 ofproto->ofproto_class->set_tables_version(ofproto,
499 ofproto->tables_version);
503 ofproto_create(const char *datapath_name, const char *datapath_type,
504 struct ofproto **ofprotop)
506 const struct ofproto_class *class;
507 struct ofproto *ofproto;
513 ofproto_unixctl_init();
515 datapath_type = ofproto_normalize_type(datapath_type);
516 class = ofproto_class_find__(datapath_type);
518 VLOG_WARN("could not create datapath %s of unknown type %s",
519 datapath_name, datapath_type);
523 ofproto = class->alloc();
525 VLOG_ERR("failed to allocate datapath %s of type %s",
526 datapath_name, datapath_type);
531 ovs_mutex_lock(&ofproto_mutex);
532 memset(ofproto, 0, sizeof *ofproto);
533 ofproto->ofproto_class = class;
534 ofproto->name = xstrdup(datapath_name);
535 ofproto->type = xstrdup(datapath_type);
536 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
537 hash_string(ofproto->name, 0));
538 ofproto->datapath_id = 0;
539 ofproto->forward_bpdu = false;
540 ofproto->fallback_dpid = pick_fallback_dpid();
541 ofproto->mfr_desc = NULL;
542 ofproto->hw_desc = NULL;
543 ofproto->sw_desc = NULL;
544 ofproto->serial_desc = NULL;
545 ofproto->dp_desc = NULL;
546 ofproto->frag_handling = OFPC_FRAG_NORMAL;
547 hmap_init(&ofproto->ports);
548 hmap_init(&ofproto->ofport_usage);
549 shash_init(&ofproto->port_by_name);
550 simap_init(&ofproto->ofp_requests);
551 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
552 ofproto->eviction_group_timer = LLONG_MIN;
553 ofproto->tables = NULL;
554 ofproto->n_tables = 0;
555 ofproto->tables_version = CLS_MIN_VERSION;
556 hindex_init(&ofproto->cookies);
557 hmap_init(&ofproto->learned_cookies);
558 list_init(&ofproto->expirable);
559 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
560 guarded_list_init(&ofproto->rule_executes);
561 ofproto->vlan_bitmap = NULL;
562 ofproto->vlans_changed = false;
563 ofproto->min_mtu = INT_MAX;
564 ovs_rwlock_init(&ofproto->groups_rwlock);
565 hmap_init(&ofproto->groups);
566 ovs_mutex_unlock(&ofproto_mutex);
567 ofproto->ogf.types = 0xf;
568 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
569 OFPGFC_SELECT_WEIGHT;
570 for (i = 0; i < 4; i++) {
571 ofproto->ogf.max_groups[i] = OFPG_MAX;
572 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
576 error = ofproto->ofproto_class->construct(ofproto);
578 VLOG_ERR("failed to open datapath %s: %s",
579 datapath_name, ovs_strerror(error));
580 connmgr_destroy(ofproto->connmgr);
581 ofproto_destroy__(ofproto);
585 /* Check that hidden tables, if any, are at the end. */
586 ovs_assert(ofproto->n_tables);
587 for (i = 0; i + 1 < ofproto->n_tables; i++) {
588 enum oftable_flags flags = ofproto->tables[i].flags;
589 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
591 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
594 ofproto->datapath_id = pick_datapath_id(ofproto);
597 /* Initialize meters table. */
598 if (ofproto->ofproto_class->meter_get_features) {
599 ofproto->ofproto_class->meter_get_features(ofproto,
600 &ofproto->meter_features);
602 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
604 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
605 * sizeof(struct meter *));
607 /* Set the initial tables version. */
608 ofproto_bump_tables_version(ofproto);
614 /* Must be called (only) by an ofproto implementation in its constructor
615 * function. See the large comment on 'construct' in struct ofproto_class for
618 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
620 struct oftable *table;
622 ovs_assert(!ofproto->n_tables);
623 ovs_assert(n_tables >= 1 && n_tables <= 255);
625 ofproto->n_tables = n_tables;
626 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
627 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
632 /* To be optionally called (only) by an ofproto implementation in its
633 * constructor function. See the large comment on 'construct' in struct
634 * ofproto_class for details.
636 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
637 * will then ensure that actions passed into the ofproto implementation will
638 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
639 * function is not called, there will be no such restriction.
641 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
642 * the 'max_ports' restriction. */
644 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
646 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
647 ofproto->max_ports = max_ports;
651 ofproto_get_datapath_id(const struct ofproto *ofproto)
653 return ofproto->datapath_id;
657 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
659 uint64_t old_dpid = p->datapath_id;
660 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
661 if (p->datapath_id != old_dpid) {
662 /* Force all active connections to reconnect, since there is no way to
663 * notify a controller that the datapath ID has changed. */
664 ofproto_reconnect_controllers(p);
669 ofproto_set_controllers(struct ofproto *p,
670 const struct ofproto_controller *controllers,
671 size_t n_controllers, uint32_t allowed_versions)
673 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
678 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
680 connmgr_set_fail_mode(p->connmgr, fail_mode);
683 /* Drops the connections between 'ofproto' and all of its controllers, forcing
684 * them to reconnect. */
686 ofproto_reconnect_controllers(struct ofproto *ofproto)
688 connmgr_reconnect(ofproto->connmgr);
691 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
692 * in-band control should guarantee access, in the same way that in-band
693 * control guarantees access to OpenFlow controllers. */
695 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
696 const struct sockaddr_in *extras, size_t n)
698 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
701 /* Sets the OpenFlow queue used by flows set up by in-band control on
702 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
703 * flows will use the default queue. */
705 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
707 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
710 /* Sets the number of flows at which eviction from the kernel flow table
713 ofproto_set_flow_limit(unsigned limit)
715 ofproto_flow_limit = limit;
718 /* Sets the maximum idle time for flows in the datapath before they are
721 ofproto_set_max_idle(unsigned max_idle)
723 ofproto_max_idle = max_idle;
726 /* If forward_bpdu is true, the NORMAL action will forward frames with
727 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
728 * the NORMAL action will drop these frames. */
730 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
732 bool old_val = ofproto->forward_bpdu;
733 ofproto->forward_bpdu = forward_bpdu;
734 if (old_val != ofproto->forward_bpdu) {
735 if (ofproto->ofproto_class->forward_bpdu_changed) {
736 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
741 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
742 * 'idle_time', in seconds, and the maximum number of MAC table entries to
745 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
748 if (ofproto->ofproto_class->set_mac_table_config) {
749 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
754 /* Multicast snooping configuration. */
756 /* Configures multicast snooping on 'ofproto' using the settings
757 * defined in 's'. If 's' is NULL, disables multicast snooping.
759 * Returns 0 if successful, otherwise a positive errno value. */
761 ofproto_set_mcast_snooping(struct ofproto *ofproto,
762 const struct ofproto_mcast_snooping_settings *s)
764 return (ofproto->ofproto_class->set_mcast_snooping
765 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
769 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
771 * Returns 0 if successful, otherwise a positive errno value.*/
773 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
774 const struct ofproto_mcast_snooping_port_settings *s)
776 return (ofproto->ofproto_class->set_mcast_snooping_port
777 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
782 ofproto_set_n_dpdk_rxqs(int n_rxqs)
784 n_dpdk_rxqs = MAX(n_rxqs, 0);
788 ofproto_set_cpu_mask(const char *cmask)
792 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
796 ofproto_set_threads(int n_handlers_, int n_revalidators_)
798 int threads = MAX(count_cpu_cores(), 2);
800 n_revalidators = MAX(n_revalidators_, 0);
801 n_handlers = MAX(n_handlers_, 0);
803 if (!n_revalidators) {
804 n_revalidators = n_handlers
805 ? MAX(threads - (int) n_handlers, 1)
810 n_handlers = MAX(threads - (int) n_revalidators, 1);
815 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
818 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
822 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
824 return connmgr_set_snoops(ofproto->connmgr, snoops);
828 ofproto_set_netflow(struct ofproto *ofproto,
829 const struct netflow_options *nf_options)
831 if (nf_options && sset_is_empty(&nf_options->collectors)) {
835 if (ofproto->ofproto_class->set_netflow) {
836 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
838 return nf_options ? EOPNOTSUPP : 0;
843 ofproto_set_sflow(struct ofproto *ofproto,
844 const struct ofproto_sflow_options *oso)
846 if (oso && sset_is_empty(&oso->targets)) {
850 if (ofproto->ofproto_class->set_sflow) {
851 return ofproto->ofproto_class->set_sflow(ofproto, oso);
853 return oso ? EOPNOTSUPP : 0;
858 ofproto_set_ipfix(struct ofproto *ofproto,
859 const struct ofproto_ipfix_bridge_exporter_options *bo,
860 const struct ofproto_ipfix_flow_exporter_options *fo,
863 if (ofproto->ofproto_class->set_ipfix) {
864 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
866 return (bo || fo) ? EOPNOTSUPP : 0;
871 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
873 flow_restore_wait = flow_restore_wait_db;
877 ofproto_get_flow_restore_wait(void)
879 return flow_restore_wait;
883 /* Spanning Tree Protocol (STP) configuration. */
885 /* Configures STP on 'ofproto' using the settings defined in 's'. If
886 * 's' is NULL, disables STP.
888 * Returns 0 if successful, otherwise a positive errno value. */
890 ofproto_set_stp(struct ofproto *ofproto,
891 const struct ofproto_stp_settings *s)
893 return (ofproto->ofproto_class->set_stp
894 ? ofproto->ofproto_class->set_stp(ofproto, s)
898 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
899 * 'enabled' member of 's' is false, then the other members are not
902 * Returns 0 if successful, otherwise a positive errno value. */
904 ofproto_get_stp_status(struct ofproto *ofproto,
905 struct ofproto_stp_status *s)
907 return (ofproto->ofproto_class->get_stp_status
908 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
912 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
913 * in 's'. The caller is responsible for assigning STP port numbers
914 * (using the 'port_num' member in the range of 1 through 255, inclusive)
915 * and ensuring there are no duplicates. If the 's' is NULL, then STP
916 * is disabled on the port.
918 * Returns 0 if successful, otherwise a positive errno value.*/
920 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
921 const struct ofproto_port_stp_settings *s)
923 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
925 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
926 ofproto->name, ofp_port);
930 return (ofproto->ofproto_class->set_stp_port
931 ? ofproto->ofproto_class->set_stp_port(ofport, s)
935 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
936 * 's'. If the 'enabled' member in 's' is false, then the other members
937 * are not meaningful.
939 * Returns 0 if successful, otherwise a positive errno value.*/
941 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
942 struct ofproto_port_stp_status *s)
944 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
946 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
947 "port %"PRIu16, ofproto->name, ofp_port);
951 return (ofproto->ofproto_class->get_stp_port_status
952 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
956 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
957 * 's'. If the 'enabled' member in 's' is false, then the other members
958 * are not meaningful.
960 * Returns 0 if successful, otherwise a positive errno value.*/
962 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
963 struct ofproto_port_stp_stats *s)
965 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
967 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
968 "port %"PRIu16, ofproto->name, ofp_port);
972 return (ofproto->ofproto_class->get_stp_port_stats
973 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
977 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
979 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
980 * 's' is NULL, disables RSTP.
982 * Returns 0 if successful, otherwise a positive errno value. */
984 ofproto_set_rstp(struct ofproto *ofproto,
985 const struct ofproto_rstp_settings *s)
987 if (!ofproto->ofproto_class->set_rstp) {
990 ofproto->ofproto_class->set_rstp(ofproto, s);
994 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
995 * 'enabled' member of 's' is false, then the other members are not
998 * Returns 0 if successful, otherwise a positive errno value. */
1000 ofproto_get_rstp_status(struct ofproto *ofproto,
1001 struct ofproto_rstp_status *s)
1003 if (!ofproto->ofproto_class->get_rstp_status) {
1006 ofproto->ofproto_class->get_rstp_status(ofproto, s);
1010 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1011 * in 's'. The caller is responsible for assigning RSTP port numbers
1012 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1013 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1014 * is disabled on the port.
1016 * Returns 0 if successful, otherwise a positive errno value.*/
1018 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
1019 const struct ofproto_port_rstp_settings *s)
1021 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1023 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
1024 ofproto->name, ofp_port);
1028 if (!ofproto->ofproto_class->set_rstp_port) {
1031 ofproto->ofproto_class->set_rstp_port(ofport, s);
1035 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1036 * 's'. If the 'enabled' member in 's' is false, then the other members
1037 * are not meaningful.
1039 * Returns 0 if successful, otherwise a positive errno value.*/
1041 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1042 struct ofproto_port_rstp_status *s)
1044 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1046 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1047 "port %"PRIu16, ofproto->name, ofp_port);
1051 if (!ofproto->ofproto_class->get_rstp_port_status) {
1054 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1058 /* Queue DSCP configuration. */
1060 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1061 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1062 * to implement QoS. Instead, it is used to implement features which require
1063 * knowledge of what queues exist on a port, and some basic information about
1066 * Returns 0 if successful, otherwise a positive errno value. */
1068 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1069 const struct ofproto_port_queue *queues,
1072 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1075 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1076 ofproto->name, ofp_port);
1080 return (ofproto->ofproto_class->set_queues
1081 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1085 /* LLDP configuration. */
1087 ofproto_port_set_lldp(struct ofproto *ofproto,
1088 ofp_port_t ofp_port,
1089 const struct smap *cfg)
1091 struct ofport *ofport;
1094 ofport = ofproto_get_port(ofproto, ofp_port);
1096 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1097 ofproto->name, ofp_port);
1100 error = (ofproto->ofproto_class->set_lldp
1101 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1104 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1105 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1106 ovs_strerror(error));
1111 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1112 const struct aa_settings *s)
1114 if (!ofproto->ofproto_class->set_aa) {
1117 ofproto->ofproto_class->set_aa(ofproto, s);
1122 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1123 const struct aa_mapping_settings *s)
1125 if (!ofproto->ofproto_class->aa_mapping_set) {
1128 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1133 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1135 if (!ofproto->ofproto_class->aa_mapping_unset) {
1138 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1143 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1144 struct ovs_list *list)
1146 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1149 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1154 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1156 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1159 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1162 /* Connectivity Fault Management configuration. */
1164 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1166 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1168 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1169 if (ofport && ofproto->ofproto_class->set_cfm) {
1170 ofproto->ofproto_class->set_cfm(ofport, NULL);
1174 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1175 * basic configuration from the configuration members in 'cfm', and the remote
1176 * maintenance point ID from remote_mpid. Ignores the statistics members of
1179 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1181 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1182 const struct cfm_settings *s)
1184 struct ofport *ofport;
1187 ofport = ofproto_get_port(ofproto, ofp_port);
1189 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1190 ofproto->name, ofp_port);
1194 /* XXX: For configuration simplicity, we only support one remote_mpid
1195 * outside of the CFM module. It's not clear if this is the correct long
1196 * term solution or not. */
1197 error = (ofproto->ofproto_class->set_cfm
1198 ? ofproto->ofproto_class->set_cfm(ofport, s)
1201 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1202 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1203 ovs_strerror(error));
1207 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1208 * 'ofproto' does not have a port 'ofp_port'. */
1210 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1211 const struct smap *cfg)
1213 struct ofport *ofport;
1216 ofport = ofproto_get_port(ofproto, ofp_port);
1218 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1219 ofproto->name, ofp_port);
1223 error = (ofproto->ofproto_class->set_bfd
1224 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1227 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1228 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1229 ovs_strerror(error));
1233 /* Checks the status change of BFD on 'ofport'.
1235 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1237 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1239 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1240 return (ofport && ofproto->ofproto_class->bfd_status_changed
1241 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1245 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1246 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1247 * is not an OpenFlow port in 'ofproto'.
1249 * The caller must provide and own '*status'. */
1251 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1252 struct smap *status)
1254 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1255 return (ofport && ofproto->ofproto_class->get_bfd_status
1256 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1260 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1261 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1262 * 0 if LACP partner information is not current (generally indicating a
1263 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1265 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1267 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1268 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1269 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1274 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1276 struct ofproto *ofproto = port->ofproto;
1279 if (ofproto->ofproto_class->port_get_lacp_stats) {
1280 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1290 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1291 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1292 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1293 * configuration plus, if there is more than one slave, a bonding
1296 * If 'aux' is already registered then this function updates its configuration
1297 * to 's'. Otherwise, this function registers a new bundle.
1299 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1302 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1303 const struct ofproto_bundle_settings *s)
1305 return (ofproto->ofproto_class->bundle_set
1306 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1310 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1311 * If no such bundle has been registered, this has no effect. */
1313 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1315 return ofproto_bundle_register(ofproto, aux, NULL);
1319 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1320 * If 'aux' is already registered then this function updates its configuration
1321 * to 's'. Otherwise, this function registers a new mirror. */
1323 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1324 const struct ofproto_mirror_settings *s)
1326 return (ofproto->ofproto_class->mirror_set
1327 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1331 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1332 * If no mirror has been registered, this has no effect. */
1334 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1336 return ofproto_mirror_register(ofproto, aux, NULL);
1339 /* Retrieves statistics from mirror associated with client data pointer
1340 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1341 * 'bytes', respectively. If a particular counters is not supported,
1342 * the appropriate argument is set to UINT64_MAX.
1345 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1346 uint64_t *packets, uint64_t *bytes)
1348 if (!ofproto->ofproto_class->mirror_get_stats) {
1349 *packets = *bytes = UINT64_MAX;
1353 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1357 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1358 * which all packets are flooded, instead of using MAC learning. If
1359 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1361 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1364 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1366 return (ofproto->ofproto_class->set_flood_vlans
1367 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1371 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1372 * output for a mirror. */
1374 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1376 return (ofproto->ofproto_class->is_mirror_output_bundle
1377 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1381 /* Configuration of OpenFlow tables. */
1383 /* Returns the number of OpenFlow tables in 'ofproto'. */
1385 ofproto_get_n_tables(const struct ofproto *ofproto)
1387 return ofproto->n_tables;
1390 /* Returns the number of Controller visible OpenFlow tables
1391 * in 'ofproto'. This number will exclude Hidden tables.
1392 * This funtion's return value should be less or equal to that of
1393 * ofproto_get_n_tables() . */
1395 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1397 uint8_t n = ofproto->n_tables;
1399 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1400 * if present, are always at the end.) */
1401 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1408 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1409 * settings from 's'. 'table_id' must be in the range 0 through the number of
1410 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1412 * For read-only tables, only the name may be configured. */
1414 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1415 const struct ofproto_table_settings *s)
1417 struct oftable *table;
1419 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1420 table = &ofproto->tables[table_id];
1422 oftable_set_name(table, s->name);
1424 if (table->flags & OFTABLE_READONLY) {
1428 if (classifier_set_prefix_fields(&table->cls,
1429 s->prefix_fields, s->n_prefix_fields)) {
1430 /* XXX: Trigger revalidation. */
1433 ovs_mutex_lock(&ofproto_mutex);
1434 unsigned int new_eviction = (s->enable_eviction
1435 ? table->eviction | EVICTION_CLIENT
1436 : table->eviction & ~EVICTION_CLIENT);
1437 oftable_configure_eviction(table, new_eviction, s->groups, s->n_groups);
1438 table->max_flows = s->max_flows;
1439 evict_rules_from_table(table);
1440 ovs_mutex_unlock(&ofproto_mutex);
1444 ofproto_has_snoops(const struct ofproto *ofproto)
1446 return connmgr_has_snoops(ofproto->connmgr);
1450 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1452 connmgr_get_snoops(ofproto->connmgr, snoops);
1455 /* Deletes 'rule' from 'ofproto'.
1457 * Within an ofproto implementation, this function allows an ofproto
1458 * implementation to destroy any rules that remain when its ->destruct()
1459 * function is called. This function is not suitable for use elsewhere in an
1460 * ofproto implementation.
1462 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1463 * Cycle" in ofproto-provider.h. */
1465 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1466 OVS_EXCLUDED(ofproto_mutex)
1468 /* This skips the ofmonitor and flow-removed notifications because the
1469 * switch is being deleted and any OpenFlow channels have been or soon will
1471 ovs_mutex_lock(&ofproto_mutex);
1473 if (!rule->removed) {
1474 /* Make sure there is no postponed removal of the rule. */
1475 ovs_assert(cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
1477 if (!classifier_remove(&rule->ofproto->tables[rule->table_id].cls,
1481 ofproto_rule_remove__(rule->ofproto, rule);
1482 ofproto->ofproto_class->rule_delete(rule);
1483 ofproto_rule_unref(rule);
1485 ovs_mutex_unlock(&ofproto_mutex);
1489 ofproto_flush__(struct ofproto *ofproto)
1490 OVS_EXCLUDED(ofproto_mutex)
1492 struct oftable *table;
1494 /* This will flush all datapath flows. */
1495 if (ofproto->ofproto_class->flush) {
1496 ofproto->ofproto_class->flush(ofproto);
1499 /* XXX: There is a small race window here, where new datapath flows can be
1500 * created by upcall handlers based on the existing flow table. We can not
1501 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1502 * as then we could deadlock on syncing with the handler threads waiting on
1503 * the same mutex. */
1505 ovs_mutex_lock(&ofproto_mutex);
1506 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1507 struct rule_collection rules;
1510 if (table->flags & OFTABLE_HIDDEN) {
1514 rule_collection_init(&rules);
1516 CLS_FOR_EACH (rule, cr, &table->cls) {
1517 rule_collection_add(&rules, rule);
1519 delete_flows__(&rules, OFPRR_DELETE, NULL);
1521 /* XXX: Concurrent handler threads may insert new learned flows based on
1522 * learn actions of the now deleted flows right after we release
1523 * 'ofproto_mutex'. */
1524 ovs_mutex_unlock(&ofproto_mutex);
1527 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1530 ofproto_destroy__(struct ofproto *ofproto)
1531 OVS_EXCLUDED(ofproto_mutex)
1533 struct oftable *table;
1535 destroy_rule_executes(ofproto);
1537 guarded_list_destroy(&ofproto->rule_executes);
1538 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1539 hmap_destroy(&ofproto->groups);
1541 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1542 free(ofproto->name);
1543 free(ofproto->type);
1544 free(ofproto->mfr_desc);
1545 free(ofproto->hw_desc);
1546 free(ofproto->sw_desc);
1547 free(ofproto->serial_desc);
1548 free(ofproto->dp_desc);
1549 hmap_destroy(&ofproto->ports);
1550 hmap_destroy(&ofproto->ofport_usage);
1551 shash_destroy(&ofproto->port_by_name);
1552 simap_destroy(&ofproto->ofp_requests);
1554 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1555 oftable_destroy(table);
1557 free(ofproto->tables);
1559 ovs_assert(hindex_is_empty(&ofproto->cookies));
1560 hindex_destroy(&ofproto->cookies);
1562 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1563 hmap_destroy(&ofproto->learned_cookies);
1565 free(ofproto->vlan_bitmap);
1567 ofproto->ofproto_class->dealloc(ofproto);
1570 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1571 * - 1st we defer the removal of the rules from the classifier
1572 * - 2nd we defer the actual destruction of the rules. */
1574 ofproto_destroy_defer__(struct ofproto *ofproto)
1575 OVS_EXCLUDED(ofproto_mutex)
1577 ovsrcu_postpone(ofproto_destroy__, ofproto);
1581 ofproto_destroy(struct ofproto *p)
1582 OVS_EXCLUDED(ofproto_mutex)
1584 struct ofport *ofport, *next_ofport;
1585 struct ofport_usage *usage, *next_usage;
1592 meter_delete(p, 1, p->meter_features.max_meters);
1593 p->meter_features.max_meters = 0;
1599 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1600 ofport_destroy(ofport);
1603 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1604 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1608 p->ofproto_class->destruct(p);
1610 /* We should not postpone this because it involves deleting a listening
1611 * socket which we may want to reopen soon. 'connmgr' should not be used
1612 * by other threads */
1613 connmgr_destroy(p->connmgr);
1615 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1616 ovsrcu_postpone(ofproto_destroy_defer__, p);
1619 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1620 * kernel datapath, for example, this destroys the datapath in the kernel, and
1621 * with the netdev-based datapath, it tears down the data structures that
1622 * represent the datapath.
1624 * The datapath should not be currently open as an ofproto. */
1626 ofproto_delete(const char *name, const char *type)
1628 const struct ofproto_class *class = ofproto_class_find__(type);
1629 return (!class ? EAFNOSUPPORT
1630 : !class->del ? EACCES
1631 : class->del(type, name));
1635 process_port_change(struct ofproto *ofproto, int error, char *devname)
1637 if (error == ENOBUFS) {
1638 reinit_ports(ofproto);
1639 } else if (!error) {
1640 update_port(ofproto, devname);
1646 ofproto_type_run(const char *datapath_type)
1648 const struct ofproto_class *class;
1651 datapath_type = ofproto_normalize_type(datapath_type);
1652 class = ofproto_class_find__(datapath_type);
1654 error = class->type_run ? class->type_run(datapath_type) : 0;
1655 if (error && error != EAGAIN) {
1656 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1657 datapath_type, ovs_strerror(error));
1663 ofproto_type_wait(const char *datapath_type)
1665 const struct ofproto_class *class;
1667 datapath_type = ofproto_normalize_type(datapath_type);
1668 class = ofproto_class_find__(datapath_type);
1670 if (class->type_wait) {
1671 class->type_wait(datapath_type);
1676 ofproto_run(struct ofproto *p)
1681 error = p->ofproto_class->run(p);
1682 if (error && error != EAGAIN) {
1683 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1686 run_rule_executes(p);
1688 /* Restore the eviction group heap invariant occasionally. */
1689 if (p->eviction_group_timer < time_msec()) {
1692 p->eviction_group_timer = time_msec() + 1000;
1694 for (i = 0; i < p->n_tables; i++) {
1695 struct oftable *table = &p->tables[i];
1696 struct eviction_group *evg;
1699 if (!table->eviction) {
1703 if (table->n_flows > 100000) {
1704 static struct vlog_rate_limit count_rl =
1705 VLOG_RATE_LIMIT_INIT(1, 1);
1706 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1707 " number of rules: %d", i, table->n_flows);
1710 ovs_mutex_lock(&ofproto_mutex);
1711 CLS_FOR_EACH (rule, cr, &table->cls) {
1712 if (rule->idle_timeout || rule->hard_timeout) {
1713 if (!rule->eviction_group) {
1714 eviction_group_add_rule(rule);
1716 heap_raw_change(&rule->evg_node,
1717 rule_eviction_priority(p, rule));
1722 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1723 heap_rebuild(&evg->rules);
1725 ovs_mutex_unlock(&ofproto_mutex);
1729 if (p->ofproto_class->port_poll) {
1732 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1733 process_port_change(p, error, devname);
1737 new_seq = seq_read(connectivity_seq_get());
1738 if (new_seq != p->change_seq) {
1739 struct sset devnames;
1740 const char *devname;
1741 struct ofport *ofport;
1743 /* Update OpenFlow port status for any port whose netdev has changed.
1745 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1746 * destroyed, so it's not safe to update ports directly from the
1747 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1748 * need this two-phase approach. */
1749 sset_init(&devnames);
1750 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1751 uint64_t port_change_seq;
1753 port_change_seq = netdev_get_change_seq(ofport->netdev);
1754 if (ofport->change_seq != port_change_seq) {
1755 ofport->change_seq = port_change_seq;
1756 sset_add(&devnames, netdev_get_name(ofport->netdev));
1759 SSET_FOR_EACH (devname, &devnames) {
1760 update_port(p, devname);
1762 sset_destroy(&devnames);
1764 p->change_seq = new_seq;
1767 connmgr_run(p->connmgr, handle_openflow);
1773 ofproto_wait(struct ofproto *p)
1775 p->ofproto_class->wait(p);
1776 if (p->ofproto_class->port_poll_wait) {
1777 p->ofproto_class->port_poll_wait(p);
1779 seq_wait(connectivity_seq_get(), p->change_seq);
1780 connmgr_wait(p->connmgr);
1784 ofproto_is_alive(const struct ofproto *p)
1786 return connmgr_has_controllers(p->connmgr);
1789 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1790 * memory_report(). */
1792 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1794 const struct oftable *table;
1795 unsigned int n_rules;
1797 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1800 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1801 n_rules += table->n_flows;
1803 simap_increase(usage, "rules", n_rules);
1805 if (ofproto->ofproto_class->get_memory_usage) {
1806 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1809 connmgr_get_memory_usage(ofproto->connmgr, usage);
1813 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1815 const struct ofproto_class *class;
1817 datapath_type = ofproto_normalize_type(datapath_type);
1818 class = ofproto_class_find__(datapath_type);
1820 if (class && class->type_get_memory_usage) {
1821 class->type_get_memory_usage(datapath_type, usage);
1826 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1829 connmgr_get_controller_info(ofproto->connmgr, info);
1833 ofproto_free_ofproto_controller_info(struct shash *info)
1835 connmgr_free_controller_info(info);
1838 /* Makes a deep copy of 'old' into 'port'. */
1840 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1842 port->name = xstrdup(old->name);
1843 port->type = xstrdup(old->type);
1844 port->ofp_port = old->ofp_port;
1847 /* Frees memory allocated to members of 'ofproto_port'.
1849 * Do not call this function on an ofproto_port obtained from
1850 * ofproto_port_dump_next(): that function retains ownership of the data in the
1853 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1855 free(ofproto_port->name);
1856 free(ofproto_port->type);
1859 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1861 * This function provides no status indication. An error status for the entire
1862 * dump operation is provided when it is completed by calling
1863 * ofproto_port_dump_done().
1866 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1867 const struct ofproto *ofproto)
1869 dump->ofproto = ofproto;
1870 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1874 /* Attempts to retrieve another port from 'dump', which must have been created
1875 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1876 * 'port' and returns true. On failure, returns false.
1878 * Failure might indicate an actual error or merely that the last port has been
1879 * dumped. An error status for the entire dump operation is provided when it
1880 * is completed by calling ofproto_port_dump_done().
1882 * The ofproto owns the data stored in 'port'. It will remain valid until at
1883 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1884 * ofproto_port_dump_done(). */
1886 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1887 struct ofproto_port *port)
1889 const struct ofproto *ofproto = dump->ofproto;
1895 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1898 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1904 /* Completes port table dump operation 'dump', which must have been created
1905 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1906 * error-free, otherwise a positive errno value describing the problem. */
1908 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1910 const struct ofproto *ofproto = dump->ofproto;
1912 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1915 return dump->error == EOF ? 0 : dump->error;
1918 /* Returns the type to pass to netdev_open() when a datapath of type
1919 * 'datapath_type' has a port of type 'port_type', for a few special
1920 * cases when a netdev type differs from a port type. For example, when
1921 * using the userspace datapath, a port of type "internal" needs to be
1924 * Returns either 'type' itself or a string literal, which must not be
1927 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1929 const struct ofproto_class *class;
1931 datapath_type = ofproto_normalize_type(datapath_type);
1932 class = ofproto_class_find__(datapath_type);
1937 return (class->port_open_type
1938 ? class->port_open_type(datapath_type, port_type)
1942 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1943 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1944 * the port's OpenFlow port number.
1946 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1947 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1948 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1949 * 'ofp_portp' is non-null). */
1951 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1952 ofp_port_t *ofp_portp)
1954 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1957 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1959 const char *netdev_name = netdev_get_name(netdev);
1961 simap_put(&ofproto->ofp_requests, netdev_name,
1962 ofp_to_u16(ofp_port));
1963 update_port(ofproto, netdev_name);
1966 *ofp_portp = OFPP_NONE;
1968 struct ofproto_port ofproto_port;
1970 error = ofproto_port_query_by_name(ofproto,
1971 netdev_get_name(netdev),
1974 *ofp_portp = ofproto_port.ofp_port;
1975 ofproto_port_destroy(&ofproto_port);
1982 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1983 * initializes '*port' appropriately; on failure, returns a positive errno
1986 * The caller owns the data in 'ofproto_port' and must free it with
1987 * ofproto_port_destroy() when it is no longer needed. */
1989 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1990 struct ofproto_port *port)
1994 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1996 memset(port, 0, sizeof *port);
2001 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
2002 * Returns 0 if successful, otherwise a positive errno. */
2004 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
2006 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2007 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
2008 struct simap_node *ofp_request_node;
2011 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
2012 if (ofp_request_node) {
2013 simap_delete(&ofproto->ofp_requests, ofp_request_node);
2016 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
2017 if (!error && ofport) {
2018 /* 'name' is the netdev's name and update_port() is going to close the
2019 * netdev. Just in case update_port() refers to 'name' after it
2020 * destroys 'ofport', make a copy of it around the update_port()
2022 char *devname = xstrdup(name);
2023 update_port(ofproto, devname);
2030 flow_mod_init(struct ofputil_flow_mod *fm,
2031 const struct match *match, int priority,
2032 const struct ofpact *ofpacts, size_t ofpacts_len,
2033 enum ofp_flow_mod_command command)
2035 memset(fm, 0, sizeof *fm);
2037 fm->priority = priority;
2040 fm->modify_cookie = false;
2042 fm->command = command;
2043 fm->idle_timeout = 0;
2044 fm->hard_timeout = 0;
2046 fm->buffer_id = UINT32_MAX;
2047 fm->out_port = OFPP_ANY;
2048 fm->out_group = OFPG_ANY;
2050 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2051 fm->ofpacts_len = ofpacts_len;
2052 fm->delete_reason = OFPRR_DELETE;
2056 simple_flow_mod(struct ofproto *ofproto,
2057 const struct match *match, int priority,
2058 const struct ofpact *ofpacts, size_t ofpacts_len,
2059 enum ofp_flow_mod_command command)
2061 struct ofproto_flow_mod ofm;
2063 flow_mod_init(&ofm.fm, match, priority, ofpacts, ofpacts_len, command);
2065 return handle_flow_mod__(ofproto, &ofm, NULL);
2068 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2069 * performs the 'n_actions' actions in 'actions'. The new flow will not
2072 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2073 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2074 * controllers; otherwise, it will be hidden.
2076 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2078 * This is a helper function for in-band control and fail-open. */
2080 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2082 const struct ofpact *ofpacts, size_t ofpacts_len)
2083 OVS_EXCLUDED(ofproto_mutex)
2085 const struct rule *rule;
2088 /* First do a cheap check whether the rule we're looking for already exists
2089 * with the actions that we want. If it does, then we're done. */
2090 rule = rule_from_cls_rule(classifier_find_match_exactly(
2091 &ofproto->tables[0].cls, match, priority,
2094 const struct rule_actions *actions = rule_get_actions(rule);
2095 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2096 ofpacts, ofpacts_len);
2101 /* If there's no such rule or the rule doesn't have the actions we want,
2102 * fall back to a executing a full flow mod. We can't optimize this at
2103 * all because we didn't take enough locks above to ensure that the flow
2104 * table didn't already change beneath us. */
2106 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2107 OFPFC_MODIFY_STRICT);
2111 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2112 * an OFPERR_* OpenFlow error code on failure.
2114 * This is a helper function for in-band control and fail-open and the "learn"
2117 ofproto_flow_mod(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
2118 OVS_EXCLUDED(ofproto_mutex)
2120 struct ofputil_flow_mod *fm = &ofm->fm;
2122 /* Optimize for the most common case of a repeated learn action.
2123 * If an identical flow already exists we only need to update its
2124 * 'modified' time. */
2125 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2126 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2127 struct oftable *table = &ofproto->tables[fm->table_id];
2131 rule = rule_from_cls_rule(classifier_find_match_exactly(
2132 &table->cls, &fm->match, fm->priority,
2135 /* Reading many of the rule fields and writing on 'modified'
2136 * requires the rule->mutex. Also, rule->actions may change
2137 * if rule->mutex is not held. */
2138 const struct rule_actions *actions;
2140 ovs_mutex_lock(&rule->mutex);
2141 actions = rule_get_actions(rule);
2142 if (rule->idle_timeout == fm->idle_timeout
2143 && rule->hard_timeout == fm->hard_timeout
2144 && rule->importance == fm->importance
2145 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2146 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2147 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2148 actions->ofpacts, actions->ofpacts_len)) {
2149 /* Rule already exists and need not change, only update the
2150 modified timestamp. */
2151 rule->modified = time_msec();
2154 ovs_mutex_unlock(&rule->mutex);
2162 return handle_flow_mod__(ofproto, ofm, NULL);
2165 /* Searches for a rule with matching criteria exactly equal to 'target' in
2166 * ofproto's table 0 and, if it finds one, deletes it.
2168 * This is a helper function for in-band control and fail-open. */
2170 ofproto_delete_flow(struct ofproto *ofproto,
2171 const struct match *target, int priority)
2172 OVS_EXCLUDED(ofproto_mutex)
2174 struct classifier *cls = &ofproto->tables[0].cls;
2177 /* First do a cheap check whether the rule we're looking for has already
2178 * been deleted. If so, then we're done. */
2179 rule = rule_from_cls_rule(classifier_find_match_exactly(
2180 cls, target, priority, CLS_MAX_VERSION));
2185 /* Execute a flow mod. We can't optimize this at all because we didn't
2186 * take enough locks above to ensure that the flow table didn't already
2187 * change beneath us. */
2188 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2191 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2192 * the flows required by in-band control and fail-open. */
2194 ofproto_flush_flows(struct ofproto *ofproto)
2196 COVERAGE_INC(ofproto_flush);
2197 ofproto_flush__(ofproto);
2198 connmgr_flushed(ofproto->connmgr);
2202 reinit_ports(struct ofproto *p)
2204 struct ofproto_port_dump dump;
2205 struct sset devnames;
2206 struct ofport *ofport;
2207 struct ofproto_port ofproto_port;
2208 const char *devname;
2210 COVERAGE_INC(ofproto_reinit_ports);
2212 sset_init(&devnames);
2213 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2214 sset_add(&devnames, netdev_get_name(ofport->netdev));
2216 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2217 sset_add(&devnames, ofproto_port.name);
2220 SSET_FOR_EACH (devname, &devnames) {
2221 update_port(p, devname);
2223 sset_destroy(&devnames);
2227 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2231 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2232 port_idx = port_idx ? port_idx : UINT16_MAX;
2234 if (port_idx >= ofproto->max_ports
2235 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2236 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2237 long long int last_used_at, lru = LLONG_MAX;
2239 /* Search for a free OpenFlow port number. We try not to
2240 * immediately reuse them to prevent problems due to old
2243 * We limit the automatically assigned port numbers to the lower half
2244 * of the port range, to reserve the upper half for assignment by
2247 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2248 ofproto->alloc_port_no = 1;
2250 last_used_at = ofport_get_usage(ofproto,
2251 u16_to_ofp(ofproto->alloc_port_no));
2252 if (!last_used_at) {
2253 port_idx = ofproto->alloc_port_no;
2255 } else if ( last_used_at < time_msec() - 60*60*1000) {
2256 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2257 * more than an hour ago, consider it usable. */
2258 ofport_remove_usage(ofproto,
2259 u16_to_ofp(ofproto->alloc_port_no));
2260 port_idx = ofproto->alloc_port_no;
2262 } else if (last_used_at < lru) {
2264 lru_ofport = ofproto->alloc_port_no;
2267 if (ofproto->alloc_port_no == end_port_no) {
2269 port_idx = lru_ofport;
2276 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2277 return u16_to_ofp(port_idx);
2281 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2283 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2284 ofport_set_usage(ofproto, ofp_port, time_msec());
2288 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2289 * pointer if the netdev cannot be opened. On success, also fills in
2291 static struct netdev *
2292 ofport_open(struct ofproto *ofproto,
2293 struct ofproto_port *ofproto_port,
2294 struct ofputil_phy_port *pp)
2296 enum netdev_flags flags;
2297 struct netdev *netdev;
2300 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2302 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2303 "cannot be opened (%s)",
2305 ofproto_port->name, ofproto_port->ofp_port,
2306 ofproto_port->name, ovs_strerror(error));
2310 if (ofproto_port->ofp_port == OFPP_NONE) {
2311 if (!strcmp(ofproto->name, ofproto_port->name)) {
2312 ofproto_port->ofp_port = OFPP_LOCAL;
2314 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2315 ofproto_port->name);
2318 pp->port_no = ofproto_port->ofp_port;
2319 netdev_get_etheraddr(netdev, pp->hw_addr);
2320 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2321 netdev_get_flags(netdev, &flags);
2322 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2323 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2324 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2325 &pp->supported, &pp->peer);
2326 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2327 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2332 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2333 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2336 ofport_equal(const struct ofputil_phy_port *a,
2337 const struct ofputil_phy_port *b)
2339 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2340 && a->state == b->state
2341 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2342 && a->curr == b->curr
2343 && a->advertised == b->advertised
2344 && a->supported == b->supported
2345 && a->peer == b->peer
2346 && a->curr_speed == b->curr_speed
2347 && a->max_speed == b->max_speed);
2350 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2351 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2352 * one with the same name or port number). */
2354 ofport_install(struct ofproto *p,
2355 struct netdev *netdev, const struct ofputil_phy_port *pp)
2357 const char *netdev_name = netdev_get_name(netdev);
2358 struct ofport *ofport;
2361 /* Create ofport. */
2362 ofport = p->ofproto_class->port_alloc();
2367 ofport->ofproto = p;
2368 ofport->netdev = netdev;
2369 ofport->change_seq = netdev_get_change_seq(netdev);
2371 ofport->ofp_port = pp->port_no;
2372 ofport->created = time_msec();
2374 /* Add port to 'p'. */
2375 hmap_insert(&p->ports, &ofport->hmap_node,
2376 hash_ofp_port(ofport->ofp_port));
2377 shash_add(&p->port_by_name, netdev_name, ofport);
2379 update_mtu(p, ofport);
2381 /* Let the ofproto_class initialize its private data. */
2382 error = p->ofproto_class->port_construct(ofport);
2386 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2390 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2391 p->name, netdev_name, ovs_strerror(error));
2393 ofport_destroy__(ofport);
2395 netdev_close(netdev);
2399 /* Removes 'ofport' from 'p' and destroys it. */
2401 ofport_remove(struct ofport *ofport)
2403 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2405 ofport_destroy(ofport);
2408 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2411 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2413 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2415 ofport_remove(port);
2419 /* Updates 'port' with new 'pp' description.
2421 * Does not handle a name or port number change. The caller must implement
2422 * such a change as a delete followed by an add. */
2424 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2426 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2427 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2428 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2429 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2430 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2431 port->pp.curr = pp->curr;
2432 port->pp.advertised = pp->advertised;
2433 port->pp.supported = pp->supported;
2434 port->pp.peer = pp->peer;
2435 port->pp.curr_speed = pp->curr_speed;
2436 port->pp.max_speed = pp->max_speed;
2438 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2439 &port->pp, OFPPR_MODIFY);
2442 /* Update OpenFlow 'state' in 'port' and notify controller. */
2444 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2446 if (port->pp.state != state) {
2447 port->pp.state = state;
2448 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2449 &port->pp, OFPPR_MODIFY);
2454 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2456 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2458 if (port->ofproto->ofproto_class->set_realdev) {
2459 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2461 if (port->ofproto->ofproto_class->set_stp_port) {
2462 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2464 if (port->ofproto->ofproto_class->set_rstp_port) {
2465 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2467 if (port->ofproto->ofproto_class->set_cfm) {
2468 port->ofproto->ofproto_class->set_cfm(port, NULL);
2470 if (port->ofproto->ofproto_class->bundle_remove) {
2471 port->ofproto->ofproto_class->bundle_remove(port);
2477 ofport_destroy__(struct ofport *port)
2479 struct ofproto *ofproto = port->ofproto;
2480 const char *name = netdev_get_name(port->netdev);
2482 hmap_remove(&ofproto->ports, &port->hmap_node);
2483 shash_delete(&ofproto->port_by_name,
2484 shash_find(&ofproto->port_by_name, name));
2486 netdev_close(port->netdev);
2487 ofproto->ofproto_class->port_dealloc(port);
2491 ofport_destroy(struct ofport *port)
2494 dealloc_ofp_port(port->ofproto, port->ofp_port);
2495 port->ofproto->ofproto_class->port_destruct(port);
2496 ofport_destroy__(port);
2501 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2503 struct ofport *port;
2505 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2507 if (port->ofp_port == ofp_port) {
2514 static long long int
2515 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2517 struct ofport_usage *usage;
2519 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2520 &ofproto->ofport_usage) {
2521 if (usage->ofp_port == ofp_port) {
2522 return usage->last_used;
2529 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2530 long long int last_used)
2532 struct ofport_usage *usage;
2533 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2534 &ofproto->ofport_usage) {
2535 if (usage->ofp_port == ofp_port) {
2536 usage->last_used = last_used;
2540 ovs_assert(last_used == LLONG_MAX);
2542 usage = xmalloc(sizeof *usage);
2543 usage->ofp_port = ofp_port;
2544 usage->last_used = last_used;
2545 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2546 hash_ofp_port(ofp_port));
2550 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2552 struct ofport_usage *usage;
2553 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2554 &ofproto->ofport_usage) {
2555 if (usage->ofp_port == ofp_port) {
2556 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2564 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2566 struct ofproto *ofproto = port->ofproto;
2569 if (ofproto->ofproto_class->port_get_stats) {
2570 error = ofproto->ofproto_class->port_get_stats(port, stats);
2579 update_port(struct ofproto *ofproto, const char *name)
2581 struct ofproto_port ofproto_port;
2582 struct ofputil_phy_port pp;
2583 struct netdev *netdev;
2584 struct ofport *port;
2586 COVERAGE_INC(ofproto_update_port);
2588 /* Fetch 'name''s location and properties from the datapath. */
2589 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2590 ? ofport_open(ofproto, &ofproto_port, &pp)
2594 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2595 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2596 struct netdev *old_netdev = port->netdev;
2598 /* 'name' hasn't changed location. Any properties changed? */
2599 if (!ofport_equal(&port->pp, &pp)) {
2600 ofport_modified(port, &pp);
2603 update_mtu(ofproto, port);
2605 /* Install the newly opened netdev in case it has changed.
2606 * Don't close the old netdev yet in case port_modified has to
2607 * remove a retained reference to it.*/
2608 port->netdev = netdev;
2609 port->change_seq = netdev_get_change_seq(netdev);
2611 if (port->ofproto->ofproto_class->port_modified) {
2612 port->ofproto->ofproto_class->port_modified(port);
2615 netdev_close(old_netdev);
2617 /* If 'port' is nonnull then its name differs from 'name' and thus
2618 * we should delete it. If we think there's a port named 'name'
2619 * then its port number must be wrong now so delete it too. */
2621 ofport_remove(port);
2623 ofport_remove_with_name(ofproto, name);
2624 ofport_install(ofproto, netdev, &pp);
2627 /* Any port named 'name' is gone now. */
2628 ofport_remove_with_name(ofproto, name);
2630 ofproto_port_destroy(&ofproto_port);
2634 init_ports(struct ofproto *p)
2636 struct ofproto_port_dump dump;
2637 struct ofproto_port ofproto_port;
2638 struct shash_node *node, *next;
2640 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2641 const char *name = ofproto_port.name;
2643 if (shash_find(&p->port_by_name, name)) {
2644 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2647 struct ofputil_phy_port pp;
2648 struct netdev *netdev;
2650 /* Check if an OpenFlow port number had been requested. */
2651 node = shash_find(&init_ofp_ports, name);
2653 const struct iface_hint *iface_hint = node->data;
2654 simap_put(&p->ofp_requests, name,
2655 ofp_to_u16(iface_hint->ofp_port));
2658 netdev = ofport_open(p, &ofproto_port, &pp);
2660 ofport_install(p, netdev, &pp);
2661 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2662 p->alloc_port_no = MAX(p->alloc_port_no,
2663 ofp_to_u16(ofproto_port.ofp_port));
2669 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2670 struct iface_hint *iface_hint = node->data;
2672 if (!strcmp(iface_hint->br_name, p->name)) {
2673 free(iface_hint->br_name);
2674 free(iface_hint->br_type);
2676 shash_delete(&init_ofp_ports, node);
2683 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2684 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2686 find_min_mtu(struct ofproto *p)
2688 struct ofport *ofport;
2691 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2692 struct netdev *netdev = ofport->netdev;
2695 /* Skip any internal ports, since that's what we're trying to
2697 if (!strcmp(netdev_get_type(netdev), "internal")) {
2701 if (netdev_get_mtu(netdev, &dev_mtu)) {
2704 if (!mtu || dev_mtu < mtu) {
2709 return mtu ? mtu: ETH_PAYLOAD_MAX;
2712 /* Update MTU of all datapath devices on 'p' to the minimum of the
2713 * non-datapath ports in event of 'port' added or changed. */
2715 update_mtu(struct ofproto *p, struct ofport *port)
2717 struct ofport *ofport;
2718 struct netdev *netdev = port->netdev;
2719 int dev_mtu, old_min;
2721 if (netdev_get_mtu(netdev, &dev_mtu)) {
2725 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2726 if (dev_mtu > p->min_mtu) {
2727 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2728 dev_mtu = p->min_mtu;
2731 port->mtu = dev_mtu;
2735 /* For non-internal port find new min mtu. */
2736 old_min = p->min_mtu;
2737 port->mtu = dev_mtu;
2738 p->min_mtu = find_min_mtu(p);
2739 if (p->min_mtu == old_min) {
2743 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2744 struct netdev *netdev = ofport->netdev;
2746 if (!strcmp(netdev_get_type(netdev), "internal")) {
2747 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2748 ofport->mtu = p->min_mtu;
2755 ofproto_rule_destroy__(struct rule *rule)
2756 OVS_NO_THREAD_SAFETY_ANALYSIS
2758 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2759 rule_actions_destroy(rule_get_actions(rule));
2760 ovs_mutex_destroy(&rule->mutex);
2761 rule->ofproto->ofproto_class->rule_dealloc(rule);
2765 rule_destroy_cb(struct rule *rule)
2766 OVS_NO_THREAD_SAFETY_ANALYSIS
2768 /* Send rule removed if needed. */
2769 if (rule->flags & OFPUTIL_FF_SEND_FLOW_REM
2770 && rule->removed_reason != OVS_OFPRR_NONE
2771 && !rule_is_hidden(rule)) {
2772 ofproto_rule_send_removed(rule);
2774 rule->ofproto->ofproto_class->rule_destruct(rule);
2775 ofproto_rule_destroy__(rule);
2779 ofproto_rule_ref(struct rule *rule)
2782 ovs_refcount_ref(&rule->ref_count);
2787 ofproto_rule_try_ref(struct rule *rule)
2790 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2795 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2796 * ref_count reaches 0.
2798 * Use of RCU allows short term use (between RCU quiescent periods) without
2799 * keeping a reference. A reference must be taken if the rule needs to
2800 * stay around accross the RCU quiescent periods. */
2802 ofproto_rule_unref(struct rule *rule)
2804 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2805 ovsrcu_postpone(rule_destroy_cb, rule);
2810 remove_rule_rcu__(struct rule *rule)
2811 OVS_REQUIRES(ofproto_mutex)
2813 struct ofproto *ofproto = rule->ofproto;
2814 struct oftable *table = &ofproto->tables[rule->table_id];
2816 ovs_assert(!cls_rule_visible_in_version(&rule->cr, CLS_MAX_VERSION));
2817 if (!classifier_remove(&table->cls, &rule->cr)) {
2820 ofproto->ofproto_class->rule_delete(rule);
2821 ofproto_rule_unref(rule);
2825 remove_rule_rcu(struct rule *rule)
2826 OVS_EXCLUDED(ofproto_mutex)
2828 ovs_mutex_lock(&ofproto_mutex);
2829 remove_rule_rcu__(rule);
2830 ovs_mutex_unlock(&ofproto_mutex);
2833 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2835 remove_rules_rcu(struct rule **rules)
2836 OVS_EXCLUDED(ofproto_mutex)
2838 struct rule **orig_rules = rules;
2841 struct ofproto *ofproto = rules[0]->ofproto;
2842 unsigned long tables[BITMAP_N_LONGS(256)];
2846 memset(tables, 0, sizeof tables);
2848 ovs_mutex_lock(&ofproto_mutex);
2849 while ((rule = *rules++)) {
2850 /* Defer once for each new table. This defers the subtable cleanup
2851 * until later, so that when removing large number of flows the
2852 * operation is faster. */
2853 if (!bitmap_is_set(tables, rule->table_id)) {
2854 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
2856 bitmap_set1(tables, rule->table_id);
2857 classifier_defer(cls);
2859 remove_rule_rcu__(rule);
2862 BITMAP_FOR_EACH_1(table_id, 256, tables) {
2863 struct classifier *cls = &ofproto->tables[table_id].cls;
2865 classifier_publish(cls);
2867 ovs_mutex_unlock(&ofproto_mutex);
2874 ofproto_group_ref(struct ofgroup *group)
2877 ovs_refcount_ref(&group->ref_count);
2882 ofproto_group_unref(struct ofgroup *group)
2884 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2885 group->ofproto->ofproto_class->group_destruct(group);
2886 ofputil_bucket_list_destroy(&group->buckets);
2887 group->ofproto->ofproto_class->group_dealloc(group);
2891 static uint32_t get_provider_meter_id(const struct ofproto *,
2892 uint32_t of_meter_id);
2894 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2895 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2896 const struct rule_actions *
2897 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2899 struct rule_actions *actions;
2901 actions = xmalloc(sizeof *actions + ofpacts_len);
2902 actions->ofpacts_len = ofpacts_len;
2903 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2904 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2906 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2912 /* Free the actions after the RCU quiescent period is reached. */
2914 rule_actions_destroy(const struct rule_actions *actions)
2917 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2921 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2922 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2924 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2925 OVS_REQUIRES(ofproto_mutex)
2927 if (port == OFPP_ANY) {
2930 const struct rule_actions *actions = rule_get_actions(rule);
2931 return ofpacts_output_to_port(actions->ofpacts,
2932 actions->ofpacts_len, port);
2936 /* Returns true if 'rule' has group and equals group_id. */
2938 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2939 OVS_REQUIRES(ofproto_mutex)
2941 if (group_id == OFPG_ANY) {
2944 const struct rule_actions *actions = rule_get_actions(rule);
2945 return ofpacts_output_to_group(actions->ofpacts,
2946 actions->ofpacts_len, group_id);
2951 rule_execute_destroy(struct rule_execute *e)
2953 ofproto_rule_unref(e->rule);
2954 list_remove(&e->list_node);
2958 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2959 * by passing them to the ofproto provider. */
2961 run_rule_executes(struct ofproto *ofproto)
2962 OVS_EXCLUDED(ofproto_mutex)
2964 struct rule_execute *e, *next;
2965 struct ovs_list executes;
2967 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2968 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2971 flow_extract(e->packet, &flow);
2972 flow.in_port.ofp_port = e->in_port;
2973 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2975 rule_execute_destroy(e);
2979 /* Destroys and discards all "rule_execute" operations queued up in
2980 * ofproto->rule_executes. */
2982 destroy_rule_executes(struct ofproto *ofproto)
2984 struct rule_execute *e, *next;
2985 struct ovs_list executes;
2987 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2988 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2989 dp_packet_delete(e->packet);
2990 rule_execute_destroy(e);
2995 rule_is_readonly(const struct rule *rule)
2997 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2998 return (table->flags & OFTABLE_READONLY) != 0;
3002 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
3004 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
3005 return hash_3words(cookie, cookie >> 32, table_id);
3009 learned_cookies_update_one__(struct ofproto *ofproto,
3010 const struct ofpact_learn *learn,
3011 int delta, struct ovs_list *dead_cookies)
3012 OVS_REQUIRES(ofproto_mutex)
3014 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
3015 struct learned_cookie *c;
3017 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
3018 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
3020 ovs_assert(c->n >= 0);
3023 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
3024 list_push_back(dead_cookies, &c->u.list_node);
3031 ovs_assert(delta > 0);
3032 c = xmalloc(sizeof *c);
3033 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
3034 c->cookie = learn->cookie;
3035 c->table_id = learn->table_id;
3039 static const struct ofpact_learn *
3040 next_learn_with_delete(const struct rule_actions *actions,
3041 const struct ofpact_learn *start)
3043 const struct ofpact *pos;
3045 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
3046 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
3047 pos = ofpact_next(pos)) {
3048 if (pos->type == OFPACT_LEARN) {
3049 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
3050 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3060 learned_cookies_update__(struct ofproto *ofproto,
3061 const struct rule_actions *actions,
3062 int delta, struct ovs_list *dead_cookies)
3063 OVS_REQUIRES(ofproto_mutex)
3065 if (actions->has_learn_with_delete) {
3066 const struct ofpact_learn *learn;
3068 for (learn = next_learn_with_delete(actions, NULL); learn;
3069 learn = next_learn_with_delete(actions, learn)) {
3070 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3076 learned_cookies_inc(struct ofproto *ofproto,
3077 const struct rule_actions *actions)
3078 OVS_REQUIRES(ofproto_mutex)
3080 learned_cookies_update__(ofproto, actions, +1, NULL);
3084 learned_cookies_dec(struct ofproto *ofproto,
3085 const struct rule_actions *actions,
3086 struct ovs_list *dead_cookies)
3087 OVS_REQUIRES(ofproto_mutex)
3089 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3093 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3094 OVS_REQUIRES(ofproto_mutex)
3096 struct learned_cookie *c;
3098 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3099 struct rule_criteria criteria;
3100 struct rule_collection rules;
3103 match_init_catchall(&match);
3104 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3105 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3106 rule_criteria_require_rw(&criteria, false);
3107 collect_rules_loose(ofproto, &criteria, &rules);
3108 rule_criteria_destroy(&criteria);
3109 delete_flows__(&rules, OFPRR_DELETE, NULL);
3116 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3118 ofconn_send_reply(ofconn, make_echo_reply(oh));
3123 query_tables(struct ofproto *ofproto,
3124 struct ofputil_table_features **featuresp,
3125 struct ofputil_table_stats **statsp)
3127 struct mf_bitmap rw_fields = oxm_writable_fields();
3128 struct mf_bitmap match = oxm_matchable_fields();
3129 struct mf_bitmap mask = oxm_maskable_fields();
3131 struct ofputil_table_features *features;
3132 struct ofputil_table_stats *stats;
3135 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3136 for (i = 0; i < ofproto->n_tables; i++) {
3137 struct ofputil_table_features *f = &features[i];
3140 sprintf(f->name, "table%d", i);
3141 f->metadata_match = OVS_BE64_MAX;
3142 f->metadata_write = OVS_BE64_MAX;
3143 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3144 f->max_entries = 1000000;
3146 bool more_tables = false;
3147 for (int j = i + 1; j < ofproto->n_tables; j++) {
3148 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3149 bitmap_set1(f->nonmiss.next, j);
3153 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3155 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3157 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3158 f->nonmiss.write.set_fields = rw_fields;
3159 f->nonmiss.apply = f->nonmiss.write;
3160 f->miss = f->nonmiss;
3164 f->wildcard = match;
3168 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3169 for (i = 0; i < ofproto->n_tables; i++) {
3170 struct ofputil_table_stats *s = &stats[i];
3173 s->active_count = ofproto->tables[i].n_flows;
3175 s->active_count -= connmgr_count_hidden_rules(
3183 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3185 for (i = 0; i < ofproto->n_tables; i++) {
3186 const struct oftable *table = &ofproto->tables[i];
3187 struct ofputil_table_features *f = &features[i];
3190 ovs_strzcpy(f->name, table->name, sizeof f->name);
3193 if (table->max_flows < f->max_entries) {
3194 f->max_entries = table->max_flows;
3200 query_switch_features(struct ofproto *ofproto,
3201 bool *arp_match_ip, uint64_t *ofpacts)
3203 struct ofputil_table_features *features, *f;
3205 *arp_match_ip = false;
3208 query_tables(ofproto, &features, NULL);
3209 for (f = features; f < &features[ofproto->n_tables]; f++) {
3210 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3211 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3212 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3213 *arp_match_ip = true;
3219 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3223 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3225 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3226 struct ofputil_switch_features features;
3227 struct ofport *port;
3231 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3233 features.datapath_id = ofproto->datapath_id;
3234 features.n_buffers = pktbuf_capacity();
3235 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3236 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3237 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3238 OFPUTIL_C_GROUP_STATS);
3240 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3242 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3243 features.auxiliary_id = 0;
3244 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3246 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3247 ofputil_put_switch_features_port(&port->pp, b);
3250 ofconn_send_reply(ofconn, b);
3255 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3257 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3258 struct ofp_switch_config *osc;
3259 enum ofp_config_flags flags;
3263 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3264 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3265 flags = ofproto->frag_handling;
3266 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3267 if (oh->version < OFP13_VERSION
3268 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3269 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3271 osc->flags = htons(flags);
3272 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3273 ofconn_send_reply(ofconn, buf);
3279 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3281 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3282 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3283 uint16_t flags = ntohs(osc->flags);
3285 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3286 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3287 enum ofp_config_flags cur = ofproto->frag_handling;
3288 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3290 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3292 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3293 ofproto->frag_handling = next;
3295 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3297 ofputil_frag_handling_to_string(next));
3301 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3302 ofconn_set_invalid_ttl_to_controller(ofconn,
3303 (oh->version < OFP13_VERSION
3304 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3306 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3311 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3312 * error message code for the caller to propagate upward. Otherwise, returns
3315 * The log message mentions 'msg_type'. */
3317 reject_slave_controller(struct ofconn *ofconn)
3319 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3320 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3321 return OFPERR_OFPBRC_IS_SLAVE;
3327 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3330 * - If they use a meter, then 'ofproto' has that meter configured.
3332 * - If they use any groups, then 'ofproto' has that group configured.
3334 * Returns 0 if successful, otherwise an OpenFlow error. */
3336 ofproto_check_ofpacts(struct ofproto *ofproto,
3337 const struct ofpact ofpacts[], size_t ofpacts_len)
3339 const struct ofpact *a;
3342 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3343 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3344 return OFPERR_OFPMMFC_INVALID_METER;
3347 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3348 if (a->type == OFPACT_GROUP
3349 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3350 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3358 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3360 struct ofproto *p = ofconn_get_ofproto(ofconn);
3361 struct ofputil_packet_out po;
3362 struct dp_packet *payload;
3363 uint64_t ofpacts_stub[1024 / 8];
3364 struct ofpbuf ofpacts;
3368 COVERAGE_INC(ofproto_packet_out);
3370 error = reject_slave_controller(ofconn);
3375 /* Decode message. */
3376 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3377 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3379 goto exit_free_ofpacts;
3381 if (ofp_to_u16(po.in_port) >= p->max_ports
3382 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3383 error = OFPERR_OFPBRC_BAD_PORT;
3384 goto exit_free_ofpacts;
3388 if (po.buffer_id != UINT32_MAX) {
3389 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3390 if (error || !payload) {
3391 goto exit_free_ofpacts;
3394 /* Ensure that the L3 header is 32-bit aligned. */
3395 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3398 /* Verify actions against packet, then send packet if successful. */
3399 flow_extract(payload, &flow);
3400 flow.in_port.ofp_port = po.in_port;
3401 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3403 error = p->ofproto_class->packet_out(p, payload, &flow,
3404 po.ofpacts, po.ofpacts_len);
3406 dp_packet_delete(payload);
3409 ofpbuf_uninit(&ofpacts);
3415 update_port_config(struct ofconn *ofconn, struct ofport *port,
3416 enum ofputil_port_config config,
3417 enum ofputil_port_config mask)
3419 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3421 if (toggle & OFPUTIL_PC_PORT_DOWN
3422 && (config & OFPUTIL_PC_PORT_DOWN
3423 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3424 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3425 /* We tried to bring the port up or down, but it failed, so don't
3426 * update the "down" bit. */
3427 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3431 enum ofputil_port_config old_config = port->pp.config;
3432 port->pp.config ^= toggle;
3433 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3434 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3440 port_mod_start(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3441 struct ofport **port)
3443 struct ofproto *p = ofconn_get_ofproto(ofconn);
3445 *port = ofproto_get_port(p, pm->port_no);
3447 return OFPERR_OFPPMFC_BAD_PORT;
3449 if (!eth_addr_equals((*port)->pp.hw_addr, pm->hw_addr)) {
3450 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3456 port_mod_finish(struct ofconn *ofconn, struct ofputil_port_mod *pm,
3457 struct ofport *port)
3459 update_port_config(ofconn, port, pm->config, pm->mask);
3460 if (pm->advertise) {
3461 netdev_set_advertisements(port->netdev, pm->advertise);
3466 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3468 struct ofputil_port_mod pm;
3469 struct ofport *port;
3472 error = reject_slave_controller(ofconn);
3477 error = ofputil_decode_port_mod(oh, &pm, false);
3482 error = port_mod_start(ofconn, &pm, &port);
3484 port_mod_finish(ofconn, &pm, port);
3490 handle_desc_stats_request(struct ofconn *ofconn,
3491 const struct ofp_header *request)
3493 static const char *default_mfr_desc = "Nicira, Inc.";
3494 static const char *default_hw_desc = "Open vSwitch";
3495 static const char *default_sw_desc = VERSION;
3496 static const char *default_serial_desc = "None";
3497 static const char *default_dp_desc = "None";
3499 struct ofproto *p = ofconn_get_ofproto(ofconn);
3500 struct ofp_desc_stats *ods;
3503 msg = ofpraw_alloc_stats_reply(request, 0);
3504 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3505 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3506 sizeof ods->mfr_desc);
3507 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3508 sizeof ods->hw_desc);
3509 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3510 sizeof ods->sw_desc);
3511 ovs_strlcpy(ods->serial_num,
3512 p->serial_desc ? p->serial_desc : default_serial_desc,
3513 sizeof ods->serial_num);
3514 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3515 sizeof ods->dp_desc);
3516 ofconn_send_reply(ofconn, msg);
3522 handle_table_stats_request(struct ofconn *ofconn,
3523 const struct ofp_header *request)
3525 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3526 struct ofputil_table_features *features;
3527 struct ofputil_table_stats *stats;
3528 struct ofpbuf *reply;
3531 query_tables(ofproto, &features, &stats);
3533 reply = ofputil_encode_table_stats_reply(request);
3534 for (i = 0; i < ofproto->n_tables; i++) {
3535 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3536 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3539 ofconn_send_reply(ofconn, reply);
3548 handle_table_features_request(struct ofconn *ofconn,
3549 const struct ofp_header *request)
3551 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3552 struct ofputil_table_features *features;
3553 struct ovs_list replies;
3557 ofpbuf_use_const(&msg, request, ntohs(request->length));
3558 ofpraw_pull_assert(&msg);
3559 if (msg.size || ofpmp_more(request)) {
3560 return OFPERR_OFPTFFC_EPERM;
3563 query_tables(ofproto, &features, NULL);
3565 ofpmp_init(&replies, request);
3566 for (i = 0; i < ofproto->n_tables; i++) {
3567 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3568 ofputil_append_table_features_reply(&features[i], &replies);
3571 ofconn_send_replies(ofconn, &replies);
3578 /* This function queries the database for dumping table-desc. */
3580 query_tables_desc(struct ofproto *ofproto, struct ofputil_table_desc **descp)
3582 struct ofputil_table_desc *table_desc;
3585 table_desc = *descp = xcalloc(ofproto->n_tables, sizeof *table_desc);
3586 for (i = 0; i < ofproto->n_tables; i++) {
3587 struct ofputil_table_desc *td = &table_desc[i];
3589 td->eviction = (ofproto->tables[i].eviction & EVICTION_OPENFLOW
3590 ? OFPUTIL_TABLE_EVICTION_ON
3591 : OFPUTIL_TABLE_EVICTION_OFF);
3592 td->eviction_flags = OFPROTO_EVICTION_FLAGS;
3596 /* Function to handle dump-table-desc request. */
3598 handle_table_desc_request(struct ofconn *ofconn,
3599 const struct ofp_header *request)
3601 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3602 struct ofputil_table_desc *table_desc;
3603 struct ovs_list replies;
3606 query_tables_desc(ofproto, &table_desc);
3607 ofpmp_init(&replies, request);
3608 for (i = 0; i < ofproto->n_tables; i++) {
3609 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3610 ofputil_append_table_desc_reply(&table_desc[i], &replies,
3614 ofconn_send_replies(ofconn, &replies);
3620 append_port_stat(struct ofport *port, struct ovs_list *replies)
3622 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3624 calc_duration(port->created, time_msec(),
3625 &ops.duration_sec, &ops.duration_nsec);
3627 /* Intentionally ignore return value, since errors will set
3628 * 'stats' to all-1s, which is correct for OpenFlow, and
3629 * netdev_get_stats() will log errors. */
3630 ofproto_port_get_stats(port, &ops.stats);
3632 ofputil_append_port_stat(replies, &ops);
3636 handle_port_request(struct ofconn *ofconn,
3637 const struct ofp_header *request, ofp_port_t port_no,
3638 void (*cb)(struct ofport *, struct ovs_list *replies))
3640 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3641 struct ofport *port;
3642 struct ovs_list replies;
3644 ofpmp_init(&replies, request);
3645 if (port_no != OFPP_ANY) {
3646 port = ofproto_get_port(ofproto, port_no);
3651 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3656 ofconn_send_replies(ofconn, &replies);
3660 handle_port_stats_request(struct ofconn *ofconn,
3661 const struct ofp_header *request)
3666 error = ofputil_decode_port_stats_request(request, &port_no);
3668 handle_port_request(ofconn, request, port_no, append_port_stat);
3674 append_port_desc(struct ofport *port, struct ovs_list *replies)
3676 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3680 handle_port_desc_stats_request(struct ofconn *ofconn,
3681 const struct ofp_header *request)
3686 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3688 handle_port_request(ofconn, request, port_no, append_port_desc);
3694 hash_cookie(ovs_be64 cookie)
3696 return hash_uint64((OVS_FORCE uint64_t)cookie);
3700 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3701 OVS_REQUIRES(ofproto_mutex)
3703 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3704 hash_cookie(rule->flow_cookie));
3708 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3709 OVS_REQUIRES(ofproto_mutex)
3711 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3715 calc_duration(long long int start, long long int now,
3716 uint32_t *sec, uint32_t *nsec)
3718 long long int msecs = now - start;
3719 *sec = msecs / 1000;
3720 *nsec = (msecs % 1000) * (1000 * 1000);
3723 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3724 * true if 'table_id' is OK, false otherwise. */
3726 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3728 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3731 static struct oftable *
3732 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3734 struct oftable *table;
3736 for (table = &ofproto->tables[table_id];
3737 table < &ofproto->tables[ofproto->n_tables];
3739 if (!(table->flags & OFTABLE_HIDDEN)) {
3747 static struct oftable *
3748 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3750 if (table_id == 0xff) {
3751 return next_visible_table(ofproto, 0);
3752 } else if (table_id < ofproto->n_tables) {
3753 return &ofproto->tables[table_id];
3759 static struct oftable *
3760 next_matching_table(const struct ofproto *ofproto,
3761 const struct oftable *table, uint8_t table_id)
3763 return (table_id == 0xff
3764 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3768 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3770 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3771 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3773 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3774 * only once, for that table. (This can be used to access tables marked
3777 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3778 * entered at all. (Perhaps you should have validated TABLE_ID with
3779 * check_table_id().)
3781 * All parameters are evaluated multiple times.
3783 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3784 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3786 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3788 /* Initializes 'criteria' in a straightforward way based on the other
3791 * By default, the criteria include flows that are read-only, on the assumption
3792 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3793 * if flows will be modified.
3795 * For "loose" matching, the 'priority' parameter is unimportant and may be
3798 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3799 const struct match *match, int priority,
3800 cls_version_t version, ovs_be64 cookie,
3801 ovs_be64 cookie_mask, ofp_port_t out_port,
3804 criteria->table_id = table_id;
3805 cls_rule_init(&criteria->cr, match, priority, version);
3806 criteria->cookie = cookie;
3807 criteria->cookie_mask = cookie_mask;
3808 criteria->out_port = out_port;
3809 criteria->out_group = out_group;
3811 /* We ordinarily want to skip hidden rules, but there has to be a way for
3812 * code internal to OVS to modify and delete them, so if the criteria
3813 * specify a priority that can only be for a hidden flow, then allow hidden
3814 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3815 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3817 criteria->include_hidden = priority > UINT16_MAX;
3819 /* We assume that the criteria are being used to collect flows for reading
3820 * but not modification. Thus, we should collect read-only flows. */
3821 criteria->include_readonly = true;
3824 /* By default, criteria initialized by rule_criteria_init() will match flows
3825 * that are read-only, on the assumption that the collected flows won't be
3826 * modified. Call this function to match only flows that are be modifiable.
3828 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3829 * caller has special privileges that allow it to modify even "read-only"
3832 rule_criteria_require_rw(struct rule_criteria *criteria,
3833 bool can_write_readonly)
3835 criteria->include_readonly = can_write_readonly;
3839 rule_criteria_destroy(struct rule_criteria *criteria)
3841 cls_rule_destroy(&criteria->cr);
3845 rule_collection_init(struct rule_collection *rules)
3847 rules->rules = rules->stub;
3849 rules->capacity = ARRAY_SIZE(rules->stub);
3853 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3855 if (rules->n >= rules->capacity) {
3856 size_t old_size, new_size;
3858 old_size = rules->capacity * sizeof *rules->rules;
3859 rules->capacity *= 2;
3860 new_size = rules->capacity * sizeof *rules->rules;
3862 if (rules->rules == rules->stub) {
3863 rules->rules = xmalloc(new_size);
3864 memcpy(rules->rules, rules->stub, old_size);
3866 rules->rules = xrealloc(rules->rules, new_size);
3870 rules->rules[rules->n++] = rule;
3874 rule_collection_ref(struct rule_collection *rules)
3875 OVS_REQUIRES(ofproto_mutex)
3879 for (i = 0; i < rules->n; i++) {
3880 ofproto_rule_ref(rules->rules[i]);
3885 rule_collection_unref(struct rule_collection *rules)
3889 for (i = 0; i < rules->n; i++) {
3890 ofproto_rule_unref(rules->rules[i]);
3894 /* Returns a NULL-terminated array of rule pointers,
3895 * destroys 'rules'. */
3896 static struct rule **
3897 rule_collection_detach(struct rule_collection *rules)
3899 struct rule **rule_array;
3901 rule_collection_add(rules, NULL);
3903 if (rules->rules == rules->stub) {
3904 rules->rules = xmemdup(rules->rules, rules->n * sizeof *rules->rules);
3907 rule_array = rules->rules;
3908 rule_collection_init(rules);
3914 rule_collection_destroy(struct rule_collection *rules)
3916 if (rules->rules != rules->stub) {
3920 /* Make repeated destruction harmless. */
3921 rule_collection_init(rules);
3924 /* Schedules postponed removal of rules, destroys 'rules'. */
3926 rule_collection_remove_postponed(struct rule_collection *rules)
3927 OVS_REQUIRES(ofproto_mutex)
3930 if (rules->n == 1) {
3931 ovsrcu_postpone(remove_rule_rcu, rules->rules[0]);
3933 ovsrcu_postpone(remove_rules_rcu, rule_collection_detach(rules));
3938 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3939 * function verifies most of the criteria in 'c' itself, but the caller must
3940 * check 'c->cr' itself.
3942 * Rules that have already been marked for removal are not collected.
3944 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3945 * 'c' only includes modifiable rules). */
3947 collect_rule(struct rule *rule, const struct rule_criteria *c,
3948 struct rule_collection *rules, size_t *n_readonly)
3949 OVS_REQUIRES(ofproto_mutex)
3951 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3952 && ofproto_rule_has_out_port(rule, c->out_port)
3953 && ofproto_rule_has_out_group(rule, c->out_group)
3954 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3955 && (!rule_is_hidden(rule) || c->include_hidden)
3956 && cls_rule_visible_in_version(&rule->cr, c->cr.version)) {
3957 /* Rule matches all the criteria... */
3958 if (!rule_is_readonly(rule) || c->include_readonly) {
3960 rule_collection_add(rules, rule);
3962 /* ...except it's read-only. */
3968 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3969 * on classifiers rules are done in the "loose" way required for OpenFlow
3970 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3973 * Returns 0 on success, otherwise an OpenFlow error code. */
3975 collect_rules_loose(struct ofproto *ofproto,
3976 const struct rule_criteria *criteria,
3977 struct rule_collection *rules)
3978 OVS_REQUIRES(ofproto_mutex)
3980 struct oftable *table;
3981 enum ofperr error = 0;
3982 size_t n_readonly = 0;
3984 rule_collection_init(rules);
3986 if (!check_table_id(ofproto, criteria->table_id)) {
3987 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3991 if (criteria->cookie_mask == OVS_BE64_MAX) {
3994 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3995 hash_cookie(criteria->cookie),
3996 &ofproto->cookies) {
3997 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3998 collect_rule(rule, criteria, rules, &n_readonly);
4002 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4005 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
4006 collect_rule(rule, criteria, rules, &n_readonly);
4012 if (!error && !rules->n && n_readonly) {
4013 /* We didn't find any rules to modify. We did find some read-only
4014 * rules that we're not allowed to modify, so report that. */
4015 error = OFPERR_OFPBRC_EPERM;
4018 rule_collection_destroy(rules);
4023 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4024 * on classifiers rules are done in the "strict" way required for OpenFlow
4025 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
4026 * rules on list 'rules'.
4028 * Returns 0 on success, otherwise an OpenFlow error code. */
4030 collect_rules_strict(struct ofproto *ofproto,
4031 const struct rule_criteria *criteria,
4032 struct rule_collection *rules)
4033 OVS_REQUIRES(ofproto_mutex)
4035 struct oftable *table;
4036 size_t n_readonly = 0;
4037 enum ofperr error = 0;
4039 rule_collection_init(rules);
4041 if (!check_table_id(ofproto, criteria->table_id)) {
4042 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4046 if (criteria->cookie_mask == OVS_BE64_MAX) {
4049 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
4050 hash_cookie(criteria->cookie),
4051 &ofproto->cookies) {
4052 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
4053 collect_rule(rule, criteria, rules, &n_readonly);
4057 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
4060 rule = rule_from_cls_rule(classifier_find_rule_exactly(
4061 &table->cls, &criteria->cr));
4063 collect_rule(rule, criteria, rules, &n_readonly);
4069 if (!error && !rules->n && n_readonly) {
4070 /* We didn't find any rules to modify. We did find some read-only
4071 * rules that we're not allowed to modify, so report that. */
4072 error = OFPERR_OFPBRC_EPERM;
4075 rule_collection_destroy(rules);
4080 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4081 * forced into the range of a uint16_t. */
4083 age_secs(long long int age_ms)
4085 return (age_ms < 0 ? 0
4086 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
4087 : (unsigned int) age_ms / 1000);
4091 handle_flow_stats_request(struct ofconn *ofconn,
4092 const struct ofp_header *request)
4093 OVS_EXCLUDED(ofproto_mutex)
4095 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4096 struct ofputil_flow_stats_request fsr;
4097 struct rule_criteria criteria;
4098 struct rule_collection rules;
4099 struct ovs_list replies;
4103 error = ofputil_decode_flow_stats_request(&fsr, request);
4108 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
4109 fsr.cookie, fsr.cookie_mask, fsr.out_port,
4112 ovs_mutex_lock(&ofproto_mutex);
4113 error = collect_rules_loose(ofproto, &criteria, &rules);
4114 rule_criteria_destroy(&criteria);
4116 rule_collection_ref(&rules);
4118 ovs_mutex_unlock(&ofproto_mutex);
4124 ofpmp_init(&replies, request);
4125 for (i = 0; i < rules.n; i++) {
4126 struct rule *rule = rules.rules[i];
4127 long long int now = time_msec();
4128 struct ofputil_flow_stats fs;
4129 long long int created, used, modified;
4130 const struct rule_actions *actions;
4131 enum ofputil_flow_mod_flags flags;
4133 ovs_mutex_lock(&rule->mutex);
4134 fs.cookie = rule->flow_cookie;
4135 fs.idle_timeout = rule->idle_timeout;
4136 fs.hard_timeout = rule->hard_timeout;
4137 fs.importance = rule->importance;
4138 created = rule->created;
4139 modified = rule->modified;
4140 actions = rule_get_actions(rule);
4141 flags = rule->flags;
4142 ovs_mutex_unlock(&rule->mutex);
4144 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
4145 &fs.byte_count, &used);
4147 minimatch_expand(&rule->cr.match, &fs.match);
4148 fs.table_id = rule->table_id;
4149 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4150 fs.priority = rule->cr.priority;
4151 fs.idle_age = age_secs(now - used);
4152 fs.hard_age = age_secs(now - modified);
4153 fs.ofpacts = actions->ofpacts;
4154 fs.ofpacts_len = actions->ofpacts_len;
4157 ofputil_append_flow_stats_reply(&fs, &replies);
4160 rule_collection_unref(&rules);
4161 rule_collection_destroy(&rules);
4163 ofconn_send_replies(ofconn, &replies);
4169 flow_stats_ds(struct rule *rule, struct ds *results)
4171 uint64_t packet_count, byte_count;
4172 const struct rule_actions *actions;
4173 long long int created, used;
4175 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4176 &byte_count, &used);
4178 ovs_mutex_lock(&rule->mutex);
4179 actions = rule_get_actions(rule);
4180 created = rule->created;
4181 ovs_mutex_unlock(&rule->mutex);
4183 if (rule->table_id != 0) {
4184 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4186 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4187 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4188 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4189 cls_rule_format(&rule->cr, results);
4190 ds_put_char(results, ',');
4192 ds_put_cstr(results, "actions=");
4193 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4195 ds_put_cstr(results, "\n");
4198 /* Adds a pretty-printed description of all flows to 'results', including
4199 * hidden flows (e.g., set up by in-band control). */
4201 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4203 struct oftable *table;
4205 OFPROTO_FOR_EACH_TABLE (table, p) {
4208 CLS_FOR_EACH (rule, cr, &table->cls) {
4209 flow_stats_ds(rule, results);
4214 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4215 * '*engine_type' and '*engine_id', respectively. */
4217 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4218 uint8_t *engine_type, uint8_t *engine_id)
4220 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4223 /* Checks the status change of CFM on 'ofport'.
4225 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4227 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4229 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4230 return (ofport && ofproto->ofproto_class->cfm_status_changed
4231 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4235 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4236 * Returns 0 if the port's CFM status was successfully stored into
4237 * '*status'. Returns positive errno if the port did not have CFM
4240 * The caller must provide and own '*status', and must free 'status->rmps'.
4241 * '*status' is indeterminate if the return value is non-zero. */
4243 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4244 struct cfm_status *status)
4246 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4247 return (ofport && ofproto->ofproto_class->get_cfm_status
4248 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4253 handle_aggregate_stats_request(struct ofconn *ofconn,
4254 const struct ofp_header *oh)
4255 OVS_EXCLUDED(ofproto_mutex)
4257 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4258 struct ofputil_flow_stats_request request;
4259 struct ofputil_aggregate_stats stats;
4260 bool unknown_packets, unknown_bytes;
4261 struct rule_criteria criteria;
4262 struct rule_collection rules;
4263 struct ofpbuf *reply;
4267 error = ofputil_decode_flow_stats_request(&request, oh);
4272 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4273 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4274 request.out_port, request.out_group);
4276 ovs_mutex_lock(&ofproto_mutex);
4277 error = collect_rules_loose(ofproto, &criteria, &rules);
4278 rule_criteria_destroy(&criteria);
4280 rule_collection_ref(&rules);
4282 ovs_mutex_unlock(&ofproto_mutex);
4288 memset(&stats, 0, sizeof stats);
4289 unknown_packets = unknown_bytes = false;
4290 for (i = 0; i < rules.n; i++) {
4291 struct rule *rule = rules.rules[i];
4292 uint64_t packet_count;
4293 uint64_t byte_count;
4296 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4297 &byte_count, &used);
4299 if (packet_count == UINT64_MAX) {
4300 unknown_packets = true;
4302 stats.packet_count += packet_count;
4305 if (byte_count == UINT64_MAX) {
4306 unknown_bytes = true;
4308 stats.byte_count += byte_count;
4313 if (unknown_packets) {
4314 stats.packet_count = UINT64_MAX;
4316 if (unknown_bytes) {
4317 stats.byte_count = UINT64_MAX;
4320 rule_collection_unref(&rules);
4321 rule_collection_destroy(&rules);
4323 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4324 ofconn_send_reply(ofconn, reply);
4329 struct queue_stats_cbdata {
4330 struct ofport *ofport;
4331 struct ovs_list replies;
4336 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4337 const struct netdev_queue_stats *stats)
4339 struct ofputil_queue_stats oqs;
4341 oqs.port_no = cbdata->ofport->pp.port_no;
4342 oqs.queue_id = queue_id;
4343 oqs.tx_bytes = stats->tx_bytes;
4344 oqs.tx_packets = stats->tx_packets;
4345 oqs.tx_errors = stats->tx_errors;
4346 if (stats->created != LLONG_MIN) {
4347 calc_duration(stats->created, cbdata->now,
4348 &oqs.duration_sec, &oqs.duration_nsec);
4350 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4352 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4356 handle_queue_stats_dump_cb(uint32_t queue_id,
4357 struct netdev_queue_stats *stats,
4360 struct queue_stats_cbdata *cbdata = cbdata_;
4362 put_queue_stats(cbdata, queue_id, stats);
4366 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4367 struct queue_stats_cbdata *cbdata)
4369 cbdata->ofport = port;
4370 if (queue_id == OFPQ_ALL) {
4371 netdev_dump_queue_stats(port->netdev,
4372 handle_queue_stats_dump_cb, cbdata);
4374 struct netdev_queue_stats stats;
4376 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4377 put_queue_stats(cbdata, queue_id, &stats);
4379 return OFPERR_OFPQOFC_BAD_QUEUE;
4386 handle_queue_stats_request(struct ofconn *ofconn,
4387 const struct ofp_header *rq)
4389 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4390 struct queue_stats_cbdata cbdata;
4391 struct ofport *port;
4393 struct ofputil_queue_stats_request oqsr;
4395 COVERAGE_INC(ofproto_queue_req);
4397 ofpmp_init(&cbdata.replies, rq);
4398 cbdata.now = time_msec();
4400 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4405 if (oqsr.port_no == OFPP_ANY) {
4406 error = OFPERR_OFPQOFC_BAD_QUEUE;
4407 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4408 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4413 port = ofproto_get_port(ofproto, oqsr.port_no);
4415 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4416 : OFPERR_OFPQOFC_BAD_PORT);
4419 ofconn_send_replies(ofconn, &cbdata.replies);
4421 ofpbuf_list_delete(&cbdata.replies);
4428 evict_rules_from_table(struct oftable *table)
4429 OVS_REQUIRES(ofproto_mutex)
4431 enum ofperr error = 0;
4432 struct rule_collection rules;
4433 unsigned int count = table->n_flows;
4434 unsigned int max_flows = table->max_flows;
4436 rule_collection_init(&rules);
4438 while (count-- > max_flows) {
4441 if (!choose_rule_to_evict(table, &rule)) {
4442 error = OFPERR_OFPFMFC_TABLE_FULL;
4445 eviction_group_remove_rule(rule);
4446 rule_collection_add(&rules, rule);
4449 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4455 get_conjunctions(const struct ofputil_flow_mod *fm,
4456 struct cls_conjunction **conjsp, size_t *n_conjsp)
4457 OVS_REQUIRES(ofproto_mutex)
4459 struct cls_conjunction *conjs = NULL;
4462 const struct ofpact *ofpact;
4463 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4464 if (ofpact->type == OFPACT_CONJUNCTION) {
4466 } else if (ofpact->type != OFPACT_NOTE) {
4467 /* "conjunction" may appear with "note" actions but not with any
4468 * other type of actions. */
4469 ovs_assert(!n_conjs);
4476 conjs = xzalloc(n_conjs * sizeof *conjs);
4477 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4478 if (ofpact->type == OFPACT_CONJUNCTION) {
4479 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4480 conjs[i].clause = oc->clause;
4481 conjs[i].n_clauses = oc->n_clauses;
4482 conjs[i].id = oc->id;
4489 *n_conjsp = n_conjs;
4492 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4493 * in which no matching flow already exists in the flow table.
4495 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4496 * success, or an OpenFlow error code on failure.
4498 * On successful return the caller must complete the operation either by
4499 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4502 * The caller retains ownership of 'fm->ofpacts'. */
4504 add_flow_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4505 OVS_REQUIRES(ofproto_mutex)
4507 struct ofputil_flow_mod *fm = &ofm->fm;
4508 struct rule **old_rule = &ofm->old_rules.stub[0];
4509 struct rule **new_rule = &ofm->new_rules.stub[0];
4510 struct oftable *table;
4514 struct cls_conjunction *conjs;
4518 if (!check_table_id(ofproto, fm->table_id)) {
4519 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4524 if (fm->table_id == 0xff) {
4525 if (ofproto->ofproto_class->rule_choose_table) {
4526 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4532 ovs_assert(table_id < ofproto->n_tables);
4536 } else if (fm->table_id < ofproto->n_tables) {
4537 table_id = fm->table_id;
4539 return OFPERR_OFPBRC_BAD_TABLE_ID;
4542 table = &ofproto->tables[table_id];
4543 if (table->flags & OFTABLE_READONLY
4544 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4545 return OFPERR_OFPBRC_EPERM;
4548 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4549 && !match_has_default_hidden_fields(&fm->match)) {
4550 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4551 "non-default values to hidden fields", ofproto->name);
4552 return OFPERR_OFPBRC_EPERM;
4555 cls_rule_init(&cr, &fm->match, fm->priority, ofm->version);
4557 /* Check for the existence of an identical rule.
4558 * This will not return rules earlier marked for removal. */
4559 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4562 /* Check for overlap, if requested. */
4563 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4564 && classifier_rule_overlaps(&table->cls, &cr)) {
4565 cls_rule_destroy(&cr);
4566 return OFPERR_OFPFMFC_OVERLAP;
4569 /* If necessary, evict an existing rule to clear out space. */
4570 if (table->n_flows >= table->max_flows) {
4571 if (!choose_rule_to_evict(table, &rule)) {
4572 error = OFPERR_OFPFMFC_TABLE_FULL;
4573 cls_rule_destroy(&cr);
4576 eviction_group_remove_rule(rule);
4577 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4579 fm->delete_reason = OFPRR_EVICTION;
4583 fm->modify_cookie = true;
4586 /* Allocate new rule. */
4587 error = replace_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4593 get_conjunctions(fm, &conjs, &n_conjs);
4594 replace_rule_start(ofproto, ofm->version, rule, *new_rule, conjs, n_conjs);
4600 /* Revert the effects of add_flow_start(). */
4602 add_flow_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4603 OVS_REQUIRES(ofproto_mutex)
4605 struct ofputil_flow_mod *fm = &ofm->fm;
4606 struct rule *old_rule = ofm->old_rules.stub[0];
4607 struct rule *new_rule = ofm->new_rules.stub[0];
4609 if (old_rule && fm->delete_reason == OFPRR_EVICTION) {
4610 /* Revert the eviction. */
4611 eviction_group_add_rule(old_rule);
4614 replace_rule_revert(ofproto, old_rule, new_rule);
4617 /* To be called after version bump. */
4619 add_flow_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4620 const struct flow_mod_requester *req)
4621 OVS_REQUIRES(ofproto_mutex)
4623 struct ofputil_flow_mod *fm = &ofm->fm;
4624 struct rule *old_rule = ofm->old_rules.stub[0];
4625 struct rule *new_rule = ofm->new_rules.stub[0];
4626 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4628 replace_rule_finish(ofproto, fm, req, old_rule, new_rule, &dead_cookies);
4629 learned_cookies_flush(ofproto, &dead_cookies);
4632 ovsrcu_postpone(remove_rule_rcu, old_rule);
4634 if (minimask_get_vid_mask(&new_rule->cr.match.mask) == VLAN_VID_MASK) {
4635 if (ofproto->vlan_bitmap) {
4636 uint16_t vid = miniflow_get_vid(&new_rule->cr.match.flow);
4638 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4639 bitmap_set1(ofproto->vlan_bitmap, vid);
4640 ofproto->vlans_changed = true;
4643 ofproto->vlans_changed = true;
4647 ofmonitor_report(ofproto->connmgr, new_rule, NXFME_ADDED, 0,
4648 req ? req->ofconn : NULL,
4649 req ? req->request->xid : 0, NULL);
4652 send_buffered_packet(req, fm->buffer_id, new_rule);
4655 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4657 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4658 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4659 * structures yet. Takes ownership of 'cr'. */
4661 replace_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4662 struct cls_rule *cr, uint8_t table_id,
4663 struct rule *old_rule, struct rule **new_rule)
4668 /* Allocate new rule. */
4669 rule = ofproto->ofproto_class->rule_alloc();
4671 cls_rule_destroy(cr);
4672 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
4673 return OFPERR_OFPFMFC_UNKNOWN;
4676 /* Initialize base state. */
4677 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4678 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
4679 ovs_refcount_init(&rule->ref_count);
4680 rule->flow_cookie = fm->new_cookie;
4681 rule->created = rule->modified = time_msec();
4683 ovs_mutex_init(&rule->mutex);
4684 ovs_mutex_lock(&rule->mutex);
4685 rule->idle_timeout = fm->idle_timeout;
4686 rule->hard_timeout = fm->hard_timeout;
4687 *CONST_CAST(uint16_t *, &rule->importance) = fm->importance;
4688 rule->removed_reason = OVS_OFPRR_NONE;
4690 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
4691 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4692 *CONST_CAST(const struct rule_actions **, &rule->actions)
4693 = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4694 list_init(&rule->meter_list_node);
4695 rule->eviction_group = NULL;
4696 list_init(&rule->expirable);
4697 rule->monitor_flags = 0;
4698 rule->add_seqno = 0;
4699 rule->modify_seqno = 0;
4701 /* Copy values from old rule for modify semantics. */
4702 if (old_rule && fm->delete_reason != OFPRR_EVICTION) {
4703 bool change_cookie = (fm->modify_cookie
4704 && fm->new_cookie != OVS_BE64_MAX
4705 && fm->new_cookie != old_rule->flow_cookie);
4707 ovs_mutex_lock(&old_rule->mutex);
4708 if (fm->command != OFPFC_ADD) {
4709 rule->idle_timeout = old_rule->idle_timeout;
4710 rule->hard_timeout = old_rule->hard_timeout;
4711 *CONST_CAST(uint16_t *, &rule->importance) = old_rule->importance;
4712 rule->flags = old_rule->flags;
4713 rule->created = old_rule->created;
4715 if (!change_cookie) {
4716 rule->flow_cookie = old_rule->flow_cookie;
4718 ovs_mutex_unlock(&old_rule->mutex);
4720 ovs_mutex_unlock(&rule->mutex);
4722 /* Construct rule, initializing derived state. */
4723 error = ofproto->ofproto_class->rule_construct(rule);
4725 ofproto_rule_destroy__(rule);
4729 rule->removed = true; /* Not yet in ofproto data structures. */
4736 replace_rule_start(struct ofproto *ofproto, cls_version_t version,
4737 struct rule *old_rule, struct rule *new_rule,
4738 struct cls_conjunction *conjs, size_t n_conjs)
4740 struct oftable *table = &ofproto->tables[new_rule->table_id];
4742 /* 'old_rule' may be either an evicted rule or replaced rule. */
4744 /* Mark the old rule for removal in the next version. */
4745 cls_rule_make_invisible_in_version(&old_rule->cr, version);
4749 /* Insert flow to the classifier, so that later flow_mods may relate
4750 * to it. This is reversible, in case later errors require this to
4752 ofproto_rule_insert__(ofproto, new_rule);
4753 /* Make the new rule visible for classifier lookups only from the next
4755 classifier_insert(&table->cls, &new_rule->cr, conjs, n_conjs);
4758 static void replace_rule_revert(struct ofproto *ofproto,
4759 struct rule *old_rule, struct rule *new_rule)
4761 struct oftable *table = &ofproto->tables[new_rule->table_id];
4764 /* Restore the original visibility of the old rule. */
4765 cls_rule_restore_visibility(&old_rule->cr);
4767 /* Restore table's rule count. */
4771 /* Remove the new rule immediately. It was never visible to lookups. */
4772 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4775 ofproto_rule_remove__(ofproto, new_rule);
4776 /* The rule was not inserted to the ofproto provider, so we can
4777 * release it without deleting it from the ofproto provider. */
4778 ofproto_rule_unref(new_rule);
4781 /* Adds the 'new_rule', replacing the 'old_rule'. */
4783 replace_rule_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4784 const struct flow_mod_requester *req,
4785 struct rule *old_rule, struct rule *new_rule,
4786 struct ovs_list *dead_cookies)
4787 OVS_REQUIRES(ofproto_mutex)
4789 bool forward_stats = !(fm->flags & OFPUTIL_FF_RESET_COUNTS);
4790 struct rule *replaced_rule;
4792 replaced_rule = fm->delete_reason != OFPRR_EVICTION ? old_rule : NULL;
4794 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4795 * is a duplicate rule the 'new_rule' is replacing. The provider should
4796 * link the stats from the old rule to the new one if 'forward_stats' is
4797 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4798 ofproto->ofproto_class->rule_insert(new_rule, replaced_rule,
4800 learned_cookies_inc(ofproto, rule_get_actions(new_rule));
4803 const struct rule_actions *old_actions = rule_get_actions(old_rule);
4805 /* Remove the old rule from data structures. Removal from the
4806 * classifier and the deletion of the rule is RCU postponed by the
4808 ofproto_rule_remove__(ofproto, old_rule);
4809 learned_cookies_dec(ofproto, old_actions, dead_cookies);
4811 if (replaced_rule) {
4812 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4813 ? NXFME_ADDED : NXFME_MODIFIED;
4815 bool change_cookie = (fm->modify_cookie
4816 && fm->new_cookie != OVS_BE64_MAX
4817 && fm->new_cookie != old_rule->flow_cookie);
4819 bool change_actions = !ofpacts_equal(fm->ofpacts,
4821 old_actions->ofpacts,
4822 old_actions->ofpacts_len);
4824 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4825 ofmonitor_report(ofproto->connmgr, new_rule, event, 0,
4826 req ? req->ofconn : NULL,
4827 req ? req->request->xid : 0,
4828 change_actions ? old_actions : NULL);
4831 /* XXX: This is slight duplication with delete_flows_finish__() */
4833 old_rule->removed_reason = OFPRR_EVICTION;
4835 ofmonitor_report(ofproto->connmgr, old_rule, NXFME_DELETED,
4837 req ? req->ofconn : NULL,
4838 req ? req->request->xid : 0, NULL);
4844 modify_flows_start__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4845 OVS_REQUIRES(ofproto_mutex)
4847 struct ofputil_flow_mod *fm = &ofm->fm;
4848 struct rule_collection *old_rules = &ofm->old_rules;
4849 struct rule_collection *new_rules = &ofm->new_rules;
4852 rule_collection_init(new_rules);
4854 if (old_rules->n > 0) {
4855 struct cls_conjunction *conjs;
4859 /* Create a new 'modified' rule for each old rule. */
4860 for (i = 0; i < old_rules->n; i++) {
4861 struct rule *old_rule = old_rules->rules[i];
4862 struct rule *new_rule;
4865 cls_rule_clone_in_version(&cr, &old_rule->cr, ofm->version);
4866 error = replace_rule_create(ofproto, fm, &cr, old_rule->table_id,
4867 old_rule, &new_rule);
4869 rule_collection_add(new_rules, new_rule);
4871 rule_collection_unref(new_rules);
4872 rule_collection_destroy(new_rules);
4876 ovs_assert(new_rules->n == old_rules->n);
4878 get_conjunctions(fm, &conjs, &n_conjs);
4879 for (i = 0; i < old_rules->n; i++) {
4880 replace_rule_start(ofproto, ofm->version, old_rules->rules[i],
4881 new_rules->rules[i], conjs, n_conjs);
4884 } else if (!(fm->cookie_mask != htonll(0)
4885 || fm->new_cookie == OVS_BE64_MAX)) {
4886 /* No match, add a new flow. */
4887 error = add_flow_start(ofproto, ofm);
4889 ovs_assert(fm->delete_reason == OFPRR_EVICTION
4890 || !old_rules->rules[0]);
4900 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4903 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4906 modify_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4907 OVS_REQUIRES(ofproto_mutex)
4909 struct ofputil_flow_mod *fm = &ofm->fm;
4910 struct rule_collection *old_rules = &ofm->old_rules;
4911 struct rule_criteria criteria;
4914 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4915 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4916 rule_criteria_require_rw(&criteria,
4917 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4918 error = collect_rules_loose(ofproto, &criteria, old_rules);
4919 rule_criteria_destroy(&criteria);
4922 error = modify_flows_start__(ofproto, ofm);
4926 rule_collection_destroy(old_rules);
4932 modify_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4933 OVS_REQUIRES(ofproto_mutex)
4935 struct rule_collection *old_rules = &ofm->old_rules;
4936 struct rule_collection *new_rules = &ofm->new_rules;
4938 /* Old rules were not changed yet, only need to revert new rules. */
4939 if (old_rules->n == 0 && new_rules->n == 1) {
4940 add_flow_revert(ofproto, ofm);
4941 } else if (old_rules->n > 0) {
4942 for (size_t i = 0; i < old_rules->n; i++) {
4943 replace_rule_revert(ofproto, old_rules->rules[i],
4944 new_rules->rules[i]);
4946 rule_collection_destroy(new_rules);
4947 rule_collection_destroy(old_rules);
4952 modify_flows_finish(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
4953 const struct flow_mod_requester *req)
4954 OVS_REQUIRES(ofproto_mutex)
4956 struct ofputil_flow_mod *fm = &ofm->fm;
4957 struct rule_collection *old_rules = &ofm->old_rules;
4958 struct rule_collection *new_rules = &ofm->new_rules;
4960 if (old_rules->n == 0 && new_rules->n == 1) {
4961 add_flow_finish(ofproto, ofm, req);
4962 } else if (old_rules->n > 0) {
4963 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4965 ovs_assert(new_rules->n == old_rules->n);
4967 for (size_t i = 0; i < old_rules->n; i++) {
4968 replace_rule_finish(ofproto, fm, req, old_rules->rules[i],
4969 new_rules->rules[i], &dead_cookies);
4971 learned_cookies_flush(ofproto, &dead_cookies);
4972 rule_collection_remove_postponed(old_rules);
4974 send_buffered_packet(req, fm->buffer_id, new_rules->rules[0]);
4975 rule_collection_destroy(new_rules);
4979 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4980 * code on failure. */
4982 modify_flow_start_strict(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
4983 OVS_REQUIRES(ofproto_mutex)
4985 struct ofputil_flow_mod *fm = &ofm->fm;
4986 struct rule_collection *old_rules = &ofm->old_rules;
4987 struct rule_criteria criteria;
4990 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4991 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
4993 rule_criteria_require_rw(&criteria,
4994 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4995 error = collect_rules_strict(ofproto, &criteria, old_rules);
4996 rule_criteria_destroy(&criteria);
4999 /* collect_rules_strict() can return max 1 rule. */
5000 error = modify_flows_start__(ofproto, ofm);
5004 rule_collection_destroy(old_rules);
5009 /* OFPFC_DELETE implementation. */
5012 delete_flows_start__(struct ofproto *ofproto, cls_version_t version,
5013 const struct rule_collection *rules)
5014 OVS_REQUIRES(ofproto_mutex)
5016 for (size_t i = 0; i < rules->n; i++) {
5017 struct rule *rule = rules->rules[i];
5018 struct oftable *table = &ofproto->tables[rule->table_id];
5021 cls_rule_make_invisible_in_version(&rule->cr, version);
5026 delete_flows_finish__(struct ofproto *ofproto,
5027 struct rule_collection *rules,
5028 enum ofp_flow_removed_reason reason,
5029 const struct flow_mod_requester *req)
5030 OVS_REQUIRES(ofproto_mutex)
5033 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
5035 for (size_t i = 0; i < rules->n; i++) {
5036 struct rule *rule = rules->rules[i];
5038 /* This value will be used to send the flow removed message right
5039 * before the rule is actually destroyed. */
5040 rule->removed_reason = reason;
5042 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
5043 req ? req->ofconn : NULL,
5044 req ? req->request->xid : 0, NULL);
5045 ofproto_rule_remove__(ofproto, rule);
5046 learned_cookies_dec(ofproto, rule_get_actions(rule),
5049 rule_collection_remove_postponed(rules);
5051 learned_cookies_flush(ofproto, &dead_cookies);
5055 /* Deletes the rules listed in 'rules'.
5056 * The deleted rules will become invisible to the lookups in the next version.
5057 * Destroys 'rules'. */
5059 delete_flows__(struct rule_collection *rules,
5060 enum ofp_flow_removed_reason reason,
5061 const struct flow_mod_requester *req)
5062 OVS_REQUIRES(ofproto_mutex)
5065 struct ofproto *ofproto = rules->rules[0]->ofproto;
5067 delete_flows_start__(ofproto, ofproto->tables_version + 1, rules);
5068 ofproto_bump_tables_version(ofproto);
5069 delete_flows_finish__(ofproto, rules, reason, req);
5070 ofmonitor_flush(ofproto->connmgr);
5074 /* Implements OFPFC_DELETE. */
5076 delete_flows_start_loose(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5077 OVS_REQUIRES(ofproto_mutex)
5079 const struct ofputil_flow_mod *fm = &ofm->fm;
5080 struct rule_collection *rules = &ofm->old_rules;
5081 struct rule_criteria criteria;
5084 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
5085 fm->cookie, fm->cookie_mask, fm->out_port,
5087 rule_criteria_require_rw(&criteria,
5088 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5089 error = collect_rules_loose(ofproto, &criteria, rules);
5090 rule_criteria_destroy(&criteria);
5093 delete_flows_start__(ofproto, ofm->version, rules);
5100 delete_flows_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
5101 OVS_REQUIRES(ofproto_mutex)
5103 struct rule_collection *rules = &ofm->old_rules;
5105 for (size_t i = 0; i < rules->n; i++) {
5106 struct rule *rule = rules->rules[i];
5107 struct oftable *table = &ofproto->tables[rule->table_id];
5109 /* Restore table's rule count. */
5112 /* Restore the original visibility of the rule. */
5113 cls_rule_restore_visibility(&rule->cr);
5115 rule_collection_destroy(rules);
5119 delete_flows_finish(struct ofproto *ofproto,
5120 struct ofproto_flow_mod *ofm,
5121 const struct flow_mod_requester *req)
5122 OVS_REQUIRES(ofproto_mutex)
5124 delete_flows_finish__(ofproto, &ofm->old_rules, ofm->fm.delete_reason,
5128 /* Implements OFPFC_DELETE_STRICT. */
5130 delete_flow_start_strict(struct ofproto *ofproto,
5131 struct ofproto_flow_mod *ofm)
5132 OVS_REQUIRES(ofproto_mutex)
5134 const struct ofputil_flow_mod *fm = &ofm->fm;
5135 struct rule_collection *rules = &ofm->old_rules;
5136 struct rule_criteria criteria;
5139 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
5140 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
5141 fm->out_port, fm->out_group);
5142 rule_criteria_require_rw(&criteria,
5143 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
5144 error = collect_rules_strict(ofproto, &criteria, rules);
5145 rule_criteria_destroy(&criteria);
5148 delete_flows_start__(ofproto, ofm->version, rules);
5154 /* This may only be called by rule_destroy_cb()! */
5156 ofproto_rule_send_removed(struct rule *rule)
5157 OVS_EXCLUDED(ofproto_mutex)
5159 struct ofputil_flow_removed fr;
5162 minimatch_expand(&rule->cr.match, &fr.match);
5163 fr.priority = rule->cr.priority;
5165 ovs_mutex_lock(&ofproto_mutex);
5166 fr.cookie = rule->flow_cookie;
5167 fr.reason = rule->removed_reason;
5168 fr.table_id = rule->table_id;
5169 calc_duration(rule->created, time_msec(),
5170 &fr.duration_sec, &fr.duration_nsec);
5171 ovs_mutex_lock(&rule->mutex);
5172 fr.idle_timeout = rule->idle_timeout;
5173 fr.hard_timeout = rule->hard_timeout;
5174 ovs_mutex_unlock(&rule->mutex);
5175 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
5176 &fr.byte_count, &used);
5177 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
5178 ovs_mutex_unlock(&ofproto_mutex);
5181 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5182 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5185 * ofproto implementation ->run() functions should use this function to expire
5186 * OpenFlow flows. */
5188 ofproto_rule_expire(struct rule *rule, uint8_t reason)
5189 OVS_REQUIRES(ofproto_mutex)
5191 struct rule_collection rules;
5193 rules.rules = rules.stub;
5195 rules.stub[0] = rule;
5196 delete_flows__(&rules, reason, NULL);
5199 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5200 * means "infinite". */
5202 reduce_timeout(uint16_t max, uint16_t *timeout)
5204 if (max && (!*timeout || *timeout > max)) {
5209 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5210 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5211 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5213 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5215 ofproto_rule_reduce_timeouts(struct rule *rule,
5216 uint16_t idle_timeout, uint16_t hard_timeout)
5217 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5219 if (!idle_timeout && !hard_timeout) {
5223 ovs_mutex_lock(&ofproto_mutex);
5224 if (list_is_empty(&rule->expirable)) {
5225 list_insert(&rule->ofproto->expirable, &rule->expirable);
5227 ovs_mutex_unlock(&ofproto_mutex);
5229 ovs_mutex_lock(&rule->mutex);
5230 reduce_timeout(idle_timeout, &rule->idle_timeout);
5231 reduce_timeout(hard_timeout, &rule->hard_timeout);
5232 ovs_mutex_unlock(&rule->mutex);
5236 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5237 OVS_EXCLUDED(ofproto_mutex)
5239 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5240 struct ofproto_flow_mod ofm;
5241 uint64_t ofpacts_stub[1024 / 8];
5242 struct ofpbuf ofpacts;
5245 error = reject_slave_controller(ofconn);
5250 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5251 error = ofputil_decode_flow_mod(&ofm.fm, oh, ofconn_get_protocol(ofconn),
5253 u16_to_ofp(ofproto->max_ports),
5256 error = ofproto_check_ofpacts(ofproto, ofm.fm.ofpacts,
5257 ofm.fm.ofpacts_len);
5260 struct flow_mod_requester req;
5262 req.ofconn = ofconn;
5264 error = handle_flow_mod__(ofproto, &ofm, &req);
5267 goto exit_free_ofpacts;
5270 ofconn_report_flow_mod(ofconn, ofm.fm.command);
5273 ofpbuf_uninit(&ofpacts);
5279 handle_flow_mod__(struct ofproto *ofproto, struct ofproto_flow_mod *ofm,
5280 const struct flow_mod_requester *req)
5281 OVS_EXCLUDED(ofproto_mutex)
5285 ovs_mutex_lock(&ofproto_mutex);
5286 ofm->version = ofproto->tables_version + 1;
5287 error = ofproto_flow_mod_start(ofproto, ofm);
5289 ofproto_bump_tables_version(ofproto);
5290 ofproto_flow_mod_finish(ofproto, ofm, req);
5292 ofmonitor_flush(ofproto->connmgr);
5293 ovs_mutex_unlock(&ofproto_mutex);
5295 run_rule_executes(ofproto);
5300 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5302 struct ofputil_role_request request;
5303 struct ofputil_role_request reply;
5307 error = ofputil_decode_role_message(oh, &request);
5312 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5313 if (request.have_generation_id
5314 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5315 return OFPERR_OFPRRFC_STALE;
5318 ofconn_set_role(ofconn, request.role);
5321 reply.role = ofconn_get_role(ofconn);
5322 reply.have_generation_id = ofconn_get_master_election_id(
5323 ofconn, &reply.generation_id);
5324 buf = ofputil_encode_role_reply(oh, &reply);
5325 ofconn_send_reply(ofconn, buf);
5331 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5332 const struct ofp_header *oh)
5334 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5335 enum ofputil_protocol cur, next;
5337 cur = ofconn_get_protocol(ofconn);
5338 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5339 ofconn_set_protocol(ofconn, next);
5345 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5347 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5348 enum ofputil_protocol cur, next;
5349 enum ofputil_protocol next_base;
5351 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5353 return OFPERR_OFPBRC_EPERM;
5356 cur = ofconn_get_protocol(ofconn);
5357 next = ofputil_protocol_set_base(cur, next_base);
5358 ofconn_set_protocol(ofconn, next);
5364 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5365 const struct ofp_header *oh)
5367 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5370 format = ntohl(msg->format);
5371 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5372 return OFPERR_OFPBRC_EPERM;
5375 ofconn_set_packet_in_format(ofconn, format);
5380 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5382 const struct nx_async_config *msg = ofpmsg_body(oh);
5383 uint32_t master[OAM_N_TYPES];
5384 uint32_t slave[OAM_N_TYPES];
5386 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5387 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5388 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5390 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5391 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5392 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5394 ofconn_set_async_config(ofconn, master, slave);
5395 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5396 !ofconn_get_miss_send_len(ofconn)) {
5397 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5404 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5407 uint32_t master[OAM_N_TYPES];
5408 uint32_t slave[OAM_N_TYPES];
5409 struct nx_async_config *msg;
5411 ofconn_get_async_config(ofconn, master, slave);
5412 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5413 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5415 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5416 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5417 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5419 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5420 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5421 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5423 ofconn_send_reply(ofconn, buf);
5429 handle_nxt_set_controller_id(struct ofconn *ofconn,
5430 const struct ofp_header *oh)
5432 const struct nx_controller_id *nci = ofpmsg_body(oh);
5434 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5435 return OFPERR_NXBRC_MUST_BE_ZERO;
5438 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5443 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5447 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5448 ? OFPRAW_OFPT10_BARRIER_REPLY
5449 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5450 ofconn_send_reply(ofconn, buf);
5455 ofproto_compose_flow_refresh_update(const struct rule *rule,
5456 enum nx_flow_monitor_flags flags,
5457 struct ovs_list *msgs)
5458 OVS_REQUIRES(ofproto_mutex)
5460 const struct rule_actions *actions;
5461 struct ofputil_flow_update fu;
5464 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5465 ? NXFME_ADDED : NXFME_MODIFIED);
5467 ovs_mutex_lock(&rule->mutex);
5468 fu.idle_timeout = rule->idle_timeout;
5469 fu.hard_timeout = rule->hard_timeout;
5470 ovs_mutex_unlock(&rule->mutex);
5471 fu.table_id = rule->table_id;
5472 fu.cookie = rule->flow_cookie;
5473 minimatch_expand(&rule->cr.match, &match);
5475 fu.priority = rule->cr.priority;
5477 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5478 fu.ofpacts = actions ? actions->ofpacts : NULL;
5479 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5481 if (list_is_empty(msgs)) {
5482 ofputil_start_flow_update(msgs);
5484 ofputil_append_flow_update(&fu, msgs);
5488 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5489 struct ovs_list *msgs)
5490 OVS_REQUIRES(ofproto_mutex)
5494 for (i = 0; i < rules->n; i++) {
5495 struct rule *rule = rules->rules[i];
5496 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5497 rule->monitor_flags = 0;
5499 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5504 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5505 struct rule *rule, uint64_t seqno,
5506 struct rule_collection *rules)
5507 OVS_REQUIRES(ofproto_mutex)
5509 enum nx_flow_monitor_flags update;
5511 if (rule_is_hidden(rule)) {
5515 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5520 if (rule->add_seqno > seqno) {
5521 update = NXFMF_ADD | NXFMF_MODIFY;
5522 } else if (rule->modify_seqno > seqno) {
5523 update = NXFMF_MODIFY;
5528 if (!(m->flags & update)) {
5532 update = NXFMF_INITIAL;
5535 if (!rule->monitor_flags) {
5536 rule_collection_add(rules, rule);
5538 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5542 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5544 struct rule_collection *rules)
5545 OVS_REQUIRES(ofproto_mutex)
5547 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5548 const struct oftable *table;
5549 struct cls_rule target;
5551 cls_rule_init_from_minimatch(&target, &m->match, 0, CLS_MAX_VERSION);
5552 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5555 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5556 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5559 cls_rule_destroy(&target);
5563 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5564 struct rule_collection *rules)
5565 OVS_REQUIRES(ofproto_mutex)
5567 if (m->flags & NXFMF_INITIAL) {
5568 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5573 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5574 uint64_t seqno, struct rule_collection *rules)
5575 OVS_REQUIRES(ofproto_mutex)
5577 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5581 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5582 OVS_REQUIRES(ofproto_mutex)
5584 struct ofmonitor *m;
5587 m = ofmonitor_lookup(ofconn, id);
5589 ofmonitor_destroy(m);
5592 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5599 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5600 OVS_EXCLUDED(ofproto_mutex)
5602 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5603 struct ofmonitor **monitors;
5604 size_t n_monitors, allocated_monitors;
5605 struct rule_collection rules;
5606 struct ovs_list replies;
5611 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5613 n_monitors = allocated_monitors = 0;
5615 ovs_mutex_lock(&ofproto_mutex);
5617 struct ofputil_flow_monitor_request request;
5618 struct ofmonitor *m;
5621 retval = ofputil_decode_flow_monitor_request(&request, &b);
5622 if (retval == EOF) {
5624 } else if (retval) {
5629 if (request.table_id != 0xff
5630 && request.table_id >= ofproto->n_tables) {
5631 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5635 error = ofmonitor_create(&request, ofconn, &m);
5640 if (n_monitors >= allocated_monitors) {
5641 monitors = x2nrealloc(monitors, &allocated_monitors,
5644 monitors[n_monitors++] = m;
5647 rule_collection_init(&rules);
5648 for (i = 0; i < n_monitors; i++) {
5649 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5652 ofpmp_init(&replies, oh);
5653 ofmonitor_compose_refresh_updates(&rules, &replies);
5654 ovs_mutex_unlock(&ofproto_mutex);
5656 rule_collection_destroy(&rules);
5658 ofconn_send_replies(ofconn, &replies);
5664 for (i = 0; i < n_monitors; i++) {
5665 ofmonitor_destroy(monitors[i]);
5668 ovs_mutex_unlock(&ofproto_mutex);
5674 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5675 OVS_EXCLUDED(ofproto_mutex)
5680 id = ofputil_decode_flow_monitor_cancel(oh);
5682 ovs_mutex_lock(&ofproto_mutex);
5683 error = flow_monitor_delete(ofconn, id);
5684 ovs_mutex_unlock(&ofproto_mutex);
5689 /* Meters implementation.
5691 * Meter table entry, indexed by the OpenFlow meter_id.
5692 * 'created' is used to compute the duration for meter stats.
5693 * 'list rules' is needed so that we can delete the dependent rules when the
5694 * meter table entry is deleted.
5695 * 'provider_meter_id' is for the provider's private use.
5698 long long int created; /* Time created. */
5699 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5700 ofproto_meter_id provider_meter_id;
5701 uint16_t flags; /* Meter flags. */
5702 uint16_t n_bands; /* Number of meter bands. */
5703 struct ofputil_meter_band *bands;
5707 * This is used in instruction validation at flow set-up time,
5708 * as flows may not use non-existing meters.
5709 * Return value of UINT32_MAX signifies an invalid meter.
5712 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5714 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5715 const struct meter *meter = ofproto->meters[of_meter_id];
5717 return meter->provider_meter_id.uint32;
5723 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5726 meter_insert_rule(struct rule *rule)
5728 const struct rule_actions *a = rule_get_actions(rule);
5729 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5730 struct meter *meter = rule->ofproto->meters[meter_id];
5732 list_insert(&meter->rules, &rule->meter_list_node);
5736 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5740 meter->flags = config->flags;
5741 meter->n_bands = config->n_bands;
5742 meter->bands = xmemdup(config->bands,
5743 config->n_bands * sizeof *meter->bands);
5746 static struct meter *
5747 meter_create(const struct ofputil_meter_config *config,
5748 ofproto_meter_id provider_meter_id)
5750 struct meter *meter;
5752 meter = xzalloc(sizeof *meter);
5753 meter->provider_meter_id = provider_meter_id;
5754 meter->created = time_msec();
5755 list_init(&meter->rules);
5757 meter_update(meter, config);
5763 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5764 OVS_REQUIRES(ofproto_mutex)
5767 for (mid = first; mid <= last; ++mid) {
5768 struct meter *meter = ofproto->meters[mid];
5770 ofproto->meters[mid] = NULL;
5771 ofproto->ofproto_class->meter_del(ofproto,
5772 meter->provider_meter_id);
5780 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5782 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5783 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5787 return OFPERR_OFPMMFC_METER_EXISTS;
5790 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5793 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5794 *meterp = meter_create(&mm->meter, provider_meter_id);
5800 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5802 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5804 uint32_t provider_meter_id;
5807 return OFPERR_OFPMMFC_UNKNOWN_METER;
5810 provider_meter_id = meter->provider_meter_id.uint32;
5811 error = ofproto->ofproto_class->meter_set(ofproto,
5812 &meter->provider_meter_id,
5814 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5816 meter_update(meter, &mm->meter);
5822 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5823 OVS_EXCLUDED(ofproto_mutex)
5825 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5826 uint32_t meter_id = mm->meter.meter_id;
5827 struct rule_collection rules;
5828 enum ofperr error = 0;
5829 uint32_t first, last;
5831 if (meter_id == OFPM13_ALL) {
5833 last = ofproto->meter_features.max_meters;
5835 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5838 first = last = meter_id;
5841 /* First delete the rules that use this meter. If any of those rules are
5842 * currently being modified, postpone the whole operation until later. */
5843 rule_collection_init(&rules);
5844 ovs_mutex_lock(&ofproto_mutex);
5845 for (meter_id = first; meter_id <= last; ++meter_id) {
5846 struct meter *meter = ofproto->meters[meter_id];
5847 if (meter && !list_is_empty(&meter->rules)) {
5850 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5851 rule_collection_add(&rules, rule);
5855 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5857 /* Delete the meters. */
5858 meter_delete(ofproto, first, last);
5860 ovs_mutex_unlock(&ofproto_mutex);
5866 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5868 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5869 struct ofputil_meter_mod mm;
5870 uint64_t bands_stub[256 / 8];
5871 struct ofpbuf bands;
5875 error = reject_slave_controller(ofconn);
5880 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5882 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5884 goto exit_free_bands;
5887 meter_id = mm.meter.meter_id;
5889 if (mm.command != OFPMC13_DELETE) {
5890 /* Fails also when meters are not implemented by the provider. */
5891 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5892 error = OFPERR_OFPMMFC_INVALID_METER;
5893 goto exit_free_bands;
5894 } else if (meter_id > ofproto->meter_features.max_meters) {
5895 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5896 goto exit_free_bands;
5898 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5899 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5900 goto exit_free_bands;
5904 switch (mm.command) {
5906 error = handle_add_meter(ofproto, &mm);
5909 case OFPMC13_MODIFY:
5910 error = handle_modify_meter(ofproto, &mm);
5913 case OFPMC13_DELETE:
5914 error = handle_delete_meter(ofconn, &mm);
5918 error = OFPERR_OFPMMFC_BAD_COMMAND;
5923 ofpbuf_uninit(&bands);
5928 handle_meter_features_request(struct ofconn *ofconn,
5929 const struct ofp_header *request)
5931 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5932 struct ofputil_meter_features features;
5935 if (ofproto->ofproto_class->meter_get_features) {
5936 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5938 memset(&features, 0, sizeof features);
5940 b = ofputil_encode_meter_features_reply(&features, request);
5942 ofconn_send_reply(ofconn, b);
5947 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5950 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5951 struct ovs_list replies;
5952 uint64_t bands_stub[256 / 8];
5953 struct ofpbuf bands;
5954 uint32_t meter_id, first, last;
5956 ofputil_decode_meter_request(request, &meter_id);
5958 if (meter_id == OFPM13_ALL) {
5960 last = ofproto->meter_features.max_meters;
5962 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5963 !ofproto->meters[meter_id]) {
5964 return OFPERR_OFPMMFC_UNKNOWN_METER;
5966 first = last = meter_id;
5969 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5970 ofpmp_init(&replies, request);
5972 for (meter_id = first; meter_id <= last; ++meter_id) {
5973 struct meter *meter = ofproto->meters[meter_id];
5975 continue; /* Skip non-existing meters. */
5977 if (type == OFPTYPE_METER_STATS_REQUEST) {
5978 struct ofputil_meter_stats stats;
5980 stats.meter_id = meter_id;
5982 /* Provider sets the packet and byte counts, we do the rest. */
5983 stats.flow_count = list_size(&meter->rules);
5984 calc_duration(meter->created, time_msec(),
5985 &stats.duration_sec, &stats.duration_nsec);
5986 stats.n_bands = meter->n_bands;
5987 ofpbuf_clear(&bands);
5989 = ofpbuf_put_uninit(&bands,
5990 meter->n_bands * sizeof *stats.bands);
5992 if (!ofproto->ofproto_class->meter_get(ofproto,
5993 meter->provider_meter_id,
5995 ofputil_append_meter_stats(&replies, &stats);
5997 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5998 struct ofputil_meter_config config;
6000 config.meter_id = meter_id;
6001 config.flags = meter->flags;
6002 config.n_bands = meter->n_bands;
6003 config.bands = meter->bands;
6004 ofputil_append_meter_config(&replies, &config);
6008 ofconn_send_replies(ofconn, &replies);
6009 ofpbuf_uninit(&bands);
6014 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
6015 struct ofgroup **group)
6016 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6018 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
6019 hash_int(group_id, 0), &ofproto->groups) {
6020 if ((*group)->group_id == group_id) {
6028 /* If the group exists, this function increments the groups's reference count.
6030 * Make sure to call ofproto_group_unref() after no longer needing to maintain
6031 * a reference to the group. */
6033 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
6034 struct ofgroup **group)
6038 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6039 found = ofproto_group_lookup__(ofproto, group_id, group);
6041 ofproto_group_ref(*group);
6043 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6048 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
6049 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
6051 struct ofgroup *grp;
6053 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
6054 hash_int(group_id, 0), &ofproto->groups) {
6055 if (grp->group_id == group_id) {
6063 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
6064 OVS_EXCLUDED(ofproto->groups_rwlock)
6068 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6069 exists = ofproto_group_exists__(ofproto, group_id);
6070 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6076 group_get_ref_count(struct ofgroup *group)
6077 OVS_EXCLUDED(ofproto_mutex)
6079 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
6080 struct rule_criteria criteria;
6081 struct rule_collection rules;
6086 match_init_catchall(&match);
6087 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
6088 htonll(0), OFPP_ANY, group->group_id);
6089 ovs_mutex_lock(&ofproto_mutex);
6090 error = collect_rules_loose(ofproto, &criteria, &rules);
6091 ovs_mutex_unlock(&ofproto_mutex);
6092 rule_criteria_destroy(&criteria);
6094 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
6096 rule_collection_destroy(&rules);
6101 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
6103 struct ofputil_group_stats ogs;
6104 const struct ofproto *ofproto = group->ofproto;
6105 long long int now = time_msec();
6108 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
6110 /* Provider sets the packet and byte counts, we do the rest. */
6111 ogs.ref_count = group_get_ref_count(group);
6112 ogs.n_buckets = group->n_buckets;
6114 error = (ofproto->ofproto_class->group_get_stats
6115 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
6118 ogs.packet_count = UINT64_MAX;
6119 ogs.byte_count = UINT64_MAX;
6120 memset(ogs.bucket_stats, 0xff,
6121 ogs.n_buckets * sizeof *ogs.bucket_stats);
6124 ogs.group_id = group->group_id;
6125 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
6127 ofputil_append_group_stats(replies, &ogs);
6129 free(ogs.bucket_stats);
6133 handle_group_request(struct ofconn *ofconn,
6134 const struct ofp_header *request, uint32_t group_id,
6135 void (*cb)(struct ofgroup *, struct ovs_list *replies))
6137 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6138 struct ofgroup *group;
6139 struct ovs_list replies;
6141 ofpmp_init(&replies, request);
6142 if (group_id == OFPG_ALL) {
6143 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
6144 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
6145 cb(group, &replies);
6147 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6149 if (ofproto_group_lookup(ofproto, group_id, &group)) {
6150 cb(group, &replies);
6151 ofproto_group_unref(group);
6154 ofconn_send_replies(ofconn, &replies);
6158 handle_group_stats_request(struct ofconn *ofconn,
6159 const struct ofp_header *request)
6164 error = ofputil_decode_group_stats_request(request, &group_id);
6169 handle_group_request(ofconn, request, group_id, append_group_stats);
6174 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
6176 struct ofputil_group_desc gds;
6178 gds.group_id = group->group_id;
6179 gds.type = group->type;
6180 gds.props = group->props;
6182 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
6186 handle_group_desc_stats_request(struct ofconn *ofconn,
6187 const struct ofp_header *request)
6189 handle_group_request(ofconn, request,
6190 ofputil_decode_group_desc_request(request),
6196 handle_group_features_stats_request(struct ofconn *ofconn,
6197 const struct ofp_header *request)
6199 struct ofproto *p = ofconn_get_ofproto(ofconn);
6202 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6204 ofconn_send_reply(ofconn, msg);
6211 handle_queue_get_config_request(struct ofconn *ofconn,
6212 const struct ofp_header *oh)
6214 struct ofproto *p = ofconn_get_ofproto(ofconn);
6215 struct netdev_queue_dump queue_dump;
6216 struct ofport *ofport;
6217 unsigned int queue_id;
6218 struct ofpbuf *reply;
6219 struct smap details;
6223 error = ofputil_decode_queue_get_config_request(oh, &request);
6228 ofport = ofproto_get_port(p, request);
6230 return OFPERR_OFPQOFC_BAD_PORT;
6233 reply = ofputil_encode_queue_get_config_reply(oh);
6235 smap_init(&details);
6236 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6237 struct ofputil_queue_config queue;
6239 /* None of the existing queues have compatible properties, so we
6240 * hard-code omitting min_rate and max_rate. */
6241 queue.queue_id = queue_id;
6242 queue.min_rate = UINT16_MAX;
6243 queue.max_rate = UINT16_MAX;
6244 ofputil_append_queue_get_config_reply(reply, &queue);
6246 smap_destroy(&details);
6248 ofconn_send_reply(ofconn, reply);
6254 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6255 struct ofgroup **ofgroup)
6258 const long long int now = time_msec();
6260 if (gm->group_id > OFPG_MAX) {
6261 return OFPERR_OFPGMFC_INVALID_GROUP;
6263 if (gm->type > OFPGT11_FF) {
6264 return OFPERR_OFPGMFC_BAD_TYPE;
6267 *ofgroup = ofproto->ofproto_class->group_alloc();
6269 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6270 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6273 (*ofgroup)->ofproto = ofproto;
6274 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6275 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6276 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6277 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6278 ovs_refcount_init(&(*ofgroup)->ref_count);
6280 list_move(&(*ofgroup)->buckets, &gm->buckets);
6281 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6282 list_size(&(*ofgroup)->buckets);
6284 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6285 &gm->props, sizeof (struct ofputil_group_props));
6287 /* Construct called BEFORE any locks are held. */
6288 error = ofproto->ofproto_class->group_construct(*ofgroup);
6290 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6291 ofproto->ofproto_class->group_dealloc(*ofgroup);
6296 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6297 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6300 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6302 struct ofgroup *ofgroup;
6305 /* Allocate new group and initialize it. */
6306 error = init_group(ofproto, gm, &ofgroup);
6311 /* We wrlock as late as possible to minimize the time we jam any other
6312 * threads: No visible state changes before acquiring the lock. */
6313 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6315 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6316 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6320 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6321 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6326 /* Insert new group. */
6327 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6328 hash_int(ofgroup->group_id, 0));
6329 ofproto->n_groups[ofgroup->type]++;
6331 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6336 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6337 ofproto->ofproto_class->group_destruct(ofgroup);
6338 ofputil_bucket_list_destroy(&ofgroup->buckets);
6339 ofproto->ofproto_class->group_dealloc(ofgroup);
6344 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6345 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6346 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6347 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6350 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6351 struct ofgroup *new_ofgroup,
6352 uint32_t command_bucket_id)
6354 struct ofputil_bucket *last = NULL;
6356 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6357 /* Check here to ensure that a bucket corresponding to
6358 * command_bucket_id exists in the old bucket list.
6360 * The subsequent search of below of new_ofgroup covers
6361 * both buckets in the old bucket list and buckets added
6362 * by the insert buckets group mod message this function processes. */
6363 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6364 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6367 if (!list_is_empty(&new_ofgroup->buckets)) {
6368 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6372 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6374 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6375 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6376 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6379 /* Rearrange list according to command_bucket_id */
6380 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6381 struct ofputil_bucket *new_first;
6382 const struct ofputil_bucket *first;
6384 first = ofputil_bucket_list_front(&ofgroup->buckets);
6385 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6388 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6389 &new_ofgroup->buckets);
6390 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6391 struct ofputil_bucket *after;
6393 /* Presence of bucket is checked above so after should never be NULL */
6394 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6396 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6397 last->list_node.next);
6403 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6404 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6405 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6406 * and OFPG15_BUCKET_ALL are also honored. */
6408 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6409 struct ofgroup *new_ofgroup,
6410 uint32_t command_bucket_id)
6412 const struct ofputil_bucket *skip = NULL;
6414 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6418 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6419 if (!list_is_empty(&ofgroup->buckets)) {
6420 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6422 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6423 if (!list_is_empty(&ofgroup->buckets)) {
6424 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6427 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6429 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6433 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6438 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6439 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6442 * Note that the group is re-created and then replaces the old group in
6443 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6444 * the xlate module hold a pointer to the group. */
6446 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6448 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6451 error = init_group(ofproto, gm, &new_ofgroup);
6456 retiring = new_ofgroup;
6458 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6459 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6460 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6464 /* Ofproto's group write lock is held now. */
6465 if (ofgroup->type != gm->type
6466 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6467 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6471 /* Manipulate bucket list for bucket commands */
6472 if (gm->command == OFPGC15_INSERT_BUCKET) {
6473 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6474 gm->command_bucket_id);
6475 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6476 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6477 gm->command_bucket_id);
6483 /* The group creation time does not change during modification. */
6484 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6485 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6487 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6493 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6494 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6495 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6496 hash_int(new_ofgroup->group_id, 0));
6497 if (ofgroup->type != new_ofgroup->type) {
6498 ofproto->n_groups[ofgroup->type]--;
6499 ofproto->n_groups[new_ofgroup->type]++;
6503 ofproto_group_unref(retiring);
6504 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6509 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6510 OVS_RELEASES(ofproto->groups_rwlock)
6513 struct ofproto_flow_mod ofm;
6515 /* Delete all flow entries containing this group in a group action */
6516 match_init_catchall(&match);
6517 flow_mod_init(&ofm.fm, &match, 0, NULL, 0, OFPFC_DELETE);
6518 ofm.fm.delete_reason = OFPRR_GROUP_DELETE;
6519 ofm.fm.out_group = ofgroup->group_id;
6520 handle_flow_mod__(ofproto, &ofm, NULL);
6522 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6523 /* No-one can find this group any more. */
6524 ofproto->n_groups[ofgroup->type]--;
6525 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6526 ofproto_group_unref(ofgroup);
6529 /* Implements OFPGC11_DELETE. */
6531 delete_group(struct ofproto *ofproto, uint32_t group_id)
6533 struct ofgroup *ofgroup;
6535 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6536 if (group_id == OFPG_ALL) {
6538 struct hmap_node *node = hmap_first(&ofproto->groups);
6542 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6543 delete_group__(ofproto, ofgroup);
6544 /* Lock for each node separately, so that we will not jam the
6545 * other threads for too long time. */
6546 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6549 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6550 hash_int(group_id, 0), &ofproto->groups) {
6551 if (ofgroup->group_id == group_id) {
6552 delete_group__(ofproto, ofgroup);
6557 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6560 /* Delete all groups from 'ofproto'.
6562 * This is intended for use within an ofproto provider's 'destruct'
6565 ofproto_group_delete_all(struct ofproto *ofproto)
6567 delete_group(ofproto, OFPG_ALL);
6571 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6573 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6574 struct ofputil_group_mod gm;
6577 error = reject_slave_controller(ofconn);
6582 error = ofputil_decode_group_mod(oh, &gm);
6587 switch (gm.command) {
6589 return add_group(ofproto, &gm);
6591 case OFPGC11_MODIFY:
6592 return modify_group(ofproto, &gm);
6594 case OFPGC11_DELETE:
6595 delete_group(ofproto, gm.group_id);
6598 case OFPGC15_INSERT_BUCKET:
6599 return modify_group(ofproto, &gm);
6601 case OFPGC15_REMOVE_BUCKET:
6602 return modify_group(ofproto, &gm);
6605 if (gm.command > OFPGC11_DELETE) {
6606 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6607 ofproto->name, gm.command);
6609 return OFPERR_OFPGMFC_BAD_COMMAND;
6613 enum ofputil_table_miss
6614 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6616 enum ofputil_table_miss miss;
6618 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &miss);
6623 table_mod__(struct oftable *oftable,
6624 enum ofputil_table_miss miss, enum ofputil_table_eviction eviction)
6626 if (miss == OFPUTIL_TABLE_MISS_DEFAULT) {
6627 /* This is how an OFPT_TABLE_MOD decodes if it doesn't specify any
6628 * table-miss configuration (because the protocol used doesn't have
6629 * such a concept), so there's nothing to do. */
6631 atomic_store_relaxed(&oftable->miss_config, miss);
6634 unsigned int new_eviction = oftable->eviction;
6635 if (eviction == OFPUTIL_TABLE_EVICTION_ON) {
6636 new_eviction |= EVICTION_OPENFLOW;
6637 } else if (eviction == OFPUTIL_TABLE_EVICTION_OFF) {
6638 new_eviction &= ~EVICTION_OPENFLOW;
6641 if (new_eviction != oftable->eviction) {
6642 ovs_mutex_lock(&ofproto_mutex);
6643 oftable_configure_eviction(oftable, new_eviction,
6644 oftable->eviction_fields,
6645 oftable->n_eviction_fields);
6646 ovs_mutex_unlock(&ofproto_mutex);
6651 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6653 if (!check_table_id(ofproto, tm->table_id)) {
6654 return OFPERR_OFPTMFC_BAD_TABLE;
6657 /* Don't allow the eviction flags to be changed (except to the only fixed
6658 * value that OVS supports). OF1.4 says this is normal: "The
6659 * OFPTMPT_EVICTION property usually cannot be modified using a
6660 * OFP_TABLE_MOD request, because the eviction mechanism is switch
6662 if (tm->eviction_flags != UINT32_MAX
6663 && tm->eviction_flags != OFPROTO_EVICTION_FLAGS) {
6664 return OFPERR_OFPTMFC_BAD_CONFIG;
6667 if (tm->table_id == OFPTT_ALL) {
6668 struct oftable *oftable;
6669 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6670 if (!(oftable->flags & (OFTABLE_HIDDEN | OFTABLE_READONLY))) {
6671 table_mod__(oftable, tm->miss, tm->eviction);
6675 struct oftable *oftable = &ofproto->tables[tm->table_id];
6676 if (oftable->flags & OFTABLE_READONLY) {
6677 return OFPERR_OFPTMFC_EPERM;
6679 table_mod__(oftable, tm->miss, tm->eviction);
6686 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6688 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6689 struct ofputil_table_mod tm;
6692 error = reject_slave_controller(ofconn);
6697 error = ofputil_decode_table_mod(oh, &tm);
6702 return table_mod(ofproto, &tm);
6706 ofproto_flow_mod_start(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6707 OVS_REQUIRES(ofproto_mutex)
6709 switch (ofm->fm.command) {
6711 return add_flow_start(ofproto, ofm);
6712 /* , &be->old_rules.stub[0],
6713 &be->new_rules.stub[0]); */
6715 return modify_flows_start_loose(ofproto, ofm);
6716 case OFPFC_MODIFY_STRICT:
6717 return modify_flow_start_strict(ofproto, ofm);
6719 return delete_flows_start_loose(ofproto, ofm);
6721 case OFPFC_DELETE_STRICT:
6722 return delete_flow_start_strict(ofproto, ofm);
6725 return OFPERR_OFPFMFC_BAD_COMMAND;
6729 ofproto_flow_mod_revert(struct ofproto *ofproto, struct ofproto_flow_mod *ofm)
6730 OVS_REQUIRES(ofproto_mutex)
6732 switch (ofm->fm.command) {
6734 add_flow_revert(ofproto, ofm);
6738 case OFPFC_MODIFY_STRICT:
6739 modify_flows_revert(ofproto, ofm);
6743 case OFPFC_DELETE_STRICT:
6744 delete_flows_revert(ofproto, ofm);
6753 ofproto_flow_mod_finish(struct ofproto *ofproto,
6754 struct ofproto_flow_mod *ofm,
6755 const struct flow_mod_requester *req)
6756 OVS_REQUIRES(ofproto_mutex)
6758 switch (ofm->fm.command) {
6760 add_flow_finish(ofproto, ofm, req);
6764 case OFPFC_MODIFY_STRICT:
6765 modify_flows_finish(ofproto, ofm, req);
6769 case OFPFC_DELETE_STRICT:
6770 delete_flows_finish(ofproto, ofm, req);
6778 /* Commit phases (all while locking ofproto_mutex):
6780 * 1. Begin: Gather resources and make changes visible in the next version.
6781 * - Mark affected rules for removal in the next version.
6782 * - Create new replacement rules, make visible in the next
6784 * - Do not send any events or notifications.
6786 * 2. Revert: Fail if any errors are found. After this point no errors are
6787 * possible. No visible changes were made, so rollback is minimal (remove
6788 * added invisible rules, restore visibility of rules marked for removal).
6790 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
6791 * the ofproto provider. Remove replaced and deleted rules from ofproto data
6792 * structures, and Schedule postponed removal of deleted rules from the
6793 * classifier. Send notifications, buffered packets, etc.
6796 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6798 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6799 cls_version_t version = ofproto->tables_version + 1;
6800 struct ofp_bundle *bundle;
6801 struct ofp_bundle_entry *be;
6804 bundle = ofconn_get_bundle(ofconn, id);
6807 return OFPERR_OFPBFC_BAD_ID;
6809 if (bundle->flags != flags) {
6810 error = OFPERR_OFPBFC_BAD_FLAGS;
6812 bool prev_is_port_mod = false;
6815 ovs_mutex_lock(&ofproto_mutex);
6818 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6819 if (be->type == OFPTYPE_PORT_MOD) {
6820 /* Our port mods are not atomic. */
6821 if (flags & OFPBF_ATOMIC) {
6822 error = OFPERR_OFPBFC_MSG_FAILED;
6824 prev_is_port_mod = true;
6825 error = port_mod_start(ofconn, &be->opm.pm, &be->opm.port);
6827 } else if (be->type == OFPTYPE_FLOW_MOD) {
6828 /* Flow mods between port mods are applied as a single
6829 * version, but the versions are published only after
6830 * we know the commit is successful. */
6831 if (prev_is_port_mod) {
6834 prev_is_port_mod = false;
6835 /* Store the version in which the changes should take
6837 be->ofm.version = version;
6838 error = ofproto_flow_mod_start(ofproto, &be->ofm);
6848 /* Send error referring to the original message. */
6850 ofconn_send_error(ofconn, be->ofp_msg, error);
6851 error = OFPERR_OFPBFC_MSG_FAILED;
6854 /* 2. Revert. Undo all the changes made above. */
6855 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6856 if (be->type == OFPTYPE_FLOW_MOD) {
6857 ofproto_flow_mod_revert(ofproto, &be->ofm);
6859 /* Nothing needs to be reverted for a port mod. */
6863 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6864 if (be->type == OFPTYPE_FLOW_MOD) {
6865 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6867 /* Bump the lookup version to the one of the current
6868 * message. This makes all the changes in the bundle at
6869 * this version visible to lookups at once. */
6870 if (ofproto->tables_version < be->ofm.version) {
6871 ofproto->tables_version = be->ofm.version;
6872 ofproto->ofproto_class->set_tables_version(
6873 ofproto, ofproto->tables_version);
6876 ofproto_flow_mod_finish(ofproto, &be->ofm, &req);
6877 } else if (be->type == OFPTYPE_PORT_MOD) {
6878 /* Perform the actual port mod. This is not atomic, i.e.,
6879 * the effects will be immediately seen by upcall
6880 * processing regardless of the lookup version. It should
6881 * be noted that port configuration changes can originate
6882 * also from OVSDB changes asynchronously to all upcall
6884 port_mod_finish(ofconn, &be->opm.pm, be->opm.port);
6889 ofmonitor_flush(ofproto->connmgr);
6890 ovs_mutex_unlock(&ofproto_mutex);
6892 run_rule_executes(ofproto);
6895 /* The bundle is discarded regardless the outcome. */
6896 ofp_bundle_remove__(ofconn, bundle, !error);
6901 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6903 struct ofputil_bundle_ctrl_msg bctrl;
6904 struct ofputil_bundle_ctrl_msg reply;
6908 error = reject_slave_controller(ofconn);
6913 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6918 reply.bundle_id = bctrl.bundle_id;
6920 switch (bctrl.type) {
6921 case OFPBCT_OPEN_REQUEST:
6922 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6923 reply.type = OFPBCT_OPEN_REPLY;
6925 case OFPBCT_CLOSE_REQUEST:
6926 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6927 reply.type = OFPBCT_CLOSE_REPLY;;
6929 case OFPBCT_COMMIT_REQUEST:
6930 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6931 reply.type = OFPBCT_COMMIT_REPLY;
6933 case OFPBCT_DISCARD_REQUEST:
6934 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6935 reply.type = OFPBCT_DISCARD_REPLY;
6938 case OFPBCT_OPEN_REPLY:
6939 case OFPBCT_CLOSE_REPLY:
6940 case OFPBCT_COMMIT_REPLY:
6941 case OFPBCT_DISCARD_REPLY:
6942 return OFPERR_OFPBFC_BAD_TYPE;
6947 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6948 ofconn_send_reply(ofconn, buf);
6954 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6956 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6958 struct ofputil_bundle_add_msg badd;
6959 struct ofp_bundle_entry *bmsg;
6962 error = reject_slave_controller(ofconn);
6967 error = ofputil_decode_bundle_add(oh, &badd, &type);
6972 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
6974 if (type == OFPTYPE_PORT_MOD) {
6975 error = ofputil_decode_port_mod(badd.msg, &bmsg->opm.pm, false);
6976 } else if (type == OFPTYPE_FLOW_MOD) {
6977 struct ofpbuf ofpacts;
6978 uint64_t ofpacts_stub[1024 / 8];
6980 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6981 error = ofputil_decode_flow_mod(&bmsg->ofm.fm, badd.msg,
6982 ofconn_get_protocol(ofconn),
6984 u16_to_ofp(ofproto->max_ports),
6986 /* Move actions to heap. */
6987 bmsg->ofm.fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6989 if (!error && bmsg->ofm.fm.ofpacts_len) {
6990 error = ofproto_check_ofpacts(ofproto, bmsg->ofm.fm.ofpacts,
6991 bmsg->ofm.fm.ofpacts_len);
6998 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
7003 ofp_bundle_entry_free(bmsg);
7010 handle_geneve_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
7012 struct ofputil_geneve_table_mod gtm;
7015 error = reject_slave_controller(ofconn);
7020 error = ofputil_decode_geneve_table_mod(oh, >m);
7025 error = tun_metadata_table_mod(>m);
7027 ofputil_uninit_geneve_table(>m.mappings);
7032 handle_geneve_table_request(struct ofconn *ofconn, const struct ofp_header *oh)
7034 struct ofputil_geneve_table_reply gtr;
7037 tun_metadata_table_request(>r);
7038 b = ofputil_encode_geneve_table_reply(oh, >r);
7039 ofputil_uninit_geneve_table(>r.mappings);
7041 ofconn_send_reply(ofconn, b);
7046 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
7047 OVS_EXCLUDED(ofproto_mutex)
7049 const struct ofp_header *oh = msg->data;
7053 error = ofptype_decode(&type, oh);
7057 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
7058 && ofpmp_more(oh)) {
7059 /* We have no buffer implementation for multipart requests.
7060 * Report overflow for requests which consists of multiple
7062 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
7066 /* OpenFlow requests. */
7067 case OFPTYPE_ECHO_REQUEST:
7068 return handle_echo_request(ofconn, oh);
7070 case OFPTYPE_FEATURES_REQUEST:
7071 return handle_features_request(ofconn, oh);
7073 case OFPTYPE_GET_CONFIG_REQUEST:
7074 return handle_get_config_request(ofconn, oh);
7076 case OFPTYPE_SET_CONFIG:
7077 return handle_set_config(ofconn, oh);
7079 case OFPTYPE_PACKET_OUT:
7080 return handle_packet_out(ofconn, oh);
7082 case OFPTYPE_PORT_MOD:
7083 return handle_port_mod(ofconn, oh);
7085 case OFPTYPE_FLOW_MOD:
7086 return handle_flow_mod(ofconn, oh);
7088 case OFPTYPE_GROUP_MOD:
7089 return handle_group_mod(ofconn, oh);
7091 case OFPTYPE_TABLE_MOD:
7092 return handle_table_mod(ofconn, oh);
7094 case OFPTYPE_METER_MOD:
7095 return handle_meter_mod(ofconn, oh);
7097 case OFPTYPE_BARRIER_REQUEST:
7098 return handle_barrier_request(ofconn, oh);
7100 case OFPTYPE_ROLE_REQUEST:
7101 return handle_role_request(ofconn, oh);
7103 /* OpenFlow replies. */
7104 case OFPTYPE_ECHO_REPLY:
7107 /* Nicira extension requests. */
7108 case OFPTYPE_FLOW_MOD_TABLE_ID:
7109 return handle_nxt_flow_mod_table_id(ofconn, oh);
7111 case OFPTYPE_SET_FLOW_FORMAT:
7112 return handle_nxt_set_flow_format(ofconn, oh);
7114 case OFPTYPE_SET_PACKET_IN_FORMAT:
7115 return handle_nxt_set_packet_in_format(ofconn, oh);
7117 case OFPTYPE_SET_CONTROLLER_ID:
7118 return handle_nxt_set_controller_id(ofconn, oh);
7120 case OFPTYPE_FLOW_AGE:
7121 /* Nothing to do. */
7124 case OFPTYPE_FLOW_MONITOR_CANCEL:
7125 return handle_flow_monitor_cancel(ofconn, oh);
7127 case OFPTYPE_SET_ASYNC_CONFIG:
7128 return handle_nxt_set_async_config(ofconn, oh);
7130 case OFPTYPE_GET_ASYNC_REQUEST:
7131 return handle_nxt_get_async_request(ofconn, oh);
7133 /* Statistics requests. */
7134 case OFPTYPE_DESC_STATS_REQUEST:
7135 return handle_desc_stats_request(ofconn, oh);
7137 case OFPTYPE_FLOW_STATS_REQUEST:
7138 return handle_flow_stats_request(ofconn, oh);
7140 case OFPTYPE_AGGREGATE_STATS_REQUEST:
7141 return handle_aggregate_stats_request(ofconn, oh);
7143 case OFPTYPE_TABLE_STATS_REQUEST:
7144 return handle_table_stats_request(ofconn, oh);
7146 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
7147 return handle_table_features_request(ofconn, oh);
7149 case OFPTYPE_TABLE_DESC_REQUEST:
7150 return handle_table_desc_request(ofconn, oh);
7152 case OFPTYPE_PORT_STATS_REQUEST:
7153 return handle_port_stats_request(ofconn, oh);
7155 case OFPTYPE_QUEUE_STATS_REQUEST:
7156 return handle_queue_stats_request(ofconn, oh);
7158 case OFPTYPE_PORT_DESC_STATS_REQUEST:
7159 return handle_port_desc_stats_request(ofconn, oh);
7161 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
7162 return handle_flow_monitor_request(ofconn, oh);
7164 case OFPTYPE_METER_STATS_REQUEST:
7165 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
7166 return handle_meter_request(ofconn, oh, type);
7168 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
7169 return handle_meter_features_request(ofconn, oh);
7171 case OFPTYPE_GROUP_STATS_REQUEST:
7172 return handle_group_stats_request(ofconn, oh);
7174 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
7175 return handle_group_desc_stats_request(ofconn, oh);
7177 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
7178 return handle_group_features_stats_request(ofconn, oh);
7180 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
7181 return handle_queue_get_config_request(ofconn, oh);
7183 case OFPTYPE_BUNDLE_CONTROL:
7184 return handle_bundle_control(ofconn, oh);
7186 case OFPTYPE_BUNDLE_ADD_MESSAGE:
7187 return handle_bundle_add(ofconn, oh);
7189 case OFPTYPE_NXT_GENEVE_TABLE_MOD:
7190 return handle_geneve_table_mod(ofconn, oh);
7192 case OFPTYPE_NXT_GENEVE_TABLE_REQUEST:
7193 return handle_geneve_table_request(ofconn, oh);
7197 case OFPTYPE_FEATURES_REPLY:
7198 case OFPTYPE_GET_CONFIG_REPLY:
7199 case OFPTYPE_PACKET_IN:
7200 case OFPTYPE_FLOW_REMOVED:
7201 case OFPTYPE_PORT_STATUS:
7202 case OFPTYPE_BARRIER_REPLY:
7203 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
7204 case OFPTYPE_DESC_STATS_REPLY:
7205 case OFPTYPE_FLOW_STATS_REPLY:
7206 case OFPTYPE_QUEUE_STATS_REPLY:
7207 case OFPTYPE_PORT_STATS_REPLY:
7208 case OFPTYPE_TABLE_STATS_REPLY:
7209 case OFPTYPE_AGGREGATE_STATS_REPLY:
7210 case OFPTYPE_PORT_DESC_STATS_REPLY:
7211 case OFPTYPE_ROLE_REPLY:
7212 case OFPTYPE_FLOW_MONITOR_PAUSED:
7213 case OFPTYPE_FLOW_MONITOR_RESUMED:
7214 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
7215 case OFPTYPE_GET_ASYNC_REPLY:
7216 case OFPTYPE_GROUP_STATS_REPLY:
7217 case OFPTYPE_GROUP_DESC_STATS_REPLY:
7218 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
7219 case OFPTYPE_METER_STATS_REPLY:
7220 case OFPTYPE_METER_CONFIG_STATS_REPLY:
7221 case OFPTYPE_METER_FEATURES_STATS_REPLY:
7222 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
7223 case OFPTYPE_TABLE_DESC_REPLY:
7224 case OFPTYPE_ROLE_STATUS:
7225 case OFPTYPE_NXT_GENEVE_TABLE_REPLY:
7227 if (ofpmsg_is_stat_request(oh)) {
7228 return OFPERR_OFPBRC_BAD_STAT;
7230 return OFPERR_OFPBRC_BAD_TYPE;
7236 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
7237 OVS_EXCLUDED(ofproto_mutex)
7239 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
7242 ofconn_send_error(ofconn, ofp_msg->data, error);
7244 COVERAGE_INC(ofproto_recv_openflow);
7247 /* Asynchronous operations. */
7250 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
7252 OVS_REQUIRES(ofproto_mutex)
7254 if (req && req->ofconn && buffer_id != UINT32_MAX) {
7255 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
7256 struct dp_packet *packet;
7260 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
7263 struct rule_execute *re;
7265 ofproto_rule_ref(rule);
7267 re = xmalloc(sizeof *re);
7269 re->in_port = in_port;
7270 re->packet = packet;
7272 if (!guarded_list_push_back(&ofproto->rule_executes,
7273 &re->list_node, 1024)) {
7274 ofproto_rule_unref(rule);
7275 dp_packet_delete(re->packet);
7279 ofconn_send_error(req->ofconn, req->request, error);
7285 pick_datapath_id(const struct ofproto *ofproto)
7287 const struct ofport *port;
7289 port = ofproto_get_port(ofproto, OFPP_LOCAL);
7291 uint8_t ea[ETH_ADDR_LEN];
7294 error = netdev_get_etheraddr(port->netdev, ea);
7296 return eth_addr_to_uint64(ea);
7298 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7299 ofproto->name, netdev_get_name(port->netdev),
7300 ovs_strerror(error));
7302 return ofproto->fallback_dpid;
7306 pick_fallback_dpid(void)
7308 uint8_t ea[ETH_ADDR_LEN];
7309 eth_addr_nicira_random(ea);
7310 return eth_addr_to_uint64(ea);
7313 /* Table overflow policy. */
7315 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7316 * to NULL if the table is not configured to evict rules or if the table
7317 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7318 * or with no timeouts are not evictable.) */
7320 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
7321 OVS_REQUIRES(ofproto_mutex)
7323 struct eviction_group *evg;
7326 if (!table->eviction) {
7330 /* In the common case, the outer and inner loops here will each be entered
7333 * - The inner loop normally "return"s in its first iteration. If the
7334 * eviction group has any evictable rules, then it always returns in
7337 * - The outer loop only iterates more than once if the largest eviction
7338 * group has no evictable rules.
7340 * - The outer loop can exit only if table's 'max_flows' is all filled up
7341 * by unevictable rules. */
7342 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7345 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7354 /* Eviction groups. */
7356 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7357 * rules. The priority contains low-order random bits to ensure that eviction
7358 * groups with the same number of rules are prioritized randomly. */
7360 eviction_group_priority(size_t n_rules)
7362 uint16_t size = MIN(UINT16_MAX, n_rules);
7363 return (size << 16) | random_uint16();
7366 /* Updates 'evg', an eviction_group within 'table', following a change that
7367 * adds or removes rules in 'evg'. */
7369 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7370 OVS_REQUIRES(ofproto_mutex)
7372 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7373 eviction_group_priority(heap_count(&evg->rules)));
7376 /* Destroys 'evg', an eviction_group within 'table':
7378 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7379 * rules themselves, just removes them from the eviction group.)
7381 * - Removes 'evg' from 'table'.
7385 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7386 OVS_REQUIRES(ofproto_mutex)
7388 while (!heap_is_empty(&evg->rules)) {
7391 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7392 rule->eviction_group = NULL;
7394 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7395 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7396 heap_destroy(&evg->rules);
7400 /* Removes 'rule' from its eviction group, if any. */
7402 eviction_group_remove_rule(struct rule *rule)
7403 OVS_REQUIRES(ofproto_mutex)
7405 if (rule->eviction_group) {
7406 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7407 struct eviction_group *evg = rule->eviction_group;
7409 rule->eviction_group = NULL;
7410 heap_remove(&evg->rules, &rule->evg_node);
7411 if (heap_is_empty(&evg->rules)) {
7412 eviction_group_destroy(table, evg);
7414 eviction_group_resized(table, evg);
7419 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7420 * returns the hash value. */
7422 eviction_group_hash_rule(struct rule *rule)
7423 OVS_REQUIRES(ofproto_mutex)
7425 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7426 const struct mf_subfield *sf;
7430 hash = table->eviction_group_id_basis;
7431 miniflow_expand(&rule->cr.match.flow, &flow);
7432 for (sf = table->eviction_fields;
7433 sf < &table->eviction_fields[table->n_eviction_fields];
7436 if (mf_are_prereqs_ok(sf->field, &flow)) {
7437 union mf_value value;
7439 mf_get_value(sf->field, &flow, &value);
7441 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7443 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7444 unsigned int start = sf->ofs + sf->n_bits;
7445 bitwise_zero(&value, sf->field->n_bytes, start,
7446 sf->field->n_bytes * 8 - start);
7448 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7450 hash = hash_int(hash, 0);
7457 /* Returns an eviction group within 'table' with the given 'id', creating one
7459 static struct eviction_group *
7460 eviction_group_find(struct oftable *table, uint32_t id)
7461 OVS_REQUIRES(ofproto_mutex)
7463 struct eviction_group *evg;
7465 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7469 evg = xmalloc(sizeof *evg);
7470 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7471 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7472 eviction_group_priority(0));
7473 heap_init(&evg->rules);
7478 /* Returns an eviction priority for 'rule'. The return value should be
7479 * interpreted so that higher priorities make a rule a more attractive
7480 * candidate for eviction. */
7482 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7483 OVS_REQUIRES(ofproto_mutex)
7485 /* Calculate absolute time when this flow will expire. If it will never
7486 * expire, then return 0 to make it unevictable. */
7487 long long int expiration = LLONG_MAX;
7488 if (rule->hard_timeout) {
7489 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7490 ovs_mutex_lock(&rule->mutex);
7491 long long int modified = rule->modified;
7492 ovs_mutex_unlock(&rule->mutex);
7494 expiration = modified + rule->hard_timeout * 1000;
7496 if (rule->idle_timeout) {
7497 uint64_t packets, bytes;
7499 long long int idle_expiration;
7501 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7502 idle_expiration = used + rule->idle_timeout * 1000;
7503 expiration = MIN(expiration, idle_expiration);
7505 if (expiration == LLONG_MAX) {
7509 /* Calculate the time of expiration as a number of (approximate) seconds
7510 * after program startup.
7512 * This should work OK for program runs that last UINT32_MAX seconds or
7513 * less. Therefore, please restart OVS at least once every 136 years. */
7514 uint32_t expiration_ofs = (expiration >> 10) - (time_boot_msec() >> 10);
7516 /* Combine expiration time with OpenFlow "importance" to form a single
7517 * priority value. We want flows with relatively low "importance" to be
7518 * evicted before even considering expiration time, so put "importance" in
7519 * the most significant bits and expiration time in the least significant
7522 * Small 'priority' should be evicted before those with large 'priority'.
7523 * The caller expects the opposite convention (a large return value being
7524 * more attractive for eviction) so we invert it before returning. */
7525 uint64_t priority = ((uint64_t) rule->importance << 32) + expiration_ofs;
7526 return UINT64_MAX - priority;
7529 /* Adds 'rule' to an appropriate eviction group for its oftable's
7530 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7531 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7534 * The caller must ensure that 'rule' is not already in an eviction group. */
7536 eviction_group_add_rule(struct rule *rule)
7537 OVS_REQUIRES(ofproto_mutex)
7539 struct ofproto *ofproto = rule->ofproto;
7540 struct oftable *table = &ofproto->tables[rule->table_id];
7543 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7544 * so no additional protection is needed. */
7545 has_timeout = rule->hard_timeout || rule->idle_timeout;
7547 if (table->eviction && has_timeout) {
7548 struct eviction_group *evg;
7550 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7552 rule->eviction_group = evg;
7553 heap_insert(&evg->rules, &rule->evg_node,
7554 rule_eviction_priority(ofproto, rule));
7555 eviction_group_resized(table, evg);
7561 /* Initializes 'table'. */
7563 oftable_init(struct oftable *table)
7565 memset(table, 0, sizeof *table);
7566 classifier_init(&table->cls, flow_segment_u64s);
7567 table->max_flows = UINT_MAX;
7569 hmap_init(&table->eviction_groups_by_id);
7570 heap_init(&table->eviction_groups_by_size);
7571 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7573 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7574 ARRAY_SIZE(default_prefix_fields));
7576 atomic_init(&table->n_matched, 0);
7577 atomic_init(&table->n_missed, 0);
7580 /* Destroys 'table', including its classifier and eviction groups.
7582 * The caller is responsible for freeing 'table' itself. */
7584 oftable_destroy(struct oftable *table)
7586 ovs_assert(classifier_is_empty(&table->cls));
7588 ovs_mutex_lock(&ofproto_mutex);
7589 oftable_configure_eviction(table, 0, NULL, 0);
7590 ovs_mutex_unlock(&ofproto_mutex);
7592 hmap_destroy(&table->eviction_groups_by_id);
7593 heap_destroy(&table->eviction_groups_by_size);
7594 classifier_destroy(&table->cls);
7598 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7599 * string, then 'table' will use its default name.
7601 * This only affects the name exposed for a table exposed through the OpenFlow
7602 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7604 oftable_set_name(struct oftable *table, const char *name)
7606 if (name && name[0]) {
7607 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7608 if (!table->name || strncmp(name, table->name, len)) {
7610 table->name = xmemdup0(name, len);
7618 /* oftables support a choice of two policies when adding a rule would cause the
7619 * number of flows in the table to exceed the configured maximum number: either
7620 * they can refuse to add the new flow or they can evict some existing flow.
7621 * This function configures the latter policy on 'table', with fairness based
7622 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7623 * 'n_fields' as 0 disables fairness.) */
7625 oftable_configure_eviction(struct oftable *table, unsigned int eviction,
7626 const struct mf_subfield *fields, size_t n_fields)
7627 OVS_REQUIRES(ofproto_mutex)
7631 if ((table->eviction != 0) == (eviction != 0)
7632 && n_fields == table->n_eviction_fields
7634 || !memcmp(fields, table->eviction_fields,
7635 n_fields * sizeof *fields))) {
7636 /* The set of eviction fields did not change. If 'eviction' changed,
7637 * it remains nonzero, so that we can just update table->eviction
7638 * without fussing with the eviction groups. */
7639 table->eviction = eviction;
7643 /* Destroy existing eviction groups, then destroy and recreate data
7644 * structures to recover memory. */
7645 struct eviction_group *evg, *next;
7646 HMAP_FOR_EACH_SAFE (evg, next, id_node, &table->eviction_groups_by_id) {
7647 eviction_group_destroy(table, evg);
7649 hmap_destroy(&table->eviction_groups_by_id);
7650 hmap_init(&table->eviction_groups_by_id);
7651 heap_destroy(&table->eviction_groups_by_size);
7652 heap_init(&table->eviction_groups_by_size);
7654 /* Replace eviction groups by the new ones, if there is a change. Free the
7655 * old fields only after allocating the new ones, because 'fields ==
7656 * table->eviction_fields' is possible. */
7657 struct mf_subfield *old_fields = table->eviction_fields;
7658 table->n_eviction_fields = n_fields;
7659 table->eviction_fields = (fields
7660 ? xmemdup(fields, n_fields * sizeof *fields)
7664 /* Add the new eviction groups, if enabled. */
7665 table->eviction = eviction;
7666 if (table->eviction) {
7667 table->eviction_group_id_basis = random_uint32();
7668 CLS_FOR_EACH (rule, cr, &table->cls) {
7669 eviction_group_add_rule(rule);
7674 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7675 * it to the classifier. */
7677 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7678 OVS_REQUIRES(ofproto_mutex)
7680 const struct rule_actions *actions = rule_get_actions(rule);
7682 ovs_assert(rule->removed);
7684 if (rule->hard_timeout || rule->idle_timeout) {
7685 list_insert(&ofproto->expirable, &rule->expirable);
7687 cookies_insert(ofproto, rule);
7688 eviction_group_add_rule(rule);
7689 if (actions->has_meter) {
7690 meter_insert_rule(rule);
7692 rule->removed = false;
7695 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7696 * the removal from the classifier. */
7698 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7699 OVS_REQUIRES(ofproto_mutex)
7701 ovs_assert(!rule->removed);
7703 cookies_remove(ofproto, rule);
7705 eviction_group_remove_rule(rule);
7706 if (!list_is_empty(&rule->expirable)) {
7707 list_remove(&rule->expirable);
7709 if (!list_is_empty(&rule->meter_list_node)) {
7710 list_remove(&rule->meter_list_node);
7711 list_init(&rule->meter_list_node);
7714 rule->removed = true;
7717 /* unixctl commands. */
7720 ofproto_lookup(const char *name)
7722 struct ofproto *ofproto;
7724 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7726 if (!strcmp(ofproto->name, name)) {
7734 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7735 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7737 struct ofproto *ofproto;
7741 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7742 ds_put_format(&results, "%s\n", ofproto->name);
7744 unixctl_command_reply(conn, ds_cstr(&results));
7745 ds_destroy(&results);
7749 ofproto_unixctl_init(void)
7751 static bool registered;
7757 unixctl_command_register("ofproto/list", "", 0, 0,
7758 ofproto_unixctl_list, NULL);
7761 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7763 * This is deprecated. It is only for compatibility with broken device drivers
7764 * in old versions of Linux that do not properly support VLANs when VLAN
7765 * devices are not used. When broken device drivers are no longer in
7766 * widespread use, we will delete these interfaces. */
7768 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7769 * (exactly) by an OpenFlow rule in 'ofproto'. */
7771 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7774 struct cls_rule target;
7775 const struct oftable *oftable;
7777 match_init_catchall(&match);
7778 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7779 cls_rule_init(&target, &match, 0, CLS_MAX_VERSION);
7781 free(ofproto->vlan_bitmap);
7782 ofproto->vlan_bitmap = bitmap_allocate(4096);
7783 ofproto->vlans_changed = false;
7785 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7788 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7789 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7790 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7792 bitmap_set1(vlan_bitmap, vid);
7793 bitmap_set1(ofproto->vlan_bitmap, vid);
7798 cls_rule_destroy(&target);
7801 /* Returns true if new VLANs have come into use by the flow table since the
7802 * last call to ofproto_get_vlan_usage().
7804 * We don't track when old VLANs stop being used. */
7806 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7808 return ofproto->vlans_changed;
7811 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7812 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7813 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7814 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7815 * then the VLAN device is un-enslaved. */
7817 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7818 ofp_port_t realdev_ofp_port, int vid)
7820 struct ofport *ofport;
7823 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7825 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7827 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7828 ofproto->name, vlandev_ofp_port);
7832 if (!ofproto->ofproto_class->set_realdev) {
7833 if (!vlandev_ofp_port) {
7836 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7840 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7842 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7843 ofproto->name, vlandev_ofp_port,
7844 netdev_get_name(ofport->netdev), ovs_strerror(error));