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 /* LLDP configuration. */
1043 ofproto_port_set_lldp(struct ofproto *ofproto,
1044 ofp_port_t ofp_port,
1045 const struct smap *cfg)
1047 struct ofport *ofport;
1050 ofport = ofproto_get_port(ofproto, ofp_port);
1052 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16,
1053 ofproto->name, ofp_port);
1056 error = (ofproto->ofproto_class->set_lldp
1057 ? ofproto->ofproto_class->set_lldp(ofport, cfg)
1060 VLOG_WARN("%s: lldp configuration on port %"PRIu16" (%s) failed (%s)",
1061 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1062 ovs_strerror(error));
1067 ofproto_set_aa(struct ofproto *ofproto, void *aux OVS_UNUSED,
1068 const struct aa_settings *s)
1070 if (!ofproto->ofproto_class->set_aa) {
1073 ofproto->ofproto_class->set_aa(ofproto, s);
1078 ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
1079 const struct aa_mapping_settings *s)
1081 if (!ofproto->ofproto_class->aa_mapping_set) {
1084 ofproto->ofproto_class->aa_mapping_set(ofproto, aux, s);
1089 ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux)
1091 if (!ofproto->ofproto_class->aa_mapping_unset) {
1094 ofproto->ofproto_class->aa_mapping_unset(ofproto, aux);
1099 ofproto_aa_vlan_get_queued(struct ofproto *ofproto,
1100 struct ovs_list *list)
1102 if (!ofproto->ofproto_class->aa_vlan_get_queued) {
1105 ofproto->ofproto_class->aa_vlan_get_queued(ofproto, list);
1110 ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto)
1112 if (!ofproto->ofproto_class->aa_vlan_get_queue_size) {
1115 return ofproto->ofproto_class->aa_vlan_get_queue_size(ofproto);
1118 /* Connectivity Fault Management configuration. */
1120 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1122 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
1124 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1125 if (ofport && ofproto->ofproto_class->set_cfm) {
1126 ofproto->ofproto_class->set_cfm(ofport, NULL);
1130 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1131 * basic configuration from the configuration members in 'cfm', and the remote
1132 * maintenance point ID from remote_mpid. Ignores the statistics members of
1135 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1137 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
1138 const struct cfm_settings *s)
1140 struct ofport *ofport;
1143 ofport = ofproto_get_port(ofproto, ofp_port);
1145 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
1146 ofproto->name, ofp_port);
1150 /* XXX: For configuration simplicity, we only support one remote_mpid
1151 * outside of the CFM module. It's not clear if this is the correct long
1152 * term solution or not. */
1153 error = (ofproto->ofproto_class->set_cfm
1154 ? ofproto->ofproto_class->set_cfm(ofport, s)
1157 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
1158 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1159 ovs_strerror(error));
1163 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1164 * 'ofproto' does not have a port 'ofp_port'. */
1166 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1167 const struct smap *cfg)
1169 struct ofport *ofport;
1172 ofport = ofproto_get_port(ofproto, ofp_port);
1174 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1175 ofproto->name, ofp_port);
1179 error = (ofproto->ofproto_class->set_bfd
1180 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1183 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1184 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1185 ovs_strerror(error));
1189 /* Checks the status change of BFD on 'ofport'.
1191 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1193 ofproto_port_bfd_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
1195 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1196 return (ofport && ofproto->ofproto_class->bfd_status_changed
1197 ? ofproto->ofproto_class->bfd_status_changed(ofport)
1201 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1202 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1203 * is not an OpenFlow port in 'ofproto'.
1205 * The caller must provide and own '*status'. */
1207 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1208 struct smap *status)
1210 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1211 return (ofport && ofproto->ofproto_class->get_bfd_status
1212 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1216 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1217 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1218 * 0 if LACP partner information is not current (generally indicating a
1219 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1221 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1223 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1224 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1225 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1230 ofproto_port_get_lacp_stats(const struct ofport *port, struct lacp_slave_stats *stats)
1232 struct ofproto *ofproto = port->ofproto;
1235 if (ofproto->ofproto_class->port_get_lacp_stats) {
1236 error = ofproto->ofproto_class->port_get_lacp_stats(port, stats);
1246 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1247 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1248 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1249 * configuration plus, if there is more than one slave, a bonding
1252 * If 'aux' is already registered then this function updates its configuration
1253 * to 's'. Otherwise, this function registers a new bundle.
1255 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1258 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1259 const struct ofproto_bundle_settings *s)
1261 return (ofproto->ofproto_class->bundle_set
1262 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1266 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1267 * If no such bundle has been registered, this has no effect. */
1269 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1271 return ofproto_bundle_register(ofproto, aux, NULL);
1275 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1276 * If 'aux' is already registered then this function updates its configuration
1277 * to 's'. Otherwise, this function registers a new mirror. */
1279 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1280 const struct ofproto_mirror_settings *s)
1282 return (ofproto->ofproto_class->mirror_set
1283 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1287 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1288 * If no mirror has been registered, this has no effect. */
1290 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1292 return ofproto_mirror_register(ofproto, aux, NULL);
1295 /* Retrieves statistics from mirror associated with client data pointer
1296 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1297 * 'bytes', respectively. If a particular counters is not supported,
1298 * the appropriate argument is set to UINT64_MAX.
1301 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1302 uint64_t *packets, uint64_t *bytes)
1304 if (!ofproto->ofproto_class->mirror_get_stats) {
1305 *packets = *bytes = UINT64_MAX;
1309 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1313 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1314 * which all packets are flooded, instead of using MAC learning. If
1315 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1317 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1320 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1322 return (ofproto->ofproto_class->set_flood_vlans
1323 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1327 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1328 * output for a mirror. */
1330 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1332 return (ofproto->ofproto_class->is_mirror_output_bundle
1333 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1337 /* Configuration of OpenFlow tables. */
1339 /* Returns the number of OpenFlow tables in 'ofproto'. */
1341 ofproto_get_n_tables(const struct ofproto *ofproto)
1343 return ofproto->n_tables;
1346 /* Returns the number of Controller visible OpenFlow tables
1347 * in 'ofproto'. This number will exclude Hidden tables.
1348 * This funtion's return value should be less or equal to that of
1349 * ofproto_get_n_tables() . */
1351 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1353 uint8_t n = ofproto->n_tables;
1355 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1356 * if present, are always at the end.) */
1357 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1364 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1365 * settings from 's'. 'table_id' must be in the range 0 through the number of
1366 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1368 * For read-only tables, only the name may be configured. */
1370 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1371 const struct ofproto_table_settings *s)
1373 struct oftable *table;
1375 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1376 table = &ofproto->tables[table_id];
1378 oftable_set_name(table, s->name);
1380 if (table->flags & OFTABLE_READONLY) {
1385 oftable_enable_eviction(table, s->groups, s->n_groups);
1387 oftable_disable_eviction(table);
1390 table->max_flows = s->max_flows;
1392 if (classifier_set_prefix_fields(&table->cls,
1393 s->prefix_fields, s->n_prefix_fields)) {
1394 /* XXX: Trigger revalidation. */
1397 ovs_mutex_lock(&ofproto_mutex);
1398 evict_rules_from_table(table, 0);
1399 ovs_mutex_unlock(&ofproto_mutex);
1403 ofproto_has_snoops(const struct ofproto *ofproto)
1405 return connmgr_has_snoops(ofproto->connmgr);
1409 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1411 connmgr_get_snoops(ofproto->connmgr, snoops);
1414 /* Deletes 'rule' from 'ofproto'.
1416 * Within an ofproto implementation, this function allows an ofproto
1417 * implementation to destroy any rules that remain when its ->destruct()
1418 * function is called. This function is not suitable for use elsewhere in an
1419 * ofproto implementation.
1421 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1422 * Cycle" in ofproto-provider.h. */
1424 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1425 OVS_EXCLUDED(ofproto_mutex)
1427 /* This skips the ofmonitor and flow-removed notifications because the
1428 * switch is being deleted and any OpenFlow channels have been or soon will
1430 ovs_mutex_lock(&ofproto_mutex);
1431 oftable_remove_rule(rule);
1432 ofproto->ofproto_class->rule_delete(rule);
1433 ovs_mutex_unlock(&ofproto_mutex);
1437 ofproto_flush__(struct ofproto *ofproto)
1438 OVS_EXCLUDED(ofproto_mutex)
1440 struct oftable *table;
1442 /* This will flush all datapath flows. */
1443 if (ofproto->ofproto_class->flush) {
1444 ofproto->ofproto_class->flush(ofproto);
1447 /* XXX: There is a small race window here, where new datapath flows can be
1448 * created by upcall handlers based on the existing flow table. We can not
1449 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1450 * as then we could deadlock on syncing with the handler threads waiting on
1451 * the same mutex. */
1453 ovs_mutex_lock(&ofproto_mutex);
1454 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1455 struct rule_collection rules;
1458 if (table->flags & OFTABLE_HIDDEN) {
1462 rule_collection_init(&rules);
1464 CLS_FOR_EACH (rule, cr, &table->cls) {
1465 rule_collection_add(&rules, rule);
1467 delete_flows__(&rules, OFPRR_DELETE, NULL);
1468 rule_collection_destroy(&rules);
1470 /* XXX: Concurrent handler threads may insert new learned flows based on
1471 * learn actions of the now deleted flows right after we release
1472 * 'ofproto_mutex'. */
1473 ovs_mutex_unlock(&ofproto_mutex);
1476 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1479 ofproto_destroy__(struct ofproto *ofproto)
1480 OVS_EXCLUDED(ofproto_mutex)
1482 struct oftable *table;
1484 destroy_rule_executes(ofproto);
1485 delete_group(ofproto, OFPG_ALL);
1487 guarded_list_destroy(&ofproto->rule_executes);
1488 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1489 hmap_destroy(&ofproto->groups);
1491 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1492 free(ofproto->name);
1493 free(ofproto->type);
1494 free(ofproto->mfr_desc);
1495 free(ofproto->hw_desc);
1496 free(ofproto->sw_desc);
1497 free(ofproto->serial_desc);
1498 free(ofproto->dp_desc);
1499 hmap_destroy(&ofproto->ports);
1500 hmap_destroy(&ofproto->ofport_usage);
1501 shash_destroy(&ofproto->port_by_name);
1502 simap_destroy(&ofproto->ofp_requests);
1504 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1505 oftable_destroy(table);
1507 free(ofproto->tables);
1509 ovs_assert(hindex_is_empty(&ofproto->cookies));
1510 hindex_destroy(&ofproto->cookies);
1512 ovs_assert(hmap_is_empty(&ofproto->learned_cookies));
1513 hmap_destroy(&ofproto->learned_cookies);
1515 free(ofproto->vlan_bitmap);
1517 ofproto->ofproto_class->dealloc(ofproto);
1521 ofproto_destroy(struct ofproto *p)
1522 OVS_EXCLUDED(ofproto_mutex)
1524 struct ofport *ofport, *next_ofport;
1525 struct ofport_usage *usage, *next_usage;
1532 meter_delete(p, 1, p->meter_features.max_meters);
1533 p->meter_features.max_meters = 0;
1539 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1540 ofport_destroy(ofport);
1543 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1544 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1548 p->ofproto_class->destruct(p);
1550 /* We should not postpone this because it involves deleting a listening
1551 * socket which we may want to reopen soon. 'connmgr' should not be used
1552 * by other threads */
1553 connmgr_destroy(p->connmgr);
1555 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1556 ovsrcu_postpone(ofproto_destroy__, p);
1559 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1560 * kernel datapath, for example, this destroys the datapath in the kernel, and
1561 * with the netdev-based datapath, it tears down the data structures that
1562 * represent the datapath.
1564 * The datapath should not be currently open as an ofproto. */
1566 ofproto_delete(const char *name, const char *type)
1568 const struct ofproto_class *class = ofproto_class_find__(type);
1569 return (!class ? EAFNOSUPPORT
1570 : !class->del ? EACCES
1571 : class->del(type, name));
1575 process_port_change(struct ofproto *ofproto, int error, char *devname)
1577 if (error == ENOBUFS) {
1578 reinit_ports(ofproto);
1579 } else if (!error) {
1580 update_port(ofproto, devname);
1586 ofproto_type_run(const char *datapath_type)
1588 const struct ofproto_class *class;
1591 datapath_type = ofproto_normalize_type(datapath_type);
1592 class = ofproto_class_find__(datapath_type);
1594 error = class->type_run ? class->type_run(datapath_type) : 0;
1595 if (error && error != EAGAIN) {
1596 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1597 datapath_type, ovs_strerror(error));
1603 ofproto_type_wait(const char *datapath_type)
1605 const struct ofproto_class *class;
1607 datapath_type = ofproto_normalize_type(datapath_type);
1608 class = ofproto_class_find__(datapath_type);
1610 if (class->type_wait) {
1611 class->type_wait(datapath_type);
1616 ofproto_run(struct ofproto *p)
1621 error = p->ofproto_class->run(p);
1622 if (error && error != EAGAIN) {
1623 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1626 run_rule_executes(p);
1628 /* Restore the eviction group heap invariant occasionally. */
1629 if (p->eviction_group_timer < time_msec()) {
1632 p->eviction_group_timer = time_msec() + 1000;
1634 for (i = 0; i < p->n_tables; i++) {
1635 struct oftable *table = &p->tables[i];
1636 struct eviction_group *evg;
1639 if (!table->eviction_fields) {
1643 if (classifier_count(&table->cls) > 100000) {
1644 static struct vlog_rate_limit count_rl =
1645 VLOG_RATE_LIMIT_INIT(1, 1);
1646 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1647 " number of rules: %d", i,
1648 classifier_count(&table->cls));
1651 ovs_mutex_lock(&ofproto_mutex);
1652 CLS_FOR_EACH (rule, cr, &table->cls) {
1653 if (rule->idle_timeout || rule->hard_timeout) {
1654 if (!rule->eviction_group) {
1655 eviction_group_add_rule(rule);
1657 heap_raw_change(&rule->evg_node,
1658 rule_eviction_priority(p, rule));
1663 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1664 heap_rebuild(&evg->rules);
1666 ovs_mutex_unlock(&ofproto_mutex);
1670 if (p->ofproto_class->port_poll) {
1673 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1674 process_port_change(p, error, devname);
1678 new_seq = seq_read(connectivity_seq_get());
1679 if (new_seq != p->change_seq) {
1680 struct sset devnames;
1681 const char *devname;
1682 struct ofport *ofport;
1684 /* Update OpenFlow port status for any port whose netdev has changed.
1686 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1687 * destroyed, so it's not safe to update ports directly from the
1688 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1689 * need this two-phase approach. */
1690 sset_init(&devnames);
1691 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1692 uint64_t port_change_seq;
1694 port_change_seq = netdev_get_change_seq(ofport->netdev);
1695 if (ofport->change_seq != port_change_seq) {
1696 ofport->change_seq = port_change_seq;
1697 sset_add(&devnames, netdev_get_name(ofport->netdev));
1700 SSET_FOR_EACH (devname, &devnames) {
1701 update_port(p, devname);
1703 sset_destroy(&devnames);
1705 p->change_seq = new_seq;
1708 connmgr_run(p->connmgr, handle_openflow);
1714 ofproto_wait(struct ofproto *p)
1716 p->ofproto_class->wait(p);
1717 if (p->ofproto_class->port_poll_wait) {
1718 p->ofproto_class->port_poll_wait(p);
1720 seq_wait(connectivity_seq_get(), p->change_seq);
1721 connmgr_wait(p->connmgr);
1725 ofproto_is_alive(const struct ofproto *p)
1727 return connmgr_has_controllers(p->connmgr);
1730 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1731 * memory_report(). */
1733 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1735 const struct oftable *table;
1736 unsigned int n_rules;
1738 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1741 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1742 n_rules += classifier_count(&table->cls);
1744 simap_increase(usage, "rules", n_rules);
1746 if (ofproto->ofproto_class->get_memory_usage) {
1747 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1750 connmgr_get_memory_usage(ofproto->connmgr, usage);
1754 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1756 const struct ofproto_class *class;
1758 datapath_type = ofproto_normalize_type(datapath_type);
1759 class = ofproto_class_find__(datapath_type);
1761 if (class && class->type_get_memory_usage) {
1762 class->type_get_memory_usage(datapath_type, usage);
1767 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1770 connmgr_get_controller_info(ofproto->connmgr, info);
1774 ofproto_free_ofproto_controller_info(struct shash *info)
1776 connmgr_free_controller_info(info);
1779 /* Makes a deep copy of 'old' into 'port'. */
1781 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1783 port->name = xstrdup(old->name);
1784 port->type = xstrdup(old->type);
1785 port->ofp_port = old->ofp_port;
1788 /* Frees memory allocated to members of 'ofproto_port'.
1790 * Do not call this function on an ofproto_port obtained from
1791 * ofproto_port_dump_next(): that function retains ownership of the data in the
1794 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1796 free(ofproto_port->name);
1797 free(ofproto_port->type);
1800 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1802 * This function provides no status indication. An error status for the entire
1803 * dump operation is provided when it is completed by calling
1804 * ofproto_port_dump_done().
1807 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1808 const struct ofproto *ofproto)
1810 dump->ofproto = ofproto;
1811 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1815 /* Attempts to retrieve another port from 'dump', which must have been created
1816 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1817 * 'port' and returns true. On failure, returns false.
1819 * Failure might indicate an actual error or merely that the last port has been
1820 * dumped. An error status for the entire dump operation is provided when it
1821 * is completed by calling ofproto_port_dump_done().
1823 * The ofproto owns the data stored in 'port'. It will remain valid until at
1824 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1825 * ofproto_port_dump_done(). */
1827 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1828 struct ofproto_port *port)
1830 const struct ofproto *ofproto = dump->ofproto;
1836 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1839 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1845 /* Completes port table dump operation 'dump', which must have been created
1846 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1847 * error-free, otherwise a positive errno value describing the problem. */
1849 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1851 const struct ofproto *ofproto = dump->ofproto;
1853 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1856 return dump->error == EOF ? 0 : dump->error;
1859 /* Returns the type to pass to netdev_open() when a datapath of type
1860 * 'datapath_type' has a port of type 'port_type', for a few special
1861 * cases when a netdev type differs from a port type. For example, when
1862 * using the userspace datapath, a port of type "internal" needs to be
1865 * Returns either 'type' itself or a string literal, which must not be
1868 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1870 const struct ofproto_class *class;
1872 datapath_type = ofproto_normalize_type(datapath_type);
1873 class = ofproto_class_find__(datapath_type);
1878 return (class->port_open_type
1879 ? class->port_open_type(datapath_type, port_type)
1883 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1884 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1885 * the port's OpenFlow port number.
1887 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1888 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1889 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1890 * 'ofp_portp' is non-null). */
1892 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1893 ofp_port_t *ofp_portp)
1895 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1898 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1900 const char *netdev_name = netdev_get_name(netdev);
1902 simap_put(&ofproto->ofp_requests, netdev_name,
1903 ofp_to_u16(ofp_port));
1904 update_port(ofproto, netdev_name);
1907 *ofp_portp = OFPP_NONE;
1909 struct ofproto_port ofproto_port;
1911 error = ofproto_port_query_by_name(ofproto,
1912 netdev_get_name(netdev),
1915 *ofp_portp = ofproto_port.ofp_port;
1916 ofproto_port_destroy(&ofproto_port);
1923 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1924 * initializes '*port' appropriately; on failure, returns a positive errno
1927 * The caller owns the data in 'ofproto_port' and must free it with
1928 * ofproto_port_destroy() when it is no longer needed. */
1930 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1931 struct ofproto_port *port)
1935 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1937 memset(port, 0, sizeof *port);
1942 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1943 * Returns 0 if successful, otherwise a positive errno. */
1945 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1947 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1948 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1949 struct simap_node *ofp_request_node;
1952 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1953 if (ofp_request_node) {
1954 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1957 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1958 if (!error && ofport) {
1959 /* 'name' is the netdev's name and update_port() is going to close the
1960 * netdev. Just in case update_port() refers to 'name' after it
1961 * destroys 'ofport', make a copy of it around the update_port()
1963 char *devname = xstrdup(name);
1964 update_port(ofproto, devname);
1971 flow_mod_init(struct ofputil_flow_mod *fm,
1972 const struct match *match, int priority,
1973 const struct ofpact *ofpacts, size_t ofpacts_len,
1974 enum ofp_flow_mod_command command)
1976 memset(fm, 0, sizeof *fm);
1978 fm->priority = priority;
1981 fm->modify_cookie = false;
1983 fm->command = command;
1984 fm->idle_timeout = 0;
1985 fm->hard_timeout = 0;
1987 fm->buffer_id = UINT32_MAX;
1988 fm->out_port = OFPP_ANY;
1989 fm->out_group = OFPG_ANY;
1991 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1992 fm->ofpacts_len = ofpacts_len;
1993 fm->delete_reason = OFPRR_DELETE;
1997 simple_flow_mod(struct ofproto *ofproto,
1998 const struct match *match, int priority,
1999 const struct ofpact *ofpacts, size_t ofpacts_len,
2000 enum ofp_flow_mod_command command)
2002 struct ofputil_flow_mod fm;
2004 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
2006 return handle_flow_mod__(ofproto, &fm, NULL);
2009 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2010 * performs the 'n_actions' actions in 'actions'. The new flow will not
2013 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2014 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2015 * controllers; otherwise, it will be hidden.
2017 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2019 * This is a helper function for in-band control and fail-open. */
2021 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
2023 const struct ofpact *ofpacts, size_t ofpacts_len)
2024 OVS_EXCLUDED(ofproto_mutex)
2026 const struct rule *rule;
2029 /* First do a cheap check whether the rule we're looking for already exists
2030 * with the actions that we want. If it does, then we're done. */
2031 rule = rule_from_cls_rule(classifier_find_match_exactly(
2032 &ofproto->tables[0].cls, match, priority));
2034 const struct rule_actions *actions = rule_get_actions(rule);
2035 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
2036 ofpacts, ofpacts_len);
2041 /* If there's no such rule or the rule doesn't have the actions we want,
2042 * fall back to a executing a full flow mod. We can't optimize this at
2043 * all because we didn't take enough locks above to ensure that the flow
2044 * table didn't already change beneath us. */
2046 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
2047 OFPFC_MODIFY_STRICT);
2051 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
2052 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
2053 * operation cannot be initiated now but may be retried later.
2055 * This is a helper function for in-band control and fail-open and the "learn"
2058 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
2059 OVS_EXCLUDED(ofproto_mutex)
2061 /* Optimize for the most common case of a repeated learn action.
2062 * If an identical flow already exists we only need to update its
2063 * 'modified' time. */
2064 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
2065 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
2066 struct oftable *table = &ofproto->tables[fm->table_id];
2070 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
2074 /* Reading many of the rule fields and writing on 'modified'
2075 * requires the rule->mutex. Also, rule->actions may change
2076 * if rule->mutex is not held. */
2077 const struct rule_actions *actions;
2079 ovs_mutex_lock(&rule->mutex);
2080 actions = rule_get_actions(rule);
2081 if (rule->idle_timeout == fm->idle_timeout
2082 && rule->hard_timeout == fm->hard_timeout
2083 && rule->importance == fm->importance
2084 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
2085 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
2086 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
2087 actions->ofpacts, actions->ofpacts_len)) {
2088 /* Rule already exists and need not change, only update the
2089 modified timestamp. */
2090 rule->modified = time_msec();
2093 ovs_mutex_unlock(&rule->mutex);
2101 return handle_flow_mod__(ofproto, fm, NULL);
2104 /* Searches for a rule with matching criteria exactly equal to 'target' in
2105 * ofproto's table 0 and, if it finds one, deletes it.
2107 * This is a helper function for in-band control and fail-open. */
2109 ofproto_delete_flow(struct ofproto *ofproto,
2110 const struct match *target, int priority)
2111 OVS_EXCLUDED(ofproto_mutex)
2113 struct classifier *cls = &ofproto->tables[0].cls;
2116 /* First do a cheap check whether the rule we're looking for has already
2117 * been deleted. If so, then we're done. */
2118 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2124 /* Execute a flow mod. We can't optimize this at all because we didn't
2125 * take enough locks above to ensure that the flow table didn't already
2126 * change beneath us. */
2127 simple_flow_mod(ofproto, target, priority, NULL, 0, OFPFC_DELETE_STRICT);
2130 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2131 * the flows required by in-band control and fail-open. */
2133 ofproto_flush_flows(struct ofproto *ofproto)
2135 COVERAGE_INC(ofproto_flush);
2136 ofproto_flush__(ofproto);
2137 connmgr_flushed(ofproto->connmgr);
2141 reinit_ports(struct ofproto *p)
2143 struct ofproto_port_dump dump;
2144 struct sset devnames;
2145 struct ofport *ofport;
2146 struct ofproto_port ofproto_port;
2147 const char *devname;
2149 COVERAGE_INC(ofproto_reinit_ports);
2151 sset_init(&devnames);
2152 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2153 sset_add(&devnames, netdev_get_name(ofport->netdev));
2155 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2156 sset_add(&devnames, ofproto_port.name);
2159 SSET_FOR_EACH (devname, &devnames) {
2160 update_port(p, devname);
2162 sset_destroy(&devnames);
2166 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2170 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2171 port_idx = port_idx ? port_idx : UINT16_MAX;
2173 if (port_idx >= ofproto->max_ports
2174 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2175 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2176 long long int last_used_at, lru = LLONG_MAX;
2178 /* Search for a free OpenFlow port number. We try not to
2179 * immediately reuse them to prevent problems due to old
2182 * We limit the automatically assigned port numbers to the lower half
2183 * of the port range, to reserve the upper half for assignment by
2186 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2187 ofproto->alloc_port_no = 1;
2189 last_used_at = ofport_get_usage(ofproto,
2190 u16_to_ofp(ofproto->alloc_port_no));
2191 if (!last_used_at) {
2192 port_idx = ofproto->alloc_port_no;
2194 } else if ( last_used_at < time_msec() - 60*60*1000) {
2195 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2196 * more than an hour ago, consider it usable. */
2197 ofport_remove_usage(ofproto,
2198 u16_to_ofp(ofproto->alloc_port_no));
2199 port_idx = ofproto->alloc_port_no;
2201 } else if (last_used_at < lru) {
2203 lru_ofport = ofproto->alloc_port_no;
2206 if (ofproto->alloc_port_no == end_port_no) {
2208 port_idx = lru_ofport;
2215 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2216 return u16_to_ofp(port_idx);
2220 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2222 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2223 ofport_set_usage(ofproto, ofp_port, time_msec());
2227 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2228 * pointer if the netdev cannot be opened. On success, also fills in
2230 static struct netdev *
2231 ofport_open(struct ofproto *ofproto,
2232 struct ofproto_port *ofproto_port,
2233 struct ofputil_phy_port *pp)
2235 enum netdev_flags flags;
2236 struct netdev *netdev;
2239 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2241 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2242 "cannot be opened (%s)",
2244 ofproto_port->name, ofproto_port->ofp_port,
2245 ofproto_port->name, ovs_strerror(error));
2249 if (ofproto_port->ofp_port == OFPP_NONE) {
2250 if (!strcmp(ofproto->name, ofproto_port->name)) {
2251 ofproto_port->ofp_port = OFPP_LOCAL;
2253 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2254 ofproto_port->name);
2257 pp->port_no = ofproto_port->ofp_port;
2258 netdev_get_etheraddr(netdev, pp->hw_addr);
2259 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2260 netdev_get_flags(netdev, &flags);
2261 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2262 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2263 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2264 &pp->supported, &pp->peer);
2265 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2266 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2271 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2272 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2275 ofport_equal(const struct ofputil_phy_port *a,
2276 const struct ofputil_phy_port *b)
2278 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2279 && a->state == b->state
2280 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2281 && a->curr == b->curr
2282 && a->advertised == b->advertised
2283 && a->supported == b->supported
2284 && a->peer == b->peer
2285 && a->curr_speed == b->curr_speed
2286 && a->max_speed == b->max_speed);
2289 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2290 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2291 * one with the same name or port number). */
2293 ofport_install(struct ofproto *p,
2294 struct netdev *netdev, const struct ofputil_phy_port *pp)
2296 const char *netdev_name = netdev_get_name(netdev);
2297 struct ofport *ofport;
2300 /* Create ofport. */
2301 ofport = p->ofproto_class->port_alloc();
2306 ofport->ofproto = p;
2307 ofport->netdev = netdev;
2308 ofport->change_seq = netdev_get_change_seq(netdev);
2310 ofport->ofp_port = pp->port_no;
2311 ofport->created = time_msec();
2313 /* Add port to 'p'. */
2314 hmap_insert(&p->ports, &ofport->hmap_node,
2315 hash_ofp_port(ofport->ofp_port));
2316 shash_add(&p->port_by_name, netdev_name, ofport);
2318 update_mtu(p, ofport);
2320 /* Let the ofproto_class initialize its private data. */
2321 error = p->ofproto_class->port_construct(ofport);
2325 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2329 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2330 p->name, netdev_name, ovs_strerror(error));
2332 ofport_destroy__(ofport);
2334 netdev_close(netdev);
2338 /* Removes 'ofport' from 'p' and destroys it. */
2340 ofport_remove(struct ofport *ofport)
2342 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2344 ofport_destroy(ofport);
2347 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2350 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2352 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2354 ofport_remove(port);
2358 /* Updates 'port' with new 'pp' description.
2360 * Does not handle a name or port number change. The caller must implement
2361 * such a change as a delete followed by an add. */
2363 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2365 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2366 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2367 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2368 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2369 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2370 port->pp.curr = pp->curr;
2371 port->pp.advertised = pp->advertised;
2372 port->pp.supported = pp->supported;
2373 port->pp.peer = pp->peer;
2374 port->pp.curr_speed = pp->curr_speed;
2375 port->pp.max_speed = pp->max_speed;
2377 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2378 &port->pp, OFPPR_MODIFY);
2381 /* Update OpenFlow 'state' in 'port' and notify controller. */
2383 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2385 if (port->pp.state != state) {
2386 port->pp.state = state;
2387 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2388 &port->pp, OFPPR_MODIFY);
2393 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2395 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2397 if (port->ofproto->ofproto_class->set_realdev) {
2398 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2400 if (port->ofproto->ofproto_class->set_stp_port) {
2401 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2403 if (port->ofproto->ofproto_class->set_rstp_port) {
2404 port->ofproto->ofproto_class->set_rstp_port(port, NULL);
2406 if (port->ofproto->ofproto_class->set_cfm) {
2407 port->ofproto->ofproto_class->set_cfm(port, NULL);
2409 if (port->ofproto->ofproto_class->bundle_remove) {
2410 port->ofproto->ofproto_class->bundle_remove(port);
2416 ofport_destroy__(struct ofport *port)
2418 struct ofproto *ofproto = port->ofproto;
2419 const char *name = netdev_get_name(port->netdev);
2421 hmap_remove(&ofproto->ports, &port->hmap_node);
2422 shash_delete(&ofproto->port_by_name,
2423 shash_find(&ofproto->port_by_name, name));
2425 netdev_close(port->netdev);
2426 ofproto->ofproto_class->port_dealloc(port);
2430 ofport_destroy(struct ofport *port)
2433 dealloc_ofp_port(port->ofproto, port->ofp_port);
2434 port->ofproto->ofproto_class->port_destruct(port);
2435 ofport_destroy__(port);
2440 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2442 struct ofport *port;
2444 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2446 if (port->ofp_port == ofp_port) {
2453 static long long int
2454 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2456 struct ofport_usage *usage;
2458 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2459 &ofproto->ofport_usage) {
2460 if (usage->ofp_port == ofp_port) {
2461 return usage->last_used;
2468 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2469 long long int last_used)
2471 struct ofport_usage *usage;
2472 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2473 &ofproto->ofport_usage) {
2474 if (usage->ofp_port == ofp_port) {
2475 usage->last_used = last_used;
2479 ovs_assert(last_used == LLONG_MAX);
2481 usage = xmalloc(sizeof *usage);
2482 usage->ofp_port = ofp_port;
2483 usage->last_used = last_used;
2484 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2485 hash_ofp_port(ofp_port));
2489 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2491 struct ofport_usage *usage;
2492 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2493 &ofproto->ofport_usage) {
2494 if (usage->ofp_port == ofp_port) {
2495 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2503 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2505 struct ofproto *ofproto = port->ofproto;
2508 if (ofproto->ofproto_class->port_get_stats) {
2509 error = ofproto->ofproto_class->port_get_stats(port, stats);
2518 update_port(struct ofproto *ofproto, const char *name)
2520 struct ofproto_port ofproto_port;
2521 struct ofputil_phy_port pp;
2522 struct netdev *netdev;
2523 struct ofport *port;
2525 COVERAGE_INC(ofproto_update_port);
2527 /* Fetch 'name''s location and properties from the datapath. */
2528 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2529 ? ofport_open(ofproto, &ofproto_port, &pp)
2533 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2534 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2535 struct netdev *old_netdev = port->netdev;
2537 /* 'name' hasn't changed location. Any properties changed? */
2538 if (!ofport_equal(&port->pp, &pp)) {
2539 ofport_modified(port, &pp);
2542 update_mtu(ofproto, port);
2544 /* Install the newly opened netdev in case it has changed.
2545 * Don't close the old netdev yet in case port_modified has to
2546 * remove a retained reference to it.*/
2547 port->netdev = netdev;
2548 port->change_seq = netdev_get_change_seq(netdev);
2550 if (port->ofproto->ofproto_class->port_modified) {
2551 port->ofproto->ofproto_class->port_modified(port);
2554 netdev_close(old_netdev);
2556 /* If 'port' is nonnull then its name differs from 'name' and thus
2557 * we should delete it. If we think there's a port named 'name'
2558 * then its port number must be wrong now so delete it too. */
2560 ofport_remove(port);
2562 ofport_remove_with_name(ofproto, name);
2563 ofport_install(ofproto, netdev, &pp);
2566 /* Any port named 'name' is gone now. */
2567 ofport_remove_with_name(ofproto, name);
2569 ofproto_port_destroy(&ofproto_port);
2573 init_ports(struct ofproto *p)
2575 struct ofproto_port_dump dump;
2576 struct ofproto_port ofproto_port;
2577 struct shash_node *node, *next;
2579 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2580 const char *name = ofproto_port.name;
2582 if (shash_find(&p->port_by_name, name)) {
2583 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2586 struct ofputil_phy_port pp;
2587 struct netdev *netdev;
2589 /* Check if an OpenFlow port number had been requested. */
2590 node = shash_find(&init_ofp_ports, name);
2592 const struct iface_hint *iface_hint = node->data;
2593 simap_put(&p->ofp_requests, name,
2594 ofp_to_u16(iface_hint->ofp_port));
2597 netdev = ofport_open(p, &ofproto_port, &pp);
2599 ofport_install(p, netdev, &pp);
2600 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2601 p->alloc_port_no = MAX(p->alloc_port_no,
2602 ofp_to_u16(ofproto_port.ofp_port));
2608 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2609 struct iface_hint *iface_hint = node->data;
2611 if (!strcmp(iface_hint->br_name, p->name)) {
2612 free(iface_hint->br_name);
2613 free(iface_hint->br_type);
2615 shash_delete(&init_ofp_ports, node);
2622 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2623 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2625 find_min_mtu(struct ofproto *p)
2627 struct ofport *ofport;
2630 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2631 struct netdev *netdev = ofport->netdev;
2634 /* Skip any internal ports, since that's what we're trying to
2636 if (!strcmp(netdev_get_type(netdev), "internal")) {
2640 if (netdev_get_mtu(netdev, &dev_mtu)) {
2643 if (!mtu || dev_mtu < mtu) {
2648 return mtu ? mtu: ETH_PAYLOAD_MAX;
2651 /* Update MTU of all datapath devices on 'p' to the minimum of the
2652 * non-datapath ports in event of 'port' added or changed. */
2654 update_mtu(struct ofproto *p, struct ofport *port)
2656 struct ofport *ofport;
2657 struct netdev *netdev = port->netdev;
2658 int dev_mtu, old_min;
2660 if (netdev_get_mtu(netdev, &dev_mtu)) {
2664 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2665 if (dev_mtu > p->min_mtu) {
2666 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2667 dev_mtu = p->min_mtu;
2670 port->mtu = dev_mtu;
2674 /* For non-internal port find new min mtu. */
2675 old_min = p->min_mtu;
2676 port->mtu = dev_mtu;
2677 p->min_mtu = find_min_mtu(p);
2678 if (p->min_mtu == old_min) {
2682 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2683 struct netdev *netdev = ofport->netdev;
2685 if (!strcmp(netdev_get_type(netdev), "internal")) {
2686 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2687 ofport->mtu = p->min_mtu;
2694 ofproto_rule_destroy__(struct rule *rule)
2695 OVS_NO_THREAD_SAFETY_ANALYSIS
2697 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2698 rule_actions_destroy(rule_get_actions(rule));
2699 ovs_mutex_destroy(&rule->mutex);
2700 rule->ofproto->ofproto_class->rule_dealloc(rule);
2704 rule_destroy_cb(struct rule *rule)
2706 rule->ofproto->ofproto_class->rule_destruct(rule);
2707 ofproto_rule_destroy__(rule);
2711 ofproto_rule_ref(struct rule *rule)
2714 ovs_refcount_ref(&rule->ref_count);
2719 ofproto_rule_try_ref(struct rule *rule)
2722 return ovs_refcount_try_ref_rcu(&rule->ref_count);
2727 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2728 * ref_count reaches 0.
2730 * Use of RCU allows short term use (between RCU quiescent periods) without
2731 * keeping a reference. A reference must be taken if the rule needs to
2732 * stay around accross the RCU quiescent periods. */
2734 ofproto_rule_unref(struct rule *rule)
2736 if (rule && ovs_refcount_unref_relaxed(&rule->ref_count) == 1) {
2737 ovsrcu_postpone(rule_destroy_cb, rule);
2742 ofproto_group_ref(struct ofgroup *group)
2745 ovs_refcount_ref(&group->ref_count);
2750 ofproto_group_unref(struct ofgroup *group)
2752 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2753 group->ofproto->ofproto_class->group_destruct(group);
2754 ofputil_bucket_list_destroy(&group->buckets);
2755 group->ofproto->ofproto_class->group_dealloc(group);
2759 static uint32_t get_provider_meter_id(const struct ofproto *,
2760 uint32_t of_meter_id);
2762 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2763 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2764 const struct rule_actions *
2765 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2767 struct rule_actions *actions;
2769 actions = xmalloc(sizeof *actions + ofpacts_len);
2770 actions->ofpacts_len = ofpacts_len;
2771 actions->has_meter = ofpacts_get_meter(ofpacts, ofpacts_len) != 0;
2772 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2774 actions->has_learn_with_delete = (next_learn_with_delete(actions, NULL)
2780 /* Free the actions after the RCU quiescent period is reached. */
2782 rule_actions_destroy(const struct rule_actions *actions)
2785 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2789 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2790 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2792 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2793 OVS_REQUIRES(ofproto_mutex)
2795 if (port == OFPP_ANY) {
2798 const struct rule_actions *actions = rule_get_actions(rule);
2799 return ofpacts_output_to_port(actions->ofpacts,
2800 actions->ofpacts_len, port);
2804 /* Returns true if 'rule' has group and equals group_id. */
2806 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2807 OVS_REQUIRES(ofproto_mutex)
2809 if (group_id == OFPG_ANY) {
2812 const struct rule_actions *actions = rule_get_actions(rule);
2813 return ofpacts_output_to_group(actions->ofpacts,
2814 actions->ofpacts_len, group_id);
2819 rule_execute_destroy(struct rule_execute *e)
2821 ofproto_rule_unref(e->rule);
2822 list_remove(&e->list_node);
2826 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2827 * by passing them to the ofproto provider. */
2829 run_rule_executes(struct ofproto *ofproto)
2830 OVS_EXCLUDED(ofproto_mutex)
2832 struct rule_execute *e, *next;
2833 struct ovs_list executes;
2835 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2836 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2839 flow_extract(e->packet, &flow);
2840 flow.in_port.ofp_port = e->in_port;
2841 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2843 rule_execute_destroy(e);
2847 /* Destroys and discards all "rule_execute" operations queued up in
2848 * ofproto->rule_executes. */
2850 destroy_rule_executes(struct ofproto *ofproto)
2852 struct rule_execute *e, *next;
2853 struct ovs_list executes;
2855 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2856 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2857 dp_packet_delete(e->packet);
2858 rule_execute_destroy(e);
2863 rule_is_readonly(const struct rule *rule)
2865 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2866 return (table->flags & OFTABLE_READONLY) != 0;
2870 hash_learned_cookie(ovs_be64 cookie_, uint8_t table_id)
2872 uint64_t cookie = (OVS_FORCE uint64_t) cookie_;
2873 return hash_3words(cookie, cookie >> 32, table_id);
2877 learned_cookies_update_one__(struct ofproto *ofproto,
2878 const struct ofpact_learn *learn,
2879 int delta, struct ovs_list *dead_cookies)
2880 OVS_REQUIRES(ofproto_mutex)
2882 uint32_t hash = hash_learned_cookie(learn->cookie, learn->table_id);
2883 struct learned_cookie *c;
2885 HMAP_FOR_EACH_WITH_HASH (c, u.hmap_node, hash, &ofproto->learned_cookies) {
2886 if (c->cookie == learn->cookie && c->table_id == learn->table_id) {
2888 ovs_assert(c->n >= 0);
2891 hmap_remove(&ofproto->learned_cookies, &c->u.hmap_node);
2892 list_push_back(dead_cookies, &c->u.list_node);
2899 ovs_assert(delta > 0);
2900 c = xmalloc(sizeof *c);
2901 hmap_insert(&ofproto->learned_cookies, &c->u.hmap_node, hash);
2902 c->cookie = learn->cookie;
2903 c->table_id = learn->table_id;
2907 static const struct ofpact_learn *
2908 next_learn_with_delete(const struct rule_actions *actions,
2909 const struct ofpact_learn *start)
2911 const struct ofpact *pos;
2913 for (pos = start ? ofpact_next(&start->ofpact) : actions->ofpacts;
2914 pos < ofpact_end(actions->ofpacts, actions->ofpacts_len);
2915 pos = ofpact_next(pos)) {
2916 if (pos->type == OFPACT_LEARN) {
2917 const struct ofpact_learn *learn = ofpact_get_LEARN(pos);
2918 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
2928 learned_cookies_update__(struct ofproto *ofproto,
2929 const struct rule_actions *actions,
2930 int delta, struct ovs_list *dead_cookies)
2931 OVS_REQUIRES(ofproto_mutex)
2933 if (actions->has_learn_with_delete) {
2934 const struct ofpact_learn *learn;
2936 for (learn = next_learn_with_delete(actions, NULL); learn;
2937 learn = next_learn_with_delete(actions, learn)) {
2938 learned_cookies_update_one__(ofproto, learn, delta, dead_cookies);
2944 learned_cookies_inc(struct ofproto *ofproto,
2945 const struct rule_actions *actions)
2946 OVS_REQUIRES(ofproto_mutex)
2948 learned_cookies_update__(ofproto, actions, +1, NULL);
2952 learned_cookies_dec(struct ofproto *ofproto,
2953 const struct rule_actions *actions,
2954 struct ovs_list *dead_cookies)
2955 OVS_REQUIRES(ofproto_mutex)
2957 learned_cookies_update__(ofproto, actions, -1, dead_cookies);
2961 learned_cookies_flush(struct ofproto *ofproto, struct ovs_list *dead_cookies)
2962 OVS_REQUIRES(ofproto_mutex)
2964 struct learned_cookie *c, *next;
2966 LIST_FOR_EACH_SAFE (c, next, u.list_node, dead_cookies) {
2967 struct rule_criteria criteria;
2968 struct rule_collection rules;
2971 match_init_catchall(&match);
2972 rule_criteria_init(&criteria, c->table_id, &match, 0,
2973 c->cookie, OVS_BE64_MAX, OFPP_ANY, OFPG_ANY);
2974 rule_criteria_require_rw(&criteria, false);
2975 collect_rules_loose(ofproto, &criteria, &rules);
2976 delete_flows__(&rules, OFPRR_DELETE, NULL);
2977 rule_criteria_destroy(&criteria);
2978 rule_collection_destroy(&rules);
2980 list_remove(&c->u.list_node);
2986 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2988 ofconn_send_reply(ofconn, make_echo_reply(oh));
2993 query_tables(struct ofproto *ofproto,
2994 struct ofputil_table_features **featuresp,
2995 struct ofputil_table_stats **statsp)
2997 struct mf_bitmap rw_fields = oxm_writable_fields();
2998 struct mf_bitmap match = oxm_matchable_fields();
2999 struct mf_bitmap mask = oxm_maskable_fields();
3001 struct ofputil_table_features *features;
3002 struct ofputil_table_stats *stats;
3005 features = *featuresp = xcalloc(ofproto->n_tables, sizeof *features);
3006 for (i = 0; i < ofproto->n_tables; i++) {
3007 struct ofputil_table_features *f = &features[i];
3010 sprintf(f->name, "table%d", i);
3011 f->metadata_match = OVS_BE64_MAX;
3012 f->metadata_write = OVS_BE64_MAX;
3013 atomic_read_relaxed(&ofproto->tables[i].miss_config, &f->miss_config);
3014 f->max_entries = 1000000;
3016 bool more_tables = false;
3017 for (int j = i + 1; j < ofproto->n_tables; j++) {
3018 if (!(ofproto->tables[j].flags & OFTABLE_HIDDEN)) {
3019 bitmap_set1(f->nonmiss.next, j);
3023 f->nonmiss.instructions = (1u << N_OVS_INSTRUCTIONS) - 1;
3025 f->nonmiss.instructions &= ~(1u << OVSINST_OFPIT11_GOTO_TABLE);
3027 f->nonmiss.write.ofpacts = (UINT64_C(1) << N_OFPACTS) - 1;
3028 f->nonmiss.write.set_fields = rw_fields;
3029 f->nonmiss.apply = f->nonmiss.write;
3030 f->miss = f->nonmiss;
3034 f->wildcard = match;
3038 stats = *statsp = xcalloc(ofproto->n_tables, sizeof *stats);
3039 for (i = 0; i < ofproto->n_tables; i++) {
3040 struct ofputil_table_stats *s = &stats[i];
3041 struct classifier *cls = &ofproto->tables[i].cls;
3044 s->active_count = classifier_count(cls);
3046 s->active_count -= connmgr_count_hidden_rules(
3054 ofproto->ofproto_class->query_tables(ofproto, features, stats);
3056 for (i = 0; i < ofproto->n_tables; i++) {
3057 const struct oftable *table = &ofproto->tables[i];
3058 struct ofputil_table_features *f = &features[i];
3061 ovs_strzcpy(f->name, table->name, sizeof f->name);
3064 if (table->max_flows < f->max_entries) {
3065 f->max_entries = table->max_flows;
3071 query_switch_features(struct ofproto *ofproto,
3072 bool *arp_match_ip, uint64_t *ofpacts)
3074 struct ofputil_table_features *features, *f;
3076 *arp_match_ip = false;
3079 query_tables(ofproto, &features, NULL);
3080 for (f = features; f < &features[ofproto->n_tables]; f++) {
3081 *ofpacts |= f->nonmiss.apply.ofpacts | f->miss.apply.ofpacts;
3082 if (bitmap_is_set(f->match.bm, MFF_ARP_SPA) ||
3083 bitmap_is_set(f->match.bm, MFF_ARP_TPA)) {
3084 *arp_match_ip = true;
3090 ovs_assert(*ofpacts & (UINT64_C(1) << OFPACT_OUTPUT));
3094 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
3096 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3097 struct ofputil_switch_features features;
3098 struct ofport *port;
3102 query_switch_features(ofproto, &arp_match_ip, &features.ofpacts);
3104 features.datapath_id = ofproto->datapath_id;
3105 features.n_buffers = pktbuf_capacity();
3106 features.n_tables = ofproto_get_n_visible_tables(ofproto);
3107 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
3108 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS |
3109 OFPUTIL_C_GROUP_STATS);
3111 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
3113 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3114 features.auxiliary_id = 0;
3115 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
3117 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3118 ofputil_put_switch_features_port(&port->pp, b);
3121 ofconn_send_reply(ofconn, b);
3126 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
3128 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3129 struct ofp_switch_config *osc;
3130 enum ofp_config_flags flags;
3134 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
3135 osc = ofpbuf_put_uninit(buf, sizeof *osc);
3136 flags = ofproto->frag_handling;
3137 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3138 if (oh->version < OFP13_VERSION
3139 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
3140 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
3142 osc->flags = htons(flags);
3143 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
3144 ofconn_send_reply(ofconn, buf);
3150 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
3152 const struct ofp_switch_config *osc = ofpmsg_body(oh);
3153 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3154 uint16_t flags = ntohs(osc->flags);
3156 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
3157 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
3158 enum ofp_config_flags cur = ofproto->frag_handling;
3159 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
3161 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
3163 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
3164 ofproto->frag_handling = next;
3166 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
3168 ofputil_frag_handling_to_string(next));
3172 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3173 ofconn_set_invalid_ttl_to_controller(ofconn,
3174 (oh->version < OFP13_VERSION
3175 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
3177 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
3182 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3183 * error message code for the caller to propagate upward. Otherwise, returns
3186 * The log message mentions 'msg_type'. */
3188 reject_slave_controller(struct ofconn *ofconn)
3190 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
3191 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
3192 return OFPERR_OFPBRC_IS_SLAVE;
3198 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3201 * - If they use a meter, then 'ofproto' has that meter configured.
3203 * - If they use any groups, then 'ofproto' has that group configured.
3205 * Returns 0 if successful, otherwise an OpenFlow error. */
3207 ofproto_check_ofpacts(struct ofproto *ofproto,
3208 const struct ofpact ofpacts[], size_t ofpacts_len)
3210 const struct ofpact *a;
3213 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
3214 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
3215 return OFPERR_OFPMMFC_INVALID_METER;
3218 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3219 if (a->type == OFPACT_GROUP
3220 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
3221 return OFPERR_OFPBAC_BAD_OUT_GROUP;
3229 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3231 struct ofproto *p = ofconn_get_ofproto(ofconn);
3232 struct ofputil_packet_out po;
3233 struct dp_packet *payload;
3234 uint64_t ofpacts_stub[1024 / 8];
3235 struct ofpbuf ofpacts;
3239 COVERAGE_INC(ofproto_packet_out);
3241 error = reject_slave_controller(ofconn);
3246 /* Decode message. */
3247 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3248 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3250 goto exit_free_ofpacts;
3252 if (ofp_to_u16(po.in_port) >= p->max_ports
3253 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3254 error = OFPERR_OFPBRC_BAD_PORT;
3255 goto exit_free_ofpacts;
3259 if (po.buffer_id != UINT32_MAX) {
3260 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3261 if (error || !payload) {
3262 goto exit_free_ofpacts;
3265 /* Ensure that the L3 header is 32-bit aligned. */
3266 payload = dp_packet_clone_data_with_headroom(po.packet, po.packet_len, 2);
3269 /* Verify actions against packet, then send packet if successful. */
3270 flow_extract(payload, &flow);
3271 flow.in_port.ofp_port = po.in_port;
3272 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3274 error = p->ofproto_class->packet_out(p, payload, &flow,
3275 po.ofpacts, po.ofpacts_len);
3277 dp_packet_delete(payload);
3280 ofpbuf_uninit(&ofpacts);
3286 update_port_config(struct ofconn *ofconn, struct ofport *port,
3287 enum ofputil_port_config config,
3288 enum ofputil_port_config mask)
3290 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3292 if (toggle & OFPUTIL_PC_PORT_DOWN
3293 && (config & OFPUTIL_PC_PORT_DOWN
3294 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3295 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3296 /* We tried to bring the port up or down, but it failed, so don't
3297 * update the "down" bit. */
3298 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3302 enum ofputil_port_config old_config = port->pp.config;
3303 port->pp.config ^= toggle;
3304 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3305 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3311 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3313 struct ofproto *p = ofconn_get_ofproto(ofconn);
3314 struct ofputil_port_mod pm;
3315 struct ofport *port;
3318 error = reject_slave_controller(ofconn);
3323 error = ofputil_decode_port_mod(oh, &pm, false);
3328 port = ofproto_get_port(p, pm.port_no);
3330 return OFPERR_OFPPMFC_BAD_PORT;
3331 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3332 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3334 update_port_config(ofconn, port, pm.config, pm.mask);
3336 netdev_set_advertisements(port->netdev, pm.advertise);
3343 handle_desc_stats_request(struct ofconn *ofconn,
3344 const struct ofp_header *request)
3346 static const char *default_mfr_desc = "Nicira, Inc.";
3347 static const char *default_hw_desc = "Open vSwitch";
3348 static const char *default_sw_desc = VERSION;
3349 static const char *default_serial_desc = "None";
3350 static const char *default_dp_desc = "None";
3352 struct ofproto *p = ofconn_get_ofproto(ofconn);
3353 struct ofp_desc_stats *ods;
3356 msg = ofpraw_alloc_stats_reply(request, 0);
3357 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3358 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3359 sizeof ods->mfr_desc);
3360 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3361 sizeof ods->hw_desc);
3362 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3363 sizeof ods->sw_desc);
3364 ovs_strlcpy(ods->serial_num,
3365 p->serial_desc ? p->serial_desc : default_serial_desc,
3366 sizeof ods->serial_num);
3367 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3368 sizeof ods->dp_desc);
3369 ofconn_send_reply(ofconn, msg);
3375 handle_table_stats_request(struct ofconn *ofconn,
3376 const struct ofp_header *request)
3378 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3379 struct ofputil_table_features *features;
3380 struct ofputil_table_stats *stats;
3381 struct ofpbuf *reply;
3384 query_tables(ofproto, &features, &stats);
3386 reply = ofputil_encode_table_stats_reply(request);
3387 for (i = 0; i < ofproto->n_tables; i++) {
3388 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3389 ofputil_append_table_stats_reply(reply, &stats[i], &features[i]);
3392 ofconn_send_reply(ofconn, reply);
3401 handle_table_features_request(struct ofconn *ofconn,
3402 const struct ofp_header *request)
3404 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3405 struct ofputil_table_features *features;
3406 struct ovs_list replies;
3410 ofpbuf_use_const(&msg, request, ntohs(request->length));
3411 ofpraw_pull_assert(&msg);
3412 if (msg.size || ofpmp_more(request)) {
3413 return OFPERR_OFPTFFC_EPERM;
3416 query_tables(ofproto, &features, NULL);
3418 ofpmp_init(&replies, request);
3419 for (i = 0; i < ofproto->n_tables; i++) {
3420 if (!(ofproto->tables[i].flags & OFTABLE_HIDDEN)) {
3421 ofputil_append_table_features_reply(&features[i], &replies);
3424 ofconn_send_replies(ofconn, &replies);
3432 append_port_stat(struct ofport *port, struct ovs_list *replies)
3434 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3436 calc_duration(port->created, time_msec(),
3437 &ops.duration_sec, &ops.duration_nsec);
3439 /* Intentionally ignore return value, since errors will set
3440 * 'stats' to all-1s, which is correct for OpenFlow, and
3441 * netdev_get_stats() will log errors. */
3442 ofproto_port_get_stats(port, &ops.stats);
3444 ofputil_append_port_stat(replies, &ops);
3448 handle_port_request(struct ofconn *ofconn,
3449 const struct ofp_header *request, ofp_port_t port_no,
3450 void (*cb)(struct ofport *, struct ovs_list *replies))
3452 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3453 struct ofport *port;
3454 struct ovs_list replies;
3456 ofpmp_init(&replies, request);
3457 if (port_no != OFPP_ANY) {
3458 port = ofproto_get_port(ofproto, port_no);
3463 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3468 ofconn_send_replies(ofconn, &replies);
3472 handle_port_stats_request(struct ofconn *ofconn,
3473 const struct ofp_header *request)
3478 error = ofputil_decode_port_stats_request(request, &port_no);
3480 handle_port_request(ofconn, request, port_no, append_port_stat);
3486 append_port_desc(struct ofport *port, struct ovs_list *replies)
3488 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3492 handle_port_desc_stats_request(struct ofconn *ofconn,
3493 const struct ofp_header *request)
3498 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3500 handle_port_request(ofconn, request, port_no, append_port_desc);
3506 hash_cookie(ovs_be64 cookie)
3508 return hash_uint64((OVS_FORCE uint64_t)cookie);
3512 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3513 OVS_REQUIRES(ofproto_mutex)
3515 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3516 hash_cookie(rule->flow_cookie));
3520 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3521 OVS_REQUIRES(ofproto_mutex)
3523 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3527 calc_duration(long long int start, long long int now,
3528 uint32_t *sec, uint32_t *nsec)
3530 long long int msecs = now - start;
3531 *sec = msecs / 1000;
3532 *nsec = (msecs % 1000) * (1000 * 1000);
3535 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3536 * true if 'table_id' is OK, false otherwise. */
3538 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3540 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3543 static struct oftable *
3544 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3546 struct oftable *table;
3548 for (table = &ofproto->tables[table_id];
3549 table < &ofproto->tables[ofproto->n_tables];
3551 if (!(table->flags & OFTABLE_HIDDEN)) {
3559 static struct oftable *
3560 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3562 if (table_id == 0xff) {
3563 return next_visible_table(ofproto, 0);
3564 } else if (table_id < ofproto->n_tables) {
3565 return &ofproto->tables[table_id];
3571 static struct oftable *
3572 next_matching_table(const struct ofproto *ofproto,
3573 const struct oftable *table, uint8_t table_id)
3575 return (table_id == 0xff
3576 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3580 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3582 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3583 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3585 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3586 * only once, for that table. (This can be used to access tables marked
3589 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3590 * entered at all. (Perhaps you should have validated TABLE_ID with
3591 * check_table_id().)
3593 * All parameters are evaluated multiple times.
3595 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3596 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3598 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3600 /* Initializes 'criteria' in a straightforward way based on the other
3603 * By default, the criteria include flows that are read-only, on the assumption
3604 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3605 * if flows will be modified.
3607 * For "loose" matching, the 'priority' parameter is unimportant and may be
3610 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3611 const struct match *match, int priority,
3612 ovs_be64 cookie, ovs_be64 cookie_mask,
3613 ofp_port_t out_port, uint32_t out_group)
3615 criteria->table_id = table_id;
3616 cls_rule_init(&criteria->cr, match, priority);
3617 criteria->cookie = cookie;
3618 criteria->cookie_mask = cookie_mask;
3619 criteria->out_port = out_port;
3620 criteria->out_group = out_group;
3622 /* We ordinarily want to skip hidden rules, but there has to be a way for
3623 * code internal to OVS to modify and delete them, so if the criteria
3624 * specify a priority that can only be for a hidden flow, then allow hidden
3625 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3626 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3628 criteria->include_hidden = priority > UINT16_MAX;
3630 /* We assume that the criteria are being used to collect flows for reading
3631 * but not modification. Thus, we should collect read-only flows. */
3632 criteria->include_readonly = true;
3635 /* By default, criteria initialized by rule_criteria_init() will match flows
3636 * that are read-only, on the assumption that the collected flows won't be
3637 * modified. Call this function to match only flows that are be modifiable.
3639 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3640 * caller has special privileges that allow it to modify even "read-only"
3643 rule_criteria_require_rw(struct rule_criteria *criteria,
3644 bool can_write_readonly)
3646 criteria->include_readonly = can_write_readonly;
3650 rule_criteria_destroy(struct rule_criteria *criteria)
3652 cls_rule_destroy(&criteria->cr);
3656 rule_collection_init(struct rule_collection *rules)
3658 rules->rules = rules->stub;
3660 rules->capacity = ARRAY_SIZE(rules->stub);
3664 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3666 if (rules->n >= rules->capacity) {
3667 size_t old_size, new_size;
3669 old_size = rules->capacity * sizeof *rules->rules;
3670 rules->capacity *= 2;
3671 new_size = rules->capacity * sizeof *rules->rules;
3673 if (rules->rules == rules->stub) {
3674 rules->rules = xmalloc(new_size);
3675 memcpy(rules->rules, rules->stub, old_size);
3677 rules->rules = xrealloc(rules->rules, new_size);
3681 rules->rules[rules->n++] = rule;
3685 rule_collection_ref(struct rule_collection *rules)
3686 OVS_REQUIRES(ofproto_mutex)
3690 for (i = 0; i < rules->n; i++) {
3691 ofproto_rule_ref(rules->rules[i]);
3696 rule_collection_unref(struct rule_collection *rules)
3700 for (i = 0; i < rules->n; i++) {
3701 ofproto_rule_unref(rules->rules[i]);
3706 rule_collection_destroy(struct rule_collection *rules)
3708 if (rules->rules != rules->stub) {
3712 /* Make repeated destruction harmless. */
3713 rule_collection_init(rules);
3716 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3717 * function verifies most of the criteria in 'c' itself, but the caller must
3718 * check 'c->cr' itself.
3720 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3721 * 'c' only includes modifiable rules). */
3723 collect_rule(struct rule *rule, const struct rule_criteria *c,
3724 struct rule_collection *rules, size_t *n_readonly)
3725 OVS_REQUIRES(ofproto_mutex)
3727 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3728 && ofproto_rule_has_out_port(rule, c->out_port)
3729 && ofproto_rule_has_out_group(rule, c->out_group)
3730 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)
3731 && (!rule_is_hidden(rule) || c->include_hidden)) {
3732 /* Rule matches all the criteria... */
3733 if (!rule_is_readonly(rule) || c->include_readonly) {
3735 rule_collection_add(rules, rule);
3737 /* ...except it's read-only. */
3743 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3744 * on classifiers rules are done in the "loose" way required for OpenFlow
3745 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3748 * Returns 0 on success, otherwise an OpenFlow error code. */
3750 collect_rules_loose(struct ofproto *ofproto,
3751 const struct rule_criteria *criteria,
3752 struct rule_collection *rules)
3753 OVS_REQUIRES(ofproto_mutex)
3755 struct oftable *table;
3756 enum ofperr error = 0;
3757 size_t n_readonly = 0;
3759 rule_collection_init(rules);
3761 if (!check_table_id(ofproto, criteria->table_id)) {
3762 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3766 if (criteria->cookie_mask == OVS_BE64_MAX) {
3769 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3770 hash_cookie(criteria->cookie),
3771 &ofproto->cookies) {
3772 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3773 collect_rule(rule, criteria, rules, &n_readonly);
3777 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3780 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &criteria->cr) {
3781 collect_rule(rule, criteria, rules, &n_readonly);
3787 if (!error && !rules->n && n_readonly) {
3788 /* We didn't find any rules to modify. We did find some read-only
3789 * rules that we're not allowed to modify, so report that. */
3790 error = OFPERR_OFPBRC_EPERM;
3793 rule_collection_destroy(rules);
3798 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3799 * on classifiers rules are done in the "strict" way required for OpenFlow
3800 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3801 * rules on list 'rules'.
3803 * Returns 0 on success, otherwise an OpenFlow error code. */
3805 collect_rules_strict(struct ofproto *ofproto,
3806 const struct rule_criteria *criteria,
3807 struct rule_collection *rules)
3808 OVS_REQUIRES(ofproto_mutex)
3810 struct oftable *table;
3811 size_t n_readonly = 0;
3814 rule_collection_init(rules);
3816 if (!check_table_id(ofproto, criteria->table_id)) {
3817 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3821 if (criteria->cookie_mask == OVS_BE64_MAX) {
3824 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3825 hash_cookie(criteria->cookie),
3826 &ofproto->cookies) {
3827 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3828 collect_rule(rule, criteria, rules, &n_readonly);
3832 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3835 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3836 &table->cls, &criteria->cr));
3838 collect_rule(rule, criteria, rules, &n_readonly);
3844 if (!error && !rules->n && n_readonly) {
3845 /* We didn't find any rules to modify. We did find some read-only
3846 * rules that we're not allowed to modify, so report that. */
3847 error = OFPERR_OFPBRC_EPERM;
3850 rule_collection_destroy(rules);
3855 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3856 * forced into the range of a uint16_t. */
3858 age_secs(long long int age_ms)
3860 return (age_ms < 0 ? 0
3861 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3862 : (unsigned int) age_ms / 1000);
3866 handle_flow_stats_request(struct ofconn *ofconn,
3867 const struct ofp_header *request)
3868 OVS_EXCLUDED(ofproto_mutex)
3870 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3871 struct ofputil_flow_stats_request fsr;
3872 struct rule_criteria criteria;
3873 struct rule_collection rules;
3874 struct ovs_list replies;
3878 error = ofputil_decode_flow_stats_request(&fsr, request);
3883 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3884 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3886 ovs_mutex_lock(&ofproto_mutex);
3887 error = collect_rules_loose(ofproto, &criteria, &rules);
3888 rule_criteria_destroy(&criteria);
3890 rule_collection_ref(&rules);
3892 ovs_mutex_unlock(&ofproto_mutex);
3898 ofpmp_init(&replies, request);
3899 for (i = 0; i < rules.n; i++) {
3900 struct rule *rule = rules.rules[i];
3901 long long int now = time_msec();
3902 struct ofputil_flow_stats fs;
3903 long long int created, used, modified;
3904 const struct rule_actions *actions;
3905 enum ofputil_flow_mod_flags flags;
3907 ovs_mutex_lock(&rule->mutex);
3908 fs.cookie = rule->flow_cookie;
3909 fs.idle_timeout = rule->idle_timeout;
3910 fs.hard_timeout = rule->hard_timeout;
3911 fs.importance = rule->importance;
3912 created = rule->created;
3913 modified = rule->modified;
3914 actions = rule_get_actions(rule);
3915 flags = rule->flags;
3916 ovs_mutex_unlock(&rule->mutex);
3918 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3919 &fs.byte_count, &used);
3921 minimatch_expand(&rule->cr.match, &fs.match);
3922 fs.table_id = rule->table_id;
3923 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3924 fs.priority = rule->cr.priority;
3925 fs.idle_age = age_secs(now - used);
3926 fs.hard_age = age_secs(now - modified);
3927 fs.ofpacts = actions->ofpacts;
3928 fs.ofpacts_len = actions->ofpacts_len;
3931 ofputil_append_flow_stats_reply(&fs, &replies);
3934 rule_collection_unref(&rules);
3935 rule_collection_destroy(&rules);
3937 ofconn_send_replies(ofconn, &replies);
3943 flow_stats_ds(struct rule *rule, struct ds *results)
3945 uint64_t packet_count, byte_count;
3946 const struct rule_actions *actions;
3947 long long int created, used;
3949 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3950 &byte_count, &used);
3952 ovs_mutex_lock(&rule->mutex);
3953 actions = rule_get_actions(rule);
3954 created = rule->created;
3955 ovs_mutex_unlock(&rule->mutex);
3957 if (rule->table_id != 0) {
3958 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3960 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3961 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3962 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3963 cls_rule_format(&rule->cr, results);
3964 ds_put_char(results, ',');
3966 ds_put_cstr(results, "actions=");
3967 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3969 ds_put_cstr(results, "\n");
3972 /* Adds a pretty-printed description of all flows to 'results', including
3973 * hidden flows (e.g., set up by in-band control). */
3975 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3977 struct oftable *table;
3979 OFPROTO_FOR_EACH_TABLE (table, p) {
3982 CLS_FOR_EACH (rule, cr, &table->cls) {
3983 flow_stats_ds(rule, results);
3988 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3989 * '*engine_type' and '*engine_id', respectively. */
3991 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3992 uint8_t *engine_type, uint8_t *engine_id)
3994 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3997 /* Checks the status change of CFM on 'ofport'.
3999 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4001 ofproto_port_cfm_status_changed(struct ofproto *ofproto, ofp_port_t ofp_port)
4003 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4004 return (ofport && ofproto->ofproto_class->cfm_status_changed
4005 ? ofproto->ofproto_class->cfm_status_changed(ofport)
4009 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4010 * Returns 0 if the port's CFM status was successfully stored into
4011 * '*status'. Returns positive errno if the port did not have CFM
4014 * The caller must provide and own '*status', and must free 'status->rmps'.
4015 * '*status' is indeterminate if the return value is non-zero. */
4017 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
4018 struct cfm_status *status)
4020 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
4021 return (ofport && ofproto->ofproto_class->get_cfm_status
4022 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
4027 handle_aggregate_stats_request(struct ofconn *ofconn,
4028 const struct ofp_header *oh)
4029 OVS_EXCLUDED(ofproto_mutex)
4031 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4032 struct ofputil_flow_stats_request request;
4033 struct ofputil_aggregate_stats stats;
4034 bool unknown_packets, unknown_bytes;
4035 struct rule_criteria criteria;
4036 struct rule_collection rules;
4037 struct ofpbuf *reply;
4041 error = ofputil_decode_flow_stats_request(&request, oh);
4046 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
4047 request.cookie, request.cookie_mask,
4048 request.out_port, request.out_group);
4050 ovs_mutex_lock(&ofproto_mutex);
4051 error = collect_rules_loose(ofproto, &criteria, &rules);
4052 rule_criteria_destroy(&criteria);
4054 rule_collection_ref(&rules);
4056 ovs_mutex_unlock(&ofproto_mutex);
4062 memset(&stats, 0, sizeof stats);
4063 unknown_packets = unknown_bytes = false;
4064 for (i = 0; i < rules.n; i++) {
4065 struct rule *rule = rules.rules[i];
4066 uint64_t packet_count;
4067 uint64_t byte_count;
4070 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
4071 &byte_count, &used);
4073 if (packet_count == UINT64_MAX) {
4074 unknown_packets = true;
4076 stats.packet_count += packet_count;
4079 if (byte_count == UINT64_MAX) {
4080 unknown_bytes = true;
4082 stats.byte_count += byte_count;
4087 if (unknown_packets) {
4088 stats.packet_count = UINT64_MAX;
4090 if (unknown_bytes) {
4091 stats.byte_count = UINT64_MAX;
4094 rule_collection_unref(&rules);
4095 rule_collection_destroy(&rules);
4097 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
4098 ofconn_send_reply(ofconn, reply);
4103 struct queue_stats_cbdata {
4104 struct ofport *ofport;
4105 struct ovs_list replies;
4110 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
4111 const struct netdev_queue_stats *stats)
4113 struct ofputil_queue_stats oqs;
4115 oqs.port_no = cbdata->ofport->pp.port_no;
4116 oqs.queue_id = queue_id;
4117 oqs.tx_bytes = stats->tx_bytes;
4118 oqs.tx_packets = stats->tx_packets;
4119 oqs.tx_errors = stats->tx_errors;
4120 if (stats->created != LLONG_MIN) {
4121 calc_duration(stats->created, cbdata->now,
4122 &oqs.duration_sec, &oqs.duration_nsec);
4124 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
4126 ofputil_append_queue_stat(&cbdata->replies, &oqs);
4130 handle_queue_stats_dump_cb(uint32_t queue_id,
4131 struct netdev_queue_stats *stats,
4134 struct queue_stats_cbdata *cbdata = cbdata_;
4136 put_queue_stats(cbdata, queue_id, stats);
4140 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
4141 struct queue_stats_cbdata *cbdata)
4143 cbdata->ofport = port;
4144 if (queue_id == OFPQ_ALL) {
4145 netdev_dump_queue_stats(port->netdev,
4146 handle_queue_stats_dump_cb, cbdata);
4148 struct netdev_queue_stats stats;
4150 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
4151 put_queue_stats(cbdata, queue_id, &stats);
4153 return OFPERR_OFPQOFC_BAD_QUEUE;
4160 handle_queue_stats_request(struct ofconn *ofconn,
4161 const struct ofp_header *rq)
4163 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4164 struct queue_stats_cbdata cbdata;
4165 struct ofport *port;
4167 struct ofputil_queue_stats_request oqsr;
4169 COVERAGE_INC(ofproto_queue_req);
4171 ofpmp_init(&cbdata.replies, rq);
4172 cbdata.now = time_msec();
4174 error = ofputil_decode_queue_stats_request(rq, &oqsr);
4179 if (oqsr.port_no == OFPP_ANY) {
4180 error = OFPERR_OFPQOFC_BAD_QUEUE;
4181 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
4182 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
4187 port = ofproto_get_port(ofproto, oqsr.port_no);
4189 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
4190 : OFPERR_OFPQOFC_BAD_PORT);
4193 ofconn_send_replies(ofconn, &cbdata.replies);
4195 ofpbuf_list_delete(&cbdata.replies);
4202 evict_rules_from_table(struct oftable *table, unsigned int extra_space)
4203 OVS_REQUIRES(ofproto_mutex)
4205 enum ofperr error = 0;
4206 struct rule_collection rules;
4207 unsigned int count = classifier_count(&table->cls) + extra_space;
4208 unsigned int max_flows = table->max_flows;
4210 rule_collection_init(&rules);
4212 while (count-- > max_flows) {
4215 if (!choose_rule_to_evict(table, &rule)) {
4216 error = OFPERR_OFPFMFC_TABLE_FULL;
4219 eviction_group_remove_rule(rule);
4220 rule_collection_add(&rules, rule);
4223 delete_flows__(&rules, OFPRR_EVICTION, NULL);
4224 rule_collection_destroy(&rules);
4230 is_conjunction(const struct ofpact *ofpacts, size_t ofpacts_len)
4232 return ofpacts_len > 0 && ofpacts->type == OFPACT_CONJUNCTION;
4236 get_conjunctions(const struct ofputil_flow_mod *fm,
4237 struct cls_conjunction **conjsp, size_t *n_conjsp)
4238 OVS_REQUIRES(ofproto_mutex)
4240 struct cls_conjunction *conjs = NULL;
4243 if (is_conjunction(fm->ofpacts, fm->ofpacts_len)) {
4244 const struct ofpact *ofpact;
4248 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4252 conjs = xzalloc(n_conjs * sizeof *conjs);
4254 OFPACT_FOR_EACH (ofpact, fm->ofpacts, fm->ofpacts_len) {
4255 struct ofpact_conjunction *oc = ofpact_get_CONJUNCTION(ofpact);
4256 conjs[i].clause = oc->clause;
4257 conjs[i].n_clauses = oc->n_clauses;
4258 conjs[i].id = oc->id;
4264 *n_conjsp = n_conjs;
4268 set_conjunctions(struct rule *rule, const struct cls_conjunction *conjs,
4270 OVS_REQUIRES(ofproto_mutex)
4272 struct cls_rule *cr = CONST_CAST(struct cls_rule *, &rule->cr);
4274 cls_rule_set_conjunctions(cr, conjs, n_conjs);
4277 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4278 * in which no matching flow already exists in the flow table.
4280 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4281 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4282 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4283 * initiated now but may be retried later.
4285 * The caller retains ownership of 'fm->ofpacts'.
4287 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4290 add_flow(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4291 const struct flow_mod_requester *req)
4292 OVS_REQUIRES(ofproto_mutex)
4294 const struct rule_actions *actions;
4295 struct oftable *table;
4301 if (!check_table_id(ofproto, fm->table_id)) {
4302 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4307 if (fm->table_id == 0xff) {
4308 if (ofproto->ofproto_class->rule_choose_table) {
4309 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4315 ovs_assert(table_id < ofproto->n_tables);
4319 } else if (fm->table_id < ofproto->n_tables) {
4320 table_id = fm->table_id;
4322 return OFPERR_OFPBRC_BAD_TABLE_ID;
4325 table = &ofproto->tables[table_id];
4326 if (table->flags & OFTABLE_READONLY
4327 && !(fm->flags & OFPUTIL_FF_NO_READONLY)) {
4328 return OFPERR_OFPBRC_EPERM;
4331 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4332 if (!match_has_default_hidden_fields(&fm->match)) {
4333 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4334 "non-default values to hidden fields", ofproto->name);
4335 return OFPERR_OFPBRC_EPERM;
4339 cls_rule_init(&cr, &fm->match, fm->priority);
4341 /* Transform "add" into "modify" if there's an existing identical flow. */
4342 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4344 struct rule_collection rules;
4346 cls_rule_destroy(&cr);
4348 rule_collection_init(&rules);
4349 rule_collection_add(&rules, rule);
4350 fm->modify_cookie = true;
4351 error = modify_flows__(ofproto, fm, &rules, req);
4352 rule_collection_destroy(&rules);
4357 /* Check for overlap, if requested. */
4358 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4359 if (classifier_rule_overlaps(&table->cls, &cr)) {
4360 cls_rule_destroy(&cr);
4361 return OFPERR_OFPFMFC_OVERLAP;
4365 /* If necessary, evict an existing rule to clear out space. */
4366 error = evict_rules_from_table(table, 1);
4368 cls_rule_destroy(&cr);
4372 /* Allocate new rule. */
4373 rule = ofproto->ofproto_class->rule_alloc();
4375 cls_rule_destroy(&cr);
4376 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4377 ofproto->name, ovs_strerror(error));
4381 /* Initialize base state. */
4382 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4383 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4384 ovs_refcount_init(&rule->ref_count);
4385 rule->flow_cookie = fm->new_cookie;
4386 rule->created = rule->modified = time_msec();
4388 ovs_mutex_init(&rule->mutex);
4389 ovs_mutex_lock(&rule->mutex);
4390 rule->idle_timeout = fm->idle_timeout;
4391 rule->hard_timeout = fm->hard_timeout;
4392 rule->importance = fm->importance;
4393 ovs_mutex_unlock(&rule->mutex);
4395 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4396 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4397 actions = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
4398 ovsrcu_set(&rule->actions, actions);
4399 list_init(&rule->meter_list_node);
4400 rule->eviction_group = NULL;
4401 list_init(&rule->expirable);
4402 rule->monitor_flags = 0;
4403 rule->add_seqno = 0;
4404 rule->modify_seqno = 0;
4406 /* Construct rule, initializing derived state. */
4407 error = ofproto->ofproto_class->rule_construct(rule);
4409 ofproto_rule_destroy__(rule);
4413 if (fm->hard_timeout || fm->idle_timeout) {
4414 list_insert(&ofproto->expirable, &rule->expirable);
4416 cookies_insert(ofproto, rule);
4417 eviction_group_add_rule(rule);
4418 if (actions->has_meter) {
4419 meter_insert_rule(rule);
4422 classifier_defer(&table->cls);
4424 struct cls_conjunction *conjs;
4426 get_conjunctions(fm, &conjs, &n_conjs);
4427 classifier_insert(&table->cls, &rule->cr, conjs, n_conjs);
4430 error = ofproto->ofproto_class->rule_insert(rule);
4432 oftable_remove_rule(rule);
4433 ofproto_rule_unref(rule);
4436 classifier_publish(&table->cls);
4438 learned_cookies_inc(ofproto, actions);
4440 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
4441 if (ofproto->vlan_bitmap) {
4442 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4443 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4444 bitmap_set1(ofproto->vlan_bitmap, vid);
4445 ofproto->vlans_changed = true;
4448 ofproto->vlans_changed = true;
4452 ofmonitor_report(ofproto->connmgr, rule, NXFME_ADDED, 0,
4453 req ? req->ofconn : NULL, req ? req->xid : 0, NULL);
4455 return req ? send_buffered_packet(req->ofconn, fm->buffer_id, rule) : 0;
4458 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4460 /* Modifies the rules listed in 'rules', changing their actions to match those
4463 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4466 * Returns 0 on success, otherwise an OpenFlow error code. */
4468 modify_flows__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4469 const struct rule_collection *rules,
4470 const struct flow_mod_requester *req)
4471 OVS_REQUIRES(ofproto_mutex)
4473 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4474 enum nx_flow_update_event event;
4477 if (ofproto->ofproto_class->rule_premodify_actions) {
4478 for (i = 0; i < rules->n; i++) {
4479 struct rule *rule = rules->rules[i];
4482 error = ofproto->ofproto_class->rule_premodify_actions(
4483 rule, fm->ofpacts, fm->ofpacts_len);
4490 event = fm->command == OFPFC_ADD ? NXFME_ADDED : NXFME_MODIFIED;
4491 for (i = 0; i < rules->n; i++) {
4492 struct rule *rule = rules->rules[i];
4494 /* 'fm' says that */
4495 bool change_cookie = (fm->modify_cookie
4496 && fm->new_cookie != OVS_BE64_MAX
4497 && fm->new_cookie != rule->flow_cookie);
4499 const struct rule_actions *actions = rule_get_actions(rule);
4500 bool change_actions = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4502 actions->ofpacts_len);
4504 bool reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4506 long long int now = time_msec();
4508 if (change_cookie) {
4509 cookies_remove(ofproto, rule);
4512 ovs_mutex_lock(&rule->mutex);
4513 if (fm->command == OFPFC_ADD) {
4514 rule->idle_timeout = fm->idle_timeout;
4515 rule->hard_timeout = fm->hard_timeout;
4516 rule->importance = fm->importance;
4517 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4518 rule->created = now;
4520 if (change_cookie) {
4521 rule->flow_cookie = fm->new_cookie;
4523 rule->modified = now;
4524 ovs_mutex_unlock(&rule->mutex);
4526 if (change_cookie) {
4527 cookies_insert(ofproto, rule);
4529 if (fm->command == OFPFC_ADD) {
4530 if (fm->idle_timeout || fm->hard_timeout || fm->importance) {
4531 if (!rule->eviction_group) {
4532 eviction_group_add_rule(rule);
4535 eviction_group_remove_rule(rule);
4539 if (change_actions) {
4540 /* We have to change the actions. The rule's conjunctive match set
4541 * is a function of its actions, so we need to update that too. The
4542 * conjunctive match set is used in the lookup process to figure
4543 * which (if any) collection of conjunctive sets the packet matches
4544 * with. However, a rule with conjunction actions is never to be
4545 * returned as a classifier lookup result. To make sure a rule with
4546 * conjunction actions is not returned as a lookup result, we update
4547 * them in a carefully chosen order:
4549 * - If we're adding a conjunctive match set where there wasn't one
4550 * before, we have to make the conjunctive match set available to
4551 * lookups before the rule's actions are changed, as otherwise
4552 * rule with a conjunction action could be returned as a lookup
4555 * - To clear some nonempty conjunctive set, we set the rule's
4556 * actions first, so that a lookup can't return a rule with
4557 * conjunction actions.
4559 * - Otherwise, order doesn't matter for changing one nonempty
4560 * conjunctive match set to some other nonempty set, since the
4561 * rule's actions are not seen by the classifier, and hence don't
4562 * matter either before or after the change. */
4563 struct cls_conjunction *conjs;
4565 get_conjunctions(fm, &conjs, &n_conjs);
4568 set_conjunctions(rule, conjs, n_conjs);
4570 ovsrcu_set(&rule->actions, rule_actions_create(fm->ofpacts,
4573 set_conjunctions(rule, conjs, n_conjs);
4579 if (change_actions || reset_counters) {
4580 ofproto->ofproto_class->rule_modify_actions(rule, reset_counters);
4583 if (event != NXFME_MODIFIED || change_actions || change_cookie) {
4584 ofmonitor_report(ofproto->connmgr, rule, event, 0,
4585 req ? req->ofconn : NULL, req ? req->xid : 0,
4586 change_actions ? actions : NULL);
4589 if (change_actions) {
4590 learned_cookies_inc(ofproto, rule_get_actions(rule));
4591 learned_cookies_dec(ofproto, actions, &dead_cookies);
4592 rule_actions_destroy(actions);
4595 learned_cookies_flush(ofproto, &dead_cookies);
4597 if (fm->buffer_id != UINT32_MAX && req) {
4598 return send_buffered_packet(req->ofconn, fm->buffer_id,
4606 modify_flows_add(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4607 const struct flow_mod_requester *req)
4608 OVS_REQUIRES(ofproto_mutex)
4610 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4613 return add_flow(ofproto, fm, req);
4616 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4619 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4622 modify_flows_loose(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4623 const struct flow_mod_requester *req)
4624 OVS_REQUIRES(ofproto_mutex)
4626 struct rule_criteria criteria;
4627 struct rule_collection rules;
4630 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4631 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4632 rule_criteria_require_rw(&criteria,
4633 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4634 error = collect_rules_loose(ofproto, &criteria, &rules);
4635 rule_criteria_destroy(&criteria);
4638 error = (rules.n > 0
4639 ? modify_flows__(ofproto, fm, &rules, req)
4640 : modify_flows_add(ofproto, fm, req));
4643 rule_collection_destroy(&rules);
4648 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4649 * code on failure. */
4651 modify_flow_strict(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4652 const struct flow_mod_requester *req)
4653 OVS_REQUIRES(ofproto_mutex)
4655 struct rule_criteria criteria;
4656 struct rule_collection rules;
4659 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4660 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4661 rule_criteria_require_rw(&criteria,
4662 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4663 error = collect_rules_strict(ofproto, &criteria, &rules);
4664 rule_criteria_destroy(&criteria);
4668 error = modify_flows_add(ofproto, fm, req);
4669 } else if (rules.n == 1) {
4670 error = modify_flows__(ofproto, fm, &rules, req);
4674 rule_collection_destroy(&rules);
4679 /* OFPFC_DELETE implementation. */
4681 /* Deletes the rules listed in 'rules'. */
4683 delete_flows__(const struct rule_collection *rules,
4684 enum ofp_flow_removed_reason reason,
4685 const struct flow_mod_requester *req)
4686 OVS_REQUIRES(ofproto_mutex)
4689 struct ovs_list dead_cookies = OVS_LIST_INITIALIZER(&dead_cookies);
4690 struct ofproto *ofproto = rules->rules[0]->ofproto;
4691 struct rule *rule, *next;
4694 for (i = 0, next = rules->rules[0];
4695 rule = next, next = (++i < rules->n) ? rules->rules[i] : NULL,
4697 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
4698 uint8_t next_table = next ? next->table_id : UINT8_MAX;
4700 ofproto_rule_send_removed(rule, reason);
4702 ofmonitor_report(ofproto->connmgr, rule, NXFME_DELETED, reason,
4703 req ? req->ofconn : NULL, req ? req->xid : 0,
4706 if (next_table == rule->table_id) {
4707 classifier_defer(cls);
4709 classifier_remove(cls, &rule->cr);
4710 if (next_table != rule->table_id) {
4711 classifier_publish(cls);
4713 ofproto_rule_remove__(ofproto, rule);
4715 ofproto->ofproto_class->rule_delete(rule);
4717 learned_cookies_dec(ofproto, rule_get_actions(rule),
4720 learned_cookies_flush(ofproto, &dead_cookies);
4721 ofmonitor_flush(ofproto->connmgr);
4725 /* Implements OFPFC_DELETE. */
4727 delete_flows_loose(struct ofproto *ofproto,
4728 const struct ofputil_flow_mod *fm,
4729 const struct flow_mod_requester *req)
4730 OVS_REQUIRES(ofproto_mutex)
4732 struct rule_criteria criteria;
4733 struct rule_collection rules;
4736 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4737 fm->cookie, fm->cookie_mask,
4738 fm->out_port, fm->out_group);
4739 rule_criteria_require_rw(&criteria,
4740 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4741 error = collect_rules_loose(ofproto, &criteria, &rules);
4742 rule_criteria_destroy(&criteria);
4745 delete_flows__(&rules, fm->delete_reason, req);
4747 rule_collection_destroy(&rules);
4752 /* Implements OFPFC_DELETE_STRICT. */
4754 delete_flow_strict(struct ofproto *ofproto, const struct ofputil_flow_mod *fm,
4755 const struct flow_mod_requester *req)
4756 OVS_REQUIRES(ofproto_mutex)
4758 struct rule_criteria criteria;
4759 struct rule_collection rules;
4762 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4763 fm->cookie, fm->cookie_mask,
4764 fm->out_port, fm->out_group);
4765 rule_criteria_require_rw(&criteria,
4766 (fm->flags & OFPUTIL_FF_NO_READONLY) != 0);
4767 error = collect_rules_strict(ofproto, &criteria, &rules);
4768 rule_criteria_destroy(&criteria);
4771 delete_flows__(&rules, fm->delete_reason, req);
4773 rule_collection_destroy(&rules);
4779 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4780 OVS_REQUIRES(ofproto_mutex)
4782 struct ofputil_flow_removed fr;
4785 if (rule_is_hidden(rule) ||
4786 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4790 minimatch_expand(&rule->cr.match, &fr.match);
4791 fr.priority = rule->cr.priority;
4792 fr.cookie = rule->flow_cookie;
4794 fr.table_id = rule->table_id;
4795 calc_duration(rule->created, time_msec(),
4796 &fr.duration_sec, &fr.duration_nsec);
4797 ovs_mutex_lock(&rule->mutex);
4798 fr.idle_timeout = rule->idle_timeout;
4799 fr.hard_timeout = rule->hard_timeout;
4800 ovs_mutex_unlock(&rule->mutex);
4801 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4802 &fr.byte_count, &used);
4804 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4807 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4808 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4811 * ofproto implementation ->run() functions should use this function to expire
4812 * OpenFlow flows. */
4814 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4815 OVS_REQUIRES(ofproto_mutex)
4817 struct rule_collection rules;
4819 rules.rules = rules.stub;
4821 rules.stub[0] = rule;
4822 delete_flows__(&rules, reason, NULL);
4825 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4826 * means "infinite". */
4828 reduce_timeout(uint16_t max, uint16_t *timeout)
4830 if (max && (!*timeout || *timeout > max)) {
4835 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4836 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4837 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4839 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4841 ofproto_rule_reduce_timeouts(struct rule *rule,
4842 uint16_t idle_timeout, uint16_t hard_timeout)
4843 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4845 if (!idle_timeout && !hard_timeout) {
4849 ovs_mutex_lock(&ofproto_mutex);
4850 if (list_is_empty(&rule->expirable)) {
4851 list_insert(&rule->ofproto->expirable, &rule->expirable);
4853 ovs_mutex_unlock(&ofproto_mutex);
4855 ovs_mutex_lock(&rule->mutex);
4856 reduce_timeout(idle_timeout, &rule->idle_timeout);
4857 reduce_timeout(hard_timeout, &rule->hard_timeout);
4858 ovs_mutex_unlock(&rule->mutex);
4862 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4863 OVS_EXCLUDED(ofproto_mutex)
4865 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4866 struct ofputil_flow_mod fm;
4867 uint64_t ofpacts_stub[1024 / 8];
4868 struct ofpbuf ofpacts;
4871 error = reject_slave_controller(ofconn);
4876 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4877 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4879 u16_to_ofp(ofproto->max_ports),
4882 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4885 struct flow_mod_requester req;
4887 req.ofconn = ofconn;
4889 error = handle_flow_mod__(ofproto, &fm, &req);
4892 goto exit_free_ofpacts;
4895 ofconn_report_flow_mod(ofconn, fm.command);
4898 ofpbuf_uninit(&ofpacts);
4904 handle_flow_mod__(struct ofproto *ofproto, struct ofputil_flow_mod *fm,
4905 const struct flow_mod_requester *req)
4906 OVS_EXCLUDED(ofproto_mutex)
4910 ovs_mutex_lock(&ofproto_mutex);
4911 switch (fm->command) {
4913 error = add_flow(ofproto, fm, req);
4917 error = modify_flows_loose(ofproto, fm, req);
4920 case OFPFC_MODIFY_STRICT:
4921 error = modify_flow_strict(ofproto, fm, req);
4925 error = delete_flows_loose(ofproto, fm, req);
4928 case OFPFC_DELETE_STRICT:
4929 error = delete_flow_strict(ofproto, fm, req);
4933 if (fm->command > 0xff) {
4934 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4935 "flow_mod_table_id extension is not enabled",
4938 error = OFPERR_OFPFMFC_BAD_COMMAND;
4941 ofmonitor_flush(ofproto->connmgr);
4942 ovs_mutex_unlock(&ofproto_mutex);
4944 run_rule_executes(ofproto);
4949 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4951 struct ofputil_role_request request;
4952 struct ofputil_role_request reply;
4956 error = ofputil_decode_role_message(oh, &request);
4961 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4962 if (request.have_generation_id
4963 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4964 return OFPERR_OFPRRFC_STALE;
4967 ofconn_set_role(ofconn, request.role);
4970 reply.role = ofconn_get_role(ofconn);
4971 reply.have_generation_id = ofconn_get_master_election_id(
4972 ofconn, &reply.generation_id);
4973 buf = ofputil_encode_role_reply(oh, &reply);
4974 ofconn_send_reply(ofconn, buf);
4980 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4981 const struct ofp_header *oh)
4983 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4984 enum ofputil_protocol cur, next;
4986 cur = ofconn_get_protocol(ofconn);
4987 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4988 ofconn_set_protocol(ofconn, next);
4994 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4996 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4997 enum ofputil_protocol cur, next;
4998 enum ofputil_protocol next_base;
5000 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
5002 return OFPERR_OFPBRC_EPERM;
5005 cur = ofconn_get_protocol(ofconn);
5006 next = ofputil_protocol_set_base(cur, next_base);
5007 ofconn_set_protocol(ofconn, next);
5013 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
5014 const struct ofp_header *oh)
5016 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
5019 format = ntohl(msg->format);
5020 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
5021 return OFPERR_OFPBRC_EPERM;
5024 ofconn_set_packet_in_format(ofconn, format);
5029 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
5031 const struct nx_async_config *msg = ofpmsg_body(oh);
5032 uint32_t master[OAM_N_TYPES];
5033 uint32_t slave[OAM_N_TYPES];
5035 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
5036 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
5037 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
5039 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
5040 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
5041 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
5043 ofconn_set_async_config(ofconn, master, slave);
5044 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
5045 !ofconn_get_miss_send_len(ofconn)) {
5046 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
5053 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
5056 uint32_t master[OAM_N_TYPES];
5057 uint32_t slave[OAM_N_TYPES];
5058 struct nx_async_config *msg;
5060 ofconn_get_async_config(ofconn, master, slave);
5061 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
5062 msg = ofpbuf_put_zeros(buf, sizeof *msg);
5064 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
5065 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
5066 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
5068 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
5069 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
5070 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
5072 ofconn_send_reply(ofconn, buf);
5078 handle_nxt_set_controller_id(struct ofconn *ofconn,
5079 const struct ofp_header *oh)
5081 const struct nx_controller_id *nci = ofpmsg_body(oh);
5083 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
5084 return OFPERR_NXBRC_MUST_BE_ZERO;
5087 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
5092 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
5096 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
5097 ? OFPRAW_OFPT10_BARRIER_REPLY
5098 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
5099 ofconn_send_reply(ofconn, buf);
5104 ofproto_compose_flow_refresh_update(const struct rule *rule,
5105 enum nx_flow_monitor_flags flags,
5106 struct ovs_list *msgs)
5107 OVS_REQUIRES(ofproto_mutex)
5109 const struct rule_actions *actions;
5110 struct ofputil_flow_update fu;
5113 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
5114 ? NXFME_ADDED : NXFME_MODIFIED);
5116 ovs_mutex_lock(&rule->mutex);
5117 fu.idle_timeout = rule->idle_timeout;
5118 fu.hard_timeout = rule->hard_timeout;
5119 ovs_mutex_unlock(&rule->mutex);
5120 fu.table_id = rule->table_id;
5121 fu.cookie = rule->flow_cookie;
5122 minimatch_expand(&rule->cr.match, &match);
5124 fu.priority = rule->cr.priority;
5126 actions = flags & NXFMF_ACTIONS ? rule_get_actions(rule) : NULL;
5127 fu.ofpacts = actions ? actions->ofpacts : NULL;
5128 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
5130 if (list_is_empty(msgs)) {
5131 ofputil_start_flow_update(msgs);
5133 ofputil_append_flow_update(&fu, msgs);
5137 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
5138 struct ovs_list *msgs)
5139 OVS_REQUIRES(ofproto_mutex)
5143 for (i = 0; i < rules->n; i++) {
5144 struct rule *rule = rules->rules[i];
5145 enum nx_flow_monitor_flags flags = rule->monitor_flags;
5146 rule->monitor_flags = 0;
5148 ofproto_compose_flow_refresh_update(rule, flags, msgs);
5153 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
5154 struct rule *rule, uint64_t seqno,
5155 struct rule_collection *rules)
5156 OVS_REQUIRES(ofproto_mutex)
5158 enum nx_flow_monitor_flags update;
5160 if (rule_is_hidden(rule)) {
5164 if (!ofproto_rule_has_out_port(rule, m->out_port)) {
5169 if (rule->add_seqno > seqno) {
5170 update = NXFMF_ADD | NXFMF_MODIFY;
5171 } else if (rule->modify_seqno > seqno) {
5172 update = NXFMF_MODIFY;
5177 if (!(m->flags & update)) {
5181 update = NXFMF_INITIAL;
5184 if (!rule->monitor_flags) {
5185 rule_collection_add(rules, rule);
5187 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
5191 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
5193 struct rule_collection *rules)
5194 OVS_REQUIRES(ofproto_mutex)
5196 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
5197 const struct oftable *table;
5198 struct cls_rule target;
5200 cls_rule_init_from_minimatch(&target, &m->match, 0);
5201 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
5204 CLS_FOR_EACH_TARGET (rule, cr, &table->cls, &target) {
5205 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
5208 cls_rule_destroy(&target);
5212 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
5213 struct rule_collection *rules)
5214 OVS_REQUIRES(ofproto_mutex)
5216 if (m->flags & NXFMF_INITIAL) {
5217 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
5222 ofmonitor_collect_resume_rules(struct ofmonitor *m,
5223 uint64_t seqno, struct rule_collection *rules)
5224 OVS_REQUIRES(ofproto_mutex)
5226 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
5230 flow_monitor_delete(struct ofconn *ofconn, uint32_t id)
5231 OVS_REQUIRES(ofproto_mutex)
5233 struct ofmonitor *m;
5236 m = ofmonitor_lookup(ofconn, id);
5238 ofmonitor_destroy(m);
5241 error = OFPERR_OFPMOFC_UNKNOWN_MONITOR;
5248 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
5249 OVS_EXCLUDED(ofproto_mutex)
5251 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5252 struct ofmonitor **monitors;
5253 size_t n_monitors, allocated_monitors;
5254 struct rule_collection rules;
5255 struct ovs_list replies;
5260 ofpbuf_use_const(&b, oh, ntohs(oh->length));
5262 n_monitors = allocated_monitors = 0;
5264 ovs_mutex_lock(&ofproto_mutex);
5266 struct ofputil_flow_monitor_request request;
5267 struct ofmonitor *m;
5270 retval = ofputil_decode_flow_monitor_request(&request, &b);
5271 if (retval == EOF) {
5273 } else if (retval) {
5278 if (request.table_id != 0xff
5279 && request.table_id >= ofproto->n_tables) {
5280 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5284 error = ofmonitor_create(&request, ofconn, &m);
5289 if (n_monitors >= allocated_monitors) {
5290 monitors = x2nrealloc(monitors, &allocated_monitors,
5293 monitors[n_monitors++] = m;
5296 rule_collection_init(&rules);
5297 for (i = 0; i < n_monitors; i++) {
5298 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5301 ofpmp_init(&replies, oh);
5302 ofmonitor_compose_refresh_updates(&rules, &replies);
5303 ovs_mutex_unlock(&ofproto_mutex);
5305 rule_collection_destroy(&rules);
5307 ofconn_send_replies(ofconn, &replies);
5313 for (i = 0; i < n_monitors; i++) {
5314 ofmonitor_destroy(monitors[i]);
5317 ovs_mutex_unlock(&ofproto_mutex);
5323 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5324 OVS_EXCLUDED(ofproto_mutex)
5329 id = ofputil_decode_flow_monitor_cancel(oh);
5331 ovs_mutex_lock(&ofproto_mutex);
5332 error = flow_monitor_delete(ofconn, id);
5333 ovs_mutex_unlock(&ofproto_mutex);
5338 /* Meters implementation.
5340 * Meter table entry, indexed by the OpenFlow meter_id.
5341 * 'created' is used to compute the duration for meter stats.
5342 * 'list rules' is needed so that we can delete the dependent rules when the
5343 * meter table entry is deleted.
5344 * 'provider_meter_id' is for the provider's private use.
5347 long long int created; /* Time created. */
5348 struct ovs_list rules; /* List of "struct rule_dpif"s. */
5349 ofproto_meter_id provider_meter_id;
5350 uint16_t flags; /* Meter flags. */
5351 uint16_t n_bands; /* Number of meter bands. */
5352 struct ofputil_meter_band *bands;
5356 * This is used in instruction validation at flow set-up time,
5357 * as flows may not use non-existing meters.
5358 * Return value of UINT32_MAX signifies an invalid meter.
5361 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5363 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5364 const struct meter *meter = ofproto->meters[of_meter_id];
5366 return meter->provider_meter_id.uint32;
5372 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5375 meter_insert_rule(struct rule *rule)
5377 const struct rule_actions *a = rule_get_actions(rule);
5378 uint32_t meter_id = ofpacts_get_meter(a->ofpacts, a->ofpacts_len);
5379 struct meter *meter = rule->ofproto->meters[meter_id];
5381 list_insert(&meter->rules, &rule->meter_list_node);
5385 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5389 meter->flags = config->flags;
5390 meter->n_bands = config->n_bands;
5391 meter->bands = xmemdup(config->bands,
5392 config->n_bands * sizeof *meter->bands);
5395 static struct meter *
5396 meter_create(const struct ofputil_meter_config *config,
5397 ofproto_meter_id provider_meter_id)
5399 struct meter *meter;
5401 meter = xzalloc(sizeof *meter);
5402 meter->provider_meter_id = provider_meter_id;
5403 meter->created = time_msec();
5404 list_init(&meter->rules);
5406 meter_update(meter, config);
5412 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5413 OVS_REQUIRES(ofproto_mutex)
5416 for (mid = first; mid <= last; ++mid) {
5417 struct meter *meter = ofproto->meters[mid];
5419 ofproto->meters[mid] = NULL;
5420 ofproto->ofproto_class->meter_del(ofproto,
5421 meter->provider_meter_id);
5429 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5431 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5432 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5436 return OFPERR_OFPMMFC_METER_EXISTS;
5439 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5442 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5443 *meterp = meter_create(&mm->meter, provider_meter_id);
5449 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5451 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5453 uint32_t provider_meter_id;
5456 return OFPERR_OFPMMFC_UNKNOWN_METER;
5459 provider_meter_id = meter->provider_meter_id.uint32;
5460 error = ofproto->ofproto_class->meter_set(ofproto,
5461 &meter->provider_meter_id,
5463 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5465 meter_update(meter, &mm->meter);
5471 handle_delete_meter(struct ofconn *ofconn, struct ofputil_meter_mod *mm)
5472 OVS_EXCLUDED(ofproto_mutex)
5474 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5475 uint32_t meter_id = mm->meter.meter_id;
5476 struct rule_collection rules;
5477 enum ofperr error = 0;
5478 uint32_t first, last;
5480 if (meter_id == OFPM13_ALL) {
5482 last = ofproto->meter_features.max_meters;
5484 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5487 first = last = meter_id;
5490 /* First delete the rules that use this meter. If any of those rules are
5491 * currently being modified, postpone the whole operation until later. */
5492 rule_collection_init(&rules);
5493 ovs_mutex_lock(&ofproto_mutex);
5494 for (meter_id = first; meter_id <= last; ++meter_id) {
5495 struct meter *meter = ofproto->meters[meter_id];
5496 if (meter && !list_is_empty(&meter->rules)) {
5499 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5500 rule_collection_add(&rules, rule);
5504 delete_flows__(&rules, OFPRR_METER_DELETE, NULL);
5506 /* Delete the meters. */
5507 meter_delete(ofproto, first, last);
5509 ovs_mutex_unlock(&ofproto_mutex);
5510 rule_collection_destroy(&rules);
5516 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5518 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5519 struct ofputil_meter_mod mm;
5520 uint64_t bands_stub[256 / 8];
5521 struct ofpbuf bands;
5525 error = reject_slave_controller(ofconn);
5530 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5532 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5534 goto exit_free_bands;
5537 meter_id = mm.meter.meter_id;
5539 if (mm.command != OFPMC13_DELETE) {
5540 /* Fails also when meters are not implemented by the provider. */
5541 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5542 error = OFPERR_OFPMMFC_INVALID_METER;
5543 goto exit_free_bands;
5544 } else if (meter_id > ofproto->meter_features.max_meters) {
5545 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5546 goto exit_free_bands;
5548 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5549 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5550 goto exit_free_bands;
5554 switch (mm.command) {
5556 error = handle_add_meter(ofproto, &mm);
5559 case OFPMC13_MODIFY:
5560 error = handle_modify_meter(ofproto, &mm);
5563 case OFPMC13_DELETE:
5564 error = handle_delete_meter(ofconn, &mm);
5568 error = OFPERR_OFPMMFC_BAD_COMMAND;
5573 ofpbuf_uninit(&bands);
5578 handle_meter_features_request(struct ofconn *ofconn,
5579 const struct ofp_header *request)
5581 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5582 struct ofputil_meter_features features;
5585 if (ofproto->ofproto_class->meter_get_features) {
5586 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5588 memset(&features, 0, sizeof features);
5590 b = ofputil_encode_meter_features_reply(&features, request);
5592 ofconn_send_reply(ofconn, b);
5597 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5600 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5601 struct ovs_list replies;
5602 uint64_t bands_stub[256 / 8];
5603 struct ofpbuf bands;
5604 uint32_t meter_id, first, last;
5606 ofputil_decode_meter_request(request, &meter_id);
5608 if (meter_id == OFPM13_ALL) {
5610 last = ofproto->meter_features.max_meters;
5612 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5613 !ofproto->meters[meter_id]) {
5614 return OFPERR_OFPMMFC_UNKNOWN_METER;
5616 first = last = meter_id;
5619 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5620 ofpmp_init(&replies, request);
5622 for (meter_id = first; meter_id <= last; ++meter_id) {
5623 struct meter *meter = ofproto->meters[meter_id];
5625 continue; /* Skip non-existing meters. */
5627 if (type == OFPTYPE_METER_STATS_REQUEST) {
5628 struct ofputil_meter_stats stats;
5630 stats.meter_id = meter_id;
5632 /* Provider sets the packet and byte counts, we do the rest. */
5633 stats.flow_count = list_size(&meter->rules);
5634 calc_duration(meter->created, time_msec(),
5635 &stats.duration_sec, &stats.duration_nsec);
5636 stats.n_bands = meter->n_bands;
5637 ofpbuf_clear(&bands);
5639 = ofpbuf_put_uninit(&bands,
5640 meter->n_bands * sizeof *stats.bands);
5642 if (!ofproto->ofproto_class->meter_get(ofproto,
5643 meter->provider_meter_id,
5645 ofputil_append_meter_stats(&replies, &stats);
5647 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5648 struct ofputil_meter_config config;
5650 config.meter_id = meter_id;
5651 config.flags = meter->flags;
5652 config.n_bands = meter->n_bands;
5653 config.bands = meter->bands;
5654 ofputil_append_meter_config(&replies, &config);
5658 ofconn_send_replies(ofconn, &replies);
5659 ofpbuf_uninit(&bands);
5664 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5665 struct ofgroup **group)
5666 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5668 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5669 hash_int(group_id, 0), &ofproto->groups) {
5670 if ((*group)->group_id == group_id) {
5678 /* If the group exists, this function increments the groups's reference count.
5680 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5681 * a reference to the group. */
5683 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5684 struct ofgroup **group)
5688 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5689 found = ofproto_group_lookup__(ofproto, group_id, group);
5691 ofproto_group_ref(*group);
5693 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5698 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5699 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5701 struct ofgroup *grp;
5703 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5704 hash_int(group_id, 0), &ofproto->groups) {
5705 if (grp->group_id == group_id) {
5713 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5714 OVS_EXCLUDED(ofproto->groups_rwlock)
5718 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5719 exists = ofproto_group_exists__(ofproto, group_id);
5720 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5726 group_get_ref_count(struct ofgroup *group)
5727 OVS_EXCLUDED(ofproto_mutex)
5729 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5730 struct rule_criteria criteria;
5731 struct rule_collection rules;
5736 match_init_catchall(&match);
5737 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5738 OFPP_ANY, group->group_id);
5739 ovs_mutex_lock(&ofproto_mutex);
5740 error = collect_rules_loose(ofproto, &criteria, &rules);
5741 ovs_mutex_unlock(&ofproto_mutex);
5742 rule_criteria_destroy(&criteria);
5744 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5746 rule_collection_destroy(&rules);
5751 append_group_stats(struct ofgroup *group, struct ovs_list *replies)
5753 struct ofputil_group_stats ogs;
5754 const struct ofproto *ofproto = group->ofproto;
5755 long long int now = time_msec();
5758 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5760 /* Provider sets the packet and byte counts, we do the rest. */
5761 ogs.ref_count = group_get_ref_count(group);
5762 ogs.n_buckets = group->n_buckets;
5764 error = (ofproto->ofproto_class->group_get_stats
5765 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5768 ogs.packet_count = UINT64_MAX;
5769 ogs.byte_count = UINT64_MAX;
5770 memset(ogs.bucket_stats, 0xff,
5771 ogs.n_buckets * sizeof *ogs.bucket_stats);
5774 ogs.group_id = group->group_id;
5775 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5777 ofputil_append_group_stats(replies, &ogs);
5779 free(ogs.bucket_stats);
5783 handle_group_request(struct ofconn *ofconn,
5784 const struct ofp_header *request, uint32_t group_id,
5785 void (*cb)(struct ofgroup *, struct ovs_list *replies))
5787 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5788 struct ofgroup *group;
5789 struct ovs_list replies;
5791 ofpmp_init(&replies, request);
5792 if (group_id == OFPG_ALL) {
5793 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5794 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5795 cb(group, &replies);
5797 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5799 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5800 cb(group, &replies);
5801 ofproto_group_unref(group);
5804 ofconn_send_replies(ofconn, &replies);
5808 handle_group_stats_request(struct ofconn *ofconn,
5809 const struct ofp_header *request)
5814 error = ofputil_decode_group_stats_request(request, &group_id);
5819 handle_group_request(ofconn, request, group_id, append_group_stats);
5824 append_group_desc(struct ofgroup *group, struct ovs_list *replies)
5826 struct ofputil_group_desc gds;
5828 gds.group_id = group->group_id;
5829 gds.type = group->type;
5830 gds.props = group->props;
5832 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5836 handle_group_desc_stats_request(struct ofconn *ofconn,
5837 const struct ofp_header *request)
5839 handle_group_request(ofconn, request,
5840 ofputil_decode_group_desc_request(request),
5846 handle_group_features_stats_request(struct ofconn *ofconn,
5847 const struct ofp_header *request)
5849 struct ofproto *p = ofconn_get_ofproto(ofconn);
5852 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5854 ofconn_send_reply(ofconn, msg);
5861 handle_queue_get_config_request(struct ofconn *ofconn,
5862 const struct ofp_header *oh)
5864 struct ofproto *p = ofconn_get_ofproto(ofconn);
5865 struct netdev_queue_dump queue_dump;
5866 struct ofport *ofport;
5867 unsigned int queue_id;
5868 struct ofpbuf *reply;
5869 struct smap details;
5873 error = ofputil_decode_queue_get_config_request(oh, &request);
5878 ofport = ofproto_get_port(p, request);
5880 return OFPERR_OFPQOFC_BAD_PORT;
5883 reply = ofputil_encode_queue_get_config_reply(oh);
5885 smap_init(&details);
5886 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5887 struct ofputil_queue_config queue;
5889 /* None of the existing queues have compatible properties, so we
5890 * hard-code omitting min_rate and max_rate. */
5891 queue.queue_id = queue_id;
5892 queue.min_rate = UINT16_MAX;
5893 queue.max_rate = UINT16_MAX;
5894 ofputil_append_queue_get_config_reply(reply, &queue);
5896 smap_destroy(&details);
5898 ofconn_send_reply(ofconn, reply);
5904 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
5905 struct ofgroup **ofgroup)
5908 const long long int now = time_msec();
5910 if (gm->group_id > OFPG_MAX) {
5911 return OFPERR_OFPGMFC_INVALID_GROUP;
5913 if (gm->type > OFPGT11_FF) {
5914 return OFPERR_OFPGMFC_BAD_TYPE;
5917 *ofgroup = ofproto->ofproto_class->group_alloc();
5919 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5920 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5923 (*ofgroup)->ofproto = ofproto;
5924 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
5925 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
5926 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
5927 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
5928 ovs_refcount_init(&(*ofgroup)->ref_count);
5930 list_move(&(*ofgroup)->buckets, &gm->buckets);
5931 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
5932 list_size(&(*ofgroup)->buckets);
5934 memcpy(CONST_CAST(struct ofputil_group_props *, &(*ofgroup)->props),
5935 &gm->props, sizeof (struct ofputil_group_props));
5937 /* Construct called BEFORE any locks are held. */
5938 error = ofproto->ofproto_class->group_construct(*ofgroup);
5940 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
5941 ofproto->ofproto_class->group_dealloc(*ofgroup);
5946 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
5947 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
5950 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5952 struct ofgroup *ofgroup;
5955 /* Allocate new group and initialize it. */
5956 error = init_group(ofproto, gm, &ofgroup);
5961 /* We wrlock as late as possible to minimize the time we jam any other
5962 * threads: No visible state changes before acquiring the lock. */
5963 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5965 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5966 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5970 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5971 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5976 /* Insert new group. */
5977 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5978 hash_int(ofgroup->group_id, 0));
5979 ofproto->n_groups[ofgroup->type]++;
5981 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5986 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5987 ofproto->ofproto_class->group_destruct(ofgroup);
5988 ofputil_bucket_list_destroy(&ofgroup->buckets);
5989 ofproto->ofproto_class->group_dealloc(ofgroup);
5994 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
5995 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
5996 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
5997 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6000 copy_buckets_for_insert_bucket(const struct ofgroup *ofgroup,
6001 struct ofgroup *new_ofgroup,
6002 uint32_t command_bucket_id)
6004 struct ofputil_bucket *last = NULL;
6006 if (command_bucket_id <= OFPG15_BUCKET_MAX) {
6007 /* Check here to ensure that a bucket corresponding to
6008 * command_bucket_id exists in the old bucket list.
6010 * The subsequent search of below of new_ofgroup covers
6011 * both buckets in the old bucket list and buckets added
6012 * by the insert buckets group mod message this function processes. */
6013 if (!ofputil_bucket_find(&ofgroup->buckets, command_bucket_id)) {
6014 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6017 if (!list_is_empty(&new_ofgroup->buckets)) {
6018 last = ofputil_bucket_list_back(&new_ofgroup->buckets);
6022 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, NULL);
6024 if (ofputil_bucket_check_duplicate_id(&ofgroup->buckets)) {
6025 VLOG_WARN_RL(&rl, "Duplicate bucket id");
6026 return OFPERR_OFPGMFC_BUCKET_EXISTS;
6029 /* Rearrange list according to command_bucket_id */
6030 if (command_bucket_id == OFPG15_BUCKET_LAST) {
6031 struct ofputil_bucket *new_first;
6032 const struct ofputil_bucket *first;
6034 first = ofputil_bucket_list_front(&ofgroup->buckets);
6035 new_first = ofputil_bucket_find(&new_ofgroup->buckets,
6038 list_splice(new_ofgroup->buckets.next, &new_first->list_node,
6039 &new_ofgroup->buckets);
6040 } else if (command_bucket_id <= OFPG15_BUCKET_MAX && last) {
6041 struct ofputil_bucket *after;
6043 /* Presence of bucket is checked above so after should never be NULL */
6044 after = ofputil_bucket_find(&new_ofgroup->buckets, command_bucket_id);
6046 list_splice(after->list_node.next, new_ofgroup->buckets.next,
6047 last->list_node.next);
6053 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6054 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6055 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6056 * and OFPG15_BUCKET_ALL are also honored. */
6058 copy_buckets_for_remove_bucket(const struct ofgroup *ofgroup,
6059 struct ofgroup *new_ofgroup,
6060 uint32_t command_bucket_id)
6062 const struct ofputil_bucket *skip = NULL;
6064 if (command_bucket_id == OFPG15_BUCKET_ALL) {
6068 if (command_bucket_id == OFPG15_BUCKET_FIRST) {
6069 if (!list_is_empty(&ofgroup->buckets)) {
6070 skip = ofputil_bucket_list_front(&ofgroup->buckets);
6072 } else if (command_bucket_id == OFPG15_BUCKET_LAST) {
6073 if (!list_is_empty(&ofgroup->buckets)) {
6074 skip = ofputil_bucket_list_back(&ofgroup->buckets);
6077 skip = ofputil_bucket_find(&ofgroup->buckets, command_bucket_id);
6079 return OFPERR_OFPGMFC_UNKNOWN_BUCKET;
6083 ofputil_bucket_clone_list(&new_ofgroup->buckets, &ofgroup->buckets, skip);
6088 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6089 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6092 * Note that the group is re-created and then replaces the old group in
6093 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6094 * the xlate module hold a pointer to the group. */
6096 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
6098 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
6101 error = init_group(ofproto, gm, &new_ofgroup);
6106 retiring = new_ofgroup;
6108 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6109 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
6110 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
6114 /* Ofproto's group write lock is held now. */
6115 if (ofgroup->type != gm->type
6116 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
6117 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
6121 /* Manipulate bucket list for bucket commands */
6122 if (gm->command == OFPGC15_INSERT_BUCKET) {
6123 error = copy_buckets_for_insert_bucket(ofgroup, new_ofgroup,
6124 gm->command_bucket_id);
6125 } else if (gm->command == OFPGC15_REMOVE_BUCKET) {
6126 error = copy_buckets_for_remove_bucket(ofgroup, new_ofgroup,
6127 gm->command_bucket_id);
6133 /* The group creation time does not change during modification. */
6134 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
6135 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
6137 error = ofproto->ofproto_class->group_modify(new_ofgroup);
6143 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6144 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6145 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
6146 hash_int(new_ofgroup->group_id, 0));
6147 if (ofgroup->type != new_ofgroup->type) {
6148 ofproto->n_groups[ofgroup->type]--;
6149 ofproto->n_groups[new_ofgroup->type]++;
6153 ofproto_group_unref(retiring);
6154 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6159 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
6160 OVS_RELEASES(ofproto->groups_rwlock)
6163 struct ofputil_flow_mod fm;
6165 /* Delete all flow entries containing this group in a group action */
6166 match_init_catchall(&match);
6167 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
6168 fm.delete_reason = OFPRR_GROUP_DELETE;
6169 fm.out_group = ofgroup->group_id;
6170 handle_flow_mod__(ofproto, &fm, NULL);
6172 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
6173 /* No-one can find this group any more. */
6174 ofproto->n_groups[ofgroup->type]--;
6175 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6176 ofproto_group_unref(ofgroup);
6179 /* Implements OFPGC11_DELETE. */
6181 delete_group(struct ofproto *ofproto, uint32_t group_id)
6183 struct ofgroup *ofgroup;
6185 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6186 if (group_id == OFPG_ALL) {
6188 struct hmap_node *node = hmap_first(&ofproto->groups);
6192 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
6193 delete_group__(ofproto, ofgroup);
6194 /* Lock for each node separately, so that we will not jam the
6195 * other threads for too long time. */
6196 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
6199 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
6200 hash_int(group_id, 0), &ofproto->groups) {
6201 if (ofgroup->group_id == group_id) {
6202 delete_group__(ofproto, ofgroup);
6207 ovs_rwlock_unlock(&ofproto->groups_rwlock);
6211 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6213 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6214 struct ofputil_group_mod gm;
6217 error = reject_slave_controller(ofconn);
6222 error = ofputil_decode_group_mod(oh, &gm);
6227 switch (gm.command) {
6229 return add_group(ofproto, &gm);
6231 case OFPGC11_MODIFY:
6232 return modify_group(ofproto, &gm);
6234 case OFPGC11_DELETE:
6235 delete_group(ofproto, gm.group_id);
6238 case OFPGC15_INSERT_BUCKET:
6239 return modify_group(ofproto, &gm);
6241 case OFPGC15_REMOVE_BUCKET:
6242 return modify_group(ofproto, &gm);
6245 if (gm.command > OFPGC11_DELETE) {
6246 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
6247 ofproto->name, gm.command);
6249 return OFPERR_OFPGMFC_BAD_COMMAND;
6253 enum ofputil_table_miss
6254 ofproto_table_get_miss_config(const struct ofproto *ofproto, uint8_t table_id)
6256 enum ofputil_table_miss value;
6258 atomic_read_relaxed(&ofproto->tables[table_id].miss_config, &value);
6263 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
6265 if (!check_table_id(ofproto, tm->table_id)) {
6266 return OFPERR_OFPTMFC_BAD_TABLE;
6267 } else if (tm->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
6268 if (tm->table_id == OFPTT_ALL) {
6270 for (i = 0; i < ofproto->n_tables; i++) {
6271 atomic_store_relaxed(&ofproto->tables[i].miss_config,
6275 atomic_store_relaxed(&ofproto->tables[tm->table_id].miss_config,
6283 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
6285 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6286 struct ofputil_table_mod tm;
6289 error = reject_slave_controller(ofconn);
6294 error = ofputil_decode_table_mod(oh, &tm);
6299 return table_mod(ofproto, &tm);
6303 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
6306 struct ofputil_bundle_ctrl_msg bctrl;
6308 struct ofputil_bundle_ctrl_msg reply;
6310 error = reject_slave_controller(ofconn);
6315 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
6320 reply.bundle_id = bctrl.bundle_id;
6322 switch (bctrl.type) {
6323 case OFPBCT_OPEN_REQUEST:
6324 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
6325 reply.type = OFPBCT_OPEN_REPLY;
6327 case OFPBCT_CLOSE_REQUEST:
6328 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
6329 reply.type = OFPBCT_CLOSE_REPLY;;
6331 case OFPBCT_COMMIT_REQUEST:
6332 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
6333 reply.type = OFPBCT_COMMIT_REPLY;
6335 case OFPBCT_DISCARD_REQUEST:
6336 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
6337 reply.type = OFPBCT_DISCARD_REPLY;
6340 case OFPBCT_OPEN_REPLY:
6341 case OFPBCT_CLOSE_REPLY:
6342 case OFPBCT_COMMIT_REPLY:
6343 case OFPBCT_DISCARD_REPLY:
6344 return OFPERR_OFPBFC_BAD_TYPE;
6349 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
6350 ofconn_send_reply(ofconn, buf);
6357 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
6360 struct ofputil_bundle_add_msg badd;
6362 error = reject_slave_controller(ofconn);
6367 error = ofputil_decode_bundle_add(oh, &badd);
6372 return ofp_bundle_add_message(ofconn, &badd);
6376 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
6377 OVS_EXCLUDED(ofproto_mutex)
6379 const struct ofp_header *oh = msg->data;
6383 error = ofptype_decode(&type, oh);
6387 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
6388 && ofpmp_more(oh)) {
6389 /* We have no buffer implementation for multipart requests.
6390 * Report overflow for requests which consists of multiple
6392 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
6396 /* OpenFlow requests. */
6397 case OFPTYPE_ECHO_REQUEST:
6398 return handle_echo_request(ofconn, oh);
6400 case OFPTYPE_FEATURES_REQUEST:
6401 return handle_features_request(ofconn, oh);
6403 case OFPTYPE_GET_CONFIG_REQUEST:
6404 return handle_get_config_request(ofconn, oh);
6406 case OFPTYPE_SET_CONFIG:
6407 return handle_set_config(ofconn, oh);
6409 case OFPTYPE_PACKET_OUT:
6410 return handle_packet_out(ofconn, oh);
6412 case OFPTYPE_PORT_MOD:
6413 return handle_port_mod(ofconn, oh);
6415 case OFPTYPE_FLOW_MOD:
6416 return handle_flow_mod(ofconn, oh);
6418 case OFPTYPE_GROUP_MOD:
6419 return handle_group_mod(ofconn, oh);
6421 case OFPTYPE_TABLE_MOD:
6422 return handle_table_mod(ofconn, oh);
6424 case OFPTYPE_METER_MOD:
6425 return handle_meter_mod(ofconn, oh);
6427 case OFPTYPE_BARRIER_REQUEST:
6428 return handle_barrier_request(ofconn, oh);
6430 case OFPTYPE_ROLE_REQUEST:
6431 return handle_role_request(ofconn, oh);
6433 /* OpenFlow replies. */
6434 case OFPTYPE_ECHO_REPLY:
6437 /* Nicira extension requests. */
6438 case OFPTYPE_FLOW_MOD_TABLE_ID:
6439 return handle_nxt_flow_mod_table_id(ofconn, oh);
6441 case OFPTYPE_SET_FLOW_FORMAT:
6442 return handle_nxt_set_flow_format(ofconn, oh);
6444 case OFPTYPE_SET_PACKET_IN_FORMAT:
6445 return handle_nxt_set_packet_in_format(ofconn, oh);
6447 case OFPTYPE_SET_CONTROLLER_ID:
6448 return handle_nxt_set_controller_id(ofconn, oh);
6450 case OFPTYPE_FLOW_AGE:
6451 /* Nothing to do. */
6454 case OFPTYPE_FLOW_MONITOR_CANCEL:
6455 return handle_flow_monitor_cancel(ofconn, oh);
6457 case OFPTYPE_SET_ASYNC_CONFIG:
6458 return handle_nxt_set_async_config(ofconn, oh);
6460 case OFPTYPE_GET_ASYNC_REQUEST:
6461 return handle_nxt_get_async_request(ofconn, oh);
6463 /* Statistics requests. */
6464 case OFPTYPE_DESC_STATS_REQUEST:
6465 return handle_desc_stats_request(ofconn, oh);
6467 case OFPTYPE_FLOW_STATS_REQUEST:
6468 return handle_flow_stats_request(ofconn, oh);
6470 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6471 return handle_aggregate_stats_request(ofconn, oh);
6473 case OFPTYPE_TABLE_STATS_REQUEST:
6474 return handle_table_stats_request(ofconn, oh);
6476 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6477 return handle_table_features_request(ofconn, oh);
6479 case OFPTYPE_PORT_STATS_REQUEST:
6480 return handle_port_stats_request(ofconn, oh);
6482 case OFPTYPE_QUEUE_STATS_REQUEST:
6483 return handle_queue_stats_request(ofconn, oh);
6485 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6486 return handle_port_desc_stats_request(ofconn, oh);
6488 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6489 return handle_flow_monitor_request(ofconn, oh);
6491 case OFPTYPE_METER_STATS_REQUEST:
6492 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6493 return handle_meter_request(ofconn, oh, type);
6495 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6496 return handle_meter_features_request(ofconn, oh);
6498 case OFPTYPE_GROUP_STATS_REQUEST:
6499 return handle_group_stats_request(ofconn, oh);
6501 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6502 return handle_group_desc_stats_request(ofconn, oh);
6504 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6505 return handle_group_features_stats_request(ofconn, oh);
6507 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6508 return handle_queue_get_config_request(ofconn, oh);
6510 case OFPTYPE_BUNDLE_CONTROL:
6511 return handle_bundle_control(ofconn, oh);
6513 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6514 return handle_bundle_add(ofconn, oh);
6518 case OFPTYPE_FEATURES_REPLY:
6519 case OFPTYPE_GET_CONFIG_REPLY:
6520 case OFPTYPE_PACKET_IN:
6521 case OFPTYPE_FLOW_REMOVED:
6522 case OFPTYPE_PORT_STATUS:
6523 case OFPTYPE_BARRIER_REPLY:
6524 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6525 case OFPTYPE_DESC_STATS_REPLY:
6526 case OFPTYPE_FLOW_STATS_REPLY:
6527 case OFPTYPE_QUEUE_STATS_REPLY:
6528 case OFPTYPE_PORT_STATS_REPLY:
6529 case OFPTYPE_TABLE_STATS_REPLY:
6530 case OFPTYPE_AGGREGATE_STATS_REPLY:
6531 case OFPTYPE_PORT_DESC_STATS_REPLY:
6532 case OFPTYPE_ROLE_REPLY:
6533 case OFPTYPE_FLOW_MONITOR_PAUSED:
6534 case OFPTYPE_FLOW_MONITOR_RESUMED:
6535 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6536 case OFPTYPE_GET_ASYNC_REPLY:
6537 case OFPTYPE_GROUP_STATS_REPLY:
6538 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6539 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6540 case OFPTYPE_METER_STATS_REPLY:
6541 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6542 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6543 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6544 case OFPTYPE_ROLE_STATUS:
6546 if (ofpmsg_is_stat_request(oh)) {
6547 return OFPERR_OFPBRC_BAD_STAT;
6549 return OFPERR_OFPBRC_BAD_TYPE;
6555 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6556 OVS_EXCLUDED(ofproto_mutex)
6558 int error = handle_openflow__(ofconn, ofp_msg);
6560 ofconn_send_error(ofconn, ofp_msg->data, error);
6562 COVERAGE_INC(ofproto_recv_openflow);
6565 /* Asynchronous operations. */
6568 send_buffered_packet(struct ofconn *ofconn, uint32_t buffer_id,
6570 OVS_REQUIRES(ofproto_mutex)
6572 enum ofperr error = 0;
6573 if (ofconn && buffer_id != UINT32_MAX) {
6574 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
6575 struct dp_packet *packet;
6578 error = ofconn_pktbuf_retrieve(ofconn, buffer_id, &packet, &in_port);
6580 struct rule_execute *re;
6582 ofproto_rule_ref(rule);
6584 re = xmalloc(sizeof *re);
6586 re->in_port = in_port;
6587 re->packet = packet;
6589 if (!guarded_list_push_back(&ofproto->rule_executes,
6590 &re->list_node, 1024)) {
6591 ofproto_rule_unref(rule);
6592 dp_packet_delete(re->packet);
6601 pick_datapath_id(const struct ofproto *ofproto)
6603 const struct ofport *port;
6605 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6607 uint8_t ea[ETH_ADDR_LEN];
6610 error = netdev_get_etheraddr(port->netdev, ea);
6612 return eth_addr_to_uint64(ea);
6614 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6615 ofproto->name, netdev_get_name(port->netdev),
6616 ovs_strerror(error));
6618 return ofproto->fallback_dpid;
6622 pick_fallback_dpid(void)
6624 uint8_t ea[ETH_ADDR_LEN];
6625 eth_addr_nicira_random(ea);
6626 return eth_addr_to_uint64(ea);
6629 /* Table overflow policy. */
6631 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6632 * to NULL if the table is not configured to evict rules or if the table
6633 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6634 * or with no timeouts are not evictable.) */
6636 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6637 OVS_REQUIRES(ofproto_mutex)
6639 struct eviction_group *evg;
6642 if (!table->eviction_fields) {
6646 /* In the common case, the outer and inner loops here will each be entered
6649 * - The inner loop normally "return"s in its first iteration. If the
6650 * eviction group has any evictable rules, then it always returns in
6653 * - The outer loop only iterates more than once if the largest eviction
6654 * group has no evictable rules.
6656 * - The outer loop can exit only if table's 'max_flows' is all filled up
6657 * by unevictable rules. */
6658 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6661 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6670 /* Eviction groups. */
6672 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6673 * rules. The priority contains low-order random bits to ensure that eviction
6674 * groups with the same number of rules are prioritized randomly. */
6676 eviction_group_priority(size_t n_rules)
6678 uint16_t size = MIN(UINT16_MAX, n_rules);
6679 return (size << 16) | random_uint16();
6682 /* Updates 'evg', an eviction_group within 'table', following a change that
6683 * adds or removes rules in 'evg'. */
6685 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6686 OVS_REQUIRES(ofproto_mutex)
6688 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6689 eviction_group_priority(heap_count(&evg->rules)));
6692 /* Destroys 'evg', an eviction_group within 'table':
6694 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6695 * rules themselves, just removes them from the eviction group.)
6697 * - Removes 'evg' from 'table'.
6701 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6702 OVS_REQUIRES(ofproto_mutex)
6704 while (!heap_is_empty(&evg->rules)) {
6707 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6708 rule->eviction_group = NULL;
6710 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6711 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6712 heap_destroy(&evg->rules);
6716 /* Removes 'rule' from its eviction group, if any. */
6718 eviction_group_remove_rule(struct rule *rule)
6719 OVS_REQUIRES(ofproto_mutex)
6721 if (rule->eviction_group) {
6722 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6723 struct eviction_group *evg = rule->eviction_group;
6725 rule->eviction_group = NULL;
6726 heap_remove(&evg->rules, &rule->evg_node);
6727 if (heap_is_empty(&evg->rules)) {
6728 eviction_group_destroy(table, evg);
6730 eviction_group_resized(table, evg);
6735 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6736 * returns the hash value. */
6738 eviction_group_hash_rule(struct rule *rule)
6739 OVS_REQUIRES(ofproto_mutex)
6741 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6742 const struct mf_subfield *sf;
6746 hash = table->eviction_group_id_basis;
6747 miniflow_expand(&rule->cr.match.flow, &flow);
6748 for (sf = table->eviction_fields;
6749 sf < &table->eviction_fields[table->n_eviction_fields];
6752 if (mf_are_prereqs_ok(sf->field, &flow)) {
6753 union mf_value value;
6755 mf_get_value(sf->field, &flow, &value);
6757 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6759 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6760 unsigned int start = sf->ofs + sf->n_bits;
6761 bitwise_zero(&value, sf->field->n_bytes, start,
6762 sf->field->n_bytes * 8 - start);
6764 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6766 hash = hash_int(hash, 0);
6773 /* Returns an eviction group within 'table' with the given 'id', creating one
6775 static struct eviction_group *
6776 eviction_group_find(struct oftable *table, uint32_t id)
6777 OVS_REQUIRES(ofproto_mutex)
6779 struct eviction_group *evg;
6781 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6785 evg = xmalloc(sizeof *evg);
6786 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6787 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6788 eviction_group_priority(0));
6789 heap_init(&evg->rules);
6794 /* Returns an eviction priority for 'rule'. The return value should be
6795 * interpreted so that higher priorities make a rule more attractive candidates
6797 * Called only if have a timeout. */
6799 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6800 OVS_REQUIRES(ofproto_mutex)
6802 long long int expiration = LLONG_MAX;
6803 long long int modified;
6804 uint32_t expiration_offset;
6806 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6807 ovs_mutex_lock(&rule->mutex);
6808 modified = rule->modified;
6809 ovs_mutex_unlock(&rule->mutex);
6811 if (rule->hard_timeout) {
6812 expiration = modified + rule->hard_timeout * 1000;
6814 if (rule->idle_timeout) {
6815 uint64_t packets, bytes;
6817 long long int idle_expiration;
6819 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6820 idle_expiration = used + rule->idle_timeout * 1000;
6821 expiration = MIN(expiration, idle_expiration);
6824 if (expiration == LLONG_MAX) {
6828 /* Calculate the time of expiration as a number of (approximate) seconds
6829 * after program startup.
6831 * This should work OK for program runs that last UINT32_MAX seconds or
6832 * less. Therefore, please restart OVS at least once every 136 years. */
6833 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6835 /* Invert the expiration offset because we're using a max-heap. */
6836 return UINT32_MAX - expiration_offset;
6839 /* Adds 'rule' to an appropriate eviction group for its oftable's
6840 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6841 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6844 * The caller must ensure that 'rule' is not already in an eviction group. */
6846 eviction_group_add_rule(struct rule *rule)
6847 OVS_REQUIRES(ofproto_mutex)
6849 struct ofproto *ofproto = rule->ofproto;
6850 struct oftable *table = &ofproto->tables[rule->table_id];
6853 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6854 * so no additional protection is needed. */
6855 has_timeout = rule->hard_timeout || rule->idle_timeout;
6857 if (table->eviction_fields && has_timeout) {
6858 struct eviction_group *evg;
6860 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6862 rule->eviction_group = evg;
6863 heap_insert(&evg->rules, &rule->evg_node,
6864 rule_eviction_priority(ofproto, rule));
6865 eviction_group_resized(table, evg);
6871 /* Initializes 'table'. */
6873 oftable_init(struct oftable *table)
6875 memset(table, 0, sizeof *table);
6876 classifier_init(&table->cls, flow_segment_u64s);
6877 table->max_flows = UINT_MAX;
6878 atomic_init(&table->miss_config, OFPUTIL_TABLE_MISS_DEFAULT);
6880 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
6881 ARRAY_SIZE(default_prefix_fields));
6883 atomic_init(&table->n_matched, 0);
6884 atomic_init(&table->n_missed, 0);
6887 /* Destroys 'table', including its classifier and eviction groups.
6889 * The caller is responsible for freeing 'table' itself. */
6891 oftable_destroy(struct oftable *table)
6893 ovs_assert(classifier_is_empty(&table->cls));
6894 oftable_disable_eviction(table);
6895 classifier_destroy(&table->cls);
6899 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6900 * string, then 'table' will use its default name.
6902 * This only affects the name exposed for a table exposed through the OpenFlow
6903 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6905 oftable_set_name(struct oftable *table, const char *name)
6907 if (name && name[0]) {
6908 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6909 if (!table->name || strncmp(name, table->name, len)) {
6911 table->name = xmemdup0(name, len);
6919 /* oftables support a choice of two policies when adding a rule would cause the
6920 * number of flows in the table to exceed the configured maximum number: either
6921 * they can refuse to add the new flow or they can evict some existing flow.
6922 * This function configures the former policy on 'table'. */
6924 oftable_disable_eviction(struct oftable *table)
6925 OVS_REQUIRES(ofproto_mutex)
6927 if (table->eviction_fields) {
6928 struct eviction_group *evg, *next;
6930 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6931 &table->eviction_groups_by_id) {
6932 eviction_group_destroy(table, evg);
6934 hmap_destroy(&table->eviction_groups_by_id);
6935 heap_destroy(&table->eviction_groups_by_size);
6937 free(table->eviction_fields);
6938 table->eviction_fields = NULL;
6939 table->n_eviction_fields = 0;
6943 /* oftables support a choice of two policies when adding a rule would cause the
6944 * number of flows in the table to exceed the configured maximum number: either
6945 * they can refuse to add the new flow or they can evict some existing flow.
6946 * This function configures the latter policy on 'table', with fairness based
6947 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6948 * 'n_fields' as 0 disables fairness.) */
6950 oftable_enable_eviction(struct oftable *table,
6951 const struct mf_subfield *fields, size_t n_fields)
6952 OVS_REQUIRES(ofproto_mutex)
6956 if (table->eviction_fields
6957 && n_fields == table->n_eviction_fields
6959 || !memcmp(fields, table->eviction_fields,
6960 n_fields * sizeof *fields))) {
6965 oftable_disable_eviction(table);
6967 table->n_eviction_fields = n_fields;
6968 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6970 table->eviction_group_id_basis = random_uint32();
6971 hmap_init(&table->eviction_groups_by_id);
6972 heap_init(&table->eviction_groups_by_size);
6974 CLS_FOR_EACH (rule, cr, &table->cls) {
6975 eviction_group_add_rule(rule);
6979 /* Removes 'rule' from the ofproto data structures AFTER caller has removed
6980 * it from the classifier. */
6982 ofproto_rule_remove__(struct ofproto *ofproto, struct rule *rule)
6983 OVS_REQUIRES(ofproto_mutex)
6985 cookies_remove(ofproto, rule);
6987 eviction_group_remove_rule(rule);
6988 if (!list_is_empty(&rule->expirable)) {
6989 list_remove(&rule->expirable);
6991 if (!list_is_empty(&rule->meter_list_node)) {
6992 list_remove(&rule->meter_list_node);
6993 list_init(&rule->meter_list_node);
6998 oftable_remove_rule(struct rule *rule)
6999 OVS_REQUIRES(ofproto_mutex)
7001 struct classifier *cls = &rule->ofproto->tables[rule->table_id].cls;
7003 if (classifier_remove(cls, &rule->cr)) {
7004 ofproto_rule_remove__(rule->ofproto, rule);
7008 /* unixctl commands. */
7011 ofproto_lookup(const char *name)
7013 struct ofproto *ofproto;
7015 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
7017 if (!strcmp(ofproto->name, name)) {
7025 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
7026 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
7028 struct ofproto *ofproto;
7032 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
7033 ds_put_format(&results, "%s\n", ofproto->name);
7035 unixctl_command_reply(conn, ds_cstr(&results));
7036 ds_destroy(&results);
7040 ofproto_unixctl_init(void)
7042 static bool registered;
7048 unixctl_command_register("ofproto/list", "", 0, 0,
7049 ofproto_unixctl_list, NULL);
7052 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7054 * This is deprecated. It is only for compatibility with broken device drivers
7055 * in old versions of Linux that do not properly support VLANs when VLAN
7056 * devices are not used. When broken device drivers are no longer in
7057 * widespread use, we will delete these interfaces. */
7059 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7060 * (exactly) by an OpenFlow rule in 'ofproto'. */
7062 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7065 struct cls_rule target;
7066 const struct oftable *oftable;
7068 match_init_catchall(&match);
7069 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7070 cls_rule_init(&target, &match, 0);
7072 free(ofproto->vlan_bitmap);
7073 ofproto->vlan_bitmap = bitmap_allocate(4096);
7074 ofproto->vlans_changed = false;
7076 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7079 CLS_FOR_EACH_TARGET (rule, cr, &oftable->cls, &target) {
7080 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7081 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7083 bitmap_set1(vlan_bitmap, vid);
7084 bitmap_set1(ofproto->vlan_bitmap, vid);
7089 cls_rule_destroy(&target);
7092 /* Returns true if new VLANs have come into use by the flow table since the
7093 * last call to ofproto_get_vlan_usage().
7095 * We don't track when old VLANs stop being used. */
7097 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7099 return ofproto->vlans_changed;
7102 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7103 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7104 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7105 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7106 * then the VLAN device is un-enslaved. */
7108 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7109 ofp_port_t realdev_ofp_port, int vid)
7111 struct ofport *ofport;
7114 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7116 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7118 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7119 ofproto->name, vlandev_ofp_port);
7123 if (!ofproto->ofproto_class->set_realdev) {
7124 if (!vlandev_ofp_port) {
7127 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7131 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7133 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7134 ofproto->name, vlandev_ofp_port,
7135 netdev_get_name(ofport->netdev), ovs_strerror(error));