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,
157 unsigned int priority,
158 ovs_be64 cookie, ovs_be64 cookie_mask,
159 ofp_port_t out_port, uint32_t out_group);
160 static void rule_criteria_require_rw(struct rule_criteria *,
161 bool can_write_readonly);
162 static void rule_criteria_destroy(struct rule_criteria *);
164 static enum ofperr collect_rules_loose(struct ofproto *,
165 const struct rule_criteria *,
166 struct rule_collection *);
168 /* A packet that needs to be passed to rule_execute().
170 * (We can't do this immediately from ofopgroup_complete() because that holds
171 * ofproto_mutex, which rule_execute() needs released.) */
172 struct rule_execute {
173 struct list list_node; /* In struct ofproto's "rule_executes" list. */
174 struct rule *rule; /* Owns a reference to the rule. */
176 struct ofpbuf *packet; /* Owns the packet. */
179 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
180 static void destroy_rule_executes(struct ofproto *);
182 struct learned_cookie {
184 /* In struct ofproto's 'learned_cookies' hmap. */
185 struct hmap_node hmap_node OVS_GUARDED_BY(ofproto_mutex);
187 /* In 'dead_cookies' list when removed from hmap. */
188 struct list list_node;
192 ovs_be64 cookie OVS_GUARDED_BY(ofproto_mutex);
193 uint8_t table_id OVS_GUARDED_BY(ofproto_mutex);
195 /* Number of references from "learn" actions.
197 * When this drops to 0, all of the flows in 'table_id' with the specified
198 * 'cookie' are deleted. */
199 int n OVS_GUARDED_BY(ofproto_mutex);
202 static const struct ofpact_learn *next_learn_with_delete(
203 const struct rule_actions *, const struct ofpact_learn *start);
205 static void learned_cookies_inc(struct ofproto *, const struct rule_actions *)
206 OVS_REQUIRES(ofproto_mutex);
207 static void learned_cookies_dec(struct ofproto *, const struct rule_actions *,
208 struct list *dead_cookies)
209 OVS_REQUIRES(ofproto_mutex);
210 static void learned_cookies_flush(struct ofproto *, struct list *dead_cookies)
211 OVS_REQUIRES(ofproto_mutex);
214 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
215 static void ofport_destroy(struct ofport *);
217 static void update_port(struct ofproto *, const char *devname);
218 static int init_ports(struct ofproto *);
219 static void reinit_ports(struct ofproto *);
221 static long long int ofport_get_usage(const struct ofproto *,
222 ofp_port_t ofp_port);
223 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
224 long long int last_used);
225 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
229 * Keeps track of the currently used and recently used ofport values and is
230 * used to prevent immediate recycling of ofport values. */
231 struct ofport_usage {
232 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
233 ofp_port_t ofp_port; /* OpenFlow port number. */
234 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
235 represents in-use ofports. */
239 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
240 static bool rule_is_readonly(const struct rule *);
242 /* The source of a flow_mod request, in the code that processes flow_mods.
244 * A flow table modification request can be generated externally, via OpenFlow,
245 * or internally through a function call. This structure indicates the source
246 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
247 * meaningful and thus supplied as NULL. */
248 struct flow_mod_requester {
249 struct ofconn *ofconn; /* Connection on which flow_mod arrived. */
250 ovs_be32 xid; /* OpenFlow xid of flow_mod request. */
254 static enum ofperr add_flow(struct ofproto *, struct ofputil_flow_mod *,
255 const struct flow_mod_requester *);
257 static enum ofperr modify_flows__(struct ofproto *, struct ofputil_flow_mod *,
258 const struct rule_collection *,
259 const struct flow_mod_requester *);
260 static void delete_flows__(const struct rule_collection *,
261 enum ofp_flow_removed_reason,
262 const struct flow_mod_requester *)
263 OVS_REQUIRES(ofproto_mutex);
265 static enum ofperr send_buffered_packet(struct ofconn *, uint32_t buffer_id,
267 OVS_REQUIRES(ofproto_mutex);
269 static bool ofproto_group_exists__(const struct ofproto *ofproto,
271 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
272 static bool ofproto_group_exists(const struct ofproto *ofproto,
274 OVS_EXCLUDED(ofproto->groups_rwlock);
275 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
276 static void handle_openflow(struct ofconn *, const struct ofpbuf *);
277 static enum ofperr handle_flow_mod__(struct ofproto *,
278 struct ofputil_flow_mod *,
279 const struct flow_mod_requester *)
280 OVS_EXCLUDED(ofproto_mutex);
281 static void calc_duration(long long int start, long long int now,
282 uint32_t *sec, uint32_t *nsec);
285 static uint64_t pick_datapath_id(const struct ofproto *);
286 static uint64_t pick_fallback_dpid(void);
287 static void ofproto_destroy__(struct ofproto *);
288 static void update_mtu(struct ofproto *, struct ofport *);
289 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
290 static void meter_insert_rule(struct rule *);
293 static void ofproto_unixctl_init(void);
295 /* All registered ofproto classes, in probe order. */
296 static const struct ofproto_class **ofproto_classes;
297 static size_t n_ofproto_classes;
298 static size_t allocated_ofproto_classes;
300 /* Global lock that protects all flow table operations. */
301 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
303 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
304 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
306 size_t n_handlers, n_revalidators;
310 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
311 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
313 /* Initial mappings of port to OpenFlow number mappings. */
314 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
316 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
318 /* The default value of true waits for flow restore. */
319 static bool flow_restore_wait = true;
321 /* Must be called to initialize the ofproto library.
323 * The caller may pass in 'iface_hints', which contains an shash of
324 * "iface_hint" elements indexed by the interface's name. The provider
325 * may use these hints to describe the startup configuration in order to
326 * reinitialize its state. The caller owns the provided data, so a
327 * provider will make copies of anything required. An ofproto provider
328 * will remove any existing state that is not described by the hint, and
329 * may choose to remove it all. */
331 ofproto_init(const struct shash *iface_hints)
333 struct shash_node *node;
336 ofproto_class_register(&ofproto_dpif_class);
338 /* Make a local copy, since we don't own 'iface_hints' elements. */
339 SHASH_FOR_EACH(node, iface_hints) {
340 const struct iface_hint *orig_hint = node->data;
341 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
342 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
344 new_hint->br_name = xstrdup(orig_hint->br_name);
345 new_hint->br_type = xstrdup(br_type);
346 new_hint->ofp_port = orig_hint->ofp_port;
348 shash_add(&init_ofp_ports, node->name, new_hint);
351 for (i = 0; i < n_ofproto_classes; i++) {
352 ofproto_classes[i]->init(&init_ofp_ports);
356 /* 'type' should be a normalized datapath type, as returned by
357 * ofproto_normalize_type(). Returns the corresponding ofproto_class
358 * structure, or a null pointer if there is none registered for 'type'. */
359 static const struct ofproto_class *
360 ofproto_class_find__(const char *type)
364 for (i = 0; i < n_ofproto_classes; i++) {
365 const struct ofproto_class *class = ofproto_classes[i];
370 class->enumerate_types(&types);
371 found = sset_contains(&types, type);
372 sset_destroy(&types);
378 VLOG_WARN("unknown datapath type %s", type);
382 /* Registers a new ofproto class. After successful registration, new ofprotos
383 * of that type can be created using ofproto_create(). */
385 ofproto_class_register(const struct ofproto_class *new_class)
389 for (i = 0; i < n_ofproto_classes; i++) {
390 if (ofproto_classes[i] == new_class) {
395 if (n_ofproto_classes >= allocated_ofproto_classes) {
396 ofproto_classes = x2nrealloc(ofproto_classes,
397 &allocated_ofproto_classes,
398 sizeof *ofproto_classes);
400 ofproto_classes[n_ofproto_classes++] = new_class;
404 /* Unregisters a datapath provider. 'type' must have been previously
405 * registered and not currently be in use by any ofprotos. After
406 * unregistration new datapaths of that type cannot be opened using
407 * ofproto_create(). */
409 ofproto_class_unregister(const struct ofproto_class *class)
413 for (i = 0; i < n_ofproto_classes; i++) {
414 if (ofproto_classes[i] == class) {
415 for (i++; i < n_ofproto_classes; i++) {
416 ofproto_classes[i - 1] = ofproto_classes[i];
422 VLOG_WARN("attempted to unregister an ofproto class that is not "
427 /* Clears 'types' and enumerates all registered ofproto types into it. The
428 * caller must first initialize the sset. */
430 ofproto_enumerate_types(struct sset *types)
435 for (i = 0; i < n_ofproto_classes; i++) {
436 ofproto_classes[i]->enumerate_types(types);
440 /* Returns the fully spelled out name for the given ofproto 'type'.
442 * Normalized type string can be compared with strcmp(). Unnormalized type
443 * string might be the same even if they have different spellings. */
445 ofproto_normalize_type(const char *type)
447 return type && type[0] ? type : "system";
450 /* Clears 'names' and enumerates the names of all known created ofprotos with
451 * the given 'type'. The caller must first initialize the sset. Returns 0 if
452 * successful, otherwise a positive errno value.
454 * Some kinds of datapaths might not be practically enumerable. This is not
455 * considered an error. */
457 ofproto_enumerate_names(const char *type, struct sset *names)
459 const struct ofproto_class *class = ofproto_class_find__(type);
460 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
464 ofproto_create(const char *datapath_name, const char *datapath_type,
465 struct ofproto **ofprotop)
467 const struct ofproto_class *class;
468 struct ofproto *ofproto;
474 ofproto_unixctl_init();
476 datapath_type = ofproto_normalize_type(datapath_type);
477 class = ofproto_class_find__(datapath_type);
479 VLOG_WARN("could not create datapath %s of unknown type %s",
480 datapath_name, datapath_type);
484 ofproto = class->alloc();
486 VLOG_ERR("failed to allocate datapath %s of type %s",
487 datapath_name, datapath_type);
492 ovs_mutex_lock(&ofproto_mutex);
493 memset(ofproto, 0, sizeof *ofproto);
494 ofproto->ofproto_class = class;
495 ofproto->name = xstrdup(datapath_name);
496 ofproto->type = xstrdup(datapath_type);
497 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
498 hash_string(ofproto->name, 0));
499 ofproto->datapath_id = 0;
500 ofproto->forward_bpdu = false;
501 ofproto->fallback_dpid = pick_fallback_dpid();
502 ofproto->mfr_desc = NULL;
503 ofproto->hw_desc = NULL;
504 ofproto->sw_desc = NULL;
505 ofproto->serial_desc = NULL;
506 ofproto->dp_desc = NULL;
507 ofproto->frag_handling = OFPC_FRAG_NORMAL;
508 hmap_init(&ofproto->ports);
509 hmap_init(&ofproto->ofport_usage);
510 shash_init(&ofproto->port_by_name);
511 simap_init(&ofproto->ofp_requests);
512 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
513 ofproto->eviction_group_timer = LLONG_MIN;
514 ofproto->tables = NULL;
515 ofproto->n_tables = 0;
516 hindex_init(&ofproto->cookies);
517 hmap_init(&ofproto->learned_cookies);
518 list_init(&ofproto->expirable);
519 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
520 guarded_list_init(&ofproto->rule_executes);
521 ofproto->vlan_bitmap = NULL;
522 ofproto->vlans_changed = false;
523 ofproto->min_mtu = INT_MAX;
524 ovs_rwlock_init(&ofproto->groups_rwlock);
525 hmap_init(&ofproto->groups);
526 ovs_mutex_unlock(&ofproto_mutex);
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 ofproto_destroy__(ofproto);
542 /* Check that hidden tables, if any, are at the end. */
543 ovs_assert(ofproto->n_tables);
544 for (i = 0; i + 1 < ofproto->n_tables; i++) {
545 enum oftable_flags flags = ofproto->tables[i].flags;
546 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
548 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
551 ofproto->datapath_id = pick_datapath_id(ofproto);
554 /* Initialize meters table. */
555 if (ofproto->ofproto_class->meter_get_features) {
556 ofproto->ofproto_class->meter_get_features(ofproto,
557 &ofproto->meter_features);
559 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
561 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
562 * sizeof(struct meter *));
568 /* Must be called (only) by an ofproto implementation in its constructor
569 * function. See the large comment on 'construct' in struct ofproto_class for
572 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
574 struct oftable *table;
576 ovs_assert(!ofproto->n_tables);
577 ovs_assert(n_tables >= 1 && n_tables <= 255);
579 ofproto->n_tables = n_tables;
580 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
581 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
586 /* To be optionally called (only) by an ofproto implementation in its
587 * constructor function. See the large comment on 'construct' in struct
588 * ofproto_class for details.
590 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
591 * will then ensure that actions passed into the ofproto implementation will
592 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
593 * function is not called, there will be no such restriction.
595 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
596 * the 'max_ports' restriction. */
598 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
600 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
601 ofproto->max_ports = max_ports;
605 ofproto_get_datapath_id(const struct ofproto *ofproto)
607 return ofproto->datapath_id;
611 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
613 uint64_t old_dpid = p->datapath_id;
614 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
615 if (p->datapath_id != old_dpid) {
616 /* Force all active connections to reconnect, since there is no way to
617 * notify a controller that the datapath ID has changed. */
618 ofproto_reconnect_controllers(p);
623 ofproto_set_controllers(struct ofproto *p,
624 const struct ofproto_controller *controllers,
625 size_t n_controllers, uint32_t allowed_versions)
627 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
632 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
634 connmgr_set_fail_mode(p->connmgr, fail_mode);
637 /* Drops the connections between 'ofproto' and all of its controllers, forcing
638 * them to reconnect. */
640 ofproto_reconnect_controllers(struct ofproto *ofproto)
642 connmgr_reconnect(ofproto->connmgr);
645 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
646 * in-band control should guarantee access, in the same way that in-band
647 * control guarantees access to OpenFlow controllers. */
649 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
650 const struct sockaddr_in *extras, size_t n)
652 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
655 /* Sets the OpenFlow queue used by flows set up by in-band control on
656 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
657 * flows will use the default queue. */
659 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
661 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
664 /* Sets the number of flows at which eviction from the kernel flow table
667 ofproto_set_flow_limit(unsigned limit)
669 ofproto_flow_limit = limit;
672 /* Sets the maximum idle time for flows in the datapath before they are
675 ofproto_set_max_idle(unsigned max_idle)
677 ofproto_max_idle = max_idle;
680 /* If forward_bpdu is true, the NORMAL action will forward frames with
681 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
682 * the NORMAL action will drop these frames. */
684 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
686 bool old_val = ofproto->forward_bpdu;
687 ofproto->forward_bpdu = forward_bpdu;
688 if (old_val != ofproto->forward_bpdu) {
689 if (ofproto->ofproto_class->forward_bpdu_changed) {
690 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
695 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
696 * 'idle_time', in seconds, and the maximum number of MAC table entries to
699 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
702 if (ofproto->ofproto_class->set_mac_table_config) {
703 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
708 /* Multicast snooping configuration. */
710 /* Configures multicast snooping on 'ofproto' using the settings
711 * defined in 's'. If 's' is NULL, disables multicast snooping.
713 * Returns 0 if successful, otherwise a positive errno value. */
715 ofproto_set_mcast_snooping(struct ofproto *ofproto,
716 const struct ofproto_mcast_snooping_settings *s)
718 return (ofproto->ofproto_class->set_mcast_snooping
719 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
723 /* Configures multicast snooping flood setting on 'ofp_port' of 'ofproto'.
725 * Returns 0 if successful, otherwise a positive errno value.*/
727 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux, bool flood)
729 return (ofproto->ofproto_class->set_mcast_snooping_port
730 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux,
736 ofproto_set_n_dpdk_rxqs(int n_rxqs)
738 n_dpdk_rxqs = MAX(n_rxqs, 0);
742 ofproto_set_cpu_mask(const char *cmask)
746 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
750 ofproto_set_threads(int n_handlers_, int n_revalidators_)
752 int threads = MAX(count_cpu_cores(), 2);
754 n_revalidators = MAX(n_revalidators_, 0);
755 n_handlers = MAX(n_handlers_, 0);
757 if (!n_revalidators) {
758 n_revalidators = n_handlers
759 ? MAX(threads - (int) n_handlers, 1)
764 n_handlers = MAX(threads - (int) n_revalidators, 1);
769 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
772 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
776 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
778 return connmgr_set_snoops(ofproto->connmgr, snoops);
782 ofproto_set_netflow(struct ofproto *ofproto,
783 const struct netflow_options *nf_options)
785 if (nf_options && sset_is_empty(&nf_options->collectors)) {
789 if (ofproto->ofproto_class->set_netflow) {
790 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
792 return nf_options ? EOPNOTSUPP : 0;
797 ofproto_set_sflow(struct ofproto *ofproto,
798 const struct ofproto_sflow_options *oso)
800 if (oso && sset_is_empty(&oso->targets)) {
804 if (ofproto->ofproto_class->set_sflow) {
805 return ofproto->ofproto_class->set_sflow(ofproto, oso);
807 return oso ? EOPNOTSUPP : 0;
812 ofproto_set_ipfix(struct ofproto *ofproto,
813 const struct ofproto_ipfix_bridge_exporter_options *bo,
814 const struct ofproto_ipfix_flow_exporter_options *fo,
817 if (ofproto->ofproto_class->set_ipfix) {
818 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
820 return (bo || fo) ? EOPNOTSUPP : 0;
825 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
827 flow_restore_wait = flow_restore_wait_db;
831 ofproto_get_flow_restore_wait(void)
833 return flow_restore_wait;
837 /* Spanning Tree Protocol (STP) configuration. */
839 /* Configures STP on 'ofproto' using the settings defined in 's'. If
840 * 's' is NULL, disables STP.
842 * Returns 0 if successful, otherwise a positive errno value. */
844 ofproto_set_stp(struct ofproto *ofproto,
845 const struct ofproto_stp_settings *s)
847 return (ofproto->ofproto_class->set_stp
848 ? ofproto->ofproto_class->set_stp(ofproto, s)
852 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
853 * 'enabled' member of 's' is false, then the other members are not
856 * Returns 0 if successful, otherwise a positive errno value. */
858 ofproto_get_stp_status(struct ofproto *ofproto,
859 struct ofproto_stp_status *s)
861 return (ofproto->ofproto_class->get_stp_status
862 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
866 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
867 * in 's'. The caller is responsible for assigning STP port numbers
868 * (using the 'port_num' member in the range of 1 through 255, inclusive)
869 * and ensuring there are no duplicates. If the 's' is NULL, then STP
870 * is disabled on the port.
872 * Returns 0 if successful, otherwise a positive errno value.*/
874 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
875 const struct ofproto_port_stp_settings *s)
877 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
879 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
880 ofproto->name, ofp_port);
884 return (ofproto->ofproto_class->set_stp_port
885 ? ofproto->ofproto_class->set_stp_port(ofport, s)
889 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
890 * 's'. If the 'enabled' member in 's' is false, then the other members
891 * are not meaningful.
893 * Returns 0 if successful, otherwise a positive errno value.*/
895 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
896 struct ofproto_port_stp_status *s)
898 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
900 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
901 "port %"PRIu16, ofproto->name, ofp_port);
905 return (ofproto->ofproto_class->get_stp_port_status
906 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
910 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
911 * 's'. If the 'enabled' member in 's' is false, then the other members
912 * are not meaningful.
914 * Returns 0 if successful, otherwise a positive errno value.*/
916 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
917 struct ofproto_port_stp_stats *s)
919 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
921 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
922 "port %"PRIu16, ofproto->name, ofp_port);
926 return (ofproto->ofproto_class->get_stp_port_stats
927 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
931 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
933 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
934 * 's' is NULL, disables RSTP.
936 * Returns 0 if successful, otherwise a positive errno value. */
938 ofproto_set_rstp(struct ofproto *ofproto,
939 const struct ofproto_rstp_settings *s)
941 if (!ofproto->ofproto_class->set_rstp) {
944 ofproto->ofproto_class->set_rstp(ofproto, s);
948 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
949 * 'enabled' member of 's' is false, then the other members are not
952 * Returns 0 if successful, otherwise a positive errno value. */
954 ofproto_get_rstp_status(struct ofproto *ofproto,
955 struct ofproto_rstp_status *s)
957 if (!ofproto->ofproto_class->get_rstp_status) {
960 ofproto->ofproto_class->get_rstp_status(ofproto, s);
964 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
965 * in 's'. The caller is responsible for assigning RSTP port numbers
966 * (using the 'port_num' member in the range of 1 through 255, inclusive)
967 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
968 * is disabled on the port.
970 * Returns 0 if successful, otherwise a positive errno value.*/
972 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
973 const struct ofproto_port_rstp_settings *s)
975 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
977 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
978 ofproto->name, ofp_port);
982 if (!ofproto->ofproto_class->set_rstp_port) {
985 ofproto->ofproto_class->set_rstp_port(ofport, s);
989 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
990 * 's'. If the 'enabled' member in 's' is false, then the other members
991 * are not meaningful.
993 * Returns 0 if successful, otherwise a positive errno value.*/
995 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
996 struct ofproto_port_rstp_status *s)
998 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1000 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1001 "port %"PRIu16, ofproto->name, ofp_port);
1005 if (!ofproto->ofproto_class->get_rstp_port_status) {
1008 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1012 /* Queue DSCP configuration. */
1014 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1015 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1016 * to implement QoS. Instead, it is used to implement features which require
1017 * knowledge of what queues exist on a port, and some basic information about
1020 * Returns 0 if successful, otherwise a positive errno value. */
1022 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1023 const struct ofproto_port_queue *queues,
1026 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1029 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1030 ofproto->name, ofp_port);
1034 return (ofproto->ofproto_class->set_queues
1035 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1039 /* Connectivity Fault Management configuration. */
1041 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1043 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1045 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1046 if (ofport && ofproto->ofproto_class->set_cfm) {
1047 ofproto->ofproto_class->set_cfm(ofport, NULL);
1051 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1052 * basic configuration from the configuration members in 'cfm', and the remote
1053 * maintenance point ID from remote_mpid. Ignores the statistics members of
1056 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1058 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1059 const struct cfm_settings *s)
1061 struct ofport *ofport;
1064 ofport = ofproto_get_port(ofproto, ofp_port);
1066 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1067 ofproto->name, ofp_port);
1071 /* XXX: For configuration simplicity, we only support one remote_mpid
1072 * outside of the CFM module. It's not clear if this is the correct long
1073 * term solution or not. */
1074 error = (ofproto->ofproto_class->set_cfm
1075 ? ofproto->ofproto_class->set_cfm(ofport, s)
1078 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1079 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1080 ovs_strerror(error));
1084 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1085 * 'ofproto' does not have a port 'ofp_port'. */
1087 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1088 const struct smap *cfg)
1090 struct ofport *ofport;
1093 ofport = ofproto_get_port(ofproto, ofp_port);
1095 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1096 ofproto->name, ofp_port);
1100 error = (ofproto->ofproto_class->set_bfd
1101 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1104 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1105 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1106 ovs_strerror(error));
1110 /* Checks the status change of BFD on 'ofport'.
1112 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1114 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1116 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1117 return (ofport && ofproto->ofproto_class->bfd_status_changed
1118 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1122 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1123 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1124 * is not an OpenFlow port in 'ofproto'.
1126 * The caller must provide and own '*status'. */
1128 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1129 struct smap *status)
1131 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1132 return (ofport && ofproto->ofproto_class->get_bfd_status
1133 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1137 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1138 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1139 * 0 if LACP partner information is not current (generally indicating a
1140 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1142 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1144 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1145 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1146 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1152 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1153 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1154 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1155 * configuration plus, if there is more than one slave, a bonding
1158 * If 'aux' is already registered then this function updates its configuration
1159 * to 's'. Otherwise, this function registers a new bundle.
1161 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1164 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1165 const struct ofproto_bundle_settings *s)
1167 return (ofproto->ofproto_class->bundle_set
1168 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1172 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1173 * If no such bundle has been registered, this has no effect. */
1175 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1177 return ofproto_bundle_register(ofproto, aux, NULL);
1181 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1182 * If 'aux' is already registered then this function updates its configuration
1183 * to 's'. Otherwise, this function registers a new mirror. */
1185 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1186 const struct ofproto_mirror_settings *s)
1188 return (ofproto->ofproto_class->mirror_set
1189 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1193 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1194 * If no mirror has been registered, this has no effect. */
1196 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1198 return ofproto_mirror_register(ofproto, aux, NULL);
1201 /* Retrieves statistics from mirror associated with client data pointer
1202 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1203 * 'bytes', respectively. If a particular counters is not supported,
1204 * the appropriate argument is set to UINT64_MAX. */
1206 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1207 uint64_t *packets, uint64_t *bytes)
1209 if (!ofproto->ofproto_class->mirror_get_stats) {
1210 *packets = *bytes = UINT64_MAX;
1214 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1218 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1219 * which all packets are flooded, instead of using MAC learning. If
1220 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1222 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1225 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1227 return (ofproto->ofproto_class->set_flood_vlans
1228 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1232 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1233 * output for a mirror. */
1235 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1237 return (ofproto->ofproto_class->is_mirror_output_bundle
1238 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1242 /* Configuration of OpenFlow tables. */
1244 /* Returns the number of OpenFlow tables in 'ofproto'. */
1246 ofproto_get_n_tables(const struct ofproto *ofproto)
1248 return ofproto->n_tables;
1251 /* Returns the number of Controller visible OpenFlow tables
1252 * in 'ofproto'. This number will exclude Hidden tables.
1253 * This funtion's return value should be less or equal to that of
1254 * ofproto_get_n_tables() . */
1256 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1258 uint8_t n = ofproto->n_tables;
1260 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1261 * if present, are always at the end.) */
1262 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1269 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1270 * settings from 's'. 'table_id' must be in the range 0 through the number of
1271 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1273 * For read-only tables, only the name may be configured. */
1275 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1276 const struct ofproto_table_settings *s)
1278 struct oftable *table;
1280 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1281 table = &ofproto->tables[table_id];
1283 oftable_set_name(table, s->name);
1285 if (table->flags & OFTABLE_READONLY) {
1290 oftable_enable_eviction(table, s->groups, s->n_groups);
1292 oftable_disable_eviction(table);
1295 table->max_flows = s->max_flows;
1297 if (classifier_set_prefix_fields(&table->cls,
1298 s->prefix_fields, s->n_prefix_fields)) {
1299 /* XXX: Trigger revalidation. */
1302 ovs_mutex_lock(&ofproto_mutex);
1303 evict_rules_from_table(table, 0);
1304 ovs_mutex_unlock(&ofproto_mutex);
1308 ofproto_has_snoops(const struct ofproto *ofproto)
1310 return connmgr_has_snoops(ofproto->connmgr);
1314 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1316 connmgr_get_snoops(ofproto->connmgr, snoops);
1320 ofproto_rule_delete__(struct rule *rule, uint8_t reason)
1321 OVS_REQUIRES(ofproto_mutex)
1323 struct rule_collection rules;
1325 rules.rules = rules.stub;
1327 rules.stub[0] = rule;
1328 delete_flows__(&rules, reason, NULL);
1331 /* Deletes 'rule' from 'ofproto'.
1333 * Within an ofproto implementation, this function allows an ofproto
1334 * implementation to destroy any rules that remain when its ->destruct()
1335 * function is called. This function is not suitable for use elsewhere in an
1336 * ofproto implementation.
1338 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1339 * Cycle" in ofproto-provider.h. */
1341 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1342 OVS_EXCLUDED(ofproto_mutex)
1344 /* This skips the ofmonitor and flow-removed notifications because the
1345 * switch is being deleted and any OpenFlow channels have been or soon will
1347 ovs_mutex_lock(&ofproto_mutex);
1348 oftable_remove_rule__(ofproto, rule);
1349 ofproto->ofproto_class->rule_delete(rule);
1350 ovs_mutex_unlock(&ofproto_mutex);
1354 ofproto_flush__(struct ofproto *ofproto)
1355 OVS_EXCLUDED(ofproto_mutex)
1357 struct oftable *table;
1359 if (ofproto->ofproto_class->flush) {
1360 ofproto->ofproto_class->flush(ofproto);
1363 ovs_mutex_lock(&ofproto_mutex);
1364 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1367 if (table->flags & OFTABLE_HIDDEN) {
1371 CLS_FOR_EACH_SAFE (rule, cr, &table->cls) {
1372 ofproto_rule_delete__(rule, OFPRR_DELETE);
1375 ovs_mutex_unlock(&ofproto_mutex);
1378 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1381 ofproto_destroy__(struct ofproto *ofproto)
1382 OVS_EXCLUDED(ofproto_mutex)
1384 struct oftable *table;
1386 destroy_rule_executes(ofproto);
1387 delete_group(ofproto, OFPG_ALL);
1389 guarded_list_destroy(&ofproto->rule_executes);
1390 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1391 hmap_destroy(&ofproto->groups);
1393 connmgr_destroy(ofproto->connmgr);
1395 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1396 free(ofproto->name);
1397 free(ofproto->type);
1398 free(ofproto->mfr_desc);
1399 free(ofproto->hw_desc);
1400 free(ofproto->sw_desc);
1401 free(ofproto->serial_desc);
1402 free(ofproto->dp_desc);
1403 hmap_destroy(&ofproto->ports);
1404 hmap_destroy(&ofproto->ofport_usage);
1405 shash_destroy(&ofproto->port_by_name);
1406 simap_destroy(&ofproto->ofp_requests);
1408 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1409 oftable_destroy(table);
1411 free(ofproto->tables);
1413 ovs_assert(hindex_is_empty(&ofproto->cookies));
1414 hindex_destroy(&ofproto->cookies);
1416 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1417 hmap_destroy(&ofproto->learned_cookies);
1419 free(ofproto->vlan_bitmap);
1421 ofproto->ofproto_class->dealloc(ofproto);
1425 ofproto_destroy(struct ofproto *p)
1426 OVS_EXCLUDED(ofproto_mutex)
1428 struct ofport *ofport, *next_ofport;
1429 struct ofport_usage *usage, *next_usage;
1436 meter_delete(p, 1, p->meter_features.max_meters);
1437 p->meter_features.max_meters = 0;
1443 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1444 ofport_destroy(ofport);
1447 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1448 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1452 p->ofproto_class->destruct(p);
1453 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1454 ovsrcu_postpone(ofproto_destroy__, p);
1457 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1458 * kernel datapath, for example, this destroys the datapath in the kernel, and
1459 * with the netdev-based datapath, it tears down the data structures that
1460 * represent the datapath.
1462 * The datapath should not be currently open as an ofproto. */
1464 ofproto_delete(const char *name, const char *type)
1466 const struct ofproto_class *class = ofproto_class_find__(type);
1467 return (!class ? EAFNOSUPPORT
1468 : !class->del ? EACCES
1469 : class->del(type, name));
1473 process_port_change(struct ofproto *ofproto, int error, char *devname)
1475 if (error == ENOBUFS) {
1476 reinit_ports(ofproto);
1477 } else if (!error) {
1478 update_port(ofproto, devname);
1484 ofproto_type_run(const char *datapath_type)
1486 const struct ofproto_class *class;
1489 datapath_type = ofproto_normalize_type(datapath_type);
1490 class = ofproto_class_find__(datapath_type);
1492 error = class->type_run ? class->type_run(datapath_type) : 0;
1493 if (error && error != EAGAIN) {
1494 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1495 datapath_type, ovs_strerror(error));
1501 ofproto_type_wait(const char *datapath_type)
1503 const struct ofproto_class *class;
1505 datapath_type = ofproto_normalize_type(datapath_type);
1506 class = ofproto_class_find__(datapath_type);
1508 if (class->type_wait) {
1509 class->type_wait(datapath_type);
1514 ofproto_run(struct ofproto *p)
1519 error = p->ofproto_class->run(p);
1520 if (error && error != EAGAIN) {
1521 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1524 run_rule_executes(p);
1526 /* Restore the eviction group heap invariant occasionally. */
1527 if (p->eviction_group_timer < time_msec()) {
1530 p->eviction_group_timer = time_msec() + 1000;
1532 for (i = 0; i < p->n_tables; i++) {
1533 struct oftable *table = &p->tables[i];
1534 struct eviction_group *evg;
1537 if (!table->eviction_fields) {
1541 if (classifier_count(&table->cls) > 100000) {
1542 static struct vlog_rate_limit count_rl =
1543 VLOG_RATE_LIMIT_INIT(1, 1);
1544 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1545 " number of rules: %d", i,
1546 classifier_count(&table->cls));
1549 ovs_mutex_lock(&ofproto_mutex);
1550 CLS_FOR_EACH (rule, cr, &table->cls) {
1551 if (rule->idle_timeout || rule->hard_timeout) {
1552 if (!rule->eviction_group) {
1553 eviction_group_add_rule(rule);
1555 heap_raw_change(&rule->evg_node,
1556 rule_eviction_priority(p, rule));
1561 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1562 heap_rebuild(&evg->rules);
1564 ovs_mutex_unlock(&ofproto_mutex);
1568 if (p->ofproto_class->port_poll) {
1571 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1572 process_port_change(p, error, devname);
1576 new_seq = seq_read(connectivity_seq_get());
1577 if (new_seq != p->change_seq) {
1578 struct sset devnames;
1579 const char *devname;
1580 struct ofport *ofport;
1582 /* Update OpenFlow port status for any port whose netdev has changed.
1584 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1585 * destroyed, so it's not safe to update ports directly from the
1586 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1587 * need this two-phase approach. */
1588 sset_init(&devnames);
1589 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1590 uint64_t port_change_seq;
1592 port_change_seq = netdev_get_change_seq(ofport->netdev);
1593 if (ofport->change_seq != port_change_seq) {
1594 ofport->change_seq = port_change_seq;
1595 sset_add(&devnames, netdev_get_name(ofport->netdev));
1598 SSET_FOR_EACH (devname, &devnames) {
1599 update_port(p, devname);
1601 sset_destroy(&devnames);
1603 p->change_seq = new_seq;
1606 connmgr_run(p->connmgr, handle_openflow);
1612 ofproto_wait(struct ofproto *p)
1614 p->ofproto_class->wait(p);
1615 if (p->ofproto_class->port_poll_wait) {
1616 p->ofproto_class->port_poll_wait(p);
1618 seq_wait(connectivity_seq_get(), p->change_seq);
1619 connmgr_wait(p->connmgr);
1623 ofproto_is_alive(const struct ofproto *p)
1625 return connmgr_has_controllers(p->connmgr);
1628 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1629 * memory_report(). */
1631 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1633 const struct oftable *table;
1634 unsigned int n_rules;
1636 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1639 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1640 n_rules += classifier_count(&table->cls);
1642 simap_increase(usage, "rules", n_rules);
1644 if (ofproto->ofproto_class->get_memory_usage) {
1645 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1648 connmgr_get_memory_usage(ofproto->connmgr, usage);
1652 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1654 const struct ofproto_class *class;
1656 datapath_type = ofproto_normalize_type(datapath_type);
1657 class = ofproto_class_find__(datapath_type);
1659 if (class && class->type_get_memory_usage) {
1660 class->type_get_memory_usage(datapath_type, usage);
1665 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1668 connmgr_get_controller_info(ofproto->connmgr, info);
1672 ofproto_free_ofproto_controller_info(struct shash *info)
1674 connmgr_free_controller_info(info);
1677 /* Makes a deep copy of 'old' into 'port'. */
1679 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1681 port->name = xstrdup(old->name);
1682 port->type = xstrdup(old->type);
1683 port->ofp_port = old->ofp_port;
1686 /* Frees memory allocated to members of 'ofproto_port'.
1688 * Do not call this function on an ofproto_port obtained from
1689 * ofproto_port_dump_next(): that function retains ownership of the data in the
1692 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1694 free(ofproto_port->name);
1695 free(ofproto_port->type);
1698 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1700 * This function provides no status indication. An error status for the entire
1701 * dump operation is provided when it is completed by calling
1702 * ofproto_port_dump_done().
1705 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1706 const struct ofproto *ofproto)
1708 dump->ofproto = ofproto;
1709 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1713 /* Attempts to retrieve another port from 'dump', which must have been created
1714 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1715 * 'port' and returns true. On failure, returns false.
1717 * Failure might indicate an actual error or merely that the last port has been
1718 * dumped. An error status for the entire dump operation is provided when it
1719 * is completed by calling ofproto_port_dump_done().
1721 * The ofproto owns the data stored in 'port'. It will remain valid until at
1722 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1723 * ofproto_port_dump_done(). */
1725 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1726 struct ofproto_port *port)
1728 const struct ofproto *ofproto = dump->ofproto;
1734 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1737 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1743 /* Completes port table dump operation 'dump', which must have been created
1744 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1745 * error-free, otherwise a positive errno value describing the problem. */
1747 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1749 const struct ofproto *ofproto = dump->ofproto;
1751 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1754 return dump->error == EOF ? 0 : dump->error;
1757 /* Returns the type to pass to netdev_open() when a datapath of type
1758 * 'datapath_type' has a port of type 'port_type', for a few special
1759 * cases when a netdev type differs from a port type. For example, when
1760 * using the userspace datapath, a port of type "internal" needs to be
1763 * Returns either 'type' itself or a string literal, which must not be
1766 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1768 const struct ofproto_class *class;
1770 datapath_type = ofproto_normalize_type(datapath_type);
1771 class = ofproto_class_find__(datapath_type);
1776 return (class->port_open_type
1777 ? class->port_open_type(datapath_type, port_type)
1781 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1782 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1783 * the port's OpenFlow port number.
1785 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1786 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1787 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1788 * 'ofp_portp' is non-null). */
1790 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1791 ofp_port_t *ofp_portp)
1793 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1796 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1798 const char *netdev_name = netdev_get_name(netdev);
1800 simap_put(&ofproto->ofp_requests, netdev_name,
1801 ofp_to_u16(ofp_port));
1802 update_port(ofproto, netdev_name);
1805 *ofp_portp = OFPP_NONE;
1807 struct ofproto_port ofproto_port;
1809 error = ofproto_port_query_by_name(ofproto,
1810 netdev_get_name(netdev),
1813 *ofp_portp = ofproto_port.ofp_port;
1814 ofproto_port_destroy(&ofproto_port);
1821 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1822 * initializes '*port' appropriately; on failure, returns a positive errno
1825 * The caller owns the data in 'ofproto_port' and must free it with
1826 * ofproto_port_destroy() when it is no longer needed. */
1828 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1829 struct ofproto_port *port)
1833 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1835 memset(port, 0, sizeof *port);
1840 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1841 * Returns 0 if successful, otherwise a positive errno. */
1843 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1845 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1846 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1847 struct simap_node *ofp_request_node;
1850 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1851 if (ofp_request_node) {
1852 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1855 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1856 if (!error && ofport) {
1857 /* 'name' is the netdev's name and update_port() is going to close the
1858 * netdev. Just in case update_port() refers to 'name' after it
1859 * destroys 'ofport', make a copy of it around the update_port()
1861 char *devname = xstrdup(name);
1862 update_port(ofproto, devname);
1869 flow_mod_init(struct ofputil_flow_mod *fm,
1870 const struct match *match, unsigned int priority,
1871 const struct ofpact *ofpacts, size_t ofpacts_len,
1872 enum ofp_flow_mod_command command)
1874 memset(fm, 0, sizeof *fm);
1876 fm->priority = priority;
1879 fm->modify_cookie = false;
1881 fm->command = command;
1882 fm->idle_timeout = 0;
1883 fm->hard_timeout = 0;
1884 fm->buffer_id = UINT32_MAX;
1885 fm->out_port = OFPP_ANY;
1886 fm->out_group = OFPG_ANY;
1888 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1889 fm->ofpacts_len = ofpacts_len;
1890 fm->delete_reason = OFPRR_DELETE;
1894 simple_flow_mod(struct ofproto *ofproto,
1895 const struct match *match, unsigned int priority,
1896 const struct ofpact *ofpacts, size_t ofpacts_len,
1897 enum ofp_flow_mod_command command)
1899 struct ofputil_flow_mod fm;
1901 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1903 return handle_flow_mod__(ofproto, &fm, NULL);
1906 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1907 * performs the 'n_actions' actions in 'actions'. The new flow will not
1910 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1911 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1912 * controllers; otherwise, it will be hidden.
1914 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1916 * This is a helper function for in-band control and fail-open. */
1918 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1919 unsigned int priority,
1920 const struct ofpact *ofpacts, size_t ofpacts_len)
1921 OVS_EXCLUDED(ofproto_mutex)
1923 const struct rule *rule;
1926 /* First do a cheap check whether the rule we're looking for already exists
1927 * with the actions that we want. If it does, then we're done. */
1928 rule = rule_from_cls_rule(classifier_find_match_exactly(
1929 &ofproto->tables[0].cls, match, priority));
1931 const struct rule_actions *actions = rule_get_actions(rule);
1932 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1933 ofpacts, ofpacts_len);
1938 /* If there's no such rule or the rule doesn't have the actions we want,
1939 * fall back to a executing a full flow mod. We can't optimize this at
1940 * all because we didn't take enough locks above to ensure that the flow
1941 * table didn't already change beneath us. */
1943 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1944 OFPFC_MODIFY_STRICT);
1948 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1949 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1950 * operation cannot be initiated now but may be retried later.
1952 * This is a helper function for in-band control and fail-open and the "learn"
1955 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1956 OVS_EXCLUDED(ofproto_mutex)
1958 /* Optimize for the most common case of a repeated learn action.
1959 * If an identical flow already exists we only need to update its
1960 * 'modified' time. */
1961 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1962 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1963 struct oftable *table = &ofproto->tables[fm->table_id];
1967 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
1971 /* Reading many of the rule fields and writing on 'modified'
1972 * requires the rule->mutex. Also, rule->actions may change
1973 * if rule->mutex is not held. */
1974 const struct rule_actions *actions;
1976 ovs_mutex_lock(&rule->mutex);
1977 actions = rule_get_actions(rule);
1978 if (rule->idle_timeout == fm->idle_timeout
1979 && rule->hard_timeout == fm->hard_timeout
1980 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1981 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1982 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
1983 actions->ofpacts, actions->ofpacts_len)) {
1984 /* Rule already exists and need not change, only update the
1985 modified timestamp. */
1986 rule->modified = time_msec();
1989 ovs_mutex_unlock(&rule->mutex);
1997 return handle_flow_mod__(ofproto, fm, NULL);
2000 /* Searches for a rule with matching criteria exactly equal to 'target' in
2001 * ofproto's table 0 and, if it finds one, deletes it.
2003 * This is a helper function for in-band control and fail-open. */
2005 ofproto_delete_flow(struct ofproto *ofproto,
2006 const struct match *target, unsigned int priority)
2007 OVS_EXCLUDED(ofproto_mutex)
2009 struct classifier *cls = &ofproto->tables[0].cls;
2012 /* First do a cheap check whether the rule we're looking for has already
2013 * been deleted. If so, then we're done. */
2014 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2020 /* Execute a flow mod. We can't optimize this at all because we didn't
2021 * take enough locks above to ensure that the flow table didn't already
2022 * change beneath us. */
2023 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2026 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2027 * the flows required by in-band control and fail-open. */
2029 ofproto_flush_flows(struct ofproto *ofproto)
2031 COVERAGE_INC(ofproto_flush);
2032 ofproto_flush__(ofproto);
2033 connmgr_flushed(ofproto->connmgr);
2037 reinit_ports(struct ofproto *p)
2039 struct ofproto_port_dump dump;
2040 struct sset devnames;
2041 struct ofport *ofport;
2042 struct ofproto_port ofproto_port;
2043 const char *devname;
2045 COVERAGE_INC(ofproto_reinit_ports);
2047 sset_init(&devnames);
2048 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2049 sset_add(&devnames, netdev_get_name(ofport->netdev));
2051 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2052 sset_add(&devnames, ofproto_port.name);
2055 SSET_FOR_EACH (devname, &devnames) {
2056 update_port(p, devname);
2058 sset_destroy(&devnames);
2062 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2066 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2067 port_idx = port_idx ? port_idx : UINT16_MAX;
2069 if (port_idx >= ofproto->max_ports
2070 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2071 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2072 long long int last_used_at, lru = LLONG_MAX;
2074 /* Search for a free OpenFlow port number. We try not to
2075 * immediately reuse them to prevent problems due to old
2078 * We limit the automatically assigned port numbers to the lower half
2079 * of the port range, to reserve the upper half for assignment by
2082 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2083 ofproto->alloc_port_no = 1;
2085 last_used_at = ofport_get_usage(ofproto,
2086 u16_to_ofp(ofproto->alloc_port_no));
2087 if (!last_used_at) {
2088 port_idx = ofproto->alloc_port_no;
2090 } else if ( last_used_at < time_msec() - 60*60*1000) {
2091 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2092 * more than an hour ago, consider it usable. */
2093 ofport_remove_usage(ofproto,
2094 u16_to_ofp(ofproto->alloc_port_no));
2095 port_idx = ofproto->alloc_port_no;
2097 } else if (last_used_at < lru) {
2099 lru_ofport = ofproto->alloc_port_no;
2102 if (ofproto->alloc_port_no == end_port_no) {
2104 port_idx = lru_ofport;
2111 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2112 return u16_to_ofp(port_idx);
2116 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2118 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2119 ofport_set_usage(ofproto, ofp_port, time_msec());
2123 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2124 * pointer if the netdev cannot be opened. On success, also fills in
2126 static struct netdev *
2127 ofport_open(struct ofproto *ofproto,
2128 struct ofproto_port *ofproto_port,
2129 struct ofputil_phy_port *pp)
2131 enum netdev_flags flags;
2132 struct netdev *netdev;
2135 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2137 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2138 "cannot be opened (%s)",
2140 ofproto_port->name, ofproto_port->ofp_port,
2141 ofproto_port->name, ovs_strerror(error));
2145 if (ofproto_port->ofp_port == OFPP_NONE) {
2146 if (!strcmp(ofproto->name, ofproto_port->name)) {
2147 ofproto_port->ofp_port = OFPP_LOCAL;
2149 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2150 ofproto_port->name);
2153 pp->port_no = ofproto_port->ofp_port;
2154 netdev_get_etheraddr(netdev, pp->hw_addr);
2155 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2156 netdev_get_flags(netdev, &flags);
2157 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2158 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2159 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2160 &pp->supported, &pp->peer);
2161 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2162 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2167 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2168 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2171 ofport_equal(const struct ofputil_phy_port *a,
2172 const struct ofputil_phy_port *b)
2174 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2175 && a->state == b->state
2176 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2177 && a->curr == b->curr
2178 && a->advertised == b->advertised
2179 && a->supported == b->supported
2180 && a->peer == b->peer
2181 && a->curr_speed == b->curr_speed
2182 && a->max_speed == b->max_speed);
2185 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2186 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2187 * one with the same name or port number). */
2189 ofport_install(struct ofproto *p,
2190 struct netdev *netdev, const struct ofputil_phy_port *pp)
2192 const char *netdev_name = netdev_get_name(netdev);
2193 struct ofport *ofport;
2196 /* Create ofport. */
2197 ofport = p->ofproto_class->port_alloc();
2202 ofport->ofproto = p;
2203 ofport->netdev = netdev;
2204 ofport->change_seq = netdev_get_change_seq(netdev);
2206 ofport->ofp_port = pp->port_no;
2207 ofport->created = time_msec();
2209 /* Add port to 'p'. */
2210 hmap_insert(&p->ports, &ofport->hmap_node,
2211 hash_ofp_port(ofport->ofp_port));
2212 shash_add(&p->port_by_name, netdev_name, ofport);
2214 update_mtu(p, ofport);
2216 /* Let the ofproto_class initialize its private data. */
2217 error = p->ofproto_class->port_construct(ofport);
2221 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2225 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2226 p->name, netdev_name, ovs_strerror(error));
2228 ofport_destroy__(ofport);
2230 netdev_close(netdev);
2234 /* Removes 'ofport' from 'p' and destroys it. */
2236 ofport_remove(struct ofport *ofport)
2238 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2240 ofport_destroy(ofport);
2243 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2246 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2248 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2250 ofport_remove(port);
2254 /* Updates 'port' with new 'pp' description.
2256 * Does not handle a name or port number change. The caller must implement
2257 * such a change as a delete followed by an add. */
2259 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2261 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2262 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2263 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2264 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2265 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2266 port->pp.curr = pp->curr;
2267 port->pp.advertised = pp->advertised;
2268 port->pp.supported = pp->supported;
2269 port->pp.peer = pp->peer;
2270 port->pp.curr_speed = pp->curr_speed;
2271 port->pp.max_speed = pp->max_speed;
2273 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2274 &port->pp, OFPPR_MODIFY);
2277 /* Update OpenFlow 'state' in 'port' and notify controller. */
2279 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2281 if (port->pp.state != state) {
2282 port->pp.state = state;
2283 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2284 &port->pp, OFPPR_MODIFY);
2289 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2291 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2293 if (port->ofproto->ofproto_class->set_realdev) {
2294 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2296 if (port->ofproto->ofproto_class->set_stp_port) {
2297 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2299 if (port->ofproto->ofproto_class->set_rstp_port) {
2300 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2302 if (port->ofproto->ofproto_class->set_cfm) {
2303 port->ofproto->ofproto_class->set_cfm(port, NULL);
2305 if (port->ofproto->ofproto_class->bundle_remove) {
2306 port->ofproto->ofproto_class->bundle_remove(port);
2312 ofport_destroy__(struct ofport *port)
2314 struct ofproto *ofproto = port->ofproto;
2315 const char *name = netdev_get_name(port->netdev);
2317 hmap_remove(&ofproto->ports, &port->hmap_node);
2318 shash_delete(&ofproto->port_by_name,
2319 shash_find(&ofproto->port_by_name, name));
2321 netdev_close(port->netdev);
2322 ofproto->ofproto_class->port_dealloc(port);
2326 ofport_destroy(struct ofport *port)
2329 dealloc_ofp_port(port->ofproto, port->ofp_port);
2330 port->ofproto->ofproto_class->port_destruct(port);
2331 ofport_destroy__(port);
2336 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2338 struct ofport *port;
2340 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2342 if (port->ofp_port == ofp_port) {
2349 static long long int
2350 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2352 struct ofport_usage *usage;
2354 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2355 &ofproto->ofport_usage) {
2356 if (usage->ofp_port == ofp_port) {
2357 return usage->last_used;
2364 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2365 long long int last_used)
2367 struct ofport_usage *usage;
2368 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2369 &ofproto->ofport_usage) {
2370 if (usage->ofp_port == ofp_port) {
2371 usage->last_used = last_used;
2375 ovs_assert(last_used == LLONG_MAX);
2377 usage = xmalloc(sizeof *usage);
2378 usage->ofp_port = ofp_port;
2379 usage->last_used = last_used;
2380 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2381 hash_ofp_port(ofp_port));
2385 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2387 struct ofport_usage *usage;
2388 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2389 &ofproto->ofport_usage) {
2390 if (usage->ofp_port == ofp_port) {
2391 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2399 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2401 struct ofproto *ofproto = port->ofproto;
2404 if (ofproto->ofproto_class->port_get_stats) {
2405 error = ofproto->ofproto_class->port_get_stats(port, stats);
2414 update_port(struct ofproto *ofproto, const char *name)
2416 struct ofproto_port ofproto_port;
2417 struct ofputil_phy_port pp;
2418 struct netdev *netdev;
2419 struct ofport *port;
2421 COVERAGE_INC(ofproto_update_port);
2423 /* Fetch 'name''s location and properties from the datapath. */
2424 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2425 ? ofport_open(ofproto, &ofproto_port, &pp)
2429 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2430 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2431 struct netdev *old_netdev = port->netdev;
2433 /* 'name' hasn't changed location. Any properties changed? */
2434 if (!ofport_equal(&port->pp, &pp)) {
2435 ofport_modified(port, &pp);
2438 update_mtu(ofproto, port);
2440 /* Install the newly opened netdev in case it has changed.
2441 * Don't close the old netdev yet in case port_modified has to
2442 * remove a retained reference to it.*/
2443 port->netdev = netdev;
2444 port->change_seq = netdev_get_change_seq(netdev);
2446 if (port->ofproto->ofproto_class->port_modified) {
2447 port->ofproto->ofproto_class->port_modified(port);
2450 netdev_close(old_netdev);
2452 /* If 'port' is nonnull then its name differs from 'name' and thus
2453 * we should delete it. If we think there's a port named 'name'
2454 * then its port number must be wrong now so delete it too. */
2456 ofport_remove(port);
2458 ofport_remove_with_name(ofproto, name);
2459 ofport_install(ofproto, netdev, &pp);
2462 /* Any port named 'name' is gone now. */
2463 ofport_remove_with_name(ofproto, name);
2465 ofproto_port_destroy(&ofproto_port);
2469 init_ports(struct ofproto *p)
2471 struct ofproto_port_dump dump;
2472 struct ofproto_port ofproto_port;
2473 struct shash_node *node, *next;
2475 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2476 const char *name = ofproto_port.name;
2478 if (shash_find(&p->port_by_name, name)) {
2479 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2482 struct ofputil_phy_port pp;
2483 struct netdev *netdev;
2485 /* Check if an OpenFlow port number had been requested. */
2486 node = shash_find(&init_ofp_ports, name);
2488 const struct iface_hint *iface_hint = node->data;
2489 simap_put(&p->ofp_requests, name,
2490 ofp_to_u16(iface_hint->ofp_port));
2493 netdev = ofport_open(p, &ofproto_port, &pp);
2495 ofport_install(p, netdev, &pp);
2496 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2497 p->alloc_port_no = MAX(p->alloc_port_no,
2498 ofp_to_u16(ofproto_port.ofp_port));
2504 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2505 struct iface_hint *iface_hint = node->data;
2507 if (!strcmp(iface_hint->br_name, p->name)) {
2508 free(iface_hint->br_name);
2509 free(iface_hint->br_type);
2511 shash_delete(&init_ofp_ports, node);
2518 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2519 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2521 find_min_mtu(struct ofproto *p)
2523 struct ofport *ofport;
2526 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2527 struct netdev *netdev = ofport->netdev;
2530 /* Skip any internal ports, since that's what we're trying to
2532 if (!strcmp(netdev_get_type(netdev), "internal")) {
2536 if (netdev_get_mtu(netdev, &dev_mtu)) {
2539 if (!mtu || dev_mtu < mtu) {
2544 return mtu ? mtu: ETH_PAYLOAD_MAX;
2547 /* Update MTU of all datapath devices on 'p' to the minimum of the
2548 * non-datapath ports in event of 'port' added or changed. */
2550 update_mtu(struct ofproto *p, struct ofport *port)
2552 struct ofport *ofport;
2553 struct netdev *netdev = port->netdev;
2554 int dev_mtu, old_min;
2556 if (netdev_get_mtu(netdev, &dev_mtu)) {
2560 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2561 if (dev_mtu > p->min_mtu) {
2562 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2563 dev_mtu = p->min_mtu;
2566 port->mtu = dev_mtu;
2570 /* For non-internal port find new min mtu. */
2571 old_min = p->min_mtu;
2572 port->mtu = dev_mtu;
2573 p->min_mtu = find_min_mtu(p);
2574 if (p->min_mtu == old_min) {
2578 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2579 struct netdev *netdev = ofport->netdev;
2581 if (!strcmp(netdev_get_type(netdev), "internal")) {
2582 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2583 ofport->mtu = p->min_mtu;
2590 ofproto_rule_destroy__(struct rule *rule)
2591 OVS_NO_THREAD_SAFETY_ANALYSIS
2593 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2594 rule_actions_destroy(rule_get_actions(rule));
2595 ovs_mutex_destroy(&rule->mutex);
2596 rule->ofproto->ofproto_class->rule_dealloc(rule);
2600 rule_destroy_cb(struct rule *rule)
2602 rule->ofproto->ofproto_class->rule_destruct(rule);
2603 ofproto_rule_destroy__(rule);
2607 ofproto_rule_ref(struct rule *rule)
2610 ovs_refcount_ref(&rule->ref_count);
2615 ofproto_rule_try_ref(struct rule *rule)
2618 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2623 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2624 * ref_count reaches 0.
2626 * Use of RCU allows short term use (between RCU quiescent periods) without
2627 * keeping a reference. A reference must be taken if the rule needs to
2628 * stay around accross the RCU quiescent periods. */
2630 ofproto_rule_unref(struct rule *rule)
2632 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2633 ovsrcu_postpone(rule_destroy_cb, rule);
2638 ofproto_group_ref(struct ofgroup *group)
2641 ovs_refcount_ref(&group->ref_count);
2646 ofproto_group_unref(struct ofgroup *group)
2648 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2649 group->ofproto->ofproto_class->group_destruct(group);
2650 ofputil_bucket_list_destroy(&group->buckets);
2651 group->ofproto->ofproto_class->group_dealloc(group);
2655 static uint32_t get_provider_meter_id(const struct ofproto *,
2656 uint32_t of_meter_id);
2658 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2659 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2660 const struct rule_actions *
2661 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2663 struct rule_actions *actions;
2665 actions = xmalloc(sizeof *actions + ofpacts_len);
2666 actions->ofpacts_len = ofpacts_len;
2667 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2668 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2670 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2676 /* Free the actions after the RCU quiescent period is reached. */
2678 rule_actions_destroy(const struct rule_actions *actions)
2681 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2685 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2686 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2688 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2689 OVS_REQUIRES(ofproto_mutex)
2691 if (port == OFPP_ANY) {
2694 const struct rule_actions *actions = rule_get_actions(rule);
2695 return ofpacts_output_to_port(actions->ofpacts,
2696 actions->ofpacts_len, port);
2700 /* Returns true if 'rule' has group and equals group_id. */
2702 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2703 OVS_REQUIRES(ofproto_mutex)
2705 if (group_id == OFPG_ANY) {
2708 const struct rule_actions *actions = rule_get_actions(rule);
2709 return ofpacts_output_to_group(actions->ofpacts,
2710 actions->ofpacts_len, group_id);
2715 rule_execute_destroy(struct rule_execute *e)
2717 ofproto_rule_unref(e->rule);
2718 list_remove(&e->list_node);
2722 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2723 * by passing them to the ofproto provider. */
2725 run_rule_executes(struct ofproto *ofproto)
2726 OVS_EXCLUDED(ofproto_mutex)
2728 struct rule_execute *e, *next;
2729 struct list executes;
2731 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2732 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2735 flow_extract(e->packet, NULL, &flow);
2736 flow.in_port.ofp_port = e->in_port;
2737 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2739 rule_execute_destroy(e);
2743 /* Destroys and discards all "rule_execute" operations queued up in
2744 * ofproto->rule_executes. */
2746 destroy_rule_executes(struct ofproto *ofproto)
2748 struct rule_execute *e, *next;
2749 struct list executes;
2751 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2752 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2753 ofpbuf_delete(e->packet);
2754 rule_execute_destroy(e);
2759 rule_is_readonly(const struct rule *rule)
2761 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2762 return (table->flags & OFTABLE_READONLY) != 0;
2766 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2768 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2769 return hash_3words(cookie, cookie >> 32, table_id);
2773 learned_cookies_update_one__(struct ofproto *ofproto,
2774 const struct ofpact_learn *learn,
2775 int delta, struct list *dead_cookies)
2776 OVS_REQUIRES(ofproto_mutex)
2778 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
2779 struct learned_cookie *c;
2781 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
2782 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
2784 ovs_assert(c->n >= 0);
2787 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
2788 list_push_back(dead_cookies, &c->u.list_node);
2795 ovs_assert(delta > 0);
2796 c = xmalloc(sizeof *c);
2797 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
2798 c->cookie = learn->cookie;
2799 c->table_id = learn->table_id;
2803 static const struct ofpact_learn *
2804 next_learn_with_delete(const struct rule_actions *actions,
2805 const struct ofpact_learn *start)
2807 const struct ofpact *pos;
2809 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
2810 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
2811 pos = ofpact_next(pos)) {
2812 if (pos->type == OFPACT_LEARN) {
2813 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
2814 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
2824 learned_cookies_update__(struct ofproto *ofproto,
2825 const struct rule_actions *actions,
2826 int delta, struct list *dead_cookies)
2827 OVS_REQUIRES(ofproto_mutex)
2829 if (actions->has_learn_with_delete) {
2830 const struct ofpact_learn *learn;
2832 for (learn = next_learn_with_delete(actions, NULL); learn;
2833 learn = next_learn_with_delete(actions, learn)) {
2834 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
2840 learned_cookies_inc(struct ofproto *ofproto,
2841 const struct rule_actions *actions)
2842 OVS_REQUIRES(ofproto_mutex)
2844 learned_cookies_update__(ofproto, actions, +1, NULL);
2848 learned_cookies_dec(struct ofproto *ofproto,
2849 const struct rule_actions *actions,
2850 struct list *dead_cookies)
2851 OVS_REQUIRES(ofproto_mutex)
2853 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
2857 learned_cookies_flush(struct ofproto *ofproto, struct list *dead_cookies)
2858 OVS_REQUIRES(ofproto_mutex)
2860 struct learned_cookie *c, *next;
2862 LIST_FOR_EACH_SAFE (c, next, u.list_node, dead_cookies) {
2863 struct rule_criteria criteria;
2864 struct rule_collection rules;
2867 match_init_catchall(&match);
2868 rule_criteria_init(&criteria, c->table_id, &match, 0,
2869 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
2870 rule_criteria_require_rw(&criteria, false);
2871 collect_rules_loose(ofproto, &criteria, &rules);
2872 delete_flows__(&rules, OFPRR_DELETE, NULL);
2873 rule_criteria_destroy(&criteria);
2874 rule_collection_destroy(&rules);
2876 list_remove(&c->u.list_node);
2882 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2884 ofconn_send_reply(ofconn, make_echo_reply(oh));
2889 query_tables(struct ofproto *ofproto,
2890 struct ofputil_table_features **featuresp,
2891 struct ofputil_table_stats **statsp)
2893 struct mf_bitmap rw_fields = MF_BITMAP_INITIALIZER;
2894 struct mf_bitmap match = MF_BITMAP_INITIALIZER;
2895 struct mf_bitmap mask = MF_BITMAP_INITIALIZER;
2897 struct ofputil_table_features *features;
2898 struct ofputil_table_stats *stats;
2901 for (i = 0; i < MFF_N_IDS; i++) {
2902 const struct mf_field *mf = mf_from_id(i);
2905 bitmap_set1(rw_fields.bm, i);
2907 if (mf->oxm_header || mf->nxm_header) {
2908 bitmap_set1(match.bm, i);
2909 if (mf->maskable == MFM_FULLY) {
2910 bitmap_set1(mask.bm, i);
2915 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
2916 for (i = 0; i < ofproto->n_tables; i++) {
2917 struct ofputil_table_features *f = &features[i];
2920 sprintf(f->name, "table%d", i);
2921 f->metadata_match = OVS_BE64_MAX;
2922 f->metadata_write = OVS_BE64_MAX;
2923 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
2924 f->max_entries = 1000000;
2926 bitmap_set_multiple(f->nonmiss.next, i + 1,
2927 ofproto->n_tables - (i + 1), true);
2928 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
2929 if (i == ofproto->n_tables - 1) {
2930 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
2932 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
2933 f->nonmiss.write.set_fields = rw_fields;
2934 f->nonmiss.apply = f->nonmiss.write;
2935 f->miss = f->nonmiss;
2939 f->wildcard = match;
2943 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
2944 for (i = 0; i < ofproto->n_tables; i++) {
2945 struct ofputil_table_stats *s = &stats[i];
2946 struct classifier *cls = &ofproto->tables[i].cls;
2949 s->active_count = classifier_count(cls);
2955 ofproto->ofproto_class->query_tables(ofproto, features, stats);
2957 for (i = 0; i < ofproto->n_tables; i++) {
2958 const struct oftable *table = &ofproto->tables[i];
2959 struct ofputil_table_features *f = &features[i];
2962 ovs_strzcpy(f->name, table->name, sizeof f->name);
2965 if (table->max_flows < f->max_entries) {
2966 f->max_entries = table->max_flows;
2972 query_switch_features(struct ofproto *ofproto,
2973 bool *arp_match_ip, uint64_t *ofpacts)
2975 struct ofputil_table_features *features, *f;
2977 *arp_match_ip = false;
2980 query_tables(ofproto, &features, NULL);
2981 for (f = features; f < &features[ofproto->n_tables]; f++) {
2982 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
2983 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
2984 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
2985 *arp_match_ip = true;
2991 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
2995 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2997 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2998 struct ofputil_switch_features features;
2999 struct ofport *port;
3003 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3005 features.datapath_id = ofproto->datapath_id;
3006 features.n_buffers = pktbuf_capacity();
3007 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3008 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3009 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
3011 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3013 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3014 features.auxiliary_id = 0;
3015 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3017 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3018 ofputil_put_switch_features_port(&port->pp, b);
3021 ofconn_send_reply(ofconn, b);
3026 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3028 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3029 struct ofp_switch_config *osc;
3030 enum ofp_config_flags flags;
3034 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3035 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3036 flags = ofproto->frag_handling;
3037 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3038 if (oh->version < OFP13_VERSION
3039 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3040 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3042 osc->flags = htons(flags);
3043 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3044 ofconn_send_reply(ofconn, buf);
3050 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3052 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3053 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3054 uint16_t flags = ntohs(osc->flags);
3056 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3057 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3058 enum ofp_config_flags cur = ofproto->frag_handling;
3059 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3061 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3063 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3064 ofproto->frag_handling = next;
3066 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3068 ofputil_frag_handling_to_string(next));
3072 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3073 ofconn_set_invalid_ttl_to_controller(ofconn,
3074 (oh->version < OFP13_VERSION
3075 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3077 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3082 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3083 * error message code for the caller to propagate upward. Otherwise, returns
3086 * The log message mentions 'msg_type'. */
3088 reject_slave_controller(struct ofconn *ofconn)
3090 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3091 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3092 return OFPERR_OFPBRC_EPERM;
3098 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3101 * - If they use a meter, then 'ofproto' has that meter configured.
3103 * - If they use any groups, then 'ofproto' has that group configured.
3105 * Returns 0 if successful, otherwise an OpenFlow error. */
3107 ofproto_check_ofpacts(struct ofproto *ofproto,
3108 const struct ofpact ofpacts[], size_t ofpacts_len)
3110 const struct ofpact *a;
3113 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3114 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3115 return OFPERR_OFPMMFC_INVALID_METER;
3118 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3119 if (a->type == OFPACT_GROUP
3120 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3121 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3129 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3131 struct ofproto *p = ofconn_get_ofproto(ofconn);
3132 struct ofputil_packet_out po;
3133 struct ofpbuf *payload;
3134 uint64_t ofpacts_stub[1024 / 8];
3135 struct ofpbuf ofpacts;
3139 COVERAGE_INC(ofproto_packet_out);
3141 error = reject_slave_controller(ofconn);
3146 /* Decode message. */
3147 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3148 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3150 goto exit_free_ofpacts;
3152 if (ofp_to_u16(po.in_port) >= p->max_ports
3153 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3154 error = OFPERR_OFPBRC_BAD_PORT;
3155 goto exit_free_ofpacts;
3159 if (po.buffer_id != UINT32_MAX) {
3160 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3161 if (error || !payload) {
3162 goto exit_free_ofpacts;
3165 /* Ensure that the L3 header is 32-bit aligned. */
3166 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
3169 /* Verify actions against packet, then send packet if successful. */
3170 flow_extract(payload, NULL, &flow);
3171 flow.in_port.ofp_port = po.in_port;
3172 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3174 error = p->ofproto_class->packet_out(p, payload, &flow,
3175 po.ofpacts, po.ofpacts_len);
3177 ofpbuf_delete(payload);
3180 ofpbuf_uninit(&ofpacts);
3186 update_port_config(struct ofconn *ofconn, struct ofport *port,
3187 enum ofputil_port_config config,
3188 enum ofputil_port_config mask)
3190 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3192 if (toggle & OFPUTIL_PC_PORT_DOWN
3193 && (config & OFPUTIL_PC_PORT_DOWN
3194 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3195 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3196 /* We tried to bring the port up or down, but it failed, so don't
3197 * update the "down" bit. */
3198 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3202 enum ofputil_port_config old_config = port->pp.config;
3203 port->pp.config ^= toggle;
3204 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3205 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3211 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3213 struct ofproto *p = ofconn_get_ofproto(ofconn);
3214 struct ofputil_port_mod pm;
3215 struct ofport *port;
3218 error = reject_slave_controller(ofconn);
3223 error = ofputil_decode_port_mod(oh, &pm, false);
3228 port = ofproto_get_port(p, pm.port_no);
3230 return OFPERR_OFPPMFC_BAD_PORT;
3231 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3232 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3234 update_port_config(ofconn, port, pm.config, pm.mask);
3236 netdev_set_advertisements(port->netdev, pm.advertise);
3243 handle_desc_stats_request(struct ofconn *ofconn,
3244 const struct ofp_header *request)
3246 static const char *default_mfr_desc = "Nicira, Inc.";
3247 static const char *default_hw_desc = "Open vSwitch";
3248 static const char *default_sw_desc = VERSION;
3249 static const char *default_serial_desc = "None";
3250 static const char *default_dp_desc = "None";
3252 struct ofproto *p = ofconn_get_ofproto(ofconn);
3253 struct ofp_desc_stats *ods;
3256 msg = ofpraw_alloc_stats_reply(request, 0);
3257 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3258 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3259 sizeof ods->mfr_desc);
3260 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3261 sizeof ods->hw_desc);
3262 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3263 sizeof ods->sw_desc);
3264 ovs_strlcpy(ods->serial_num,
3265 p->serial_desc ? p->serial_desc : default_serial_desc,
3266 sizeof ods->serial_num);
3267 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3268 sizeof ods->dp_desc);
3269 ofconn_send_reply(ofconn, msg);
3275 handle_table_stats_request(struct ofconn *ofconn,
3276 const struct ofp_header *request)
3278 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3279 struct ofputil_table_features *features;
3280 struct ofputil_table_stats *stats;
3281 struct ofpbuf *reply;
3284 query_tables(ofproto, &features, &stats);
3286 reply = ofputil_encode_table_stats_reply(request);
3287 for (i = 0; i < ofproto->n_tables; i++) {
3288 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3289 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3292 ofconn_send_reply(ofconn, reply);
3301 handle_table_features_request(struct ofconn *ofconn,
3302 const struct ofp_header *request)
3304 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3305 struct ofputil_table_features *features;
3306 struct list replies;
3310 ofpbuf_use_const(&msg, request, ntohs(request->length));
3311 ofpraw_pull_assert(&msg);
3312 if (ofpbuf_size(&msg) || ofpmp_more(request)) {
3313 return OFPERR_OFPTFFC_EPERM;
3316 query_tables(ofproto, &features, NULL);
3318 ofpmp_init(&replies, request);
3319 for (i = 0; i < ofproto->n_tables; i++) {
3320 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3321 ofputil_append_table_features_reply(&features[i], &replies);
3324 ofconn_send_replies(ofconn, &replies);
3332 append_port_stat(struct ofport *port, struct list *replies)
3334 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3336 calc_duration(port->created, time_msec(),
3337 &ops.duration_sec, &ops.duration_nsec);
3339 /* Intentionally ignore return value, since errors will set
3340 * 'stats' to all-1s, which is correct for OpenFlow, and
3341 * netdev_get_stats() will log errors. */
3342 ofproto_port_get_stats(port, &ops.stats);
3344 ofputil_append_port_stat(replies, &ops);
3348 handle_port_request(struct ofconn *ofconn,
3349 const struct ofp_header *request, ofp_port_t port_no,
3350 void (*cb)(struct ofport *, struct list *replies))
3352 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3353 struct ofport *port;
3354 struct list replies;
3356 ofpmp_init(&replies, request);
3357 if (port_no != OFPP_ANY) {
3358 port = ofproto_get_port(ofproto, port_no);
3363 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3368 ofconn_send_replies(ofconn, &replies);
3372 handle_port_stats_request(struct ofconn *ofconn,
3373 const struct ofp_header *request)
3378 error = ofputil_decode_port_stats_request(request, &port_no);
3380 handle_port_request(ofconn, request, port_no, append_port_stat);
3386 append_port_desc(struct ofport *port, struct list *replies)
3388 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3392 handle_port_desc_stats_request(struct ofconn *ofconn,
3393 const struct ofp_header *request)
3398 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3400 handle_port_request(ofconn, request, port_no, append_port_desc);
3406 hash_cookie(ovs_be64 cookie)
3408 return hash_uint64((OVS_FORCE uint64_t)cookie);
3412 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3413 OVS_REQUIRES(ofproto_mutex)
3415 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3416 hash_cookie(rule->flow_cookie));
3420 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3421 OVS_REQUIRES(ofproto_mutex)
3423 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3427 calc_duration(long long int start, long long int now,
3428 uint32_t *sec, uint32_t *nsec)
3430 long long int msecs = now - start;
3431 *sec = msecs / 1000;
3432 *nsec = (msecs % 1000) * (1000 * 1000);
3435 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3436 * true if 'table_id' is OK, false otherwise. */
3438 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3440 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3443 static struct oftable *
3444 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3446 struct oftable *table;
3448 for (table = &ofproto->tables[table_id];
3449 table < &ofproto->tables[ofproto->n_tables];
3451 if (!(table->flags & OFTABLE_HIDDEN)) {
3459 static struct oftable *
3460 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3462 if (table_id == 0xff) {
3463 return next_visible_table(ofproto, 0);
3464 } else if (table_id < ofproto->n_tables) {
3465 return &ofproto->tables[table_id];
3471 static struct oftable *
3472 next_matching_table(const struct ofproto *ofproto,
3473 const struct oftable *table, uint8_t table_id)
3475 return (table_id == 0xff
3476 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3480 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3482 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3483 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3485 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3486 * only once, for that table. (This can be used to access tables marked
3489 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3490 * entered at all. (Perhaps you should have validated TABLE_ID with
3491 * check_table_id().)
3493 * All parameters are evaluated multiple times.
3495 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3496 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3498 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3500 /* Initializes 'criteria' in a straightforward way based on the other
3503 * By default, the criteria include flows that are read-only, on the assumption
3504 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3505 * if flows will be modified.
3507 * For "loose" matching, the 'priority' parameter is unimportant and may be
3510 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3511 const struct match *match, unsigned int priority,
3512 ovs_be64 cookie, ovs_be64 cookie_mask,
3513 ofp_port_t out_port, uint32_t out_group)
3515 criteria->table_id = table_id;
3516 cls_rule_init(&criteria->cr, match, priority);
3517 criteria->cookie = cookie;
3518 criteria->cookie_mask = cookie_mask;
3519 criteria->out_port = out_port;
3520 criteria->out_group = out_group;
3522 /* We ordinarily want to skip hidden rules, but there has to be a way for
3523 * code internal to OVS to modify and delete them, so if the criteria
3524 * specify a priority that can only be for a hidden flow, then allow hidden
3525 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3526 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3528 criteria->include_hidden = priority > UINT16_MAX;
3530 /* We assume that the criteria are being used to collect flows for reading
3531 * but not modification. Thus, we should collect read-only flows. */
3532 criteria->include_readonly = true;
3535 /* By default, criteria initialized by rule_criteria_init() will match flows
3536 * that are read-only, on the assumption that the collected flows won't be
3537 * modified. Call this function to match only flows that are be modifiable.
3539 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3540 * caller has special privileges that allow it to modify even "read-only"
3543 rule_criteria_require_rw(struct rule_criteria *criteria,
3544 bool can_write_readonly)
3546 criteria->include_readonly = can_write_readonly;
3550 rule_criteria_destroy(struct rule_criteria *criteria)
3552 cls_rule_destroy(&criteria->cr);
3556 rule_collection_init(struct rule_collection *rules)
3558 rules->rules = rules->stub;
3560 rules->capacity = ARRAY_SIZE(rules->stub);
3564 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3566 if (rules->n >= rules->capacity) {
3567 size_t old_size, new_size;
3569 old_size = rules->capacity * sizeof *rules->rules;
3570 rules->capacity *= 2;
3571 new_size = rules->capacity * sizeof *rules->rules;
3573 if (rules->rules == rules->stub) {
3574 rules->rules = xmalloc(new_size);
3575 memcpy(rules->rules, rules->stub, old_size);
3577 rules->rules = xrealloc(rules->rules, new_size);
3581 rules->rules[rules->n++] = rule;
3585 rule_collection_ref(struct rule_collection *rules)
3586 OVS_REQUIRES(ofproto_mutex)
3590 for (i = 0; i < rules->n; i++) {
3591 ofproto_rule_ref(rules->rules[i]);
3596 rule_collection_unref(struct rule_collection *rules)
3600 for (i = 0; i < rules->n; i++) {
3601 ofproto_rule_unref(rules->rules[i]);
3606 rule_collection_destroy(struct rule_collection *rules)
3608 if (rules->rules != rules->stub) {
3612 /* Make repeated destruction harmless. */
3613 rule_collection_init(rules);
3616 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3617 * function verifies most of the criteria in 'c' itself, but the caller must
3618 * check 'c->cr' itself.
3620 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3621 * 'c' only includes modifiable rules). */
3623 collect_rule(struct rule *rule, const struct rule_criteria *c,
3624 struct rule_collection *rules, size_t *n_readonly)
3625 OVS_REQUIRES(ofproto_mutex)
3627 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3628 && ofproto_rule_has_out_port(rule, c->out_port)
3629 && ofproto_rule_has_out_group(rule, c->out_group)
3630 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3631 && (!rule_is_hidden(rule) || c->include_hidden)) {
3632 /* Rule matches all the criteria... */
3633 if (!rule_is_readonly(rule) || c->include_readonly) {
3635 rule_collection_add(rules, rule);
3637 /* ...except it's read-only. */
3643 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3644 * on classifiers rules are done in the "loose" way required for OpenFlow
3645 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3648 * Returns 0 on success, otherwise an OpenFlow error code. */
3650 collect_rules_loose(struct ofproto *ofproto,
3651 const struct rule_criteria *criteria,
3652 struct rule_collection *rules)
3653 OVS_REQUIRES(ofproto_mutex)
3655 struct oftable *table;
3656 enum ofperr error = 0;
3657 size_t n_readonly = 0;
3659 rule_collection_init(rules);
3661 if (!check_table_id(ofproto, criteria->table_id)) {
3662 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3666 if (criteria->cookie_mask == OVS_BE64_MAX) {
3669 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3670 hash_cookie(criteria->cookie),
3671 &ofproto->cookies) {
3672 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3673 collect_rule(rule, criteria, rules, &n_readonly);
3677 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3680 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3681 collect_rule(rule, criteria, rules, &n_readonly);
3687 if (!error && !rules->n && n_readonly) {
3688 /* We didn't find any rules to modify. We did find some read-only
3689 * rules that we're not allowed to modify, so report that. */
3690 error = OFPERR_OFPBRC_EPERM;
3693 rule_collection_destroy(rules);
3698 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3699 * on classifiers rules are done in the "strict" way required for OpenFlow
3700 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3701 * rules on list 'rules'.
3703 * Returns 0 on success, otherwise an OpenFlow error code. */
3705 collect_rules_strict(struct ofproto *ofproto,
3706 const struct rule_criteria *criteria,
3707 struct rule_collection *rules)
3708 OVS_REQUIRES(ofproto_mutex)
3710 struct oftable *table;
3711 size_t n_readonly = 0;
3714 rule_collection_init(rules);
3716 if (!check_table_id(ofproto, criteria->table_id)) {
3717 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3721 if (criteria->cookie_mask == OVS_BE64_MAX) {
3724 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3725 hash_cookie(criteria->cookie),
3726 &ofproto->cookies) {
3727 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3728 collect_rule(rule, criteria, rules, &n_readonly);
3732 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3735 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3736 &table->cls, &criteria->cr));
3738 collect_rule(rule, criteria, rules, &n_readonly);
3744 if (!error && !rules->n && n_readonly) {
3745 /* We didn't find any rules to modify. We did find some read-only
3746 * rules that we're not allowed to modify, so report that. */
3747 error = OFPERR_OFPBRC_EPERM;
3750 rule_collection_destroy(rules);
3755 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3756 * forced into the range of a uint16_t. */
3758 age_secs(long long int age_ms)
3760 return (age_ms < 0 ? 0
3761 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3762 : (unsigned int) age_ms / 1000);
3766 handle_flow_stats_request(struct ofconn *ofconn,
3767 const struct ofp_header *request)
3768 OVS_EXCLUDED(ofproto_mutex)
3770 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3771 struct ofputil_flow_stats_request fsr;
3772 struct rule_criteria criteria;
3773 struct rule_collection rules;
3774 struct list replies;
3778 error = ofputil_decode_flow_stats_request(&fsr, request);
3783 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3784 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3786 ovs_mutex_lock(&ofproto_mutex);
3787 error = collect_rules_loose(ofproto, &criteria, &rules);
3788 rule_criteria_destroy(&criteria);
3790 rule_collection_ref(&rules);
3792 ovs_mutex_unlock(&ofproto_mutex);
3798 ofpmp_init(&replies, request);
3799 for (i = 0; i < rules.n; i++) {
3800 struct rule *rule = rules.rules[i];
3801 long long int now = time_msec();
3802 struct ofputil_flow_stats fs;
3803 long long int created, used, modified;
3804 const struct rule_actions *actions;
3805 enum ofputil_flow_mod_flags flags;
3807 ovs_mutex_lock(&rule->mutex);
3808 fs.cookie = rule->flow_cookie;
3809 fs.idle_timeout = rule->idle_timeout;
3810 fs.hard_timeout = rule->hard_timeout;
3811 created = rule->created;
3812 modified = rule->modified;
3813 actions = rule_get_actions(rule);
3814 flags = rule->flags;
3815 ovs_mutex_unlock(&rule->mutex);
3817 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3818 &fs.byte_count, &used);
3820 minimatch_expand(&rule->cr.match, &fs.match);
3821 fs.table_id = rule->table_id;
3822 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3823 fs.priority = rule->cr.priority;
3824 fs.idle_age = age_secs(now - used);
3825 fs.hard_age = age_secs(now - modified);
3826 fs.ofpacts = actions->ofpacts;
3827 fs.ofpacts_len = actions->ofpacts_len;
3830 ofputil_append_flow_stats_reply(&fs, &replies);
3833 rule_collection_unref(&rules);
3834 rule_collection_destroy(&rules);
3836 ofconn_send_replies(ofconn, &replies);
3842 flow_stats_ds(struct rule *rule, struct ds *results)
3844 uint64_t packet_count, byte_count;
3845 const struct rule_actions *actions;
3846 long long int created, used;
3848 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3849 &byte_count, &used);
3851 ovs_mutex_lock(&rule->mutex);
3852 actions = rule_get_actions(rule);
3853 created = rule->created;
3854 ovs_mutex_unlock(&rule->mutex);
3856 if (rule->table_id != 0) {
3857 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3859 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3860 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3861 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3862 cls_rule_format(&rule->cr, results);
3863 ds_put_char(results, ',');
3865 ds_put_cstr(results, "actions=");
3866 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3868 ds_put_cstr(results, "\n");
3871 /* Adds a pretty-printed description of all flows to 'results', including
3872 * hidden flows (e.g., set up by in-band control). */
3874 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3876 struct oftable *table;
3878 OFPROTO_FOR_EACH_TABLE (table, p) {
3881 CLS_FOR_EACH (rule, cr, &table->cls) {
3882 flow_stats_ds(rule, results);
3887 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3888 * '*engine_type' and '*engine_id', respectively. */
3890 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3891 uint8_t *engine_type, uint8_t *engine_id)
3893 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3896 /* Checks the status change of CFM on 'ofport'.
3898 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
3900 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
3902 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3903 return (ofport && ofproto->ofproto_class->cfm_status_changed
3904 ? ofproto->ofproto_class->cfm_status_changed(ofport)
3908 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3909 * Returns 0 if the port's CFM status was successfully stored into
3910 * '*status'. Returns positive errno if the port did not have CFM
3913 * The caller must provide and own '*status', and must free 'status->rmps'.
3914 * '*status' is indeterminate if the return value is non-zero. */
3916 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3917 struct cfm_status *status)
3919 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3920 return (ofport && ofproto->ofproto_class->get_cfm_status
3921 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
3926 handle_aggregate_stats_request(struct ofconn *ofconn,
3927 const struct ofp_header *oh)
3928 OVS_EXCLUDED(ofproto_mutex)
3930 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3931 struct ofputil_flow_stats_request request;
3932 struct ofputil_aggregate_stats stats;
3933 bool unknown_packets, unknown_bytes;
3934 struct rule_criteria criteria;
3935 struct rule_collection rules;
3936 struct ofpbuf *reply;
3940 error = ofputil_decode_flow_stats_request(&request, oh);
3945 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3946 request.cookie, request.cookie_mask,
3947 request.out_port, request.out_group);
3949 ovs_mutex_lock(&ofproto_mutex);
3950 error = collect_rules_loose(ofproto, &criteria, &rules);
3951 rule_criteria_destroy(&criteria);
3953 rule_collection_ref(&rules);
3955 ovs_mutex_unlock(&ofproto_mutex);
3961 memset(&stats, 0, sizeof stats);
3962 unknown_packets = unknown_bytes = false;
3963 for (i = 0; i < rules.n; i++) {
3964 struct rule *rule = rules.rules[i];
3965 uint64_t packet_count;
3966 uint64_t byte_count;
3969 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3970 &byte_count, &used);
3972 if (packet_count == UINT64_MAX) {
3973 unknown_packets = true;
3975 stats.packet_count += packet_count;
3978 if (byte_count == UINT64_MAX) {
3979 unknown_bytes = true;
3981 stats.byte_count += byte_count;
3986 if (unknown_packets) {
3987 stats.packet_count = UINT64_MAX;
3989 if (unknown_bytes) {
3990 stats.byte_count = UINT64_MAX;
3993 rule_collection_unref(&rules);
3994 rule_collection_destroy(&rules);
3996 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3997 ofconn_send_reply(ofconn, reply);
4002 struct queue_stats_cbdata {
4003 struct ofport *ofport;
4004 struct list replies;
4009 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4010 const struct netdev_queue_stats *stats)
4012 struct ofputil_queue_stats oqs;
4014 oqs.port_no = cbdata->ofport->pp.port_no;
4015 oqs.queue_id = queue_id;
4016 oqs.tx_bytes = stats->tx_bytes;
4017 oqs.tx_packets = stats->tx_packets;
4018 oqs.tx_errors = stats->tx_errors;
4019 if (stats->created != LLONG_MIN) {
4020 calc_duration(stats->created, cbdata->now,
4021 &oqs.duration_sec, &oqs.duration_nsec);
4023 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4025 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4029 handle_queue_stats_dump_cb(uint32_t queue_id,
4030 struct netdev_queue_stats *stats,
4033 struct queue_stats_cbdata *cbdata = cbdata_;
4035 put_queue_stats(cbdata, queue_id, stats);
4039 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4040 struct queue_stats_cbdata *cbdata)
4042 cbdata->ofport = port;
4043 if (queue_id == OFPQ_ALL) {
4044 netdev_dump_queue_stats(port->netdev,
4045 handle_queue_stats_dump_cb, cbdata);
4047 struct netdev_queue_stats stats;
4049 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4050 put_queue_stats(cbdata, queue_id, &stats);
4052 return OFPERR_OFPQOFC_BAD_QUEUE;
4059 handle_queue_stats_request(struct ofconn *ofconn,
4060 const struct ofp_header *rq)
4062 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4063 struct queue_stats_cbdata cbdata;
4064 struct ofport *port;
4066 struct ofputil_queue_stats_request oqsr;
4068 COVERAGE_INC(ofproto_queue_req);
4070 ofpmp_init(&cbdata.replies, rq);
4071 cbdata.now = time_msec();
4073 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4078 if (oqsr.port_no == OFPP_ANY) {
4079 error = OFPERR_OFPQOFC_BAD_QUEUE;
4080 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4081 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4086 port = ofproto_get_port(ofproto, oqsr.port_no);
4088 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4089 : OFPERR_OFPQOFC_BAD_PORT);
4092 ofconn_send_replies(ofconn, &cbdata.replies);
4094 ofpbuf_list_delete(&cbdata.replies);
4101 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
4102 OVS_REQUIRES(ofproto_mutex)
4103 OVS_NO_THREAD_SAFETY_ANALYSIS
4105 return classifier_count(&table->cls) + extra_space > table->max_flows;
4109 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4110 OVS_REQUIRES(ofproto_mutex)
4112 while (should_evict_a_rule(table, extra_space)) {
4115 if (!choose_rule_to_evict(table, &rule)) {
4116 return OFPERR_OFPFMFC_TABLE_FULL;
4118 ofproto_rule_delete__(rule, OFPRR_EVICTION);
4125 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4126 * in which no matching flow already exists in the flow table.
4128 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4129 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4130 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4131 * initiated now but may be retried later.
4133 * The caller retains ownership of 'fm->ofpacts'.
4135 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4138 add_flow(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4139 const struct flow_mod_requester *req)
4140 OVS_REQUIRES(ofproto_mutex)
4142 const struct rule_actions *actions;
4143 struct oftable *table;
4149 if (!check_table_id(ofproto, fm->table_id)) {
4150 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4155 if (fm->table_id == 0xff) {
4156 if (ofproto->ofproto_class->rule_choose_table) {
4157 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4163 ovs_assert(table_id < ofproto->n_tables);
4167 } else if (fm->table_id < ofproto->n_tables) {
4168 table_id = fm->table_id;
4170 return OFPERR_OFPBRC_BAD_TABLE_ID;
4173 table = &ofproto->tables[table_id];
4174 if (table->flags & OFTABLE_READONLY
4175 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4176 return OFPERR_OFPBRC_EPERM;
4179 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4180 if (!match_has_default_hidden_fields(&fm->match)) {
4181 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4182 "non-default values to hidden fields", ofproto->name);
4183 return OFPERR_OFPBRC_EPERM;
4187 cls_rule_init(&cr, &fm->match, fm->priority);
4189 /* Transform "add" into "modify" if there's an existing identical flow. */
4190 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4192 struct rule_collection rules;
4194 cls_rule_destroy(&cr);
4196 rule_collection_init(&rules);
4197 rule_collection_add(&rules, rule);
4198 fm->modify_cookie = true;
4199 error = modify_flows__(ofproto, fm, &rules, req);
4200 rule_collection_destroy(&rules);
4205 /* Check for overlap, if requested. */
4206 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4207 if (classifier_rule_overlaps(&table->cls, &cr)) {
4208 cls_rule_destroy(&cr);
4209 return OFPERR_OFPFMFC_OVERLAP;
4213 /* If necessary, evict an existing rule to clear out space. */
4214 error = evict_rules_from_table(table, 1);
4216 cls_rule_destroy(&cr);
4220 /* Allocate new rule. */
4221 rule = ofproto->ofproto_class->rule_alloc();
4223 cls_rule_destroy(&cr);
4224 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4225 ofproto->name, ovs_strerror(error));
4229 /* Initialize base state. */
4230 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4231 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4232 ovs_refcount_init(&rule->ref_count);
4233 rule->flow_cookie = fm->new_cookie;
4234 rule->created = rule->modified = time_msec();
4236 ovs_mutex_init(&rule->mutex);
4237 ovs_mutex_lock(&rule->mutex);
4238 rule->idle_timeout = fm->idle_timeout;
4239 rule->hard_timeout = fm->hard_timeout;
4240 ovs_mutex_unlock(&rule->mutex);
4242 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4243 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4244 actions = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4245 ovsrcu_set(&rule->actions, actions);
4246 list_init(&rule->meter_list_node);
4247 rule->eviction_group = NULL;
4248 list_init(&rule->expirable);
4249 rule->monitor_flags = 0;
4250 rule->add_seqno = 0;
4251 rule->modify_seqno = 0;
4253 /* Construct rule, initializing derived state. */
4254 error = ofproto->ofproto_class->rule_construct(rule);
4256 ofproto_rule_destroy__(rule);
4260 if (fm->hard_timeout || fm->idle_timeout) {
4261 list_insert(&ofproto->expirable, &rule->expirable);
4263 cookies_insert(ofproto, rule);
4264 eviction_group_add_rule(rule);
4265 if (actions->has_meter) {
4266 meter_insert_rule(rule);
4269 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
4271 error = ofproto->ofproto_class->rule_insert(rule);
4273 oftable_remove_rule(rule);
4274 ofproto_rule_unref(rule);
4277 learned_cookies_inc(ofproto, actions);
4279 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
4280 if (ofproto->vlan_bitmap) {
4281 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4282 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4283 bitmap_set1(ofproto->vlan_bitmap, vid);
4284 ofproto->vlans_changed = true;
4287 ofproto->vlans_changed = true;
4291 ofmonitor_report(ofproto->connmgr, rule, NXFME_ADDED, 0,
4292 req ? req->ofconn : NULL, req ? req->xid : 0, NULL);
4294 return req ? send_buffered_packet(req->ofconn, fm->buffer_id, rule) : 0;
4297 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4299 /* Modifies the rules listed in 'rules', changing their actions to match those
4302 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4305 * Returns 0 on success, otherwise an OpenFlow error code. */
4307 modify_flows__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4308 const struct rule_collection *rules,
4309 const struct flow_mod_requester *req)
4310 OVS_REQUIRES(ofproto_mutex)
4312 struct list dead_cookies = LIST_INITIALIZER(&dead_cookies);
4313 enum nx_flow_update_event event;
4316 if (ofproto->ofproto_class->rule_premodify_actions) {
4317 for (i = 0; i < rules->n; i++) {
4318 struct rule *rule = rules->rules[i];
4321 error = ofproto->ofproto_class->rule_premodify_actions(
4322 rule, fm->ofpacts, fm->ofpacts_len);
4329 event = fm->command == OFPFC_ADD ? NXFME_ADDED : NXFME_MODIFIED;
4330 for (i = 0; i < rules->n; i++) {
4331 struct rule *rule = rules->rules[i];
4333 /* 'fm' says that */
4334 bool change_cookie = (fm->modify_cookie
4335 && fm->new_cookie != OVS_BE64_MAX
4336 && fm->new_cookie != rule->flow_cookie);
4338 const struct rule_actions *actions = rule_get_actions(rule);
4339 bool change_actions = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4341 actions->ofpacts_len);
4343 bool reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4345 long long int now = time_msec();
4347 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4349 if (change_cookie) {
4350 cookies_remove(ofproto, rule);
4353 ovs_mutex_lock(&rule->mutex);
4354 if (fm->command == OFPFC_ADD) {
4355 rule->idle_timeout = fm->idle_timeout;
4356 rule->hard_timeout = fm->hard_timeout;
4357 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4358 rule->created = now;
4360 if (change_cookie) {
4361 rule->flow_cookie = fm->new_cookie;
4363 rule->modified = now;
4364 ovs_mutex_unlock(&rule->mutex);
4366 if (change_cookie) {
4367 cookies_insert(ofproto, rule);
4369 if (fm->command == OFPFC_ADD) {
4370 if (fm->idle_timeout || fm->hard_timeout) {
4371 if (!rule->eviction_group) {
4372 eviction_group_add_rule(rule);
4375 eviction_group_remove_rule(rule);
4379 if (change_actions) {
4380 ovsrcu_set(&rule->actions, rule_actions_create(fm->ofpacts,
4384 if (change_actions || reset_counters) {
4385 ofproto->ofproto_class->rule_modify_actions(rule, reset_counters);
4388 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4389 ofmonitor_report(ofproto->connmgr, rule, event, 0,
4390 req ? req->ofconn : NULL, req ? req->xid : 0,
4391 change_actions ? actions : NULL);
4394 if (change_actions) {
4395 learned_cookies_inc(ofproto, rule_get_actions(rule));
4396 learned_cookies_dec(ofproto, actions, &dead_cookies);
4397 rule_actions_destroy(actions);
4400 learned_cookies_flush(ofproto, &dead_cookies);
4402 if (fm->buffer_id != UINT32_MAX && req) {
4403 return send_buffered_packet(req->ofconn, fm->buffer_id,
4411 modify_flows_add(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4412 const struct flow_mod_requester *req)
4413 OVS_REQUIRES(ofproto_mutex)
4415 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4418 return add_flow(ofproto, fm, req);
4421 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4424 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4427 modify_flows_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4428 const struct flow_mod_requester *req)
4429 OVS_REQUIRES(ofproto_mutex)
4431 struct rule_criteria criteria;
4432 struct rule_collection rules;
4435 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4436 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4437 rule_criteria_require_rw(&criteria,
4438 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4439 error = collect_rules_loose(ofproto, &criteria, &rules);
4440 rule_criteria_destroy(&criteria);
4443 error = (rules.n > 0
4444 ? modify_flows__(ofproto, fm, &rules, req)
4445 : modify_flows_add(ofproto, fm, req));
4448 rule_collection_destroy(&rules);
4453 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4454 * code on failure. */
4456 modify_flow_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4457 const struct flow_mod_requester *req)
4458 OVS_REQUIRES(ofproto_mutex)
4460 struct rule_criteria criteria;
4461 struct rule_collection rules;
4464 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4465 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4466 rule_criteria_require_rw(&criteria,
4467 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4468 error = collect_rules_strict(ofproto, &criteria, &rules);
4469 rule_criteria_destroy(&criteria);
4473 error = modify_flows_add(ofproto, fm, req);
4474 } else if (rules.n == 1) {
4475 error = modify_flows__(ofproto, fm, &rules, req);
4479 rule_collection_destroy(&rules);
4484 /* OFPFC_DELETE implementation. */
4486 /* Deletes the rules listed in 'rules'. */
4488 delete_flows__(const struct rule_collection *rules,
4489 enum ofp_flow_removed_reason reason,
4490 const struct flow_mod_requester *req)
4491 OVS_REQUIRES(ofproto_mutex)
4494 struct list dead_cookies = LIST_INITIALIZER(&dead_cookies);
4495 struct ofproto *ofproto = rules->rules[0]->ofproto;
4498 for (i = 0; i < rules->n; i++) {
4499 struct rule *rule = rules->rules[i];
4500 const struct rule_actions *actions = rule_get_actions(rule);
4502 ofproto_rule_send_removed(rule, reason);
4504 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4505 req ? req->ofconn : NULL, req ? req->xid : 0,
4507 oftable_remove_rule(rule);
4508 ofproto->ofproto_class->rule_delete(rule);
4510 learned_cookies_dec(ofproto, actions, &dead_cookies);
4512 learned_cookies_flush(ofproto, &dead_cookies);
4513 ofmonitor_flush(ofproto->connmgr);
4517 /* Implements OFPFC_DELETE. */
4519 delete_flows_loose(struct ofproto *ofproto,
4520 const struct ofputil_flow_mod *fm,
4521 const struct flow_mod_requester *req)
4522 OVS_REQUIRES(ofproto_mutex)
4524 struct rule_criteria criteria;
4525 struct rule_collection rules;
4528 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4529 fm->cookie, fm->cookie_mask,
4530 fm->out_port, fm->out_group);
4531 rule_criteria_require_rw(&criteria,
4532 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4533 error = collect_rules_loose(ofproto, &criteria, &rules);
4534 rule_criteria_destroy(&criteria);
4536 if (!error && rules.n > 0) {
4537 delete_flows__(&rules, fm->delete_reason, req);
4539 rule_collection_destroy(&rules);
4544 /* Implements OFPFC_DELETE_STRICT. */
4546 delete_flow_strict(struct ofproto *ofproto, const struct ofputil_flow_mod *fm,
4547 const struct flow_mod_requester *req)
4548 OVS_REQUIRES(ofproto_mutex)
4550 struct rule_criteria criteria;
4551 struct rule_collection rules;
4554 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4555 fm->cookie, fm->cookie_mask,
4556 fm->out_port, fm->out_group);
4557 rule_criteria_require_rw(&criteria,
4558 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4559 error = collect_rules_strict(ofproto, &criteria, &rules);
4560 rule_criteria_destroy(&criteria);
4562 if (!error && rules.n > 0) {
4563 delete_flows__(&rules, fm->delete_reason, req);
4565 rule_collection_destroy(&rules);
4571 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4572 OVS_REQUIRES(ofproto_mutex)
4574 struct ofputil_flow_removed fr;
4577 if (rule_is_hidden(rule) ||
4578 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4582 minimatch_expand(&rule->cr.match, &fr.match);
4583 fr.priority = rule->cr.priority;
4584 fr.cookie = rule->flow_cookie;
4586 fr.table_id = rule->table_id;
4587 calc_duration(rule->created, time_msec(),
4588 &fr.duration_sec, &fr.duration_nsec);
4589 ovs_mutex_lock(&rule->mutex);
4590 fr.idle_timeout = rule->idle_timeout;
4591 fr.hard_timeout = rule->hard_timeout;
4592 ovs_mutex_unlock(&rule->mutex);
4593 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4594 &fr.byte_count, &used);
4596 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4599 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4600 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4603 * ofproto implementation ->run() functions should use this function to expire
4604 * OpenFlow flows. */
4606 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4607 OVS_REQUIRES(ofproto_mutex)
4609 ofproto_rule_delete__(rule, reason);
4612 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4613 * means "infinite". */
4615 reduce_timeout(uint16_t max, uint16_t *timeout)
4617 if (max && (!*timeout || *timeout > max)) {
4622 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4623 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4624 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4626 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4628 ofproto_rule_reduce_timeouts(struct rule *rule,
4629 uint16_t idle_timeout, uint16_t hard_timeout)
4630 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4632 if (!idle_timeout && !hard_timeout) {
4636 ovs_mutex_lock(&ofproto_mutex);
4637 if (list_is_empty(&rule->expirable)) {
4638 list_insert(&rule->ofproto->expirable, &rule->expirable);
4640 ovs_mutex_unlock(&ofproto_mutex);
4642 ovs_mutex_lock(&rule->mutex);
4643 reduce_timeout(idle_timeout, &rule->idle_timeout);
4644 reduce_timeout(hard_timeout, &rule->hard_timeout);
4645 ovs_mutex_unlock(&rule->mutex);
4649 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4650 OVS_EXCLUDED(ofproto_mutex)
4652 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4653 struct ofputil_flow_mod fm;
4654 uint64_t ofpacts_stub[1024 / 8];
4655 struct ofpbuf ofpacts;
4658 error = reject_slave_controller(ofconn);
4663 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4664 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4666 u16_to_ofp(ofproto->max_ports),
4669 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4672 struct flow_mod_requester req;
4674 req.ofconn = ofconn;
4676 error = handle_flow_mod__(ofproto, &fm, &req);
4679 goto exit_free_ofpacts;
4682 ofconn_report_flow_mod(ofconn, fm.command);
4685 ofpbuf_uninit(&ofpacts);
4691 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4692 const struct flow_mod_requester *req)
4693 OVS_EXCLUDED(ofproto_mutex)
4697 ovs_mutex_lock(&ofproto_mutex);
4698 switch (fm->command) {
4700 error = add_flow(ofproto, fm, req);
4704 error = modify_flows_loose(ofproto, fm, req);
4707 case OFPFC_MODIFY_STRICT:
4708 error = modify_flow_strict(ofproto, fm, req);
4712 error = delete_flows_loose(ofproto, fm, req);
4715 case OFPFC_DELETE_STRICT:
4716 error = delete_flow_strict(ofproto, fm, req);
4720 if (fm->command > 0xff) {
4721 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4722 "flow_mod_table_id extension is not enabled",
4725 error = OFPERR_OFPFMFC_BAD_COMMAND;
4728 ofmonitor_flush(ofproto->connmgr);
4729 ovs_mutex_unlock(&ofproto_mutex);
4731 run_rule_executes(ofproto);
4736 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4738 struct ofputil_role_request request;
4739 struct ofputil_role_request reply;
4743 error = ofputil_decode_role_message(oh, &request);
4748 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4749 if (request.have_generation_id
4750 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4751 return OFPERR_OFPRRFC_STALE;
4754 ofconn_set_role(ofconn, request.role);
4757 reply.role = ofconn_get_role(ofconn);
4758 reply.have_generation_id = ofconn_get_master_election_id(
4759 ofconn, &reply.generation_id);
4760 buf = ofputil_encode_role_reply(oh, &reply);
4761 ofconn_send_reply(ofconn, buf);
4767 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4768 const struct ofp_header *oh)
4770 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4771 enum ofputil_protocol cur, next;
4773 cur = ofconn_get_protocol(ofconn);
4774 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4775 ofconn_set_protocol(ofconn, next);
4781 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4783 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4784 enum ofputil_protocol cur, next;
4785 enum ofputil_protocol next_base;
4787 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4789 return OFPERR_OFPBRC_EPERM;
4792 cur = ofconn_get_protocol(ofconn);
4793 next = ofputil_protocol_set_base(cur, next_base);
4794 ofconn_set_protocol(ofconn, next);
4800 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4801 const struct ofp_header *oh)
4803 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4806 format = ntohl(msg->format);
4807 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4808 return OFPERR_OFPBRC_EPERM;
4811 ofconn_set_packet_in_format(ofconn, format);
4816 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4818 const struct nx_async_config *msg = ofpmsg_body(oh);
4819 uint32_t master[OAM_N_TYPES];
4820 uint32_t slave[OAM_N_TYPES];
4822 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4823 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4824 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4826 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4827 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4828 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4830 ofconn_set_async_config(ofconn, master, slave);
4831 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4832 !ofconn_get_miss_send_len(ofconn)) {
4833 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4840 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4843 uint32_t master[OAM_N_TYPES];
4844 uint32_t slave[OAM_N_TYPES];
4845 struct nx_async_config *msg;
4847 ofconn_get_async_config(ofconn, master, slave);
4848 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4849 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4851 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4852 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4853 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4855 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4856 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4857 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4859 ofconn_send_reply(ofconn, buf);
4865 handle_nxt_set_controller_id(struct ofconn *ofconn,
4866 const struct ofp_header *oh)
4868 const struct nx_controller_id *nci = ofpmsg_body(oh);
4870 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4871 return OFPERR_NXBRC_MUST_BE_ZERO;
4874 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4879 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4883 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4884 ? OFPRAW_OFPT10_BARRIER_REPLY
4885 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4886 ofconn_send_reply(ofconn, buf);
4891 ofproto_compose_flow_refresh_update(const struct rule *rule,
4892 enum nx_flow_monitor_flags flags,
4894 OVS_REQUIRES(ofproto_mutex)
4896 const struct rule_actions *actions;
4897 struct ofputil_flow_update fu;
4900 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4901 ? NXFME_ADDED : NXFME_MODIFIED);
4903 ovs_mutex_lock(&rule->mutex);
4904 fu.idle_timeout = rule->idle_timeout;
4905 fu.hard_timeout = rule->hard_timeout;
4906 ovs_mutex_unlock(&rule->mutex);
4907 fu.table_id = rule->table_id;
4908 fu.cookie = rule->flow_cookie;
4909 minimatch_expand(&rule->cr.match, &match);
4911 fu.priority = rule->cr.priority;
4913 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
4914 fu.ofpacts = actions ? actions->ofpacts : NULL;
4915 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4917 if (list_is_empty(msgs)) {
4918 ofputil_start_flow_update(msgs);
4920 ofputil_append_flow_update(&fu, msgs);
4924 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4926 OVS_REQUIRES(ofproto_mutex)
4930 for (i = 0; i < rules->n; i++) {
4931 struct rule *rule = rules->rules[i];
4932 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4933 rule->monitor_flags = 0;
4935 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4940 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4941 struct rule *rule, uint64_t seqno,
4942 struct rule_collection *rules)
4943 OVS_REQUIRES(ofproto_mutex)
4945 enum nx_flow_monitor_flags update;
4947 if (rule_is_hidden(rule)) {
4951 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
4956 if (rule->add_seqno > seqno) {
4957 update = NXFMF_ADD | NXFMF_MODIFY;
4958 } else if (rule->modify_seqno > seqno) {
4959 update = NXFMF_MODIFY;
4964 if (!(m->flags & update)) {
4968 update = NXFMF_INITIAL;
4971 if (!rule->monitor_flags) {
4972 rule_collection_add(rules, rule);
4974 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4978 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4980 struct rule_collection *rules)
4981 OVS_REQUIRES(ofproto_mutex)
4983 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4984 const struct oftable *table;
4985 struct cls_rule target;
4987 cls_rule_init_from_minimatch(&target, &m->match, 0);
4988 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4991 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
4992 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4995 cls_rule_destroy(&target);
4999 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5000 struct rule_collection *rules)
5001 OVS_REQUIRES(ofproto_mutex)
5003 if (m->flags & NXFMF_INITIAL) {
5004 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5009 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5010 uint64_t seqno, struct rule_collection *rules)
5011 OVS_REQUIRES(ofproto_mutex)
5013 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5017 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5018 OVS_REQUIRES(ofproto_mutex)
5020 struct ofmonitor *m;
5023 m = ofmonitor_lookup(ofconn, id);
5025 ofmonitor_destroy(m);
5028 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5035 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5036 OVS_EXCLUDED(ofproto_mutex)
5038 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5039 struct ofmonitor **monitors;
5040 size_t n_monitors, allocated_monitors;
5041 struct rule_collection rules;
5042 struct list replies;
5047 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5049 n_monitors = allocated_monitors = 0;
5051 ovs_mutex_lock(&ofproto_mutex);
5053 struct ofputil_flow_monitor_request request;
5054 struct ofmonitor *m;
5057 retval = ofputil_decode_flow_monitor_request(&request, &b);
5058 if (retval == EOF) {
5060 } else if (retval) {
5065 if (request.table_id != 0xff
5066 && request.table_id >= ofproto->n_tables) {
5067 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5071 error = ofmonitor_create(&request, ofconn, &m);
5076 if (n_monitors >= allocated_monitors) {
5077 monitors = x2nrealloc(monitors, &allocated_monitors,
5080 monitors[n_monitors++] = m;
5083 rule_collection_init(&rules);
5084 for (i = 0; i < n_monitors; i++) {
5085 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5088 ofpmp_init(&replies, oh);
5089 ofmonitor_compose_refresh_updates(&rules, &replies);
5090 ovs_mutex_unlock(&ofproto_mutex);
5092 rule_collection_destroy(&rules);
5094 ofconn_send_replies(ofconn, &replies);
5100 for (i = 0; i < n_monitors; i++) {
5101 ofmonitor_destroy(monitors[i]);
5104 ovs_mutex_unlock(&ofproto_mutex);
5110 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5111 OVS_EXCLUDED(ofproto_mutex)
5116 id = ofputil_decode_flow_monitor_cancel(oh);
5118 ovs_mutex_lock(&ofproto_mutex);
5119 error = flow_monitor_delete(ofconn, id);
5120 ovs_mutex_unlock(&ofproto_mutex);
5125 /* Meters implementation.
5127 * Meter table entry, indexed by the OpenFlow meter_id.
5128 * 'created' is used to compute the duration for meter stats.
5129 * 'list rules' is needed so that we can delete the dependent rules when the
5130 * meter table entry is deleted.
5131 * 'provider_meter_id' is for the provider's private use.
5134 long long int created; /* Time created. */
5135 struct list rules; /* List of "struct rule_dpif"s. */
5136 ofproto_meter_id provider_meter_id;
5137 uint16_t flags; /* Meter flags. */
5138 uint16_t n_bands; /* Number of meter bands. */
5139 struct ofputil_meter_band *bands;
5143 * This is used in instruction validation at flow set-up time,
5144 * as flows may not use non-existing meters.
5145 * Return value of UINT32_MAX signifies an invalid meter.
5148 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5150 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5151 const struct meter *meter = ofproto->meters[of_meter_id];
5153 return meter->provider_meter_id.uint32;
5159 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5162 meter_insert_rule(struct rule *rule)
5164 const struct rule_actions *a = rule_get_actions(rule);
5165 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5166 struct meter *meter = rule->ofproto->meters[meter_id];
5168 list_insert(&meter->rules, &rule->meter_list_node);
5172 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5176 meter->flags = config->flags;
5177 meter->n_bands = config->n_bands;
5178 meter->bands = xmemdup(config->bands,
5179 config->n_bands * sizeof *meter->bands);
5182 static struct meter *
5183 meter_create(const struct ofputil_meter_config *config,
5184 ofproto_meter_id provider_meter_id)
5186 struct meter *meter;
5188 meter = xzalloc(sizeof *meter);
5189 meter->provider_meter_id = provider_meter_id;
5190 meter->created = time_msec();
5191 list_init(&meter->rules);
5193 meter_update(meter, config);
5199 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5200 OVS_REQUIRES(ofproto_mutex)
5203 for (mid = first; mid <= last; ++mid) {
5204 struct meter *meter = ofproto->meters[mid];
5206 ofproto->meters[mid] = NULL;
5207 ofproto->ofproto_class->meter_del(ofproto,
5208 meter->provider_meter_id);
5216 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5218 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5219 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5223 return OFPERR_OFPMMFC_METER_EXISTS;
5226 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5229 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5230 *meterp = meter_create(&mm->meter, provider_meter_id);
5236 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5238 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5240 uint32_t provider_meter_id;
5243 return OFPERR_OFPMMFC_UNKNOWN_METER;
5246 provider_meter_id = meter->provider_meter_id.uint32;
5247 error = ofproto->ofproto_class->meter_set(ofproto,
5248 &meter->provider_meter_id,
5250 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5252 meter_update(meter, &mm->meter);
5258 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5259 OVS_EXCLUDED(ofproto_mutex)
5261 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5262 uint32_t meter_id = mm->meter.meter_id;
5263 struct rule_collection rules;
5264 enum ofperr error = 0;
5265 uint32_t first, last;
5267 if (meter_id == OFPM13_ALL) {
5269 last = ofproto->meter_features.max_meters;
5271 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5274 first = last = meter_id;
5277 /* First delete the rules that use this meter. If any of those rules are
5278 * currently being modified, postpone the whole operation until later. */
5279 rule_collection_init(&rules);
5280 ovs_mutex_lock(&ofproto_mutex);
5281 for (meter_id = first; meter_id <= last; ++meter_id) {
5282 struct meter *meter = ofproto->meters[meter_id];
5283 if (meter && !list_is_empty(&meter->rules)) {
5286 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5287 rule_collection_add(&rules, rule);
5292 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5295 /* Delete the meters. */
5296 meter_delete(ofproto, first, last);
5298 ovs_mutex_unlock(&ofproto_mutex);
5299 rule_collection_destroy(&rules);
5305 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5307 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5308 struct ofputil_meter_mod mm;
5309 uint64_t bands_stub[256 / 8];
5310 struct ofpbuf bands;
5314 error = reject_slave_controller(ofconn);
5319 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5321 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5323 goto exit_free_bands;
5326 meter_id = mm.meter.meter_id;
5328 if (mm.command != OFPMC13_DELETE) {
5329 /* Fails also when meters are not implemented by the provider. */
5330 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5331 error = OFPERR_OFPMMFC_INVALID_METER;
5332 goto exit_free_bands;
5333 } else if (meter_id > ofproto->meter_features.max_meters) {
5334 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5335 goto exit_free_bands;
5337 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5338 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5339 goto exit_free_bands;
5343 switch (mm.command) {
5345 error = handle_add_meter(ofproto, &mm);
5348 case OFPMC13_MODIFY:
5349 error = handle_modify_meter(ofproto, &mm);
5352 case OFPMC13_DELETE:
5353 error = handle_delete_meter(ofconn, &mm);
5357 error = OFPERR_OFPMMFC_BAD_COMMAND;
5362 ofpbuf_uninit(&bands);
5367 handle_meter_features_request(struct ofconn *ofconn,
5368 const struct ofp_header *request)
5370 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5371 struct ofputil_meter_features features;
5374 if (ofproto->ofproto_class->meter_get_features) {
5375 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5377 memset(&features, 0, sizeof features);
5379 b = ofputil_encode_meter_features_reply(&features, request);
5381 ofconn_send_reply(ofconn, b);
5386 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5389 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5390 struct list replies;
5391 uint64_t bands_stub[256 / 8];
5392 struct ofpbuf bands;
5393 uint32_t meter_id, first, last;
5395 ofputil_decode_meter_request(request, &meter_id);
5397 if (meter_id == OFPM13_ALL) {
5399 last = ofproto->meter_features.max_meters;
5401 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5402 !ofproto->meters[meter_id]) {
5403 return OFPERR_OFPMMFC_UNKNOWN_METER;
5405 first = last = meter_id;
5408 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5409 ofpmp_init(&replies, request);
5411 for (meter_id = first; meter_id <= last; ++meter_id) {
5412 struct meter *meter = ofproto->meters[meter_id];
5414 continue; /* Skip non-existing meters. */
5416 if (type == OFPTYPE_METER_STATS_REQUEST) {
5417 struct ofputil_meter_stats stats;
5419 stats.meter_id = meter_id;
5421 /* Provider sets the packet and byte counts, we do the rest. */
5422 stats.flow_count = list_size(&meter->rules);
5423 calc_duration(meter->created, time_msec(),
5424 &stats.duration_sec, &stats.duration_nsec);
5425 stats.n_bands = meter->n_bands;
5426 ofpbuf_clear(&bands);
5428 = ofpbuf_put_uninit(&bands,
5429 meter->n_bands * sizeof *stats.bands);
5431 if (!ofproto->ofproto_class->meter_get(ofproto,
5432 meter->provider_meter_id,
5434 ofputil_append_meter_stats(&replies, &stats);
5436 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5437 struct ofputil_meter_config config;
5439 config.meter_id = meter_id;
5440 config.flags = meter->flags;
5441 config.n_bands = meter->n_bands;
5442 config.bands = meter->bands;
5443 ofputil_append_meter_config(&replies, &config);
5447 ofconn_send_replies(ofconn, &replies);
5448 ofpbuf_uninit(&bands);
5453 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5454 struct ofgroup **group)
5455 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5457 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5458 hash_int(group_id, 0), &ofproto->groups) {
5459 if ((*group)->group_id == group_id) {
5467 /* If the group exists, this function increments the groups's reference count.
5469 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5470 * a reference to the group. */
5472 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5473 struct ofgroup **group)
5477 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5478 found = ofproto_group_lookup__(ofproto, group_id, group);
5480 ofproto_group_ref(*group);
5482 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5487 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5488 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5490 struct ofgroup *grp;
5492 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5493 hash_int(group_id, 0), &ofproto->groups) {
5494 if (grp->group_id == group_id) {
5502 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5503 OVS_EXCLUDED(ofproto->groups_rwlock)
5507 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5508 exists = ofproto_group_exists__(ofproto, group_id);
5509 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5515 group_get_ref_count(struct ofgroup *group)
5516 OVS_EXCLUDED(ofproto_mutex)
5518 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5519 struct rule_criteria criteria;
5520 struct rule_collection rules;
5525 match_init_catchall(&match);
5526 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5527 OFPP_ANY, group->group_id);
5528 ovs_mutex_lock(&ofproto_mutex);
5529 error = collect_rules_loose(ofproto, &criteria, &rules);
5530 ovs_mutex_unlock(&ofproto_mutex);
5531 rule_criteria_destroy(&criteria);
5533 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5535 rule_collection_destroy(&rules);
5540 append_group_stats(struct ofgroup *group, struct list *replies)
5542 struct ofputil_group_stats ogs;
5543 const struct ofproto *ofproto = group->ofproto;
5544 long long int now = time_msec();
5547 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5549 /* Provider sets the packet and byte counts, we do the rest. */
5550 ogs.ref_count = group_get_ref_count(group);
5551 ogs.n_buckets = group->n_buckets;
5553 error = (ofproto->ofproto_class->group_get_stats
5554 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5557 ogs.packet_count = UINT64_MAX;
5558 ogs.byte_count = UINT64_MAX;
5559 memset(ogs.bucket_stats, 0xff,
5560 ogs.n_buckets * sizeof *ogs.bucket_stats);
5563 ogs.group_id = group->group_id;
5564 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5566 ofputil_append_group_stats(replies, &ogs);
5568 free(ogs.bucket_stats);
5572 handle_group_request(struct ofconn *ofconn,
5573 const struct ofp_header *request, uint32_t group_id,
5574 void (*cb)(struct ofgroup *, struct list *replies))
5576 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5577 struct ofgroup *group;
5578 struct list replies;
5580 ofpmp_init(&replies, request);
5581 if (group_id == OFPG_ALL) {
5582 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5583 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5584 cb(group, &replies);
5586 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5588 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5589 cb(group, &replies);
5590 ofproto_group_unref(group);
5593 ofconn_send_replies(ofconn, &replies);
5597 handle_group_stats_request(struct ofconn *ofconn,
5598 const struct ofp_header *request)
5603 error = ofputil_decode_group_stats_request(request, &group_id);
5608 handle_group_request(ofconn, request, group_id, append_group_stats);
5613 append_group_desc(struct ofgroup *group, struct list *replies)
5615 struct ofputil_group_desc gds;
5617 gds.group_id = group->group_id;
5618 gds.type = group->type;
5619 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5623 handle_group_desc_stats_request(struct ofconn *ofconn,
5624 const struct ofp_header *request)
5626 handle_group_request(ofconn, request,
5627 ofputil_decode_group_desc_request(request),
5633 handle_group_features_stats_request(struct ofconn *ofconn,
5634 const struct ofp_header *request)
5636 struct ofproto *p = ofconn_get_ofproto(ofconn);
5639 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5641 ofconn_send_reply(ofconn, msg);
5648 handle_queue_get_config_request(struct ofconn *ofconn,
5649 const struct ofp_header *oh)
5651 struct ofproto *p = ofconn_get_ofproto(ofconn);
5652 struct netdev_queue_dump queue_dump;
5653 struct ofport *ofport;
5654 unsigned int queue_id;
5655 struct ofpbuf *reply;
5656 struct smap details;
5660 error = ofputil_decode_queue_get_config_request(oh, &request);
5665 ofport = ofproto_get_port(p, request);
5667 return OFPERR_OFPQOFC_BAD_PORT;
5670 reply = ofputil_encode_queue_get_config_reply(oh);
5672 smap_init(&details);
5673 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5674 struct ofputil_queue_config queue;
5676 /* None of the existing queues have compatible properties, so we
5677 * hard-code omitting min_rate and max_rate. */
5678 queue.queue_id = queue_id;
5679 queue.min_rate = UINT16_MAX;
5680 queue.max_rate = UINT16_MAX;
5681 ofputil_append_queue_get_config_reply(reply, &queue);
5683 smap_destroy(&details);
5685 ofconn_send_reply(ofconn, reply);
5691 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
5692 struct ofgroup **ofgroup)
5695 const long long int now = time_msec();
5697 if (gm->group_id > OFPG_MAX) {
5698 return OFPERR_OFPGMFC_INVALID_GROUP;
5700 if (gm->type > OFPGT11_FF) {
5701 return OFPERR_OFPGMFC_BAD_TYPE;
5704 *ofgroup = ofproto->ofproto_class->group_alloc();
5706 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5707 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5710 (*ofgroup)->ofproto = ofproto;
5711 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
5712 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
5713 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
5714 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
5715 ovs_refcount_init(&(*ofgroup)->ref_count);
5717 list_move(&(*ofgroup)->buckets, &gm->buckets);
5718 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
5719 list_size(&(*ofgroup)->buckets);
5721 /* Construct called BEFORE any locks are held. */
5722 error = ofproto->ofproto_class->group_construct(*ofgroup);
5724 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
5725 ofproto->ofproto_class->group_dealloc(*ofgroup);
5730 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
5731 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
5734 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5736 struct ofgroup *ofgroup;
5739 /* Allocate new group and initialize it. */
5740 error = init_group(ofproto, gm, &ofgroup);
5745 /* We wrlock as late as possible to minimize the time we jam any other
5746 * threads: No visible state changes before acquiring the lock. */
5747 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5749 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5750 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5754 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5755 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5760 /* Insert new group. */
5761 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5762 hash_int(ofgroup->group_id, 0));
5763 ofproto->n_groups[ofgroup->type]++;
5765 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5770 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5771 ofproto->ofproto_class->group_destruct(ofgroup);
5772 ofputil_bucket_list_destroy(&ofgroup->buckets);
5773 ofproto->ofproto_class->group_dealloc(ofgroup);
5778 /* Implements OFPGC11_MODIFY. Returns 0 on success or an OpenFlow error code
5781 * Note that the group is re-created and then replaces the old group in
5782 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
5783 * the xlate module hold a pointer to the group. */
5785 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5787 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
5790 error = init_group(ofproto, gm, &new_ofgroup);
5795 retiring = new_ofgroup;
5797 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5798 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
5799 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5803 /* Ofproto's group write lock is held now. */
5804 if (ofgroup->type != gm->type
5805 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5806 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5810 /* The group creation time does not change during modification. */
5811 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
5812 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
5814 error = ofproto->ofproto_class->group_modify(new_ofgroup);
5820 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
5821 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5822 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
5823 hash_int(new_ofgroup->group_id, 0));
5824 if (ofgroup->type != new_ofgroup->type) {
5825 ofproto->n_groups[ofgroup->type]--;
5826 ofproto->n_groups[new_ofgroup->type]++;
5830 ofproto_group_unref(retiring);
5831 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5836 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5837 OVS_RELEASES(ofproto->groups_rwlock)
5840 struct ofputil_flow_mod fm;
5842 /* Delete all flow entries containing this group in a group action */
5843 match_init_catchall(&match);
5844 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5845 fm.delete_reason = OFPRR_GROUP_DELETE;
5846 fm.out_group = ofgroup->group_id;
5847 handle_flow_mod__(ofproto, &fm, NULL);
5849 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5850 /* No-one can find this group any more. */
5851 ofproto->n_groups[ofgroup->type]--;
5852 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5853 ofproto_group_unref(ofgroup);
5856 /* Implements OFPGC11_DELETE. */
5858 delete_group(struct ofproto *ofproto, uint32_t group_id)
5860 struct ofgroup *ofgroup;
5862 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5863 if (group_id == OFPG_ALL) {
5865 struct hmap_node *node = hmap_first(&ofproto->groups);
5869 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5870 delete_group__(ofproto, ofgroup);
5871 /* Lock for each node separately, so that we will not jam the
5872 * other threads for too long time. */
5873 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5876 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5877 hash_int(group_id, 0), &ofproto->groups) {
5878 if (ofgroup->group_id == group_id) {
5879 delete_group__(ofproto, ofgroup);
5884 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5888 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5890 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5891 struct ofputil_group_mod gm;
5894 error = reject_slave_controller(ofconn);
5899 error = ofputil_decode_group_mod(oh, &gm);
5904 switch (gm.command) {
5906 return add_group(ofproto, &gm);
5908 case OFPGC11_MODIFY:
5909 return modify_group(ofproto, &gm);
5911 case OFPGC11_DELETE:
5912 delete_group(ofproto, gm.group_id);
5916 if (gm.command > OFPGC11_DELETE) {
5917 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5918 ofproto->name, gm.command);
5920 return OFPERR_OFPGMFC_BAD_COMMAND;
5924 enum ofputil_table_miss
5925 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
5927 enum ofputil_table_miss value;
5929 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
5934 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5936 if (!check_table_id(ofproto, tm->table_id)) {
5937 return OFPERR_OFPTMFC_BAD_TABLE;
5938 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
5939 if (tm->table_id == OFPTT_ALL) {
5941 for (i = 0; i < ofproto->n_tables; i++) {
5942 atomic_store_relaxed(&ofproto->tables[i].miss_config,
5946 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
5954 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5956 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5957 struct ofputil_table_mod tm;
5960 error = reject_slave_controller(ofconn);
5965 error = ofputil_decode_table_mod(oh, &tm);
5970 return table_mod(ofproto, &tm);
5974 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
5977 struct ofputil_bundle_ctrl_msg bctrl;
5979 struct ofputil_bundle_ctrl_msg reply;
5981 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
5986 reply.bundle_id = bctrl.bundle_id;
5988 switch (bctrl.type) {
5989 case OFPBCT_OPEN_REQUEST:
5990 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
5991 reply.type = OFPBCT_OPEN_REPLY;
5993 case OFPBCT_CLOSE_REQUEST:
5994 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
5995 reply.type = OFPBCT_CLOSE_REPLY;;
5997 case OFPBCT_COMMIT_REQUEST:
5998 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
5999 reply.type = OFPBCT_COMMIT_REPLY;
6001 case OFPBCT_DISCARD_REQUEST:
6002 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6003 reply.type = OFPBCT_DISCARD_REPLY;
6006 case OFPBCT_OPEN_REPLY:
6007 case OFPBCT_CLOSE_REPLY:
6008 case OFPBCT_COMMIT_REPLY:
6009 case OFPBCT_DISCARD_REPLY:
6010 return OFPERR_OFPBFC_BAD_TYPE;
6015 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6016 ofconn_send_reply(ofconn, buf);
6023 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6026 struct ofputil_bundle_add_msg badd;
6028 error = ofputil_decode_bundle_add(oh, &badd);
6033 return ofp_bundle_add_message(ofconn, &badd);
6037 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6038 OVS_EXCLUDED(ofproto_mutex)
6040 const struct ofp_header *oh = ofpbuf_data(msg);
6044 error = ofptype_decode(&type, oh);
6048 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6049 && ofpmp_more(oh)) {
6050 /* We have no buffer implementation for multipart requests.
6051 * Report overflow for requests which consists of multiple
6053 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6057 /* OpenFlow requests. */
6058 case OFPTYPE_ECHO_REQUEST:
6059 return handle_echo_request(ofconn, oh);
6061 case OFPTYPE_FEATURES_REQUEST:
6062 return handle_features_request(ofconn, oh);
6064 case OFPTYPE_GET_CONFIG_REQUEST:
6065 return handle_get_config_request(ofconn, oh);
6067 case OFPTYPE_SET_CONFIG:
6068 return handle_set_config(ofconn, oh);
6070 case OFPTYPE_PACKET_OUT:
6071 return handle_packet_out(ofconn, oh);
6073 case OFPTYPE_PORT_MOD:
6074 return handle_port_mod(ofconn, oh);
6076 case OFPTYPE_FLOW_MOD:
6077 return handle_flow_mod(ofconn, oh);
6079 case OFPTYPE_GROUP_MOD:
6080 return handle_group_mod(ofconn, oh);
6082 case OFPTYPE_TABLE_MOD:
6083 return handle_table_mod(ofconn, oh);
6085 case OFPTYPE_METER_MOD:
6086 return handle_meter_mod(ofconn, oh);
6088 case OFPTYPE_BARRIER_REQUEST:
6089 return handle_barrier_request(ofconn, oh);
6091 case OFPTYPE_ROLE_REQUEST:
6092 return handle_role_request(ofconn, oh);
6094 /* OpenFlow replies. */
6095 case OFPTYPE_ECHO_REPLY:
6098 /* Nicira extension requests. */
6099 case OFPTYPE_FLOW_MOD_TABLE_ID:
6100 return handle_nxt_flow_mod_table_id(ofconn, oh);
6102 case OFPTYPE_SET_FLOW_FORMAT:
6103 return handle_nxt_set_flow_format(ofconn, oh);
6105 case OFPTYPE_SET_PACKET_IN_FORMAT:
6106 return handle_nxt_set_packet_in_format(ofconn, oh);
6108 case OFPTYPE_SET_CONTROLLER_ID:
6109 return handle_nxt_set_controller_id(ofconn, oh);
6111 case OFPTYPE_FLOW_AGE:
6112 /* Nothing to do. */
6115 case OFPTYPE_FLOW_MONITOR_CANCEL:
6116 return handle_flow_monitor_cancel(ofconn, oh);
6118 case OFPTYPE_SET_ASYNC_CONFIG:
6119 return handle_nxt_set_async_config(ofconn, oh);
6121 case OFPTYPE_GET_ASYNC_REQUEST:
6122 return handle_nxt_get_async_request(ofconn, oh);
6124 /* Statistics requests. */
6125 case OFPTYPE_DESC_STATS_REQUEST:
6126 return handle_desc_stats_request(ofconn, oh);
6128 case OFPTYPE_FLOW_STATS_REQUEST:
6129 return handle_flow_stats_request(ofconn, oh);
6131 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6132 return handle_aggregate_stats_request(ofconn, oh);
6134 case OFPTYPE_TABLE_STATS_REQUEST:
6135 return handle_table_stats_request(ofconn, oh);
6137 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6138 return handle_table_features_request(ofconn, oh);
6140 case OFPTYPE_PORT_STATS_REQUEST:
6141 return handle_port_stats_request(ofconn, oh);
6143 case OFPTYPE_QUEUE_STATS_REQUEST:
6144 return handle_queue_stats_request(ofconn, oh);
6146 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6147 return handle_port_desc_stats_request(ofconn, oh);
6149 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6150 return handle_flow_monitor_request(ofconn, oh);
6152 case OFPTYPE_METER_STATS_REQUEST:
6153 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6154 return handle_meter_request(ofconn, oh, type);
6156 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6157 return handle_meter_features_request(ofconn, oh);
6159 case OFPTYPE_GROUP_STATS_REQUEST:
6160 return handle_group_stats_request(ofconn, oh);
6162 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6163 return handle_group_desc_stats_request(ofconn, oh);
6165 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6166 return handle_group_features_stats_request(ofconn, oh);
6168 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6169 return handle_queue_get_config_request(ofconn, oh);
6171 case OFPTYPE_BUNDLE_CONTROL:
6172 return handle_bundle_control(ofconn, oh);
6174 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6175 return handle_bundle_add(ofconn, oh);
6179 case OFPTYPE_FEATURES_REPLY:
6180 case OFPTYPE_GET_CONFIG_REPLY:
6181 case OFPTYPE_PACKET_IN:
6182 case OFPTYPE_FLOW_REMOVED:
6183 case OFPTYPE_PORT_STATUS:
6184 case OFPTYPE_BARRIER_REPLY:
6185 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6186 case OFPTYPE_DESC_STATS_REPLY:
6187 case OFPTYPE_FLOW_STATS_REPLY:
6188 case OFPTYPE_QUEUE_STATS_REPLY:
6189 case OFPTYPE_PORT_STATS_REPLY:
6190 case OFPTYPE_TABLE_STATS_REPLY:
6191 case OFPTYPE_AGGREGATE_STATS_REPLY:
6192 case OFPTYPE_PORT_DESC_STATS_REPLY:
6193 case OFPTYPE_ROLE_REPLY:
6194 case OFPTYPE_FLOW_MONITOR_PAUSED:
6195 case OFPTYPE_FLOW_MONITOR_RESUMED:
6196 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6197 case OFPTYPE_GET_ASYNC_REPLY:
6198 case OFPTYPE_GROUP_STATS_REPLY:
6199 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6200 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6201 case OFPTYPE_METER_STATS_REPLY:
6202 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6203 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6204 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6205 case OFPTYPE_ROLE_STATUS:
6207 if (ofpmsg_is_stat_request(oh)) {
6208 return OFPERR_OFPBRC_BAD_STAT;
6210 return OFPERR_OFPBRC_BAD_TYPE;
6216 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6217 OVS_EXCLUDED(ofproto_mutex)
6219 int error = handle_openflow__(ofconn, ofp_msg);
6221 ofconn_send_error(ofconn, ofpbuf_data(ofp_msg), error);
6223 COVERAGE_INC(ofproto_recv_openflow);
6226 /* Asynchronous operations. */
6229 send_buffered_packet(struct ofconn *ofconn, uint32_t buffer_id,
6231 OVS_REQUIRES(ofproto_mutex)
6233 enum ofperr error = 0;
6234 if (ofconn && buffer_id != UINT32_MAX) {
6235 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6236 struct ofpbuf *packet;
6239 error = ofconn_pktbuf_retrieve(ofconn, buffer_id, &packet, &in_port);
6241 struct rule_execute *re;
6243 ofproto_rule_ref(rule);
6245 re = xmalloc(sizeof *re);
6247 re->in_port = in_port;
6248 re->packet = packet;
6250 if (!guarded_list_push_back(&ofproto->rule_executes,
6251 &re->list_node, 1024)) {
6252 ofproto_rule_unref(rule);
6253 ofpbuf_delete(re->packet);
6262 pick_datapath_id(const struct ofproto *ofproto)
6264 const struct ofport *port;
6266 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6268 uint8_t ea[ETH_ADDR_LEN];
6271 error = netdev_get_etheraddr(port->netdev, ea);
6273 return eth_addr_to_uint64(ea);
6275 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6276 ofproto->name, netdev_get_name(port->netdev),
6277 ovs_strerror(error));
6279 return ofproto->fallback_dpid;
6283 pick_fallback_dpid(void)
6285 uint8_t ea[ETH_ADDR_LEN];
6286 eth_addr_nicira_random(ea);
6287 return eth_addr_to_uint64(ea);
6290 /* Table overflow policy. */
6292 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6293 * to NULL if the table is not configured to evict rules or if the table
6294 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6295 * or with no timeouts are not evictable.) */
6297 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6298 OVS_REQUIRES(ofproto_mutex)
6300 struct eviction_group *evg;
6303 if (!table->eviction_fields) {
6307 /* In the common case, the outer and inner loops here will each be entered
6310 * - The inner loop normally "return"s in its first iteration. If the
6311 * eviction group has any evictable rules, then it always returns in
6314 * - The outer loop only iterates more than once if the largest eviction
6315 * group has no evictable rules.
6317 * - The outer loop can exit only if table's 'max_flows' is all filled up
6318 * by unevictable rules. */
6319 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6322 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6331 /* Eviction groups. */
6333 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6334 * rules. The priority contains low-order random bits to ensure that eviction
6335 * groups with the same number of rules are prioritized randomly. */
6337 eviction_group_priority(size_t n_rules)
6339 uint16_t size = MIN(UINT16_MAX, n_rules);
6340 return (size << 16) | random_uint16();
6343 /* Updates 'evg', an eviction_group within 'table', following a change that
6344 * adds or removes rules in 'evg'. */
6346 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6347 OVS_REQUIRES(ofproto_mutex)
6349 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6350 eviction_group_priority(heap_count(&evg->rules)));
6353 /* Destroys 'evg', an eviction_group within 'table':
6355 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6356 * rules themselves, just removes them from the eviction group.)
6358 * - Removes 'evg' from 'table'.
6362 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6363 OVS_REQUIRES(ofproto_mutex)
6365 while (!heap_is_empty(&evg->rules)) {
6368 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6369 rule->eviction_group = NULL;
6371 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6372 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6373 heap_destroy(&evg->rules);
6377 /* Removes 'rule' from its eviction group, if any. */
6379 eviction_group_remove_rule(struct rule *rule)
6380 OVS_REQUIRES(ofproto_mutex)
6382 if (rule->eviction_group) {
6383 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6384 struct eviction_group *evg = rule->eviction_group;
6386 rule->eviction_group = NULL;
6387 heap_remove(&evg->rules, &rule->evg_node);
6388 if (heap_is_empty(&evg->rules)) {
6389 eviction_group_destroy(table, evg);
6391 eviction_group_resized(table, evg);
6396 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6397 * returns the hash value. */
6399 eviction_group_hash_rule(struct rule *rule)
6400 OVS_REQUIRES(ofproto_mutex)
6402 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6403 const struct mf_subfield *sf;
6407 hash = table->eviction_group_id_basis;
6408 miniflow_expand(&rule->cr.match.flow, &flow);
6409 for (sf = table->eviction_fields;
6410 sf < &table->eviction_fields[table->n_eviction_fields];
6413 if (mf_are_prereqs_ok(sf->field, &flow)) {
6414 union mf_value value;
6416 mf_get_value(sf->field, &flow, &value);
6418 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6420 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6421 unsigned int start = sf->ofs + sf->n_bits;
6422 bitwise_zero(&value, sf->field->n_bytes, start,
6423 sf->field->n_bytes * 8 - start);
6425 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6427 hash = hash_int(hash, 0);
6434 /* Returns an eviction group within 'table' with the given 'id', creating one
6436 static struct eviction_group *
6437 eviction_group_find(struct oftable *table, uint32_t id)
6438 OVS_REQUIRES(ofproto_mutex)
6440 struct eviction_group *evg;
6442 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6446 evg = xmalloc(sizeof *evg);
6447 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6448 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6449 eviction_group_priority(0));
6450 heap_init(&evg->rules);
6455 /* Returns an eviction priority for 'rule'. The return value should be
6456 * interpreted so that higher priorities make a rule more attractive candidates
6458 * Called only if have a timeout. */
6460 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6461 OVS_REQUIRES(ofproto_mutex)
6463 long long int expiration = LLONG_MAX;
6464 long long int modified;
6465 uint32_t expiration_offset;
6467 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6468 ovs_mutex_lock(&rule->mutex);
6469 modified = rule->modified;
6470 ovs_mutex_unlock(&rule->mutex);
6472 if (rule->hard_timeout) {
6473 expiration = modified + rule->hard_timeout * 1000;
6475 if (rule->idle_timeout) {
6476 uint64_t packets, bytes;
6478 long long int idle_expiration;
6480 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6481 idle_expiration = used + rule->idle_timeout * 1000;
6482 expiration = MIN(expiration, idle_expiration);
6485 if (expiration == LLONG_MAX) {
6489 /* Calculate the time of expiration as a number of (approximate) seconds
6490 * after program startup.
6492 * This should work OK for program runs that last UINT32_MAX seconds or
6493 * less. Therefore, please restart OVS at least once every 136 years. */
6494 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6496 /* Invert the expiration offset because we're using a max-heap. */
6497 return UINT32_MAX - expiration_offset;
6500 /* Adds 'rule' to an appropriate eviction group for its oftable's
6501 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6502 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6505 * The caller must ensure that 'rule' is not already in an eviction group. */
6507 eviction_group_add_rule(struct rule *rule)
6508 OVS_REQUIRES(ofproto_mutex)
6510 struct ofproto *ofproto = rule->ofproto;
6511 struct oftable *table = &ofproto->tables[rule->table_id];
6514 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6515 * so no additional protection is needed. */
6516 has_timeout = rule->hard_timeout || rule->idle_timeout;
6518 if (table->eviction_fields && has_timeout) {
6519 struct eviction_group *evg;
6521 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6523 rule->eviction_group = evg;
6524 heap_insert(&evg->rules, &rule->evg_node,
6525 rule_eviction_priority(ofproto, rule));
6526 eviction_group_resized(table, evg);
6532 /* Initializes 'table'. */
6534 oftable_init(struct oftable *table)
6536 memset(table, 0, sizeof *table);
6537 classifier_init(&table->cls, flow_segment_u32s);
6538 table->max_flows = UINT_MAX;
6539 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
6541 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
6542 ARRAY_SIZE(default_prefix_fields));
6544 atomic_init(&table->n_matched, 0);
6545 atomic_init(&table->n_missed, 0);
6548 /* Destroys 'table', including its classifier and eviction groups.
6550 * The caller is responsible for freeing 'table' itself. */
6552 oftable_destroy(struct oftable *table)
6554 ovs_assert(classifier_is_empty(&table->cls));
6555 oftable_disable_eviction(table);
6556 classifier_destroy(&table->cls);
6560 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6561 * string, then 'table' will use its default name.
6563 * This only affects the name exposed for a table exposed through the OpenFlow
6564 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6566 oftable_set_name(struct oftable *table, const char *name)
6568 if (name && name[0]) {
6569 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6570 if (!table->name || strncmp(name, table->name, len)) {
6572 table->name = xmemdup0(name, len);
6580 /* oftables support a choice of two policies when adding a rule would cause the
6581 * number of flows in the table to exceed the configured maximum number: either
6582 * they can refuse to add the new flow or they can evict some existing flow.
6583 * This function configures the former policy on 'table'. */
6585 oftable_disable_eviction(struct oftable *table)
6586 OVS_REQUIRES(ofproto_mutex)
6588 if (table->eviction_fields) {
6589 struct eviction_group *evg, *next;
6591 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6592 &table->eviction_groups_by_id) {
6593 eviction_group_destroy(table, evg);
6595 hmap_destroy(&table->eviction_groups_by_id);
6596 heap_destroy(&table->eviction_groups_by_size);
6598 free(table->eviction_fields);
6599 table->eviction_fields = NULL;
6600 table->n_eviction_fields = 0;
6604 /* oftables support a choice of two policies when adding a rule would cause the
6605 * number of flows in the table to exceed the configured maximum number: either
6606 * they can refuse to add the new flow or they can evict some existing flow.
6607 * This function configures the latter policy on 'table', with fairness based
6608 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6609 * 'n_fields' as 0 disables fairness.) */
6611 oftable_enable_eviction(struct oftable *table,
6612 const struct mf_subfield *fields, size_t n_fields)
6613 OVS_REQUIRES(ofproto_mutex)
6617 if (table->eviction_fields
6618 && n_fields == table->n_eviction_fields
6620 || !memcmp(fields, table->eviction_fields,
6621 n_fields * sizeof *fields))) {
6626 oftable_disable_eviction(table);
6628 table->n_eviction_fields = n_fields;
6629 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6631 table->eviction_group_id_basis = random_uint32();
6632 hmap_init(&table->eviction_groups_by_id);
6633 heap_init(&table->eviction_groups_by_size);
6635 CLS_FOR_EACH (rule, cr, &table->cls) {
6636 eviction_group_add_rule(rule);
6640 /* Removes 'rule' from the oftable that contains it. */
6642 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6643 OVS_REQUIRES(ofproto_mutex)
6645 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6647 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6649 cookies_remove(ofproto, rule);
6651 eviction_group_remove_rule(rule);
6652 if (!list_is_empty(&rule->expirable)) {
6653 list_remove(&rule->expirable);
6655 if (!list_is_empty(&rule->meter_list_node)) {
6656 list_remove(&rule->meter_list_node);
6657 list_init(&rule->meter_list_node);
6662 oftable_remove_rule(struct rule *rule)
6663 OVS_REQUIRES(ofproto_mutex)
6665 oftable_remove_rule__(rule->ofproto, rule);
6668 /* unixctl commands. */
6671 ofproto_lookup(const char *name)
6673 struct ofproto *ofproto;
6675 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6677 if (!strcmp(ofproto->name, name)) {
6685 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6686 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6688 struct ofproto *ofproto;
6692 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6693 ds_put_format(&results, "%s\n", ofproto->name);
6695 unixctl_command_reply(conn, ds_cstr(&results));
6696 ds_destroy(&results);
6700 ofproto_unixctl_init(void)
6702 static bool registered;
6708 unixctl_command_register("ofproto/list", "", 0, 0,
6709 ofproto_unixctl_list, NULL);
6712 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6714 * This is deprecated. It is only for compatibility with broken device drivers
6715 * in old versions of Linux that do not properly support VLANs when VLAN
6716 * devices are not used. When broken device drivers are no longer in
6717 * widespread use, we will delete these interfaces. */
6719 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6720 * (exactly) by an OpenFlow rule in 'ofproto'. */
6722 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6725 struct cls_rule target;
6726 const struct oftable *oftable;
6728 match_init_catchall(&match);
6729 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
6730 cls_rule_init(&target, &match, 0);
6732 free(ofproto->vlan_bitmap);
6733 ofproto->vlan_bitmap = bitmap_allocate(4096);
6734 ofproto->vlans_changed = false;
6736 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6739 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
6740 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
6741 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6743 bitmap_set1(vlan_bitmap, vid);
6744 bitmap_set1(ofproto->vlan_bitmap, vid);
6749 cls_rule_destroy(&target);
6752 /* Returns true if new VLANs have come into use by the flow table since the
6753 * last call to ofproto_get_vlan_usage().
6755 * We don't track when old VLANs stop being used. */
6757 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
6759 return ofproto->vlans_changed;
6762 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6763 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6764 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6765 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6766 * then the VLAN device is un-enslaved. */
6768 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
6769 ofp_port_t realdev_ofp_port, int vid)
6771 struct ofport *ofport;
6774 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
6776 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
6778 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
6779 ofproto->name, vlandev_ofp_port);
6783 if (!ofproto->ofproto_class->set_realdev) {
6784 if (!vlandev_ofp_port) {
6787 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
6791 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
6793 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
6794 ofproto->name, vlandev_ofp_port,
6795 netdev_get_name(ofport->netdev), ovs_strerror(error));