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,
157 ovs_be64 cookie, ovs_be64 cookie_mask,
158 ofp_port_t out_port, uint32_t out_group);
159 static void rule_criteria_require_rw(struct rule_criteria *,
160 bool can_write_readonly);
161 static void rule_criteria_destroy(struct rule_criteria *);
163 static enum ofperr collect_rules_loose(struct ofproto *,
164 const struct rule_criteria *,
165 struct rule_collection *);
167 /* A packet that needs to be passed to rule_execute().
169 * (We can't do this immediately from ofopgroup_complete() because that holds
170 * ofproto_mutex, which rule_execute() needs released.) */
171 struct rule_execute {
172 struct ovs_list list_node; /* In struct ofproto's "rule_executes" list. */
173 struct rule *rule; /* Owns a reference to the rule. */
175 struct dp_packet *packet; /* Owns the packet. */
178 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
179 static void destroy_rule_executes(struct ofproto *);
181 struct learned_cookie {
183 /* In struct ofproto's 'learned_cookies' hmap. */
184 struct hmap_node hmap_node OVS_GUARDED_BY(ofproto_mutex);
186 /* In 'dead_cookies' list when removed from hmap. */
187 struct ovs_list list_node;
191 ovs_be64 cookie OVS_GUARDED_BY(ofproto_mutex);
192 uint8_t table_id OVS_GUARDED_BY(ofproto_mutex);
194 /* Number of references from "learn" actions.
196 * When this drops to 0, all of the flows in 'table_id' with the specified
197 * 'cookie' are deleted. */
198 int n OVS_GUARDED_BY(ofproto_mutex);
201 static const struct ofpact_learn *next_learn_with_delete(
202 const struct rule_actions *, const struct ofpact_learn *start);
204 static void learned_cookies_inc(struct ofproto *, const struct rule_actions *)
205 OVS_REQUIRES(ofproto_mutex);
206 static void learned_cookies_dec(struct ofproto *, const struct rule_actions *,
207 struct ovs_list *dead_cookies)
208 OVS_REQUIRES(ofproto_mutex);
209 static void learned_cookies_flush(struct ofproto *, struct ovs_list *dead_cookies)
210 OVS_REQUIRES(ofproto_mutex);
213 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
214 static void ofport_destroy(struct ofport *);
216 static void update_port(struct ofproto *, const char *devname);
217 static int init_ports(struct ofproto *);
218 static void reinit_ports(struct ofproto *);
220 static long long int ofport_get_usage(const struct ofproto *,
221 ofp_port_t ofp_port);
222 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
223 long long int last_used);
224 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
228 * Keeps track of the currently used and recently used ofport values and is
229 * used to prevent immediate recycling of ofport values. */
230 struct ofport_usage {
231 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
232 ofp_port_t ofp_port; /* OpenFlow port number. */
233 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
234 represents in-use ofports. */
238 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
239 static bool rule_is_readonly(const struct rule *);
240 static void ofproto_rule_insert__(struct ofproto *, struct rule *)
241 OVS_REQUIRES(ofproto_mutex);
242 static void ofproto_rule_remove__(struct ofproto *, struct rule *)
243 OVS_REQUIRES(ofproto_mutex);
245 /* The source of a flow_mod request, in the code that processes flow_mods.
247 * A flow table modification request can be generated externally, via OpenFlow,
248 * or internally through a function call. This structure indicates the source
249 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
250 * meaningful and thus supplied as NULL. */
251 struct flow_mod_requester {
252 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
253 const struct ofp_header *request;
257 static enum ofperr modify_flow_check__(struct ofproto *,
258 struct ofputil_flow_mod *,
260 OVS_REQUIRES(ofproto_mutex);
261 static void modify_flow__(struct ofproto *, struct ofputil_flow_mod *,
262 const struct flow_mod_requester *, struct rule *,
263 struct ovs_list *dead_cookies)
264 OVS_REQUIRES(ofproto_mutex);
265 static void delete_flows__(const struct rule_collection *,
266 enum ofp_flow_removed_reason,
267 const struct flow_mod_requester *)
268 OVS_REQUIRES(ofproto_mutex);
270 static void send_buffered_packet(const struct flow_mod_requester *,
271 uint32_t buffer_id, struct rule *)
272 OVS_REQUIRES(ofproto_mutex);
274 static bool ofproto_group_exists__(const struct ofproto *ofproto,
276 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
277 static bool ofproto_group_exists(const struct ofproto *ofproto,
279 OVS_EXCLUDED(ofproto->groups_rwlock);
280 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
281 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
282 static enum ofperr do_bundle_flow_mod_start(struct ofproto *,
283 struct ofputil_flow_mod *,
284 struct ofp_bundle_entry *)
285 OVS_REQUIRES(ofproto_mutex);
286 static void do_bundle_flow_mod_finish(struct ofproto *,
287 struct ofputil_flow_mod *,
288 const struct flow_mod_requester *,
289 struct ofp_bundle_entry *)
290 OVS_REQUIRES(ofproto_mutex);
291 static enum ofperr handle_flow_mod__(struct ofproto *,
292 struct ofputil_flow_mod *,
293 const struct flow_mod_requester *)
294 OVS_EXCLUDED(ofproto_mutex);
295 static void calc_duration(long long int start, long long int now,
296 uint32_t *sec, uint32_t *nsec);
299 static uint64_t pick_datapath_id(const struct ofproto *);
300 static uint64_t pick_fallback_dpid(void);
301 static void ofproto_destroy__(struct ofproto *);
302 static void update_mtu(struct ofproto *, struct ofport *);
303 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
304 static void meter_insert_rule(struct rule *);
307 static void ofproto_unixctl_init(void);
309 /* All registered ofproto classes, in probe order. */
310 static const struct ofproto_class **ofproto_classes;
311 static size_t n_ofproto_classes;
312 static size_t allocated_ofproto_classes;
314 /* Global lock that protects all flow table operations. */
315 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
317 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
318 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
320 size_t n_handlers, n_revalidators;
324 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
325 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
327 /* Initial mappings of port to OpenFlow number mappings. */
328 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
330 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
332 /* The default value of true waits for flow restore. */
333 static bool flow_restore_wait = true;
335 /* Must be called to initialize the ofproto library.
337 * The caller may pass in 'iface_hints', which contains an shash of
338 * "iface_hint" elements indexed by the interface's name. The provider
339 * may use these hints to describe the startup configuration in order to
340 * reinitialize its state. The caller owns the provided data, so a
341 * provider will make copies of anything required. An ofproto provider
342 * will remove any existing state that is not described by the hint, and
343 * may choose to remove it all. */
345 ofproto_init(const struct shash *iface_hints)
347 struct shash_node *node;
350 ofproto_class_register(&ofproto_dpif_class);
352 /* Make a local copy, since we don't own 'iface_hints' elements. */
353 SHASH_FOR_EACH(node, iface_hints) {
354 const struct iface_hint *orig_hint = node->data;
355 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
356 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
358 new_hint->br_name = xstrdup(orig_hint->br_name);
359 new_hint->br_type = xstrdup(br_type);
360 new_hint->ofp_port = orig_hint->ofp_port;
362 shash_add(&init_ofp_ports, node->name, new_hint);
365 for (i = 0; i < n_ofproto_classes; i++) {
366 ofproto_classes[i]->init(&init_ofp_ports);
370 /* 'type' should be a normalized datapath type, as returned by
371 * ofproto_normalize_type(). Returns the corresponding ofproto_class
372 * structure, or a null pointer if there is none registered for 'type'. */
373 static const struct ofproto_class *
374 ofproto_class_find__(const char *type)
378 for (i = 0; i < n_ofproto_classes; i++) {
379 const struct ofproto_class *class = ofproto_classes[i];
384 class->enumerate_types(&types);
385 found = sset_contains(&types, type);
386 sset_destroy(&types);
392 VLOG_WARN("unknown datapath type %s", type);
396 /* Registers a new ofproto class. After successful registration, new ofprotos
397 * of that type can be created using ofproto_create(). */
399 ofproto_class_register(const struct ofproto_class *new_class)
403 for (i = 0; i < n_ofproto_classes; i++) {
404 if (ofproto_classes[i] == new_class) {
409 if (n_ofproto_classes >= allocated_ofproto_classes) {
410 ofproto_classes = x2nrealloc(ofproto_classes,
411 &allocated_ofproto_classes,
412 sizeof *ofproto_classes);
414 ofproto_classes[n_ofproto_classes++] = new_class;
418 /* Unregisters a datapath provider. 'type' must have been previously
419 * registered and not currently be in use by any ofprotos. After
420 * unregistration new datapaths of that type cannot be opened using
421 * ofproto_create(). */
423 ofproto_class_unregister(const struct ofproto_class *class)
427 for (i = 0; i < n_ofproto_classes; i++) {
428 if (ofproto_classes[i] == class) {
429 for (i++; i < n_ofproto_classes; i++) {
430 ofproto_classes[i - 1] = ofproto_classes[i];
436 VLOG_WARN("attempted to unregister an ofproto class that is not "
441 /* Clears 'types' and enumerates all registered ofproto types into it. The
442 * caller must first initialize the sset. */
444 ofproto_enumerate_types(struct sset *types)
449 for (i = 0; i < n_ofproto_classes; i++) {
450 ofproto_classes[i]->enumerate_types(types);
454 /* Returns the fully spelled out name for the given ofproto 'type'.
456 * Normalized type string can be compared with strcmp(). Unnormalized type
457 * string might be the same even if they have different spellings. */
459 ofproto_normalize_type(const char *type)
461 return type && type[0] ? type : "system";
464 /* Clears 'names' and enumerates the names of all known created ofprotos with
465 * the given 'type'. The caller must first initialize the sset. Returns 0 if
466 * successful, otherwise a positive errno value.
468 * Some kinds of datapaths might not be practically enumerable. This is not
469 * considered an error. */
471 ofproto_enumerate_names(const char *type, struct sset *names)
473 const struct ofproto_class *class = ofproto_class_find__(type);
474 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
478 ofproto_create(const char *datapath_name, const char *datapath_type,
479 struct ofproto **ofprotop)
481 const struct ofproto_class *class;
482 struct ofproto *ofproto;
488 ofproto_unixctl_init();
490 datapath_type = ofproto_normalize_type(datapath_type);
491 class = ofproto_class_find__(datapath_type);
493 VLOG_WARN("could not create datapath %s of unknown type %s",
494 datapath_name, datapath_type);
498 ofproto = class->alloc();
500 VLOG_ERR("failed to allocate datapath %s of type %s",
501 datapath_name, datapath_type);
506 ovs_mutex_lock(&ofproto_mutex);
507 memset(ofproto, 0, sizeof *ofproto);
508 ofproto->ofproto_class = class;
509 ofproto->name = xstrdup(datapath_name);
510 ofproto->type = xstrdup(datapath_type);
511 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
512 hash_string(ofproto->name, 0));
513 ofproto->datapath_id = 0;
514 ofproto->forward_bpdu = false;
515 ofproto->fallback_dpid = pick_fallback_dpid();
516 ofproto->mfr_desc = NULL;
517 ofproto->hw_desc = NULL;
518 ofproto->sw_desc = NULL;
519 ofproto->serial_desc = NULL;
520 ofproto->dp_desc = NULL;
521 ofproto->frag_handling = OFPC_FRAG_NORMAL;
522 hmap_init(&ofproto->ports);
523 hmap_init(&ofproto->ofport_usage);
524 shash_init(&ofproto->port_by_name);
525 simap_init(&ofproto->ofp_requests);
526 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
527 ofproto->eviction_group_timer = LLONG_MIN;
528 ofproto->tables = NULL;
529 ofproto->n_tables = 0;
530 hindex_init(&ofproto->cookies);
531 hmap_init(&ofproto->learned_cookies);
532 list_init(&ofproto->expirable);
533 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
534 guarded_list_init(&ofproto->rule_executes);
535 ofproto->vlan_bitmap = NULL;
536 ofproto->vlans_changed = false;
537 ofproto->min_mtu = INT_MAX;
538 ovs_rwlock_init(&ofproto->groups_rwlock);
539 hmap_init(&ofproto->groups);
540 ovs_mutex_unlock(&ofproto_mutex);
541 ofproto->ogf.types = 0xf;
542 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
543 OFPGFC_SELECT_WEIGHT;
544 for (i = 0; i < 4; i++) {
545 ofproto->ogf.max_groups[i] = OFPG_MAX;
546 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
549 error = ofproto->ofproto_class->construct(ofproto);
551 VLOG_ERR("failed to open datapath %s: %s",
552 datapath_name, ovs_strerror(error));
553 connmgr_destroy(ofproto->connmgr);
554 ofproto_destroy__(ofproto);
558 /* Check that hidden tables, if any, are at the end. */
559 ovs_assert(ofproto->n_tables);
560 for (i = 0; i + 1 < ofproto->n_tables; i++) {
561 enum oftable_flags flags = ofproto->tables[i].flags;
562 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
564 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
567 ofproto->datapath_id = pick_datapath_id(ofproto);
570 /* Initialize meters table. */
571 if (ofproto->ofproto_class->meter_get_features) {
572 ofproto->ofproto_class->meter_get_features(ofproto,
573 &ofproto->meter_features);
575 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
577 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
578 * sizeof(struct meter *));
584 /* Must be called (only) by an ofproto implementation in its constructor
585 * function. See the large comment on 'construct' in struct ofproto_class for
588 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
590 struct oftable *table;
592 ovs_assert(!ofproto->n_tables);
593 ovs_assert(n_tables >= 1 && n_tables <= 255);
595 ofproto->n_tables = n_tables;
596 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
597 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
602 /* To be optionally called (only) by an ofproto implementation in its
603 * constructor function. See the large comment on 'construct' in struct
604 * ofproto_class for details.
606 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
607 * will then ensure that actions passed into the ofproto implementation will
608 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
609 * function is not called, there will be no such restriction.
611 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
612 * the 'max_ports' restriction. */
614 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
616 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
617 ofproto->max_ports = max_ports;
621 ofproto_get_datapath_id(const struct ofproto *ofproto)
623 return ofproto->datapath_id;
627 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
629 uint64_t old_dpid = p->datapath_id;
630 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
631 if (p->datapath_id != old_dpid) {
632 /* Force all active connections to reconnect, since there is no way to
633 * notify a controller that the datapath ID has changed. */
634 ofproto_reconnect_controllers(p);
639 ofproto_set_controllers(struct ofproto *p,
640 const struct ofproto_controller *controllers,
641 size_t n_controllers, uint32_t allowed_versions)
643 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
648 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
650 connmgr_set_fail_mode(p->connmgr, fail_mode);
653 /* Drops the connections between 'ofproto' and all of its controllers, forcing
654 * them to reconnect. */
656 ofproto_reconnect_controllers(struct ofproto *ofproto)
658 connmgr_reconnect(ofproto->connmgr);
661 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
662 * in-band control should guarantee access, in the same way that in-band
663 * control guarantees access to OpenFlow controllers. */
665 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
666 const struct sockaddr_in *extras, size_t n)
668 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
671 /* Sets the OpenFlow queue used by flows set up by in-band control on
672 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
673 * flows will use the default queue. */
675 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
677 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
680 /* Sets the number of flows at which eviction from the kernel flow table
683 ofproto_set_flow_limit(unsigned limit)
685 ofproto_flow_limit = limit;
688 /* Sets the maximum idle time for flows in the datapath before they are
691 ofproto_set_max_idle(unsigned max_idle)
693 ofproto_max_idle = max_idle;
696 /* If forward_bpdu is true, the NORMAL action will forward frames with
697 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
698 * the NORMAL action will drop these frames. */
700 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
702 bool old_val = ofproto->forward_bpdu;
703 ofproto->forward_bpdu = forward_bpdu;
704 if (old_val != ofproto->forward_bpdu) {
705 if (ofproto->ofproto_class->forward_bpdu_changed) {
706 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
711 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
712 * 'idle_time', in seconds, and the maximum number of MAC table entries to
715 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
718 if (ofproto->ofproto_class->set_mac_table_config) {
719 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
724 /* Multicast snooping configuration. */
726 /* Configures multicast snooping on 'ofproto' using the settings
727 * defined in 's'. If 's' is NULL, disables multicast snooping.
729 * Returns 0 if successful, otherwise a positive errno value. */
731 ofproto_set_mcast_snooping(struct ofproto *ofproto,
732 const struct ofproto_mcast_snooping_settings *s)
734 return (ofproto->ofproto_class->set_mcast_snooping
735 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
739 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
741 * Returns 0 if successful, otherwise a positive errno value.*/
743 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
744 const struct ofproto_mcast_snooping_port_settings *s)
746 return (ofproto->ofproto_class->set_mcast_snooping_port
747 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
752 ofproto_set_n_dpdk_rxqs(int n_rxqs)
754 n_dpdk_rxqs = MAX(n_rxqs, 0);
758 ofproto_set_cpu_mask(const char *cmask)
762 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
766 ofproto_set_threads(int n_handlers_, int n_revalidators_)
768 int threads = MAX(count_cpu_cores(), 2);
770 n_revalidators = MAX(n_revalidators_, 0);
771 n_handlers = MAX(n_handlers_, 0);
773 if (!n_revalidators) {
774 n_revalidators = n_handlers
775 ? MAX(threads - (int) n_handlers, 1)
780 n_handlers = MAX(threads - (int) n_revalidators, 1);
785 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
788 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
792 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
794 return connmgr_set_snoops(ofproto->connmgr, snoops);
798 ofproto_set_netflow(struct ofproto *ofproto,
799 const struct netflow_options *nf_options)
801 if (nf_options && sset_is_empty(&nf_options->collectors)) {
805 if (ofproto->ofproto_class->set_netflow) {
806 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
808 return nf_options ? EOPNOTSUPP : 0;
813 ofproto_set_sflow(struct ofproto *ofproto,
814 const struct ofproto_sflow_options *oso)
816 if (oso && sset_is_empty(&oso->targets)) {
820 if (ofproto->ofproto_class->set_sflow) {
821 return ofproto->ofproto_class->set_sflow(ofproto, oso);
823 return oso ? EOPNOTSUPP : 0;
828 ofproto_set_ipfix(struct ofproto *ofproto,
829 const struct ofproto_ipfix_bridge_exporter_options *bo,
830 const struct ofproto_ipfix_flow_exporter_options *fo,
833 if (ofproto->ofproto_class->set_ipfix) {
834 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
836 return (bo || fo) ? EOPNOTSUPP : 0;
841 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
843 flow_restore_wait = flow_restore_wait_db;
847 ofproto_get_flow_restore_wait(void)
849 return flow_restore_wait;
853 /* Spanning Tree Protocol (STP) configuration. */
855 /* Configures STP on 'ofproto' using the settings defined in 's'. If
856 * 's' is NULL, disables STP.
858 * Returns 0 if successful, otherwise a positive errno value. */
860 ofproto_set_stp(struct ofproto *ofproto,
861 const struct ofproto_stp_settings *s)
863 return (ofproto->ofproto_class->set_stp
864 ? ofproto->ofproto_class->set_stp(ofproto, s)
868 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
869 * 'enabled' member of 's' is false, then the other members are not
872 * Returns 0 if successful, otherwise a positive errno value. */
874 ofproto_get_stp_status(struct ofproto *ofproto,
875 struct ofproto_stp_status *s)
877 return (ofproto->ofproto_class->get_stp_status
878 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
882 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
883 * in 's'. The caller is responsible for assigning STP port numbers
884 * (using the 'port_num' member in the range of 1 through 255, inclusive)
885 * and ensuring there are no duplicates. If the 's' is NULL, then STP
886 * is disabled on the port.
888 * Returns 0 if successful, otherwise a positive errno value.*/
890 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
891 const struct ofproto_port_stp_settings *s)
893 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
895 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
896 ofproto->name, ofp_port);
900 return (ofproto->ofproto_class->set_stp_port
901 ? ofproto->ofproto_class->set_stp_port(ofport, s)
905 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
906 * 's'. If the 'enabled' member in 's' is false, then the other members
907 * are not meaningful.
909 * Returns 0 if successful, otherwise a positive errno value.*/
911 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
912 struct ofproto_port_stp_status *s)
914 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
916 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
917 "port %"PRIu16, ofproto->name, ofp_port);
921 return (ofproto->ofproto_class->get_stp_port_status
922 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
926 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
927 * 's'. If the 'enabled' member in 's' is false, then the other members
928 * are not meaningful.
930 * Returns 0 if successful, otherwise a positive errno value.*/
932 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
933 struct ofproto_port_stp_stats *s)
935 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
937 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
938 "port %"PRIu16, ofproto->name, ofp_port);
942 return (ofproto->ofproto_class->get_stp_port_stats
943 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
947 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
949 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
950 * 's' is NULL, disables RSTP.
952 * Returns 0 if successful, otherwise a positive errno value. */
954 ofproto_set_rstp(struct ofproto *ofproto,
955 const struct ofproto_rstp_settings *s)
957 if (!ofproto->ofproto_class->set_rstp) {
960 ofproto->ofproto_class->set_rstp(ofproto, s);
964 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
965 * 'enabled' member of 's' is false, then the other members are not
968 * Returns 0 if successful, otherwise a positive errno value. */
970 ofproto_get_rstp_status(struct ofproto *ofproto,
971 struct ofproto_rstp_status *s)
973 if (!ofproto->ofproto_class->get_rstp_status) {
976 ofproto->ofproto_class->get_rstp_status(ofproto, s);
980 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
981 * in 's'. The caller is responsible for assigning RSTP port numbers
982 * (using the 'port_num' member in the range of 1 through 255, inclusive)
983 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
984 * is disabled on the port.
986 * Returns 0 if successful, otherwise a positive errno value.*/
988 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
989 const struct ofproto_port_rstp_settings *s)
991 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
993 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
994 ofproto->name, ofp_port);
998 if (!ofproto->ofproto_class->set_rstp_port) {
1001 ofproto->ofproto_class->set_rstp_port(ofport, s);
1005 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1006 * 's'. If the 'enabled' member in 's' is false, then the other members
1007 * are not meaningful.
1009 * Returns 0 if successful, otherwise a positive errno value.*/
1011 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1012 struct ofproto_port_rstp_status *s)
1014 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1016 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1017 "port %"PRIu16, ofproto->name, ofp_port);
1021 if (!ofproto->ofproto_class->get_rstp_port_status) {
1024 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1028 /* Queue DSCP configuration. */
1030 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1031 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1032 * to implement QoS. Instead, it is used to implement features which require
1033 * knowledge of what queues exist on a port, and some basic information about
1036 * Returns 0 if successful, otherwise a positive errno value. */
1038 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1039 const struct ofproto_port_queue *queues,
1042 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1045 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1046 ofproto->name, ofp_port);
1050 return (ofproto->ofproto_class->set_queues
1051 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1055 /* LLDP configuration. */
1057 ofproto_port_set_lldp(struct ofproto *ofproto,
1058 ofp_port_t ofp_port,
1059 const struct smap *cfg)
1061 struct ofport *ofport;
1064 ofport = ofproto_get_port(ofproto, ofp_port);
1066 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1067 ofproto->name, ofp_port);
1070 error = (ofproto->ofproto_class->set_lldp
1071 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1074 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1075 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1076 ovs_strerror(error));
1081 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1082 const struct aa_settings *s)
1084 if (!ofproto->ofproto_class->set_aa) {
1087 ofproto->ofproto_class->set_aa(ofproto, s);
1092 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1093 const struct aa_mapping_settings *s)
1095 if (!ofproto->ofproto_class->aa_mapping_set) {
1098 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1103 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1105 if (!ofproto->ofproto_class->aa_mapping_unset) {
1108 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1113 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1114 struct ovs_list *list)
1116 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1119 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1124 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1126 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1129 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1132 /* Connectivity Fault Management configuration. */
1134 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1136 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1138 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1139 if (ofport && ofproto->ofproto_class->set_cfm) {
1140 ofproto->ofproto_class->set_cfm(ofport, NULL);
1144 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1145 * basic configuration from the configuration members in 'cfm', and the remote
1146 * maintenance point ID from remote_mpid. Ignores the statistics members of
1149 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1151 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1152 const struct cfm_settings *s)
1154 struct ofport *ofport;
1157 ofport = ofproto_get_port(ofproto, ofp_port);
1159 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1160 ofproto->name, ofp_port);
1164 /* XXX: For configuration simplicity, we only support one remote_mpid
1165 * outside of the CFM module. It's not clear if this is the correct long
1166 * term solution or not. */
1167 error = (ofproto->ofproto_class->set_cfm
1168 ? ofproto->ofproto_class->set_cfm(ofport, s)
1171 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1172 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1173 ovs_strerror(error));
1177 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1178 * 'ofproto' does not have a port 'ofp_port'. */
1180 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1181 const struct smap *cfg)
1183 struct ofport *ofport;
1186 ofport = ofproto_get_port(ofproto, ofp_port);
1188 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1189 ofproto->name, ofp_port);
1193 error = (ofproto->ofproto_class->set_bfd
1194 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1197 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1198 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1199 ovs_strerror(error));
1203 /* Checks the status change of BFD on 'ofport'.
1205 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1207 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1209 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1210 return (ofport && ofproto->ofproto_class->bfd_status_changed
1211 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1215 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1216 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1217 * is not an OpenFlow port in 'ofproto'.
1219 * The caller must provide and own '*status'. */
1221 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1222 struct smap *status)
1224 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1225 return (ofport && ofproto->ofproto_class->get_bfd_status
1226 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1230 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1231 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1232 * 0 if LACP partner information is not current (generally indicating a
1233 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1235 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1237 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1238 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1239 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1244 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1246 struct ofproto *ofproto = port->ofproto;
1249 if (ofproto->ofproto_class->port_get_lacp_stats) {
1250 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1260 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1261 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1262 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1263 * configuration plus, if there is more than one slave, a bonding
1266 * If 'aux' is already registered then this function updates its configuration
1267 * to 's'. Otherwise, this function registers a new bundle.
1269 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1272 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1273 const struct ofproto_bundle_settings *s)
1275 return (ofproto->ofproto_class->bundle_set
1276 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1280 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1281 * If no such bundle has been registered, this has no effect. */
1283 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1285 return ofproto_bundle_register(ofproto, aux, NULL);
1289 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1290 * If 'aux' is already registered then this function updates its configuration
1291 * to 's'. Otherwise, this function registers a new mirror. */
1293 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1294 const struct ofproto_mirror_settings *s)
1296 return (ofproto->ofproto_class->mirror_set
1297 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1301 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1302 * If no mirror has been registered, this has no effect. */
1304 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1306 return ofproto_mirror_register(ofproto, aux, NULL);
1309 /* Retrieves statistics from mirror associated with client data pointer
1310 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1311 * 'bytes', respectively. If a particular counters is not supported,
1312 * the appropriate argument is set to UINT64_MAX.
1315 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1316 uint64_t *packets, uint64_t *bytes)
1318 if (!ofproto->ofproto_class->mirror_get_stats) {
1319 *packets = *bytes = UINT64_MAX;
1323 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1327 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1328 * which all packets are flooded, instead of using MAC learning. If
1329 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1331 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1334 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1336 return (ofproto->ofproto_class->set_flood_vlans
1337 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1341 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1342 * output for a mirror. */
1344 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1346 return (ofproto->ofproto_class->is_mirror_output_bundle
1347 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1351 /* Configuration of OpenFlow tables. */
1353 /* Returns the number of OpenFlow tables in 'ofproto'. */
1355 ofproto_get_n_tables(const struct ofproto *ofproto)
1357 return ofproto->n_tables;
1360 /* Returns the number of Controller visible OpenFlow tables
1361 * in 'ofproto'. This number will exclude Hidden tables.
1362 * This funtion's return value should be less or equal to that of
1363 * ofproto_get_n_tables() . */
1365 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1367 uint8_t n = ofproto->n_tables;
1369 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1370 * if present, are always at the end.) */
1371 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1378 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1379 * settings from 's'. 'table_id' must be in the range 0 through the number of
1380 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1382 * For read-only tables, only the name may be configured. */
1384 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1385 const struct ofproto_table_settings *s)
1387 struct oftable *table;
1389 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1390 table = &ofproto->tables[table_id];
1392 oftable_set_name(table, s->name);
1394 if (table->flags & OFTABLE_READONLY) {
1399 oftable_enable_eviction(table, s->groups, s->n_groups);
1401 oftable_disable_eviction(table);
1404 table->max_flows = s->max_flows;
1406 if (classifier_set_prefix_fields(&table->cls,
1407 s->prefix_fields, s->n_prefix_fields)) {
1408 /* XXX: Trigger revalidation. */
1411 ovs_mutex_lock(&ofproto_mutex);
1412 evict_rules_from_table(table, 0);
1413 ovs_mutex_unlock(&ofproto_mutex);
1417 ofproto_has_snoops(const struct ofproto *ofproto)
1419 return connmgr_has_snoops(ofproto->connmgr);
1423 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1425 connmgr_get_snoops(ofproto->connmgr, snoops);
1428 /* Deletes 'rule' from 'ofproto'.
1430 * Within an ofproto implementation, this function allows an ofproto
1431 * implementation to destroy any rules that remain when its ->destruct()
1432 * function is called. This function is not suitable for use elsewhere in an
1433 * ofproto implementation.
1435 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1436 * Cycle" in ofproto-provider.h. */
1438 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1439 OVS_EXCLUDED(ofproto_mutex)
1441 /* This skips the ofmonitor and flow-removed notifications because the
1442 * switch is being deleted and any OpenFlow channels have been or soon will
1444 ovs_mutex_lock(&ofproto_mutex);
1445 oftable_remove_rule(rule);
1446 ofproto->ofproto_class->rule_delete(rule);
1447 ofproto_rule_unref(rule);
1448 ovs_mutex_unlock(&ofproto_mutex);
1452 ofproto_flush__(struct ofproto *ofproto)
1453 OVS_EXCLUDED(ofproto_mutex)
1455 struct oftable *table;
1457 /* This will flush all datapath flows. */
1458 if (ofproto->ofproto_class->flush) {
1459 ofproto->ofproto_class->flush(ofproto);
1462 /* XXX: There is a small race window here, where new datapath flows can be
1463 * created by upcall handlers based on the existing flow table. We can not
1464 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1465 * as then we could deadlock on syncing with the handler threads waiting on
1466 * the same mutex. */
1468 ovs_mutex_lock(&ofproto_mutex);
1469 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1470 struct rule_collection rules;
1473 if (table->flags & OFTABLE_HIDDEN) {
1477 rule_collection_init(&rules);
1479 CLS_FOR_EACH (rule, cr, &table->cls) {
1480 rule_collection_add(&rules, rule);
1482 delete_flows__(&rules, OFPRR_DELETE, NULL);
1483 rule_collection_destroy(&rules);
1485 /* XXX: Concurrent handler threads may insert new learned flows based on
1486 * learn actions of the now deleted flows right after we release
1487 * 'ofproto_mutex'. */
1488 ovs_mutex_unlock(&ofproto_mutex);
1491 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1494 ofproto_destroy__(struct ofproto *ofproto)
1495 OVS_EXCLUDED(ofproto_mutex)
1497 struct oftable *table;
1499 destroy_rule_executes(ofproto);
1500 delete_group(ofproto, OFPG_ALL);
1502 guarded_list_destroy(&ofproto->rule_executes);
1503 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1504 hmap_destroy(&ofproto->groups);
1506 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1507 free(ofproto->name);
1508 free(ofproto->type);
1509 free(ofproto->mfr_desc);
1510 free(ofproto->hw_desc);
1511 free(ofproto->sw_desc);
1512 free(ofproto->serial_desc);
1513 free(ofproto->dp_desc);
1514 hmap_destroy(&ofproto->ports);
1515 hmap_destroy(&ofproto->ofport_usage);
1516 shash_destroy(&ofproto->port_by_name);
1517 simap_destroy(&ofproto->ofp_requests);
1519 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1520 oftable_destroy(table);
1522 free(ofproto->tables);
1524 ovs_assert(hindex_is_empty(&ofproto->cookies));
1525 hindex_destroy(&ofproto->cookies);
1527 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1528 hmap_destroy(&ofproto->learned_cookies);
1530 free(ofproto->vlan_bitmap);
1532 ofproto->ofproto_class->dealloc(ofproto);
1536 ofproto_destroy(struct ofproto *p)
1537 OVS_EXCLUDED(ofproto_mutex)
1539 struct ofport *ofport, *next_ofport;
1540 struct ofport_usage *usage, *next_usage;
1547 meter_delete(p, 1, p->meter_features.max_meters);
1548 p->meter_features.max_meters = 0;
1554 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1555 ofport_destroy(ofport);
1558 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1559 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1563 p->ofproto_class->destruct(p);
1565 /* We should not postpone this because it involves deleting a listening
1566 * socket which we may want to reopen soon. 'connmgr' should not be used
1567 * by other threads */
1568 connmgr_destroy(p->connmgr);
1570 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1571 ovsrcu_postpone(ofproto_destroy__, p);
1574 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1575 * kernel datapath, for example, this destroys the datapath in the kernel, and
1576 * with the netdev-based datapath, it tears down the data structures that
1577 * represent the datapath.
1579 * The datapath should not be currently open as an ofproto. */
1581 ofproto_delete(const char *name, const char *type)
1583 const struct ofproto_class *class = ofproto_class_find__(type);
1584 return (!class ? EAFNOSUPPORT
1585 : !class->del ? EACCES
1586 : class->del(type, name));
1590 process_port_change(struct ofproto *ofproto, int error, char *devname)
1592 if (error == ENOBUFS) {
1593 reinit_ports(ofproto);
1594 } else if (!error) {
1595 update_port(ofproto, devname);
1601 ofproto_type_run(const char *datapath_type)
1603 const struct ofproto_class *class;
1606 datapath_type = ofproto_normalize_type(datapath_type);
1607 class = ofproto_class_find__(datapath_type);
1609 error = class->type_run ? class->type_run(datapath_type) : 0;
1610 if (error && error != EAGAIN) {
1611 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1612 datapath_type, ovs_strerror(error));
1618 ofproto_type_wait(const char *datapath_type)
1620 const struct ofproto_class *class;
1622 datapath_type = ofproto_normalize_type(datapath_type);
1623 class = ofproto_class_find__(datapath_type);
1625 if (class->type_wait) {
1626 class->type_wait(datapath_type);
1631 ofproto_run(struct ofproto *p)
1636 error = p->ofproto_class->run(p);
1637 if (error && error != EAGAIN) {
1638 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1641 run_rule_executes(p);
1643 /* Restore the eviction group heap invariant occasionally. */
1644 if (p->eviction_group_timer < time_msec()) {
1647 p->eviction_group_timer = time_msec() + 1000;
1649 for (i = 0; i < p->n_tables; i++) {
1650 struct oftable *table = &p->tables[i];
1651 struct eviction_group *evg;
1654 if (!table->eviction_fields) {
1658 if (classifier_count(&table->cls) > 100000) {
1659 static struct vlog_rate_limit count_rl =
1660 VLOG_RATE_LIMIT_INIT(1, 1);
1661 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1662 " number of rules: %d", i,
1663 classifier_count(&table->cls));
1666 ovs_mutex_lock(&ofproto_mutex);
1667 CLS_FOR_EACH (rule, cr, &table->cls) {
1668 if (rule->idle_timeout || rule->hard_timeout) {
1669 if (!rule->eviction_group) {
1670 eviction_group_add_rule(rule);
1672 heap_raw_change(&rule->evg_node,
1673 rule_eviction_priority(p, rule));
1678 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1679 heap_rebuild(&evg->rules);
1681 ovs_mutex_unlock(&ofproto_mutex);
1685 if (p->ofproto_class->port_poll) {
1688 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1689 process_port_change(p, error, devname);
1693 new_seq = seq_read(connectivity_seq_get());
1694 if (new_seq != p->change_seq) {
1695 struct sset devnames;
1696 const char *devname;
1697 struct ofport *ofport;
1699 /* Update OpenFlow port status for any port whose netdev has changed.
1701 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1702 * destroyed, so it's not safe to update ports directly from the
1703 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1704 * need this two-phase approach. */
1705 sset_init(&devnames);
1706 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1707 uint64_t port_change_seq;
1709 port_change_seq = netdev_get_change_seq(ofport->netdev);
1710 if (ofport->change_seq != port_change_seq) {
1711 ofport->change_seq = port_change_seq;
1712 sset_add(&devnames, netdev_get_name(ofport->netdev));
1715 SSET_FOR_EACH (devname, &devnames) {
1716 update_port(p, devname);
1718 sset_destroy(&devnames);
1720 p->change_seq = new_seq;
1723 connmgr_run(p->connmgr, handle_openflow);
1729 ofproto_wait(struct ofproto *p)
1731 p->ofproto_class->wait(p);
1732 if (p->ofproto_class->port_poll_wait) {
1733 p->ofproto_class->port_poll_wait(p);
1735 seq_wait(connectivity_seq_get(), p->change_seq);
1736 connmgr_wait(p->connmgr);
1740 ofproto_is_alive(const struct ofproto *p)
1742 return connmgr_has_controllers(p->connmgr);
1745 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1746 * memory_report(). */
1748 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1750 const struct oftable *table;
1751 unsigned int n_rules;
1753 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1756 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1757 n_rules += classifier_count(&table->cls);
1759 simap_increase(usage, "rules", n_rules);
1761 if (ofproto->ofproto_class->get_memory_usage) {
1762 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1765 connmgr_get_memory_usage(ofproto->connmgr, usage);
1769 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1771 const struct ofproto_class *class;
1773 datapath_type = ofproto_normalize_type(datapath_type);
1774 class = ofproto_class_find__(datapath_type);
1776 if (class && class->type_get_memory_usage) {
1777 class->type_get_memory_usage(datapath_type, usage);
1782 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1785 connmgr_get_controller_info(ofproto->connmgr, info);
1789 ofproto_free_ofproto_controller_info(struct shash *info)
1791 connmgr_free_controller_info(info);
1794 /* Makes a deep copy of 'old' into 'port'. */
1796 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1798 port->name = xstrdup(old->name);
1799 port->type = xstrdup(old->type);
1800 port->ofp_port = old->ofp_port;
1803 /* Frees memory allocated to members of 'ofproto_port'.
1805 * Do not call this function on an ofproto_port obtained from
1806 * ofproto_port_dump_next(): that function retains ownership of the data in the
1809 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1811 free(ofproto_port->name);
1812 free(ofproto_port->type);
1815 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1817 * This function provides no status indication. An error status for the entire
1818 * dump operation is provided when it is completed by calling
1819 * ofproto_port_dump_done().
1822 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1823 const struct ofproto *ofproto)
1825 dump->ofproto = ofproto;
1826 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1830 /* Attempts to retrieve another port from 'dump', which must have been created
1831 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1832 * 'port' and returns true. On failure, returns false.
1834 * Failure might indicate an actual error or merely that the last port has been
1835 * dumped. An error status for the entire dump operation is provided when it
1836 * is completed by calling ofproto_port_dump_done().
1838 * The ofproto owns the data stored in 'port'. It will remain valid until at
1839 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1840 * ofproto_port_dump_done(). */
1842 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1843 struct ofproto_port *port)
1845 const struct ofproto *ofproto = dump->ofproto;
1851 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1854 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1860 /* Completes port table dump operation 'dump', which must have been created
1861 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1862 * error-free, otherwise a positive errno value describing the problem. */
1864 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1866 const struct ofproto *ofproto = dump->ofproto;
1868 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1871 return dump->error == EOF ? 0 : dump->error;
1874 /* Returns the type to pass to netdev_open() when a datapath of type
1875 * 'datapath_type' has a port of type 'port_type', for a few special
1876 * cases when a netdev type differs from a port type. For example, when
1877 * using the userspace datapath, a port of type "internal" needs to be
1880 * Returns either 'type' itself or a string literal, which must not be
1883 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1885 const struct ofproto_class *class;
1887 datapath_type = ofproto_normalize_type(datapath_type);
1888 class = ofproto_class_find__(datapath_type);
1893 return (class->port_open_type
1894 ? class->port_open_type(datapath_type, port_type)
1898 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1899 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1900 * the port's OpenFlow port number.
1902 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1903 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1904 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1905 * 'ofp_portp' is non-null). */
1907 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1908 ofp_port_t *ofp_portp)
1910 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1913 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1915 const char *netdev_name = netdev_get_name(netdev);
1917 simap_put(&ofproto->ofp_requests, netdev_name,
1918 ofp_to_u16(ofp_port));
1919 update_port(ofproto, netdev_name);
1922 *ofp_portp = OFPP_NONE;
1924 struct ofproto_port ofproto_port;
1926 error = ofproto_port_query_by_name(ofproto,
1927 netdev_get_name(netdev),
1930 *ofp_portp = ofproto_port.ofp_port;
1931 ofproto_port_destroy(&ofproto_port);
1938 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1939 * initializes '*port' appropriately; on failure, returns a positive errno
1942 * The caller owns the data in 'ofproto_port' and must free it with
1943 * ofproto_port_destroy() when it is no longer needed. */
1945 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1946 struct ofproto_port *port)
1950 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1952 memset(port, 0, sizeof *port);
1957 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1958 * Returns 0 if successful, otherwise a positive errno. */
1960 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1962 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1963 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1964 struct simap_node *ofp_request_node;
1967 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1968 if (ofp_request_node) {
1969 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1972 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1973 if (!error && ofport) {
1974 /* 'name' is the netdev's name and update_port() is going to close the
1975 * netdev. Just in case update_port() refers to 'name' after it
1976 * destroys 'ofport', make a copy of it around the update_port()
1978 char *devname = xstrdup(name);
1979 update_port(ofproto, devname);
1986 flow_mod_init(struct ofputil_flow_mod *fm,
1987 const struct match *match, int priority,
1988 const struct ofpact *ofpacts, size_t ofpacts_len,
1989 enum ofp_flow_mod_command command)
1991 memset(fm, 0, sizeof *fm);
1993 fm->priority = priority;
1996 fm->modify_cookie = false;
1998 fm->command = command;
1999 fm->idle_timeout = 0;
2000 fm->hard_timeout = 0;
2002 fm->buffer_id = UINT32_MAX;
2003 fm->out_port = OFPP_ANY;
2004 fm->out_group = OFPG_ANY;
2006 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2007 fm->ofpacts_len = ofpacts_len;
2008 fm->delete_reason = OFPRR_DELETE;
2012 simple_flow_mod(struct ofproto *ofproto,
2013 const struct match *match, int priority,
2014 const struct ofpact *ofpacts, size_t ofpacts_len,
2015 enum ofp_flow_mod_command command)
2017 struct ofputil_flow_mod fm;
2019 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2021 return handle_flow_mod__(ofproto, &fm, NULL);
2024 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2025 * performs the 'n_actions' actions in 'actions'. The new flow will not
2028 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2029 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2030 * controllers; otherwise, it will be hidden.
2032 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2034 * This is a helper function for in-band control and fail-open. */
2036 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2038 const struct ofpact *ofpacts, size_t ofpacts_len)
2039 OVS_EXCLUDED(ofproto_mutex)
2041 const struct rule *rule;
2044 /* First do a cheap check whether the rule we're looking for already exists
2045 * with the actions that we want. If it does, then we're done. */
2046 rule = rule_from_cls_rule(classifier_find_match_exactly(
2047 &ofproto->tables[0].cls, match, priority,
2050 const struct rule_actions *actions = rule_get_actions(rule);
2051 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2052 ofpacts, ofpacts_len);
2057 /* If there's no such rule or the rule doesn't have the actions we want,
2058 * fall back to a executing a full flow mod. We can't optimize this at
2059 * all because we didn't take enough locks above to ensure that the flow
2060 * table didn't already change beneath us. */
2062 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2063 OFPFC_MODIFY_STRICT);
2067 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2068 * an OFPERR_* OpenFlow error code on failure.
2070 * This is a helper function for in-band control and fail-open and the "learn"
2073 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2074 OVS_EXCLUDED(ofproto_mutex)
2076 /* Optimize for the most common case of a repeated learn action.
2077 * If an identical flow already exists we only need to update its
2078 * 'modified' time. */
2079 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2080 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2081 struct oftable *table = &ofproto->tables[fm->table_id];
2085 rule = rule_from_cls_rule(classifier_find_match_exactly(
2086 &table->cls, &fm->match,
2087 fm->priority, CLS_MAX_VERSION));
2089 /* Reading many of the rule fields and writing on 'modified'
2090 * requires the rule->mutex. Also, rule->actions may change
2091 * if rule->mutex is not held. */
2092 const struct rule_actions *actions;
2094 ovs_mutex_lock(&rule->mutex);
2095 actions = rule_get_actions(rule);
2096 if (rule->idle_timeout == fm->idle_timeout
2097 && rule->hard_timeout == fm->hard_timeout
2098 && rule->importance == fm->importance
2099 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2100 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2101 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2102 actions->ofpacts, actions->ofpacts_len)) {
2103 /* Rule already exists and need not change, only update the
2104 modified timestamp. */
2105 rule->modified = time_msec();
2108 ovs_mutex_unlock(&rule->mutex);
2116 return handle_flow_mod__(ofproto, fm, NULL);
2119 /* Searches for a rule with matching criteria exactly equal to 'target' in
2120 * ofproto's table 0 and, if it finds one, deletes it.
2122 * This is a helper function for in-band control and fail-open. */
2124 ofproto_delete_flow(struct ofproto *ofproto,
2125 const struct match *target, int priority)
2126 OVS_EXCLUDED(ofproto_mutex)
2128 struct classifier *cls = &ofproto->tables[0].cls;
2131 /* First do a cheap check whether the rule we're looking for has already
2132 * been deleted. If so, then we're done. */
2133 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2140 /* Execute a flow mod. We can't optimize this at all because we didn't
2141 * take enough locks above to ensure that the flow table didn't already
2142 * change beneath us. */
2143 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2146 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2147 * the flows required by in-band control and fail-open. */
2149 ofproto_flush_flows(struct ofproto *ofproto)
2151 COVERAGE_INC(ofproto_flush);
2152 ofproto_flush__(ofproto);
2153 connmgr_flushed(ofproto->connmgr);
2157 reinit_ports(struct ofproto *p)
2159 struct ofproto_port_dump dump;
2160 struct sset devnames;
2161 struct ofport *ofport;
2162 struct ofproto_port ofproto_port;
2163 const char *devname;
2165 COVERAGE_INC(ofproto_reinit_ports);
2167 sset_init(&devnames);
2168 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2169 sset_add(&devnames, netdev_get_name(ofport->netdev));
2171 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2172 sset_add(&devnames, ofproto_port.name);
2175 SSET_FOR_EACH (devname, &devnames) {
2176 update_port(p, devname);
2178 sset_destroy(&devnames);
2182 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2186 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2187 port_idx = port_idx ? port_idx : UINT16_MAX;
2189 if (port_idx >= ofproto->max_ports
2190 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2191 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2192 long long int last_used_at, lru = LLONG_MAX;
2194 /* Search for a free OpenFlow port number. We try not to
2195 * immediately reuse them to prevent problems due to old
2198 * We limit the automatically assigned port numbers to the lower half
2199 * of the port range, to reserve the upper half for assignment by
2202 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2203 ofproto->alloc_port_no = 1;
2205 last_used_at = ofport_get_usage(ofproto,
2206 u16_to_ofp(ofproto->alloc_port_no));
2207 if (!last_used_at) {
2208 port_idx = ofproto->alloc_port_no;
2210 } else if ( last_used_at < time_msec() - 60*60*1000) {
2211 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2212 * more than an hour ago, consider it usable. */
2213 ofport_remove_usage(ofproto,
2214 u16_to_ofp(ofproto->alloc_port_no));
2215 port_idx = ofproto->alloc_port_no;
2217 } else if (last_used_at < lru) {
2219 lru_ofport = ofproto->alloc_port_no;
2222 if (ofproto->alloc_port_no == end_port_no) {
2224 port_idx = lru_ofport;
2231 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2232 return u16_to_ofp(port_idx);
2236 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2238 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2239 ofport_set_usage(ofproto, ofp_port, time_msec());
2243 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2244 * pointer if the netdev cannot be opened. On success, also fills in
2246 static struct netdev *
2247 ofport_open(struct ofproto *ofproto,
2248 struct ofproto_port *ofproto_port,
2249 struct ofputil_phy_port *pp)
2251 enum netdev_flags flags;
2252 struct netdev *netdev;
2255 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2257 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2258 "cannot be opened (%s)",
2260 ofproto_port->name, ofproto_port->ofp_port,
2261 ofproto_port->name, ovs_strerror(error));
2265 if (ofproto_port->ofp_port == OFPP_NONE) {
2266 if (!strcmp(ofproto->name, ofproto_port->name)) {
2267 ofproto_port->ofp_port = OFPP_LOCAL;
2269 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2270 ofproto_port->name);
2273 pp->port_no = ofproto_port->ofp_port;
2274 netdev_get_etheraddr(netdev, pp->hw_addr);
2275 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2276 netdev_get_flags(netdev, &flags);
2277 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2278 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2279 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2280 &pp->supported, &pp->peer);
2281 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2282 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2287 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2288 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2291 ofport_equal(const struct ofputil_phy_port *a,
2292 const struct ofputil_phy_port *b)
2294 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2295 && a->state == b->state
2296 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2297 && a->curr == b->curr
2298 && a->advertised == b->advertised
2299 && a->supported == b->supported
2300 && a->peer == b->peer
2301 && a->curr_speed == b->curr_speed
2302 && a->max_speed == b->max_speed);
2305 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2306 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2307 * one with the same name or port number). */
2309 ofport_install(struct ofproto *p,
2310 struct netdev *netdev, const struct ofputil_phy_port *pp)
2312 const char *netdev_name = netdev_get_name(netdev);
2313 struct ofport *ofport;
2316 /* Create ofport. */
2317 ofport = p->ofproto_class->port_alloc();
2322 ofport->ofproto = p;
2323 ofport->netdev = netdev;
2324 ofport->change_seq = netdev_get_change_seq(netdev);
2326 ofport->ofp_port = pp->port_no;
2327 ofport->created = time_msec();
2329 /* Add port to 'p'. */
2330 hmap_insert(&p->ports, &ofport->hmap_node,
2331 hash_ofp_port(ofport->ofp_port));
2332 shash_add(&p->port_by_name, netdev_name, ofport);
2334 update_mtu(p, ofport);
2336 /* Let the ofproto_class initialize its private data. */
2337 error = p->ofproto_class->port_construct(ofport);
2341 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2345 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2346 p->name, netdev_name, ovs_strerror(error));
2348 ofport_destroy__(ofport);
2350 netdev_close(netdev);
2354 /* Removes 'ofport' from 'p' and destroys it. */
2356 ofport_remove(struct ofport *ofport)
2358 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2360 ofport_destroy(ofport);
2363 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2366 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2368 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2370 ofport_remove(port);
2374 /* Updates 'port' with new 'pp' description.
2376 * Does not handle a name or port number change. The caller must implement
2377 * such a change as a delete followed by an add. */
2379 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2381 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2382 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2383 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2384 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2385 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2386 port->pp.curr = pp->curr;
2387 port->pp.advertised = pp->advertised;
2388 port->pp.supported = pp->supported;
2389 port->pp.peer = pp->peer;
2390 port->pp.curr_speed = pp->curr_speed;
2391 port->pp.max_speed = pp->max_speed;
2393 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2394 &port->pp, OFPPR_MODIFY);
2397 /* Update OpenFlow 'state' in 'port' and notify controller. */
2399 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2401 if (port->pp.state != state) {
2402 port->pp.state = state;
2403 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2404 &port->pp, OFPPR_MODIFY);
2409 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2411 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2413 if (port->ofproto->ofproto_class->set_realdev) {
2414 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2416 if (port->ofproto->ofproto_class->set_stp_port) {
2417 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2419 if (port->ofproto->ofproto_class->set_rstp_port) {
2420 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2422 if (port->ofproto->ofproto_class->set_cfm) {
2423 port->ofproto->ofproto_class->set_cfm(port, NULL);
2425 if (port->ofproto->ofproto_class->bundle_remove) {
2426 port->ofproto->ofproto_class->bundle_remove(port);
2432 ofport_destroy__(struct ofport *port)
2434 struct ofproto *ofproto = port->ofproto;
2435 const char *name = netdev_get_name(port->netdev);
2437 hmap_remove(&ofproto->ports, &port->hmap_node);
2438 shash_delete(&ofproto->port_by_name,
2439 shash_find(&ofproto->port_by_name, name));
2441 netdev_close(port->netdev);
2442 ofproto->ofproto_class->port_dealloc(port);
2446 ofport_destroy(struct ofport *port)
2449 dealloc_ofp_port(port->ofproto, port->ofp_port);
2450 port->ofproto->ofproto_class->port_destruct(port);
2451 ofport_destroy__(port);
2456 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2458 struct ofport *port;
2460 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2462 if (port->ofp_port == ofp_port) {
2469 static long long int
2470 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2472 struct ofport_usage *usage;
2474 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2475 &ofproto->ofport_usage) {
2476 if (usage->ofp_port == ofp_port) {
2477 return usage->last_used;
2484 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2485 long long int last_used)
2487 struct ofport_usage *usage;
2488 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2489 &ofproto->ofport_usage) {
2490 if (usage->ofp_port == ofp_port) {
2491 usage->last_used = last_used;
2495 ovs_assert(last_used == LLONG_MAX);
2497 usage = xmalloc(sizeof *usage);
2498 usage->ofp_port = ofp_port;
2499 usage->last_used = last_used;
2500 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2501 hash_ofp_port(ofp_port));
2505 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2507 struct ofport_usage *usage;
2508 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2509 &ofproto->ofport_usage) {
2510 if (usage->ofp_port == ofp_port) {
2511 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2519 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2521 struct ofproto *ofproto = port->ofproto;
2524 if (ofproto->ofproto_class->port_get_stats) {
2525 error = ofproto->ofproto_class->port_get_stats(port, stats);
2534 update_port(struct ofproto *ofproto, const char *name)
2536 struct ofproto_port ofproto_port;
2537 struct ofputil_phy_port pp;
2538 struct netdev *netdev;
2539 struct ofport *port;
2541 COVERAGE_INC(ofproto_update_port);
2543 /* Fetch 'name''s location and properties from the datapath. */
2544 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2545 ? ofport_open(ofproto, &ofproto_port, &pp)
2549 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2550 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2551 struct netdev *old_netdev = port->netdev;
2553 /* 'name' hasn't changed location. Any properties changed? */
2554 if (!ofport_equal(&port->pp, &pp)) {
2555 ofport_modified(port, &pp);
2558 update_mtu(ofproto, port);
2560 /* Install the newly opened netdev in case it has changed.
2561 * Don't close the old netdev yet in case port_modified has to
2562 * remove a retained reference to it.*/
2563 port->netdev = netdev;
2564 port->change_seq = netdev_get_change_seq(netdev);
2566 if (port->ofproto->ofproto_class->port_modified) {
2567 port->ofproto->ofproto_class->port_modified(port);
2570 netdev_close(old_netdev);
2572 /* If 'port' is nonnull then its name differs from 'name' and thus
2573 * we should delete it. If we think there's a port named 'name'
2574 * then its port number must be wrong now so delete it too. */
2576 ofport_remove(port);
2578 ofport_remove_with_name(ofproto, name);
2579 ofport_install(ofproto, netdev, &pp);
2582 /* Any port named 'name' is gone now. */
2583 ofport_remove_with_name(ofproto, name);
2585 ofproto_port_destroy(&ofproto_port);
2589 init_ports(struct ofproto *p)
2591 struct ofproto_port_dump dump;
2592 struct ofproto_port ofproto_port;
2593 struct shash_node *node, *next;
2595 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2596 const char *name = ofproto_port.name;
2598 if (shash_find(&p->port_by_name, name)) {
2599 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2602 struct ofputil_phy_port pp;
2603 struct netdev *netdev;
2605 /* Check if an OpenFlow port number had been requested. */
2606 node = shash_find(&init_ofp_ports, name);
2608 const struct iface_hint *iface_hint = node->data;
2609 simap_put(&p->ofp_requests, name,
2610 ofp_to_u16(iface_hint->ofp_port));
2613 netdev = ofport_open(p, &ofproto_port, &pp);
2615 ofport_install(p, netdev, &pp);
2616 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2617 p->alloc_port_no = MAX(p->alloc_port_no,
2618 ofp_to_u16(ofproto_port.ofp_port));
2624 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2625 struct iface_hint *iface_hint = node->data;
2627 if (!strcmp(iface_hint->br_name, p->name)) {
2628 free(iface_hint->br_name);
2629 free(iface_hint->br_type);
2631 shash_delete(&init_ofp_ports, node);
2638 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2639 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2641 find_min_mtu(struct ofproto *p)
2643 struct ofport *ofport;
2646 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2647 struct netdev *netdev = ofport->netdev;
2650 /* Skip any internal ports, since that's what we're trying to
2652 if (!strcmp(netdev_get_type(netdev), "internal")) {
2656 if (netdev_get_mtu(netdev, &dev_mtu)) {
2659 if (!mtu || dev_mtu < mtu) {
2664 return mtu ? mtu: ETH_PAYLOAD_MAX;
2667 /* Update MTU of all datapath devices on 'p' to the minimum of the
2668 * non-datapath ports in event of 'port' added or changed. */
2670 update_mtu(struct ofproto *p, struct ofport *port)
2672 struct ofport *ofport;
2673 struct netdev *netdev = port->netdev;
2674 int dev_mtu, old_min;
2676 if (netdev_get_mtu(netdev, &dev_mtu)) {
2680 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2681 if (dev_mtu > p->min_mtu) {
2682 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2683 dev_mtu = p->min_mtu;
2686 port->mtu = dev_mtu;
2690 /* For non-internal port find new min mtu. */
2691 old_min = p->min_mtu;
2692 port->mtu = dev_mtu;
2693 p->min_mtu = find_min_mtu(p);
2694 if (p->min_mtu == old_min) {
2698 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2699 struct netdev *netdev = ofport->netdev;
2701 if (!strcmp(netdev_get_type(netdev), "internal")) {
2702 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2703 ofport->mtu = p->min_mtu;
2710 ofproto_rule_destroy__(struct rule *rule)
2711 OVS_NO_THREAD_SAFETY_ANALYSIS
2713 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2714 rule_actions_destroy(rule_get_actions(rule));
2715 ovs_mutex_destroy(&rule->mutex);
2716 rule->ofproto->ofproto_class->rule_dealloc(rule);
2719 /* Create a new rule based on attributes in 'fm', match in 'cr', and
2720 * 'table_id'. Note that the rule is NOT inserted into a any data structures
2721 * yet. Takes ownership of 'cr'. */
2723 ofproto_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
2724 struct cls_rule *cr, uint8_t table_id,
2725 struct rule **rulep)
2726 OVS_REQUIRES(ofproto_mutex)
2731 /* Allocate new rule. */
2732 rule = ofproto->ofproto_class->rule_alloc();
2734 cls_rule_destroy(cr);
2735 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
2736 return OFPERR_OFPFMFC_UNKNOWN;
2739 /* Initialize base state. */
2740 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
2741 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
2742 ovs_refcount_init(&rule->ref_count);
2743 rule->flow_cookie = fm->new_cookie;
2744 rule->created = rule->modified = time_msec();
2746 ovs_mutex_init(&rule->mutex);
2747 ovs_mutex_lock(&rule->mutex);
2748 rule->idle_timeout = fm->idle_timeout;
2749 rule->hard_timeout = fm->hard_timeout;
2750 rule->importance = fm->importance;
2751 ovs_mutex_unlock(&rule->mutex);
2753 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
2754 rule->flags = fm->flags & OFPUTIL_FF_STATE;
2755 ovsrcu_set_hidden(&rule->actions,
2756 rule_actions_create(fm->ofpacts, fm->ofpacts_len));
2757 list_init(&rule->meter_list_node);
2758 rule->eviction_group = NULL;
2759 list_init(&rule->expirable);
2760 rule->monitor_flags = 0;
2761 rule->add_seqno = 0;
2762 rule->modify_seqno = 0;
2764 /* Construct rule, initializing derived state. */
2765 error = ofproto->ofproto_class->rule_construct(rule);
2767 ofproto_rule_destroy__(rule);
2776 rule_destroy_cb(struct rule *rule)
2778 rule->ofproto->ofproto_class->rule_destruct(rule);
2779 ofproto_rule_destroy__(rule);
2783 ofproto_rule_ref(struct rule *rule)
2786 ovs_refcount_ref(&rule->ref_count);
2791 ofproto_rule_try_ref(struct rule *rule)
2794 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2799 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2800 * ref_count reaches 0.
2802 * Use of RCU allows short term use (between RCU quiescent periods) without
2803 * keeping a reference. A reference must be taken if the rule needs to
2804 * stay around accross the RCU quiescent periods. */
2806 ofproto_rule_unref(struct rule *rule)
2808 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2809 ovsrcu_postpone(rule_destroy_cb, rule);
2814 ofproto_group_ref(struct ofgroup *group)
2817 ovs_refcount_ref(&group->ref_count);
2822 ofproto_group_unref(struct ofgroup *group)
2824 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2825 group->ofproto->ofproto_class->group_destruct(group);
2826 ofputil_bucket_list_destroy(&group->buckets);
2827 group->ofproto->ofproto_class->group_dealloc(group);
2831 static uint32_t get_provider_meter_id(const struct ofproto *,
2832 uint32_t of_meter_id);
2834 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2835 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2836 const struct rule_actions *
2837 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2839 struct rule_actions *actions;
2841 actions = xmalloc(sizeof *actions + ofpacts_len);
2842 actions->ofpacts_len = ofpacts_len;
2843 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2844 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2846 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2852 /* Free the actions after the RCU quiescent period is reached. */
2854 rule_actions_destroy(const struct rule_actions *actions)
2857 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2861 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2862 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2864 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2865 OVS_REQUIRES(ofproto_mutex)
2867 if (port == OFPP_ANY) {
2870 const struct rule_actions *actions = rule_get_actions(rule);
2871 return ofpacts_output_to_port(actions->ofpacts,
2872 actions->ofpacts_len, port);
2876 /* Returns true if 'rule' has group and equals group_id. */
2878 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2879 OVS_REQUIRES(ofproto_mutex)
2881 if (group_id == OFPG_ANY) {
2884 const struct rule_actions *actions = rule_get_actions(rule);
2885 return ofpacts_output_to_group(actions->ofpacts,
2886 actions->ofpacts_len, group_id);
2891 rule_execute_destroy(struct rule_execute *e)
2893 ofproto_rule_unref(e->rule);
2894 list_remove(&e->list_node);
2898 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2899 * by passing them to the ofproto provider. */
2901 run_rule_executes(struct ofproto *ofproto)
2902 OVS_EXCLUDED(ofproto_mutex)
2904 struct rule_execute *e, *next;
2905 struct ovs_list executes;
2907 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2908 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2911 flow_extract(e->packet, &flow);
2912 flow.in_port.ofp_port = e->in_port;
2913 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2915 rule_execute_destroy(e);
2919 /* Destroys and discards all "rule_execute" operations queued up in
2920 * ofproto->rule_executes. */
2922 destroy_rule_executes(struct ofproto *ofproto)
2924 struct rule_execute *e, *next;
2925 struct ovs_list executes;
2927 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2928 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2929 dp_packet_delete(e->packet);
2930 rule_execute_destroy(e);
2935 rule_is_readonly(const struct rule *rule)
2937 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2938 return (table->flags & OFTABLE_READONLY) != 0;
2942 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2944 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2945 return hash_3words(cookie, cookie >> 32, table_id);
2949 learned_cookies_update_one__(struct ofproto *ofproto,
2950 const struct ofpact_learn *learn,
2951 int delta, struct ovs_list *dead_cookies)
2952 OVS_REQUIRES(ofproto_mutex)
2954 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
2955 struct learned_cookie *c;
2957 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
2958 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
2960 ovs_assert(c->n >= 0);
2963 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
2964 list_push_back(dead_cookies, &c->u.list_node);
2971 ovs_assert(delta > 0);
2972 c = xmalloc(sizeof *c);
2973 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
2974 c->cookie = learn->cookie;
2975 c->table_id = learn->table_id;
2979 static const struct ofpact_learn *
2980 next_learn_with_delete(const struct rule_actions *actions,
2981 const struct ofpact_learn *start)
2983 const struct ofpact *pos;
2985 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
2986 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
2987 pos = ofpact_next(pos)) {
2988 if (pos->type == OFPACT_LEARN) {
2989 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
2990 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3000 learned_cookies_update__(struct ofproto *ofproto,
3001 const struct rule_actions *actions,
3002 int delta, struct ovs_list *dead_cookies)
3003 OVS_REQUIRES(ofproto_mutex)
3005 if (actions->has_learn_with_delete) {
3006 const struct ofpact_learn *learn;
3008 for (learn = next_learn_with_delete(actions, NULL); learn;
3009 learn = next_learn_with_delete(actions, learn)) {
3010 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3016 learned_cookies_inc(struct ofproto *ofproto,
3017 const struct rule_actions *actions)
3018 OVS_REQUIRES(ofproto_mutex)
3020 learned_cookies_update__(ofproto, actions, +1, NULL);
3024 learned_cookies_dec(struct ofproto *ofproto,
3025 const struct rule_actions *actions,
3026 struct ovs_list *dead_cookies)
3027 OVS_REQUIRES(ofproto_mutex)
3029 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3033 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3034 OVS_REQUIRES(ofproto_mutex)
3036 struct learned_cookie *c;
3038 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3039 struct rule_criteria criteria;
3040 struct rule_collection rules;
3043 match_init_catchall(&match);
3044 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3045 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3046 rule_criteria_require_rw(&criteria, false);
3047 collect_rules_loose(ofproto, &criteria, &rules);
3048 delete_flows__(&rules, OFPRR_DELETE, NULL);
3049 rule_criteria_destroy(&criteria);
3050 rule_collection_destroy(&rules);
3057 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3059 ofconn_send_reply(ofconn, make_echo_reply(oh));
3064 query_tables(struct ofproto *ofproto,
3065 struct ofputil_table_features **featuresp,
3066 struct ofputil_table_stats **statsp)
3068 struct mf_bitmap rw_fields = oxm_writable_fields();
3069 struct mf_bitmap match = oxm_matchable_fields();
3070 struct mf_bitmap mask = oxm_maskable_fields();
3072 struct ofputil_table_features *features;
3073 struct ofputil_table_stats *stats;
3076 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3077 for (i = 0; i < ofproto->n_tables; i++) {
3078 struct ofputil_table_features *f = &features[i];
3081 sprintf(f->name, "table%d", i);
3082 f->metadata_match = OVS_BE64_MAX;
3083 f->metadata_write = OVS_BE64_MAX;
3084 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3085 f->max_entries = 1000000;
3087 bool more_tables = false;
3088 for (int j = i + 1; j < ofproto->n_tables; j++) {
3089 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3090 bitmap_set1(f->nonmiss.next, j);
3094 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3096 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3098 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3099 f->nonmiss.write.set_fields = rw_fields;
3100 f->nonmiss.apply = f->nonmiss.write;
3101 f->miss = f->nonmiss;
3105 f->wildcard = match;
3109 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3110 for (i = 0; i < ofproto->n_tables; i++) {
3111 struct ofputil_table_stats *s = &stats[i];
3112 struct classifier *cls = &ofproto->tables[i].cls;
3115 s->active_count = classifier_count(cls);
3117 s->active_count -= connmgr_count_hidden_rules(
3125 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3127 for (i = 0; i < ofproto->n_tables; i++) {
3128 const struct oftable *table = &ofproto->tables[i];
3129 struct ofputil_table_features *f = &features[i];
3132 ovs_strzcpy(f->name, table->name, sizeof f->name);
3135 if (table->max_flows < f->max_entries) {
3136 f->max_entries = table->max_flows;
3142 query_switch_features(struct ofproto *ofproto,
3143 bool *arp_match_ip, uint64_t *ofpacts)
3145 struct ofputil_table_features *features, *f;
3147 *arp_match_ip = false;
3150 query_tables(ofproto, &features, NULL);
3151 for (f = features; f < &features[ofproto->n_tables]; f++) {
3152 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3153 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3154 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3155 *arp_match_ip = true;
3161 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3165 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3167 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3168 struct ofputil_switch_features features;
3169 struct ofport *port;
3173 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3175 features.datapath_id = ofproto->datapath_id;
3176 features.n_buffers = pktbuf_capacity();
3177 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3178 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3179 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3180 OFPUTIL_C_GROUP_STATS);
3182 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3184 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3185 features.auxiliary_id = 0;
3186 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3188 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3189 ofputil_put_switch_features_port(&port->pp, b);
3192 ofconn_send_reply(ofconn, b);
3197 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3199 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3200 struct ofp_switch_config *osc;
3201 enum ofp_config_flags flags;
3205 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3206 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3207 flags = ofproto->frag_handling;
3208 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3209 if (oh->version < OFP13_VERSION
3210 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3211 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3213 osc->flags = htons(flags);
3214 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3215 ofconn_send_reply(ofconn, buf);
3221 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3223 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3224 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3225 uint16_t flags = ntohs(osc->flags);
3227 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3228 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3229 enum ofp_config_flags cur = ofproto->frag_handling;
3230 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3232 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3234 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3235 ofproto->frag_handling = next;
3237 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3239 ofputil_frag_handling_to_string(next));
3243 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3244 ofconn_set_invalid_ttl_to_controller(ofconn,
3245 (oh->version < OFP13_VERSION
3246 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3248 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3253 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3254 * error message code for the caller to propagate upward. Otherwise, returns
3257 * The log message mentions 'msg_type'. */
3259 reject_slave_controller(struct ofconn *ofconn)
3261 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3262 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3263 return OFPERR_OFPBRC_IS_SLAVE;
3269 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3272 * - If they use a meter, then 'ofproto' has that meter configured.
3274 * - If they use any groups, then 'ofproto' has that group configured.
3276 * Returns 0 if successful, otherwise an OpenFlow error. */
3278 ofproto_check_ofpacts(struct ofproto *ofproto,
3279 const struct ofpact ofpacts[], size_t ofpacts_len)
3281 const struct ofpact *a;
3284 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3285 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3286 return OFPERR_OFPMMFC_INVALID_METER;
3289 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3290 if (a->type == OFPACT_GROUP
3291 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3292 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3300 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3302 struct ofproto *p = ofconn_get_ofproto(ofconn);
3303 struct ofputil_packet_out po;
3304 struct dp_packet *payload;
3305 uint64_t ofpacts_stub[1024 / 8];
3306 struct ofpbuf ofpacts;
3310 COVERAGE_INC(ofproto_packet_out);
3312 error = reject_slave_controller(ofconn);
3317 /* Decode message. */
3318 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3319 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3321 goto exit_free_ofpacts;
3323 if (ofp_to_u16(po.in_port) >= p->max_ports
3324 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3325 error = OFPERR_OFPBRC_BAD_PORT;
3326 goto exit_free_ofpacts;
3330 if (po.buffer_id != UINT32_MAX) {
3331 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3332 if (error || !payload) {
3333 goto exit_free_ofpacts;
3336 /* Ensure that the L3 header is 32-bit aligned. */
3337 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3340 /* Verify actions against packet, then send packet if successful. */
3341 flow_extract(payload, &flow);
3342 flow.in_port.ofp_port = po.in_port;
3343 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3345 error = p->ofproto_class->packet_out(p, payload, &flow,
3346 po.ofpacts, po.ofpacts_len);
3348 dp_packet_delete(payload);
3351 ofpbuf_uninit(&ofpacts);
3357 update_port_config(struct ofconn *ofconn, struct ofport *port,
3358 enum ofputil_port_config config,
3359 enum ofputil_port_config mask)
3361 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3363 if (toggle & OFPUTIL_PC_PORT_DOWN
3364 && (config & OFPUTIL_PC_PORT_DOWN
3365 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3366 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3367 /* We tried to bring the port up or down, but it failed, so don't
3368 * update the "down" bit. */
3369 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3373 enum ofputil_port_config old_config = port->pp.config;
3374 port->pp.config ^= toggle;
3375 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3376 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3382 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3384 struct ofproto *p = ofconn_get_ofproto(ofconn);
3385 struct ofputil_port_mod pm;
3386 struct ofport *port;
3389 error = reject_slave_controller(ofconn);
3394 error = ofputil_decode_port_mod(oh, &pm, false);
3399 port = ofproto_get_port(p, pm.port_no);
3401 return OFPERR_OFPPMFC_BAD_PORT;
3402 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3403 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3405 update_port_config(ofconn, port, pm.config, pm.mask);
3407 netdev_set_advertisements(port->netdev, pm.advertise);
3414 handle_desc_stats_request(struct ofconn *ofconn,
3415 const struct ofp_header *request)
3417 static const char *default_mfr_desc = "Nicira, Inc.";
3418 static const char *default_hw_desc = "Open vSwitch";
3419 static const char *default_sw_desc = VERSION;
3420 static const char *default_serial_desc = "None";
3421 static const char *default_dp_desc = "None";
3423 struct ofproto *p = ofconn_get_ofproto(ofconn);
3424 struct ofp_desc_stats *ods;
3427 msg = ofpraw_alloc_stats_reply(request, 0);
3428 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3429 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3430 sizeof ods->mfr_desc);
3431 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3432 sizeof ods->hw_desc);
3433 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3434 sizeof ods->sw_desc);
3435 ovs_strlcpy(ods->serial_num,
3436 p->serial_desc ? p->serial_desc : default_serial_desc,
3437 sizeof ods->serial_num);
3438 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3439 sizeof ods->dp_desc);
3440 ofconn_send_reply(ofconn, msg);
3446 handle_table_stats_request(struct ofconn *ofconn,
3447 const struct ofp_header *request)
3449 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3450 struct ofputil_table_features *features;
3451 struct ofputil_table_stats *stats;
3452 struct ofpbuf *reply;
3455 query_tables(ofproto, &features, &stats);
3457 reply = ofputil_encode_table_stats_reply(request);
3458 for (i = 0; i < ofproto->n_tables; i++) {
3459 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3460 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3463 ofconn_send_reply(ofconn, reply);
3472 handle_table_features_request(struct ofconn *ofconn,
3473 const struct ofp_header *request)
3475 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3476 struct ofputil_table_features *features;
3477 struct ovs_list replies;
3481 ofpbuf_use_const(&msg, request, ntohs(request->length));
3482 ofpraw_pull_assert(&msg);
3483 if (msg.size || ofpmp_more(request)) {
3484 return OFPERR_OFPTFFC_EPERM;
3487 query_tables(ofproto, &features, NULL);
3489 ofpmp_init(&replies, request);
3490 for (i = 0; i < ofproto->n_tables; i++) {
3491 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3492 ofputil_append_table_features_reply(&features[i], &replies);
3495 ofconn_send_replies(ofconn, &replies);
3503 append_port_stat(struct ofport *port, struct ovs_list *replies)
3505 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3507 calc_duration(port->created, time_msec(),
3508 &ops.duration_sec, &ops.duration_nsec);
3510 /* Intentionally ignore return value, since errors will set
3511 * 'stats' to all-1s, which is correct for OpenFlow, and
3512 * netdev_get_stats() will log errors. */
3513 ofproto_port_get_stats(port, &ops.stats);
3515 ofputil_append_port_stat(replies, &ops);
3519 handle_port_request(struct ofconn *ofconn,
3520 const struct ofp_header *request, ofp_port_t port_no,
3521 void (*cb)(struct ofport *, struct ovs_list *replies))
3523 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3524 struct ofport *port;
3525 struct ovs_list replies;
3527 ofpmp_init(&replies, request);
3528 if (port_no != OFPP_ANY) {
3529 port = ofproto_get_port(ofproto, port_no);
3534 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3539 ofconn_send_replies(ofconn, &replies);
3543 handle_port_stats_request(struct ofconn *ofconn,
3544 const struct ofp_header *request)
3549 error = ofputil_decode_port_stats_request(request, &port_no);
3551 handle_port_request(ofconn, request, port_no, append_port_stat);
3557 append_port_desc(struct ofport *port, struct ovs_list *replies)
3559 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3563 handle_port_desc_stats_request(struct ofconn *ofconn,
3564 const struct ofp_header *request)
3569 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3571 handle_port_request(ofconn, request, port_no, append_port_desc);
3577 hash_cookie(ovs_be64 cookie)
3579 return hash_uint64((OVS_FORCE uint64_t)cookie);
3583 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3584 OVS_REQUIRES(ofproto_mutex)
3586 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3587 hash_cookie(rule->flow_cookie));
3591 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3592 OVS_REQUIRES(ofproto_mutex)
3594 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3598 calc_duration(long long int start, long long int now,
3599 uint32_t *sec, uint32_t *nsec)
3601 long long int msecs = now - start;
3602 *sec = msecs / 1000;
3603 *nsec = (msecs % 1000) * (1000 * 1000);
3606 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3607 * true if 'table_id' is OK, false otherwise. */
3609 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3611 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3614 static struct oftable *
3615 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3617 struct oftable *table;
3619 for (table = &ofproto->tables[table_id];
3620 table < &ofproto->tables[ofproto->n_tables];
3622 if (!(table->flags & OFTABLE_HIDDEN)) {
3630 static struct oftable *
3631 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3633 if (table_id == 0xff) {
3634 return next_visible_table(ofproto, 0);
3635 } else if (table_id < ofproto->n_tables) {
3636 return &ofproto->tables[table_id];
3642 static struct oftable *
3643 next_matching_table(const struct ofproto *ofproto,
3644 const struct oftable *table, uint8_t table_id)
3646 return (table_id == 0xff
3647 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3651 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3653 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3654 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3656 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3657 * only once, for that table. (This can be used to access tables marked
3660 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3661 * entered at all. (Perhaps you should have validated TABLE_ID with
3662 * check_table_id().)
3664 * All parameters are evaluated multiple times.
3666 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3667 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3669 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3671 /* Initializes 'criteria' in a straightforward way based on the other
3674 * By default, the criteria include flows that are read-only, on the assumption
3675 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3676 * if flows will be modified.
3678 * For "loose" matching, the 'priority' parameter is unimportant and may be
3681 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3682 const struct match *match, int priority, long long version,
3683 ovs_be64 cookie, ovs_be64 cookie_mask,
3684 ofp_port_t out_port, uint32_t out_group)
3686 criteria->table_id = table_id;
3687 cls_rule_init(&criteria->cr, match, priority, version);
3688 criteria->cookie = cookie;
3689 criteria->cookie_mask = cookie_mask;
3690 criteria->out_port = out_port;
3691 criteria->out_group = out_group;
3693 /* We ordinarily want to skip hidden rules, but there has to be a way for
3694 * code internal to OVS to modify and delete them, so if the criteria
3695 * specify a priority that can only be for a hidden flow, then allow hidden
3696 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3697 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3699 criteria->include_hidden = priority > UINT16_MAX;
3701 /* We assume that the criteria are being used to collect flows for reading
3702 * but not modification. Thus, we should collect read-only flows. */
3703 criteria->include_readonly = true;
3706 /* By default, criteria initialized by rule_criteria_init() will match flows
3707 * that are read-only, on the assumption that the collected flows won't be
3708 * modified. Call this function to match only flows that are be modifiable.
3710 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3711 * caller has special privileges that allow it to modify even "read-only"
3714 rule_criteria_require_rw(struct rule_criteria *criteria,
3715 bool can_write_readonly)
3717 criteria->include_readonly = can_write_readonly;
3721 rule_criteria_destroy(struct rule_criteria *criteria)
3723 cls_rule_destroy(&criteria->cr);
3727 rule_collection_init(struct rule_collection *rules)
3729 rules->rules = rules->stub;
3731 rules->capacity = ARRAY_SIZE(rules->stub);
3735 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3737 if (rules->n >= rules->capacity) {
3738 size_t old_size, new_size;
3740 old_size = rules->capacity * sizeof *rules->rules;
3741 rules->capacity *= 2;
3742 new_size = rules->capacity * sizeof *rules->rules;
3744 if (rules->rules == rules->stub) {
3745 rules->rules = xmalloc(new_size);
3746 memcpy(rules->rules, rules->stub, old_size);
3748 rules->rules = xrealloc(rules->rules, new_size);
3752 rules->rules[rules->n++] = rule;
3756 rule_collection_ref(struct rule_collection *rules)
3757 OVS_REQUIRES(ofproto_mutex)
3761 for (i = 0; i < rules->n; i++) {
3762 ofproto_rule_ref(rules->rules[i]);
3767 rule_collection_unref(struct rule_collection *rules)
3771 for (i = 0; i < rules->n; i++) {
3772 ofproto_rule_unref(rules->rules[i]);
3777 rule_collection_destroy(struct rule_collection *rules)
3779 if (rules->rules != rules->stub) {
3783 /* Make repeated destruction harmless. */
3784 rule_collection_init(rules);
3787 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3788 * function verifies most of the criteria in 'c' itself, but the caller must
3789 * check 'c->cr' itself.
3791 * Rules that have already been marked for removal are not collected.
3793 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3794 * 'c' only includes modifiable rules). */
3796 collect_rule(struct rule *rule, const struct rule_criteria *c,
3797 struct rule_collection *rules, size_t *n_readonly)
3798 OVS_REQUIRES(ofproto_mutex)
3800 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3801 && ofproto_rule_has_out_port(rule, c->out_port)
3802 && ofproto_rule_has_out_group(rule, c->out_group)
3803 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3804 && (!rule_is_hidden(rule) || c->include_hidden)
3805 && cls_rule_visible_in_version(&rule->cr, c->cr.version)) {
3806 /* Rule matches all the criteria... */
3807 if (!rule_is_readonly(rule) || c->include_readonly) {
3809 rule_collection_add(rules, rule);
3811 /* ...except it's read-only. */
3817 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3818 * on classifiers rules are done in the "loose" way required for OpenFlow
3819 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3822 * Returns 0 on success, otherwise an OpenFlow error code. */
3824 collect_rules_loose(struct ofproto *ofproto,
3825 const struct rule_criteria *criteria,
3826 struct rule_collection *rules)
3827 OVS_REQUIRES(ofproto_mutex)
3829 struct oftable *table;
3830 enum ofperr error = 0;
3831 size_t n_readonly = 0;
3833 rule_collection_init(rules);
3835 if (!check_table_id(ofproto, criteria->table_id)) {
3836 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3840 if (criteria->cookie_mask == OVS_BE64_MAX) {
3843 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3844 hash_cookie(criteria->cookie),
3845 &ofproto->cookies) {
3846 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3847 collect_rule(rule, criteria, rules, &n_readonly);
3851 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3854 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3855 collect_rule(rule, criteria, rules, &n_readonly);
3861 if (!error && !rules->n && n_readonly) {
3862 /* We didn't find any rules to modify. We did find some read-only
3863 * rules that we're not allowed to modify, so report that. */
3864 error = OFPERR_OFPBRC_EPERM;
3867 rule_collection_destroy(rules);
3872 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3873 * on classifiers rules are done in the "strict" way required for OpenFlow
3874 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3875 * rules on list 'rules'.
3877 * Returns 0 on success, otherwise an OpenFlow error code. */
3879 collect_rules_strict(struct ofproto *ofproto,
3880 const struct rule_criteria *criteria,
3881 struct rule_collection *rules)
3882 OVS_REQUIRES(ofproto_mutex)
3884 struct oftable *table;
3885 size_t n_readonly = 0;
3886 enum ofperr error = 0;
3888 rule_collection_init(rules);
3890 if (!check_table_id(ofproto, criteria->table_id)) {
3891 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3895 if (criteria->cookie_mask == OVS_BE64_MAX) {
3898 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3899 hash_cookie(criteria->cookie),
3900 &ofproto->cookies) {
3901 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3902 collect_rule(rule, criteria, rules, &n_readonly);
3906 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3909 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3910 &table->cls, &criteria->cr));
3912 collect_rule(rule, criteria, rules, &n_readonly);
3918 if (!error && !rules->n && n_readonly) {
3919 /* We didn't find any rules to modify. We did find some read-only
3920 * rules that we're not allowed to modify, so report that. */
3921 error = OFPERR_OFPBRC_EPERM;
3924 rule_collection_destroy(rules);
3929 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3930 * forced into the range of a uint16_t. */
3932 age_secs(long long int age_ms)
3934 return (age_ms < 0 ? 0
3935 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3936 : (unsigned int) age_ms / 1000);
3940 handle_flow_stats_request(struct ofconn *ofconn,
3941 const struct ofp_header *request)
3942 OVS_EXCLUDED(ofproto_mutex)
3944 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3945 struct ofputil_flow_stats_request fsr;
3946 struct rule_criteria criteria;
3947 struct rule_collection rules;
3948 struct ovs_list replies;
3952 error = ofputil_decode_flow_stats_request(&fsr, request);
3957 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
3958 fsr.cookie, fsr.cookie_mask, fsr.out_port,
3961 ovs_mutex_lock(&ofproto_mutex);
3962 error = collect_rules_loose(ofproto, &criteria, &rules);
3963 rule_criteria_destroy(&criteria);
3965 rule_collection_ref(&rules);
3967 ovs_mutex_unlock(&ofproto_mutex);
3973 ofpmp_init(&replies, request);
3974 for (i = 0; i < rules.n; i++) {
3975 struct rule *rule = rules.rules[i];
3976 long long int now = time_msec();
3977 struct ofputil_flow_stats fs;
3978 long long int created, used, modified;
3979 const struct rule_actions *actions;
3980 enum ofputil_flow_mod_flags flags;
3982 ovs_mutex_lock(&rule->mutex);
3983 fs.cookie = rule->flow_cookie;
3984 fs.idle_timeout = rule->idle_timeout;
3985 fs.hard_timeout = rule->hard_timeout;
3986 fs.importance = rule->importance;
3987 created = rule->created;
3988 modified = rule->modified;
3989 actions = rule_get_actions(rule);
3990 flags = rule->flags;
3991 ovs_mutex_unlock(&rule->mutex);
3993 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3994 &fs.byte_count, &used);
3996 minimatch_expand(&rule->cr.match, &fs.match);
3997 fs.table_id = rule->table_id;
3998 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3999 fs.priority = rule->cr.priority;
4000 fs.idle_age = age_secs(now - used);
4001 fs.hard_age = age_secs(now - modified);
4002 fs.ofpacts = actions->ofpacts;
4003 fs.ofpacts_len = actions->ofpacts_len;
4006 ofputil_append_flow_stats_reply(&fs, &replies);
4009 rule_collection_unref(&rules);
4010 rule_collection_destroy(&rules);
4012 ofconn_send_replies(ofconn, &replies);
4018 flow_stats_ds(struct rule *rule, struct ds *results)
4020 uint64_t packet_count, byte_count;
4021 const struct rule_actions *actions;
4022 long long int created, used;
4024 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4025 &byte_count, &used);
4027 ovs_mutex_lock(&rule->mutex);
4028 actions = rule_get_actions(rule);
4029 created = rule->created;
4030 ovs_mutex_unlock(&rule->mutex);
4032 if (rule->table_id != 0) {
4033 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4035 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4036 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4037 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4038 cls_rule_format(&rule->cr, results);
4039 ds_put_char(results, ',');
4041 ds_put_cstr(results, "actions=");
4042 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4044 ds_put_cstr(results, "\n");
4047 /* Adds a pretty-printed description of all flows to 'results', including
4048 * hidden flows (e.g., set up by in-band control). */
4050 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4052 struct oftable *table;
4054 OFPROTO_FOR_EACH_TABLE (table, p) {
4057 CLS_FOR_EACH (rule, cr, &table->cls) {
4058 flow_stats_ds(rule, results);
4063 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4064 * '*engine_type' and '*engine_id', respectively. */
4066 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4067 uint8_t *engine_type, uint8_t *engine_id)
4069 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4072 /* Checks the status change of CFM on 'ofport'.
4074 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4076 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4078 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4079 return (ofport && ofproto->ofproto_class->cfm_status_changed
4080 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4084 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4085 * Returns 0 if the port's CFM status was successfully stored into
4086 * '*status'. Returns positive errno if the port did not have CFM
4089 * The caller must provide and own '*status', and must free 'status->rmps'.
4090 * '*status' is indeterminate if the return value is non-zero. */
4092 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4093 struct cfm_status *status)
4095 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4096 return (ofport && ofproto->ofproto_class->get_cfm_status
4097 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4102 handle_aggregate_stats_request(struct ofconn *ofconn,
4103 const struct ofp_header *oh)
4104 OVS_EXCLUDED(ofproto_mutex)
4106 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4107 struct ofputil_flow_stats_request request;
4108 struct ofputil_aggregate_stats stats;
4109 bool unknown_packets, unknown_bytes;
4110 struct rule_criteria criteria;
4111 struct rule_collection rules;
4112 struct ofpbuf *reply;
4116 error = ofputil_decode_flow_stats_request(&request, oh);
4121 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4122 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4123 request.out_port, request.out_group);
4125 ovs_mutex_lock(&ofproto_mutex);
4126 error = collect_rules_loose(ofproto, &criteria, &rules);
4127 rule_criteria_destroy(&criteria);
4129 rule_collection_ref(&rules);
4131 ovs_mutex_unlock(&ofproto_mutex);
4137 memset(&stats, 0, sizeof stats);
4138 unknown_packets = unknown_bytes = false;
4139 for (i = 0; i < rules.n; i++) {
4140 struct rule *rule = rules.rules[i];
4141 uint64_t packet_count;
4142 uint64_t byte_count;
4145 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4146 &byte_count, &used);
4148 if (packet_count == UINT64_MAX) {
4149 unknown_packets = true;
4151 stats.packet_count += packet_count;
4154 if (byte_count == UINT64_MAX) {
4155 unknown_bytes = true;
4157 stats.byte_count += byte_count;
4162 if (unknown_packets) {
4163 stats.packet_count = UINT64_MAX;
4165 if (unknown_bytes) {
4166 stats.byte_count = UINT64_MAX;
4169 rule_collection_unref(&rules);
4170 rule_collection_destroy(&rules);
4172 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4173 ofconn_send_reply(ofconn, reply);
4178 struct queue_stats_cbdata {
4179 struct ofport *ofport;
4180 struct ovs_list replies;
4185 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4186 const struct netdev_queue_stats *stats)
4188 struct ofputil_queue_stats oqs;
4190 oqs.port_no = cbdata->ofport->pp.port_no;
4191 oqs.queue_id = queue_id;
4192 oqs.tx_bytes = stats->tx_bytes;
4193 oqs.tx_packets = stats->tx_packets;
4194 oqs.tx_errors = stats->tx_errors;
4195 if (stats->created != LLONG_MIN) {
4196 calc_duration(stats->created, cbdata->now,
4197 &oqs.duration_sec, &oqs.duration_nsec);
4199 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4201 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4205 handle_queue_stats_dump_cb(uint32_t queue_id,
4206 struct netdev_queue_stats *stats,
4209 struct queue_stats_cbdata *cbdata = cbdata_;
4211 put_queue_stats(cbdata, queue_id, stats);
4215 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4216 struct queue_stats_cbdata *cbdata)
4218 cbdata->ofport = port;
4219 if (queue_id == OFPQ_ALL) {
4220 netdev_dump_queue_stats(port->netdev,
4221 handle_queue_stats_dump_cb, cbdata);
4223 struct netdev_queue_stats stats;
4225 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4226 put_queue_stats(cbdata, queue_id, &stats);
4228 return OFPERR_OFPQOFC_BAD_QUEUE;
4235 handle_queue_stats_request(struct ofconn *ofconn,
4236 const struct ofp_header *rq)
4238 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4239 struct queue_stats_cbdata cbdata;
4240 struct ofport *port;
4242 struct ofputil_queue_stats_request oqsr;
4244 COVERAGE_INC(ofproto_queue_req);
4246 ofpmp_init(&cbdata.replies, rq);
4247 cbdata.now = time_msec();
4249 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4254 if (oqsr.port_no == OFPP_ANY) {
4255 error = OFPERR_OFPQOFC_BAD_QUEUE;
4256 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4257 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4262 port = ofproto_get_port(ofproto, oqsr.port_no);
4264 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4265 : OFPERR_OFPQOFC_BAD_PORT);
4268 ofconn_send_replies(ofconn, &cbdata.replies);
4270 ofpbuf_list_delete(&cbdata.replies);
4277 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4278 OVS_REQUIRES(ofproto_mutex)
4280 enum ofperr error = 0;
4281 struct rule_collection rules;
4282 unsigned int count = classifier_count(&table->cls) + extra_space;
4283 unsigned int max_flows = table->max_flows;
4285 rule_collection_init(&rules);
4287 while (count-- > max_flows) {
4290 if (!choose_rule_to_evict(table, &rule)) {
4291 error = OFPERR_OFPFMFC_TABLE_FULL;
4294 eviction_group_remove_rule(rule);
4295 rule_collection_add(&rules, rule);
4298 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4299 rule_collection_destroy(&rules);
4305 is_conjunction(const struct ofpact *ofpacts, size_t ofpacts_len)
4307 return ofpacts_len > 0 && ofpacts->type == OFPACT_CONJUNCTION;
4311 get_conjunctions(const struct ofputil_flow_mod *fm,
4312 struct cls_conjunction **conjsp, size_t *n_conjsp)
4313 OVS_REQUIRES(ofproto_mutex)
4315 struct cls_conjunction *conjs = NULL;
4318 if (is_conjunction(fm->ofpacts, fm->ofpacts_len)) {
4319 const struct ofpact *ofpact;
4323 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4327 conjs = xzalloc(n_conjs * sizeof *conjs);
4329 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4330 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4331 conjs[i].clause = oc->clause;
4332 conjs[i].n_clauses = oc->n_clauses;
4333 conjs[i].id = oc->id;
4339 *n_conjsp = n_conjs;
4343 set_conjunctions(struct rule *rule, const struct cls_conjunction *conjs,
4345 OVS_REQUIRES(ofproto_mutex)
4347 struct cls_rule *cr = CONST_CAST(struct cls_rule *, &rule->cr);
4349 cls_rule_set_conjunctions(cr, conjs, n_conjs);
4352 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4353 * in which no matching flow already exists in the flow table.
4355 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4356 * success, or an OpenFlow error code on failure.
4358 * On successful return the caller must complete the operation either by
4359 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4362 * The caller retains ownership of 'fm->ofpacts'. */
4364 add_flow_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4365 struct rule **rulep, bool *modify)
4366 OVS_REQUIRES(ofproto_mutex)
4368 struct oftable *table;
4372 enum ofperr error = 0;
4374 if (!check_table_id(ofproto, fm->table_id)) {
4375 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4380 if (fm->table_id == 0xff) {
4381 if (ofproto->ofproto_class->rule_choose_table) {
4382 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4388 ovs_assert(table_id < ofproto->n_tables);
4392 } else if (fm->table_id < ofproto->n_tables) {
4393 table_id = fm->table_id;
4395 return OFPERR_OFPBRC_BAD_TABLE_ID;
4398 table = &ofproto->tables[table_id];
4399 if (table->flags & OFTABLE_READONLY
4400 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4401 return OFPERR_OFPBRC_EPERM;
4404 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4405 && !match_has_default_hidden_fields(&fm->match)) {
4406 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4407 "non-default values to hidden fields", ofproto->name);
4408 return OFPERR_OFPBRC_EPERM;
4411 cls_rule_init(&cr, &fm->match, fm->priority, CLS_MIN_VERSION);
4413 /* Check for the existence of an identical rule.
4414 * This will not return rules earlier marked for removal. */
4415 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4417 /* Transform "add" into "modify" of an existing identical flow. */
4418 cls_rule_destroy(&cr);
4420 fm->modify_cookie = true;
4421 error = modify_flow_check__(ofproto, fm, rule);
4427 } else { /* New rule. */
4428 struct cls_conjunction *conjs;
4431 /* Check for overlap, if requested. */
4432 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4433 && classifier_rule_overlaps(&table->cls, &cr)) {
4434 cls_rule_destroy(&cr);
4435 return OFPERR_OFPFMFC_OVERLAP;
4438 /* If necessary, evict an existing rule to clear out space. */
4439 error = evict_rules_from_table(table, 1);
4441 cls_rule_destroy(&cr);
4445 /* Allocate new rule. */
4446 error = ofproto_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4452 /* Insert flow to the classifier, so that later flow_mods may relate
4453 * to it. This is reversible, in case later errors require this to
4455 ofproto_rule_insert__(ofproto, rule);
4456 /* Make the new rule invisible for classifier lookups. */
4457 classifier_defer(&table->cls);
4458 get_conjunctions(fm, &conjs, &n_conjs);
4459 classifier_insert(&table->cls, &rule->cr, conjs, n_conjs);
4462 error = ofproto->ofproto_class->rule_insert(rule);
4464 oftable_remove_rule(rule);
4465 ofproto_rule_unref(rule);
4476 /* Revert the effects of add_flow_start().
4477 * 'new_rule' must be passed in as NULL, if no new rule was allocated and
4478 * inserted to the classifier.
4479 * Note: evictions cannot be reverted. */
4481 add_flow_revert(struct ofproto *ofproto, struct rule *new_rule)
4482 OVS_REQUIRES(ofproto_mutex)
4484 /* Old rule was not changed yet, only need to revert a new rule. */
4486 struct oftable *table = &ofproto->tables[new_rule->table_id];
4488 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4491 classifier_publish(&table->cls);
4493 ofproto_rule_remove__(ofproto, new_rule);
4494 ofproto->ofproto_class->rule_delete(new_rule);
4495 ofproto_rule_unref(new_rule);
4500 add_flow_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4501 const struct flow_mod_requester *req,
4502 struct rule *rule, bool modify)
4503 OVS_REQUIRES(ofproto_mutex)
4506 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4508 modify_flow__(ofproto, fm, req, rule, &dead_cookies);
4509 learned_cookies_flush(ofproto, &dead_cookies);
4511 struct oftable *table = &ofproto->tables[rule->table_id];
4513 classifier_publish(&table->cls);
4515 learned_cookies_inc(ofproto, rule_get_actions(rule));
4517 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
4518 if (ofproto->vlan_bitmap) {
4519 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4521 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4522 bitmap_set1(ofproto->vlan_bitmap, vid);
4523 ofproto->vlans_changed = true;
4526 ofproto->vlans_changed = true;
4530 ofmonitor_report(ofproto->connmgr, rule, NXFME_ADDED, 0,
4531 req ? req->ofconn : NULL,
4532 req ? req->request->xid : 0, NULL);
4535 send_buffered_packet(req, fm->buffer_id, rule);
4538 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4540 /* Checks if the 'rule' can be modified to match 'fm'.
4542 * Returns 0 on success, otherwise an OpenFlow error code. */
4544 modify_flow_check__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4545 const struct rule *rule)
4546 OVS_REQUIRES(ofproto_mutex)
4548 if (ofproto->ofproto_class->rule_premodify_actions) {
4549 return ofproto->ofproto_class->rule_premodify_actions(
4550 rule, fm->ofpacts, fm->ofpacts_len);
4555 /* Checks if the rules listed in 'rules' can have their actions changed to
4556 * match those in 'fm'.
4558 * Returns 0 on success, otherwise an OpenFlow error code. */
4560 modify_flows_check__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4561 const struct rule_collection *rules)
4562 OVS_REQUIRES(ofproto_mutex)
4567 if (ofproto->ofproto_class->rule_premodify_actions) {
4568 for (i = 0; i < rules->n; i++) {
4569 error = modify_flow_check__(ofproto, fm, rules->rules[i]);
4579 /* Modifies the 'rule', changing it to match 'fm'. */
4581 modify_flow__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4582 const struct flow_mod_requester *req, struct rule *rule,
4583 struct ovs_list *dead_cookies)
4584 OVS_REQUIRES(ofproto_mutex)
4586 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4587 ? NXFME_ADDED : NXFME_MODIFIED;
4589 /* 'fm' says that */
4590 bool change_cookie = (fm->modify_cookie
4591 && fm->new_cookie != OVS_BE64_MAX
4592 && fm->new_cookie != rule->flow_cookie);
4594 const struct rule_actions *actions = rule_get_actions(rule);
4595 bool change_actions = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4597 actions->ofpacts_len);
4599 bool reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4601 long long int now = time_msec();
4603 if (change_cookie) {
4604 cookies_remove(ofproto, rule);
4607 ovs_mutex_lock(&rule->mutex);
4608 if (fm->command == OFPFC_ADD) {
4609 rule->idle_timeout = fm->idle_timeout;
4610 rule->hard_timeout = fm->hard_timeout;
4611 rule->importance = fm->importance;
4612 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4613 rule->created = now;
4615 if (change_cookie) {
4616 rule->flow_cookie = fm->new_cookie;
4618 rule->modified = now;
4619 ovs_mutex_unlock(&rule->mutex);
4621 if (change_cookie) {
4622 cookies_insert(ofproto, rule);
4624 if (fm->command == OFPFC_ADD) {
4625 if (fm->idle_timeout || fm->hard_timeout || fm->importance) {
4626 if (!rule->eviction_group) {
4627 eviction_group_add_rule(rule);
4630 eviction_group_remove_rule(rule);
4634 if (change_actions) {
4635 /* We have to change the actions. The rule's conjunctive match set
4636 * is a function of its actions, so we need to update that too. The
4637 * conjunctive match set is used in the lookup process to figure
4638 * which (if any) collection of conjunctive sets the packet matches
4639 * with. However, a rule with conjunction actions is never to be
4640 * returned as a classifier lookup result. To make sure a rule with
4641 * conjunction actions is not returned as a lookup result, we update
4642 * them in a carefully chosen order:
4644 * - If we're adding a conjunctive match set where there wasn't one
4645 * before, we have to make the conjunctive match set available to
4646 * lookups before the rule's actions are changed, as otherwise
4647 * rule with a conjunction action could be returned as a lookup
4650 * - To clear some nonempty conjunctive set, we set the rule's
4651 * actions first, so that a lookup can't return a rule with
4652 * conjunction actions.
4654 * - Otherwise, order doesn't matter for changing one nonempty
4655 * conjunctive match set to some other nonempty set, since the
4656 * rule's actions are not seen by the classifier, and hence don't
4657 * matter either before or after the change. */
4658 struct cls_conjunction *conjs;
4660 get_conjunctions(fm, &conjs, &n_conjs);
4663 set_conjunctions(rule, conjs, n_conjs);
4665 ovsrcu_set(&rule->actions, rule_actions_create(fm->ofpacts,
4668 set_conjunctions(rule, conjs, n_conjs);
4674 if (change_actions || reset_counters) {
4675 ofproto->ofproto_class->rule_modify_actions(rule, reset_counters);
4678 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4679 ofmonitor_report(ofproto->connmgr, rule, event, 0,
4680 req ? req->ofconn : NULL, req ? req->request->xid : 0,
4681 change_actions ? actions : NULL);
4684 if (change_actions) {
4685 learned_cookies_inc(ofproto, rule_get_actions(rule));
4686 learned_cookies_dec(ofproto, actions, dead_cookies);
4687 rule_actions_destroy(actions);
4691 /* Modifies the rules listed in 'rules', changing their actions to match those
4694 * 'req' is used to retrieve the packet buffer specified in fm->buffer_id,
4697 modify_flows__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4698 const struct flow_mod_requester *req,
4699 const struct rule_collection *rules)
4700 OVS_REQUIRES(ofproto_mutex)
4702 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4705 for (i = 0; i < rules->n; i++) {
4706 modify_flow__(ofproto, fm, req, rules->rules[i], &dead_cookies);
4708 learned_cookies_flush(ofproto, &dead_cookies);
4712 modify_flows_start__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4713 struct rule_collection *rules)
4714 OVS_REQUIRES(ofproto_mutex)
4719 error = modify_flows_check__(ofproto, fm, rules);
4720 } else if (!(fm->cookie_mask != htonll(0)
4721 || fm->new_cookie == OVS_BE64_MAX)) {
4724 error = add_flow_start(ofproto, fm, &rules->rules[0], &modify);
4726 ovs_assert(!modify);
4729 rules->rules[0] = NULL;
4735 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4738 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4741 modify_flows_start_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4742 struct rule_collection *rules)
4743 OVS_REQUIRES(ofproto_mutex)
4745 struct rule_criteria criteria;
4748 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4749 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4750 rule_criteria_require_rw(&criteria,
4751 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4752 error = collect_rules_loose(ofproto, &criteria, rules);
4753 rule_criteria_destroy(&criteria);
4756 error = modify_flows_start__(ofproto, fm, rules);
4760 rule_collection_destroy(rules);
4766 modify_flows_revert(struct ofproto *ofproto, struct rule_collection *rules)
4767 OVS_REQUIRES(ofproto_mutex)
4769 /* Old rules were not changed yet, only need to revert a new rule. */
4770 if (rules->n == 0 && rules->rules[0] != NULL) {
4771 add_flow_revert(ofproto, rules->rules[0]);
4773 rule_collection_destroy(rules);
4777 modify_flows_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4778 const struct flow_mod_requester *req,
4779 struct rule_collection *rules)
4780 OVS_REQUIRES(ofproto_mutex)
4783 modify_flows__(ofproto, fm, req, rules);
4784 send_buffered_packet(req, fm->buffer_id, rules->rules[0]);
4785 } else if (rules->rules[0] != NULL) {
4786 add_flow_finish(ofproto, fm, req, rules->rules[0], false);
4788 rule_collection_destroy(rules);
4791 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4792 * code on failure. */
4794 modify_flow_start_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4795 struct rule_collection *rules)
4796 OVS_REQUIRES(ofproto_mutex)
4798 struct rule_criteria criteria;
4801 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4802 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
4804 rule_criteria_require_rw(&criteria,
4805 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4806 error = collect_rules_strict(ofproto, &criteria, rules);
4807 rule_criteria_destroy(&criteria);
4810 /* collect_rules_strict() can return max 1 rule. */
4811 error = modify_flows_start__(ofproto, fm, rules);
4815 rule_collection_destroy(rules);
4820 /* OFPFC_DELETE implementation. */
4822 /* Deletes the rules listed in 'rules'. */
4824 delete_flows__(const struct rule_collection *rules,
4825 enum ofp_flow_removed_reason reason,
4826 const struct flow_mod_requester *req)
4827 OVS_REQUIRES(ofproto_mutex)
4830 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4831 struct ofproto *ofproto = rules->rules[0]->ofproto;
4832 struct rule *rule, *next;
4833 uint8_t prev_table = UINT8_MAX;
4836 for (i = 0, next = rules->rules[0];
4837 rule = next, next = (++i < rules->n) ? rules->rules[i] : NULL,
4838 rule; prev_table = rule->table_id) {
4839 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
4840 uint8_t next_table = next ? next->table_id : UINT8_MAX;
4842 ofproto_rule_send_removed(rule, reason);
4844 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4845 req ? req->ofconn : NULL,
4846 req ? req->request->xid : 0, NULL);
4848 /* Defer once for each new table. */
4849 if (rule->table_id != prev_table) {
4850 classifier_defer(cls);
4852 if (!classifier_remove(cls, &rule->cr)) {
4855 if (next_table != rule->table_id) {
4856 classifier_publish(cls);
4858 ofproto_rule_remove__(ofproto, rule);
4860 ofproto->ofproto_class->rule_delete(rule);
4862 learned_cookies_dec(ofproto, rule_get_actions(rule),
4865 ofproto_rule_unref(rule);
4867 learned_cookies_flush(ofproto, &dead_cookies);
4868 ofmonitor_flush(ofproto->connmgr);
4872 /* Implements OFPFC_DELETE. */
4874 delete_flows_start_loose(struct ofproto *ofproto,
4875 const struct ofputil_flow_mod *fm,
4876 struct rule_collection *rules)
4877 OVS_REQUIRES(ofproto_mutex)
4879 struct rule_criteria criteria;
4882 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4883 fm->cookie, fm->cookie_mask,
4884 fm->out_port, fm->out_group);
4885 rule_criteria_require_rw(&criteria,
4886 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4887 error = collect_rules_loose(ofproto, &criteria, rules);
4888 rule_criteria_destroy(&criteria);
4891 for (size_t i = 0; i < rules->n; i++) {
4892 struct rule *rule = rules->rules[i];
4894 cls_rule_make_invisible_in_version(CONST_CAST(struct cls_rule *,
4905 delete_flows_revert(struct rule_collection *rules)
4906 OVS_REQUIRES(ofproto_mutex)
4908 for (size_t i = 0; i < rules->n; i++) {
4909 cls_rule_restore_visibility(&rules->rules[i]->cr);
4911 rule_collection_destroy(rules);
4915 delete_flows_finish(const struct ofputil_flow_mod *fm,
4916 const struct flow_mod_requester *req,
4917 struct rule_collection *rules)
4918 OVS_REQUIRES(ofproto_mutex)
4920 delete_flows__(rules, fm->delete_reason, req);
4921 rule_collection_destroy(rules);
4924 /* Implements OFPFC_DELETE_STRICT. */
4926 delete_flow_start_strict(struct ofproto *ofproto,
4927 const struct ofputil_flow_mod *fm,
4928 struct rule_collection *rules)
4929 OVS_REQUIRES(ofproto_mutex)
4931 struct rule_criteria criteria;
4934 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4935 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
4936 fm->out_port, fm->out_group);
4937 rule_criteria_require_rw(&criteria,
4938 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4939 error = collect_rules_strict(ofproto, &criteria, rules);
4940 rule_criteria_destroy(&criteria);
4943 for (size_t i = 0; i < rules->n; i++) {
4944 struct rule *rule = rules->rules[i];
4946 cls_rule_make_invisible_in_version(CONST_CAST(struct cls_rule *,
4957 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4958 OVS_REQUIRES(ofproto_mutex)
4960 struct ofputil_flow_removed fr;
4963 if (rule_is_hidden(rule) ||
4964 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4968 minimatch_expand(&rule->cr.match, &fr.match);
4969 fr.priority = rule->cr.priority;
4970 fr.cookie = rule->flow_cookie;
4972 fr.table_id = rule->table_id;
4973 calc_duration(rule->created, time_msec(),
4974 &fr.duration_sec, &fr.duration_nsec);
4975 ovs_mutex_lock(&rule->mutex);
4976 fr.idle_timeout = rule->idle_timeout;
4977 fr.hard_timeout = rule->hard_timeout;
4978 ovs_mutex_unlock(&rule->mutex);
4979 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4980 &fr.byte_count, &used);
4982 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4985 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4986 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4989 * ofproto implementation ->run() functions should use this function to expire
4990 * OpenFlow flows. */
4992 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4993 OVS_REQUIRES(ofproto_mutex)
4995 struct rule_collection rules;
4997 rules.rules = rules.stub;
4999 rules.stub[0] = rule;
5000 delete_flows__(&rules, reason, NULL);
5003 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5004 * means "infinite". */
5006 reduce_timeout(uint16_t max, uint16_t *timeout)
5008 if (max && (!*timeout || *timeout > max)) {
5013 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5014 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5015 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5017 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5019 ofproto_rule_reduce_timeouts(struct rule *rule,
5020 uint16_t idle_timeout, uint16_t hard_timeout)
5021 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5023 if (!idle_timeout && !hard_timeout) {
5027 ovs_mutex_lock(&ofproto_mutex);
5028 if (list_is_empty(&rule->expirable)) {
5029 list_insert(&rule->ofproto->expirable, &rule->expirable);
5031 ovs_mutex_unlock(&ofproto_mutex);
5033 ovs_mutex_lock(&rule->mutex);
5034 reduce_timeout(idle_timeout, &rule->idle_timeout);
5035 reduce_timeout(hard_timeout, &rule->hard_timeout);
5036 ovs_mutex_unlock(&rule->mutex);
5040 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5041 OVS_EXCLUDED(ofproto_mutex)
5043 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5044 struct ofputil_flow_mod fm;
5045 uint64_t ofpacts_stub[1024 / 8];
5046 struct ofpbuf ofpacts;
5049 error = reject_slave_controller(ofconn);
5054 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5055 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
5057 u16_to_ofp(ofproto->max_ports),
5060 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
5063 struct flow_mod_requester req;
5065 req.ofconn = ofconn;
5067 error = handle_flow_mod__(ofproto, &fm, &req);
5070 goto exit_free_ofpacts;
5073 ofconn_report_flow_mod(ofconn, fm.command);
5076 ofpbuf_uninit(&ofpacts);
5082 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
5083 const struct flow_mod_requester *req)
5084 OVS_EXCLUDED(ofproto_mutex)
5086 struct ofp_bundle_entry be;
5089 ovs_mutex_lock(&ofproto_mutex);
5090 error = do_bundle_flow_mod_start(ofproto, fm, &be);
5092 do_bundle_flow_mod_finish(ofproto, fm, req, &be);
5094 ofmonitor_flush(ofproto->connmgr);
5095 ovs_mutex_unlock(&ofproto_mutex);
5097 run_rule_executes(ofproto);
5102 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5104 struct ofputil_role_request request;
5105 struct ofputil_role_request reply;
5109 error = ofputil_decode_role_message(oh, &request);
5114 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5115 if (request.have_generation_id
5116 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5117 return OFPERR_OFPRRFC_STALE;
5120 ofconn_set_role(ofconn, request.role);
5123 reply.role = ofconn_get_role(ofconn);
5124 reply.have_generation_id = ofconn_get_master_election_id(
5125 ofconn, &reply.generation_id);
5126 buf = ofputil_encode_role_reply(oh, &reply);
5127 ofconn_send_reply(ofconn, buf);
5133 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5134 const struct ofp_header *oh)
5136 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5137 enum ofputil_protocol cur, next;
5139 cur = ofconn_get_protocol(ofconn);
5140 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5141 ofconn_set_protocol(ofconn, next);
5147 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5149 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5150 enum ofputil_protocol cur, next;
5151 enum ofputil_protocol next_base;
5153 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5155 return OFPERR_OFPBRC_EPERM;
5158 cur = ofconn_get_protocol(ofconn);
5159 next = ofputil_protocol_set_base(cur, next_base);
5160 ofconn_set_protocol(ofconn, next);
5166 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5167 const struct ofp_header *oh)
5169 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5172 format = ntohl(msg->format);
5173 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5174 return OFPERR_OFPBRC_EPERM;
5177 ofconn_set_packet_in_format(ofconn, format);
5182 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5184 const struct nx_async_config *msg = ofpmsg_body(oh);
5185 uint32_t master[OAM_N_TYPES];
5186 uint32_t slave[OAM_N_TYPES];
5188 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5189 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5190 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5192 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5193 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5194 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5196 ofconn_set_async_config(ofconn, master, slave);
5197 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5198 !ofconn_get_miss_send_len(ofconn)) {
5199 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5206 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5209 uint32_t master[OAM_N_TYPES];
5210 uint32_t slave[OAM_N_TYPES];
5211 struct nx_async_config *msg;
5213 ofconn_get_async_config(ofconn, master, slave);
5214 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5215 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5217 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5218 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5219 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5221 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5222 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5223 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5225 ofconn_send_reply(ofconn, buf);
5231 handle_nxt_set_controller_id(struct ofconn *ofconn,
5232 const struct ofp_header *oh)
5234 const struct nx_controller_id *nci = ofpmsg_body(oh);
5236 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5237 return OFPERR_NXBRC_MUST_BE_ZERO;
5240 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5245 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5249 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5250 ? OFPRAW_OFPT10_BARRIER_REPLY
5251 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5252 ofconn_send_reply(ofconn, buf);
5257 ofproto_compose_flow_refresh_update(const struct rule *rule,
5258 enum nx_flow_monitor_flags flags,
5259 struct ovs_list *msgs)
5260 OVS_REQUIRES(ofproto_mutex)
5262 const struct rule_actions *actions;
5263 struct ofputil_flow_update fu;
5266 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5267 ? NXFME_ADDED : NXFME_MODIFIED);
5269 ovs_mutex_lock(&rule->mutex);
5270 fu.idle_timeout = rule->idle_timeout;
5271 fu.hard_timeout = rule->hard_timeout;
5272 ovs_mutex_unlock(&rule->mutex);
5273 fu.table_id = rule->table_id;
5274 fu.cookie = rule->flow_cookie;
5275 minimatch_expand(&rule->cr.match, &match);
5277 fu.priority = rule->cr.priority;
5279 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5280 fu.ofpacts = actions ? actions->ofpacts : NULL;
5281 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5283 if (list_is_empty(msgs)) {
5284 ofputil_start_flow_update(msgs);
5286 ofputil_append_flow_update(&fu, msgs);
5290 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5291 struct ovs_list *msgs)
5292 OVS_REQUIRES(ofproto_mutex)
5296 for (i = 0; i < rules->n; i++) {
5297 struct rule *rule = rules->rules[i];
5298 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5299 rule->monitor_flags = 0;
5301 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5306 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5307 struct rule *rule, uint64_t seqno,
5308 struct rule_collection *rules)
5309 OVS_REQUIRES(ofproto_mutex)
5311 enum nx_flow_monitor_flags update;
5313 if (rule_is_hidden(rule)) {
5317 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5322 if (rule->add_seqno > seqno) {
5323 update = NXFMF_ADD | NXFMF_MODIFY;
5324 } else if (rule->modify_seqno > seqno) {
5325 update = NXFMF_MODIFY;
5330 if (!(m->flags & update)) {
5334 update = NXFMF_INITIAL;
5337 if (!rule->monitor_flags) {
5338 rule_collection_add(rules, rule);
5340 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5344 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5346 struct rule_collection *rules)
5347 OVS_REQUIRES(ofproto_mutex)
5349 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5350 const struct oftable *table;
5351 struct cls_rule target;
5353 cls_rule_init_from_minimatch(&target, &m->match, 0, CLS_MAX_VERSION);
5354 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5357 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5358 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5361 cls_rule_destroy(&target);
5365 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5366 struct rule_collection *rules)
5367 OVS_REQUIRES(ofproto_mutex)
5369 if (m->flags & NXFMF_INITIAL) {
5370 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5375 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5376 uint64_t seqno, struct rule_collection *rules)
5377 OVS_REQUIRES(ofproto_mutex)
5379 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5383 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5384 OVS_REQUIRES(ofproto_mutex)
5386 struct ofmonitor *m;
5389 m = ofmonitor_lookup(ofconn, id);
5391 ofmonitor_destroy(m);
5394 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5401 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5402 OVS_EXCLUDED(ofproto_mutex)
5404 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5405 struct ofmonitor **monitors;
5406 size_t n_monitors, allocated_monitors;
5407 struct rule_collection rules;
5408 struct ovs_list replies;
5413 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5415 n_monitors = allocated_monitors = 0;
5417 ovs_mutex_lock(&ofproto_mutex);
5419 struct ofputil_flow_monitor_request request;
5420 struct ofmonitor *m;
5423 retval = ofputil_decode_flow_monitor_request(&request, &b);
5424 if (retval == EOF) {
5426 } else if (retval) {
5431 if (request.table_id != 0xff
5432 && request.table_id >= ofproto->n_tables) {
5433 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5437 error = ofmonitor_create(&request, ofconn, &m);
5442 if (n_monitors >= allocated_monitors) {
5443 monitors = x2nrealloc(monitors, &allocated_monitors,
5446 monitors[n_monitors++] = m;
5449 rule_collection_init(&rules);
5450 for (i = 0; i < n_monitors; i++) {
5451 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5454 ofpmp_init(&replies, oh);
5455 ofmonitor_compose_refresh_updates(&rules, &replies);
5456 ovs_mutex_unlock(&ofproto_mutex);
5458 rule_collection_destroy(&rules);
5460 ofconn_send_replies(ofconn, &replies);
5466 for (i = 0; i < n_monitors; i++) {
5467 ofmonitor_destroy(monitors[i]);
5470 ovs_mutex_unlock(&ofproto_mutex);
5476 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5477 OVS_EXCLUDED(ofproto_mutex)
5482 id = ofputil_decode_flow_monitor_cancel(oh);
5484 ovs_mutex_lock(&ofproto_mutex);
5485 error = flow_monitor_delete(ofconn, id);
5486 ovs_mutex_unlock(&ofproto_mutex);
5491 /* Meters implementation.
5493 * Meter table entry, indexed by the OpenFlow meter_id.
5494 * 'created' is used to compute the duration for meter stats.
5495 * 'list rules' is needed so that we can delete the dependent rules when the
5496 * meter table entry is deleted.
5497 * 'provider_meter_id' is for the provider's private use.
5500 long long int created; /* Time created. */
5501 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5502 ofproto_meter_id provider_meter_id;
5503 uint16_t flags; /* Meter flags. */
5504 uint16_t n_bands; /* Number of meter bands. */
5505 struct ofputil_meter_band *bands;
5509 * This is used in instruction validation at flow set-up time,
5510 * as flows may not use non-existing meters.
5511 * Return value of UINT32_MAX signifies an invalid meter.
5514 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5516 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5517 const struct meter *meter = ofproto->meters[of_meter_id];
5519 return meter->provider_meter_id.uint32;
5525 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5528 meter_insert_rule(struct rule *rule)
5530 const struct rule_actions *a = rule_get_actions(rule);
5531 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5532 struct meter *meter = rule->ofproto->meters[meter_id];
5534 list_insert(&meter->rules, &rule->meter_list_node);
5538 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5542 meter->flags = config->flags;
5543 meter->n_bands = config->n_bands;
5544 meter->bands = xmemdup(config->bands,
5545 config->n_bands * sizeof *meter->bands);
5548 static struct meter *
5549 meter_create(const struct ofputil_meter_config *config,
5550 ofproto_meter_id provider_meter_id)
5552 struct meter *meter;
5554 meter = xzalloc(sizeof *meter);
5555 meter->provider_meter_id = provider_meter_id;
5556 meter->created = time_msec();
5557 list_init(&meter->rules);
5559 meter_update(meter, config);
5565 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5566 OVS_REQUIRES(ofproto_mutex)
5569 for (mid = first; mid <= last; ++mid) {
5570 struct meter *meter = ofproto->meters[mid];
5572 ofproto->meters[mid] = NULL;
5573 ofproto->ofproto_class->meter_del(ofproto,
5574 meter->provider_meter_id);
5582 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5584 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5585 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5589 return OFPERR_OFPMMFC_METER_EXISTS;
5592 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5595 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5596 *meterp = meter_create(&mm->meter, provider_meter_id);
5602 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5604 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5606 uint32_t provider_meter_id;
5609 return OFPERR_OFPMMFC_UNKNOWN_METER;
5612 provider_meter_id = meter->provider_meter_id.uint32;
5613 error = ofproto->ofproto_class->meter_set(ofproto,
5614 &meter->provider_meter_id,
5616 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5618 meter_update(meter, &mm->meter);
5624 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5625 OVS_EXCLUDED(ofproto_mutex)
5627 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5628 uint32_t meter_id = mm->meter.meter_id;
5629 struct rule_collection rules;
5630 enum ofperr error = 0;
5631 uint32_t first, last;
5633 if (meter_id == OFPM13_ALL) {
5635 last = ofproto->meter_features.max_meters;
5637 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5640 first = last = meter_id;
5643 /* First delete the rules that use this meter. If any of those rules are
5644 * currently being modified, postpone the whole operation until later. */
5645 rule_collection_init(&rules);
5646 ovs_mutex_lock(&ofproto_mutex);
5647 for (meter_id = first; meter_id <= last; ++meter_id) {
5648 struct meter *meter = ofproto->meters[meter_id];
5649 if (meter && !list_is_empty(&meter->rules)) {
5652 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5653 rule_collection_add(&rules, rule);
5657 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5659 /* Delete the meters. */
5660 meter_delete(ofproto, first, last);
5662 ovs_mutex_unlock(&ofproto_mutex);
5663 rule_collection_destroy(&rules);
5669 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5671 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5672 struct ofputil_meter_mod mm;
5673 uint64_t bands_stub[256 / 8];
5674 struct ofpbuf bands;
5678 error = reject_slave_controller(ofconn);
5683 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5685 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5687 goto exit_free_bands;
5690 meter_id = mm.meter.meter_id;
5692 if (mm.command != OFPMC13_DELETE) {
5693 /* Fails also when meters are not implemented by the provider. */
5694 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5695 error = OFPERR_OFPMMFC_INVALID_METER;
5696 goto exit_free_bands;
5697 } else if (meter_id > ofproto->meter_features.max_meters) {
5698 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5699 goto exit_free_bands;
5701 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5702 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5703 goto exit_free_bands;
5707 switch (mm.command) {
5709 error = handle_add_meter(ofproto, &mm);
5712 case OFPMC13_MODIFY:
5713 error = handle_modify_meter(ofproto, &mm);
5716 case OFPMC13_DELETE:
5717 error = handle_delete_meter(ofconn, &mm);
5721 error = OFPERR_OFPMMFC_BAD_COMMAND;
5726 ofpbuf_uninit(&bands);
5731 handle_meter_features_request(struct ofconn *ofconn,
5732 const struct ofp_header *request)
5734 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5735 struct ofputil_meter_features features;
5738 if (ofproto->ofproto_class->meter_get_features) {
5739 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5741 memset(&features, 0, sizeof features);
5743 b = ofputil_encode_meter_features_reply(&features, request);
5745 ofconn_send_reply(ofconn, b);
5750 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5753 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5754 struct ovs_list replies;
5755 uint64_t bands_stub[256 / 8];
5756 struct ofpbuf bands;
5757 uint32_t meter_id, first, last;
5759 ofputil_decode_meter_request(request, &meter_id);
5761 if (meter_id == OFPM13_ALL) {
5763 last = ofproto->meter_features.max_meters;
5765 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5766 !ofproto->meters[meter_id]) {
5767 return OFPERR_OFPMMFC_UNKNOWN_METER;
5769 first = last = meter_id;
5772 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5773 ofpmp_init(&replies, request);
5775 for (meter_id = first; meter_id <= last; ++meter_id) {
5776 struct meter *meter = ofproto->meters[meter_id];
5778 continue; /* Skip non-existing meters. */
5780 if (type == OFPTYPE_METER_STATS_REQUEST) {
5781 struct ofputil_meter_stats stats;
5783 stats.meter_id = meter_id;
5785 /* Provider sets the packet and byte counts, we do the rest. */
5786 stats.flow_count = list_size(&meter->rules);
5787 calc_duration(meter->created, time_msec(),
5788 &stats.duration_sec, &stats.duration_nsec);
5789 stats.n_bands = meter->n_bands;
5790 ofpbuf_clear(&bands);
5792 = ofpbuf_put_uninit(&bands,
5793 meter->n_bands * sizeof *stats.bands);
5795 if (!ofproto->ofproto_class->meter_get(ofproto,
5796 meter->provider_meter_id,
5798 ofputil_append_meter_stats(&replies, &stats);
5800 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5801 struct ofputil_meter_config config;
5803 config.meter_id = meter_id;
5804 config.flags = meter->flags;
5805 config.n_bands = meter->n_bands;
5806 config.bands = meter->bands;
5807 ofputil_append_meter_config(&replies, &config);
5811 ofconn_send_replies(ofconn, &replies);
5812 ofpbuf_uninit(&bands);
5817 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5818 struct ofgroup **group)
5819 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5821 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5822 hash_int(group_id, 0), &ofproto->groups) {
5823 if ((*group)->group_id == group_id) {
5831 /* If the group exists, this function increments the groups's reference count.
5833 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5834 * a reference to the group. */
5836 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5837 struct ofgroup **group)
5841 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5842 found = ofproto_group_lookup__(ofproto, group_id, group);
5844 ofproto_group_ref(*group);
5846 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5851 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5852 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5854 struct ofgroup *grp;
5856 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5857 hash_int(group_id, 0), &ofproto->groups) {
5858 if (grp->group_id == group_id) {
5866 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5867 OVS_EXCLUDED(ofproto->groups_rwlock)
5871 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5872 exists = ofproto_group_exists__(ofproto, group_id);
5873 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5879 group_get_ref_count(struct ofgroup *group)
5880 OVS_EXCLUDED(ofproto_mutex)
5882 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5883 struct rule_criteria criteria;
5884 struct rule_collection rules;
5889 match_init_catchall(&match);
5890 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
5891 htonll(0), OFPP_ANY, group->group_id);
5892 ovs_mutex_lock(&ofproto_mutex);
5893 error = collect_rules_loose(ofproto, &criteria, &rules);
5894 ovs_mutex_unlock(&ofproto_mutex);
5895 rule_criteria_destroy(&criteria);
5897 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5899 rule_collection_destroy(&rules);
5904 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
5906 struct ofputil_group_stats ogs;
5907 const struct ofproto *ofproto = group->ofproto;
5908 long long int now = time_msec();
5911 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5913 /* Provider sets the packet and byte counts, we do the rest. */
5914 ogs.ref_count = group_get_ref_count(group);
5915 ogs.n_buckets = group->n_buckets;
5917 error = (ofproto->ofproto_class->group_get_stats
5918 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5921 ogs.packet_count = UINT64_MAX;
5922 ogs.byte_count = UINT64_MAX;
5923 memset(ogs.bucket_stats, 0xff,
5924 ogs.n_buckets * sizeof *ogs.bucket_stats);
5927 ogs.group_id = group->group_id;
5928 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5930 ofputil_append_group_stats(replies, &ogs);
5932 free(ogs.bucket_stats);
5936 handle_group_request(struct ofconn *ofconn,
5937 const struct ofp_header *request, uint32_t group_id,
5938 void (*cb)(struct ofgroup *, struct ovs_list *replies))
5940 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5941 struct ofgroup *group;
5942 struct ovs_list replies;
5944 ofpmp_init(&replies, request);
5945 if (group_id == OFPG_ALL) {
5946 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5947 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5948 cb(group, &replies);
5950 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5952 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5953 cb(group, &replies);
5954 ofproto_group_unref(group);
5957 ofconn_send_replies(ofconn, &replies);
5961 handle_group_stats_request(struct ofconn *ofconn,
5962 const struct ofp_header *request)
5967 error = ofputil_decode_group_stats_request(request, &group_id);
5972 handle_group_request(ofconn, request, group_id, append_group_stats);
5977 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
5979 struct ofputil_group_desc gds;
5981 gds.group_id = group->group_id;
5982 gds.type = group->type;
5983 gds.props = group->props;
5985 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5989 handle_group_desc_stats_request(struct ofconn *ofconn,
5990 const struct ofp_header *request)
5992 handle_group_request(ofconn, request,
5993 ofputil_decode_group_desc_request(request),
5999 handle_group_features_stats_request(struct ofconn *ofconn,
6000 const struct ofp_header *request)
6002 struct ofproto *p = ofconn_get_ofproto(ofconn);
6005 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6007 ofconn_send_reply(ofconn, msg);
6014 handle_queue_get_config_request(struct ofconn *ofconn,
6015 const struct ofp_header *oh)
6017 struct ofproto *p = ofconn_get_ofproto(ofconn);
6018 struct netdev_queue_dump queue_dump;
6019 struct ofport *ofport;
6020 unsigned int queue_id;
6021 struct ofpbuf *reply;
6022 struct smap details;
6026 error = ofputil_decode_queue_get_config_request(oh, &request);
6031 ofport = ofproto_get_port(p, request);
6033 return OFPERR_OFPQOFC_BAD_PORT;
6036 reply = ofputil_encode_queue_get_config_reply(oh);
6038 smap_init(&details);
6039 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6040 struct ofputil_queue_config queue;
6042 /* None of the existing queues have compatible properties, so we
6043 * hard-code omitting min_rate and max_rate. */
6044 queue.queue_id = queue_id;
6045 queue.min_rate = UINT16_MAX;
6046 queue.max_rate = UINT16_MAX;
6047 ofputil_append_queue_get_config_reply(reply, &queue);
6049 smap_destroy(&details);
6051 ofconn_send_reply(ofconn, reply);
6057 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6058 struct ofgroup **ofgroup)
6061 const long long int now = time_msec();
6063 if (gm->group_id > OFPG_MAX) {
6064 return OFPERR_OFPGMFC_INVALID_GROUP;
6066 if (gm->type > OFPGT11_FF) {
6067 return OFPERR_OFPGMFC_BAD_TYPE;
6070 *ofgroup = ofproto->ofproto_class->group_alloc();
6072 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6073 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6076 (*ofgroup)->ofproto = ofproto;
6077 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6078 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6079 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6080 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6081 ovs_refcount_init(&(*ofgroup)->ref_count);
6083 list_move(&(*ofgroup)->buckets, &gm->buckets);
6084 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6085 list_size(&(*ofgroup)->buckets);
6087 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6088 &gm->props, sizeof (struct ofputil_group_props));
6090 /* Construct called BEFORE any locks are held. */
6091 error = ofproto->ofproto_class->group_construct(*ofgroup);
6093 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6094 ofproto->ofproto_class->group_dealloc(*ofgroup);
6099 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6100 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6103 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6105 struct ofgroup *ofgroup;
6108 /* Allocate new group and initialize it. */
6109 error = init_group(ofproto, gm, &ofgroup);
6114 /* We wrlock as late as possible to minimize the time we jam any other
6115 * threads: No visible state changes before acquiring the lock. */
6116 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6118 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6119 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6123 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6124 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6129 /* Insert new group. */
6130 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6131 hash_int(ofgroup->group_id, 0));
6132 ofproto->n_groups[ofgroup->type]++;
6134 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6139 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6140 ofproto->ofproto_class->group_destruct(ofgroup);
6141 ofputil_bucket_list_destroy(&ofgroup->buckets);
6142 ofproto->ofproto_class->group_dealloc(ofgroup);
6147 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6148 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6149 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6150 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6153 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6154 struct ofgroup *new_ofgroup,
6155 uint32_t command_bucket_id)
6157 struct ofputil_bucket *last = NULL;
6159 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6160 /* Check here to ensure that a bucket corresponding to
6161 * command_bucket_id exists in the old bucket list.
6163 * The subsequent search of below of new_ofgroup covers
6164 * both buckets in the old bucket list and buckets added
6165 * by the insert buckets group mod message this function processes. */
6166 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6167 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6170 if (!list_is_empty(&new_ofgroup->buckets)) {
6171 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6175 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6177 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6178 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6179 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6182 /* Rearrange list according to command_bucket_id */
6183 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6184 struct ofputil_bucket *new_first;
6185 const struct ofputil_bucket *first;
6187 first = ofputil_bucket_list_front(&ofgroup->buckets);
6188 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6191 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6192 &new_ofgroup->buckets);
6193 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6194 struct ofputil_bucket *after;
6196 /* Presence of bucket is checked above so after should never be NULL */
6197 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6199 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6200 last->list_node.next);
6206 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6207 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6208 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6209 * and OFPG15_BUCKET_ALL are also honored. */
6211 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6212 struct ofgroup *new_ofgroup,
6213 uint32_t command_bucket_id)
6215 const struct ofputil_bucket *skip = NULL;
6217 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6221 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6222 if (!list_is_empty(&ofgroup->buckets)) {
6223 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6225 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6226 if (!list_is_empty(&ofgroup->buckets)) {
6227 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6230 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6232 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6236 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6241 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6242 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6245 * Note that the group is re-created and then replaces the old group in
6246 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6247 * the xlate module hold a pointer to the group. */
6249 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6251 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6254 error = init_group(ofproto, gm, &new_ofgroup);
6259 retiring = new_ofgroup;
6261 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6262 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6263 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6267 /* Ofproto's group write lock is held now. */
6268 if (ofgroup->type != gm->type
6269 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6270 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6274 /* Manipulate bucket list for bucket commands */
6275 if (gm->command == OFPGC15_INSERT_BUCKET) {
6276 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6277 gm->command_bucket_id);
6278 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6279 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6280 gm->command_bucket_id);
6286 /* The group creation time does not change during modification. */
6287 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6288 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6290 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6296 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6297 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6298 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6299 hash_int(new_ofgroup->group_id, 0));
6300 if (ofgroup->type != new_ofgroup->type) {
6301 ofproto->n_groups[ofgroup->type]--;
6302 ofproto->n_groups[new_ofgroup->type]++;
6306 ofproto_group_unref(retiring);
6307 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6312 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6313 OVS_RELEASES(ofproto->groups_rwlock)
6316 struct ofputil_flow_mod fm;
6318 /* Delete all flow entries containing this group in a group action */
6319 match_init_catchall(&match);
6320 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6321 fm.delete_reason = OFPRR_GROUP_DELETE;
6322 fm.out_group = ofgroup->group_id;
6323 handle_flow_mod__(ofproto, &fm, NULL);
6325 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6326 /* No-one can find this group any more. */
6327 ofproto->n_groups[ofgroup->type]--;
6328 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6329 ofproto_group_unref(ofgroup);
6332 /* Implements OFPGC11_DELETE. */
6334 delete_group(struct ofproto *ofproto, uint32_t group_id)
6336 struct ofgroup *ofgroup;
6338 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6339 if (group_id == OFPG_ALL) {
6341 struct hmap_node *node = hmap_first(&ofproto->groups);
6345 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6346 delete_group__(ofproto, ofgroup);
6347 /* Lock for each node separately, so that we will not jam the
6348 * other threads for too long time. */
6349 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6352 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6353 hash_int(group_id, 0), &ofproto->groups) {
6354 if (ofgroup->group_id == group_id) {
6355 delete_group__(ofproto, ofgroup);
6360 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6364 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6366 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6367 struct ofputil_group_mod gm;
6370 error = reject_slave_controller(ofconn);
6375 error = ofputil_decode_group_mod(oh, &gm);
6380 switch (gm.command) {
6382 return add_group(ofproto, &gm);
6384 case OFPGC11_MODIFY:
6385 return modify_group(ofproto, &gm);
6387 case OFPGC11_DELETE:
6388 delete_group(ofproto, gm.group_id);
6391 case OFPGC15_INSERT_BUCKET:
6392 return modify_group(ofproto, &gm);
6394 case OFPGC15_REMOVE_BUCKET:
6395 return modify_group(ofproto, &gm);
6398 if (gm.command > OFPGC11_DELETE) {
6399 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6400 ofproto->name, gm.command);
6402 return OFPERR_OFPGMFC_BAD_COMMAND;
6406 enum ofputil_table_miss
6407 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6409 enum ofputil_table_miss value;
6411 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6416 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6418 if (!check_table_id(ofproto, tm->table_id)) {
6419 return OFPERR_OFPTMFC_BAD_TABLE;
6420 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6421 if (tm->table_id == OFPTT_ALL) {
6423 for (i = 0; i < ofproto->n_tables; i++) {
6424 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6428 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6436 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6438 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6439 struct ofputil_table_mod tm;
6442 error = reject_slave_controller(ofconn);
6447 error = ofputil_decode_table_mod(oh, &tm);
6452 return table_mod(ofproto, &tm);
6456 do_bundle_flow_mod_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6457 struct ofp_bundle_entry *be)
6458 OVS_REQUIRES(ofproto_mutex)
6460 switch (fm->command) {
6462 return add_flow_start(ofproto, fm, &be->rule, &be->modify);
6465 return modify_flows_start_loose(ofproto, fm, &be->rules);
6467 case OFPFC_MODIFY_STRICT:
6468 return modify_flow_start_strict(ofproto, fm, &be->rules);
6471 return delete_flows_start_loose(ofproto, fm, &be->rules);
6473 case OFPFC_DELETE_STRICT:
6474 return delete_flow_start_strict(ofproto, fm, &be->rules);
6477 return OFPERR_OFPFMFC_BAD_COMMAND;
6481 do_bundle_flow_mod_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6482 struct ofp_bundle_entry *be)
6483 OVS_REQUIRES(ofproto_mutex)
6485 switch (fm->command) {
6487 add_flow_revert(ofproto, be->modify ? NULL : be->rule);
6491 case OFPFC_MODIFY_STRICT:
6492 modify_flows_revert(ofproto, &be->rules);
6496 case OFPFC_DELETE_STRICT:
6497 delete_flows_revert(&be->rules);
6506 do_bundle_flow_mod_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6507 const struct flow_mod_requester *req,
6508 struct ofp_bundle_entry *be)
6509 OVS_REQUIRES(ofproto_mutex)
6511 switch (fm->command) {
6513 add_flow_finish(ofproto, fm, req, be->rule, be->modify);
6517 case OFPFC_MODIFY_STRICT:
6518 modify_flows_finish(ofproto, fm, req, &be->rules);
6522 case OFPFC_DELETE_STRICT:
6523 delete_flows_finish(fm, req, &be->rules);
6532 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6534 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6535 struct ofp_bundle *bundle;
6536 struct ofp_bundle_entry *be;
6539 bundle = ofconn_get_bundle(ofconn, id);
6542 return OFPERR_OFPBFC_BAD_ID;
6544 if (bundle->flags != flags) {
6545 error = OFPERR_OFPBFC_BAD_FLAGS;
6548 ovs_mutex_lock(&ofproto_mutex);
6549 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6550 if (be->type == OFPTYPE_PORT_MOD) {
6551 /* Not supported yet. */
6552 error = OFPERR_OFPBFC_MSG_FAILED;
6553 } else if (be->type == OFPTYPE_FLOW_MOD) {
6554 error = do_bundle_flow_mod_start(ofproto, &be->fm, be);
6563 /* Send error referring to the original message. */
6565 ofconn_send_error(ofconn, be->ofp_msg, error);
6566 error = OFPERR_OFPBFC_MSG_FAILED;
6569 /* Revert all previous entires. */
6570 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6571 if (be->type == OFPTYPE_FLOW_MOD) {
6572 do_bundle_flow_mod_revert(ofproto, &be->fm, be);
6576 /* Finish the changes. */
6577 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6578 if (be->type == OFPTYPE_FLOW_MOD) {
6579 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6581 do_bundle_flow_mod_finish(ofproto, &be->fm, &req, be);
6585 ofmonitor_flush(ofproto->connmgr);
6586 ovs_mutex_unlock(&ofproto_mutex);
6588 run_rule_executes(ofproto);
6591 /* The bundle is discarded regardless the outcome. */
6592 ofp_bundle_remove__(ofconn, bundle, !error);
6597 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6599 struct ofputil_bundle_ctrl_msg bctrl;
6600 struct ofputil_bundle_ctrl_msg reply;
6604 error = reject_slave_controller(ofconn);
6609 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6613 /* Atomic updates not supported yet. */
6614 if (bctrl.flags & OFPBF_ATOMIC) {
6615 return OFPERR_OFPBFC_BAD_FLAGS;
6618 reply.bundle_id = bctrl.bundle_id;
6620 switch (bctrl.type) {
6621 case OFPBCT_OPEN_REQUEST:
6622 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6623 reply.type = OFPBCT_OPEN_REPLY;
6625 case OFPBCT_CLOSE_REQUEST:
6626 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6627 reply.type = OFPBCT_CLOSE_REPLY;;
6629 case OFPBCT_COMMIT_REQUEST:
6630 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6631 reply.type = OFPBCT_COMMIT_REPLY;
6633 case OFPBCT_DISCARD_REQUEST:
6634 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6635 reply.type = OFPBCT_DISCARD_REPLY;
6638 case OFPBCT_OPEN_REPLY:
6639 case OFPBCT_CLOSE_REPLY:
6640 case OFPBCT_COMMIT_REPLY:
6641 case OFPBCT_DISCARD_REPLY:
6642 return OFPERR_OFPBFC_BAD_TYPE;
6647 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6648 ofconn_send_reply(ofconn, buf);
6654 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6656 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6658 struct ofputil_bundle_add_msg badd;
6659 struct ofp_bundle_entry *bmsg;
6662 error = reject_slave_controller(ofconn);
6667 error = ofputil_decode_bundle_add(oh, &badd, &type);
6672 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
6674 if (type == OFPTYPE_PORT_MOD) {
6675 error = ofputil_decode_port_mod(badd.msg, &bmsg->pm, false);
6676 } else if (type == OFPTYPE_FLOW_MOD) {
6677 struct ofpbuf ofpacts;
6678 uint64_t ofpacts_stub[1024 / 8];
6680 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6681 error = ofputil_decode_flow_mod(&bmsg->fm, badd.msg,
6682 ofconn_get_protocol(ofconn),
6684 u16_to_ofp(ofproto->max_ports),
6686 /* Move actions to heap. */
6687 bmsg->fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6689 if (!error && bmsg->fm.ofpacts_len) {
6690 error = ofproto_check_ofpacts(ofproto, bmsg->fm.ofpacts,
6691 bmsg->fm.ofpacts_len);
6698 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
6703 ofp_bundle_entry_free(bmsg);
6710 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6711 OVS_EXCLUDED(ofproto_mutex)
6713 const struct ofp_header *oh = msg->data;
6717 error = ofptype_decode(&type, oh);
6721 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6722 && ofpmp_more(oh)) {
6723 /* We have no buffer implementation for multipart requests.
6724 * Report overflow for requests which consists of multiple
6726 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6730 /* OpenFlow requests. */
6731 case OFPTYPE_ECHO_REQUEST:
6732 return handle_echo_request(ofconn, oh);
6734 case OFPTYPE_FEATURES_REQUEST:
6735 return handle_features_request(ofconn, oh);
6737 case OFPTYPE_GET_CONFIG_REQUEST:
6738 return handle_get_config_request(ofconn, oh);
6740 case OFPTYPE_SET_CONFIG:
6741 return handle_set_config(ofconn, oh);
6743 case OFPTYPE_PACKET_OUT:
6744 return handle_packet_out(ofconn, oh);
6746 case OFPTYPE_PORT_MOD:
6747 return handle_port_mod(ofconn, oh);
6749 case OFPTYPE_FLOW_MOD:
6750 return handle_flow_mod(ofconn, oh);
6752 case OFPTYPE_GROUP_MOD:
6753 return handle_group_mod(ofconn, oh);
6755 case OFPTYPE_TABLE_MOD:
6756 return handle_table_mod(ofconn, oh);
6758 case OFPTYPE_METER_MOD:
6759 return handle_meter_mod(ofconn, oh);
6761 case OFPTYPE_BARRIER_REQUEST:
6762 return handle_barrier_request(ofconn, oh);
6764 case OFPTYPE_ROLE_REQUEST:
6765 return handle_role_request(ofconn, oh);
6767 /* OpenFlow replies. */
6768 case OFPTYPE_ECHO_REPLY:
6771 /* Nicira extension requests. */
6772 case OFPTYPE_FLOW_MOD_TABLE_ID:
6773 return handle_nxt_flow_mod_table_id(ofconn, oh);
6775 case OFPTYPE_SET_FLOW_FORMAT:
6776 return handle_nxt_set_flow_format(ofconn, oh);
6778 case OFPTYPE_SET_PACKET_IN_FORMAT:
6779 return handle_nxt_set_packet_in_format(ofconn, oh);
6781 case OFPTYPE_SET_CONTROLLER_ID:
6782 return handle_nxt_set_controller_id(ofconn, oh);
6784 case OFPTYPE_FLOW_AGE:
6785 /* Nothing to do. */
6788 case OFPTYPE_FLOW_MONITOR_CANCEL:
6789 return handle_flow_monitor_cancel(ofconn, oh);
6791 case OFPTYPE_SET_ASYNC_CONFIG:
6792 return handle_nxt_set_async_config(ofconn, oh);
6794 case OFPTYPE_GET_ASYNC_REQUEST:
6795 return handle_nxt_get_async_request(ofconn, oh);
6797 /* Statistics requests. */
6798 case OFPTYPE_DESC_STATS_REQUEST:
6799 return handle_desc_stats_request(ofconn, oh);
6801 case OFPTYPE_FLOW_STATS_REQUEST:
6802 return handle_flow_stats_request(ofconn, oh);
6804 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6805 return handle_aggregate_stats_request(ofconn, oh);
6807 case OFPTYPE_TABLE_STATS_REQUEST:
6808 return handle_table_stats_request(ofconn, oh);
6810 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6811 return handle_table_features_request(ofconn, oh);
6813 case OFPTYPE_PORT_STATS_REQUEST:
6814 return handle_port_stats_request(ofconn, oh);
6816 case OFPTYPE_QUEUE_STATS_REQUEST:
6817 return handle_queue_stats_request(ofconn, oh);
6819 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6820 return handle_port_desc_stats_request(ofconn, oh);
6822 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6823 return handle_flow_monitor_request(ofconn, oh);
6825 case OFPTYPE_METER_STATS_REQUEST:
6826 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6827 return handle_meter_request(ofconn, oh, type);
6829 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6830 return handle_meter_features_request(ofconn, oh);
6832 case OFPTYPE_GROUP_STATS_REQUEST:
6833 return handle_group_stats_request(ofconn, oh);
6835 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6836 return handle_group_desc_stats_request(ofconn, oh);
6838 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6839 return handle_group_features_stats_request(ofconn, oh);
6841 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6842 return handle_queue_get_config_request(ofconn, oh);
6844 case OFPTYPE_BUNDLE_CONTROL:
6845 return handle_bundle_control(ofconn, oh);
6847 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6848 return handle_bundle_add(ofconn, oh);
6852 case OFPTYPE_FEATURES_REPLY:
6853 case OFPTYPE_GET_CONFIG_REPLY:
6854 case OFPTYPE_PACKET_IN:
6855 case OFPTYPE_FLOW_REMOVED:
6856 case OFPTYPE_PORT_STATUS:
6857 case OFPTYPE_BARRIER_REPLY:
6858 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6859 case OFPTYPE_DESC_STATS_REPLY:
6860 case OFPTYPE_FLOW_STATS_REPLY:
6861 case OFPTYPE_QUEUE_STATS_REPLY:
6862 case OFPTYPE_PORT_STATS_REPLY:
6863 case OFPTYPE_TABLE_STATS_REPLY:
6864 case OFPTYPE_AGGREGATE_STATS_REPLY:
6865 case OFPTYPE_PORT_DESC_STATS_REPLY:
6866 case OFPTYPE_ROLE_REPLY:
6867 case OFPTYPE_FLOW_MONITOR_PAUSED:
6868 case OFPTYPE_FLOW_MONITOR_RESUMED:
6869 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6870 case OFPTYPE_GET_ASYNC_REPLY:
6871 case OFPTYPE_GROUP_STATS_REPLY:
6872 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6873 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6874 case OFPTYPE_METER_STATS_REPLY:
6875 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6876 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6877 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6878 case OFPTYPE_ROLE_STATUS:
6880 if (ofpmsg_is_stat_request(oh)) {
6881 return OFPERR_OFPBRC_BAD_STAT;
6883 return OFPERR_OFPBRC_BAD_TYPE;
6889 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6890 OVS_EXCLUDED(ofproto_mutex)
6892 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
6895 ofconn_send_error(ofconn, ofp_msg->data, error);
6897 COVERAGE_INC(ofproto_recv_openflow);
6900 /* Asynchronous operations. */
6903 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
6905 OVS_REQUIRES(ofproto_mutex)
6907 if (req && req->ofconn && buffer_id != UINT32_MAX) {
6908 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
6909 struct dp_packet *packet;
6913 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
6916 struct rule_execute *re;
6918 ofproto_rule_ref(rule);
6920 re = xmalloc(sizeof *re);
6922 re->in_port = in_port;
6923 re->packet = packet;
6925 if (!guarded_list_push_back(&ofproto->rule_executes,
6926 &re->list_node, 1024)) {
6927 ofproto_rule_unref(rule);
6928 dp_packet_delete(re->packet);
6932 ofconn_send_error(req->ofconn, req->request, error);
6938 pick_datapath_id(const struct ofproto *ofproto)
6940 const struct ofport *port;
6942 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6944 uint8_t ea[ETH_ADDR_LEN];
6947 error = netdev_get_etheraddr(port->netdev, ea);
6949 return eth_addr_to_uint64(ea);
6951 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6952 ofproto->name, netdev_get_name(port->netdev),
6953 ovs_strerror(error));
6955 return ofproto->fallback_dpid;
6959 pick_fallback_dpid(void)
6961 uint8_t ea[ETH_ADDR_LEN];
6962 eth_addr_nicira_random(ea);
6963 return eth_addr_to_uint64(ea);
6966 /* Table overflow policy. */
6968 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6969 * to NULL if the table is not configured to evict rules or if the table
6970 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6971 * or with no timeouts are not evictable.) */
6973 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6974 OVS_REQUIRES(ofproto_mutex)
6976 struct eviction_group *evg;
6979 if (!table->eviction_fields) {
6983 /* In the common case, the outer and inner loops here will each be entered
6986 * - The inner loop normally "return"s in its first iteration. If the
6987 * eviction group has any evictable rules, then it always returns in
6990 * - The outer loop only iterates more than once if the largest eviction
6991 * group has no evictable rules.
6993 * - The outer loop can exit only if table's 'max_flows' is all filled up
6994 * by unevictable rules. */
6995 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6998 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7007 /* Eviction groups. */
7009 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7010 * rules. The priority contains low-order random bits to ensure that eviction
7011 * groups with the same number of rules are prioritized randomly. */
7013 eviction_group_priority(size_t n_rules)
7015 uint16_t size = MIN(UINT16_MAX, n_rules);
7016 return (size << 16) | random_uint16();
7019 /* Updates 'evg', an eviction_group within 'table', following a change that
7020 * adds or removes rules in 'evg'. */
7022 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7023 OVS_REQUIRES(ofproto_mutex)
7025 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7026 eviction_group_priority(heap_count(&evg->rules)));
7029 /* Destroys 'evg', an eviction_group within 'table':
7031 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7032 * rules themselves, just removes them from the eviction group.)
7034 * - Removes 'evg' from 'table'.
7038 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7039 OVS_REQUIRES(ofproto_mutex)
7041 while (!heap_is_empty(&evg->rules)) {
7044 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7045 rule->eviction_group = NULL;
7047 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7048 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7049 heap_destroy(&evg->rules);
7053 /* Removes 'rule' from its eviction group, if any. */
7055 eviction_group_remove_rule(struct rule *rule)
7056 OVS_REQUIRES(ofproto_mutex)
7058 if (rule->eviction_group) {
7059 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7060 struct eviction_group *evg = rule->eviction_group;
7062 rule->eviction_group = NULL;
7063 heap_remove(&evg->rules, &rule->evg_node);
7064 if (heap_is_empty(&evg->rules)) {
7065 eviction_group_destroy(table, evg);
7067 eviction_group_resized(table, evg);
7072 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7073 * returns the hash value. */
7075 eviction_group_hash_rule(struct rule *rule)
7076 OVS_REQUIRES(ofproto_mutex)
7078 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7079 const struct mf_subfield *sf;
7083 hash = table->eviction_group_id_basis;
7084 miniflow_expand(&rule->cr.match.flow, &flow);
7085 for (sf = table->eviction_fields;
7086 sf < &table->eviction_fields[table->n_eviction_fields];
7089 if (mf_are_prereqs_ok(sf->field, &flow)) {
7090 union mf_value value;
7092 mf_get_value(sf->field, &flow, &value);
7094 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7096 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7097 unsigned int start = sf->ofs + sf->n_bits;
7098 bitwise_zero(&value, sf->field->n_bytes, start,
7099 sf->field->n_bytes * 8 - start);
7101 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7103 hash = hash_int(hash, 0);
7110 /* Returns an eviction group within 'table' with the given 'id', creating one
7112 static struct eviction_group *
7113 eviction_group_find(struct oftable *table, uint32_t id)
7114 OVS_REQUIRES(ofproto_mutex)
7116 struct eviction_group *evg;
7118 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7122 evg = xmalloc(sizeof *evg);
7123 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7124 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7125 eviction_group_priority(0));
7126 heap_init(&evg->rules);
7131 /* Returns an eviction priority for 'rule'. The return value should be
7132 * interpreted so that higher priorities make a rule more attractive candidates
7134 * Called only if have a timeout. */
7136 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7137 OVS_REQUIRES(ofproto_mutex)
7139 long long int expiration = LLONG_MAX;
7140 long long int modified;
7141 uint32_t expiration_offset;
7143 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7144 ovs_mutex_lock(&rule->mutex);
7145 modified = rule->modified;
7146 ovs_mutex_unlock(&rule->mutex);
7148 if (rule->hard_timeout) {
7149 expiration = modified + rule->hard_timeout * 1000;
7151 if (rule->idle_timeout) {
7152 uint64_t packets, bytes;
7154 long long int idle_expiration;
7156 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7157 idle_expiration = used + rule->idle_timeout * 1000;
7158 expiration = MIN(expiration, idle_expiration);
7161 if (expiration == LLONG_MAX) {
7165 /* Calculate the time of expiration as a number of (approximate) seconds
7166 * after program startup.
7168 * This should work OK for program runs that last UINT32_MAX seconds or
7169 * less. Therefore, please restart OVS at least once every 136 years. */
7170 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
7172 /* Invert the expiration offset because we're using a max-heap. */
7173 return UINT32_MAX - expiration_offset;
7176 /* Adds 'rule' to an appropriate eviction group for its oftable's
7177 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7178 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7181 * The caller must ensure that 'rule' is not already in an eviction group. */
7183 eviction_group_add_rule(struct rule *rule)
7184 OVS_REQUIRES(ofproto_mutex)
7186 struct ofproto *ofproto = rule->ofproto;
7187 struct oftable *table = &ofproto->tables[rule->table_id];
7190 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7191 * so no additional protection is needed. */
7192 has_timeout = rule->hard_timeout || rule->idle_timeout;
7194 if (table->eviction_fields && has_timeout) {
7195 struct eviction_group *evg;
7197 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7199 rule->eviction_group = evg;
7200 heap_insert(&evg->rules, &rule->evg_node,
7201 rule_eviction_priority(ofproto, rule));
7202 eviction_group_resized(table, evg);
7208 /* Initializes 'table'. */
7210 oftable_init(struct oftable *table)
7212 memset(table, 0, sizeof *table);
7213 classifier_init(&table->cls, flow_segment_u64s);
7214 table->max_flows = UINT_MAX;
7215 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7217 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7218 ARRAY_SIZE(default_prefix_fields));
7220 atomic_init(&table->n_matched, 0);
7221 atomic_init(&table->n_missed, 0);
7224 /* Destroys 'table', including its classifier and eviction groups.
7226 * The caller is responsible for freeing 'table' itself. */
7228 oftable_destroy(struct oftable *table)
7230 ovs_assert(classifier_is_empty(&table->cls));
7231 oftable_disable_eviction(table);
7232 classifier_destroy(&table->cls);
7236 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7237 * string, then 'table' will use its default name.
7239 * This only affects the name exposed for a table exposed through the OpenFlow
7240 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7242 oftable_set_name(struct oftable *table, const char *name)
7244 if (name && name[0]) {
7245 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7246 if (!table->name || strncmp(name, table->name, len)) {
7248 table->name = xmemdup0(name, len);
7256 /* oftables support a choice of two policies when adding a rule would cause the
7257 * number of flows in the table to exceed the configured maximum number: either
7258 * they can refuse to add the new flow or they can evict some existing flow.
7259 * This function configures the former policy on 'table'. */
7261 oftable_disable_eviction(struct oftable *table)
7262 OVS_REQUIRES(ofproto_mutex)
7264 if (table->eviction_fields) {
7265 struct eviction_group *evg, *next;
7267 HMAP_FOR_EACH_SAFE (evg, next, id_node,
7268 &table->eviction_groups_by_id) {
7269 eviction_group_destroy(table, evg);
7271 hmap_destroy(&table->eviction_groups_by_id);
7272 heap_destroy(&table->eviction_groups_by_size);
7274 free(table->eviction_fields);
7275 table->eviction_fields = NULL;
7276 table->n_eviction_fields = 0;
7280 /* oftables support a choice of two policies when adding a rule would cause the
7281 * number of flows in the table to exceed the configured maximum number: either
7282 * they can refuse to add the new flow or they can evict some existing flow.
7283 * This function configures the latter policy on 'table', with fairness based
7284 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7285 * 'n_fields' as 0 disables fairness.) */
7287 oftable_enable_eviction(struct oftable *table,
7288 const struct mf_subfield *fields, size_t n_fields)
7289 OVS_REQUIRES(ofproto_mutex)
7293 if (table->eviction_fields
7294 && n_fields == table->n_eviction_fields
7296 || !memcmp(fields, table->eviction_fields,
7297 n_fields * sizeof *fields))) {
7302 oftable_disable_eviction(table);
7304 table->n_eviction_fields = n_fields;
7305 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
7307 table->eviction_group_id_basis = random_uint32();
7308 hmap_init(&table->eviction_groups_by_id);
7309 heap_init(&table->eviction_groups_by_size);
7311 CLS_FOR_EACH (rule, cr, &table->cls) {
7312 eviction_group_add_rule(rule);
7316 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7317 * it to the classifier. */
7319 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7320 OVS_REQUIRES(ofproto_mutex)
7322 const struct rule_actions *actions = rule_get_actions(rule);
7324 if (rule->hard_timeout || rule->idle_timeout) {
7325 list_insert(&ofproto->expirable, &rule->expirable);
7327 cookies_insert(ofproto, rule);
7328 eviction_group_add_rule(rule);
7329 if (actions->has_meter) {
7330 meter_insert_rule(rule);
7334 /* Removes 'rule' from the ofproto data structures AFTER caller has removed
7335 * it from the classifier. */
7337 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7338 OVS_REQUIRES(ofproto_mutex)
7340 cookies_remove(ofproto, rule);
7342 eviction_group_remove_rule(rule);
7343 if (!list_is_empty(&rule->expirable)) {
7344 list_remove(&rule->expirable);
7346 if (!list_is_empty(&rule->meter_list_node)) {
7347 list_remove(&rule->meter_list_node);
7348 list_init(&rule->meter_list_node);
7353 oftable_remove_rule(struct rule *rule)
7354 OVS_REQUIRES(ofproto_mutex)
7356 struct classifier *cls = &rule->ofproto->tables[rule->table_id].cls;
7358 if (classifier_remove(cls, &rule->cr)) {
7359 ofproto_rule_remove__(rule->ofproto, rule);
7365 /* unixctl commands. */
7368 ofproto_lookup(const char *name)
7370 struct ofproto *ofproto;
7372 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7374 if (!strcmp(ofproto->name, name)) {
7382 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7383 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7385 struct ofproto *ofproto;
7389 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7390 ds_put_format(&results, "%s\n", ofproto->name);
7392 unixctl_command_reply(conn, ds_cstr(&results));
7393 ds_destroy(&results);
7397 ofproto_unixctl_init(void)
7399 static bool registered;
7405 unixctl_command_register("ofproto/list", "", 0, 0,
7406 ofproto_unixctl_list, NULL);
7409 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7411 * This is deprecated. It is only for compatibility with broken device drivers
7412 * in old versions of Linux that do not properly support VLANs when VLAN
7413 * devices are not used. When broken device drivers are no longer in
7414 * widespread use, we will delete these interfaces. */
7416 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7417 * (exactly) by an OpenFlow rule in 'ofproto'. */
7419 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7422 struct cls_rule target;
7423 const struct oftable *oftable;
7425 match_init_catchall(&match);
7426 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7427 cls_rule_init(&target, &match, 0, CLS_MAX_VERSION);
7429 free(ofproto->vlan_bitmap);
7430 ofproto->vlan_bitmap = bitmap_allocate(4096);
7431 ofproto->vlans_changed = false;
7433 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7436 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7437 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7438 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7440 bitmap_set1(vlan_bitmap, vid);
7441 bitmap_set1(ofproto->vlan_bitmap, vid);
7446 cls_rule_destroy(&target);
7449 /* Returns true if new VLANs have come into use by the flow table since the
7450 * last call to ofproto_get_vlan_usage().
7452 * We don't track when old VLANs stop being used. */
7454 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7456 return ofproto->vlans_changed;
7459 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7460 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7461 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7462 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7463 * then the VLAN device is un-enslaved. */
7465 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7466 ofp_port_t realdev_ofp_port, int vid)
7468 struct ofport *ofport;
7471 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7473 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7475 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7476 ofproto->name, vlandev_ofp_port);
7480 if (!ofproto->ofproto_class->set_realdev) {
7481 if (!vlandev_ofp_port) {
7484 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7488 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7490 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7491 ofproto->name, vlandev_ofp_port,
7492 netdev_get_name(ofport->netdev), ovs_strerror(error));