2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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"
50 #include "poll-loop.h"
58 #include "unaligned.h"
63 VLOG_DEFINE_THIS_MODULE(ofproto);
65 COVERAGE_DEFINE(ofproto_flush);
66 COVERAGE_DEFINE(ofproto_packet_out);
67 COVERAGE_DEFINE(ofproto_queue_req);
68 COVERAGE_DEFINE(ofproto_recv_openflow);
69 COVERAGE_DEFINE(ofproto_reinit_ports);
70 COVERAGE_DEFINE(ofproto_update_port);
72 /* Default fields to use for prefix tries in each flow table, unless something
73 * else is configured. */
74 const enum mf_field_id default_prefix_fields[2] =
75 { MFF_IPV4_DST, MFF_IPV4_SRC };
78 static void oftable_init(struct oftable *);
79 static void oftable_destroy(struct oftable *);
81 static void oftable_set_name(struct oftable *, const char *name);
83 static enum ofperr evict_rules_from_table(struct oftable *,
84 unsigned int extra_space)
85 OVS_REQUIRES(ofproto_mutex);
86 static void oftable_disable_eviction(struct oftable *);
87 static void oftable_enable_eviction(struct oftable *,
88 const struct mf_subfield *fields,
91 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
92 static void oftable_remove_rule__(struct ofproto *, struct rule *)
93 OVS_REQUIRES(ofproto_mutex);
95 /* A set of rules within a single OpenFlow table (oftable) that have the same
96 * values for the oftable's eviction_fields. A rule to be evicted, when one is
97 * needed, is taken from the eviction group that contains the greatest number
100 * An oftable owns any number of eviction groups, each of which contains any
103 * Membership in an eviction group is imprecise, based on the hash of the
104 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
105 * That is, if two rules have different eviction_fields, but those
106 * eviction_fields hash to the same value, then they will belong to the same
107 * eviction_group anyway.
109 * (When eviction is not enabled on an oftable, we don't track any eviction
110 * groups, to save time and space.) */
111 struct eviction_group {
112 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
113 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
114 struct heap rules; /* Contains "struct rule"s. */
117 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
118 OVS_REQUIRES(ofproto_mutex);
119 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *)
120 OVS_REQUIRES(ofproto_mutex);;
121 static void eviction_group_add_rule(struct rule *)
122 OVS_REQUIRES(ofproto_mutex);
123 static void eviction_group_remove_rule(struct rule *)
124 OVS_REQUIRES(ofproto_mutex);
126 /* Criteria that flow_mod and other operations use for selecting rules on
127 * which to operate. */
128 struct rule_criteria {
129 /* An OpenFlow table or 255 for all tables. */
132 /* OpenFlow matching criteria. Interpreted different in "loose" way by
133 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
134 * defined in the OpenFlow spec. */
137 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
138 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
139 * The rule will not be selected if M is 1 and B != C. */
141 ovs_be64 cookie_mask;
143 /* Selection based on actions within a rule:
145 * If out_port != OFPP_ANY, selects only rules that output to out_port.
146 * If out_group != OFPG_ALL, select only rules that output to out_group. */
150 /* If true, collects only rules that are modifiable. */
152 bool include_readonly;
155 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
156 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 list list_node; /* In struct ofproto's "rule_executes" list. */
173 struct rule *rule; /* Owns a reference to the rule. */
175 struct ofpbuf *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 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 list *dead_cookies)
208 OVS_REQUIRES(ofproto_mutex);
209 static void learned_cookies_flush(struct ofproto *, struct 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 *);
241 /* The source of a flow_mod request, in the code that processes flow_mods.
243 * A flow table modification request can be generated externally, via OpenFlow,
244 * or internally through a function call. This structure indicates the source
245 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
246 * meaningful and thus supplied as NULL. */
247 struct flow_mod_requester {
248 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
249 ovs_be32 xid; /* OpenFlow xid of flow_mod request. */
253 static enum ofperr add_flow(struct ofproto *, struct ofputil_flow_mod *,
254 const struct flow_mod_requester *);
256 static enum ofperr modify_flows__(struct ofproto *, struct ofputil_flow_mod *,
257 const struct rule_collection *,
258 const struct flow_mod_requester *);
259 static void delete_flows__(const struct rule_collection *,
260 enum ofp_flow_removed_reason,
261 const struct flow_mod_requester *)
262 OVS_REQUIRES(ofproto_mutex);
264 static enum ofperr send_buffered_packet(struct ofconn *, uint32_t buffer_id,
266 OVS_REQUIRES(ofproto_mutex);
268 static bool ofproto_group_exists__(const struct ofproto *ofproto,
270 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
271 static bool ofproto_group_exists(const struct ofproto *ofproto,
273 OVS_EXCLUDED(ofproto->groups_rwlock);
274 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
275 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
276 static enum ofperr handle_flow_mod__(struct ofproto *,
277 struct ofputil_flow_mod *,
278 const struct flow_mod_requester *)
279 OVS_EXCLUDED(ofproto_mutex);
280 static void calc_duration(long long int start, long long int now,
281 uint32_t *sec, uint32_t *nsec);
284 static uint64_t pick_datapath_id(const struct ofproto *);
285 static uint64_t pick_fallback_dpid(void);
286 static void ofproto_destroy__(struct ofproto *);
287 static void update_mtu(struct ofproto *, struct ofport *);
288 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
289 static void meter_insert_rule(struct rule *);
292 static void ofproto_unixctl_init(void);
294 /* All registered ofproto classes, in probe order. */
295 static const struct ofproto_class **ofproto_classes;
296 static size_t n_ofproto_classes;
297 static size_t allocated_ofproto_classes;
299 /* Global lock that protects all flow table operations. */
300 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
302 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
303 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
305 size_t n_handlers, n_revalidators;
309 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
310 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
312 /* Initial mappings of port to OpenFlow number mappings. */
313 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
315 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
317 /* The default value of true waits for flow restore. */
318 static bool flow_restore_wait = true;
320 /* Must be called to initialize the ofproto library.
322 * The caller may pass in 'iface_hints', which contains an shash of
323 * "iface_hint" elements indexed by the interface's name. The provider
324 * may use these hints to describe the startup configuration in order to
325 * reinitialize its state. The caller owns the provided data, so a
326 * provider will make copies of anything required. An ofproto provider
327 * will remove any existing state that is not described by the hint, and
328 * may choose to remove it all. */
330 ofproto_init(const struct shash *iface_hints)
332 struct shash_node *node;
335 ofproto_class_register(&ofproto_dpif_class);
337 /* Make a local copy, since we don't own 'iface_hints' elements. */
338 SHASH_FOR_EACH(node, iface_hints) {
339 const struct iface_hint *orig_hint = node->data;
340 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
341 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
343 new_hint->br_name = xstrdup(orig_hint->br_name);
344 new_hint->br_type = xstrdup(br_type);
345 new_hint->ofp_port = orig_hint->ofp_port;
347 shash_add(&init_ofp_ports, node->name, new_hint);
350 for (i = 0; i < n_ofproto_classes; i++) {
351 ofproto_classes[i]->init(&init_ofp_ports);
355 /* 'type' should be a normalized datapath type, as returned by
356 * ofproto_normalize_type(). Returns the corresponding ofproto_class
357 * structure, or a null pointer if there is none registered for 'type'. */
358 static const struct ofproto_class *
359 ofproto_class_find__(const char *type)
363 for (i = 0; i < n_ofproto_classes; i++) {
364 const struct ofproto_class *class = ofproto_classes[i];
369 class->enumerate_types(&types);
370 found = sset_contains(&types, type);
371 sset_destroy(&types);
377 VLOG_WARN("unknown datapath type %s", type);
381 /* Registers a new ofproto class. After successful registration, new ofprotos
382 * of that type can be created using ofproto_create(). */
384 ofproto_class_register(const struct ofproto_class *new_class)
388 for (i = 0; i < n_ofproto_classes; i++) {
389 if (ofproto_classes[i] == new_class) {
394 if (n_ofproto_classes >= allocated_ofproto_classes) {
395 ofproto_classes = x2nrealloc(ofproto_classes,
396 &allocated_ofproto_classes,
397 sizeof *ofproto_classes);
399 ofproto_classes[n_ofproto_classes++] = new_class;
403 /* Unregisters a datapath provider. 'type' must have been previously
404 * registered and not currently be in use by any ofprotos. After
405 * unregistration new datapaths of that type cannot be opened using
406 * ofproto_create(). */
408 ofproto_class_unregister(const struct ofproto_class *class)
412 for (i = 0; i < n_ofproto_classes; i++) {
413 if (ofproto_classes[i] == class) {
414 for (i++; i < n_ofproto_classes; i++) {
415 ofproto_classes[i - 1] = ofproto_classes[i];
421 VLOG_WARN("attempted to unregister an ofproto class that is not "
426 /* Clears 'types' and enumerates all registered ofproto types into it. The
427 * caller must first initialize the sset. */
429 ofproto_enumerate_types(struct sset *types)
434 for (i = 0; i < n_ofproto_classes; i++) {
435 ofproto_classes[i]->enumerate_types(types);
439 /* Returns the fully spelled out name for the given ofproto 'type'.
441 * Normalized type string can be compared with strcmp(). Unnormalized type
442 * string might be the same even if they have different spellings. */
444 ofproto_normalize_type(const char *type)
446 return type && type[0] ? type : "system";
449 /* Clears 'names' and enumerates the names of all known created ofprotos with
450 * the given 'type'. The caller must first initialize the sset. Returns 0 if
451 * successful, otherwise a positive errno value.
453 * Some kinds of datapaths might not be practically enumerable. This is not
454 * considered an error. */
456 ofproto_enumerate_names(const char *type, struct sset *names)
458 const struct ofproto_class *class = ofproto_class_find__(type);
459 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
463 ofproto_create(const char *datapath_name, const char *datapath_type,
464 struct ofproto **ofprotop)
466 const struct ofproto_class *class;
467 struct ofproto *ofproto;
473 ofproto_unixctl_init();
475 datapath_type = ofproto_normalize_type(datapath_type);
476 class = ofproto_class_find__(datapath_type);
478 VLOG_WARN("could not create datapath %s of unknown type %s",
479 datapath_name, datapath_type);
483 ofproto = class->alloc();
485 VLOG_ERR("failed to allocate datapath %s of type %s",
486 datapath_name, datapath_type);
491 ovs_mutex_lock(&ofproto_mutex);
492 memset(ofproto, 0, sizeof *ofproto);
493 ofproto->ofproto_class = class;
494 ofproto->name = xstrdup(datapath_name);
495 ofproto->type = xstrdup(datapath_type);
496 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
497 hash_string(ofproto->name, 0));
498 ofproto->datapath_id = 0;
499 ofproto->forward_bpdu = false;
500 ofproto->fallback_dpid = pick_fallback_dpid();
501 ofproto->mfr_desc = NULL;
502 ofproto->hw_desc = NULL;
503 ofproto->sw_desc = NULL;
504 ofproto->serial_desc = NULL;
505 ofproto->dp_desc = NULL;
506 ofproto->frag_handling = OFPC_FRAG_NORMAL;
507 hmap_init(&ofproto->ports);
508 hmap_init(&ofproto->ofport_usage);
509 shash_init(&ofproto->port_by_name);
510 simap_init(&ofproto->ofp_requests);
511 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
512 ofproto->eviction_group_timer = LLONG_MIN;
513 ofproto->tables = NULL;
514 ofproto->n_tables = 0;
515 hindex_init(&ofproto->cookies);
516 hmap_init(&ofproto->learned_cookies);
517 list_init(&ofproto->expirable);
518 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
519 guarded_list_init(&ofproto->rule_executes);
520 ofproto->vlan_bitmap = NULL;
521 ofproto->vlans_changed = false;
522 ofproto->min_mtu = INT_MAX;
523 ovs_rwlock_init(&ofproto->groups_rwlock);
524 hmap_init(&ofproto->groups);
525 ovs_mutex_unlock(&ofproto_mutex);
526 ofproto->ogf.types = 0xf;
527 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
528 OFPGFC_SELECT_WEIGHT;
529 for (i = 0; i < 4; i++) {
530 ofproto->ogf.max_groups[i] = OFPG_MAX;
531 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
534 error = ofproto->ofproto_class->construct(ofproto);
536 VLOG_ERR("failed to open datapath %s: %s",
537 datapath_name, ovs_strerror(error));
538 connmgr_destroy(ofproto->connmgr);
539 ofproto_destroy__(ofproto);
543 /* Check that hidden tables, if any, are at the end. */
544 ovs_assert(ofproto->n_tables);
545 for (i = 0; i + 1 < ofproto->n_tables; i++) {
546 enum oftable_flags flags = ofproto->tables[i].flags;
547 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
549 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
552 ofproto->datapath_id = pick_datapath_id(ofproto);
555 /* Initialize meters table. */
556 if (ofproto->ofproto_class->meter_get_features) {
557 ofproto->ofproto_class->meter_get_features(ofproto,
558 &ofproto->meter_features);
560 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
562 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
563 * sizeof(struct meter *));
569 /* Must be called (only) by an ofproto implementation in its constructor
570 * function. See the large comment on 'construct' in struct ofproto_class for
573 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
575 struct oftable *table;
577 ovs_assert(!ofproto->n_tables);
578 ovs_assert(n_tables >= 1 && n_tables <= 255);
580 ofproto->n_tables = n_tables;
581 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
582 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
587 /* To be optionally called (only) by an ofproto implementation in its
588 * constructor function. See the large comment on 'construct' in struct
589 * ofproto_class for details.
591 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
592 * will then ensure that actions passed into the ofproto implementation will
593 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
594 * function is not called, there will be no such restriction.
596 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
597 * the 'max_ports' restriction. */
599 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
601 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
602 ofproto->max_ports = max_ports;
606 ofproto_get_datapath_id(const struct ofproto *ofproto)
608 return ofproto->datapath_id;
612 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
614 uint64_t old_dpid = p->datapath_id;
615 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
616 if (p->datapath_id != old_dpid) {
617 /* Force all active connections to reconnect, since there is no way to
618 * notify a controller that the datapath ID has changed. */
619 ofproto_reconnect_controllers(p);
624 ofproto_set_controllers(struct ofproto *p,
625 const struct ofproto_controller *controllers,
626 size_t n_controllers, uint32_t allowed_versions)
628 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
633 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
635 connmgr_set_fail_mode(p->connmgr, fail_mode);
638 /* Drops the connections between 'ofproto' and all of its controllers, forcing
639 * them to reconnect. */
641 ofproto_reconnect_controllers(struct ofproto *ofproto)
643 connmgr_reconnect(ofproto->connmgr);
646 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
647 * in-band control should guarantee access, in the same way that in-band
648 * control guarantees access to OpenFlow controllers. */
650 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
651 const struct sockaddr_in *extras, size_t n)
653 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
656 /* Sets the OpenFlow queue used by flows set up by in-band control on
657 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
658 * flows will use the default queue. */
660 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
662 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
665 /* Sets the number of flows at which eviction from the kernel flow table
668 ofproto_set_flow_limit(unsigned limit)
670 ofproto_flow_limit = limit;
673 /* Sets the maximum idle time for flows in the datapath before they are
676 ofproto_set_max_idle(unsigned max_idle)
678 ofproto_max_idle = max_idle;
681 /* If forward_bpdu is true, the NORMAL action will forward frames with
682 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
683 * the NORMAL action will drop these frames. */
685 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
687 bool old_val = ofproto->forward_bpdu;
688 ofproto->forward_bpdu = forward_bpdu;
689 if (old_val != ofproto->forward_bpdu) {
690 if (ofproto->ofproto_class->forward_bpdu_changed) {
691 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
696 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
697 * 'idle_time', in seconds, and the maximum number of MAC table entries to
700 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
703 if (ofproto->ofproto_class->set_mac_table_config) {
704 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
709 /* Multicast snooping configuration. */
711 /* Configures multicast snooping on 'ofproto' using the settings
712 * defined in 's'. If 's' is NULL, disables multicast snooping.
714 * Returns 0 if successful, otherwise a positive errno value. */
716 ofproto_set_mcast_snooping(struct ofproto *ofproto,
717 const struct ofproto_mcast_snooping_settings *s)
719 return (ofproto->ofproto_class->set_mcast_snooping
720 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
724 /* Configures multicast snooping flood setting on 'ofp_port' of 'ofproto'.
726 * Returns 0 if successful, otherwise a positive errno value.*/
728 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux, bool flood)
730 return (ofproto->ofproto_class->set_mcast_snooping_port
731 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux,
737 ofproto_set_n_dpdk_rxqs(int n_rxqs)
739 n_dpdk_rxqs = MAX(n_rxqs, 0);
743 ofproto_set_cpu_mask(const char *cmask)
747 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
751 ofproto_set_threads(int n_handlers_, int n_revalidators_)
753 int threads = MAX(count_cpu_cores(), 2);
755 n_revalidators = MAX(n_revalidators_, 0);
756 n_handlers = MAX(n_handlers_, 0);
758 if (!n_revalidators) {
759 n_revalidators = n_handlers
760 ? MAX(threads - (int) n_handlers, 1)
765 n_handlers = MAX(threads - (int) n_revalidators, 1);
770 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
773 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
777 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
779 return connmgr_set_snoops(ofproto->connmgr, snoops);
783 ofproto_set_netflow(struct ofproto *ofproto,
784 const struct netflow_options *nf_options)
786 if (nf_options && sset_is_empty(&nf_options->collectors)) {
790 if (ofproto->ofproto_class->set_netflow) {
791 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
793 return nf_options ? EOPNOTSUPP : 0;
798 ofproto_set_sflow(struct ofproto *ofproto,
799 const struct ofproto_sflow_options *oso)
801 if (oso && sset_is_empty(&oso->targets)) {
805 if (ofproto->ofproto_class->set_sflow) {
806 return ofproto->ofproto_class->set_sflow(ofproto, oso);
808 return oso ? EOPNOTSUPP : 0;
813 ofproto_set_ipfix(struct ofproto *ofproto,
814 const struct ofproto_ipfix_bridge_exporter_options *bo,
815 const struct ofproto_ipfix_flow_exporter_options *fo,
818 if (ofproto->ofproto_class->set_ipfix) {
819 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
821 return (bo || fo) ? EOPNOTSUPP : 0;
826 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
828 flow_restore_wait = flow_restore_wait_db;
832 ofproto_get_flow_restore_wait(void)
834 return flow_restore_wait;
838 /* Spanning Tree Protocol (STP) configuration. */
840 /* Configures STP on 'ofproto' using the settings defined in 's'. If
841 * 's' is NULL, disables STP.
843 * Returns 0 if successful, otherwise a positive errno value. */
845 ofproto_set_stp(struct ofproto *ofproto,
846 const struct ofproto_stp_settings *s)
848 return (ofproto->ofproto_class->set_stp
849 ? ofproto->ofproto_class->set_stp(ofproto, s)
853 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
854 * 'enabled' member of 's' is false, then the other members are not
857 * Returns 0 if successful, otherwise a positive errno value. */
859 ofproto_get_stp_status(struct ofproto *ofproto,
860 struct ofproto_stp_status *s)
862 return (ofproto->ofproto_class->get_stp_status
863 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
867 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
868 * in 's'. The caller is responsible for assigning STP port numbers
869 * (using the 'port_num' member in the range of 1 through 255, inclusive)
870 * and ensuring there are no duplicates. If the 's' is NULL, then STP
871 * is disabled on the port.
873 * Returns 0 if successful, otherwise a positive errno value.*/
875 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
876 const struct ofproto_port_stp_settings *s)
878 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
880 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
881 ofproto->name, ofp_port);
885 return (ofproto->ofproto_class->set_stp_port
886 ? ofproto->ofproto_class->set_stp_port(ofport, s)
890 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
891 * 's'. If the 'enabled' member in 's' is false, then the other members
892 * are not meaningful.
894 * Returns 0 if successful, otherwise a positive errno value.*/
896 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
897 struct ofproto_port_stp_status *s)
899 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
901 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
902 "port %"PRIu16, ofproto->name, ofp_port);
906 return (ofproto->ofproto_class->get_stp_port_status
907 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
911 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
912 * 's'. If the 'enabled' member in 's' is false, then the other members
913 * are not meaningful.
915 * Returns 0 if successful, otherwise a positive errno value.*/
917 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
918 struct ofproto_port_stp_stats *s)
920 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
922 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
923 "port %"PRIu16, ofproto->name, ofp_port);
927 return (ofproto->ofproto_class->get_stp_port_stats
928 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
932 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
934 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
935 * 's' is NULL, disables RSTP.
937 * Returns 0 if successful, otherwise a positive errno value. */
939 ofproto_set_rstp(struct ofproto *ofproto,
940 const struct ofproto_rstp_settings *s)
942 if (!ofproto->ofproto_class->set_rstp) {
945 ofproto->ofproto_class->set_rstp(ofproto, s);
949 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
950 * 'enabled' member of 's' is false, then the other members are not
953 * Returns 0 if successful, otherwise a positive errno value. */
955 ofproto_get_rstp_status(struct ofproto *ofproto,
956 struct ofproto_rstp_status *s)
958 if (!ofproto->ofproto_class->get_rstp_status) {
961 ofproto->ofproto_class->get_rstp_status(ofproto, s);
965 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
966 * in 's'. The caller is responsible for assigning RSTP port numbers
967 * (using the 'port_num' member in the range of 1 through 255, inclusive)
968 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
969 * is disabled on the port.
971 * Returns 0 if successful, otherwise a positive errno value.*/
973 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
974 const struct ofproto_port_rstp_settings *s)
976 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
978 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
979 ofproto->name, ofp_port);
983 if (!ofproto->ofproto_class->set_rstp_port) {
986 ofproto->ofproto_class->set_rstp_port(ofport, s);
990 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
991 * 's'. If the 'enabled' member in 's' is false, then the other members
992 * are not meaningful.
994 * Returns 0 if successful, otherwise a positive errno value.*/
996 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
997 struct ofproto_port_rstp_status *s)
999 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1001 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1002 "port %"PRIu16, ofproto->name, ofp_port);
1006 if (!ofproto->ofproto_class->get_rstp_port_status) {
1009 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1013 /* Queue DSCP configuration. */
1015 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1016 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1017 * to implement QoS. Instead, it is used to implement features which require
1018 * knowledge of what queues exist on a port, and some basic information about
1021 * Returns 0 if successful, otherwise a positive errno value. */
1023 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1024 const struct ofproto_port_queue *queues,
1027 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1030 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1031 ofproto->name, ofp_port);
1035 return (ofproto->ofproto_class->set_queues
1036 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1040 /* Connectivity Fault Management configuration. */
1042 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1044 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1046 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1047 if (ofport && ofproto->ofproto_class->set_cfm) {
1048 ofproto->ofproto_class->set_cfm(ofport, NULL);
1052 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1053 * basic configuration from the configuration members in 'cfm', and the remote
1054 * maintenance point ID from remote_mpid. Ignores the statistics members of
1057 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1059 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1060 const struct cfm_settings *s)
1062 struct ofport *ofport;
1065 ofport = ofproto_get_port(ofproto, ofp_port);
1067 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1068 ofproto->name, ofp_port);
1072 /* XXX: For configuration simplicity, we only support one remote_mpid
1073 * outside of the CFM module. It's not clear if this is the correct long
1074 * term solution or not. */
1075 error = (ofproto->ofproto_class->set_cfm
1076 ? ofproto->ofproto_class->set_cfm(ofport, s)
1079 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1080 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1081 ovs_strerror(error));
1085 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1086 * 'ofproto' does not have a port 'ofp_port'. */
1088 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1089 const struct smap *cfg)
1091 struct ofport *ofport;
1094 ofport = ofproto_get_port(ofproto, ofp_port);
1096 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1097 ofproto->name, ofp_port);
1101 error = (ofproto->ofproto_class->set_bfd
1102 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1105 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1106 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1107 ovs_strerror(error));
1111 /* Checks the status change of BFD on 'ofport'.
1113 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1115 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1117 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1118 return (ofport && ofproto->ofproto_class->bfd_status_changed
1119 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1123 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1124 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1125 * is not an OpenFlow port in 'ofproto'.
1127 * The caller must provide and own '*status'. */
1129 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1130 struct smap *status)
1132 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1133 return (ofport && ofproto->ofproto_class->get_bfd_status
1134 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1138 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1139 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1140 * 0 if LACP partner information is not current (generally indicating a
1141 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1143 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1145 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1146 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1147 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1153 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1154 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1155 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1156 * configuration plus, if there is more than one slave, a bonding
1159 * If 'aux' is already registered then this function updates its configuration
1160 * to 's'. Otherwise, this function registers a new bundle.
1162 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1165 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1166 const struct ofproto_bundle_settings *s)
1168 return (ofproto->ofproto_class->bundle_set
1169 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1173 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1174 * If no such bundle has been registered, this has no effect. */
1176 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1178 return ofproto_bundle_register(ofproto, aux, NULL);
1182 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1183 * If 'aux' is already registered then this function updates its configuration
1184 * to 's'. Otherwise, this function registers a new mirror. */
1186 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1187 const struct ofproto_mirror_settings *s)
1189 return (ofproto->ofproto_class->mirror_set
1190 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1194 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1195 * If no mirror has been registered, this has no effect. */
1197 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1199 return ofproto_mirror_register(ofproto, aux, NULL);
1202 /* Retrieves statistics from mirror associated with client data pointer
1203 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1204 * 'bytes', respectively. If a particular counters is not supported,
1205 * the appropriate argument is set to UINT64_MAX. */
1207 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1208 uint64_t *packets, uint64_t *bytes)
1210 if (!ofproto->ofproto_class->mirror_get_stats) {
1211 *packets = *bytes = UINT64_MAX;
1215 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1219 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1220 * which all packets are flooded, instead of using MAC learning. If
1221 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1223 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1226 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1228 return (ofproto->ofproto_class->set_flood_vlans
1229 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1233 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1234 * output for a mirror. */
1236 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1238 return (ofproto->ofproto_class->is_mirror_output_bundle
1239 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1243 /* Configuration of OpenFlow tables. */
1245 /* Returns the number of OpenFlow tables in 'ofproto'. */
1247 ofproto_get_n_tables(const struct ofproto *ofproto)
1249 return ofproto->n_tables;
1252 /* Returns the number of Controller visible OpenFlow tables
1253 * in 'ofproto'. This number will exclude Hidden tables.
1254 * This funtion's return value should be less or equal to that of
1255 * ofproto_get_n_tables() . */
1257 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1259 uint8_t n = ofproto->n_tables;
1261 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1262 * if present, are always at the end.) */
1263 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1270 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1271 * settings from 's'. 'table_id' must be in the range 0 through the number of
1272 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1274 * For read-only tables, only the name may be configured. */
1276 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1277 const struct ofproto_table_settings *s)
1279 struct oftable *table;
1281 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1282 table = &ofproto->tables[table_id];
1284 oftable_set_name(table, s->name);
1286 if (table->flags & OFTABLE_READONLY) {
1291 oftable_enable_eviction(table, s->groups, s->n_groups);
1293 oftable_disable_eviction(table);
1296 table->max_flows = s->max_flows;
1298 if (classifier_set_prefix_fields(&table->cls,
1299 s->prefix_fields, s->n_prefix_fields)) {
1300 /* XXX: Trigger revalidation. */
1303 ovs_mutex_lock(&ofproto_mutex);
1304 evict_rules_from_table(table, 0);
1305 ovs_mutex_unlock(&ofproto_mutex);
1309 ofproto_has_snoops(const struct ofproto *ofproto)
1311 return connmgr_has_snoops(ofproto->connmgr);
1315 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1317 connmgr_get_snoops(ofproto->connmgr, snoops);
1321 ofproto_rule_delete__(struct rule *rule, uint8_t reason)
1322 OVS_REQUIRES(ofproto_mutex)
1324 struct rule_collection rules;
1326 rules.rules = rules.stub;
1328 rules.stub[0] = rule;
1329 delete_flows__(&rules, reason, NULL);
1332 /* Deletes 'rule' from 'ofproto'.
1334 * Within an ofproto implementation, this function allows an ofproto
1335 * implementation to destroy any rules that remain when its ->destruct()
1336 * function is called. This function is not suitable for use elsewhere in an
1337 * ofproto implementation.
1339 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1340 * Cycle" in ofproto-provider.h. */
1342 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1343 OVS_EXCLUDED(ofproto_mutex)
1345 /* This skips the ofmonitor and flow-removed notifications because the
1346 * switch is being deleted and any OpenFlow channels have been or soon will
1348 ovs_mutex_lock(&ofproto_mutex);
1349 oftable_remove_rule__(ofproto, rule);
1350 ofproto->ofproto_class->rule_delete(rule);
1351 ovs_mutex_unlock(&ofproto_mutex);
1355 ofproto_flush__(struct ofproto *ofproto)
1356 OVS_EXCLUDED(ofproto_mutex)
1358 struct oftable *table;
1360 /* This will flush all datapath flows. */
1361 if (ofproto->ofproto_class->flush) {
1362 ofproto->ofproto_class->flush(ofproto);
1365 /* XXX: There is a small race window here, where new datapath flows can be
1366 * created by upcall handlers based on the existing flow table. We can not
1367 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1368 * as then we could deadlock on syncing with the handler threads waiting on
1369 * the same mutex. */
1371 ovs_mutex_lock(&ofproto_mutex);
1372 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1375 if (table->flags & OFTABLE_HIDDEN) {
1379 CLS_FOR_EACH_SAFE (rule, cr, &table->cls) {
1380 ofproto_rule_delete__(rule, OFPRR_DELETE);
1383 /* XXX: Concurrent handler threads may insert new learned flows based on
1384 * learn actions of the now deleted flows right after we release
1385 * 'ofproto_mutex'. */
1386 ovs_mutex_unlock(&ofproto_mutex);
1389 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1392 ofproto_destroy__(struct ofproto *ofproto)
1393 OVS_EXCLUDED(ofproto_mutex)
1395 struct oftable *table;
1397 destroy_rule_executes(ofproto);
1398 delete_group(ofproto, OFPG_ALL);
1400 guarded_list_destroy(&ofproto->rule_executes);
1401 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1402 hmap_destroy(&ofproto->groups);
1404 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1405 free(ofproto->name);
1406 free(ofproto->type);
1407 free(ofproto->mfr_desc);
1408 free(ofproto->hw_desc);
1409 free(ofproto->sw_desc);
1410 free(ofproto->serial_desc);
1411 free(ofproto->dp_desc);
1412 hmap_destroy(&ofproto->ports);
1413 hmap_destroy(&ofproto->ofport_usage);
1414 shash_destroy(&ofproto->port_by_name);
1415 simap_destroy(&ofproto->ofp_requests);
1417 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1418 oftable_destroy(table);
1420 free(ofproto->tables);
1422 ovs_assert(hindex_is_empty(&ofproto->cookies));
1423 hindex_destroy(&ofproto->cookies);
1425 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1426 hmap_destroy(&ofproto->learned_cookies);
1428 free(ofproto->vlan_bitmap);
1430 ofproto->ofproto_class->dealloc(ofproto);
1434 ofproto_destroy(struct ofproto *p)
1435 OVS_EXCLUDED(ofproto_mutex)
1437 struct ofport *ofport, *next_ofport;
1438 struct ofport_usage *usage, *next_usage;
1445 meter_delete(p, 1, p->meter_features.max_meters);
1446 p->meter_features.max_meters = 0;
1452 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1453 ofport_destroy(ofport);
1456 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1457 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1461 p->ofproto_class->destruct(p);
1463 /* We should not postpone this because it involves deleting a listening
1464 * socket which we may want to reopen soon. 'connmgr' should not be used
1465 * by other threads */
1466 connmgr_destroy(p->connmgr);
1468 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1469 ovsrcu_postpone(ofproto_destroy__, p);
1472 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1473 * kernel datapath, for example, this destroys the datapath in the kernel, and
1474 * with the netdev-based datapath, it tears down the data structures that
1475 * represent the datapath.
1477 * The datapath should not be currently open as an ofproto. */
1479 ofproto_delete(const char *name, const char *type)
1481 const struct ofproto_class *class = ofproto_class_find__(type);
1482 return (!class ? EAFNOSUPPORT
1483 : !class->del ? EACCES
1484 : class->del(type, name));
1488 process_port_change(struct ofproto *ofproto, int error, char *devname)
1490 if (error == ENOBUFS) {
1491 reinit_ports(ofproto);
1492 } else if (!error) {
1493 update_port(ofproto, devname);
1499 ofproto_type_run(const char *datapath_type)
1501 const struct ofproto_class *class;
1504 datapath_type = ofproto_normalize_type(datapath_type);
1505 class = ofproto_class_find__(datapath_type);
1507 error = class->type_run ? class->type_run(datapath_type) : 0;
1508 if (error && error != EAGAIN) {
1509 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1510 datapath_type, ovs_strerror(error));
1516 ofproto_type_wait(const char *datapath_type)
1518 const struct ofproto_class *class;
1520 datapath_type = ofproto_normalize_type(datapath_type);
1521 class = ofproto_class_find__(datapath_type);
1523 if (class->type_wait) {
1524 class->type_wait(datapath_type);
1529 ofproto_run(struct ofproto *p)
1534 error = p->ofproto_class->run(p);
1535 if (error && error != EAGAIN) {
1536 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1539 run_rule_executes(p);
1541 /* Restore the eviction group heap invariant occasionally. */
1542 if (p->eviction_group_timer < time_msec()) {
1545 p->eviction_group_timer = time_msec() + 1000;
1547 for (i = 0; i < p->n_tables; i++) {
1548 struct oftable *table = &p->tables[i];
1549 struct eviction_group *evg;
1552 if (!table->eviction_fields) {
1556 if (classifier_count(&table->cls) > 100000) {
1557 static struct vlog_rate_limit count_rl =
1558 VLOG_RATE_LIMIT_INIT(1, 1);
1559 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1560 " number of rules: %d", i,
1561 classifier_count(&table->cls));
1564 ovs_mutex_lock(&ofproto_mutex);
1565 CLS_FOR_EACH (rule, cr, &table->cls) {
1566 if (rule->idle_timeout || rule->hard_timeout) {
1567 if (!rule->eviction_group) {
1568 eviction_group_add_rule(rule);
1570 heap_raw_change(&rule->evg_node,
1571 rule_eviction_priority(p, rule));
1576 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1577 heap_rebuild(&evg->rules);
1579 ovs_mutex_unlock(&ofproto_mutex);
1583 if (p->ofproto_class->port_poll) {
1586 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1587 process_port_change(p, error, devname);
1591 new_seq = seq_read(connectivity_seq_get());
1592 if (new_seq != p->change_seq) {
1593 struct sset devnames;
1594 const char *devname;
1595 struct ofport *ofport;
1597 /* Update OpenFlow port status for any port whose netdev has changed.
1599 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1600 * destroyed, so it's not safe to update ports directly from the
1601 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1602 * need this two-phase approach. */
1603 sset_init(&devnames);
1604 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1605 uint64_t port_change_seq;
1607 port_change_seq = netdev_get_change_seq(ofport->netdev);
1608 if (ofport->change_seq != port_change_seq) {
1609 ofport->change_seq = port_change_seq;
1610 sset_add(&devnames, netdev_get_name(ofport->netdev));
1613 SSET_FOR_EACH (devname, &devnames) {
1614 update_port(p, devname);
1616 sset_destroy(&devnames);
1618 p->change_seq = new_seq;
1621 connmgr_run(p->connmgr, handle_openflow);
1627 ofproto_wait(struct ofproto *p)
1629 p->ofproto_class->wait(p);
1630 if (p->ofproto_class->port_poll_wait) {
1631 p->ofproto_class->port_poll_wait(p);
1633 seq_wait(connectivity_seq_get(), p->change_seq);
1634 connmgr_wait(p->connmgr);
1638 ofproto_is_alive(const struct ofproto *p)
1640 return connmgr_has_controllers(p->connmgr);
1643 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1644 * memory_report(). */
1646 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1648 const struct oftable *table;
1649 unsigned int n_rules;
1651 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1654 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1655 n_rules += classifier_count(&table->cls);
1657 simap_increase(usage, "rules", n_rules);
1659 if (ofproto->ofproto_class->get_memory_usage) {
1660 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1663 connmgr_get_memory_usage(ofproto->connmgr, usage);
1667 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1669 const struct ofproto_class *class;
1671 datapath_type = ofproto_normalize_type(datapath_type);
1672 class = ofproto_class_find__(datapath_type);
1674 if (class && class->type_get_memory_usage) {
1675 class->type_get_memory_usage(datapath_type, usage);
1680 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1683 connmgr_get_controller_info(ofproto->connmgr, info);
1687 ofproto_free_ofproto_controller_info(struct shash *info)
1689 connmgr_free_controller_info(info);
1692 /* Makes a deep copy of 'old' into 'port'. */
1694 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1696 port->name = xstrdup(old->name);
1697 port->type = xstrdup(old->type);
1698 port->ofp_port = old->ofp_port;
1701 /* Frees memory allocated to members of 'ofproto_port'.
1703 * Do not call this function on an ofproto_port obtained from
1704 * ofproto_port_dump_next(): that function retains ownership of the data in the
1707 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1709 free(ofproto_port->name);
1710 free(ofproto_port->type);
1713 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1715 * This function provides no status indication. An error status for the entire
1716 * dump operation is provided when it is completed by calling
1717 * ofproto_port_dump_done().
1720 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1721 const struct ofproto *ofproto)
1723 dump->ofproto = ofproto;
1724 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1728 /* Attempts to retrieve another port from 'dump', which must have been created
1729 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1730 * 'port' and returns true. On failure, returns false.
1732 * Failure might indicate an actual error or merely that the last port has been
1733 * dumped. An error status for the entire dump operation is provided when it
1734 * is completed by calling ofproto_port_dump_done().
1736 * The ofproto owns the data stored in 'port'. It will remain valid until at
1737 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1738 * ofproto_port_dump_done(). */
1740 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1741 struct ofproto_port *port)
1743 const struct ofproto *ofproto = dump->ofproto;
1749 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1752 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1758 /* Completes port table dump operation 'dump', which must have been created
1759 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1760 * error-free, otherwise a positive errno value describing the problem. */
1762 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1764 const struct ofproto *ofproto = dump->ofproto;
1766 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1769 return dump->error == EOF ? 0 : dump->error;
1772 /* Returns the type to pass to netdev_open() when a datapath of type
1773 * 'datapath_type' has a port of type 'port_type', for a few special
1774 * cases when a netdev type differs from a port type. For example, when
1775 * using the userspace datapath, a port of type "internal" needs to be
1778 * Returns either 'type' itself or a string literal, which must not be
1781 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1783 const struct ofproto_class *class;
1785 datapath_type = ofproto_normalize_type(datapath_type);
1786 class = ofproto_class_find__(datapath_type);
1791 return (class->port_open_type
1792 ? class->port_open_type(datapath_type, port_type)
1796 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1797 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1798 * the port's OpenFlow port number.
1800 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1801 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1802 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1803 * 'ofp_portp' is non-null). */
1805 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1806 ofp_port_t *ofp_portp)
1808 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1811 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1813 const char *netdev_name = netdev_get_name(netdev);
1815 simap_put(&ofproto->ofp_requests, netdev_name,
1816 ofp_to_u16(ofp_port));
1817 update_port(ofproto, netdev_name);
1820 *ofp_portp = OFPP_NONE;
1822 struct ofproto_port ofproto_port;
1824 error = ofproto_port_query_by_name(ofproto,
1825 netdev_get_name(netdev),
1828 *ofp_portp = ofproto_port.ofp_port;
1829 ofproto_port_destroy(&ofproto_port);
1836 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1837 * initializes '*port' appropriately; on failure, returns a positive errno
1840 * The caller owns the data in 'ofproto_port' and must free it with
1841 * ofproto_port_destroy() when it is no longer needed. */
1843 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1844 struct ofproto_port *port)
1848 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1850 memset(port, 0, sizeof *port);
1855 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1856 * Returns 0 if successful, otherwise a positive errno. */
1858 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1860 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1861 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1862 struct simap_node *ofp_request_node;
1865 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1866 if (ofp_request_node) {
1867 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1870 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1871 if (!error && ofport) {
1872 /* 'name' is the netdev's name and update_port() is going to close the
1873 * netdev. Just in case update_port() refers to 'name' after it
1874 * destroys 'ofport', make a copy of it around the update_port()
1876 char *devname = xstrdup(name);
1877 update_port(ofproto, devname);
1884 flow_mod_init(struct ofputil_flow_mod *fm,
1885 const struct match *match, int priority,
1886 const struct ofpact *ofpacts, size_t ofpacts_len,
1887 enum ofp_flow_mod_command command)
1889 memset(fm, 0, sizeof *fm);
1891 fm->priority = priority;
1894 fm->modify_cookie = false;
1896 fm->command = command;
1897 fm->idle_timeout = 0;
1898 fm->hard_timeout = 0;
1900 fm->buffer_id = UINT32_MAX;
1901 fm->out_port = OFPP_ANY;
1902 fm->out_group = OFPG_ANY;
1904 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1905 fm->ofpacts_len = ofpacts_len;
1906 fm->delete_reason = OFPRR_DELETE;
1910 simple_flow_mod(struct ofproto *ofproto,
1911 const struct match *match, int priority,
1912 const struct ofpact *ofpacts, size_t ofpacts_len,
1913 enum ofp_flow_mod_command command)
1915 struct ofputil_flow_mod fm;
1917 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1919 return handle_flow_mod__(ofproto, &fm, NULL);
1922 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1923 * performs the 'n_actions' actions in 'actions'. The new flow will not
1926 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1927 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1928 * controllers; otherwise, it will be hidden.
1930 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1932 * This is a helper function for in-band control and fail-open. */
1934 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1936 const struct ofpact *ofpacts, size_t ofpacts_len)
1937 OVS_EXCLUDED(ofproto_mutex)
1939 const struct rule *rule;
1942 /* First do a cheap check whether the rule we're looking for already exists
1943 * with the actions that we want. If it does, then we're done. */
1944 rule = rule_from_cls_rule(classifier_find_match_exactly(
1945 &ofproto->tables[0].cls, match, priority));
1947 const struct rule_actions *actions = rule_get_actions(rule);
1948 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1949 ofpacts, ofpacts_len);
1954 /* If there's no such rule or the rule doesn't have the actions we want,
1955 * fall back to a executing a full flow mod. We can't optimize this at
1956 * all because we didn't take enough locks above to ensure that the flow
1957 * table didn't already change beneath us. */
1959 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1960 OFPFC_MODIFY_STRICT);
1964 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1965 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1966 * operation cannot be initiated now but may be retried later.
1968 * This is a helper function for in-band control and fail-open and the "learn"
1971 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1972 OVS_EXCLUDED(ofproto_mutex)
1974 /* Optimize for the most common case of a repeated learn action.
1975 * If an identical flow already exists we only need to update its
1976 * 'modified' time. */
1977 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1978 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1979 struct oftable *table = &ofproto->tables[fm->table_id];
1983 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
1987 /* Reading many of the rule fields and writing on 'modified'
1988 * requires the rule->mutex. Also, rule->actions may change
1989 * if rule->mutex is not held. */
1990 const struct rule_actions *actions;
1992 ovs_mutex_lock(&rule->mutex);
1993 actions = rule_get_actions(rule);
1994 if (rule->idle_timeout == fm->idle_timeout
1995 && rule->hard_timeout == fm->hard_timeout
1996 && rule->importance == fm->importance
1997 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1998 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1999 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2000 actions->ofpacts, actions->ofpacts_len)) {
2001 /* Rule already exists and need not change, only update the
2002 modified timestamp. */
2003 rule->modified = time_msec();
2006 ovs_mutex_unlock(&rule->mutex);
2014 return handle_flow_mod__(ofproto, fm, NULL);
2017 /* Searches for a rule with matching criteria exactly equal to 'target' in
2018 * ofproto's table 0 and, if it finds one, deletes it.
2020 * This is a helper function for in-band control and fail-open. */
2022 ofproto_delete_flow(struct ofproto *ofproto,
2023 const struct match *target, int priority)
2024 OVS_EXCLUDED(ofproto_mutex)
2026 struct classifier *cls = &ofproto->tables[0].cls;
2029 /* First do a cheap check whether the rule we're looking for has already
2030 * been deleted. If so, then we're done. */
2031 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2037 /* Execute a flow mod. We can't optimize this at all because we didn't
2038 * take enough locks above to ensure that the flow table didn't already
2039 * change beneath us. */
2040 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2043 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2044 * the flows required by in-band control and fail-open. */
2046 ofproto_flush_flows(struct ofproto *ofproto)
2048 COVERAGE_INC(ofproto_flush);
2049 ofproto_flush__(ofproto);
2050 connmgr_flushed(ofproto->connmgr);
2054 reinit_ports(struct ofproto *p)
2056 struct ofproto_port_dump dump;
2057 struct sset devnames;
2058 struct ofport *ofport;
2059 struct ofproto_port ofproto_port;
2060 const char *devname;
2062 COVERAGE_INC(ofproto_reinit_ports);
2064 sset_init(&devnames);
2065 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2066 sset_add(&devnames, netdev_get_name(ofport->netdev));
2068 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2069 sset_add(&devnames, ofproto_port.name);
2072 SSET_FOR_EACH (devname, &devnames) {
2073 update_port(p, devname);
2075 sset_destroy(&devnames);
2079 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2083 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2084 port_idx = port_idx ? port_idx : UINT16_MAX;
2086 if (port_idx >= ofproto->max_ports
2087 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2088 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2089 long long int last_used_at, lru = LLONG_MAX;
2091 /* Search for a free OpenFlow port number. We try not to
2092 * immediately reuse them to prevent problems due to old
2095 * We limit the automatically assigned port numbers to the lower half
2096 * of the port range, to reserve the upper half for assignment by
2099 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2100 ofproto->alloc_port_no = 1;
2102 last_used_at = ofport_get_usage(ofproto,
2103 u16_to_ofp(ofproto->alloc_port_no));
2104 if (!last_used_at) {
2105 port_idx = ofproto->alloc_port_no;
2107 } else if ( last_used_at < time_msec() - 60*60*1000) {
2108 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2109 * more than an hour ago, consider it usable. */
2110 ofport_remove_usage(ofproto,
2111 u16_to_ofp(ofproto->alloc_port_no));
2112 port_idx = ofproto->alloc_port_no;
2114 } else if (last_used_at < lru) {
2116 lru_ofport = ofproto->alloc_port_no;
2119 if (ofproto->alloc_port_no == end_port_no) {
2121 port_idx = lru_ofport;
2128 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2129 return u16_to_ofp(port_idx);
2133 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2135 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2136 ofport_set_usage(ofproto, ofp_port, time_msec());
2140 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2141 * pointer if the netdev cannot be opened. On success, also fills in
2143 static struct netdev *
2144 ofport_open(struct ofproto *ofproto,
2145 struct ofproto_port *ofproto_port,
2146 struct ofputil_phy_port *pp)
2148 enum netdev_flags flags;
2149 struct netdev *netdev;
2152 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2154 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2155 "cannot be opened (%s)",
2157 ofproto_port->name, ofproto_port->ofp_port,
2158 ofproto_port->name, ovs_strerror(error));
2162 if (ofproto_port->ofp_port == OFPP_NONE) {
2163 if (!strcmp(ofproto->name, ofproto_port->name)) {
2164 ofproto_port->ofp_port = OFPP_LOCAL;
2166 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2167 ofproto_port->name);
2170 pp->port_no = ofproto_port->ofp_port;
2171 netdev_get_etheraddr(netdev, pp->hw_addr);
2172 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2173 netdev_get_flags(netdev, &flags);
2174 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2175 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2176 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2177 &pp->supported, &pp->peer);
2178 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2179 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2184 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2185 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2188 ofport_equal(const struct ofputil_phy_port *a,
2189 const struct ofputil_phy_port *b)
2191 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2192 && a->state == b->state
2193 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2194 && a->curr == b->curr
2195 && a->advertised == b->advertised
2196 && a->supported == b->supported
2197 && a->peer == b->peer
2198 && a->curr_speed == b->curr_speed
2199 && a->max_speed == b->max_speed);
2202 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2203 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2204 * one with the same name or port number). */
2206 ofport_install(struct ofproto *p,
2207 struct netdev *netdev, const struct ofputil_phy_port *pp)
2209 const char *netdev_name = netdev_get_name(netdev);
2210 struct ofport *ofport;
2213 /* Create ofport. */
2214 ofport = p->ofproto_class->port_alloc();
2219 ofport->ofproto = p;
2220 ofport->netdev = netdev;
2221 ofport->change_seq = netdev_get_change_seq(netdev);
2223 ofport->ofp_port = pp->port_no;
2224 ofport->created = time_msec();
2226 /* Add port to 'p'. */
2227 hmap_insert(&p->ports, &ofport->hmap_node,
2228 hash_ofp_port(ofport->ofp_port));
2229 shash_add(&p->port_by_name, netdev_name, ofport);
2231 update_mtu(p, ofport);
2233 /* Let the ofproto_class initialize its private data. */
2234 error = p->ofproto_class->port_construct(ofport);
2238 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2242 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2243 p->name, netdev_name, ovs_strerror(error));
2245 ofport_destroy__(ofport);
2247 netdev_close(netdev);
2251 /* Removes 'ofport' from 'p' and destroys it. */
2253 ofport_remove(struct ofport *ofport)
2255 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2257 ofport_destroy(ofport);
2260 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2263 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2265 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2267 ofport_remove(port);
2271 /* Updates 'port' with new 'pp' description.
2273 * Does not handle a name or port number change. The caller must implement
2274 * such a change as a delete followed by an add. */
2276 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2278 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2279 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2280 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2281 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2282 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2283 port->pp.curr = pp->curr;
2284 port->pp.advertised = pp->advertised;
2285 port->pp.supported = pp->supported;
2286 port->pp.peer = pp->peer;
2287 port->pp.curr_speed = pp->curr_speed;
2288 port->pp.max_speed = pp->max_speed;
2290 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2291 &port->pp, OFPPR_MODIFY);
2294 /* Update OpenFlow 'state' in 'port' and notify controller. */
2296 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2298 if (port->pp.state != state) {
2299 port->pp.state = state;
2300 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2301 &port->pp, OFPPR_MODIFY);
2306 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2308 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2310 if (port->ofproto->ofproto_class->set_realdev) {
2311 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2313 if (port->ofproto->ofproto_class->set_stp_port) {
2314 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2316 if (port->ofproto->ofproto_class->set_rstp_port) {
2317 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2319 if (port->ofproto->ofproto_class->set_cfm) {
2320 port->ofproto->ofproto_class->set_cfm(port, NULL);
2322 if (port->ofproto->ofproto_class->bundle_remove) {
2323 port->ofproto->ofproto_class->bundle_remove(port);
2329 ofport_destroy__(struct ofport *port)
2331 struct ofproto *ofproto = port->ofproto;
2332 const char *name = netdev_get_name(port->netdev);
2334 hmap_remove(&ofproto->ports, &port->hmap_node);
2335 shash_delete(&ofproto->port_by_name,
2336 shash_find(&ofproto->port_by_name, name));
2338 netdev_close(port->netdev);
2339 ofproto->ofproto_class->port_dealloc(port);
2343 ofport_destroy(struct ofport *port)
2346 dealloc_ofp_port(port->ofproto, port->ofp_port);
2347 port->ofproto->ofproto_class->port_destruct(port);
2348 ofport_destroy__(port);
2353 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2355 struct ofport *port;
2357 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2359 if (port->ofp_port == ofp_port) {
2366 static long long int
2367 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2369 struct ofport_usage *usage;
2371 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2372 &ofproto->ofport_usage) {
2373 if (usage->ofp_port == ofp_port) {
2374 return usage->last_used;
2381 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2382 long long int last_used)
2384 struct ofport_usage *usage;
2385 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2386 &ofproto->ofport_usage) {
2387 if (usage->ofp_port == ofp_port) {
2388 usage->last_used = last_used;
2392 ovs_assert(last_used == LLONG_MAX);
2394 usage = xmalloc(sizeof *usage);
2395 usage->ofp_port = ofp_port;
2396 usage->last_used = last_used;
2397 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2398 hash_ofp_port(ofp_port));
2402 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2404 struct ofport_usage *usage;
2405 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2406 &ofproto->ofport_usage) {
2407 if (usage->ofp_port == ofp_port) {
2408 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2416 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2418 struct ofproto *ofproto = port->ofproto;
2421 if (ofproto->ofproto_class->port_get_stats) {
2422 error = ofproto->ofproto_class->port_get_stats(port, stats);
2431 update_port(struct ofproto *ofproto, const char *name)
2433 struct ofproto_port ofproto_port;
2434 struct ofputil_phy_port pp;
2435 struct netdev *netdev;
2436 struct ofport *port;
2438 COVERAGE_INC(ofproto_update_port);
2440 /* Fetch 'name''s location and properties from the datapath. */
2441 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2442 ? ofport_open(ofproto, &ofproto_port, &pp)
2446 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2447 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2448 struct netdev *old_netdev = port->netdev;
2450 /* 'name' hasn't changed location. Any properties changed? */
2451 if (!ofport_equal(&port->pp, &pp)) {
2452 ofport_modified(port, &pp);
2455 update_mtu(ofproto, port);
2457 /* Install the newly opened netdev in case it has changed.
2458 * Don't close the old netdev yet in case port_modified has to
2459 * remove a retained reference to it.*/
2460 port->netdev = netdev;
2461 port->change_seq = netdev_get_change_seq(netdev);
2463 if (port->ofproto->ofproto_class->port_modified) {
2464 port->ofproto->ofproto_class->port_modified(port);
2467 netdev_close(old_netdev);
2469 /* If 'port' is nonnull then its name differs from 'name' and thus
2470 * we should delete it. If we think there's a port named 'name'
2471 * then its port number must be wrong now so delete it too. */
2473 ofport_remove(port);
2475 ofport_remove_with_name(ofproto, name);
2476 ofport_install(ofproto, netdev, &pp);
2479 /* Any port named 'name' is gone now. */
2480 ofport_remove_with_name(ofproto, name);
2482 ofproto_port_destroy(&ofproto_port);
2486 init_ports(struct ofproto *p)
2488 struct ofproto_port_dump dump;
2489 struct ofproto_port ofproto_port;
2490 struct shash_node *node, *next;
2492 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2493 const char *name = ofproto_port.name;
2495 if (shash_find(&p->port_by_name, name)) {
2496 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2499 struct ofputil_phy_port pp;
2500 struct netdev *netdev;
2502 /* Check if an OpenFlow port number had been requested. */
2503 node = shash_find(&init_ofp_ports, name);
2505 const struct iface_hint *iface_hint = node->data;
2506 simap_put(&p->ofp_requests, name,
2507 ofp_to_u16(iface_hint->ofp_port));
2510 netdev = ofport_open(p, &ofproto_port, &pp);
2512 ofport_install(p, netdev, &pp);
2513 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2514 p->alloc_port_no = MAX(p->alloc_port_no,
2515 ofp_to_u16(ofproto_port.ofp_port));
2521 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2522 struct iface_hint *iface_hint = node->data;
2524 if (!strcmp(iface_hint->br_name, p->name)) {
2525 free(iface_hint->br_name);
2526 free(iface_hint->br_type);
2528 shash_delete(&init_ofp_ports, node);
2535 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2536 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2538 find_min_mtu(struct ofproto *p)
2540 struct ofport *ofport;
2543 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2544 struct netdev *netdev = ofport->netdev;
2547 /* Skip any internal ports, since that's what we're trying to
2549 if (!strcmp(netdev_get_type(netdev), "internal")) {
2553 if (netdev_get_mtu(netdev, &dev_mtu)) {
2556 if (!mtu || dev_mtu < mtu) {
2561 return mtu ? mtu: ETH_PAYLOAD_MAX;
2564 /* Update MTU of all datapath devices on 'p' to the minimum of the
2565 * non-datapath ports in event of 'port' added or changed. */
2567 update_mtu(struct ofproto *p, struct ofport *port)
2569 struct ofport *ofport;
2570 struct netdev *netdev = port->netdev;
2571 int dev_mtu, old_min;
2573 if (netdev_get_mtu(netdev, &dev_mtu)) {
2577 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2578 if (dev_mtu > p->min_mtu) {
2579 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2580 dev_mtu = p->min_mtu;
2583 port->mtu = dev_mtu;
2587 /* For non-internal port find new min mtu. */
2588 old_min = p->min_mtu;
2589 port->mtu = dev_mtu;
2590 p->min_mtu = find_min_mtu(p);
2591 if (p->min_mtu == old_min) {
2595 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2596 struct netdev *netdev = ofport->netdev;
2598 if (!strcmp(netdev_get_type(netdev), "internal")) {
2599 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2600 ofport->mtu = p->min_mtu;
2607 ofproto_rule_destroy__(struct rule *rule)
2608 OVS_NO_THREAD_SAFETY_ANALYSIS
2610 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2611 rule_actions_destroy(rule_get_actions(rule));
2612 ovs_mutex_destroy(&rule->mutex);
2613 rule->ofproto->ofproto_class->rule_dealloc(rule);
2617 rule_destroy_cb(struct rule *rule)
2619 rule->ofproto->ofproto_class->rule_destruct(rule);
2620 ofproto_rule_destroy__(rule);
2624 ofproto_rule_ref(struct rule *rule)
2627 ovs_refcount_ref(&rule->ref_count);
2632 ofproto_rule_try_ref(struct rule *rule)
2635 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2640 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2641 * ref_count reaches 0.
2643 * Use of RCU allows short term use (between RCU quiescent periods) without
2644 * keeping a reference. A reference must be taken if the rule needs to
2645 * stay around accross the RCU quiescent periods. */
2647 ofproto_rule_unref(struct rule *rule)
2649 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2650 ovsrcu_postpone(rule_destroy_cb, rule);
2655 ofproto_group_ref(struct ofgroup *group)
2658 ovs_refcount_ref(&group->ref_count);
2663 ofproto_group_unref(struct ofgroup *group)
2665 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2666 group->ofproto->ofproto_class->group_destruct(group);
2667 ofputil_bucket_list_destroy(&group->buckets);
2668 group->ofproto->ofproto_class->group_dealloc(group);
2672 static uint32_t get_provider_meter_id(const struct ofproto *,
2673 uint32_t of_meter_id);
2675 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2676 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2677 const struct rule_actions *
2678 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2680 struct rule_actions *actions;
2682 actions = xmalloc(sizeof *actions + ofpacts_len);
2683 actions->ofpacts_len = ofpacts_len;
2684 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2685 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2687 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2693 /* Free the actions after the RCU quiescent period is reached. */
2695 rule_actions_destroy(const struct rule_actions *actions)
2698 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2702 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2703 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2705 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2706 OVS_REQUIRES(ofproto_mutex)
2708 if (port == OFPP_ANY) {
2711 const struct rule_actions *actions = rule_get_actions(rule);
2712 return ofpacts_output_to_port(actions->ofpacts,
2713 actions->ofpacts_len, port);
2717 /* Returns true if 'rule' has group and equals group_id. */
2719 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2720 OVS_REQUIRES(ofproto_mutex)
2722 if (group_id == OFPG_ANY) {
2725 const struct rule_actions *actions = rule_get_actions(rule);
2726 return ofpacts_output_to_group(actions->ofpacts,
2727 actions->ofpacts_len, group_id);
2732 rule_execute_destroy(struct rule_execute *e)
2734 ofproto_rule_unref(e->rule);
2735 list_remove(&e->list_node);
2739 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2740 * by passing them to the ofproto provider. */
2742 run_rule_executes(struct ofproto *ofproto)
2743 OVS_EXCLUDED(ofproto_mutex)
2745 struct rule_execute *e, *next;
2746 struct list executes;
2748 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2749 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2752 flow_extract(e->packet, NULL, &flow);
2753 flow.in_port.ofp_port = e->in_port;
2754 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2756 rule_execute_destroy(e);
2760 /* Destroys and discards all "rule_execute" operations queued up in
2761 * ofproto->rule_executes. */
2763 destroy_rule_executes(struct ofproto *ofproto)
2765 struct rule_execute *e, *next;
2766 struct list executes;
2768 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2769 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2770 ofpbuf_delete(e->packet);
2771 rule_execute_destroy(e);
2776 rule_is_readonly(const struct rule *rule)
2778 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2779 return (table->flags & OFTABLE_READONLY) != 0;
2783 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2785 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2786 return hash_3words(cookie, cookie >> 32, table_id);
2790 learned_cookies_update_one__(struct ofproto *ofproto,
2791 const struct ofpact_learn *learn,
2792 int delta, struct list *dead_cookies)
2793 OVS_REQUIRES(ofproto_mutex)
2795 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
2796 struct learned_cookie *c;
2798 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
2799 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
2801 ovs_assert(c->n >= 0);
2804 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
2805 list_push_back(dead_cookies, &c->u.list_node);
2812 ovs_assert(delta > 0);
2813 c = xmalloc(sizeof *c);
2814 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
2815 c->cookie = learn->cookie;
2816 c->table_id = learn->table_id;
2820 static const struct ofpact_learn *
2821 next_learn_with_delete(const struct rule_actions *actions,
2822 const struct ofpact_learn *start)
2824 const struct ofpact *pos;
2826 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
2827 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
2828 pos = ofpact_next(pos)) {
2829 if (pos->type == OFPACT_LEARN) {
2830 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
2831 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
2841 learned_cookies_update__(struct ofproto *ofproto,
2842 const struct rule_actions *actions,
2843 int delta, struct list *dead_cookies)
2844 OVS_REQUIRES(ofproto_mutex)
2846 if (actions->has_learn_with_delete) {
2847 const struct ofpact_learn *learn;
2849 for (learn = next_learn_with_delete(actions, NULL); learn;
2850 learn = next_learn_with_delete(actions, learn)) {
2851 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
2857 learned_cookies_inc(struct ofproto *ofproto,
2858 const struct rule_actions *actions)
2859 OVS_REQUIRES(ofproto_mutex)
2861 learned_cookies_update__(ofproto, actions, +1, NULL);
2865 learned_cookies_dec(struct ofproto *ofproto,
2866 const struct rule_actions *actions,
2867 struct list *dead_cookies)
2868 OVS_REQUIRES(ofproto_mutex)
2870 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
2874 learned_cookies_flush(struct ofproto *ofproto, struct list *dead_cookies)
2875 OVS_REQUIRES(ofproto_mutex)
2877 struct learned_cookie *c, *next;
2879 LIST_FOR_EACH_SAFE (c, next, u.list_node, dead_cookies) {
2880 struct rule_criteria criteria;
2881 struct rule_collection rules;
2884 match_init_catchall(&match);
2885 rule_criteria_init(&criteria, c->table_id, &match, 0,
2886 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
2887 rule_criteria_require_rw(&criteria, false);
2888 collect_rules_loose(ofproto, &criteria, &rules);
2889 delete_flows__(&rules, OFPRR_DELETE, NULL);
2890 rule_criteria_destroy(&criteria);
2891 rule_collection_destroy(&rules);
2893 list_remove(&c->u.list_node);
2899 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2901 ofconn_send_reply(ofconn, make_echo_reply(oh));
2906 query_tables(struct ofproto *ofproto,
2907 struct ofputil_table_features **featuresp,
2908 struct ofputil_table_stats **statsp)
2910 struct mf_bitmap rw_fields = oxm_writable_fields();
2911 struct mf_bitmap match = oxm_matchable_fields();
2912 struct mf_bitmap mask = oxm_maskable_fields();
2914 struct ofputil_table_features *features;
2915 struct ofputil_table_stats *stats;
2918 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
2919 for (i = 0; i < ofproto->n_tables; i++) {
2920 struct ofputil_table_features *f = &features[i];
2923 sprintf(f->name, "table%d", i);
2924 f->metadata_match = OVS_BE64_MAX;
2925 f->metadata_write = OVS_BE64_MAX;
2926 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
2927 f->max_entries = 1000000;
2929 bitmap_set_multiple(f->nonmiss.next, i + 1,
2930 ofproto->n_tables - (i + 1), true);
2931 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
2932 if (i == ofproto->n_tables - 1) {
2933 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
2935 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
2936 f->nonmiss.write.set_fields = rw_fields;
2937 f->nonmiss.apply = f->nonmiss.write;
2938 f->miss = f->nonmiss;
2942 f->wildcard = match;
2946 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
2947 for (i = 0; i < ofproto->n_tables; i++) {
2948 struct ofputil_table_stats *s = &stats[i];
2949 struct classifier *cls = &ofproto->tables[i].cls;
2952 s->active_count = classifier_count(cls);
2958 ofproto->ofproto_class->query_tables(ofproto, features, stats);
2960 for (i = 0; i < ofproto->n_tables; i++) {
2961 const struct oftable *table = &ofproto->tables[i];
2962 struct ofputil_table_features *f = &features[i];
2965 ovs_strzcpy(f->name, table->name, sizeof f->name);
2968 if (table->max_flows < f->max_entries) {
2969 f->max_entries = table->max_flows;
2975 query_switch_features(struct ofproto *ofproto,
2976 bool *arp_match_ip, uint64_t *ofpacts)
2978 struct ofputil_table_features *features, *f;
2980 *arp_match_ip = false;
2983 query_tables(ofproto, &features, NULL);
2984 for (f = features; f < &features[ofproto->n_tables]; f++) {
2985 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
2986 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
2987 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
2988 *arp_match_ip = true;
2994 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
2998 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3000 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3001 struct ofputil_switch_features features;
3002 struct ofport *port;
3006 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3008 features.datapath_id = ofproto->datapath_id;
3009 features.n_buffers = pktbuf_capacity();
3010 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3011 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3012 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3013 OFPUTIL_C_GROUP_STATS);
3015 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3017 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3018 features.auxiliary_id = 0;
3019 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3021 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3022 ofputil_put_switch_features_port(&port->pp, b);
3025 ofconn_send_reply(ofconn, b);
3030 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3032 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3033 struct ofp_switch_config *osc;
3034 enum ofp_config_flags flags;
3038 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3039 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3040 flags = ofproto->frag_handling;
3041 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3042 if (oh->version < OFP13_VERSION
3043 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3044 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3046 osc->flags = htons(flags);
3047 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3048 ofconn_send_reply(ofconn, buf);
3054 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3056 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3057 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3058 uint16_t flags = ntohs(osc->flags);
3060 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3061 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3062 enum ofp_config_flags cur = ofproto->frag_handling;
3063 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3065 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3067 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3068 ofproto->frag_handling = next;
3070 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3072 ofputil_frag_handling_to_string(next));
3076 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3077 ofconn_set_invalid_ttl_to_controller(ofconn,
3078 (oh->version < OFP13_VERSION
3079 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3081 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3086 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3087 * error message code for the caller to propagate upward. Otherwise, returns
3090 * The log message mentions 'msg_type'. */
3092 reject_slave_controller(struct ofconn *ofconn)
3094 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3095 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3096 return OFPERR_OFPBRC_EPERM;
3102 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3105 * - If they use a meter, then 'ofproto' has that meter configured.
3107 * - If they use any groups, then 'ofproto' has that group configured.
3109 * Returns 0 if successful, otherwise an OpenFlow error. */
3111 ofproto_check_ofpacts(struct ofproto *ofproto,
3112 const struct ofpact ofpacts[], size_t ofpacts_len)
3114 const struct ofpact *a;
3117 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3118 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3119 return OFPERR_OFPMMFC_INVALID_METER;
3122 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3123 if (a->type == OFPACT_GROUP
3124 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3125 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3133 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3135 struct ofproto *p = ofconn_get_ofproto(ofconn);
3136 struct ofputil_packet_out po;
3137 struct ofpbuf *payload;
3138 uint64_t ofpacts_stub[1024 / 8];
3139 struct ofpbuf ofpacts;
3143 COVERAGE_INC(ofproto_packet_out);
3145 error = reject_slave_controller(ofconn);
3150 /* Decode message. */
3151 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3152 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3154 goto exit_free_ofpacts;
3156 if (ofp_to_u16(po.in_port) >= p->max_ports
3157 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3158 error = OFPERR_OFPBRC_BAD_PORT;
3159 goto exit_free_ofpacts;
3163 if (po.buffer_id != UINT32_MAX) {
3164 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3165 if (error || !payload) {
3166 goto exit_free_ofpacts;
3169 /* Ensure that the L3 header is 32-bit aligned. */
3170 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
3173 /* Verify actions against packet, then send packet if successful. */
3174 flow_extract(payload, NULL, &flow);
3175 flow.in_port.ofp_port = po.in_port;
3176 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3178 error = p->ofproto_class->packet_out(p, payload, &flow,
3179 po.ofpacts, po.ofpacts_len);
3181 ofpbuf_delete(payload);
3184 ofpbuf_uninit(&ofpacts);
3190 update_port_config(struct ofconn *ofconn, struct ofport *port,
3191 enum ofputil_port_config config,
3192 enum ofputil_port_config mask)
3194 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3196 if (toggle & OFPUTIL_PC_PORT_DOWN
3197 && (config & OFPUTIL_PC_PORT_DOWN
3198 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3199 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3200 /* We tried to bring the port up or down, but it failed, so don't
3201 * update the "down" bit. */
3202 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3206 enum ofputil_port_config old_config = port->pp.config;
3207 port->pp.config ^= toggle;
3208 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3209 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3215 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3217 struct ofproto *p = ofconn_get_ofproto(ofconn);
3218 struct ofputil_port_mod pm;
3219 struct ofport *port;
3222 error = reject_slave_controller(ofconn);
3227 error = ofputil_decode_port_mod(oh, &pm, false);
3232 port = ofproto_get_port(p, pm.port_no);
3234 return OFPERR_OFPPMFC_BAD_PORT;
3235 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3236 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3238 update_port_config(ofconn, port, pm.config, pm.mask);
3240 netdev_set_advertisements(port->netdev, pm.advertise);
3247 handle_desc_stats_request(struct ofconn *ofconn,
3248 const struct ofp_header *request)
3250 static const char *default_mfr_desc = "Nicira, Inc.";
3251 static const char *default_hw_desc = "Open vSwitch";
3252 static const char *default_sw_desc = VERSION;
3253 static const char *default_serial_desc = "None";
3254 static const char *default_dp_desc = "None";
3256 struct ofproto *p = ofconn_get_ofproto(ofconn);
3257 struct ofp_desc_stats *ods;
3260 msg = ofpraw_alloc_stats_reply(request, 0);
3261 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3262 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3263 sizeof ods->mfr_desc);
3264 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3265 sizeof ods->hw_desc);
3266 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3267 sizeof ods->sw_desc);
3268 ovs_strlcpy(ods->serial_num,
3269 p->serial_desc ? p->serial_desc : default_serial_desc,
3270 sizeof ods->serial_num);
3271 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3272 sizeof ods->dp_desc);
3273 ofconn_send_reply(ofconn, msg);
3279 handle_table_stats_request(struct ofconn *ofconn,
3280 const struct ofp_header *request)
3282 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3283 struct ofputil_table_features *features;
3284 struct ofputil_table_stats *stats;
3285 struct ofpbuf *reply;
3288 query_tables(ofproto, &features, &stats);
3290 reply = ofputil_encode_table_stats_reply(request);
3291 for (i = 0; i < ofproto->n_tables; i++) {
3292 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3293 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3296 ofconn_send_reply(ofconn, reply);
3305 handle_table_features_request(struct ofconn *ofconn,
3306 const struct ofp_header *request)
3308 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3309 struct ofputil_table_features *features;
3310 struct list replies;
3314 ofpbuf_use_const(&msg, request, ntohs(request->length));
3315 ofpraw_pull_assert(&msg);
3316 if (ofpbuf_size(&msg) || ofpmp_more(request)) {
3317 return OFPERR_OFPTFFC_EPERM;
3320 query_tables(ofproto, &features, NULL);
3322 ofpmp_init(&replies, request);
3323 for (i = 0; i < ofproto->n_tables; i++) {
3324 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3325 ofputil_append_table_features_reply(&features[i], &replies);
3328 ofconn_send_replies(ofconn, &replies);
3336 append_port_stat(struct ofport *port, struct list *replies)
3338 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3340 calc_duration(port->created, time_msec(),
3341 &ops.duration_sec, &ops.duration_nsec);
3343 /* Intentionally ignore return value, since errors will set
3344 * 'stats' to all-1s, which is correct for OpenFlow, and
3345 * netdev_get_stats() will log errors. */
3346 ofproto_port_get_stats(port, &ops.stats);
3348 ofputil_append_port_stat(replies, &ops);
3352 handle_port_request(struct ofconn *ofconn,
3353 const struct ofp_header *request, ofp_port_t port_no,
3354 void (*cb)(struct ofport *, struct list *replies))
3356 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3357 struct ofport *port;
3358 struct list replies;
3360 ofpmp_init(&replies, request);
3361 if (port_no != OFPP_ANY) {
3362 port = ofproto_get_port(ofproto, port_no);
3367 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3372 ofconn_send_replies(ofconn, &replies);
3376 handle_port_stats_request(struct ofconn *ofconn,
3377 const struct ofp_header *request)
3382 error = ofputil_decode_port_stats_request(request, &port_no);
3384 handle_port_request(ofconn, request, port_no, append_port_stat);
3390 append_port_desc(struct ofport *port, struct list *replies)
3392 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3396 handle_port_desc_stats_request(struct ofconn *ofconn,
3397 const struct ofp_header *request)
3402 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3404 handle_port_request(ofconn, request, port_no, append_port_desc);
3410 hash_cookie(ovs_be64 cookie)
3412 return hash_uint64((OVS_FORCE uint64_t)cookie);
3416 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3417 OVS_REQUIRES(ofproto_mutex)
3419 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3420 hash_cookie(rule->flow_cookie));
3424 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3425 OVS_REQUIRES(ofproto_mutex)
3427 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3431 calc_duration(long long int start, long long int now,
3432 uint32_t *sec, uint32_t *nsec)
3434 long long int msecs = now - start;
3435 *sec = msecs / 1000;
3436 *nsec = (msecs % 1000) * (1000 * 1000);
3439 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3440 * true if 'table_id' is OK, false otherwise. */
3442 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3444 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3447 static struct oftable *
3448 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3450 struct oftable *table;
3452 for (table = &ofproto->tables[table_id];
3453 table < &ofproto->tables[ofproto->n_tables];
3455 if (!(table->flags & OFTABLE_HIDDEN)) {
3463 static struct oftable *
3464 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3466 if (table_id == 0xff) {
3467 return next_visible_table(ofproto, 0);
3468 } else if (table_id < ofproto->n_tables) {
3469 return &ofproto->tables[table_id];
3475 static struct oftable *
3476 next_matching_table(const struct ofproto *ofproto,
3477 const struct oftable *table, uint8_t table_id)
3479 return (table_id == 0xff
3480 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3484 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3486 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3487 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3489 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3490 * only once, for that table. (This can be used to access tables marked
3493 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3494 * entered at all. (Perhaps you should have validated TABLE_ID with
3495 * check_table_id().)
3497 * All parameters are evaluated multiple times.
3499 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3500 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3502 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3504 /* Initializes 'criteria' in a straightforward way based on the other
3507 * By default, the criteria include flows that are read-only, on the assumption
3508 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3509 * if flows will be modified.
3511 * For "loose" matching, the 'priority' parameter is unimportant and may be
3514 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3515 const struct match *match, int priority,
3516 ovs_be64 cookie, ovs_be64 cookie_mask,
3517 ofp_port_t out_port, uint32_t out_group)
3519 criteria->table_id = table_id;
3520 cls_rule_init(&criteria->cr, match, priority);
3521 criteria->cookie = cookie;
3522 criteria->cookie_mask = cookie_mask;
3523 criteria->out_port = out_port;
3524 criteria->out_group = out_group;
3526 /* We ordinarily want to skip hidden rules, but there has to be a way for
3527 * code internal to OVS to modify and delete them, so if the criteria
3528 * specify a priority that can only be for a hidden flow, then allow hidden
3529 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3530 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3532 criteria->include_hidden = priority > UINT16_MAX;
3534 /* We assume that the criteria are being used to collect flows for reading
3535 * but not modification. Thus, we should collect read-only flows. */
3536 criteria->include_readonly = true;
3539 /* By default, criteria initialized by rule_criteria_init() will match flows
3540 * that are read-only, on the assumption that the collected flows won't be
3541 * modified. Call this function to match only flows that are be modifiable.
3543 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3544 * caller has special privileges that allow it to modify even "read-only"
3547 rule_criteria_require_rw(struct rule_criteria *criteria,
3548 bool can_write_readonly)
3550 criteria->include_readonly = can_write_readonly;
3554 rule_criteria_destroy(struct rule_criteria *criteria)
3556 cls_rule_destroy(&criteria->cr);
3560 rule_collection_init(struct rule_collection *rules)
3562 rules->rules = rules->stub;
3564 rules->capacity = ARRAY_SIZE(rules->stub);
3568 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3570 if (rules->n >= rules->capacity) {
3571 size_t old_size, new_size;
3573 old_size = rules->capacity * sizeof *rules->rules;
3574 rules->capacity *= 2;
3575 new_size = rules->capacity * sizeof *rules->rules;
3577 if (rules->rules == rules->stub) {
3578 rules->rules = xmalloc(new_size);
3579 memcpy(rules->rules, rules->stub, old_size);
3581 rules->rules = xrealloc(rules->rules, new_size);
3585 rules->rules[rules->n++] = rule;
3589 rule_collection_ref(struct rule_collection *rules)
3590 OVS_REQUIRES(ofproto_mutex)
3594 for (i = 0; i < rules->n; i++) {
3595 ofproto_rule_ref(rules->rules[i]);
3600 rule_collection_unref(struct rule_collection *rules)
3604 for (i = 0; i < rules->n; i++) {
3605 ofproto_rule_unref(rules->rules[i]);
3610 rule_collection_destroy(struct rule_collection *rules)
3612 if (rules->rules != rules->stub) {
3616 /* Make repeated destruction harmless. */
3617 rule_collection_init(rules);
3620 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3621 * function verifies most of the criteria in 'c' itself, but the caller must
3622 * check 'c->cr' itself.
3624 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3625 * 'c' only includes modifiable rules). */
3627 collect_rule(struct rule *rule, const struct rule_criteria *c,
3628 struct rule_collection *rules, size_t *n_readonly)
3629 OVS_REQUIRES(ofproto_mutex)
3631 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3632 && ofproto_rule_has_out_port(rule, c->out_port)
3633 && ofproto_rule_has_out_group(rule, c->out_group)
3634 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3635 && (!rule_is_hidden(rule) || c->include_hidden)) {
3636 /* Rule matches all the criteria... */
3637 if (!rule_is_readonly(rule) || c->include_readonly) {
3639 rule_collection_add(rules, rule);
3641 /* ...except it's read-only. */
3647 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3648 * on classifiers rules are done in the "loose" way required for OpenFlow
3649 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3652 * Returns 0 on success, otherwise an OpenFlow error code. */
3654 collect_rules_loose(struct ofproto *ofproto,
3655 const struct rule_criteria *criteria,
3656 struct rule_collection *rules)
3657 OVS_REQUIRES(ofproto_mutex)
3659 struct oftable *table;
3660 enum ofperr error = 0;
3661 size_t n_readonly = 0;
3663 rule_collection_init(rules);
3665 if (!check_table_id(ofproto, criteria->table_id)) {
3666 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3670 if (criteria->cookie_mask == OVS_BE64_MAX) {
3673 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3674 hash_cookie(criteria->cookie),
3675 &ofproto->cookies) {
3676 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3677 collect_rule(rule, criteria, rules, &n_readonly);
3681 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3684 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3685 collect_rule(rule, criteria, rules, &n_readonly);
3691 if (!error && !rules->n && n_readonly) {
3692 /* We didn't find any rules to modify. We did find some read-only
3693 * rules that we're not allowed to modify, so report that. */
3694 error = OFPERR_OFPBRC_EPERM;
3697 rule_collection_destroy(rules);
3702 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3703 * on classifiers rules are done in the "strict" way required for OpenFlow
3704 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3705 * rules on list 'rules'.
3707 * Returns 0 on success, otherwise an OpenFlow error code. */
3709 collect_rules_strict(struct ofproto *ofproto,
3710 const struct rule_criteria *criteria,
3711 struct rule_collection *rules)
3712 OVS_REQUIRES(ofproto_mutex)
3714 struct oftable *table;
3715 size_t n_readonly = 0;
3718 rule_collection_init(rules);
3720 if (!check_table_id(ofproto, criteria->table_id)) {
3721 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3725 if (criteria->cookie_mask == OVS_BE64_MAX) {
3728 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3729 hash_cookie(criteria->cookie),
3730 &ofproto->cookies) {
3731 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3732 collect_rule(rule, criteria, rules, &n_readonly);
3736 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3739 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3740 &table->cls, &criteria->cr));
3742 collect_rule(rule, criteria, rules, &n_readonly);
3748 if (!error && !rules->n && n_readonly) {
3749 /* We didn't find any rules to modify. We did find some read-only
3750 * rules that we're not allowed to modify, so report that. */
3751 error = OFPERR_OFPBRC_EPERM;
3754 rule_collection_destroy(rules);
3759 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3760 * forced into the range of a uint16_t. */
3762 age_secs(long long int age_ms)
3764 return (age_ms < 0 ? 0
3765 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3766 : (unsigned int) age_ms / 1000);
3770 handle_flow_stats_request(struct ofconn *ofconn,
3771 const struct ofp_header *request)
3772 OVS_EXCLUDED(ofproto_mutex)
3774 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3775 struct ofputil_flow_stats_request fsr;
3776 struct rule_criteria criteria;
3777 struct rule_collection rules;
3778 struct list replies;
3782 error = ofputil_decode_flow_stats_request(&fsr, request);
3787 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3788 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3790 ovs_mutex_lock(&ofproto_mutex);
3791 error = collect_rules_loose(ofproto, &criteria, &rules);
3792 rule_criteria_destroy(&criteria);
3794 rule_collection_ref(&rules);
3796 ovs_mutex_unlock(&ofproto_mutex);
3802 ofpmp_init(&replies, request);
3803 for (i = 0; i < rules.n; i++) {
3804 struct rule *rule = rules.rules[i];
3805 long long int now = time_msec();
3806 struct ofputil_flow_stats fs;
3807 long long int created, used, modified;
3808 const struct rule_actions *actions;
3809 enum ofputil_flow_mod_flags flags;
3811 ovs_mutex_lock(&rule->mutex);
3812 fs.cookie = rule->flow_cookie;
3813 fs.idle_timeout = rule->idle_timeout;
3814 fs.hard_timeout = rule->hard_timeout;
3815 fs.importance = rule->importance;
3816 created = rule->created;
3817 modified = rule->modified;
3818 actions = rule_get_actions(rule);
3819 flags = rule->flags;
3820 ovs_mutex_unlock(&rule->mutex);
3822 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3823 &fs.byte_count, &used);
3825 minimatch_expand(&rule->cr.match, &fs.match);
3826 fs.table_id = rule->table_id;
3827 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3828 fs.priority = rule->cr.priority;
3829 fs.idle_age = age_secs(now - used);
3830 fs.hard_age = age_secs(now - modified);
3831 fs.ofpacts = actions->ofpacts;
3832 fs.ofpacts_len = actions->ofpacts_len;
3835 ofputil_append_flow_stats_reply(&fs, &replies);
3838 rule_collection_unref(&rules);
3839 rule_collection_destroy(&rules);
3841 ofconn_send_replies(ofconn, &replies);
3847 flow_stats_ds(struct rule *rule, struct ds *results)
3849 uint64_t packet_count, byte_count;
3850 const struct rule_actions *actions;
3851 long long int created, used;
3853 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3854 &byte_count, &used);
3856 ovs_mutex_lock(&rule->mutex);
3857 actions = rule_get_actions(rule);
3858 created = rule->created;
3859 ovs_mutex_unlock(&rule->mutex);
3861 if (rule->table_id != 0) {
3862 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3864 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3865 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3866 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3867 cls_rule_format(&rule->cr, results);
3868 ds_put_char(results, ',');
3870 ds_put_cstr(results, "actions=");
3871 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3873 ds_put_cstr(results, "\n");
3876 /* Adds a pretty-printed description of all flows to 'results', including
3877 * hidden flows (e.g., set up by in-band control). */
3879 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3881 struct oftable *table;
3883 OFPROTO_FOR_EACH_TABLE (table, p) {
3886 CLS_FOR_EACH (rule, cr, &table->cls) {
3887 flow_stats_ds(rule, results);
3892 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3893 * '*engine_type' and '*engine_id', respectively. */
3895 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3896 uint8_t *engine_type, uint8_t *engine_id)
3898 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3901 /* Checks the status change of CFM on 'ofport'.
3903 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
3905 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
3907 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3908 return (ofport && ofproto->ofproto_class->cfm_status_changed
3909 ? ofproto->ofproto_class->cfm_status_changed(ofport)
3913 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3914 * Returns 0 if the port's CFM status was successfully stored into
3915 * '*status'. Returns positive errno if the port did not have CFM
3918 * The caller must provide and own '*status', and must free 'status->rmps'.
3919 * '*status' is indeterminate if the return value is non-zero. */
3921 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3922 struct cfm_status *status)
3924 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3925 return (ofport && ofproto->ofproto_class->get_cfm_status
3926 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
3931 handle_aggregate_stats_request(struct ofconn *ofconn,
3932 const struct ofp_header *oh)
3933 OVS_EXCLUDED(ofproto_mutex)
3935 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3936 struct ofputil_flow_stats_request request;
3937 struct ofputil_aggregate_stats stats;
3938 bool unknown_packets, unknown_bytes;
3939 struct rule_criteria criteria;
3940 struct rule_collection rules;
3941 struct ofpbuf *reply;
3945 error = ofputil_decode_flow_stats_request(&request, oh);
3950 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3951 request.cookie, request.cookie_mask,
3952 request.out_port, request.out_group);
3954 ovs_mutex_lock(&ofproto_mutex);
3955 error = collect_rules_loose(ofproto, &criteria, &rules);
3956 rule_criteria_destroy(&criteria);
3958 rule_collection_ref(&rules);
3960 ovs_mutex_unlock(&ofproto_mutex);
3966 memset(&stats, 0, sizeof stats);
3967 unknown_packets = unknown_bytes = false;
3968 for (i = 0; i < rules.n; i++) {
3969 struct rule *rule = rules.rules[i];
3970 uint64_t packet_count;
3971 uint64_t byte_count;
3974 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3975 &byte_count, &used);
3977 if (packet_count == UINT64_MAX) {
3978 unknown_packets = true;
3980 stats.packet_count += packet_count;
3983 if (byte_count == UINT64_MAX) {
3984 unknown_bytes = true;
3986 stats.byte_count += byte_count;
3991 if (unknown_packets) {
3992 stats.packet_count = UINT64_MAX;
3994 if (unknown_bytes) {
3995 stats.byte_count = UINT64_MAX;
3998 rule_collection_unref(&rules);
3999 rule_collection_destroy(&rules);
4001 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4002 ofconn_send_reply(ofconn, reply);
4007 struct queue_stats_cbdata {
4008 struct ofport *ofport;
4009 struct list replies;
4014 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4015 const struct netdev_queue_stats *stats)
4017 struct ofputil_queue_stats oqs;
4019 oqs.port_no = cbdata->ofport->pp.port_no;
4020 oqs.queue_id = queue_id;
4021 oqs.tx_bytes = stats->tx_bytes;
4022 oqs.tx_packets = stats->tx_packets;
4023 oqs.tx_errors = stats->tx_errors;
4024 if (stats->created != LLONG_MIN) {
4025 calc_duration(stats->created, cbdata->now,
4026 &oqs.duration_sec, &oqs.duration_nsec);
4028 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4030 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4034 handle_queue_stats_dump_cb(uint32_t queue_id,
4035 struct netdev_queue_stats *stats,
4038 struct queue_stats_cbdata *cbdata = cbdata_;
4040 put_queue_stats(cbdata, queue_id, stats);
4044 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4045 struct queue_stats_cbdata *cbdata)
4047 cbdata->ofport = port;
4048 if (queue_id == OFPQ_ALL) {
4049 netdev_dump_queue_stats(port->netdev,
4050 handle_queue_stats_dump_cb, cbdata);
4052 struct netdev_queue_stats stats;
4054 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4055 put_queue_stats(cbdata, queue_id, &stats);
4057 return OFPERR_OFPQOFC_BAD_QUEUE;
4064 handle_queue_stats_request(struct ofconn *ofconn,
4065 const struct ofp_header *rq)
4067 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4068 struct queue_stats_cbdata cbdata;
4069 struct ofport *port;
4071 struct ofputil_queue_stats_request oqsr;
4073 COVERAGE_INC(ofproto_queue_req);
4075 ofpmp_init(&cbdata.replies, rq);
4076 cbdata.now = time_msec();
4078 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4083 if (oqsr.port_no == OFPP_ANY) {
4084 error = OFPERR_OFPQOFC_BAD_QUEUE;
4085 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4086 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4091 port = ofproto_get_port(ofproto, oqsr.port_no);
4093 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4094 : OFPERR_OFPQOFC_BAD_PORT);
4097 ofconn_send_replies(ofconn, &cbdata.replies);
4099 ofpbuf_list_delete(&cbdata.replies);
4106 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
4107 OVS_REQUIRES(ofproto_mutex)
4108 OVS_NO_THREAD_SAFETY_ANALYSIS
4110 return classifier_count(&table->cls) + extra_space > table->max_flows;
4114 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4115 OVS_REQUIRES(ofproto_mutex)
4117 while (should_evict_a_rule(table, extra_space)) {
4120 if (!choose_rule_to_evict(table, &rule)) {
4121 return OFPERR_OFPFMFC_TABLE_FULL;
4123 ofproto_rule_delete__(rule, OFPRR_EVICTION);
4130 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4131 * in which no matching flow already exists in the flow table.
4133 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4134 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4135 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4136 * initiated now but may be retried later.
4138 * The caller retains ownership of 'fm->ofpacts'.
4140 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4143 add_flow(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4144 const struct flow_mod_requester *req)
4145 OVS_REQUIRES(ofproto_mutex)
4147 const struct rule_actions *actions;
4148 struct oftable *table;
4154 if (!check_table_id(ofproto, fm->table_id)) {
4155 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4160 if (fm->table_id == 0xff) {
4161 if (ofproto->ofproto_class->rule_choose_table) {
4162 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4168 ovs_assert(table_id < ofproto->n_tables);
4172 } else if (fm->table_id < ofproto->n_tables) {
4173 table_id = fm->table_id;
4175 return OFPERR_OFPBRC_BAD_TABLE_ID;
4178 table = &ofproto->tables[table_id];
4179 if (table->flags & OFTABLE_READONLY
4180 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4181 return OFPERR_OFPBRC_EPERM;
4184 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4185 if (!match_has_default_hidden_fields(&fm->match)) {
4186 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4187 "non-default values to hidden fields", ofproto->name);
4188 return OFPERR_OFPBRC_EPERM;
4192 cls_rule_init(&cr, &fm->match, fm->priority);
4194 /* Transform "add" into "modify" if there's an existing identical flow. */
4195 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4197 struct rule_collection rules;
4199 cls_rule_destroy(&cr);
4201 rule_collection_init(&rules);
4202 rule_collection_add(&rules, rule);
4203 fm->modify_cookie = true;
4204 error = modify_flows__(ofproto, fm, &rules, req);
4205 rule_collection_destroy(&rules);
4210 /* Check for overlap, if requested. */
4211 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4212 if (classifier_rule_overlaps(&table->cls, &cr)) {
4213 cls_rule_destroy(&cr);
4214 return OFPERR_OFPFMFC_OVERLAP;
4218 /* If necessary, evict an existing rule to clear out space. */
4219 error = evict_rules_from_table(table, 1);
4221 cls_rule_destroy(&cr);
4225 /* Allocate new rule. */
4226 rule = ofproto->ofproto_class->rule_alloc();
4228 cls_rule_destroy(&cr);
4229 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4230 ofproto->name, ovs_strerror(error));
4234 /* Initialize base state. */
4235 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4236 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4237 ovs_refcount_init(&rule->ref_count);
4238 rule->flow_cookie = fm->new_cookie;
4239 rule->created = rule->modified = time_msec();
4241 ovs_mutex_init(&rule->mutex);
4242 ovs_mutex_lock(&rule->mutex);
4243 rule->idle_timeout = fm->idle_timeout;
4244 rule->hard_timeout = fm->hard_timeout;
4245 rule->importance = fm->importance;
4246 ovs_mutex_unlock(&rule->mutex);
4248 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4249 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4250 actions = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4251 ovsrcu_set(&rule->actions, actions);
4252 list_init(&rule->meter_list_node);
4253 rule->eviction_group = NULL;
4254 list_init(&rule->expirable);
4255 rule->monitor_flags = 0;
4256 rule->add_seqno = 0;
4257 rule->modify_seqno = 0;
4259 /* Construct rule, initializing derived state. */
4260 error = ofproto->ofproto_class->rule_construct(rule);
4262 ofproto_rule_destroy__(rule);
4266 if (fm->hard_timeout || fm->idle_timeout) {
4267 list_insert(&ofproto->expirable, &rule->expirable);
4269 cookies_insert(ofproto, rule);
4270 eviction_group_add_rule(rule);
4271 if (actions->has_meter) {
4272 meter_insert_rule(rule);
4275 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
4277 error = ofproto->ofproto_class->rule_insert(rule);
4279 oftable_remove_rule(rule);
4280 ofproto_rule_unref(rule);
4283 learned_cookies_inc(ofproto, actions);
4285 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
4286 if (ofproto->vlan_bitmap) {
4287 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4288 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4289 bitmap_set1(ofproto->vlan_bitmap, vid);
4290 ofproto->vlans_changed = true;
4293 ofproto->vlans_changed = true;
4297 ofmonitor_report(ofproto->connmgr, rule, NXFME_ADDED, 0,
4298 req ? req->ofconn : NULL, req ? req->xid : 0, NULL);
4300 return req ? send_buffered_packet(req->ofconn, fm->buffer_id, rule) : 0;
4303 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4305 /* Modifies the rules listed in 'rules', changing their actions to match those
4308 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4311 * Returns 0 on success, otherwise an OpenFlow error code. */
4313 modify_flows__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4314 const struct rule_collection *rules,
4315 const struct flow_mod_requester *req)
4316 OVS_REQUIRES(ofproto_mutex)
4318 struct list dead_cookies = LIST_INITIALIZER(&dead_cookies);
4319 enum nx_flow_update_event event;
4322 if (ofproto->ofproto_class->rule_premodify_actions) {
4323 for (i = 0; i < rules->n; i++) {
4324 struct rule *rule = rules->rules[i];
4327 error = ofproto->ofproto_class->rule_premodify_actions(
4328 rule, fm->ofpacts, fm->ofpacts_len);
4335 event = fm->command == OFPFC_ADD ? NXFME_ADDED : NXFME_MODIFIED;
4336 for (i = 0; i < rules->n; i++) {
4337 struct rule *rule = rules->rules[i];
4339 /* 'fm' says that */
4340 bool change_cookie = (fm->modify_cookie
4341 && fm->new_cookie != OVS_BE64_MAX
4342 && fm->new_cookie != rule->flow_cookie);
4344 const struct rule_actions *actions = rule_get_actions(rule);
4345 bool change_actions = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4347 actions->ofpacts_len);
4349 bool reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4351 long long int now = time_msec();
4353 if (change_cookie) {
4354 cookies_remove(ofproto, rule);
4357 ovs_mutex_lock(&rule->mutex);
4358 if (fm->command == OFPFC_ADD) {
4359 rule->idle_timeout = fm->idle_timeout;
4360 rule->hard_timeout = fm->hard_timeout;
4361 rule->importance = fm->importance;
4362 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4363 rule->created = now;
4365 if (change_cookie) {
4366 rule->flow_cookie = fm->new_cookie;
4368 rule->modified = now;
4369 ovs_mutex_unlock(&rule->mutex);
4371 if (change_cookie) {
4372 cookies_insert(ofproto, rule);
4374 if (fm->command == OFPFC_ADD) {
4375 if (fm->idle_timeout || fm->hard_timeout || fm->importance) {
4376 if (!rule->eviction_group) {
4377 eviction_group_add_rule(rule);
4380 eviction_group_remove_rule(rule);
4384 if (change_actions) {
4385 ovsrcu_set(&rule->actions, rule_actions_create(fm->ofpacts,
4389 if (change_actions || reset_counters) {
4390 ofproto->ofproto_class->rule_modify_actions(rule, reset_counters);
4393 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4394 ofmonitor_report(ofproto->connmgr, rule, event, 0,
4395 req ? req->ofconn : NULL, req ? req->xid : 0,
4396 change_actions ? actions : NULL);
4399 if (change_actions) {
4400 learned_cookies_inc(ofproto, rule_get_actions(rule));
4401 learned_cookies_dec(ofproto, actions, &dead_cookies);
4402 rule_actions_destroy(actions);
4405 learned_cookies_flush(ofproto, &dead_cookies);
4407 if (fm->buffer_id != UINT32_MAX && req) {
4408 return send_buffered_packet(req->ofconn, fm->buffer_id,
4416 modify_flows_add(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4417 const struct flow_mod_requester *req)
4418 OVS_REQUIRES(ofproto_mutex)
4420 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4423 return add_flow(ofproto, fm, req);
4426 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4429 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4432 modify_flows_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4433 const struct flow_mod_requester *req)
4434 OVS_REQUIRES(ofproto_mutex)
4436 struct rule_criteria criteria;
4437 struct rule_collection rules;
4440 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4441 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4442 rule_criteria_require_rw(&criteria,
4443 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4444 error = collect_rules_loose(ofproto, &criteria, &rules);
4445 rule_criteria_destroy(&criteria);
4448 error = (rules.n > 0
4449 ? modify_flows__(ofproto, fm, &rules, req)
4450 : modify_flows_add(ofproto, fm, req));
4453 rule_collection_destroy(&rules);
4458 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4459 * code on failure. */
4461 modify_flow_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4462 const struct flow_mod_requester *req)
4463 OVS_REQUIRES(ofproto_mutex)
4465 struct rule_criteria criteria;
4466 struct rule_collection rules;
4469 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4470 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4471 rule_criteria_require_rw(&criteria,
4472 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4473 error = collect_rules_strict(ofproto, &criteria, &rules);
4474 rule_criteria_destroy(&criteria);
4478 error = modify_flows_add(ofproto, fm, req);
4479 } else if (rules.n == 1) {
4480 error = modify_flows__(ofproto, fm, &rules, req);
4484 rule_collection_destroy(&rules);
4489 /* OFPFC_DELETE implementation. */
4491 /* Deletes the rules listed in 'rules'. */
4493 delete_flows__(const struct rule_collection *rules,
4494 enum ofp_flow_removed_reason reason,
4495 const struct flow_mod_requester *req)
4496 OVS_REQUIRES(ofproto_mutex)
4499 struct list dead_cookies = LIST_INITIALIZER(&dead_cookies);
4500 struct ofproto *ofproto = rules->rules[0]->ofproto;
4503 for (i = 0; i < rules->n; i++) {
4504 struct rule *rule = rules->rules[i];
4505 const struct rule_actions *actions = rule_get_actions(rule);
4507 ofproto_rule_send_removed(rule, reason);
4509 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4510 req ? req->ofconn : NULL, req ? req->xid : 0,
4512 oftable_remove_rule(rule);
4513 ofproto->ofproto_class->rule_delete(rule);
4515 learned_cookies_dec(ofproto, actions, &dead_cookies);
4517 learned_cookies_flush(ofproto, &dead_cookies);
4518 ofmonitor_flush(ofproto->connmgr);
4522 /* Implements OFPFC_DELETE. */
4524 delete_flows_loose(struct ofproto *ofproto,
4525 const struct ofputil_flow_mod *fm,
4526 const struct flow_mod_requester *req)
4527 OVS_REQUIRES(ofproto_mutex)
4529 struct rule_criteria criteria;
4530 struct rule_collection rules;
4533 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4534 fm->cookie, fm->cookie_mask,
4535 fm->out_port, fm->out_group);
4536 rule_criteria_require_rw(&criteria,
4537 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4538 error = collect_rules_loose(ofproto, &criteria, &rules);
4539 rule_criteria_destroy(&criteria);
4541 if (!error && rules.n > 0) {
4542 delete_flows__(&rules, fm->delete_reason, req);
4544 rule_collection_destroy(&rules);
4549 /* Implements OFPFC_DELETE_STRICT. */
4551 delete_flow_strict(struct ofproto *ofproto, const struct ofputil_flow_mod *fm,
4552 const struct flow_mod_requester *req)
4553 OVS_REQUIRES(ofproto_mutex)
4555 struct rule_criteria criteria;
4556 struct rule_collection rules;
4559 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4560 fm->cookie, fm->cookie_mask,
4561 fm->out_port, fm->out_group);
4562 rule_criteria_require_rw(&criteria,
4563 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4564 error = collect_rules_strict(ofproto, &criteria, &rules);
4565 rule_criteria_destroy(&criteria);
4567 if (!error && rules.n > 0) {
4568 delete_flows__(&rules, fm->delete_reason, req);
4570 rule_collection_destroy(&rules);
4576 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4577 OVS_REQUIRES(ofproto_mutex)
4579 struct ofputil_flow_removed fr;
4582 if (rule_is_hidden(rule) ||
4583 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4587 minimatch_expand(&rule->cr.match, &fr.match);
4588 fr.priority = rule->cr.priority;
4589 fr.cookie = rule->flow_cookie;
4591 fr.table_id = rule->table_id;
4592 calc_duration(rule->created, time_msec(),
4593 &fr.duration_sec, &fr.duration_nsec);
4594 ovs_mutex_lock(&rule->mutex);
4595 fr.idle_timeout = rule->idle_timeout;
4596 fr.hard_timeout = rule->hard_timeout;
4597 ovs_mutex_unlock(&rule->mutex);
4598 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4599 &fr.byte_count, &used);
4601 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4604 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4605 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4608 * ofproto implementation ->run() functions should use this function to expire
4609 * OpenFlow flows. */
4611 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4612 OVS_REQUIRES(ofproto_mutex)
4614 ofproto_rule_delete__(rule, reason);
4617 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4618 * means "infinite". */
4620 reduce_timeout(uint16_t max, uint16_t *timeout)
4622 if (max && (!*timeout || *timeout > max)) {
4627 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4628 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4629 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4631 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4633 ofproto_rule_reduce_timeouts(struct rule *rule,
4634 uint16_t idle_timeout, uint16_t hard_timeout)
4635 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4637 if (!idle_timeout && !hard_timeout) {
4641 ovs_mutex_lock(&ofproto_mutex);
4642 if (list_is_empty(&rule->expirable)) {
4643 list_insert(&rule->ofproto->expirable, &rule->expirable);
4645 ovs_mutex_unlock(&ofproto_mutex);
4647 ovs_mutex_lock(&rule->mutex);
4648 reduce_timeout(idle_timeout, &rule->idle_timeout);
4649 reduce_timeout(hard_timeout, &rule->hard_timeout);
4650 ovs_mutex_unlock(&rule->mutex);
4654 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4655 OVS_EXCLUDED(ofproto_mutex)
4657 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4658 struct ofputil_flow_mod fm;
4659 uint64_t ofpacts_stub[1024 / 8];
4660 struct ofpbuf ofpacts;
4663 error = reject_slave_controller(ofconn);
4668 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4669 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4671 u16_to_ofp(ofproto->max_ports),
4674 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4677 struct flow_mod_requester req;
4679 req.ofconn = ofconn;
4681 error = handle_flow_mod__(ofproto, &fm, &req);
4684 goto exit_free_ofpacts;
4687 ofconn_report_flow_mod(ofconn, fm.command);
4690 ofpbuf_uninit(&ofpacts);
4696 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4697 const struct flow_mod_requester *req)
4698 OVS_EXCLUDED(ofproto_mutex)
4702 ovs_mutex_lock(&ofproto_mutex);
4703 switch (fm->command) {
4705 error = add_flow(ofproto, fm, req);
4709 error = modify_flows_loose(ofproto, fm, req);
4712 case OFPFC_MODIFY_STRICT:
4713 error = modify_flow_strict(ofproto, fm, req);
4717 error = delete_flows_loose(ofproto, fm, req);
4720 case OFPFC_DELETE_STRICT:
4721 error = delete_flow_strict(ofproto, fm, req);
4725 if (fm->command > 0xff) {
4726 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4727 "flow_mod_table_id extension is not enabled",
4730 error = OFPERR_OFPFMFC_BAD_COMMAND;
4733 ofmonitor_flush(ofproto->connmgr);
4734 ovs_mutex_unlock(&ofproto_mutex);
4736 run_rule_executes(ofproto);
4741 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4743 struct ofputil_role_request request;
4744 struct ofputil_role_request reply;
4748 error = ofputil_decode_role_message(oh, &request);
4753 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4754 if (request.have_generation_id
4755 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4756 return OFPERR_OFPRRFC_STALE;
4759 ofconn_set_role(ofconn, request.role);
4762 reply.role = ofconn_get_role(ofconn);
4763 reply.have_generation_id = ofconn_get_master_election_id(
4764 ofconn, &reply.generation_id);
4765 buf = ofputil_encode_role_reply(oh, &reply);
4766 ofconn_send_reply(ofconn, buf);
4772 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4773 const struct ofp_header *oh)
4775 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4776 enum ofputil_protocol cur, next;
4778 cur = ofconn_get_protocol(ofconn);
4779 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4780 ofconn_set_protocol(ofconn, next);
4786 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4788 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4789 enum ofputil_protocol cur, next;
4790 enum ofputil_protocol next_base;
4792 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4794 return OFPERR_OFPBRC_EPERM;
4797 cur = ofconn_get_protocol(ofconn);
4798 next = ofputil_protocol_set_base(cur, next_base);
4799 ofconn_set_protocol(ofconn, next);
4805 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4806 const struct ofp_header *oh)
4808 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4811 format = ntohl(msg->format);
4812 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4813 return OFPERR_OFPBRC_EPERM;
4816 ofconn_set_packet_in_format(ofconn, format);
4821 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4823 const struct nx_async_config *msg = ofpmsg_body(oh);
4824 uint32_t master[OAM_N_TYPES];
4825 uint32_t slave[OAM_N_TYPES];
4827 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4828 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4829 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4831 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4832 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4833 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4835 ofconn_set_async_config(ofconn, master, slave);
4836 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4837 !ofconn_get_miss_send_len(ofconn)) {
4838 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4845 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4848 uint32_t master[OAM_N_TYPES];
4849 uint32_t slave[OAM_N_TYPES];
4850 struct nx_async_config *msg;
4852 ofconn_get_async_config(ofconn, master, slave);
4853 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4854 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4856 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4857 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4858 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4860 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4861 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4862 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4864 ofconn_send_reply(ofconn, buf);
4870 handle_nxt_set_controller_id(struct ofconn *ofconn,
4871 const struct ofp_header *oh)
4873 const struct nx_controller_id *nci = ofpmsg_body(oh);
4875 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4876 return OFPERR_NXBRC_MUST_BE_ZERO;
4879 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4884 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4888 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4889 ? OFPRAW_OFPT10_BARRIER_REPLY
4890 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4891 ofconn_send_reply(ofconn, buf);
4896 ofproto_compose_flow_refresh_update(const struct rule *rule,
4897 enum nx_flow_monitor_flags flags,
4899 OVS_REQUIRES(ofproto_mutex)
4901 const struct rule_actions *actions;
4902 struct ofputil_flow_update fu;
4905 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4906 ? NXFME_ADDED : NXFME_MODIFIED);
4908 ovs_mutex_lock(&rule->mutex);
4909 fu.idle_timeout = rule->idle_timeout;
4910 fu.hard_timeout = rule->hard_timeout;
4911 ovs_mutex_unlock(&rule->mutex);
4912 fu.table_id = rule->table_id;
4913 fu.cookie = rule->flow_cookie;
4914 minimatch_expand(&rule->cr.match, &match);
4916 fu.priority = rule->cr.priority;
4918 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
4919 fu.ofpacts = actions ? actions->ofpacts : NULL;
4920 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4922 if (list_is_empty(msgs)) {
4923 ofputil_start_flow_update(msgs);
4925 ofputil_append_flow_update(&fu, msgs);
4929 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4931 OVS_REQUIRES(ofproto_mutex)
4935 for (i = 0; i < rules->n; i++) {
4936 struct rule *rule = rules->rules[i];
4937 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4938 rule->monitor_flags = 0;
4940 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4945 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4946 struct rule *rule, uint64_t seqno,
4947 struct rule_collection *rules)
4948 OVS_REQUIRES(ofproto_mutex)
4950 enum nx_flow_monitor_flags update;
4952 if (rule_is_hidden(rule)) {
4956 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
4961 if (rule->add_seqno > seqno) {
4962 update = NXFMF_ADD | NXFMF_MODIFY;
4963 } else if (rule->modify_seqno > seqno) {
4964 update = NXFMF_MODIFY;
4969 if (!(m->flags & update)) {
4973 update = NXFMF_INITIAL;
4976 if (!rule->monitor_flags) {
4977 rule_collection_add(rules, rule);
4979 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4983 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4985 struct rule_collection *rules)
4986 OVS_REQUIRES(ofproto_mutex)
4988 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4989 const struct oftable *table;
4990 struct cls_rule target;
4992 cls_rule_init_from_minimatch(&target, &m->match, 0);
4993 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4996 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
4997 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5000 cls_rule_destroy(&target);
5004 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5005 struct rule_collection *rules)
5006 OVS_REQUIRES(ofproto_mutex)
5008 if (m->flags & NXFMF_INITIAL) {
5009 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5014 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5015 uint64_t seqno, struct rule_collection *rules)
5016 OVS_REQUIRES(ofproto_mutex)
5018 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5022 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5023 OVS_REQUIRES(ofproto_mutex)
5025 struct ofmonitor *m;
5028 m = ofmonitor_lookup(ofconn, id);
5030 ofmonitor_destroy(m);
5033 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5040 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5041 OVS_EXCLUDED(ofproto_mutex)
5043 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5044 struct ofmonitor **monitors;
5045 size_t n_monitors, allocated_monitors;
5046 struct rule_collection rules;
5047 struct list replies;
5052 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5054 n_monitors = allocated_monitors = 0;
5056 ovs_mutex_lock(&ofproto_mutex);
5058 struct ofputil_flow_monitor_request request;
5059 struct ofmonitor *m;
5062 retval = ofputil_decode_flow_monitor_request(&request, &b);
5063 if (retval == EOF) {
5065 } else if (retval) {
5070 if (request.table_id != 0xff
5071 && request.table_id >= ofproto->n_tables) {
5072 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5076 error = ofmonitor_create(&request, ofconn, &m);
5081 if (n_monitors >= allocated_monitors) {
5082 monitors = x2nrealloc(monitors, &allocated_monitors,
5085 monitors[n_monitors++] = m;
5088 rule_collection_init(&rules);
5089 for (i = 0; i < n_monitors; i++) {
5090 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5093 ofpmp_init(&replies, oh);
5094 ofmonitor_compose_refresh_updates(&rules, &replies);
5095 ovs_mutex_unlock(&ofproto_mutex);
5097 rule_collection_destroy(&rules);
5099 ofconn_send_replies(ofconn, &replies);
5105 for (i = 0; i < n_monitors; i++) {
5106 ofmonitor_destroy(monitors[i]);
5109 ovs_mutex_unlock(&ofproto_mutex);
5115 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5116 OVS_EXCLUDED(ofproto_mutex)
5121 id = ofputil_decode_flow_monitor_cancel(oh);
5123 ovs_mutex_lock(&ofproto_mutex);
5124 error = flow_monitor_delete(ofconn, id);
5125 ovs_mutex_unlock(&ofproto_mutex);
5130 /* Meters implementation.
5132 * Meter table entry, indexed by the OpenFlow meter_id.
5133 * 'created' is used to compute the duration for meter stats.
5134 * 'list rules' is needed so that we can delete the dependent rules when the
5135 * meter table entry is deleted.
5136 * 'provider_meter_id' is for the provider's private use.
5139 long long int created; /* Time created. */
5140 struct list rules; /* List of "struct rule_dpif"s. */
5141 ofproto_meter_id provider_meter_id;
5142 uint16_t flags; /* Meter flags. */
5143 uint16_t n_bands; /* Number of meter bands. */
5144 struct ofputil_meter_band *bands;
5148 * This is used in instruction validation at flow set-up time,
5149 * as flows may not use non-existing meters.
5150 * Return value of UINT32_MAX signifies an invalid meter.
5153 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5155 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5156 const struct meter *meter = ofproto->meters[of_meter_id];
5158 return meter->provider_meter_id.uint32;
5164 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5167 meter_insert_rule(struct rule *rule)
5169 const struct rule_actions *a = rule_get_actions(rule);
5170 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5171 struct meter *meter = rule->ofproto->meters[meter_id];
5173 list_insert(&meter->rules, &rule->meter_list_node);
5177 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5181 meter->flags = config->flags;
5182 meter->n_bands = config->n_bands;
5183 meter->bands = xmemdup(config->bands,
5184 config->n_bands * sizeof *meter->bands);
5187 static struct meter *
5188 meter_create(const struct ofputil_meter_config *config,
5189 ofproto_meter_id provider_meter_id)
5191 struct meter *meter;
5193 meter = xzalloc(sizeof *meter);
5194 meter->provider_meter_id = provider_meter_id;
5195 meter->created = time_msec();
5196 list_init(&meter->rules);
5198 meter_update(meter, config);
5204 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5205 OVS_REQUIRES(ofproto_mutex)
5208 for (mid = first; mid <= last; ++mid) {
5209 struct meter *meter = ofproto->meters[mid];
5211 ofproto->meters[mid] = NULL;
5212 ofproto->ofproto_class->meter_del(ofproto,
5213 meter->provider_meter_id);
5221 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5223 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5224 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5228 return OFPERR_OFPMMFC_METER_EXISTS;
5231 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5234 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5235 *meterp = meter_create(&mm->meter, provider_meter_id);
5241 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5243 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5245 uint32_t provider_meter_id;
5248 return OFPERR_OFPMMFC_UNKNOWN_METER;
5251 provider_meter_id = meter->provider_meter_id.uint32;
5252 error = ofproto->ofproto_class->meter_set(ofproto,
5253 &meter->provider_meter_id,
5255 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5257 meter_update(meter, &mm->meter);
5263 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5264 OVS_EXCLUDED(ofproto_mutex)
5266 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5267 uint32_t meter_id = mm->meter.meter_id;
5268 struct rule_collection rules;
5269 enum ofperr error = 0;
5270 uint32_t first, last;
5272 if (meter_id == OFPM13_ALL) {
5274 last = ofproto->meter_features.max_meters;
5276 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5279 first = last = meter_id;
5282 /* First delete the rules that use this meter. If any of those rules are
5283 * currently being modified, postpone the whole operation until later. */
5284 rule_collection_init(&rules);
5285 ovs_mutex_lock(&ofproto_mutex);
5286 for (meter_id = first; meter_id <= last; ++meter_id) {
5287 struct meter *meter = ofproto->meters[meter_id];
5288 if (meter && !list_is_empty(&meter->rules)) {
5291 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5292 rule_collection_add(&rules, rule);
5297 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5300 /* Delete the meters. */
5301 meter_delete(ofproto, first, last);
5303 ovs_mutex_unlock(&ofproto_mutex);
5304 rule_collection_destroy(&rules);
5310 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5312 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5313 struct ofputil_meter_mod mm;
5314 uint64_t bands_stub[256 / 8];
5315 struct ofpbuf bands;
5319 error = reject_slave_controller(ofconn);
5324 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5326 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5328 goto exit_free_bands;
5331 meter_id = mm.meter.meter_id;
5333 if (mm.command != OFPMC13_DELETE) {
5334 /* Fails also when meters are not implemented by the provider. */
5335 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5336 error = OFPERR_OFPMMFC_INVALID_METER;
5337 goto exit_free_bands;
5338 } else if (meter_id > ofproto->meter_features.max_meters) {
5339 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5340 goto exit_free_bands;
5342 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5343 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5344 goto exit_free_bands;
5348 switch (mm.command) {
5350 error = handle_add_meter(ofproto, &mm);
5353 case OFPMC13_MODIFY:
5354 error = handle_modify_meter(ofproto, &mm);
5357 case OFPMC13_DELETE:
5358 error = handle_delete_meter(ofconn, &mm);
5362 error = OFPERR_OFPMMFC_BAD_COMMAND;
5367 ofpbuf_uninit(&bands);
5372 handle_meter_features_request(struct ofconn *ofconn,
5373 const struct ofp_header *request)
5375 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5376 struct ofputil_meter_features features;
5379 if (ofproto->ofproto_class->meter_get_features) {
5380 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5382 memset(&features, 0, sizeof features);
5384 b = ofputil_encode_meter_features_reply(&features, request);
5386 ofconn_send_reply(ofconn, b);
5391 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5394 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5395 struct list replies;
5396 uint64_t bands_stub[256 / 8];
5397 struct ofpbuf bands;
5398 uint32_t meter_id, first, last;
5400 ofputil_decode_meter_request(request, &meter_id);
5402 if (meter_id == OFPM13_ALL) {
5404 last = ofproto->meter_features.max_meters;
5406 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5407 !ofproto->meters[meter_id]) {
5408 return OFPERR_OFPMMFC_UNKNOWN_METER;
5410 first = last = meter_id;
5413 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5414 ofpmp_init(&replies, request);
5416 for (meter_id = first; meter_id <= last; ++meter_id) {
5417 struct meter *meter = ofproto->meters[meter_id];
5419 continue; /* Skip non-existing meters. */
5421 if (type == OFPTYPE_METER_STATS_REQUEST) {
5422 struct ofputil_meter_stats stats;
5424 stats.meter_id = meter_id;
5426 /* Provider sets the packet and byte counts, we do the rest. */
5427 stats.flow_count = list_size(&meter->rules);
5428 calc_duration(meter->created, time_msec(),
5429 &stats.duration_sec, &stats.duration_nsec);
5430 stats.n_bands = meter->n_bands;
5431 ofpbuf_clear(&bands);
5433 = ofpbuf_put_uninit(&bands,
5434 meter->n_bands * sizeof *stats.bands);
5436 if (!ofproto->ofproto_class->meter_get(ofproto,
5437 meter->provider_meter_id,
5439 ofputil_append_meter_stats(&replies, &stats);
5441 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5442 struct ofputil_meter_config config;
5444 config.meter_id = meter_id;
5445 config.flags = meter->flags;
5446 config.n_bands = meter->n_bands;
5447 config.bands = meter->bands;
5448 ofputil_append_meter_config(&replies, &config);
5452 ofconn_send_replies(ofconn, &replies);
5453 ofpbuf_uninit(&bands);
5458 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5459 struct ofgroup **group)
5460 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5462 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5463 hash_int(group_id, 0), &ofproto->groups) {
5464 if ((*group)->group_id == group_id) {
5472 /* If the group exists, this function increments the groups's reference count.
5474 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5475 * a reference to the group. */
5477 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5478 struct ofgroup **group)
5482 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5483 found = ofproto_group_lookup__(ofproto, group_id, group);
5485 ofproto_group_ref(*group);
5487 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5492 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5493 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5495 struct ofgroup *grp;
5497 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5498 hash_int(group_id, 0), &ofproto->groups) {
5499 if (grp->group_id == group_id) {
5507 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5508 OVS_EXCLUDED(ofproto->groups_rwlock)
5512 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5513 exists = ofproto_group_exists__(ofproto, group_id);
5514 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5520 group_get_ref_count(struct ofgroup *group)
5521 OVS_EXCLUDED(ofproto_mutex)
5523 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5524 struct rule_criteria criteria;
5525 struct rule_collection rules;
5530 match_init_catchall(&match);
5531 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5532 OFPP_ANY, group->group_id);
5533 ovs_mutex_lock(&ofproto_mutex);
5534 error = collect_rules_loose(ofproto, &criteria, &rules);
5535 ovs_mutex_unlock(&ofproto_mutex);
5536 rule_criteria_destroy(&criteria);
5538 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5540 rule_collection_destroy(&rules);
5545 append_group_stats(struct ofgroup *group, struct list *replies)
5547 struct ofputil_group_stats ogs;
5548 const struct ofproto *ofproto = group->ofproto;
5549 long long int now = time_msec();
5552 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5554 /* Provider sets the packet and byte counts, we do the rest. */
5555 ogs.ref_count = group_get_ref_count(group);
5556 ogs.n_buckets = group->n_buckets;
5558 error = (ofproto->ofproto_class->group_get_stats
5559 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5562 ogs.packet_count = UINT64_MAX;
5563 ogs.byte_count = UINT64_MAX;
5564 memset(ogs.bucket_stats, 0xff,
5565 ogs.n_buckets * sizeof *ogs.bucket_stats);
5568 ogs.group_id = group->group_id;
5569 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5571 ofputil_append_group_stats(replies, &ogs);
5573 free(ogs.bucket_stats);
5577 handle_group_request(struct ofconn *ofconn,
5578 const struct ofp_header *request, uint32_t group_id,
5579 void (*cb)(struct ofgroup *, struct list *replies))
5581 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5582 struct ofgroup *group;
5583 struct list replies;
5585 ofpmp_init(&replies, request);
5586 if (group_id == OFPG_ALL) {
5587 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5588 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5589 cb(group, &replies);
5591 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5593 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5594 cb(group, &replies);
5595 ofproto_group_unref(group);
5598 ofconn_send_replies(ofconn, &replies);
5602 handle_group_stats_request(struct ofconn *ofconn,
5603 const struct ofp_header *request)
5608 error = ofputil_decode_group_stats_request(request, &group_id);
5613 handle_group_request(ofconn, request, group_id, append_group_stats);
5618 append_group_desc(struct ofgroup *group, struct list *replies)
5620 struct ofputil_group_desc gds;
5622 gds.group_id = group->group_id;
5623 gds.type = group->type;
5624 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5628 handle_group_desc_stats_request(struct ofconn *ofconn,
5629 const struct ofp_header *request)
5631 handle_group_request(ofconn, request,
5632 ofputil_decode_group_desc_request(request),
5638 handle_group_features_stats_request(struct ofconn *ofconn,
5639 const struct ofp_header *request)
5641 struct ofproto *p = ofconn_get_ofproto(ofconn);
5644 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5646 ofconn_send_reply(ofconn, msg);
5653 handle_queue_get_config_request(struct ofconn *ofconn,
5654 const struct ofp_header *oh)
5656 struct ofproto *p = ofconn_get_ofproto(ofconn);
5657 struct netdev_queue_dump queue_dump;
5658 struct ofport *ofport;
5659 unsigned int queue_id;
5660 struct ofpbuf *reply;
5661 struct smap details;
5665 error = ofputil_decode_queue_get_config_request(oh, &request);
5670 ofport = ofproto_get_port(p, request);
5672 return OFPERR_OFPQOFC_BAD_PORT;
5675 reply = ofputil_encode_queue_get_config_reply(oh);
5677 smap_init(&details);
5678 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5679 struct ofputil_queue_config queue;
5681 /* None of the existing queues have compatible properties, so we
5682 * hard-code omitting min_rate and max_rate. */
5683 queue.queue_id = queue_id;
5684 queue.min_rate = UINT16_MAX;
5685 queue.max_rate = UINT16_MAX;
5686 ofputil_append_queue_get_config_reply(reply, &queue);
5688 smap_destroy(&details);
5690 ofconn_send_reply(ofconn, reply);
5696 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
5697 struct ofgroup **ofgroup)
5700 const long long int now = time_msec();
5702 if (gm->group_id > OFPG_MAX) {
5703 return OFPERR_OFPGMFC_INVALID_GROUP;
5705 if (gm->type > OFPGT11_FF) {
5706 return OFPERR_OFPGMFC_BAD_TYPE;
5709 *ofgroup = ofproto->ofproto_class->group_alloc();
5711 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5712 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5715 (*ofgroup)->ofproto = ofproto;
5716 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
5717 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
5718 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
5719 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
5720 ovs_refcount_init(&(*ofgroup)->ref_count);
5722 list_move(&(*ofgroup)->buckets, &gm->buckets);
5723 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
5724 list_size(&(*ofgroup)->buckets);
5726 /* Construct called BEFORE any locks are held. */
5727 error = ofproto->ofproto_class->group_construct(*ofgroup);
5729 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
5730 ofproto->ofproto_class->group_dealloc(*ofgroup);
5735 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
5736 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
5739 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5741 struct ofgroup *ofgroup;
5744 /* Allocate new group and initialize it. */
5745 error = init_group(ofproto, gm, &ofgroup);
5750 /* We wrlock as late as possible to minimize the time we jam any other
5751 * threads: No visible state changes before acquiring the lock. */
5752 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5754 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5755 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5759 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5760 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5765 /* Insert new group. */
5766 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5767 hash_int(ofgroup->group_id, 0));
5768 ofproto->n_groups[ofgroup->type]++;
5770 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5775 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5776 ofproto->ofproto_class->group_destruct(ofgroup);
5777 ofputil_bucket_list_destroy(&ofgroup->buckets);
5778 ofproto->ofproto_class->group_dealloc(ofgroup);
5783 /* Implements OFPGC11_MODIFY. Returns 0 on success or an OpenFlow error code
5786 * Note that the group is re-created and then replaces the old group in
5787 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
5788 * the xlate module hold a pointer to the group. */
5790 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5792 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
5795 error = init_group(ofproto, gm, &new_ofgroup);
5800 retiring = new_ofgroup;
5802 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5803 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
5804 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5808 /* Ofproto's group write lock is held now. */
5809 if (ofgroup->type != gm->type
5810 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5811 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5815 /* The group creation time does not change during modification. */
5816 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
5817 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
5819 error = ofproto->ofproto_class->group_modify(new_ofgroup);
5825 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
5826 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5827 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
5828 hash_int(new_ofgroup->group_id, 0));
5829 if (ofgroup->type != new_ofgroup->type) {
5830 ofproto->n_groups[ofgroup->type]--;
5831 ofproto->n_groups[new_ofgroup->type]++;
5835 ofproto_group_unref(retiring);
5836 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5841 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5842 OVS_RELEASES(ofproto->groups_rwlock)
5845 struct ofputil_flow_mod fm;
5847 /* Delete all flow entries containing this group in a group action */
5848 match_init_catchall(&match);
5849 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5850 fm.delete_reason = OFPRR_GROUP_DELETE;
5851 fm.out_group = ofgroup->group_id;
5852 handle_flow_mod__(ofproto, &fm, NULL);
5854 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5855 /* No-one can find this group any more. */
5856 ofproto->n_groups[ofgroup->type]--;
5857 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5858 ofproto_group_unref(ofgroup);
5861 /* Implements OFPGC11_DELETE. */
5863 delete_group(struct ofproto *ofproto, uint32_t group_id)
5865 struct ofgroup *ofgroup;
5867 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5868 if (group_id == OFPG_ALL) {
5870 struct hmap_node *node = hmap_first(&ofproto->groups);
5874 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5875 delete_group__(ofproto, ofgroup);
5876 /* Lock for each node separately, so that we will not jam the
5877 * other threads for too long time. */
5878 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5881 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5882 hash_int(group_id, 0), &ofproto->groups) {
5883 if (ofgroup->group_id == group_id) {
5884 delete_group__(ofproto, ofgroup);
5889 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5893 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5895 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5896 struct ofputil_group_mod gm;
5899 error = reject_slave_controller(ofconn);
5904 error = ofputil_decode_group_mod(oh, &gm);
5909 switch (gm.command) {
5911 return add_group(ofproto, &gm);
5913 case OFPGC11_MODIFY:
5914 return modify_group(ofproto, &gm);
5916 case OFPGC11_DELETE:
5917 delete_group(ofproto, gm.group_id);
5921 if (gm.command > OFPGC11_DELETE) {
5922 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5923 ofproto->name, gm.command);
5925 return OFPERR_OFPGMFC_BAD_COMMAND;
5929 enum ofputil_table_miss
5930 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
5932 enum ofputil_table_miss value;
5934 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
5939 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5941 if (!check_table_id(ofproto, tm->table_id)) {
5942 return OFPERR_OFPTMFC_BAD_TABLE;
5943 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
5944 if (tm->table_id == OFPTT_ALL) {
5946 for (i = 0; i < ofproto->n_tables; i++) {
5947 atomic_store_relaxed(&ofproto->tables[i].miss_config,
5951 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
5959 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5961 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5962 struct ofputil_table_mod tm;
5965 error = reject_slave_controller(ofconn);
5970 error = ofputil_decode_table_mod(oh, &tm);
5975 return table_mod(ofproto, &tm);
5979 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
5982 struct ofputil_bundle_ctrl_msg bctrl;
5984 struct ofputil_bundle_ctrl_msg reply;
5986 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
5991 reply.bundle_id = bctrl.bundle_id;
5993 switch (bctrl.type) {
5994 case OFPBCT_OPEN_REQUEST:
5995 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
5996 reply.type = OFPBCT_OPEN_REPLY;
5998 case OFPBCT_CLOSE_REQUEST:
5999 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6000 reply.type = OFPBCT_CLOSE_REPLY;;
6002 case OFPBCT_COMMIT_REQUEST:
6003 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6004 reply.type = OFPBCT_COMMIT_REPLY;
6006 case OFPBCT_DISCARD_REQUEST:
6007 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6008 reply.type = OFPBCT_DISCARD_REPLY;
6011 case OFPBCT_OPEN_REPLY:
6012 case OFPBCT_CLOSE_REPLY:
6013 case OFPBCT_COMMIT_REPLY:
6014 case OFPBCT_DISCARD_REPLY:
6015 return OFPERR_OFPBFC_BAD_TYPE;
6020 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6021 ofconn_send_reply(ofconn, buf);
6028 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6031 struct ofputil_bundle_add_msg badd;
6033 error = ofputil_decode_bundle_add(oh, &badd);
6038 return ofp_bundle_add_message(ofconn, &badd);
6042 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6043 OVS_EXCLUDED(ofproto_mutex)
6045 const struct ofp_header *oh = ofpbuf_data(msg);
6049 error = ofptype_decode(&type, oh);
6053 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6054 && ofpmp_more(oh)) {
6055 /* We have no buffer implementation for multipart requests.
6056 * Report overflow for requests which consists of multiple
6058 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6062 /* OpenFlow requests. */
6063 case OFPTYPE_ECHO_REQUEST:
6064 return handle_echo_request(ofconn, oh);
6066 case OFPTYPE_FEATURES_REQUEST:
6067 return handle_features_request(ofconn, oh);
6069 case OFPTYPE_GET_CONFIG_REQUEST:
6070 return handle_get_config_request(ofconn, oh);
6072 case OFPTYPE_SET_CONFIG:
6073 return handle_set_config(ofconn, oh);
6075 case OFPTYPE_PACKET_OUT:
6076 return handle_packet_out(ofconn, oh);
6078 case OFPTYPE_PORT_MOD:
6079 return handle_port_mod(ofconn, oh);
6081 case OFPTYPE_FLOW_MOD:
6082 return handle_flow_mod(ofconn, oh);
6084 case OFPTYPE_GROUP_MOD:
6085 return handle_group_mod(ofconn, oh);
6087 case OFPTYPE_TABLE_MOD:
6088 return handle_table_mod(ofconn, oh);
6090 case OFPTYPE_METER_MOD:
6091 return handle_meter_mod(ofconn, oh);
6093 case OFPTYPE_BARRIER_REQUEST:
6094 return handle_barrier_request(ofconn, oh);
6096 case OFPTYPE_ROLE_REQUEST:
6097 return handle_role_request(ofconn, oh);
6099 /* OpenFlow replies. */
6100 case OFPTYPE_ECHO_REPLY:
6103 /* Nicira extension requests. */
6104 case OFPTYPE_FLOW_MOD_TABLE_ID:
6105 return handle_nxt_flow_mod_table_id(ofconn, oh);
6107 case OFPTYPE_SET_FLOW_FORMAT:
6108 return handle_nxt_set_flow_format(ofconn, oh);
6110 case OFPTYPE_SET_PACKET_IN_FORMAT:
6111 return handle_nxt_set_packet_in_format(ofconn, oh);
6113 case OFPTYPE_SET_CONTROLLER_ID:
6114 return handle_nxt_set_controller_id(ofconn, oh);
6116 case OFPTYPE_FLOW_AGE:
6117 /* Nothing to do. */
6120 case OFPTYPE_FLOW_MONITOR_CANCEL:
6121 return handle_flow_monitor_cancel(ofconn, oh);
6123 case OFPTYPE_SET_ASYNC_CONFIG:
6124 return handle_nxt_set_async_config(ofconn, oh);
6126 case OFPTYPE_GET_ASYNC_REQUEST:
6127 return handle_nxt_get_async_request(ofconn, oh);
6129 /* Statistics requests. */
6130 case OFPTYPE_DESC_STATS_REQUEST:
6131 return handle_desc_stats_request(ofconn, oh);
6133 case OFPTYPE_FLOW_STATS_REQUEST:
6134 return handle_flow_stats_request(ofconn, oh);
6136 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6137 return handle_aggregate_stats_request(ofconn, oh);
6139 case OFPTYPE_TABLE_STATS_REQUEST:
6140 return handle_table_stats_request(ofconn, oh);
6142 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6143 return handle_table_features_request(ofconn, oh);
6145 case OFPTYPE_PORT_STATS_REQUEST:
6146 return handle_port_stats_request(ofconn, oh);
6148 case OFPTYPE_QUEUE_STATS_REQUEST:
6149 return handle_queue_stats_request(ofconn, oh);
6151 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6152 return handle_port_desc_stats_request(ofconn, oh);
6154 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6155 return handle_flow_monitor_request(ofconn, oh);
6157 case OFPTYPE_METER_STATS_REQUEST:
6158 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6159 return handle_meter_request(ofconn, oh, type);
6161 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6162 return handle_meter_features_request(ofconn, oh);
6164 case OFPTYPE_GROUP_STATS_REQUEST:
6165 return handle_group_stats_request(ofconn, oh);
6167 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6168 return handle_group_desc_stats_request(ofconn, oh);
6170 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6171 return handle_group_features_stats_request(ofconn, oh);
6173 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6174 return handle_queue_get_config_request(ofconn, oh);
6176 case OFPTYPE_BUNDLE_CONTROL:
6177 return handle_bundle_control(ofconn, oh);
6179 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6180 return handle_bundle_add(ofconn, oh);
6184 case OFPTYPE_FEATURES_REPLY:
6185 case OFPTYPE_GET_CONFIG_REPLY:
6186 case OFPTYPE_PACKET_IN:
6187 case OFPTYPE_FLOW_REMOVED:
6188 case OFPTYPE_PORT_STATUS:
6189 case OFPTYPE_BARRIER_REPLY:
6190 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6191 case OFPTYPE_DESC_STATS_REPLY:
6192 case OFPTYPE_FLOW_STATS_REPLY:
6193 case OFPTYPE_QUEUE_STATS_REPLY:
6194 case OFPTYPE_PORT_STATS_REPLY:
6195 case OFPTYPE_TABLE_STATS_REPLY:
6196 case OFPTYPE_AGGREGATE_STATS_REPLY:
6197 case OFPTYPE_PORT_DESC_STATS_REPLY:
6198 case OFPTYPE_ROLE_REPLY:
6199 case OFPTYPE_FLOW_MONITOR_PAUSED:
6200 case OFPTYPE_FLOW_MONITOR_RESUMED:
6201 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6202 case OFPTYPE_GET_ASYNC_REPLY:
6203 case OFPTYPE_GROUP_STATS_REPLY:
6204 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6205 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6206 case OFPTYPE_METER_STATS_REPLY:
6207 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6208 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6209 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6210 case OFPTYPE_ROLE_STATUS:
6212 if (ofpmsg_is_stat_request(oh)) {
6213 return OFPERR_OFPBRC_BAD_STAT;
6215 return OFPERR_OFPBRC_BAD_TYPE;
6221 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6222 OVS_EXCLUDED(ofproto_mutex)
6224 int error = handle_openflow__(ofconn, ofp_msg);
6226 ofconn_send_error(ofconn, ofpbuf_data(ofp_msg), error);
6228 COVERAGE_INC(ofproto_recv_openflow);
6231 /* Asynchronous operations. */
6234 send_buffered_packet(struct ofconn *ofconn, uint32_t buffer_id,
6236 OVS_REQUIRES(ofproto_mutex)
6238 enum ofperr error = 0;
6239 if (ofconn && buffer_id != UINT32_MAX) {
6240 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6241 struct ofpbuf *packet;
6244 error = ofconn_pktbuf_retrieve(ofconn, buffer_id, &packet, &in_port);
6246 struct rule_execute *re;
6248 ofproto_rule_ref(rule);
6250 re = xmalloc(sizeof *re);
6252 re->in_port = in_port;
6253 re->packet = packet;
6255 if (!guarded_list_push_back(&ofproto->rule_executes,
6256 &re->list_node, 1024)) {
6257 ofproto_rule_unref(rule);
6258 ofpbuf_delete(re->packet);
6267 pick_datapath_id(const struct ofproto *ofproto)
6269 const struct ofport *port;
6271 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6273 uint8_t ea[ETH_ADDR_LEN];
6276 error = netdev_get_etheraddr(port->netdev, ea);
6278 return eth_addr_to_uint64(ea);
6280 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6281 ofproto->name, netdev_get_name(port->netdev),
6282 ovs_strerror(error));
6284 return ofproto->fallback_dpid;
6288 pick_fallback_dpid(void)
6290 uint8_t ea[ETH_ADDR_LEN];
6291 eth_addr_nicira_random(ea);
6292 return eth_addr_to_uint64(ea);
6295 /* Table overflow policy. */
6297 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6298 * to NULL if the table is not configured to evict rules or if the table
6299 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6300 * or with no timeouts are not evictable.) */
6302 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6303 OVS_REQUIRES(ofproto_mutex)
6305 struct eviction_group *evg;
6308 if (!table->eviction_fields) {
6312 /* In the common case, the outer and inner loops here will each be entered
6315 * - The inner loop normally "return"s in its first iteration. If the
6316 * eviction group has any evictable rules, then it always returns in
6319 * - The outer loop only iterates more than once if the largest eviction
6320 * group has no evictable rules.
6322 * - The outer loop can exit only if table's 'max_flows' is all filled up
6323 * by unevictable rules. */
6324 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6327 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6336 /* Eviction groups. */
6338 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6339 * rules. The priority contains low-order random bits to ensure that eviction
6340 * groups with the same number of rules are prioritized randomly. */
6342 eviction_group_priority(size_t n_rules)
6344 uint16_t size = MIN(UINT16_MAX, n_rules);
6345 return (size << 16) | random_uint16();
6348 /* Updates 'evg', an eviction_group within 'table', following a change that
6349 * adds or removes rules in 'evg'. */
6351 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6352 OVS_REQUIRES(ofproto_mutex)
6354 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6355 eviction_group_priority(heap_count(&evg->rules)));
6358 /* Destroys 'evg', an eviction_group within 'table':
6360 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6361 * rules themselves, just removes them from the eviction group.)
6363 * - Removes 'evg' from 'table'.
6367 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6368 OVS_REQUIRES(ofproto_mutex)
6370 while (!heap_is_empty(&evg->rules)) {
6373 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6374 rule->eviction_group = NULL;
6376 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6377 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6378 heap_destroy(&evg->rules);
6382 /* Removes 'rule' from its eviction group, if any. */
6384 eviction_group_remove_rule(struct rule *rule)
6385 OVS_REQUIRES(ofproto_mutex)
6387 if (rule->eviction_group) {
6388 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6389 struct eviction_group *evg = rule->eviction_group;
6391 rule->eviction_group = NULL;
6392 heap_remove(&evg->rules, &rule->evg_node);
6393 if (heap_is_empty(&evg->rules)) {
6394 eviction_group_destroy(table, evg);
6396 eviction_group_resized(table, evg);
6401 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6402 * returns the hash value. */
6404 eviction_group_hash_rule(struct rule *rule)
6405 OVS_REQUIRES(ofproto_mutex)
6407 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6408 const struct mf_subfield *sf;
6412 hash = table->eviction_group_id_basis;
6413 miniflow_expand(&rule->cr.match.flow, &flow);
6414 for (sf = table->eviction_fields;
6415 sf < &table->eviction_fields[table->n_eviction_fields];
6418 if (mf_are_prereqs_ok(sf->field, &flow)) {
6419 union mf_value value;
6421 mf_get_value(sf->field, &flow, &value);
6423 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6425 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6426 unsigned int start = sf->ofs + sf->n_bits;
6427 bitwise_zero(&value, sf->field->n_bytes, start,
6428 sf->field->n_bytes * 8 - start);
6430 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6432 hash = hash_int(hash, 0);
6439 /* Returns an eviction group within 'table' with the given 'id', creating one
6441 static struct eviction_group *
6442 eviction_group_find(struct oftable *table, uint32_t id)
6443 OVS_REQUIRES(ofproto_mutex)
6445 struct eviction_group *evg;
6447 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6451 evg = xmalloc(sizeof *evg);
6452 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6453 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6454 eviction_group_priority(0));
6455 heap_init(&evg->rules);
6460 /* Returns an eviction priority for 'rule'. The return value should be
6461 * interpreted so that higher priorities make a rule more attractive candidates
6463 * Called only if have a timeout. */
6465 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6466 OVS_REQUIRES(ofproto_mutex)
6468 long long int expiration = LLONG_MAX;
6469 long long int modified;
6470 uint32_t expiration_offset;
6472 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6473 ovs_mutex_lock(&rule->mutex);
6474 modified = rule->modified;
6475 ovs_mutex_unlock(&rule->mutex);
6477 if (rule->hard_timeout) {
6478 expiration = modified + rule->hard_timeout * 1000;
6480 if (rule->idle_timeout) {
6481 uint64_t packets, bytes;
6483 long long int idle_expiration;
6485 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6486 idle_expiration = used + rule->idle_timeout * 1000;
6487 expiration = MIN(expiration, idle_expiration);
6490 if (expiration == LLONG_MAX) {
6494 /* Calculate the time of expiration as a number of (approximate) seconds
6495 * after program startup.
6497 * This should work OK for program runs that last UINT32_MAX seconds or
6498 * less. Therefore, please restart OVS at least once every 136 years. */
6499 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6501 /* Invert the expiration offset because we're using a max-heap. */
6502 return UINT32_MAX - expiration_offset;
6505 /* Adds 'rule' to an appropriate eviction group for its oftable's
6506 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6507 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6510 * The caller must ensure that 'rule' is not already in an eviction group. */
6512 eviction_group_add_rule(struct rule *rule)
6513 OVS_REQUIRES(ofproto_mutex)
6515 struct ofproto *ofproto = rule->ofproto;
6516 struct oftable *table = &ofproto->tables[rule->table_id];
6519 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6520 * so no additional protection is needed. */
6521 has_timeout = rule->hard_timeout || rule->idle_timeout;
6523 if (table->eviction_fields && has_timeout) {
6524 struct eviction_group *evg;
6526 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6528 rule->eviction_group = evg;
6529 heap_insert(&evg->rules, &rule->evg_node,
6530 rule_eviction_priority(ofproto, rule));
6531 eviction_group_resized(table, evg);
6537 /* Initializes 'table'. */
6539 oftable_init(struct oftable *table)
6541 memset(table, 0, sizeof *table);
6542 classifier_init(&table->cls, flow_segment_u32s);
6543 table->max_flows = UINT_MAX;
6544 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
6546 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
6547 ARRAY_SIZE(default_prefix_fields));
6549 atomic_init(&table->n_matched, 0);
6550 atomic_init(&table->n_missed, 0);
6553 /* Destroys 'table', including its classifier and eviction groups.
6555 * The caller is responsible for freeing 'table' itself. */
6557 oftable_destroy(struct oftable *table)
6559 ovs_assert(classifier_is_empty(&table->cls));
6560 oftable_disable_eviction(table);
6561 classifier_destroy(&table->cls);
6565 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6566 * string, then 'table' will use its default name.
6568 * This only affects the name exposed for a table exposed through the OpenFlow
6569 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6571 oftable_set_name(struct oftable *table, const char *name)
6573 if (name && name[0]) {
6574 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6575 if (!table->name || strncmp(name, table->name, len)) {
6577 table->name = xmemdup0(name, len);
6585 /* oftables support a choice of two policies when adding a rule would cause the
6586 * number of flows in the table to exceed the configured maximum number: either
6587 * they can refuse to add the new flow or they can evict some existing flow.
6588 * This function configures the former policy on 'table'. */
6590 oftable_disable_eviction(struct oftable *table)
6591 OVS_REQUIRES(ofproto_mutex)
6593 if (table->eviction_fields) {
6594 struct eviction_group *evg, *next;
6596 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6597 &table->eviction_groups_by_id) {
6598 eviction_group_destroy(table, evg);
6600 hmap_destroy(&table->eviction_groups_by_id);
6601 heap_destroy(&table->eviction_groups_by_size);
6603 free(table->eviction_fields);
6604 table->eviction_fields = NULL;
6605 table->n_eviction_fields = 0;
6609 /* oftables support a choice of two policies when adding a rule would cause the
6610 * number of flows in the table to exceed the configured maximum number: either
6611 * they can refuse to add the new flow or they can evict some existing flow.
6612 * This function configures the latter policy on 'table', with fairness based
6613 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6614 * 'n_fields' as 0 disables fairness.) */
6616 oftable_enable_eviction(struct oftable *table,
6617 const struct mf_subfield *fields, size_t n_fields)
6618 OVS_REQUIRES(ofproto_mutex)
6622 if (table->eviction_fields
6623 && n_fields == table->n_eviction_fields
6625 || !memcmp(fields, table->eviction_fields,
6626 n_fields * sizeof *fields))) {
6631 oftable_disable_eviction(table);
6633 table->n_eviction_fields = n_fields;
6634 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6636 table->eviction_group_id_basis = random_uint32();
6637 hmap_init(&table->eviction_groups_by_id);
6638 heap_init(&table->eviction_groups_by_size);
6640 CLS_FOR_EACH (rule, cr, &table->cls) {
6641 eviction_group_add_rule(rule);
6645 /* Removes 'rule' from the oftable that contains it. */
6647 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6648 OVS_REQUIRES(ofproto_mutex)
6650 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6652 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6654 cookies_remove(ofproto, rule);
6656 eviction_group_remove_rule(rule);
6657 if (!list_is_empty(&rule->expirable)) {
6658 list_remove(&rule->expirable);
6660 if (!list_is_empty(&rule->meter_list_node)) {
6661 list_remove(&rule->meter_list_node);
6662 list_init(&rule->meter_list_node);
6667 oftable_remove_rule(struct rule *rule)
6668 OVS_REQUIRES(ofproto_mutex)
6670 oftable_remove_rule__(rule->ofproto, rule);
6673 /* unixctl commands. */
6676 ofproto_lookup(const char *name)
6678 struct ofproto *ofproto;
6680 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6682 if (!strcmp(ofproto->name, name)) {
6690 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6691 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6693 struct ofproto *ofproto;
6697 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6698 ds_put_format(&results, "%s\n", ofproto->name);
6700 unixctl_command_reply(conn, ds_cstr(&results));
6701 ds_destroy(&results);
6705 ofproto_unixctl_init(void)
6707 static bool registered;
6713 unixctl_command_register("ofproto/list", "", 0, 0,
6714 ofproto_unixctl_list, NULL);
6717 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6719 * This is deprecated. It is only for compatibility with broken device drivers
6720 * in old versions of Linux that do not properly support VLANs when VLAN
6721 * devices are not used. When broken device drivers are no longer in
6722 * widespread use, we will delete these interfaces. */
6724 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6725 * (exactly) by an OpenFlow rule in 'ofproto'. */
6727 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6730 struct cls_rule target;
6731 const struct oftable *oftable;
6733 match_init_catchall(&match);
6734 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
6735 cls_rule_init(&target, &match, 0);
6737 free(ofproto->vlan_bitmap);
6738 ofproto->vlan_bitmap = bitmap_allocate(4096);
6739 ofproto->vlans_changed = false;
6741 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6744 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
6745 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
6746 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6748 bitmap_set1(vlan_bitmap, vid);
6749 bitmap_set1(ofproto->vlan_bitmap, vid);
6754 cls_rule_destroy(&target);
6757 /* Returns true if new VLANs have come into use by the flow table since the
6758 * last call to ofproto_get_vlan_usage().
6760 * We don't track when old VLANs stop being used. */
6762 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
6764 return ofproto->vlans_changed;
6767 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6768 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6769 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6770 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6771 * then the VLAN device is un-enslaved. */
6773 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
6774 ofp_port_t realdev_ofp_port, int vid)
6776 struct ofport *ofport;
6779 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
6781 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
6783 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
6784 ofproto->name, vlandev_ofp_port);
6788 if (!ofproto->ofproto_class->set_realdev) {
6789 if (!vlandev_ofp_port) {
6792 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
6796 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
6798 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
6799 ofproto->name, vlandev_ofp_port,
6800 netdev_get_name(ofport->netdev), ovs_strerror(error));