2 * Copyright (c) 2009-2015 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
47 #include "dp-packet.h"
51 #include "poll-loop.h"
59 #include "unaligned.h"
61 #include "openvswitch/vlog.h"
64 VLOG_DEFINE_THIS_MODULE(ofproto);
66 COVERAGE_DEFINE(ofproto_flush);
67 COVERAGE_DEFINE(ofproto_packet_out);
68 COVERAGE_DEFINE(ofproto_queue_req);
69 COVERAGE_DEFINE(ofproto_recv_openflow);
70 COVERAGE_DEFINE(ofproto_reinit_ports);
71 COVERAGE_DEFINE(ofproto_update_port);
73 /* Default fields to use for prefix tries in each flow table, unless something
74 * else is configured. */
75 const enum mf_field_id default_prefix_fields[2] =
76 { MFF_IPV4_DST, MFF_IPV4_SRC };
79 static void oftable_init(struct oftable *);
80 static void oftable_destroy(struct oftable *);
82 static void oftable_set_name(struct oftable *, const char *name);
84 static enum ofperr evict_rules_from_table(struct oftable *,
85 unsigned int extra_space)
86 OVS_REQUIRES(ofproto_mutex);
87 static void oftable_disable_eviction(struct oftable *);
88 static void oftable_enable_eviction(struct oftable *,
89 const struct mf_subfield *fields,
92 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
94 /* A set of rules within a single OpenFlow table (oftable) that have the same
95 * values for the oftable's eviction_fields. A rule to be evicted, when one is
96 * needed, is taken from the eviction group that contains the greatest number
99 * An oftable owns any number of eviction groups, each of which contains any
102 * Membership in an eviction group is imprecise, based on the hash of the
103 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
104 * That is, if two rules have different eviction_fields, but those
105 * eviction_fields hash to the same value, then they will belong to the same
106 * eviction_group anyway.
108 * (When eviction is not enabled on an oftable, we don't track any eviction
109 * groups, to save time and space.) */
110 struct eviction_group {
111 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
112 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
113 struct heap rules; /* Contains "struct rule"s. */
116 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
117 OVS_REQUIRES(ofproto_mutex);
118 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *)
119 OVS_REQUIRES(ofproto_mutex);;
120 static void eviction_group_add_rule(struct rule *)
121 OVS_REQUIRES(ofproto_mutex);
122 static void eviction_group_remove_rule(struct rule *)
123 OVS_REQUIRES(ofproto_mutex);
125 /* Criteria that flow_mod and other operations use for selecting rules on
126 * which to operate. */
127 struct rule_criteria {
128 /* An OpenFlow table or 255 for all tables. */
131 /* OpenFlow matching criteria. Interpreted different in "loose" way by
132 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
133 * defined in the OpenFlow spec. */
136 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
137 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
138 * The rule will not be selected if M is 1 and B != C. */
140 ovs_be64 cookie_mask;
142 /* Selection based on actions within a rule:
144 * If out_port != OFPP_ANY, selects only rules that output to out_port.
145 * If out_group != OFPG_ALL, select only rules that output to out_group. */
149 /* If true, collects only rules that are modifiable. */
151 bool include_readonly;
154 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
155 const struct match *match, int priority,
156 ovs_be64 cookie, ovs_be64 cookie_mask,
157 ofp_port_t out_port, uint32_t out_group);
158 static void rule_criteria_require_rw(struct rule_criteria *,
159 bool can_write_readonly);
160 static void rule_criteria_destroy(struct rule_criteria *);
162 static enum ofperr collect_rules_loose(struct ofproto *,
163 const struct rule_criteria *,
164 struct rule_collection *);
166 /* A packet that needs to be passed to rule_execute().
168 * (We can't do this immediately from ofopgroup_complete() because that holds
169 * ofproto_mutex, which rule_execute() needs released.) */
170 struct rule_execute {
171 struct ovs_list list_node; /* In struct ofproto's "rule_executes" list. */
172 struct rule *rule; /* Owns a reference to the rule. */
174 struct dp_packet *packet; /* Owns the packet. */
177 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
178 static void destroy_rule_executes(struct ofproto *);
180 struct learned_cookie {
182 /* In struct ofproto's 'learned_cookies' hmap. */
183 struct hmap_node hmap_node OVS_GUARDED_BY(ofproto_mutex);
185 /* In 'dead_cookies' list when removed from hmap. */
186 struct ovs_list list_node;
190 ovs_be64 cookie OVS_GUARDED_BY(ofproto_mutex);
191 uint8_t table_id OVS_GUARDED_BY(ofproto_mutex);
193 /* Number of references from "learn" actions.
195 * When this drops to 0, all of the flows in 'table_id' with the specified
196 * 'cookie' are deleted. */
197 int n OVS_GUARDED_BY(ofproto_mutex);
200 static const struct ofpact_learn *next_learn_with_delete(
201 const struct rule_actions *, const struct ofpact_learn *start);
203 static void learned_cookies_inc(struct ofproto *, const struct rule_actions *)
204 OVS_REQUIRES(ofproto_mutex);
205 static void learned_cookies_dec(struct ofproto *, const struct rule_actions *,
206 struct ovs_list *dead_cookies)
207 OVS_REQUIRES(ofproto_mutex);
208 static void learned_cookies_flush(struct ofproto *, struct ovs_list *dead_cookies)
209 OVS_REQUIRES(ofproto_mutex);
212 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
213 static void ofport_destroy(struct ofport *);
215 static void update_port(struct ofproto *, const char *devname);
216 static int init_ports(struct ofproto *);
217 static void reinit_ports(struct ofproto *);
219 static long long int ofport_get_usage(const struct ofproto *,
220 ofp_port_t ofp_port);
221 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
222 long long int last_used);
223 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
227 * Keeps track of the currently used and recently used ofport values and is
228 * used to prevent immediate recycling of ofport values. */
229 struct ofport_usage {
230 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
231 ofp_port_t ofp_port; /* OpenFlow port number. */
232 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
233 represents in-use ofports. */
237 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
238 static bool rule_is_readonly(const struct rule *);
239 static void ofproto_rule_remove__(struct ofproto *, struct rule *)
240 OVS_REQUIRES(ofproto_mutex);
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.types = 0xf;
528 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
529 OFPGFC_SELECT_WEIGHT;
530 for (i = 0; i < 4; i++) {
531 ofproto->ogf.max_groups[i] = OFPG_MAX;
532 ofproto->ogf.ofpacts[i] = (UINT64_C(1) << N_OFPACTS) - 1;
535 error = ofproto->ofproto_class->construct(ofproto);
537 VLOG_ERR("failed to open datapath %s: %s",
538 datapath_name, ovs_strerror(error));
539 connmgr_destroy(ofproto->connmgr);
540 ofproto_destroy__(ofproto);
544 /* Check that hidden tables, if any, are at the end. */
545 ovs_assert(ofproto->n_tables);
546 for (i = 0; i + 1 < ofproto->n_tables; i++) {
547 enum oftable_flags flags = ofproto->tables[i].flags;
548 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
550 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
553 ofproto->datapath_id = pick_datapath_id(ofproto);
556 /* Initialize meters table. */
557 if (ofproto->ofproto_class->meter_get_features) {
558 ofproto->ofproto_class->meter_get_features(ofproto,
559 &ofproto->meter_features);
561 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
563 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
564 * sizeof(struct meter *));
570 /* Must be called (only) by an ofproto implementation in its constructor
571 * function. See the large comment on 'construct' in struct ofproto_class for
574 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
576 struct oftable *table;
578 ovs_assert(!ofproto->n_tables);
579 ovs_assert(n_tables >= 1 && n_tables <= 255);
581 ofproto->n_tables = n_tables;
582 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
583 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
588 /* To be optionally called (only) by an ofproto implementation in its
589 * constructor function. See the large comment on 'construct' in struct
590 * ofproto_class for details.
592 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
593 * will then ensure that actions passed into the ofproto implementation will
594 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
595 * function is not called, there will be no such restriction.
597 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
598 * the 'max_ports' restriction. */
600 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
602 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
603 ofproto->max_ports = max_ports;
607 ofproto_get_datapath_id(const struct ofproto *ofproto)
609 return ofproto->datapath_id;
613 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
615 uint64_t old_dpid = p->datapath_id;
616 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
617 if (p->datapath_id != old_dpid) {
618 /* Force all active connections to reconnect, since there is no way to
619 * notify a controller that the datapath ID has changed. */
620 ofproto_reconnect_controllers(p);
625 ofproto_set_controllers(struct ofproto *p,
626 const struct ofproto_controller *controllers,
627 size_t n_controllers, uint32_t allowed_versions)
629 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
634 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
636 connmgr_set_fail_mode(p->connmgr, fail_mode);
639 /* Drops the connections between 'ofproto' and all of its controllers, forcing
640 * them to reconnect. */
642 ofproto_reconnect_controllers(struct ofproto *ofproto)
644 connmgr_reconnect(ofproto->connmgr);
647 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
648 * in-band control should guarantee access, in the same way that in-band
649 * control guarantees access to OpenFlow controllers. */
651 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
652 const struct sockaddr_in *extras, size_t n)
654 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
657 /* Sets the OpenFlow queue used by flows set up by in-band control on
658 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
659 * flows will use the default queue. */
661 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
663 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
666 /* Sets the number of flows at which eviction from the kernel flow table
669 ofproto_set_flow_limit(unsigned limit)
671 ofproto_flow_limit = limit;
674 /* Sets the maximum idle time for flows in the datapath before they are
677 ofproto_set_max_idle(unsigned max_idle)
679 ofproto_max_idle = max_idle;
682 /* If forward_bpdu is true, the NORMAL action will forward frames with
683 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
684 * the NORMAL action will drop these frames. */
686 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
688 bool old_val = ofproto->forward_bpdu;
689 ofproto->forward_bpdu = forward_bpdu;
690 if (old_val != ofproto->forward_bpdu) {
691 if (ofproto->ofproto_class->forward_bpdu_changed) {
692 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
697 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
698 * 'idle_time', in seconds, and the maximum number of MAC table entries to
701 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
704 if (ofproto->ofproto_class->set_mac_table_config) {
705 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
710 /* Multicast snooping configuration. */
712 /* Configures multicast snooping on 'ofproto' using the settings
713 * defined in 's'. If 's' is NULL, disables multicast snooping.
715 * Returns 0 if successful, otherwise a positive errno value. */
717 ofproto_set_mcast_snooping(struct ofproto *ofproto,
718 const struct ofproto_mcast_snooping_settings *s)
720 return (ofproto->ofproto_class->set_mcast_snooping
721 ? ofproto->ofproto_class->set_mcast_snooping(ofproto, s)
725 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
727 * Returns 0 if successful, otherwise a positive errno value.*/
729 ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
730 const struct ofproto_mcast_snooping_port_settings *s)
732 return (ofproto->ofproto_class->set_mcast_snooping_port
733 ? ofproto->ofproto_class->set_mcast_snooping_port(ofproto, aux, s)
738 ofproto_set_n_dpdk_rxqs(int n_rxqs)
740 n_dpdk_rxqs = MAX(n_rxqs, 0);
744 ofproto_set_cpu_mask(const char *cmask)
748 pmd_cpu_mask = cmask ? xstrdup(cmask) : NULL;
752 ofproto_set_threads(int n_handlers_, int n_revalidators_)
754 int threads = MAX(count_cpu_cores(), 2);
756 n_revalidators = MAX(n_revalidators_, 0);
757 n_handlers = MAX(n_handlers_, 0);
759 if (!n_revalidators) {
760 n_revalidators = n_handlers
761 ? MAX(threads - (int) n_handlers, 1)
766 n_handlers = MAX(threads - (int) n_revalidators, 1);
771 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
774 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
778 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
780 return connmgr_set_snoops(ofproto->connmgr, snoops);
784 ofproto_set_netflow(struct ofproto *ofproto,
785 const struct netflow_options *nf_options)
787 if (nf_options && sset_is_empty(&nf_options->collectors)) {
791 if (ofproto->ofproto_class->set_netflow) {
792 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
794 return nf_options ? EOPNOTSUPP : 0;
799 ofproto_set_sflow(struct ofproto *ofproto,
800 const struct ofproto_sflow_options *oso)
802 if (oso && sset_is_empty(&oso->targets)) {
806 if (ofproto->ofproto_class->set_sflow) {
807 return ofproto->ofproto_class->set_sflow(ofproto, oso);
809 return oso ? EOPNOTSUPP : 0;
814 ofproto_set_ipfix(struct ofproto *ofproto,
815 const struct ofproto_ipfix_bridge_exporter_options *bo,
816 const struct ofproto_ipfix_flow_exporter_options *fo,
819 if (ofproto->ofproto_class->set_ipfix) {
820 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
822 return (bo || fo) ? EOPNOTSUPP : 0;
827 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
829 flow_restore_wait = flow_restore_wait_db;
833 ofproto_get_flow_restore_wait(void)
835 return flow_restore_wait;
839 /* Spanning Tree Protocol (STP) configuration. */
841 /* Configures STP on 'ofproto' using the settings defined in 's'. If
842 * 's' is NULL, disables STP.
844 * Returns 0 if successful, otherwise a positive errno value. */
846 ofproto_set_stp(struct ofproto *ofproto,
847 const struct ofproto_stp_settings *s)
849 return (ofproto->ofproto_class->set_stp
850 ? ofproto->ofproto_class->set_stp(ofproto, s)
854 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
855 * 'enabled' member of 's' is false, then the other members are not
858 * Returns 0 if successful, otherwise a positive errno value. */
860 ofproto_get_stp_status(struct ofproto *ofproto,
861 struct ofproto_stp_status *s)
863 return (ofproto->ofproto_class->get_stp_status
864 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
868 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
869 * in 's'. The caller is responsible for assigning STP port numbers
870 * (using the 'port_num' member in the range of 1 through 255, inclusive)
871 * and ensuring there are no duplicates. If the 's' is NULL, then STP
872 * is disabled on the port.
874 * Returns 0 if successful, otherwise a positive errno value.*/
876 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
877 const struct ofproto_port_stp_settings *s)
879 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
881 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
882 ofproto->name, ofp_port);
886 return (ofproto->ofproto_class->set_stp_port
887 ? ofproto->ofproto_class->set_stp_port(ofport, s)
891 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
892 * 's'. If the 'enabled' member in 's' is false, then the other members
893 * are not meaningful.
895 * Returns 0 if successful, otherwise a positive errno value.*/
897 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
898 struct ofproto_port_stp_status *s)
900 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
902 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
903 "port %"PRIu16, ofproto->name, ofp_port);
907 return (ofproto->ofproto_class->get_stp_port_status
908 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
912 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
913 * 's'. If the 'enabled' member in 's' is false, then the other members
914 * are not meaningful.
916 * Returns 0 if successful, otherwise a positive errno value.*/
918 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
919 struct ofproto_port_stp_stats *s)
921 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
923 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
924 "port %"PRIu16, ofproto->name, ofp_port);
928 return (ofproto->ofproto_class->get_stp_port_stats
929 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
933 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
935 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
936 * 's' is NULL, disables RSTP.
938 * Returns 0 if successful, otherwise a positive errno value. */
940 ofproto_set_rstp(struct ofproto *ofproto,
941 const struct ofproto_rstp_settings *s)
943 if (!ofproto->ofproto_class->set_rstp) {
946 ofproto->ofproto_class->set_rstp(ofproto, s);
950 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
951 * 'enabled' member of 's' is false, then the other members are not
954 * Returns 0 if successful, otherwise a positive errno value. */
956 ofproto_get_rstp_status(struct ofproto *ofproto,
957 struct ofproto_rstp_status *s)
959 if (!ofproto->ofproto_class->get_rstp_status) {
962 ofproto->ofproto_class->get_rstp_status(ofproto, s);
966 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
967 * in 's'. The caller is responsible for assigning RSTP port numbers
968 * (using the 'port_num' member in the range of 1 through 255, inclusive)
969 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
970 * is disabled on the port.
972 * Returns 0 if successful, otherwise a positive errno value.*/
974 ofproto_port_set_rstp(struct ofproto *ofproto, ofp_port_t ofp_port,
975 const struct ofproto_port_rstp_settings *s)
977 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
979 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16,
980 ofproto->name, ofp_port);
984 if (!ofproto->ofproto_class->set_rstp_port) {
987 ofproto->ofproto_class->set_rstp_port(ofport, s);
991 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
992 * 's'. If the 'enabled' member in 's' is false, then the other members
993 * are not meaningful.
995 * Returns 0 if successful, otherwise a positive errno value.*/
997 ofproto_port_get_rstp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
998 struct ofproto_port_rstp_status *s)
1000 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1002 VLOG_WARN_RL(&rl, "%s: cannot get RSTP status on nonexistent "
1003 "port %"PRIu16, ofproto->name, ofp_port);
1007 if (!ofproto->ofproto_class->get_rstp_port_status) {
1010 ofproto->ofproto_class->get_rstp_port_status(ofport, s);
1014 /* Queue DSCP configuration. */
1016 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1017 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1018 * to implement QoS. Instead, it is used to implement features which require
1019 * knowledge of what queues exist on a port, and some basic information about
1022 * Returns 0 if successful, otherwise a positive errno value. */
1024 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
1025 const struct ofproto_port_queue *queues,
1028 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1031 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
1032 ofproto->name, ofp_port);
1036 return (ofproto->ofproto_class->set_queues
1037 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
1041 /* Connectivity Fault Management configuration. */
1043 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1045 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1047 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1048 if (ofport && ofproto->ofproto_class->set_cfm) {
1049 ofproto->ofproto_class->set_cfm(ofport, NULL);
1053 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1054 * basic configuration from the configuration members in 'cfm', and the remote
1055 * maintenance point ID from remote_mpid. Ignores the statistics members of
1058 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1060 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1061 const struct cfm_settings *s)
1063 struct ofport *ofport;
1066 ofport = ofproto_get_port(ofproto, ofp_port);
1068 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1069 ofproto->name, ofp_port);
1073 /* XXX: For configuration simplicity, we only support one remote_mpid
1074 * outside of the CFM module. It's not clear if this is the correct long
1075 * term solution or not. */
1076 error = (ofproto->ofproto_class->set_cfm
1077 ? ofproto->ofproto_class->set_cfm(ofport, s)
1080 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1081 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1082 ovs_strerror(error));
1086 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1087 * 'ofproto' does not have a port 'ofp_port'. */
1089 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1090 const struct smap *cfg)
1092 struct ofport *ofport;
1095 ofport = ofproto_get_port(ofproto, ofp_port);
1097 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1098 ofproto->name, ofp_port);
1102 error = (ofproto->ofproto_class->set_bfd
1103 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1106 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1107 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1108 ovs_strerror(error));
1112 /* Checks the status change of BFD on 'ofport'.
1114 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1116 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1118 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1119 return (ofport && ofproto->ofproto_class->bfd_status_changed
1120 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1124 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1125 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1126 * is not an OpenFlow port in 'ofproto'.
1128 * The caller must provide and own '*status'. */
1130 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1131 struct smap *status)
1133 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1134 return (ofport && ofproto->ofproto_class->get_bfd_status
1135 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1139 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1140 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1141 * 0 if LACP partner information is not current (generally indicating a
1142 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1144 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1146 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1147 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1148 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1153 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1155 struct ofproto *ofproto = port->ofproto;
1158 if (ofproto->ofproto_class->port_get_lacp_stats) {
1159 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1169 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1170 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1171 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1172 * configuration plus, if there is more than one slave, a bonding
1175 * If 'aux' is already registered then this function updates its configuration
1176 * to 's'. Otherwise, this function registers a new bundle.
1178 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1181 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1182 const struct ofproto_bundle_settings *s)
1184 return (ofproto->ofproto_class->bundle_set
1185 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1189 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1190 * If no such bundle has been registered, this has no effect. */
1192 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1194 return ofproto_bundle_register(ofproto, aux, NULL);
1198 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1199 * If 'aux' is already registered then this function updates its configuration
1200 * to 's'. Otherwise, this function registers a new mirror. */
1202 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1203 const struct ofproto_mirror_settings *s)
1205 return (ofproto->ofproto_class->mirror_set
1206 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1210 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1211 * If no mirror has been registered, this has no effect. */
1213 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1215 return ofproto_mirror_register(ofproto, aux, NULL);
1218 /* Retrieves statistics from mirror associated with client data pointer
1219 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1220 * 'bytes', respectively. If a particular counters is not supported,
1221 * the appropriate argument is set to UINT64_MAX. */
1223 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1224 uint64_t *packets, uint64_t *bytes)
1226 if (!ofproto->ofproto_class->mirror_get_stats) {
1227 *packets = *bytes = UINT64_MAX;
1231 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1235 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1236 * which all packets are flooded, instead of using MAC learning. If
1237 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1239 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1242 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1244 return (ofproto->ofproto_class->set_flood_vlans
1245 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1249 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1250 * output for a mirror. */
1252 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1254 return (ofproto->ofproto_class->is_mirror_output_bundle
1255 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1259 /* Configuration of OpenFlow tables. */
1261 /* Returns the number of OpenFlow tables in 'ofproto'. */
1263 ofproto_get_n_tables(const struct ofproto *ofproto)
1265 return ofproto->n_tables;
1268 /* Returns the number of Controller visible OpenFlow tables
1269 * in 'ofproto'. This number will exclude Hidden tables.
1270 * This funtion's return value should be less or equal to that of
1271 * ofproto_get_n_tables() . */
1273 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1275 uint8_t n = ofproto->n_tables;
1277 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1278 * if present, are always at the end.) */
1279 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1286 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1287 * settings from 's'. 'table_id' must be in the range 0 through the number of
1288 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1290 * For read-only tables, only the name may be configured. */
1292 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1293 const struct ofproto_table_settings *s)
1295 struct oftable *table;
1297 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1298 table = &ofproto->tables[table_id];
1300 oftable_set_name(table, s->name);
1302 if (table->flags & OFTABLE_READONLY) {
1307 oftable_enable_eviction(table, s->groups, s->n_groups);
1309 oftable_disable_eviction(table);
1312 table->max_flows = s->max_flows;
1314 if (classifier_set_prefix_fields(&table->cls,
1315 s->prefix_fields, s->n_prefix_fields)) {
1316 /* XXX: Trigger revalidation. */
1319 ovs_mutex_lock(&ofproto_mutex);
1320 evict_rules_from_table(table, 0);
1321 ovs_mutex_unlock(&ofproto_mutex);
1325 ofproto_has_snoops(const struct ofproto *ofproto)
1327 return connmgr_has_snoops(ofproto->connmgr);
1331 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1333 connmgr_get_snoops(ofproto->connmgr, snoops);
1336 /* Deletes 'rule' from 'ofproto'.
1338 * Within an ofproto implementation, this function allows an ofproto
1339 * implementation to destroy any rules that remain when its ->destruct()
1340 * function is called. This function is not suitable for use elsewhere in an
1341 * ofproto implementation.
1343 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1344 * Cycle" in ofproto-provider.h. */
1346 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1347 OVS_EXCLUDED(ofproto_mutex)
1349 /* This skips the ofmonitor and flow-removed notifications because the
1350 * switch is being deleted and any OpenFlow channels have been or soon will
1352 ovs_mutex_lock(&ofproto_mutex);
1353 oftable_remove_rule(rule);
1354 ofproto->ofproto_class->rule_delete(rule);
1355 ovs_mutex_unlock(&ofproto_mutex);
1359 ofproto_flush__(struct ofproto *ofproto)
1360 OVS_EXCLUDED(ofproto_mutex)
1362 struct oftable *table;
1364 /* This will flush all datapath flows. */
1365 if (ofproto->ofproto_class->flush) {
1366 ofproto->ofproto_class->flush(ofproto);
1369 /* XXX: There is a small race window here, where new datapath flows can be
1370 * created by upcall handlers based on the existing flow table. We can not
1371 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1372 * as then we could deadlock on syncing with the handler threads waiting on
1373 * the same mutex. */
1375 ovs_mutex_lock(&ofproto_mutex);
1376 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1377 struct rule_collection rules;
1380 if (table->flags & OFTABLE_HIDDEN) {
1384 rule_collection_init(&rules);
1386 CLS_FOR_EACH (rule, cr, &table->cls) {
1387 rule_collection_add(&rules, rule);
1389 delete_flows__(&rules, OFPRR_DELETE, NULL);
1390 rule_collection_destroy(&rules);
1392 /* XXX: Concurrent handler threads may insert new learned flows based on
1393 * learn actions of the now deleted flows right after we release
1394 * 'ofproto_mutex'. */
1395 ovs_mutex_unlock(&ofproto_mutex);
1398 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1401 ofproto_destroy__(struct ofproto *ofproto)
1402 OVS_EXCLUDED(ofproto_mutex)
1404 struct oftable *table;
1406 destroy_rule_executes(ofproto);
1407 delete_group(ofproto, OFPG_ALL);
1409 guarded_list_destroy(&ofproto->rule_executes);
1410 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1411 hmap_destroy(&ofproto->groups);
1413 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1414 free(ofproto->name);
1415 free(ofproto->type);
1416 free(ofproto->mfr_desc);
1417 free(ofproto->hw_desc);
1418 free(ofproto->sw_desc);
1419 free(ofproto->serial_desc);
1420 free(ofproto->dp_desc);
1421 hmap_destroy(&ofproto->ports);
1422 hmap_destroy(&ofproto->ofport_usage);
1423 shash_destroy(&ofproto->port_by_name);
1424 simap_destroy(&ofproto->ofp_requests);
1426 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1427 oftable_destroy(table);
1429 free(ofproto->tables);
1431 ovs_assert(hindex_is_empty(&ofproto->cookies));
1432 hindex_destroy(&ofproto->cookies);
1434 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1435 hmap_destroy(&ofproto->learned_cookies);
1437 free(ofproto->vlan_bitmap);
1439 ofproto->ofproto_class->dealloc(ofproto);
1443 ofproto_destroy(struct ofproto *p)
1444 OVS_EXCLUDED(ofproto_mutex)
1446 struct ofport *ofport, *next_ofport;
1447 struct ofport_usage *usage, *next_usage;
1454 meter_delete(p, 1, p->meter_features.max_meters);
1455 p->meter_features.max_meters = 0;
1461 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1462 ofport_destroy(ofport);
1465 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1466 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1470 p->ofproto_class->destruct(p);
1472 /* We should not postpone this because it involves deleting a listening
1473 * socket which we may want to reopen soon. 'connmgr' should not be used
1474 * by other threads */
1475 connmgr_destroy(p->connmgr);
1477 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1478 ovsrcu_postpone(ofproto_destroy__, p);
1481 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1482 * kernel datapath, for example, this destroys the datapath in the kernel, and
1483 * with the netdev-based datapath, it tears down the data structures that
1484 * represent the datapath.
1486 * The datapath should not be currently open as an ofproto. */
1488 ofproto_delete(const char *name, const char *type)
1490 const struct ofproto_class *class = ofproto_class_find__(type);
1491 return (!class ? EAFNOSUPPORT
1492 : !class->del ? EACCES
1493 : class->del(type, name));
1497 process_port_change(struct ofproto *ofproto, int error, char *devname)
1499 if (error == ENOBUFS) {
1500 reinit_ports(ofproto);
1501 } else if (!error) {
1502 update_port(ofproto, devname);
1508 ofproto_type_run(const char *datapath_type)
1510 const struct ofproto_class *class;
1513 datapath_type = ofproto_normalize_type(datapath_type);
1514 class = ofproto_class_find__(datapath_type);
1516 error = class->type_run ? class->type_run(datapath_type) : 0;
1517 if (error && error != EAGAIN) {
1518 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1519 datapath_type, ovs_strerror(error));
1525 ofproto_type_wait(const char *datapath_type)
1527 const struct ofproto_class *class;
1529 datapath_type = ofproto_normalize_type(datapath_type);
1530 class = ofproto_class_find__(datapath_type);
1532 if (class->type_wait) {
1533 class->type_wait(datapath_type);
1538 ofproto_run(struct ofproto *p)
1543 error = p->ofproto_class->run(p);
1544 if (error && error != EAGAIN) {
1545 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1548 run_rule_executes(p);
1550 /* Restore the eviction group heap invariant occasionally. */
1551 if (p->eviction_group_timer < time_msec()) {
1554 p->eviction_group_timer = time_msec() + 1000;
1556 for (i = 0; i < p->n_tables; i++) {
1557 struct oftable *table = &p->tables[i];
1558 struct eviction_group *evg;
1561 if (!table->eviction_fields) {
1565 if (classifier_count(&table->cls) > 100000) {
1566 static struct vlog_rate_limit count_rl =
1567 VLOG_RATE_LIMIT_INIT(1, 1);
1568 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1569 " number of rules: %d", i,
1570 classifier_count(&table->cls));
1573 ovs_mutex_lock(&ofproto_mutex);
1574 CLS_FOR_EACH (rule, cr, &table->cls) {
1575 if (rule->idle_timeout || rule->hard_timeout) {
1576 if (!rule->eviction_group) {
1577 eviction_group_add_rule(rule);
1579 heap_raw_change(&rule->evg_node,
1580 rule_eviction_priority(p, rule));
1585 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1586 heap_rebuild(&evg->rules);
1588 ovs_mutex_unlock(&ofproto_mutex);
1592 if (p->ofproto_class->port_poll) {
1595 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1596 process_port_change(p, error, devname);
1600 new_seq = seq_read(connectivity_seq_get());
1601 if (new_seq != p->change_seq) {
1602 struct sset devnames;
1603 const char *devname;
1604 struct ofport *ofport;
1606 /* Update OpenFlow port status for any port whose netdev has changed.
1608 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1609 * destroyed, so it's not safe to update ports directly from the
1610 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1611 * need this two-phase approach. */
1612 sset_init(&devnames);
1613 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1614 uint64_t port_change_seq;
1616 port_change_seq = netdev_get_change_seq(ofport->netdev);
1617 if (ofport->change_seq != port_change_seq) {
1618 ofport->change_seq = port_change_seq;
1619 sset_add(&devnames, netdev_get_name(ofport->netdev));
1622 SSET_FOR_EACH (devname, &devnames) {
1623 update_port(p, devname);
1625 sset_destroy(&devnames);
1627 p->change_seq = new_seq;
1630 connmgr_run(p->connmgr, handle_openflow);
1636 ofproto_wait(struct ofproto *p)
1638 p->ofproto_class->wait(p);
1639 if (p->ofproto_class->port_poll_wait) {
1640 p->ofproto_class->port_poll_wait(p);
1642 seq_wait(connectivity_seq_get(), p->change_seq);
1643 connmgr_wait(p->connmgr);
1647 ofproto_is_alive(const struct ofproto *p)
1649 return connmgr_has_controllers(p->connmgr);
1652 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1653 * memory_report(). */
1655 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1657 const struct oftable *table;
1658 unsigned int n_rules;
1660 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1663 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1664 n_rules += classifier_count(&table->cls);
1666 simap_increase(usage, "rules", n_rules);
1668 if (ofproto->ofproto_class->get_memory_usage) {
1669 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1672 connmgr_get_memory_usage(ofproto->connmgr, usage);
1676 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1678 const struct ofproto_class *class;
1680 datapath_type = ofproto_normalize_type(datapath_type);
1681 class = ofproto_class_find__(datapath_type);
1683 if (class && class->type_get_memory_usage) {
1684 class->type_get_memory_usage(datapath_type, usage);
1689 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1692 connmgr_get_controller_info(ofproto->connmgr, info);
1696 ofproto_free_ofproto_controller_info(struct shash *info)
1698 connmgr_free_controller_info(info);
1701 /* Makes a deep copy of 'old' into 'port'. */
1703 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1705 port->name = xstrdup(old->name);
1706 port->type = xstrdup(old->type);
1707 port->ofp_port = old->ofp_port;
1710 /* Frees memory allocated to members of 'ofproto_port'.
1712 * Do not call this function on an ofproto_port obtained from
1713 * ofproto_port_dump_next(): that function retains ownership of the data in the
1716 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1718 free(ofproto_port->name);
1719 free(ofproto_port->type);
1722 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1724 * This function provides no status indication. An error status for the entire
1725 * dump operation is provided when it is completed by calling
1726 * ofproto_port_dump_done().
1729 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1730 const struct ofproto *ofproto)
1732 dump->ofproto = ofproto;
1733 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1737 /* Attempts to retrieve another port from 'dump', which must have been created
1738 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1739 * 'port' and returns true. On failure, returns false.
1741 * Failure might indicate an actual error or merely that the last port has been
1742 * dumped. An error status for the entire dump operation is provided when it
1743 * is completed by calling ofproto_port_dump_done().
1745 * The ofproto owns the data stored in 'port'. It will remain valid until at
1746 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1747 * ofproto_port_dump_done(). */
1749 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1750 struct ofproto_port *port)
1752 const struct ofproto *ofproto = dump->ofproto;
1758 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1761 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1767 /* Completes port table dump operation 'dump', which must have been created
1768 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1769 * error-free, otherwise a positive errno value describing the problem. */
1771 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1773 const struct ofproto *ofproto = dump->ofproto;
1775 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1778 return dump->error == EOF ? 0 : dump->error;
1781 /* Returns the type to pass to netdev_open() when a datapath of type
1782 * 'datapath_type' has a port of type 'port_type', for a few special
1783 * cases when a netdev type differs from a port type. For example, when
1784 * using the userspace datapath, a port of type "internal" needs to be
1787 * Returns either 'type' itself or a string literal, which must not be
1790 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1792 const struct ofproto_class *class;
1794 datapath_type = ofproto_normalize_type(datapath_type);
1795 class = ofproto_class_find__(datapath_type);
1800 return (class->port_open_type
1801 ? class->port_open_type(datapath_type, port_type)
1805 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1806 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1807 * the port's OpenFlow port number.
1809 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1810 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1811 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1812 * 'ofp_portp' is non-null). */
1814 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1815 ofp_port_t *ofp_portp)
1817 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1820 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1822 const char *netdev_name = netdev_get_name(netdev);
1824 simap_put(&ofproto->ofp_requests, netdev_name,
1825 ofp_to_u16(ofp_port));
1826 update_port(ofproto, netdev_name);
1829 *ofp_portp = OFPP_NONE;
1831 struct ofproto_port ofproto_port;
1833 error = ofproto_port_query_by_name(ofproto,
1834 netdev_get_name(netdev),
1837 *ofp_portp = ofproto_port.ofp_port;
1838 ofproto_port_destroy(&ofproto_port);
1845 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1846 * initializes '*port' appropriately; on failure, returns a positive errno
1849 * The caller owns the data in 'ofproto_port' and must free it with
1850 * ofproto_port_destroy() when it is no longer needed. */
1852 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1853 struct ofproto_port *port)
1857 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1859 memset(port, 0, sizeof *port);
1864 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1865 * Returns 0 if successful, otherwise a positive errno. */
1867 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1869 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1870 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1871 struct simap_node *ofp_request_node;
1874 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1875 if (ofp_request_node) {
1876 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1879 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1880 if (!error && ofport) {
1881 /* 'name' is the netdev's name and update_port() is going to close the
1882 * netdev. Just in case update_port() refers to 'name' after it
1883 * destroys 'ofport', make a copy of it around the update_port()
1885 char *devname = xstrdup(name);
1886 update_port(ofproto, devname);
1893 flow_mod_init(struct ofputil_flow_mod *fm,
1894 const struct match *match, int priority,
1895 const struct ofpact *ofpacts, size_t ofpacts_len,
1896 enum ofp_flow_mod_command command)
1898 memset(fm, 0, sizeof *fm);
1900 fm->priority = priority;
1903 fm->modify_cookie = false;
1905 fm->command = command;
1906 fm->idle_timeout = 0;
1907 fm->hard_timeout = 0;
1909 fm->buffer_id = UINT32_MAX;
1910 fm->out_port = OFPP_ANY;
1911 fm->out_group = OFPG_ANY;
1913 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1914 fm->ofpacts_len = ofpacts_len;
1915 fm->delete_reason = OFPRR_DELETE;
1919 simple_flow_mod(struct ofproto *ofproto,
1920 const struct match *match, int priority,
1921 const struct ofpact *ofpacts, size_t ofpacts_len,
1922 enum ofp_flow_mod_command command)
1924 struct ofputil_flow_mod fm;
1926 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1928 return handle_flow_mod__(ofproto, &fm, NULL);
1931 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1932 * performs the 'n_actions' actions in 'actions'. The new flow will not
1935 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1936 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1937 * controllers; otherwise, it will be hidden.
1939 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1941 * This is a helper function for in-band control and fail-open. */
1943 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1945 const struct ofpact *ofpacts, size_t ofpacts_len)
1946 OVS_EXCLUDED(ofproto_mutex)
1948 const struct rule *rule;
1951 /* First do a cheap check whether the rule we're looking for already exists
1952 * with the actions that we want. If it does, then we're done. */
1953 rule = rule_from_cls_rule(classifier_find_match_exactly(
1954 &ofproto->tables[0].cls, match, priority));
1956 const struct rule_actions *actions = rule_get_actions(rule);
1957 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1958 ofpacts, ofpacts_len);
1963 /* If there's no such rule or the rule doesn't have the actions we want,
1964 * fall back to a executing a full flow mod. We can't optimize this at
1965 * all because we didn't take enough locks above to ensure that the flow
1966 * table didn't already change beneath us. */
1968 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1969 OFPFC_MODIFY_STRICT);
1973 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1974 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1975 * operation cannot be initiated now but may be retried later.
1977 * This is a helper function for in-band control and fail-open and the "learn"
1980 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1981 OVS_EXCLUDED(ofproto_mutex)
1983 /* Optimize for the most common case of a repeated learn action.
1984 * If an identical flow already exists we only need to update its
1985 * 'modified' time. */
1986 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1987 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1988 struct oftable *table = &ofproto->tables[fm->table_id];
1992 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
1996 /* Reading many of the rule fields and writing on 'modified'
1997 * requires the rule->mutex. Also, rule->actions may change
1998 * if rule->mutex is not held. */
1999 const struct rule_actions *actions;
2001 ovs_mutex_lock(&rule->mutex);
2002 actions = rule_get_actions(rule);
2003 if (rule->idle_timeout == fm->idle_timeout
2004 && rule->hard_timeout == fm->hard_timeout
2005 && rule->importance == fm->importance
2006 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2007 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2008 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2009 actions->ofpacts, actions->ofpacts_len)) {
2010 /* Rule already exists and need not change, only update the
2011 modified timestamp. */
2012 rule->modified = time_msec();
2015 ovs_mutex_unlock(&rule->mutex);
2023 return handle_flow_mod__(ofproto, fm, NULL);
2026 /* Searches for a rule with matching criteria exactly equal to 'target' in
2027 * ofproto's table 0 and, if it finds one, deletes it.
2029 * This is a helper function for in-band control and fail-open. */
2031 ofproto_delete_flow(struct ofproto *ofproto,
2032 const struct match *target, int priority)
2033 OVS_EXCLUDED(ofproto_mutex)
2035 struct classifier *cls = &ofproto->tables[0].cls;
2038 /* First do a cheap check whether the rule we're looking for has already
2039 * been deleted. If so, then we're done. */
2040 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2046 /* Execute a flow mod. We can't optimize this at all because we didn't
2047 * take enough locks above to ensure that the flow table didn't already
2048 * change beneath us. */
2049 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2052 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2053 * the flows required by in-band control and fail-open. */
2055 ofproto_flush_flows(struct ofproto *ofproto)
2057 COVERAGE_INC(ofproto_flush);
2058 ofproto_flush__(ofproto);
2059 connmgr_flushed(ofproto->connmgr);
2063 reinit_ports(struct ofproto *p)
2065 struct ofproto_port_dump dump;
2066 struct sset devnames;
2067 struct ofport *ofport;
2068 struct ofproto_port ofproto_port;
2069 const char *devname;
2071 COVERAGE_INC(ofproto_reinit_ports);
2073 sset_init(&devnames);
2074 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2075 sset_add(&devnames, netdev_get_name(ofport->netdev));
2077 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2078 sset_add(&devnames, ofproto_port.name);
2081 SSET_FOR_EACH (devname, &devnames) {
2082 update_port(p, devname);
2084 sset_destroy(&devnames);
2088 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2092 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2093 port_idx = port_idx ? port_idx : UINT16_MAX;
2095 if (port_idx >= ofproto->max_ports
2096 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2097 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2098 long long int last_used_at, lru = LLONG_MAX;
2100 /* Search for a free OpenFlow port number. We try not to
2101 * immediately reuse them to prevent problems due to old
2104 * We limit the automatically assigned port numbers to the lower half
2105 * of the port range, to reserve the upper half for assignment by
2108 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2109 ofproto->alloc_port_no = 1;
2111 last_used_at = ofport_get_usage(ofproto,
2112 u16_to_ofp(ofproto->alloc_port_no));
2113 if (!last_used_at) {
2114 port_idx = ofproto->alloc_port_no;
2116 } else if ( last_used_at < time_msec() - 60*60*1000) {
2117 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2118 * more than an hour ago, consider it usable. */
2119 ofport_remove_usage(ofproto,
2120 u16_to_ofp(ofproto->alloc_port_no));
2121 port_idx = ofproto->alloc_port_no;
2123 } else if (last_used_at < lru) {
2125 lru_ofport = ofproto->alloc_port_no;
2128 if (ofproto->alloc_port_no == end_port_no) {
2130 port_idx = lru_ofport;
2137 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2138 return u16_to_ofp(port_idx);
2142 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2144 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2145 ofport_set_usage(ofproto, ofp_port, time_msec());
2149 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2150 * pointer if the netdev cannot be opened. On success, also fills in
2152 static struct netdev *
2153 ofport_open(struct ofproto *ofproto,
2154 struct ofproto_port *ofproto_port,
2155 struct ofputil_phy_port *pp)
2157 enum netdev_flags flags;
2158 struct netdev *netdev;
2161 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2163 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2164 "cannot be opened (%s)",
2166 ofproto_port->name, ofproto_port->ofp_port,
2167 ofproto_port->name, ovs_strerror(error));
2171 if (ofproto_port->ofp_port == OFPP_NONE) {
2172 if (!strcmp(ofproto->name, ofproto_port->name)) {
2173 ofproto_port->ofp_port = OFPP_LOCAL;
2175 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2176 ofproto_port->name);
2179 pp->port_no = ofproto_port->ofp_port;
2180 netdev_get_etheraddr(netdev, pp->hw_addr);
2181 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2182 netdev_get_flags(netdev, &flags);
2183 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2184 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2185 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2186 &pp->supported, &pp->peer);
2187 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2188 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2193 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2194 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2197 ofport_equal(const struct ofputil_phy_port *a,
2198 const struct ofputil_phy_port *b)
2200 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2201 && a->state == b->state
2202 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2203 && a->curr == b->curr
2204 && a->advertised == b->advertised
2205 && a->supported == b->supported
2206 && a->peer == b->peer
2207 && a->curr_speed == b->curr_speed
2208 && a->max_speed == b->max_speed);
2211 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2212 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2213 * one with the same name or port number). */
2215 ofport_install(struct ofproto *p,
2216 struct netdev *netdev, const struct ofputil_phy_port *pp)
2218 const char *netdev_name = netdev_get_name(netdev);
2219 struct ofport *ofport;
2222 /* Create ofport. */
2223 ofport = p->ofproto_class->port_alloc();
2228 ofport->ofproto = p;
2229 ofport->netdev = netdev;
2230 ofport->change_seq = netdev_get_change_seq(netdev);
2232 ofport->ofp_port = pp->port_no;
2233 ofport->created = time_msec();
2235 /* Add port to 'p'. */
2236 hmap_insert(&p->ports, &ofport->hmap_node,
2237 hash_ofp_port(ofport->ofp_port));
2238 shash_add(&p->port_by_name, netdev_name, ofport);
2240 update_mtu(p, ofport);
2242 /* Let the ofproto_class initialize its private data. */
2243 error = p->ofproto_class->port_construct(ofport);
2247 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2251 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2252 p->name, netdev_name, ovs_strerror(error));
2254 ofport_destroy__(ofport);
2256 netdev_close(netdev);
2260 /* Removes 'ofport' from 'p' and destroys it. */
2262 ofport_remove(struct ofport *ofport)
2264 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2266 ofport_destroy(ofport);
2269 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2272 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2274 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2276 ofport_remove(port);
2280 /* Updates 'port' with new 'pp' description.
2282 * Does not handle a name or port number change. The caller must implement
2283 * such a change as a delete followed by an add. */
2285 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2287 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2288 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2289 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2290 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2291 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2292 port->pp.curr = pp->curr;
2293 port->pp.advertised = pp->advertised;
2294 port->pp.supported = pp->supported;
2295 port->pp.peer = pp->peer;
2296 port->pp.curr_speed = pp->curr_speed;
2297 port->pp.max_speed = pp->max_speed;
2299 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2300 &port->pp, OFPPR_MODIFY);
2303 /* Update OpenFlow 'state' in 'port' and notify controller. */
2305 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2307 if (port->pp.state != state) {
2308 port->pp.state = state;
2309 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2310 &port->pp, OFPPR_MODIFY);
2315 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2317 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2319 if (port->ofproto->ofproto_class->set_realdev) {
2320 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2322 if (port->ofproto->ofproto_class->set_stp_port) {
2323 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2325 if (port->ofproto->ofproto_class->set_rstp_port) {
2326 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2328 if (port->ofproto->ofproto_class->set_cfm) {
2329 port->ofproto->ofproto_class->set_cfm(port, NULL);
2331 if (port->ofproto->ofproto_class->bundle_remove) {
2332 port->ofproto->ofproto_class->bundle_remove(port);
2338 ofport_destroy__(struct ofport *port)
2340 struct ofproto *ofproto = port->ofproto;
2341 const char *name = netdev_get_name(port->netdev);
2343 hmap_remove(&ofproto->ports, &port->hmap_node);
2344 shash_delete(&ofproto->port_by_name,
2345 shash_find(&ofproto->port_by_name, name));
2347 netdev_close(port->netdev);
2348 ofproto->ofproto_class->port_dealloc(port);
2352 ofport_destroy(struct ofport *port)
2355 dealloc_ofp_port(port->ofproto, port->ofp_port);
2356 port->ofproto->ofproto_class->port_destruct(port);
2357 ofport_destroy__(port);
2362 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2364 struct ofport *port;
2366 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2368 if (port->ofp_port == ofp_port) {
2375 static long long int
2376 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2378 struct ofport_usage *usage;
2380 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2381 &ofproto->ofport_usage) {
2382 if (usage->ofp_port == ofp_port) {
2383 return usage->last_used;
2390 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2391 long long int last_used)
2393 struct ofport_usage *usage;
2394 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2395 &ofproto->ofport_usage) {
2396 if (usage->ofp_port == ofp_port) {
2397 usage->last_used = last_used;
2401 ovs_assert(last_used == LLONG_MAX);
2403 usage = xmalloc(sizeof *usage);
2404 usage->ofp_port = ofp_port;
2405 usage->last_used = last_used;
2406 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2407 hash_ofp_port(ofp_port));
2411 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2413 struct ofport_usage *usage;
2414 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2415 &ofproto->ofport_usage) {
2416 if (usage->ofp_port == ofp_port) {
2417 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2425 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2427 struct ofproto *ofproto = port->ofproto;
2430 if (ofproto->ofproto_class->port_get_stats) {
2431 error = ofproto->ofproto_class->port_get_stats(port, stats);
2440 update_port(struct ofproto *ofproto, const char *name)
2442 struct ofproto_port ofproto_port;
2443 struct ofputil_phy_port pp;
2444 struct netdev *netdev;
2445 struct ofport *port;
2447 COVERAGE_INC(ofproto_update_port);
2449 /* Fetch 'name''s location and properties from the datapath. */
2450 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2451 ? ofport_open(ofproto, &ofproto_port, &pp)
2455 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2456 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2457 struct netdev *old_netdev = port->netdev;
2459 /* 'name' hasn't changed location. Any properties changed? */
2460 if (!ofport_equal(&port->pp, &pp)) {
2461 ofport_modified(port, &pp);
2464 update_mtu(ofproto, port);
2466 /* Install the newly opened netdev in case it has changed.
2467 * Don't close the old netdev yet in case port_modified has to
2468 * remove a retained reference to it.*/
2469 port->netdev = netdev;
2470 port->change_seq = netdev_get_change_seq(netdev);
2472 if (port->ofproto->ofproto_class->port_modified) {
2473 port->ofproto->ofproto_class->port_modified(port);
2476 netdev_close(old_netdev);
2478 /* If 'port' is nonnull then its name differs from 'name' and thus
2479 * we should delete it. If we think there's a port named 'name'
2480 * then its port number must be wrong now so delete it too. */
2482 ofport_remove(port);
2484 ofport_remove_with_name(ofproto, name);
2485 ofport_install(ofproto, netdev, &pp);
2488 /* Any port named 'name' is gone now. */
2489 ofport_remove_with_name(ofproto, name);
2491 ofproto_port_destroy(&ofproto_port);
2495 init_ports(struct ofproto *p)
2497 struct ofproto_port_dump dump;
2498 struct ofproto_port ofproto_port;
2499 struct shash_node *node, *next;
2501 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2502 const char *name = ofproto_port.name;
2504 if (shash_find(&p->port_by_name, name)) {
2505 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2508 struct ofputil_phy_port pp;
2509 struct netdev *netdev;
2511 /* Check if an OpenFlow port number had been requested. */
2512 node = shash_find(&init_ofp_ports, name);
2514 const struct iface_hint *iface_hint = node->data;
2515 simap_put(&p->ofp_requests, name,
2516 ofp_to_u16(iface_hint->ofp_port));
2519 netdev = ofport_open(p, &ofproto_port, &pp);
2521 ofport_install(p, netdev, &pp);
2522 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2523 p->alloc_port_no = MAX(p->alloc_port_no,
2524 ofp_to_u16(ofproto_port.ofp_port));
2530 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2531 struct iface_hint *iface_hint = node->data;
2533 if (!strcmp(iface_hint->br_name, p->name)) {
2534 free(iface_hint->br_name);
2535 free(iface_hint->br_type);
2537 shash_delete(&init_ofp_ports, node);
2544 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2545 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2547 find_min_mtu(struct ofproto *p)
2549 struct ofport *ofport;
2552 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2553 struct netdev *netdev = ofport->netdev;
2556 /* Skip any internal ports, since that's what we're trying to
2558 if (!strcmp(netdev_get_type(netdev), "internal")) {
2562 if (netdev_get_mtu(netdev, &dev_mtu)) {
2565 if (!mtu || dev_mtu < mtu) {
2570 return mtu ? mtu: ETH_PAYLOAD_MAX;
2573 /* Update MTU of all datapath devices on 'p' to the minimum of the
2574 * non-datapath ports in event of 'port' added or changed. */
2576 update_mtu(struct ofproto *p, struct ofport *port)
2578 struct ofport *ofport;
2579 struct netdev *netdev = port->netdev;
2580 int dev_mtu, old_min;
2582 if (netdev_get_mtu(netdev, &dev_mtu)) {
2586 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2587 if (dev_mtu > p->min_mtu) {
2588 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2589 dev_mtu = p->min_mtu;
2592 port->mtu = dev_mtu;
2596 /* For non-internal port find new min mtu. */
2597 old_min = p->min_mtu;
2598 port->mtu = dev_mtu;
2599 p->min_mtu = find_min_mtu(p);
2600 if (p->min_mtu == old_min) {
2604 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2605 struct netdev *netdev = ofport->netdev;
2607 if (!strcmp(netdev_get_type(netdev), "internal")) {
2608 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2609 ofport->mtu = p->min_mtu;
2616 ofproto_rule_destroy__(struct rule *rule)
2617 OVS_NO_THREAD_SAFETY_ANALYSIS
2619 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2620 rule_actions_destroy(rule_get_actions(rule));
2621 ovs_mutex_destroy(&rule->mutex);
2622 rule->ofproto->ofproto_class->rule_dealloc(rule);
2626 rule_destroy_cb(struct rule *rule)
2628 rule->ofproto->ofproto_class->rule_destruct(rule);
2629 ofproto_rule_destroy__(rule);
2633 ofproto_rule_ref(struct rule *rule)
2636 ovs_refcount_ref(&rule->ref_count);
2641 ofproto_rule_try_ref(struct rule *rule)
2644 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2649 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2650 * ref_count reaches 0.
2652 * Use of RCU allows short term use (between RCU quiescent periods) without
2653 * keeping a reference. A reference must be taken if the rule needs to
2654 * stay around accross the RCU quiescent periods. */
2656 ofproto_rule_unref(struct rule *rule)
2658 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2659 ovsrcu_postpone(rule_destroy_cb, rule);
2664 ofproto_group_ref(struct ofgroup *group)
2667 ovs_refcount_ref(&group->ref_count);
2672 ofproto_group_unref(struct ofgroup *group)
2674 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2675 group->ofproto->ofproto_class->group_destruct(group);
2676 ofputil_bucket_list_destroy(&group->buckets);
2677 group->ofproto->ofproto_class->group_dealloc(group);
2681 static uint32_t get_provider_meter_id(const struct ofproto *,
2682 uint32_t of_meter_id);
2684 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2685 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2686 const struct rule_actions *
2687 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2689 struct rule_actions *actions;
2691 actions = xmalloc(sizeof *actions + ofpacts_len);
2692 actions->ofpacts_len = ofpacts_len;
2693 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2694 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2696 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2702 /* Free the actions after the RCU quiescent period is reached. */
2704 rule_actions_destroy(const struct rule_actions *actions)
2707 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2711 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2712 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2714 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2715 OVS_REQUIRES(ofproto_mutex)
2717 if (port == OFPP_ANY) {
2720 const struct rule_actions *actions = rule_get_actions(rule);
2721 return ofpacts_output_to_port(actions->ofpacts,
2722 actions->ofpacts_len, port);
2726 /* Returns true if 'rule' has group and equals group_id. */
2728 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2729 OVS_REQUIRES(ofproto_mutex)
2731 if (group_id == OFPG_ANY) {
2734 const struct rule_actions *actions = rule_get_actions(rule);
2735 return ofpacts_output_to_group(actions->ofpacts,
2736 actions->ofpacts_len, group_id);
2741 rule_execute_destroy(struct rule_execute *e)
2743 ofproto_rule_unref(e->rule);
2744 list_remove(&e->list_node);
2748 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2749 * by passing them to the ofproto provider. */
2751 run_rule_executes(struct ofproto *ofproto)
2752 OVS_EXCLUDED(ofproto_mutex)
2754 struct rule_execute *e, *next;
2755 struct ovs_list executes;
2757 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2758 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2761 flow_extract(e->packet, &flow);
2762 flow.in_port.ofp_port = e->in_port;
2763 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2765 rule_execute_destroy(e);
2769 /* Destroys and discards all "rule_execute" operations queued up in
2770 * ofproto->rule_executes. */
2772 destroy_rule_executes(struct ofproto *ofproto)
2774 struct rule_execute *e, *next;
2775 struct ovs_list executes;
2777 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2778 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2779 dp_packet_delete(e->packet);
2780 rule_execute_destroy(e);
2785 rule_is_readonly(const struct rule *rule)
2787 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2788 return (table->flags & OFTABLE_READONLY) != 0;
2792 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2794 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2795 return hash_3words(cookie, cookie >> 32, table_id);
2799 learned_cookies_update_one__(struct ofproto *ofproto,
2800 const struct ofpact_learn *learn,
2801 int delta, struct ovs_list *dead_cookies)
2802 OVS_REQUIRES(ofproto_mutex)
2804 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
2805 struct learned_cookie *c;
2807 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
2808 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
2810 ovs_assert(c->n >= 0);
2813 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
2814 list_push_back(dead_cookies, &c->u.list_node);
2821 ovs_assert(delta > 0);
2822 c = xmalloc(sizeof *c);
2823 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
2824 c->cookie = learn->cookie;
2825 c->table_id = learn->table_id;
2829 static const struct ofpact_learn *
2830 next_learn_with_delete(const struct rule_actions *actions,
2831 const struct ofpact_learn *start)
2833 const struct ofpact *pos;
2835 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
2836 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
2837 pos = ofpact_next(pos)) {
2838 if (pos->type == OFPACT_LEARN) {
2839 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
2840 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
2850 learned_cookies_update__(struct ofproto *ofproto,
2851 const struct rule_actions *actions,
2852 int delta, struct ovs_list *dead_cookies)
2853 OVS_REQUIRES(ofproto_mutex)
2855 if (actions->has_learn_with_delete) {
2856 const struct ofpact_learn *learn;
2858 for (learn = next_learn_with_delete(actions, NULL); learn;
2859 learn = next_learn_with_delete(actions, learn)) {
2860 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
2866 learned_cookies_inc(struct ofproto *ofproto,
2867 const struct rule_actions *actions)
2868 OVS_REQUIRES(ofproto_mutex)
2870 learned_cookies_update__(ofproto, actions, +1, NULL);
2874 learned_cookies_dec(struct ofproto *ofproto,
2875 const struct rule_actions *actions,
2876 struct ovs_list *dead_cookies)
2877 OVS_REQUIRES(ofproto_mutex)
2879 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
2883 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
2884 OVS_REQUIRES(ofproto_mutex)
2886 struct learned_cookie *c, *next;
2888 LIST_FOR_EACH_SAFE (c, next, u.list_node, dead_cookies) {
2889 struct rule_criteria criteria;
2890 struct rule_collection rules;
2893 match_init_catchall(&match);
2894 rule_criteria_init(&criteria, c->table_id, &match, 0,
2895 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
2896 rule_criteria_require_rw(&criteria, false);
2897 collect_rules_loose(ofproto, &criteria, &rules);
2898 delete_flows__(&rules, OFPRR_DELETE, NULL);
2899 rule_criteria_destroy(&criteria);
2900 rule_collection_destroy(&rules);
2902 list_remove(&c->u.list_node);
2908 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2910 ofconn_send_reply(ofconn, make_echo_reply(oh));
2915 query_tables(struct ofproto *ofproto,
2916 struct ofputil_table_features **featuresp,
2917 struct ofputil_table_stats **statsp)
2919 struct mf_bitmap rw_fields = oxm_writable_fields();
2920 struct mf_bitmap match = oxm_matchable_fields();
2921 struct mf_bitmap mask = oxm_maskable_fields();
2923 struct ofputil_table_features *features;
2924 struct ofputil_table_stats *stats;
2927 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
2928 for (i = 0; i < ofproto->n_tables; i++) {
2929 struct ofputil_table_features *f = &features[i];
2932 sprintf(f->name, "table%d", i);
2933 f->metadata_match = OVS_BE64_MAX;
2934 f->metadata_write = OVS_BE64_MAX;
2935 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
2936 f->max_entries = 1000000;
2938 bool more_tables = false;
2939 for (int j = i + 1; j < ofproto->n_tables; j++) {
2940 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
2941 bitmap_set1(f->nonmiss.next, j);
2945 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
2947 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
2949 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
2950 f->nonmiss.write.set_fields = rw_fields;
2951 f->nonmiss.apply = f->nonmiss.write;
2952 f->miss = f->nonmiss;
2956 f->wildcard = match;
2960 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
2961 for (i = 0; i < ofproto->n_tables; i++) {
2962 struct ofputil_table_stats *s = &stats[i];
2963 struct classifier *cls = &ofproto->tables[i].cls;
2966 s->active_count = classifier_count(cls);
2968 s->active_count -= connmgr_count_hidden_rules(
2976 ofproto->ofproto_class->query_tables(ofproto, features, stats);
2978 for (i = 0; i < ofproto->n_tables; i++) {
2979 const struct oftable *table = &ofproto->tables[i];
2980 struct ofputil_table_features *f = &features[i];
2983 ovs_strzcpy(f->name, table->name, sizeof f->name);
2986 if (table->max_flows < f->max_entries) {
2987 f->max_entries = table->max_flows;
2993 query_switch_features(struct ofproto *ofproto,
2994 bool *arp_match_ip, uint64_t *ofpacts)
2996 struct ofputil_table_features *features, *f;
2998 *arp_match_ip = false;
3001 query_tables(ofproto, &features, NULL);
3002 for (f = features; f < &features[ofproto->n_tables]; f++) {
3003 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3004 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3005 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3006 *arp_match_ip = true;
3012 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3016 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3018 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3019 struct ofputil_switch_features features;
3020 struct ofport *port;
3024 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3026 features.datapath_id = ofproto->datapath_id;
3027 features.n_buffers = pktbuf_capacity();
3028 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3029 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3030 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3031 OFPUTIL_C_GROUP_STATS);
3033 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3035 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3036 features.auxiliary_id = 0;
3037 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3039 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3040 ofputil_put_switch_features_port(&port->pp, b);
3043 ofconn_send_reply(ofconn, b);
3048 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3050 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3051 struct ofp_switch_config *osc;
3052 enum ofp_config_flags flags;
3056 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3057 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3058 flags = ofproto->frag_handling;
3059 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3060 if (oh->version < OFP13_VERSION
3061 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3062 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3064 osc->flags = htons(flags);
3065 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3066 ofconn_send_reply(ofconn, buf);
3072 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3074 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3075 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3076 uint16_t flags = ntohs(osc->flags);
3078 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3079 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3080 enum ofp_config_flags cur = ofproto->frag_handling;
3081 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3083 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3085 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3086 ofproto->frag_handling = next;
3088 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3090 ofputil_frag_handling_to_string(next));
3094 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3095 ofconn_set_invalid_ttl_to_controller(ofconn,
3096 (oh->version < OFP13_VERSION
3097 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3099 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3104 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3105 * error message code for the caller to propagate upward. Otherwise, returns
3108 * The log message mentions 'msg_type'. */
3110 reject_slave_controller(struct ofconn *ofconn)
3112 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3113 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3114 return OFPERR_OFPBRC_IS_SLAVE;
3120 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3123 * - If they use a meter, then 'ofproto' has that meter configured.
3125 * - If they use any groups, then 'ofproto' has that group configured.
3127 * Returns 0 if successful, otherwise an OpenFlow error. */
3129 ofproto_check_ofpacts(struct ofproto *ofproto,
3130 const struct ofpact ofpacts[], size_t ofpacts_len)
3132 const struct ofpact *a;
3135 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3136 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3137 return OFPERR_OFPMMFC_INVALID_METER;
3140 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3141 if (a->type == OFPACT_GROUP
3142 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3143 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3151 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3153 struct ofproto *p = ofconn_get_ofproto(ofconn);
3154 struct ofputil_packet_out po;
3155 struct dp_packet *payload;
3156 uint64_t ofpacts_stub[1024 / 8];
3157 struct ofpbuf ofpacts;
3161 COVERAGE_INC(ofproto_packet_out);
3163 error = reject_slave_controller(ofconn);
3168 /* Decode message. */
3169 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3170 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3172 goto exit_free_ofpacts;
3174 if (ofp_to_u16(po.in_port) >= p->max_ports
3175 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3176 error = OFPERR_OFPBRC_BAD_PORT;
3177 goto exit_free_ofpacts;
3181 if (po.buffer_id != UINT32_MAX) {
3182 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3183 if (error || !payload) {
3184 goto exit_free_ofpacts;
3187 /* Ensure that the L3 header is 32-bit aligned. */
3188 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3191 /* Verify actions against packet, then send packet if successful. */
3192 flow_extract(payload, &flow);
3193 flow.in_port.ofp_port = po.in_port;
3194 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3196 error = p->ofproto_class->packet_out(p, payload, &flow,
3197 po.ofpacts, po.ofpacts_len);
3199 dp_packet_delete(payload);
3202 ofpbuf_uninit(&ofpacts);
3208 update_port_config(struct ofconn *ofconn, struct ofport *port,
3209 enum ofputil_port_config config,
3210 enum ofputil_port_config mask)
3212 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3214 if (toggle & OFPUTIL_PC_PORT_DOWN
3215 && (config & OFPUTIL_PC_PORT_DOWN
3216 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3217 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3218 /* We tried to bring the port up or down, but it failed, so don't
3219 * update the "down" bit. */
3220 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3224 enum ofputil_port_config old_config = port->pp.config;
3225 port->pp.config ^= toggle;
3226 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3227 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3233 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3235 struct ofproto *p = ofconn_get_ofproto(ofconn);
3236 struct ofputil_port_mod pm;
3237 struct ofport *port;
3240 error = reject_slave_controller(ofconn);
3245 error = ofputil_decode_port_mod(oh, &pm, false);
3250 port = ofproto_get_port(p, pm.port_no);
3252 return OFPERR_OFPPMFC_BAD_PORT;
3253 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3254 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3256 update_port_config(ofconn, port, pm.config, pm.mask);
3258 netdev_set_advertisements(port->netdev, pm.advertise);
3265 handle_desc_stats_request(struct ofconn *ofconn,
3266 const struct ofp_header *request)
3268 static const char *default_mfr_desc = "Nicira, Inc.";
3269 static const char *default_hw_desc = "Open vSwitch";
3270 static const char *default_sw_desc = VERSION;
3271 static const char *default_serial_desc = "None";
3272 static const char *default_dp_desc = "None";
3274 struct ofproto *p = ofconn_get_ofproto(ofconn);
3275 struct ofp_desc_stats *ods;
3278 msg = ofpraw_alloc_stats_reply(request, 0);
3279 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3280 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3281 sizeof ods->mfr_desc);
3282 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3283 sizeof ods->hw_desc);
3284 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3285 sizeof ods->sw_desc);
3286 ovs_strlcpy(ods->serial_num,
3287 p->serial_desc ? p->serial_desc : default_serial_desc,
3288 sizeof ods->serial_num);
3289 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3290 sizeof ods->dp_desc);
3291 ofconn_send_reply(ofconn, msg);
3297 handle_table_stats_request(struct ofconn *ofconn,
3298 const struct ofp_header *request)
3300 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3301 struct ofputil_table_features *features;
3302 struct ofputil_table_stats *stats;
3303 struct ofpbuf *reply;
3306 query_tables(ofproto, &features, &stats);
3308 reply = ofputil_encode_table_stats_reply(request);
3309 for (i = 0; i < ofproto->n_tables; i++) {
3310 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3311 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3314 ofconn_send_reply(ofconn, reply);
3323 handle_table_features_request(struct ofconn *ofconn,
3324 const struct ofp_header *request)
3326 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3327 struct ofputil_table_features *features;
3328 struct ovs_list replies;
3332 ofpbuf_use_const(&msg, request, ntohs(request->length));
3333 ofpraw_pull_assert(&msg);
3334 if (msg.size || ofpmp_more(request)) {
3335 return OFPERR_OFPTFFC_EPERM;
3338 query_tables(ofproto, &features, NULL);
3340 ofpmp_init(&replies, request);
3341 for (i = 0; i < ofproto->n_tables; i++) {
3342 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3343 ofputil_append_table_features_reply(&features[i], &replies);
3346 ofconn_send_replies(ofconn, &replies);
3354 append_port_stat(struct ofport *port, struct ovs_list *replies)
3356 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3358 calc_duration(port->created, time_msec(),
3359 &ops.duration_sec, &ops.duration_nsec);
3361 /* Intentionally ignore return value, since errors will set
3362 * 'stats' to all-1s, which is correct for OpenFlow, and
3363 * netdev_get_stats() will log errors. */
3364 ofproto_port_get_stats(port, &ops.stats);
3366 ofputil_append_port_stat(replies, &ops);
3370 handle_port_request(struct ofconn *ofconn,
3371 const struct ofp_header *request, ofp_port_t port_no,
3372 void (*cb)(struct ofport *, struct ovs_list *replies))
3374 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3375 struct ofport *port;
3376 struct ovs_list replies;
3378 ofpmp_init(&replies, request);
3379 if (port_no != OFPP_ANY) {
3380 port = ofproto_get_port(ofproto, port_no);
3385 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3390 ofconn_send_replies(ofconn, &replies);
3394 handle_port_stats_request(struct ofconn *ofconn,
3395 const struct ofp_header *request)
3400 error = ofputil_decode_port_stats_request(request, &port_no);
3402 handle_port_request(ofconn, request, port_no, append_port_stat);
3408 append_port_desc(struct ofport *port, struct ovs_list *replies)
3410 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3414 handle_port_desc_stats_request(struct ofconn *ofconn,
3415 const struct ofp_header *request)
3420 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3422 handle_port_request(ofconn, request, port_no, append_port_desc);
3428 hash_cookie(ovs_be64 cookie)
3430 return hash_uint64((OVS_FORCE uint64_t)cookie);
3434 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3435 OVS_REQUIRES(ofproto_mutex)
3437 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3438 hash_cookie(rule->flow_cookie));
3442 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3443 OVS_REQUIRES(ofproto_mutex)
3445 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3449 calc_duration(long long int start, long long int now,
3450 uint32_t *sec, uint32_t *nsec)
3452 long long int msecs = now - start;
3453 *sec = msecs / 1000;
3454 *nsec = (msecs % 1000) * (1000 * 1000);
3457 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3458 * true if 'table_id' is OK, false otherwise. */
3460 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3462 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3465 static struct oftable *
3466 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3468 struct oftable *table;
3470 for (table = &ofproto->tables[table_id];
3471 table < &ofproto->tables[ofproto->n_tables];
3473 if (!(table->flags & OFTABLE_HIDDEN)) {
3481 static struct oftable *
3482 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3484 if (table_id == 0xff) {
3485 return next_visible_table(ofproto, 0);
3486 } else if (table_id < ofproto->n_tables) {
3487 return &ofproto->tables[table_id];
3493 static struct oftable *
3494 next_matching_table(const struct ofproto *ofproto,
3495 const struct oftable *table, uint8_t table_id)
3497 return (table_id == 0xff
3498 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3502 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3504 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3505 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3507 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3508 * only once, for that table. (This can be used to access tables marked
3511 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3512 * entered at all. (Perhaps you should have validated TABLE_ID with
3513 * check_table_id().)
3515 * All parameters are evaluated multiple times.
3517 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3518 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3520 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3522 /* Initializes 'criteria' in a straightforward way based on the other
3525 * By default, the criteria include flows that are read-only, on the assumption
3526 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3527 * if flows will be modified.
3529 * For "loose" matching, the 'priority' parameter is unimportant and may be
3532 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3533 const struct match *match, int priority,
3534 ovs_be64 cookie, ovs_be64 cookie_mask,
3535 ofp_port_t out_port, uint32_t out_group)
3537 criteria->table_id = table_id;
3538 cls_rule_init(&criteria->cr, match, priority);
3539 criteria->cookie = cookie;
3540 criteria->cookie_mask = cookie_mask;
3541 criteria->out_port = out_port;
3542 criteria->out_group = out_group;
3544 /* We ordinarily want to skip hidden rules, but there has to be a way for
3545 * code internal to OVS to modify and delete them, so if the criteria
3546 * specify a priority that can only be for a hidden flow, then allow hidden
3547 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3548 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3550 criteria->include_hidden = priority > UINT16_MAX;
3552 /* We assume that the criteria are being used to collect flows for reading
3553 * but not modification. Thus, we should collect read-only flows. */
3554 criteria->include_readonly = true;
3557 /* By default, criteria initialized by rule_criteria_init() will match flows
3558 * that are read-only, on the assumption that the collected flows won't be
3559 * modified. Call this function to match only flows that are be modifiable.
3561 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3562 * caller has special privileges that allow it to modify even "read-only"
3565 rule_criteria_require_rw(struct rule_criteria *criteria,
3566 bool can_write_readonly)
3568 criteria->include_readonly = can_write_readonly;
3572 rule_criteria_destroy(struct rule_criteria *criteria)
3574 cls_rule_destroy(&criteria->cr);
3578 rule_collection_init(struct rule_collection *rules)
3580 rules->rules = rules->stub;
3582 rules->capacity = ARRAY_SIZE(rules->stub);
3586 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3588 if (rules->n >= rules->capacity) {
3589 size_t old_size, new_size;
3591 old_size = rules->capacity * sizeof *rules->rules;
3592 rules->capacity *= 2;
3593 new_size = rules->capacity * sizeof *rules->rules;
3595 if (rules->rules == rules->stub) {
3596 rules->rules = xmalloc(new_size);
3597 memcpy(rules->rules, rules->stub, old_size);
3599 rules->rules = xrealloc(rules->rules, new_size);
3603 rules->rules[rules->n++] = rule;
3607 rule_collection_ref(struct rule_collection *rules)
3608 OVS_REQUIRES(ofproto_mutex)
3612 for (i = 0; i < rules->n; i++) {
3613 ofproto_rule_ref(rules->rules[i]);
3618 rule_collection_unref(struct rule_collection *rules)
3622 for (i = 0; i < rules->n; i++) {
3623 ofproto_rule_unref(rules->rules[i]);
3628 rule_collection_destroy(struct rule_collection *rules)
3630 if (rules->rules != rules->stub) {
3634 /* Make repeated destruction harmless. */
3635 rule_collection_init(rules);
3638 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3639 * function verifies most of the criteria in 'c' itself, but the caller must
3640 * check 'c->cr' itself.
3642 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3643 * 'c' only includes modifiable rules). */
3645 collect_rule(struct rule *rule, const struct rule_criteria *c,
3646 struct rule_collection *rules, size_t *n_readonly)
3647 OVS_REQUIRES(ofproto_mutex)
3649 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3650 && ofproto_rule_has_out_port(rule, c->out_port)
3651 && ofproto_rule_has_out_group(rule, c->out_group)
3652 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3653 && (!rule_is_hidden(rule) || c->include_hidden)) {
3654 /* Rule matches all the criteria... */
3655 if (!rule_is_readonly(rule) || c->include_readonly) {
3657 rule_collection_add(rules, rule);
3659 /* ...except it's read-only. */
3665 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3666 * on classifiers rules are done in the "loose" way required for OpenFlow
3667 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3670 * Returns 0 on success, otherwise an OpenFlow error code. */
3672 collect_rules_loose(struct ofproto *ofproto,
3673 const struct rule_criteria *criteria,
3674 struct rule_collection *rules)
3675 OVS_REQUIRES(ofproto_mutex)
3677 struct oftable *table;
3678 enum ofperr error = 0;
3679 size_t n_readonly = 0;
3681 rule_collection_init(rules);
3683 if (!check_table_id(ofproto, criteria->table_id)) {
3684 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3688 if (criteria->cookie_mask == OVS_BE64_MAX) {
3691 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3692 hash_cookie(criteria->cookie),
3693 &ofproto->cookies) {
3694 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3695 collect_rule(rule, criteria, rules, &n_readonly);
3699 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3702 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3703 collect_rule(rule, criteria, rules, &n_readonly);
3709 if (!error && !rules->n && n_readonly) {
3710 /* We didn't find any rules to modify. We did find some read-only
3711 * rules that we're not allowed to modify, so report that. */
3712 error = OFPERR_OFPBRC_EPERM;
3715 rule_collection_destroy(rules);
3720 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3721 * on classifiers rules are done in the "strict" way required for OpenFlow
3722 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3723 * rules on list 'rules'.
3725 * Returns 0 on success, otherwise an OpenFlow error code. */
3727 collect_rules_strict(struct ofproto *ofproto,
3728 const struct rule_criteria *criteria,
3729 struct rule_collection *rules)
3730 OVS_REQUIRES(ofproto_mutex)
3732 struct oftable *table;
3733 size_t n_readonly = 0;
3736 rule_collection_init(rules);
3738 if (!check_table_id(ofproto, criteria->table_id)) {
3739 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3743 if (criteria->cookie_mask == OVS_BE64_MAX) {
3746 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3747 hash_cookie(criteria->cookie),
3748 &ofproto->cookies) {
3749 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3750 collect_rule(rule, criteria, rules, &n_readonly);
3754 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3757 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3758 &table->cls, &criteria->cr));
3760 collect_rule(rule, criteria, rules, &n_readonly);
3766 if (!error && !rules->n && n_readonly) {
3767 /* We didn't find any rules to modify. We did find some read-only
3768 * rules that we're not allowed to modify, so report that. */
3769 error = OFPERR_OFPBRC_EPERM;
3772 rule_collection_destroy(rules);
3777 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3778 * forced into the range of a uint16_t. */
3780 age_secs(long long int age_ms)
3782 return (age_ms < 0 ? 0
3783 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3784 : (unsigned int) age_ms / 1000);
3788 handle_flow_stats_request(struct ofconn *ofconn,
3789 const struct ofp_header *request)
3790 OVS_EXCLUDED(ofproto_mutex)
3792 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3793 struct ofputil_flow_stats_request fsr;
3794 struct rule_criteria criteria;
3795 struct rule_collection rules;
3796 struct ovs_list replies;
3800 error = ofputil_decode_flow_stats_request(&fsr, request);
3805 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3806 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3808 ovs_mutex_lock(&ofproto_mutex);
3809 error = collect_rules_loose(ofproto, &criteria, &rules);
3810 rule_criteria_destroy(&criteria);
3812 rule_collection_ref(&rules);
3814 ovs_mutex_unlock(&ofproto_mutex);
3820 ofpmp_init(&replies, request);
3821 for (i = 0; i < rules.n; i++) {
3822 struct rule *rule = rules.rules[i];
3823 long long int now = time_msec();
3824 struct ofputil_flow_stats fs;
3825 long long int created, used, modified;
3826 const struct rule_actions *actions;
3827 enum ofputil_flow_mod_flags flags;
3829 ovs_mutex_lock(&rule->mutex);
3830 fs.cookie = rule->flow_cookie;
3831 fs.idle_timeout = rule->idle_timeout;
3832 fs.hard_timeout = rule->hard_timeout;
3833 fs.importance = rule->importance;
3834 created = rule->created;
3835 modified = rule->modified;
3836 actions = rule_get_actions(rule);
3837 flags = rule->flags;
3838 ovs_mutex_unlock(&rule->mutex);
3840 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3841 &fs.byte_count, &used);
3843 minimatch_expand(&rule->cr.match, &fs.match);
3844 fs.table_id = rule->table_id;
3845 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3846 fs.priority = rule->cr.priority;
3847 fs.idle_age = age_secs(now - used);
3848 fs.hard_age = age_secs(now - modified);
3849 fs.ofpacts = actions->ofpacts;
3850 fs.ofpacts_len = actions->ofpacts_len;
3853 ofputil_append_flow_stats_reply(&fs, &replies);
3856 rule_collection_unref(&rules);
3857 rule_collection_destroy(&rules);
3859 ofconn_send_replies(ofconn, &replies);
3865 flow_stats_ds(struct rule *rule, struct ds *results)
3867 uint64_t packet_count, byte_count;
3868 const struct rule_actions *actions;
3869 long long int created, used;
3871 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3872 &byte_count, &used);
3874 ovs_mutex_lock(&rule->mutex);
3875 actions = rule_get_actions(rule);
3876 created = rule->created;
3877 ovs_mutex_unlock(&rule->mutex);
3879 if (rule->table_id != 0) {
3880 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3882 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3883 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3884 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3885 cls_rule_format(&rule->cr, results);
3886 ds_put_char(results, ',');
3888 ds_put_cstr(results, "actions=");
3889 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3891 ds_put_cstr(results, "\n");
3894 /* Adds a pretty-printed description of all flows to 'results', including
3895 * hidden flows (e.g., set up by in-band control). */
3897 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3899 struct oftable *table;
3901 OFPROTO_FOR_EACH_TABLE (table, p) {
3904 CLS_FOR_EACH (rule, cr, &table->cls) {
3905 flow_stats_ds(rule, results);
3910 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3911 * '*engine_type' and '*engine_id', respectively. */
3913 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3914 uint8_t *engine_type, uint8_t *engine_id)
3916 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3919 /* Checks the status change of CFM on 'ofport'.
3921 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
3923 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
3925 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3926 return (ofport && ofproto->ofproto_class->cfm_status_changed
3927 ? ofproto->ofproto_class->cfm_status_changed(ofport)
3931 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3932 * Returns 0 if the port's CFM status was successfully stored into
3933 * '*status'. Returns positive errno if the port did not have CFM
3936 * The caller must provide and own '*status', and must free 'status->rmps'.
3937 * '*status' is indeterminate if the return value is non-zero. */
3939 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3940 struct cfm_status *status)
3942 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3943 return (ofport && ofproto->ofproto_class->get_cfm_status
3944 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
3949 handle_aggregate_stats_request(struct ofconn *ofconn,
3950 const struct ofp_header *oh)
3951 OVS_EXCLUDED(ofproto_mutex)
3953 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3954 struct ofputil_flow_stats_request request;
3955 struct ofputil_aggregate_stats stats;
3956 bool unknown_packets, unknown_bytes;
3957 struct rule_criteria criteria;
3958 struct rule_collection rules;
3959 struct ofpbuf *reply;
3963 error = ofputil_decode_flow_stats_request(&request, oh);
3968 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3969 request.cookie, request.cookie_mask,
3970 request.out_port, request.out_group);
3972 ovs_mutex_lock(&ofproto_mutex);
3973 error = collect_rules_loose(ofproto, &criteria, &rules);
3974 rule_criteria_destroy(&criteria);
3976 rule_collection_ref(&rules);
3978 ovs_mutex_unlock(&ofproto_mutex);
3984 memset(&stats, 0, sizeof stats);
3985 unknown_packets = unknown_bytes = false;
3986 for (i = 0; i < rules.n; i++) {
3987 struct rule *rule = rules.rules[i];
3988 uint64_t packet_count;
3989 uint64_t byte_count;
3992 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3993 &byte_count, &used);
3995 if (packet_count == UINT64_MAX) {
3996 unknown_packets = true;
3998 stats.packet_count += packet_count;
4001 if (byte_count == UINT64_MAX) {
4002 unknown_bytes = true;
4004 stats.byte_count += byte_count;
4009 if (unknown_packets) {
4010 stats.packet_count = UINT64_MAX;
4012 if (unknown_bytes) {
4013 stats.byte_count = UINT64_MAX;
4016 rule_collection_unref(&rules);
4017 rule_collection_destroy(&rules);
4019 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4020 ofconn_send_reply(ofconn, reply);
4025 struct queue_stats_cbdata {
4026 struct ofport *ofport;
4027 struct ovs_list replies;
4032 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4033 const struct netdev_queue_stats *stats)
4035 struct ofputil_queue_stats oqs;
4037 oqs.port_no = cbdata->ofport->pp.port_no;
4038 oqs.queue_id = queue_id;
4039 oqs.tx_bytes = stats->tx_bytes;
4040 oqs.tx_packets = stats->tx_packets;
4041 oqs.tx_errors = stats->tx_errors;
4042 if (stats->created != LLONG_MIN) {
4043 calc_duration(stats->created, cbdata->now,
4044 &oqs.duration_sec, &oqs.duration_nsec);
4046 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4048 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4052 handle_queue_stats_dump_cb(uint32_t queue_id,
4053 struct netdev_queue_stats *stats,
4056 struct queue_stats_cbdata *cbdata = cbdata_;
4058 put_queue_stats(cbdata, queue_id, stats);
4062 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4063 struct queue_stats_cbdata *cbdata)
4065 cbdata->ofport = port;
4066 if (queue_id == OFPQ_ALL) {
4067 netdev_dump_queue_stats(port->netdev,
4068 handle_queue_stats_dump_cb, cbdata);
4070 struct netdev_queue_stats stats;
4072 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4073 put_queue_stats(cbdata, queue_id, &stats);
4075 return OFPERR_OFPQOFC_BAD_QUEUE;
4082 handle_queue_stats_request(struct ofconn *ofconn,
4083 const struct ofp_header *rq)
4085 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4086 struct queue_stats_cbdata cbdata;
4087 struct ofport *port;
4089 struct ofputil_queue_stats_request oqsr;
4091 COVERAGE_INC(ofproto_queue_req);
4093 ofpmp_init(&cbdata.replies, rq);
4094 cbdata.now = time_msec();
4096 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4101 if (oqsr.port_no == OFPP_ANY) {
4102 error = OFPERR_OFPQOFC_BAD_QUEUE;
4103 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4104 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4109 port = ofproto_get_port(ofproto, oqsr.port_no);
4111 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4112 : OFPERR_OFPQOFC_BAD_PORT);
4115 ofconn_send_replies(ofconn, &cbdata.replies);
4117 ofpbuf_list_delete(&cbdata.replies);
4124 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4125 OVS_REQUIRES(ofproto_mutex)
4127 enum ofperr error = 0;
4128 struct rule_collection rules;
4129 unsigned int count = classifier_count(&table->cls) + extra_space;
4130 unsigned int max_flows = table->max_flows;
4132 rule_collection_init(&rules);
4134 while (count-- > max_flows) {
4137 if (!choose_rule_to_evict(table, &rule)) {
4138 error = OFPERR_OFPFMFC_TABLE_FULL;
4141 eviction_group_remove_rule(rule);
4142 rule_collection_add(&rules, rule);
4145 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4146 rule_collection_destroy(&rules);
4152 is_conjunction(const struct ofpact *ofpacts, size_t ofpacts_len)
4154 return ofpacts_len > 0 && ofpacts->type == OFPACT_CONJUNCTION;
4158 get_conjunctions(const struct ofputil_flow_mod *fm,
4159 struct cls_conjunction **conjsp, size_t *n_conjsp)
4160 OVS_REQUIRES(ofproto_mutex)
4162 struct cls_conjunction *conjs = NULL;
4165 if (is_conjunction(fm->ofpacts, fm->ofpacts_len)) {
4166 const struct ofpact *ofpact;
4170 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4174 conjs = xzalloc(n_conjs * sizeof *conjs);
4176 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4177 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4178 conjs[i].clause = oc->clause;
4179 conjs[i].n_clauses = oc->n_clauses;
4180 conjs[i].id = oc->id;
4186 *n_conjsp = n_conjs;
4190 set_conjunctions(struct rule *rule, const struct cls_conjunction *conjs,
4192 OVS_REQUIRES(ofproto_mutex)
4194 struct cls_rule *cr = CONST_CAST(struct cls_rule *, &rule->cr);
4196 cls_rule_set_conjunctions(cr, conjs, n_conjs);
4199 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4200 * in which no matching flow already exists in the flow table.
4202 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4203 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4204 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4205 * initiated now but may be retried later.
4207 * The caller retains ownership of 'fm->ofpacts'.
4209 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4212 add_flow(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4213 const struct flow_mod_requester *req)
4214 OVS_REQUIRES(ofproto_mutex)
4216 const struct rule_actions *actions;
4217 struct oftable *table;
4223 if (!check_table_id(ofproto, fm->table_id)) {
4224 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4229 if (fm->table_id == 0xff) {
4230 if (ofproto->ofproto_class->rule_choose_table) {
4231 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4237 ovs_assert(table_id < ofproto->n_tables);
4241 } else if (fm->table_id < ofproto->n_tables) {
4242 table_id = fm->table_id;
4244 return OFPERR_OFPBRC_BAD_TABLE_ID;
4247 table = &ofproto->tables[table_id];
4248 if (table->flags & OFTABLE_READONLY
4249 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4250 return OFPERR_OFPBRC_EPERM;
4253 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4254 if (!match_has_default_hidden_fields(&fm->match)) {
4255 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4256 "non-default values to hidden fields", ofproto->name);
4257 return OFPERR_OFPBRC_EPERM;
4261 cls_rule_init(&cr, &fm->match, fm->priority);
4263 /* Transform "add" into "modify" if there's an existing identical flow. */
4264 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4266 struct rule_collection rules;
4268 cls_rule_destroy(&cr);
4270 rule_collection_init(&rules);
4271 rule_collection_add(&rules, rule);
4272 fm->modify_cookie = true;
4273 error = modify_flows__(ofproto, fm, &rules, req);
4274 rule_collection_destroy(&rules);
4279 /* Check for overlap, if requested. */
4280 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4281 if (classifier_rule_overlaps(&table->cls, &cr)) {
4282 cls_rule_destroy(&cr);
4283 return OFPERR_OFPFMFC_OVERLAP;
4287 /* If necessary, evict an existing rule to clear out space. */
4288 error = evict_rules_from_table(table, 1);
4290 cls_rule_destroy(&cr);
4294 /* Allocate new rule. */
4295 rule = ofproto->ofproto_class->rule_alloc();
4297 cls_rule_destroy(&cr);
4298 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4299 ofproto->name, ovs_strerror(error));
4303 /* Initialize base state. */
4304 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4305 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4306 ovs_refcount_init(&rule->ref_count);
4307 rule->flow_cookie = fm->new_cookie;
4308 rule->created = rule->modified = time_msec();
4310 ovs_mutex_init(&rule->mutex);
4311 ovs_mutex_lock(&rule->mutex);
4312 rule->idle_timeout = fm->idle_timeout;
4313 rule->hard_timeout = fm->hard_timeout;
4314 rule->importance = fm->importance;
4315 ovs_mutex_unlock(&rule->mutex);
4317 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4318 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4319 actions = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4320 ovsrcu_set(&rule->actions, actions);
4321 list_init(&rule->meter_list_node);
4322 rule->eviction_group = NULL;
4323 list_init(&rule->expirable);
4324 rule->monitor_flags = 0;
4325 rule->add_seqno = 0;
4326 rule->modify_seqno = 0;
4328 /* Construct rule, initializing derived state. */
4329 error = ofproto->ofproto_class->rule_construct(rule);
4331 ofproto_rule_destroy__(rule);
4335 if (fm->hard_timeout || fm->idle_timeout) {
4336 list_insert(&ofproto->expirable, &rule->expirable);
4338 cookies_insert(ofproto, rule);
4339 eviction_group_add_rule(rule);
4340 if (actions->has_meter) {
4341 meter_insert_rule(rule);
4344 classifier_defer(&table->cls);
4346 struct cls_conjunction *conjs;
4348 get_conjunctions(fm, &conjs, &n_conjs);
4349 classifier_insert(&table->cls, &rule->cr, conjs, n_conjs);
4352 error = ofproto->ofproto_class->rule_insert(rule);
4354 oftable_remove_rule(rule);
4355 ofproto_rule_unref(rule);
4358 classifier_publish(&table->cls);
4360 learned_cookies_inc(ofproto, actions);
4362 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
4363 if (ofproto->vlan_bitmap) {
4364 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4365 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4366 bitmap_set1(ofproto->vlan_bitmap, vid);
4367 ofproto->vlans_changed = true;
4370 ofproto->vlans_changed = true;
4374 ofmonitor_report(ofproto->connmgr, rule, NXFME_ADDED, 0,
4375 req ? req->ofconn : NULL, req ? req->xid : 0, NULL);
4377 return req ? send_buffered_packet(req->ofconn, fm->buffer_id, rule) : 0;
4380 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4382 /* Modifies the rules listed in 'rules', changing their actions to match those
4385 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4388 * Returns 0 on success, otherwise an OpenFlow error code. */
4390 modify_flows__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4391 const struct rule_collection *rules,
4392 const struct flow_mod_requester *req)
4393 OVS_REQUIRES(ofproto_mutex)
4395 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4396 enum nx_flow_update_event event;
4399 if (ofproto->ofproto_class->rule_premodify_actions) {
4400 for (i = 0; i < rules->n; i++) {
4401 struct rule *rule = rules->rules[i];
4404 error = ofproto->ofproto_class->rule_premodify_actions(
4405 rule, fm->ofpacts, fm->ofpacts_len);
4412 event = fm->command == OFPFC_ADD ? NXFME_ADDED : NXFME_MODIFIED;
4413 for (i = 0; i < rules->n; i++) {
4414 struct rule *rule = rules->rules[i];
4416 /* 'fm' says that */
4417 bool change_cookie = (fm->modify_cookie
4418 && fm->new_cookie != OVS_BE64_MAX
4419 && fm->new_cookie != rule->flow_cookie);
4421 const struct rule_actions *actions = rule_get_actions(rule);
4422 bool change_actions = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4424 actions->ofpacts_len);
4426 bool reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4428 long long int now = time_msec();
4430 if (change_cookie) {
4431 cookies_remove(ofproto, rule);
4434 ovs_mutex_lock(&rule->mutex);
4435 if (fm->command == OFPFC_ADD) {
4436 rule->idle_timeout = fm->idle_timeout;
4437 rule->hard_timeout = fm->hard_timeout;
4438 rule->importance = fm->importance;
4439 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4440 rule->created = now;
4442 if (change_cookie) {
4443 rule->flow_cookie = fm->new_cookie;
4445 rule->modified = now;
4446 ovs_mutex_unlock(&rule->mutex);
4448 if (change_cookie) {
4449 cookies_insert(ofproto, rule);
4451 if (fm->command == OFPFC_ADD) {
4452 if (fm->idle_timeout || fm->hard_timeout || fm->importance) {
4453 if (!rule->eviction_group) {
4454 eviction_group_add_rule(rule);
4457 eviction_group_remove_rule(rule);
4461 if (change_actions) {
4462 /* We have to change the actions. The rule's conjunctive match set
4463 * is a function of its actions, so we need to update that too. The
4464 * conjunctive match set is used in the lookup process to figure
4465 * which (if any) collection of conjunctive sets the packet matches
4466 * with. However, a rule with conjunction actions is never to be
4467 * returned as a classifier lookup result. To make sure a rule with
4468 * conjunction actions is not returned as a lookup result, we update
4469 * them in a carefully chosen order:
4471 * - If we're adding a conjunctive match set where there wasn't one
4472 * before, we have to make the conjunctive match set available to
4473 * lookups before the rule's actions are changed, as otherwise
4474 * rule with a conjunction action could be returned as a lookup
4477 * - To clear some nonempty conjunctive set, we set the rule's
4478 * actions first, so that a lookup can't return a rule with
4479 * conjunction actions.
4481 * - Otherwise, order doesn't matter for changing one nonempty
4482 * conjunctive match set to some other nonempty set, since the
4483 * rule's actions are not seen by the classifier, and hence don't
4484 * matter either before or after the change. */
4485 struct cls_conjunction *conjs;
4487 get_conjunctions(fm, &conjs, &n_conjs);
4490 set_conjunctions(rule, conjs, n_conjs);
4492 ovsrcu_set(&rule->actions, rule_actions_create(fm->ofpacts,
4495 set_conjunctions(rule, conjs, n_conjs);
4501 if (change_actions || reset_counters) {
4502 ofproto->ofproto_class->rule_modify_actions(rule, reset_counters);
4505 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4506 ofmonitor_report(ofproto->connmgr, rule, event, 0,
4507 req ? req->ofconn : NULL, req ? req->xid : 0,
4508 change_actions ? actions : NULL);
4511 if (change_actions) {
4512 learned_cookies_inc(ofproto, rule_get_actions(rule));
4513 learned_cookies_dec(ofproto, actions, &dead_cookies);
4514 rule_actions_destroy(actions);
4517 learned_cookies_flush(ofproto, &dead_cookies);
4519 if (fm->buffer_id != UINT32_MAX && req) {
4520 return send_buffered_packet(req->ofconn, fm->buffer_id,
4528 modify_flows_add(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4529 const struct flow_mod_requester *req)
4530 OVS_REQUIRES(ofproto_mutex)
4532 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4535 return add_flow(ofproto, fm, req);
4538 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4541 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4544 modify_flows_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4545 const struct flow_mod_requester *req)
4546 OVS_REQUIRES(ofproto_mutex)
4548 struct rule_criteria criteria;
4549 struct rule_collection rules;
4552 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4553 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4554 rule_criteria_require_rw(&criteria,
4555 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4556 error = collect_rules_loose(ofproto, &criteria, &rules);
4557 rule_criteria_destroy(&criteria);
4560 error = (rules.n > 0
4561 ? modify_flows__(ofproto, fm, &rules, req)
4562 : modify_flows_add(ofproto, fm, req));
4565 rule_collection_destroy(&rules);
4570 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4571 * code on failure. */
4573 modify_flow_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4574 const struct flow_mod_requester *req)
4575 OVS_REQUIRES(ofproto_mutex)
4577 struct rule_criteria criteria;
4578 struct rule_collection rules;
4581 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4582 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4583 rule_criteria_require_rw(&criteria,
4584 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4585 error = collect_rules_strict(ofproto, &criteria, &rules);
4586 rule_criteria_destroy(&criteria);
4590 error = modify_flows_add(ofproto, fm, req);
4591 } else if (rules.n == 1) {
4592 error = modify_flows__(ofproto, fm, &rules, req);
4596 rule_collection_destroy(&rules);
4601 /* OFPFC_DELETE implementation. */
4603 /* Deletes the rules listed in 'rules'. */
4605 delete_flows__(const struct rule_collection *rules,
4606 enum ofp_flow_removed_reason reason,
4607 const struct flow_mod_requester *req)
4608 OVS_REQUIRES(ofproto_mutex)
4611 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4612 struct ofproto *ofproto = rules->rules[0]->ofproto;
4613 struct rule *rule, *next;
4616 for (i = 0, next = rules->rules[0];
4617 rule = next, next = (++i < rules->n) ? rules->rules[i] : NULL,
4619 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
4620 uint8_t next_table = next ? next->table_id : UINT8_MAX;
4622 ofproto_rule_send_removed(rule, reason);
4624 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4625 req ? req->ofconn : NULL, req ? req->xid : 0,
4628 if (next_table == rule->table_id) {
4629 classifier_defer(cls);
4631 classifier_remove(cls, &rule->cr);
4632 if (next_table != rule->table_id) {
4633 classifier_publish(cls);
4635 ofproto_rule_remove__(ofproto, rule);
4637 ofproto->ofproto_class->rule_delete(rule);
4639 learned_cookies_dec(ofproto, rule_get_actions(rule),
4642 learned_cookies_flush(ofproto, &dead_cookies);
4643 ofmonitor_flush(ofproto->connmgr);
4647 /* Implements OFPFC_DELETE. */
4649 delete_flows_loose(struct ofproto *ofproto,
4650 const struct ofputil_flow_mod *fm,
4651 const struct flow_mod_requester *req)
4652 OVS_REQUIRES(ofproto_mutex)
4654 struct rule_criteria criteria;
4655 struct rule_collection rules;
4658 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4659 fm->cookie, fm->cookie_mask,
4660 fm->out_port, fm->out_group);
4661 rule_criteria_require_rw(&criteria,
4662 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4663 error = collect_rules_loose(ofproto, &criteria, &rules);
4664 rule_criteria_destroy(&criteria);
4667 delete_flows__(&rules, fm->delete_reason, req);
4669 rule_collection_destroy(&rules);
4674 /* Implements OFPFC_DELETE_STRICT. */
4676 delete_flow_strict(struct ofproto *ofproto, const struct ofputil_flow_mod *fm,
4677 const struct flow_mod_requester *req)
4678 OVS_REQUIRES(ofproto_mutex)
4680 struct rule_criteria criteria;
4681 struct rule_collection rules;
4684 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4685 fm->cookie, fm->cookie_mask,
4686 fm->out_port, fm->out_group);
4687 rule_criteria_require_rw(&criteria,
4688 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4689 error = collect_rules_strict(ofproto, &criteria, &rules);
4690 rule_criteria_destroy(&criteria);
4693 delete_flows__(&rules, fm->delete_reason, req);
4695 rule_collection_destroy(&rules);
4701 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4702 OVS_REQUIRES(ofproto_mutex)
4704 struct ofputil_flow_removed fr;
4707 if (rule_is_hidden(rule) ||
4708 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4712 minimatch_expand(&rule->cr.match, &fr.match);
4713 fr.priority = rule->cr.priority;
4714 fr.cookie = rule->flow_cookie;
4716 fr.table_id = rule->table_id;
4717 calc_duration(rule->created, time_msec(),
4718 &fr.duration_sec, &fr.duration_nsec);
4719 ovs_mutex_lock(&rule->mutex);
4720 fr.idle_timeout = rule->idle_timeout;
4721 fr.hard_timeout = rule->hard_timeout;
4722 ovs_mutex_unlock(&rule->mutex);
4723 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4724 &fr.byte_count, &used);
4726 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4729 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4730 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4733 * ofproto implementation ->run() functions should use this function to expire
4734 * OpenFlow flows. */
4736 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4737 OVS_REQUIRES(ofproto_mutex)
4739 struct rule_collection rules;
4741 rules.rules = rules.stub;
4743 rules.stub[0] = rule;
4744 delete_flows__(&rules, reason, NULL);
4747 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4748 * means "infinite". */
4750 reduce_timeout(uint16_t max, uint16_t *timeout)
4752 if (max && (!*timeout || *timeout > max)) {
4757 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4758 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4759 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4761 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4763 ofproto_rule_reduce_timeouts(struct rule *rule,
4764 uint16_t idle_timeout, uint16_t hard_timeout)
4765 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4767 if (!idle_timeout && !hard_timeout) {
4771 ovs_mutex_lock(&ofproto_mutex);
4772 if (list_is_empty(&rule->expirable)) {
4773 list_insert(&rule->ofproto->expirable, &rule->expirable);
4775 ovs_mutex_unlock(&ofproto_mutex);
4777 ovs_mutex_lock(&rule->mutex);
4778 reduce_timeout(idle_timeout, &rule->idle_timeout);
4779 reduce_timeout(hard_timeout, &rule->hard_timeout);
4780 ovs_mutex_unlock(&rule->mutex);
4784 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4785 OVS_EXCLUDED(ofproto_mutex)
4787 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4788 struct ofputil_flow_mod fm;
4789 uint64_t ofpacts_stub[1024 / 8];
4790 struct ofpbuf ofpacts;
4793 error = reject_slave_controller(ofconn);
4798 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4799 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4801 u16_to_ofp(ofproto->max_ports),
4804 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4807 struct flow_mod_requester req;
4809 req.ofconn = ofconn;
4811 error = handle_flow_mod__(ofproto, &fm, &req);
4814 goto exit_free_ofpacts;
4817 ofconn_report_flow_mod(ofconn, fm.command);
4820 ofpbuf_uninit(&ofpacts);
4826 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4827 const struct flow_mod_requester *req)
4828 OVS_EXCLUDED(ofproto_mutex)
4832 ovs_mutex_lock(&ofproto_mutex);
4833 switch (fm->command) {
4835 error = add_flow(ofproto, fm, req);
4839 error = modify_flows_loose(ofproto, fm, req);
4842 case OFPFC_MODIFY_STRICT:
4843 error = modify_flow_strict(ofproto, fm, req);
4847 error = delete_flows_loose(ofproto, fm, req);
4850 case OFPFC_DELETE_STRICT:
4851 error = delete_flow_strict(ofproto, fm, req);
4855 if (fm->command > 0xff) {
4856 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4857 "flow_mod_table_id extension is not enabled",
4860 error = OFPERR_OFPFMFC_BAD_COMMAND;
4863 ofmonitor_flush(ofproto->connmgr);
4864 ovs_mutex_unlock(&ofproto_mutex);
4866 run_rule_executes(ofproto);
4871 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4873 struct ofputil_role_request request;
4874 struct ofputil_role_request reply;
4878 error = ofputil_decode_role_message(oh, &request);
4883 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4884 if (request.have_generation_id
4885 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4886 return OFPERR_OFPRRFC_STALE;
4889 ofconn_set_role(ofconn, request.role);
4892 reply.role = ofconn_get_role(ofconn);
4893 reply.have_generation_id = ofconn_get_master_election_id(
4894 ofconn, &reply.generation_id);
4895 buf = ofputil_encode_role_reply(oh, &reply);
4896 ofconn_send_reply(ofconn, buf);
4902 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4903 const struct ofp_header *oh)
4905 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4906 enum ofputil_protocol cur, next;
4908 cur = ofconn_get_protocol(ofconn);
4909 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4910 ofconn_set_protocol(ofconn, next);
4916 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4918 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4919 enum ofputil_protocol cur, next;
4920 enum ofputil_protocol next_base;
4922 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4924 return OFPERR_OFPBRC_EPERM;
4927 cur = ofconn_get_protocol(ofconn);
4928 next = ofputil_protocol_set_base(cur, next_base);
4929 ofconn_set_protocol(ofconn, next);
4935 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4936 const struct ofp_header *oh)
4938 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4941 format = ntohl(msg->format);
4942 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4943 return OFPERR_OFPBRC_EPERM;
4946 ofconn_set_packet_in_format(ofconn, format);
4951 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4953 const struct nx_async_config *msg = ofpmsg_body(oh);
4954 uint32_t master[OAM_N_TYPES];
4955 uint32_t slave[OAM_N_TYPES];
4957 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4958 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4959 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4961 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4962 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4963 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4965 ofconn_set_async_config(ofconn, master, slave);
4966 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4967 !ofconn_get_miss_send_len(ofconn)) {
4968 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4975 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4978 uint32_t master[OAM_N_TYPES];
4979 uint32_t slave[OAM_N_TYPES];
4980 struct nx_async_config *msg;
4982 ofconn_get_async_config(ofconn, master, slave);
4983 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4984 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4986 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4987 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4988 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4990 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4991 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4992 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4994 ofconn_send_reply(ofconn, buf);
5000 handle_nxt_set_controller_id(struct ofconn *ofconn,
5001 const struct ofp_header *oh)
5003 const struct nx_controller_id *nci = ofpmsg_body(oh);
5005 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5006 return OFPERR_NXBRC_MUST_BE_ZERO;
5009 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5014 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5018 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5019 ? OFPRAW_OFPT10_BARRIER_REPLY
5020 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5021 ofconn_send_reply(ofconn, buf);
5026 ofproto_compose_flow_refresh_update(const struct rule *rule,
5027 enum nx_flow_monitor_flags flags,
5028 struct ovs_list *msgs)
5029 OVS_REQUIRES(ofproto_mutex)
5031 const struct rule_actions *actions;
5032 struct ofputil_flow_update fu;
5035 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5036 ? NXFME_ADDED : NXFME_MODIFIED);
5038 ovs_mutex_lock(&rule->mutex);
5039 fu.idle_timeout = rule->idle_timeout;
5040 fu.hard_timeout = rule->hard_timeout;
5041 ovs_mutex_unlock(&rule->mutex);
5042 fu.table_id = rule->table_id;
5043 fu.cookie = rule->flow_cookie;
5044 minimatch_expand(&rule->cr.match, &match);
5046 fu.priority = rule->cr.priority;
5048 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5049 fu.ofpacts = actions ? actions->ofpacts : NULL;
5050 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5052 if (list_is_empty(msgs)) {
5053 ofputil_start_flow_update(msgs);
5055 ofputil_append_flow_update(&fu, msgs);
5059 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5060 struct ovs_list *msgs)
5061 OVS_REQUIRES(ofproto_mutex)
5065 for (i = 0; i < rules->n; i++) {
5066 struct rule *rule = rules->rules[i];
5067 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5068 rule->monitor_flags = 0;
5070 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5075 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5076 struct rule *rule, uint64_t seqno,
5077 struct rule_collection *rules)
5078 OVS_REQUIRES(ofproto_mutex)
5080 enum nx_flow_monitor_flags update;
5082 if (rule_is_hidden(rule)) {
5086 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5091 if (rule->add_seqno > seqno) {
5092 update = NXFMF_ADD | NXFMF_MODIFY;
5093 } else if (rule->modify_seqno > seqno) {
5094 update = NXFMF_MODIFY;
5099 if (!(m->flags & update)) {
5103 update = NXFMF_INITIAL;
5106 if (!rule->monitor_flags) {
5107 rule_collection_add(rules, rule);
5109 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5113 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5115 struct rule_collection *rules)
5116 OVS_REQUIRES(ofproto_mutex)
5118 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5119 const struct oftable *table;
5120 struct cls_rule target;
5122 cls_rule_init_from_minimatch(&target, &m->match, 0);
5123 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5126 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5127 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5130 cls_rule_destroy(&target);
5134 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5135 struct rule_collection *rules)
5136 OVS_REQUIRES(ofproto_mutex)
5138 if (m->flags & NXFMF_INITIAL) {
5139 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5144 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5145 uint64_t seqno, struct rule_collection *rules)
5146 OVS_REQUIRES(ofproto_mutex)
5148 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5152 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5153 OVS_REQUIRES(ofproto_mutex)
5155 struct ofmonitor *m;
5158 m = ofmonitor_lookup(ofconn, id);
5160 ofmonitor_destroy(m);
5163 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5170 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5171 OVS_EXCLUDED(ofproto_mutex)
5173 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5174 struct ofmonitor **monitors;
5175 size_t n_monitors, allocated_monitors;
5176 struct rule_collection rules;
5177 struct ovs_list replies;
5182 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5184 n_monitors = allocated_monitors = 0;
5186 ovs_mutex_lock(&ofproto_mutex);
5188 struct ofputil_flow_monitor_request request;
5189 struct ofmonitor *m;
5192 retval = ofputil_decode_flow_monitor_request(&request, &b);
5193 if (retval == EOF) {
5195 } else if (retval) {
5200 if (request.table_id != 0xff
5201 && request.table_id >= ofproto->n_tables) {
5202 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5206 error = ofmonitor_create(&request, ofconn, &m);
5211 if (n_monitors >= allocated_monitors) {
5212 monitors = x2nrealloc(monitors, &allocated_monitors,
5215 monitors[n_monitors++] = m;
5218 rule_collection_init(&rules);
5219 for (i = 0; i < n_monitors; i++) {
5220 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5223 ofpmp_init(&replies, oh);
5224 ofmonitor_compose_refresh_updates(&rules, &replies);
5225 ovs_mutex_unlock(&ofproto_mutex);
5227 rule_collection_destroy(&rules);
5229 ofconn_send_replies(ofconn, &replies);
5235 for (i = 0; i < n_monitors; i++) {
5236 ofmonitor_destroy(monitors[i]);
5239 ovs_mutex_unlock(&ofproto_mutex);
5245 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5246 OVS_EXCLUDED(ofproto_mutex)
5251 id = ofputil_decode_flow_monitor_cancel(oh);
5253 ovs_mutex_lock(&ofproto_mutex);
5254 error = flow_monitor_delete(ofconn, id);
5255 ovs_mutex_unlock(&ofproto_mutex);
5260 /* Meters implementation.
5262 * Meter table entry, indexed by the OpenFlow meter_id.
5263 * 'created' is used to compute the duration for meter stats.
5264 * 'list rules' is needed so that we can delete the dependent rules when the
5265 * meter table entry is deleted.
5266 * 'provider_meter_id' is for the provider's private use.
5269 long long int created; /* Time created. */
5270 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5271 ofproto_meter_id provider_meter_id;
5272 uint16_t flags; /* Meter flags. */
5273 uint16_t n_bands; /* Number of meter bands. */
5274 struct ofputil_meter_band *bands;
5278 * This is used in instruction validation at flow set-up time,
5279 * as flows may not use non-existing meters.
5280 * Return value of UINT32_MAX signifies an invalid meter.
5283 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5285 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5286 const struct meter *meter = ofproto->meters[of_meter_id];
5288 return meter->provider_meter_id.uint32;
5294 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5297 meter_insert_rule(struct rule *rule)
5299 const struct rule_actions *a = rule_get_actions(rule);
5300 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5301 struct meter *meter = rule->ofproto->meters[meter_id];
5303 list_insert(&meter->rules, &rule->meter_list_node);
5307 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5311 meter->flags = config->flags;
5312 meter->n_bands = config->n_bands;
5313 meter->bands = xmemdup(config->bands,
5314 config->n_bands * sizeof *meter->bands);
5317 static struct meter *
5318 meter_create(const struct ofputil_meter_config *config,
5319 ofproto_meter_id provider_meter_id)
5321 struct meter *meter;
5323 meter = xzalloc(sizeof *meter);
5324 meter->provider_meter_id = provider_meter_id;
5325 meter->created = time_msec();
5326 list_init(&meter->rules);
5328 meter_update(meter, config);
5334 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5335 OVS_REQUIRES(ofproto_mutex)
5338 for (mid = first; mid <= last; ++mid) {
5339 struct meter *meter = ofproto->meters[mid];
5341 ofproto->meters[mid] = NULL;
5342 ofproto->ofproto_class->meter_del(ofproto,
5343 meter->provider_meter_id);
5351 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5353 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5354 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5358 return OFPERR_OFPMMFC_METER_EXISTS;
5361 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5364 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5365 *meterp = meter_create(&mm->meter, provider_meter_id);
5371 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5373 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5375 uint32_t provider_meter_id;
5378 return OFPERR_OFPMMFC_UNKNOWN_METER;
5381 provider_meter_id = meter->provider_meter_id.uint32;
5382 error = ofproto->ofproto_class->meter_set(ofproto,
5383 &meter->provider_meter_id,
5385 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5387 meter_update(meter, &mm->meter);
5393 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5394 OVS_EXCLUDED(ofproto_mutex)
5396 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5397 uint32_t meter_id = mm->meter.meter_id;
5398 struct rule_collection rules;
5399 enum ofperr error = 0;
5400 uint32_t first, last;
5402 if (meter_id == OFPM13_ALL) {
5404 last = ofproto->meter_features.max_meters;
5406 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5409 first = last = meter_id;
5412 /* First delete the rules that use this meter. If any of those rules are
5413 * currently being modified, postpone the whole operation until later. */
5414 rule_collection_init(&rules);
5415 ovs_mutex_lock(&ofproto_mutex);
5416 for (meter_id = first; meter_id <= last; ++meter_id) {
5417 struct meter *meter = ofproto->meters[meter_id];
5418 if (meter && !list_is_empty(&meter->rules)) {
5421 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5422 rule_collection_add(&rules, rule);
5426 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5428 /* Delete the meters. */
5429 meter_delete(ofproto, first, last);
5431 ovs_mutex_unlock(&ofproto_mutex);
5432 rule_collection_destroy(&rules);
5438 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5440 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5441 struct ofputil_meter_mod mm;
5442 uint64_t bands_stub[256 / 8];
5443 struct ofpbuf bands;
5447 error = reject_slave_controller(ofconn);
5452 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5454 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5456 goto exit_free_bands;
5459 meter_id = mm.meter.meter_id;
5461 if (mm.command != OFPMC13_DELETE) {
5462 /* Fails also when meters are not implemented by the provider. */
5463 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5464 error = OFPERR_OFPMMFC_INVALID_METER;
5465 goto exit_free_bands;
5466 } else if (meter_id > ofproto->meter_features.max_meters) {
5467 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5468 goto exit_free_bands;
5470 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5471 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5472 goto exit_free_bands;
5476 switch (mm.command) {
5478 error = handle_add_meter(ofproto, &mm);
5481 case OFPMC13_MODIFY:
5482 error = handle_modify_meter(ofproto, &mm);
5485 case OFPMC13_DELETE:
5486 error = handle_delete_meter(ofconn, &mm);
5490 error = OFPERR_OFPMMFC_BAD_COMMAND;
5495 ofpbuf_uninit(&bands);
5500 handle_meter_features_request(struct ofconn *ofconn,
5501 const struct ofp_header *request)
5503 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5504 struct ofputil_meter_features features;
5507 if (ofproto->ofproto_class->meter_get_features) {
5508 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5510 memset(&features, 0, sizeof features);
5512 b = ofputil_encode_meter_features_reply(&features, request);
5514 ofconn_send_reply(ofconn, b);
5519 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5522 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5523 struct ovs_list replies;
5524 uint64_t bands_stub[256 / 8];
5525 struct ofpbuf bands;
5526 uint32_t meter_id, first, last;
5528 ofputil_decode_meter_request(request, &meter_id);
5530 if (meter_id == OFPM13_ALL) {
5532 last = ofproto->meter_features.max_meters;
5534 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5535 !ofproto->meters[meter_id]) {
5536 return OFPERR_OFPMMFC_UNKNOWN_METER;
5538 first = last = meter_id;
5541 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5542 ofpmp_init(&replies, request);
5544 for (meter_id = first; meter_id <= last; ++meter_id) {
5545 struct meter *meter = ofproto->meters[meter_id];
5547 continue; /* Skip non-existing meters. */
5549 if (type == OFPTYPE_METER_STATS_REQUEST) {
5550 struct ofputil_meter_stats stats;
5552 stats.meter_id = meter_id;
5554 /* Provider sets the packet and byte counts, we do the rest. */
5555 stats.flow_count = list_size(&meter->rules);
5556 calc_duration(meter->created, time_msec(),
5557 &stats.duration_sec, &stats.duration_nsec);
5558 stats.n_bands = meter->n_bands;
5559 ofpbuf_clear(&bands);
5561 = ofpbuf_put_uninit(&bands,
5562 meter->n_bands * sizeof *stats.bands);
5564 if (!ofproto->ofproto_class->meter_get(ofproto,
5565 meter->provider_meter_id,
5567 ofputil_append_meter_stats(&replies, &stats);
5569 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5570 struct ofputil_meter_config config;
5572 config.meter_id = meter_id;
5573 config.flags = meter->flags;
5574 config.n_bands = meter->n_bands;
5575 config.bands = meter->bands;
5576 ofputil_append_meter_config(&replies, &config);
5580 ofconn_send_replies(ofconn, &replies);
5581 ofpbuf_uninit(&bands);
5586 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5587 struct ofgroup **group)
5588 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5590 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5591 hash_int(group_id, 0), &ofproto->groups) {
5592 if ((*group)->group_id == group_id) {
5600 /* If the group exists, this function increments the groups's reference count.
5602 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5603 * a reference to the group. */
5605 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5606 struct ofgroup **group)
5610 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5611 found = ofproto_group_lookup__(ofproto, group_id, group);
5613 ofproto_group_ref(*group);
5615 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5620 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5621 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5623 struct ofgroup *grp;
5625 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5626 hash_int(group_id, 0), &ofproto->groups) {
5627 if (grp->group_id == group_id) {
5635 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5636 OVS_EXCLUDED(ofproto->groups_rwlock)
5640 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5641 exists = ofproto_group_exists__(ofproto, group_id);
5642 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5648 group_get_ref_count(struct ofgroup *group)
5649 OVS_EXCLUDED(ofproto_mutex)
5651 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5652 struct rule_criteria criteria;
5653 struct rule_collection rules;
5658 match_init_catchall(&match);
5659 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5660 OFPP_ANY, group->group_id);
5661 ovs_mutex_lock(&ofproto_mutex);
5662 error = collect_rules_loose(ofproto, &criteria, &rules);
5663 ovs_mutex_unlock(&ofproto_mutex);
5664 rule_criteria_destroy(&criteria);
5666 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5668 rule_collection_destroy(&rules);
5673 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
5675 struct ofputil_group_stats ogs;
5676 const struct ofproto *ofproto = group->ofproto;
5677 long long int now = time_msec();
5680 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5682 /* Provider sets the packet and byte counts, we do the rest. */
5683 ogs.ref_count = group_get_ref_count(group);
5684 ogs.n_buckets = group->n_buckets;
5686 error = (ofproto->ofproto_class->group_get_stats
5687 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5690 ogs.packet_count = UINT64_MAX;
5691 ogs.byte_count = UINT64_MAX;
5692 memset(ogs.bucket_stats, 0xff,
5693 ogs.n_buckets * sizeof *ogs.bucket_stats);
5696 ogs.group_id = group->group_id;
5697 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5699 ofputil_append_group_stats(replies, &ogs);
5701 free(ogs.bucket_stats);
5705 handle_group_request(struct ofconn *ofconn,
5706 const struct ofp_header *request, uint32_t group_id,
5707 void (*cb)(struct ofgroup *, struct ovs_list *replies))
5709 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5710 struct ofgroup *group;
5711 struct ovs_list replies;
5713 ofpmp_init(&replies, request);
5714 if (group_id == OFPG_ALL) {
5715 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5716 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5717 cb(group, &replies);
5719 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5721 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5722 cb(group, &replies);
5723 ofproto_group_unref(group);
5726 ofconn_send_replies(ofconn, &replies);
5730 handle_group_stats_request(struct ofconn *ofconn,
5731 const struct ofp_header *request)
5736 error = ofputil_decode_group_stats_request(request, &group_id);
5741 handle_group_request(ofconn, request, group_id, append_group_stats);
5746 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
5748 struct ofputil_group_desc gds;
5750 gds.group_id = group->group_id;
5751 gds.type = group->type;
5752 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5756 handle_group_desc_stats_request(struct ofconn *ofconn,
5757 const struct ofp_header *request)
5759 handle_group_request(ofconn, request,
5760 ofputil_decode_group_desc_request(request),
5766 handle_group_features_stats_request(struct ofconn *ofconn,
5767 const struct ofp_header *request)
5769 struct ofproto *p = ofconn_get_ofproto(ofconn);
5772 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5774 ofconn_send_reply(ofconn, msg);
5781 handle_queue_get_config_request(struct ofconn *ofconn,
5782 const struct ofp_header *oh)
5784 struct ofproto *p = ofconn_get_ofproto(ofconn);
5785 struct netdev_queue_dump queue_dump;
5786 struct ofport *ofport;
5787 unsigned int queue_id;
5788 struct ofpbuf *reply;
5789 struct smap details;
5793 error = ofputil_decode_queue_get_config_request(oh, &request);
5798 ofport = ofproto_get_port(p, request);
5800 return OFPERR_OFPQOFC_BAD_PORT;
5803 reply = ofputil_encode_queue_get_config_reply(oh);
5805 smap_init(&details);
5806 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5807 struct ofputil_queue_config queue;
5809 /* None of the existing queues have compatible properties, so we
5810 * hard-code omitting min_rate and max_rate. */
5811 queue.queue_id = queue_id;
5812 queue.min_rate = UINT16_MAX;
5813 queue.max_rate = UINT16_MAX;
5814 ofputil_append_queue_get_config_reply(reply, &queue);
5816 smap_destroy(&details);
5818 ofconn_send_reply(ofconn, reply);
5824 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
5825 struct ofgroup **ofgroup)
5828 const long long int now = time_msec();
5830 if (gm->group_id > OFPG_MAX) {
5831 return OFPERR_OFPGMFC_INVALID_GROUP;
5833 if (gm->type > OFPGT11_FF) {
5834 return OFPERR_OFPGMFC_BAD_TYPE;
5837 *ofgroup = ofproto->ofproto_class->group_alloc();
5839 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5840 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5843 (*ofgroup)->ofproto = ofproto;
5844 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
5845 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
5846 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
5847 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
5848 ovs_refcount_init(&(*ofgroup)->ref_count);
5850 list_move(&(*ofgroup)->buckets, &gm->buckets);
5851 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
5852 list_size(&(*ofgroup)->buckets);
5854 /* Construct called BEFORE any locks are held. */
5855 error = ofproto->ofproto_class->group_construct(*ofgroup);
5857 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
5858 ofproto->ofproto_class->group_dealloc(*ofgroup);
5863 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
5864 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
5867 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5869 struct ofgroup *ofgroup;
5872 /* Allocate new group and initialize it. */
5873 error = init_group(ofproto, gm, &ofgroup);
5878 /* We wrlock as late as possible to minimize the time we jam any other
5879 * threads: No visible state changes before acquiring the lock. */
5880 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5882 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5883 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5887 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5888 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5893 /* Insert new group. */
5894 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5895 hash_int(ofgroup->group_id, 0));
5896 ofproto->n_groups[ofgroup->type]++;
5898 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5903 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5904 ofproto->ofproto_class->group_destruct(ofgroup);
5905 ofputil_bucket_list_destroy(&ofgroup->buckets);
5906 ofproto->ofproto_class->group_dealloc(ofgroup);
5911 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
5912 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
5913 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
5914 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
5917 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
5918 struct ofgroup *new_ofgroup,
5919 uint32_t command_bucket_id)
5921 struct ofputil_bucket *last = NULL;
5923 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
5924 /* Check here to ensure that a bucket corresponding to
5925 * command_bucket_id exists in the old bucket list.
5927 * The subsequent search of below of new_ofgroup covers
5928 * both buckets in the old bucket list and buckets added
5929 * by the insert buckets group mod message this function processes. */
5930 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
5931 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
5934 if (!list_is_empty(&new_ofgroup->buckets)) {
5935 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
5939 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
5941 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
5942 VLOG_WARN_RL(&rl, "Duplicate bucket id");
5943 return OFPERR_OFPGMFC_BUCKET_EXISTS;
5946 /* Rearrange list according to command_bucket_id */
5947 if (command_bucket_id == OFPG15_BUCKET_LAST) {
5948 struct ofputil_bucket *new_first;
5949 const struct ofputil_bucket *first;
5951 first = ofputil_bucket_list_front(&ofgroup->buckets);
5952 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
5955 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
5956 &new_ofgroup->buckets);
5957 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
5958 struct ofputil_bucket *after;
5960 /* Presence of bucket is checked above so after should never be NULL */
5961 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
5963 list_splice(after->list_node.next, new_ofgroup->buckets.next,
5964 last->list_node.next);
5970 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
5971 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
5972 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
5973 * and OFPG15_BUCKET_ALL are also honored. */
5975 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
5976 struct ofgroup *new_ofgroup,
5977 uint32_t command_bucket_id)
5979 const struct ofputil_bucket *skip = NULL;
5981 if (command_bucket_id == OFPG15_BUCKET_ALL) {
5985 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
5986 if (!list_is_empty(&ofgroup->buckets)) {
5987 skip = ofputil_bucket_list_front(&ofgroup->buckets);
5989 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
5990 if (!list_is_empty(&ofgroup->buckets)) {
5991 skip = ofputil_bucket_list_back(&ofgroup->buckets);
5994 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
5996 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6000 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6005 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6006 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6009 * Note that the group is re-created and then replaces the old group in
6010 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6011 * the xlate module hold a pointer to the group. */
6013 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6015 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6018 error = init_group(ofproto, gm, &new_ofgroup);
6023 retiring = new_ofgroup;
6025 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6026 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6027 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6031 /* Ofproto's group write lock is held now. */
6032 if (ofgroup->type != gm->type
6033 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6034 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6038 /* Manipulate bucket list for bucket commands */
6039 if (gm->command == OFPGC15_INSERT_BUCKET) {
6040 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6041 gm->command_bucket_id);
6042 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6043 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6044 gm->command_bucket_id);
6050 /* The group creation time does not change during modification. */
6051 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6052 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6054 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6060 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6061 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6062 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6063 hash_int(new_ofgroup->group_id, 0));
6064 if (ofgroup->type != new_ofgroup->type) {
6065 ofproto->n_groups[ofgroup->type]--;
6066 ofproto->n_groups[new_ofgroup->type]++;
6070 ofproto_group_unref(retiring);
6071 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6076 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6077 OVS_RELEASES(ofproto->groups_rwlock)
6080 struct ofputil_flow_mod fm;
6082 /* Delete all flow entries containing this group in a group action */
6083 match_init_catchall(&match);
6084 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6085 fm.delete_reason = OFPRR_GROUP_DELETE;
6086 fm.out_group = ofgroup->group_id;
6087 handle_flow_mod__(ofproto, &fm, NULL);
6089 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6090 /* No-one can find this group any more. */
6091 ofproto->n_groups[ofgroup->type]--;
6092 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6093 ofproto_group_unref(ofgroup);
6096 /* Implements OFPGC11_DELETE. */
6098 delete_group(struct ofproto *ofproto, uint32_t group_id)
6100 struct ofgroup *ofgroup;
6102 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6103 if (group_id == OFPG_ALL) {
6105 struct hmap_node *node = hmap_first(&ofproto->groups);
6109 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6110 delete_group__(ofproto, ofgroup);
6111 /* Lock for each node separately, so that we will not jam the
6112 * other threads for too long time. */
6113 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6116 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6117 hash_int(group_id, 0), &ofproto->groups) {
6118 if (ofgroup->group_id == group_id) {
6119 delete_group__(ofproto, ofgroup);
6124 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6128 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6130 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6131 struct ofputil_group_mod gm;
6134 error = reject_slave_controller(ofconn);
6139 error = ofputil_decode_group_mod(oh, &gm);
6144 switch (gm.command) {
6146 return add_group(ofproto, &gm);
6148 case OFPGC11_MODIFY:
6149 return modify_group(ofproto, &gm);
6151 case OFPGC11_DELETE:
6152 delete_group(ofproto, gm.group_id);
6155 case OFPGC15_INSERT_BUCKET:
6156 return modify_group(ofproto, &gm);
6158 case OFPGC15_REMOVE_BUCKET:
6159 return modify_group(ofproto, &gm);
6162 if (gm.command > OFPGC11_DELETE) {
6163 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6164 ofproto->name, gm.command);
6166 return OFPERR_OFPGMFC_BAD_COMMAND;
6170 enum ofputil_table_miss
6171 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6173 enum ofputil_table_miss value;
6175 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6180 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6182 if (!check_table_id(ofproto, tm->table_id)) {
6183 return OFPERR_OFPTMFC_BAD_TABLE;
6184 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6185 if (tm->table_id == OFPTT_ALL) {
6187 for (i = 0; i < ofproto->n_tables; i++) {
6188 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6192 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6200 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6202 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6203 struct ofputil_table_mod tm;
6206 error = reject_slave_controller(ofconn);
6211 error = ofputil_decode_table_mod(oh, &tm);
6216 return table_mod(ofproto, &tm);
6220 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6223 struct ofputil_bundle_ctrl_msg bctrl;
6225 struct ofputil_bundle_ctrl_msg reply;
6227 error = reject_slave_controller(ofconn);
6232 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6237 reply.bundle_id = bctrl.bundle_id;
6239 switch (bctrl.type) {
6240 case OFPBCT_OPEN_REQUEST:
6241 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6242 reply.type = OFPBCT_OPEN_REPLY;
6244 case OFPBCT_CLOSE_REQUEST:
6245 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6246 reply.type = OFPBCT_CLOSE_REPLY;;
6248 case OFPBCT_COMMIT_REQUEST:
6249 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6250 reply.type = OFPBCT_COMMIT_REPLY;
6252 case OFPBCT_DISCARD_REQUEST:
6253 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6254 reply.type = OFPBCT_DISCARD_REPLY;
6257 case OFPBCT_OPEN_REPLY:
6258 case OFPBCT_CLOSE_REPLY:
6259 case OFPBCT_COMMIT_REPLY:
6260 case OFPBCT_DISCARD_REPLY:
6261 return OFPERR_OFPBFC_BAD_TYPE;
6266 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6267 ofconn_send_reply(ofconn, buf);
6274 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6277 struct ofputil_bundle_add_msg badd;
6279 error = reject_slave_controller(ofconn);
6284 error = ofputil_decode_bundle_add(oh, &badd);
6289 return ofp_bundle_add_message(ofconn, &badd);
6293 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6294 OVS_EXCLUDED(ofproto_mutex)
6296 const struct ofp_header *oh = msg->data;
6300 error = ofptype_decode(&type, oh);
6304 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6305 && ofpmp_more(oh)) {
6306 /* We have no buffer implementation for multipart requests.
6307 * Report overflow for requests which consists of multiple
6309 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6313 /* OpenFlow requests. */
6314 case OFPTYPE_ECHO_REQUEST:
6315 return handle_echo_request(ofconn, oh);
6317 case OFPTYPE_FEATURES_REQUEST:
6318 return handle_features_request(ofconn, oh);
6320 case OFPTYPE_GET_CONFIG_REQUEST:
6321 return handle_get_config_request(ofconn, oh);
6323 case OFPTYPE_SET_CONFIG:
6324 return handle_set_config(ofconn, oh);
6326 case OFPTYPE_PACKET_OUT:
6327 return handle_packet_out(ofconn, oh);
6329 case OFPTYPE_PORT_MOD:
6330 return handle_port_mod(ofconn, oh);
6332 case OFPTYPE_FLOW_MOD:
6333 return handle_flow_mod(ofconn, oh);
6335 case OFPTYPE_GROUP_MOD:
6336 return handle_group_mod(ofconn, oh);
6338 case OFPTYPE_TABLE_MOD:
6339 return handle_table_mod(ofconn, oh);
6341 case OFPTYPE_METER_MOD:
6342 return handle_meter_mod(ofconn, oh);
6344 case OFPTYPE_BARRIER_REQUEST:
6345 return handle_barrier_request(ofconn, oh);
6347 case OFPTYPE_ROLE_REQUEST:
6348 return handle_role_request(ofconn, oh);
6350 /* OpenFlow replies. */
6351 case OFPTYPE_ECHO_REPLY:
6354 /* Nicira extension requests. */
6355 case OFPTYPE_FLOW_MOD_TABLE_ID:
6356 return handle_nxt_flow_mod_table_id(ofconn, oh);
6358 case OFPTYPE_SET_FLOW_FORMAT:
6359 return handle_nxt_set_flow_format(ofconn, oh);
6361 case OFPTYPE_SET_PACKET_IN_FORMAT:
6362 return handle_nxt_set_packet_in_format(ofconn, oh);
6364 case OFPTYPE_SET_CONTROLLER_ID:
6365 return handle_nxt_set_controller_id(ofconn, oh);
6367 case OFPTYPE_FLOW_AGE:
6368 /* Nothing to do. */
6371 case OFPTYPE_FLOW_MONITOR_CANCEL:
6372 return handle_flow_monitor_cancel(ofconn, oh);
6374 case OFPTYPE_SET_ASYNC_CONFIG:
6375 return handle_nxt_set_async_config(ofconn, oh);
6377 case OFPTYPE_GET_ASYNC_REQUEST:
6378 return handle_nxt_get_async_request(ofconn, oh);
6380 /* Statistics requests. */
6381 case OFPTYPE_DESC_STATS_REQUEST:
6382 return handle_desc_stats_request(ofconn, oh);
6384 case OFPTYPE_FLOW_STATS_REQUEST:
6385 return handle_flow_stats_request(ofconn, oh);
6387 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6388 return handle_aggregate_stats_request(ofconn, oh);
6390 case OFPTYPE_TABLE_STATS_REQUEST:
6391 return handle_table_stats_request(ofconn, oh);
6393 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6394 return handle_table_features_request(ofconn, oh);
6396 case OFPTYPE_PORT_STATS_REQUEST:
6397 return handle_port_stats_request(ofconn, oh);
6399 case OFPTYPE_QUEUE_STATS_REQUEST:
6400 return handle_queue_stats_request(ofconn, oh);
6402 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6403 return handle_port_desc_stats_request(ofconn, oh);
6405 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6406 return handle_flow_monitor_request(ofconn, oh);
6408 case OFPTYPE_METER_STATS_REQUEST:
6409 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6410 return handle_meter_request(ofconn, oh, type);
6412 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6413 return handle_meter_features_request(ofconn, oh);
6415 case OFPTYPE_GROUP_STATS_REQUEST:
6416 return handle_group_stats_request(ofconn, oh);
6418 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6419 return handle_group_desc_stats_request(ofconn, oh);
6421 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6422 return handle_group_features_stats_request(ofconn, oh);
6424 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6425 return handle_queue_get_config_request(ofconn, oh);
6427 case OFPTYPE_BUNDLE_CONTROL:
6428 return handle_bundle_control(ofconn, oh);
6430 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6431 return handle_bundle_add(ofconn, oh);
6435 case OFPTYPE_FEATURES_REPLY:
6436 case OFPTYPE_GET_CONFIG_REPLY:
6437 case OFPTYPE_PACKET_IN:
6438 case OFPTYPE_FLOW_REMOVED:
6439 case OFPTYPE_PORT_STATUS:
6440 case OFPTYPE_BARRIER_REPLY:
6441 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6442 case OFPTYPE_DESC_STATS_REPLY:
6443 case OFPTYPE_FLOW_STATS_REPLY:
6444 case OFPTYPE_QUEUE_STATS_REPLY:
6445 case OFPTYPE_PORT_STATS_REPLY:
6446 case OFPTYPE_TABLE_STATS_REPLY:
6447 case OFPTYPE_AGGREGATE_STATS_REPLY:
6448 case OFPTYPE_PORT_DESC_STATS_REPLY:
6449 case OFPTYPE_ROLE_REPLY:
6450 case OFPTYPE_FLOW_MONITOR_PAUSED:
6451 case OFPTYPE_FLOW_MONITOR_RESUMED:
6452 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6453 case OFPTYPE_GET_ASYNC_REPLY:
6454 case OFPTYPE_GROUP_STATS_REPLY:
6455 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6456 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6457 case OFPTYPE_METER_STATS_REPLY:
6458 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6459 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6460 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6461 case OFPTYPE_ROLE_STATUS:
6463 if (ofpmsg_is_stat_request(oh)) {
6464 return OFPERR_OFPBRC_BAD_STAT;
6466 return OFPERR_OFPBRC_BAD_TYPE;
6472 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6473 OVS_EXCLUDED(ofproto_mutex)
6475 int error = handle_openflow__(ofconn, ofp_msg);
6477 ofconn_send_error(ofconn, ofp_msg->data, error);
6479 COVERAGE_INC(ofproto_recv_openflow);
6482 /* Asynchronous operations. */
6485 send_buffered_packet(struct ofconn *ofconn, uint32_t buffer_id,
6487 OVS_REQUIRES(ofproto_mutex)
6489 enum ofperr error = 0;
6490 if (ofconn && buffer_id != UINT32_MAX) {
6491 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6492 struct dp_packet *packet;
6495 error = ofconn_pktbuf_retrieve(ofconn, buffer_id, &packet, &in_port);
6497 struct rule_execute *re;
6499 ofproto_rule_ref(rule);
6501 re = xmalloc(sizeof *re);
6503 re->in_port = in_port;
6504 re->packet = packet;
6506 if (!guarded_list_push_back(&ofproto->rule_executes,
6507 &re->list_node, 1024)) {
6508 ofproto_rule_unref(rule);
6509 dp_packet_delete(re->packet);
6518 pick_datapath_id(const struct ofproto *ofproto)
6520 const struct ofport *port;
6522 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6524 uint8_t ea[ETH_ADDR_LEN];
6527 error = netdev_get_etheraddr(port->netdev, ea);
6529 return eth_addr_to_uint64(ea);
6531 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6532 ofproto->name, netdev_get_name(port->netdev),
6533 ovs_strerror(error));
6535 return ofproto->fallback_dpid;
6539 pick_fallback_dpid(void)
6541 uint8_t ea[ETH_ADDR_LEN];
6542 eth_addr_nicira_random(ea);
6543 return eth_addr_to_uint64(ea);
6546 /* Table overflow policy. */
6548 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6549 * to NULL if the table is not configured to evict rules or if the table
6550 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6551 * or with no timeouts are not evictable.) */
6553 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6554 OVS_REQUIRES(ofproto_mutex)
6556 struct eviction_group *evg;
6559 if (!table->eviction_fields) {
6563 /* In the common case, the outer and inner loops here will each be entered
6566 * - The inner loop normally "return"s in its first iteration. If the
6567 * eviction group has any evictable rules, then it always returns in
6570 * - The outer loop only iterates more than once if the largest eviction
6571 * group has no evictable rules.
6573 * - The outer loop can exit only if table's 'max_flows' is all filled up
6574 * by unevictable rules. */
6575 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6578 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6587 /* Eviction groups. */
6589 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6590 * rules. The priority contains low-order random bits to ensure that eviction
6591 * groups with the same number of rules are prioritized randomly. */
6593 eviction_group_priority(size_t n_rules)
6595 uint16_t size = MIN(UINT16_MAX, n_rules);
6596 return (size << 16) | random_uint16();
6599 /* Updates 'evg', an eviction_group within 'table', following a change that
6600 * adds or removes rules in 'evg'. */
6602 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6603 OVS_REQUIRES(ofproto_mutex)
6605 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6606 eviction_group_priority(heap_count(&evg->rules)));
6609 /* Destroys 'evg', an eviction_group within 'table':
6611 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6612 * rules themselves, just removes them from the eviction group.)
6614 * - Removes 'evg' from 'table'.
6618 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6619 OVS_REQUIRES(ofproto_mutex)
6621 while (!heap_is_empty(&evg->rules)) {
6624 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6625 rule->eviction_group = NULL;
6627 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6628 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6629 heap_destroy(&evg->rules);
6633 /* Removes 'rule' from its eviction group, if any. */
6635 eviction_group_remove_rule(struct rule *rule)
6636 OVS_REQUIRES(ofproto_mutex)
6638 if (rule->eviction_group) {
6639 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6640 struct eviction_group *evg = rule->eviction_group;
6642 rule->eviction_group = NULL;
6643 heap_remove(&evg->rules, &rule->evg_node);
6644 if (heap_is_empty(&evg->rules)) {
6645 eviction_group_destroy(table, evg);
6647 eviction_group_resized(table, evg);
6652 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6653 * returns the hash value. */
6655 eviction_group_hash_rule(struct rule *rule)
6656 OVS_REQUIRES(ofproto_mutex)
6658 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6659 const struct mf_subfield *sf;
6663 hash = table->eviction_group_id_basis;
6664 miniflow_expand(&rule->cr.match.flow, &flow);
6665 for (sf = table->eviction_fields;
6666 sf < &table->eviction_fields[table->n_eviction_fields];
6669 if (mf_are_prereqs_ok(sf->field, &flow)) {
6670 union mf_value value;
6672 mf_get_value(sf->field, &flow, &value);
6674 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6676 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6677 unsigned int start = sf->ofs + sf->n_bits;
6678 bitwise_zero(&value, sf->field->n_bytes, start,
6679 sf->field->n_bytes * 8 - start);
6681 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6683 hash = hash_int(hash, 0);
6690 /* Returns an eviction group within 'table' with the given 'id', creating one
6692 static struct eviction_group *
6693 eviction_group_find(struct oftable *table, uint32_t id)
6694 OVS_REQUIRES(ofproto_mutex)
6696 struct eviction_group *evg;
6698 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6702 evg = xmalloc(sizeof *evg);
6703 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6704 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6705 eviction_group_priority(0));
6706 heap_init(&evg->rules);
6711 /* Returns an eviction priority for 'rule'. The return value should be
6712 * interpreted so that higher priorities make a rule more attractive candidates
6714 * Called only if have a timeout. */
6716 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6717 OVS_REQUIRES(ofproto_mutex)
6719 long long int expiration = LLONG_MAX;
6720 long long int modified;
6721 uint32_t expiration_offset;
6723 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6724 ovs_mutex_lock(&rule->mutex);
6725 modified = rule->modified;
6726 ovs_mutex_unlock(&rule->mutex);
6728 if (rule->hard_timeout) {
6729 expiration = modified + rule->hard_timeout * 1000;
6731 if (rule->idle_timeout) {
6732 uint64_t packets, bytes;
6734 long long int idle_expiration;
6736 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6737 idle_expiration = used + rule->idle_timeout * 1000;
6738 expiration = MIN(expiration, idle_expiration);
6741 if (expiration == LLONG_MAX) {
6745 /* Calculate the time of expiration as a number of (approximate) seconds
6746 * after program startup.
6748 * This should work OK for program runs that last UINT32_MAX seconds or
6749 * less. Therefore, please restart OVS at least once every 136 years. */
6750 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6752 /* Invert the expiration offset because we're using a max-heap. */
6753 return UINT32_MAX - expiration_offset;
6756 /* Adds 'rule' to an appropriate eviction group for its oftable's
6757 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6758 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6761 * The caller must ensure that 'rule' is not already in an eviction group. */
6763 eviction_group_add_rule(struct rule *rule)
6764 OVS_REQUIRES(ofproto_mutex)
6766 struct ofproto *ofproto = rule->ofproto;
6767 struct oftable *table = &ofproto->tables[rule->table_id];
6770 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6771 * so no additional protection is needed. */
6772 has_timeout = rule->hard_timeout || rule->idle_timeout;
6774 if (table->eviction_fields && has_timeout) {
6775 struct eviction_group *evg;
6777 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6779 rule->eviction_group = evg;
6780 heap_insert(&evg->rules, &rule->evg_node,
6781 rule_eviction_priority(ofproto, rule));
6782 eviction_group_resized(table, evg);
6788 /* Initializes 'table'. */
6790 oftable_init(struct oftable *table)
6792 memset(table, 0, sizeof *table);
6793 classifier_init(&table->cls, flow_segment_u64s);
6794 table->max_flows = UINT_MAX;
6795 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
6797 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
6798 ARRAY_SIZE(default_prefix_fields));
6800 atomic_init(&table->n_matched, 0);
6801 atomic_init(&table->n_missed, 0);
6804 /* Destroys 'table', including its classifier and eviction groups.
6806 * The caller is responsible for freeing 'table' itself. */
6808 oftable_destroy(struct oftable *table)
6810 ovs_assert(classifier_is_empty(&table->cls));
6811 oftable_disable_eviction(table);
6812 classifier_destroy(&table->cls);
6816 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6817 * string, then 'table' will use its default name.
6819 * This only affects the name exposed for a table exposed through the OpenFlow
6820 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6822 oftable_set_name(struct oftable *table, const char *name)
6824 if (name && name[0]) {
6825 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6826 if (!table->name || strncmp(name, table->name, len)) {
6828 table->name = xmemdup0(name, len);
6836 /* oftables support a choice of two policies when adding a rule would cause the
6837 * number of flows in the table to exceed the configured maximum number: either
6838 * they can refuse to add the new flow or they can evict some existing flow.
6839 * This function configures the former policy on 'table'. */
6841 oftable_disable_eviction(struct oftable *table)
6842 OVS_REQUIRES(ofproto_mutex)
6844 if (table->eviction_fields) {
6845 struct eviction_group *evg, *next;
6847 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6848 &table->eviction_groups_by_id) {
6849 eviction_group_destroy(table, evg);
6851 hmap_destroy(&table->eviction_groups_by_id);
6852 heap_destroy(&table->eviction_groups_by_size);
6854 free(table->eviction_fields);
6855 table->eviction_fields = NULL;
6856 table->n_eviction_fields = 0;
6860 /* oftables support a choice of two policies when adding a rule would cause the
6861 * number of flows in the table to exceed the configured maximum number: either
6862 * they can refuse to add the new flow or they can evict some existing flow.
6863 * This function configures the latter policy on 'table', with fairness based
6864 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6865 * 'n_fields' as 0 disables fairness.) */
6867 oftable_enable_eviction(struct oftable *table,
6868 const struct mf_subfield *fields, size_t n_fields)
6869 OVS_REQUIRES(ofproto_mutex)
6873 if (table->eviction_fields
6874 && n_fields == table->n_eviction_fields
6876 || !memcmp(fields, table->eviction_fields,
6877 n_fields * sizeof *fields))) {
6882 oftable_disable_eviction(table);
6884 table->n_eviction_fields = n_fields;
6885 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6887 table->eviction_group_id_basis = random_uint32();
6888 hmap_init(&table->eviction_groups_by_id);
6889 heap_init(&table->eviction_groups_by_size);
6891 CLS_FOR_EACH (rule, cr, &table->cls) {
6892 eviction_group_add_rule(rule);
6896 /* Removes 'rule' from the ofproto data structures AFTER caller has removed
6897 * it from the classifier. */
6899 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
6900 OVS_REQUIRES(ofproto_mutex)
6902 cookies_remove(ofproto, rule);
6904 eviction_group_remove_rule(rule);
6905 if (!list_is_empty(&rule->expirable)) {
6906 list_remove(&rule->expirable);
6908 if (!list_is_empty(&rule->meter_list_node)) {
6909 list_remove(&rule->meter_list_node);
6910 list_init(&rule->meter_list_node);
6915 oftable_remove_rule(struct rule *rule)
6916 OVS_REQUIRES(ofproto_mutex)
6918 struct classifier *cls = &rule->ofproto->tables[rule->table_id].cls;
6920 if (classifier_remove(cls, &rule->cr)) {
6921 ofproto_rule_remove__(rule->ofproto, rule);
6925 /* unixctl commands. */
6928 ofproto_lookup(const char *name)
6930 struct ofproto *ofproto;
6932 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6934 if (!strcmp(ofproto->name, name)) {
6942 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6943 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6945 struct ofproto *ofproto;
6949 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6950 ds_put_format(&results, "%s\n", ofproto->name);
6952 unixctl_command_reply(conn, ds_cstr(&results));
6953 ds_destroy(&results);
6957 ofproto_unixctl_init(void)
6959 static bool registered;
6965 unixctl_command_register("ofproto/list", "", 0, 0,
6966 ofproto_unixctl_list, NULL);
6969 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6971 * This is deprecated. It is only for compatibility with broken device drivers
6972 * in old versions of Linux that do not properly support VLANs when VLAN
6973 * devices are not used. When broken device drivers are no longer in
6974 * widespread use, we will delete these interfaces. */
6976 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6977 * (exactly) by an OpenFlow rule in 'ofproto'. */
6979 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6982 struct cls_rule target;
6983 const struct oftable *oftable;
6985 match_init_catchall(&match);
6986 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
6987 cls_rule_init(&target, &match, 0);
6989 free(ofproto->vlan_bitmap);
6990 ofproto->vlan_bitmap = bitmap_allocate(4096);
6991 ofproto->vlans_changed = false;
6993 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6996 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
6997 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
6998 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7000 bitmap_set1(vlan_bitmap, vid);
7001 bitmap_set1(ofproto->vlan_bitmap, vid);
7006 cls_rule_destroy(&target);
7009 /* Returns true if new VLANs have come into use by the flow table since the
7010 * last call to ofproto_get_vlan_usage().
7012 * We don't track when old VLANs stop being used. */
7014 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7016 return ofproto->vlans_changed;
7019 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7020 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7021 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7022 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7023 * then the VLAN device is un-enslaved. */
7025 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7026 ofp_port_t realdev_ofp_port, int vid)
7028 struct ofport *ofport;
7031 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7033 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7035 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7036 ofproto->name, vlandev_ofp_port);
7040 if (!ofproto->ofproto_class->set_realdev) {
7041 if (!vlandev_ofp_port) {
7044 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7048 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7050 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7051 ofproto->name, vlandev_ofp_port,
7052 netdev_get_name(ofport->netdev), ovs_strerror(error));