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_flow_check__(struct ofproto *,
260 struct ofputil_flow_mod *,
262 OVS_REQUIRES(ofproto_mutex);
263 static void modify_flow__(struct ofproto *, struct ofputil_flow_mod *,
264 struct rule *, const struct flow_mod_requester *,
265 struct ovs_list *dead_cookies)
266 OVS_REQUIRES(ofproto_mutex);
267 static void delete_flows__(const struct rule_collection *,
268 enum ofp_flow_removed_reason,
269 const struct flow_mod_requester *)
270 OVS_REQUIRES(ofproto_mutex);
272 static enum ofperr send_buffered_packet(struct ofconn *, uint32_t buffer_id,
274 OVS_REQUIRES(ofproto_mutex);
276 static bool ofproto_group_exists__(const struct ofproto *ofproto,
278 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
279 static bool ofproto_group_exists(const struct ofproto *ofproto,
281 OVS_EXCLUDED(ofproto->groups_rwlock);
282 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
283 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
284 static enum ofperr handle_flow_mod__(struct ofproto *,
285 struct ofputil_flow_mod *,
286 const struct flow_mod_requester *)
287 OVS_EXCLUDED(ofproto_mutex);
288 static void calc_duration(long long int start, long long int now,
289 uint32_t *sec, uint32_t *nsec);
292 static uint64_t pick_datapath_id(const struct ofproto *);
293 static uint64_t pick_fallback_dpid(void);
294 static void ofproto_destroy__(struct ofproto *);
295 static void update_mtu(struct ofproto *, struct ofport *);
296 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
297 static void meter_insert_rule(struct rule *);
300 static void ofproto_unixctl_init(void);
302 /* All registered ofproto classes, in probe order. */
303 static const struct ofproto_class **ofproto_classes;
304 static size_t n_ofproto_classes;
305 static size_t allocated_ofproto_classes;
307 /* Global lock that protects all flow table operations. */
308 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
310 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
311 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
313 size_t n_handlers, n_revalidators;
317 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
318 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
320 /* Initial mappings of port to OpenFlow number mappings. */
321 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
323 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
325 /* The default value of true waits for flow restore. */
326 static bool flow_restore_wait = true;
328 /* Must be called to initialize the ofproto library.
330 * The caller may pass in 'iface_hints', which contains an shash of
331 * "iface_hint" elements indexed by the interface's name. The provider
332 * may use these hints to describe the startup configuration in order to
333 * reinitialize its state. The caller owns the provided data, so a
334 * provider will make copies of anything required. An ofproto provider
335 * will remove any existing state that is not described by the hint, and
336 * may choose to remove it all. */
338 ofproto_init(const struct shash *iface_hints)
340 struct shash_node *node;
343 ofproto_class_register(&ofproto_dpif_class);
345 /* Make a local copy, since we don't own 'iface_hints' elements. */
346 SHASH_FOR_EACH(node, iface_hints) {
347 const struct iface_hint *orig_hint = node->data;
348 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
349 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
351 new_hint->br_name = xstrdup(orig_hint->br_name);
352 new_hint->br_type = xstrdup(br_type);
353 new_hint->ofp_port = orig_hint->ofp_port;
355 shash_add(&init_ofp_ports, node->name, new_hint);
358 for (i = 0; i < n_ofproto_classes; i++) {
359 ofproto_classes[i]->init(&init_ofp_ports);
363 /* 'type' should be a normalized datapath type, as returned by
364 * ofproto_normalize_type(). Returns the corresponding ofproto_class
365 * structure, or a null pointer if there is none registered for 'type'. */
366 static const struct ofproto_class *
367 ofproto_class_find__(const char *type)
371 for (i = 0; i < n_ofproto_classes; i++) {
372 const struct ofproto_class *class = ofproto_classes[i];
377 class->enumerate_types(&types);
378 found = sset_contains(&types, type);
379 sset_destroy(&types);
385 VLOG_WARN("unknown datapath type %s", type);
389 /* Registers a new ofproto class. After successful registration, new ofprotos
390 * of that type can be created using ofproto_create(). */
392 ofproto_class_register(const struct ofproto_class *new_class)
396 for (i = 0; i < n_ofproto_classes; i++) {
397 if (ofproto_classes[i] == new_class) {
402 if (n_ofproto_classes >= allocated_ofproto_classes) {
403 ofproto_classes = x2nrealloc(ofproto_classes,
404 &allocated_ofproto_classes,
405 sizeof *ofproto_classes);
407 ofproto_classes[n_ofproto_classes++] = new_class;
411 /* Unregisters a datapath provider. 'type' must have been previously
412 * registered and not currently be in use by any ofprotos. After
413 * unregistration new datapaths of that type cannot be opened using
414 * ofproto_create(). */
416 ofproto_class_unregister(const struct ofproto_class *class)
420 for (i = 0; i < n_ofproto_classes; i++) {
421 if (ofproto_classes[i] == class) {
422 for (i++; i < n_ofproto_classes; i++) {
423 ofproto_classes[i - 1] = ofproto_classes[i];
429 VLOG_WARN("attempted to unregister an ofproto class that is not "
434 /* Clears 'types' and enumerates all registered ofproto types into it. The
435 * caller must first initialize the sset. */
437 ofproto_enumerate_types(struct sset *types)
442 for (i = 0; i < n_ofproto_classes; i++) {
443 ofproto_classes[i]->enumerate_types(types);
447 /* Returns the fully spelled out name for the given ofproto 'type'.
449 * Normalized type string can be compared with strcmp(). Unnormalized type
450 * string might be the same even if they have different spellings. */
452 ofproto_normalize_type(const char *type)
454 return type && type[0] ? type : "system";
457 /* Clears 'names' and enumerates the names of all known created ofprotos with
458 * the given 'type'. The caller must first initialize the sset. Returns 0 if
459 * successful, otherwise a positive errno value.
461 * Some kinds of datapaths might not be practically enumerable. This is not
462 * considered an error. */
464 ofproto_enumerate_names(const char *type, struct sset *names)
466 const struct ofproto_class *class = ofproto_class_find__(type);
467 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
471 ofproto_create(const char *datapath_name, const char *datapath_type,
472 struct ofproto **ofprotop)
474 const struct ofproto_class *class;
475 struct ofproto *ofproto;
481 ofproto_unixctl_init();
483 datapath_type = ofproto_normalize_type(datapath_type);
484 class = ofproto_class_find__(datapath_type);
486 VLOG_WARN("could not create datapath %s of unknown type %s",
487 datapath_name, datapath_type);
491 ofproto = class->alloc();
493 VLOG_ERR("failed to allocate datapath %s of type %s",
494 datapath_name, datapath_type);
499 ovs_mutex_lock(&ofproto_mutex);
500 memset(ofproto, 0, sizeof *ofproto);
501 ofproto->ofproto_class = class;
502 ofproto->name = xstrdup(datapath_name);
503 ofproto->type = xstrdup(datapath_type);
504 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
505 hash_string(ofproto->name, 0));
506 ofproto->datapath_id = 0;
507 ofproto->forward_bpdu = false;
508 ofproto->fallback_dpid = pick_fallback_dpid();
509 ofproto->mfr_desc = NULL;
510 ofproto->hw_desc = NULL;
511 ofproto->sw_desc = NULL;
512 ofproto->serial_desc = NULL;
513 ofproto->dp_desc = NULL;
514 ofproto->frag_handling = OFPC_FRAG_NORMAL;
515 hmap_init(&ofproto->ports);
516 hmap_init(&ofproto->ofport_usage);
517 shash_init(&ofproto->port_by_name);
518 simap_init(&ofproto->ofp_requests);
519 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
520 ofproto->eviction_group_timer = LLONG_MIN;
521 ofproto->tables = NULL;
522 ofproto->n_tables = 0;
523 hindex_init(&ofproto->cookies);
524 hmap_init(&ofproto->learned_cookies);
525 list_init(&ofproto->expirable);
526 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
527 guarded_list_init(&ofproto->rule_executes);
528 ofproto->vlan_bitmap = NULL;
529 ofproto->vlans_changed = false;
530 ofproto->min_mtu = INT_MAX;
531 ovs_rwlock_init(&ofproto->groups_rwlock);
532 hmap_init(&ofproto->groups);
533 ovs_mutex_unlock(&ofproto_mutex);
534 ofproto->ogf.types = 0xf;
535 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
536 OFPGFC_SELECT_WEIGHT;
537 for (i = 0; i < 4; i++) {
538 ofproto->ogf.max_groups[i] = OFPG_MAX;
539 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
542 error = ofproto->ofproto_class->construct(ofproto);
544 VLOG_ERR("failed to open datapath %s: %s",
545 datapath_name, ovs_strerror(error));
546 connmgr_destroy(ofproto->connmgr);
547 ofproto_destroy__(ofproto);
551 /* Check that hidden tables, if any, are at the end. */
552 ovs_assert(ofproto->n_tables);
553 for (i = 0; i + 1 < ofproto->n_tables; i++) {
554 enum oftable_flags flags = ofproto->tables[i].flags;
555 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
557 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
560 ofproto->datapath_id = pick_datapath_id(ofproto);
563 /* Initialize meters table. */
564 if (ofproto->ofproto_class->meter_get_features) {
565 ofproto->ofproto_class->meter_get_features(ofproto,
566 &ofproto->meter_features);
568 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
570 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
571 * sizeof(struct meter *));
577 /* Must be called (only) by an ofproto implementation in its constructor
578 * function. See the large comment on 'construct' in struct ofproto_class for
581 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
583 struct oftable *table;
585 ovs_assert(!ofproto->n_tables);
586 ovs_assert(n_tables >= 1 && n_tables <= 255);
588 ofproto->n_tables = n_tables;
589 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
590 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
595 /* To be optionally called (only) by an ofproto implementation in its
596 * constructor function. See the large comment on 'construct' in struct
597 * ofproto_class for details.
599 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
600 * will then ensure that actions passed into the ofproto implementation will
601 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
602 * function is not called, there will be no such restriction.
604 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
605 * the 'max_ports' restriction. */
607 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
609 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
610 ofproto->max_ports = max_ports;
614 ofproto_get_datapath_id(const struct ofproto *ofproto)
616 return ofproto->datapath_id;
620 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
622 uint64_t old_dpid = p->datapath_id;
623 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
624 if (p->datapath_id != old_dpid) {
625 /* Force all active connections to reconnect, since there is no way to
626 * notify a controller that the datapath ID has changed. */
627 ofproto_reconnect_controllers(p);
632 ofproto_set_controllers(struct ofproto *p,
633 const struct ofproto_controller *controllers,
634 size_t n_controllers, uint32_t allowed_versions)
636 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
641 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
643 connmgr_set_fail_mode(p->connmgr, fail_mode);
646 /* Drops the connections between 'ofproto' and all of its controllers, forcing
647 * them to reconnect. */
649 ofproto_reconnect_controllers(struct ofproto *ofproto)
651 connmgr_reconnect(ofproto->connmgr);
654 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
655 * in-band control should guarantee access, in the same way that in-band
656 * control guarantees access to OpenFlow controllers. */
658 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
659 const struct sockaddr_in *extras, size_t n)
661 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
664 /* Sets the OpenFlow queue used by flows set up by in-band control on
665 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
666 * flows will use the default queue. */
668 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
670 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
673 /* Sets the number of flows at which eviction from the kernel flow table
676 ofproto_set_flow_limit(unsigned limit)
678 ofproto_flow_limit = limit;
681 /* Sets the maximum idle time for flows in the datapath before they are
684 ofproto_set_max_idle(unsigned max_idle)
686 ofproto_max_idle = max_idle;
689 /* If forward_bpdu is true, the NORMAL action will forward frames with
690 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
691 * the NORMAL action will drop these frames. */
693 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
695 bool old_val = ofproto->forward_bpdu;
696 ofproto->forward_bpdu = forward_bpdu;
697 if (old_val != ofproto->forward_bpdu) {
698 if (ofproto->ofproto_class->forward_bpdu_changed) {
699 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
704 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
705 * 'idle_time', in seconds, and the maximum number of MAC table entries to
708 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
711 if (ofproto->ofproto_class->set_mac_table_config) {
712 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
717 /* Multicast snooping configuration. */
719 /* Configures multicast snooping on 'ofproto' using the settings
720 * defined in 's'. If 's' is NULL, disables multicast snooping.
722 * Returns 0 if successful, otherwise a positive errno value. */
724 ofproto_set_mcast_snooping(struct ofproto *ofproto,
725 const struct ofproto_mcast_snooping_settings *s)
727 return (ofproto->ofproto_class->set_mcast_snooping
728 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
732 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
734 * Returns 0 if successful, otherwise a positive errno value.*/
736 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
737 const struct ofproto_mcast_snooping_port_settings *s)
739 return (ofproto->ofproto_class->set_mcast_snooping_port
740 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
745 ofproto_set_n_dpdk_rxqs(int n_rxqs)
747 n_dpdk_rxqs = MAX(n_rxqs, 0);
751 ofproto_set_cpu_mask(const char *cmask)
755 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
759 ofproto_set_threads(int n_handlers_, int n_revalidators_)
761 int threads = MAX(count_cpu_cores(), 2);
763 n_revalidators = MAX(n_revalidators_, 0);
764 n_handlers = MAX(n_handlers_, 0);
766 if (!n_revalidators) {
767 n_revalidators = n_handlers
768 ? MAX(threads - (int) n_handlers, 1)
773 n_handlers = MAX(threads - (int) n_revalidators, 1);
778 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
781 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
785 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
787 return connmgr_set_snoops(ofproto->connmgr, snoops);
791 ofproto_set_netflow(struct ofproto *ofproto,
792 const struct netflow_options *nf_options)
794 if (nf_options && sset_is_empty(&nf_options->collectors)) {
798 if (ofproto->ofproto_class->set_netflow) {
799 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
801 return nf_options ? EOPNOTSUPP : 0;
806 ofproto_set_sflow(struct ofproto *ofproto,
807 const struct ofproto_sflow_options *oso)
809 if (oso && sset_is_empty(&oso->targets)) {
813 if (ofproto->ofproto_class->set_sflow) {
814 return ofproto->ofproto_class->set_sflow(ofproto, oso);
816 return oso ? EOPNOTSUPP : 0;
821 ofproto_set_ipfix(struct ofproto *ofproto,
822 const struct ofproto_ipfix_bridge_exporter_options *bo,
823 const struct ofproto_ipfix_flow_exporter_options *fo,
826 if (ofproto->ofproto_class->set_ipfix) {
827 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
829 return (bo || fo) ? EOPNOTSUPP : 0;
834 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
836 flow_restore_wait = flow_restore_wait_db;
840 ofproto_get_flow_restore_wait(void)
842 return flow_restore_wait;
846 /* Spanning Tree Protocol (STP) configuration. */
848 /* Configures STP on 'ofproto' using the settings defined in 's'. If
849 * 's' is NULL, disables STP.
851 * Returns 0 if successful, otherwise a positive errno value. */
853 ofproto_set_stp(struct ofproto *ofproto,
854 const struct ofproto_stp_settings *s)
856 return (ofproto->ofproto_class->set_stp
857 ? ofproto->ofproto_class->set_stp(ofproto, s)
861 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
862 * 'enabled' member of 's' is false, then the other members are not
865 * Returns 0 if successful, otherwise a positive errno value. */
867 ofproto_get_stp_status(struct ofproto *ofproto,
868 struct ofproto_stp_status *s)
870 return (ofproto->ofproto_class->get_stp_status
871 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
875 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
876 * in 's'. The caller is responsible for assigning STP port numbers
877 * (using the 'port_num' member in the range of 1 through 255, inclusive)
878 * and ensuring there are no duplicates. If the 's' is NULL, then STP
879 * is disabled on the port.
881 * Returns 0 if successful, otherwise a positive errno value.*/
883 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
884 const struct ofproto_port_stp_settings *s)
886 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
888 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
889 ofproto->name, ofp_port);
893 return (ofproto->ofproto_class->set_stp_port
894 ? ofproto->ofproto_class->set_stp_port(ofport, s)
898 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
899 * 's'. If the 'enabled' member in 's' is false, then the other members
900 * are not meaningful.
902 * Returns 0 if successful, otherwise a positive errno value.*/
904 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
905 struct ofproto_port_stp_status *s)
907 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
909 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
910 "port %"PRIu16, ofproto->name, ofp_port);
914 return (ofproto->ofproto_class->get_stp_port_status
915 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
919 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
920 * 's'. If the 'enabled' member in 's' is false, then the other members
921 * are not meaningful.
923 * Returns 0 if successful, otherwise a positive errno value.*/
925 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
926 struct ofproto_port_stp_stats *s)
928 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
930 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
931 "port %"PRIu16, ofproto->name, ofp_port);
935 return (ofproto->ofproto_class->get_stp_port_stats
936 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
940 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
942 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
943 * 's' is NULL, disables RSTP.
945 * Returns 0 if successful, otherwise a positive errno value. */
947 ofproto_set_rstp(struct ofproto *ofproto,
948 const struct ofproto_rstp_settings *s)
950 if (!ofproto->ofproto_class->set_rstp) {
953 ofproto->ofproto_class->set_rstp(ofproto, s);
957 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
958 * 'enabled' member of 's' is false, then the other members are not
961 * Returns 0 if successful, otherwise a positive errno value. */
963 ofproto_get_rstp_status(struct ofproto *ofproto,
964 struct ofproto_rstp_status *s)
966 if (!ofproto->ofproto_class->get_rstp_status) {
969 ofproto->ofproto_class->get_rstp_status(ofproto, s);
973 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
974 * in 's'. The caller is responsible for assigning RSTP port numbers
975 * (using the 'port_num' member in the range of 1 through 255, inclusive)
976 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
977 * is disabled on the port.
979 * Returns 0 if successful, otherwise a positive errno value.*/
981 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
982 const struct ofproto_port_rstp_settings *s)
984 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
986 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
987 ofproto->name, ofp_port);
991 if (!ofproto->ofproto_class->set_rstp_port) {
994 ofproto->ofproto_class->set_rstp_port(ofport, s);
998 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
999 * 's'. If the 'enabled' member in 's' is false, then the other members
1000 * are not meaningful.
1002 * Returns 0 if successful, otherwise a positive errno value.*/
1004 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1005 struct ofproto_port_rstp_status *s)
1007 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1009 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1010 "port %"PRIu16, ofproto->name, ofp_port);
1014 if (!ofproto->ofproto_class->get_rstp_port_status) {
1017 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1021 /* Queue DSCP configuration. */
1023 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1024 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1025 * to implement QoS. Instead, it is used to implement features which require
1026 * knowledge of what queues exist on a port, and some basic information about
1029 * Returns 0 if successful, otherwise a positive errno value. */
1031 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1032 const struct ofproto_port_queue *queues,
1035 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1038 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1039 ofproto->name, ofp_port);
1043 return (ofproto->ofproto_class->set_queues
1044 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1048 /* LLDP configuration. */
1050 ofproto_port_set_lldp(struct ofproto *ofproto,
1051 ofp_port_t ofp_port,
1052 const struct smap *cfg)
1054 struct ofport *ofport;
1057 ofport = ofproto_get_port(ofproto, ofp_port);
1059 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1060 ofproto->name, ofp_port);
1063 error = (ofproto->ofproto_class->set_lldp
1064 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1067 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1068 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1069 ovs_strerror(error));
1074 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1075 const struct aa_settings *s)
1077 if (!ofproto->ofproto_class->set_aa) {
1080 ofproto->ofproto_class->set_aa(ofproto, s);
1085 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1086 const struct aa_mapping_settings *s)
1088 if (!ofproto->ofproto_class->aa_mapping_set) {
1091 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1096 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1098 if (!ofproto->ofproto_class->aa_mapping_unset) {
1101 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1106 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1107 struct ovs_list *list)
1109 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1112 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1117 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1119 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1122 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1125 /* Connectivity Fault Management configuration. */
1127 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1129 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1131 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1132 if (ofport && ofproto->ofproto_class->set_cfm) {
1133 ofproto->ofproto_class->set_cfm(ofport, NULL);
1137 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1138 * basic configuration from the configuration members in 'cfm', and the remote
1139 * maintenance point ID from remote_mpid. Ignores the statistics members of
1142 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1144 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1145 const struct cfm_settings *s)
1147 struct ofport *ofport;
1150 ofport = ofproto_get_port(ofproto, ofp_port);
1152 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1153 ofproto->name, ofp_port);
1157 /* XXX: For configuration simplicity, we only support one remote_mpid
1158 * outside of the CFM module. It's not clear if this is the correct long
1159 * term solution or not. */
1160 error = (ofproto->ofproto_class->set_cfm
1161 ? ofproto->ofproto_class->set_cfm(ofport, s)
1164 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1165 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1166 ovs_strerror(error));
1170 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1171 * 'ofproto' does not have a port 'ofp_port'. */
1173 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1174 const struct smap *cfg)
1176 struct ofport *ofport;
1179 ofport = ofproto_get_port(ofproto, ofp_port);
1181 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1182 ofproto->name, ofp_port);
1186 error = (ofproto->ofproto_class->set_bfd
1187 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1190 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1191 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1192 ovs_strerror(error));
1196 /* Checks the status change of BFD on 'ofport'.
1198 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1200 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1202 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1203 return (ofport && ofproto->ofproto_class->bfd_status_changed
1204 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1208 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1209 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1210 * is not an OpenFlow port in 'ofproto'.
1212 * The caller must provide and own '*status'. */
1214 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1215 struct smap *status)
1217 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1218 return (ofport && ofproto->ofproto_class->get_bfd_status
1219 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1223 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1224 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1225 * 0 if LACP partner information is not current (generally indicating a
1226 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1228 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1230 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1231 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1232 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1237 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1239 struct ofproto *ofproto = port->ofproto;
1242 if (ofproto->ofproto_class->port_get_lacp_stats) {
1243 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1253 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1254 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1255 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1256 * configuration plus, if there is more than one slave, a bonding
1259 * If 'aux' is already registered then this function updates its configuration
1260 * to 's'. Otherwise, this function registers a new bundle.
1262 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1265 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1266 const struct ofproto_bundle_settings *s)
1268 return (ofproto->ofproto_class->bundle_set
1269 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1273 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1274 * If no such bundle has been registered, this has no effect. */
1276 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1278 return ofproto_bundle_register(ofproto, aux, NULL);
1282 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1283 * If 'aux' is already registered then this function updates its configuration
1284 * to 's'. Otherwise, this function registers a new mirror. */
1286 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1287 const struct ofproto_mirror_settings *s)
1289 return (ofproto->ofproto_class->mirror_set
1290 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1294 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1295 * If no mirror has been registered, this has no effect. */
1297 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1299 return ofproto_mirror_register(ofproto, aux, NULL);
1302 /* Retrieves statistics from mirror associated with client data pointer
1303 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1304 * 'bytes', respectively. If a particular counters is not supported,
1305 * the appropriate argument is set to UINT64_MAX.
1308 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1309 uint64_t *packets, uint64_t *bytes)
1311 if (!ofproto->ofproto_class->mirror_get_stats) {
1312 *packets = *bytes = UINT64_MAX;
1316 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1320 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1321 * which all packets are flooded, instead of using MAC learning. If
1322 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1324 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1327 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1329 return (ofproto->ofproto_class->set_flood_vlans
1330 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1334 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1335 * output for a mirror. */
1337 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1339 return (ofproto->ofproto_class->is_mirror_output_bundle
1340 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1344 /* Configuration of OpenFlow tables. */
1346 /* Returns the number of OpenFlow tables in 'ofproto'. */
1348 ofproto_get_n_tables(const struct ofproto *ofproto)
1350 return ofproto->n_tables;
1353 /* Returns the number of Controller visible OpenFlow tables
1354 * in 'ofproto'. This number will exclude Hidden tables.
1355 * This funtion's return value should be less or equal to that of
1356 * ofproto_get_n_tables() . */
1358 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1360 uint8_t n = ofproto->n_tables;
1362 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1363 * if present, are always at the end.) */
1364 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1371 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1372 * settings from 's'. 'table_id' must be in the range 0 through the number of
1373 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1375 * For read-only tables, only the name may be configured. */
1377 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1378 const struct ofproto_table_settings *s)
1380 struct oftable *table;
1382 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1383 table = &ofproto->tables[table_id];
1385 oftable_set_name(table, s->name);
1387 if (table->flags & OFTABLE_READONLY) {
1392 oftable_enable_eviction(table, s->groups, s->n_groups);
1394 oftable_disable_eviction(table);
1397 table->max_flows = s->max_flows;
1399 if (classifier_set_prefix_fields(&table->cls,
1400 s->prefix_fields, s->n_prefix_fields)) {
1401 /* XXX: Trigger revalidation. */
1404 ovs_mutex_lock(&ofproto_mutex);
1405 evict_rules_from_table(table, 0);
1406 ovs_mutex_unlock(&ofproto_mutex);
1410 ofproto_has_snoops(const struct ofproto *ofproto)
1412 return connmgr_has_snoops(ofproto->connmgr);
1416 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1418 connmgr_get_snoops(ofproto->connmgr, snoops);
1421 /* Deletes 'rule' from 'ofproto'.
1423 * Within an ofproto implementation, this function allows an ofproto
1424 * implementation to destroy any rules that remain when its ->destruct()
1425 * function is called. This function is not suitable for use elsewhere in an
1426 * ofproto implementation.
1428 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1429 * Cycle" in ofproto-provider.h. */
1431 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1432 OVS_EXCLUDED(ofproto_mutex)
1434 /* This skips the ofmonitor and flow-removed notifications because the
1435 * switch is being deleted and any OpenFlow channels have been or soon will
1437 ovs_mutex_lock(&ofproto_mutex);
1438 oftable_remove_rule(rule);
1439 ofproto->ofproto_class->rule_delete(rule);
1440 ovs_mutex_unlock(&ofproto_mutex);
1444 ofproto_flush__(struct ofproto *ofproto)
1445 OVS_EXCLUDED(ofproto_mutex)
1447 struct oftable *table;
1449 /* This will flush all datapath flows. */
1450 if (ofproto->ofproto_class->flush) {
1451 ofproto->ofproto_class->flush(ofproto);
1454 /* XXX: There is a small race window here, where new datapath flows can be
1455 * created by upcall handlers based on the existing flow table. We can not
1456 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1457 * as then we could deadlock on syncing with the handler threads waiting on
1458 * the same mutex. */
1460 ovs_mutex_lock(&ofproto_mutex);
1461 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1462 struct rule_collection rules;
1465 if (table->flags & OFTABLE_HIDDEN) {
1469 rule_collection_init(&rules);
1471 CLS_FOR_EACH (rule, cr, &table->cls) {
1472 rule_collection_add(&rules, rule);
1474 delete_flows__(&rules, OFPRR_DELETE, NULL);
1475 rule_collection_destroy(&rules);
1477 /* XXX: Concurrent handler threads may insert new learned flows based on
1478 * learn actions of the now deleted flows right after we release
1479 * 'ofproto_mutex'. */
1480 ovs_mutex_unlock(&ofproto_mutex);
1483 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1486 ofproto_destroy__(struct ofproto *ofproto)
1487 OVS_EXCLUDED(ofproto_mutex)
1489 struct oftable *table;
1491 destroy_rule_executes(ofproto);
1492 delete_group(ofproto, OFPG_ALL);
1494 guarded_list_destroy(&ofproto->rule_executes);
1495 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1496 hmap_destroy(&ofproto->groups);
1498 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1499 free(ofproto->name);
1500 free(ofproto->type);
1501 free(ofproto->mfr_desc);
1502 free(ofproto->hw_desc);
1503 free(ofproto->sw_desc);
1504 free(ofproto->serial_desc);
1505 free(ofproto->dp_desc);
1506 hmap_destroy(&ofproto->ports);
1507 hmap_destroy(&ofproto->ofport_usage);
1508 shash_destroy(&ofproto->port_by_name);
1509 simap_destroy(&ofproto->ofp_requests);
1511 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1512 oftable_destroy(table);
1514 free(ofproto->tables);
1516 ovs_assert(hindex_is_empty(&ofproto->cookies));
1517 hindex_destroy(&ofproto->cookies);
1519 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1520 hmap_destroy(&ofproto->learned_cookies);
1522 free(ofproto->vlan_bitmap);
1524 ofproto->ofproto_class->dealloc(ofproto);
1528 ofproto_destroy(struct ofproto *p)
1529 OVS_EXCLUDED(ofproto_mutex)
1531 struct ofport *ofport, *next_ofport;
1532 struct ofport_usage *usage, *next_usage;
1539 meter_delete(p, 1, p->meter_features.max_meters);
1540 p->meter_features.max_meters = 0;
1546 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1547 ofport_destroy(ofport);
1550 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1551 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1555 p->ofproto_class->destruct(p);
1557 /* We should not postpone this because it involves deleting a listening
1558 * socket which we may want to reopen soon. 'connmgr' should not be used
1559 * by other threads */
1560 connmgr_destroy(p->connmgr);
1562 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1563 ovsrcu_postpone(ofproto_destroy__, p);
1566 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1567 * kernel datapath, for example, this destroys the datapath in the kernel, and
1568 * with the netdev-based datapath, it tears down the data structures that
1569 * represent the datapath.
1571 * The datapath should not be currently open as an ofproto. */
1573 ofproto_delete(const char *name, const char *type)
1575 const struct ofproto_class *class = ofproto_class_find__(type);
1576 return (!class ? EAFNOSUPPORT
1577 : !class->del ? EACCES
1578 : class->del(type, name));
1582 process_port_change(struct ofproto *ofproto, int error, char *devname)
1584 if (error == ENOBUFS) {
1585 reinit_ports(ofproto);
1586 } else if (!error) {
1587 update_port(ofproto, devname);
1593 ofproto_type_run(const char *datapath_type)
1595 const struct ofproto_class *class;
1598 datapath_type = ofproto_normalize_type(datapath_type);
1599 class = ofproto_class_find__(datapath_type);
1601 error = class->type_run ? class->type_run(datapath_type) : 0;
1602 if (error && error != EAGAIN) {
1603 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1604 datapath_type, ovs_strerror(error));
1610 ofproto_type_wait(const char *datapath_type)
1612 const struct ofproto_class *class;
1614 datapath_type = ofproto_normalize_type(datapath_type);
1615 class = ofproto_class_find__(datapath_type);
1617 if (class->type_wait) {
1618 class->type_wait(datapath_type);
1623 ofproto_run(struct ofproto *p)
1628 error = p->ofproto_class->run(p);
1629 if (error && error != EAGAIN) {
1630 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1633 run_rule_executes(p);
1635 /* Restore the eviction group heap invariant occasionally. */
1636 if (p->eviction_group_timer < time_msec()) {
1639 p->eviction_group_timer = time_msec() + 1000;
1641 for (i = 0; i < p->n_tables; i++) {
1642 struct oftable *table = &p->tables[i];
1643 struct eviction_group *evg;
1646 if (!table->eviction_fields) {
1650 if (classifier_count(&table->cls) > 100000) {
1651 static struct vlog_rate_limit count_rl =
1652 VLOG_RATE_LIMIT_INIT(1, 1);
1653 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1654 " number of rules: %d", i,
1655 classifier_count(&table->cls));
1658 ovs_mutex_lock(&ofproto_mutex);
1659 CLS_FOR_EACH (rule, cr, &table->cls) {
1660 if (rule->idle_timeout || rule->hard_timeout) {
1661 if (!rule->eviction_group) {
1662 eviction_group_add_rule(rule);
1664 heap_raw_change(&rule->evg_node,
1665 rule_eviction_priority(p, rule));
1670 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1671 heap_rebuild(&evg->rules);
1673 ovs_mutex_unlock(&ofproto_mutex);
1677 if (p->ofproto_class->port_poll) {
1680 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1681 process_port_change(p, error, devname);
1685 new_seq = seq_read(connectivity_seq_get());
1686 if (new_seq != p->change_seq) {
1687 struct sset devnames;
1688 const char *devname;
1689 struct ofport *ofport;
1691 /* Update OpenFlow port status for any port whose netdev has changed.
1693 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1694 * destroyed, so it's not safe to update ports directly from the
1695 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1696 * need this two-phase approach. */
1697 sset_init(&devnames);
1698 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1699 uint64_t port_change_seq;
1701 port_change_seq = netdev_get_change_seq(ofport->netdev);
1702 if (ofport->change_seq != port_change_seq) {
1703 ofport->change_seq = port_change_seq;
1704 sset_add(&devnames, netdev_get_name(ofport->netdev));
1707 SSET_FOR_EACH (devname, &devnames) {
1708 update_port(p, devname);
1710 sset_destroy(&devnames);
1712 p->change_seq = new_seq;
1715 connmgr_run(p->connmgr, handle_openflow);
1721 ofproto_wait(struct ofproto *p)
1723 p->ofproto_class->wait(p);
1724 if (p->ofproto_class->port_poll_wait) {
1725 p->ofproto_class->port_poll_wait(p);
1727 seq_wait(connectivity_seq_get(), p->change_seq);
1728 connmgr_wait(p->connmgr);
1732 ofproto_is_alive(const struct ofproto *p)
1734 return connmgr_has_controllers(p->connmgr);
1737 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1738 * memory_report(). */
1740 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1742 const struct oftable *table;
1743 unsigned int n_rules;
1745 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1748 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1749 n_rules += classifier_count(&table->cls);
1751 simap_increase(usage, "rules", n_rules);
1753 if (ofproto->ofproto_class->get_memory_usage) {
1754 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1757 connmgr_get_memory_usage(ofproto->connmgr, usage);
1761 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1763 const struct ofproto_class *class;
1765 datapath_type = ofproto_normalize_type(datapath_type);
1766 class = ofproto_class_find__(datapath_type);
1768 if (class && class->type_get_memory_usage) {
1769 class->type_get_memory_usage(datapath_type, usage);
1774 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1777 connmgr_get_controller_info(ofproto->connmgr, info);
1781 ofproto_free_ofproto_controller_info(struct shash *info)
1783 connmgr_free_controller_info(info);
1786 /* Makes a deep copy of 'old' into 'port'. */
1788 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1790 port->name = xstrdup(old->name);
1791 port->type = xstrdup(old->type);
1792 port->ofp_port = old->ofp_port;
1795 /* Frees memory allocated to members of 'ofproto_port'.
1797 * Do not call this function on an ofproto_port obtained from
1798 * ofproto_port_dump_next(): that function retains ownership of the data in the
1801 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1803 free(ofproto_port->name);
1804 free(ofproto_port->type);
1807 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1809 * This function provides no status indication. An error status for the entire
1810 * dump operation is provided when it is completed by calling
1811 * ofproto_port_dump_done().
1814 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1815 const struct ofproto *ofproto)
1817 dump->ofproto = ofproto;
1818 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1822 /* Attempts to retrieve another port from 'dump', which must have been created
1823 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1824 * 'port' and returns true. On failure, returns false.
1826 * Failure might indicate an actual error or merely that the last port has been
1827 * dumped. An error status for the entire dump operation is provided when it
1828 * is completed by calling ofproto_port_dump_done().
1830 * The ofproto owns the data stored in 'port'. It will remain valid until at
1831 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1832 * ofproto_port_dump_done(). */
1834 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1835 struct ofproto_port *port)
1837 const struct ofproto *ofproto = dump->ofproto;
1843 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1846 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1852 /* Completes port table dump operation 'dump', which must have been created
1853 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1854 * error-free, otherwise a positive errno value describing the problem. */
1856 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1858 const struct ofproto *ofproto = dump->ofproto;
1860 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1863 return dump->error == EOF ? 0 : dump->error;
1866 /* Returns the type to pass to netdev_open() when a datapath of type
1867 * 'datapath_type' has a port of type 'port_type', for a few special
1868 * cases when a netdev type differs from a port type. For example, when
1869 * using the userspace datapath, a port of type "internal" needs to be
1872 * Returns either 'type' itself or a string literal, which must not be
1875 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1877 const struct ofproto_class *class;
1879 datapath_type = ofproto_normalize_type(datapath_type);
1880 class = ofproto_class_find__(datapath_type);
1885 return (class->port_open_type
1886 ? class->port_open_type(datapath_type, port_type)
1890 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1891 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1892 * the port's OpenFlow port number.
1894 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1895 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1896 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1897 * 'ofp_portp' is non-null). */
1899 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1900 ofp_port_t *ofp_portp)
1902 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1905 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1907 const char *netdev_name = netdev_get_name(netdev);
1909 simap_put(&ofproto->ofp_requests, netdev_name,
1910 ofp_to_u16(ofp_port));
1911 update_port(ofproto, netdev_name);
1914 *ofp_portp = OFPP_NONE;
1916 struct ofproto_port ofproto_port;
1918 error = ofproto_port_query_by_name(ofproto,
1919 netdev_get_name(netdev),
1922 *ofp_portp = ofproto_port.ofp_port;
1923 ofproto_port_destroy(&ofproto_port);
1930 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1931 * initializes '*port' appropriately; on failure, returns a positive errno
1934 * The caller owns the data in 'ofproto_port' and must free it with
1935 * ofproto_port_destroy() when it is no longer needed. */
1937 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1938 struct ofproto_port *port)
1942 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1944 memset(port, 0, sizeof *port);
1949 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1950 * Returns 0 if successful, otherwise a positive errno. */
1952 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1954 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1955 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1956 struct simap_node *ofp_request_node;
1959 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1960 if (ofp_request_node) {
1961 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1964 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1965 if (!error && ofport) {
1966 /* 'name' is the netdev's name and update_port() is going to close the
1967 * netdev. Just in case update_port() refers to 'name' after it
1968 * destroys 'ofport', make a copy of it around the update_port()
1970 char *devname = xstrdup(name);
1971 update_port(ofproto, devname);
1978 flow_mod_init(struct ofputil_flow_mod *fm,
1979 const struct match *match, int priority,
1980 const struct ofpact *ofpacts, size_t ofpacts_len,
1981 enum ofp_flow_mod_command command)
1983 memset(fm, 0, sizeof *fm);
1985 fm->priority = priority;
1988 fm->modify_cookie = false;
1990 fm->command = command;
1991 fm->idle_timeout = 0;
1992 fm->hard_timeout = 0;
1994 fm->buffer_id = UINT32_MAX;
1995 fm->out_port = OFPP_ANY;
1996 fm->out_group = OFPG_ANY;
1998 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1999 fm->ofpacts_len = ofpacts_len;
2000 fm->delete_reason = OFPRR_DELETE;
2004 simple_flow_mod(struct ofproto *ofproto,
2005 const struct match *match, int priority,
2006 const struct ofpact *ofpacts, size_t ofpacts_len,
2007 enum ofp_flow_mod_command command)
2009 struct ofputil_flow_mod fm;
2011 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2013 return handle_flow_mod__(ofproto, &fm, NULL);
2016 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2017 * performs the 'n_actions' actions in 'actions'. The new flow will not
2020 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2021 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2022 * controllers; otherwise, it will be hidden.
2024 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2026 * This is a helper function for in-band control and fail-open. */
2028 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2030 const struct ofpact *ofpacts, size_t ofpacts_len)
2031 OVS_EXCLUDED(ofproto_mutex)
2033 const struct rule *rule;
2036 /* First do a cheap check whether the rule we're looking for already exists
2037 * with the actions that we want. If it does, then we're done. */
2038 rule = rule_from_cls_rule(classifier_find_match_exactly(
2039 &ofproto->tables[0].cls, match, priority));
2041 const struct rule_actions *actions = rule_get_actions(rule);
2042 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2043 ofpacts, ofpacts_len);
2048 /* If there's no such rule or the rule doesn't have the actions we want,
2049 * fall back to a executing a full flow mod. We can't optimize this at
2050 * all because we didn't take enough locks above to ensure that the flow
2051 * table didn't already change beneath us. */
2053 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2054 OFPFC_MODIFY_STRICT);
2058 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2059 * an OFPERR_* OpenFlow error code on failure.
2061 * This is a helper function for in-band control and fail-open and the "learn"
2064 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2065 OVS_EXCLUDED(ofproto_mutex)
2067 /* Optimize for the most common case of a repeated learn action.
2068 * If an identical flow already exists we only need to update its
2069 * 'modified' time. */
2070 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2071 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2072 struct oftable *table = &ofproto->tables[fm->table_id];
2076 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
2080 /* Reading many of the rule fields and writing on 'modified'
2081 * requires the rule->mutex. Also, rule->actions may change
2082 * if rule->mutex is not held. */
2083 const struct rule_actions *actions;
2085 ovs_mutex_lock(&rule->mutex);
2086 actions = rule_get_actions(rule);
2087 if (rule->idle_timeout == fm->idle_timeout
2088 && rule->hard_timeout == fm->hard_timeout
2089 && rule->importance == fm->importance
2090 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2091 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2092 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2093 actions->ofpacts, actions->ofpacts_len)) {
2094 /* Rule already exists and need not change, only update the
2095 modified timestamp. */
2096 rule->modified = time_msec();
2099 ovs_mutex_unlock(&rule->mutex);
2107 return handle_flow_mod__(ofproto, fm, NULL);
2110 /* Searches for a rule with matching criteria exactly equal to 'target' in
2111 * ofproto's table 0 and, if it finds one, deletes it.
2113 * This is a helper function for in-band control and fail-open. */
2115 ofproto_delete_flow(struct ofproto *ofproto,
2116 const struct match *target, int priority)
2117 OVS_EXCLUDED(ofproto_mutex)
2119 struct classifier *cls = &ofproto->tables[0].cls;
2122 /* First do a cheap check whether the rule we're looking for has already
2123 * been deleted. If so, then we're done. */
2124 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2130 /* Execute a flow mod. We can't optimize this at all because we didn't
2131 * take enough locks above to ensure that the flow table didn't already
2132 * change beneath us. */
2133 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2136 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2137 * the flows required by in-band control and fail-open. */
2139 ofproto_flush_flows(struct ofproto *ofproto)
2141 COVERAGE_INC(ofproto_flush);
2142 ofproto_flush__(ofproto);
2143 connmgr_flushed(ofproto->connmgr);
2147 reinit_ports(struct ofproto *p)
2149 struct ofproto_port_dump dump;
2150 struct sset devnames;
2151 struct ofport *ofport;
2152 struct ofproto_port ofproto_port;
2153 const char *devname;
2155 COVERAGE_INC(ofproto_reinit_ports);
2157 sset_init(&devnames);
2158 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2159 sset_add(&devnames, netdev_get_name(ofport->netdev));
2161 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2162 sset_add(&devnames, ofproto_port.name);
2165 SSET_FOR_EACH (devname, &devnames) {
2166 update_port(p, devname);
2168 sset_destroy(&devnames);
2172 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2176 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2177 port_idx = port_idx ? port_idx : UINT16_MAX;
2179 if (port_idx >= ofproto->max_ports
2180 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2181 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2182 long long int last_used_at, lru = LLONG_MAX;
2184 /* Search for a free OpenFlow port number. We try not to
2185 * immediately reuse them to prevent problems due to old
2188 * We limit the automatically assigned port numbers to the lower half
2189 * of the port range, to reserve the upper half for assignment by
2192 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2193 ofproto->alloc_port_no = 1;
2195 last_used_at = ofport_get_usage(ofproto,
2196 u16_to_ofp(ofproto->alloc_port_no));
2197 if (!last_used_at) {
2198 port_idx = ofproto->alloc_port_no;
2200 } else if ( last_used_at < time_msec() - 60*60*1000) {
2201 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2202 * more than an hour ago, consider it usable. */
2203 ofport_remove_usage(ofproto,
2204 u16_to_ofp(ofproto->alloc_port_no));
2205 port_idx = ofproto->alloc_port_no;
2207 } else if (last_used_at < lru) {
2209 lru_ofport = ofproto->alloc_port_no;
2212 if (ofproto->alloc_port_no == end_port_no) {
2214 port_idx = lru_ofport;
2221 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2222 return u16_to_ofp(port_idx);
2226 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2228 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2229 ofport_set_usage(ofproto, ofp_port, time_msec());
2233 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2234 * pointer if the netdev cannot be opened. On success, also fills in
2236 static struct netdev *
2237 ofport_open(struct ofproto *ofproto,
2238 struct ofproto_port *ofproto_port,
2239 struct ofputil_phy_port *pp)
2241 enum netdev_flags flags;
2242 struct netdev *netdev;
2245 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2247 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2248 "cannot be opened (%s)",
2250 ofproto_port->name, ofproto_port->ofp_port,
2251 ofproto_port->name, ovs_strerror(error));
2255 if (ofproto_port->ofp_port == OFPP_NONE) {
2256 if (!strcmp(ofproto->name, ofproto_port->name)) {
2257 ofproto_port->ofp_port = OFPP_LOCAL;
2259 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2260 ofproto_port->name);
2263 pp->port_no = ofproto_port->ofp_port;
2264 netdev_get_etheraddr(netdev, pp->hw_addr);
2265 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2266 netdev_get_flags(netdev, &flags);
2267 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2268 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2269 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2270 &pp->supported, &pp->peer);
2271 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2272 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2277 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2278 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2281 ofport_equal(const struct ofputil_phy_port *a,
2282 const struct ofputil_phy_port *b)
2284 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2285 && a->state == b->state
2286 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2287 && a->curr == b->curr
2288 && a->advertised == b->advertised
2289 && a->supported == b->supported
2290 && a->peer == b->peer
2291 && a->curr_speed == b->curr_speed
2292 && a->max_speed == b->max_speed);
2295 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2296 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2297 * one with the same name or port number). */
2299 ofport_install(struct ofproto *p,
2300 struct netdev *netdev, const struct ofputil_phy_port *pp)
2302 const char *netdev_name = netdev_get_name(netdev);
2303 struct ofport *ofport;
2306 /* Create ofport. */
2307 ofport = p->ofproto_class->port_alloc();
2312 ofport->ofproto = p;
2313 ofport->netdev = netdev;
2314 ofport->change_seq = netdev_get_change_seq(netdev);
2316 ofport->ofp_port = pp->port_no;
2317 ofport->created = time_msec();
2319 /* Add port to 'p'. */
2320 hmap_insert(&p->ports, &ofport->hmap_node,
2321 hash_ofp_port(ofport->ofp_port));
2322 shash_add(&p->port_by_name, netdev_name, ofport);
2324 update_mtu(p, ofport);
2326 /* Let the ofproto_class initialize its private data. */
2327 error = p->ofproto_class->port_construct(ofport);
2331 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2335 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2336 p->name, netdev_name, ovs_strerror(error));
2338 ofport_destroy__(ofport);
2340 netdev_close(netdev);
2344 /* Removes 'ofport' from 'p' and destroys it. */
2346 ofport_remove(struct ofport *ofport)
2348 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2350 ofport_destroy(ofport);
2353 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2356 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2358 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2360 ofport_remove(port);
2364 /* Updates 'port' with new 'pp' description.
2366 * Does not handle a name or port number change. The caller must implement
2367 * such a change as a delete followed by an add. */
2369 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2371 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2372 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2373 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2374 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2375 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2376 port->pp.curr = pp->curr;
2377 port->pp.advertised = pp->advertised;
2378 port->pp.supported = pp->supported;
2379 port->pp.peer = pp->peer;
2380 port->pp.curr_speed = pp->curr_speed;
2381 port->pp.max_speed = pp->max_speed;
2383 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2384 &port->pp, OFPPR_MODIFY);
2387 /* Update OpenFlow 'state' in 'port' and notify controller. */
2389 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2391 if (port->pp.state != state) {
2392 port->pp.state = state;
2393 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2394 &port->pp, OFPPR_MODIFY);
2399 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2401 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2403 if (port->ofproto->ofproto_class->set_realdev) {
2404 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2406 if (port->ofproto->ofproto_class->set_stp_port) {
2407 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2409 if (port->ofproto->ofproto_class->set_rstp_port) {
2410 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2412 if (port->ofproto->ofproto_class->set_cfm) {
2413 port->ofproto->ofproto_class->set_cfm(port, NULL);
2415 if (port->ofproto->ofproto_class->bundle_remove) {
2416 port->ofproto->ofproto_class->bundle_remove(port);
2422 ofport_destroy__(struct ofport *port)
2424 struct ofproto *ofproto = port->ofproto;
2425 const char *name = netdev_get_name(port->netdev);
2427 hmap_remove(&ofproto->ports, &port->hmap_node);
2428 shash_delete(&ofproto->port_by_name,
2429 shash_find(&ofproto->port_by_name, name));
2431 netdev_close(port->netdev);
2432 ofproto->ofproto_class->port_dealloc(port);
2436 ofport_destroy(struct ofport *port)
2439 dealloc_ofp_port(port->ofproto, port->ofp_port);
2440 port->ofproto->ofproto_class->port_destruct(port);
2441 ofport_destroy__(port);
2446 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2448 struct ofport *port;
2450 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2452 if (port->ofp_port == ofp_port) {
2459 static long long int
2460 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2462 struct ofport_usage *usage;
2464 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2465 &ofproto->ofport_usage) {
2466 if (usage->ofp_port == ofp_port) {
2467 return usage->last_used;
2474 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2475 long long int last_used)
2477 struct ofport_usage *usage;
2478 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2479 &ofproto->ofport_usage) {
2480 if (usage->ofp_port == ofp_port) {
2481 usage->last_used = last_used;
2485 ovs_assert(last_used == LLONG_MAX);
2487 usage = xmalloc(sizeof *usage);
2488 usage->ofp_port = ofp_port;
2489 usage->last_used = last_used;
2490 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2491 hash_ofp_port(ofp_port));
2495 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2497 struct ofport_usage *usage;
2498 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2499 &ofproto->ofport_usage) {
2500 if (usage->ofp_port == ofp_port) {
2501 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2509 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2511 struct ofproto *ofproto = port->ofproto;
2514 if (ofproto->ofproto_class->port_get_stats) {
2515 error = ofproto->ofproto_class->port_get_stats(port, stats);
2524 update_port(struct ofproto *ofproto, const char *name)
2526 struct ofproto_port ofproto_port;
2527 struct ofputil_phy_port pp;
2528 struct netdev *netdev;
2529 struct ofport *port;
2531 COVERAGE_INC(ofproto_update_port);
2533 /* Fetch 'name''s location and properties from the datapath. */
2534 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2535 ? ofport_open(ofproto, &ofproto_port, &pp)
2539 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2540 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2541 struct netdev *old_netdev = port->netdev;
2543 /* 'name' hasn't changed location. Any properties changed? */
2544 if (!ofport_equal(&port->pp, &pp)) {
2545 ofport_modified(port, &pp);
2548 update_mtu(ofproto, port);
2550 /* Install the newly opened netdev in case it has changed.
2551 * Don't close the old netdev yet in case port_modified has to
2552 * remove a retained reference to it.*/
2553 port->netdev = netdev;
2554 port->change_seq = netdev_get_change_seq(netdev);
2556 if (port->ofproto->ofproto_class->port_modified) {
2557 port->ofproto->ofproto_class->port_modified(port);
2560 netdev_close(old_netdev);
2562 /* If 'port' is nonnull then its name differs from 'name' and thus
2563 * we should delete it. If we think there's a port named 'name'
2564 * then its port number must be wrong now so delete it too. */
2566 ofport_remove(port);
2568 ofport_remove_with_name(ofproto, name);
2569 ofport_install(ofproto, netdev, &pp);
2572 /* Any port named 'name' is gone now. */
2573 ofport_remove_with_name(ofproto, name);
2575 ofproto_port_destroy(&ofproto_port);
2579 init_ports(struct ofproto *p)
2581 struct ofproto_port_dump dump;
2582 struct ofproto_port ofproto_port;
2583 struct shash_node *node, *next;
2585 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2586 const char *name = ofproto_port.name;
2588 if (shash_find(&p->port_by_name, name)) {
2589 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2592 struct ofputil_phy_port pp;
2593 struct netdev *netdev;
2595 /* Check if an OpenFlow port number had been requested. */
2596 node = shash_find(&init_ofp_ports, name);
2598 const struct iface_hint *iface_hint = node->data;
2599 simap_put(&p->ofp_requests, name,
2600 ofp_to_u16(iface_hint->ofp_port));
2603 netdev = ofport_open(p, &ofproto_port, &pp);
2605 ofport_install(p, netdev, &pp);
2606 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2607 p->alloc_port_no = MAX(p->alloc_port_no,
2608 ofp_to_u16(ofproto_port.ofp_port));
2614 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2615 struct iface_hint *iface_hint = node->data;
2617 if (!strcmp(iface_hint->br_name, p->name)) {
2618 free(iface_hint->br_name);
2619 free(iface_hint->br_type);
2621 shash_delete(&init_ofp_ports, node);
2628 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2629 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2631 find_min_mtu(struct ofproto *p)
2633 struct ofport *ofport;
2636 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2637 struct netdev *netdev = ofport->netdev;
2640 /* Skip any internal ports, since that's what we're trying to
2642 if (!strcmp(netdev_get_type(netdev), "internal")) {
2646 if (netdev_get_mtu(netdev, &dev_mtu)) {
2649 if (!mtu || dev_mtu < mtu) {
2654 return mtu ? mtu: ETH_PAYLOAD_MAX;
2657 /* Update MTU of all datapath devices on 'p' to the minimum of the
2658 * non-datapath ports in event of 'port' added or changed. */
2660 update_mtu(struct ofproto *p, struct ofport *port)
2662 struct ofport *ofport;
2663 struct netdev *netdev = port->netdev;
2664 int dev_mtu, old_min;
2666 if (netdev_get_mtu(netdev, &dev_mtu)) {
2670 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2671 if (dev_mtu > p->min_mtu) {
2672 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2673 dev_mtu = p->min_mtu;
2676 port->mtu = dev_mtu;
2680 /* For non-internal port find new min mtu. */
2681 old_min = p->min_mtu;
2682 port->mtu = dev_mtu;
2683 p->min_mtu = find_min_mtu(p);
2684 if (p->min_mtu == old_min) {
2688 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2689 struct netdev *netdev = ofport->netdev;
2691 if (!strcmp(netdev_get_type(netdev), "internal")) {
2692 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2693 ofport->mtu = p->min_mtu;
2700 ofproto_rule_destroy__(struct rule *rule)
2701 OVS_NO_THREAD_SAFETY_ANALYSIS
2703 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2704 rule_actions_destroy(rule_get_actions(rule));
2705 ovs_mutex_destroy(&rule->mutex);
2706 rule->ofproto->ofproto_class->rule_dealloc(rule);
2709 /* Create a new rule based on attributes in 'fm', match in 'cr', and
2710 * 'table_id'. Note that the rule is NOT inserted into a any data structures
2711 * yet. Takes ownership of 'cr'. */
2713 ofproto_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
2714 struct cls_rule *cr, uint8_t table_id,
2715 struct rule **rulep)
2716 OVS_REQUIRES(ofproto_mutex)
2721 /* Allocate new rule. */
2722 rule = ofproto->ofproto_class->rule_alloc();
2724 cls_rule_destroy(cr);
2725 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
2726 return OFPERR_OFPFMFC_UNKNOWN;
2729 /* Initialize base state. */
2730 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
2731 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
2732 ovs_refcount_init(&rule->ref_count);
2733 rule->flow_cookie = fm->new_cookie;
2734 rule->created = rule->modified = time_msec();
2736 ovs_mutex_init(&rule->mutex);
2737 ovs_mutex_lock(&rule->mutex);
2738 rule->idle_timeout = fm->idle_timeout;
2739 rule->hard_timeout = fm->hard_timeout;
2740 rule->importance = fm->importance;
2741 ovs_mutex_unlock(&rule->mutex);
2743 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
2744 rule->flags = fm->flags & OFPUTIL_FF_STATE;
2745 ovsrcu_set_hidden(&rule->actions,
2746 rule_actions_create(fm->ofpacts, fm->ofpacts_len));
2747 list_init(&rule->meter_list_node);
2748 rule->eviction_group = NULL;
2749 list_init(&rule->expirable);
2750 rule->monitor_flags = 0;
2751 rule->add_seqno = 0;
2752 rule->modify_seqno = 0;
2754 /* Construct rule, initializing derived state. */
2755 error = ofproto->ofproto_class->rule_construct(rule);
2757 ofproto_rule_destroy__(rule);
2766 rule_destroy_cb(struct rule *rule)
2768 rule->ofproto->ofproto_class->rule_destruct(rule);
2769 ofproto_rule_destroy__(rule);
2773 ofproto_rule_ref(struct rule *rule)
2776 ovs_refcount_ref(&rule->ref_count);
2781 ofproto_rule_try_ref(struct rule *rule)
2784 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2789 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2790 * ref_count reaches 0.
2792 * Use of RCU allows short term use (between RCU quiescent periods) without
2793 * keeping a reference. A reference must be taken if the rule needs to
2794 * stay around accross the RCU quiescent periods. */
2796 ofproto_rule_unref(struct rule *rule)
2798 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2799 ovsrcu_postpone(rule_destroy_cb, rule);
2804 ofproto_group_ref(struct ofgroup *group)
2807 ovs_refcount_ref(&group->ref_count);
2812 ofproto_group_unref(struct ofgroup *group)
2814 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2815 group->ofproto->ofproto_class->group_destruct(group);
2816 ofputil_bucket_list_destroy(&group->buckets);
2817 group->ofproto->ofproto_class->group_dealloc(group);
2821 static uint32_t get_provider_meter_id(const struct ofproto *,
2822 uint32_t of_meter_id);
2824 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2825 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2826 const struct rule_actions *
2827 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2829 struct rule_actions *actions;
2831 actions = xmalloc(sizeof *actions + ofpacts_len);
2832 actions->ofpacts_len = ofpacts_len;
2833 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2834 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2836 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2842 /* Free the actions after the RCU quiescent period is reached. */
2844 rule_actions_destroy(const struct rule_actions *actions)
2847 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2851 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2852 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2854 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2855 OVS_REQUIRES(ofproto_mutex)
2857 if (port == OFPP_ANY) {
2860 const struct rule_actions *actions = rule_get_actions(rule);
2861 return ofpacts_output_to_port(actions->ofpacts,
2862 actions->ofpacts_len, port);
2866 /* Returns true if 'rule' has group and equals group_id. */
2868 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2869 OVS_REQUIRES(ofproto_mutex)
2871 if (group_id == OFPG_ANY) {
2874 const struct rule_actions *actions = rule_get_actions(rule);
2875 return ofpacts_output_to_group(actions->ofpacts,
2876 actions->ofpacts_len, group_id);
2881 rule_execute_destroy(struct rule_execute *e)
2883 ofproto_rule_unref(e->rule);
2884 list_remove(&e->list_node);
2888 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2889 * by passing them to the ofproto provider. */
2891 run_rule_executes(struct ofproto *ofproto)
2892 OVS_EXCLUDED(ofproto_mutex)
2894 struct rule_execute *e, *next;
2895 struct ovs_list executes;
2897 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2898 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2901 flow_extract(e->packet, &flow);
2902 flow.in_port.ofp_port = e->in_port;
2903 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2905 rule_execute_destroy(e);
2909 /* Destroys and discards all "rule_execute" operations queued up in
2910 * ofproto->rule_executes. */
2912 destroy_rule_executes(struct ofproto *ofproto)
2914 struct rule_execute *e, *next;
2915 struct ovs_list executes;
2917 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2918 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2919 dp_packet_delete(e->packet);
2920 rule_execute_destroy(e);
2925 rule_is_readonly(const struct rule *rule)
2927 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2928 return (table->flags & OFTABLE_READONLY) != 0;
2932 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2934 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2935 return hash_3words(cookie, cookie >> 32, table_id);
2939 learned_cookies_update_one__(struct ofproto *ofproto,
2940 const struct ofpact_learn *learn,
2941 int delta, struct ovs_list *dead_cookies)
2942 OVS_REQUIRES(ofproto_mutex)
2944 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
2945 struct learned_cookie *c;
2947 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
2948 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
2950 ovs_assert(c->n >= 0);
2953 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
2954 list_push_back(dead_cookies, &c->u.list_node);
2961 ovs_assert(delta > 0);
2962 c = xmalloc(sizeof *c);
2963 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
2964 c->cookie = learn->cookie;
2965 c->table_id = learn->table_id;
2969 static const struct ofpact_learn *
2970 next_learn_with_delete(const struct rule_actions *actions,
2971 const struct ofpact_learn *start)
2973 const struct ofpact *pos;
2975 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
2976 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
2977 pos = ofpact_next(pos)) {
2978 if (pos->type == OFPACT_LEARN) {
2979 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
2980 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
2990 learned_cookies_update__(struct ofproto *ofproto,
2991 const struct rule_actions *actions,
2992 int delta, struct ovs_list *dead_cookies)
2993 OVS_REQUIRES(ofproto_mutex)
2995 if (actions->has_learn_with_delete) {
2996 const struct ofpact_learn *learn;
2998 for (learn = next_learn_with_delete(actions, NULL); learn;
2999 learn = next_learn_with_delete(actions, learn)) {
3000 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3006 learned_cookies_inc(struct ofproto *ofproto,
3007 const struct rule_actions *actions)
3008 OVS_REQUIRES(ofproto_mutex)
3010 learned_cookies_update__(ofproto, actions, +1, NULL);
3014 learned_cookies_dec(struct ofproto *ofproto,
3015 const struct rule_actions *actions,
3016 struct ovs_list *dead_cookies)
3017 OVS_REQUIRES(ofproto_mutex)
3019 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3023 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3024 OVS_REQUIRES(ofproto_mutex)
3026 struct learned_cookie *c;
3028 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3029 struct rule_criteria criteria;
3030 struct rule_collection rules;
3033 match_init_catchall(&match);
3034 rule_criteria_init(&criteria, c->table_id, &match, 0,
3035 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3036 rule_criteria_require_rw(&criteria, false);
3037 collect_rules_loose(ofproto, &criteria, &rules);
3038 delete_flows__(&rules, OFPRR_DELETE, NULL);
3039 rule_criteria_destroy(&criteria);
3040 rule_collection_destroy(&rules);
3047 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3049 ofconn_send_reply(ofconn, make_echo_reply(oh));
3054 query_tables(struct ofproto *ofproto,
3055 struct ofputil_table_features **featuresp,
3056 struct ofputil_table_stats **statsp)
3058 struct mf_bitmap rw_fields = oxm_writable_fields();
3059 struct mf_bitmap match = oxm_matchable_fields();
3060 struct mf_bitmap mask = oxm_maskable_fields();
3062 struct ofputil_table_features *features;
3063 struct ofputil_table_stats *stats;
3066 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3067 for (i = 0; i < ofproto->n_tables; i++) {
3068 struct ofputil_table_features *f = &features[i];
3071 sprintf(f->name, "table%d", i);
3072 f->metadata_match = OVS_BE64_MAX;
3073 f->metadata_write = OVS_BE64_MAX;
3074 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3075 f->max_entries = 1000000;
3077 bool more_tables = false;
3078 for (int j = i + 1; j < ofproto->n_tables; j++) {
3079 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3080 bitmap_set1(f->nonmiss.next, j);
3084 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3086 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3088 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3089 f->nonmiss.write.set_fields = rw_fields;
3090 f->nonmiss.apply = f->nonmiss.write;
3091 f->miss = f->nonmiss;
3095 f->wildcard = match;
3099 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3100 for (i = 0; i < ofproto->n_tables; i++) {
3101 struct ofputil_table_stats *s = &stats[i];
3102 struct classifier *cls = &ofproto->tables[i].cls;
3105 s->active_count = classifier_count(cls);
3107 s->active_count -= connmgr_count_hidden_rules(
3115 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3117 for (i = 0; i < ofproto->n_tables; i++) {
3118 const struct oftable *table = &ofproto->tables[i];
3119 struct ofputil_table_features *f = &features[i];
3122 ovs_strzcpy(f->name, table->name, sizeof f->name);
3125 if (table->max_flows < f->max_entries) {
3126 f->max_entries = table->max_flows;
3132 query_switch_features(struct ofproto *ofproto,
3133 bool *arp_match_ip, uint64_t *ofpacts)
3135 struct ofputil_table_features *features, *f;
3137 *arp_match_ip = false;
3140 query_tables(ofproto, &features, NULL);
3141 for (f = features; f < &features[ofproto->n_tables]; f++) {
3142 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3143 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3144 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3145 *arp_match_ip = true;
3151 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3155 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3157 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3158 struct ofputil_switch_features features;
3159 struct ofport *port;
3163 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3165 features.datapath_id = ofproto->datapath_id;
3166 features.n_buffers = pktbuf_capacity();
3167 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3168 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3169 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3170 OFPUTIL_C_GROUP_STATS);
3172 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3174 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3175 features.auxiliary_id = 0;
3176 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3178 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3179 ofputil_put_switch_features_port(&port->pp, b);
3182 ofconn_send_reply(ofconn, b);
3187 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3189 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3190 struct ofp_switch_config *osc;
3191 enum ofp_config_flags flags;
3195 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3196 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3197 flags = ofproto->frag_handling;
3198 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3199 if (oh->version < OFP13_VERSION
3200 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3201 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3203 osc->flags = htons(flags);
3204 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3205 ofconn_send_reply(ofconn, buf);
3211 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3213 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3214 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3215 uint16_t flags = ntohs(osc->flags);
3217 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3218 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3219 enum ofp_config_flags cur = ofproto->frag_handling;
3220 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3222 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3224 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3225 ofproto->frag_handling = next;
3227 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3229 ofputil_frag_handling_to_string(next));
3233 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3234 ofconn_set_invalid_ttl_to_controller(ofconn,
3235 (oh->version < OFP13_VERSION
3236 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3238 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3243 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3244 * error message code for the caller to propagate upward. Otherwise, returns
3247 * The log message mentions 'msg_type'. */
3249 reject_slave_controller(struct ofconn *ofconn)
3251 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3252 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3253 return OFPERR_OFPBRC_IS_SLAVE;
3259 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3262 * - If they use a meter, then 'ofproto' has that meter configured.
3264 * - If they use any groups, then 'ofproto' has that group configured.
3266 * Returns 0 if successful, otherwise an OpenFlow error. */
3268 ofproto_check_ofpacts(struct ofproto *ofproto,
3269 const struct ofpact ofpacts[], size_t ofpacts_len)
3271 const struct ofpact *a;
3274 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3275 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3276 return OFPERR_OFPMMFC_INVALID_METER;
3279 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3280 if (a->type == OFPACT_GROUP
3281 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3282 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3290 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3292 struct ofproto *p = ofconn_get_ofproto(ofconn);
3293 struct ofputil_packet_out po;
3294 struct dp_packet *payload;
3295 uint64_t ofpacts_stub[1024 / 8];
3296 struct ofpbuf ofpacts;
3300 COVERAGE_INC(ofproto_packet_out);
3302 error = reject_slave_controller(ofconn);
3307 /* Decode message. */
3308 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3309 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3311 goto exit_free_ofpacts;
3313 if (ofp_to_u16(po.in_port) >= p->max_ports
3314 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3315 error = OFPERR_OFPBRC_BAD_PORT;
3316 goto exit_free_ofpacts;
3320 if (po.buffer_id != UINT32_MAX) {
3321 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3322 if (error || !payload) {
3323 goto exit_free_ofpacts;
3326 /* Ensure that the L3 header is 32-bit aligned. */
3327 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3330 /* Verify actions against packet, then send packet if successful. */
3331 flow_extract(payload, &flow);
3332 flow.in_port.ofp_port = po.in_port;
3333 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3335 error = p->ofproto_class->packet_out(p, payload, &flow,
3336 po.ofpacts, po.ofpacts_len);
3338 dp_packet_delete(payload);
3341 ofpbuf_uninit(&ofpacts);
3347 update_port_config(struct ofconn *ofconn, struct ofport *port,
3348 enum ofputil_port_config config,
3349 enum ofputil_port_config mask)
3351 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3353 if (toggle & OFPUTIL_PC_PORT_DOWN
3354 && (config & OFPUTIL_PC_PORT_DOWN
3355 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3356 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3357 /* We tried to bring the port up or down, but it failed, so don't
3358 * update the "down" bit. */
3359 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3363 enum ofputil_port_config old_config = port->pp.config;
3364 port->pp.config ^= toggle;
3365 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3366 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3372 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3374 struct ofproto *p = ofconn_get_ofproto(ofconn);
3375 struct ofputil_port_mod pm;
3376 struct ofport *port;
3379 error = reject_slave_controller(ofconn);
3384 error = ofputil_decode_port_mod(oh, &pm, false);
3389 port = ofproto_get_port(p, pm.port_no);
3391 return OFPERR_OFPPMFC_BAD_PORT;
3392 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3393 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3395 update_port_config(ofconn, port, pm.config, pm.mask);
3397 netdev_set_advertisements(port->netdev, pm.advertise);
3404 handle_desc_stats_request(struct ofconn *ofconn,
3405 const struct ofp_header *request)
3407 static const char *default_mfr_desc = "Nicira, Inc.";
3408 static const char *default_hw_desc = "Open vSwitch";
3409 static const char *default_sw_desc = VERSION;
3410 static const char *default_serial_desc = "None";
3411 static const char *default_dp_desc = "None";
3413 struct ofproto *p = ofconn_get_ofproto(ofconn);
3414 struct ofp_desc_stats *ods;
3417 msg = ofpraw_alloc_stats_reply(request, 0);
3418 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3419 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3420 sizeof ods->mfr_desc);
3421 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3422 sizeof ods->hw_desc);
3423 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3424 sizeof ods->sw_desc);
3425 ovs_strlcpy(ods->serial_num,
3426 p->serial_desc ? p->serial_desc : default_serial_desc,
3427 sizeof ods->serial_num);
3428 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3429 sizeof ods->dp_desc);
3430 ofconn_send_reply(ofconn, msg);
3436 handle_table_stats_request(struct ofconn *ofconn,
3437 const struct ofp_header *request)
3439 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3440 struct ofputil_table_features *features;
3441 struct ofputil_table_stats *stats;
3442 struct ofpbuf *reply;
3445 query_tables(ofproto, &features, &stats);
3447 reply = ofputil_encode_table_stats_reply(request);
3448 for (i = 0; i < ofproto->n_tables; i++) {
3449 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3450 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3453 ofconn_send_reply(ofconn, reply);
3462 handle_table_features_request(struct ofconn *ofconn,
3463 const struct ofp_header *request)
3465 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3466 struct ofputil_table_features *features;
3467 struct ovs_list replies;
3471 ofpbuf_use_const(&msg, request, ntohs(request->length));
3472 ofpraw_pull_assert(&msg);
3473 if (msg.size || ofpmp_more(request)) {
3474 return OFPERR_OFPTFFC_EPERM;
3477 query_tables(ofproto, &features, NULL);
3479 ofpmp_init(&replies, request);
3480 for (i = 0; i < ofproto->n_tables; i++) {
3481 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3482 ofputil_append_table_features_reply(&features[i], &replies);
3485 ofconn_send_replies(ofconn, &replies);
3493 append_port_stat(struct ofport *port, struct ovs_list *replies)
3495 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3497 calc_duration(port->created, time_msec(),
3498 &ops.duration_sec, &ops.duration_nsec);
3500 /* Intentionally ignore return value, since errors will set
3501 * 'stats' to all-1s, which is correct for OpenFlow, and
3502 * netdev_get_stats() will log errors. */
3503 ofproto_port_get_stats(port, &ops.stats);
3505 ofputil_append_port_stat(replies, &ops);
3509 handle_port_request(struct ofconn *ofconn,
3510 const struct ofp_header *request, ofp_port_t port_no,
3511 void (*cb)(struct ofport *, struct ovs_list *replies))
3513 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3514 struct ofport *port;
3515 struct ovs_list replies;
3517 ofpmp_init(&replies, request);
3518 if (port_no != OFPP_ANY) {
3519 port = ofproto_get_port(ofproto, port_no);
3524 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3529 ofconn_send_replies(ofconn, &replies);
3533 handle_port_stats_request(struct ofconn *ofconn,
3534 const struct ofp_header *request)
3539 error = ofputil_decode_port_stats_request(request, &port_no);
3541 handle_port_request(ofconn, request, port_no, append_port_stat);
3547 append_port_desc(struct ofport *port, struct ovs_list *replies)
3549 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3553 handle_port_desc_stats_request(struct ofconn *ofconn,
3554 const struct ofp_header *request)
3559 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3561 handle_port_request(ofconn, request, port_no, append_port_desc);
3567 hash_cookie(ovs_be64 cookie)
3569 return hash_uint64((OVS_FORCE uint64_t)cookie);
3573 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3574 OVS_REQUIRES(ofproto_mutex)
3576 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3577 hash_cookie(rule->flow_cookie));
3581 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3582 OVS_REQUIRES(ofproto_mutex)
3584 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3588 calc_duration(long long int start, long long int now,
3589 uint32_t *sec, uint32_t *nsec)
3591 long long int msecs = now - start;
3592 *sec = msecs / 1000;
3593 *nsec = (msecs % 1000) * (1000 * 1000);
3596 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3597 * true if 'table_id' is OK, false otherwise. */
3599 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3601 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3604 static struct oftable *
3605 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3607 struct oftable *table;
3609 for (table = &ofproto->tables[table_id];
3610 table < &ofproto->tables[ofproto->n_tables];
3612 if (!(table->flags & OFTABLE_HIDDEN)) {
3620 static struct oftable *
3621 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3623 if (table_id == 0xff) {
3624 return next_visible_table(ofproto, 0);
3625 } else if (table_id < ofproto->n_tables) {
3626 return &ofproto->tables[table_id];
3632 static struct oftable *
3633 next_matching_table(const struct ofproto *ofproto,
3634 const struct oftable *table, uint8_t table_id)
3636 return (table_id == 0xff
3637 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3641 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3643 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3644 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3646 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3647 * only once, for that table. (This can be used to access tables marked
3650 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3651 * entered at all. (Perhaps you should have validated TABLE_ID with
3652 * check_table_id().)
3654 * All parameters are evaluated multiple times.
3656 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3657 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3659 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3661 /* Initializes 'criteria' in a straightforward way based on the other
3664 * By default, the criteria include flows that are read-only, on the assumption
3665 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3666 * if flows will be modified.
3668 * For "loose" matching, the 'priority' parameter is unimportant and may be
3671 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3672 const struct match *match, int priority,
3673 ovs_be64 cookie, ovs_be64 cookie_mask,
3674 ofp_port_t out_port, uint32_t out_group)
3676 criteria->table_id = table_id;
3677 cls_rule_init(&criteria->cr, match, priority);
3678 criteria->cookie = cookie;
3679 criteria->cookie_mask = cookie_mask;
3680 criteria->out_port = out_port;
3681 criteria->out_group = out_group;
3683 /* We ordinarily want to skip hidden rules, but there has to be a way for
3684 * code internal to OVS to modify and delete them, so if the criteria
3685 * specify a priority that can only be for a hidden flow, then allow hidden
3686 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3687 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3689 criteria->include_hidden = priority > UINT16_MAX;
3691 /* We assume that the criteria are being used to collect flows for reading
3692 * but not modification. Thus, we should collect read-only flows. */
3693 criteria->include_readonly = true;
3696 /* By default, criteria initialized by rule_criteria_init() will match flows
3697 * that are read-only, on the assumption that the collected flows won't be
3698 * modified. Call this function to match only flows that are be modifiable.
3700 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3701 * caller has special privileges that allow it to modify even "read-only"
3704 rule_criteria_require_rw(struct rule_criteria *criteria,
3705 bool can_write_readonly)
3707 criteria->include_readonly = can_write_readonly;
3711 rule_criteria_destroy(struct rule_criteria *criteria)
3713 cls_rule_destroy(&criteria->cr);
3717 rule_collection_init(struct rule_collection *rules)
3719 rules->rules = rules->stub;
3721 rules->capacity = ARRAY_SIZE(rules->stub);
3725 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3727 if (rules->n >= rules->capacity) {
3728 size_t old_size, new_size;
3730 old_size = rules->capacity * sizeof *rules->rules;
3731 rules->capacity *= 2;
3732 new_size = rules->capacity * sizeof *rules->rules;
3734 if (rules->rules == rules->stub) {
3735 rules->rules = xmalloc(new_size);
3736 memcpy(rules->rules, rules->stub, old_size);
3738 rules->rules = xrealloc(rules->rules, new_size);
3742 rules->rules[rules->n++] = rule;
3746 rule_collection_ref(struct rule_collection *rules)
3747 OVS_REQUIRES(ofproto_mutex)
3751 for (i = 0; i < rules->n; i++) {
3752 ofproto_rule_ref(rules->rules[i]);
3757 rule_collection_unref(struct rule_collection *rules)
3761 for (i = 0; i < rules->n; i++) {
3762 ofproto_rule_unref(rules->rules[i]);
3767 rule_collection_destroy(struct rule_collection *rules)
3769 if (rules->rules != rules->stub) {
3773 /* Make repeated destruction harmless. */
3774 rule_collection_init(rules);
3777 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3778 * function verifies most of the criteria in 'c' itself, but the caller must
3779 * check 'c->cr' itself.
3781 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3782 * 'c' only includes modifiable rules). */
3784 collect_rule(struct rule *rule, const struct rule_criteria *c,
3785 struct rule_collection *rules, size_t *n_readonly)
3786 OVS_REQUIRES(ofproto_mutex)
3788 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3789 && ofproto_rule_has_out_port(rule, c->out_port)
3790 && ofproto_rule_has_out_group(rule, c->out_group)
3791 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3792 && (!rule_is_hidden(rule) || c->include_hidden)) {
3793 /* Rule matches all the criteria... */
3794 if (!rule_is_readonly(rule) || c->include_readonly) {
3796 rule_collection_add(rules, rule);
3798 /* ...except it's read-only. */
3804 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3805 * on classifiers rules are done in the "loose" way required for OpenFlow
3806 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3809 * Returns 0 on success, otherwise an OpenFlow error code. */
3811 collect_rules_loose(struct ofproto *ofproto,
3812 const struct rule_criteria *criteria,
3813 struct rule_collection *rules)
3814 OVS_REQUIRES(ofproto_mutex)
3816 struct oftable *table;
3817 enum ofperr error = 0;
3818 size_t n_readonly = 0;
3820 rule_collection_init(rules);
3822 if (!check_table_id(ofproto, criteria->table_id)) {
3823 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3827 if (criteria->cookie_mask == OVS_BE64_MAX) {
3830 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3831 hash_cookie(criteria->cookie),
3832 &ofproto->cookies) {
3833 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3834 collect_rule(rule, criteria, rules, &n_readonly);
3838 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3841 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3842 collect_rule(rule, criteria, rules, &n_readonly);
3848 if (!error && !rules->n && n_readonly) {
3849 /* We didn't find any rules to modify. We did find some read-only
3850 * rules that we're not allowed to modify, so report that. */
3851 error = OFPERR_OFPBRC_EPERM;
3854 rule_collection_destroy(rules);
3859 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3860 * on classifiers rules are done in the "strict" way required for OpenFlow
3861 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3862 * rules on list 'rules'.
3864 * Returns 0 on success, otherwise an OpenFlow error code. */
3866 collect_rules_strict(struct ofproto *ofproto,
3867 const struct rule_criteria *criteria,
3868 struct rule_collection *rules)
3869 OVS_REQUIRES(ofproto_mutex)
3871 struct oftable *table;
3872 size_t n_readonly = 0;
3873 enum ofperr error = 0;
3875 rule_collection_init(rules);
3877 if (!check_table_id(ofproto, criteria->table_id)) {
3878 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3882 if (criteria->cookie_mask == OVS_BE64_MAX) {
3885 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3886 hash_cookie(criteria->cookie),
3887 &ofproto->cookies) {
3888 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3889 collect_rule(rule, criteria, rules, &n_readonly);
3893 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3896 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3897 &table->cls, &criteria->cr));
3899 collect_rule(rule, criteria, rules, &n_readonly);
3905 if (!error && !rules->n && n_readonly) {
3906 /* We didn't find any rules to modify. We did find some read-only
3907 * rules that we're not allowed to modify, so report that. */
3908 error = OFPERR_OFPBRC_EPERM;
3911 rule_collection_destroy(rules);
3916 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3917 * forced into the range of a uint16_t. */
3919 age_secs(long long int age_ms)
3921 return (age_ms < 0 ? 0
3922 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3923 : (unsigned int) age_ms / 1000);
3927 handle_flow_stats_request(struct ofconn *ofconn,
3928 const struct ofp_header *request)
3929 OVS_EXCLUDED(ofproto_mutex)
3931 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3932 struct ofputil_flow_stats_request fsr;
3933 struct rule_criteria criteria;
3934 struct rule_collection rules;
3935 struct ovs_list replies;
3939 error = ofputil_decode_flow_stats_request(&fsr, request);
3944 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3945 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3947 ovs_mutex_lock(&ofproto_mutex);
3948 error = collect_rules_loose(ofproto, &criteria, &rules);
3949 rule_criteria_destroy(&criteria);
3951 rule_collection_ref(&rules);
3953 ovs_mutex_unlock(&ofproto_mutex);
3959 ofpmp_init(&replies, request);
3960 for (i = 0; i < rules.n; i++) {
3961 struct rule *rule = rules.rules[i];
3962 long long int now = time_msec();
3963 struct ofputil_flow_stats fs;
3964 long long int created, used, modified;
3965 const struct rule_actions *actions;
3966 enum ofputil_flow_mod_flags flags;
3968 ovs_mutex_lock(&rule->mutex);
3969 fs.cookie = rule->flow_cookie;
3970 fs.idle_timeout = rule->idle_timeout;
3971 fs.hard_timeout = rule->hard_timeout;
3972 fs.importance = rule->importance;
3973 created = rule->created;
3974 modified = rule->modified;
3975 actions = rule_get_actions(rule);
3976 flags = rule->flags;
3977 ovs_mutex_unlock(&rule->mutex);
3979 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3980 &fs.byte_count, &used);
3982 minimatch_expand(&rule->cr.match, &fs.match);
3983 fs.table_id = rule->table_id;
3984 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3985 fs.priority = rule->cr.priority;
3986 fs.idle_age = age_secs(now - used);
3987 fs.hard_age = age_secs(now - modified);
3988 fs.ofpacts = actions->ofpacts;
3989 fs.ofpacts_len = actions->ofpacts_len;
3992 ofputil_append_flow_stats_reply(&fs, &replies);
3995 rule_collection_unref(&rules);
3996 rule_collection_destroy(&rules);
3998 ofconn_send_replies(ofconn, &replies);
4004 flow_stats_ds(struct rule *rule, struct ds *results)
4006 uint64_t packet_count, byte_count;
4007 const struct rule_actions *actions;
4008 long long int created, used;
4010 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4011 &byte_count, &used);
4013 ovs_mutex_lock(&rule->mutex);
4014 actions = rule_get_actions(rule);
4015 created = rule->created;
4016 ovs_mutex_unlock(&rule->mutex);
4018 if (rule->table_id != 0) {
4019 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4021 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4022 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4023 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4024 cls_rule_format(&rule->cr, results);
4025 ds_put_char(results, ',');
4027 ds_put_cstr(results, "actions=");
4028 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4030 ds_put_cstr(results, "\n");
4033 /* Adds a pretty-printed description of all flows to 'results', including
4034 * hidden flows (e.g., set up by in-band control). */
4036 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4038 struct oftable *table;
4040 OFPROTO_FOR_EACH_TABLE (table, p) {
4043 CLS_FOR_EACH (rule, cr, &table->cls) {
4044 flow_stats_ds(rule, results);
4049 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4050 * '*engine_type' and '*engine_id', respectively. */
4052 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4053 uint8_t *engine_type, uint8_t *engine_id)
4055 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4058 /* Checks the status change of CFM on 'ofport'.
4060 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4062 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4064 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4065 return (ofport && ofproto->ofproto_class->cfm_status_changed
4066 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4070 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4071 * Returns 0 if the port's CFM status was successfully stored into
4072 * '*status'. Returns positive errno if the port did not have CFM
4075 * The caller must provide and own '*status', and must free 'status->rmps'.
4076 * '*status' is indeterminate if the return value is non-zero. */
4078 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4079 struct cfm_status *status)
4081 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4082 return (ofport && ofproto->ofproto_class->get_cfm_status
4083 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4088 handle_aggregate_stats_request(struct ofconn *ofconn,
4089 const struct ofp_header *oh)
4090 OVS_EXCLUDED(ofproto_mutex)
4092 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4093 struct ofputil_flow_stats_request request;
4094 struct ofputil_aggregate_stats stats;
4095 bool unknown_packets, unknown_bytes;
4096 struct rule_criteria criteria;
4097 struct rule_collection rules;
4098 struct ofpbuf *reply;
4102 error = ofputil_decode_flow_stats_request(&request, oh);
4107 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4108 request.cookie, request.cookie_mask,
4109 request.out_port, request.out_group);
4111 ovs_mutex_lock(&ofproto_mutex);
4112 error = collect_rules_loose(ofproto, &criteria, &rules);
4113 rule_criteria_destroy(&criteria);
4115 rule_collection_ref(&rules);
4117 ovs_mutex_unlock(&ofproto_mutex);
4123 memset(&stats, 0, sizeof stats);
4124 unknown_packets = unknown_bytes = false;
4125 for (i = 0; i < rules.n; i++) {
4126 struct rule *rule = rules.rules[i];
4127 uint64_t packet_count;
4128 uint64_t byte_count;
4131 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4132 &byte_count, &used);
4134 if (packet_count == UINT64_MAX) {
4135 unknown_packets = true;
4137 stats.packet_count += packet_count;
4140 if (byte_count == UINT64_MAX) {
4141 unknown_bytes = true;
4143 stats.byte_count += byte_count;
4148 if (unknown_packets) {
4149 stats.packet_count = UINT64_MAX;
4151 if (unknown_bytes) {
4152 stats.byte_count = UINT64_MAX;
4155 rule_collection_unref(&rules);
4156 rule_collection_destroy(&rules);
4158 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4159 ofconn_send_reply(ofconn, reply);
4164 struct queue_stats_cbdata {
4165 struct ofport *ofport;
4166 struct ovs_list replies;
4171 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4172 const struct netdev_queue_stats *stats)
4174 struct ofputil_queue_stats oqs;
4176 oqs.port_no = cbdata->ofport->pp.port_no;
4177 oqs.queue_id = queue_id;
4178 oqs.tx_bytes = stats->tx_bytes;
4179 oqs.tx_packets = stats->tx_packets;
4180 oqs.tx_errors = stats->tx_errors;
4181 if (stats->created != LLONG_MIN) {
4182 calc_duration(stats->created, cbdata->now,
4183 &oqs.duration_sec, &oqs.duration_nsec);
4185 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4187 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4191 handle_queue_stats_dump_cb(uint32_t queue_id,
4192 struct netdev_queue_stats *stats,
4195 struct queue_stats_cbdata *cbdata = cbdata_;
4197 put_queue_stats(cbdata, queue_id, stats);
4201 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4202 struct queue_stats_cbdata *cbdata)
4204 cbdata->ofport = port;
4205 if (queue_id == OFPQ_ALL) {
4206 netdev_dump_queue_stats(port->netdev,
4207 handle_queue_stats_dump_cb, cbdata);
4209 struct netdev_queue_stats stats;
4211 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4212 put_queue_stats(cbdata, queue_id, &stats);
4214 return OFPERR_OFPQOFC_BAD_QUEUE;
4221 handle_queue_stats_request(struct ofconn *ofconn,
4222 const struct ofp_header *rq)
4224 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4225 struct queue_stats_cbdata cbdata;
4226 struct ofport *port;
4228 struct ofputil_queue_stats_request oqsr;
4230 COVERAGE_INC(ofproto_queue_req);
4232 ofpmp_init(&cbdata.replies, rq);
4233 cbdata.now = time_msec();
4235 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4240 if (oqsr.port_no == OFPP_ANY) {
4241 error = OFPERR_OFPQOFC_BAD_QUEUE;
4242 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4243 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4248 port = ofproto_get_port(ofproto, oqsr.port_no);
4250 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4251 : OFPERR_OFPQOFC_BAD_PORT);
4254 ofconn_send_replies(ofconn, &cbdata.replies);
4256 ofpbuf_list_delete(&cbdata.replies);
4263 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4264 OVS_REQUIRES(ofproto_mutex)
4266 enum ofperr error = 0;
4267 struct rule_collection rules;
4268 unsigned int count = classifier_count(&table->cls) + extra_space;
4269 unsigned int max_flows = table->max_flows;
4271 rule_collection_init(&rules);
4273 while (count-- > max_flows) {
4276 if (!choose_rule_to_evict(table, &rule)) {
4277 error = OFPERR_OFPFMFC_TABLE_FULL;
4280 eviction_group_remove_rule(rule);
4281 rule_collection_add(&rules, rule);
4284 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4285 rule_collection_destroy(&rules);
4291 is_conjunction(const struct ofpact *ofpacts, size_t ofpacts_len)
4293 return ofpacts_len > 0 && ofpacts->type == OFPACT_CONJUNCTION;
4297 get_conjunctions(const struct ofputil_flow_mod *fm,
4298 struct cls_conjunction **conjsp, size_t *n_conjsp)
4299 OVS_REQUIRES(ofproto_mutex)
4301 struct cls_conjunction *conjs = NULL;
4304 if (is_conjunction(fm->ofpacts, fm->ofpacts_len)) {
4305 const struct ofpact *ofpact;
4309 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4313 conjs = xzalloc(n_conjs * sizeof *conjs);
4315 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4316 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4317 conjs[i].clause = oc->clause;
4318 conjs[i].n_clauses = oc->n_clauses;
4319 conjs[i].id = oc->id;
4325 *n_conjsp = n_conjs;
4329 set_conjunctions(struct rule *rule, const struct cls_conjunction *conjs,
4331 OVS_REQUIRES(ofproto_mutex)
4333 struct cls_rule *cr = CONST_CAST(struct cls_rule *, &rule->cr);
4335 cls_rule_set_conjunctions(cr, conjs, n_conjs);
4338 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4339 * in which no matching flow already exists in the flow table.
4341 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4342 * ofp_actions, to the ofproto's flow table. Returns 0 on success, or an
4343 * OpenFlow error code on failure.
4345 * The caller retains ownership of 'fm->ofpacts'.
4347 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4350 add_flow(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4351 const struct flow_mod_requester *req)
4352 OVS_REQUIRES(ofproto_mutex)
4354 struct oftable *table;
4358 enum ofperr error = 0;
4360 if (!check_table_id(ofproto, fm->table_id)) {
4361 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4366 if (fm->table_id == 0xff) {
4367 if (ofproto->ofproto_class->rule_choose_table) {
4368 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4374 ovs_assert(table_id < ofproto->n_tables);
4378 } else if (fm->table_id < ofproto->n_tables) {
4379 table_id = fm->table_id;
4381 return OFPERR_OFPBRC_BAD_TABLE_ID;
4384 table = &ofproto->tables[table_id];
4385 if (table->flags & OFTABLE_READONLY
4386 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4387 return OFPERR_OFPBRC_EPERM;
4390 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4391 if (!match_has_default_hidden_fields(&fm->match)) {
4392 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4393 "non-default values to hidden fields", ofproto->name);
4394 return OFPERR_OFPBRC_EPERM;
4398 cls_rule_init(&cr, &fm->match, fm->priority);
4400 /* Transform "add" into "modify" if there's an existing identical flow. */
4401 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4403 cls_rule_destroy(&cr);
4405 fm->modify_cookie = true;
4406 error = modify_flow_check__(ofproto, fm, rule);
4408 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4410 modify_flow__(ofproto, fm, rule, req, &dead_cookies);
4411 learned_cookies_flush(ofproto, &dead_cookies);
4418 /* Check for overlap, if requested. */
4419 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4420 if (classifier_rule_overlaps(&table->cls, &cr)) {
4421 cls_rule_destroy(&cr);
4422 return OFPERR_OFPFMFC_OVERLAP;
4426 /* If necessary, evict an existing rule to clear out space. */
4427 error = evict_rules_from_table(table, 1);
4429 cls_rule_destroy(&cr);
4433 /* Allocate new rule. */
4434 error = ofproto_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4440 ofproto_rule_insert__(ofproto, rule);
4442 classifier_defer(&table->cls);
4444 struct cls_conjunction *conjs;
4446 get_conjunctions(fm, &conjs, &n_conjs);
4447 classifier_insert(&table->cls, &rule->cr, conjs, n_conjs);
4450 error = ofproto->ofproto_class->rule_insert(rule);
4452 oftable_remove_rule(rule);
4453 ofproto_rule_unref(rule);
4456 cls_rule_make_visible(&rule->cr);
4457 classifier_publish(&table->cls);
4459 learned_cookies_inc(ofproto, rule_get_actions(rule));
4461 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
4462 if (ofproto->vlan_bitmap) {
4463 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4464 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4465 bitmap_set1(ofproto->vlan_bitmap, vid);
4466 ofproto->vlans_changed = true;
4469 ofproto->vlans_changed = true;
4473 ofmonitor_report(ofproto->connmgr, rule, NXFME_ADDED, 0,
4474 req ? req->ofconn : NULL, req ? req->xid : 0, NULL);
4476 return req ? send_buffered_packet(req->ofconn, fm->buffer_id, rule) : 0;
4479 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4481 /* Checks if the 'rule' can be modified to match 'fm'.
4483 * Returns 0 on success, otherwise an OpenFlow error code. */
4485 modify_flow_check__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4486 const struct rule *rule)
4487 OVS_REQUIRES(ofproto_mutex)
4489 if (ofproto->ofproto_class->rule_premodify_actions) {
4490 return ofproto->ofproto_class->rule_premodify_actions(
4491 rule, fm->ofpacts, fm->ofpacts_len);
4496 /* Checks if the rules listed in 'rules' can have their actions changed to
4497 * match those in 'fm'.
4499 * Returns 0 on success, otherwise an OpenFlow error code. */
4501 modify_flows_check__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4502 const struct rule_collection *rules)
4503 OVS_REQUIRES(ofproto_mutex)
4508 if (ofproto->ofproto_class->rule_premodify_actions) {
4509 for (i = 0; i < rules->n; i++) {
4510 error = modify_flow_check__(ofproto, fm, rules->rules[i]);
4520 /* Modifies the 'rule', changing them to match 'fm'. */
4522 modify_flow__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4523 struct rule *rule, const struct flow_mod_requester *req,
4524 struct ovs_list *dead_cookies)
4525 OVS_REQUIRES(ofproto_mutex)
4527 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4528 ? NXFME_ADDED : NXFME_MODIFIED;
4530 /* 'fm' says that */
4531 bool change_cookie = (fm->modify_cookie
4532 && fm->new_cookie != OVS_BE64_MAX
4533 && fm->new_cookie != rule->flow_cookie);
4535 const struct rule_actions *actions = rule_get_actions(rule);
4536 bool change_actions = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4538 actions->ofpacts_len);
4540 bool reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4542 long long int now = time_msec();
4544 if (change_cookie) {
4545 cookies_remove(ofproto, rule);
4548 ovs_mutex_lock(&rule->mutex);
4549 if (fm->command == OFPFC_ADD) {
4550 rule->idle_timeout = fm->idle_timeout;
4551 rule->hard_timeout = fm->hard_timeout;
4552 rule->importance = fm->importance;
4553 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4554 rule->created = now;
4556 if (change_cookie) {
4557 rule->flow_cookie = fm->new_cookie;
4559 rule->modified = now;
4560 ovs_mutex_unlock(&rule->mutex);
4562 if (change_cookie) {
4563 cookies_insert(ofproto, rule);
4565 if (fm->command == OFPFC_ADD) {
4566 if (fm->idle_timeout || fm->hard_timeout || fm->importance) {
4567 if (!rule->eviction_group) {
4568 eviction_group_add_rule(rule);
4571 eviction_group_remove_rule(rule);
4575 if (change_actions) {
4576 /* We have to change the actions. The rule's conjunctive match set
4577 * is a function of its actions, so we need to update that too. The
4578 * conjunctive match set is used in the lookup process to figure
4579 * which (if any) collection of conjunctive sets the packet matches
4580 * with. However, a rule with conjunction actions is never to be
4581 * returned as a classifier lookup result. To make sure a rule with
4582 * conjunction actions is not returned as a lookup result, we update
4583 * them in a carefully chosen order:
4585 * - If we're adding a conjunctive match set where there wasn't one
4586 * before, we have to make the conjunctive match set available to
4587 * lookups before the rule's actions are changed, as otherwise
4588 * rule with a conjunction action could be returned as a lookup
4591 * - To clear some nonempty conjunctive set, we set the rule's
4592 * actions first, so that a lookup can't return a rule with
4593 * conjunction actions.
4595 * - Otherwise, order doesn't matter for changing one nonempty
4596 * conjunctive match set to some other nonempty set, since the
4597 * rule's actions are not seen by the classifier, and hence don't
4598 * matter either before or after the change. */
4599 struct cls_conjunction *conjs;
4601 get_conjunctions(fm, &conjs, &n_conjs);
4604 set_conjunctions(rule, conjs, n_conjs);
4606 ovsrcu_set(&rule->actions, rule_actions_create(fm->ofpacts,
4609 set_conjunctions(rule, conjs, n_conjs);
4615 if (change_actions || reset_counters) {
4616 ofproto->ofproto_class->rule_modify_actions(rule, reset_counters);
4619 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4620 ofmonitor_report(ofproto->connmgr, rule, event, 0,
4621 req ? req->ofconn : NULL, req ? req->xid : 0,
4622 change_actions ? actions : NULL);
4625 if (change_actions) {
4626 learned_cookies_inc(ofproto, rule_get_actions(rule));
4627 learned_cookies_dec(ofproto, actions, dead_cookies);
4628 rule_actions_destroy(actions);
4632 /* Modifies the rules listed in 'rules', changing their actions to match those
4635 * 'req' is used to retrieve the packet buffer specified in fm->buffer_id,
4638 modify_flows__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4639 const struct rule_collection *rules,
4640 const struct flow_mod_requester *req)
4641 OVS_REQUIRES(ofproto_mutex)
4643 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4646 for (i = 0; i < rules->n; i++) {
4647 modify_flow__(ofproto, fm, rules->rules[i], req, &dead_cookies);
4649 learned_cookies_flush(ofproto, &dead_cookies);
4653 modify_flows_add__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4654 const struct flow_mod_requester *req)
4655 OVS_REQUIRES(ofproto_mutex)
4657 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4660 return add_flow(ofproto, fm, req);
4664 modify_flows(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4665 const struct rule_collection *rules,
4666 const struct flow_mod_requester *req)
4667 OVS_REQUIRES(ofproto_mutex)
4672 error = modify_flows_check__(ofproto, fm, rules);
4674 modify_flows__(ofproto, fm, rules, req);
4676 if (fm->buffer_id != UINT32_MAX && req) {
4677 error = send_buffered_packet(req->ofconn, fm->buffer_id,
4682 error = modify_flows_add__(ofproto, fm, req);
4688 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4691 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4694 modify_flows_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4695 const struct flow_mod_requester *req)
4696 OVS_REQUIRES(ofproto_mutex)
4698 struct rule_criteria criteria;
4699 struct rule_collection rules;
4702 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4703 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4704 rule_criteria_require_rw(&criteria,
4705 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4706 error = collect_rules_loose(ofproto, &criteria, &rules);
4707 rule_criteria_destroy(&criteria);
4710 error = modify_flows(ofproto, fm, &rules, req);
4712 rule_collection_destroy(&rules);
4717 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4718 * code on failure. */
4720 modify_flow_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4721 const struct flow_mod_requester *req)
4722 OVS_REQUIRES(ofproto_mutex)
4724 struct rule_criteria criteria;
4725 struct rule_collection rules;
4728 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4729 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4730 rule_criteria_require_rw(&criteria,
4731 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4732 error = collect_rules_strict(ofproto, &criteria, &rules);
4733 rule_criteria_destroy(&criteria);
4736 /* collect_rules_strict() can return max 1 rule. */
4737 error = modify_flows(ofproto, fm, &rules, req);
4739 rule_collection_destroy(&rules);
4744 /* OFPFC_DELETE implementation. */
4746 /* Deletes the rules listed in 'rules'. */
4748 delete_flows__(const struct rule_collection *rules,
4749 enum ofp_flow_removed_reason reason,
4750 const struct flow_mod_requester *req)
4751 OVS_REQUIRES(ofproto_mutex)
4754 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4755 struct ofproto *ofproto = rules->rules[0]->ofproto;
4756 struct rule *rule, *next;
4759 for (i = 0, next = rules->rules[0];
4760 rule = next, next = (++i < rules->n) ? rules->rules[i] : NULL,
4762 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
4763 uint8_t next_table = next ? next->table_id : UINT8_MAX;
4765 ofproto_rule_send_removed(rule, reason);
4767 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4768 req ? req->ofconn : NULL, req ? req->xid : 0,
4771 if (next_table == rule->table_id) {
4772 classifier_defer(cls);
4774 classifier_remove(cls, &rule->cr);
4775 if (next_table != rule->table_id) {
4776 classifier_publish(cls);
4778 ofproto_rule_remove__(ofproto, rule);
4780 ofproto->ofproto_class->rule_delete(rule);
4782 learned_cookies_dec(ofproto, rule_get_actions(rule),
4785 ofproto_rule_unref(rule);
4787 learned_cookies_flush(ofproto, &dead_cookies);
4788 ofmonitor_flush(ofproto->connmgr);
4792 /* Implements OFPFC_DELETE. */
4794 delete_flows_loose(struct ofproto *ofproto,
4795 const struct ofputil_flow_mod *fm,
4796 const struct flow_mod_requester *req)
4797 OVS_REQUIRES(ofproto_mutex)
4799 struct rule_criteria criteria;
4800 struct rule_collection rules;
4803 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4804 fm->cookie, fm->cookie_mask,
4805 fm->out_port, fm->out_group);
4806 rule_criteria_require_rw(&criteria,
4807 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4808 error = collect_rules_loose(ofproto, &criteria, &rules);
4809 rule_criteria_destroy(&criteria);
4812 delete_flows__(&rules, fm->delete_reason, req);
4814 rule_collection_destroy(&rules);
4819 /* Implements OFPFC_DELETE_STRICT. */
4821 delete_flow_strict(struct ofproto *ofproto, const struct ofputil_flow_mod *fm,
4822 const struct flow_mod_requester *req)
4823 OVS_REQUIRES(ofproto_mutex)
4825 struct rule_criteria criteria;
4826 struct rule_collection rules;
4829 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4830 fm->cookie, fm->cookie_mask,
4831 fm->out_port, fm->out_group);
4832 rule_criteria_require_rw(&criteria,
4833 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4834 error = collect_rules_strict(ofproto, &criteria, &rules);
4835 rule_criteria_destroy(&criteria);
4838 delete_flows__(&rules, fm->delete_reason, req);
4840 rule_collection_destroy(&rules);
4846 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4847 OVS_REQUIRES(ofproto_mutex)
4849 struct ofputil_flow_removed fr;
4852 if (rule_is_hidden(rule) ||
4853 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4857 minimatch_expand(&rule->cr.match, &fr.match);
4858 fr.priority = rule->cr.priority;
4859 fr.cookie = rule->flow_cookie;
4861 fr.table_id = rule->table_id;
4862 calc_duration(rule->created, time_msec(),
4863 &fr.duration_sec, &fr.duration_nsec);
4864 ovs_mutex_lock(&rule->mutex);
4865 fr.idle_timeout = rule->idle_timeout;
4866 fr.hard_timeout = rule->hard_timeout;
4867 ovs_mutex_unlock(&rule->mutex);
4868 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4869 &fr.byte_count, &used);
4871 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4874 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4875 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4878 * ofproto implementation ->run() functions should use this function to expire
4879 * OpenFlow flows. */
4881 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4882 OVS_REQUIRES(ofproto_mutex)
4884 struct rule_collection rules;
4886 rules.rules = rules.stub;
4888 rules.stub[0] = rule;
4889 delete_flows__(&rules, reason, NULL);
4892 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4893 * means "infinite". */
4895 reduce_timeout(uint16_t max, uint16_t *timeout)
4897 if (max && (!*timeout || *timeout > max)) {
4902 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4903 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4904 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4906 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4908 ofproto_rule_reduce_timeouts(struct rule *rule,
4909 uint16_t idle_timeout, uint16_t hard_timeout)
4910 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4912 if (!idle_timeout && !hard_timeout) {
4916 ovs_mutex_lock(&ofproto_mutex);
4917 if (list_is_empty(&rule->expirable)) {
4918 list_insert(&rule->ofproto->expirable, &rule->expirable);
4920 ovs_mutex_unlock(&ofproto_mutex);
4922 ovs_mutex_lock(&rule->mutex);
4923 reduce_timeout(idle_timeout, &rule->idle_timeout);
4924 reduce_timeout(hard_timeout, &rule->hard_timeout);
4925 ovs_mutex_unlock(&rule->mutex);
4929 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4930 OVS_EXCLUDED(ofproto_mutex)
4932 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4933 struct ofputil_flow_mod fm;
4934 uint64_t ofpacts_stub[1024 / 8];
4935 struct ofpbuf ofpacts;
4938 error = reject_slave_controller(ofconn);
4943 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4944 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4946 u16_to_ofp(ofproto->max_ports),
4949 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4952 struct flow_mod_requester req;
4954 req.ofconn = ofconn;
4956 error = handle_flow_mod__(ofproto, &fm, &req);
4959 goto exit_free_ofpacts;
4962 ofconn_report_flow_mod(ofconn, fm.command);
4965 ofpbuf_uninit(&ofpacts);
4971 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4972 const struct flow_mod_requester *req)
4973 OVS_EXCLUDED(ofproto_mutex)
4977 ovs_mutex_lock(&ofproto_mutex);
4978 switch (fm->command) {
4980 error = add_flow(ofproto, fm, req);
4984 error = modify_flows_loose(ofproto, fm, req);
4987 case OFPFC_MODIFY_STRICT:
4988 error = modify_flow_strict(ofproto, fm, req);
4992 error = delete_flows_loose(ofproto, fm, req);
4995 case OFPFC_DELETE_STRICT:
4996 error = delete_flow_strict(ofproto, fm, req);
5000 if (fm->command > 0xff) {
5001 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
5002 "flow_mod_table_id extension is not enabled",
5005 error = OFPERR_OFPFMFC_BAD_COMMAND;
5008 ofmonitor_flush(ofproto->connmgr);
5009 ovs_mutex_unlock(&ofproto_mutex);
5011 run_rule_executes(ofproto);
5016 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5018 struct ofputil_role_request request;
5019 struct ofputil_role_request reply;
5023 error = ofputil_decode_role_message(oh, &request);
5028 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5029 if (request.have_generation_id
5030 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5031 return OFPERR_OFPRRFC_STALE;
5034 ofconn_set_role(ofconn, request.role);
5037 reply.role = ofconn_get_role(ofconn);
5038 reply.have_generation_id = ofconn_get_master_election_id(
5039 ofconn, &reply.generation_id);
5040 buf = ofputil_encode_role_reply(oh, &reply);
5041 ofconn_send_reply(ofconn, buf);
5047 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5048 const struct ofp_header *oh)
5050 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5051 enum ofputil_protocol cur, next;
5053 cur = ofconn_get_protocol(ofconn);
5054 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5055 ofconn_set_protocol(ofconn, next);
5061 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5063 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5064 enum ofputil_protocol cur, next;
5065 enum ofputil_protocol next_base;
5067 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5069 return OFPERR_OFPBRC_EPERM;
5072 cur = ofconn_get_protocol(ofconn);
5073 next = ofputil_protocol_set_base(cur, next_base);
5074 ofconn_set_protocol(ofconn, next);
5080 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5081 const struct ofp_header *oh)
5083 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5086 format = ntohl(msg->format);
5087 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5088 return OFPERR_OFPBRC_EPERM;
5091 ofconn_set_packet_in_format(ofconn, format);
5096 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5098 const struct nx_async_config *msg = ofpmsg_body(oh);
5099 uint32_t master[OAM_N_TYPES];
5100 uint32_t slave[OAM_N_TYPES];
5102 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5103 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5104 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5106 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5107 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5108 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5110 ofconn_set_async_config(ofconn, master, slave);
5111 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5112 !ofconn_get_miss_send_len(ofconn)) {
5113 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5120 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5123 uint32_t master[OAM_N_TYPES];
5124 uint32_t slave[OAM_N_TYPES];
5125 struct nx_async_config *msg;
5127 ofconn_get_async_config(ofconn, master, slave);
5128 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5129 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5131 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5132 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5133 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5135 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5136 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5137 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5139 ofconn_send_reply(ofconn, buf);
5145 handle_nxt_set_controller_id(struct ofconn *ofconn,
5146 const struct ofp_header *oh)
5148 const struct nx_controller_id *nci = ofpmsg_body(oh);
5150 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5151 return OFPERR_NXBRC_MUST_BE_ZERO;
5154 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5159 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5163 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5164 ? OFPRAW_OFPT10_BARRIER_REPLY
5165 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5166 ofconn_send_reply(ofconn, buf);
5171 ofproto_compose_flow_refresh_update(const struct rule *rule,
5172 enum nx_flow_monitor_flags flags,
5173 struct ovs_list *msgs)
5174 OVS_REQUIRES(ofproto_mutex)
5176 const struct rule_actions *actions;
5177 struct ofputil_flow_update fu;
5180 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5181 ? NXFME_ADDED : NXFME_MODIFIED);
5183 ovs_mutex_lock(&rule->mutex);
5184 fu.idle_timeout = rule->idle_timeout;
5185 fu.hard_timeout = rule->hard_timeout;
5186 ovs_mutex_unlock(&rule->mutex);
5187 fu.table_id = rule->table_id;
5188 fu.cookie = rule->flow_cookie;
5189 minimatch_expand(&rule->cr.match, &match);
5191 fu.priority = rule->cr.priority;
5193 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5194 fu.ofpacts = actions ? actions->ofpacts : NULL;
5195 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5197 if (list_is_empty(msgs)) {
5198 ofputil_start_flow_update(msgs);
5200 ofputil_append_flow_update(&fu, msgs);
5204 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5205 struct ovs_list *msgs)
5206 OVS_REQUIRES(ofproto_mutex)
5210 for (i = 0; i < rules->n; i++) {
5211 struct rule *rule = rules->rules[i];
5212 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5213 rule->monitor_flags = 0;
5215 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5220 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5221 struct rule *rule, uint64_t seqno,
5222 struct rule_collection *rules)
5223 OVS_REQUIRES(ofproto_mutex)
5225 enum nx_flow_monitor_flags update;
5227 if (rule_is_hidden(rule)) {
5231 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5236 if (rule->add_seqno > seqno) {
5237 update = NXFMF_ADD | NXFMF_MODIFY;
5238 } else if (rule->modify_seqno > seqno) {
5239 update = NXFMF_MODIFY;
5244 if (!(m->flags & update)) {
5248 update = NXFMF_INITIAL;
5251 if (!rule->monitor_flags) {
5252 rule_collection_add(rules, rule);
5254 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5258 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5260 struct rule_collection *rules)
5261 OVS_REQUIRES(ofproto_mutex)
5263 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5264 const struct oftable *table;
5265 struct cls_rule target;
5267 cls_rule_init_from_minimatch(&target, &m->match, 0);
5268 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5271 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5272 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5275 cls_rule_destroy(&target);
5279 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5280 struct rule_collection *rules)
5281 OVS_REQUIRES(ofproto_mutex)
5283 if (m->flags & NXFMF_INITIAL) {
5284 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5289 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5290 uint64_t seqno, struct rule_collection *rules)
5291 OVS_REQUIRES(ofproto_mutex)
5293 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5297 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5298 OVS_REQUIRES(ofproto_mutex)
5300 struct ofmonitor *m;
5303 m = ofmonitor_lookup(ofconn, id);
5305 ofmonitor_destroy(m);
5308 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5315 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5316 OVS_EXCLUDED(ofproto_mutex)
5318 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5319 struct ofmonitor **monitors;
5320 size_t n_monitors, allocated_monitors;
5321 struct rule_collection rules;
5322 struct ovs_list replies;
5327 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5329 n_monitors = allocated_monitors = 0;
5331 ovs_mutex_lock(&ofproto_mutex);
5333 struct ofputil_flow_monitor_request request;
5334 struct ofmonitor *m;
5337 retval = ofputil_decode_flow_monitor_request(&request, &b);
5338 if (retval == EOF) {
5340 } else if (retval) {
5345 if (request.table_id != 0xff
5346 && request.table_id >= ofproto->n_tables) {
5347 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5351 error = ofmonitor_create(&request, ofconn, &m);
5356 if (n_monitors >= allocated_monitors) {
5357 monitors = x2nrealloc(monitors, &allocated_monitors,
5360 monitors[n_monitors++] = m;
5363 rule_collection_init(&rules);
5364 for (i = 0; i < n_monitors; i++) {
5365 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5368 ofpmp_init(&replies, oh);
5369 ofmonitor_compose_refresh_updates(&rules, &replies);
5370 ovs_mutex_unlock(&ofproto_mutex);
5372 rule_collection_destroy(&rules);
5374 ofconn_send_replies(ofconn, &replies);
5380 for (i = 0; i < n_monitors; i++) {
5381 ofmonitor_destroy(monitors[i]);
5384 ovs_mutex_unlock(&ofproto_mutex);
5390 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5391 OVS_EXCLUDED(ofproto_mutex)
5396 id = ofputil_decode_flow_monitor_cancel(oh);
5398 ovs_mutex_lock(&ofproto_mutex);
5399 error = flow_monitor_delete(ofconn, id);
5400 ovs_mutex_unlock(&ofproto_mutex);
5405 /* Meters implementation.
5407 * Meter table entry, indexed by the OpenFlow meter_id.
5408 * 'created' is used to compute the duration for meter stats.
5409 * 'list rules' is needed so that we can delete the dependent rules when the
5410 * meter table entry is deleted.
5411 * 'provider_meter_id' is for the provider's private use.
5414 long long int created; /* Time created. */
5415 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5416 ofproto_meter_id provider_meter_id;
5417 uint16_t flags; /* Meter flags. */
5418 uint16_t n_bands; /* Number of meter bands. */
5419 struct ofputil_meter_band *bands;
5423 * This is used in instruction validation at flow set-up time,
5424 * as flows may not use non-existing meters.
5425 * Return value of UINT32_MAX signifies an invalid meter.
5428 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5430 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5431 const struct meter *meter = ofproto->meters[of_meter_id];
5433 return meter->provider_meter_id.uint32;
5439 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5442 meter_insert_rule(struct rule *rule)
5444 const struct rule_actions *a = rule_get_actions(rule);
5445 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5446 struct meter *meter = rule->ofproto->meters[meter_id];
5448 list_insert(&meter->rules, &rule->meter_list_node);
5452 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5456 meter->flags = config->flags;
5457 meter->n_bands = config->n_bands;
5458 meter->bands = xmemdup(config->bands,
5459 config->n_bands * sizeof *meter->bands);
5462 static struct meter *
5463 meter_create(const struct ofputil_meter_config *config,
5464 ofproto_meter_id provider_meter_id)
5466 struct meter *meter;
5468 meter = xzalloc(sizeof *meter);
5469 meter->provider_meter_id = provider_meter_id;
5470 meter->created = time_msec();
5471 list_init(&meter->rules);
5473 meter_update(meter, config);
5479 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5480 OVS_REQUIRES(ofproto_mutex)
5483 for (mid = first; mid <= last; ++mid) {
5484 struct meter *meter = ofproto->meters[mid];
5486 ofproto->meters[mid] = NULL;
5487 ofproto->ofproto_class->meter_del(ofproto,
5488 meter->provider_meter_id);
5496 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5498 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5499 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5503 return OFPERR_OFPMMFC_METER_EXISTS;
5506 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5509 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5510 *meterp = meter_create(&mm->meter, provider_meter_id);
5516 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5518 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5520 uint32_t provider_meter_id;
5523 return OFPERR_OFPMMFC_UNKNOWN_METER;
5526 provider_meter_id = meter->provider_meter_id.uint32;
5527 error = ofproto->ofproto_class->meter_set(ofproto,
5528 &meter->provider_meter_id,
5530 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5532 meter_update(meter, &mm->meter);
5538 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5539 OVS_EXCLUDED(ofproto_mutex)
5541 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5542 uint32_t meter_id = mm->meter.meter_id;
5543 struct rule_collection rules;
5544 enum ofperr error = 0;
5545 uint32_t first, last;
5547 if (meter_id == OFPM13_ALL) {
5549 last = ofproto->meter_features.max_meters;
5551 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5554 first = last = meter_id;
5557 /* First delete the rules that use this meter. If any of those rules are
5558 * currently being modified, postpone the whole operation until later. */
5559 rule_collection_init(&rules);
5560 ovs_mutex_lock(&ofproto_mutex);
5561 for (meter_id = first; meter_id <= last; ++meter_id) {
5562 struct meter *meter = ofproto->meters[meter_id];
5563 if (meter && !list_is_empty(&meter->rules)) {
5566 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5567 rule_collection_add(&rules, rule);
5571 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5573 /* Delete the meters. */
5574 meter_delete(ofproto, first, last);
5576 ovs_mutex_unlock(&ofproto_mutex);
5577 rule_collection_destroy(&rules);
5583 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5585 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5586 struct ofputil_meter_mod mm;
5587 uint64_t bands_stub[256 / 8];
5588 struct ofpbuf bands;
5592 error = reject_slave_controller(ofconn);
5597 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5599 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5601 goto exit_free_bands;
5604 meter_id = mm.meter.meter_id;
5606 if (mm.command != OFPMC13_DELETE) {
5607 /* Fails also when meters are not implemented by the provider. */
5608 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5609 error = OFPERR_OFPMMFC_INVALID_METER;
5610 goto exit_free_bands;
5611 } else if (meter_id > ofproto->meter_features.max_meters) {
5612 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5613 goto exit_free_bands;
5615 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5616 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5617 goto exit_free_bands;
5621 switch (mm.command) {
5623 error = handle_add_meter(ofproto, &mm);
5626 case OFPMC13_MODIFY:
5627 error = handle_modify_meter(ofproto, &mm);
5630 case OFPMC13_DELETE:
5631 error = handle_delete_meter(ofconn, &mm);
5635 error = OFPERR_OFPMMFC_BAD_COMMAND;
5640 ofpbuf_uninit(&bands);
5645 handle_meter_features_request(struct ofconn *ofconn,
5646 const struct ofp_header *request)
5648 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5649 struct ofputil_meter_features features;
5652 if (ofproto->ofproto_class->meter_get_features) {
5653 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5655 memset(&features, 0, sizeof features);
5657 b = ofputil_encode_meter_features_reply(&features, request);
5659 ofconn_send_reply(ofconn, b);
5664 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5667 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5668 struct ovs_list replies;
5669 uint64_t bands_stub[256 / 8];
5670 struct ofpbuf bands;
5671 uint32_t meter_id, first, last;
5673 ofputil_decode_meter_request(request, &meter_id);
5675 if (meter_id == OFPM13_ALL) {
5677 last = ofproto->meter_features.max_meters;
5679 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5680 !ofproto->meters[meter_id]) {
5681 return OFPERR_OFPMMFC_UNKNOWN_METER;
5683 first = last = meter_id;
5686 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5687 ofpmp_init(&replies, request);
5689 for (meter_id = first; meter_id <= last; ++meter_id) {
5690 struct meter *meter = ofproto->meters[meter_id];
5692 continue; /* Skip non-existing meters. */
5694 if (type == OFPTYPE_METER_STATS_REQUEST) {
5695 struct ofputil_meter_stats stats;
5697 stats.meter_id = meter_id;
5699 /* Provider sets the packet and byte counts, we do the rest. */
5700 stats.flow_count = list_size(&meter->rules);
5701 calc_duration(meter->created, time_msec(),
5702 &stats.duration_sec, &stats.duration_nsec);
5703 stats.n_bands = meter->n_bands;
5704 ofpbuf_clear(&bands);
5706 = ofpbuf_put_uninit(&bands,
5707 meter->n_bands * sizeof *stats.bands);
5709 if (!ofproto->ofproto_class->meter_get(ofproto,
5710 meter->provider_meter_id,
5712 ofputil_append_meter_stats(&replies, &stats);
5714 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5715 struct ofputil_meter_config config;
5717 config.meter_id = meter_id;
5718 config.flags = meter->flags;
5719 config.n_bands = meter->n_bands;
5720 config.bands = meter->bands;
5721 ofputil_append_meter_config(&replies, &config);
5725 ofconn_send_replies(ofconn, &replies);
5726 ofpbuf_uninit(&bands);
5731 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5732 struct ofgroup **group)
5733 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5735 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5736 hash_int(group_id, 0), &ofproto->groups) {
5737 if ((*group)->group_id == group_id) {
5745 /* If the group exists, this function increments the groups's reference count.
5747 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5748 * a reference to the group. */
5750 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5751 struct ofgroup **group)
5755 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5756 found = ofproto_group_lookup__(ofproto, group_id, group);
5758 ofproto_group_ref(*group);
5760 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5765 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5766 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5768 struct ofgroup *grp;
5770 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5771 hash_int(group_id, 0), &ofproto->groups) {
5772 if (grp->group_id == group_id) {
5780 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5781 OVS_EXCLUDED(ofproto->groups_rwlock)
5785 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5786 exists = ofproto_group_exists__(ofproto, group_id);
5787 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5793 group_get_ref_count(struct ofgroup *group)
5794 OVS_EXCLUDED(ofproto_mutex)
5796 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5797 struct rule_criteria criteria;
5798 struct rule_collection rules;
5803 match_init_catchall(&match);
5804 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5805 OFPP_ANY, group->group_id);
5806 ovs_mutex_lock(&ofproto_mutex);
5807 error = collect_rules_loose(ofproto, &criteria, &rules);
5808 ovs_mutex_unlock(&ofproto_mutex);
5809 rule_criteria_destroy(&criteria);
5811 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5813 rule_collection_destroy(&rules);
5818 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
5820 struct ofputil_group_stats ogs;
5821 const struct ofproto *ofproto = group->ofproto;
5822 long long int now = time_msec();
5825 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5827 /* Provider sets the packet and byte counts, we do the rest. */
5828 ogs.ref_count = group_get_ref_count(group);
5829 ogs.n_buckets = group->n_buckets;
5831 error = (ofproto->ofproto_class->group_get_stats
5832 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5835 ogs.packet_count = UINT64_MAX;
5836 ogs.byte_count = UINT64_MAX;
5837 memset(ogs.bucket_stats, 0xff,
5838 ogs.n_buckets * sizeof *ogs.bucket_stats);
5841 ogs.group_id = group->group_id;
5842 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5844 ofputil_append_group_stats(replies, &ogs);
5846 free(ogs.bucket_stats);
5850 handle_group_request(struct ofconn *ofconn,
5851 const struct ofp_header *request, uint32_t group_id,
5852 void (*cb)(struct ofgroup *, struct ovs_list *replies))
5854 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5855 struct ofgroup *group;
5856 struct ovs_list replies;
5858 ofpmp_init(&replies, request);
5859 if (group_id == OFPG_ALL) {
5860 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5861 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5862 cb(group, &replies);
5864 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5866 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5867 cb(group, &replies);
5868 ofproto_group_unref(group);
5871 ofconn_send_replies(ofconn, &replies);
5875 handle_group_stats_request(struct ofconn *ofconn,
5876 const struct ofp_header *request)
5881 error = ofputil_decode_group_stats_request(request, &group_id);
5886 handle_group_request(ofconn, request, group_id, append_group_stats);
5891 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
5893 struct ofputil_group_desc gds;
5895 gds.group_id = group->group_id;
5896 gds.type = group->type;
5897 gds.props = group->props;
5899 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5903 handle_group_desc_stats_request(struct ofconn *ofconn,
5904 const struct ofp_header *request)
5906 handle_group_request(ofconn, request,
5907 ofputil_decode_group_desc_request(request),
5913 handle_group_features_stats_request(struct ofconn *ofconn,
5914 const struct ofp_header *request)
5916 struct ofproto *p = ofconn_get_ofproto(ofconn);
5919 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5921 ofconn_send_reply(ofconn, msg);
5928 handle_queue_get_config_request(struct ofconn *ofconn,
5929 const struct ofp_header *oh)
5931 struct ofproto *p = ofconn_get_ofproto(ofconn);
5932 struct netdev_queue_dump queue_dump;
5933 struct ofport *ofport;
5934 unsigned int queue_id;
5935 struct ofpbuf *reply;
5936 struct smap details;
5940 error = ofputil_decode_queue_get_config_request(oh, &request);
5945 ofport = ofproto_get_port(p, request);
5947 return OFPERR_OFPQOFC_BAD_PORT;
5950 reply = ofputil_encode_queue_get_config_reply(oh);
5952 smap_init(&details);
5953 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5954 struct ofputil_queue_config queue;
5956 /* None of the existing queues have compatible properties, so we
5957 * hard-code omitting min_rate and max_rate. */
5958 queue.queue_id = queue_id;
5959 queue.min_rate = UINT16_MAX;
5960 queue.max_rate = UINT16_MAX;
5961 ofputil_append_queue_get_config_reply(reply, &queue);
5963 smap_destroy(&details);
5965 ofconn_send_reply(ofconn, reply);
5971 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
5972 struct ofgroup **ofgroup)
5975 const long long int now = time_msec();
5977 if (gm->group_id > OFPG_MAX) {
5978 return OFPERR_OFPGMFC_INVALID_GROUP;
5980 if (gm->type > OFPGT11_FF) {
5981 return OFPERR_OFPGMFC_BAD_TYPE;
5984 *ofgroup = ofproto->ofproto_class->group_alloc();
5986 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5987 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5990 (*ofgroup)->ofproto = ofproto;
5991 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
5992 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
5993 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
5994 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
5995 ovs_refcount_init(&(*ofgroup)->ref_count);
5997 list_move(&(*ofgroup)->buckets, &gm->buckets);
5998 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
5999 list_size(&(*ofgroup)->buckets);
6001 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6002 &gm->props, sizeof (struct ofputil_group_props));
6004 /* Construct called BEFORE any locks are held. */
6005 error = ofproto->ofproto_class->group_construct(*ofgroup);
6007 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6008 ofproto->ofproto_class->group_dealloc(*ofgroup);
6013 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6014 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6017 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6019 struct ofgroup *ofgroup;
6022 /* Allocate new group and initialize it. */
6023 error = init_group(ofproto, gm, &ofgroup);
6028 /* We wrlock as late as possible to minimize the time we jam any other
6029 * threads: No visible state changes before acquiring the lock. */
6030 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6032 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6033 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6037 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6038 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6043 /* Insert new group. */
6044 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6045 hash_int(ofgroup->group_id, 0));
6046 ofproto->n_groups[ofgroup->type]++;
6048 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6053 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6054 ofproto->ofproto_class->group_destruct(ofgroup);
6055 ofputil_bucket_list_destroy(&ofgroup->buckets);
6056 ofproto->ofproto_class->group_dealloc(ofgroup);
6061 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6062 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6063 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6064 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6067 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6068 struct ofgroup *new_ofgroup,
6069 uint32_t command_bucket_id)
6071 struct ofputil_bucket *last = NULL;
6073 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6074 /* Check here to ensure that a bucket corresponding to
6075 * command_bucket_id exists in the old bucket list.
6077 * The subsequent search of below of new_ofgroup covers
6078 * both buckets in the old bucket list and buckets added
6079 * by the insert buckets group mod message this function processes. */
6080 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6081 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6084 if (!list_is_empty(&new_ofgroup->buckets)) {
6085 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6089 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6091 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6092 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6093 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6096 /* Rearrange list according to command_bucket_id */
6097 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6098 struct ofputil_bucket *new_first;
6099 const struct ofputil_bucket *first;
6101 first = ofputil_bucket_list_front(&ofgroup->buckets);
6102 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6105 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6106 &new_ofgroup->buckets);
6107 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6108 struct ofputil_bucket *after;
6110 /* Presence of bucket is checked above so after should never be NULL */
6111 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6113 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6114 last->list_node.next);
6120 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6121 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6122 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6123 * and OFPG15_BUCKET_ALL are also honored. */
6125 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6126 struct ofgroup *new_ofgroup,
6127 uint32_t command_bucket_id)
6129 const struct ofputil_bucket *skip = NULL;
6131 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6135 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6136 if (!list_is_empty(&ofgroup->buckets)) {
6137 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6139 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6140 if (!list_is_empty(&ofgroup->buckets)) {
6141 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6144 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6146 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6150 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6155 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6156 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6159 * Note that the group is re-created and then replaces the old group in
6160 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6161 * the xlate module hold a pointer to the group. */
6163 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6165 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6168 error = init_group(ofproto, gm, &new_ofgroup);
6173 retiring = new_ofgroup;
6175 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6176 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6177 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6181 /* Ofproto's group write lock is held now. */
6182 if (ofgroup->type != gm->type
6183 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6184 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6188 /* Manipulate bucket list for bucket commands */
6189 if (gm->command == OFPGC15_INSERT_BUCKET) {
6190 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6191 gm->command_bucket_id);
6192 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6193 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6194 gm->command_bucket_id);
6200 /* The group creation time does not change during modification. */
6201 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6202 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6204 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6210 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6211 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6212 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6213 hash_int(new_ofgroup->group_id, 0));
6214 if (ofgroup->type != new_ofgroup->type) {
6215 ofproto->n_groups[ofgroup->type]--;
6216 ofproto->n_groups[new_ofgroup->type]++;
6220 ofproto_group_unref(retiring);
6221 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6226 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6227 OVS_RELEASES(ofproto->groups_rwlock)
6230 struct ofputil_flow_mod fm;
6232 /* Delete all flow entries containing this group in a group action */
6233 match_init_catchall(&match);
6234 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6235 fm.delete_reason = OFPRR_GROUP_DELETE;
6236 fm.out_group = ofgroup->group_id;
6237 handle_flow_mod__(ofproto, &fm, NULL);
6239 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6240 /* No-one can find this group any more. */
6241 ofproto->n_groups[ofgroup->type]--;
6242 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6243 ofproto_group_unref(ofgroup);
6246 /* Implements OFPGC11_DELETE. */
6248 delete_group(struct ofproto *ofproto, uint32_t group_id)
6250 struct ofgroup *ofgroup;
6252 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6253 if (group_id == OFPG_ALL) {
6255 struct hmap_node *node = hmap_first(&ofproto->groups);
6259 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6260 delete_group__(ofproto, ofgroup);
6261 /* Lock for each node separately, so that we will not jam the
6262 * other threads for too long time. */
6263 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6266 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6267 hash_int(group_id, 0), &ofproto->groups) {
6268 if (ofgroup->group_id == group_id) {
6269 delete_group__(ofproto, ofgroup);
6274 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6278 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6280 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6281 struct ofputil_group_mod gm;
6284 error = reject_slave_controller(ofconn);
6289 error = ofputil_decode_group_mod(oh, &gm);
6294 switch (gm.command) {
6296 return add_group(ofproto, &gm);
6298 case OFPGC11_MODIFY:
6299 return modify_group(ofproto, &gm);
6301 case OFPGC11_DELETE:
6302 delete_group(ofproto, gm.group_id);
6305 case OFPGC15_INSERT_BUCKET:
6306 return modify_group(ofproto, &gm);
6308 case OFPGC15_REMOVE_BUCKET:
6309 return modify_group(ofproto, &gm);
6312 if (gm.command > OFPGC11_DELETE) {
6313 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6314 ofproto->name, gm.command);
6316 return OFPERR_OFPGMFC_BAD_COMMAND;
6320 enum ofputil_table_miss
6321 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6323 enum ofputil_table_miss value;
6325 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6330 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6332 if (!check_table_id(ofproto, tm->table_id)) {
6333 return OFPERR_OFPTMFC_BAD_TABLE;
6334 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6335 if (tm->table_id == OFPTT_ALL) {
6337 for (i = 0; i < ofproto->n_tables; i++) {
6338 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6342 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6350 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6352 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6353 struct ofputil_table_mod tm;
6356 error = reject_slave_controller(ofconn);
6361 error = ofputil_decode_table_mod(oh, &tm);
6366 return table_mod(ofproto, &tm);
6370 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6373 struct ofputil_bundle_ctrl_msg bctrl;
6375 struct ofputil_bundle_ctrl_msg reply;
6377 error = reject_slave_controller(ofconn);
6382 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6387 reply.bundle_id = bctrl.bundle_id;
6389 switch (bctrl.type) {
6390 case OFPBCT_OPEN_REQUEST:
6391 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6392 reply.type = OFPBCT_OPEN_REPLY;
6394 case OFPBCT_CLOSE_REQUEST:
6395 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6396 reply.type = OFPBCT_CLOSE_REPLY;;
6398 case OFPBCT_COMMIT_REQUEST:
6399 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6400 reply.type = OFPBCT_COMMIT_REPLY;
6402 case OFPBCT_DISCARD_REQUEST:
6403 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6404 reply.type = OFPBCT_DISCARD_REPLY;
6407 case OFPBCT_OPEN_REPLY:
6408 case OFPBCT_CLOSE_REPLY:
6409 case OFPBCT_COMMIT_REPLY:
6410 case OFPBCT_DISCARD_REPLY:
6411 return OFPERR_OFPBFC_BAD_TYPE;
6416 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6417 ofconn_send_reply(ofconn, buf);
6423 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6425 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6427 struct ofputil_bundle_add_msg badd;
6428 struct ofp_bundle_entry *bmsg;
6431 error = reject_slave_controller(ofconn);
6436 error = ofputil_decode_bundle_add(oh, &badd, &type);
6441 bmsg = ofp_bundle_entry_alloc(type, badd.msg->xid);
6443 if (type == OFPTYPE_PORT_MOD) {
6444 error = ofputil_decode_port_mod(badd.msg, &bmsg->pm, false);
6445 } else if (type == OFPTYPE_FLOW_MOD) {
6446 struct ofpbuf ofpacts;
6447 uint64_t ofpacts_stub[1024 / 8];
6449 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6450 error = ofputil_decode_flow_mod(&bmsg->fm, badd.msg,
6451 ofconn_get_protocol(ofconn),
6453 u16_to_ofp(ofproto->max_ports),
6455 /* Move actions to heap. */
6456 bmsg->fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6458 if (!error && bmsg->fm.ofpacts_len) {
6459 error = ofproto_check_ofpacts(ofproto, bmsg->fm.ofpacts,
6460 bmsg->fm.ofpacts_len);
6467 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
6472 ofp_bundle_entry_free(bmsg);
6479 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6480 OVS_EXCLUDED(ofproto_mutex)
6482 const struct ofp_header *oh = msg->data;
6486 error = ofptype_decode(&type, oh);
6490 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6491 && ofpmp_more(oh)) {
6492 /* We have no buffer implementation for multipart requests.
6493 * Report overflow for requests which consists of multiple
6495 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6499 /* OpenFlow requests. */
6500 case OFPTYPE_ECHO_REQUEST:
6501 return handle_echo_request(ofconn, oh);
6503 case OFPTYPE_FEATURES_REQUEST:
6504 return handle_features_request(ofconn, oh);
6506 case OFPTYPE_GET_CONFIG_REQUEST:
6507 return handle_get_config_request(ofconn, oh);
6509 case OFPTYPE_SET_CONFIG:
6510 return handle_set_config(ofconn, oh);
6512 case OFPTYPE_PACKET_OUT:
6513 return handle_packet_out(ofconn, oh);
6515 case OFPTYPE_PORT_MOD:
6516 return handle_port_mod(ofconn, oh);
6518 case OFPTYPE_FLOW_MOD:
6519 return handle_flow_mod(ofconn, oh);
6521 case OFPTYPE_GROUP_MOD:
6522 return handle_group_mod(ofconn, oh);
6524 case OFPTYPE_TABLE_MOD:
6525 return handle_table_mod(ofconn, oh);
6527 case OFPTYPE_METER_MOD:
6528 return handle_meter_mod(ofconn, oh);
6530 case OFPTYPE_BARRIER_REQUEST:
6531 return handle_barrier_request(ofconn, oh);
6533 case OFPTYPE_ROLE_REQUEST:
6534 return handle_role_request(ofconn, oh);
6536 /* OpenFlow replies. */
6537 case OFPTYPE_ECHO_REPLY:
6540 /* Nicira extension requests. */
6541 case OFPTYPE_FLOW_MOD_TABLE_ID:
6542 return handle_nxt_flow_mod_table_id(ofconn, oh);
6544 case OFPTYPE_SET_FLOW_FORMAT:
6545 return handle_nxt_set_flow_format(ofconn, oh);
6547 case OFPTYPE_SET_PACKET_IN_FORMAT:
6548 return handle_nxt_set_packet_in_format(ofconn, oh);
6550 case OFPTYPE_SET_CONTROLLER_ID:
6551 return handle_nxt_set_controller_id(ofconn, oh);
6553 case OFPTYPE_FLOW_AGE:
6554 /* Nothing to do. */
6557 case OFPTYPE_FLOW_MONITOR_CANCEL:
6558 return handle_flow_monitor_cancel(ofconn, oh);
6560 case OFPTYPE_SET_ASYNC_CONFIG:
6561 return handle_nxt_set_async_config(ofconn, oh);
6563 case OFPTYPE_GET_ASYNC_REQUEST:
6564 return handle_nxt_get_async_request(ofconn, oh);
6566 /* Statistics requests. */
6567 case OFPTYPE_DESC_STATS_REQUEST:
6568 return handle_desc_stats_request(ofconn, oh);
6570 case OFPTYPE_FLOW_STATS_REQUEST:
6571 return handle_flow_stats_request(ofconn, oh);
6573 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6574 return handle_aggregate_stats_request(ofconn, oh);
6576 case OFPTYPE_TABLE_STATS_REQUEST:
6577 return handle_table_stats_request(ofconn, oh);
6579 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6580 return handle_table_features_request(ofconn, oh);
6582 case OFPTYPE_PORT_STATS_REQUEST:
6583 return handle_port_stats_request(ofconn, oh);
6585 case OFPTYPE_QUEUE_STATS_REQUEST:
6586 return handle_queue_stats_request(ofconn, oh);
6588 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6589 return handle_port_desc_stats_request(ofconn, oh);
6591 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6592 return handle_flow_monitor_request(ofconn, oh);
6594 case OFPTYPE_METER_STATS_REQUEST:
6595 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6596 return handle_meter_request(ofconn, oh, type);
6598 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6599 return handle_meter_features_request(ofconn, oh);
6601 case OFPTYPE_GROUP_STATS_REQUEST:
6602 return handle_group_stats_request(ofconn, oh);
6604 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6605 return handle_group_desc_stats_request(ofconn, oh);
6607 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6608 return handle_group_features_stats_request(ofconn, oh);
6610 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6611 return handle_queue_get_config_request(ofconn, oh);
6613 case OFPTYPE_BUNDLE_CONTROL:
6614 return handle_bundle_control(ofconn, oh);
6616 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6617 return handle_bundle_add(ofconn, oh);
6621 case OFPTYPE_FEATURES_REPLY:
6622 case OFPTYPE_GET_CONFIG_REPLY:
6623 case OFPTYPE_PACKET_IN:
6624 case OFPTYPE_FLOW_REMOVED:
6625 case OFPTYPE_PORT_STATUS:
6626 case OFPTYPE_BARRIER_REPLY:
6627 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6628 case OFPTYPE_DESC_STATS_REPLY:
6629 case OFPTYPE_FLOW_STATS_REPLY:
6630 case OFPTYPE_QUEUE_STATS_REPLY:
6631 case OFPTYPE_PORT_STATS_REPLY:
6632 case OFPTYPE_TABLE_STATS_REPLY:
6633 case OFPTYPE_AGGREGATE_STATS_REPLY:
6634 case OFPTYPE_PORT_DESC_STATS_REPLY:
6635 case OFPTYPE_ROLE_REPLY:
6636 case OFPTYPE_FLOW_MONITOR_PAUSED:
6637 case OFPTYPE_FLOW_MONITOR_RESUMED:
6638 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6639 case OFPTYPE_GET_ASYNC_REPLY:
6640 case OFPTYPE_GROUP_STATS_REPLY:
6641 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6642 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6643 case OFPTYPE_METER_STATS_REPLY:
6644 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6645 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6646 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6647 case OFPTYPE_ROLE_STATUS:
6649 if (ofpmsg_is_stat_request(oh)) {
6650 return OFPERR_OFPBRC_BAD_STAT;
6652 return OFPERR_OFPBRC_BAD_TYPE;
6658 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6659 OVS_EXCLUDED(ofproto_mutex)
6661 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
6664 ofconn_send_error(ofconn, ofp_msg->data, error);
6666 COVERAGE_INC(ofproto_recv_openflow);
6669 /* Asynchronous operations. */
6672 send_buffered_packet(struct ofconn *ofconn, uint32_t buffer_id,
6674 OVS_REQUIRES(ofproto_mutex)
6676 enum ofperr error = 0;
6677 if (ofconn && buffer_id != UINT32_MAX) {
6678 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6679 struct dp_packet *packet;
6682 error = ofconn_pktbuf_retrieve(ofconn, buffer_id, &packet, &in_port);
6684 struct rule_execute *re;
6686 ofproto_rule_ref(rule);
6688 re = xmalloc(sizeof *re);
6690 re->in_port = in_port;
6691 re->packet = packet;
6693 if (!guarded_list_push_back(&ofproto->rule_executes,
6694 &re->list_node, 1024)) {
6695 ofproto_rule_unref(rule);
6696 dp_packet_delete(re->packet);
6705 pick_datapath_id(const struct ofproto *ofproto)
6707 const struct ofport *port;
6709 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6711 uint8_t ea[ETH_ADDR_LEN];
6714 error = netdev_get_etheraddr(port->netdev, ea);
6716 return eth_addr_to_uint64(ea);
6718 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6719 ofproto->name, netdev_get_name(port->netdev),
6720 ovs_strerror(error));
6722 return ofproto->fallback_dpid;
6726 pick_fallback_dpid(void)
6728 uint8_t ea[ETH_ADDR_LEN];
6729 eth_addr_nicira_random(ea);
6730 return eth_addr_to_uint64(ea);
6733 /* Table overflow policy. */
6735 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6736 * to NULL if the table is not configured to evict rules or if the table
6737 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6738 * or with no timeouts are not evictable.) */
6740 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6741 OVS_REQUIRES(ofproto_mutex)
6743 struct eviction_group *evg;
6746 if (!table->eviction_fields) {
6750 /* In the common case, the outer and inner loops here will each be entered
6753 * - The inner loop normally "return"s in its first iteration. If the
6754 * eviction group has any evictable rules, then it always returns in
6757 * - The outer loop only iterates more than once if the largest eviction
6758 * group has no evictable rules.
6760 * - The outer loop can exit only if table's 'max_flows' is all filled up
6761 * by unevictable rules. */
6762 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6765 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6774 /* Eviction groups. */
6776 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6777 * rules. The priority contains low-order random bits to ensure that eviction
6778 * groups with the same number of rules are prioritized randomly. */
6780 eviction_group_priority(size_t n_rules)
6782 uint16_t size = MIN(UINT16_MAX, n_rules);
6783 return (size << 16) | random_uint16();
6786 /* Updates 'evg', an eviction_group within 'table', following a change that
6787 * adds or removes rules in 'evg'. */
6789 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6790 OVS_REQUIRES(ofproto_mutex)
6792 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6793 eviction_group_priority(heap_count(&evg->rules)));
6796 /* Destroys 'evg', an eviction_group within 'table':
6798 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6799 * rules themselves, just removes them from the eviction group.)
6801 * - Removes 'evg' from 'table'.
6805 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6806 OVS_REQUIRES(ofproto_mutex)
6808 while (!heap_is_empty(&evg->rules)) {
6811 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6812 rule->eviction_group = NULL;
6814 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6815 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6816 heap_destroy(&evg->rules);
6820 /* Removes 'rule' from its eviction group, if any. */
6822 eviction_group_remove_rule(struct rule *rule)
6823 OVS_REQUIRES(ofproto_mutex)
6825 if (rule->eviction_group) {
6826 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6827 struct eviction_group *evg = rule->eviction_group;
6829 rule->eviction_group = NULL;
6830 heap_remove(&evg->rules, &rule->evg_node);
6831 if (heap_is_empty(&evg->rules)) {
6832 eviction_group_destroy(table, evg);
6834 eviction_group_resized(table, evg);
6839 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6840 * returns the hash value. */
6842 eviction_group_hash_rule(struct rule *rule)
6843 OVS_REQUIRES(ofproto_mutex)
6845 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6846 const struct mf_subfield *sf;
6850 hash = table->eviction_group_id_basis;
6851 miniflow_expand(&rule->cr.match.flow, &flow);
6852 for (sf = table->eviction_fields;
6853 sf < &table->eviction_fields[table->n_eviction_fields];
6856 if (mf_are_prereqs_ok(sf->field, &flow)) {
6857 union mf_value value;
6859 mf_get_value(sf->field, &flow, &value);
6861 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6863 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6864 unsigned int start = sf->ofs + sf->n_bits;
6865 bitwise_zero(&value, sf->field->n_bytes, start,
6866 sf->field->n_bytes * 8 - start);
6868 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6870 hash = hash_int(hash, 0);
6877 /* Returns an eviction group within 'table' with the given 'id', creating one
6879 static struct eviction_group *
6880 eviction_group_find(struct oftable *table, uint32_t id)
6881 OVS_REQUIRES(ofproto_mutex)
6883 struct eviction_group *evg;
6885 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6889 evg = xmalloc(sizeof *evg);
6890 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6891 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6892 eviction_group_priority(0));
6893 heap_init(&evg->rules);
6898 /* Returns an eviction priority for 'rule'. The return value should be
6899 * interpreted so that higher priorities make a rule more attractive candidates
6901 * Called only if have a timeout. */
6903 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6904 OVS_REQUIRES(ofproto_mutex)
6906 long long int expiration = LLONG_MAX;
6907 long long int modified;
6908 uint32_t expiration_offset;
6910 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6911 ovs_mutex_lock(&rule->mutex);
6912 modified = rule->modified;
6913 ovs_mutex_unlock(&rule->mutex);
6915 if (rule->hard_timeout) {
6916 expiration = modified + rule->hard_timeout * 1000;
6918 if (rule->idle_timeout) {
6919 uint64_t packets, bytes;
6921 long long int idle_expiration;
6923 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6924 idle_expiration = used + rule->idle_timeout * 1000;
6925 expiration = MIN(expiration, idle_expiration);
6928 if (expiration == LLONG_MAX) {
6932 /* Calculate the time of expiration as a number of (approximate) seconds
6933 * after program startup.
6935 * This should work OK for program runs that last UINT32_MAX seconds or
6936 * less. Therefore, please restart OVS at least once every 136 years. */
6937 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6939 /* Invert the expiration offset because we're using a max-heap. */
6940 return UINT32_MAX - expiration_offset;
6943 /* Adds 'rule' to an appropriate eviction group for its oftable's
6944 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6945 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6948 * The caller must ensure that 'rule' is not already in an eviction group. */
6950 eviction_group_add_rule(struct rule *rule)
6951 OVS_REQUIRES(ofproto_mutex)
6953 struct ofproto *ofproto = rule->ofproto;
6954 struct oftable *table = &ofproto->tables[rule->table_id];
6957 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6958 * so no additional protection is needed. */
6959 has_timeout = rule->hard_timeout || rule->idle_timeout;
6961 if (table->eviction_fields && has_timeout) {
6962 struct eviction_group *evg;
6964 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6966 rule->eviction_group = evg;
6967 heap_insert(&evg->rules, &rule->evg_node,
6968 rule_eviction_priority(ofproto, rule));
6969 eviction_group_resized(table, evg);
6975 /* Initializes 'table'. */
6977 oftable_init(struct oftable *table)
6979 memset(table, 0, sizeof *table);
6980 classifier_init(&table->cls, flow_segment_u64s);
6981 table->max_flows = UINT_MAX;
6982 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
6984 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
6985 ARRAY_SIZE(default_prefix_fields));
6987 atomic_init(&table->n_matched, 0);
6988 atomic_init(&table->n_missed, 0);
6991 /* Destroys 'table', including its classifier and eviction groups.
6993 * The caller is responsible for freeing 'table' itself. */
6995 oftable_destroy(struct oftable *table)
6997 ovs_assert(classifier_is_empty(&table->cls));
6998 oftable_disable_eviction(table);
6999 classifier_destroy(&table->cls);
7003 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7004 * string, then 'table' will use its default name.
7006 * This only affects the name exposed for a table exposed through the OpenFlow
7007 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7009 oftable_set_name(struct oftable *table, const char *name)
7011 if (name && name[0]) {
7012 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7013 if (!table->name || strncmp(name, table->name, len)) {
7015 table->name = xmemdup0(name, len);
7023 /* oftables support a choice of two policies when adding a rule would cause the
7024 * number of flows in the table to exceed the configured maximum number: either
7025 * they can refuse to add the new flow or they can evict some existing flow.
7026 * This function configures the former policy on 'table'. */
7028 oftable_disable_eviction(struct oftable *table)
7029 OVS_REQUIRES(ofproto_mutex)
7031 if (table->eviction_fields) {
7032 struct eviction_group *evg, *next;
7034 HMAP_FOR_EACH_SAFE (evg, next, id_node,
7035 &table->eviction_groups_by_id) {
7036 eviction_group_destroy(table, evg);
7038 hmap_destroy(&table->eviction_groups_by_id);
7039 heap_destroy(&table->eviction_groups_by_size);
7041 free(table->eviction_fields);
7042 table->eviction_fields = NULL;
7043 table->n_eviction_fields = 0;
7047 /* oftables support a choice of two policies when adding a rule would cause the
7048 * number of flows in the table to exceed the configured maximum number: either
7049 * they can refuse to add the new flow or they can evict some existing flow.
7050 * This function configures the latter policy on 'table', with fairness based
7051 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7052 * 'n_fields' as 0 disables fairness.) */
7054 oftable_enable_eviction(struct oftable *table,
7055 const struct mf_subfield *fields, size_t n_fields)
7056 OVS_REQUIRES(ofproto_mutex)
7060 if (table->eviction_fields
7061 && n_fields == table->n_eviction_fields
7063 || !memcmp(fields, table->eviction_fields,
7064 n_fields * sizeof *fields))) {
7069 oftable_disable_eviction(table);
7071 table->n_eviction_fields = n_fields;
7072 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
7074 table->eviction_group_id_basis = random_uint32();
7075 hmap_init(&table->eviction_groups_by_id);
7076 heap_init(&table->eviction_groups_by_size);
7078 CLS_FOR_EACH (rule, cr, &table->cls) {
7079 eviction_group_add_rule(rule);
7083 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7084 * it to the classifier. */
7086 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7087 OVS_REQUIRES(ofproto_mutex)
7089 const struct rule_actions *actions = rule_get_actions(rule);
7091 if (rule->hard_timeout || rule->idle_timeout) {
7092 list_insert(&ofproto->expirable, &rule->expirable);
7094 cookies_insert(ofproto, rule);
7095 eviction_group_add_rule(rule);
7096 if (actions->has_meter) {
7097 meter_insert_rule(rule);
7101 /* Removes 'rule' from the ofproto data structures AFTER caller has removed
7102 * it from the classifier. */
7104 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7105 OVS_REQUIRES(ofproto_mutex)
7107 cookies_remove(ofproto, rule);
7109 eviction_group_remove_rule(rule);
7110 if (!list_is_empty(&rule->expirable)) {
7111 list_remove(&rule->expirable);
7113 if (!list_is_empty(&rule->meter_list_node)) {
7114 list_remove(&rule->meter_list_node);
7115 list_init(&rule->meter_list_node);
7120 oftable_remove_rule(struct rule *rule)
7121 OVS_REQUIRES(ofproto_mutex)
7123 struct classifier *cls = &rule->ofproto->tables[rule->table_id].cls;
7125 if (classifier_remove(cls, &rule->cr)) {
7126 ofproto_rule_remove__(rule->ofproto, rule);
7130 /* unixctl commands. */
7133 ofproto_lookup(const char *name)
7135 struct ofproto *ofproto;
7137 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7139 if (!strcmp(ofproto->name, name)) {
7147 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7148 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7150 struct ofproto *ofproto;
7154 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7155 ds_put_format(&results, "%s\n", ofproto->name);
7157 unixctl_command_reply(conn, ds_cstr(&results));
7158 ds_destroy(&results);
7162 ofproto_unixctl_init(void)
7164 static bool registered;
7170 unixctl_command_register("ofproto/list", "", 0, 0,
7171 ofproto_unixctl_list, NULL);
7174 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7176 * This is deprecated. It is only for compatibility with broken device drivers
7177 * in old versions of Linux that do not properly support VLANs when VLAN
7178 * devices are not used. When broken device drivers are no longer in
7179 * widespread use, we will delete these interfaces. */
7181 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7182 * (exactly) by an OpenFlow rule in 'ofproto'. */
7184 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7187 struct cls_rule target;
7188 const struct oftable *oftable;
7190 match_init_catchall(&match);
7191 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7192 cls_rule_init(&target, &match, 0);
7194 free(ofproto->vlan_bitmap);
7195 ofproto->vlan_bitmap = bitmap_allocate(4096);
7196 ofproto->vlans_changed = false;
7198 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7201 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7202 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7203 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7205 bitmap_set1(vlan_bitmap, vid);
7206 bitmap_set1(ofproto->vlan_bitmap, vid);
7211 cls_rule_destroy(&target);
7214 /* Returns true if new VLANs have come into use by the flow table since the
7215 * last call to ofproto_get_vlan_usage().
7217 * We don't track when old VLANs stop being used. */
7219 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7221 return ofproto->vlans_changed;
7224 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7225 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7226 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7227 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7228 * then the VLAN device is un-enslaved. */
7230 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7231 ofp_port_t realdev_ofp_port, int vid)
7233 struct ofport *ofport;
7236 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7238 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7240 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7241 ofproto->name, vlandev_ofp_port);
7245 if (!ofproto->ofproto_class->set_realdev) {
7246 if (!vlandev_ofp_port) {
7249 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7253 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7255 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7256 ofproto->name, vlandev_ofp_port,
7257 netdev_get_name(ofport->netdev), ovs_strerror(error));