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 "unaligned.h"
61 #include "openvswitch/vlog.h"
64 VLOG_DEFINE_THIS_MODULE(ofproto);
66 COVERAGE_DEFINE(ofproto_flush);
67 COVERAGE_DEFINE(ofproto_packet_out);
68 COVERAGE_DEFINE(ofproto_queue_req);
69 COVERAGE_DEFINE(ofproto_recv_openflow);
70 COVERAGE_DEFINE(ofproto_reinit_ports);
71 COVERAGE_DEFINE(ofproto_update_port);
73 /* Default fields to use for prefix tries in each flow table, unless something
74 * else is configured. */
75 const enum mf_field_id default_prefix_fields[2] =
76 { MFF_IPV4_DST, MFF_IPV4_SRC };
79 static void oftable_init(struct oftable *);
80 static void oftable_destroy(struct oftable *);
82 static void oftable_set_name(struct oftable *, const char *name);
84 static enum ofperr evict_rules_from_table(struct oftable *,
85 unsigned int extra_space)
86 OVS_REQUIRES(ofproto_mutex);
87 static void oftable_disable_eviction(struct oftable *);
88 static void oftable_enable_eviction(struct oftable *,
89 const struct mf_subfield *fields,
92 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
94 /* A set of rules within a single OpenFlow table (oftable) that have the same
95 * values for the oftable's eviction_fields. A rule to be evicted, when one is
96 * needed, is taken from the eviction group that contains the greatest number
99 * An oftable owns any number of eviction groups, each of which contains any
102 * Membership in an eviction group is imprecise, based on the hash of the
103 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
104 * That is, if two rules have different eviction_fields, but those
105 * eviction_fields hash to the same value, then they will belong to the same
106 * eviction_group anyway.
108 * (When eviction is not enabled on an oftable, we don't track any eviction
109 * groups, to save time and space.) */
110 struct eviction_group {
111 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
112 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
113 struct heap rules; /* Contains "struct rule"s. */
116 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
117 OVS_REQUIRES(ofproto_mutex);
118 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *)
119 OVS_REQUIRES(ofproto_mutex);;
120 static void eviction_group_add_rule(struct rule *)
121 OVS_REQUIRES(ofproto_mutex);
122 static void eviction_group_remove_rule(struct rule *)
123 OVS_REQUIRES(ofproto_mutex);
125 /* Criteria that flow_mod and other operations use for selecting rules on
126 * which to operate. */
127 struct rule_criteria {
128 /* An OpenFlow table or 255 for all tables. */
131 /* OpenFlow matching criteria. Interpreted different in "loose" way by
132 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
133 * defined in the OpenFlow spec. */
136 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
137 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
138 * The rule will not be selected if M is 1 and B != C. */
140 ovs_be64 cookie_mask;
142 /* Selection based on actions within a rule:
144 * If out_port != OFPP_ANY, selects only rules that output to out_port.
145 * If out_group != OFPG_ALL, select only rules that output to out_group. */
149 /* If true, collects only rules that are modifiable. */
151 bool include_readonly;
154 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
155 const struct match *match, int priority,
156 ovs_be64 cookie, ovs_be64 cookie_mask,
157 ofp_port_t out_port, uint32_t out_group);
158 static void rule_criteria_require_rw(struct rule_criteria *,
159 bool can_write_readonly);
160 static void rule_criteria_destroy(struct rule_criteria *);
162 static enum ofperr collect_rules_loose(struct ofproto *,
163 const struct rule_criteria *,
164 struct rule_collection *);
166 /* A packet that needs to be passed to rule_execute().
168 * (We can't do this immediately from ofopgroup_complete() because that holds
169 * ofproto_mutex, which rule_execute() needs released.) */
170 struct rule_execute {
171 struct ovs_list list_node; /* In struct ofproto's "rule_executes" list. */
172 struct rule *rule; /* Owns a reference to the rule. */
174 struct dp_packet *packet; /* Owns the packet. */
177 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
178 static void destroy_rule_executes(struct ofproto *);
180 struct learned_cookie {
182 /* In struct ofproto's 'learned_cookies' hmap. */
183 struct hmap_node hmap_node OVS_GUARDED_BY(ofproto_mutex);
185 /* In 'dead_cookies' list when removed from hmap. */
186 struct ovs_list list_node;
190 ovs_be64 cookie OVS_GUARDED_BY(ofproto_mutex);
191 uint8_t table_id OVS_GUARDED_BY(ofproto_mutex);
193 /* Number of references from "learn" actions.
195 * When this drops to 0, all of the flows in 'table_id' with the specified
196 * 'cookie' are deleted. */
197 int n OVS_GUARDED_BY(ofproto_mutex);
200 static const struct ofpact_learn *next_learn_with_delete(
201 const struct rule_actions *, const struct ofpact_learn *start);
203 static void learned_cookies_inc(struct ofproto *, const struct rule_actions *)
204 OVS_REQUIRES(ofproto_mutex);
205 static void learned_cookies_dec(struct ofproto *, const struct rule_actions *,
206 struct ovs_list *dead_cookies)
207 OVS_REQUIRES(ofproto_mutex);
208 static void learned_cookies_flush(struct ofproto *, struct ovs_list *dead_cookies)
209 OVS_REQUIRES(ofproto_mutex);
212 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
213 static void ofport_destroy(struct ofport *);
215 static void update_port(struct ofproto *, const char *devname);
216 static int init_ports(struct ofproto *);
217 static void reinit_ports(struct ofproto *);
219 static long long int ofport_get_usage(const struct ofproto *,
220 ofp_port_t ofp_port);
221 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
222 long long int last_used);
223 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
227 * Keeps track of the currently used and recently used ofport values and is
228 * used to prevent immediate recycling of ofport values. */
229 struct ofport_usage {
230 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
231 ofp_port_t ofp_port; /* OpenFlow port number. */
232 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
233 represents in-use ofports. */
237 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
238 static bool rule_is_readonly(const struct rule *);
239 static void ofproto_rule_insert__(struct ofproto *, struct rule *)
240 OVS_REQUIRES(ofproto_mutex);
241 static void ofproto_rule_remove__(struct ofproto *, struct rule *)
242 OVS_REQUIRES(ofproto_mutex);
244 /* The source of a flow_mod request, in the code that processes flow_mods.
246 * A flow table modification request can be generated externally, via OpenFlow,
247 * or internally through a function call. This structure indicates the source
248 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
249 * meaningful and thus supplied as NULL. */
250 struct flow_mod_requester {
251 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
252 const struct ofp_header *request;
256 static enum ofperr modify_flow_check__(struct ofproto *,
257 struct ofputil_flow_mod *,
259 OVS_REQUIRES(ofproto_mutex);
260 static void modify_flow__(struct ofproto *, struct ofputil_flow_mod *,
261 const struct flow_mod_requester *, struct rule *,
262 struct ovs_list *dead_cookies)
263 OVS_REQUIRES(ofproto_mutex);
264 static void delete_flows__(const struct rule_collection *,
265 enum ofp_flow_removed_reason,
266 const struct flow_mod_requester *)
267 OVS_REQUIRES(ofproto_mutex);
269 static void send_buffered_packet(const struct flow_mod_requester *,
270 uint32_t buffer_id, struct rule *)
271 OVS_REQUIRES(ofproto_mutex);
273 static bool ofproto_group_exists__(const struct ofproto *ofproto,
275 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
276 static bool ofproto_group_exists(const struct ofproto *ofproto,
278 OVS_EXCLUDED(ofproto->groups_rwlock);
279 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
280 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
281 static enum ofperr do_bundle_flow_mod_begin(struct ofproto *,
282 struct ofputil_flow_mod *,
283 struct ofp_bundle_entry *)
284 OVS_REQUIRES(ofproto_mutex);
285 static void do_bundle_flow_mod_finish(struct ofproto *,
286 struct ofputil_flow_mod *,
287 const struct flow_mod_requester *,
288 struct ofp_bundle_entry *)
289 OVS_REQUIRES(ofproto_mutex);
290 static enum ofperr handle_flow_mod__(struct ofproto *,
291 struct ofputil_flow_mod *,
292 const struct flow_mod_requester *)
293 OVS_EXCLUDED(ofproto_mutex);
294 static void calc_duration(long long int start, long long int now,
295 uint32_t *sec, uint32_t *nsec);
298 static uint64_t pick_datapath_id(const struct ofproto *);
299 static uint64_t pick_fallback_dpid(void);
300 static void ofproto_destroy__(struct ofproto *);
301 static void update_mtu(struct ofproto *, struct ofport *);
302 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
303 static void meter_insert_rule(struct rule *);
306 static void ofproto_unixctl_init(void);
308 /* All registered ofproto classes, in probe order. */
309 static const struct ofproto_class **ofproto_classes;
310 static size_t n_ofproto_classes;
311 static size_t allocated_ofproto_classes;
313 /* Global lock that protects all flow table operations. */
314 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
316 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
317 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
319 size_t n_handlers, n_revalidators;
323 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
324 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
326 /* Initial mappings of port to OpenFlow number mappings. */
327 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
329 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
331 /* The default value of true waits for flow restore. */
332 static bool flow_restore_wait = true;
334 /* Must be called to initialize the ofproto library.
336 * The caller may pass in 'iface_hints', which contains an shash of
337 * "iface_hint" elements indexed by the interface's name. The provider
338 * may use these hints to describe the startup configuration in order to
339 * reinitialize its state. The caller owns the provided data, so a
340 * provider will make copies of anything required. An ofproto provider
341 * will remove any existing state that is not described by the hint, and
342 * may choose to remove it all. */
344 ofproto_init(const struct shash *iface_hints)
346 struct shash_node *node;
349 ofproto_class_register(&ofproto_dpif_class);
351 /* Make a local copy, since we don't own 'iface_hints' elements. */
352 SHASH_FOR_EACH(node, iface_hints) {
353 const struct iface_hint *orig_hint = node->data;
354 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
355 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
357 new_hint->br_name = xstrdup(orig_hint->br_name);
358 new_hint->br_type = xstrdup(br_type);
359 new_hint->ofp_port = orig_hint->ofp_port;
361 shash_add(&init_ofp_ports, node->name, new_hint);
364 for (i = 0; i < n_ofproto_classes; i++) {
365 ofproto_classes[i]->init(&init_ofp_ports);
369 /* 'type' should be a normalized datapath type, as returned by
370 * ofproto_normalize_type(). Returns the corresponding ofproto_class
371 * structure, or a null pointer if there is none registered for 'type'. */
372 static const struct ofproto_class *
373 ofproto_class_find__(const char *type)
377 for (i = 0; i < n_ofproto_classes; i++) {
378 const struct ofproto_class *class = ofproto_classes[i];
383 class->enumerate_types(&types);
384 found = sset_contains(&types, type);
385 sset_destroy(&types);
391 VLOG_WARN("unknown datapath type %s", type);
395 /* Registers a new ofproto class. After successful registration, new ofprotos
396 * of that type can be created using ofproto_create(). */
398 ofproto_class_register(const struct ofproto_class *new_class)
402 for (i = 0; i < n_ofproto_classes; i++) {
403 if (ofproto_classes[i] == new_class) {
408 if (n_ofproto_classes >= allocated_ofproto_classes) {
409 ofproto_classes = x2nrealloc(ofproto_classes,
410 &allocated_ofproto_classes,
411 sizeof *ofproto_classes);
413 ofproto_classes[n_ofproto_classes++] = new_class;
417 /* Unregisters a datapath provider. 'type' must have been previously
418 * registered and not currently be in use by any ofprotos. After
419 * unregistration new datapaths of that type cannot be opened using
420 * ofproto_create(). */
422 ofproto_class_unregister(const struct ofproto_class *class)
426 for (i = 0; i < n_ofproto_classes; i++) {
427 if (ofproto_classes[i] == class) {
428 for (i++; i < n_ofproto_classes; i++) {
429 ofproto_classes[i - 1] = ofproto_classes[i];
435 VLOG_WARN("attempted to unregister an ofproto class that is not "
440 /* Clears 'types' and enumerates all registered ofproto types into it. The
441 * caller must first initialize the sset. */
443 ofproto_enumerate_types(struct sset *types)
448 for (i = 0; i < n_ofproto_classes; i++) {
449 ofproto_classes[i]->enumerate_types(types);
453 /* Returns the fully spelled out name for the given ofproto 'type'.
455 * Normalized type string can be compared with strcmp(). Unnormalized type
456 * string might be the same even if they have different spellings. */
458 ofproto_normalize_type(const char *type)
460 return type && type[0] ? type : "system";
463 /* Clears 'names' and enumerates the names of all known created ofprotos with
464 * the given 'type'. The caller must first initialize the sset. Returns 0 if
465 * successful, otherwise a positive errno value.
467 * Some kinds of datapaths might not be practically enumerable. This is not
468 * considered an error. */
470 ofproto_enumerate_names(const char *type, struct sset *names)
472 const struct ofproto_class *class = ofproto_class_find__(type);
473 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
477 ofproto_create(const char *datapath_name, const char *datapath_type,
478 struct ofproto **ofprotop)
480 const struct ofproto_class *class;
481 struct ofproto *ofproto;
487 ofproto_unixctl_init();
489 datapath_type = ofproto_normalize_type(datapath_type);
490 class = ofproto_class_find__(datapath_type);
492 VLOG_WARN("could not create datapath %s of unknown type %s",
493 datapath_name, datapath_type);
497 ofproto = class->alloc();
499 VLOG_ERR("failed to allocate datapath %s of type %s",
500 datapath_name, datapath_type);
505 ovs_mutex_lock(&ofproto_mutex);
506 memset(ofproto, 0, sizeof *ofproto);
507 ofproto->ofproto_class = class;
508 ofproto->name = xstrdup(datapath_name);
509 ofproto->type = xstrdup(datapath_type);
510 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
511 hash_string(ofproto->name, 0));
512 ofproto->datapath_id = 0;
513 ofproto->forward_bpdu = false;
514 ofproto->fallback_dpid = pick_fallback_dpid();
515 ofproto->mfr_desc = NULL;
516 ofproto->hw_desc = NULL;
517 ofproto->sw_desc = NULL;
518 ofproto->serial_desc = NULL;
519 ofproto->dp_desc = NULL;
520 ofproto->frag_handling = OFPC_FRAG_NORMAL;
521 hmap_init(&ofproto->ports);
522 hmap_init(&ofproto->ofport_usage);
523 shash_init(&ofproto->port_by_name);
524 simap_init(&ofproto->ofp_requests);
525 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
526 ofproto->eviction_group_timer = LLONG_MIN;
527 ofproto->tables = NULL;
528 ofproto->n_tables = 0;
529 hindex_init(&ofproto->cookies);
530 hmap_init(&ofproto->learned_cookies);
531 list_init(&ofproto->expirable);
532 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
533 guarded_list_init(&ofproto->rule_executes);
534 ofproto->vlan_bitmap = NULL;
535 ofproto->vlans_changed = false;
536 ofproto->min_mtu = INT_MAX;
537 ovs_rwlock_init(&ofproto->groups_rwlock);
538 hmap_init(&ofproto->groups);
539 ovs_mutex_unlock(&ofproto_mutex);
540 ofproto->ogf.types = 0xf;
541 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
542 OFPGFC_SELECT_WEIGHT;
543 for (i = 0; i < 4; i++) {
544 ofproto->ogf.max_groups[i] = OFPG_MAX;
545 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
548 error = ofproto->ofproto_class->construct(ofproto);
550 VLOG_ERR("failed to open datapath %s: %s",
551 datapath_name, ovs_strerror(error));
552 connmgr_destroy(ofproto->connmgr);
553 ofproto_destroy__(ofproto);
557 /* Check that hidden tables, if any, are at the end. */
558 ovs_assert(ofproto->n_tables);
559 for (i = 0; i + 1 < ofproto->n_tables; i++) {
560 enum oftable_flags flags = ofproto->tables[i].flags;
561 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
563 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
566 ofproto->datapath_id = pick_datapath_id(ofproto);
569 /* Initialize meters table. */
570 if (ofproto->ofproto_class->meter_get_features) {
571 ofproto->ofproto_class->meter_get_features(ofproto,
572 &ofproto->meter_features);
574 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
576 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
577 * sizeof(struct meter *));
583 /* Must be called (only) by an ofproto implementation in its constructor
584 * function. See the large comment on 'construct' in struct ofproto_class for
587 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
589 struct oftable *table;
591 ovs_assert(!ofproto->n_tables);
592 ovs_assert(n_tables >= 1 && n_tables <= 255);
594 ofproto->n_tables = n_tables;
595 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
596 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
601 /* To be optionally called (only) by an ofproto implementation in its
602 * constructor function. See the large comment on 'construct' in struct
603 * ofproto_class for details.
605 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
606 * will then ensure that actions passed into the ofproto implementation will
607 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
608 * function is not called, there will be no such restriction.
610 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
611 * the 'max_ports' restriction. */
613 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
615 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
616 ofproto->max_ports = max_ports;
620 ofproto_get_datapath_id(const struct ofproto *ofproto)
622 return ofproto->datapath_id;
626 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
628 uint64_t old_dpid = p->datapath_id;
629 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
630 if (p->datapath_id != old_dpid) {
631 /* Force all active connections to reconnect, since there is no way to
632 * notify a controller that the datapath ID has changed. */
633 ofproto_reconnect_controllers(p);
638 ofproto_set_controllers(struct ofproto *p,
639 const struct ofproto_controller *controllers,
640 size_t n_controllers, uint32_t allowed_versions)
642 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
647 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
649 connmgr_set_fail_mode(p->connmgr, fail_mode);
652 /* Drops the connections between 'ofproto' and all of its controllers, forcing
653 * them to reconnect. */
655 ofproto_reconnect_controllers(struct ofproto *ofproto)
657 connmgr_reconnect(ofproto->connmgr);
660 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
661 * in-band control should guarantee access, in the same way that in-band
662 * control guarantees access to OpenFlow controllers. */
664 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
665 const struct sockaddr_in *extras, size_t n)
667 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
670 /* Sets the OpenFlow queue used by flows set up by in-band control on
671 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
672 * flows will use the default queue. */
674 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
676 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
679 /* Sets the number of flows at which eviction from the kernel flow table
682 ofproto_set_flow_limit(unsigned limit)
684 ofproto_flow_limit = limit;
687 /* Sets the maximum idle time for flows in the datapath before they are
690 ofproto_set_max_idle(unsigned max_idle)
692 ofproto_max_idle = max_idle;
695 /* If forward_bpdu is true, the NORMAL action will forward frames with
696 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
697 * the NORMAL action will drop these frames. */
699 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
701 bool old_val = ofproto->forward_bpdu;
702 ofproto->forward_bpdu = forward_bpdu;
703 if (old_val != ofproto->forward_bpdu) {
704 if (ofproto->ofproto_class->forward_bpdu_changed) {
705 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
710 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
711 * 'idle_time', in seconds, and the maximum number of MAC table entries to
714 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
717 if (ofproto->ofproto_class->set_mac_table_config) {
718 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
723 /* Multicast snooping configuration. */
725 /* Configures multicast snooping on 'ofproto' using the settings
726 * defined in 's'. If 's' is NULL, disables multicast snooping.
728 * Returns 0 if successful, otherwise a positive errno value. */
730 ofproto_set_mcast_snooping(struct ofproto *ofproto,
731 const struct ofproto_mcast_snooping_settings *s)
733 return (ofproto->ofproto_class->set_mcast_snooping
734 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
738 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
740 * Returns 0 if successful, otherwise a positive errno value.*/
742 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
743 const struct ofproto_mcast_snooping_port_settings *s)
745 return (ofproto->ofproto_class->set_mcast_snooping_port
746 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
751 ofproto_set_n_dpdk_rxqs(int n_rxqs)
753 n_dpdk_rxqs = MAX(n_rxqs, 0);
757 ofproto_set_cpu_mask(const char *cmask)
761 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
765 ofproto_set_threads(int n_handlers_, int n_revalidators_)
767 int threads = MAX(count_cpu_cores(), 2);
769 n_revalidators = MAX(n_revalidators_, 0);
770 n_handlers = MAX(n_handlers_, 0);
772 if (!n_revalidators) {
773 n_revalidators = n_handlers
774 ? MAX(threads - (int) n_handlers, 1)
779 n_handlers = MAX(threads - (int) n_revalidators, 1);
784 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
787 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
791 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
793 return connmgr_set_snoops(ofproto->connmgr, snoops);
797 ofproto_set_netflow(struct ofproto *ofproto,
798 const struct netflow_options *nf_options)
800 if (nf_options && sset_is_empty(&nf_options->collectors)) {
804 if (ofproto->ofproto_class->set_netflow) {
805 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
807 return nf_options ? EOPNOTSUPP : 0;
812 ofproto_set_sflow(struct ofproto *ofproto,
813 const struct ofproto_sflow_options *oso)
815 if (oso && sset_is_empty(&oso->targets)) {
819 if (ofproto->ofproto_class->set_sflow) {
820 return ofproto->ofproto_class->set_sflow(ofproto, oso);
822 return oso ? EOPNOTSUPP : 0;
827 ofproto_set_ipfix(struct ofproto *ofproto,
828 const struct ofproto_ipfix_bridge_exporter_options *bo,
829 const struct ofproto_ipfix_flow_exporter_options *fo,
832 if (ofproto->ofproto_class->set_ipfix) {
833 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
835 return (bo || fo) ? EOPNOTSUPP : 0;
840 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
842 flow_restore_wait = flow_restore_wait_db;
846 ofproto_get_flow_restore_wait(void)
848 return flow_restore_wait;
852 /* Spanning Tree Protocol (STP) configuration. */
854 /* Configures STP on 'ofproto' using the settings defined in 's'. If
855 * 's' is NULL, disables STP.
857 * Returns 0 if successful, otherwise a positive errno value. */
859 ofproto_set_stp(struct ofproto *ofproto,
860 const struct ofproto_stp_settings *s)
862 return (ofproto->ofproto_class->set_stp
863 ? ofproto->ofproto_class->set_stp(ofproto, s)
867 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
868 * 'enabled' member of 's' is false, then the other members are not
871 * Returns 0 if successful, otherwise a positive errno value. */
873 ofproto_get_stp_status(struct ofproto *ofproto,
874 struct ofproto_stp_status *s)
876 return (ofproto->ofproto_class->get_stp_status
877 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
881 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
882 * in 's'. The caller is responsible for assigning STP port numbers
883 * (using the 'port_num' member in the range of 1 through 255, inclusive)
884 * and ensuring there are no duplicates. If the 's' is NULL, then STP
885 * is disabled on the port.
887 * Returns 0 if successful, otherwise a positive errno value.*/
889 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
890 const struct ofproto_port_stp_settings *s)
892 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
894 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
895 ofproto->name, ofp_port);
899 return (ofproto->ofproto_class->set_stp_port
900 ? ofproto->ofproto_class->set_stp_port(ofport, s)
904 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
905 * 's'. If the 'enabled' member in 's' is false, then the other members
906 * are not meaningful.
908 * Returns 0 if successful, otherwise a positive errno value.*/
910 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
911 struct ofproto_port_stp_status *s)
913 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
915 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
916 "port %"PRIu16, ofproto->name, ofp_port);
920 return (ofproto->ofproto_class->get_stp_port_status
921 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
925 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
926 * 's'. If the 'enabled' member in 's' is false, then the other members
927 * are not meaningful.
929 * Returns 0 if successful, otherwise a positive errno value.*/
931 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
932 struct ofproto_port_stp_stats *s)
934 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
936 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
937 "port %"PRIu16, ofproto->name, ofp_port);
941 return (ofproto->ofproto_class->get_stp_port_stats
942 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
946 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
948 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
949 * 's' is NULL, disables RSTP.
951 * Returns 0 if successful, otherwise a positive errno value. */
953 ofproto_set_rstp(struct ofproto *ofproto,
954 const struct ofproto_rstp_settings *s)
956 if (!ofproto->ofproto_class->set_rstp) {
959 ofproto->ofproto_class->set_rstp(ofproto, s);
963 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
964 * 'enabled' member of 's' is false, then the other members are not
967 * Returns 0 if successful, otherwise a positive errno value. */
969 ofproto_get_rstp_status(struct ofproto *ofproto,
970 struct ofproto_rstp_status *s)
972 if (!ofproto->ofproto_class->get_rstp_status) {
975 ofproto->ofproto_class->get_rstp_status(ofproto, s);
979 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
980 * in 's'. The caller is responsible for assigning RSTP port numbers
981 * (using the 'port_num' member in the range of 1 through 255, inclusive)
982 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
983 * is disabled on the port.
985 * Returns 0 if successful, otherwise a positive errno value.*/
987 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
988 const struct ofproto_port_rstp_settings *s)
990 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
992 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
993 ofproto->name, ofp_port);
997 if (!ofproto->ofproto_class->set_rstp_port) {
1000 ofproto->ofproto_class->set_rstp_port(ofport, s);
1004 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1005 * 's'. If the 'enabled' member in 's' is false, then the other members
1006 * are not meaningful.
1008 * Returns 0 if successful, otherwise a positive errno value.*/
1010 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1011 struct ofproto_port_rstp_status *s)
1013 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1015 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1016 "port %"PRIu16, ofproto->name, ofp_port);
1020 if (!ofproto->ofproto_class->get_rstp_port_status) {
1023 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1027 /* Queue DSCP configuration. */
1029 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1030 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1031 * to implement QoS. Instead, it is used to implement features which require
1032 * knowledge of what queues exist on a port, and some basic information about
1035 * Returns 0 if successful, otherwise a positive errno value. */
1037 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1038 const struct ofproto_port_queue *queues,
1041 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1044 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1045 ofproto->name, ofp_port);
1049 return (ofproto->ofproto_class->set_queues
1050 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1054 /* LLDP configuration. */
1056 ofproto_port_set_lldp(struct ofproto *ofproto,
1057 ofp_port_t ofp_port,
1058 const struct smap *cfg)
1060 struct ofport *ofport;
1063 ofport = ofproto_get_port(ofproto, ofp_port);
1065 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1066 ofproto->name, ofp_port);
1069 error = (ofproto->ofproto_class->set_lldp
1070 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1073 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1074 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1075 ovs_strerror(error));
1080 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1081 const struct aa_settings *s)
1083 if (!ofproto->ofproto_class->set_aa) {
1086 ofproto->ofproto_class->set_aa(ofproto, s);
1091 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1092 const struct aa_mapping_settings *s)
1094 if (!ofproto->ofproto_class->aa_mapping_set) {
1097 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1102 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1104 if (!ofproto->ofproto_class->aa_mapping_unset) {
1107 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1112 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1113 struct ovs_list *list)
1115 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1118 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1123 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1125 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1128 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1131 /* Connectivity Fault Management configuration. */
1133 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1135 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1137 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1138 if (ofport && ofproto->ofproto_class->set_cfm) {
1139 ofproto->ofproto_class->set_cfm(ofport, NULL);
1143 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1144 * basic configuration from the configuration members in 'cfm', and the remote
1145 * maintenance point ID from remote_mpid. Ignores the statistics members of
1148 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1150 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1151 const struct cfm_settings *s)
1153 struct ofport *ofport;
1156 ofport = ofproto_get_port(ofproto, ofp_port);
1158 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1159 ofproto->name, ofp_port);
1163 /* XXX: For configuration simplicity, we only support one remote_mpid
1164 * outside of the CFM module. It's not clear if this is the correct long
1165 * term solution or not. */
1166 error = (ofproto->ofproto_class->set_cfm
1167 ? ofproto->ofproto_class->set_cfm(ofport, s)
1170 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1171 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1172 ovs_strerror(error));
1176 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1177 * 'ofproto' does not have a port 'ofp_port'. */
1179 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1180 const struct smap *cfg)
1182 struct ofport *ofport;
1185 ofport = ofproto_get_port(ofproto, ofp_port);
1187 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1188 ofproto->name, ofp_port);
1192 error = (ofproto->ofproto_class->set_bfd
1193 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1196 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1197 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1198 ovs_strerror(error));
1202 /* Checks the status change of BFD on 'ofport'.
1204 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1206 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1208 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1209 return (ofport && ofproto->ofproto_class->bfd_status_changed
1210 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1214 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1215 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1216 * is not an OpenFlow port in 'ofproto'.
1218 * The caller must provide and own '*status'. */
1220 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1221 struct smap *status)
1223 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1224 return (ofport && ofproto->ofproto_class->get_bfd_status
1225 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1229 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1230 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1231 * 0 if LACP partner information is not current (generally indicating a
1232 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1234 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1236 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1237 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1238 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1243 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1245 struct ofproto *ofproto = port->ofproto;
1248 if (ofproto->ofproto_class->port_get_lacp_stats) {
1249 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1259 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1260 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1261 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1262 * configuration plus, if there is more than one slave, a bonding
1265 * If 'aux' is already registered then this function updates its configuration
1266 * to 's'. Otherwise, this function registers a new bundle.
1268 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1271 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1272 const struct ofproto_bundle_settings *s)
1274 return (ofproto->ofproto_class->bundle_set
1275 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1279 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1280 * If no such bundle has been registered, this has no effect. */
1282 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1284 return ofproto_bundle_register(ofproto, aux, NULL);
1288 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1289 * If 'aux' is already registered then this function updates its configuration
1290 * to 's'. Otherwise, this function registers a new mirror. */
1292 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1293 const struct ofproto_mirror_settings *s)
1295 return (ofproto->ofproto_class->mirror_set
1296 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1300 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1301 * If no mirror has been registered, this has no effect. */
1303 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1305 return ofproto_mirror_register(ofproto, aux, NULL);
1308 /* Retrieves statistics from mirror associated with client data pointer
1309 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1310 * 'bytes', respectively. If a particular counters is not supported,
1311 * the appropriate argument is set to UINT64_MAX.
1314 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1315 uint64_t *packets, uint64_t *bytes)
1317 if (!ofproto->ofproto_class->mirror_get_stats) {
1318 *packets = *bytes = UINT64_MAX;
1322 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1326 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1327 * which all packets are flooded, instead of using MAC learning. If
1328 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1330 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1333 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1335 return (ofproto->ofproto_class->set_flood_vlans
1336 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1340 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1341 * output for a mirror. */
1343 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1345 return (ofproto->ofproto_class->is_mirror_output_bundle
1346 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1350 /* Configuration of OpenFlow tables. */
1352 /* Returns the number of OpenFlow tables in 'ofproto'. */
1354 ofproto_get_n_tables(const struct ofproto *ofproto)
1356 return ofproto->n_tables;
1359 /* Returns the number of Controller visible OpenFlow tables
1360 * in 'ofproto'. This number will exclude Hidden tables.
1361 * This funtion's return value should be less or equal to that of
1362 * ofproto_get_n_tables() . */
1364 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1366 uint8_t n = ofproto->n_tables;
1368 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1369 * if present, are always at the end.) */
1370 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1377 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1378 * settings from 's'. 'table_id' must be in the range 0 through the number of
1379 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1381 * For read-only tables, only the name may be configured. */
1383 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1384 const struct ofproto_table_settings *s)
1386 struct oftable *table;
1388 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1389 table = &ofproto->tables[table_id];
1391 oftable_set_name(table, s->name);
1393 if (table->flags & OFTABLE_READONLY) {
1398 oftable_enable_eviction(table, s->groups, s->n_groups);
1400 oftable_disable_eviction(table);
1403 table->max_flows = s->max_flows;
1405 if (classifier_set_prefix_fields(&table->cls,
1406 s->prefix_fields, s->n_prefix_fields)) {
1407 /* XXX: Trigger revalidation. */
1410 ovs_mutex_lock(&ofproto_mutex);
1411 evict_rules_from_table(table, 0);
1412 ovs_mutex_unlock(&ofproto_mutex);
1416 ofproto_has_snoops(const struct ofproto *ofproto)
1418 return connmgr_has_snoops(ofproto->connmgr);
1422 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1424 connmgr_get_snoops(ofproto->connmgr, snoops);
1427 /* Deletes 'rule' from 'ofproto'.
1429 * Within an ofproto implementation, this function allows an ofproto
1430 * implementation to destroy any rules that remain when its ->destruct()
1431 * function is called. This function is not suitable for use elsewhere in an
1432 * ofproto implementation.
1434 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1435 * Cycle" in ofproto-provider.h. */
1437 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1438 OVS_EXCLUDED(ofproto_mutex)
1440 /* This skips the ofmonitor and flow-removed notifications because the
1441 * switch is being deleted and any OpenFlow channels have been or soon will
1443 ovs_mutex_lock(&ofproto_mutex);
1444 oftable_remove_rule(rule);
1445 ofproto->ofproto_class->rule_delete(rule);
1446 ofproto_rule_unref(rule);
1447 ovs_mutex_unlock(&ofproto_mutex);
1451 ofproto_flush__(struct ofproto *ofproto)
1452 OVS_EXCLUDED(ofproto_mutex)
1454 struct oftable *table;
1456 /* This will flush all datapath flows. */
1457 if (ofproto->ofproto_class->flush) {
1458 ofproto->ofproto_class->flush(ofproto);
1461 /* XXX: There is a small race window here, where new datapath flows can be
1462 * created by upcall handlers based on the existing flow table. We can not
1463 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1464 * as then we could deadlock on syncing with the handler threads waiting on
1465 * the same mutex. */
1467 ovs_mutex_lock(&ofproto_mutex);
1468 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1469 struct rule_collection rules;
1472 if (table->flags & OFTABLE_HIDDEN) {
1476 rule_collection_init(&rules);
1478 CLS_FOR_EACH (rule, cr, &table->cls) {
1479 rule_collection_add(&rules, rule);
1481 delete_flows__(&rules, OFPRR_DELETE, NULL);
1482 rule_collection_destroy(&rules);
1484 /* XXX: Concurrent handler threads may insert new learned flows based on
1485 * learn actions of the now deleted flows right after we release
1486 * 'ofproto_mutex'. */
1487 ovs_mutex_unlock(&ofproto_mutex);
1490 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1493 ofproto_destroy__(struct ofproto *ofproto)
1494 OVS_EXCLUDED(ofproto_mutex)
1496 struct oftable *table;
1498 destroy_rule_executes(ofproto);
1499 delete_group(ofproto, OFPG_ALL);
1501 guarded_list_destroy(&ofproto->rule_executes);
1502 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1503 hmap_destroy(&ofproto->groups);
1505 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1506 free(ofproto->name);
1507 free(ofproto->type);
1508 free(ofproto->mfr_desc);
1509 free(ofproto->hw_desc);
1510 free(ofproto->sw_desc);
1511 free(ofproto->serial_desc);
1512 free(ofproto->dp_desc);
1513 hmap_destroy(&ofproto->ports);
1514 hmap_destroy(&ofproto->ofport_usage);
1515 shash_destroy(&ofproto->port_by_name);
1516 simap_destroy(&ofproto->ofp_requests);
1518 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1519 oftable_destroy(table);
1521 free(ofproto->tables);
1523 ovs_assert(hindex_is_empty(&ofproto->cookies));
1524 hindex_destroy(&ofproto->cookies);
1526 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1527 hmap_destroy(&ofproto->learned_cookies);
1529 free(ofproto->vlan_bitmap);
1531 ofproto->ofproto_class->dealloc(ofproto);
1535 ofproto_destroy(struct ofproto *p)
1536 OVS_EXCLUDED(ofproto_mutex)
1538 struct ofport *ofport, *next_ofport;
1539 struct ofport_usage *usage, *next_usage;
1546 meter_delete(p, 1, p->meter_features.max_meters);
1547 p->meter_features.max_meters = 0;
1553 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1554 ofport_destroy(ofport);
1557 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1558 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1562 p->ofproto_class->destruct(p);
1564 /* We should not postpone this because it involves deleting a listening
1565 * socket which we may want to reopen soon. 'connmgr' should not be used
1566 * by other threads */
1567 connmgr_destroy(p->connmgr);
1569 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1570 ovsrcu_postpone(ofproto_destroy__, p);
1573 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1574 * kernel datapath, for example, this destroys the datapath in the kernel, and
1575 * with the netdev-based datapath, it tears down the data structures that
1576 * represent the datapath.
1578 * The datapath should not be currently open as an ofproto. */
1580 ofproto_delete(const char *name, const char *type)
1582 const struct ofproto_class *class = ofproto_class_find__(type);
1583 return (!class ? EAFNOSUPPORT
1584 : !class->del ? EACCES
1585 : class->del(type, name));
1589 process_port_change(struct ofproto *ofproto, int error, char *devname)
1591 if (error == ENOBUFS) {
1592 reinit_ports(ofproto);
1593 } else if (!error) {
1594 update_port(ofproto, devname);
1600 ofproto_type_run(const char *datapath_type)
1602 const struct ofproto_class *class;
1605 datapath_type = ofproto_normalize_type(datapath_type);
1606 class = ofproto_class_find__(datapath_type);
1608 error = class->type_run ? class->type_run(datapath_type) : 0;
1609 if (error && error != EAGAIN) {
1610 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1611 datapath_type, ovs_strerror(error));
1617 ofproto_type_wait(const char *datapath_type)
1619 const struct ofproto_class *class;
1621 datapath_type = ofproto_normalize_type(datapath_type);
1622 class = ofproto_class_find__(datapath_type);
1624 if (class->type_wait) {
1625 class->type_wait(datapath_type);
1630 ofproto_run(struct ofproto *p)
1635 error = p->ofproto_class->run(p);
1636 if (error && error != EAGAIN) {
1637 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1640 run_rule_executes(p);
1642 /* Restore the eviction group heap invariant occasionally. */
1643 if (p->eviction_group_timer < time_msec()) {
1646 p->eviction_group_timer = time_msec() + 1000;
1648 for (i = 0; i < p->n_tables; i++) {
1649 struct oftable *table = &p->tables[i];
1650 struct eviction_group *evg;
1653 if (!table->eviction_fields) {
1657 if (classifier_count(&table->cls) > 100000) {
1658 static struct vlog_rate_limit count_rl =
1659 VLOG_RATE_LIMIT_INIT(1, 1);
1660 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1661 " number of rules: %d", i,
1662 classifier_count(&table->cls));
1665 ovs_mutex_lock(&ofproto_mutex);
1666 CLS_FOR_EACH (rule, cr, &table->cls) {
1667 if (rule->idle_timeout || rule->hard_timeout) {
1668 if (!rule->eviction_group) {
1669 eviction_group_add_rule(rule);
1671 heap_raw_change(&rule->evg_node,
1672 rule_eviction_priority(p, rule));
1677 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1678 heap_rebuild(&evg->rules);
1680 ovs_mutex_unlock(&ofproto_mutex);
1684 if (p->ofproto_class->port_poll) {
1687 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1688 process_port_change(p, error, devname);
1692 new_seq = seq_read(connectivity_seq_get());
1693 if (new_seq != p->change_seq) {
1694 struct sset devnames;
1695 const char *devname;
1696 struct ofport *ofport;
1698 /* Update OpenFlow port status for any port whose netdev has changed.
1700 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1701 * destroyed, so it's not safe to update ports directly from the
1702 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1703 * need this two-phase approach. */
1704 sset_init(&devnames);
1705 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1706 uint64_t port_change_seq;
1708 port_change_seq = netdev_get_change_seq(ofport->netdev);
1709 if (ofport->change_seq != port_change_seq) {
1710 ofport->change_seq = port_change_seq;
1711 sset_add(&devnames, netdev_get_name(ofport->netdev));
1714 SSET_FOR_EACH (devname, &devnames) {
1715 update_port(p, devname);
1717 sset_destroy(&devnames);
1719 p->change_seq = new_seq;
1722 connmgr_run(p->connmgr, handle_openflow);
1728 ofproto_wait(struct ofproto *p)
1730 p->ofproto_class->wait(p);
1731 if (p->ofproto_class->port_poll_wait) {
1732 p->ofproto_class->port_poll_wait(p);
1734 seq_wait(connectivity_seq_get(), p->change_seq);
1735 connmgr_wait(p->connmgr);
1739 ofproto_is_alive(const struct ofproto *p)
1741 return connmgr_has_controllers(p->connmgr);
1744 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1745 * memory_report(). */
1747 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1749 const struct oftable *table;
1750 unsigned int n_rules;
1752 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1755 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1756 n_rules += classifier_count(&table->cls);
1758 simap_increase(usage, "rules", n_rules);
1760 if (ofproto->ofproto_class->get_memory_usage) {
1761 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1764 connmgr_get_memory_usage(ofproto->connmgr, usage);
1768 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1770 const struct ofproto_class *class;
1772 datapath_type = ofproto_normalize_type(datapath_type);
1773 class = ofproto_class_find__(datapath_type);
1775 if (class && class->type_get_memory_usage) {
1776 class->type_get_memory_usage(datapath_type, usage);
1781 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1784 connmgr_get_controller_info(ofproto->connmgr, info);
1788 ofproto_free_ofproto_controller_info(struct shash *info)
1790 connmgr_free_controller_info(info);
1793 /* Makes a deep copy of 'old' into 'port'. */
1795 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1797 port->name = xstrdup(old->name);
1798 port->type = xstrdup(old->type);
1799 port->ofp_port = old->ofp_port;
1802 /* Frees memory allocated to members of 'ofproto_port'.
1804 * Do not call this function on an ofproto_port obtained from
1805 * ofproto_port_dump_next(): that function retains ownership of the data in the
1808 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1810 free(ofproto_port->name);
1811 free(ofproto_port->type);
1814 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1816 * This function provides no status indication. An error status for the entire
1817 * dump operation is provided when it is completed by calling
1818 * ofproto_port_dump_done().
1821 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1822 const struct ofproto *ofproto)
1824 dump->ofproto = ofproto;
1825 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1829 /* Attempts to retrieve another port from 'dump', which must have been created
1830 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1831 * 'port' and returns true. On failure, returns false.
1833 * Failure might indicate an actual error or merely that the last port has been
1834 * dumped. An error status for the entire dump operation is provided when it
1835 * is completed by calling ofproto_port_dump_done().
1837 * The ofproto owns the data stored in 'port'. It will remain valid until at
1838 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1839 * ofproto_port_dump_done(). */
1841 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1842 struct ofproto_port *port)
1844 const struct ofproto *ofproto = dump->ofproto;
1850 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1853 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1859 /* Completes port table dump operation 'dump', which must have been created
1860 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1861 * error-free, otherwise a positive errno value describing the problem. */
1863 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1865 const struct ofproto *ofproto = dump->ofproto;
1867 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1870 return dump->error == EOF ? 0 : dump->error;
1873 /* Returns the type to pass to netdev_open() when a datapath of type
1874 * 'datapath_type' has a port of type 'port_type', for a few special
1875 * cases when a netdev type differs from a port type. For example, when
1876 * using the userspace datapath, a port of type "internal" needs to be
1879 * Returns either 'type' itself or a string literal, which must not be
1882 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1884 const struct ofproto_class *class;
1886 datapath_type = ofproto_normalize_type(datapath_type);
1887 class = ofproto_class_find__(datapath_type);
1892 return (class->port_open_type
1893 ? class->port_open_type(datapath_type, port_type)
1897 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1898 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1899 * the port's OpenFlow port number.
1901 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1902 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1903 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1904 * 'ofp_portp' is non-null). */
1906 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1907 ofp_port_t *ofp_portp)
1909 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1912 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1914 const char *netdev_name = netdev_get_name(netdev);
1916 simap_put(&ofproto->ofp_requests, netdev_name,
1917 ofp_to_u16(ofp_port));
1918 update_port(ofproto, netdev_name);
1921 *ofp_portp = OFPP_NONE;
1923 struct ofproto_port ofproto_port;
1925 error = ofproto_port_query_by_name(ofproto,
1926 netdev_get_name(netdev),
1929 *ofp_portp = ofproto_port.ofp_port;
1930 ofproto_port_destroy(&ofproto_port);
1937 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1938 * initializes '*port' appropriately; on failure, returns a positive errno
1941 * The caller owns the data in 'ofproto_port' and must free it with
1942 * ofproto_port_destroy() when it is no longer needed. */
1944 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1945 struct ofproto_port *port)
1949 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1951 memset(port, 0, sizeof *port);
1956 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1957 * Returns 0 if successful, otherwise a positive errno. */
1959 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1961 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1962 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1963 struct simap_node *ofp_request_node;
1966 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1967 if (ofp_request_node) {
1968 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1971 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1972 if (!error && ofport) {
1973 /* 'name' is the netdev's name and update_port() is going to close the
1974 * netdev. Just in case update_port() refers to 'name' after it
1975 * destroys 'ofport', make a copy of it around the update_port()
1977 char *devname = xstrdup(name);
1978 update_port(ofproto, devname);
1985 flow_mod_init(struct ofputil_flow_mod *fm,
1986 const struct match *match, int priority,
1987 const struct ofpact *ofpacts, size_t ofpacts_len,
1988 enum ofp_flow_mod_command command)
1990 memset(fm, 0, sizeof *fm);
1992 fm->priority = priority;
1995 fm->modify_cookie = false;
1997 fm->command = command;
1998 fm->idle_timeout = 0;
1999 fm->hard_timeout = 0;
2001 fm->buffer_id = UINT32_MAX;
2002 fm->out_port = OFPP_ANY;
2003 fm->out_group = OFPG_ANY;
2005 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2006 fm->ofpacts_len = ofpacts_len;
2007 fm->delete_reason = OFPRR_DELETE;
2011 simple_flow_mod(struct ofproto *ofproto,
2012 const struct match *match, int priority,
2013 const struct ofpact *ofpacts, size_t ofpacts_len,
2014 enum ofp_flow_mod_command command)
2016 struct ofputil_flow_mod fm;
2018 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2020 return handle_flow_mod__(ofproto, &fm, NULL);
2023 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2024 * performs the 'n_actions' actions in 'actions'. The new flow will not
2027 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2028 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2029 * controllers; otherwise, it will be hidden.
2031 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2033 * This is a helper function for in-band control and fail-open. */
2035 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2037 const struct ofpact *ofpacts, size_t ofpacts_len)
2038 OVS_EXCLUDED(ofproto_mutex)
2040 const struct rule *rule;
2043 /* First do a cheap check whether the rule we're looking for already exists
2044 * with the actions that we want. If it does, then we're done. */
2045 rule = rule_from_cls_rule(classifier_find_match_exactly(
2046 &ofproto->tables[0].cls, match, priority));
2048 const struct rule_actions *actions = rule_get_actions(rule);
2049 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2050 ofpacts, ofpacts_len);
2055 /* If there's no such rule or the rule doesn't have the actions we want,
2056 * fall back to a executing a full flow mod. We can't optimize this at
2057 * all because we didn't take enough locks above to ensure that the flow
2058 * table didn't already change beneath us. */
2060 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2061 OFPFC_MODIFY_STRICT);
2065 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2066 * an OFPERR_* OpenFlow error code on failure.
2068 * This is a helper function for in-band control and fail-open and the "learn"
2071 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2072 OVS_EXCLUDED(ofproto_mutex)
2074 /* Optimize for the most common case of a repeated learn action.
2075 * If an identical flow already exists we only need to update its
2076 * 'modified' time. */
2077 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2078 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2079 struct oftable *table = &ofproto->tables[fm->table_id];
2083 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
2087 /* Reading many of the rule fields and writing on 'modified'
2088 * requires the rule->mutex. Also, rule->actions may change
2089 * if rule->mutex is not held. */
2090 const struct rule_actions *actions;
2092 ovs_mutex_lock(&rule->mutex);
2093 actions = rule_get_actions(rule);
2094 if (rule->idle_timeout == fm->idle_timeout
2095 && rule->hard_timeout == fm->hard_timeout
2096 && rule->importance == fm->importance
2097 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2098 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2099 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2100 actions->ofpacts, actions->ofpacts_len)) {
2101 /* Rule already exists and need not change, only update the
2102 modified timestamp. */
2103 rule->modified = time_msec();
2106 ovs_mutex_unlock(&rule->mutex);
2114 return handle_flow_mod__(ofproto, fm, NULL);
2117 /* Searches for a rule with matching criteria exactly equal to 'target' in
2118 * ofproto's table 0 and, if it finds one, deletes it.
2120 * This is a helper function for in-band control and fail-open. */
2122 ofproto_delete_flow(struct ofproto *ofproto,
2123 const struct match *target, int priority)
2124 OVS_EXCLUDED(ofproto_mutex)
2126 struct classifier *cls = &ofproto->tables[0].cls;
2129 /* First do a cheap check whether the rule we're looking for has already
2130 * been deleted. If so, then we're done. */
2131 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2137 /* Execute a flow mod. We can't optimize this at all because we didn't
2138 * take enough locks above to ensure that the flow table didn't already
2139 * change beneath us. */
2140 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2143 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2144 * the flows required by in-band control and fail-open. */
2146 ofproto_flush_flows(struct ofproto *ofproto)
2148 COVERAGE_INC(ofproto_flush);
2149 ofproto_flush__(ofproto);
2150 connmgr_flushed(ofproto->connmgr);
2154 reinit_ports(struct ofproto *p)
2156 struct ofproto_port_dump dump;
2157 struct sset devnames;
2158 struct ofport *ofport;
2159 struct ofproto_port ofproto_port;
2160 const char *devname;
2162 COVERAGE_INC(ofproto_reinit_ports);
2164 sset_init(&devnames);
2165 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2166 sset_add(&devnames, netdev_get_name(ofport->netdev));
2168 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2169 sset_add(&devnames, ofproto_port.name);
2172 SSET_FOR_EACH (devname, &devnames) {
2173 update_port(p, devname);
2175 sset_destroy(&devnames);
2179 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2183 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2184 port_idx = port_idx ? port_idx : UINT16_MAX;
2186 if (port_idx >= ofproto->max_ports
2187 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2188 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2189 long long int last_used_at, lru = LLONG_MAX;
2191 /* Search for a free OpenFlow port number. We try not to
2192 * immediately reuse them to prevent problems due to old
2195 * We limit the automatically assigned port numbers to the lower half
2196 * of the port range, to reserve the upper half for assignment by
2199 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2200 ofproto->alloc_port_no = 1;
2202 last_used_at = ofport_get_usage(ofproto,
2203 u16_to_ofp(ofproto->alloc_port_no));
2204 if (!last_used_at) {
2205 port_idx = ofproto->alloc_port_no;
2207 } else if ( last_used_at < time_msec() - 60*60*1000) {
2208 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2209 * more than an hour ago, consider it usable. */
2210 ofport_remove_usage(ofproto,
2211 u16_to_ofp(ofproto->alloc_port_no));
2212 port_idx = ofproto->alloc_port_no;
2214 } else if (last_used_at < lru) {
2216 lru_ofport = ofproto->alloc_port_no;
2219 if (ofproto->alloc_port_no == end_port_no) {
2221 port_idx = lru_ofport;
2228 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2229 return u16_to_ofp(port_idx);
2233 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2235 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2236 ofport_set_usage(ofproto, ofp_port, time_msec());
2240 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2241 * pointer if the netdev cannot be opened. On success, also fills in
2243 static struct netdev *
2244 ofport_open(struct ofproto *ofproto,
2245 struct ofproto_port *ofproto_port,
2246 struct ofputil_phy_port *pp)
2248 enum netdev_flags flags;
2249 struct netdev *netdev;
2252 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2254 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2255 "cannot be opened (%s)",
2257 ofproto_port->name, ofproto_port->ofp_port,
2258 ofproto_port->name, ovs_strerror(error));
2262 if (ofproto_port->ofp_port == OFPP_NONE) {
2263 if (!strcmp(ofproto->name, ofproto_port->name)) {
2264 ofproto_port->ofp_port = OFPP_LOCAL;
2266 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2267 ofproto_port->name);
2270 pp->port_no = ofproto_port->ofp_port;
2271 netdev_get_etheraddr(netdev, pp->hw_addr);
2272 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2273 netdev_get_flags(netdev, &flags);
2274 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2275 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2276 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2277 &pp->supported, &pp->peer);
2278 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2279 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2284 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2285 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2288 ofport_equal(const struct ofputil_phy_port *a,
2289 const struct ofputil_phy_port *b)
2291 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2292 && a->state == b->state
2293 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2294 && a->curr == b->curr
2295 && a->advertised == b->advertised
2296 && a->supported == b->supported
2297 && a->peer == b->peer
2298 && a->curr_speed == b->curr_speed
2299 && a->max_speed == b->max_speed);
2302 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2303 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2304 * one with the same name or port number). */
2306 ofport_install(struct ofproto *p,
2307 struct netdev *netdev, const struct ofputil_phy_port *pp)
2309 const char *netdev_name = netdev_get_name(netdev);
2310 struct ofport *ofport;
2313 /* Create ofport. */
2314 ofport = p->ofproto_class->port_alloc();
2319 ofport->ofproto = p;
2320 ofport->netdev = netdev;
2321 ofport->change_seq = netdev_get_change_seq(netdev);
2323 ofport->ofp_port = pp->port_no;
2324 ofport->created = time_msec();
2326 /* Add port to 'p'. */
2327 hmap_insert(&p->ports, &ofport->hmap_node,
2328 hash_ofp_port(ofport->ofp_port));
2329 shash_add(&p->port_by_name, netdev_name, ofport);
2331 update_mtu(p, ofport);
2333 /* Let the ofproto_class initialize its private data. */
2334 error = p->ofproto_class->port_construct(ofport);
2338 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2342 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2343 p->name, netdev_name, ovs_strerror(error));
2345 ofport_destroy__(ofport);
2347 netdev_close(netdev);
2351 /* Removes 'ofport' from 'p' and destroys it. */
2353 ofport_remove(struct ofport *ofport)
2355 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2357 ofport_destroy(ofport);
2360 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2363 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2365 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2367 ofport_remove(port);
2371 /* Updates 'port' with new 'pp' description.
2373 * Does not handle a name or port number change. The caller must implement
2374 * such a change as a delete followed by an add. */
2376 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2378 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2379 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2380 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2381 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2382 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2383 port->pp.curr = pp->curr;
2384 port->pp.advertised = pp->advertised;
2385 port->pp.supported = pp->supported;
2386 port->pp.peer = pp->peer;
2387 port->pp.curr_speed = pp->curr_speed;
2388 port->pp.max_speed = pp->max_speed;
2390 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2391 &port->pp, OFPPR_MODIFY);
2394 /* Update OpenFlow 'state' in 'port' and notify controller. */
2396 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2398 if (port->pp.state != state) {
2399 port->pp.state = state;
2400 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2401 &port->pp, OFPPR_MODIFY);
2406 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2408 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2410 if (port->ofproto->ofproto_class->set_realdev) {
2411 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2413 if (port->ofproto->ofproto_class->set_stp_port) {
2414 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2416 if (port->ofproto->ofproto_class->set_rstp_port) {
2417 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2419 if (port->ofproto->ofproto_class->set_cfm) {
2420 port->ofproto->ofproto_class->set_cfm(port, NULL);
2422 if (port->ofproto->ofproto_class->bundle_remove) {
2423 port->ofproto->ofproto_class->bundle_remove(port);
2429 ofport_destroy__(struct ofport *port)
2431 struct ofproto *ofproto = port->ofproto;
2432 const char *name = netdev_get_name(port->netdev);
2434 hmap_remove(&ofproto->ports, &port->hmap_node);
2435 shash_delete(&ofproto->port_by_name,
2436 shash_find(&ofproto->port_by_name, name));
2438 netdev_close(port->netdev);
2439 ofproto->ofproto_class->port_dealloc(port);
2443 ofport_destroy(struct ofport *port)
2446 dealloc_ofp_port(port->ofproto, port->ofp_port);
2447 port->ofproto->ofproto_class->port_destruct(port);
2448 ofport_destroy__(port);
2453 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2455 struct ofport *port;
2457 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2459 if (port->ofp_port == ofp_port) {
2466 static long long int
2467 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2469 struct ofport_usage *usage;
2471 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2472 &ofproto->ofport_usage) {
2473 if (usage->ofp_port == ofp_port) {
2474 return usage->last_used;
2481 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2482 long long int last_used)
2484 struct ofport_usage *usage;
2485 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2486 &ofproto->ofport_usage) {
2487 if (usage->ofp_port == ofp_port) {
2488 usage->last_used = last_used;
2492 ovs_assert(last_used == LLONG_MAX);
2494 usage = xmalloc(sizeof *usage);
2495 usage->ofp_port = ofp_port;
2496 usage->last_used = last_used;
2497 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2498 hash_ofp_port(ofp_port));
2502 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2504 struct ofport_usage *usage;
2505 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2506 &ofproto->ofport_usage) {
2507 if (usage->ofp_port == ofp_port) {
2508 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2516 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2518 struct ofproto *ofproto = port->ofproto;
2521 if (ofproto->ofproto_class->port_get_stats) {
2522 error = ofproto->ofproto_class->port_get_stats(port, stats);
2531 update_port(struct ofproto *ofproto, const char *name)
2533 struct ofproto_port ofproto_port;
2534 struct ofputil_phy_port pp;
2535 struct netdev *netdev;
2536 struct ofport *port;
2538 COVERAGE_INC(ofproto_update_port);
2540 /* Fetch 'name''s location and properties from the datapath. */
2541 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2542 ? ofport_open(ofproto, &ofproto_port, &pp)
2546 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2547 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2548 struct netdev *old_netdev = port->netdev;
2550 /* 'name' hasn't changed location. Any properties changed? */
2551 if (!ofport_equal(&port->pp, &pp)) {
2552 ofport_modified(port, &pp);
2555 update_mtu(ofproto, port);
2557 /* Install the newly opened netdev in case it has changed.
2558 * Don't close the old netdev yet in case port_modified has to
2559 * remove a retained reference to it.*/
2560 port->netdev = netdev;
2561 port->change_seq = netdev_get_change_seq(netdev);
2563 if (port->ofproto->ofproto_class->port_modified) {
2564 port->ofproto->ofproto_class->port_modified(port);
2567 netdev_close(old_netdev);
2569 /* If 'port' is nonnull then its name differs from 'name' and thus
2570 * we should delete it. If we think there's a port named 'name'
2571 * then its port number must be wrong now so delete it too. */
2573 ofport_remove(port);
2575 ofport_remove_with_name(ofproto, name);
2576 ofport_install(ofproto, netdev, &pp);
2579 /* Any port named 'name' is gone now. */
2580 ofport_remove_with_name(ofproto, name);
2582 ofproto_port_destroy(&ofproto_port);
2586 init_ports(struct ofproto *p)
2588 struct ofproto_port_dump dump;
2589 struct ofproto_port ofproto_port;
2590 struct shash_node *node, *next;
2592 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2593 const char *name = ofproto_port.name;
2595 if (shash_find(&p->port_by_name, name)) {
2596 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2599 struct ofputil_phy_port pp;
2600 struct netdev *netdev;
2602 /* Check if an OpenFlow port number had been requested. */
2603 node = shash_find(&init_ofp_ports, name);
2605 const struct iface_hint *iface_hint = node->data;
2606 simap_put(&p->ofp_requests, name,
2607 ofp_to_u16(iface_hint->ofp_port));
2610 netdev = ofport_open(p, &ofproto_port, &pp);
2612 ofport_install(p, netdev, &pp);
2613 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2614 p->alloc_port_no = MAX(p->alloc_port_no,
2615 ofp_to_u16(ofproto_port.ofp_port));
2621 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2622 struct iface_hint *iface_hint = node->data;
2624 if (!strcmp(iface_hint->br_name, p->name)) {
2625 free(iface_hint->br_name);
2626 free(iface_hint->br_type);
2628 shash_delete(&init_ofp_ports, node);
2635 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2636 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2638 find_min_mtu(struct ofproto *p)
2640 struct ofport *ofport;
2643 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2644 struct netdev *netdev = ofport->netdev;
2647 /* Skip any internal ports, since that's what we're trying to
2649 if (!strcmp(netdev_get_type(netdev), "internal")) {
2653 if (netdev_get_mtu(netdev, &dev_mtu)) {
2656 if (!mtu || dev_mtu < mtu) {
2661 return mtu ? mtu: ETH_PAYLOAD_MAX;
2664 /* Update MTU of all datapath devices on 'p' to the minimum of the
2665 * non-datapath ports in event of 'port' added or changed. */
2667 update_mtu(struct ofproto *p, struct ofport *port)
2669 struct ofport *ofport;
2670 struct netdev *netdev = port->netdev;
2671 int dev_mtu, old_min;
2673 if (netdev_get_mtu(netdev, &dev_mtu)) {
2677 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2678 if (dev_mtu > p->min_mtu) {
2679 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2680 dev_mtu = p->min_mtu;
2683 port->mtu = dev_mtu;
2687 /* For non-internal port find new min mtu. */
2688 old_min = p->min_mtu;
2689 port->mtu = dev_mtu;
2690 p->min_mtu = find_min_mtu(p);
2691 if (p->min_mtu == old_min) {
2695 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2696 struct netdev *netdev = ofport->netdev;
2698 if (!strcmp(netdev_get_type(netdev), "internal")) {
2699 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2700 ofport->mtu = p->min_mtu;
2707 ofproto_rule_destroy__(struct rule *rule)
2708 OVS_NO_THREAD_SAFETY_ANALYSIS
2710 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2711 rule_actions_destroy(rule_get_actions(rule));
2712 ovs_mutex_destroy(&rule->mutex);
2713 rule->ofproto->ofproto_class->rule_dealloc(rule);
2716 /* Create a new rule based on attributes in 'fm', match in 'cr', and
2717 * 'table_id'. Note that the rule is NOT inserted into a any data structures
2718 * yet. Takes ownership of 'cr'. */
2720 ofproto_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
2721 struct cls_rule *cr, uint8_t table_id,
2722 struct rule **rulep)
2723 OVS_REQUIRES(ofproto_mutex)
2728 /* Allocate new rule. */
2729 rule = ofproto->ofproto_class->rule_alloc();
2731 cls_rule_destroy(cr);
2732 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
2733 return OFPERR_OFPFMFC_UNKNOWN;
2736 /* Initialize base state. */
2737 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
2738 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
2739 ovs_refcount_init(&rule->ref_count);
2740 rule->flow_cookie = fm->new_cookie;
2741 rule->created = rule->modified = time_msec();
2743 ovs_mutex_init(&rule->mutex);
2744 ovs_mutex_lock(&rule->mutex);
2745 rule->idle_timeout = fm->idle_timeout;
2746 rule->hard_timeout = fm->hard_timeout;
2747 rule->importance = fm->importance;
2748 ovs_mutex_unlock(&rule->mutex);
2750 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
2751 rule->flags = fm->flags & OFPUTIL_FF_STATE;
2752 ovsrcu_set_hidden(&rule->actions,
2753 rule_actions_create(fm->ofpacts, fm->ofpacts_len));
2754 list_init(&rule->meter_list_node);
2755 rule->eviction_group = NULL;
2756 list_init(&rule->expirable);
2757 rule->monitor_flags = 0;
2758 rule->add_seqno = 0;
2759 rule->modify_seqno = 0;
2761 /* Construct rule, initializing derived state. */
2762 error = ofproto->ofproto_class->rule_construct(rule);
2764 ofproto_rule_destroy__(rule);
2773 rule_destroy_cb(struct rule *rule)
2775 rule->ofproto->ofproto_class->rule_destruct(rule);
2776 ofproto_rule_destroy__(rule);
2780 ofproto_rule_ref(struct rule *rule)
2783 ovs_refcount_ref(&rule->ref_count);
2788 ofproto_rule_try_ref(struct rule *rule)
2791 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2796 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2797 * ref_count reaches 0.
2799 * Use of RCU allows short term use (between RCU quiescent periods) without
2800 * keeping a reference. A reference must be taken if the rule needs to
2801 * stay around accross the RCU quiescent periods. */
2803 ofproto_rule_unref(struct rule *rule)
2805 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2806 ovsrcu_postpone(rule_destroy_cb, rule);
2811 ofproto_group_ref(struct ofgroup *group)
2814 ovs_refcount_ref(&group->ref_count);
2819 ofproto_group_unref(struct ofgroup *group)
2821 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2822 group->ofproto->ofproto_class->group_destruct(group);
2823 ofputil_bucket_list_destroy(&group->buckets);
2824 group->ofproto->ofproto_class->group_dealloc(group);
2828 static uint32_t get_provider_meter_id(const struct ofproto *,
2829 uint32_t of_meter_id);
2831 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2832 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2833 const struct rule_actions *
2834 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2836 struct rule_actions *actions;
2838 actions = xmalloc(sizeof *actions + ofpacts_len);
2839 actions->ofpacts_len = ofpacts_len;
2840 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2841 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2843 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2849 /* Free the actions after the RCU quiescent period is reached. */
2851 rule_actions_destroy(const struct rule_actions *actions)
2854 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2858 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2859 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2861 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2862 OVS_REQUIRES(ofproto_mutex)
2864 if (port == OFPP_ANY) {
2867 const struct rule_actions *actions = rule_get_actions(rule);
2868 return ofpacts_output_to_port(actions->ofpacts,
2869 actions->ofpacts_len, port);
2873 /* Returns true if 'rule' has group and equals group_id. */
2875 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2876 OVS_REQUIRES(ofproto_mutex)
2878 if (group_id == OFPG_ANY) {
2881 const struct rule_actions *actions = rule_get_actions(rule);
2882 return ofpacts_output_to_group(actions->ofpacts,
2883 actions->ofpacts_len, group_id);
2888 rule_execute_destroy(struct rule_execute *e)
2890 ofproto_rule_unref(e->rule);
2891 list_remove(&e->list_node);
2895 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2896 * by passing them to the ofproto provider. */
2898 run_rule_executes(struct ofproto *ofproto)
2899 OVS_EXCLUDED(ofproto_mutex)
2901 struct rule_execute *e, *next;
2902 struct ovs_list executes;
2904 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2905 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2908 flow_extract(e->packet, &flow);
2909 flow.in_port.ofp_port = e->in_port;
2910 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2912 rule_execute_destroy(e);
2916 /* Destroys and discards all "rule_execute" operations queued up in
2917 * ofproto->rule_executes. */
2919 destroy_rule_executes(struct ofproto *ofproto)
2921 struct rule_execute *e, *next;
2922 struct ovs_list executes;
2924 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2925 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2926 dp_packet_delete(e->packet);
2927 rule_execute_destroy(e);
2932 rule_is_readonly(const struct rule *rule)
2934 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2935 return (table->flags & OFTABLE_READONLY) != 0;
2939 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2941 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2942 return hash_3words(cookie, cookie >> 32, table_id);
2946 learned_cookies_update_one__(struct ofproto *ofproto,
2947 const struct ofpact_learn *learn,
2948 int delta, struct ovs_list *dead_cookies)
2949 OVS_REQUIRES(ofproto_mutex)
2951 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
2952 struct learned_cookie *c;
2954 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
2955 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
2957 ovs_assert(c->n >= 0);
2960 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
2961 list_push_back(dead_cookies, &c->u.list_node);
2968 ovs_assert(delta > 0);
2969 c = xmalloc(sizeof *c);
2970 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
2971 c->cookie = learn->cookie;
2972 c->table_id = learn->table_id;
2976 static const struct ofpact_learn *
2977 next_learn_with_delete(const struct rule_actions *actions,
2978 const struct ofpact_learn *start)
2980 const struct ofpact *pos;
2982 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
2983 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
2984 pos = ofpact_next(pos)) {
2985 if (pos->type == OFPACT_LEARN) {
2986 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
2987 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
2997 learned_cookies_update__(struct ofproto *ofproto,
2998 const struct rule_actions *actions,
2999 int delta, struct ovs_list *dead_cookies)
3000 OVS_REQUIRES(ofproto_mutex)
3002 if (actions->has_learn_with_delete) {
3003 const struct ofpact_learn *learn;
3005 for (learn = next_learn_with_delete(actions, NULL); learn;
3006 learn = next_learn_with_delete(actions, learn)) {
3007 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3013 learned_cookies_inc(struct ofproto *ofproto,
3014 const struct rule_actions *actions)
3015 OVS_REQUIRES(ofproto_mutex)
3017 learned_cookies_update__(ofproto, actions, +1, NULL);
3021 learned_cookies_dec(struct ofproto *ofproto,
3022 const struct rule_actions *actions,
3023 struct ovs_list *dead_cookies)
3024 OVS_REQUIRES(ofproto_mutex)
3026 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3030 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3031 OVS_REQUIRES(ofproto_mutex)
3033 struct learned_cookie *c;
3035 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3036 struct rule_criteria criteria;
3037 struct rule_collection rules;
3040 match_init_catchall(&match);
3041 rule_criteria_init(&criteria, c->table_id, &match, 0,
3042 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3043 rule_criteria_require_rw(&criteria, false);
3044 collect_rules_loose(ofproto, &criteria, &rules);
3045 delete_flows__(&rules, OFPRR_DELETE, NULL);
3046 rule_criteria_destroy(&criteria);
3047 rule_collection_destroy(&rules);
3054 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3056 ofconn_send_reply(ofconn, make_echo_reply(oh));
3061 query_tables(struct ofproto *ofproto,
3062 struct ofputil_table_features **featuresp,
3063 struct ofputil_table_stats **statsp)
3065 struct mf_bitmap rw_fields = oxm_writable_fields();
3066 struct mf_bitmap match = oxm_matchable_fields();
3067 struct mf_bitmap mask = oxm_maskable_fields();
3069 struct ofputil_table_features *features;
3070 struct ofputil_table_stats *stats;
3073 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3074 for (i = 0; i < ofproto->n_tables; i++) {
3075 struct ofputil_table_features *f = &features[i];
3078 sprintf(f->name, "table%d", i);
3079 f->metadata_match = OVS_BE64_MAX;
3080 f->metadata_write = OVS_BE64_MAX;
3081 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3082 f->max_entries = 1000000;
3084 bool more_tables = false;
3085 for (int j = i + 1; j < ofproto->n_tables; j++) {
3086 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3087 bitmap_set1(f->nonmiss.next, j);
3091 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3093 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3095 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3096 f->nonmiss.write.set_fields = rw_fields;
3097 f->nonmiss.apply = f->nonmiss.write;
3098 f->miss = f->nonmiss;
3102 f->wildcard = match;
3106 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3107 for (i = 0; i < ofproto->n_tables; i++) {
3108 struct ofputil_table_stats *s = &stats[i];
3109 struct classifier *cls = &ofproto->tables[i].cls;
3112 s->active_count = classifier_count(cls);
3114 s->active_count -= connmgr_count_hidden_rules(
3122 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3124 for (i = 0; i < ofproto->n_tables; i++) {
3125 const struct oftable *table = &ofproto->tables[i];
3126 struct ofputil_table_features *f = &features[i];
3129 ovs_strzcpy(f->name, table->name, sizeof f->name);
3132 if (table->max_flows < f->max_entries) {
3133 f->max_entries = table->max_flows;
3139 query_switch_features(struct ofproto *ofproto,
3140 bool *arp_match_ip, uint64_t *ofpacts)
3142 struct ofputil_table_features *features, *f;
3144 *arp_match_ip = false;
3147 query_tables(ofproto, &features, NULL);
3148 for (f = features; f < &features[ofproto->n_tables]; f++) {
3149 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3150 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3151 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3152 *arp_match_ip = true;
3158 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3162 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3164 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3165 struct ofputil_switch_features features;
3166 struct ofport *port;
3170 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3172 features.datapath_id = ofproto->datapath_id;
3173 features.n_buffers = pktbuf_capacity();
3174 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3175 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3176 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3177 OFPUTIL_C_GROUP_STATS);
3179 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3181 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3182 features.auxiliary_id = 0;
3183 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3185 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3186 ofputil_put_switch_features_port(&port->pp, b);
3189 ofconn_send_reply(ofconn, b);
3194 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3196 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3197 struct ofp_switch_config *osc;
3198 enum ofp_config_flags flags;
3202 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3203 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3204 flags = ofproto->frag_handling;
3205 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3206 if (oh->version < OFP13_VERSION
3207 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3208 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3210 osc->flags = htons(flags);
3211 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3212 ofconn_send_reply(ofconn, buf);
3218 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3220 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3221 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3222 uint16_t flags = ntohs(osc->flags);
3224 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3225 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3226 enum ofp_config_flags cur = ofproto->frag_handling;
3227 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3229 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3231 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3232 ofproto->frag_handling = next;
3234 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3236 ofputil_frag_handling_to_string(next));
3240 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3241 ofconn_set_invalid_ttl_to_controller(ofconn,
3242 (oh->version < OFP13_VERSION
3243 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3245 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3250 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3251 * error message code for the caller to propagate upward. Otherwise, returns
3254 * The log message mentions 'msg_type'. */
3256 reject_slave_controller(struct ofconn *ofconn)
3258 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3259 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3260 return OFPERR_OFPBRC_IS_SLAVE;
3266 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3269 * - If they use a meter, then 'ofproto' has that meter configured.
3271 * - If they use any groups, then 'ofproto' has that group configured.
3273 * Returns 0 if successful, otherwise an OpenFlow error. */
3275 ofproto_check_ofpacts(struct ofproto *ofproto,
3276 const struct ofpact ofpacts[], size_t ofpacts_len)
3278 const struct ofpact *a;
3281 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3282 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3283 return OFPERR_OFPMMFC_INVALID_METER;
3286 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3287 if (a->type == OFPACT_GROUP
3288 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3289 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3297 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3299 struct ofproto *p = ofconn_get_ofproto(ofconn);
3300 struct ofputil_packet_out po;
3301 struct dp_packet *payload;
3302 uint64_t ofpacts_stub[1024 / 8];
3303 struct ofpbuf ofpacts;
3307 COVERAGE_INC(ofproto_packet_out);
3309 error = reject_slave_controller(ofconn);
3314 /* Decode message. */
3315 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3316 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3318 goto exit_free_ofpacts;
3320 if (ofp_to_u16(po.in_port) >= p->max_ports
3321 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3322 error = OFPERR_OFPBRC_BAD_PORT;
3323 goto exit_free_ofpacts;
3327 if (po.buffer_id != UINT32_MAX) {
3328 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3329 if (error || !payload) {
3330 goto exit_free_ofpacts;
3333 /* Ensure that the L3 header is 32-bit aligned. */
3334 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3337 /* Verify actions against packet, then send packet if successful. */
3338 flow_extract(payload, &flow);
3339 flow.in_port.ofp_port = po.in_port;
3340 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3342 error = p->ofproto_class->packet_out(p, payload, &flow,
3343 po.ofpacts, po.ofpacts_len);
3345 dp_packet_delete(payload);
3348 ofpbuf_uninit(&ofpacts);
3354 update_port_config(struct ofconn *ofconn, struct ofport *port,
3355 enum ofputil_port_config config,
3356 enum ofputil_port_config mask)
3358 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3360 if (toggle & OFPUTIL_PC_PORT_DOWN
3361 && (config & OFPUTIL_PC_PORT_DOWN
3362 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3363 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3364 /* We tried to bring the port up or down, but it failed, so don't
3365 * update the "down" bit. */
3366 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3370 enum ofputil_port_config old_config = port->pp.config;
3371 port->pp.config ^= toggle;
3372 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3373 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3379 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3381 struct ofproto *p = ofconn_get_ofproto(ofconn);
3382 struct ofputil_port_mod pm;
3383 struct ofport *port;
3386 error = reject_slave_controller(ofconn);
3391 error = ofputil_decode_port_mod(oh, &pm, false);
3396 port = ofproto_get_port(p, pm.port_no);
3398 return OFPERR_OFPPMFC_BAD_PORT;
3399 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3400 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3402 update_port_config(ofconn, port, pm.config, pm.mask);
3404 netdev_set_advertisements(port->netdev, pm.advertise);
3411 handle_desc_stats_request(struct ofconn *ofconn,
3412 const struct ofp_header *request)
3414 static const char *default_mfr_desc = "Nicira, Inc.";
3415 static const char *default_hw_desc = "Open vSwitch";
3416 static const char *default_sw_desc = VERSION;
3417 static const char *default_serial_desc = "None";
3418 static const char *default_dp_desc = "None";
3420 struct ofproto *p = ofconn_get_ofproto(ofconn);
3421 struct ofp_desc_stats *ods;
3424 msg = ofpraw_alloc_stats_reply(request, 0);
3425 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3426 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3427 sizeof ods->mfr_desc);
3428 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3429 sizeof ods->hw_desc);
3430 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3431 sizeof ods->sw_desc);
3432 ovs_strlcpy(ods->serial_num,
3433 p->serial_desc ? p->serial_desc : default_serial_desc,
3434 sizeof ods->serial_num);
3435 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3436 sizeof ods->dp_desc);
3437 ofconn_send_reply(ofconn, msg);
3443 handle_table_stats_request(struct ofconn *ofconn,
3444 const struct ofp_header *request)
3446 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3447 struct ofputil_table_features *features;
3448 struct ofputil_table_stats *stats;
3449 struct ofpbuf *reply;
3452 query_tables(ofproto, &features, &stats);
3454 reply = ofputil_encode_table_stats_reply(request);
3455 for (i = 0; i < ofproto->n_tables; i++) {
3456 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3457 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3460 ofconn_send_reply(ofconn, reply);
3469 handle_table_features_request(struct ofconn *ofconn,
3470 const struct ofp_header *request)
3472 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3473 struct ofputil_table_features *features;
3474 struct ovs_list replies;
3478 ofpbuf_use_const(&msg, request, ntohs(request->length));
3479 ofpraw_pull_assert(&msg);
3480 if (msg.size || ofpmp_more(request)) {
3481 return OFPERR_OFPTFFC_EPERM;
3484 query_tables(ofproto, &features, NULL);
3486 ofpmp_init(&replies, request);
3487 for (i = 0; i < ofproto->n_tables; i++) {
3488 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3489 ofputil_append_table_features_reply(&features[i], &replies);
3492 ofconn_send_replies(ofconn, &replies);
3500 append_port_stat(struct ofport *port, struct ovs_list *replies)
3502 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3504 calc_duration(port->created, time_msec(),
3505 &ops.duration_sec, &ops.duration_nsec);
3507 /* Intentionally ignore return value, since errors will set
3508 * 'stats' to all-1s, which is correct for OpenFlow, and
3509 * netdev_get_stats() will log errors. */
3510 ofproto_port_get_stats(port, &ops.stats);
3512 ofputil_append_port_stat(replies, &ops);
3516 handle_port_request(struct ofconn *ofconn,
3517 const struct ofp_header *request, ofp_port_t port_no,
3518 void (*cb)(struct ofport *, struct ovs_list *replies))
3520 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3521 struct ofport *port;
3522 struct ovs_list replies;
3524 ofpmp_init(&replies, request);
3525 if (port_no != OFPP_ANY) {
3526 port = ofproto_get_port(ofproto, port_no);
3531 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3536 ofconn_send_replies(ofconn, &replies);
3540 handle_port_stats_request(struct ofconn *ofconn,
3541 const struct ofp_header *request)
3546 error = ofputil_decode_port_stats_request(request, &port_no);
3548 handle_port_request(ofconn, request, port_no, append_port_stat);
3554 append_port_desc(struct ofport *port, struct ovs_list *replies)
3556 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3560 handle_port_desc_stats_request(struct ofconn *ofconn,
3561 const struct ofp_header *request)
3566 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3568 handle_port_request(ofconn, request, port_no, append_port_desc);
3574 hash_cookie(ovs_be64 cookie)
3576 return hash_uint64((OVS_FORCE uint64_t)cookie);
3580 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3581 OVS_REQUIRES(ofproto_mutex)
3583 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3584 hash_cookie(rule->flow_cookie));
3588 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3589 OVS_REQUIRES(ofproto_mutex)
3591 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3595 calc_duration(long long int start, long long int now,
3596 uint32_t *sec, uint32_t *nsec)
3598 long long int msecs = now - start;
3599 *sec = msecs / 1000;
3600 *nsec = (msecs % 1000) * (1000 * 1000);
3603 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3604 * true if 'table_id' is OK, false otherwise. */
3606 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3608 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3611 static struct oftable *
3612 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3614 struct oftable *table;
3616 for (table = &ofproto->tables[table_id];
3617 table < &ofproto->tables[ofproto->n_tables];
3619 if (!(table->flags & OFTABLE_HIDDEN)) {
3627 static struct oftable *
3628 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3630 if (table_id == 0xff) {
3631 return next_visible_table(ofproto, 0);
3632 } else if (table_id < ofproto->n_tables) {
3633 return &ofproto->tables[table_id];
3639 static struct oftable *
3640 next_matching_table(const struct ofproto *ofproto,
3641 const struct oftable *table, uint8_t table_id)
3643 return (table_id == 0xff
3644 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3648 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3650 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3651 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3653 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3654 * only once, for that table. (This can be used to access tables marked
3657 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3658 * entered at all. (Perhaps you should have validated TABLE_ID with
3659 * check_table_id().)
3661 * All parameters are evaluated multiple times.
3663 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3664 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3666 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3668 /* Initializes 'criteria' in a straightforward way based on the other
3671 * By default, the criteria include flows that are read-only, on the assumption
3672 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3673 * if flows will be modified.
3675 * For "loose" matching, the 'priority' parameter is unimportant and may be
3678 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3679 const struct match *match, int priority,
3680 ovs_be64 cookie, ovs_be64 cookie_mask,
3681 ofp_port_t out_port, uint32_t out_group)
3683 criteria->table_id = table_id;
3684 cls_rule_init(&criteria->cr, match, priority);
3685 criteria->cookie = cookie;
3686 criteria->cookie_mask = cookie_mask;
3687 criteria->out_port = out_port;
3688 criteria->out_group = out_group;
3690 /* We ordinarily want to skip hidden rules, but there has to be a way for
3691 * code internal to OVS to modify and delete them, so if the criteria
3692 * specify a priority that can only be for a hidden flow, then allow hidden
3693 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3694 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3696 criteria->include_hidden = priority > UINT16_MAX;
3698 /* We assume that the criteria are being used to collect flows for reading
3699 * but not modification. Thus, we should collect read-only flows. */
3700 criteria->include_readonly = true;
3703 /* By default, criteria initialized by rule_criteria_init() will match flows
3704 * that are read-only, on the assumption that the collected flows won't be
3705 * modified. Call this function to match only flows that are be modifiable.
3707 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3708 * caller has special privileges that allow it to modify even "read-only"
3711 rule_criteria_require_rw(struct rule_criteria *criteria,
3712 bool can_write_readonly)
3714 criteria->include_readonly = can_write_readonly;
3718 rule_criteria_destroy(struct rule_criteria *criteria)
3720 cls_rule_destroy(&criteria->cr);
3724 rule_collection_init(struct rule_collection *rules)
3726 rules->rules = rules->stub;
3728 rules->capacity = ARRAY_SIZE(rules->stub);
3732 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3734 if (rules->n >= rules->capacity) {
3735 size_t old_size, new_size;
3737 old_size = rules->capacity * sizeof *rules->rules;
3738 rules->capacity *= 2;
3739 new_size = rules->capacity * sizeof *rules->rules;
3741 if (rules->rules == rules->stub) {
3742 rules->rules = xmalloc(new_size);
3743 memcpy(rules->rules, rules->stub, old_size);
3745 rules->rules = xrealloc(rules->rules, new_size);
3749 rules->rules[rules->n++] = rule;
3753 rule_collection_ref(struct rule_collection *rules)
3754 OVS_REQUIRES(ofproto_mutex)
3758 for (i = 0; i < rules->n; i++) {
3759 ofproto_rule_ref(rules->rules[i]);
3764 rule_collection_unref(struct rule_collection *rules)
3768 for (i = 0; i < rules->n; i++) {
3769 ofproto_rule_unref(rules->rules[i]);
3774 rule_collection_destroy(struct rule_collection *rules)
3776 if (rules->rules != rules->stub) {
3780 /* Make repeated destruction harmless. */
3781 rule_collection_init(rules);
3784 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3785 * function verifies most of the criteria in 'c' itself, but the caller must
3786 * check 'c->cr' itself.
3788 * Rules that have already been marked as 'to_be_removed' are not collected.
3790 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3791 * 'c' only includes modifiable rules). */
3793 collect_rule(struct rule *rule, const struct rule_criteria *c,
3794 struct rule_collection *rules, size_t *n_readonly)
3795 OVS_REQUIRES(ofproto_mutex)
3797 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3798 && ofproto_rule_has_out_port(rule, c->out_port)
3799 && ofproto_rule_has_out_group(rule, c->out_group)
3800 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3801 && (!rule_is_hidden(rule) || c->include_hidden)
3802 && !rule->cr.to_be_removed) {
3803 /* Rule matches all the criteria... */
3804 if (!rule_is_readonly(rule) || c->include_readonly) {
3806 rule_collection_add(rules, rule);
3808 /* ...except it's read-only. */
3814 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3815 * on classifiers rules are done in the "loose" way required for OpenFlow
3816 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3819 * Returns 0 on success, otherwise an OpenFlow error code. */
3821 collect_rules_loose(struct ofproto *ofproto,
3822 const struct rule_criteria *criteria,
3823 struct rule_collection *rules)
3824 OVS_REQUIRES(ofproto_mutex)
3826 struct oftable *table;
3827 enum ofperr error = 0;
3828 size_t n_readonly = 0;
3830 rule_collection_init(rules);
3832 if (!check_table_id(ofproto, criteria->table_id)) {
3833 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3837 if (criteria->cookie_mask == OVS_BE64_MAX) {
3840 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3841 hash_cookie(criteria->cookie),
3842 &ofproto->cookies) {
3843 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3844 collect_rule(rule, criteria, rules, &n_readonly);
3848 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3851 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3852 collect_rule(rule, criteria, rules, &n_readonly);
3858 if (!error && !rules->n && n_readonly) {
3859 /* We didn't find any rules to modify. We did find some read-only
3860 * rules that we're not allowed to modify, so report that. */
3861 error = OFPERR_OFPBRC_EPERM;
3864 rule_collection_destroy(rules);
3869 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3870 * on classifiers rules are done in the "strict" way required for OpenFlow
3871 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3872 * rules on list 'rules'.
3874 * Returns 0 on success, otherwise an OpenFlow error code. */
3876 collect_rules_strict(struct ofproto *ofproto,
3877 const struct rule_criteria *criteria,
3878 struct rule_collection *rules)
3879 OVS_REQUIRES(ofproto_mutex)
3881 struct oftable *table;
3882 size_t n_readonly = 0;
3883 enum ofperr error = 0;
3885 rule_collection_init(rules);
3887 if (!check_table_id(ofproto, criteria->table_id)) {
3888 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3892 if (criteria->cookie_mask == OVS_BE64_MAX) {
3895 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3896 hash_cookie(criteria->cookie),
3897 &ofproto->cookies) {
3898 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3899 collect_rule(rule, criteria, rules, &n_readonly);
3903 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3906 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3907 &table->cls, &criteria->cr));
3909 collect_rule(rule, criteria, rules, &n_readonly);
3915 if (!error && !rules->n && n_readonly) {
3916 /* We didn't find any rules to modify. We did find some read-only
3917 * rules that we're not allowed to modify, so report that. */
3918 error = OFPERR_OFPBRC_EPERM;
3921 rule_collection_destroy(rules);
3926 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3927 * forced into the range of a uint16_t. */
3929 age_secs(long long int age_ms)
3931 return (age_ms < 0 ? 0
3932 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3933 : (unsigned int) age_ms / 1000);
3937 handle_flow_stats_request(struct ofconn *ofconn,
3938 const struct ofp_header *request)
3939 OVS_EXCLUDED(ofproto_mutex)
3941 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3942 struct ofputil_flow_stats_request fsr;
3943 struct rule_criteria criteria;
3944 struct rule_collection rules;
3945 struct ovs_list replies;
3949 error = ofputil_decode_flow_stats_request(&fsr, request);
3954 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3955 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3957 ovs_mutex_lock(&ofproto_mutex);
3958 error = collect_rules_loose(ofproto, &criteria, &rules);
3959 rule_criteria_destroy(&criteria);
3961 rule_collection_ref(&rules);
3963 ovs_mutex_unlock(&ofproto_mutex);
3969 ofpmp_init(&replies, request);
3970 for (i = 0; i < rules.n; i++) {
3971 struct rule *rule = rules.rules[i];
3972 long long int now = time_msec();
3973 struct ofputil_flow_stats fs;
3974 long long int created, used, modified;
3975 const struct rule_actions *actions;
3976 enum ofputil_flow_mod_flags flags;
3978 ovs_mutex_lock(&rule->mutex);
3979 fs.cookie = rule->flow_cookie;
3980 fs.idle_timeout = rule->idle_timeout;
3981 fs.hard_timeout = rule->hard_timeout;
3982 fs.importance = rule->importance;
3983 created = rule->created;
3984 modified = rule->modified;
3985 actions = rule_get_actions(rule);
3986 flags = rule->flags;
3987 ovs_mutex_unlock(&rule->mutex);
3989 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3990 &fs.byte_count, &used);
3992 minimatch_expand(&rule->cr.match, &fs.match);
3993 fs.table_id = rule->table_id;
3994 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3995 fs.priority = rule->cr.priority;
3996 fs.idle_age = age_secs(now - used);
3997 fs.hard_age = age_secs(now - modified);
3998 fs.ofpacts = actions->ofpacts;
3999 fs.ofpacts_len = actions->ofpacts_len;
4002 ofputil_append_flow_stats_reply(&fs, &replies);
4005 rule_collection_unref(&rules);
4006 rule_collection_destroy(&rules);
4008 ofconn_send_replies(ofconn, &replies);
4014 flow_stats_ds(struct rule *rule, struct ds *results)
4016 uint64_t packet_count, byte_count;
4017 const struct rule_actions *actions;
4018 long long int created, used;
4020 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4021 &byte_count, &used);
4023 ovs_mutex_lock(&rule->mutex);
4024 actions = rule_get_actions(rule);
4025 created = rule->created;
4026 ovs_mutex_unlock(&rule->mutex);
4028 if (rule->table_id != 0) {
4029 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4031 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4032 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4033 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4034 cls_rule_format(&rule->cr, results);
4035 ds_put_char(results, ',');
4037 ds_put_cstr(results, "actions=");
4038 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4040 ds_put_cstr(results, "\n");
4043 /* Adds a pretty-printed description of all flows to 'results', including
4044 * hidden flows (e.g., set up by in-band control). */
4046 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4048 struct oftable *table;
4050 OFPROTO_FOR_EACH_TABLE (table, p) {
4053 CLS_FOR_EACH (rule, cr, &table->cls) {
4054 flow_stats_ds(rule, results);
4059 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4060 * '*engine_type' and '*engine_id', respectively. */
4062 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4063 uint8_t *engine_type, uint8_t *engine_id)
4065 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4068 /* Checks the status change of CFM on 'ofport'.
4070 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4072 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4074 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4075 return (ofport && ofproto->ofproto_class->cfm_status_changed
4076 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4080 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4081 * Returns 0 if the port's CFM status was successfully stored into
4082 * '*status'. Returns positive errno if the port did not have CFM
4085 * The caller must provide and own '*status', and must free 'status->rmps'.
4086 * '*status' is indeterminate if the return value is non-zero. */
4088 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4089 struct cfm_status *status)
4091 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4092 return (ofport && ofproto->ofproto_class->get_cfm_status
4093 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4098 handle_aggregate_stats_request(struct ofconn *ofconn,
4099 const struct ofp_header *oh)
4100 OVS_EXCLUDED(ofproto_mutex)
4102 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4103 struct ofputil_flow_stats_request request;
4104 struct ofputil_aggregate_stats stats;
4105 bool unknown_packets, unknown_bytes;
4106 struct rule_criteria criteria;
4107 struct rule_collection rules;
4108 struct ofpbuf *reply;
4112 error = ofputil_decode_flow_stats_request(&request, oh);
4117 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4118 request.cookie, request.cookie_mask,
4119 request.out_port, request.out_group);
4121 ovs_mutex_lock(&ofproto_mutex);
4122 error = collect_rules_loose(ofproto, &criteria, &rules);
4123 rule_criteria_destroy(&criteria);
4125 rule_collection_ref(&rules);
4127 ovs_mutex_unlock(&ofproto_mutex);
4133 memset(&stats, 0, sizeof stats);
4134 unknown_packets = unknown_bytes = false;
4135 for (i = 0; i < rules.n; i++) {
4136 struct rule *rule = rules.rules[i];
4137 uint64_t packet_count;
4138 uint64_t byte_count;
4141 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4142 &byte_count, &used);
4144 if (packet_count == UINT64_MAX) {
4145 unknown_packets = true;
4147 stats.packet_count += packet_count;
4150 if (byte_count == UINT64_MAX) {
4151 unknown_bytes = true;
4153 stats.byte_count += byte_count;
4158 if (unknown_packets) {
4159 stats.packet_count = UINT64_MAX;
4161 if (unknown_bytes) {
4162 stats.byte_count = UINT64_MAX;
4165 rule_collection_unref(&rules);
4166 rule_collection_destroy(&rules);
4168 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4169 ofconn_send_reply(ofconn, reply);
4174 struct queue_stats_cbdata {
4175 struct ofport *ofport;
4176 struct ovs_list replies;
4181 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4182 const struct netdev_queue_stats *stats)
4184 struct ofputil_queue_stats oqs;
4186 oqs.port_no = cbdata->ofport->pp.port_no;
4187 oqs.queue_id = queue_id;
4188 oqs.tx_bytes = stats->tx_bytes;
4189 oqs.tx_packets = stats->tx_packets;
4190 oqs.tx_errors = stats->tx_errors;
4191 if (stats->created != LLONG_MIN) {
4192 calc_duration(stats->created, cbdata->now,
4193 &oqs.duration_sec, &oqs.duration_nsec);
4195 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4197 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4201 handle_queue_stats_dump_cb(uint32_t queue_id,
4202 struct netdev_queue_stats *stats,
4205 struct queue_stats_cbdata *cbdata = cbdata_;
4207 put_queue_stats(cbdata, queue_id, stats);
4211 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4212 struct queue_stats_cbdata *cbdata)
4214 cbdata->ofport = port;
4215 if (queue_id == OFPQ_ALL) {
4216 netdev_dump_queue_stats(port->netdev,
4217 handle_queue_stats_dump_cb, cbdata);
4219 struct netdev_queue_stats stats;
4221 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4222 put_queue_stats(cbdata, queue_id, &stats);
4224 return OFPERR_OFPQOFC_BAD_QUEUE;
4231 handle_queue_stats_request(struct ofconn *ofconn,
4232 const struct ofp_header *rq)
4234 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4235 struct queue_stats_cbdata cbdata;
4236 struct ofport *port;
4238 struct ofputil_queue_stats_request oqsr;
4240 COVERAGE_INC(ofproto_queue_req);
4242 ofpmp_init(&cbdata.replies, rq);
4243 cbdata.now = time_msec();
4245 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4250 if (oqsr.port_no == OFPP_ANY) {
4251 error = OFPERR_OFPQOFC_BAD_QUEUE;
4252 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4253 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4258 port = ofproto_get_port(ofproto, oqsr.port_no);
4260 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4261 : OFPERR_OFPQOFC_BAD_PORT);
4264 ofconn_send_replies(ofconn, &cbdata.replies);
4266 ofpbuf_list_delete(&cbdata.replies);
4273 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4274 OVS_REQUIRES(ofproto_mutex)
4276 enum ofperr error = 0;
4277 struct rule_collection rules;
4278 unsigned int count = classifier_count(&table->cls) + extra_space;
4279 unsigned int max_flows = table->max_flows;
4281 rule_collection_init(&rules);
4283 while (count-- > max_flows) {
4286 if (!choose_rule_to_evict(table, &rule)) {
4287 error = OFPERR_OFPFMFC_TABLE_FULL;
4290 eviction_group_remove_rule(rule);
4291 rule_collection_add(&rules, rule);
4294 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4295 rule_collection_destroy(&rules);
4301 is_conjunction(const struct ofpact *ofpacts, size_t ofpacts_len)
4303 return ofpacts_len > 0 && ofpacts->type == OFPACT_CONJUNCTION;
4307 get_conjunctions(const struct ofputil_flow_mod *fm,
4308 struct cls_conjunction **conjsp, size_t *n_conjsp)
4309 OVS_REQUIRES(ofproto_mutex)
4311 struct cls_conjunction *conjs = NULL;
4314 if (is_conjunction(fm->ofpacts, fm->ofpacts_len)) {
4315 const struct ofpact *ofpact;
4319 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4323 conjs = xzalloc(n_conjs * sizeof *conjs);
4325 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4326 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4327 conjs[i].clause = oc->clause;
4328 conjs[i].n_clauses = oc->n_clauses;
4329 conjs[i].id = oc->id;
4335 *n_conjsp = n_conjs;
4339 set_conjunctions(struct rule *rule, const struct cls_conjunction *conjs,
4341 OVS_REQUIRES(ofproto_mutex)
4343 struct cls_rule *cr = CONST_CAST(struct cls_rule *, &rule->cr);
4345 cls_rule_set_conjunctions(cr, conjs, n_conjs);
4348 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4349 * in which no matching flow already exists in the flow table.
4351 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4352 * success, or an OpenFlow error code on failure.
4354 * On successful return the caller must complete the operation either by
4355 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4358 * The caller retains ownership of 'fm->ofpacts'. */
4360 add_flow_begin(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4361 struct rule **rulep, bool *modify)
4362 OVS_REQUIRES(ofproto_mutex)
4364 struct oftable *table;
4368 enum ofperr error = 0;
4370 if (!check_table_id(ofproto, fm->table_id)) {
4371 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4376 if (fm->table_id == 0xff) {
4377 if (ofproto->ofproto_class->rule_choose_table) {
4378 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4384 ovs_assert(table_id < ofproto->n_tables);
4388 } else if (fm->table_id < ofproto->n_tables) {
4389 table_id = fm->table_id;
4391 return OFPERR_OFPBRC_BAD_TABLE_ID;
4394 table = &ofproto->tables[table_id];
4395 if (table->flags & OFTABLE_READONLY
4396 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4397 return OFPERR_OFPBRC_EPERM;
4400 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4401 && !match_has_default_hidden_fields(&fm->match)) {
4402 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4403 "non-default values to hidden fields", ofproto->name);
4404 return OFPERR_OFPBRC_EPERM;
4407 cls_rule_init(&cr, &fm->match, fm->priority);
4409 /* Check for the existence of an identical rule.
4410 * This will not return rules earlier marked as 'to_be_removed'. */
4411 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4413 /* Transform "add" into "modify" of an existing identical flow. */
4414 cls_rule_destroy(&cr);
4416 fm->modify_cookie = true;
4417 error = modify_flow_check__(ofproto, fm, rule);
4423 } else { /* New rule. */
4424 struct cls_conjunction *conjs;
4427 /* Check for overlap, if requested. */
4428 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4429 && classifier_rule_overlaps(&table->cls, &cr)) {
4430 cls_rule_destroy(&cr);
4431 return OFPERR_OFPFMFC_OVERLAP;
4434 /* If necessary, evict an existing rule to clear out space. */
4435 error = evict_rules_from_table(table, 1);
4437 cls_rule_destroy(&cr);
4441 /* Allocate new rule. */
4442 error = ofproto_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4448 /* Insert flow to the classifier, so that later flow_mods may relate
4449 * to it. This is reversible, in case later errors require this to
4451 ofproto_rule_insert__(ofproto, rule);
4452 /* Make the new rule invisible for classifier lookups. */
4453 classifier_defer(&table->cls);
4454 get_conjunctions(fm, &conjs, &n_conjs);
4455 classifier_insert(&table->cls, &rule->cr, conjs, n_conjs);
4458 error = ofproto->ofproto_class->rule_insert(rule);
4460 oftable_remove_rule(rule);
4461 ofproto_rule_unref(rule);
4472 /* Revert the effects of add_flow_begin().
4473 * 'new_rule' must be passed in as NULL, if no new rule was allocated and
4474 * inserted to the classifier.
4475 * Note: evictions cannot be reverted. */
4477 add_flow_revert(struct ofproto *ofproto, struct rule *new_rule)
4478 OVS_REQUIRES(ofproto_mutex)
4480 /* Old rule was not changed yet, only need to revert a new rule. */
4482 struct oftable *table = &ofproto->tables[new_rule->table_id];
4484 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4487 classifier_publish(&table->cls);
4489 ofproto_rule_remove__(ofproto, new_rule);
4490 ofproto->ofproto_class->rule_delete(new_rule);
4491 ofproto_rule_unref(new_rule);
4496 add_flow_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4497 const struct flow_mod_requester *req,
4498 struct rule *rule, bool modify)
4499 OVS_REQUIRES(ofproto_mutex)
4502 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4504 modify_flow__(ofproto, fm, req, rule, &dead_cookies);
4505 learned_cookies_flush(ofproto, &dead_cookies);
4507 struct oftable *table = &ofproto->tables[rule->table_id];
4509 cls_rule_make_visible(&rule->cr);
4510 classifier_publish(&table->cls);
4512 learned_cookies_inc(ofproto, rule_get_actions(rule));
4514 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
4515 if (ofproto->vlan_bitmap) {
4516 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4518 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4519 bitmap_set1(ofproto->vlan_bitmap, vid);
4520 ofproto->vlans_changed = true;
4523 ofproto->vlans_changed = true;
4527 ofmonitor_report(ofproto->connmgr, rule, NXFME_ADDED, 0,
4528 req ? req->ofconn : NULL,
4529 req ? req->request->xid : 0, NULL);
4532 send_buffered_packet(req, fm->buffer_id, rule);
4535 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4537 /* Checks if the 'rule' can be modified to match 'fm'.
4539 * Returns 0 on success, otherwise an OpenFlow error code. */
4541 modify_flow_check__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4542 const struct rule *rule)
4543 OVS_REQUIRES(ofproto_mutex)
4545 if (ofproto->ofproto_class->rule_premodify_actions) {
4546 return ofproto->ofproto_class->rule_premodify_actions(
4547 rule, fm->ofpacts, fm->ofpacts_len);
4552 /* Checks if the rules listed in 'rules' can have their actions changed to
4553 * match those in 'fm'.
4555 * Returns 0 on success, otherwise an OpenFlow error code. */
4557 modify_flows_check__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4558 const struct rule_collection *rules)
4559 OVS_REQUIRES(ofproto_mutex)
4564 if (ofproto->ofproto_class->rule_premodify_actions) {
4565 for (i = 0; i < rules->n; i++) {
4566 error = modify_flow_check__(ofproto, fm, rules->rules[i]);
4576 /* Modifies the 'rule', changing them to match 'fm'. */
4578 modify_flow__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4579 const struct flow_mod_requester *req, struct rule *rule,
4580 struct ovs_list *dead_cookies)
4581 OVS_REQUIRES(ofproto_mutex)
4583 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4584 ? NXFME_ADDED : NXFME_MODIFIED;
4586 /* 'fm' says that */
4587 bool change_cookie = (fm->modify_cookie
4588 && fm->new_cookie != OVS_BE64_MAX
4589 && fm->new_cookie != rule->flow_cookie);
4591 const struct rule_actions *actions = rule_get_actions(rule);
4592 bool change_actions = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4594 actions->ofpacts_len);
4596 bool reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4598 long long int now = time_msec();
4600 if (change_cookie) {
4601 cookies_remove(ofproto, rule);
4604 ovs_mutex_lock(&rule->mutex);
4605 if (fm->command == OFPFC_ADD) {
4606 rule->idle_timeout = fm->idle_timeout;
4607 rule->hard_timeout = fm->hard_timeout;
4608 rule->importance = fm->importance;
4609 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4610 rule->created = now;
4612 if (change_cookie) {
4613 rule->flow_cookie = fm->new_cookie;
4615 rule->modified = now;
4616 ovs_mutex_unlock(&rule->mutex);
4618 if (change_cookie) {
4619 cookies_insert(ofproto, rule);
4621 if (fm->command == OFPFC_ADD) {
4622 if (fm->idle_timeout || fm->hard_timeout || fm->importance) {
4623 if (!rule->eviction_group) {
4624 eviction_group_add_rule(rule);
4627 eviction_group_remove_rule(rule);
4631 if (change_actions) {
4632 /* We have to change the actions. The rule's conjunctive match set
4633 * is a function of its actions, so we need to update that too. The
4634 * conjunctive match set is used in the lookup process to figure
4635 * which (if any) collection of conjunctive sets the packet matches
4636 * with. However, a rule with conjunction actions is never to be
4637 * returned as a classifier lookup result. To make sure a rule with
4638 * conjunction actions is not returned as a lookup result, we update
4639 * them in a carefully chosen order:
4641 * - If we're adding a conjunctive match set where there wasn't one
4642 * before, we have to make the conjunctive match set available to
4643 * lookups before the rule's actions are changed, as otherwise
4644 * rule with a conjunction action could be returned as a lookup
4647 * - To clear some nonempty conjunctive set, we set the rule's
4648 * actions first, so that a lookup can't return a rule with
4649 * conjunction actions.
4651 * - Otherwise, order doesn't matter for changing one nonempty
4652 * conjunctive match set to some other nonempty set, since the
4653 * rule's actions are not seen by the classifier, and hence don't
4654 * matter either before or after the change. */
4655 struct cls_conjunction *conjs;
4657 get_conjunctions(fm, &conjs, &n_conjs);
4660 set_conjunctions(rule, conjs, n_conjs);
4662 ovsrcu_set(&rule->actions, rule_actions_create(fm->ofpacts,
4665 set_conjunctions(rule, conjs, n_conjs);
4671 if (change_actions || reset_counters) {
4672 ofproto->ofproto_class->rule_modify_actions(rule, reset_counters);
4675 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4676 ofmonitor_report(ofproto->connmgr, rule, event, 0,
4677 req ? req->ofconn : NULL, req ? req->request->xid : 0,
4678 change_actions ? actions : NULL);
4681 if (change_actions) {
4682 learned_cookies_inc(ofproto, rule_get_actions(rule));
4683 learned_cookies_dec(ofproto, actions, dead_cookies);
4684 rule_actions_destroy(actions);
4688 /* Modifies the rules listed in 'rules', changing their actions to match those
4691 * 'req' is used to retrieve the packet buffer specified in fm->buffer_id,
4694 modify_flows__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4695 const struct flow_mod_requester *req,
4696 const struct rule_collection *rules)
4697 OVS_REQUIRES(ofproto_mutex)
4699 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4702 for (i = 0; i < rules->n; i++) {
4703 modify_flow__(ofproto, fm, req, rules->rules[i], &dead_cookies);
4705 learned_cookies_flush(ofproto, &dead_cookies);
4709 modify_flows_begin__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4710 struct rule_collection *rules)
4711 OVS_REQUIRES(ofproto_mutex)
4716 error = modify_flows_check__(ofproto, fm, rules);
4717 } else if (!(fm->cookie_mask != htonll(0)
4718 || fm->new_cookie == OVS_BE64_MAX)) {
4721 error = add_flow_begin(ofproto, fm, &rules->rules[0], &modify);
4723 ovs_assert(!modify);
4726 rules->rules[0] = NULL;
4732 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4735 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4738 modify_flows_begin_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4739 struct rule_collection *rules)
4740 OVS_REQUIRES(ofproto_mutex)
4742 struct rule_criteria criteria;
4745 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4746 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4747 rule_criteria_require_rw(&criteria,
4748 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4749 error = collect_rules_loose(ofproto, &criteria, rules);
4750 rule_criteria_destroy(&criteria);
4753 error = modify_flows_begin__(ofproto, fm, rules);
4757 rule_collection_destroy(rules);
4763 modify_flows_revert(struct ofproto *ofproto, struct rule_collection *rules)
4764 OVS_REQUIRES(ofproto_mutex)
4766 /* Old rules were not changed yet, only need to revert a new rule. */
4767 if (rules->n == 0 && rules->rules[0] != NULL) {
4768 add_flow_revert(ofproto, rules->rules[0]);
4770 rule_collection_destroy(rules);
4774 modify_flows_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4775 const struct flow_mod_requester *req,
4776 struct rule_collection *rules)
4777 OVS_REQUIRES(ofproto_mutex)
4780 modify_flows__(ofproto, fm, req, rules);
4781 send_buffered_packet(req, fm->buffer_id, rules->rules[0]);
4782 } else if (rules->rules[0] != NULL) {
4783 add_flow_finish(ofproto, fm, req, rules->rules[0], false);
4785 rule_collection_destroy(rules);
4788 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4789 * code on failure. */
4791 modify_flow_begin_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4792 struct rule_collection *rules)
4793 OVS_REQUIRES(ofproto_mutex)
4795 struct rule_criteria criteria;
4798 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4799 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4800 rule_criteria_require_rw(&criteria,
4801 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4802 error = collect_rules_strict(ofproto, &criteria, rules);
4803 rule_criteria_destroy(&criteria);
4806 /* collect_rules_strict() can return max 1 rule. */
4807 error = modify_flows_begin__(ofproto, fm, rules);
4811 rule_collection_destroy(rules);
4816 /* OFPFC_DELETE implementation. */
4818 /* Deletes the rules listed in 'rules'. */
4820 delete_flows__(const struct rule_collection *rules,
4821 enum ofp_flow_removed_reason reason,
4822 const struct flow_mod_requester *req)
4823 OVS_REQUIRES(ofproto_mutex)
4826 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4827 struct ofproto *ofproto = rules->rules[0]->ofproto;
4828 struct rule *rule, *next;
4831 for (i = 0, next = rules->rules[0];
4832 rule = next, next = (++i < rules->n) ? rules->rules[i] : NULL,
4834 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
4835 uint8_t next_table = next ? next->table_id : UINT8_MAX;
4837 ofproto_rule_send_removed(rule, reason);
4839 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4840 req ? req->ofconn : NULL,
4841 req ? req->request->xid : 0, NULL);
4843 if (next_table == rule->table_id) {
4844 classifier_defer(cls);
4846 if (!classifier_remove(cls, &rule->cr)) {
4849 if (next_table != rule->table_id) {
4850 classifier_publish(cls);
4852 ofproto_rule_remove__(ofproto, rule);
4854 ofproto->ofproto_class->rule_delete(rule);
4856 learned_cookies_dec(ofproto, rule_get_actions(rule),
4859 ofproto_rule_unref(rule);
4861 learned_cookies_flush(ofproto, &dead_cookies);
4862 ofmonitor_flush(ofproto->connmgr);
4866 /* Implements OFPFC_DELETE. */
4868 delete_flows_begin_loose(struct ofproto *ofproto,
4869 const struct ofputil_flow_mod *fm,
4870 struct rule_collection *rules)
4871 OVS_REQUIRES(ofproto_mutex)
4873 struct rule_criteria criteria;
4876 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4877 fm->cookie, fm->cookie_mask,
4878 fm->out_port, fm->out_group);
4879 rule_criteria_require_rw(&criteria,
4880 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4881 error = collect_rules_loose(ofproto, &criteria, rules);
4882 rule_criteria_destroy(&criteria);
4885 for (size_t i = 0; i < rules->n; i++) {
4886 struct rule *rule = rules->rules[i];
4888 CONST_CAST(struct cls_rule *, &rule->cr)->to_be_removed = true;
4896 delete_flows_revert(struct rule_collection *rules)
4897 OVS_REQUIRES(ofproto_mutex)
4899 for (size_t i = 0; i < rules->n; i++) {
4900 struct rule *rule = rules->rules[i];
4902 CONST_CAST(struct cls_rule *, &rule->cr)->to_be_removed = false;
4904 rule_collection_destroy(rules);
4908 delete_flows_finish(const struct ofputil_flow_mod *fm,
4909 const struct flow_mod_requester *req,
4910 struct rule_collection *rules)
4911 OVS_REQUIRES(ofproto_mutex)
4913 delete_flows__(rules, fm->delete_reason, req);
4914 rule_collection_destroy(rules);
4917 /* Implements OFPFC_DELETE_STRICT. */
4919 delete_flow_begin_strict(struct ofproto *ofproto,
4920 const struct ofputil_flow_mod *fm,
4921 struct rule_collection *rules)
4922 OVS_REQUIRES(ofproto_mutex)
4924 struct rule_criteria criteria;
4927 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4928 fm->cookie, fm->cookie_mask,
4929 fm->out_port, fm->out_group);
4930 rule_criteria_require_rw(&criteria,
4931 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4932 error = collect_rules_strict(ofproto, &criteria, rules);
4933 rule_criteria_destroy(&criteria);
4936 for (size_t i = 0; i < rules->n; i++) {
4937 struct rule *rule = rules->rules[i];
4939 CONST_CAST(struct cls_rule *, &rule->cr)->to_be_removed = true;
4947 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4948 OVS_REQUIRES(ofproto_mutex)
4950 struct ofputil_flow_removed fr;
4953 if (rule_is_hidden(rule) ||
4954 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4958 minimatch_expand(&rule->cr.match, &fr.match);
4959 fr.priority = rule->cr.priority;
4960 fr.cookie = rule->flow_cookie;
4962 fr.table_id = rule->table_id;
4963 calc_duration(rule->created, time_msec(),
4964 &fr.duration_sec, &fr.duration_nsec);
4965 ovs_mutex_lock(&rule->mutex);
4966 fr.idle_timeout = rule->idle_timeout;
4967 fr.hard_timeout = rule->hard_timeout;
4968 ovs_mutex_unlock(&rule->mutex);
4969 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4970 &fr.byte_count, &used);
4972 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4975 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4976 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4979 * ofproto implementation ->run() functions should use this function to expire
4980 * OpenFlow flows. */
4982 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4983 OVS_REQUIRES(ofproto_mutex)
4985 struct rule_collection rules;
4987 rules.rules = rules.stub;
4989 rules.stub[0] = rule;
4990 delete_flows__(&rules, reason, NULL);
4993 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4994 * means "infinite". */
4996 reduce_timeout(uint16_t max, uint16_t *timeout)
4998 if (max && (!*timeout || *timeout > max)) {
5003 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5004 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5005 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5007 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5009 ofproto_rule_reduce_timeouts(struct rule *rule,
5010 uint16_t idle_timeout, uint16_t hard_timeout)
5011 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5013 if (!idle_timeout && !hard_timeout) {
5017 ovs_mutex_lock(&ofproto_mutex);
5018 if (list_is_empty(&rule->expirable)) {
5019 list_insert(&rule->ofproto->expirable, &rule->expirable);
5021 ovs_mutex_unlock(&ofproto_mutex);
5023 ovs_mutex_lock(&rule->mutex);
5024 reduce_timeout(idle_timeout, &rule->idle_timeout);
5025 reduce_timeout(hard_timeout, &rule->hard_timeout);
5026 ovs_mutex_unlock(&rule->mutex);
5030 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5031 OVS_EXCLUDED(ofproto_mutex)
5033 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5034 struct ofputil_flow_mod fm;
5035 uint64_t ofpacts_stub[1024 / 8];
5036 struct ofpbuf ofpacts;
5039 error = reject_slave_controller(ofconn);
5044 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5045 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
5047 u16_to_ofp(ofproto->max_ports),
5050 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
5053 struct flow_mod_requester req;
5055 req.ofconn = ofconn;
5057 error = handle_flow_mod__(ofproto, &fm, &req);
5060 goto exit_free_ofpacts;
5063 ofconn_report_flow_mod(ofconn, fm.command);
5066 ofpbuf_uninit(&ofpacts);
5072 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
5073 const struct flow_mod_requester *req)
5074 OVS_EXCLUDED(ofproto_mutex)
5076 struct ofp_bundle_entry be;
5079 ovs_mutex_lock(&ofproto_mutex);
5080 error = do_bundle_flow_mod_begin(ofproto, fm, &be);
5082 do_bundle_flow_mod_finish(ofproto, fm, req, &be);
5084 ofmonitor_flush(ofproto->connmgr);
5085 ovs_mutex_unlock(&ofproto_mutex);
5087 run_rule_executes(ofproto);
5092 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5094 struct ofputil_role_request request;
5095 struct ofputil_role_request reply;
5099 error = ofputil_decode_role_message(oh, &request);
5104 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5105 if (request.have_generation_id
5106 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5107 return OFPERR_OFPRRFC_STALE;
5110 ofconn_set_role(ofconn, request.role);
5113 reply.role = ofconn_get_role(ofconn);
5114 reply.have_generation_id = ofconn_get_master_election_id(
5115 ofconn, &reply.generation_id);
5116 buf = ofputil_encode_role_reply(oh, &reply);
5117 ofconn_send_reply(ofconn, buf);
5123 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5124 const struct ofp_header *oh)
5126 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5127 enum ofputil_protocol cur, next;
5129 cur = ofconn_get_protocol(ofconn);
5130 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5131 ofconn_set_protocol(ofconn, next);
5137 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5139 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5140 enum ofputil_protocol cur, next;
5141 enum ofputil_protocol next_base;
5143 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5145 return OFPERR_OFPBRC_EPERM;
5148 cur = ofconn_get_protocol(ofconn);
5149 next = ofputil_protocol_set_base(cur, next_base);
5150 ofconn_set_protocol(ofconn, next);
5156 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5157 const struct ofp_header *oh)
5159 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5162 format = ntohl(msg->format);
5163 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5164 return OFPERR_OFPBRC_EPERM;
5167 ofconn_set_packet_in_format(ofconn, format);
5172 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5174 const struct nx_async_config *msg = ofpmsg_body(oh);
5175 uint32_t master[OAM_N_TYPES];
5176 uint32_t slave[OAM_N_TYPES];
5178 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5179 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5180 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5182 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5183 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5184 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5186 ofconn_set_async_config(ofconn, master, slave);
5187 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5188 !ofconn_get_miss_send_len(ofconn)) {
5189 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5196 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5199 uint32_t master[OAM_N_TYPES];
5200 uint32_t slave[OAM_N_TYPES];
5201 struct nx_async_config *msg;
5203 ofconn_get_async_config(ofconn, master, slave);
5204 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5205 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5207 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5208 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5209 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5211 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5212 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5213 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5215 ofconn_send_reply(ofconn, buf);
5221 handle_nxt_set_controller_id(struct ofconn *ofconn,
5222 const struct ofp_header *oh)
5224 const struct nx_controller_id *nci = ofpmsg_body(oh);
5226 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5227 return OFPERR_NXBRC_MUST_BE_ZERO;
5230 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5235 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5239 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5240 ? OFPRAW_OFPT10_BARRIER_REPLY
5241 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5242 ofconn_send_reply(ofconn, buf);
5247 ofproto_compose_flow_refresh_update(const struct rule *rule,
5248 enum nx_flow_monitor_flags flags,
5249 struct ovs_list *msgs)
5250 OVS_REQUIRES(ofproto_mutex)
5252 const struct rule_actions *actions;
5253 struct ofputil_flow_update fu;
5256 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5257 ? NXFME_ADDED : NXFME_MODIFIED);
5259 ovs_mutex_lock(&rule->mutex);
5260 fu.idle_timeout = rule->idle_timeout;
5261 fu.hard_timeout = rule->hard_timeout;
5262 ovs_mutex_unlock(&rule->mutex);
5263 fu.table_id = rule->table_id;
5264 fu.cookie = rule->flow_cookie;
5265 minimatch_expand(&rule->cr.match, &match);
5267 fu.priority = rule->cr.priority;
5269 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5270 fu.ofpacts = actions ? actions->ofpacts : NULL;
5271 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5273 if (list_is_empty(msgs)) {
5274 ofputil_start_flow_update(msgs);
5276 ofputil_append_flow_update(&fu, msgs);
5280 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5281 struct ovs_list *msgs)
5282 OVS_REQUIRES(ofproto_mutex)
5286 for (i = 0; i < rules->n; i++) {
5287 struct rule *rule = rules->rules[i];
5288 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5289 rule->monitor_flags = 0;
5291 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5296 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5297 struct rule *rule, uint64_t seqno,
5298 struct rule_collection *rules)
5299 OVS_REQUIRES(ofproto_mutex)
5301 enum nx_flow_monitor_flags update;
5303 if (rule_is_hidden(rule)) {
5307 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5312 if (rule->add_seqno > seqno) {
5313 update = NXFMF_ADD | NXFMF_MODIFY;
5314 } else if (rule->modify_seqno > seqno) {
5315 update = NXFMF_MODIFY;
5320 if (!(m->flags & update)) {
5324 update = NXFMF_INITIAL;
5327 if (!rule->monitor_flags) {
5328 rule_collection_add(rules, rule);
5330 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5334 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5336 struct rule_collection *rules)
5337 OVS_REQUIRES(ofproto_mutex)
5339 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5340 const struct oftable *table;
5341 struct cls_rule target;
5343 cls_rule_init_from_minimatch(&target, &m->match, 0);
5344 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5347 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5348 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5351 cls_rule_destroy(&target);
5355 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5356 struct rule_collection *rules)
5357 OVS_REQUIRES(ofproto_mutex)
5359 if (m->flags & NXFMF_INITIAL) {
5360 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5365 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5366 uint64_t seqno, struct rule_collection *rules)
5367 OVS_REQUIRES(ofproto_mutex)
5369 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5373 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5374 OVS_REQUIRES(ofproto_mutex)
5376 struct ofmonitor *m;
5379 m = ofmonitor_lookup(ofconn, id);
5381 ofmonitor_destroy(m);
5384 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5391 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5392 OVS_EXCLUDED(ofproto_mutex)
5394 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5395 struct ofmonitor **monitors;
5396 size_t n_monitors, allocated_monitors;
5397 struct rule_collection rules;
5398 struct ovs_list replies;
5403 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5405 n_monitors = allocated_monitors = 0;
5407 ovs_mutex_lock(&ofproto_mutex);
5409 struct ofputil_flow_monitor_request request;
5410 struct ofmonitor *m;
5413 retval = ofputil_decode_flow_monitor_request(&request, &b);
5414 if (retval == EOF) {
5416 } else if (retval) {
5421 if (request.table_id != 0xff
5422 && request.table_id >= ofproto->n_tables) {
5423 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5427 error = ofmonitor_create(&request, ofconn, &m);
5432 if (n_monitors >= allocated_monitors) {
5433 monitors = x2nrealloc(monitors, &allocated_monitors,
5436 monitors[n_monitors++] = m;
5439 rule_collection_init(&rules);
5440 for (i = 0; i < n_monitors; i++) {
5441 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5444 ofpmp_init(&replies, oh);
5445 ofmonitor_compose_refresh_updates(&rules, &replies);
5446 ovs_mutex_unlock(&ofproto_mutex);
5448 rule_collection_destroy(&rules);
5450 ofconn_send_replies(ofconn, &replies);
5456 for (i = 0; i < n_monitors; i++) {
5457 ofmonitor_destroy(monitors[i]);
5460 ovs_mutex_unlock(&ofproto_mutex);
5466 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5467 OVS_EXCLUDED(ofproto_mutex)
5472 id = ofputil_decode_flow_monitor_cancel(oh);
5474 ovs_mutex_lock(&ofproto_mutex);
5475 error = flow_monitor_delete(ofconn, id);
5476 ovs_mutex_unlock(&ofproto_mutex);
5481 /* Meters implementation.
5483 * Meter table entry, indexed by the OpenFlow meter_id.
5484 * 'created' is used to compute the duration for meter stats.
5485 * 'list rules' is needed so that we can delete the dependent rules when the
5486 * meter table entry is deleted.
5487 * 'provider_meter_id' is for the provider's private use.
5490 long long int created; /* Time created. */
5491 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5492 ofproto_meter_id provider_meter_id;
5493 uint16_t flags; /* Meter flags. */
5494 uint16_t n_bands; /* Number of meter bands. */
5495 struct ofputil_meter_band *bands;
5499 * This is used in instruction validation at flow set-up time,
5500 * as flows may not use non-existing meters.
5501 * Return value of UINT32_MAX signifies an invalid meter.
5504 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5506 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5507 const struct meter *meter = ofproto->meters[of_meter_id];
5509 return meter->provider_meter_id.uint32;
5515 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5518 meter_insert_rule(struct rule *rule)
5520 const struct rule_actions *a = rule_get_actions(rule);
5521 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5522 struct meter *meter = rule->ofproto->meters[meter_id];
5524 list_insert(&meter->rules, &rule->meter_list_node);
5528 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5532 meter->flags = config->flags;
5533 meter->n_bands = config->n_bands;
5534 meter->bands = xmemdup(config->bands,
5535 config->n_bands * sizeof *meter->bands);
5538 static struct meter *
5539 meter_create(const struct ofputil_meter_config *config,
5540 ofproto_meter_id provider_meter_id)
5542 struct meter *meter;
5544 meter = xzalloc(sizeof *meter);
5545 meter->provider_meter_id = provider_meter_id;
5546 meter->created = time_msec();
5547 list_init(&meter->rules);
5549 meter_update(meter, config);
5555 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5556 OVS_REQUIRES(ofproto_mutex)
5559 for (mid = first; mid <= last; ++mid) {
5560 struct meter *meter = ofproto->meters[mid];
5562 ofproto->meters[mid] = NULL;
5563 ofproto->ofproto_class->meter_del(ofproto,
5564 meter->provider_meter_id);
5572 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5574 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5575 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5579 return OFPERR_OFPMMFC_METER_EXISTS;
5582 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5585 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5586 *meterp = meter_create(&mm->meter, provider_meter_id);
5592 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5594 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5596 uint32_t provider_meter_id;
5599 return OFPERR_OFPMMFC_UNKNOWN_METER;
5602 provider_meter_id = meter->provider_meter_id.uint32;
5603 error = ofproto->ofproto_class->meter_set(ofproto,
5604 &meter->provider_meter_id,
5606 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5608 meter_update(meter, &mm->meter);
5614 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5615 OVS_EXCLUDED(ofproto_mutex)
5617 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5618 uint32_t meter_id = mm->meter.meter_id;
5619 struct rule_collection rules;
5620 enum ofperr error = 0;
5621 uint32_t first, last;
5623 if (meter_id == OFPM13_ALL) {
5625 last = ofproto->meter_features.max_meters;
5627 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5630 first = last = meter_id;
5633 /* First delete the rules that use this meter. If any of those rules are
5634 * currently being modified, postpone the whole operation until later. */
5635 rule_collection_init(&rules);
5636 ovs_mutex_lock(&ofproto_mutex);
5637 for (meter_id = first; meter_id <= last; ++meter_id) {
5638 struct meter *meter = ofproto->meters[meter_id];
5639 if (meter && !list_is_empty(&meter->rules)) {
5642 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5643 rule_collection_add(&rules, rule);
5647 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5649 /* Delete the meters. */
5650 meter_delete(ofproto, first, last);
5652 ovs_mutex_unlock(&ofproto_mutex);
5653 rule_collection_destroy(&rules);
5659 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5661 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5662 struct ofputil_meter_mod mm;
5663 uint64_t bands_stub[256 / 8];
5664 struct ofpbuf bands;
5668 error = reject_slave_controller(ofconn);
5673 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5675 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5677 goto exit_free_bands;
5680 meter_id = mm.meter.meter_id;
5682 if (mm.command != OFPMC13_DELETE) {
5683 /* Fails also when meters are not implemented by the provider. */
5684 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5685 error = OFPERR_OFPMMFC_INVALID_METER;
5686 goto exit_free_bands;
5687 } else if (meter_id > ofproto->meter_features.max_meters) {
5688 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5689 goto exit_free_bands;
5691 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5692 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5693 goto exit_free_bands;
5697 switch (mm.command) {
5699 error = handle_add_meter(ofproto, &mm);
5702 case OFPMC13_MODIFY:
5703 error = handle_modify_meter(ofproto, &mm);
5706 case OFPMC13_DELETE:
5707 error = handle_delete_meter(ofconn, &mm);
5711 error = OFPERR_OFPMMFC_BAD_COMMAND;
5716 ofpbuf_uninit(&bands);
5721 handle_meter_features_request(struct ofconn *ofconn,
5722 const struct ofp_header *request)
5724 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5725 struct ofputil_meter_features features;
5728 if (ofproto->ofproto_class->meter_get_features) {
5729 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5731 memset(&features, 0, sizeof features);
5733 b = ofputil_encode_meter_features_reply(&features, request);
5735 ofconn_send_reply(ofconn, b);
5740 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5743 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5744 struct ovs_list replies;
5745 uint64_t bands_stub[256 / 8];
5746 struct ofpbuf bands;
5747 uint32_t meter_id, first, last;
5749 ofputil_decode_meter_request(request, &meter_id);
5751 if (meter_id == OFPM13_ALL) {
5753 last = ofproto->meter_features.max_meters;
5755 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5756 !ofproto->meters[meter_id]) {
5757 return OFPERR_OFPMMFC_UNKNOWN_METER;
5759 first = last = meter_id;
5762 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5763 ofpmp_init(&replies, request);
5765 for (meter_id = first; meter_id <= last; ++meter_id) {
5766 struct meter *meter = ofproto->meters[meter_id];
5768 continue; /* Skip non-existing meters. */
5770 if (type == OFPTYPE_METER_STATS_REQUEST) {
5771 struct ofputil_meter_stats stats;
5773 stats.meter_id = meter_id;
5775 /* Provider sets the packet and byte counts, we do the rest. */
5776 stats.flow_count = list_size(&meter->rules);
5777 calc_duration(meter->created, time_msec(),
5778 &stats.duration_sec, &stats.duration_nsec);
5779 stats.n_bands = meter->n_bands;
5780 ofpbuf_clear(&bands);
5782 = ofpbuf_put_uninit(&bands,
5783 meter->n_bands * sizeof *stats.bands);
5785 if (!ofproto->ofproto_class->meter_get(ofproto,
5786 meter->provider_meter_id,
5788 ofputil_append_meter_stats(&replies, &stats);
5790 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5791 struct ofputil_meter_config config;
5793 config.meter_id = meter_id;
5794 config.flags = meter->flags;
5795 config.n_bands = meter->n_bands;
5796 config.bands = meter->bands;
5797 ofputil_append_meter_config(&replies, &config);
5801 ofconn_send_replies(ofconn, &replies);
5802 ofpbuf_uninit(&bands);
5807 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5808 struct ofgroup **group)
5809 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5811 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5812 hash_int(group_id, 0), &ofproto->groups) {
5813 if ((*group)->group_id == group_id) {
5821 /* If the group exists, this function increments the groups's reference count.
5823 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5824 * a reference to the group. */
5826 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5827 struct ofgroup **group)
5831 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5832 found = ofproto_group_lookup__(ofproto, group_id, group);
5834 ofproto_group_ref(*group);
5836 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5841 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5842 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5844 struct ofgroup *grp;
5846 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5847 hash_int(group_id, 0), &ofproto->groups) {
5848 if (grp->group_id == group_id) {
5856 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5857 OVS_EXCLUDED(ofproto->groups_rwlock)
5861 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5862 exists = ofproto_group_exists__(ofproto, group_id);
5863 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5869 group_get_ref_count(struct ofgroup *group)
5870 OVS_EXCLUDED(ofproto_mutex)
5872 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5873 struct rule_criteria criteria;
5874 struct rule_collection rules;
5879 match_init_catchall(&match);
5880 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5881 OFPP_ANY, group->group_id);
5882 ovs_mutex_lock(&ofproto_mutex);
5883 error = collect_rules_loose(ofproto, &criteria, &rules);
5884 ovs_mutex_unlock(&ofproto_mutex);
5885 rule_criteria_destroy(&criteria);
5887 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5889 rule_collection_destroy(&rules);
5894 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
5896 struct ofputil_group_stats ogs;
5897 const struct ofproto *ofproto = group->ofproto;
5898 long long int now = time_msec();
5901 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5903 /* Provider sets the packet and byte counts, we do the rest. */
5904 ogs.ref_count = group_get_ref_count(group);
5905 ogs.n_buckets = group->n_buckets;
5907 error = (ofproto->ofproto_class->group_get_stats
5908 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5911 ogs.packet_count = UINT64_MAX;
5912 ogs.byte_count = UINT64_MAX;
5913 memset(ogs.bucket_stats, 0xff,
5914 ogs.n_buckets * sizeof *ogs.bucket_stats);
5917 ogs.group_id = group->group_id;
5918 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5920 ofputil_append_group_stats(replies, &ogs);
5922 free(ogs.bucket_stats);
5926 handle_group_request(struct ofconn *ofconn,
5927 const struct ofp_header *request, uint32_t group_id,
5928 void (*cb)(struct ofgroup *, struct ovs_list *replies))
5930 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5931 struct ofgroup *group;
5932 struct ovs_list replies;
5934 ofpmp_init(&replies, request);
5935 if (group_id == OFPG_ALL) {
5936 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5937 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5938 cb(group, &replies);
5940 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5942 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5943 cb(group, &replies);
5944 ofproto_group_unref(group);
5947 ofconn_send_replies(ofconn, &replies);
5951 handle_group_stats_request(struct ofconn *ofconn,
5952 const struct ofp_header *request)
5957 error = ofputil_decode_group_stats_request(request, &group_id);
5962 handle_group_request(ofconn, request, group_id, append_group_stats);
5967 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
5969 struct ofputil_group_desc gds;
5971 gds.group_id = group->group_id;
5972 gds.type = group->type;
5973 gds.props = group->props;
5975 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5979 handle_group_desc_stats_request(struct ofconn *ofconn,
5980 const struct ofp_header *request)
5982 handle_group_request(ofconn, request,
5983 ofputil_decode_group_desc_request(request),
5989 handle_group_features_stats_request(struct ofconn *ofconn,
5990 const struct ofp_header *request)
5992 struct ofproto *p = ofconn_get_ofproto(ofconn);
5995 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5997 ofconn_send_reply(ofconn, msg);
6004 handle_queue_get_config_request(struct ofconn *ofconn,
6005 const struct ofp_header *oh)
6007 struct ofproto *p = ofconn_get_ofproto(ofconn);
6008 struct netdev_queue_dump queue_dump;
6009 struct ofport *ofport;
6010 unsigned int queue_id;
6011 struct ofpbuf *reply;
6012 struct smap details;
6016 error = ofputil_decode_queue_get_config_request(oh, &request);
6021 ofport = ofproto_get_port(p, request);
6023 return OFPERR_OFPQOFC_BAD_PORT;
6026 reply = ofputil_encode_queue_get_config_reply(oh);
6028 smap_init(&details);
6029 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6030 struct ofputil_queue_config queue;
6032 /* None of the existing queues have compatible properties, so we
6033 * hard-code omitting min_rate and max_rate. */
6034 queue.queue_id = queue_id;
6035 queue.min_rate = UINT16_MAX;
6036 queue.max_rate = UINT16_MAX;
6037 ofputil_append_queue_get_config_reply(reply, &queue);
6039 smap_destroy(&details);
6041 ofconn_send_reply(ofconn, reply);
6047 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6048 struct ofgroup **ofgroup)
6051 const long long int now = time_msec();
6053 if (gm->group_id > OFPG_MAX) {
6054 return OFPERR_OFPGMFC_INVALID_GROUP;
6056 if (gm->type > OFPGT11_FF) {
6057 return OFPERR_OFPGMFC_BAD_TYPE;
6060 *ofgroup = ofproto->ofproto_class->group_alloc();
6062 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6063 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6066 (*ofgroup)->ofproto = ofproto;
6067 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6068 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6069 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6070 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6071 ovs_refcount_init(&(*ofgroup)->ref_count);
6073 list_move(&(*ofgroup)->buckets, &gm->buckets);
6074 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6075 list_size(&(*ofgroup)->buckets);
6077 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6078 &gm->props, sizeof (struct ofputil_group_props));
6080 /* Construct called BEFORE any locks are held. */
6081 error = ofproto->ofproto_class->group_construct(*ofgroup);
6083 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6084 ofproto->ofproto_class->group_dealloc(*ofgroup);
6089 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6090 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6093 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6095 struct ofgroup *ofgroup;
6098 /* Allocate new group and initialize it. */
6099 error = init_group(ofproto, gm, &ofgroup);
6104 /* We wrlock as late as possible to minimize the time we jam any other
6105 * threads: No visible state changes before acquiring the lock. */
6106 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6108 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6109 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6113 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6114 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6119 /* Insert new group. */
6120 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6121 hash_int(ofgroup->group_id, 0));
6122 ofproto->n_groups[ofgroup->type]++;
6124 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6129 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6130 ofproto->ofproto_class->group_destruct(ofgroup);
6131 ofputil_bucket_list_destroy(&ofgroup->buckets);
6132 ofproto->ofproto_class->group_dealloc(ofgroup);
6137 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6138 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6139 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6140 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6143 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6144 struct ofgroup *new_ofgroup,
6145 uint32_t command_bucket_id)
6147 struct ofputil_bucket *last = NULL;
6149 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6150 /* Check here to ensure that a bucket corresponding to
6151 * command_bucket_id exists in the old bucket list.
6153 * The subsequent search of below of new_ofgroup covers
6154 * both buckets in the old bucket list and buckets added
6155 * by the insert buckets group mod message this function processes. */
6156 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6157 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6160 if (!list_is_empty(&new_ofgroup->buckets)) {
6161 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6165 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6167 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6168 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6169 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6172 /* Rearrange list according to command_bucket_id */
6173 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6174 struct ofputil_bucket *new_first;
6175 const struct ofputil_bucket *first;
6177 first = ofputil_bucket_list_front(&ofgroup->buckets);
6178 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6181 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6182 &new_ofgroup->buckets);
6183 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6184 struct ofputil_bucket *after;
6186 /* Presence of bucket is checked above so after should never be NULL */
6187 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6189 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6190 last->list_node.next);
6196 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6197 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6198 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6199 * and OFPG15_BUCKET_ALL are also honored. */
6201 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6202 struct ofgroup *new_ofgroup,
6203 uint32_t command_bucket_id)
6205 const struct ofputil_bucket *skip = NULL;
6207 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6211 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6212 if (!list_is_empty(&ofgroup->buckets)) {
6213 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6215 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6216 if (!list_is_empty(&ofgroup->buckets)) {
6217 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6220 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6222 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6226 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6231 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6232 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6235 * Note that the group is re-created and then replaces the old group in
6236 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6237 * the xlate module hold a pointer to the group. */
6239 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6241 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6244 error = init_group(ofproto, gm, &new_ofgroup);
6249 retiring = new_ofgroup;
6251 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6252 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6253 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6257 /* Ofproto's group write lock is held now. */
6258 if (ofgroup->type != gm->type
6259 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6260 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6264 /* Manipulate bucket list for bucket commands */
6265 if (gm->command == OFPGC15_INSERT_BUCKET) {
6266 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6267 gm->command_bucket_id);
6268 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6269 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6270 gm->command_bucket_id);
6276 /* The group creation time does not change during modification. */
6277 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6278 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6280 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6286 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6287 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6288 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6289 hash_int(new_ofgroup->group_id, 0));
6290 if (ofgroup->type != new_ofgroup->type) {
6291 ofproto->n_groups[ofgroup->type]--;
6292 ofproto->n_groups[new_ofgroup->type]++;
6296 ofproto_group_unref(retiring);
6297 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6302 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6303 OVS_RELEASES(ofproto->groups_rwlock)
6306 struct ofputil_flow_mod fm;
6308 /* Delete all flow entries containing this group in a group action */
6309 match_init_catchall(&match);
6310 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6311 fm.delete_reason = OFPRR_GROUP_DELETE;
6312 fm.out_group = ofgroup->group_id;
6313 handle_flow_mod__(ofproto, &fm, NULL);
6315 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6316 /* No-one can find this group any more. */
6317 ofproto->n_groups[ofgroup->type]--;
6318 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6319 ofproto_group_unref(ofgroup);
6322 /* Implements OFPGC11_DELETE. */
6324 delete_group(struct ofproto *ofproto, uint32_t group_id)
6326 struct ofgroup *ofgroup;
6328 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6329 if (group_id == OFPG_ALL) {
6331 struct hmap_node *node = hmap_first(&ofproto->groups);
6335 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6336 delete_group__(ofproto, ofgroup);
6337 /* Lock for each node separately, so that we will not jam the
6338 * other threads for too long time. */
6339 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6342 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6343 hash_int(group_id, 0), &ofproto->groups) {
6344 if (ofgroup->group_id == group_id) {
6345 delete_group__(ofproto, ofgroup);
6350 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6354 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6356 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6357 struct ofputil_group_mod gm;
6360 error = reject_slave_controller(ofconn);
6365 error = ofputil_decode_group_mod(oh, &gm);
6370 switch (gm.command) {
6372 return add_group(ofproto, &gm);
6374 case OFPGC11_MODIFY:
6375 return modify_group(ofproto, &gm);
6377 case OFPGC11_DELETE:
6378 delete_group(ofproto, gm.group_id);
6381 case OFPGC15_INSERT_BUCKET:
6382 return modify_group(ofproto, &gm);
6384 case OFPGC15_REMOVE_BUCKET:
6385 return modify_group(ofproto, &gm);
6388 if (gm.command > OFPGC11_DELETE) {
6389 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6390 ofproto->name, gm.command);
6392 return OFPERR_OFPGMFC_BAD_COMMAND;
6396 enum ofputil_table_miss
6397 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6399 enum ofputil_table_miss value;
6401 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6406 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6408 if (!check_table_id(ofproto, tm->table_id)) {
6409 return OFPERR_OFPTMFC_BAD_TABLE;
6410 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6411 if (tm->table_id == OFPTT_ALL) {
6413 for (i = 0; i < ofproto->n_tables; i++) {
6414 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6418 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6426 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6428 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6429 struct ofputil_table_mod tm;
6432 error = reject_slave_controller(ofconn);
6437 error = ofputil_decode_table_mod(oh, &tm);
6442 return table_mod(ofproto, &tm);
6446 do_bundle_flow_mod_begin(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6447 struct ofp_bundle_entry *be)
6448 OVS_REQUIRES(ofproto_mutex)
6450 switch (fm->command) {
6452 return add_flow_begin(ofproto, fm, &be->rule, &be->modify);
6455 return modify_flows_begin_loose(ofproto, fm, &be->rules);
6457 case OFPFC_MODIFY_STRICT:
6458 return modify_flow_begin_strict(ofproto, fm, &be->rules);
6461 return delete_flows_begin_loose(ofproto, fm, &be->rules);
6463 case OFPFC_DELETE_STRICT:
6464 return delete_flow_begin_strict(ofproto, fm, &be->rules);
6467 return OFPERR_OFPFMFC_BAD_COMMAND;
6471 do_bundle_flow_mod_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6472 struct ofp_bundle_entry *be)
6473 OVS_REQUIRES(ofproto_mutex)
6475 switch (fm->command) {
6477 add_flow_revert(ofproto, be->modify ? NULL : be->rule);
6481 case OFPFC_MODIFY_STRICT:
6482 modify_flows_revert(ofproto, &be->rules);
6486 case OFPFC_DELETE_STRICT:
6487 delete_flows_revert(&be->rules);
6496 do_bundle_flow_mod_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6497 const struct flow_mod_requester *req,
6498 struct ofp_bundle_entry *be)
6499 OVS_REQUIRES(ofproto_mutex)
6501 switch (fm->command) {
6503 add_flow_finish(ofproto, fm, req, be->rule, be->modify);
6507 case OFPFC_MODIFY_STRICT:
6508 modify_flows_finish(ofproto, fm, req, &be->rules);
6512 case OFPFC_DELETE_STRICT:
6513 delete_flows_finish(fm, req, &be->rules);
6521 /* Commit phases (all while locking ofproto_mutex):
6523 * 1. Gather resources - do not send any events or notifications.
6525 * add: Check conflicts, check for a displaced flow. If no displaced flow
6526 * exists, add the new flow, but mark it as "invisible".
6527 * mod: Collect affected flows, Do not modify yet.
6528 * del: Collect affected flows, Do not delete yet.
6530 * 2a. Fail if any errors are found. After this point no errors are possible.
6531 * No visible changes were made, so rollback is minimal (remove added invisible
6532 * flows, revert 'to_be_removed' status of flows).
6534 * 2b. Commit the changes
6536 * add: if have displaced flow, modify it, otherwise mark the new flow as
6538 * mod: Modify the collected flows.
6539 * del: Delete the collected flows.
6542 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6544 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6545 struct ofp_bundle *bundle;
6546 struct ofp_bundle_entry *be;
6549 bundle = ofconn_get_bundle(ofconn, id);
6552 return OFPERR_OFPBFC_BAD_ID;
6554 if (bundle->flags != flags) {
6555 error = OFPERR_OFPBFC_BAD_FLAGS;
6558 ovs_mutex_lock(&ofproto_mutex);
6559 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6560 if (be->type == OFPTYPE_PORT_MOD) {
6561 /* Not supported yet. */
6562 error = OFPERR_OFPBFC_MSG_FAILED;
6563 } else if (be->type == OFPTYPE_FLOW_MOD) {
6564 error = do_bundle_flow_mod_begin(ofproto, &be->fm, be);
6573 /* Send error referring to the original message. */
6575 ofconn_send_error(ofconn, be->ofp_msg, error);
6576 error = OFPERR_OFPBFC_MSG_FAILED;
6579 /* Revert all previous entires. */
6580 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6581 if (be->type == OFPTYPE_FLOW_MOD) {
6582 do_bundle_flow_mod_revert(ofproto, &be->fm, be);
6586 /* Finish the changes. */
6587 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6588 if (be->type == OFPTYPE_FLOW_MOD) {
6589 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6591 do_bundle_flow_mod_finish(ofproto, &be->fm, &req, be);
6595 ofmonitor_flush(ofproto->connmgr);
6596 ovs_mutex_unlock(&ofproto_mutex);
6598 run_rule_executes(ofproto);
6601 /* The bundle is discarded regardless the outcome. */
6602 ofp_bundle_remove__(ofconn, bundle, !error);
6607 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6609 struct ofputil_bundle_ctrl_msg bctrl;
6610 struct ofputil_bundle_ctrl_msg reply;
6614 error = reject_slave_controller(ofconn);
6619 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6623 /* Atomic updates not supported yet. */
6624 if (bctrl.flags & OFPBF_ATOMIC) {
6625 return OFPERR_OFPBFC_BAD_FLAGS;
6628 reply.bundle_id = bctrl.bundle_id;
6630 switch (bctrl.type) {
6631 case OFPBCT_OPEN_REQUEST:
6632 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6633 reply.type = OFPBCT_OPEN_REPLY;
6635 case OFPBCT_CLOSE_REQUEST:
6636 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6637 reply.type = OFPBCT_CLOSE_REPLY;;
6639 case OFPBCT_COMMIT_REQUEST:
6640 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6641 reply.type = OFPBCT_COMMIT_REPLY;
6643 case OFPBCT_DISCARD_REQUEST:
6644 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6645 reply.type = OFPBCT_DISCARD_REPLY;
6648 case OFPBCT_OPEN_REPLY:
6649 case OFPBCT_CLOSE_REPLY:
6650 case OFPBCT_COMMIT_REPLY:
6651 case OFPBCT_DISCARD_REPLY:
6652 return OFPERR_OFPBFC_BAD_TYPE;
6657 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6658 ofconn_send_reply(ofconn, buf);
6664 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6666 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6668 struct ofputil_bundle_add_msg badd;
6669 struct ofp_bundle_entry *bmsg;
6672 error = reject_slave_controller(ofconn);
6677 error = ofputil_decode_bundle_add(oh, &badd, &type);
6682 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
6684 if (type == OFPTYPE_PORT_MOD) {
6685 error = ofputil_decode_port_mod(badd.msg, &bmsg->pm, false);
6686 } else if (type == OFPTYPE_FLOW_MOD) {
6687 struct ofpbuf ofpacts;
6688 uint64_t ofpacts_stub[1024 / 8];
6690 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6691 error = ofputil_decode_flow_mod(&bmsg->fm, badd.msg,
6692 ofconn_get_protocol(ofconn),
6694 u16_to_ofp(ofproto->max_ports),
6696 /* Move actions to heap. */
6697 bmsg->fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6699 if (!error && bmsg->fm.ofpacts_len) {
6700 error = ofproto_check_ofpacts(ofproto, bmsg->fm.ofpacts,
6701 bmsg->fm.ofpacts_len);
6708 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
6713 ofp_bundle_entry_free(bmsg);
6720 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6721 OVS_EXCLUDED(ofproto_mutex)
6723 const struct ofp_header *oh = msg->data;
6727 error = ofptype_decode(&type, oh);
6731 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6732 && ofpmp_more(oh)) {
6733 /* We have no buffer implementation for multipart requests.
6734 * Report overflow for requests which consists of multiple
6736 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6740 /* OpenFlow requests. */
6741 case OFPTYPE_ECHO_REQUEST:
6742 return handle_echo_request(ofconn, oh);
6744 case OFPTYPE_FEATURES_REQUEST:
6745 return handle_features_request(ofconn, oh);
6747 case OFPTYPE_GET_CONFIG_REQUEST:
6748 return handle_get_config_request(ofconn, oh);
6750 case OFPTYPE_SET_CONFIG:
6751 return handle_set_config(ofconn, oh);
6753 case OFPTYPE_PACKET_OUT:
6754 return handle_packet_out(ofconn, oh);
6756 case OFPTYPE_PORT_MOD:
6757 return handle_port_mod(ofconn, oh);
6759 case OFPTYPE_FLOW_MOD:
6760 return handle_flow_mod(ofconn, oh);
6762 case OFPTYPE_GROUP_MOD:
6763 return handle_group_mod(ofconn, oh);
6765 case OFPTYPE_TABLE_MOD:
6766 return handle_table_mod(ofconn, oh);
6768 case OFPTYPE_METER_MOD:
6769 return handle_meter_mod(ofconn, oh);
6771 case OFPTYPE_BARRIER_REQUEST:
6772 return handle_barrier_request(ofconn, oh);
6774 case OFPTYPE_ROLE_REQUEST:
6775 return handle_role_request(ofconn, oh);
6777 /* OpenFlow replies. */
6778 case OFPTYPE_ECHO_REPLY:
6781 /* Nicira extension requests. */
6782 case OFPTYPE_FLOW_MOD_TABLE_ID:
6783 return handle_nxt_flow_mod_table_id(ofconn, oh);
6785 case OFPTYPE_SET_FLOW_FORMAT:
6786 return handle_nxt_set_flow_format(ofconn, oh);
6788 case OFPTYPE_SET_PACKET_IN_FORMAT:
6789 return handle_nxt_set_packet_in_format(ofconn, oh);
6791 case OFPTYPE_SET_CONTROLLER_ID:
6792 return handle_nxt_set_controller_id(ofconn, oh);
6794 case OFPTYPE_FLOW_AGE:
6795 /* Nothing to do. */
6798 case OFPTYPE_FLOW_MONITOR_CANCEL:
6799 return handle_flow_monitor_cancel(ofconn, oh);
6801 case OFPTYPE_SET_ASYNC_CONFIG:
6802 return handle_nxt_set_async_config(ofconn, oh);
6804 case OFPTYPE_GET_ASYNC_REQUEST:
6805 return handle_nxt_get_async_request(ofconn, oh);
6807 /* Statistics requests. */
6808 case OFPTYPE_DESC_STATS_REQUEST:
6809 return handle_desc_stats_request(ofconn, oh);
6811 case OFPTYPE_FLOW_STATS_REQUEST:
6812 return handle_flow_stats_request(ofconn, oh);
6814 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6815 return handle_aggregate_stats_request(ofconn, oh);
6817 case OFPTYPE_TABLE_STATS_REQUEST:
6818 return handle_table_stats_request(ofconn, oh);
6820 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6821 return handle_table_features_request(ofconn, oh);
6823 case OFPTYPE_PORT_STATS_REQUEST:
6824 return handle_port_stats_request(ofconn, oh);
6826 case OFPTYPE_QUEUE_STATS_REQUEST:
6827 return handle_queue_stats_request(ofconn, oh);
6829 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6830 return handle_port_desc_stats_request(ofconn, oh);
6832 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6833 return handle_flow_monitor_request(ofconn, oh);
6835 case OFPTYPE_METER_STATS_REQUEST:
6836 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6837 return handle_meter_request(ofconn, oh, type);
6839 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6840 return handle_meter_features_request(ofconn, oh);
6842 case OFPTYPE_GROUP_STATS_REQUEST:
6843 return handle_group_stats_request(ofconn, oh);
6845 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6846 return handle_group_desc_stats_request(ofconn, oh);
6848 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6849 return handle_group_features_stats_request(ofconn, oh);
6851 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6852 return handle_queue_get_config_request(ofconn, oh);
6854 case OFPTYPE_BUNDLE_CONTROL:
6855 return handle_bundle_control(ofconn, oh);
6857 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6858 return handle_bundle_add(ofconn, oh);
6862 case OFPTYPE_FEATURES_REPLY:
6863 case OFPTYPE_GET_CONFIG_REPLY:
6864 case OFPTYPE_PACKET_IN:
6865 case OFPTYPE_FLOW_REMOVED:
6866 case OFPTYPE_PORT_STATUS:
6867 case OFPTYPE_BARRIER_REPLY:
6868 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6869 case OFPTYPE_DESC_STATS_REPLY:
6870 case OFPTYPE_FLOW_STATS_REPLY:
6871 case OFPTYPE_QUEUE_STATS_REPLY:
6872 case OFPTYPE_PORT_STATS_REPLY:
6873 case OFPTYPE_TABLE_STATS_REPLY:
6874 case OFPTYPE_AGGREGATE_STATS_REPLY:
6875 case OFPTYPE_PORT_DESC_STATS_REPLY:
6876 case OFPTYPE_ROLE_REPLY:
6877 case OFPTYPE_FLOW_MONITOR_PAUSED:
6878 case OFPTYPE_FLOW_MONITOR_RESUMED:
6879 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6880 case OFPTYPE_GET_ASYNC_REPLY:
6881 case OFPTYPE_GROUP_STATS_REPLY:
6882 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6883 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6884 case OFPTYPE_METER_STATS_REPLY:
6885 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6886 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6887 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6888 case OFPTYPE_ROLE_STATUS:
6890 if (ofpmsg_is_stat_request(oh)) {
6891 return OFPERR_OFPBRC_BAD_STAT;
6893 return OFPERR_OFPBRC_BAD_TYPE;
6899 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6900 OVS_EXCLUDED(ofproto_mutex)
6902 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
6905 ofconn_send_error(ofconn, ofp_msg->data, error);
6907 COVERAGE_INC(ofproto_recv_openflow);
6910 /* Asynchronous operations. */
6913 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
6915 OVS_REQUIRES(ofproto_mutex)
6917 if (req && req->ofconn && buffer_id != UINT32_MAX) {
6918 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
6919 struct dp_packet *packet;
6923 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
6926 struct rule_execute *re;
6928 ofproto_rule_ref(rule);
6930 re = xmalloc(sizeof *re);
6932 re->in_port = in_port;
6933 re->packet = packet;
6935 if (!guarded_list_push_back(&ofproto->rule_executes,
6936 &re->list_node, 1024)) {
6937 ofproto_rule_unref(rule);
6938 dp_packet_delete(re->packet);
6942 ofconn_send_error(req->ofconn, req->request, error);
6948 pick_datapath_id(const struct ofproto *ofproto)
6950 const struct ofport *port;
6952 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6954 uint8_t ea[ETH_ADDR_LEN];
6957 error = netdev_get_etheraddr(port->netdev, ea);
6959 return eth_addr_to_uint64(ea);
6961 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6962 ofproto->name, netdev_get_name(port->netdev),
6963 ovs_strerror(error));
6965 return ofproto->fallback_dpid;
6969 pick_fallback_dpid(void)
6971 uint8_t ea[ETH_ADDR_LEN];
6972 eth_addr_nicira_random(ea);
6973 return eth_addr_to_uint64(ea);
6976 /* Table overflow policy. */
6978 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6979 * to NULL if the table is not configured to evict rules or if the table
6980 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6981 * or with no timeouts are not evictable.) */
6983 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6984 OVS_REQUIRES(ofproto_mutex)
6986 struct eviction_group *evg;
6989 if (!table->eviction_fields) {
6993 /* In the common case, the outer and inner loops here will each be entered
6996 * - The inner loop normally "return"s in its first iteration. If the
6997 * eviction group has any evictable rules, then it always returns in
7000 * - The outer loop only iterates more than once if the largest eviction
7001 * group has no evictable rules.
7003 * - The outer loop can exit only if table's 'max_flows' is all filled up
7004 * by unevictable rules. */
7005 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7008 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7017 /* Eviction groups. */
7019 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7020 * rules. The priority contains low-order random bits to ensure that eviction
7021 * groups with the same number of rules are prioritized randomly. */
7023 eviction_group_priority(size_t n_rules)
7025 uint16_t size = MIN(UINT16_MAX, n_rules);
7026 return (size << 16) | random_uint16();
7029 /* Updates 'evg', an eviction_group within 'table', following a change that
7030 * adds or removes rules in 'evg'. */
7032 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7033 OVS_REQUIRES(ofproto_mutex)
7035 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7036 eviction_group_priority(heap_count(&evg->rules)));
7039 /* Destroys 'evg', an eviction_group within 'table':
7041 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7042 * rules themselves, just removes them from the eviction group.)
7044 * - Removes 'evg' from 'table'.
7048 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7049 OVS_REQUIRES(ofproto_mutex)
7051 while (!heap_is_empty(&evg->rules)) {
7054 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7055 rule->eviction_group = NULL;
7057 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7058 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7059 heap_destroy(&evg->rules);
7063 /* Removes 'rule' from its eviction group, if any. */
7065 eviction_group_remove_rule(struct rule *rule)
7066 OVS_REQUIRES(ofproto_mutex)
7068 if (rule->eviction_group) {
7069 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7070 struct eviction_group *evg = rule->eviction_group;
7072 rule->eviction_group = NULL;
7073 heap_remove(&evg->rules, &rule->evg_node);
7074 if (heap_is_empty(&evg->rules)) {
7075 eviction_group_destroy(table, evg);
7077 eviction_group_resized(table, evg);
7082 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7083 * returns the hash value. */
7085 eviction_group_hash_rule(struct rule *rule)
7086 OVS_REQUIRES(ofproto_mutex)
7088 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7089 const struct mf_subfield *sf;
7093 hash = table->eviction_group_id_basis;
7094 miniflow_expand(&rule->cr.match.flow, &flow);
7095 for (sf = table->eviction_fields;
7096 sf < &table->eviction_fields[table->n_eviction_fields];
7099 if (mf_are_prereqs_ok(sf->field, &flow)) {
7100 union mf_value value;
7102 mf_get_value(sf->field, &flow, &value);
7104 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7106 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7107 unsigned int start = sf->ofs + sf->n_bits;
7108 bitwise_zero(&value, sf->field->n_bytes, start,
7109 sf->field->n_bytes * 8 - start);
7111 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7113 hash = hash_int(hash, 0);
7120 /* Returns an eviction group within 'table' with the given 'id', creating one
7122 static struct eviction_group *
7123 eviction_group_find(struct oftable *table, uint32_t id)
7124 OVS_REQUIRES(ofproto_mutex)
7126 struct eviction_group *evg;
7128 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7132 evg = xmalloc(sizeof *evg);
7133 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7134 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7135 eviction_group_priority(0));
7136 heap_init(&evg->rules);
7141 /* Returns an eviction priority for 'rule'. The return value should be
7142 * interpreted so that higher priorities make a rule more attractive candidates
7144 * Called only if have a timeout. */
7146 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7147 OVS_REQUIRES(ofproto_mutex)
7149 long long int expiration = LLONG_MAX;
7150 long long int modified;
7151 uint32_t expiration_offset;
7153 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7154 ovs_mutex_lock(&rule->mutex);
7155 modified = rule->modified;
7156 ovs_mutex_unlock(&rule->mutex);
7158 if (rule->hard_timeout) {
7159 expiration = modified + rule->hard_timeout * 1000;
7161 if (rule->idle_timeout) {
7162 uint64_t packets, bytes;
7164 long long int idle_expiration;
7166 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7167 idle_expiration = used + rule->idle_timeout * 1000;
7168 expiration = MIN(expiration, idle_expiration);
7171 if (expiration == LLONG_MAX) {
7175 /* Calculate the time of expiration as a number of (approximate) seconds
7176 * after program startup.
7178 * This should work OK for program runs that last UINT32_MAX seconds or
7179 * less. Therefore, please restart OVS at least once every 136 years. */
7180 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
7182 /* Invert the expiration offset because we're using a max-heap. */
7183 return UINT32_MAX - expiration_offset;
7186 /* Adds 'rule' to an appropriate eviction group for its oftable's
7187 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7188 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7191 * The caller must ensure that 'rule' is not already in an eviction group. */
7193 eviction_group_add_rule(struct rule *rule)
7194 OVS_REQUIRES(ofproto_mutex)
7196 struct ofproto *ofproto = rule->ofproto;
7197 struct oftable *table = &ofproto->tables[rule->table_id];
7200 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7201 * so no additional protection is needed. */
7202 has_timeout = rule->hard_timeout || rule->idle_timeout;
7204 if (table->eviction_fields && has_timeout) {
7205 struct eviction_group *evg;
7207 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7209 rule->eviction_group = evg;
7210 heap_insert(&evg->rules, &rule->evg_node,
7211 rule_eviction_priority(ofproto, rule));
7212 eviction_group_resized(table, evg);
7218 /* Initializes 'table'. */
7220 oftable_init(struct oftable *table)
7222 memset(table, 0, sizeof *table);
7223 classifier_init(&table->cls, flow_segment_u64s);
7224 table->max_flows = UINT_MAX;
7225 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7227 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7228 ARRAY_SIZE(default_prefix_fields));
7230 atomic_init(&table->n_matched, 0);
7231 atomic_init(&table->n_missed, 0);
7234 /* Destroys 'table', including its classifier and eviction groups.
7236 * The caller is responsible for freeing 'table' itself. */
7238 oftable_destroy(struct oftable *table)
7240 ovs_assert(classifier_is_empty(&table->cls));
7241 oftable_disable_eviction(table);
7242 classifier_destroy(&table->cls);
7246 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7247 * string, then 'table' will use its default name.
7249 * This only affects the name exposed for a table exposed through the OpenFlow
7250 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7252 oftable_set_name(struct oftable *table, const char *name)
7254 if (name && name[0]) {
7255 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7256 if (!table->name || strncmp(name, table->name, len)) {
7258 table->name = xmemdup0(name, len);
7266 /* oftables support a choice of two policies when adding a rule would cause the
7267 * number of flows in the table to exceed the configured maximum number: either
7268 * they can refuse to add the new flow or they can evict some existing flow.
7269 * This function configures the former policy on 'table'. */
7271 oftable_disable_eviction(struct oftable *table)
7272 OVS_REQUIRES(ofproto_mutex)
7274 if (table->eviction_fields) {
7275 struct eviction_group *evg, *next;
7277 HMAP_FOR_EACH_SAFE (evg, next, id_node,
7278 &table->eviction_groups_by_id) {
7279 eviction_group_destroy(table, evg);
7281 hmap_destroy(&table->eviction_groups_by_id);
7282 heap_destroy(&table->eviction_groups_by_size);
7284 free(table->eviction_fields);
7285 table->eviction_fields = NULL;
7286 table->n_eviction_fields = 0;
7290 /* oftables support a choice of two policies when adding a rule would cause the
7291 * number of flows in the table to exceed the configured maximum number: either
7292 * they can refuse to add the new flow or they can evict some existing flow.
7293 * This function configures the latter policy on 'table', with fairness based
7294 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7295 * 'n_fields' as 0 disables fairness.) */
7297 oftable_enable_eviction(struct oftable *table,
7298 const struct mf_subfield *fields, size_t n_fields)
7299 OVS_REQUIRES(ofproto_mutex)
7303 if (table->eviction_fields
7304 && n_fields == table->n_eviction_fields
7306 || !memcmp(fields, table->eviction_fields,
7307 n_fields * sizeof *fields))) {
7312 oftable_disable_eviction(table);
7314 table->n_eviction_fields = n_fields;
7315 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
7317 table->eviction_group_id_basis = random_uint32();
7318 hmap_init(&table->eviction_groups_by_id);
7319 heap_init(&table->eviction_groups_by_size);
7321 CLS_FOR_EACH (rule, cr, &table->cls) {
7322 eviction_group_add_rule(rule);
7326 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7327 * it to the classifier. */
7329 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7330 OVS_REQUIRES(ofproto_mutex)
7332 const struct rule_actions *actions = rule_get_actions(rule);
7334 if (rule->hard_timeout || rule->idle_timeout) {
7335 list_insert(&ofproto->expirable, &rule->expirable);
7337 cookies_insert(ofproto, rule);
7338 eviction_group_add_rule(rule);
7339 if (actions->has_meter) {
7340 meter_insert_rule(rule);
7344 /* Removes 'rule' from the ofproto data structures AFTER caller has removed
7345 * it from the classifier. */
7347 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7348 OVS_REQUIRES(ofproto_mutex)
7350 cookies_remove(ofproto, rule);
7352 eviction_group_remove_rule(rule);
7353 if (!list_is_empty(&rule->expirable)) {
7354 list_remove(&rule->expirable);
7356 if (!list_is_empty(&rule->meter_list_node)) {
7357 list_remove(&rule->meter_list_node);
7358 list_init(&rule->meter_list_node);
7363 oftable_remove_rule(struct rule *rule)
7364 OVS_REQUIRES(ofproto_mutex)
7366 struct classifier *cls = &rule->ofproto->tables[rule->table_id].cls;
7368 if (classifier_remove(cls, &rule->cr)) {
7369 ofproto_rule_remove__(rule->ofproto, rule);
7375 /* unixctl commands. */
7378 ofproto_lookup(const char *name)
7380 struct ofproto *ofproto;
7382 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7384 if (!strcmp(ofproto->name, name)) {
7392 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7393 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7395 struct ofproto *ofproto;
7399 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7400 ds_put_format(&results, "%s\n", ofproto->name);
7402 unixctl_command_reply(conn, ds_cstr(&results));
7403 ds_destroy(&results);
7407 ofproto_unixctl_init(void)
7409 static bool registered;
7415 unixctl_command_register("ofproto/list", "", 0, 0,
7416 ofproto_unixctl_list, NULL);
7419 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7421 * This is deprecated. It is only for compatibility with broken device drivers
7422 * in old versions of Linux that do not properly support VLANs when VLAN
7423 * devices are not used. When broken device drivers are no longer in
7424 * widespread use, we will delete these interfaces. */
7426 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7427 * (exactly) by an OpenFlow rule in 'ofproto'. */
7429 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7432 struct cls_rule target;
7433 const struct oftable *oftable;
7435 match_init_catchall(&match);
7436 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7437 cls_rule_init(&target, &match, 0);
7439 free(ofproto->vlan_bitmap);
7440 ofproto->vlan_bitmap = bitmap_allocate(4096);
7441 ofproto->vlans_changed = false;
7443 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7446 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7447 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7448 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7450 bitmap_set1(vlan_bitmap, vid);
7451 bitmap_set1(ofproto->vlan_bitmap, vid);
7456 cls_rule_destroy(&target);
7459 /* Returns true if new VLANs have come into use by the flow table since the
7460 * last call to ofproto_get_vlan_usage().
7462 * We don't track when old VLANs stop being used. */
7464 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7466 return ofproto->vlans_changed;
7469 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7470 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7471 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7472 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7473 * then the VLAN device is un-enslaved. */
7475 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7476 ofp_port_t realdev_ofp_port, int vid)
7478 struct ofport *ofport;
7481 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7483 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7485 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7486 ofproto->name, vlandev_ofp_port);
7490 if (!ofproto->ofproto_class->set_realdev) {
7491 if (!vlandev_ofp_port) {
7494 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7498 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7500 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7501 ofproto->name, vlandev_ofp_port,
7502 netdev_get_name(ofport->netdev), ovs_strerror(error));