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 ofproto->tables_version = CLS_MIN_VERSION;
531 hindex_init(&ofproto->cookies);
532 hmap_init(&ofproto->learned_cookies);
533 list_init(&ofproto->expirable);
534 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
535 guarded_list_init(&ofproto->rule_executes);
536 ofproto->vlan_bitmap = NULL;
537 ofproto->vlans_changed = false;
538 ofproto->min_mtu = INT_MAX;
539 ovs_rwlock_init(&ofproto->groups_rwlock);
540 hmap_init(&ofproto->groups);
541 ovs_mutex_unlock(&ofproto_mutex);
542 ofproto->ogf.types = 0xf;
543 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
544 OFPGFC_SELECT_WEIGHT;
545 for (i = 0; i < 4; i++) {
546 ofproto->ogf.max_groups[i] = OFPG_MAX;
547 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
550 error = ofproto->ofproto_class->construct(ofproto);
552 VLOG_ERR("failed to open datapath %s: %s",
553 datapath_name, ovs_strerror(error));
554 connmgr_destroy(ofproto->connmgr);
555 ofproto_destroy__(ofproto);
559 /* Check that hidden tables, if any, are at the end. */
560 ovs_assert(ofproto->n_tables);
561 for (i = 0; i + 1 < ofproto->n_tables; i++) {
562 enum oftable_flags flags = ofproto->tables[i].flags;
563 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
565 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
568 ofproto->datapath_id = pick_datapath_id(ofproto);
571 /* Initialize meters table. */
572 if (ofproto->ofproto_class->meter_get_features) {
573 ofproto->ofproto_class->meter_get_features(ofproto,
574 &ofproto->meter_features);
576 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
578 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
579 * sizeof(struct meter *));
581 /* Set the initial tables version. */
582 ofproto->ofproto_class->set_tables_version(ofproto,
583 ofproto->tables_version);
589 /* Must be called (only) by an ofproto implementation in its constructor
590 * function. See the large comment on 'construct' in struct ofproto_class for
593 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
595 struct oftable *table;
597 ovs_assert(!ofproto->n_tables);
598 ovs_assert(n_tables >= 1 && n_tables <= 255);
600 ofproto->n_tables = n_tables;
601 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
602 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
607 /* To be optionally called (only) by an ofproto implementation in its
608 * constructor function. See the large comment on 'construct' in struct
609 * ofproto_class for details.
611 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
612 * will then ensure that actions passed into the ofproto implementation will
613 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
614 * function is not called, there will be no such restriction.
616 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
617 * the 'max_ports' restriction. */
619 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
621 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
622 ofproto->max_ports = max_ports;
626 ofproto_get_datapath_id(const struct ofproto *ofproto)
628 return ofproto->datapath_id;
632 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
634 uint64_t old_dpid = p->datapath_id;
635 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
636 if (p->datapath_id != old_dpid) {
637 /* Force all active connections to reconnect, since there is no way to
638 * notify a controller that the datapath ID has changed. */
639 ofproto_reconnect_controllers(p);
644 ofproto_set_controllers(struct ofproto *p,
645 const struct ofproto_controller *controllers,
646 size_t n_controllers, uint32_t allowed_versions)
648 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
653 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
655 connmgr_set_fail_mode(p->connmgr, fail_mode);
658 /* Drops the connections between 'ofproto' and all of its controllers, forcing
659 * them to reconnect. */
661 ofproto_reconnect_controllers(struct ofproto *ofproto)
663 connmgr_reconnect(ofproto->connmgr);
666 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
667 * in-band control should guarantee access, in the same way that in-band
668 * control guarantees access to OpenFlow controllers. */
670 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
671 const struct sockaddr_in *extras, size_t n)
673 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
676 /* Sets the OpenFlow queue used by flows set up by in-band control on
677 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
678 * flows will use the default queue. */
680 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
682 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
685 /* Sets the number of flows at which eviction from the kernel flow table
688 ofproto_set_flow_limit(unsigned limit)
690 ofproto_flow_limit = limit;
693 /* Sets the maximum idle time for flows in the datapath before they are
696 ofproto_set_max_idle(unsigned max_idle)
698 ofproto_max_idle = max_idle;
701 /* If forward_bpdu is true, the NORMAL action will forward frames with
702 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
703 * the NORMAL action will drop these frames. */
705 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
707 bool old_val = ofproto->forward_bpdu;
708 ofproto->forward_bpdu = forward_bpdu;
709 if (old_val != ofproto->forward_bpdu) {
710 if (ofproto->ofproto_class->forward_bpdu_changed) {
711 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
716 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
717 * 'idle_time', in seconds, and the maximum number of MAC table entries to
720 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
723 if (ofproto->ofproto_class->set_mac_table_config) {
724 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
729 /* Multicast snooping configuration. */
731 /* Configures multicast snooping on 'ofproto' using the settings
732 * defined in 's'. If 's' is NULL, disables multicast snooping.
734 * Returns 0 if successful, otherwise a positive errno value. */
736 ofproto_set_mcast_snooping(struct ofproto *ofproto,
737 const struct ofproto_mcast_snooping_settings *s)
739 return (ofproto->ofproto_class->set_mcast_snooping
740 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
744 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
746 * Returns 0 if successful, otherwise a positive errno value.*/
748 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
749 const struct ofproto_mcast_snooping_port_settings *s)
751 return (ofproto->ofproto_class->set_mcast_snooping_port
752 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
757 ofproto_set_n_dpdk_rxqs(int n_rxqs)
759 n_dpdk_rxqs = MAX(n_rxqs, 0);
763 ofproto_set_cpu_mask(const char *cmask)
767 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
771 ofproto_set_threads(int n_handlers_, int n_revalidators_)
773 int threads = MAX(count_cpu_cores(), 2);
775 n_revalidators = MAX(n_revalidators_, 0);
776 n_handlers = MAX(n_handlers_, 0);
778 if (!n_revalidators) {
779 n_revalidators = n_handlers
780 ? MAX(threads - (int) n_handlers, 1)
785 n_handlers = MAX(threads - (int) n_revalidators, 1);
790 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
793 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
797 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
799 return connmgr_set_snoops(ofproto->connmgr, snoops);
803 ofproto_set_netflow(struct ofproto *ofproto,
804 const struct netflow_options *nf_options)
806 if (nf_options && sset_is_empty(&nf_options->collectors)) {
810 if (ofproto->ofproto_class->set_netflow) {
811 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
813 return nf_options ? EOPNOTSUPP : 0;
818 ofproto_set_sflow(struct ofproto *ofproto,
819 const struct ofproto_sflow_options *oso)
821 if (oso && sset_is_empty(&oso->targets)) {
825 if (ofproto->ofproto_class->set_sflow) {
826 return ofproto->ofproto_class->set_sflow(ofproto, oso);
828 return oso ? EOPNOTSUPP : 0;
833 ofproto_set_ipfix(struct ofproto *ofproto,
834 const struct ofproto_ipfix_bridge_exporter_options *bo,
835 const struct ofproto_ipfix_flow_exporter_options *fo,
838 if (ofproto->ofproto_class->set_ipfix) {
839 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
841 return (bo || fo) ? EOPNOTSUPP : 0;
846 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
848 flow_restore_wait = flow_restore_wait_db;
852 ofproto_get_flow_restore_wait(void)
854 return flow_restore_wait;
858 /* Spanning Tree Protocol (STP) configuration. */
860 /* Configures STP on 'ofproto' using the settings defined in 's'. If
861 * 's' is NULL, disables STP.
863 * Returns 0 if successful, otherwise a positive errno value. */
865 ofproto_set_stp(struct ofproto *ofproto,
866 const struct ofproto_stp_settings *s)
868 return (ofproto->ofproto_class->set_stp
869 ? ofproto->ofproto_class->set_stp(ofproto, s)
873 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
874 * 'enabled' member of 's' is false, then the other members are not
877 * Returns 0 if successful, otherwise a positive errno value. */
879 ofproto_get_stp_status(struct ofproto *ofproto,
880 struct ofproto_stp_status *s)
882 return (ofproto->ofproto_class->get_stp_status
883 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
887 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
888 * in 's'. The caller is responsible for assigning STP port numbers
889 * (using the 'port_num' member in the range of 1 through 255, inclusive)
890 * and ensuring there are no duplicates. If the 's' is NULL, then STP
891 * is disabled on the port.
893 * Returns 0 if successful, otherwise a positive errno value.*/
895 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
896 const struct ofproto_port_stp_settings *s)
898 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
900 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
901 ofproto->name, ofp_port);
905 return (ofproto->ofproto_class->set_stp_port
906 ? ofproto->ofproto_class->set_stp_port(ofport, s)
910 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
911 * 's'. If the 'enabled' member in 's' is false, then the other members
912 * are not meaningful.
914 * Returns 0 if successful, otherwise a positive errno value.*/
916 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
917 struct ofproto_port_stp_status *s)
919 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
921 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
922 "port %"PRIu16, ofproto->name, ofp_port);
926 return (ofproto->ofproto_class->get_stp_port_status
927 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
931 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
932 * 's'. If the 'enabled' member in 's' is false, then the other members
933 * are not meaningful.
935 * Returns 0 if successful, otherwise a positive errno value.*/
937 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
938 struct ofproto_port_stp_stats *s)
940 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
942 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
943 "port %"PRIu16, ofproto->name, ofp_port);
947 return (ofproto->ofproto_class->get_stp_port_stats
948 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
952 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
954 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
955 * 's' is NULL, disables RSTP.
957 * Returns 0 if successful, otherwise a positive errno value. */
959 ofproto_set_rstp(struct ofproto *ofproto,
960 const struct ofproto_rstp_settings *s)
962 if (!ofproto->ofproto_class->set_rstp) {
965 ofproto->ofproto_class->set_rstp(ofproto, s);
969 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
970 * 'enabled' member of 's' is false, then the other members are not
973 * Returns 0 if successful, otherwise a positive errno value. */
975 ofproto_get_rstp_status(struct ofproto *ofproto,
976 struct ofproto_rstp_status *s)
978 if (!ofproto->ofproto_class->get_rstp_status) {
981 ofproto->ofproto_class->get_rstp_status(ofproto, s);
985 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
986 * in 's'. The caller is responsible for assigning RSTP port numbers
987 * (using the 'port_num' member in the range of 1 through 255, inclusive)
988 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
989 * is disabled on the port.
991 * Returns 0 if successful, otherwise a positive errno value.*/
993 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
994 const struct ofproto_port_rstp_settings *s)
996 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
998 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
999 ofproto->name, ofp_port);
1003 if (!ofproto->ofproto_class->set_rstp_port) {
1006 ofproto->ofproto_class->set_rstp_port(ofport, s);
1010 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1011 * 's'. If the 'enabled' member in 's' is false, then the other members
1012 * are not meaningful.
1014 * Returns 0 if successful, otherwise a positive errno value.*/
1016 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1017 struct ofproto_port_rstp_status *s)
1019 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1021 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1022 "port %"PRIu16, ofproto->name, ofp_port);
1026 if (!ofproto->ofproto_class->get_rstp_port_status) {
1029 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1033 /* Queue DSCP configuration. */
1035 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1036 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1037 * to implement QoS. Instead, it is used to implement features which require
1038 * knowledge of what queues exist on a port, and some basic information about
1041 * Returns 0 if successful, otherwise a positive errno value. */
1043 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1044 const struct ofproto_port_queue *queues,
1047 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1050 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1051 ofproto->name, ofp_port);
1055 return (ofproto->ofproto_class->set_queues
1056 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1060 /* LLDP configuration. */
1062 ofproto_port_set_lldp(struct ofproto *ofproto,
1063 ofp_port_t ofp_port,
1064 const struct smap *cfg)
1066 struct ofport *ofport;
1069 ofport = ofproto_get_port(ofproto, ofp_port);
1071 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1072 ofproto->name, ofp_port);
1075 error = (ofproto->ofproto_class->set_lldp
1076 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1079 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1080 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1081 ovs_strerror(error));
1086 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1087 const struct aa_settings *s)
1089 if (!ofproto->ofproto_class->set_aa) {
1092 ofproto->ofproto_class->set_aa(ofproto, s);
1097 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1098 const struct aa_mapping_settings *s)
1100 if (!ofproto->ofproto_class->aa_mapping_set) {
1103 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1108 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1110 if (!ofproto->ofproto_class->aa_mapping_unset) {
1113 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1118 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1119 struct ovs_list *list)
1121 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1124 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1129 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1131 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1134 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1137 /* Connectivity Fault Management configuration. */
1139 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1141 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1143 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1144 if (ofport && ofproto->ofproto_class->set_cfm) {
1145 ofproto->ofproto_class->set_cfm(ofport, NULL);
1149 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1150 * basic configuration from the configuration members in 'cfm', and the remote
1151 * maintenance point ID from remote_mpid. Ignores the statistics members of
1154 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1156 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1157 const struct cfm_settings *s)
1159 struct ofport *ofport;
1162 ofport = ofproto_get_port(ofproto, ofp_port);
1164 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1165 ofproto->name, ofp_port);
1169 /* XXX: For configuration simplicity, we only support one remote_mpid
1170 * outside of the CFM module. It's not clear if this is the correct long
1171 * term solution or not. */
1172 error = (ofproto->ofproto_class->set_cfm
1173 ? ofproto->ofproto_class->set_cfm(ofport, s)
1176 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1177 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1178 ovs_strerror(error));
1182 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1183 * 'ofproto' does not have a port 'ofp_port'. */
1185 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1186 const struct smap *cfg)
1188 struct ofport *ofport;
1191 ofport = ofproto_get_port(ofproto, ofp_port);
1193 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1194 ofproto->name, ofp_port);
1198 error = (ofproto->ofproto_class->set_bfd
1199 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1202 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1203 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1204 ovs_strerror(error));
1208 /* Checks the status change of BFD on 'ofport'.
1210 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1212 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1214 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1215 return (ofport && ofproto->ofproto_class->bfd_status_changed
1216 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1220 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1221 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1222 * is not an OpenFlow port in 'ofproto'.
1224 * The caller must provide and own '*status'. */
1226 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1227 struct smap *status)
1229 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1230 return (ofport && ofproto->ofproto_class->get_bfd_status
1231 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1235 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1236 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1237 * 0 if LACP partner information is not current (generally indicating a
1238 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1240 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1242 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1243 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1244 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1249 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1251 struct ofproto *ofproto = port->ofproto;
1254 if (ofproto->ofproto_class->port_get_lacp_stats) {
1255 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1265 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1266 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1267 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1268 * configuration plus, if there is more than one slave, a bonding
1271 * If 'aux' is already registered then this function updates its configuration
1272 * to 's'. Otherwise, this function registers a new bundle.
1274 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1277 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1278 const struct ofproto_bundle_settings *s)
1280 return (ofproto->ofproto_class->bundle_set
1281 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1285 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1286 * If no such bundle has been registered, this has no effect. */
1288 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1290 return ofproto_bundle_register(ofproto, aux, NULL);
1294 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1295 * If 'aux' is already registered then this function updates its configuration
1296 * to 's'. Otherwise, this function registers a new mirror. */
1298 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1299 const struct ofproto_mirror_settings *s)
1301 return (ofproto->ofproto_class->mirror_set
1302 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1306 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1307 * If no mirror has been registered, this has no effect. */
1309 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1311 return ofproto_mirror_register(ofproto, aux, NULL);
1314 /* Retrieves statistics from mirror associated with client data pointer
1315 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1316 * 'bytes', respectively. If a particular counters is not supported,
1317 * the appropriate argument is set to UINT64_MAX.
1320 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1321 uint64_t *packets, uint64_t *bytes)
1323 if (!ofproto->ofproto_class->mirror_get_stats) {
1324 *packets = *bytes = UINT64_MAX;
1328 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1332 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1333 * which all packets are flooded, instead of using MAC learning. If
1334 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1336 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1339 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1341 return (ofproto->ofproto_class->set_flood_vlans
1342 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1346 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1347 * output for a mirror. */
1349 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1351 return (ofproto->ofproto_class->is_mirror_output_bundle
1352 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1356 /* Configuration of OpenFlow tables. */
1358 /* Returns the number of OpenFlow tables in 'ofproto'. */
1360 ofproto_get_n_tables(const struct ofproto *ofproto)
1362 return ofproto->n_tables;
1365 /* Returns the number of Controller visible OpenFlow tables
1366 * in 'ofproto'. This number will exclude Hidden tables.
1367 * This funtion's return value should be less or equal to that of
1368 * ofproto_get_n_tables() . */
1370 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1372 uint8_t n = ofproto->n_tables;
1374 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1375 * if present, are always at the end.) */
1376 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1383 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1384 * settings from 's'. 'table_id' must be in the range 0 through the number of
1385 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1387 * For read-only tables, only the name may be configured. */
1389 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1390 const struct ofproto_table_settings *s)
1392 struct oftable *table;
1394 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1395 table = &ofproto->tables[table_id];
1397 oftable_set_name(table, s->name);
1399 if (table->flags & OFTABLE_READONLY) {
1404 oftable_enable_eviction(table, s->groups, s->n_groups);
1406 oftable_disable_eviction(table);
1409 table->max_flows = s->max_flows;
1411 if (classifier_set_prefix_fields(&table->cls,
1412 s->prefix_fields, s->n_prefix_fields)) {
1413 /* XXX: Trigger revalidation. */
1416 ovs_mutex_lock(&ofproto_mutex);
1417 evict_rules_from_table(table, 0);
1418 ovs_mutex_unlock(&ofproto_mutex);
1422 ofproto_has_snoops(const struct ofproto *ofproto)
1424 return connmgr_has_snoops(ofproto->connmgr);
1428 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1430 connmgr_get_snoops(ofproto->connmgr, snoops);
1433 /* Deletes 'rule' from 'ofproto'.
1435 * Within an ofproto implementation, this function allows an ofproto
1436 * implementation to destroy any rules that remain when its ->destruct()
1437 * function is called. This function is not suitable for use elsewhere in an
1438 * ofproto implementation.
1440 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1441 * Cycle" in ofproto-provider.h. */
1443 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1444 OVS_EXCLUDED(ofproto_mutex)
1446 /* This skips the ofmonitor and flow-removed notifications because the
1447 * switch is being deleted and any OpenFlow channels have been or soon will
1449 ovs_mutex_lock(&ofproto_mutex);
1450 oftable_remove_rule(rule);
1451 ofproto->ofproto_class->rule_delete(rule);
1452 ofproto_rule_unref(rule);
1453 ovs_mutex_unlock(&ofproto_mutex);
1457 ofproto_flush__(struct ofproto *ofproto)
1458 OVS_EXCLUDED(ofproto_mutex)
1460 struct oftable *table;
1462 /* This will flush all datapath flows. */
1463 if (ofproto->ofproto_class->flush) {
1464 ofproto->ofproto_class->flush(ofproto);
1467 /* XXX: There is a small race window here, where new datapath flows can be
1468 * created by upcall handlers based on the existing flow table. We can not
1469 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1470 * as then we could deadlock on syncing with the handler threads waiting on
1471 * the same mutex. */
1473 ovs_mutex_lock(&ofproto_mutex);
1474 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1475 struct rule_collection rules;
1478 if (table->flags & OFTABLE_HIDDEN) {
1482 rule_collection_init(&rules);
1484 CLS_FOR_EACH (rule, cr, &table->cls) {
1485 rule_collection_add(&rules, rule);
1487 delete_flows__(&rules, OFPRR_DELETE, NULL);
1488 rule_collection_destroy(&rules);
1490 /* XXX: Concurrent handler threads may insert new learned flows based on
1491 * learn actions of the now deleted flows right after we release
1492 * 'ofproto_mutex'. */
1493 ovs_mutex_unlock(&ofproto_mutex);
1496 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1499 ofproto_destroy__(struct ofproto *ofproto)
1500 OVS_EXCLUDED(ofproto_mutex)
1502 struct oftable *table;
1504 destroy_rule_executes(ofproto);
1505 delete_group(ofproto, OFPG_ALL);
1507 guarded_list_destroy(&ofproto->rule_executes);
1508 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1509 hmap_destroy(&ofproto->groups);
1511 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1512 free(ofproto->name);
1513 free(ofproto->type);
1514 free(ofproto->mfr_desc);
1515 free(ofproto->hw_desc);
1516 free(ofproto->sw_desc);
1517 free(ofproto->serial_desc);
1518 free(ofproto->dp_desc);
1519 hmap_destroy(&ofproto->ports);
1520 hmap_destroy(&ofproto->ofport_usage);
1521 shash_destroy(&ofproto->port_by_name);
1522 simap_destroy(&ofproto->ofp_requests);
1524 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1525 oftable_destroy(table);
1527 free(ofproto->tables);
1529 ovs_assert(hindex_is_empty(&ofproto->cookies));
1530 hindex_destroy(&ofproto->cookies);
1532 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1533 hmap_destroy(&ofproto->learned_cookies);
1535 free(ofproto->vlan_bitmap);
1537 ofproto->ofproto_class->dealloc(ofproto);
1541 ofproto_destroy(struct ofproto *p)
1542 OVS_EXCLUDED(ofproto_mutex)
1544 struct ofport *ofport, *next_ofport;
1545 struct ofport_usage *usage, *next_usage;
1552 meter_delete(p, 1, p->meter_features.max_meters);
1553 p->meter_features.max_meters = 0;
1559 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1560 ofport_destroy(ofport);
1563 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1564 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1568 p->ofproto_class->destruct(p);
1570 /* We should not postpone this because it involves deleting a listening
1571 * socket which we may want to reopen soon. 'connmgr' should not be used
1572 * by other threads */
1573 connmgr_destroy(p->connmgr);
1575 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1576 ovsrcu_postpone(ofproto_destroy__, p);
1579 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1580 * kernel datapath, for example, this destroys the datapath in the kernel, and
1581 * with the netdev-based datapath, it tears down the data structures that
1582 * represent the datapath.
1584 * The datapath should not be currently open as an ofproto. */
1586 ofproto_delete(const char *name, const char *type)
1588 const struct ofproto_class *class = ofproto_class_find__(type);
1589 return (!class ? EAFNOSUPPORT
1590 : !class->del ? EACCES
1591 : class->del(type, name));
1595 process_port_change(struct ofproto *ofproto, int error, char *devname)
1597 if (error == ENOBUFS) {
1598 reinit_ports(ofproto);
1599 } else if (!error) {
1600 update_port(ofproto, devname);
1606 ofproto_type_run(const char *datapath_type)
1608 const struct ofproto_class *class;
1611 datapath_type = ofproto_normalize_type(datapath_type);
1612 class = ofproto_class_find__(datapath_type);
1614 error = class->type_run ? class->type_run(datapath_type) : 0;
1615 if (error && error != EAGAIN) {
1616 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1617 datapath_type, ovs_strerror(error));
1623 ofproto_type_wait(const char *datapath_type)
1625 const struct ofproto_class *class;
1627 datapath_type = ofproto_normalize_type(datapath_type);
1628 class = ofproto_class_find__(datapath_type);
1630 if (class->type_wait) {
1631 class->type_wait(datapath_type);
1636 ofproto_run(struct ofproto *p)
1641 error = p->ofproto_class->run(p);
1642 if (error && error != EAGAIN) {
1643 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1646 run_rule_executes(p);
1648 /* Restore the eviction group heap invariant occasionally. */
1649 if (p->eviction_group_timer < time_msec()) {
1652 p->eviction_group_timer = time_msec() + 1000;
1654 for (i = 0; i < p->n_tables; i++) {
1655 struct oftable *table = &p->tables[i];
1656 struct eviction_group *evg;
1659 if (!table->eviction_fields) {
1663 if (classifier_count(&table->cls) > 100000) {
1664 static struct vlog_rate_limit count_rl =
1665 VLOG_RATE_LIMIT_INIT(1, 1);
1666 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1667 " number of rules: %d", i,
1668 classifier_count(&table->cls));
1671 ovs_mutex_lock(&ofproto_mutex);
1672 CLS_FOR_EACH (rule, cr, &table->cls) {
1673 if (rule->idle_timeout || rule->hard_timeout) {
1674 if (!rule->eviction_group) {
1675 eviction_group_add_rule(rule);
1677 heap_raw_change(&rule->evg_node,
1678 rule_eviction_priority(p, rule));
1683 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1684 heap_rebuild(&evg->rules);
1686 ovs_mutex_unlock(&ofproto_mutex);
1690 if (p->ofproto_class->port_poll) {
1693 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1694 process_port_change(p, error, devname);
1698 new_seq = seq_read(connectivity_seq_get());
1699 if (new_seq != p->change_seq) {
1700 struct sset devnames;
1701 const char *devname;
1702 struct ofport *ofport;
1704 /* Update OpenFlow port status for any port whose netdev has changed.
1706 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1707 * destroyed, so it's not safe to update ports directly from the
1708 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1709 * need this two-phase approach. */
1710 sset_init(&devnames);
1711 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1712 uint64_t port_change_seq;
1714 port_change_seq = netdev_get_change_seq(ofport->netdev);
1715 if (ofport->change_seq != port_change_seq) {
1716 ofport->change_seq = port_change_seq;
1717 sset_add(&devnames, netdev_get_name(ofport->netdev));
1720 SSET_FOR_EACH (devname, &devnames) {
1721 update_port(p, devname);
1723 sset_destroy(&devnames);
1725 p->change_seq = new_seq;
1728 connmgr_run(p->connmgr, handle_openflow);
1734 ofproto_wait(struct ofproto *p)
1736 p->ofproto_class->wait(p);
1737 if (p->ofproto_class->port_poll_wait) {
1738 p->ofproto_class->port_poll_wait(p);
1740 seq_wait(connectivity_seq_get(), p->change_seq);
1741 connmgr_wait(p->connmgr);
1745 ofproto_is_alive(const struct ofproto *p)
1747 return connmgr_has_controllers(p->connmgr);
1750 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1751 * memory_report(). */
1753 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1755 const struct oftable *table;
1756 unsigned int n_rules;
1758 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1761 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1762 n_rules += classifier_count(&table->cls);
1764 simap_increase(usage, "rules", n_rules);
1766 if (ofproto->ofproto_class->get_memory_usage) {
1767 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1770 connmgr_get_memory_usage(ofproto->connmgr, usage);
1774 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1776 const struct ofproto_class *class;
1778 datapath_type = ofproto_normalize_type(datapath_type);
1779 class = ofproto_class_find__(datapath_type);
1781 if (class && class->type_get_memory_usage) {
1782 class->type_get_memory_usage(datapath_type, usage);
1787 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1790 connmgr_get_controller_info(ofproto->connmgr, info);
1794 ofproto_free_ofproto_controller_info(struct shash *info)
1796 connmgr_free_controller_info(info);
1799 /* Makes a deep copy of 'old' into 'port'. */
1801 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1803 port->name = xstrdup(old->name);
1804 port->type = xstrdup(old->type);
1805 port->ofp_port = old->ofp_port;
1808 /* Frees memory allocated to members of 'ofproto_port'.
1810 * Do not call this function on an ofproto_port obtained from
1811 * ofproto_port_dump_next(): that function retains ownership of the data in the
1814 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1816 free(ofproto_port->name);
1817 free(ofproto_port->type);
1820 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1822 * This function provides no status indication. An error status for the entire
1823 * dump operation is provided when it is completed by calling
1824 * ofproto_port_dump_done().
1827 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1828 const struct ofproto *ofproto)
1830 dump->ofproto = ofproto;
1831 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1835 /* Attempts to retrieve another port from 'dump', which must have been created
1836 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1837 * 'port' and returns true. On failure, returns false.
1839 * Failure might indicate an actual error or merely that the last port has been
1840 * dumped. An error status for the entire dump operation is provided when it
1841 * is completed by calling ofproto_port_dump_done().
1843 * The ofproto owns the data stored in 'port'. It will remain valid until at
1844 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1845 * ofproto_port_dump_done(). */
1847 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1848 struct ofproto_port *port)
1850 const struct ofproto *ofproto = dump->ofproto;
1856 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1859 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1865 /* Completes port table dump operation 'dump', which must have been created
1866 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1867 * error-free, otherwise a positive errno value describing the problem. */
1869 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1871 const struct ofproto *ofproto = dump->ofproto;
1873 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1876 return dump->error == EOF ? 0 : dump->error;
1879 /* Returns the type to pass to netdev_open() when a datapath of type
1880 * 'datapath_type' has a port of type 'port_type', for a few special
1881 * cases when a netdev type differs from a port type. For example, when
1882 * using the userspace datapath, a port of type "internal" needs to be
1885 * Returns either 'type' itself or a string literal, which must not be
1888 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1890 const struct ofproto_class *class;
1892 datapath_type = ofproto_normalize_type(datapath_type);
1893 class = ofproto_class_find__(datapath_type);
1898 return (class->port_open_type
1899 ? class->port_open_type(datapath_type, port_type)
1903 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1904 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1905 * the port's OpenFlow port number.
1907 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1908 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1909 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1910 * 'ofp_portp' is non-null). */
1912 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1913 ofp_port_t *ofp_portp)
1915 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1918 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1920 const char *netdev_name = netdev_get_name(netdev);
1922 simap_put(&ofproto->ofp_requests, netdev_name,
1923 ofp_to_u16(ofp_port));
1924 update_port(ofproto, netdev_name);
1927 *ofp_portp = OFPP_NONE;
1929 struct ofproto_port ofproto_port;
1931 error = ofproto_port_query_by_name(ofproto,
1932 netdev_get_name(netdev),
1935 *ofp_portp = ofproto_port.ofp_port;
1936 ofproto_port_destroy(&ofproto_port);
1943 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1944 * initializes '*port' appropriately; on failure, returns a positive errno
1947 * The caller owns the data in 'ofproto_port' and must free it with
1948 * ofproto_port_destroy() when it is no longer needed. */
1950 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1951 struct ofproto_port *port)
1955 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1957 memset(port, 0, sizeof *port);
1962 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1963 * Returns 0 if successful, otherwise a positive errno. */
1965 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1967 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1968 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1969 struct simap_node *ofp_request_node;
1972 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1973 if (ofp_request_node) {
1974 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1977 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1978 if (!error && ofport) {
1979 /* 'name' is the netdev's name and update_port() is going to close the
1980 * netdev. Just in case update_port() refers to 'name' after it
1981 * destroys 'ofport', make a copy of it around the update_port()
1983 char *devname = xstrdup(name);
1984 update_port(ofproto, devname);
1991 flow_mod_init(struct ofputil_flow_mod *fm,
1992 const struct match *match, int priority,
1993 const struct ofpact *ofpacts, size_t ofpacts_len,
1994 enum ofp_flow_mod_command command)
1996 memset(fm, 0, sizeof *fm);
1998 fm->priority = priority;
2001 fm->modify_cookie = false;
2003 fm->command = command;
2004 fm->idle_timeout = 0;
2005 fm->hard_timeout = 0;
2007 fm->buffer_id = UINT32_MAX;
2008 fm->out_port = OFPP_ANY;
2009 fm->out_group = OFPG_ANY;
2011 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
2012 fm->ofpacts_len = ofpacts_len;
2013 fm->delete_reason = OFPRR_DELETE;
2017 simple_flow_mod(struct ofproto *ofproto,
2018 const struct match *match, int priority,
2019 const struct ofpact *ofpacts, size_t ofpacts_len,
2020 enum ofp_flow_mod_command command)
2022 struct ofputil_flow_mod fm;
2024 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2026 return handle_flow_mod__(ofproto, &fm, NULL);
2029 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2030 * performs the 'n_actions' actions in 'actions'. The new flow will not
2033 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2034 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2035 * controllers; otherwise, it will be hidden.
2037 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2039 * This is a helper function for in-band control and fail-open. */
2041 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2043 const struct ofpact *ofpacts, size_t ofpacts_len)
2044 OVS_EXCLUDED(ofproto_mutex)
2046 const struct rule *rule;
2049 /* First do a cheap check whether the rule we're looking for already exists
2050 * with the actions that we want. If it does, then we're done. */
2051 rule = rule_from_cls_rule(classifier_find_match_exactly(
2052 &ofproto->tables[0].cls, match, priority,
2055 const struct rule_actions *actions = rule_get_actions(rule);
2056 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2057 ofpacts, ofpacts_len);
2062 /* If there's no such rule or the rule doesn't have the actions we want,
2063 * fall back to a executing a full flow mod. We can't optimize this at
2064 * all because we didn't take enough locks above to ensure that the flow
2065 * table didn't already change beneath us. */
2067 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2068 OFPFC_MODIFY_STRICT);
2072 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2073 * an OFPERR_* OpenFlow error code on failure.
2075 * This is a helper function for in-band control and fail-open and the "learn"
2078 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2079 OVS_EXCLUDED(ofproto_mutex)
2081 /* Optimize for the most common case of a repeated learn action.
2082 * If an identical flow already exists we only need to update its
2083 * 'modified' time. */
2084 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2085 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2086 struct oftable *table = &ofproto->tables[fm->table_id];
2090 rule = rule_from_cls_rule(classifier_find_match_exactly(
2091 &table->cls, &fm->match,
2092 fm->priority, CLS_MAX_VERSION));
2094 /* Reading many of the rule fields and writing on 'modified'
2095 * requires the rule->mutex. Also, rule->actions may change
2096 * if rule->mutex is not held. */
2097 const struct rule_actions *actions;
2099 ovs_mutex_lock(&rule->mutex);
2100 actions = rule_get_actions(rule);
2101 if (rule->idle_timeout == fm->idle_timeout
2102 && rule->hard_timeout == fm->hard_timeout
2103 && rule->importance == fm->importance
2104 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2105 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2106 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2107 actions->ofpacts, actions->ofpacts_len)) {
2108 /* Rule already exists and need not change, only update the
2109 modified timestamp. */
2110 rule->modified = time_msec();
2113 ovs_mutex_unlock(&rule->mutex);
2121 return handle_flow_mod__(ofproto, fm, NULL);
2124 /* Searches for a rule with matching criteria exactly equal to 'target' in
2125 * ofproto's table 0 and, if it finds one, deletes it.
2127 * This is a helper function for in-band control and fail-open. */
2129 ofproto_delete_flow(struct ofproto *ofproto,
2130 const struct match *target, int priority)
2131 OVS_EXCLUDED(ofproto_mutex)
2133 struct classifier *cls = &ofproto->tables[0].cls;
2136 /* First do a cheap check whether the rule we're looking for has already
2137 * been deleted. If so, then we're done. */
2138 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2145 /* Execute a flow mod. We can't optimize this at all because we didn't
2146 * take enough locks above to ensure that the flow table didn't already
2147 * change beneath us. */
2148 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2151 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2152 * the flows required by in-band control and fail-open. */
2154 ofproto_flush_flows(struct ofproto *ofproto)
2156 COVERAGE_INC(ofproto_flush);
2157 ofproto_flush__(ofproto);
2158 connmgr_flushed(ofproto->connmgr);
2162 reinit_ports(struct ofproto *p)
2164 struct ofproto_port_dump dump;
2165 struct sset devnames;
2166 struct ofport *ofport;
2167 struct ofproto_port ofproto_port;
2168 const char *devname;
2170 COVERAGE_INC(ofproto_reinit_ports);
2172 sset_init(&devnames);
2173 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2174 sset_add(&devnames, netdev_get_name(ofport->netdev));
2176 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2177 sset_add(&devnames, ofproto_port.name);
2180 SSET_FOR_EACH (devname, &devnames) {
2181 update_port(p, devname);
2183 sset_destroy(&devnames);
2187 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2191 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2192 port_idx = port_idx ? port_idx : UINT16_MAX;
2194 if (port_idx >= ofproto->max_ports
2195 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2196 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2197 long long int last_used_at, lru = LLONG_MAX;
2199 /* Search for a free OpenFlow port number. We try not to
2200 * immediately reuse them to prevent problems due to old
2203 * We limit the automatically assigned port numbers to the lower half
2204 * of the port range, to reserve the upper half for assignment by
2207 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2208 ofproto->alloc_port_no = 1;
2210 last_used_at = ofport_get_usage(ofproto,
2211 u16_to_ofp(ofproto->alloc_port_no));
2212 if (!last_used_at) {
2213 port_idx = ofproto->alloc_port_no;
2215 } else if ( last_used_at < time_msec() - 60*60*1000) {
2216 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2217 * more than an hour ago, consider it usable. */
2218 ofport_remove_usage(ofproto,
2219 u16_to_ofp(ofproto->alloc_port_no));
2220 port_idx = ofproto->alloc_port_no;
2222 } else if (last_used_at < lru) {
2224 lru_ofport = ofproto->alloc_port_no;
2227 if (ofproto->alloc_port_no == end_port_no) {
2229 port_idx = lru_ofport;
2236 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2237 return u16_to_ofp(port_idx);
2241 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2243 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2244 ofport_set_usage(ofproto, ofp_port, time_msec());
2248 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2249 * pointer if the netdev cannot be opened. On success, also fills in
2251 static struct netdev *
2252 ofport_open(struct ofproto *ofproto,
2253 struct ofproto_port *ofproto_port,
2254 struct ofputil_phy_port *pp)
2256 enum netdev_flags flags;
2257 struct netdev *netdev;
2260 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2262 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2263 "cannot be opened (%s)",
2265 ofproto_port->name, ofproto_port->ofp_port,
2266 ofproto_port->name, ovs_strerror(error));
2270 if (ofproto_port->ofp_port == OFPP_NONE) {
2271 if (!strcmp(ofproto->name, ofproto_port->name)) {
2272 ofproto_port->ofp_port = OFPP_LOCAL;
2274 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2275 ofproto_port->name);
2278 pp->port_no = ofproto_port->ofp_port;
2279 netdev_get_etheraddr(netdev, pp->hw_addr);
2280 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2281 netdev_get_flags(netdev, &flags);
2282 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2283 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2284 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2285 &pp->supported, &pp->peer);
2286 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2287 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2292 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2293 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2296 ofport_equal(const struct ofputil_phy_port *a,
2297 const struct ofputil_phy_port *b)
2299 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2300 && a->state == b->state
2301 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2302 && a->curr == b->curr
2303 && a->advertised == b->advertised
2304 && a->supported == b->supported
2305 && a->peer == b->peer
2306 && a->curr_speed == b->curr_speed
2307 && a->max_speed == b->max_speed);
2310 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2311 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2312 * one with the same name or port number). */
2314 ofport_install(struct ofproto *p,
2315 struct netdev *netdev, const struct ofputil_phy_port *pp)
2317 const char *netdev_name = netdev_get_name(netdev);
2318 struct ofport *ofport;
2321 /* Create ofport. */
2322 ofport = p->ofproto_class->port_alloc();
2327 ofport->ofproto = p;
2328 ofport->netdev = netdev;
2329 ofport->change_seq = netdev_get_change_seq(netdev);
2331 ofport->ofp_port = pp->port_no;
2332 ofport->created = time_msec();
2334 /* Add port to 'p'. */
2335 hmap_insert(&p->ports, &ofport->hmap_node,
2336 hash_ofp_port(ofport->ofp_port));
2337 shash_add(&p->port_by_name, netdev_name, ofport);
2339 update_mtu(p, ofport);
2341 /* Let the ofproto_class initialize its private data. */
2342 error = p->ofproto_class->port_construct(ofport);
2346 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2350 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2351 p->name, netdev_name, ovs_strerror(error));
2353 ofport_destroy__(ofport);
2355 netdev_close(netdev);
2359 /* Removes 'ofport' from 'p' and destroys it. */
2361 ofport_remove(struct ofport *ofport)
2363 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2365 ofport_destroy(ofport);
2368 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2371 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2373 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2375 ofport_remove(port);
2379 /* Updates 'port' with new 'pp' description.
2381 * Does not handle a name or port number change. The caller must implement
2382 * such a change as a delete followed by an add. */
2384 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2386 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2387 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2388 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2389 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2390 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2391 port->pp.curr = pp->curr;
2392 port->pp.advertised = pp->advertised;
2393 port->pp.supported = pp->supported;
2394 port->pp.peer = pp->peer;
2395 port->pp.curr_speed = pp->curr_speed;
2396 port->pp.max_speed = pp->max_speed;
2398 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2399 &port->pp, OFPPR_MODIFY);
2402 /* Update OpenFlow 'state' in 'port' and notify controller. */
2404 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2406 if (port->pp.state != state) {
2407 port->pp.state = state;
2408 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2409 &port->pp, OFPPR_MODIFY);
2414 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2416 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2418 if (port->ofproto->ofproto_class->set_realdev) {
2419 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2421 if (port->ofproto->ofproto_class->set_stp_port) {
2422 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2424 if (port->ofproto->ofproto_class->set_rstp_port) {
2425 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2427 if (port->ofproto->ofproto_class->set_cfm) {
2428 port->ofproto->ofproto_class->set_cfm(port, NULL);
2430 if (port->ofproto->ofproto_class->bundle_remove) {
2431 port->ofproto->ofproto_class->bundle_remove(port);
2437 ofport_destroy__(struct ofport *port)
2439 struct ofproto *ofproto = port->ofproto;
2440 const char *name = netdev_get_name(port->netdev);
2442 hmap_remove(&ofproto->ports, &port->hmap_node);
2443 shash_delete(&ofproto->port_by_name,
2444 shash_find(&ofproto->port_by_name, name));
2446 netdev_close(port->netdev);
2447 ofproto->ofproto_class->port_dealloc(port);
2451 ofport_destroy(struct ofport *port)
2454 dealloc_ofp_port(port->ofproto, port->ofp_port);
2455 port->ofproto->ofproto_class->port_destruct(port);
2456 ofport_destroy__(port);
2461 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2463 struct ofport *port;
2465 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2467 if (port->ofp_port == ofp_port) {
2474 static long long int
2475 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2477 struct ofport_usage *usage;
2479 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2480 &ofproto->ofport_usage) {
2481 if (usage->ofp_port == ofp_port) {
2482 return usage->last_used;
2489 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2490 long long int last_used)
2492 struct ofport_usage *usage;
2493 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2494 &ofproto->ofport_usage) {
2495 if (usage->ofp_port == ofp_port) {
2496 usage->last_used = last_used;
2500 ovs_assert(last_used == LLONG_MAX);
2502 usage = xmalloc(sizeof *usage);
2503 usage->ofp_port = ofp_port;
2504 usage->last_used = last_used;
2505 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2506 hash_ofp_port(ofp_port));
2510 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2512 struct ofport_usage *usage;
2513 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2514 &ofproto->ofport_usage) {
2515 if (usage->ofp_port == ofp_port) {
2516 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2524 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2526 struct ofproto *ofproto = port->ofproto;
2529 if (ofproto->ofproto_class->port_get_stats) {
2530 error = ofproto->ofproto_class->port_get_stats(port, stats);
2539 update_port(struct ofproto *ofproto, const char *name)
2541 struct ofproto_port ofproto_port;
2542 struct ofputil_phy_port pp;
2543 struct netdev *netdev;
2544 struct ofport *port;
2546 COVERAGE_INC(ofproto_update_port);
2548 /* Fetch 'name''s location and properties from the datapath. */
2549 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2550 ? ofport_open(ofproto, &ofproto_port, &pp)
2554 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2555 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2556 struct netdev *old_netdev = port->netdev;
2558 /* 'name' hasn't changed location. Any properties changed? */
2559 if (!ofport_equal(&port->pp, &pp)) {
2560 ofport_modified(port, &pp);
2563 update_mtu(ofproto, port);
2565 /* Install the newly opened netdev in case it has changed.
2566 * Don't close the old netdev yet in case port_modified has to
2567 * remove a retained reference to it.*/
2568 port->netdev = netdev;
2569 port->change_seq = netdev_get_change_seq(netdev);
2571 if (port->ofproto->ofproto_class->port_modified) {
2572 port->ofproto->ofproto_class->port_modified(port);
2575 netdev_close(old_netdev);
2577 /* If 'port' is nonnull then its name differs from 'name' and thus
2578 * we should delete it. If we think there's a port named 'name'
2579 * then its port number must be wrong now so delete it too. */
2581 ofport_remove(port);
2583 ofport_remove_with_name(ofproto, name);
2584 ofport_install(ofproto, netdev, &pp);
2587 /* Any port named 'name' is gone now. */
2588 ofport_remove_with_name(ofproto, name);
2590 ofproto_port_destroy(&ofproto_port);
2594 init_ports(struct ofproto *p)
2596 struct ofproto_port_dump dump;
2597 struct ofproto_port ofproto_port;
2598 struct shash_node *node, *next;
2600 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2601 const char *name = ofproto_port.name;
2603 if (shash_find(&p->port_by_name, name)) {
2604 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2607 struct ofputil_phy_port pp;
2608 struct netdev *netdev;
2610 /* Check if an OpenFlow port number had been requested. */
2611 node = shash_find(&init_ofp_ports, name);
2613 const struct iface_hint *iface_hint = node->data;
2614 simap_put(&p->ofp_requests, name,
2615 ofp_to_u16(iface_hint->ofp_port));
2618 netdev = ofport_open(p, &ofproto_port, &pp);
2620 ofport_install(p, netdev, &pp);
2621 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2622 p->alloc_port_no = MAX(p->alloc_port_no,
2623 ofp_to_u16(ofproto_port.ofp_port));
2629 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2630 struct iface_hint *iface_hint = node->data;
2632 if (!strcmp(iface_hint->br_name, p->name)) {
2633 free(iface_hint->br_name);
2634 free(iface_hint->br_type);
2636 shash_delete(&init_ofp_ports, node);
2643 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2644 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2646 find_min_mtu(struct ofproto *p)
2648 struct ofport *ofport;
2651 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2652 struct netdev *netdev = ofport->netdev;
2655 /* Skip any internal ports, since that's what we're trying to
2657 if (!strcmp(netdev_get_type(netdev), "internal")) {
2661 if (netdev_get_mtu(netdev, &dev_mtu)) {
2664 if (!mtu || dev_mtu < mtu) {
2669 return mtu ? mtu: ETH_PAYLOAD_MAX;
2672 /* Update MTU of all datapath devices on 'p' to the minimum of the
2673 * non-datapath ports in event of 'port' added or changed. */
2675 update_mtu(struct ofproto *p, struct ofport *port)
2677 struct ofport *ofport;
2678 struct netdev *netdev = port->netdev;
2679 int dev_mtu, old_min;
2681 if (netdev_get_mtu(netdev, &dev_mtu)) {
2685 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2686 if (dev_mtu > p->min_mtu) {
2687 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2688 dev_mtu = p->min_mtu;
2691 port->mtu = dev_mtu;
2695 /* For non-internal port find new min mtu. */
2696 old_min = p->min_mtu;
2697 port->mtu = dev_mtu;
2698 p->min_mtu = find_min_mtu(p);
2699 if (p->min_mtu == old_min) {
2703 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2704 struct netdev *netdev = ofport->netdev;
2706 if (!strcmp(netdev_get_type(netdev), "internal")) {
2707 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2708 ofport->mtu = p->min_mtu;
2715 ofproto_rule_destroy__(struct rule *rule)
2716 OVS_NO_THREAD_SAFETY_ANALYSIS
2718 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2719 rule_actions_destroy(rule_get_actions(rule));
2720 ovs_mutex_destroy(&rule->mutex);
2721 rule->ofproto->ofproto_class->rule_dealloc(rule);
2724 /* Create a new rule based on attributes in 'fm', match in 'cr', and
2725 * 'table_id'. Note that the rule is NOT inserted into a any data structures
2726 * yet. Takes ownership of 'cr'. */
2728 ofproto_rule_create(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
2729 struct cls_rule *cr, uint8_t table_id,
2730 struct rule **rulep)
2731 OVS_REQUIRES(ofproto_mutex)
2736 /* Allocate new rule. */
2737 rule = ofproto->ofproto_class->rule_alloc();
2739 cls_rule_destroy(cr);
2740 VLOG_WARN_RL(&rl, "%s: failed to allocate a rule.", ofproto->name);
2741 return OFPERR_OFPFMFC_UNKNOWN;
2744 /* Initialize base state. */
2745 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
2746 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), cr);
2747 ovs_refcount_init(&rule->ref_count);
2748 rule->flow_cookie = fm->new_cookie;
2749 rule->created = rule->modified = time_msec();
2751 ovs_mutex_init(&rule->mutex);
2752 ovs_mutex_lock(&rule->mutex);
2753 rule->idle_timeout = fm->idle_timeout;
2754 rule->hard_timeout = fm->hard_timeout;
2755 rule->importance = fm->importance;
2756 ovs_mutex_unlock(&rule->mutex);
2758 *CONST_CAST(uint8_t *, &rule->table_id) = table_id;
2759 rule->flags = fm->flags & OFPUTIL_FF_STATE;
2760 ovsrcu_set_hidden(&rule->actions,
2761 rule_actions_create(fm->ofpacts, fm->ofpacts_len));
2762 list_init(&rule->meter_list_node);
2763 rule->eviction_group = NULL;
2764 list_init(&rule->expirable);
2765 rule->monitor_flags = 0;
2766 rule->add_seqno = 0;
2767 rule->modify_seqno = 0;
2769 /* Construct rule, initializing derived state. */
2770 error = ofproto->ofproto_class->rule_construct(rule);
2772 ofproto_rule_destroy__(rule);
2781 rule_destroy_cb(struct rule *rule)
2783 rule->ofproto->ofproto_class->rule_destruct(rule);
2784 ofproto_rule_destroy__(rule);
2788 ofproto_rule_ref(struct rule *rule)
2791 ovs_refcount_ref(&rule->ref_count);
2796 ofproto_rule_try_ref(struct rule *rule)
2799 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2804 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2805 * ref_count reaches 0.
2807 * Use of RCU allows short term use (between RCU quiescent periods) without
2808 * keeping a reference. A reference must be taken if the rule needs to
2809 * stay around accross the RCU quiescent periods. */
2811 ofproto_rule_unref(struct rule *rule)
2813 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2814 ovsrcu_postpone(rule_destroy_cb, rule);
2819 ofproto_group_ref(struct ofgroup *group)
2822 ovs_refcount_ref(&group->ref_count);
2827 ofproto_group_unref(struct ofgroup *group)
2829 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2830 group->ofproto->ofproto_class->group_destruct(group);
2831 ofputil_bucket_list_destroy(&group->buckets);
2832 group->ofproto->ofproto_class->group_dealloc(group);
2836 static uint32_t get_provider_meter_id(const struct ofproto *,
2837 uint32_t of_meter_id);
2839 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2840 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2841 const struct rule_actions *
2842 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2844 struct rule_actions *actions;
2846 actions = xmalloc(sizeof *actions + ofpacts_len);
2847 actions->ofpacts_len = ofpacts_len;
2848 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2849 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2851 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2857 /* Free the actions after the RCU quiescent period is reached. */
2859 rule_actions_destroy(const struct rule_actions *actions)
2862 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2866 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2867 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2869 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2870 OVS_REQUIRES(ofproto_mutex)
2872 if (port == OFPP_ANY) {
2875 const struct rule_actions *actions = rule_get_actions(rule);
2876 return ofpacts_output_to_port(actions->ofpacts,
2877 actions->ofpacts_len, port);
2881 /* Returns true if 'rule' has group and equals group_id. */
2883 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2884 OVS_REQUIRES(ofproto_mutex)
2886 if (group_id == OFPG_ANY) {
2889 const struct rule_actions *actions = rule_get_actions(rule);
2890 return ofpacts_output_to_group(actions->ofpacts,
2891 actions->ofpacts_len, group_id);
2896 rule_execute_destroy(struct rule_execute *e)
2898 ofproto_rule_unref(e->rule);
2899 list_remove(&e->list_node);
2903 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2904 * by passing them to the ofproto provider. */
2906 run_rule_executes(struct ofproto *ofproto)
2907 OVS_EXCLUDED(ofproto_mutex)
2909 struct rule_execute *e, *next;
2910 struct ovs_list executes;
2912 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2913 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2916 flow_extract(e->packet, &flow);
2917 flow.in_port.ofp_port = e->in_port;
2918 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2920 rule_execute_destroy(e);
2924 /* Destroys and discards all "rule_execute" operations queued up in
2925 * ofproto->rule_executes. */
2927 destroy_rule_executes(struct ofproto *ofproto)
2929 struct rule_execute *e, *next;
2930 struct ovs_list executes;
2932 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2933 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2934 dp_packet_delete(e->packet);
2935 rule_execute_destroy(e);
2940 rule_is_readonly(const struct rule *rule)
2942 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2943 return (table->flags & OFTABLE_READONLY) != 0;
2947 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2949 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2950 return hash_3words(cookie, cookie >> 32, table_id);
2954 learned_cookies_update_one__(struct ofproto *ofproto,
2955 const struct ofpact_learn *learn,
2956 int delta, struct ovs_list *dead_cookies)
2957 OVS_REQUIRES(ofproto_mutex)
2959 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
2960 struct learned_cookie *c;
2962 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
2963 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
2965 ovs_assert(c->n >= 0);
2968 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
2969 list_push_back(dead_cookies, &c->u.list_node);
2976 ovs_assert(delta > 0);
2977 c = xmalloc(sizeof *c);
2978 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
2979 c->cookie = learn->cookie;
2980 c->table_id = learn->table_id;
2984 static const struct ofpact_learn *
2985 next_learn_with_delete(const struct rule_actions *actions,
2986 const struct ofpact_learn *start)
2988 const struct ofpact *pos;
2990 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
2991 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
2992 pos = ofpact_next(pos)) {
2993 if (pos->type == OFPACT_LEARN) {
2994 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
2995 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
3005 learned_cookies_update__(struct ofproto *ofproto,
3006 const struct rule_actions *actions,
3007 int delta, struct ovs_list *dead_cookies)
3008 OVS_REQUIRES(ofproto_mutex)
3010 if (actions->has_learn_with_delete) {
3011 const struct ofpact_learn *learn;
3013 for (learn = next_learn_with_delete(actions, NULL); learn;
3014 learn = next_learn_with_delete(actions, learn)) {
3015 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
3021 learned_cookies_inc(struct ofproto *ofproto,
3022 const struct rule_actions *actions)
3023 OVS_REQUIRES(ofproto_mutex)
3025 learned_cookies_update__(ofproto, actions, +1, NULL);
3029 learned_cookies_dec(struct ofproto *ofproto,
3030 const struct rule_actions *actions,
3031 struct ovs_list *dead_cookies)
3032 OVS_REQUIRES(ofproto_mutex)
3034 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
3038 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
3039 OVS_REQUIRES(ofproto_mutex)
3041 struct learned_cookie *c;
3043 LIST_FOR_EACH_POP (c, u.list_node, dead_cookies) {
3044 struct rule_criteria criteria;
3045 struct rule_collection rules;
3048 match_init_catchall(&match);
3049 rule_criteria_init(&criteria, c->table_id, &match, 0, CLS_MAX_VERSION,
3050 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
3051 rule_criteria_require_rw(&criteria, false);
3052 collect_rules_loose(ofproto, &criteria, &rules);
3053 delete_flows__(&rules, OFPRR_DELETE, NULL);
3054 rule_criteria_destroy(&criteria);
3055 rule_collection_destroy(&rules);
3062 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
3064 ofconn_send_reply(ofconn, make_echo_reply(oh));
3069 query_tables(struct ofproto *ofproto,
3070 struct ofputil_table_features **featuresp,
3071 struct ofputil_table_stats **statsp)
3073 struct mf_bitmap rw_fields = oxm_writable_fields();
3074 struct mf_bitmap match = oxm_matchable_fields();
3075 struct mf_bitmap mask = oxm_maskable_fields();
3077 struct ofputil_table_features *features;
3078 struct ofputil_table_stats *stats;
3081 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3082 for (i = 0; i < ofproto->n_tables; i++) {
3083 struct ofputil_table_features *f = &features[i];
3086 sprintf(f->name, "table%d", i);
3087 f->metadata_match = OVS_BE64_MAX;
3088 f->metadata_write = OVS_BE64_MAX;
3089 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3090 f->max_entries = 1000000;
3092 bool more_tables = false;
3093 for (int j = i + 1; j < ofproto->n_tables; j++) {
3094 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3095 bitmap_set1(f->nonmiss.next, j);
3099 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3101 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3103 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3104 f->nonmiss.write.set_fields = rw_fields;
3105 f->nonmiss.apply = f->nonmiss.write;
3106 f->miss = f->nonmiss;
3110 f->wildcard = match;
3114 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3115 for (i = 0; i < ofproto->n_tables; i++) {
3116 struct ofputil_table_stats *s = &stats[i];
3117 struct classifier *cls = &ofproto->tables[i].cls;
3120 s->active_count = classifier_count(cls);
3122 s->active_count -= connmgr_count_hidden_rules(
3130 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3132 for (i = 0; i < ofproto->n_tables; i++) {
3133 const struct oftable *table = &ofproto->tables[i];
3134 struct ofputil_table_features *f = &features[i];
3137 ovs_strzcpy(f->name, table->name, sizeof f->name);
3140 if (table->max_flows < f->max_entries) {
3141 f->max_entries = table->max_flows;
3147 query_switch_features(struct ofproto *ofproto,
3148 bool *arp_match_ip, uint64_t *ofpacts)
3150 struct ofputil_table_features *features, *f;
3152 *arp_match_ip = false;
3155 query_tables(ofproto, &features, NULL);
3156 for (f = features; f < &features[ofproto->n_tables]; f++) {
3157 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3158 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3159 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3160 *arp_match_ip = true;
3166 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3170 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3172 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3173 struct ofputil_switch_features features;
3174 struct ofport *port;
3178 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3180 features.datapath_id = ofproto->datapath_id;
3181 features.n_buffers = pktbuf_capacity();
3182 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3183 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3184 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3185 OFPUTIL_C_GROUP_STATS);
3187 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3189 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3190 features.auxiliary_id = 0;
3191 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3193 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3194 ofputil_put_switch_features_port(&port->pp, b);
3197 ofconn_send_reply(ofconn, b);
3202 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3204 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3205 struct ofp_switch_config *osc;
3206 enum ofp_config_flags flags;
3210 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3211 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3212 flags = ofproto->frag_handling;
3213 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3214 if (oh->version < OFP13_VERSION
3215 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3216 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3218 osc->flags = htons(flags);
3219 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3220 ofconn_send_reply(ofconn, buf);
3226 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3228 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3229 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3230 uint16_t flags = ntohs(osc->flags);
3232 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3233 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3234 enum ofp_config_flags cur = ofproto->frag_handling;
3235 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3237 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3239 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3240 ofproto->frag_handling = next;
3242 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3244 ofputil_frag_handling_to_string(next));
3248 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3249 ofconn_set_invalid_ttl_to_controller(ofconn,
3250 (oh->version < OFP13_VERSION
3251 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3253 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3258 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3259 * error message code for the caller to propagate upward. Otherwise, returns
3262 * The log message mentions 'msg_type'. */
3264 reject_slave_controller(struct ofconn *ofconn)
3266 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3267 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3268 return OFPERR_OFPBRC_IS_SLAVE;
3274 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3277 * - If they use a meter, then 'ofproto' has that meter configured.
3279 * - If they use any groups, then 'ofproto' has that group configured.
3281 * Returns 0 if successful, otherwise an OpenFlow error. */
3283 ofproto_check_ofpacts(struct ofproto *ofproto,
3284 const struct ofpact ofpacts[], size_t ofpacts_len)
3286 const struct ofpact *a;
3289 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3290 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3291 return OFPERR_OFPMMFC_INVALID_METER;
3294 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3295 if (a->type == OFPACT_GROUP
3296 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3297 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3305 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3307 struct ofproto *p = ofconn_get_ofproto(ofconn);
3308 struct ofputil_packet_out po;
3309 struct dp_packet *payload;
3310 uint64_t ofpacts_stub[1024 / 8];
3311 struct ofpbuf ofpacts;
3315 COVERAGE_INC(ofproto_packet_out);
3317 error = reject_slave_controller(ofconn);
3322 /* Decode message. */
3323 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3324 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3326 goto exit_free_ofpacts;
3328 if (ofp_to_u16(po.in_port) >= p->max_ports
3329 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3330 error = OFPERR_OFPBRC_BAD_PORT;
3331 goto exit_free_ofpacts;
3335 if (po.buffer_id != UINT32_MAX) {
3336 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3337 if (error || !payload) {
3338 goto exit_free_ofpacts;
3341 /* Ensure that the L3 header is 32-bit aligned. */
3342 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3345 /* Verify actions against packet, then send packet if successful. */
3346 flow_extract(payload, &flow);
3347 flow.in_port.ofp_port = po.in_port;
3348 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3350 error = p->ofproto_class->packet_out(p, payload, &flow,
3351 po.ofpacts, po.ofpacts_len);
3353 dp_packet_delete(payload);
3356 ofpbuf_uninit(&ofpacts);
3362 update_port_config(struct ofconn *ofconn, struct ofport *port,
3363 enum ofputil_port_config config,
3364 enum ofputil_port_config mask)
3366 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3368 if (toggle & OFPUTIL_PC_PORT_DOWN
3369 && (config & OFPUTIL_PC_PORT_DOWN
3370 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3371 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3372 /* We tried to bring the port up or down, but it failed, so don't
3373 * update the "down" bit. */
3374 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3378 enum ofputil_port_config old_config = port->pp.config;
3379 port->pp.config ^= toggle;
3380 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3381 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3387 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3389 struct ofproto *p = ofconn_get_ofproto(ofconn);
3390 struct ofputil_port_mod pm;
3391 struct ofport *port;
3394 error = reject_slave_controller(ofconn);
3399 error = ofputil_decode_port_mod(oh, &pm, false);
3404 port = ofproto_get_port(p, pm.port_no);
3406 return OFPERR_OFPPMFC_BAD_PORT;
3407 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3408 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3410 update_port_config(ofconn, port, pm.config, pm.mask);
3412 netdev_set_advertisements(port->netdev, pm.advertise);
3419 handle_desc_stats_request(struct ofconn *ofconn,
3420 const struct ofp_header *request)
3422 static const char *default_mfr_desc = "Nicira, Inc.";
3423 static const char *default_hw_desc = "Open vSwitch";
3424 static const char *default_sw_desc = VERSION;
3425 static const char *default_serial_desc = "None";
3426 static const char *default_dp_desc = "None";
3428 struct ofproto *p = ofconn_get_ofproto(ofconn);
3429 struct ofp_desc_stats *ods;
3432 msg = ofpraw_alloc_stats_reply(request, 0);
3433 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3434 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3435 sizeof ods->mfr_desc);
3436 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3437 sizeof ods->hw_desc);
3438 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3439 sizeof ods->sw_desc);
3440 ovs_strlcpy(ods->serial_num,
3441 p->serial_desc ? p->serial_desc : default_serial_desc,
3442 sizeof ods->serial_num);
3443 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3444 sizeof ods->dp_desc);
3445 ofconn_send_reply(ofconn, msg);
3451 handle_table_stats_request(struct ofconn *ofconn,
3452 const struct ofp_header *request)
3454 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3455 struct ofputil_table_features *features;
3456 struct ofputil_table_stats *stats;
3457 struct ofpbuf *reply;
3460 query_tables(ofproto, &features, &stats);
3462 reply = ofputil_encode_table_stats_reply(request);
3463 for (i = 0; i < ofproto->n_tables; i++) {
3464 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3465 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3468 ofconn_send_reply(ofconn, reply);
3477 handle_table_features_request(struct ofconn *ofconn,
3478 const struct ofp_header *request)
3480 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3481 struct ofputil_table_features *features;
3482 struct ovs_list replies;
3486 ofpbuf_use_const(&msg, request, ntohs(request->length));
3487 ofpraw_pull_assert(&msg);
3488 if (msg.size || ofpmp_more(request)) {
3489 return OFPERR_OFPTFFC_EPERM;
3492 query_tables(ofproto, &features, NULL);
3494 ofpmp_init(&replies, request);
3495 for (i = 0; i < ofproto->n_tables; i++) {
3496 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3497 ofputil_append_table_features_reply(&features[i], &replies);
3500 ofconn_send_replies(ofconn, &replies);
3508 append_port_stat(struct ofport *port, struct ovs_list *replies)
3510 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3512 calc_duration(port->created, time_msec(),
3513 &ops.duration_sec, &ops.duration_nsec);
3515 /* Intentionally ignore return value, since errors will set
3516 * 'stats' to all-1s, which is correct for OpenFlow, and
3517 * netdev_get_stats() will log errors. */
3518 ofproto_port_get_stats(port, &ops.stats);
3520 ofputil_append_port_stat(replies, &ops);
3524 handle_port_request(struct ofconn *ofconn,
3525 const struct ofp_header *request, ofp_port_t port_no,
3526 void (*cb)(struct ofport *, struct ovs_list *replies))
3528 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3529 struct ofport *port;
3530 struct ovs_list replies;
3532 ofpmp_init(&replies, request);
3533 if (port_no != OFPP_ANY) {
3534 port = ofproto_get_port(ofproto, port_no);
3539 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3544 ofconn_send_replies(ofconn, &replies);
3548 handle_port_stats_request(struct ofconn *ofconn,
3549 const struct ofp_header *request)
3554 error = ofputil_decode_port_stats_request(request, &port_no);
3556 handle_port_request(ofconn, request, port_no, append_port_stat);
3562 append_port_desc(struct ofport *port, struct ovs_list *replies)
3564 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3568 handle_port_desc_stats_request(struct ofconn *ofconn,
3569 const struct ofp_header *request)
3574 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3576 handle_port_request(ofconn, request, port_no, append_port_desc);
3582 hash_cookie(ovs_be64 cookie)
3584 return hash_uint64((OVS_FORCE uint64_t)cookie);
3588 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3589 OVS_REQUIRES(ofproto_mutex)
3591 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3592 hash_cookie(rule->flow_cookie));
3596 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3597 OVS_REQUIRES(ofproto_mutex)
3599 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3603 calc_duration(long long int start, long long int now,
3604 uint32_t *sec, uint32_t *nsec)
3606 long long int msecs = now - start;
3607 *sec = msecs / 1000;
3608 *nsec = (msecs % 1000) * (1000 * 1000);
3611 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3612 * true if 'table_id' is OK, false otherwise. */
3614 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3616 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3619 static struct oftable *
3620 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3622 struct oftable *table;
3624 for (table = &ofproto->tables[table_id];
3625 table < &ofproto->tables[ofproto->n_tables];
3627 if (!(table->flags & OFTABLE_HIDDEN)) {
3635 static struct oftable *
3636 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3638 if (table_id == 0xff) {
3639 return next_visible_table(ofproto, 0);
3640 } else if (table_id < ofproto->n_tables) {
3641 return &ofproto->tables[table_id];
3647 static struct oftable *
3648 next_matching_table(const struct ofproto *ofproto,
3649 const struct oftable *table, uint8_t table_id)
3651 return (table_id == 0xff
3652 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3656 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3658 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3659 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3661 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3662 * only once, for that table. (This can be used to access tables marked
3665 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3666 * entered at all. (Perhaps you should have validated TABLE_ID with
3667 * check_table_id().)
3669 * All parameters are evaluated multiple times.
3671 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3672 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3674 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3676 /* Initializes 'criteria' in a straightforward way based on the other
3679 * By default, the criteria include flows that are read-only, on the assumption
3680 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3681 * if flows will be modified.
3683 * For "loose" matching, the 'priority' parameter is unimportant and may be
3686 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3687 const struct match *match, int priority, long long version,
3688 ovs_be64 cookie, ovs_be64 cookie_mask,
3689 ofp_port_t out_port, uint32_t out_group)
3691 criteria->table_id = table_id;
3692 cls_rule_init(&criteria->cr, match, priority, version);
3693 criteria->cookie = cookie;
3694 criteria->cookie_mask = cookie_mask;
3695 criteria->out_port = out_port;
3696 criteria->out_group = out_group;
3698 /* We ordinarily want to skip hidden rules, but there has to be a way for
3699 * code internal to OVS to modify and delete them, so if the criteria
3700 * specify a priority that can only be for a hidden flow, then allow hidden
3701 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3702 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3704 criteria->include_hidden = priority > UINT16_MAX;
3706 /* We assume that the criteria are being used to collect flows for reading
3707 * but not modification. Thus, we should collect read-only flows. */
3708 criteria->include_readonly = true;
3711 /* By default, criteria initialized by rule_criteria_init() will match flows
3712 * that are read-only, on the assumption that the collected flows won't be
3713 * modified. Call this function to match only flows that are be modifiable.
3715 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3716 * caller has special privileges that allow it to modify even "read-only"
3719 rule_criteria_require_rw(struct rule_criteria *criteria,
3720 bool can_write_readonly)
3722 criteria->include_readonly = can_write_readonly;
3726 rule_criteria_destroy(struct rule_criteria *criteria)
3728 cls_rule_destroy(&criteria->cr);
3732 rule_collection_init(struct rule_collection *rules)
3734 rules->rules = rules->stub;
3736 rules->capacity = ARRAY_SIZE(rules->stub);
3740 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3742 if (rules->n >= rules->capacity) {
3743 size_t old_size, new_size;
3745 old_size = rules->capacity * sizeof *rules->rules;
3746 rules->capacity *= 2;
3747 new_size = rules->capacity * sizeof *rules->rules;
3749 if (rules->rules == rules->stub) {
3750 rules->rules = xmalloc(new_size);
3751 memcpy(rules->rules, rules->stub, old_size);
3753 rules->rules = xrealloc(rules->rules, new_size);
3757 rules->rules[rules->n++] = rule;
3761 rule_collection_ref(struct rule_collection *rules)
3762 OVS_REQUIRES(ofproto_mutex)
3766 for (i = 0; i < rules->n; i++) {
3767 ofproto_rule_ref(rules->rules[i]);
3772 rule_collection_unref(struct rule_collection *rules)
3776 for (i = 0; i < rules->n; i++) {
3777 ofproto_rule_unref(rules->rules[i]);
3782 rule_collection_destroy(struct rule_collection *rules)
3784 if (rules->rules != rules->stub) {
3788 /* Make repeated destruction harmless. */
3789 rule_collection_init(rules);
3792 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3793 * function verifies most of the criteria in 'c' itself, but the caller must
3794 * check 'c->cr' itself.
3796 * Rules that have already been marked for removal are not collected.
3798 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3799 * 'c' only includes modifiable rules). */
3801 collect_rule(struct rule *rule, const struct rule_criteria *c,
3802 struct rule_collection *rules, size_t *n_readonly)
3803 OVS_REQUIRES(ofproto_mutex)
3805 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3806 && ofproto_rule_has_out_port(rule, c->out_port)
3807 && ofproto_rule_has_out_group(rule, c->out_group)
3808 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3809 && (!rule_is_hidden(rule) || c->include_hidden)
3810 && cls_rule_visible_in_version(&rule->cr, c->cr.version)) {
3811 /* Rule matches all the criteria... */
3812 if (!rule_is_readonly(rule) || c->include_readonly) {
3814 rule_collection_add(rules, rule);
3816 /* ...except it's read-only. */
3822 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3823 * on classifiers rules are done in the "loose" way required for OpenFlow
3824 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3827 * Returns 0 on success, otherwise an OpenFlow error code. */
3829 collect_rules_loose(struct ofproto *ofproto,
3830 const struct rule_criteria *criteria,
3831 struct rule_collection *rules)
3832 OVS_REQUIRES(ofproto_mutex)
3834 struct oftable *table;
3835 enum ofperr error = 0;
3836 size_t n_readonly = 0;
3838 rule_collection_init(rules);
3840 if (!check_table_id(ofproto, criteria->table_id)) {
3841 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3845 if (criteria->cookie_mask == OVS_BE64_MAX) {
3848 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3849 hash_cookie(criteria->cookie),
3850 &ofproto->cookies) {
3851 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3852 collect_rule(rule, criteria, rules, &n_readonly);
3856 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3859 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3860 collect_rule(rule, criteria, rules, &n_readonly);
3866 if (!error && !rules->n && n_readonly) {
3867 /* We didn't find any rules to modify. We did find some read-only
3868 * rules that we're not allowed to modify, so report that. */
3869 error = OFPERR_OFPBRC_EPERM;
3872 rule_collection_destroy(rules);
3877 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3878 * on classifiers rules are done in the "strict" way required for OpenFlow
3879 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3880 * rules on list 'rules'.
3882 * Returns 0 on success, otherwise an OpenFlow error code. */
3884 collect_rules_strict(struct ofproto *ofproto,
3885 const struct rule_criteria *criteria,
3886 struct rule_collection *rules)
3887 OVS_REQUIRES(ofproto_mutex)
3889 struct oftable *table;
3890 size_t n_readonly = 0;
3891 enum ofperr error = 0;
3893 rule_collection_init(rules);
3895 if (!check_table_id(ofproto, criteria->table_id)) {
3896 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3900 if (criteria->cookie_mask == OVS_BE64_MAX) {
3903 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3904 hash_cookie(criteria->cookie),
3905 &ofproto->cookies) {
3906 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3907 collect_rule(rule, criteria, rules, &n_readonly);
3911 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3914 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3915 &table->cls, &criteria->cr));
3917 collect_rule(rule, criteria, rules, &n_readonly);
3923 if (!error && !rules->n && n_readonly) {
3924 /* We didn't find any rules to modify. We did find some read-only
3925 * rules that we're not allowed to modify, so report that. */
3926 error = OFPERR_OFPBRC_EPERM;
3929 rule_collection_destroy(rules);
3934 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3935 * forced into the range of a uint16_t. */
3937 age_secs(long long int age_ms)
3939 return (age_ms < 0 ? 0
3940 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3941 : (unsigned int) age_ms / 1000);
3945 handle_flow_stats_request(struct ofconn *ofconn,
3946 const struct ofp_header *request)
3947 OVS_EXCLUDED(ofproto_mutex)
3949 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3950 struct ofputil_flow_stats_request fsr;
3951 struct rule_criteria criteria;
3952 struct rule_collection rules;
3953 struct ovs_list replies;
3957 error = ofputil_decode_flow_stats_request(&fsr, request);
3962 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, CLS_MAX_VERSION,
3963 fsr.cookie, fsr.cookie_mask, fsr.out_port,
3966 ovs_mutex_lock(&ofproto_mutex);
3967 error = collect_rules_loose(ofproto, &criteria, &rules);
3968 rule_criteria_destroy(&criteria);
3970 rule_collection_ref(&rules);
3972 ovs_mutex_unlock(&ofproto_mutex);
3978 ofpmp_init(&replies, request);
3979 for (i = 0; i < rules.n; i++) {
3980 struct rule *rule = rules.rules[i];
3981 long long int now = time_msec();
3982 struct ofputil_flow_stats fs;
3983 long long int created, used, modified;
3984 const struct rule_actions *actions;
3985 enum ofputil_flow_mod_flags flags;
3987 ovs_mutex_lock(&rule->mutex);
3988 fs.cookie = rule->flow_cookie;
3989 fs.idle_timeout = rule->idle_timeout;
3990 fs.hard_timeout = rule->hard_timeout;
3991 fs.importance = rule->importance;
3992 created = rule->created;
3993 modified = rule->modified;
3994 actions = rule_get_actions(rule);
3995 flags = rule->flags;
3996 ovs_mutex_unlock(&rule->mutex);
3998 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3999 &fs.byte_count, &used);
4001 minimatch_expand(&rule->cr.match, &fs.match);
4002 fs.table_id = rule->table_id;
4003 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
4004 fs.priority = rule->cr.priority;
4005 fs.idle_age = age_secs(now - used);
4006 fs.hard_age = age_secs(now - modified);
4007 fs.ofpacts = actions->ofpacts;
4008 fs.ofpacts_len = actions->ofpacts_len;
4011 ofputil_append_flow_stats_reply(&fs, &replies);
4014 rule_collection_unref(&rules);
4015 rule_collection_destroy(&rules);
4017 ofconn_send_replies(ofconn, &replies);
4023 flow_stats_ds(struct rule *rule, struct ds *results)
4025 uint64_t packet_count, byte_count;
4026 const struct rule_actions *actions;
4027 long long int created, used;
4029 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4030 &byte_count, &used);
4032 ovs_mutex_lock(&rule->mutex);
4033 actions = rule_get_actions(rule);
4034 created = rule->created;
4035 ovs_mutex_unlock(&rule->mutex);
4037 if (rule->table_id != 0) {
4038 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
4040 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
4041 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
4042 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
4043 cls_rule_format(&rule->cr, results);
4044 ds_put_char(results, ',');
4046 ds_put_cstr(results, "actions=");
4047 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
4049 ds_put_cstr(results, "\n");
4052 /* Adds a pretty-printed description of all flows to 'results', including
4053 * hidden flows (e.g., set up by in-band control). */
4055 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
4057 struct oftable *table;
4059 OFPROTO_FOR_EACH_TABLE (table, p) {
4062 CLS_FOR_EACH (rule, cr, &table->cls) {
4063 flow_stats_ds(rule, results);
4068 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4069 * '*engine_type' and '*engine_id', respectively. */
4071 ofproto_get_netflow_ids(const struct ofproto *ofproto,
4072 uint8_t *engine_type, uint8_t *engine_id)
4074 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
4077 /* Checks the status change of CFM on 'ofport'.
4079 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4081 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4083 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4084 return (ofport && ofproto->ofproto_class->cfm_status_changed
4085 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4089 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4090 * Returns 0 if the port's CFM status was successfully stored into
4091 * '*status'. Returns positive errno if the port did not have CFM
4094 * The caller must provide and own '*status', and must free 'status->rmps'.
4095 * '*status' is indeterminate if the return value is non-zero. */
4097 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4098 struct cfm_status *status)
4100 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4101 return (ofport && ofproto->ofproto_class->get_cfm_status
4102 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4107 handle_aggregate_stats_request(struct ofconn *ofconn,
4108 const struct ofp_header *oh)
4109 OVS_EXCLUDED(ofproto_mutex)
4111 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4112 struct ofputil_flow_stats_request request;
4113 struct ofputil_aggregate_stats stats;
4114 bool unknown_packets, unknown_bytes;
4115 struct rule_criteria criteria;
4116 struct rule_collection rules;
4117 struct ofpbuf *reply;
4121 error = ofputil_decode_flow_stats_request(&request, oh);
4126 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4127 CLS_MAX_VERSION, request.cookie, request.cookie_mask,
4128 request.out_port, request.out_group);
4130 ovs_mutex_lock(&ofproto_mutex);
4131 error = collect_rules_loose(ofproto, &criteria, &rules);
4132 rule_criteria_destroy(&criteria);
4134 rule_collection_ref(&rules);
4136 ovs_mutex_unlock(&ofproto_mutex);
4142 memset(&stats, 0, sizeof stats);
4143 unknown_packets = unknown_bytes = false;
4144 for (i = 0; i < rules.n; i++) {
4145 struct rule *rule = rules.rules[i];
4146 uint64_t packet_count;
4147 uint64_t byte_count;
4150 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4151 &byte_count, &used);
4153 if (packet_count == UINT64_MAX) {
4154 unknown_packets = true;
4156 stats.packet_count += packet_count;
4159 if (byte_count == UINT64_MAX) {
4160 unknown_bytes = true;
4162 stats.byte_count += byte_count;
4167 if (unknown_packets) {
4168 stats.packet_count = UINT64_MAX;
4170 if (unknown_bytes) {
4171 stats.byte_count = UINT64_MAX;
4174 rule_collection_unref(&rules);
4175 rule_collection_destroy(&rules);
4177 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4178 ofconn_send_reply(ofconn, reply);
4183 struct queue_stats_cbdata {
4184 struct ofport *ofport;
4185 struct ovs_list replies;
4190 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4191 const struct netdev_queue_stats *stats)
4193 struct ofputil_queue_stats oqs;
4195 oqs.port_no = cbdata->ofport->pp.port_no;
4196 oqs.queue_id = queue_id;
4197 oqs.tx_bytes = stats->tx_bytes;
4198 oqs.tx_packets = stats->tx_packets;
4199 oqs.tx_errors = stats->tx_errors;
4200 if (stats->created != LLONG_MIN) {
4201 calc_duration(stats->created, cbdata->now,
4202 &oqs.duration_sec, &oqs.duration_nsec);
4204 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4206 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4210 handle_queue_stats_dump_cb(uint32_t queue_id,
4211 struct netdev_queue_stats *stats,
4214 struct queue_stats_cbdata *cbdata = cbdata_;
4216 put_queue_stats(cbdata, queue_id, stats);
4220 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4221 struct queue_stats_cbdata *cbdata)
4223 cbdata->ofport = port;
4224 if (queue_id == OFPQ_ALL) {
4225 netdev_dump_queue_stats(port->netdev,
4226 handle_queue_stats_dump_cb, cbdata);
4228 struct netdev_queue_stats stats;
4230 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4231 put_queue_stats(cbdata, queue_id, &stats);
4233 return OFPERR_OFPQOFC_BAD_QUEUE;
4240 handle_queue_stats_request(struct ofconn *ofconn,
4241 const struct ofp_header *rq)
4243 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4244 struct queue_stats_cbdata cbdata;
4245 struct ofport *port;
4247 struct ofputil_queue_stats_request oqsr;
4249 COVERAGE_INC(ofproto_queue_req);
4251 ofpmp_init(&cbdata.replies, rq);
4252 cbdata.now = time_msec();
4254 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4259 if (oqsr.port_no == OFPP_ANY) {
4260 error = OFPERR_OFPQOFC_BAD_QUEUE;
4261 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4262 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4267 port = ofproto_get_port(ofproto, oqsr.port_no);
4269 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4270 : OFPERR_OFPQOFC_BAD_PORT);
4273 ofconn_send_replies(ofconn, &cbdata.replies);
4275 ofpbuf_list_delete(&cbdata.replies);
4282 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4283 OVS_REQUIRES(ofproto_mutex)
4285 enum ofperr error = 0;
4286 struct rule_collection rules;
4287 unsigned int count = classifier_count(&table->cls) + extra_space;
4288 unsigned int max_flows = table->max_flows;
4290 rule_collection_init(&rules);
4292 while (count-- > max_flows) {
4295 if (!choose_rule_to_evict(table, &rule)) {
4296 error = OFPERR_OFPFMFC_TABLE_FULL;
4299 eviction_group_remove_rule(rule);
4300 rule_collection_add(&rules, rule);
4303 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4304 rule_collection_destroy(&rules);
4310 is_conjunction(const struct ofpact *ofpacts, size_t ofpacts_len)
4312 return ofpacts_len > 0 && ofpacts->type == OFPACT_CONJUNCTION;
4316 get_conjunctions(const struct ofputil_flow_mod *fm,
4317 struct cls_conjunction **conjsp, size_t *n_conjsp)
4318 OVS_REQUIRES(ofproto_mutex)
4320 struct cls_conjunction *conjs = NULL;
4323 if (is_conjunction(fm->ofpacts, fm->ofpacts_len)) {
4324 const struct ofpact *ofpact;
4328 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4332 conjs = xzalloc(n_conjs * sizeof *conjs);
4334 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4335 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4336 conjs[i].clause = oc->clause;
4337 conjs[i].n_clauses = oc->n_clauses;
4338 conjs[i].id = oc->id;
4344 *n_conjsp = n_conjs;
4348 set_conjunctions(struct rule *rule, const struct cls_conjunction *conjs,
4350 OVS_REQUIRES(ofproto_mutex)
4352 struct cls_rule *cr = CONST_CAST(struct cls_rule *, &rule->cr);
4354 cls_rule_set_conjunctions(cr, conjs, n_conjs);
4357 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4358 * in which no matching flow already exists in the flow table.
4360 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4361 * success, or an OpenFlow error code on failure.
4363 * On successful return the caller must complete the operation either by
4364 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4367 * The caller retains ownership of 'fm->ofpacts'. */
4369 add_flow_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4370 struct rule **rulep, bool *modify)
4371 OVS_REQUIRES(ofproto_mutex)
4373 struct oftable *table;
4377 enum ofperr error = 0;
4379 if (!check_table_id(ofproto, fm->table_id)) {
4380 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4385 if (fm->table_id == 0xff) {
4386 if (ofproto->ofproto_class->rule_choose_table) {
4387 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4393 ovs_assert(table_id < ofproto->n_tables);
4397 } else if (fm->table_id < ofproto->n_tables) {
4398 table_id = fm->table_id;
4400 return OFPERR_OFPBRC_BAD_TABLE_ID;
4403 table = &ofproto->tables[table_id];
4404 if (table->flags & OFTABLE_READONLY
4405 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4406 return OFPERR_OFPBRC_EPERM;
4409 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)
4410 && !match_has_default_hidden_fields(&fm->match)) {
4411 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4412 "non-default values to hidden fields", ofproto->name);
4413 return OFPERR_OFPBRC_EPERM;
4416 cls_rule_init(&cr, &fm->match, fm->priority, CLS_MIN_VERSION);
4418 /* Check for the existence of an identical rule.
4419 * This will not return rules earlier marked for removal. */
4420 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4422 /* Transform "add" into "modify" of an existing identical flow. */
4423 cls_rule_destroy(&cr);
4425 fm->modify_cookie = true;
4426 error = modify_flow_check__(ofproto, fm, rule);
4432 } else { /* New rule. */
4433 struct cls_conjunction *conjs;
4436 /* Check for overlap, if requested. */
4437 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP
4438 && classifier_rule_overlaps(&table->cls, &cr)) {
4439 cls_rule_destroy(&cr);
4440 return OFPERR_OFPFMFC_OVERLAP;
4443 /* If necessary, evict an existing rule to clear out space. */
4444 error = evict_rules_from_table(table, 1);
4446 cls_rule_destroy(&cr);
4450 /* Allocate new rule. */
4451 error = ofproto_rule_create(ofproto, fm, &cr, table - ofproto->tables,
4457 /* Insert flow to the classifier, so that later flow_mods may relate
4458 * to it. This is reversible, in case later errors require this to
4460 ofproto_rule_insert__(ofproto, rule);
4461 /* Make the new rule invisible for classifier lookups. */
4462 classifier_defer(&table->cls);
4463 get_conjunctions(fm, &conjs, &n_conjs);
4464 classifier_insert(&table->cls, &rule->cr, conjs, n_conjs);
4467 error = ofproto->ofproto_class->rule_insert(rule);
4469 oftable_remove_rule(rule);
4470 ofproto_rule_unref(rule);
4481 /* Revert the effects of add_flow_start().
4482 * 'new_rule' must be passed in as NULL, if no new rule was allocated and
4483 * inserted to the classifier.
4484 * Note: evictions cannot be reverted. */
4486 add_flow_revert(struct ofproto *ofproto, struct rule *new_rule)
4487 OVS_REQUIRES(ofproto_mutex)
4489 /* Old rule was not changed yet, only need to revert a new rule. */
4491 struct oftable *table = &ofproto->tables[new_rule->table_id];
4493 if (!classifier_remove(&table->cls, &new_rule->cr)) {
4496 classifier_publish(&table->cls);
4498 ofproto_rule_remove__(ofproto, new_rule);
4499 ofproto->ofproto_class->rule_delete(new_rule);
4500 ofproto_rule_unref(new_rule);
4505 add_flow_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4506 const struct flow_mod_requester *req,
4507 struct rule *rule, bool modify)
4508 OVS_REQUIRES(ofproto_mutex)
4511 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4513 modify_flow__(ofproto, fm, req, rule, &dead_cookies);
4514 learned_cookies_flush(ofproto, &dead_cookies);
4516 struct oftable *table = &ofproto->tables[rule->table_id];
4518 classifier_publish(&table->cls);
4520 learned_cookies_inc(ofproto, rule_get_actions(rule));
4522 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
4523 if (ofproto->vlan_bitmap) {
4524 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4526 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4527 bitmap_set1(ofproto->vlan_bitmap, vid);
4528 ofproto->vlans_changed = true;
4531 ofproto->vlans_changed = true;
4535 ofmonitor_report(ofproto->connmgr, rule, NXFME_ADDED, 0,
4536 req ? req->ofconn : NULL,
4537 req ? req->request->xid : 0, NULL);
4540 send_buffered_packet(req, fm->buffer_id, rule);
4543 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4545 /* Checks if the 'rule' can be modified to match 'fm'.
4547 * Returns 0 on success, otherwise an OpenFlow error code. */
4549 modify_flow_check__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4550 const struct rule *rule)
4551 OVS_REQUIRES(ofproto_mutex)
4553 if (ofproto->ofproto_class->rule_premodify_actions) {
4554 return ofproto->ofproto_class->rule_premodify_actions(
4555 rule, fm->ofpacts, fm->ofpacts_len);
4560 /* Checks if the rules listed in 'rules' can have their actions changed to
4561 * match those in 'fm'.
4563 * Returns 0 on success, otherwise an OpenFlow error code. */
4565 modify_flows_check__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4566 const struct rule_collection *rules)
4567 OVS_REQUIRES(ofproto_mutex)
4572 if (ofproto->ofproto_class->rule_premodify_actions) {
4573 for (i = 0; i < rules->n; i++) {
4574 error = modify_flow_check__(ofproto, fm, rules->rules[i]);
4584 /* Modifies the 'rule', changing it to match 'fm'. */
4586 modify_flow__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4587 const struct flow_mod_requester *req, struct rule *rule,
4588 struct ovs_list *dead_cookies)
4589 OVS_REQUIRES(ofproto_mutex)
4591 enum nx_flow_update_event event = fm->command == OFPFC_ADD
4592 ? NXFME_ADDED : NXFME_MODIFIED;
4594 /* 'fm' says that */
4595 bool change_cookie = (fm->modify_cookie
4596 && fm->new_cookie != OVS_BE64_MAX
4597 && fm->new_cookie != rule->flow_cookie);
4599 const struct rule_actions *actions = rule_get_actions(rule);
4600 bool change_actions = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4602 actions->ofpacts_len);
4604 bool reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4606 long long int now = time_msec();
4608 if (change_cookie) {
4609 cookies_remove(ofproto, rule);
4612 ovs_mutex_lock(&rule->mutex);
4613 if (fm->command == OFPFC_ADD) {
4614 rule->idle_timeout = fm->idle_timeout;
4615 rule->hard_timeout = fm->hard_timeout;
4616 rule->importance = fm->importance;
4617 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4618 rule->created = now;
4620 if (change_cookie) {
4621 rule->flow_cookie = fm->new_cookie;
4623 rule->modified = now;
4624 ovs_mutex_unlock(&rule->mutex);
4626 if (change_cookie) {
4627 cookies_insert(ofproto, rule);
4629 if (fm->command == OFPFC_ADD) {
4630 if (fm->idle_timeout || fm->hard_timeout || fm->importance) {
4631 if (!rule->eviction_group) {
4632 eviction_group_add_rule(rule);
4635 eviction_group_remove_rule(rule);
4639 if (change_actions) {
4640 /* We have to change the actions. The rule's conjunctive match set
4641 * is a function of its actions, so we need to update that too. The
4642 * conjunctive match set is used in the lookup process to figure
4643 * which (if any) collection of conjunctive sets the packet matches
4644 * with. However, a rule with conjunction actions is never to be
4645 * returned as a classifier lookup result. To make sure a rule with
4646 * conjunction actions is not returned as a lookup result, we update
4647 * them in a carefully chosen order:
4649 * - If we're adding a conjunctive match set where there wasn't one
4650 * before, we have to make the conjunctive match set available to
4651 * lookups before the rule's actions are changed, as otherwise
4652 * rule with a conjunction action could be returned as a lookup
4655 * - To clear some nonempty conjunctive set, we set the rule's
4656 * actions first, so that a lookup can't return a rule with
4657 * conjunction actions.
4659 * - Otherwise, order doesn't matter for changing one nonempty
4660 * conjunctive match set to some other nonempty set, since the
4661 * rule's actions are not seen by the classifier, and hence don't
4662 * matter either before or after the change. */
4663 struct cls_conjunction *conjs;
4665 get_conjunctions(fm, &conjs, &n_conjs);
4668 set_conjunctions(rule, conjs, n_conjs);
4670 ovsrcu_set(&rule->actions, rule_actions_create(fm->ofpacts,
4673 set_conjunctions(rule, conjs, n_conjs);
4679 if (change_actions || reset_counters) {
4680 ofproto->ofproto_class->rule_modify_actions(rule, reset_counters);
4683 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4684 ofmonitor_report(ofproto->connmgr, rule, event, 0,
4685 req ? req->ofconn : NULL, req ? req->request->xid : 0,
4686 change_actions ? actions : NULL);
4689 if (change_actions) {
4690 learned_cookies_inc(ofproto, rule_get_actions(rule));
4691 learned_cookies_dec(ofproto, actions, dead_cookies);
4692 rule_actions_destroy(actions);
4696 /* Modifies the rules listed in 'rules', changing their actions to match those
4699 * 'req' is used to retrieve the packet buffer specified in fm->buffer_id,
4702 modify_flows__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4703 const struct flow_mod_requester *req,
4704 const struct rule_collection *rules)
4705 OVS_REQUIRES(ofproto_mutex)
4707 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4710 for (i = 0; i < rules->n; i++) {
4711 modify_flow__(ofproto, fm, req, rules->rules[i], &dead_cookies);
4713 learned_cookies_flush(ofproto, &dead_cookies);
4717 modify_flows_start__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4718 struct rule_collection *rules)
4719 OVS_REQUIRES(ofproto_mutex)
4724 error = modify_flows_check__(ofproto, fm, rules);
4725 } else if (!(fm->cookie_mask != htonll(0)
4726 || fm->new_cookie == OVS_BE64_MAX)) {
4729 error = add_flow_start(ofproto, fm, &rules->rules[0], &modify);
4731 ovs_assert(!modify);
4734 rules->rules[0] = NULL;
4740 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4743 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4746 modify_flows_start_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4747 struct rule_collection *rules)
4748 OVS_REQUIRES(ofproto_mutex)
4750 struct rule_criteria criteria;
4753 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4754 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4755 rule_criteria_require_rw(&criteria,
4756 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4757 error = collect_rules_loose(ofproto, &criteria, rules);
4758 rule_criteria_destroy(&criteria);
4761 error = modify_flows_start__(ofproto, fm, rules);
4765 rule_collection_destroy(rules);
4771 modify_flows_revert(struct ofproto *ofproto, struct rule_collection *rules)
4772 OVS_REQUIRES(ofproto_mutex)
4774 /* Old rules were not changed yet, only need to revert a new rule. */
4775 if (rules->n == 0 && rules->rules[0] != NULL) {
4776 add_flow_revert(ofproto, rules->rules[0]);
4778 rule_collection_destroy(rules);
4782 modify_flows_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4783 const struct flow_mod_requester *req,
4784 struct rule_collection *rules)
4785 OVS_REQUIRES(ofproto_mutex)
4788 modify_flows__(ofproto, fm, req, rules);
4789 send_buffered_packet(req, fm->buffer_id, rules->rules[0]);
4790 } else if (rules->rules[0] != NULL) {
4791 add_flow_finish(ofproto, fm, req, rules->rules[0], false);
4793 rule_collection_destroy(rules);
4796 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4797 * code on failure. */
4799 modify_flow_start_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4800 struct rule_collection *rules)
4801 OVS_REQUIRES(ofproto_mutex)
4803 struct rule_criteria criteria;
4806 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4807 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask, OFPP_ANY,
4809 rule_criteria_require_rw(&criteria,
4810 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4811 error = collect_rules_strict(ofproto, &criteria, rules);
4812 rule_criteria_destroy(&criteria);
4815 /* collect_rules_strict() can return max 1 rule. */
4816 error = modify_flows_start__(ofproto, fm, rules);
4820 rule_collection_destroy(rules);
4825 /* OFPFC_DELETE implementation. */
4827 /* Deletes the rules listed in 'rules'. */
4829 delete_flows__(const struct rule_collection *rules,
4830 enum ofp_flow_removed_reason reason,
4831 const struct flow_mod_requester *req)
4832 OVS_REQUIRES(ofproto_mutex)
4835 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4836 struct ofproto *ofproto = rules->rules[0]->ofproto;
4837 struct rule *rule, *next;
4838 uint8_t prev_table = UINT8_MAX;
4841 for (i = 0, next = rules->rules[0];
4842 rule = next, next = (++i < rules->n) ? rules->rules[i] : NULL,
4843 rule; prev_table = rule->table_id) {
4844 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
4845 uint8_t next_table = next ? next->table_id : UINT8_MAX;
4847 ofproto_rule_send_removed(rule, reason);
4849 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4850 req ? req->ofconn : NULL,
4851 req ? req->request->xid : 0, NULL);
4853 /* Defer once for each new table. */
4854 if (rule->table_id != prev_table) {
4855 classifier_defer(cls);
4857 if (!classifier_remove(cls, &rule->cr)) {
4860 if (next_table != rule->table_id) {
4861 classifier_publish(cls);
4863 ofproto_rule_remove__(ofproto, rule);
4865 ofproto->ofproto_class->rule_delete(rule);
4867 learned_cookies_dec(ofproto, rule_get_actions(rule),
4870 ofproto_rule_unref(rule);
4872 learned_cookies_flush(ofproto, &dead_cookies);
4873 ofmonitor_flush(ofproto->connmgr);
4877 /* Implements OFPFC_DELETE. */
4879 delete_flows_start_loose(struct ofproto *ofproto,
4880 const struct ofputil_flow_mod *fm,
4881 struct rule_collection *rules)
4882 OVS_REQUIRES(ofproto_mutex)
4884 struct rule_criteria criteria;
4887 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0, CLS_MAX_VERSION,
4888 fm->cookie, fm->cookie_mask,
4889 fm->out_port, fm->out_group);
4890 rule_criteria_require_rw(&criteria,
4891 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4892 error = collect_rules_loose(ofproto, &criteria, rules);
4893 rule_criteria_destroy(&criteria);
4896 for (size_t i = 0; i < rules->n; i++) {
4897 struct rule *rule = rules->rules[i];
4899 cls_rule_make_invisible_in_version(CONST_CAST(struct cls_rule *,
4910 delete_flows_revert(struct rule_collection *rules)
4911 OVS_REQUIRES(ofproto_mutex)
4913 for (size_t i = 0; i < rules->n; i++) {
4914 cls_rule_restore_visibility(&rules->rules[i]->cr);
4916 rule_collection_destroy(rules);
4920 delete_flows_finish(const struct ofputil_flow_mod *fm,
4921 const struct flow_mod_requester *req,
4922 struct rule_collection *rules)
4923 OVS_REQUIRES(ofproto_mutex)
4925 delete_flows__(rules, fm->delete_reason, req);
4926 rule_collection_destroy(rules);
4929 /* Implements OFPFC_DELETE_STRICT. */
4931 delete_flow_start_strict(struct ofproto *ofproto,
4932 const struct ofputil_flow_mod *fm,
4933 struct rule_collection *rules)
4934 OVS_REQUIRES(ofproto_mutex)
4936 struct rule_criteria criteria;
4939 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4940 CLS_MAX_VERSION, fm->cookie, fm->cookie_mask,
4941 fm->out_port, fm->out_group);
4942 rule_criteria_require_rw(&criteria,
4943 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4944 error = collect_rules_strict(ofproto, &criteria, rules);
4945 rule_criteria_destroy(&criteria);
4948 for (size_t i = 0; i < rules->n; i++) {
4949 struct rule *rule = rules->rules[i];
4951 cls_rule_make_invisible_in_version(CONST_CAST(struct cls_rule *,
4962 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4963 OVS_REQUIRES(ofproto_mutex)
4965 struct ofputil_flow_removed fr;
4968 if (rule_is_hidden(rule) ||
4969 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4973 minimatch_expand(&rule->cr.match, &fr.match);
4974 fr.priority = rule->cr.priority;
4975 fr.cookie = rule->flow_cookie;
4977 fr.table_id = rule->table_id;
4978 calc_duration(rule->created, time_msec(),
4979 &fr.duration_sec, &fr.duration_nsec);
4980 ovs_mutex_lock(&rule->mutex);
4981 fr.idle_timeout = rule->idle_timeout;
4982 fr.hard_timeout = rule->hard_timeout;
4983 ovs_mutex_unlock(&rule->mutex);
4984 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4985 &fr.byte_count, &used);
4987 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4990 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4991 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4994 * ofproto implementation ->run() functions should use this function to expire
4995 * OpenFlow flows. */
4997 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4998 OVS_REQUIRES(ofproto_mutex)
5000 struct rule_collection rules;
5002 rules.rules = rules.stub;
5004 rules.stub[0] = rule;
5005 delete_flows__(&rules, reason, NULL);
5008 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5009 * means "infinite". */
5011 reduce_timeout(uint16_t max, uint16_t *timeout)
5013 if (max && (!*timeout || *timeout > max)) {
5018 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5019 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5020 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5022 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5024 ofproto_rule_reduce_timeouts(struct rule *rule,
5025 uint16_t idle_timeout, uint16_t hard_timeout)
5026 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
5028 if (!idle_timeout && !hard_timeout) {
5032 ovs_mutex_lock(&ofproto_mutex);
5033 if (list_is_empty(&rule->expirable)) {
5034 list_insert(&rule->ofproto->expirable, &rule->expirable);
5036 ovs_mutex_unlock(&ofproto_mutex);
5038 ovs_mutex_lock(&rule->mutex);
5039 reduce_timeout(idle_timeout, &rule->idle_timeout);
5040 reduce_timeout(hard_timeout, &rule->hard_timeout);
5041 ovs_mutex_unlock(&rule->mutex);
5045 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5046 OVS_EXCLUDED(ofproto_mutex)
5048 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5049 struct ofputil_flow_mod fm;
5050 uint64_t ofpacts_stub[1024 / 8];
5051 struct ofpbuf ofpacts;
5054 error = reject_slave_controller(ofconn);
5059 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5060 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
5062 u16_to_ofp(ofproto->max_ports),
5065 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
5068 struct flow_mod_requester req;
5070 req.ofconn = ofconn;
5072 error = handle_flow_mod__(ofproto, &fm, &req);
5075 goto exit_free_ofpacts;
5078 ofconn_report_flow_mod(ofconn, fm.command);
5081 ofpbuf_uninit(&ofpacts);
5087 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
5088 const struct flow_mod_requester *req)
5089 OVS_EXCLUDED(ofproto_mutex)
5091 struct ofp_bundle_entry be;
5094 ovs_mutex_lock(&ofproto_mutex);
5095 error = do_bundle_flow_mod_start(ofproto, fm, &be);
5097 do_bundle_flow_mod_finish(ofproto, fm, req, &be);
5099 ofmonitor_flush(ofproto->connmgr);
5100 ovs_mutex_unlock(&ofproto_mutex);
5102 run_rule_executes(ofproto);
5107 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
5109 struct ofputil_role_request request;
5110 struct ofputil_role_request reply;
5114 error = ofputil_decode_role_message(oh, &request);
5119 if (request.role != OFPCR12_ROLE_NOCHANGE) {
5120 if (request.have_generation_id
5121 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
5122 return OFPERR_OFPRRFC_STALE;
5125 ofconn_set_role(ofconn, request.role);
5128 reply.role = ofconn_get_role(ofconn);
5129 reply.have_generation_id = ofconn_get_master_election_id(
5130 ofconn, &reply.generation_id);
5131 buf = ofputil_encode_role_reply(oh, &reply);
5132 ofconn_send_reply(ofconn, buf);
5138 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
5139 const struct ofp_header *oh)
5141 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
5142 enum ofputil_protocol cur, next;
5144 cur = ofconn_get_protocol(ofconn);
5145 next = ofputil_protocol_set_tid(cur, msg->set != 0);
5146 ofconn_set_protocol(ofconn, next);
5152 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
5154 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
5155 enum ofputil_protocol cur, next;
5156 enum ofputil_protocol next_base;
5158 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5160 return OFPERR_OFPBRC_EPERM;
5163 cur = ofconn_get_protocol(ofconn);
5164 next = ofputil_protocol_set_base(cur, next_base);
5165 ofconn_set_protocol(ofconn, next);
5171 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5172 const struct ofp_header *oh)
5174 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5177 format = ntohl(msg->format);
5178 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5179 return OFPERR_OFPBRC_EPERM;
5182 ofconn_set_packet_in_format(ofconn, format);
5187 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5189 const struct nx_async_config *msg = ofpmsg_body(oh);
5190 uint32_t master[OAM_N_TYPES];
5191 uint32_t slave[OAM_N_TYPES];
5193 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5194 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5195 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5197 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5198 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5199 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5201 ofconn_set_async_config(ofconn, master, slave);
5202 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5203 !ofconn_get_miss_send_len(ofconn)) {
5204 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5211 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5214 uint32_t master[OAM_N_TYPES];
5215 uint32_t slave[OAM_N_TYPES];
5216 struct nx_async_config *msg;
5218 ofconn_get_async_config(ofconn, master, slave);
5219 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5220 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5222 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5223 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5224 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5226 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5227 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5228 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5230 ofconn_send_reply(ofconn, buf);
5236 handle_nxt_set_controller_id(struct ofconn *ofconn,
5237 const struct ofp_header *oh)
5239 const struct nx_controller_id *nci = ofpmsg_body(oh);
5241 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5242 return OFPERR_NXBRC_MUST_BE_ZERO;
5245 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5250 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5254 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5255 ? OFPRAW_OFPT10_BARRIER_REPLY
5256 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5257 ofconn_send_reply(ofconn, buf);
5262 ofproto_compose_flow_refresh_update(const struct rule *rule,
5263 enum nx_flow_monitor_flags flags,
5264 struct ovs_list *msgs)
5265 OVS_REQUIRES(ofproto_mutex)
5267 const struct rule_actions *actions;
5268 struct ofputil_flow_update fu;
5271 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5272 ? NXFME_ADDED : NXFME_MODIFIED);
5274 ovs_mutex_lock(&rule->mutex);
5275 fu.idle_timeout = rule->idle_timeout;
5276 fu.hard_timeout = rule->hard_timeout;
5277 ovs_mutex_unlock(&rule->mutex);
5278 fu.table_id = rule->table_id;
5279 fu.cookie = rule->flow_cookie;
5280 minimatch_expand(&rule->cr.match, &match);
5282 fu.priority = rule->cr.priority;
5284 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5285 fu.ofpacts = actions ? actions->ofpacts : NULL;
5286 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5288 if (list_is_empty(msgs)) {
5289 ofputil_start_flow_update(msgs);
5291 ofputil_append_flow_update(&fu, msgs);
5295 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5296 struct ovs_list *msgs)
5297 OVS_REQUIRES(ofproto_mutex)
5301 for (i = 0; i < rules->n; i++) {
5302 struct rule *rule = rules->rules[i];
5303 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5304 rule->monitor_flags = 0;
5306 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5311 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5312 struct rule *rule, uint64_t seqno,
5313 struct rule_collection *rules)
5314 OVS_REQUIRES(ofproto_mutex)
5316 enum nx_flow_monitor_flags update;
5318 if (rule_is_hidden(rule)) {
5322 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5327 if (rule->add_seqno > seqno) {
5328 update = NXFMF_ADD | NXFMF_MODIFY;
5329 } else if (rule->modify_seqno > seqno) {
5330 update = NXFMF_MODIFY;
5335 if (!(m->flags & update)) {
5339 update = NXFMF_INITIAL;
5342 if (!rule->monitor_flags) {
5343 rule_collection_add(rules, rule);
5345 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5349 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5351 struct rule_collection *rules)
5352 OVS_REQUIRES(ofproto_mutex)
5354 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5355 const struct oftable *table;
5356 struct cls_rule target;
5358 cls_rule_init_from_minimatch(&target, &m->match, 0, CLS_MAX_VERSION);
5359 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5362 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5363 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5366 cls_rule_destroy(&target);
5370 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5371 struct rule_collection *rules)
5372 OVS_REQUIRES(ofproto_mutex)
5374 if (m->flags & NXFMF_INITIAL) {
5375 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5380 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5381 uint64_t seqno, struct rule_collection *rules)
5382 OVS_REQUIRES(ofproto_mutex)
5384 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5388 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5389 OVS_REQUIRES(ofproto_mutex)
5391 struct ofmonitor *m;
5394 m = ofmonitor_lookup(ofconn, id);
5396 ofmonitor_destroy(m);
5399 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5406 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5407 OVS_EXCLUDED(ofproto_mutex)
5409 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5410 struct ofmonitor **monitors;
5411 size_t n_monitors, allocated_monitors;
5412 struct rule_collection rules;
5413 struct ovs_list replies;
5418 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5420 n_monitors = allocated_monitors = 0;
5422 ovs_mutex_lock(&ofproto_mutex);
5424 struct ofputil_flow_monitor_request request;
5425 struct ofmonitor *m;
5428 retval = ofputil_decode_flow_monitor_request(&request, &b);
5429 if (retval == EOF) {
5431 } else if (retval) {
5436 if (request.table_id != 0xff
5437 && request.table_id >= ofproto->n_tables) {
5438 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5442 error = ofmonitor_create(&request, ofconn, &m);
5447 if (n_monitors >= allocated_monitors) {
5448 monitors = x2nrealloc(monitors, &allocated_monitors,
5451 monitors[n_monitors++] = m;
5454 rule_collection_init(&rules);
5455 for (i = 0; i < n_monitors; i++) {
5456 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5459 ofpmp_init(&replies, oh);
5460 ofmonitor_compose_refresh_updates(&rules, &replies);
5461 ovs_mutex_unlock(&ofproto_mutex);
5463 rule_collection_destroy(&rules);
5465 ofconn_send_replies(ofconn, &replies);
5471 for (i = 0; i < n_monitors; i++) {
5472 ofmonitor_destroy(monitors[i]);
5475 ovs_mutex_unlock(&ofproto_mutex);
5481 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5482 OVS_EXCLUDED(ofproto_mutex)
5487 id = ofputil_decode_flow_monitor_cancel(oh);
5489 ovs_mutex_lock(&ofproto_mutex);
5490 error = flow_monitor_delete(ofconn, id);
5491 ovs_mutex_unlock(&ofproto_mutex);
5496 /* Meters implementation.
5498 * Meter table entry, indexed by the OpenFlow meter_id.
5499 * 'created' is used to compute the duration for meter stats.
5500 * 'list rules' is needed so that we can delete the dependent rules when the
5501 * meter table entry is deleted.
5502 * 'provider_meter_id' is for the provider's private use.
5505 long long int created; /* Time created. */
5506 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5507 ofproto_meter_id provider_meter_id;
5508 uint16_t flags; /* Meter flags. */
5509 uint16_t n_bands; /* Number of meter bands. */
5510 struct ofputil_meter_band *bands;
5514 * This is used in instruction validation at flow set-up time,
5515 * as flows may not use non-existing meters.
5516 * Return value of UINT32_MAX signifies an invalid meter.
5519 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5521 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5522 const struct meter *meter = ofproto->meters[of_meter_id];
5524 return meter->provider_meter_id.uint32;
5530 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5533 meter_insert_rule(struct rule *rule)
5535 const struct rule_actions *a = rule_get_actions(rule);
5536 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5537 struct meter *meter = rule->ofproto->meters[meter_id];
5539 list_insert(&meter->rules, &rule->meter_list_node);
5543 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5547 meter->flags = config->flags;
5548 meter->n_bands = config->n_bands;
5549 meter->bands = xmemdup(config->bands,
5550 config->n_bands * sizeof *meter->bands);
5553 static struct meter *
5554 meter_create(const struct ofputil_meter_config *config,
5555 ofproto_meter_id provider_meter_id)
5557 struct meter *meter;
5559 meter = xzalloc(sizeof *meter);
5560 meter->provider_meter_id = provider_meter_id;
5561 meter->created = time_msec();
5562 list_init(&meter->rules);
5564 meter_update(meter, config);
5570 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5571 OVS_REQUIRES(ofproto_mutex)
5574 for (mid = first; mid <= last; ++mid) {
5575 struct meter *meter = ofproto->meters[mid];
5577 ofproto->meters[mid] = NULL;
5578 ofproto->ofproto_class->meter_del(ofproto,
5579 meter->provider_meter_id);
5587 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5589 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5590 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5594 return OFPERR_OFPMMFC_METER_EXISTS;
5597 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5600 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5601 *meterp = meter_create(&mm->meter, provider_meter_id);
5607 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5609 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5611 uint32_t provider_meter_id;
5614 return OFPERR_OFPMMFC_UNKNOWN_METER;
5617 provider_meter_id = meter->provider_meter_id.uint32;
5618 error = ofproto->ofproto_class->meter_set(ofproto,
5619 &meter->provider_meter_id,
5621 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5623 meter_update(meter, &mm->meter);
5629 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5630 OVS_EXCLUDED(ofproto_mutex)
5632 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5633 uint32_t meter_id = mm->meter.meter_id;
5634 struct rule_collection rules;
5635 enum ofperr error = 0;
5636 uint32_t first, last;
5638 if (meter_id == OFPM13_ALL) {
5640 last = ofproto->meter_features.max_meters;
5642 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5645 first = last = meter_id;
5648 /* First delete the rules that use this meter. If any of those rules are
5649 * currently being modified, postpone the whole operation until later. */
5650 rule_collection_init(&rules);
5651 ovs_mutex_lock(&ofproto_mutex);
5652 for (meter_id = first; meter_id <= last; ++meter_id) {
5653 struct meter *meter = ofproto->meters[meter_id];
5654 if (meter && !list_is_empty(&meter->rules)) {
5657 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5658 rule_collection_add(&rules, rule);
5662 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5664 /* Delete the meters. */
5665 meter_delete(ofproto, first, last);
5667 ovs_mutex_unlock(&ofproto_mutex);
5668 rule_collection_destroy(&rules);
5674 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5676 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5677 struct ofputil_meter_mod mm;
5678 uint64_t bands_stub[256 / 8];
5679 struct ofpbuf bands;
5683 error = reject_slave_controller(ofconn);
5688 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5690 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5692 goto exit_free_bands;
5695 meter_id = mm.meter.meter_id;
5697 if (mm.command != OFPMC13_DELETE) {
5698 /* Fails also when meters are not implemented by the provider. */
5699 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5700 error = OFPERR_OFPMMFC_INVALID_METER;
5701 goto exit_free_bands;
5702 } else if (meter_id > ofproto->meter_features.max_meters) {
5703 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5704 goto exit_free_bands;
5706 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5707 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5708 goto exit_free_bands;
5712 switch (mm.command) {
5714 error = handle_add_meter(ofproto, &mm);
5717 case OFPMC13_MODIFY:
5718 error = handle_modify_meter(ofproto, &mm);
5721 case OFPMC13_DELETE:
5722 error = handle_delete_meter(ofconn, &mm);
5726 error = OFPERR_OFPMMFC_BAD_COMMAND;
5731 ofpbuf_uninit(&bands);
5736 handle_meter_features_request(struct ofconn *ofconn,
5737 const struct ofp_header *request)
5739 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5740 struct ofputil_meter_features features;
5743 if (ofproto->ofproto_class->meter_get_features) {
5744 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5746 memset(&features, 0, sizeof features);
5748 b = ofputil_encode_meter_features_reply(&features, request);
5750 ofconn_send_reply(ofconn, b);
5755 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5758 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5759 struct ovs_list replies;
5760 uint64_t bands_stub[256 / 8];
5761 struct ofpbuf bands;
5762 uint32_t meter_id, first, last;
5764 ofputil_decode_meter_request(request, &meter_id);
5766 if (meter_id == OFPM13_ALL) {
5768 last = ofproto->meter_features.max_meters;
5770 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5771 !ofproto->meters[meter_id]) {
5772 return OFPERR_OFPMMFC_UNKNOWN_METER;
5774 first = last = meter_id;
5777 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5778 ofpmp_init(&replies, request);
5780 for (meter_id = first; meter_id <= last; ++meter_id) {
5781 struct meter *meter = ofproto->meters[meter_id];
5783 continue; /* Skip non-existing meters. */
5785 if (type == OFPTYPE_METER_STATS_REQUEST) {
5786 struct ofputil_meter_stats stats;
5788 stats.meter_id = meter_id;
5790 /* Provider sets the packet and byte counts, we do the rest. */
5791 stats.flow_count = list_size(&meter->rules);
5792 calc_duration(meter->created, time_msec(),
5793 &stats.duration_sec, &stats.duration_nsec);
5794 stats.n_bands = meter->n_bands;
5795 ofpbuf_clear(&bands);
5797 = ofpbuf_put_uninit(&bands,
5798 meter->n_bands * sizeof *stats.bands);
5800 if (!ofproto->ofproto_class->meter_get(ofproto,
5801 meter->provider_meter_id,
5803 ofputil_append_meter_stats(&replies, &stats);
5805 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5806 struct ofputil_meter_config config;
5808 config.meter_id = meter_id;
5809 config.flags = meter->flags;
5810 config.n_bands = meter->n_bands;
5811 config.bands = meter->bands;
5812 ofputil_append_meter_config(&replies, &config);
5816 ofconn_send_replies(ofconn, &replies);
5817 ofpbuf_uninit(&bands);
5822 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5823 struct ofgroup **group)
5824 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5826 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5827 hash_int(group_id, 0), &ofproto->groups) {
5828 if ((*group)->group_id == group_id) {
5836 /* If the group exists, this function increments the groups's reference count.
5838 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5839 * a reference to the group. */
5841 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5842 struct ofgroup **group)
5846 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5847 found = ofproto_group_lookup__(ofproto, group_id, group);
5849 ofproto_group_ref(*group);
5851 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5856 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5857 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5859 struct ofgroup *grp;
5861 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5862 hash_int(group_id, 0), &ofproto->groups) {
5863 if (grp->group_id == group_id) {
5871 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5872 OVS_EXCLUDED(ofproto->groups_rwlock)
5876 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5877 exists = ofproto_group_exists__(ofproto, group_id);
5878 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5884 group_get_ref_count(struct ofgroup *group)
5885 OVS_EXCLUDED(ofproto_mutex)
5887 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5888 struct rule_criteria criteria;
5889 struct rule_collection rules;
5894 match_init_catchall(&match);
5895 rule_criteria_init(&criteria, 0xff, &match, 0, CLS_MAX_VERSION, htonll(0),
5896 htonll(0), OFPP_ANY, group->group_id);
5897 ovs_mutex_lock(&ofproto_mutex);
5898 error = collect_rules_loose(ofproto, &criteria, &rules);
5899 ovs_mutex_unlock(&ofproto_mutex);
5900 rule_criteria_destroy(&criteria);
5902 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5904 rule_collection_destroy(&rules);
5909 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
5911 struct ofputil_group_stats ogs;
5912 const struct ofproto *ofproto = group->ofproto;
5913 long long int now = time_msec();
5916 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5918 /* Provider sets the packet and byte counts, we do the rest. */
5919 ogs.ref_count = group_get_ref_count(group);
5920 ogs.n_buckets = group->n_buckets;
5922 error = (ofproto->ofproto_class->group_get_stats
5923 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5926 ogs.packet_count = UINT64_MAX;
5927 ogs.byte_count = UINT64_MAX;
5928 memset(ogs.bucket_stats, 0xff,
5929 ogs.n_buckets * sizeof *ogs.bucket_stats);
5932 ogs.group_id = group->group_id;
5933 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5935 ofputil_append_group_stats(replies, &ogs);
5937 free(ogs.bucket_stats);
5941 handle_group_request(struct ofconn *ofconn,
5942 const struct ofp_header *request, uint32_t group_id,
5943 void (*cb)(struct ofgroup *, struct ovs_list *replies))
5945 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5946 struct ofgroup *group;
5947 struct ovs_list replies;
5949 ofpmp_init(&replies, request);
5950 if (group_id == OFPG_ALL) {
5951 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5952 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5953 cb(group, &replies);
5955 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5957 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5958 cb(group, &replies);
5959 ofproto_group_unref(group);
5962 ofconn_send_replies(ofconn, &replies);
5966 handle_group_stats_request(struct ofconn *ofconn,
5967 const struct ofp_header *request)
5972 error = ofputil_decode_group_stats_request(request, &group_id);
5977 handle_group_request(ofconn, request, group_id, append_group_stats);
5982 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
5984 struct ofputil_group_desc gds;
5986 gds.group_id = group->group_id;
5987 gds.type = group->type;
5988 gds.props = group->props;
5990 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5994 handle_group_desc_stats_request(struct ofconn *ofconn,
5995 const struct ofp_header *request)
5997 handle_group_request(ofconn, request,
5998 ofputil_decode_group_desc_request(request),
6004 handle_group_features_stats_request(struct ofconn *ofconn,
6005 const struct ofp_header *request)
6007 struct ofproto *p = ofconn_get_ofproto(ofconn);
6010 msg = ofputil_encode_group_features_reply(&p->ogf, request);
6012 ofconn_send_reply(ofconn, msg);
6019 handle_queue_get_config_request(struct ofconn *ofconn,
6020 const struct ofp_header *oh)
6022 struct ofproto *p = ofconn_get_ofproto(ofconn);
6023 struct netdev_queue_dump queue_dump;
6024 struct ofport *ofport;
6025 unsigned int queue_id;
6026 struct ofpbuf *reply;
6027 struct smap details;
6031 error = ofputil_decode_queue_get_config_request(oh, &request);
6036 ofport = ofproto_get_port(p, request);
6038 return OFPERR_OFPQOFC_BAD_PORT;
6041 reply = ofputil_encode_queue_get_config_reply(oh);
6043 smap_init(&details);
6044 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
6045 struct ofputil_queue_config queue;
6047 /* None of the existing queues have compatible properties, so we
6048 * hard-code omitting min_rate and max_rate. */
6049 queue.queue_id = queue_id;
6050 queue.min_rate = UINT16_MAX;
6051 queue.max_rate = UINT16_MAX;
6052 ofputil_append_queue_get_config_reply(reply, &queue);
6054 smap_destroy(&details);
6056 ofconn_send_reply(ofconn, reply);
6062 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
6063 struct ofgroup **ofgroup)
6066 const long long int now = time_msec();
6068 if (gm->group_id > OFPG_MAX) {
6069 return OFPERR_OFPGMFC_INVALID_GROUP;
6071 if (gm->type > OFPGT11_FF) {
6072 return OFPERR_OFPGMFC_BAD_TYPE;
6075 *ofgroup = ofproto->ofproto_class->group_alloc();
6077 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
6078 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
6081 (*ofgroup)->ofproto = ofproto;
6082 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
6083 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
6084 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
6085 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
6086 ovs_refcount_init(&(*ofgroup)->ref_count);
6088 list_move(&(*ofgroup)->buckets, &gm->buckets);
6089 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
6090 list_size(&(*ofgroup)->buckets);
6092 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
6093 &gm->props, sizeof (struct ofputil_group_props));
6095 /* Construct called BEFORE any locks are held. */
6096 error = ofproto->ofproto_class->group_construct(*ofgroup);
6098 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
6099 ofproto->ofproto_class->group_dealloc(*ofgroup);
6104 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6105 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6108 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6110 struct ofgroup *ofgroup;
6113 /* Allocate new group and initialize it. */
6114 error = init_group(ofproto, gm, &ofgroup);
6119 /* We wrlock as late as possible to minimize the time we jam any other
6120 * threads: No visible state changes before acquiring the lock. */
6121 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6123 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6124 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6128 if (ofproto_group_exists__(ofproto, gm->group_id)) {
6129 error = OFPERR_OFPGMFC_GROUP_EXISTS;
6134 /* Insert new group. */
6135 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
6136 hash_int(ofgroup->group_id, 0));
6137 ofproto->n_groups[ofgroup->type]++;
6139 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6144 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6145 ofproto->ofproto_class->group_destruct(ofgroup);
6146 ofputil_bucket_list_destroy(&ofgroup->buckets);
6147 ofproto->ofproto_class->group_dealloc(ofgroup);
6152 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6153 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6154 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6155 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6158 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6159 struct ofgroup *new_ofgroup,
6160 uint32_t command_bucket_id)
6162 struct ofputil_bucket *last = NULL;
6164 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6165 /* Check here to ensure that a bucket corresponding to
6166 * command_bucket_id exists in the old bucket list.
6168 * The subsequent search of below of new_ofgroup covers
6169 * both buckets in the old bucket list and buckets added
6170 * by the insert buckets group mod message this function processes. */
6171 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6172 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6175 if (!list_is_empty(&new_ofgroup->buckets)) {
6176 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6180 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6182 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6183 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6184 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6187 /* Rearrange list according to command_bucket_id */
6188 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6189 struct ofputil_bucket *new_first;
6190 const struct ofputil_bucket *first;
6192 first = ofputil_bucket_list_front(&ofgroup->buckets);
6193 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6196 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6197 &new_ofgroup->buckets);
6198 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6199 struct ofputil_bucket *after;
6201 /* Presence of bucket is checked above so after should never be NULL */
6202 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6204 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6205 last->list_node.next);
6211 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6212 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6213 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6214 * and OFPG15_BUCKET_ALL are also honored. */
6216 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6217 struct ofgroup *new_ofgroup,
6218 uint32_t command_bucket_id)
6220 const struct ofputil_bucket *skip = NULL;
6222 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6226 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6227 if (!list_is_empty(&ofgroup->buckets)) {
6228 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6230 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6231 if (!list_is_empty(&ofgroup->buckets)) {
6232 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6235 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6237 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6241 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6246 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6247 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6250 * Note that the group is re-created and then replaces the old group in
6251 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6252 * the xlate module hold a pointer to the group. */
6254 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6256 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6259 error = init_group(ofproto, gm, &new_ofgroup);
6264 retiring = new_ofgroup;
6266 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6267 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6268 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6272 /* Ofproto's group write lock is held now. */
6273 if (ofgroup->type != gm->type
6274 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6275 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6279 /* Manipulate bucket list for bucket commands */
6280 if (gm->command == OFPGC15_INSERT_BUCKET) {
6281 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6282 gm->command_bucket_id);
6283 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6284 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6285 gm->command_bucket_id);
6291 /* The group creation time does not change during modification. */
6292 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6293 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6295 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6301 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6302 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6303 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6304 hash_int(new_ofgroup->group_id, 0));
6305 if (ofgroup->type != new_ofgroup->type) {
6306 ofproto->n_groups[ofgroup->type]--;
6307 ofproto->n_groups[new_ofgroup->type]++;
6311 ofproto_group_unref(retiring);
6312 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6317 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6318 OVS_RELEASES(ofproto->groups_rwlock)
6321 struct ofputil_flow_mod fm;
6323 /* Delete all flow entries containing this group in a group action */
6324 match_init_catchall(&match);
6325 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6326 fm.delete_reason = OFPRR_GROUP_DELETE;
6327 fm.out_group = ofgroup->group_id;
6328 handle_flow_mod__(ofproto, &fm, NULL);
6330 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6331 /* No-one can find this group any more. */
6332 ofproto->n_groups[ofgroup->type]--;
6333 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6334 ofproto_group_unref(ofgroup);
6337 /* Implements OFPGC11_DELETE. */
6339 delete_group(struct ofproto *ofproto, uint32_t group_id)
6341 struct ofgroup *ofgroup;
6343 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6344 if (group_id == OFPG_ALL) {
6346 struct hmap_node *node = hmap_first(&ofproto->groups);
6350 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6351 delete_group__(ofproto, ofgroup);
6352 /* Lock for each node separately, so that we will not jam the
6353 * other threads for too long time. */
6354 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6357 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6358 hash_int(group_id, 0), &ofproto->groups) {
6359 if (ofgroup->group_id == group_id) {
6360 delete_group__(ofproto, ofgroup);
6365 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6369 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6371 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6372 struct ofputil_group_mod gm;
6375 error = reject_slave_controller(ofconn);
6380 error = ofputil_decode_group_mod(oh, &gm);
6385 switch (gm.command) {
6387 return add_group(ofproto, &gm);
6389 case OFPGC11_MODIFY:
6390 return modify_group(ofproto, &gm);
6392 case OFPGC11_DELETE:
6393 delete_group(ofproto, gm.group_id);
6396 case OFPGC15_INSERT_BUCKET:
6397 return modify_group(ofproto, &gm);
6399 case OFPGC15_REMOVE_BUCKET:
6400 return modify_group(ofproto, &gm);
6403 if (gm.command > OFPGC11_DELETE) {
6404 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6405 ofproto->name, gm.command);
6407 return OFPERR_OFPGMFC_BAD_COMMAND;
6411 enum ofputil_table_miss
6412 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6414 enum ofputil_table_miss value;
6416 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6421 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6423 if (!check_table_id(ofproto, tm->table_id)) {
6424 return OFPERR_OFPTMFC_BAD_TABLE;
6425 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6426 if (tm->table_id == OFPTT_ALL) {
6428 for (i = 0; i < ofproto->n_tables; i++) {
6429 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6433 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6441 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6443 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6444 struct ofputil_table_mod tm;
6447 error = reject_slave_controller(ofconn);
6452 error = ofputil_decode_table_mod(oh, &tm);
6457 return table_mod(ofproto, &tm);
6461 do_bundle_flow_mod_start(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6462 struct ofp_bundle_entry *be)
6463 OVS_REQUIRES(ofproto_mutex)
6465 switch (fm->command) {
6467 return add_flow_start(ofproto, fm, &be->rule, &be->modify);
6470 return modify_flows_start_loose(ofproto, fm, &be->rules);
6472 case OFPFC_MODIFY_STRICT:
6473 return modify_flow_start_strict(ofproto, fm, &be->rules);
6476 return delete_flows_start_loose(ofproto, fm, &be->rules);
6478 case OFPFC_DELETE_STRICT:
6479 return delete_flow_start_strict(ofproto, fm, &be->rules);
6482 return OFPERR_OFPFMFC_BAD_COMMAND;
6486 do_bundle_flow_mod_revert(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6487 struct ofp_bundle_entry *be)
6488 OVS_REQUIRES(ofproto_mutex)
6490 switch (fm->command) {
6492 add_flow_revert(ofproto, be->modify ? NULL : be->rule);
6496 case OFPFC_MODIFY_STRICT:
6497 modify_flows_revert(ofproto, &be->rules);
6501 case OFPFC_DELETE_STRICT:
6502 delete_flows_revert(&be->rules);
6511 do_bundle_flow_mod_finish(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
6512 const struct flow_mod_requester *req,
6513 struct ofp_bundle_entry *be)
6514 OVS_REQUIRES(ofproto_mutex)
6516 switch (fm->command) {
6518 add_flow_finish(ofproto, fm, req, be->rule, be->modify);
6522 case OFPFC_MODIFY_STRICT:
6523 modify_flows_finish(ofproto, fm, req, &be->rules);
6527 case OFPFC_DELETE_STRICT:
6528 delete_flows_finish(fm, req, &be->rules);
6537 do_bundle_commit(struct ofconn *ofconn, uint32_t id, uint16_t flags)
6539 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6540 struct ofp_bundle *bundle;
6541 struct ofp_bundle_entry *be;
6544 bundle = ofconn_get_bundle(ofconn, id);
6547 return OFPERR_OFPBFC_BAD_ID;
6549 if (bundle->flags != flags) {
6550 error = OFPERR_OFPBFC_BAD_FLAGS;
6553 ovs_mutex_lock(&ofproto_mutex);
6554 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6555 if (be->type == OFPTYPE_PORT_MOD) {
6556 /* Not supported yet. */
6557 error = OFPERR_OFPBFC_MSG_FAILED;
6558 } else if (be->type == OFPTYPE_FLOW_MOD) {
6559 error = do_bundle_flow_mod_start(ofproto, &be->fm, be);
6568 /* Send error referring to the original message. */
6570 ofconn_send_error(ofconn, be->ofp_msg, error);
6571 error = OFPERR_OFPBFC_MSG_FAILED;
6574 /* Revert all previous entires. */
6575 LIST_FOR_EACH_REVERSE_CONTINUE(be, node, &bundle->msg_list) {
6576 if (be->type == OFPTYPE_FLOW_MOD) {
6577 do_bundle_flow_mod_revert(ofproto, &be->fm, be);
6581 /* Finish the changes. */
6582 LIST_FOR_EACH (be, node, &bundle->msg_list) {
6583 if (be->type == OFPTYPE_FLOW_MOD) {
6584 struct flow_mod_requester req = { ofconn, be->ofp_msg };
6586 do_bundle_flow_mod_finish(ofproto, &be->fm, &req, be);
6590 ofmonitor_flush(ofproto->connmgr);
6591 ovs_mutex_unlock(&ofproto_mutex);
6593 run_rule_executes(ofproto);
6596 /* The bundle is discarded regardless the outcome. */
6597 ofp_bundle_remove__(ofconn, bundle, !error);
6602 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6604 struct ofputil_bundle_ctrl_msg bctrl;
6605 struct ofputil_bundle_ctrl_msg reply;
6609 error = reject_slave_controller(ofconn);
6614 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6618 /* Atomic updates not supported yet. */
6619 if (bctrl.flags & OFPBF_ATOMIC) {
6620 return OFPERR_OFPBFC_BAD_FLAGS;
6623 reply.bundle_id = bctrl.bundle_id;
6625 switch (bctrl.type) {
6626 case OFPBCT_OPEN_REQUEST:
6627 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6628 reply.type = OFPBCT_OPEN_REPLY;
6630 case OFPBCT_CLOSE_REQUEST:
6631 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6632 reply.type = OFPBCT_CLOSE_REPLY;;
6634 case OFPBCT_COMMIT_REQUEST:
6635 error = do_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6636 reply.type = OFPBCT_COMMIT_REPLY;
6638 case OFPBCT_DISCARD_REQUEST:
6639 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6640 reply.type = OFPBCT_DISCARD_REPLY;
6643 case OFPBCT_OPEN_REPLY:
6644 case OFPBCT_CLOSE_REPLY:
6645 case OFPBCT_COMMIT_REPLY:
6646 case OFPBCT_DISCARD_REPLY:
6647 return OFPERR_OFPBFC_BAD_TYPE;
6652 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6653 ofconn_send_reply(ofconn, buf);
6659 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6661 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6663 struct ofputil_bundle_add_msg badd;
6664 struct ofp_bundle_entry *bmsg;
6667 error = reject_slave_controller(ofconn);
6672 error = ofputil_decode_bundle_add(oh, &badd, &type);
6677 bmsg = ofp_bundle_entry_alloc(type, badd.msg);
6679 if (type == OFPTYPE_PORT_MOD) {
6680 error = ofputil_decode_port_mod(badd.msg, &bmsg->pm, false);
6681 } else if (type == OFPTYPE_FLOW_MOD) {
6682 struct ofpbuf ofpacts;
6683 uint64_t ofpacts_stub[1024 / 8];
6685 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6686 error = ofputil_decode_flow_mod(&bmsg->fm, badd.msg,
6687 ofconn_get_protocol(ofconn),
6689 u16_to_ofp(ofproto->max_ports),
6691 /* Move actions to heap. */
6692 bmsg->fm.ofpacts = ofpbuf_steal_data(&ofpacts);
6694 if (!error && bmsg->fm.ofpacts_len) {
6695 error = ofproto_check_ofpacts(ofproto, bmsg->fm.ofpacts,
6696 bmsg->fm.ofpacts_len);
6703 error = ofp_bundle_add_message(ofconn, badd.bundle_id, badd.flags,
6708 ofp_bundle_entry_free(bmsg);
6715 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6716 OVS_EXCLUDED(ofproto_mutex)
6718 const struct ofp_header *oh = msg->data;
6722 error = ofptype_decode(&type, oh);
6726 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6727 && ofpmp_more(oh)) {
6728 /* We have no buffer implementation for multipart requests.
6729 * Report overflow for requests which consists of multiple
6731 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6735 /* OpenFlow requests. */
6736 case OFPTYPE_ECHO_REQUEST:
6737 return handle_echo_request(ofconn, oh);
6739 case OFPTYPE_FEATURES_REQUEST:
6740 return handle_features_request(ofconn, oh);
6742 case OFPTYPE_GET_CONFIG_REQUEST:
6743 return handle_get_config_request(ofconn, oh);
6745 case OFPTYPE_SET_CONFIG:
6746 return handle_set_config(ofconn, oh);
6748 case OFPTYPE_PACKET_OUT:
6749 return handle_packet_out(ofconn, oh);
6751 case OFPTYPE_PORT_MOD:
6752 return handle_port_mod(ofconn, oh);
6754 case OFPTYPE_FLOW_MOD:
6755 return handle_flow_mod(ofconn, oh);
6757 case OFPTYPE_GROUP_MOD:
6758 return handle_group_mod(ofconn, oh);
6760 case OFPTYPE_TABLE_MOD:
6761 return handle_table_mod(ofconn, oh);
6763 case OFPTYPE_METER_MOD:
6764 return handle_meter_mod(ofconn, oh);
6766 case OFPTYPE_BARRIER_REQUEST:
6767 return handle_barrier_request(ofconn, oh);
6769 case OFPTYPE_ROLE_REQUEST:
6770 return handle_role_request(ofconn, oh);
6772 /* OpenFlow replies. */
6773 case OFPTYPE_ECHO_REPLY:
6776 /* Nicira extension requests. */
6777 case OFPTYPE_FLOW_MOD_TABLE_ID:
6778 return handle_nxt_flow_mod_table_id(ofconn, oh);
6780 case OFPTYPE_SET_FLOW_FORMAT:
6781 return handle_nxt_set_flow_format(ofconn, oh);
6783 case OFPTYPE_SET_PACKET_IN_FORMAT:
6784 return handle_nxt_set_packet_in_format(ofconn, oh);
6786 case OFPTYPE_SET_CONTROLLER_ID:
6787 return handle_nxt_set_controller_id(ofconn, oh);
6789 case OFPTYPE_FLOW_AGE:
6790 /* Nothing to do. */
6793 case OFPTYPE_FLOW_MONITOR_CANCEL:
6794 return handle_flow_monitor_cancel(ofconn, oh);
6796 case OFPTYPE_SET_ASYNC_CONFIG:
6797 return handle_nxt_set_async_config(ofconn, oh);
6799 case OFPTYPE_GET_ASYNC_REQUEST:
6800 return handle_nxt_get_async_request(ofconn, oh);
6802 /* Statistics requests. */
6803 case OFPTYPE_DESC_STATS_REQUEST:
6804 return handle_desc_stats_request(ofconn, oh);
6806 case OFPTYPE_FLOW_STATS_REQUEST:
6807 return handle_flow_stats_request(ofconn, oh);
6809 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6810 return handle_aggregate_stats_request(ofconn, oh);
6812 case OFPTYPE_TABLE_STATS_REQUEST:
6813 return handle_table_stats_request(ofconn, oh);
6815 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6816 return handle_table_features_request(ofconn, oh);
6818 case OFPTYPE_PORT_STATS_REQUEST:
6819 return handle_port_stats_request(ofconn, oh);
6821 case OFPTYPE_QUEUE_STATS_REQUEST:
6822 return handle_queue_stats_request(ofconn, oh);
6824 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6825 return handle_port_desc_stats_request(ofconn, oh);
6827 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6828 return handle_flow_monitor_request(ofconn, oh);
6830 case OFPTYPE_METER_STATS_REQUEST:
6831 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6832 return handle_meter_request(ofconn, oh, type);
6834 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6835 return handle_meter_features_request(ofconn, oh);
6837 case OFPTYPE_GROUP_STATS_REQUEST:
6838 return handle_group_stats_request(ofconn, oh);
6840 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6841 return handle_group_desc_stats_request(ofconn, oh);
6843 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6844 return handle_group_features_stats_request(ofconn, oh);
6846 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6847 return handle_queue_get_config_request(ofconn, oh);
6849 case OFPTYPE_BUNDLE_CONTROL:
6850 return handle_bundle_control(ofconn, oh);
6852 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6853 return handle_bundle_add(ofconn, oh);
6857 case OFPTYPE_FEATURES_REPLY:
6858 case OFPTYPE_GET_CONFIG_REPLY:
6859 case OFPTYPE_PACKET_IN:
6860 case OFPTYPE_FLOW_REMOVED:
6861 case OFPTYPE_PORT_STATUS:
6862 case OFPTYPE_BARRIER_REPLY:
6863 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6864 case OFPTYPE_DESC_STATS_REPLY:
6865 case OFPTYPE_FLOW_STATS_REPLY:
6866 case OFPTYPE_QUEUE_STATS_REPLY:
6867 case OFPTYPE_PORT_STATS_REPLY:
6868 case OFPTYPE_TABLE_STATS_REPLY:
6869 case OFPTYPE_AGGREGATE_STATS_REPLY:
6870 case OFPTYPE_PORT_DESC_STATS_REPLY:
6871 case OFPTYPE_ROLE_REPLY:
6872 case OFPTYPE_FLOW_MONITOR_PAUSED:
6873 case OFPTYPE_FLOW_MONITOR_RESUMED:
6874 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6875 case OFPTYPE_GET_ASYNC_REPLY:
6876 case OFPTYPE_GROUP_STATS_REPLY:
6877 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6878 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6879 case OFPTYPE_METER_STATS_REPLY:
6880 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6881 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6882 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6883 case OFPTYPE_ROLE_STATUS:
6885 if (ofpmsg_is_stat_request(oh)) {
6886 return OFPERR_OFPBRC_BAD_STAT;
6888 return OFPERR_OFPBRC_BAD_TYPE;
6894 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6895 OVS_EXCLUDED(ofproto_mutex)
6897 enum ofperr error = handle_openflow__(ofconn, ofp_msg);
6900 ofconn_send_error(ofconn, ofp_msg->data, error);
6902 COVERAGE_INC(ofproto_recv_openflow);
6905 /* Asynchronous operations. */
6908 send_buffered_packet(const struct flow_mod_requester *req, uint32_t buffer_id,
6910 OVS_REQUIRES(ofproto_mutex)
6912 if (req && req->ofconn && buffer_id != UINT32_MAX) {
6913 struct ofproto *ofproto = ofconn_get_ofproto(req->ofconn);
6914 struct dp_packet *packet;
6918 error = ofconn_pktbuf_retrieve(req->ofconn, buffer_id, &packet,
6921 struct rule_execute *re;
6923 ofproto_rule_ref(rule);
6925 re = xmalloc(sizeof *re);
6927 re->in_port = in_port;
6928 re->packet = packet;
6930 if (!guarded_list_push_back(&ofproto->rule_executes,
6931 &re->list_node, 1024)) {
6932 ofproto_rule_unref(rule);
6933 dp_packet_delete(re->packet);
6937 ofconn_send_error(req->ofconn, req->request, error);
6943 pick_datapath_id(const struct ofproto *ofproto)
6945 const struct ofport *port;
6947 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6949 uint8_t ea[ETH_ADDR_LEN];
6952 error = netdev_get_etheraddr(port->netdev, ea);
6954 return eth_addr_to_uint64(ea);
6956 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6957 ofproto->name, netdev_get_name(port->netdev),
6958 ovs_strerror(error));
6960 return ofproto->fallback_dpid;
6964 pick_fallback_dpid(void)
6966 uint8_t ea[ETH_ADDR_LEN];
6967 eth_addr_nicira_random(ea);
6968 return eth_addr_to_uint64(ea);
6971 /* Table overflow policy. */
6973 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6974 * to NULL if the table is not configured to evict rules or if the table
6975 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6976 * or with no timeouts are not evictable.) */
6978 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6979 OVS_REQUIRES(ofproto_mutex)
6981 struct eviction_group *evg;
6984 if (!table->eviction_fields) {
6988 /* In the common case, the outer and inner loops here will each be entered
6991 * - The inner loop normally "return"s in its first iteration. If the
6992 * eviction group has any evictable rules, then it always returns in
6995 * - The outer loop only iterates more than once if the largest eviction
6996 * group has no evictable rules.
6998 * - The outer loop can exit only if table's 'max_flows' is all filled up
6999 * by unevictable rules. */
7000 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
7003 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
7012 /* Eviction groups. */
7014 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7015 * rules. The priority contains low-order random bits to ensure that eviction
7016 * groups with the same number of rules are prioritized randomly. */
7018 eviction_group_priority(size_t n_rules)
7020 uint16_t size = MIN(UINT16_MAX, n_rules);
7021 return (size << 16) | random_uint16();
7024 /* Updates 'evg', an eviction_group within 'table', following a change that
7025 * adds or removes rules in 'evg'. */
7027 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
7028 OVS_REQUIRES(ofproto_mutex)
7030 heap_change(&table->eviction_groups_by_size, &evg->size_node,
7031 eviction_group_priority(heap_count(&evg->rules)));
7034 /* Destroys 'evg', an eviction_group within 'table':
7036 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7037 * rules themselves, just removes them from the eviction group.)
7039 * - Removes 'evg' from 'table'.
7043 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
7044 OVS_REQUIRES(ofproto_mutex)
7046 while (!heap_is_empty(&evg->rules)) {
7049 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
7050 rule->eviction_group = NULL;
7052 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
7053 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
7054 heap_destroy(&evg->rules);
7058 /* Removes 'rule' from its eviction group, if any. */
7060 eviction_group_remove_rule(struct rule *rule)
7061 OVS_REQUIRES(ofproto_mutex)
7063 if (rule->eviction_group) {
7064 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7065 struct eviction_group *evg = rule->eviction_group;
7067 rule->eviction_group = NULL;
7068 heap_remove(&evg->rules, &rule->evg_node);
7069 if (heap_is_empty(&evg->rules)) {
7070 eviction_group_destroy(table, evg);
7072 eviction_group_resized(table, evg);
7077 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7078 * returns the hash value. */
7080 eviction_group_hash_rule(struct rule *rule)
7081 OVS_REQUIRES(ofproto_mutex)
7083 struct oftable *table = &rule->ofproto->tables[rule->table_id];
7084 const struct mf_subfield *sf;
7088 hash = table->eviction_group_id_basis;
7089 miniflow_expand(&rule->cr.match.flow, &flow);
7090 for (sf = table->eviction_fields;
7091 sf < &table->eviction_fields[table->n_eviction_fields];
7094 if (mf_are_prereqs_ok(sf->field, &flow)) {
7095 union mf_value value;
7097 mf_get_value(sf->field, &flow, &value);
7099 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
7101 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
7102 unsigned int start = sf->ofs + sf->n_bits;
7103 bitwise_zero(&value, sf->field->n_bytes, start,
7104 sf->field->n_bytes * 8 - start);
7106 hash = hash_bytes(&value, sf->field->n_bytes, hash);
7108 hash = hash_int(hash, 0);
7115 /* Returns an eviction group within 'table' with the given 'id', creating one
7117 static struct eviction_group *
7118 eviction_group_find(struct oftable *table, uint32_t id)
7119 OVS_REQUIRES(ofproto_mutex)
7121 struct eviction_group *evg;
7123 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
7127 evg = xmalloc(sizeof *evg);
7128 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
7129 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
7130 eviction_group_priority(0));
7131 heap_init(&evg->rules);
7136 /* Returns an eviction priority for 'rule'. The return value should be
7137 * interpreted so that higher priorities make a rule more attractive candidates
7139 * Called only if have a timeout. */
7141 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
7142 OVS_REQUIRES(ofproto_mutex)
7144 long long int expiration = LLONG_MAX;
7145 long long int modified;
7146 uint32_t expiration_offset;
7148 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7149 ovs_mutex_lock(&rule->mutex);
7150 modified = rule->modified;
7151 ovs_mutex_unlock(&rule->mutex);
7153 if (rule->hard_timeout) {
7154 expiration = modified + rule->hard_timeout * 1000;
7156 if (rule->idle_timeout) {
7157 uint64_t packets, bytes;
7159 long long int idle_expiration;
7161 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
7162 idle_expiration = used + rule->idle_timeout * 1000;
7163 expiration = MIN(expiration, idle_expiration);
7166 if (expiration == LLONG_MAX) {
7170 /* Calculate the time of expiration as a number of (approximate) seconds
7171 * after program startup.
7173 * This should work OK for program runs that last UINT32_MAX seconds or
7174 * less. Therefore, please restart OVS at least once every 136 years. */
7175 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
7177 /* Invert the expiration offset because we're using a max-heap. */
7178 return UINT32_MAX - expiration_offset;
7181 /* Adds 'rule' to an appropriate eviction group for its oftable's
7182 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7183 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7186 * The caller must ensure that 'rule' is not already in an eviction group. */
7188 eviction_group_add_rule(struct rule *rule)
7189 OVS_REQUIRES(ofproto_mutex)
7191 struct ofproto *ofproto = rule->ofproto;
7192 struct oftable *table = &ofproto->tables[rule->table_id];
7195 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7196 * so no additional protection is needed. */
7197 has_timeout = rule->hard_timeout || rule->idle_timeout;
7199 if (table->eviction_fields && has_timeout) {
7200 struct eviction_group *evg;
7202 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
7204 rule->eviction_group = evg;
7205 heap_insert(&evg->rules, &rule->evg_node,
7206 rule_eviction_priority(ofproto, rule));
7207 eviction_group_resized(table, evg);
7213 /* Initializes 'table'. */
7215 oftable_init(struct oftable *table)
7217 memset(table, 0, sizeof *table);
7218 classifier_init(&table->cls, flow_segment_u64s);
7219 table->max_flows = UINT_MAX;
7220 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
7222 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
7223 ARRAY_SIZE(default_prefix_fields));
7225 atomic_init(&table->n_matched, 0);
7226 atomic_init(&table->n_missed, 0);
7229 /* Destroys 'table', including its classifier and eviction groups.
7231 * The caller is responsible for freeing 'table' itself. */
7233 oftable_destroy(struct oftable *table)
7235 ovs_assert(classifier_is_empty(&table->cls));
7236 oftable_disable_eviction(table);
7237 classifier_destroy(&table->cls);
7241 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7242 * string, then 'table' will use its default name.
7244 * This only affects the name exposed for a table exposed through the OpenFlow
7245 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7247 oftable_set_name(struct oftable *table, const char *name)
7249 if (name && name[0]) {
7250 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
7251 if (!table->name || strncmp(name, table->name, len)) {
7253 table->name = xmemdup0(name, len);
7261 /* oftables support a choice of two policies when adding a rule would cause the
7262 * number of flows in the table to exceed the configured maximum number: either
7263 * they can refuse to add the new flow or they can evict some existing flow.
7264 * This function configures the former policy on 'table'. */
7266 oftable_disable_eviction(struct oftable *table)
7267 OVS_REQUIRES(ofproto_mutex)
7269 if (table->eviction_fields) {
7270 struct eviction_group *evg, *next;
7272 HMAP_FOR_EACH_SAFE (evg, next, id_node,
7273 &table->eviction_groups_by_id) {
7274 eviction_group_destroy(table, evg);
7276 hmap_destroy(&table->eviction_groups_by_id);
7277 heap_destroy(&table->eviction_groups_by_size);
7279 free(table->eviction_fields);
7280 table->eviction_fields = NULL;
7281 table->n_eviction_fields = 0;
7285 /* oftables support a choice of two policies when adding a rule would cause the
7286 * number of flows in the table to exceed the configured maximum number: either
7287 * they can refuse to add the new flow or they can evict some existing flow.
7288 * This function configures the latter policy on 'table', with fairness based
7289 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7290 * 'n_fields' as 0 disables fairness.) */
7292 oftable_enable_eviction(struct oftable *table,
7293 const struct mf_subfield *fields, size_t n_fields)
7294 OVS_REQUIRES(ofproto_mutex)
7298 if (table->eviction_fields
7299 && n_fields == table->n_eviction_fields
7301 || !memcmp(fields, table->eviction_fields,
7302 n_fields * sizeof *fields))) {
7307 oftable_disable_eviction(table);
7309 table->n_eviction_fields = n_fields;
7310 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
7312 table->eviction_group_id_basis = random_uint32();
7313 hmap_init(&table->eviction_groups_by_id);
7314 heap_init(&table->eviction_groups_by_size);
7316 CLS_FOR_EACH (rule, cr, &table->cls) {
7317 eviction_group_add_rule(rule);
7321 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7322 * it to the classifier. */
7324 ofproto_rule_insert__(struct ofproto *ofproto, struct rule *rule)
7325 OVS_REQUIRES(ofproto_mutex)
7327 const struct rule_actions *actions = rule_get_actions(rule);
7329 if (rule->hard_timeout || rule->idle_timeout) {
7330 list_insert(&ofproto->expirable, &rule->expirable);
7332 cookies_insert(ofproto, rule);
7333 eviction_group_add_rule(rule);
7334 if (actions->has_meter) {
7335 meter_insert_rule(rule);
7339 /* Removes 'rule' from the ofproto data structures AFTER caller has removed
7340 * it from the classifier. */
7342 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
7343 OVS_REQUIRES(ofproto_mutex)
7345 cookies_remove(ofproto, rule);
7347 eviction_group_remove_rule(rule);
7348 if (!list_is_empty(&rule->expirable)) {
7349 list_remove(&rule->expirable);
7351 if (!list_is_empty(&rule->meter_list_node)) {
7352 list_remove(&rule->meter_list_node);
7353 list_init(&rule->meter_list_node);
7358 oftable_remove_rule(struct rule *rule)
7359 OVS_REQUIRES(ofproto_mutex)
7361 struct classifier *cls = &rule->ofproto->tables[rule->table_id].cls;
7363 if (classifier_remove(cls, &rule->cr)) {
7364 ofproto_rule_remove__(rule->ofproto, rule);
7370 /* unixctl commands. */
7373 ofproto_lookup(const char *name)
7375 struct ofproto *ofproto;
7377 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7379 if (!strcmp(ofproto->name, name)) {
7387 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7388 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7390 struct ofproto *ofproto;
7394 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7395 ds_put_format(&results, "%s\n", ofproto->name);
7397 unixctl_command_reply(conn, ds_cstr(&results));
7398 ds_destroy(&results);
7402 ofproto_unixctl_init(void)
7404 static bool registered;
7410 unixctl_command_register("ofproto/list", "", 0, 0,
7411 ofproto_unixctl_list, NULL);
7414 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7416 * This is deprecated. It is only for compatibility with broken device drivers
7417 * in old versions of Linux that do not properly support VLANs when VLAN
7418 * devices are not used. When broken device drivers are no longer in
7419 * widespread use, we will delete these interfaces. */
7421 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7422 * (exactly) by an OpenFlow rule in 'ofproto'. */
7424 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7427 struct cls_rule target;
7428 const struct oftable *oftable;
7430 match_init_catchall(&match);
7431 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7432 cls_rule_init(&target, &match, 0, CLS_MAX_VERSION);
7434 free(ofproto->vlan_bitmap);
7435 ofproto->vlan_bitmap = bitmap_allocate(4096);
7436 ofproto->vlans_changed = false;
7438 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7441 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7442 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7443 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7445 bitmap_set1(vlan_bitmap, vid);
7446 bitmap_set1(ofproto->vlan_bitmap, vid);
7451 cls_rule_destroy(&target);
7454 /* Returns true if new VLANs have come into use by the flow table since the
7455 * last call to ofproto_get_vlan_usage().
7457 * We don't track when old VLANs stop being used. */
7459 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7461 return ofproto->vlans_changed;
7464 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7465 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7466 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7467 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7468 * then the VLAN device is un-enslaved. */
7470 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7471 ofp_port_t realdev_ofp_port, int vid)
7473 struct ofport *ofport;
7476 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7478 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7480 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7481 ofproto->name, vlandev_ofp_port);
7485 if (!ofproto->ofproto_class->set_realdev) {
7486 if (!vlandev_ofp_port) {
7489 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7493 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7495 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7496 ofproto->name, vlandev_ofp_port,
7497 netdev_get_name(ofport->netdev), ovs_strerror(error));