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 ovs_be32 xid; /* OpenFlow xid of flow_mod request. */
256 static enum ofperr add_flow(struct ofproto *, struct ofputil_flow_mod *,
257 const struct flow_mod_requester *);
259 static enum ofperr modify_flows__(struct ofproto *, struct ofputil_flow_mod *,
260 const struct rule_collection *,
261 const struct flow_mod_requester *);
262 static void delete_flows__(const struct rule_collection *,
263 enum ofp_flow_removed_reason,
264 const struct flow_mod_requester *)
265 OVS_REQUIRES(ofproto_mutex);
267 static enum ofperr send_buffered_packet(struct ofconn *, uint32_t buffer_id,
269 OVS_REQUIRES(ofproto_mutex);
271 static bool ofproto_group_exists__(const struct ofproto *ofproto,
273 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
274 static bool ofproto_group_exists(const struct ofproto *ofproto,
276 OVS_EXCLUDED(ofproto->groups_rwlock);
277 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
278 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
279 static enum ofperr handle_flow_mod__(struct ofproto *,
280 struct ofputil_flow_mod *,
281 const struct flow_mod_requester *)
282 OVS_EXCLUDED(ofproto_mutex);
283 static void calc_duration(long long int start, long long int now,
284 uint32_t *sec, uint32_t *nsec);
287 static uint64_t pick_datapath_id(const struct ofproto *);
288 static uint64_t pick_fallback_dpid(void);
289 static void ofproto_destroy__(struct ofproto *);
290 static void update_mtu(struct ofproto *, struct ofport *);
291 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
292 static void meter_insert_rule(struct rule *);
295 static void ofproto_unixctl_init(void);
297 /* All registered ofproto classes, in probe order. */
298 static const struct ofproto_class **ofproto_classes;
299 static size_t n_ofproto_classes;
300 static size_t allocated_ofproto_classes;
302 /* Global lock that protects all flow table operations. */
303 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
305 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
306 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
308 size_t n_handlers, n_revalidators;
312 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
313 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
315 /* Initial mappings of port to OpenFlow number mappings. */
316 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
318 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
320 /* The default value of true waits for flow restore. */
321 static bool flow_restore_wait = true;
323 /* Must be called to initialize the ofproto library.
325 * The caller may pass in 'iface_hints', which contains an shash of
326 * "iface_hint" elements indexed by the interface's name. The provider
327 * may use these hints to describe the startup configuration in order to
328 * reinitialize its state. The caller owns the provided data, so a
329 * provider will make copies of anything required. An ofproto provider
330 * will remove any existing state that is not described by the hint, and
331 * may choose to remove it all. */
333 ofproto_init(const struct shash *iface_hints)
335 struct shash_node *node;
338 ofproto_class_register(&ofproto_dpif_class);
340 /* Make a local copy, since we don't own 'iface_hints' elements. */
341 SHASH_FOR_EACH(node, iface_hints) {
342 const struct iface_hint *orig_hint = node->data;
343 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
344 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
346 new_hint->br_name = xstrdup(orig_hint->br_name);
347 new_hint->br_type = xstrdup(br_type);
348 new_hint->ofp_port = orig_hint->ofp_port;
350 shash_add(&init_ofp_ports, node->name, new_hint);
353 for (i = 0; i < n_ofproto_classes; i++) {
354 ofproto_classes[i]->init(&init_ofp_ports);
358 /* 'type' should be a normalized datapath type, as returned by
359 * ofproto_normalize_type(). Returns the corresponding ofproto_class
360 * structure, or a null pointer if there is none registered for 'type'. */
361 static const struct ofproto_class *
362 ofproto_class_find__(const char *type)
366 for (i = 0; i < n_ofproto_classes; i++) {
367 const struct ofproto_class *class = ofproto_classes[i];
372 class->enumerate_types(&types);
373 found = sset_contains(&types, type);
374 sset_destroy(&types);
380 VLOG_WARN("unknown datapath type %s", type);
384 /* Registers a new ofproto class. After successful registration, new ofprotos
385 * of that type can be created using ofproto_create(). */
387 ofproto_class_register(const struct ofproto_class *new_class)
391 for (i = 0; i < n_ofproto_classes; i++) {
392 if (ofproto_classes[i] == new_class) {
397 if (n_ofproto_classes >= allocated_ofproto_classes) {
398 ofproto_classes = x2nrealloc(ofproto_classes,
399 &allocated_ofproto_classes,
400 sizeof *ofproto_classes);
402 ofproto_classes[n_ofproto_classes++] = new_class;
406 /* Unregisters a datapath provider. 'type' must have been previously
407 * registered and not currently be in use by any ofprotos. After
408 * unregistration new datapaths of that type cannot be opened using
409 * ofproto_create(). */
411 ofproto_class_unregister(const struct ofproto_class *class)
415 for (i = 0; i < n_ofproto_classes; i++) {
416 if (ofproto_classes[i] == class) {
417 for (i++; i < n_ofproto_classes; i++) {
418 ofproto_classes[i - 1] = ofproto_classes[i];
424 VLOG_WARN("attempted to unregister an ofproto class that is not "
429 /* Clears 'types' and enumerates all registered ofproto types into it. The
430 * caller must first initialize the sset. */
432 ofproto_enumerate_types(struct sset *types)
437 for (i = 0; i < n_ofproto_classes; i++) {
438 ofproto_classes[i]->enumerate_types(types);
442 /* Returns the fully spelled out name for the given ofproto 'type'.
444 * Normalized type string can be compared with strcmp(). Unnormalized type
445 * string might be the same even if they have different spellings. */
447 ofproto_normalize_type(const char *type)
449 return type && type[0] ? type : "system";
452 /* Clears 'names' and enumerates the names of all known created ofprotos with
453 * the given 'type'. The caller must first initialize the sset. Returns 0 if
454 * successful, otherwise a positive errno value.
456 * Some kinds of datapaths might not be practically enumerable. This is not
457 * considered an error. */
459 ofproto_enumerate_names(const char *type, struct sset *names)
461 const struct ofproto_class *class = ofproto_class_find__(type);
462 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
466 ofproto_create(const char *datapath_name, const char *datapath_type,
467 struct ofproto **ofprotop)
469 const struct ofproto_class *class;
470 struct ofproto *ofproto;
476 ofproto_unixctl_init();
478 datapath_type = ofproto_normalize_type(datapath_type);
479 class = ofproto_class_find__(datapath_type);
481 VLOG_WARN("could not create datapath %s of unknown type %s",
482 datapath_name, datapath_type);
486 ofproto = class->alloc();
488 VLOG_ERR("failed to allocate datapath %s of type %s",
489 datapath_name, datapath_type);
494 ovs_mutex_lock(&ofproto_mutex);
495 memset(ofproto, 0, sizeof *ofproto);
496 ofproto->ofproto_class = class;
497 ofproto->name = xstrdup(datapath_name);
498 ofproto->type = xstrdup(datapath_type);
499 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
500 hash_string(ofproto->name, 0));
501 ofproto->datapath_id = 0;
502 ofproto->forward_bpdu = false;
503 ofproto->fallback_dpid = pick_fallback_dpid();
504 ofproto->mfr_desc = NULL;
505 ofproto->hw_desc = NULL;
506 ofproto->sw_desc = NULL;
507 ofproto->serial_desc = NULL;
508 ofproto->dp_desc = NULL;
509 ofproto->frag_handling = OFPC_FRAG_NORMAL;
510 hmap_init(&ofproto->ports);
511 hmap_init(&ofproto->ofport_usage);
512 shash_init(&ofproto->port_by_name);
513 simap_init(&ofproto->ofp_requests);
514 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
515 ofproto->eviction_group_timer = LLONG_MIN;
516 ofproto->tables = NULL;
517 ofproto->n_tables = 0;
518 hindex_init(&ofproto->cookies);
519 hmap_init(&ofproto->learned_cookies);
520 list_init(&ofproto->expirable);
521 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
522 guarded_list_init(&ofproto->rule_executes);
523 ofproto->vlan_bitmap = NULL;
524 ofproto->vlans_changed = false;
525 ofproto->min_mtu = INT_MAX;
526 ovs_rwlock_init(&ofproto->groups_rwlock);
527 hmap_init(&ofproto->groups);
528 ovs_mutex_unlock(&ofproto_mutex);
529 ofproto->ogf.types = 0xf;
530 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
531 OFPGFC_SELECT_WEIGHT;
532 for (i = 0; i < 4; i++) {
533 ofproto->ogf.max_groups[i] = OFPG_MAX;
534 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
537 error = ofproto->ofproto_class->construct(ofproto);
539 VLOG_ERR("failed to open datapath %s: %s",
540 datapath_name, ovs_strerror(error));
541 connmgr_destroy(ofproto->connmgr);
542 ofproto_destroy__(ofproto);
546 /* Check that hidden tables, if any, are at the end. */
547 ovs_assert(ofproto->n_tables);
548 for (i = 0; i + 1 < ofproto->n_tables; i++) {
549 enum oftable_flags flags = ofproto->tables[i].flags;
550 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
552 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
555 ofproto->datapath_id = pick_datapath_id(ofproto);
558 /* Initialize meters table. */
559 if (ofproto->ofproto_class->meter_get_features) {
560 ofproto->ofproto_class->meter_get_features(ofproto,
561 &ofproto->meter_features);
563 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
565 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
566 * sizeof(struct meter *));
572 /* Must be called (only) by an ofproto implementation in its constructor
573 * function. See the large comment on 'construct' in struct ofproto_class for
576 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
578 struct oftable *table;
580 ovs_assert(!ofproto->n_tables);
581 ovs_assert(n_tables >= 1 && n_tables <= 255);
583 ofproto->n_tables = n_tables;
584 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
585 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
590 /* To be optionally called (only) by an ofproto implementation in its
591 * constructor function. See the large comment on 'construct' in struct
592 * ofproto_class for details.
594 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
595 * will then ensure that actions passed into the ofproto implementation will
596 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
597 * function is not called, there will be no such restriction.
599 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
600 * the 'max_ports' restriction. */
602 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
604 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
605 ofproto->max_ports = max_ports;
609 ofproto_get_datapath_id(const struct ofproto *ofproto)
611 return ofproto->datapath_id;
615 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
617 uint64_t old_dpid = p->datapath_id;
618 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
619 if (p->datapath_id != old_dpid) {
620 /* Force all active connections to reconnect, since there is no way to
621 * notify a controller that the datapath ID has changed. */
622 ofproto_reconnect_controllers(p);
627 ofproto_set_controllers(struct ofproto *p,
628 const struct ofproto_controller *controllers,
629 size_t n_controllers, uint32_t allowed_versions)
631 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
636 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
638 connmgr_set_fail_mode(p->connmgr, fail_mode);
641 /* Drops the connections between 'ofproto' and all of its controllers, forcing
642 * them to reconnect. */
644 ofproto_reconnect_controllers(struct ofproto *ofproto)
646 connmgr_reconnect(ofproto->connmgr);
649 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
650 * in-band control should guarantee access, in the same way that in-band
651 * control guarantees access to OpenFlow controllers. */
653 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
654 const struct sockaddr_in *extras, size_t n)
656 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
659 /* Sets the OpenFlow queue used by flows set up by in-band control on
660 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
661 * flows will use the default queue. */
663 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
665 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
668 /* Sets the number of flows at which eviction from the kernel flow table
671 ofproto_set_flow_limit(unsigned limit)
673 ofproto_flow_limit = limit;
676 /* Sets the maximum idle time for flows in the datapath before they are
679 ofproto_set_max_idle(unsigned max_idle)
681 ofproto_max_idle = max_idle;
684 /* If forward_bpdu is true, the NORMAL action will forward frames with
685 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
686 * the NORMAL action will drop these frames. */
688 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
690 bool old_val = ofproto->forward_bpdu;
691 ofproto->forward_bpdu = forward_bpdu;
692 if (old_val != ofproto->forward_bpdu) {
693 if (ofproto->ofproto_class->forward_bpdu_changed) {
694 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
699 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
700 * 'idle_time', in seconds, and the maximum number of MAC table entries to
703 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
706 if (ofproto->ofproto_class->set_mac_table_config) {
707 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
712 /* Multicast snooping configuration. */
714 /* Configures multicast snooping on 'ofproto' using the settings
715 * defined in 's'. If 's' is NULL, disables multicast snooping.
717 * Returns 0 if successful, otherwise a positive errno value. */
719 ofproto_set_mcast_snooping(struct ofproto *ofproto,
720 const struct ofproto_mcast_snooping_settings *s)
722 return (ofproto->ofproto_class->set_mcast_snooping
723 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
727 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
729 * Returns 0 if successful, otherwise a positive errno value.*/
731 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
732 const struct ofproto_mcast_snooping_port_settings *s)
734 return (ofproto->ofproto_class->set_mcast_snooping_port
735 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
740 ofproto_set_n_dpdk_rxqs(int n_rxqs)
742 n_dpdk_rxqs = MAX(n_rxqs, 0);
746 ofproto_set_cpu_mask(const char *cmask)
750 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
754 ofproto_set_threads(int n_handlers_, int n_revalidators_)
756 int threads = MAX(count_cpu_cores(), 2);
758 n_revalidators = MAX(n_revalidators_, 0);
759 n_handlers = MAX(n_handlers_, 0);
761 if (!n_revalidators) {
762 n_revalidators = n_handlers
763 ? MAX(threads - (int) n_handlers, 1)
768 n_handlers = MAX(threads - (int) n_revalidators, 1);
773 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
776 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
780 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
782 return connmgr_set_snoops(ofproto->connmgr, snoops);
786 ofproto_set_netflow(struct ofproto *ofproto,
787 const struct netflow_options *nf_options)
789 if (nf_options && sset_is_empty(&nf_options->collectors)) {
793 if (ofproto->ofproto_class->set_netflow) {
794 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
796 return nf_options ? EOPNOTSUPP : 0;
801 ofproto_set_sflow(struct ofproto *ofproto,
802 const struct ofproto_sflow_options *oso)
804 if (oso && sset_is_empty(&oso->targets)) {
808 if (ofproto->ofproto_class->set_sflow) {
809 return ofproto->ofproto_class->set_sflow(ofproto, oso);
811 return oso ? EOPNOTSUPP : 0;
816 ofproto_set_ipfix(struct ofproto *ofproto,
817 const struct ofproto_ipfix_bridge_exporter_options *bo,
818 const struct ofproto_ipfix_flow_exporter_options *fo,
821 if (ofproto->ofproto_class->set_ipfix) {
822 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
824 return (bo || fo) ? EOPNOTSUPP : 0;
829 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
831 flow_restore_wait = flow_restore_wait_db;
835 ofproto_get_flow_restore_wait(void)
837 return flow_restore_wait;
841 /* Spanning Tree Protocol (STP) configuration. */
843 /* Configures STP on 'ofproto' using the settings defined in 's'. If
844 * 's' is NULL, disables STP.
846 * Returns 0 if successful, otherwise a positive errno value. */
848 ofproto_set_stp(struct ofproto *ofproto,
849 const struct ofproto_stp_settings *s)
851 return (ofproto->ofproto_class->set_stp
852 ? ofproto->ofproto_class->set_stp(ofproto, s)
856 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
857 * 'enabled' member of 's' is false, then the other members are not
860 * Returns 0 if successful, otherwise a positive errno value. */
862 ofproto_get_stp_status(struct ofproto *ofproto,
863 struct ofproto_stp_status *s)
865 return (ofproto->ofproto_class->get_stp_status
866 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
870 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
871 * in 's'. The caller is responsible for assigning STP port numbers
872 * (using the 'port_num' member in the range of 1 through 255, inclusive)
873 * and ensuring there are no duplicates. If the 's' is NULL, then STP
874 * is disabled on the port.
876 * Returns 0 if successful, otherwise a positive errno value.*/
878 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
879 const struct ofproto_port_stp_settings *s)
881 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
883 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
884 ofproto->name, ofp_port);
888 return (ofproto->ofproto_class->set_stp_port
889 ? ofproto->ofproto_class->set_stp_port(ofport, s)
893 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
894 * 's'. If the 'enabled' member in 's' is false, then the other members
895 * are not meaningful.
897 * Returns 0 if successful, otherwise a positive errno value.*/
899 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
900 struct ofproto_port_stp_status *s)
902 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
904 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
905 "port %"PRIu16, ofproto->name, ofp_port);
909 return (ofproto->ofproto_class->get_stp_port_status
910 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
914 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
915 * 's'. If the 'enabled' member in 's' is false, then the other members
916 * are not meaningful.
918 * Returns 0 if successful, otherwise a positive errno value.*/
920 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
921 struct ofproto_port_stp_stats *s)
923 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
925 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
926 "port %"PRIu16, ofproto->name, ofp_port);
930 return (ofproto->ofproto_class->get_stp_port_stats
931 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
935 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
937 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
938 * 's' is NULL, disables RSTP.
940 * Returns 0 if successful, otherwise a positive errno value. */
942 ofproto_set_rstp(struct ofproto *ofproto,
943 const struct ofproto_rstp_settings *s)
945 if (!ofproto->ofproto_class->set_rstp) {
948 ofproto->ofproto_class->set_rstp(ofproto, s);
952 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
953 * 'enabled' member of 's' is false, then the other members are not
956 * Returns 0 if successful, otherwise a positive errno value. */
958 ofproto_get_rstp_status(struct ofproto *ofproto,
959 struct ofproto_rstp_status *s)
961 if (!ofproto->ofproto_class->get_rstp_status) {
964 ofproto->ofproto_class->get_rstp_status(ofproto, s);
968 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
969 * in 's'. The caller is responsible for assigning RSTP port numbers
970 * (using the 'port_num' member in the range of 1 through 255, inclusive)
971 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
972 * is disabled on the port.
974 * Returns 0 if successful, otherwise a positive errno value.*/
976 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
977 const struct ofproto_port_rstp_settings *s)
979 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
981 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
982 ofproto->name, ofp_port);
986 if (!ofproto->ofproto_class->set_rstp_port) {
989 ofproto->ofproto_class->set_rstp_port(ofport, s);
993 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
994 * 's'. If the 'enabled' member in 's' is false, then the other members
995 * are not meaningful.
997 * Returns 0 if successful, otherwise a positive errno value.*/
999 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1000 struct ofproto_port_rstp_status *s)
1002 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1004 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1005 "port %"PRIu16, ofproto->name, ofp_port);
1009 if (!ofproto->ofproto_class->get_rstp_port_status) {
1012 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1016 /* Queue DSCP configuration. */
1018 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1019 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1020 * to implement QoS. Instead, it is used to implement features which require
1021 * knowledge of what queues exist on a port, and some basic information about
1024 * Returns 0 if successful, otherwise a positive errno value. */
1026 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1027 const struct ofproto_port_queue *queues,
1030 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1033 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1034 ofproto->name, ofp_port);
1038 return (ofproto->ofproto_class->set_queues
1039 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1043 /* LLDP configuration. */
1045 ofproto_port_set_lldp(struct ofproto *ofproto,
1046 ofp_port_t ofp_port,
1047 const struct smap *cfg)
1049 struct ofport *ofport;
1052 ofport = ofproto_get_port(ofproto, ofp_port);
1054 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1055 ofproto->name, ofp_port);
1058 error = (ofproto->ofproto_class->set_lldp
1059 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1062 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1063 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1064 ovs_strerror(error));
1069 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1070 const struct aa_settings *s)
1072 if (!ofproto->ofproto_class->set_aa) {
1075 ofproto->ofproto_class->set_aa(ofproto, s);
1080 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1081 const struct aa_mapping_settings *s)
1083 if (!ofproto->ofproto_class->aa_mapping_set) {
1086 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1091 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1093 if (!ofproto->ofproto_class->aa_mapping_unset) {
1096 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1101 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1102 struct ovs_list *list)
1104 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1107 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1112 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1114 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1117 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1120 /* Connectivity Fault Management configuration. */
1122 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1124 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1126 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1127 if (ofport && ofproto->ofproto_class->set_cfm) {
1128 ofproto->ofproto_class->set_cfm(ofport, NULL);
1132 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1133 * basic configuration from the configuration members in 'cfm', and the remote
1134 * maintenance point ID from remote_mpid. Ignores the statistics members of
1137 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1139 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1140 const struct cfm_settings *s)
1142 struct ofport *ofport;
1145 ofport = ofproto_get_port(ofproto, ofp_port);
1147 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1148 ofproto->name, ofp_port);
1152 /* XXX: For configuration simplicity, we only support one remote_mpid
1153 * outside of the CFM module. It's not clear if this is the correct long
1154 * term solution or not. */
1155 error = (ofproto->ofproto_class->set_cfm
1156 ? ofproto->ofproto_class->set_cfm(ofport, s)
1159 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1160 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1161 ovs_strerror(error));
1165 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1166 * 'ofproto' does not have a port 'ofp_port'. */
1168 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1169 const struct smap *cfg)
1171 struct ofport *ofport;
1174 ofport = ofproto_get_port(ofproto, ofp_port);
1176 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1177 ofproto->name, ofp_port);
1181 error = (ofproto->ofproto_class->set_bfd
1182 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1185 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1186 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1187 ovs_strerror(error));
1191 /* Checks the status change of BFD on 'ofport'.
1193 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1195 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1197 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1198 return (ofport && ofproto->ofproto_class->bfd_status_changed
1199 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1203 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1204 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1205 * is not an OpenFlow port in 'ofproto'.
1207 * The caller must provide and own '*status'. */
1209 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1210 struct smap *status)
1212 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1213 return (ofport && ofproto->ofproto_class->get_bfd_status
1214 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1218 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1219 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1220 * 0 if LACP partner information is not current (generally indicating a
1221 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1223 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1225 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1226 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1227 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1232 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1234 struct ofproto *ofproto = port->ofproto;
1237 if (ofproto->ofproto_class->port_get_lacp_stats) {
1238 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1248 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1249 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1250 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1251 * configuration plus, if there is more than one slave, a bonding
1254 * If 'aux' is already registered then this function updates its configuration
1255 * to 's'. Otherwise, this function registers a new bundle.
1257 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1260 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1261 const struct ofproto_bundle_settings *s)
1263 return (ofproto->ofproto_class->bundle_set
1264 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1268 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1269 * If no such bundle has been registered, this has no effect. */
1271 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1273 return ofproto_bundle_register(ofproto, aux, NULL);
1277 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1278 * If 'aux' is already registered then this function updates its configuration
1279 * to 's'. Otherwise, this function registers a new mirror. */
1281 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1282 const struct ofproto_mirror_settings *s)
1284 return (ofproto->ofproto_class->mirror_set
1285 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1289 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1290 * If no mirror has been registered, this has no effect. */
1292 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1294 return ofproto_mirror_register(ofproto, aux, NULL);
1297 /* Retrieves statistics from mirror associated with client data pointer
1298 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1299 * 'bytes', respectively. If a particular counters is not supported,
1300 * the appropriate argument is set to UINT64_MAX.
1303 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1304 uint64_t *packets, uint64_t *bytes)
1306 if (!ofproto->ofproto_class->mirror_get_stats) {
1307 *packets = *bytes = UINT64_MAX;
1311 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1315 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1316 * which all packets are flooded, instead of using MAC learning. If
1317 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1319 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1322 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1324 return (ofproto->ofproto_class->set_flood_vlans
1325 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1329 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1330 * output for a mirror. */
1332 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1334 return (ofproto->ofproto_class->is_mirror_output_bundle
1335 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1339 /* Configuration of OpenFlow tables. */
1341 /* Returns the number of OpenFlow tables in 'ofproto'. */
1343 ofproto_get_n_tables(const struct ofproto *ofproto)
1345 return ofproto->n_tables;
1348 /* Returns the number of Controller visible OpenFlow tables
1349 * in 'ofproto'. This number will exclude Hidden tables.
1350 * This funtion's return value should be less or equal to that of
1351 * ofproto_get_n_tables() . */
1353 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1355 uint8_t n = ofproto->n_tables;
1357 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1358 * if present, are always at the end.) */
1359 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1366 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1367 * settings from 's'. 'table_id' must be in the range 0 through the number of
1368 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1370 * For read-only tables, only the name may be configured. */
1372 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1373 const struct ofproto_table_settings *s)
1375 struct oftable *table;
1377 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1378 table = &ofproto->tables[table_id];
1380 oftable_set_name(table, s->name);
1382 if (table->flags & OFTABLE_READONLY) {
1387 oftable_enable_eviction(table, s->groups, s->n_groups);
1389 oftable_disable_eviction(table);
1392 table->max_flows = s->max_flows;
1394 if (classifier_set_prefix_fields(&table->cls,
1395 s->prefix_fields, s->n_prefix_fields)) {
1396 /* XXX: Trigger revalidation. */
1399 ovs_mutex_lock(&ofproto_mutex);
1400 evict_rules_from_table(table, 0);
1401 ovs_mutex_unlock(&ofproto_mutex);
1405 ofproto_has_snoops(const struct ofproto *ofproto)
1407 return connmgr_has_snoops(ofproto->connmgr);
1411 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1413 connmgr_get_snoops(ofproto->connmgr, snoops);
1416 /* Deletes 'rule' from 'ofproto'.
1418 * Within an ofproto implementation, this function allows an ofproto
1419 * implementation to destroy any rules that remain when its ->destruct()
1420 * function is called. This function is not suitable for use elsewhere in an
1421 * ofproto implementation.
1423 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1424 * Cycle" in ofproto-provider.h. */
1426 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1427 OVS_EXCLUDED(ofproto_mutex)
1429 /* This skips the ofmonitor and flow-removed notifications because the
1430 * switch is being deleted and any OpenFlow channels have been or soon will
1432 ovs_mutex_lock(&ofproto_mutex);
1433 oftable_remove_rule(rule);
1434 ofproto->ofproto_class->rule_delete(rule);
1435 ovs_mutex_unlock(&ofproto_mutex);
1439 ofproto_flush__(struct ofproto *ofproto)
1440 OVS_EXCLUDED(ofproto_mutex)
1442 struct oftable *table;
1444 /* This will flush all datapath flows. */
1445 if (ofproto->ofproto_class->flush) {
1446 ofproto->ofproto_class->flush(ofproto);
1449 /* XXX: There is a small race window here, where new datapath flows can be
1450 * created by upcall handlers based on the existing flow table. We can not
1451 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1452 * as then we could deadlock on syncing with the handler threads waiting on
1453 * the same mutex. */
1455 ovs_mutex_lock(&ofproto_mutex);
1456 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1457 struct rule_collection rules;
1460 if (table->flags & OFTABLE_HIDDEN) {
1464 rule_collection_init(&rules);
1466 CLS_FOR_EACH (rule, cr, &table->cls) {
1467 rule_collection_add(&rules, rule);
1469 delete_flows__(&rules, OFPRR_DELETE, NULL);
1470 rule_collection_destroy(&rules);
1472 /* XXX: Concurrent handler threads may insert new learned flows based on
1473 * learn actions of the now deleted flows right after we release
1474 * 'ofproto_mutex'. */
1475 ovs_mutex_unlock(&ofproto_mutex);
1478 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1481 ofproto_destroy__(struct ofproto *ofproto)
1482 OVS_EXCLUDED(ofproto_mutex)
1484 struct oftable *table;
1486 destroy_rule_executes(ofproto);
1487 delete_group(ofproto, OFPG_ALL);
1489 guarded_list_destroy(&ofproto->rule_executes);
1490 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1491 hmap_destroy(&ofproto->groups);
1493 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1494 free(ofproto->name);
1495 free(ofproto->type);
1496 free(ofproto->mfr_desc);
1497 free(ofproto->hw_desc);
1498 free(ofproto->sw_desc);
1499 free(ofproto->serial_desc);
1500 free(ofproto->dp_desc);
1501 hmap_destroy(&ofproto->ports);
1502 hmap_destroy(&ofproto->ofport_usage);
1503 shash_destroy(&ofproto->port_by_name);
1504 simap_destroy(&ofproto->ofp_requests);
1506 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1507 oftable_destroy(table);
1509 free(ofproto->tables);
1511 ovs_assert(hindex_is_empty(&ofproto->cookies));
1512 hindex_destroy(&ofproto->cookies);
1514 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1515 hmap_destroy(&ofproto->learned_cookies);
1517 free(ofproto->vlan_bitmap);
1519 ofproto->ofproto_class->dealloc(ofproto);
1523 ofproto_destroy(struct ofproto *p)
1524 OVS_EXCLUDED(ofproto_mutex)
1526 struct ofport *ofport, *next_ofport;
1527 struct ofport_usage *usage, *next_usage;
1534 meter_delete(p, 1, p->meter_features.max_meters);
1535 p->meter_features.max_meters = 0;
1541 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1542 ofport_destroy(ofport);
1545 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1546 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1550 p->ofproto_class->destruct(p);
1552 /* We should not postpone this because it involves deleting a listening
1553 * socket which we may want to reopen soon. 'connmgr' should not be used
1554 * by other threads */
1555 connmgr_destroy(p->connmgr);
1557 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1558 ovsrcu_postpone(ofproto_destroy__, p);
1561 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1562 * kernel datapath, for example, this destroys the datapath in the kernel, and
1563 * with the netdev-based datapath, it tears down the data structures that
1564 * represent the datapath.
1566 * The datapath should not be currently open as an ofproto. */
1568 ofproto_delete(const char *name, const char *type)
1570 const struct ofproto_class *class = ofproto_class_find__(type);
1571 return (!class ? EAFNOSUPPORT
1572 : !class->del ? EACCES
1573 : class->del(type, name));
1577 process_port_change(struct ofproto *ofproto, int error, char *devname)
1579 if (error == ENOBUFS) {
1580 reinit_ports(ofproto);
1581 } else if (!error) {
1582 update_port(ofproto, devname);
1588 ofproto_type_run(const char *datapath_type)
1590 const struct ofproto_class *class;
1593 datapath_type = ofproto_normalize_type(datapath_type);
1594 class = ofproto_class_find__(datapath_type);
1596 error = class->type_run ? class->type_run(datapath_type) : 0;
1597 if (error && error != EAGAIN) {
1598 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1599 datapath_type, ovs_strerror(error));
1605 ofproto_type_wait(const char *datapath_type)
1607 const struct ofproto_class *class;
1609 datapath_type = ofproto_normalize_type(datapath_type);
1610 class = ofproto_class_find__(datapath_type);
1612 if (class->type_wait) {
1613 class->type_wait(datapath_type);
1618 ofproto_run(struct ofproto *p)
1623 error = p->ofproto_class->run(p);
1624 if (error && error != EAGAIN) {
1625 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1628 run_rule_executes(p);
1630 /* Restore the eviction group heap invariant occasionally. */
1631 if (p->eviction_group_timer < time_msec()) {
1634 p->eviction_group_timer = time_msec() + 1000;
1636 for (i = 0; i < p->n_tables; i++) {
1637 struct oftable *table = &p->tables[i];
1638 struct eviction_group *evg;
1641 if (!table->eviction_fields) {
1645 if (classifier_count(&table->cls) > 100000) {
1646 static struct vlog_rate_limit count_rl =
1647 VLOG_RATE_LIMIT_INIT(1, 1);
1648 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1649 " number of rules: %d", i,
1650 classifier_count(&table->cls));
1653 ovs_mutex_lock(&ofproto_mutex);
1654 CLS_FOR_EACH (rule, cr, &table->cls) {
1655 if (rule->idle_timeout || rule->hard_timeout) {
1656 if (!rule->eviction_group) {
1657 eviction_group_add_rule(rule);
1659 heap_raw_change(&rule->evg_node,
1660 rule_eviction_priority(p, rule));
1665 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1666 heap_rebuild(&evg->rules);
1668 ovs_mutex_unlock(&ofproto_mutex);
1672 if (p->ofproto_class->port_poll) {
1675 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1676 process_port_change(p, error, devname);
1680 new_seq = seq_read(connectivity_seq_get());
1681 if (new_seq != p->change_seq) {
1682 struct sset devnames;
1683 const char *devname;
1684 struct ofport *ofport;
1686 /* Update OpenFlow port status for any port whose netdev has changed.
1688 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1689 * destroyed, so it's not safe to update ports directly from the
1690 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1691 * need this two-phase approach. */
1692 sset_init(&devnames);
1693 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1694 uint64_t port_change_seq;
1696 port_change_seq = netdev_get_change_seq(ofport->netdev);
1697 if (ofport->change_seq != port_change_seq) {
1698 ofport->change_seq = port_change_seq;
1699 sset_add(&devnames, netdev_get_name(ofport->netdev));
1702 SSET_FOR_EACH (devname, &devnames) {
1703 update_port(p, devname);
1705 sset_destroy(&devnames);
1707 p->change_seq = new_seq;
1710 connmgr_run(p->connmgr, handle_openflow);
1716 ofproto_wait(struct ofproto *p)
1718 p->ofproto_class->wait(p);
1719 if (p->ofproto_class->port_poll_wait) {
1720 p->ofproto_class->port_poll_wait(p);
1722 seq_wait(connectivity_seq_get(), p->change_seq);
1723 connmgr_wait(p->connmgr);
1727 ofproto_is_alive(const struct ofproto *p)
1729 return connmgr_has_controllers(p->connmgr);
1732 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1733 * memory_report(). */
1735 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1737 const struct oftable *table;
1738 unsigned int n_rules;
1740 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1743 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1744 n_rules += classifier_count(&table->cls);
1746 simap_increase(usage, "rules", n_rules);
1748 if (ofproto->ofproto_class->get_memory_usage) {
1749 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1752 connmgr_get_memory_usage(ofproto->connmgr, usage);
1756 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1758 const struct ofproto_class *class;
1760 datapath_type = ofproto_normalize_type(datapath_type);
1761 class = ofproto_class_find__(datapath_type);
1763 if (class && class->type_get_memory_usage) {
1764 class->type_get_memory_usage(datapath_type, usage);
1769 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1772 connmgr_get_controller_info(ofproto->connmgr, info);
1776 ofproto_free_ofproto_controller_info(struct shash *info)
1778 connmgr_free_controller_info(info);
1781 /* Makes a deep copy of 'old' into 'port'. */
1783 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1785 port->name = xstrdup(old->name);
1786 port->type = xstrdup(old->type);
1787 port->ofp_port = old->ofp_port;
1790 /* Frees memory allocated to members of 'ofproto_port'.
1792 * Do not call this function on an ofproto_port obtained from
1793 * ofproto_port_dump_next(): that function retains ownership of the data in the
1796 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1798 free(ofproto_port->name);
1799 free(ofproto_port->type);
1802 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1804 * This function provides no status indication. An error status for the entire
1805 * dump operation is provided when it is completed by calling
1806 * ofproto_port_dump_done().
1809 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1810 const struct ofproto *ofproto)
1812 dump->ofproto = ofproto;
1813 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1817 /* Attempts to retrieve another port from 'dump', which must have been created
1818 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1819 * 'port' and returns true. On failure, returns false.
1821 * Failure might indicate an actual error or merely that the last port has been
1822 * dumped. An error status for the entire dump operation is provided when it
1823 * is completed by calling ofproto_port_dump_done().
1825 * The ofproto owns the data stored in 'port'. It will remain valid until at
1826 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1827 * ofproto_port_dump_done(). */
1829 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1830 struct ofproto_port *port)
1832 const struct ofproto *ofproto = dump->ofproto;
1838 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1841 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1847 /* Completes port table dump operation 'dump', which must have been created
1848 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1849 * error-free, otherwise a positive errno value describing the problem. */
1851 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1853 const struct ofproto *ofproto = dump->ofproto;
1855 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1858 return dump->error == EOF ? 0 : dump->error;
1861 /* Returns the type to pass to netdev_open() when a datapath of type
1862 * 'datapath_type' has a port of type 'port_type', for a few special
1863 * cases when a netdev type differs from a port type. For example, when
1864 * using the userspace datapath, a port of type "internal" needs to be
1867 * Returns either 'type' itself or a string literal, which must not be
1870 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1872 const struct ofproto_class *class;
1874 datapath_type = ofproto_normalize_type(datapath_type);
1875 class = ofproto_class_find__(datapath_type);
1880 return (class->port_open_type
1881 ? class->port_open_type(datapath_type, port_type)
1885 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1886 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1887 * the port's OpenFlow port number.
1889 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1890 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1891 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1892 * 'ofp_portp' is non-null). */
1894 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1895 ofp_port_t *ofp_portp)
1897 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1900 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1902 const char *netdev_name = netdev_get_name(netdev);
1904 simap_put(&ofproto->ofp_requests, netdev_name,
1905 ofp_to_u16(ofp_port));
1906 update_port(ofproto, netdev_name);
1909 *ofp_portp = OFPP_NONE;
1911 struct ofproto_port ofproto_port;
1913 error = ofproto_port_query_by_name(ofproto,
1914 netdev_get_name(netdev),
1917 *ofp_portp = ofproto_port.ofp_port;
1918 ofproto_port_destroy(&ofproto_port);
1925 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1926 * initializes '*port' appropriately; on failure, returns a positive errno
1929 * The caller owns the data in 'ofproto_port' and must free it with
1930 * ofproto_port_destroy() when it is no longer needed. */
1932 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1933 struct ofproto_port *port)
1937 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1939 memset(port, 0, sizeof *port);
1944 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1945 * Returns 0 if successful, otherwise a positive errno. */
1947 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1949 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1950 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1951 struct simap_node *ofp_request_node;
1954 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1955 if (ofp_request_node) {
1956 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1959 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1960 if (!error && ofport) {
1961 /* 'name' is the netdev's name and update_port() is going to close the
1962 * netdev. Just in case update_port() refers to 'name' after it
1963 * destroys 'ofport', make a copy of it around the update_port()
1965 char *devname = xstrdup(name);
1966 update_port(ofproto, devname);
1973 flow_mod_init(struct ofputil_flow_mod *fm,
1974 const struct match *match, int priority,
1975 const struct ofpact *ofpacts, size_t ofpacts_len,
1976 enum ofp_flow_mod_command command)
1978 memset(fm, 0, sizeof *fm);
1980 fm->priority = priority;
1983 fm->modify_cookie = false;
1985 fm->command = command;
1986 fm->idle_timeout = 0;
1987 fm->hard_timeout = 0;
1989 fm->buffer_id = UINT32_MAX;
1990 fm->out_port = OFPP_ANY;
1991 fm->out_group = OFPG_ANY;
1993 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1994 fm->ofpacts_len = ofpacts_len;
1995 fm->delete_reason = OFPRR_DELETE;
1999 simple_flow_mod(struct ofproto *ofproto,
2000 const struct match *match, int priority,
2001 const struct ofpact *ofpacts, size_t ofpacts_len,
2002 enum ofp_flow_mod_command command)
2004 struct ofputil_flow_mod fm;
2006 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2008 return handle_flow_mod__(ofproto, &fm, NULL);
2011 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2012 * performs the 'n_actions' actions in 'actions'. The new flow will not
2015 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2016 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2017 * controllers; otherwise, it will be hidden.
2019 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2021 * This is a helper function for in-band control and fail-open. */
2023 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2025 const struct ofpact *ofpacts, size_t ofpacts_len)
2026 OVS_EXCLUDED(ofproto_mutex)
2028 const struct rule *rule;
2031 /* First do a cheap check whether the rule we're looking for already exists
2032 * with the actions that we want. If it does, then we're done. */
2033 rule = rule_from_cls_rule(classifier_find_match_exactly(
2034 &ofproto->tables[0].cls, match, priority));
2036 const struct rule_actions *actions = rule_get_actions(rule);
2037 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2038 ofpacts, ofpacts_len);
2043 /* If there's no such rule or the rule doesn't have the actions we want,
2044 * fall back to a executing a full flow mod. We can't optimize this at
2045 * all because we didn't take enough locks above to ensure that the flow
2046 * table didn't already change beneath us. */
2048 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2049 OFPFC_MODIFY_STRICT);
2053 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
2054 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
2055 * operation cannot be initiated now but may be retried later.
2057 * This is a helper function for in-band control and fail-open and the "learn"
2060 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2061 OVS_EXCLUDED(ofproto_mutex)
2063 /* Optimize for the most common case of a repeated learn action.
2064 * If an identical flow already exists we only need to update its
2065 * 'modified' time. */
2066 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2067 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2068 struct oftable *table = &ofproto->tables[fm->table_id];
2072 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
2076 /* Reading many of the rule fields and writing on 'modified'
2077 * requires the rule->mutex. Also, rule->actions may change
2078 * if rule->mutex is not held. */
2079 const struct rule_actions *actions;
2081 ovs_mutex_lock(&rule->mutex);
2082 actions = rule_get_actions(rule);
2083 if (rule->idle_timeout == fm->idle_timeout
2084 && rule->hard_timeout == fm->hard_timeout
2085 && rule->importance == fm->importance
2086 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2087 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2088 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2089 actions->ofpacts, actions->ofpacts_len)) {
2090 /* Rule already exists and need not change, only update the
2091 modified timestamp. */
2092 rule->modified = time_msec();
2095 ovs_mutex_unlock(&rule->mutex);
2103 return handle_flow_mod__(ofproto, fm, NULL);
2106 /* Searches for a rule with matching criteria exactly equal to 'target' in
2107 * ofproto's table 0 and, if it finds one, deletes it.
2109 * This is a helper function for in-band control and fail-open. */
2111 ofproto_delete_flow(struct ofproto *ofproto,
2112 const struct match *target, int priority)
2113 OVS_EXCLUDED(ofproto_mutex)
2115 struct classifier *cls = &ofproto->tables[0].cls;
2118 /* First do a cheap check whether the rule we're looking for has already
2119 * been deleted. If so, then we're done. */
2120 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2126 /* Execute a flow mod. We can't optimize this at all because we didn't
2127 * take enough locks above to ensure that the flow table didn't already
2128 * change beneath us. */
2129 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2132 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2133 * the flows required by in-band control and fail-open. */
2135 ofproto_flush_flows(struct ofproto *ofproto)
2137 COVERAGE_INC(ofproto_flush);
2138 ofproto_flush__(ofproto);
2139 connmgr_flushed(ofproto->connmgr);
2143 reinit_ports(struct ofproto *p)
2145 struct ofproto_port_dump dump;
2146 struct sset devnames;
2147 struct ofport *ofport;
2148 struct ofproto_port ofproto_port;
2149 const char *devname;
2151 COVERAGE_INC(ofproto_reinit_ports);
2153 sset_init(&devnames);
2154 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2155 sset_add(&devnames, netdev_get_name(ofport->netdev));
2157 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2158 sset_add(&devnames, ofproto_port.name);
2161 SSET_FOR_EACH (devname, &devnames) {
2162 update_port(p, devname);
2164 sset_destroy(&devnames);
2168 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2172 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2173 port_idx = port_idx ? port_idx : UINT16_MAX;
2175 if (port_idx >= ofproto->max_ports
2176 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2177 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2178 long long int last_used_at, lru = LLONG_MAX;
2180 /* Search for a free OpenFlow port number. We try not to
2181 * immediately reuse them to prevent problems due to old
2184 * We limit the automatically assigned port numbers to the lower half
2185 * of the port range, to reserve the upper half for assignment by
2188 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2189 ofproto->alloc_port_no = 1;
2191 last_used_at = ofport_get_usage(ofproto,
2192 u16_to_ofp(ofproto->alloc_port_no));
2193 if (!last_used_at) {
2194 port_idx = ofproto->alloc_port_no;
2196 } else if ( last_used_at < time_msec() - 60*60*1000) {
2197 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2198 * more than an hour ago, consider it usable. */
2199 ofport_remove_usage(ofproto,
2200 u16_to_ofp(ofproto->alloc_port_no));
2201 port_idx = ofproto->alloc_port_no;
2203 } else if (last_used_at < lru) {
2205 lru_ofport = ofproto->alloc_port_no;
2208 if (ofproto->alloc_port_no == end_port_no) {
2210 port_idx = lru_ofport;
2217 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2218 return u16_to_ofp(port_idx);
2222 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2224 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2225 ofport_set_usage(ofproto, ofp_port, time_msec());
2229 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2230 * pointer if the netdev cannot be opened. On success, also fills in
2232 static struct netdev *
2233 ofport_open(struct ofproto *ofproto,
2234 struct ofproto_port *ofproto_port,
2235 struct ofputil_phy_port *pp)
2237 enum netdev_flags flags;
2238 struct netdev *netdev;
2241 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2243 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2244 "cannot be opened (%s)",
2246 ofproto_port->name, ofproto_port->ofp_port,
2247 ofproto_port->name, ovs_strerror(error));
2251 if (ofproto_port->ofp_port == OFPP_NONE) {
2252 if (!strcmp(ofproto->name, ofproto_port->name)) {
2253 ofproto_port->ofp_port = OFPP_LOCAL;
2255 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2256 ofproto_port->name);
2259 pp->port_no = ofproto_port->ofp_port;
2260 netdev_get_etheraddr(netdev, pp->hw_addr);
2261 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2262 netdev_get_flags(netdev, &flags);
2263 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2264 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2265 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2266 &pp->supported, &pp->peer);
2267 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2268 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2273 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2274 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2277 ofport_equal(const struct ofputil_phy_port *a,
2278 const struct ofputil_phy_port *b)
2280 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2281 && a->state == b->state
2282 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2283 && a->curr == b->curr
2284 && a->advertised == b->advertised
2285 && a->supported == b->supported
2286 && a->peer == b->peer
2287 && a->curr_speed == b->curr_speed
2288 && a->max_speed == b->max_speed);
2291 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2292 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2293 * one with the same name or port number). */
2295 ofport_install(struct ofproto *p,
2296 struct netdev *netdev, const struct ofputil_phy_port *pp)
2298 const char *netdev_name = netdev_get_name(netdev);
2299 struct ofport *ofport;
2302 /* Create ofport. */
2303 ofport = p->ofproto_class->port_alloc();
2308 ofport->ofproto = p;
2309 ofport->netdev = netdev;
2310 ofport->change_seq = netdev_get_change_seq(netdev);
2312 ofport->ofp_port = pp->port_no;
2313 ofport->created = time_msec();
2315 /* Add port to 'p'. */
2316 hmap_insert(&p->ports, &ofport->hmap_node,
2317 hash_ofp_port(ofport->ofp_port));
2318 shash_add(&p->port_by_name, netdev_name, ofport);
2320 update_mtu(p, ofport);
2322 /* Let the ofproto_class initialize its private data. */
2323 error = p->ofproto_class->port_construct(ofport);
2327 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2331 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2332 p->name, netdev_name, ovs_strerror(error));
2334 ofport_destroy__(ofport);
2336 netdev_close(netdev);
2340 /* Removes 'ofport' from 'p' and destroys it. */
2342 ofport_remove(struct ofport *ofport)
2344 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2346 ofport_destroy(ofport);
2349 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2352 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2354 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2356 ofport_remove(port);
2360 /* Updates 'port' with new 'pp' description.
2362 * Does not handle a name or port number change. The caller must implement
2363 * such a change as a delete followed by an add. */
2365 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2367 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2368 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2369 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2370 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2371 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2372 port->pp.curr = pp->curr;
2373 port->pp.advertised = pp->advertised;
2374 port->pp.supported = pp->supported;
2375 port->pp.peer = pp->peer;
2376 port->pp.curr_speed = pp->curr_speed;
2377 port->pp.max_speed = pp->max_speed;
2379 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2380 &port->pp, OFPPR_MODIFY);
2383 /* Update OpenFlow 'state' in 'port' and notify controller. */
2385 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2387 if (port->pp.state != state) {
2388 port->pp.state = state;
2389 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2390 &port->pp, OFPPR_MODIFY);
2395 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2397 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2399 if (port->ofproto->ofproto_class->set_realdev) {
2400 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2402 if (port->ofproto->ofproto_class->set_stp_port) {
2403 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2405 if (port->ofproto->ofproto_class->set_rstp_port) {
2406 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2408 if (port->ofproto->ofproto_class->set_cfm) {
2409 port->ofproto->ofproto_class->set_cfm(port, NULL);
2411 if (port->ofproto->ofproto_class->bundle_remove) {
2412 port->ofproto->ofproto_class->bundle_remove(port);
2418 ofport_destroy__(struct ofport *port)
2420 struct ofproto *ofproto = port->ofproto;
2421 const char *name = netdev_get_name(port->netdev);
2423 hmap_remove(&ofproto->ports, &port->hmap_node);
2424 shash_delete(&ofproto->port_by_name,
2425 shash_find(&ofproto->port_by_name, name));
2427 netdev_close(port->netdev);
2428 ofproto->ofproto_class->port_dealloc(port);
2432 ofport_destroy(struct ofport *port)
2435 dealloc_ofp_port(port->ofproto, port->ofp_port);
2436 port->ofproto->ofproto_class->port_destruct(port);
2437 ofport_destroy__(port);
2442 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2444 struct ofport *port;
2446 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2448 if (port->ofp_port == ofp_port) {
2455 static long long int
2456 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2458 struct ofport_usage *usage;
2460 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2461 &ofproto->ofport_usage) {
2462 if (usage->ofp_port == ofp_port) {
2463 return usage->last_used;
2470 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2471 long long int last_used)
2473 struct ofport_usage *usage;
2474 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2475 &ofproto->ofport_usage) {
2476 if (usage->ofp_port == ofp_port) {
2477 usage->last_used = last_used;
2481 ovs_assert(last_used == LLONG_MAX);
2483 usage = xmalloc(sizeof *usage);
2484 usage->ofp_port = ofp_port;
2485 usage->last_used = last_used;
2486 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2487 hash_ofp_port(ofp_port));
2491 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2493 struct ofport_usage *usage;
2494 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2495 &ofproto->ofport_usage) {
2496 if (usage->ofp_port == ofp_port) {
2497 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2505 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2507 struct ofproto *ofproto = port->ofproto;
2510 if (ofproto->ofproto_class->port_get_stats) {
2511 error = ofproto->ofproto_class->port_get_stats(port, stats);
2520 update_port(struct ofproto *ofproto, const char *name)
2522 struct ofproto_port ofproto_port;
2523 struct ofputil_phy_port pp;
2524 struct netdev *netdev;
2525 struct ofport *port;
2527 COVERAGE_INC(ofproto_update_port);
2529 /* Fetch 'name''s location and properties from the datapath. */
2530 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2531 ? ofport_open(ofproto, &ofproto_port, &pp)
2535 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2536 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2537 struct netdev *old_netdev = port->netdev;
2539 /* 'name' hasn't changed location. Any properties changed? */
2540 if (!ofport_equal(&port->pp, &pp)) {
2541 ofport_modified(port, &pp);
2544 update_mtu(ofproto, port);
2546 /* Install the newly opened netdev in case it has changed.
2547 * Don't close the old netdev yet in case port_modified has to
2548 * remove a retained reference to it.*/
2549 port->netdev = netdev;
2550 port->change_seq = netdev_get_change_seq(netdev);
2552 if (port->ofproto->ofproto_class->port_modified) {
2553 port->ofproto->ofproto_class->port_modified(port);
2556 netdev_close(old_netdev);
2558 /* If 'port' is nonnull then its name differs from 'name' and thus
2559 * we should delete it. If we think there's a port named 'name'
2560 * then its port number must be wrong now so delete it too. */
2562 ofport_remove(port);
2564 ofport_remove_with_name(ofproto, name);
2565 ofport_install(ofproto, netdev, &pp);
2568 /* Any port named 'name' is gone now. */
2569 ofport_remove_with_name(ofproto, name);
2571 ofproto_port_destroy(&ofproto_port);
2575 init_ports(struct ofproto *p)
2577 struct ofproto_port_dump dump;
2578 struct ofproto_port ofproto_port;
2579 struct shash_node *node, *next;
2581 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2582 const char *name = ofproto_port.name;
2584 if (shash_find(&p->port_by_name, name)) {
2585 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2588 struct ofputil_phy_port pp;
2589 struct netdev *netdev;
2591 /* Check if an OpenFlow port number had been requested. */
2592 node = shash_find(&init_ofp_ports, name);
2594 const struct iface_hint *iface_hint = node->data;
2595 simap_put(&p->ofp_requests, name,
2596 ofp_to_u16(iface_hint->ofp_port));
2599 netdev = ofport_open(p, &ofproto_port, &pp);
2601 ofport_install(p, netdev, &pp);
2602 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2603 p->alloc_port_no = MAX(p->alloc_port_no,
2604 ofp_to_u16(ofproto_port.ofp_port));
2610 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2611 struct iface_hint *iface_hint = node->data;
2613 if (!strcmp(iface_hint->br_name, p->name)) {
2614 free(iface_hint->br_name);
2615 free(iface_hint->br_type);
2617 shash_delete(&init_ofp_ports, node);
2624 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2625 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2627 find_min_mtu(struct ofproto *p)
2629 struct ofport *ofport;
2632 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2633 struct netdev *netdev = ofport->netdev;
2636 /* Skip any internal ports, since that's what we're trying to
2638 if (!strcmp(netdev_get_type(netdev), "internal")) {
2642 if (netdev_get_mtu(netdev, &dev_mtu)) {
2645 if (!mtu || dev_mtu < mtu) {
2650 return mtu ? mtu: ETH_PAYLOAD_MAX;
2653 /* Update MTU of all datapath devices on 'p' to the minimum of the
2654 * non-datapath ports in event of 'port' added or changed. */
2656 update_mtu(struct ofproto *p, struct ofport *port)
2658 struct ofport *ofport;
2659 struct netdev *netdev = port->netdev;
2660 int dev_mtu, old_min;
2662 if (netdev_get_mtu(netdev, &dev_mtu)) {
2666 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2667 if (dev_mtu > p->min_mtu) {
2668 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2669 dev_mtu = p->min_mtu;
2672 port->mtu = dev_mtu;
2676 /* For non-internal port find new min mtu. */
2677 old_min = p->min_mtu;
2678 port->mtu = dev_mtu;
2679 p->min_mtu = find_min_mtu(p);
2680 if (p->min_mtu == old_min) {
2684 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2685 struct netdev *netdev = ofport->netdev;
2687 if (!strcmp(netdev_get_type(netdev), "internal")) {
2688 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2689 ofport->mtu = p->min_mtu;
2696 ofproto_rule_destroy__(struct rule *rule)
2697 OVS_NO_THREAD_SAFETY_ANALYSIS
2699 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2700 rule_actions_destroy(rule_get_actions(rule));
2701 ovs_mutex_destroy(&rule->mutex);
2702 rule->ofproto->ofproto_class->rule_dealloc(rule);
2705 /* Create a new rule based on attributes in 'fm', match in 'cr', and
2706 * 'table_id'. Note that the rule is NOT inserted into a any data structures
2707 * yet. Takes ownership of 'cr'. */
2709 ofproto_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
2710 struct cls_rule *cr, uint8_t table_id,
2711 struct rule **rulep)
2712 OVS_REQUIRES(ofproto_mutex)
2717 /* Allocate new rule. */
2718 rule = ofproto->ofproto_class->rule_alloc();
2720 cls_rule_destroy(cr);
2721 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
2725 /* Initialize base state. */
2726 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
2727 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
2728 ovs_refcount_init(&rule->ref_count);
2729 rule->flow_cookie = fm->new_cookie;
2730 rule->created = rule->modified = time_msec();
2732 ovs_mutex_init(&rule->mutex);
2733 ovs_mutex_lock(&rule->mutex);
2734 rule->idle_timeout = fm->idle_timeout;
2735 rule->hard_timeout = fm->hard_timeout;
2736 rule->importance = fm->importance;
2737 ovs_mutex_unlock(&rule->mutex);
2739 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
2740 rule->flags = fm->flags & OFPUTIL_FF_STATE;
2741 ovsrcu_set_hidden(&rule->actions,
2742 rule_actions_create(fm->ofpacts, fm->ofpacts_len));
2743 list_init(&rule->meter_list_node);
2744 rule->eviction_group = NULL;
2745 list_init(&rule->expirable);
2746 rule->monitor_flags = 0;
2747 rule->add_seqno = 0;
2748 rule->modify_seqno = 0;
2750 /* Construct rule, initializing derived state. */
2751 error = ofproto->ofproto_class->rule_construct(rule);
2753 ofproto_rule_destroy__(rule);
2762 rule_destroy_cb(struct rule *rule)
2764 rule->ofproto->ofproto_class->rule_destruct(rule);
2765 ofproto_rule_destroy__(rule);
2769 ofproto_rule_ref(struct rule *rule)
2772 ovs_refcount_ref(&rule->ref_count);
2777 ofproto_rule_try_ref(struct rule *rule)
2780 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2785 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2786 * ref_count reaches 0.
2788 * Use of RCU allows short term use (between RCU quiescent periods) without
2789 * keeping a reference. A reference must be taken if the rule needs to
2790 * stay around accross the RCU quiescent periods. */
2792 ofproto_rule_unref(struct rule *rule)
2794 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2795 ovsrcu_postpone(rule_destroy_cb, rule);
2800 ofproto_group_ref(struct ofgroup *group)
2803 ovs_refcount_ref(&group->ref_count);
2808 ofproto_group_unref(struct ofgroup *group)
2810 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2811 group->ofproto->ofproto_class->group_destruct(group);
2812 ofputil_bucket_list_destroy(&group->buckets);
2813 group->ofproto->ofproto_class->group_dealloc(group);
2817 static uint32_t get_provider_meter_id(const struct ofproto *,
2818 uint32_t of_meter_id);
2820 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2821 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2822 const struct rule_actions *
2823 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2825 struct rule_actions *actions;
2827 actions = xmalloc(sizeof *actions + ofpacts_len);
2828 actions->ofpacts_len = ofpacts_len;
2829 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2830 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2832 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2838 /* Free the actions after the RCU quiescent period is reached. */
2840 rule_actions_destroy(const struct rule_actions *actions)
2843 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2847 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2848 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2850 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2851 OVS_REQUIRES(ofproto_mutex)
2853 if (port == OFPP_ANY) {
2856 const struct rule_actions *actions = rule_get_actions(rule);
2857 return ofpacts_output_to_port(actions->ofpacts,
2858 actions->ofpacts_len, port);
2862 /* Returns true if 'rule' has group and equals group_id. */
2864 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2865 OVS_REQUIRES(ofproto_mutex)
2867 if (group_id == OFPG_ANY) {
2870 const struct rule_actions *actions = rule_get_actions(rule);
2871 return ofpacts_output_to_group(actions->ofpacts,
2872 actions->ofpacts_len, group_id);
2877 rule_execute_destroy(struct rule_execute *e)
2879 ofproto_rule_unref(e->rule);
2880 list_remove(&e->list_node);
2884 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2885 * by passing them to the ofproto provider. */
2887 run_rule_executes(struct ofproto *ofproto)
2888 OVS_EXCLUDED(ofproto_mutex)
2890 struct rule_execute *e, *next;
2891 struct ovs_list executes;
2893 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2894 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2897 flow_extract(e->packet, &flow);
2898 flow.in_port.ofp_port = e->in_port;
2899 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2901 rule_execute_destroy(e);
2905 /* Destroys and discards all "rule_execute" operations queued up in
2906 * ofproto->rule_executes. */
2908 destroy_rule_executes(struct ofproto *ofproto)
2910 struct rule_execute *e, *next;
2911 struct ovs_list executes;
2913 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2914 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2915 dp_packet_delete(e->packet);
2916 rule_execute_destroy(e);
2921 rule_is_readonly(const struct rule *rule)
2923 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2924 return (table->flags & OFTABLE_READONLY) != 0;
2928 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2930 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2931 return hash_3words(cookie, cookie >> 32, table_id);
2935 learned_cookies_update_one__(struct ofproto *ofproto,
2936 const struct ofpact_learn *learn,
2937 int delta, struct ovs_list *dead_cookies)
2938 OVS_REQUIRES(ofproto_mutex)
2940 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
2941 struct learned_cookie *c;
2943 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
2944 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
2946 ovs_assert(c->n >= 0);
2949 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
2950 list_push_back(dead_cookies, &c->u.list_node);
2957 ovs_assert(delta > 0);
2958 c = xmalloc(sizeof *c);
2959 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
2960 c->cookie = learn->cookie;
2961 c->table_id = learn->table_id;
2965 static const struct ofpact_learn *
2966 next_learn_with_delete(const struct rule_actions *actions,
2967 const struct ofpact_learn *start)
2969 const struct ofpact *pos;
2971 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
2972 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
2973 pos = ofpact_next(pos)) {
2974 if (pos->type == OFPACT_LEARN) {
2975 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
2976 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
2986 learned_cookies_update__(struct ofproto *ofproto,
2987 const struct rule_actions *actions,
2988 int delta, struct ovs_list *dead_cookies)
2989 OVS_REQUIRES(ofproto_mutex)
2991 if (actions->has_learn_with_delete) {
2992 const struct ofpact_learn *learn;
2994 for (learn = next_learn_with_delete(actions, NULL); learn;
2995 learn = next_learn_with_delete(actions, learn)) {
2996 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3002 learned_cookies_inc(struct ofproto *ofproto,
3003 const struct rule_actions *actions)
3004 OVS_REQUIRES(ofproto_mutex)
3006 learned_cookies_update__(ofproto, actions, +1, NULL);
3010 learned_cookies_dec(struct ofproto *ofproto,
3011 const struct rule_actions *actions,
3012 struct ovs_list *dead_cookies)
3013 OVS_REQUIRES(ofproto_mutex)
3015 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3019 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3020 OVS_REQUIRES(ofproto_mutex)
3022 struct learned_cookie *c;
3024 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3025 struct rule_criteria criteria;
3026 struct rule_collection rules;
3029 match_init_catchall(&match);
3030 rule_criteria_init(&criteria, c->table_id, &match, 0,
3031 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3032 rule_criteria_require_rw(&criteria, false);
3033 collect_rules_loose(ofproto, &criteria, &rules);
3034 delete_flows__(&rules, OFPRR_DELETE, NULL);
3035 rule_criteria_destroy(&criteria);
3036 rule_collection_destroy(&rules);
3043 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3045 ofconn_send_reply(ofconn, make_echo_reply(oh));
3050 query_tables(struct ofproto *ofproto,
3051 struct ofputil_table_features **featuresp,
3052 struct ofputil_table_stats **statsp)
3054 struct mf_bitmap rw_fields = oxm_writable_fields();
3055 struct mf_bitmap match = oxm_matchable_fields();
3056 struct mf_bitmap mask = oxm_maskable_fields();
3058 struct ofputil_table_features *features;
3059 struct ofputil_table_stats *stats;
3062 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3063 for (i = 0; i < ofproto->n_tables; i++) {
3064 struct ofputil_table_features *f = &features[i];
3067 sprintf(f->name, "table%d", i);
3068 f->metadata_match = OVS_BE64_MAX;
3069 f->metadata_write = OVS_BE64_MAX;
3070 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3071 f->max_entries = 1000000;
3073 bool more_tables = false;
3074 for (int j = i + 1; j < ofproto->n_tables; j++) {
3075 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3076 bitmap_set1(f->nonmiss.next, j);
3080 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3082 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3084 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3085 f->nonmiss.write.set_fields = rw_fields;
3086 f->nonmiss.apply = f->nonmiss.write;
3087 f->miss = f->nonmiss;
3091 f->wildcard = match;
3095 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3096 for (i = 0; i < ofproto->n_tables; i++) {
3097 struct ofputil_table_stats *s = &stats[i];
3098 struct classifier *cls = &ofproto->tables[i].cls;
3101 s->active_count = classifier_count(cls);
3103 s->active_count -= connmgr_count_hidden_rules(
3111 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3113 for (i = 0; i < ofproto->n_tables; i++) {
3114 const struct oftable *table = &ofproto->tables[i];
3115 struct ofputil_table_features *f = &features[i];
3118 ovs_strzcpy(f->name, table->name, sizeof f->name);
3121 if (table->max_flows < f->max_entries) {
3122 f->max_entries = table->max_flows;
3128 query_switch_features(struct ofproto *ofproto,
3129 bool *arp_match_ip, uint64_t *ofpacts)
3131 struct ofputil_table_features *features, *f;
3133 *arp_match_ip = false;
3136 query_tables(ofproto, &features, NULL);
3137 for (f = features; f < &features[ofproto->n_tables]; f++) {
3138 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3139 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3140 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3141 *arp_match_ip = true;
3147 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3151 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3153 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3154 struct ofputil_switch_features features;
3155 struct ofport *port;
3159 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3161 features.datapath_id = ofproto->datapath_id;
3162 features.n_buffers = pktbuf_capacity();
3163 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3164 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3165 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3166 OFPUTIL_C_GROUP_STATS);
3168 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3170 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3171 features.auxiliary_id = 0;
3172 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3174 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3175 ofputil_put_switch_features_port(&port->pp, b);
3178 ofconn_send_reply(ofconn, b);
3183 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3185 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3186 struct ofp_switch_config *osc;
3187 enum ofp_config_flags flags;
3191 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3192 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3193 flags = ofproto->frag_handling;
3194 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3195 if (oh->version < OFP13_VERSION
3196 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3197 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3199 osc->flags = htons(flags);
3200 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3201 ofconn_send_reply(ofconn, buf);
3207 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3209 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3210 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3211 uint16_t flags = ntohs(osc->flags);
3213 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3214 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3215 enum ofp_config_flags cur = ofproto->frag_handling;
3216 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3218 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3220 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3221 ofproto->frag_handling = next;
3223 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3225 ofputil_frag_handling_to_string(next));
3229 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3230 ofconn_set_invalid_ttl_to_controller(ofconn,
3231 (oh->version < OFP13_VERSION
3232 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3234 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3239 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3240 * error message code for the caller to propagate upward. Otherwise, returns
3243 * The log message mentions 'msg_type'. */
3245 reject_slave_controller(struct ofconn *ofconn)
3247 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3248 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3249 return OFPERR_OFPBRC_IS_SLAVE;
3255 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3258 * - If they use a meter, then 'ofproto' has that meter configured.
3260 * - If they use any groups, then 'ofproto' has that group configured.
3262 * Returns 0 if successful, otherwise an OpenFlow error. */
3264 ofproto_check_ofpacts(struct ofproto *ofproto,
3265 const struct ofpact ofpacts[], size_t ofpacts_len)
3267 const struct ofpact *a;
3270 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3271 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3272 return OFPERR_OFPMMFC_INVALID_METER;
3275 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3276 if (a->type == OFPACT_GROUP
3277 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3278 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3286 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3288 struct ofproto *p = ofconn_get_ofproto(ofconn);
3289 struct ofputil_packet_out po;
3290 struct dp_packet *payload;
3291 uint64_t ofpacts_stub[1024 / 8];
3292 struct ofpbuf ofpacts;
3296 COVERAGE_INC(ofproto_packet_out);
3298 error = reject_slave_controller(ofconn);
3303 /* Decode message. */
3304 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3305 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3307 goto exit_free_ofpacts;
3309 if (ofp_to_u16(po.in_port) >= p->max_ports
3310 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3311 error = OFPERR_OFPBRC_BAD_PORT;
3312 goto exit_free_ofpacts;
3316 if (po.buffer_id != UINT32_MAX) {
3317 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3318 if (error || !payload) {
3319 goto exit_free_ofpacts;
3322 /* Ensure that the L3 header is 32-bit aligned. */
3323 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3326 /* Verify actions against packet, then send packet if successful. */
3327 flow_extract(payload, &flow);
3328 flow.in_port.ofp_port = po.in_port;
3329 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3331 error = p->ofproto_class->packet_out(p, payload, &flow,
3332 po.ofpacts, po.ofpacts_len);
3334 dp_packet_delete(payload);
3337 ofpbuf_uninit(&ofpacts);
3343 update_port_config(struct ofconn *ofconn, struct ofport *port,
3344 enum ofputil_port_config config,
3345 enum ofputil_port_config mask)
3347 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3349 if (toggle & OFPUTIL_PC_PORT_DOWN
3350 && (config & OFPUTIL_PC_PORT_DOWN
3351 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3352 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3353 /* We tried to bring the port up or down, but it failed, so don't
3354 * update the "down" bit. */
3355 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3359 enum ofputil_port_config old_config = port->pp.config;
3360 port->pp.config ^= toggle;
3361 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3362 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3368 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3370 struct ofproto *p = ofconn_get_ofproto(ofconn);
3371 struct ofputil_port_mod pm;
3372 struct ofport *port;
3375 error = reject_slave_controller(ofconn);
3380 error = ofputil_decode_port_mod(oh, &pm, false);
3385 port = ofproto_get_port(p, pm.port_no);
3387 return OFPERR_OFPPMFC_BAD_PORT;
3388 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3389 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3391 update_port_config(ofconn, port, pm.config, pm.mask);
3393 netdev_set_advertisements(port->netdev, pm.advertise);
3400 handle_desc_stats_request(struct ofconn *ofconn,
3401 const struct ofp_header *request)
3403 static const char *default_mfr_desc = "Nicira, Inc.";
3404 static const char *default_hw_desc = "Open vSwitch";
3405 static const char *default_sw_desc = VERSION;
3406 static const char *default_serial_desc = "None";
3407 static const char *default_dp_desc = "None";
3409 struct ofproto *p = ofconn_get_ofproto(ofconn);
3410 struct ofp_desc_stats *ods;
3413 msg = ofpraw_alloc_stats_reply(request, 0);
3414 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3415 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3416 sizeof ods->mfr_desc);
3417 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3418 sizeof ods->hw_desc);
3419 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3420 sizeof ods->sw_desc);
3421 ovs_strlcpy(ods->serial_num,
3422 p->serial_desc ? p->serial_desc : default_serial_desc,
3423 sizeof ods->serial_num);
3424 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3425 sizeof ods->dp_desc);
3426 ofconn_send_reply(ofconn, msg);
3432 handle_table_stats_request(struct ofconn *ofconn,
3433 const struct ofp_header *request)
3435 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3436 struct ofputil_table_features *features;
3437 struct ofputil_table_stats *stats;
3438 struct ofpbuf *reply;
3441 query_tables(ofproto, &features, &stats);
3443 reply = ofputil_encode_table_stats_reply(request);
3444 for (i = 0; i < ofproto->n_tables; i++) {
3445 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3446 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3449 ofconn_send_reply(ofconn, reply);
3458 handle_table_features_request(struct ofconn *ofconn,
3459 const struct ofp_header *request)
3461 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3462 struct ofputil_table_features *features;
3463 struct ovs_list replies;
3467 ofpbuf_use_const(&msg, request, ntohs(request->length));
3468 ofpraw_pull_assert(&msg);
3469 if (msg.size || ofpmp_more(request)) {
3470 return OFPERR_OFPTFFC_EPERM;
3473 query_tables(ofproto, &features, NULL);
3475 ofpmp_init(&replies, request);
3476 for (i = 0; i < ofproto->n_tables; i++) {
3477 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3478 ofputil_append_table_features_reply(&features[i], &replies);
3481 ofconn_send_replies(ofconn, &replies);
3489 append_port_stat(struct ofport *port, struct ovs_list *replies)
3491 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3493 calc_duration(port->created, time_msec(),
3494 &ops.duration_sec, &ops.duration_nsec);
3496 /* Intentionally ignore return value, since errors will set
3497 * 'stats' to all-1s, which is correct for OpenFlow, and
3498 * netdev_get_stats() will log errors. */
3499 ofproto_port_get_stats(port, &ops.stats);
3501 ofputil_append_port_stat(replies, &ops);
3505 handle_port_request(struct ofconn *ofconn,
3506 const struct ofp_header *request, ofp_port_t port_no,
3507 void (*cb)(struct ofport *, struct ovs_list *replies))
3509 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3510 struct ofport *port;
3511 struct ovs_list replies;
3513 ofpmp_init(&replies, request);
3514 if (port_no != OFPP_ANY) {
3515 port = ofproto_get_port(ofproto, port_no);
3520 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3525 ofconn_send_replies(ofconn, &replies);
3529 handle_port_stats_request(struct ofconn *ofconn,
3530 const struct ofp_header *request)
3535 error = ofputil_decode_port_stats_request(request, &port_no);
3537 handle_port_request(ofconn, request, port_no, append_port_stat);
3543 append_port_desc(struct ofport *port, struct ovs_list *replies)
3545 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3549 handle_port_desc_stats_request(struct ofconn *ofconn,
3550 const struct ofp_header *request)
3555 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3557 handle_port_request(ofconn, request, port_no, append_port_desc);
3563 hash_cookie(ovs_be64 cookie)
3565 return hash_uint64((OVS_FORCE uint64_t)cookie);
3569 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3570 OVS_REQUIRES(ofproto_mutex)
3572 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3573 hash_cookie(rule->flow_cookie));
3577 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3578 OVS_REQUIRES(ofproto_mutex)
3580 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3584 calc_duration(long long int start, long long int now,
3585 uint32_t *sec, uint32_t *nsec)
3587 long long int msecs = now - start;
3588 *sec = msecs / 1000;
3589 *nsec = (msecs % 1000) * (1000 * 1000);
3592 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3593 * true if 'table_id' is OK, false otherwise. */
3595 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3597 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3600 static struct oftable *
3601 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3603 struct oftable *table;
3605 for (table = &ofproto->tables[table_id];
3606 table < &ofproto->tables[ofproto->n_tables];
3608 if (!(table->flags & OFTABLE_HIDDEN)) {
3616 static struct oftable *
3617 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3619 if (table_id == 0xff) {
3620 return next_visible_table(ofproto, 0);
3621 } else if (table_id < ofproto->n_tables) {
3622 return &ofproto->tables[table_id];
3628 static struct oftable *
3629 next_matching_table(const struct ofproto *ofproto,
3630 const struct oftable *table, uint8_t table_id)
3632 return (table_id == 0xff
3633 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3637 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3639 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3640 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3642 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3643 * only once, for that table. (This can be used to access tables marked
3646 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3647 * entered at all. (Perhaps you should have validated TABLE_ID with
3648 * check_table_id().)
3650 * All parameters are evaluated multiple times.
3652 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3653 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3655 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3657 /* Initializes 'criteria' in a straightforward way based on the other
3660 * By default, the criteria include flows that are read-only, on the assumption
3661 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3662 * if flows will be modified.
3664 * For "loose" matching, the 'priority' parameter is unimportant and may be
3667 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3668 const struct match *match, int priority,
3669 ovs_be64 cookie, ovs_be64 cookie_mask,
3670 ofp_port_t out_port, uint32_t out_group)
3672 criteria->table_id = table_id;
3673 cls_rule_init(&criteria->cr, match, priority);
3674 criteria->cookie = cookie;
3675 criteria->cookie_mask = cookie_mask;
3676 criteria->out_port = out_port;
3677 criteria->out_group = out_group;
3679 /* We ordinarily want to skip hidden rules, but there has to be a way for
3680 * code internal to OVS to modify and delete them, so if the criteria
3681 * specify a priority that can only be for a hidden flow, then allow hidden
3682 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3683 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3685 criteria->include_hidden = priority > UINT16_MAX;
3687 /* We assume that the criteria are being used to collect flows for reading
3688 * but not modification. Thus, we should collect read-only flows. */
3689 criteria->include_readonly = true;
3692 /* By default, criteria initialized by rule_criteria_init() will match flows
3693 * that are read-only, on the assumption that the collected flows won't be
3694 * modified. Call this function to match only flows that are be modifiable.
3696 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3697 * caller has special privileges that allow it to modify even "read-only"
3700 rule_criteria_require_rw(struct rule_criteria *criteria,
3701 bool can_write_readonly)
3703 criteria->include_readonly = can_write_readonly;
3707 rule_criteria_destroy(struct rule_criteria *criteria)
3709 cls_rule_destroy(&criteria->cr);
3713 rule_collection_init(struct rule_collection *rules)
3715 rules->rules = rules->stub;
3717 rules->capacity = ARRAY_SIZE(rules->stub);
3721 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3723 if (rules->n >= rules->capacity) {
3724 size_t old_size, new_size;
3726 old_size = rules->capacity * sizeof *rules->rules;
3727 rules->capacity *= 2;
3728 new_size = rules->capacity * sizeof *rules->rules;
3730 if (rules->rules == rules->stub) {
3731 rules->rules = xmalloc(new_size);
3732 memcpy(rules->rules, rules->stub, old_size);
3734 rules->rules = xrealloc(rules->rules, new_size);
3738 rules->rules[rules->n++] = rule;
3742 rule_collection_ref(struct rule_collection *rules)
3743 OVS_REQUIRES(ofproto_mutex)
3747 for (i = 0; i < rules->n; i++) {
3748 ofproto_rule_ref(rules->rules[i]);
3753 rule_collection_unref(struct rule_collection *rules)
3757 for (i = 0; i < rules->n; i++) {
3758 ofproto_rule_unref(rules->rules[i]);
3763 rule_collection_destroy(struct rule_collection *rules)
3765 if (rules->rules != rules->stub) {
3769 /* Make repeated destruction harmless. */
3770 rule_collection_init(rules);
3773 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3774 * function verifies most of the criteria in 'c' itself, but the caller must
3775 * check 'c->cr' itself.
3777 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3778 * 'c' only includes modifiable rules). */
3780 collect_rule(struct rule *rule, const struct rule_criteria *c,
3781 struct rule_collection *rules, size_t *n_readonly)
3782 OVS_REQUIRES(ofproto_mutex)
3784 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3785 && ofproto_rule_has_out_port(rule, c->out_port)
3786 && ofproto_rule_has_out_group(rule, c->out_group)
3787 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3788 && (!rule_is_hidden(rule) || c->include_hidden)) {
3789 /* Rule matches all the criteria... */
3790 if (!rule_is_readonly(rule) || c->include_readonly) {
3792 rule_collection_add(rules, rule);
3794 /* ...except it's read-only. */
3800 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3801 * on classifiers rules are done in the "loose" way required for OpenFlow
3802 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3805 * Returns 0 on success, otherwise an OpenFlow error code. */
3807 collect_rules_loose(struct ofproto *ofproto,
3808 const struct rule_criteria *criteria,
3809 struct rule_collection *rules)
3810 OVS_REQUIRES(ofproto_mutex)
3812 struct oftable *table;
3813 enum ofperr error = 0;
3814 size_t n_readonly = 0;
3816 rule_collection_init(rules);
3818 if (!check_table_id(ofproto, criteria->table_id)) {
3819 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3823 if (criteria->cookie_mask == OVS_BE64_MAX) {
3826 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3827 hash_cookie(criteria->cookie),
3828 &ofproto->cookies) {
3829 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3830 collect_rule(rule, criteria, rules, &n_readonly);
3834 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3837 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3838 collect_rule(rule, criteria, rules, &n_readonly);
3844 if (!error && !rules->n && n_readonly) {
3845 /* We didn't find any rules to modify. We did find some read-only
3846 * rules that we're not allowed to modify, so report that. */
3847 error = OFPERR_OFPBRC_EPERM;
3850 rule_collection_destroy(rules);
3855 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3856 * on classifiers rules are done in the "strict" way required for OpenFlow
3857 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3858 * rules on list 'rules'.
3860 * Returns 0 on success, otherwise an OpenFlow error code. */
3862 collect_rules_strict(struct ofproto *ofproto,
3863 const struct rule_criteria *criteria,
3864 struct rule_collection *rules)
3865 OVS_REQUIRES(ofproto_mutex)
3867 struct oftable *table;
3868 size_t n_readonly = 0;
3871 rule_collection_init(rules);
3873 if (!check_table_id(ofproto, criteria->table_id)) {
3874 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3878 if (criteria->cookie_mask == OVS_BE64_MAX) {
3881 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3882 hash_cookie(criteria->cookie),
3883 &ofproto->cookies) {
3884 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3885 collect_rule(rule, criteria, rules, &n_readonly);
3889 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3892 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3893 &table->cls, &criteria->cr));
3895 collect_rule(rule, criteria, rules, &n_readonly);
3901 if (!error && !rules->n && n_readonly) {
3902 /* We didn't find any rules to modify. We did find some read-only
3903 * rules that we're not allowed to modify, so report that. */
3904 error = OFPERR_OFPBRC_EPERM;
3907 rule_collection_destroy(rules);
3912 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3913 * forced into the range of a uint16_t. */
3915 age_secs(long long int age_ms)
3917 return (age_ms < 0 ? 0
3918 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3919 : (unsigned int) age_ms / 1000);
3923 handle_flow_stats_request(struct ofconn *ofconn,
3924 const struct ofp_header *request)
3925 OVS_EXCLUDED(ofproto_mutex)
3927 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3928 struct ofputil_flow_stats_request fsr;
3929 struct rule_criteria criteria;
3930 struct rule_collection rules;
3931 struct ovs_list replies;
3935 error = ofputil_decode_flow_stats_request(&fsr, request);
3940 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3941 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3943 ovs_mutex_lock(&ofproto_mutex);
3944 error = collect_rules_loose(ofproto, &criteria, &rules);
3945 rule_criteria_destroy(&criteria);
3947 rule_collection_ref(&rules);
3949 ovs_mutex_unlock(&ofproto_mutex);
3955 ofpmp_init(&replies, request);
3956 for (i = 0; i < rules.n; i++) {
3957 struct rule *rule = rules.rules[i];
3958 long long int now = time_msec();
3959 struct ofputil_flow_stats fs;
3960 long long int created, used, modified;
3961 const struct rule_actions *actions;
3962 enum ofputil_flow_mod_flags flags;
3964 ovs_mutex_lock(&rule->mutex);
3965 fs.cookie = rule->flow_cookie;
3966 fs.idle_timeout = rule->idle_timeout;
3967 fs.hard_timeout = rule->hard_timeout;
3968 fs.importance = rule->importance;
3969 created = rule->created;
3970 modified = rule->modified;
3971 actions = rule_get_actions(rule);
3972 flags = rule->flags;
3973 ovs_mutex_unlock(&rule->mutex);
3975 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3976 &fs.byte_count, &used);
3978 minimatch_expand(&rule->cr.match, &fs.match);
3979 fs.table_id = rule->table_id;
3980 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3981 fs.priority = rule->cr.priority;
3982 fs.idle_age = age_secs(now - used);
3983 fs.hard_age = age_secs(now - modified);
3984 fs.ofpacts = actions->ofpacts;
3985 fs.ofpacts_len = actions->ofpacts_len;
3988 ofputil_append_flow_stats_reply(&fs, &replies);
3991 rule_collection_unref(&rules);
3992 rule_collection_destroy(&rules);
3994 ofconn_send_replies(ofconn, &replies);
4000 flow_stats_ds(struct rule *rule, struct ds *results)
4002 uint64_t packet_count, byte_count;
4003 const struct rule_actions *actions;
4004 long long int created, used;
4006 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4007 &byte_count, &used);
4009 ovs_mutex_lock(&rule->mutex);
4010 actions = rule_get_actions(rule);
4011 created = rule->created;
4012 ovs_mutex_unlock(&rule->mutex);
4014 if (rule->table_id != 0) {
4015 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4017 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4018 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4019 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4020 cls_rule_format(&rule->cr, results);
4021 ds_put_char(results, ',');
4023 ds_put_cstr(results, "actions=");
4024 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4026 ds_put_cstr(results, "\n");
4029 /* Adds a pretty-printed description of all flows to 'results', including
4030 * hidden flows (e.g., set up by in-band control). */
4032 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4034 struct oftable *table;
4036 OFPROTO_FOR_EACH_TABLE (table, p) {
4039 CLS_FOR_EACH (rule, cr, &table->cls) {
4040 flow_stats_ds(rule, results);
4045 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4046 * '*engine_type' and '*engine_id', respectively. */
4048 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4049 uint8_t *engine_type, uint8_t *engine_id)
4051 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4054 /* Checks the status change of CFM on 'ofport'.
4056 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4058 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4060 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4061 return (ofport && ofproto->ofproto_class->cfm_status_changed
4062 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4066 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4067 * Returns 0 if the port's CFM status was successfully stored into
4068 * '*status'. Returns positive errno if the port did not have CFM
4071 * The caller must provide and own '*status', and must free 'status->rmps'.
4072 * '*status' is indeterminate if the return value is non-zero. */
4074 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4075 struct cfm_status *status)
4077 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4078 return (ofport && ofproto->ofproto_class->get_cfm_status
4079 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4084 handle_aggregate_stats_request(struct ofconn *ofconn,
4085 const struct ofp_header *oh)
4086 OVS_EXCLUDED(ofproto_mutex)
4088 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4089 struct ofputil_flow_stats_request request;
4090 struct ofputil_aggregate_stats stats;
4091 bool unknown_packets, unknown_bytes;
4092 struct rule_criteria criteria;
4093 struct rule_collection rules;
4094 struct ofpbuf *reply;
4098 error = ofputil_decode_flow_stats_request(&request, oh);
4103 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4104 request.cookie, request.cookie_mask,
4105 request.out_port, request.out_group);
4107 ovs_mutex_lock(&ofproto_mutex);
4108 error = collect_rules_loose(ofproto, &criteria, &rules);
4109 rule_criteria_destroy(&criteria);
4111 rule_collection_ref(&rules);
4113 ovs_mutex_unlock(&ofproto_mutex);
4119 memset(&stats, 0, sizeof stats);
4120 unknown_packets = unknown_bytes = false;
4121 for (i = 0; i < rules.n; i++) {
4122 struct rule *rule = rules.rules[i];
4123 uint64_t packet_count;
4124 uint64_t byte_count;
4127 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4128 &byte_count, &used);
4130 if (packet_count == UINT64_MAX) {
4131 unknown_packets = true;
4133 stats.packet_count += packet_count;
4136 if (byte_count == UINT64_MAX) {
4137 unknown_bytes = true;
4139 stats.byte_count += byte_count;
4144 if (unknown_packets) {
4145 stats.packet_count = UINT64_MAX;
4147 if (unknown_bytes) {
4148 stats.byte_count = UINT64_MAX;
4151 rule_collection_unref(&rules);
4152 rule_collection_destroy(&rules);
4154 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4155 ofconn_send_reply(ofconn, reply);
4160 struct queue_stats_cbdata {
4161 struct ofport *ofport;
4162 struct ovs_list replies;
4167 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4168 const struct netdev_queue_stats *stats)
4170 struct ofputil_queue_stats oqs;
4172 oqs.port_no = cbdata->ofport->pp.port_no;
4173 oqs.queue_id = queue_id;
4174 oqs.tx_bytes = stats->tx_bytes;
4175 oqs.tx_packets = stats->tx_packets;
4176 oqs.tx_errors = stats->tx_errors;
4177 if (stats->created != LLONG_MIN) {
4178 calc_duration(stats->created, cbdata->now,
4179 &oqs.duration_sec, &oqs.duration_nsec);
4181 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4183 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4187 handle_queue_stats_dump_cb(uint32_t queue_id,
4188 struct netdev_queue_stats *stats,
4191 struct queue_stats_cbdata *cbdata = cbdata_;
4193 put_queue_stats(cbdata, queue_id, stats);
4197 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4198 struct queue_stats_cbdata *cbdata)
4200 cbdata->ofport = port;
4201 if (queue_id == OFPQ_ALL) {
4202 netdev_dump_queue_stats(port->netdev,
4203 handle_queue_stats_dump_cb, cbdata);
4205 struct netdev_queue_stats stats;
4207 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4208 put_queue_stats(cbdata, queue_id, &stats);
4210 return OFPERR_OFPQOFC_BAD_QUEUE;
4217 handle_queue_stats_request(struct ofconn *ofconn,
4218 const struct ofp_header *rq)
4220 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4221 struct queue_stats_cbdata cbdata;
4222 struct ofport *port;
4224 struct ofputil_queue_stats_request oqsr;
4226 COVERAGE_INC(ofproto_queue_req);
4228 ofpmp_init(&cbdata.replies, rq);
4229 cbdata.now = time_msec();
4231 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4236 if (oqsr.port_no == OFPP_ANY) {
4237 error = OFPERR_OFPQOFC_BAD_QUEUE;
4238 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4239 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4244 port = ofproto_get_port(ofproto, oqsr.port_no);
4246 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4247 : OFPERR_OFPQOFC_BAD_PORT);
4250 ofconn_send_replies(ofconn, &cbdata.replies);
4252 ofpbuf_list_delete(&cbdata.replies);
4259 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4260 OVS_REQUIRES(ofproto_mutex)
4262 enum ofperr error = 0;
4263 struct rule_collection rules;
4264 unsigned int count = classifier_count(&table->cls) + extra_space;
4265 unsigned int max_flows = table->max_flows;
4267 rule_collection_init(&rules);
4269 while (count-- > max_flows) {
4272 if (!choose_rule_to_evict(table, &rule)) {
4273 error = OFPERR_OFPFMFC_TABLE_FULL;
4276 eviction_group_remove_rule(rule);
4277 rule_collection_add(&rules, rule);
4280 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4281 rule_collection_destroy(&rules);
4287 is_conjunction(const struct ofpact *ofpacts, size_t ofpacts_len)
4289 return ofpacts_len > 0 && ofpacts->type == OFPACT_CONJUNCTION;
4293 get_conjunctions(const struct ofputil_flow_mod *fm,
4294 struct cls_conjunction **conjsp, size_t *n_conjsp)
4295 OVS_REQUIRES(ofproto_mutex)
4297 struct cls_conjunction *conjs = NULL;
4300 if (is_conjunction(fm->ofpacts, fm->ofpacts_len)) {
4301 const struct ofpact *ofpact;
4305 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4309 conjs = xzalloc(n_conjs * sizeof *conjs);
4311 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4312 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4313 conjs[i].clause = oc->clause;
4314 conjs[i].n_clauses = oc->n_clauses;
4315 conjs[i].id = oc->id;
4321 *n_conjsp = n_conjs;
4325 set_conjunctions(struct rule *rule, const struct cls_conjunction *conjs,
4327 OVS_REQUIRES(ofproto_mutex)
4329 struct cls_rule *cr = CONST_CAST(struct cls_rule *, &rule->cr);
4331 cls_rule_set_conjunctions(cr, conjs, n_conjs);
4334 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4335 * in which no matching flow already exists in the flow table.
4337 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4338 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4339 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4340 * initiated now but may be retried later.
4342 * The caller retains ownership of 'fm->ofpacts'.
4344 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4347 add_flow(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4348 const struct flow_mod_requester *req)
4349 OVS_REQUIRES(ofproto_mutex)
4351 struct oftable *table;
4357 if (!check_table_id(ofproto, fm->table_id)) {
4358 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4363 if (fm->table_id == 0xff) {
4364 if (ofproto->ofproto_class->rule_choose_table) {
4365 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4371 ovs_assert(table_id < ofproto->n_tables);
4375 } else if (fm->table_id < ofproto->n_tables) {
4376 table_id = fm->table_id;
4378 return OFPERR_OFPBRC_BAD_TABLE_ID;
4381 table = &ofproto->tables[table_id];
4382 if (table->flags & OFTABLE_READONLY
4383 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4384 return OFPERR_OFPBRC_EPERM;
4387 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4388 if (!match_has_default_hidden_fields(&fm->match)) {
4389 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4390 "non-default values to hidden fields", ofproto->name);
4391 return OFPERR_OFPBRC_EPERM;
4395 cls_rule_init(&cr, &fm->match, fm->priority);
4397 /* Transform "add" into "modify" if there's an existing identical flow. */
4398 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4400 struct rule_collection rules;
4402 cls_rule_destroy(&cr);
4404 rule_collection_init(&rules);
4405 rule_collection_add(&rules, rule);
4406 fm->modify_cookie = true;
4407 error = modify_flows__(ofproto, fm, &rules, req);
4408 rule_collection_destroy(&rules);
4413 /* Check for overlap, if requested. */
4414 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4415 if (classifier_rule_overlaps(&table->cls, &cr)) {
4416 cls_rule_destroy(&cr);
4417 return OFPERR_OFPFMFC_OVERLAP;
4421 /* If necessary, evict an existing rule to clear out space. */
4422 error = evict_rules_from_table(table, 1);
4424 cls_rule_destroy(&cr);
4428 /* Allocate new rule. */
4429 error = ofproto_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4435 ofproto_rule_insert__(ofproto, rule);
4437 classifier_defer(&table->cls);
4439 struct cls_conjunction *conjs;
4441 get_conjunctions(fm, &conjs, &n_conjs);
4442 classifier_insert(&table->cls, &rule->cr, conjs, n_conjs);
4445 error = ofproto->ofproto_class->rule_insert(rule);
4447 oftable_remove_rule(rule);
4448 ofproto_rule_unref(rule);
4451 cls_rule_make_visible(&rule->cr);
4452 classifier_publish(&table->cls);
4454 learned_cookies_inc(ofproto, rule_get_actions(rule));
4456 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
4457 if (ofproto->vlan_bitmap) {
4458 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4459 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4460 bitmap_set1(ofproto->vlan_bitmap, vid);
4461 ofproto->vlans_changed = true;
4464 ofproto->vlans_changed = true;
4468 ofmonitor_report(ofproto->connmgr, rule, NXFME_ADDED, 0,
4469 req ? req->ofconn : NULL, req ? req->xid : 0, NULL);
4471 return req ? send_buffered_packet(req->ofconn, fm->buffer_id, rule) : 0;
4474 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4476 /* Modifies the rules listed in 'rules', changing their actions to match those
4479 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4482 * Returns 0 on success, otherwise an OpenFlow error code. */
4484 modify_flows__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4485 const struct rule_collection *rules,
4486 const struct flow_mod_requester *req)
4487 OVS_REQUIRES(ofproto_mutex)
4489 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4490 enum nx_flow_update_event event;
4493 if (ofproto->ofproto_class->rule_premodify_actions) {
4494 for (i = 0; i < rules->n; i++) {
4495 struct rule *rule = rules->rules[i];
4498 error = ofproto->ofproto_class->rule_premodify_actions(
4499 rule, fm->ofpacts, fm->ofpacts_len);
4506 event = fm->command == OFPFC_ADD ? NXFME_ADDED : NXFME_MODIFIED;
4507 for (i = 0; i < rules->n; i++) {
4508 struct rule *rule = rules->rules[i];
4510 /* 'fm' says that */
4511 bool change_cookie = (fm->modify_cookie
4512 && fm->new_cookie != OVS_BE64_MAX
4513 && fm->new_cookie != rule->flow_cookie);
4515 const struct rule_actions *actions = rule_get_actions(rule);
4516 bool change_actions = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4518 actions->ofpacts_len);
4520 bool reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4522 long long int now = time_msec();
4524 if (change_cookie) {
4525 cookies_remove(ofproto, rule);
4528 ovs_mutex_lock(&rule->mutex);
4529 if (fm->command == OFPFC_ADD) {
4530 rule->idle_timeout = fm->idle_timeout;
4531 rule->hard_timeout = fm->hard_timeout;
4532 rule->importance = fm->importance;
4533 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4534 rule->created = now;
4536 if (change_cookie) {
4537 rule->flow_cookie = fm->new_cookie;
4539 rule->modified = now;
4540 ovs_mutex_unlock(&rule->mutex);
4542 if (change_cookie) {
4543 cookies_insert(ofproto, rule);
4545 if (fm->command == OFPFC_ADD) {
4546 if (fm->idle_timeout || fm->hard_timeout || fm->importance) {
4547 if (!rule->eviction_group) {
4548 eviction_group_add_rule(rule);
4551 eviction_group_remove_rule(rule);
4555 if (change_actions) {
4556 /* We have to change the actions. The rule's conjunctive match set
4557 * is a function of its actions, so we need to update that too. The
4558 * conjunctive match set is used in the lookup process to figure
4559 * which (if any) collection of conjunctive sets the packet matches
4560 * with. However, a rule with conjunction actions is never to be
4561 * returned as a classifier lookup result. To make sure a rule with
4562 * conjunction actions is not returned as a lookup result, we update
4563 * them in a carefully chosen order:
4565 * - If we're adding a conjunctive match set where there wasn't one
4566 * before, we have to make the conjunctive match set available to
4567 * lookups before the rule's actions are changed, as otherwise
4568 * rule with a conjunction action could be returned as a lookup
4571 * - To clear some nonempty conjunctive set, we set the rule's
4572 * actions first, so that a lookup can't return a rule with
4573 * conjunction actions.
4575 * - Otherwise, order doesn't matter for changing one nonempty
4576 * conjunctive match set to some other nonempty set, since the
4577 * rule's actions are not seen by the classifier, and hence don't
4578 * matter either before or after the change. */
4579 struct cls_conjunction *conjs;
4581 get_conjunctions(fm, &conjs, &n_conjs);
4584 set_conjunctions(rule, conjs, n_conjs);
4586 ovsrcu_set(&rule->actions, rule_actions_create(fm->ofpacts,
4589 set_conjunctions(rule, conjs, n_conjs);
4595 if (change_actions || reset_counters) {
4596 ofproto->ofproto_class->rule_modify_actions(rule, reset_counters);
4599 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4600 ofmonitor_report(ofproto->connmgr, rule, event, 0,
4601 req ? req->ofconn : NULL, req ? req->xid : 0,
4602 change_actions ? actions : NULL);
4605 if (change_actions) {
4606 learned_cookies_inc(ofproto, rule_get_actions(rule));
4607 learned_cookies_dec(ofproto, actions, &dead_cookies);
4608 rule_actions_destroy(actions);
4611 learned_cookies_flush(ofproto, &dead_cookies);
4613 if (fm->buffer_id != UINT32_MAX && req) {
4614 return send_buffered_packet(req->ofconn, fm->buffer_id,
4622 modify_flows_add(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4623 const struct flow_mod_requester *req)
4624 OVS_REQUIRES(ofproto_mutex)
4626 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4629 return add_flow(ofproto, fm, req);
4632 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4635 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4638 modify_flows_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4639 const struct flow_mod_requester *req)
4640 OVS_REQUIRES(ofproto_mutex)
4642 struct rule_criteria criteria;
4643 struct rule_collection rules;
4646 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4647 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4648 rule_criteria_require_rw(&criteria,
4649 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4650 error = collect_rules_loose(ofproto, &criteria, &rules);
4651 rule_criteria_destroy(&criteria);
4654 error = (rules.n > 0
4655 ? modify_flows__(ofproto, fm, &rules, req)
4656 : modify_flows_add(ofproto, fm, req));
4659 rule_collection_destroy(&rules);
4664 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4665 * code on failure. */
4667 modify_flow_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4668 const struct flow_mod_requester *req)
4669 OVS_REQUIRES(ofproto_mutex)
4671 struct rule_criteria criteria;
4672 struct rule_collection rules;
4675 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4676 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4677 rule_criteria_require_rw(&criteria,
4678 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4679 error = collect_rules_strict(ofproto, &criteria, &rules);
4680 rule_criteria_destroy(&criteria);
4684 error = modify_flows_add(ofproto, fm, req);
4685 } else if (rules.n == 1) {
4686 error = modify_flows__(ofproto, fm, &rules, req);
4690 rule_collection_destroy(&rules);
4695 /* OFPFC_DELETE implementation. */
4697 /* Deletes the rules listed in 'rules'. */
4699 delete_flows__(const struct rule_collection *rules,
4700 enum ofp_flow_removed_reason reason,
4701 const struct flow_mod_requester *req)
4702 OVS_REQUIRES(ofproto_mutex)
4705 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4706 struct ofproto *ofproto = rules->rules[0]->ofproto;
4707 struct rule *rule, *next;
4710 for (i = 0, next = rules->rules[0];
4711 rule = next, next = (++i < rules->n) ? rules->rules[i] : NULL,
4713 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
4714 uint8_t next_table = next ? next->table_id : UINT8_MAX;
4716 ofproto_rule_send_removed(rule, reason);
4718 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4719 req ? req->ofconn : NULL, req ? req->xid : 0,
4722 if (next_table == rule->table_id) {
4723 classifier_defer(cls);
4725 classifier_remove(cls, &rule->cr);
4726 if (next_table != rule->table_id) {
4727 classifier_publish(cls);
4729 ofproto_rule_remove__(ofproto, rule);
4731 ofproto->ofproto_class->rule_delete(rule);
4733 learned_cookies_dec(ofproto, rule_get_actions(rule),
4736 ofproto_rule_unref(rule);
4738 learned_cookies_flush(ofproto, &dead_cookies);
4739 ofmonitor_flush(ofproto->connmgr);
4743 /* Implements OFPFC_DELETE. */
4745 delete_flows_loose(struct ofproto *ofproto,
4746 const struct ofputil_flow_mod *fm,
4747 const struct flow_mod_requester *req)
4748 OVS_REQUIRES(ofproto_mutex)
4750 struct rule_criteria criteria;
4751 struct rule_collection rules;
4754 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4755 fm->cookie, fm->cookie_mask,
4756 fm->out_port, fm->out_group);
4757 rule_criteria_require_rw(&criteria,
4758 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4759 error = collect_rules_loose(ofproto, &criteria, &rules);
4760 rule_criteria_destroy(&criteria);
4763 delete_flows__(&rules, fm->delete_reason, req);
4765 rule_collection_destroy(&rules);
4770 /* Implements OFPFC_DELETE_STRICT. */
4772 delete_flow_strict(struct ofproto *ofproto, const struct ofputil_flow_mod *fm,
4773 const struct flow_mod_requester *req)
4774 OVS_REQUIRES(ofproto_mutex)
4776 struct rule_criteria criteria;
4777 struct rule_collection rules;
4780 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4781 fm->cookie, fm->cookie_mask,
4782 fm->out_port, fm->out_group);
4783 rule_criteria_require_rw(&criteria,
4784 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4785 error = collect_rules_strict(ofproto, &criteria, &rules);
4786 rule_criteria_destroy(&criteria);
4789 delete_flows__(&rules, fm->delete_reason, req);
4791 rule_collection_destroy(&rules);
4797 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4798 OVS_REQUIRES(ofproto_mutex)
4800 struct ofputil_flow_removed fr;
4803 if (rule_is_hidden(rule) ||
4804 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4808 minimatch_expand(&rule->cr.match, &fr.match);
4809 fr.priority = rule->cr.priority;
4810 fr.cookie = rule->flow_cookie;
4812 fr.table_id = rule->table_id;
4813 calc_duration(rule->created, time_msec(),
4814 &fr.duration_sec, &fr.duration_nsec);
4815 ovs_mutex_lock(&rule->mutex);
4816 fr.idle_timeout = rule->idle_timeout;
4817 fr.hard_timeout = rule->hard_timeout;
4818 ovs_mutex_unlock(&rule->mutex);
4819 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4820 &fr.byte_count, &used);
4822 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4825 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4826 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4829 * ofproto implementation ->run() functions should use this function to expire
4830 * OpenFlow flows. */
4832 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4833 OVS_REQUIRES(ofproto_mutex)
4835 struct rule_collection rules;
4837 rules.rules = rules.stub;
4839 rules.stub[0] = rule;
4840 delete_flows__(&rules, reason, NULL);
4843 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4844 * means "infinite". */
4846 reduce_timeout(uint16_t max, uint16_t *timeout)
4848 if (max && (!*timeout || *timeout > max)) {
4853 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4854 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4855 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4857 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4859 ofproto_rule_reduce_timeouts(struct rule *rule,
4860 uint16_t idle_timeout, uint16_t hard_timeout)
4861 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4863 if (!idle_timeout && !hard_timeout) {
4867 ovs_mutex_lock(&ofproto_mutex);
4868 if (list_is_empty(&rule->expirable)) {
4869 list_insert(&rule->ofproto->expirable, &rule->expirable);
4871 ovs_mutex_unlock(&ofproto_mutex);
4873 ovs_mutex_lock(&rule->mutex);
4874 reduce_timeout(idle_timeout, &rule->idle_timeout);
4875 reduce_timeout(hard_timeout, &rule->hard_timeout);
4876 ovs_mutex_unlock(&rule->mutex);
4880 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4881 OVS_EXCLUDED(ofproto_mutex)
4883 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4884 struct ofputil_flow_mod fm;
4885 uint64_t ofpacts_stub[1024 / 8];
4886 struct ofpbuf ofpacts;
4889 error = reject_slave_controller(ofconn);
4894 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4895 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4897 u16_to_ofp(ofproto->max_ports),
4900 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4903 struct flow_mod_requester req;
4905 req.ofconn = ofconn;
4907 error = handle_flow_mod__(ofproto, &fm, &req);
4910 goto exit_free_ofpacts;
4913 ofconn_report_flow_mod(ofconn, fm.command);
4916 ofpbuf_uninit(&ofpacts);
4922 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4923 const struct flow_mod_requester *req)
4924 OVS_EXCLUDED(ofproto_mutex)
4928 ovs_mutex_lock(&ofproto_mutex);
4929 switch (fm->command) {
4931 error = add_flow(ofproto, fm, req);
4935 error = modify_flows_loose(ofproto, fm, req);
4938 case OFPFC_MODIFY_STRICT:
4939 error = modify_flow_strict(ofproto, fm, req);
4943 error = delete_flows_loose(ofproto, fm, req);
4946 case OFPFC_DELETE_STRICT:
4947 error = delete_flow_strict(ofproto, fm, req);
4951 if (fm->command > 0xff) {
4952 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4953 "flow_mod_table_id extension is not enabled",
4956 error = OFPERR_OFPFMFC_BAD_COMMAND;
4959 ofmonitor_flush(ofproto->connmgr);
4960 ovs_mutex_unlock(&ofproto_mutex);
4962 run_rule_executes(ofproto);
4967 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4969 struct ofputil_role_request request;
4970 struct ofputil_role_request reply;
4974 error = ofputil_decode_role_message(oh, &request);
4979 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4980 if (request.have_generation_id
4981 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4982 return OFPERR_OFPRRFC_STALE;
4985 ofconn_set_role(ofconn, request.role);
4988 reply.role = ofconn_get_role(ofconn);
4989 reply.have_generation_id = ofconn_get_master_election_id(
4990 ofconn, &reply.generation_id);
4991 buf = ofputil_encode_role_reply(oh, &reply);
4992 ofconn_send_reply(ofconn, buf);
4998 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4999 const struct ofp_header *oh)
5001 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5002 enum ofputil_protocol cur, next;
5004 cur = ofconn_get_protocol(ofconn);
5005 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5006 ofconn_set_protocol(ofconn, next);
5012 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5014 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5015 enum ofputil_protocol cur, next;
5016 enum ofputil_protocol next_base;
5018 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5020 return OFPERR_OFPBRC_EPERM;
5023 cur = ofconn_get_protocol(ofconn);
5024 next = ofputil_protocol_set_base(cur, next_base);
5025 ofconn_set_protocol(ofconn, next);
5031 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5032 const struct ofp_header *oh)
5034 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5037 format = ntohl(msg->format);
5038 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5039 return OFPERR_OFPBRC_EPERM;
5042 ofconn_set_packet_in_format(ofconn, format);
5047 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5049 const struct nx_async_config *msg = ofpmsg_body(oh);
5050 uint32_t master[OAM_N_TYPES];
5051 uint32_t slave[OAM_N_TYPES];
5053 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5054 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5055 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5057 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5058 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5059 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5061 ofconn_set_async_config(ofconn, master, slave);
5062 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5063 !ofconn_get_miss_send_len(ofconn)) {
5064 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5071 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5074 uint32_t master[OAM_N_TYPES];
5075 uint32_t slave[OAM_N_TYPES];
5076 struct nx_async_config *msg;
5078 ofconn_get_async_config(ofconn, master, slave);
5079 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5080 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5082 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5083 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5084 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5086 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5087 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5088 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5090 ofconn_send_reply(ofconn, buf);
5096 handle_nxt_set_controller_id(struct ofconn *ofconn,
5097 const struct ofp_header *oh)
5099 const struct nx_controller_id *nci = ofpmsg_body(oh);
5101 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5102 return OFPERR_NXBRC_MUST_BE_ZERO;
5105 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5110 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5114 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5115 ? OFPRAW_OFPT10_BARRIER_REPLY
5116 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5117 ofconn_send_reply(ofconn, buf);
5122 ofproto_compose_flow_refresh_update(const struct rule *rule,
5123 enum nx_flow_monitor_flags flags,
5124 struct ovs_list *msgs)
5125 OVS_REQUIRES(ofproto_mutex)
5127 const struct rule_actions *actions;
5128 struct ofputil_flow_update fu;
5131 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5132 ? NXFME_ADDED : NXFME_MODIFIED);
5134 ovs_mutex_lock(&rule->mutex);
5135 fu.idle_timeout = rule->idle_timeout;
5136 fu.hard_timeout = rule->hard_timeout;
5137 ovs_mutex_unlock(&rule->mutex);
5138 fu.table_id = rule->table_id;
5139 fu.cookie = rule->flow_cookie;
5140 minimatch_expand(&rule->cr.match, &match);
5142 fu.priority = rule->cr.priority;
5144 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5145 fu.ofpacts = actions ? actions->ofpacts : NULL;
5146 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5148 if (list_is_empty(msgs)) {
5149 ofputil_start_flow_update(msgs);
5151 ofputil_append_flow_update(&fu, msgs);
5155 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5156 struct ovs_list *msgs)
5157 OVS_REQUIRES(ofproto_mutex)
5161 for (i = 0; i < rules->n; i++) {
5162 struct rule *rule = rules->rules[i];
5163 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5164 rule->monitor_flags = 0;
5166 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5171 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5172 struct rule *rule, uint64_t seqno,
5173 struct rule_collection *rules)
5174 OVS_REQUIRES(ofproto_mutex)
5176 enum nx_flow_monitor_flags update;
5178 if (rule_is_hidden(rule)) {
5182 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5187 if (rule->add_seqno > seqno) {
5188 update = NXFMF_ADD | NXFMF_MODIFY;
5189 } else if (rule->modify_seqno > seqno) {
5190 update = NXFMF_MODIFY;
5195 if (!(m->flags & update)) {
5199 update = NXFMF_INITIAL;
5202 if (!rule->monitor_flags) {
5203 rule_collection_add(rules, rule);
5205 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5209 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5211 struct rule_collection *rules)
5212 OVS_REQUIRES(ofproto_mutex)
5214 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5215 const struct oftable *table;
5216 struct cls_rule target;
5218 cls_rule_init_from_minimatch(&target, &m->match, 0);
5219 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5222 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5223 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5226 cls_rule_destroy(&target);
5230 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5231 struct rule_collection *rules)
5232 OVS_REQUIRES(ofproto_mutex)
5234 if (m->flags & NXFMF_INITIAL) {
5235 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5240 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5241 uint64_t seqno, struct rule_collection *rules)
5242 OVS_REQUIRES(ofproto_mutex)
5244 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5248 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5249 OVS_REQUIRES(ofproto_mutex)
5251 struct ofmonitor *m;
5254 m = ofmonitor_lookup(ofconn, id);
5256 ofmonitor_destroy(m);
5259 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5266 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5267 OVS_EXCLUDED(ofproto_mutex)
5269 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5270 struct ofmonitor **monitors;
5271 size_t n_monitors, allocated_monitors;
5272 struct rule_collection rules;
5273 struct ovs_list replies;
5278 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5280 n_monitors = allocated_monitors = 0;
5282 ovs_mutex_lock(&ofproto_mutex);
5284 struct ofputil_flow_monitor_request request;
5285 struct ofmonitor *m;
5288 retval = ofputil_decode_flow_monitor_request(&request, &b);
5289 if (retval == EOF) {
5291 } else if (retval) {
5296 if (request.table_id != 0xff
5297 && request.table_id >= ofproto->n_tables) {
5298 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5302 error = ofmonitor_create(&request, ofconn, &m);
5307 if (n_monitors >= allocated_monitors) {
5308 monitors = x2nrealloc(monitors, &allocated_monitors,
5311 monitors[n_monitors++] = m;
5314 rule_collection_init(&rules);
5315 for (i = 0; i < n_monitors; i++) {
5316 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5319 ofpmp_init(&replies, oh);
5320 ofmonitor_compose_refresh_updates(&rules, &replies);
5321 ovs_mutex_unlock(&ofproto_mutex);
5323 rule_collection_destroy(&rules);
5325 ofconn_send_replies(ofconn, &replies);
5331 for (i = 0; i < n_monitors; i++) {
5332 ofmonitor_destroy(monitors[i]);
5335 ovs_mutex_unlock(&ofproto_mutex);
5341 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5342 OVS_EXCLUDED(ofproto_mutex)
5347 id = ofputil_decode_flow_monitor_cancel(oh);
5349 ovs_mutex_lock(&ofproto_mutex);
5350 error = flow_monitor_delete(ofconn, id);
5351 ovs_mutex_unlock(&ofproto_mutex);
5356 /* Meters implementation.
5358 * Meter table entry, indexed by the OpenFlow meter_id.
5359 * 'created' is used to compute the duration for meter stats.
5360 * 'list rules' is needed so that we can delete the dependent rules when the
5361 * meter table entry is deleted.
5362 * 'provider_meter_id' is for the provider's private use.
5365 long long int created; /* Time created. */
5366 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5367 ofproto_meter_id provider_meter_id;
5368 uint16_t flags; /* Meter flags. */
5369 uint16_t n_bands; /* Number of meter bands. */
5370 struct ofputil_meter_band *bands;
5374 * This is used in instruction validation at flow set-up time,
5375 * as flows may not use non-existing meters.
5376 * Return value of UINT32_MAX signifies an invalid meter.
5379 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5381 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5382 const struct meter *meter = ofproto->meters[of_meter_id];
5384 return meter->provider_meter_id.uint32;
5390 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5393 meter_insert_rule(struct rule *rule)
5395 const struct rule_actions *a = rule_get_actions(rule);
5396 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5397 struct meter *meter = rule->ofproto->meters[meter_id];
5399 list_insert(&meter->rules, &rule->meter_list_node);
5403 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5407 meter->flags = config->flags;
5408 meter->n_bands = config->n_bands;
5409 meter->bands = xmemdup(config->bands,
5410 config->n_bands * sizeof *meter->bands);
5413 static struct meter *
5414 meter_create(const struct ofputil_meter_config *config,
5415 ofproto_meter_id provider_meter_id)
5417 struct meter *meter;
5419 meter = xzalloc(sizeof *meter);
5420 meter->provider_meter_id = provider_meter_id;
5421 meter->created = time_msec();
5422 list_init(&meter->rules);
5424 meter_update(meter, config);
5430 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5431 OVS_REQUIRES(ofproto_mutex)
5434 for (mid = first; mid <= last; ++mid) {
5435 struct meter *meter = ofproto->meters[mid];
5437 ofproto->meters[mid] = NULL;
5438 ofproto->ofproto_class->meter_del(ofproto,
5439 meter->provider_meter_id);
5447 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5449 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5450 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5454 return OFPERR_OFPMMFC_METER_EXISTS;
5457 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5460 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5461 *meterp = meter_create(&mm->meter, provider_meter_id);
5467 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5469 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5471 uint32_t provider_meter_id;
5474 return OFPERR_OFPMMFC_UNKNOWN_METER;
5477 provider_meter_id = meter->provider_meter_id.uint32;
5478 error = ofproto->ofproto_class->meter_set(ofproto,
5479 &meter->provider_meter_id,
5481 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5483 meter_update(meter, &mm->meter);
5489 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5490 OVS_EXCLUDED(ofproto_mutex)
5492 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5493 uint32_t meter_id = mm->meter.meter_id;
5494 struct rule_collection rules;
5495 enum ofperr error = 0;
5496 uint32_t first, last;
5498 if (meter_id == OFPM13_ALL) {
5500 last = ofproto->meter_features.max_meters;
5502 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5505 first = last = meter_id;
5508 /* First delete the rules that use this meter. If any of those rules are
5509 * currently being modified, postpone the whole operation until later. */
5510 rule_collection_init(&rules);
5511 ovs_mutex_lock(&ofproto_mutex);
5512 for (meter_id = first; meter_id <= last; ++meter_id) {
5513 struct meter *meter = ofproto->meters[meter_id];
5514 if (meter && !list_is_empty(&meter->rules)) {
5517 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5518 rule_collection_add(&rules, rule);
5522 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5524 /* Delete the meters. */
5525 meter_delete(ofproto, first, last);
5527 ovs_mutex_unlock(&ofproto_mutex);
5528 rule_collection_destroy(&rules);
5534 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5536 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5537 struct ofputil_meter_mod mm;
5538 uint64_t bands_stub[256 / 8];
5539 struct ofpbuf bands;
5543 error = reject_slave_controller(ofconn);
5548 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5550 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5552 goto exit_free_bands;
5555 meter_id = mm.meter.meter_id;
5557 if (mm.command != OFPMC13_DELETE) {
5558 /* Fails also when meters are not implemented by the provider. */
5559 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5560 error = OFPERR_OFPMMFC_INVALID_METER;
5561 goto exit_free_bands;
5562 } else if (meter_id > ofproto->meter_features.max_meters) {
5563 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5564 goto exit_free_bands;
5566 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5567 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5568 goto exit_free_bands;
5572 switch (mm.command) {
5574 error = handle_add_meter(ofproto, &mm);
5577 case OFPMC13_MODIFY:
5578 error = handle_modify_meter(ofproto, &mm);
5581 case OFPMC13_DELETE:
5582 error = handle_delete_meter(ofconn, &mm);
5586 error = OFPERR_OFPMMFC_BAD_COMMAND;
5591 ofpbuf_uninit(&bands);
5596 handle_meter_features_request(struct ofconn *ofconn,
5597 const struct ofp_header *request)
5599 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5600 struct ofputil_meter_features features;
5603 if (ofproto->ofproto_class->meter_get_features) {
5604 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5606 memset(&features, 0, sizeof features);
5608 b = ofputil_encode_meter_features_reply(&features, request);
5610 ofconn_send_reply(ofconn, b);
5615 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5618 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5619 struct ovs_list replies;
5620 uint64_t bands_stub[256 / 8];
5621 struct ofpbuf bands;
5622 uint32_t meter_id, first, last;
5624 ofputil_decode_meter_request(request, &meter_id);
5626 if (meter_id == OFPM13_ALL) {
5628 last = ofproto->meter_features.max_meters;
5630 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5631 !ofproto->meters[meter_id]) {
5632 return OFPERR_OFPMMFC_UNKNOWN_METER;
5634 first = last = meter_id;
5637 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5638 ofpmp_init(&replies, request);
5640 for (meter_id = first; meter_id <= last; ++meter_id) {
5641 struct meter *meter = ofproto->meters[meter_id];
5643 continue; /* Skip non-existing meters. */
5645 if (type == OFPTYPE_METER_STATS_REQUEST) {
5646 struct ofputil_meter_stats stats;
5648 stats.meter_id = meter_id;
5650 /* Provider sets the packet and byte counts, we do the rest. */
5651 stats.flow_count = list_size(&meter->rules);
5652 calc_duration(meter->created, time_msec(),
5653 &stats.duration_sec, &stats.duration_nsec);
5654 stats.n_bands = meter->n_bands;
5655 ofpbuf_clear(&bands);
5657 = ofpbuf_put_uninit(&bands,
5658 meter->n_bands * sizeof *stats.bands);
5660 if (!ofproto->ofproto_class->meter_get(ofproto,
5661 meter->provider_meter_id,
5663 ofputil_append_meter_stats(&replies, &stats);
5665 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5666 struct ofputil_meter_config config;
5668 config.meter_id = meter_id;
5669 config.flags = meter->flags;
5670 config.n_bands = meter->n_bands;
5671 config.bands = meter->bands;
5672 ofputil_append_meter_config(&replies, &config);
5676 ofconn_send_replies(ofconn, &replies);
5677 ofpbuf_uninit(&bands);
5682 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5683 struct ofgroup **group)
5684 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5686 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5687 hash_int(group_id, 0), &ofproto->groups) {
5688 if ((*group)->group_id == group_id) {
5696 /* If the group exists, this function increments the groups's reference count.
5698 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5699 * a reference to the group. */
5701 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5702 struct ofgroup **group)
5706 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5707 found = ofproto_group_lookup__(ofproto, group_id, group);
5709 ofproto_group_ref(*group);
5711 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5716 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5717 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5719 struct ofgroup *grp;
5721 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5722 hash_int(group_id, 0), &ofproto->groups) {
5723 if (grp->group_id == group_id) {
5731 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5732 OVS_EXCLUDED(ofproto->groups_rwlock)
5736 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5737 exists = ofproto_group_exists__(ofproto, group_id);
5738 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5744 group_get_ref_count(struct ofgroup *group)
5745 OVS_EXCLUDED(ofproto_mutex)
5747 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5748 struct rule_criteria criteria;
5749 struct rule_collection rules;
5754 match_init_catchall(&match);
5755 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5756 OFPP_ANY, group->group_id);
5757 ovs_mutex_lock(&ofproto_mutex);
5758 error = collect_rules_loose(ofproto, &criteria, &rules);
5759 ovs_mutex_unlock(&ofproto_mutex);
5760 rule_criteria_destroy(&criteria);
5762 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5764 rule_collection_destroy(&rules);
5769 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
5771 struct ofputil_group_stats ogs;
5772 const struct ofproto *ofproto = group->ofproto;
5773 long long int now = time_msec();
5776 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5778 /* Provider sets the packet and byte counts, we do the rest. */
5779 ogs.ref_count = group_get_ref_count(group);
5780 ogs.n_buckets = group->n_buckets;
5782 error = (ofproto->ofproto_class->group_get_stats
5783 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5786 ogs.packet_count = UINT64_MAX;
5787 ogs.byte_count = UINT64_MAX;
5788 memset(ogs.bucket_stats, 0xff,
5789 ogs.n_buckets * sizeof *ogs.bucket_stats);
5792 ogs.group_id = group->group_id;
5793 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5795 ofputil_append_group_stats(replies, &ogs);
5797 free(ogs.bucket_stats);
5801 handle_group_request(struct ofconn *ofconn,
5802 const struct ofp_header *request, uint32_t group_id,
5803 void (*cb)(struct ofgroup *, struct ovs_list *replies))
5805 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5806 struct ofgroup *group;
5807 struct ovs_list replies;
5809 ofpmp_init(&replies, request);
5810 if (group_id == OFPG_ALL) {
5811 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5812 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5813 cb(group, &replies);
5815 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5817 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5818 cb(group, &replies);
5819 ofproto_group_unref(group);
5822 ofconn_send_replies(ofconn, &replies);
5826 handle_group_stats_request(struct ofconn *ofconn,
5827 const struct ofp_header *request)
5832 error = ofputil_decode_group_stats_request(request, &group_id);
5837 handle_group_request(ofconn, request, group_id, append_group_stats);
5842 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
5844 struct ofputil_group_desc gds;
5846 gds.group_id = group->group_id;
5847 gds.type = group->type;
5848 gds.props = group->props;
5850 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5854 handle_group_desc_stats_request(struct ofconn *ofconn,
5855 const struct ofp_header *request)
5857 handle_group_request(ofconn, request,
5858 ofputil_decode_group_desc_request(request),
5864 handle_group_features_stats_request(struct ofconn *ofconn,
5865 const struct ofp_header *request)
5867 struct ofproto *p = ofconn_get_ofproto(ofconn);
5870 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5872 ofconn_send_reply(ofconn, msg);
5879 handle_queue_get_config_request(struct ofconn *ofconn,
5880 const struct ofp_header *oh)
5882 struct ofproto *p = ofconn_get_ofproto(ofconn);
5883 struct netdev_queue_dump queue_dump;
5884 struct ofport *ofport;
5885 unsigned int queue_id;
5886 struct ofpbuf *reply;
5887 struct smap details;
5891 error = ofputil_decode_queue_get_config_request(oh, &request);
5896 ofport = ofproto_get_port(p, request);
5898 return OFPERR_OFPQOFC_BAD_PORT;
5901 reply = ofputil_encode_queue_get_config_reply(oh);
5903 smap_init(&details);
5904 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5905 struct ofputil_queue_config queue;
5907 /* None of the existing queues have compatible properties, so we
5908 * hard-code omitting min_rate and max_rate. */
5909 queue.queue_id = queue_id;
5910 queue.min_rate = UINT16_MAX;
5911 queue.max_rate = UINT16_MAX;
5912 ofputil_append_queue_get_config_reply(reply, &queue);
5914 smap_destroy(&details);
5916 ofconn_send_reply(ofconn, reply);
5922 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
5923 struct ofgroup **ofgroup)
5926 const long long int now = time_msec();
5928 if (gm->group_id > OFPG_MAX) {
5929 return OFPERR_OFPGMFC_INVALID_GROUP;
5931 if (gm->type > OFPGT11_FF) {
5932 return OFPERR_OFPGMFC_BAD_TYPE;
5935 *ofgroup = ofproto->ofproto_class->group_alloc();
5937 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5938 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5941 (*ofgroup)->ofproto = ofproto;
5942 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
5943 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
5944 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
5945 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
5946 ovs_refcount_init(&(*ofgroup)->ref_count);
5948 list_move(&(*ofgroup)->buckets, &gm->buckets);
5949 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
5950 list_size(&(*ofgroup)->buckets);
5952 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
5953 &gm->props, sizeof (struct ofputil_group_props));
5955 /* Construct called BEFORE any locks are held. */
5956 error = ofproto->ofproto_class->group_construct(*ofgroup);
5958 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
5959 ofproto->ofproto_class->group_dealloc(*ofgroup);
5964 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
5965 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
5968 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5970 struct ofgroup *ofgroup;
5973 /* Allocate new group and initialize it. */
5974 error = init_group(ofproto, gm, &ofgroup);
5979 /* We wrlock as late as possible to minimize the time we jam any other
5980 * threads: No visible state changes before acquiring the lock. */
5981 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5983 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5984 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5988 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5989 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5994 /* Insert new group. */
5995 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5996 hash_int(ofgroup->group_id, 0));
5997 ofproto->n_groups[ofgroup->type]++;
5999 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6004 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6005 ofproto->ofproto_class->group_destruct(ofgroup);
6006 ofputil_bucket_list_destroy(&ofgroup->buckets);
6007 ofproto->ofproto_class->group_dealloc(ofgroup);
6012 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6013 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6014 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6015 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6018 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6019 struct ofgroup *new_ofgroup,
6020 uint32_t command_bucket_id)
6022 struct ofputil_bucket *last = NULL;
6024 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6025 /* Check here to ensure that a bucket corresponding to
6026 * command_bucket_id exists in the old bucket list.
6028 * The subsequent search of below of new_ofgroup covers
6029 * both buckets in the old bucket list and buckets added
6030 * by the insert buckets group mod message this function processes. */
6031 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6032 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6035 if (!list_is_empty(&new_ofgroup->buckets)) {
6036 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6040 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6042 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6043 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6044 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6047 /* Rearrange list according to command_bucket_id */
6048 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6049 struct ofputil_bucket *new_first;
6050 const struct ofputil_bucket *first;
6052 first = ofputil_bucket_list_front(&ofgroup->buckets);
6053 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6056 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6057 &new_ofgroup->buckets);
6058 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6059 struct ofputil_bucket *after;
6061 /* Presence of bucket is checked above so after should never be NULL */
6062 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6064 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6065 last->list_node.next);
6071 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6072 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6073 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6074 * and OFPG15_BUCKET_ALL are also honored. */
6076 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6077 struct ofgroup *new_ofgroup,
6078 uint32_t command_bucket_id)
6080 const struct ofputil_bucket *skip = NULL;
6082 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6086 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6087 if (!list_is_empty(&ofgroup->buckets)) {
6088 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6090 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6091 if (!list_is_empty(&ofgroup->buckets)) {
6092 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6095 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6097 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6101 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6106 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6107 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6110 * Note that the group is re-created and then replaces the old group in
6111 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6112 * the xlate module hold a pointer to the group. */
6114 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6116 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6119 error = init_group(ofproto, gm, &new_ofgroup);
6124 retiring = new_ofgroup;
6126 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6127 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6128 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6132 /* Ofproto's group write lock is held now. */
6133 if (ofgroup->type != gm->type
6134 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6135 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6139 /* Manipulate bucket list for bucket commands */
6140 if (gm->command == OFPGC15_INSERT_BUCKET) {
6141 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6142 gm->command_bucket_id);
6143 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6144 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6145 gm->command_bucket_id);
6151 /* The group creation time does not change during modification. */
6152 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6153 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6155 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6161 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6162 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6163 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6164 hash_int(new_ofgroup->group_id, 0));
6165 if (ofgroup->type != new_ofgroup->type) {
6166 ofproto->n_groups[ofgroup->type]--;
6167 ofproto->n_groups[new_ofgroup->type]++;
6171 ofproto_group_unref(retiring);
6172 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6177 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6178 OVS_RELEASES(ofproto->groups_rwlock)
6181 struct ofputil_flow_mod fm;
6183 /* Delete all flow entries containing this group in a group action */
6184 match_init_catchall(&match);
6185 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6186 fm.delete_reason = OFPRR_GROUP_DELETE;
6187 fm.out_group = ofgroup->group_id;
6188 handle_flow_mod__(ofproto, &fm, NULL);
6190 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6191 /* No-one can find this group any more. */
6192 ofproto->n_groups[ofgroup->type]--;
6193 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6194 ofproto_group_unref(ofgroup);
6197 /* Implements OFPGC11_DELETE. */
6199 delete_group(struct ofproto *ofproto, uint32_t group_id)
6201 struct ofgroup *ofgroup;
6203 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6204 if (group_id == OFPG_ALL) {
6206 struct hmap_node *node = hmap_first(&ofproto->groups);
6210 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6211 delete_group__(ofproto, ofgroup);
6212 /* Lock for each node separately, so that we will not jam the
6213 * other threads for too long time. */
6214 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6217 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6218 hash_int(group_id, 0), &ofproto->groups) {
6219 if (ofgroup->group_id == group_id) {
6220 delete_group__(ofproto, ofgroup);
6225 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6229 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6231 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6232 struct ofputil_group_mod gm;
6235 error = reject_slave_controller(ofconn);
6240 error = ofputil_decode_group_mod(oh, &gm);
6245 switch (gm.command) {
6247 return add_group(ofproto, &gm);
6249 case OFPGC11_MODIFY:
6250 return modify_group(ofproto, &gm);
6252 case OFPGC11_DELETE:
6253 delete_group(ofproto, gm.group_id);
6256 case OFPGC15_INSERT_BUCKET:
6257 return modify_group(ofproto, &gm);
6259 case OFPGC15_REMOVE_BUCKET:
6260 return modify_group(ofproto, &gm);
6263 if (gm.command > OFPGC11_DELETE) {
6264 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6265 ofproto->name, gm.command);
6267 return OFPERR_OFPGMFC_BAD_COMMAND;
6271 enum ofputil_table_miss
6272 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6274 enum ofputil_table_miss value;
6276 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6281 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6283 if (!check_table_id(ofproto, tm->table_id)) {
6284 return OFPERR_OFPTMFC_BAD_TABLE;
6285 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6286 if (tm->table_id == OFPTT_ALL) {
6288 for (i = 0; i < ofproto->n_tables; i++) {
6289 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6293 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6301 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6303 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6304 struct ofputil_table_mod tm;
6307 error = reject_slave_controller(ofconn);
6312 error = ofputil_decode_table_mod(oh, &tm);
6317 return table_mod(ofproto, &tm);
6321 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6324 struct ofputil_bundle_ctrl_msg bctrl;
6326 struct ofputil_bundle_ctrl_msg reply;
6328 error = reject_slave_controller(ofconn);
6333 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6338 reply.bundle_id = bctrl.bundle_id;
6340 switch (bctrl.type) {
6341 case OFPBCT_OPEN_REQUEST:
6342 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6343 reply.type = OFPBCT_OPEN_REPLY;
6345 case OFPBCT_CLOSE_REQUEST:
6346 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6347 reply.type = OFPBCT_CLOSE_REPLY;;
6349 case OFPBCT_COMMIT_REQUEST:
6350 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6351 reply.type = OFPBCT_COMMIT_REPLY;
6353 case OFPBCT_DISCARD_REQUEST:
6354 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6355 reply.type = OFPBCT_DISCARD_REPLY;
6358 case OFPBCT_OPEN_REPLY:
6359 case OFPBCT_CLOSE_REPLY:
6360 case OFPBCT_COMMIT_REPLY:
6361 case OFPBCT_DISCARD_REPLY:
6362 return OFPERR_OFPBFC_BAD_TYPE;
6367 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6368 ofconn_send_reply(ofconn, buf);
6375 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6377 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6379 struct ofputil_bundle_add_msg badd;
6380 struct ofp_bundle_entry *bmsg;
6383 error = reject_slave_controller(ofconn);
6388 error = ofputil_decode_bundle_add(oh, &badd, &type);
6393 bmsg = ofp_bundle_entry_alloc(type, badd.msg->xid);
6395 if (type == OFPTYPE_PORT_MOD) {
6396 error = ofputil_decode_port_mod(badd.msg, &bmsg->pm, false);
6397 } else if (type == OFPTYPE_FLOW_MOD) {
6398 struct ofpbuf ofpacts;
6399 uint64_t ofpacts_stub[1024 / 8];
6401 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6402 error = ofputil_decode_flow_mod(&bmsg->fm, badd.msg,
6403 ofconn_get_protocol(ofconn),
6405 u16_to_ofp(ofproto->max_ports),
6407 /* Move actions to heap. */
6408 bmsg->fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6410 if (!error && bmsg->fm.ofpacts_len) {
6411 error = ofproto_check_ofpacts(ofproto, bmsg->fm.ofpacts,
6412 bmsg->fm.ofpacts_len);
6419 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
6424 ofp_bundle_entry_free(bmsg);
6431 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6432 OVS_EXCLUDED(ofproto_mutex)
6434 const struct ofp_header *oh = msg->data;
6438 error = ofptype_decode(&type, oh);
6442 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6443 && ofpmp_more(oh)) {
6444 /* We have no buffer implementation for multipart requests.
6445 * Report overflow for requests which consists of multiple
6447 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6451 /* OpenFlow requests. */
6452 case OFPTYPE_ECHO_REQUEST:
6453 return handle_echo_request(ofconn, oh);
6455 case OFPTYPE_FEATURES_REQUEST:
6456 return handle_features_request(ofconn, oh);
6458 case OFPTYPE_GET_CONFIG_REQUEST:
6459 return handle_get_config_request(ofconn, oh);
6461 case OFPTYPE_SET_CONFIG:
6462 return handle_set_config(ofconn, oh);
6464 case OFPTYPE_PACKET_OUT:
6465 return handle_packet_out(ofconn, oh);
6467 case OFPTYPE_PORT_MOD:
6468 return handle_port_mod(ofconn, oh);
6470 case OFPTYPE_FLOW_MOD:
6471 return handle_flow_mod(ofconn, oh);
6473 case OFPTYPE_GROUP_MOD:
6474 return handle_group_mod(ofconn, oh);
6476 case OFPTYPE_TABLE_MOD:
6477 return handle_table_mod(ofconn, oh);
6479 case OFPTYPE_METER_MOD:
6480 return handle_meter_mod(ofconn, oh);
6482 case OFPTYPE_BARRIER_REQUEST:
6483 return handle_barrier_request(ofconn, oh);
6485 case OFPTYPE_ROLE_REQUEST:
6486 return handle_role_request(ofconn, oh);
6488 /* OpenFlow replies. */
6489 case OFPTYPE_ECHO_REPLY:
6492 /* Nicira extension requests. */
6493 case OFPTYPE_FLOW_MOD_TABLE_ID:
6494 return handle_nxt_flow_mod_table_id(ofconn, oh);
6496 case OFPTYPE_SET_FLOW_FORMAT:
6497 return handle_nxt_set_flow_format(ofconn, oh);
6499 case OFPTYPE_SET_PACKET_IN_FORMAT:
6500 return handle_nxt_set_packet_in_format(ofconn, oh);
6502 case OFPTYPE_SET_CONTROLLER_ID:
6503 return handle_nxt_set_controller_id(ofconn, oh);
6505 case OFPTYPE_FLOW_AGE:
6506 /* Nothing to do. */
6509 case OFPTYPE_FLOW_MONITOR_CANCEL:
6510 return handle_flow_monitor_cancel(ofconn, oh);
6512 case OFPTYPE_SET_ASYNC_CONFIG:
6513 return handle_nxt_set_async_config(ofconn, oh);
6515 case OFPTYPE_GET_ASYNC_REQUEST:
6516 return handle_nxt_get_async_request(ofconn, oh);
6518 /* Statistics requests. */
6519 case OFPTYPE_DESC_STATS_REQUEST:
6520 return handle_desc_stats_request(ofconn, oh);
6522 case OFPTYPE_FLOW_STATS_REQUEST:
6523 return handle_flow_stats_request(ofconn, oh);
6525 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6526 return handle_aggregate_stats_request(ofconn, oh);
6528 case OFPTYPE_TABLE_STATS_REQUEST:
6529 return handle_table_stats_request(ofconn, oh);
6531 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6532 return handle_table_features_request(ofconn, oh);
6534 case OFPTYPE_PORT_STATS_REQUEST:
6535 return handle_port_stats_request(ofconn, oh);
6537 case OFPTYPE_QUEUE_STATS_REQUEST:
6538 return handle_queue_stats_request(ofconn, oh);
6540 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6541 return handle_port_desc_stats_request(ofconn, oh);
6543 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6544 return handle_flow_monitor_request(ofconn, oh);
6546 case OFPTYPE_METER_STATS_REQUEST:
6547 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6548 return handle_meter_request(ofconn, oh, type);
6550 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6551 return handle_meter_features_request(ofconn, oh);
6553 case OFPTYPE_GROUP_STATS_REQUEST:
6554 return handle_group_stats_request(ofconn, oh);
6556 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6557 return handle_group_desc_stats_request(ofconn, oh);
6559 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6560 return handle_group_features_stats_request(ofconn, oh);
6562 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6563 return handle_queue_get_config_request(ofconn, oh);
6565 case OFPTYPE_BUNDLE_CONTROL:
6566 return handle_bundle_control(ofconn, oh);
6568 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6569 return handle_bundle_add(ofconn, oh);
6573 case OFPTYPE_FEATURES_REPLY:
6574 case OFPTYPE_GET_CONFIG_REPLY:
6575 case OFPTYPE_PACKET_IN:
6576 case OFPTYPE_FLOW_REMOVED:
6577 case OFPTYPE_PORT_STATUS:
6578 case OFPTYPE_BARRIER_REPLY:
6579 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6580 case OFPTYPE_DESC_STATS_REPLY:
6581 case OFPTYPE_FLOW_STATS_REPLY:
6582 case OFPTYPE_QUEUE_STATS_REPLY:
6583 case OFPTYPE_PORT_STATS_REPLY:
6584 case OFPTYPE_TABLE_STATS_REPLY:
6585 case OFPTYPE_AGGREGATE_STATS_REPLY:
6586 case OFPTYPE_PORT_DESC_STATS_REPLY:
6587 case OFPTYPE_ROLE_REPLY:
6588 case OFPTYPE_FLOW_MONITOR_PAUSED:
6589 case OFPTYPE_FLOW_MONITOR_RESUMED:
6590 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6591 case OFPTYPE_GET_ASYNC_REPLY:
6592 case OFPTYPE_GROUP_STATS_REPLY:
6593 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6594 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6595 case OFPTYPE_METER_STATS_REPLY:
6596 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6597 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6598 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6599 case OFPTYPE_ROLE_STATUS:
6601 if (ofpmsg_is_stat_request(oh)) {
6602 return OFPERR_OFPBRC_BAD_STAT;
6604 return OFPERR_OFPBRC_BAD_TYPE;
6610 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6611 OVS_EXCLUDED(ofproto_mutex)
6613 int error = handle_openflow__(ofconn, ofp_msg);
6615 ofconn_send_error(ofconn, ofp_msg->data, error);
6617 COVERAGE_INC(ofproto_recv_openflow);
6620 /* Asynchronous operations. */
6623 send_buffered_packet(struct ofconn *ofconn, uint32_t buffer_id,
6625 OVS_REQUIRES(ofproto_mutex)
6627 enum ofperr error = 0;
6628 if (ofconn && buffer_id != UINT32_MAX) {
6629 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6630 struct dp_packet *packet;
6633 error = ofconn_pktbuf_retrieve(ofconn, buffer_id, &packet, &in_port);
6635 struct rule_execute *re;
6637 ofproto_rule_ref(rule);
6639 re = xmalloc(sizeof *re);
6641 re->in_port = in_port;
6642 re->packet = packet;
6644 if (!guarded_list_push_back(&ofproto->rule_executes,
6645 &re->list_node, 1024)) {
6646 ofproto_rule_unref(rule);
6647 dp_packet_delete(re->packet);
6656 pick_datapath_id(const struct ofproto *ofproto)
6658 const struct ofport *port;
6660 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6662 uint8_t ea[ETH_ADDR_LEN];
6665 error = netdev_get_etheraddr(port->netdev, ea);
6667 return eth_addr_to_uint64(ea);
6669 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6670 ofproto->name, netdev_get_name(port->netdev),
6671 ovs_strerror(error));
6673 return ofproto->fallback_dpid;
6677 pick_fallback_dpid(void)
6679 uint8_t ea[ETH_ADDR_LEN];
6680 eth_addr_nicira_random(ea);
6681 return eth_addr_to_uint64(ea);
6684 /* Table overflow policy. */
6686 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6687 * to NULL if the table is not configured to evict rules or if the table
6688 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6689 * or with no timeouts are not evictable.) */
6691 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6692 OVS_REQUIRES(ofproto_mutex)
6694 struct eviction_group *evg;
6697 if (!table->eviction_fields) {
6701 /* In the common case, the outer and inner loops here will each be entered
6704 * - The inner loop normally "return"s in its first iteration. If the
6705 * eviction group has any evictable rules, then it always returns in
6708 * - The outer loop only iterates more than once if the largest eviction
6709 * group has no evictable rules.
6711 * - The outer loop can exit only if table's 'max_flows' is all filled up
6712 * by unevictable rules. */
6713 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6716 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6725 /* Eviction groups. */
6727 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6728 * rules. The priority contains low-order random bits to ensure that eviction
6729 * groups with the same number of rules are prioritized randomly. */
6731 eviction_group_priority(size_t n_rules)
6733 uint16_t size = MIN(UINT16_MAX, n_rules);
6734 return (size << 16) | random_uint16();
6737 /* Updates 'evg', an eviction_group within 'table', following a change that
6738 * adds or removes rules in 'evg'. */
6740 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6741 OVS_REQUIRES(ofproto_mutex)
6743 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6744 eviction_group_priority(heap_count(&evg->rules)));
6747 /* Destroys 'evg', an eviction_group within 'table':
6749 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6750 * rules themselves, just removes them from the eviction group.)
6752 * - Removes 'evg' from 'table'.
6756 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6757 OVS_REQUIRES(ofproto_mutex)
6759 while (!heap_is_empty(&evg->rules)) {
6762 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6763 rule->eviction_group = NULL;
6765 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6766 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6767 heap_destroy(&evg->rules);
6771 /* Removes 'rule' from its eviction group, if any. */
6773 eviction_group_remove_rule(struct rule *rule)
6774 OVS_REQUIRES(ofproto_mutex)
6776 if (rule->eviction_group) {
6777 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6778 struct eviction_group *evg = rule->eviction_group;
6780 rule->eviction_group = NULL;
6781 heap_remove(&evg->rules, &rule->evg_node);
6782 if (heap_is_empty(&evg->rules)) {
6783 eviction_group_destroy(table, evg);
6785 eviction_group_resized(table, evg);
6790 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6791 * returns the hash value. */
6793 eviction_group_hash_rule(struct rule *rule)
6794 OVS_REQUIRES(ofproto_mutex)
6796 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6797 const struct mf_subfield *sf;
6801 hash = table->eviction_group_id_basis;
6802 miniflow_expand(&rule->cr.match.flow, &flow);
6803 for (sf = table->eviction_fields;
6804 sf < &table->eviction_fields[table->n_eviction_fields];
6807 if (mf_are_prereqs_ok(sf->field, &flow)) {
6808 union mf_value value;
6810 mf_get_value(sf->field, &flow, &value);
6812 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6814 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6815 unsigned int start = sf->ofs + sf->n_bits;
6816 bitwise_zero(&value, sf->field->n_bytes, start,
6817 sf->field->n_bytes * 8 - start);
6819 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6821 hash = hash_int(hash, 0);
6828 /* Returns an eviction group within 'table' with the given 'id', creating one
6830 static struct eviction_group *
6831 eviction_group_find(struct oftable *table, uint32_t id)
6832 OVS_REQUIRES(ofproto_mutex)
6834 struct eviction_group *evg;
6836 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6840 evg = xmalloc(sizeof *evg);
6841 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6842 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6843 eviction_group_priority(0));
6844 heap_init(&evg->rules);
6849 /* Returns an eviction priority for 'rule'. The return value should be
6850 * interpreted so that higher priorities make a rule more attractive candidates
6852 * Called only if have a timeout. */
6854 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6855 OVS_REQUIRES(ofproto_mutex)
6857 long long int expiration = LLONG_MAX;
6858 long long int modified;
6859 uint32_t expiration_offset;
6861 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6862 ovs_mutex_lock(&rule->mutex);
6863 modified = rule->modified;
6864 ovs_mutex_unlock(&rule->mutex);
6866 if (rule->hard_timeout) {
6867 expiration = modified + rule->hard_timeout * 1000;
6869 if (rule->idle_timeout) {
6870 uint64_t packets, bytes;
6872 long long int idle_expiration;
6874 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6875 idle_expiration = used + rule->idle_timeout * 1000;
6876 expiration = MIN(expiration, idle_expiration);
6879 if (expiration == LLONG_MAX) {
6883 /* Calculate the time of expiration as a number of (approximate) seconds
6884 * after program startup.
6886 * This should work OK for program runs that last UINT32_MAX seconds or
6887 * less. Therefore, please restart OVS at least once every 136 years. */
6888 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6890 /* Invert the expiration offset because we're using a max-heap. */
6891 return UINT32_MAX - expiration_offset;
6894 /* Adds 'rule' to an appropriate eviction group for its oftable's
6895 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6896 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6899 * The caller must ensure that 'rule' is not already in an eviction group. */
6901 eviction_group_add_rule(struct rule *rule)
6902 OVS_REQUIRES(ofproto_mutex)
6904 struct ofproto *ofproto = rule->ofproto;
6905 struct oftable *table = &ofproto->tables[rule->table_id];
6908 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6909 * so no additional protection is needed. */
6910 has_timeout = rule->hard_timeout || rule->idle_timeout;
6912 if (table->eviction_fields && has_timeout) {
6913 struct eviction_group *evg;
6915 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6917 rule->eviction_group = evg;
6918 heap_insert(&evg->rules, &rule->evg_node,
6919 rule_eviction_priority(ofproto, rule));
6920 eviction_group_resized(table, evg);
6926 /* Initializes 'table'. */
6928 oftable_init(struct oftable *table)
6930 memset(table, 0, sizeof *table);
6931 classifier_init(&table->cls, flow_segment_u64s);
6932 table->max_flows = UINT_MAX;
6933 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
6935 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
6936 ARRAY_SIZE(default_prefix_fields));
6938 atomic_init(&table->n_matched, 0);
6939 atomic_init(&table->n_missed, 0);
6942 /* Destroys 'table', including its classifier and eviction groups.
6944 * The caller is responsible for freeing 'table' itself. */
6946 oftable_destroy(struct oftable *table)
6948 ovs_assert(classifier_is_empty(&table->cls));
6949 oftable_disable_eviction(table);
6950 classifier_destroy(&table->cls);
6954 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6955 * string, then 'table' will use its default name.
6957 * This only affects the name exposed for a table exposed through the OpenFlow
6958 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6960 oftable_set_name(struct oftable *table, const char *name)
6962 if (name && name[0]) {
6963 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6964 if (!table->name || strncmp(name, table->name, len)) {
6966 table->name = xmemdup0(name, len);
6974 /* oftables support a choice of two policies when adding a rule would cause the
6975 * number of flows in the table to exceed the configured maximum number: either
6976 * they can refuse to add the new flow or they can evict some existing flow.
6977 * This function configures the former policy on 'table'. */
6979 oftable_disable_eviction(struct oftable *table)
6980 OVS_REQUIRES(ofproto_mutex)
6982 if (table->eviction_fields) {
6983 struct eviction_group *evg, *next;
6985 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6986 &table->eviction_groups_by_id) {
6987 eviction_group_destroy(table, evg);
6989 hmap_destroy(&table->eviction_groups_by_id);
6990 heap_destroy(&table->eviction_groups_by_size);
6992 free(table->eviction_fields);
6993 table->eviction_fields = NULL;
6994 table->n_eviction_fields = 0;
6998 /* oftables support a choice of two policies when adding a rule would cause the
6999 * number of flows in the table to exceed the configured maximum number: either
7000 * they can refuse to add the new flow or they can evict some existing flow.
7001 * This function configures the latter policy on 'table', with fairness based
7002 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7003 * 'n_fields' as 0 disables fairness.) */
7005 oftable_enable_eviction(struct oftable *table,
7006 const struct mf_subfield *fields, size_t n_fields)
7007 OVS_REQUIRES(ofproto_mutex)
7011 if (table->eviction_fields
7012 && n_fields == table->n_eviction_fields
7014 || !memcmp(fields, table->eviction_fields,
7015 n_fields * sizeof *fields))) {
7020 oftable_disable_eviction(table);
7022 table->n_eviction_fields = n_fields;
7023 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
7025 table->eviction_group_id_basis = random_uint32();
7026 hmap_init(&table->eviction_groups_by_id);
7027 heap_init(&table->eviction_groups_by_size);
7029 CLS_FOR_EACH (rule, cr, &table->cls) {
7030 eviction_group_add_rule(rule);
7034 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7035 * it to the classifier. */
7037 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7038 OVS_REQUIRES(ofproto_mutex)
7040 const struct rule_actions *actions = rule_get_actions(rule);
7042 if (rule->hard_timeout || rule->idle_timeout) {
7043 list_insert(&ofproto->expirable, &rule->expirable);
7045 cookies_insert(ofproto, rule);
7046 eviction_group_add_rule(rule);
7047 if (actions->has_meter) {
7048 meter_insert_rule(rule);
7052 /* Removes 'rule' from the ofproto data structures AFTER caller has removed
7053 * it from the classifier. */
7055 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7056 OVS_REQUIRES(ofproto_mutex)
7058 cookies_remove(ofproto, rule);
7060 eviction_group_remove_rule(rule);
7061 if (!list_is_empty(&rule->expirable)) {
7062 list_remove(&rule->expirable);
7064 if (!list_is_empty(&rule->meter_list_node)) {
7065 list_remove(&rule->meter_list_node);
7066 list_init(&rule->meter_list_node);
7071 oftable_remove_rule(struct rule *rule)
7072 OVS_REQUIRES(ofproto_mutex)
7074 struct classifier *cls = &rule->ofproto->tables[rule->table_id].cls;
7076 if (classifier_remove(cls, &rule->cr)) {
7077 ofproto_rule_remove__(rule->ofproto, rule);
7081 /* unixctl commands. */
7084 ofproto_lookup(const char *name)
7086 struct ofproto *ofproto;
7088 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7090 if (!strcmp(ofproto->name, name)) {
7098 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7099 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7101 struct ofproto *ofproto;
7105 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7106 ds_put_format(&results, "%s\n", ofproto->name);
7108 unixctl_command_reply(conn, ds_cstr(&results));
7109 ds_destroy(&results);
7113 ofproto_unixctl_init(void)
7115 static bool registered;
7121 unixctl_command_register("ofproto/list", "", 0, 0,
7122 ofproto_unixctl_list, NULL);
7125 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7127 * This is deprecated. It is only for compatibility with broken device drivers
7128 * in old versions of Linux that do not properly support VLANs when VLAN
7129 * devices are not used. When broken device drivers are no longer in
7130 * widespread use, we will delete these interfaces. */
7132 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7133 * (exactly) by an OpenFlow rule in 'ofproto'. */
7135 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7138 struct cls_rule target;
7139 const struct oftable *oftable;
7141 match_init_catchall(&match);
7142 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7143 cls_rule_init(&target, &match, 0);
7145 free(ofproto->vlan_bitmap);
7146 ofproto->vlan_bitmap = bitmap_allocate(4096);
7147 ofproto->vlans_changed = false;
7149 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7152 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7153 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7154 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7156 bitmap_set1(vlan_bitmap, vid);
7157 bitmap_set1(ofproto->vlan_bitmap, vid);
7162 cls_rule_destroy(&target);
7165 /* Returns true if new VLANs have come into use by the flow table since the
7166 * last call to ofproto_get_vlan_usage().
7168 * We don't track when old VLANs stop being used. */
7170 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7172 return ofproto->vlans_changed;
7175 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7176 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7177 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7178 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7179 * then the VLAN device is un-enslaved. */
7181 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7182 ofp_port_t realdev_ofp_port, int vid)
7184 struct ofport *ofport;
7187 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7189 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7191 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7192 ofproto->name, vlandev_ofp_port);
7196 if (!ofproto->ofproto_class->set_realdev) {
7197 if (!vlandev_ofp_port) {
7200 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7204 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7206 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7207 ofproto->name, vlandev_ofp_port,
7208 netdev_get_name(ofport->netdev), ovs_strerror(error));