2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
50 #include "poll-loop.h"
58 #include "unaligned.h"
62 VLOG_DEFINE_THIS_MODULE(ofproto);
64 COVERAGE_DEFINE(ofproto_flush);
65 COVERAGE_DEFINE(ofproto_packet_out);
66 COVERAGE_DEFINE(ofproto_queue_req);
67 COVERAGE_DEFINE(ofproto_recv_openflow);
68 COVERAGE_DEFINE(ofproto_reinit_ports);
69 COVERAGE_DEFINE(ofproto_update_port);
72 S_OPENFLOW, /* Processing OpenFlow commands. */
73 S_EVICT, /* Evicting flows from over-limit tables. */
74 S_FLUSH, /* Deleting all flow table rules. */
77 enum ofoperation_type {
84 /* A single OpenFlow request can execute any number of operations. The
85 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
86 * ofconn to which an error reply should be sent if necessary.
88 * ofproto initiates some operations internally. These operations are still
89 * assigned to groups but will not have an associated ofconn. */
91 struct ofproto *ofproto; /* Owning ofproto. */
92 struct list ofproto_node; /* In ofproto's "pending" list. */
93 struct list ops; /* List of "struct ofoperation"s. */
94 int n_running; /* Number of ops still pending. */
96 /* Data needed to send OpenFlow reply on failure or to send a buffered
99 * If list_is_empty(ofconn_node) then this ofopgroup never had an
100 * associated ofconn or its ofconn's connection dropped after it initiated
101 * the operation. In the latter case 'ofconn' is a wild pointer that
102 * refers to freed memory, so the 'ofconn' member must be used only if
103 * !list_is_empty(ofconn_node).
105 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
106 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
107 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
108 uint32_t buffer_id; /* Buffer id from original request. */
111 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
112 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
113 const struct ofp_header *,
115 static void ofopgroup_submit(struct ofopgroup *);
116 static void ofopgroup_complete(struct ofopgroup *);
118 /* A single flow table operation. */
120 struct ofopgroup *group; /* Owning group. */
121 struct list group_node; /* In ofopgroup's "ops" list. */
122 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
123 struct rule *rule; /* Rule being operated upon. */
124 enum ofoperation_type type; /* Type of operation. */
126 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
128 const struct rule_actions *actions;
130 /* OFOPERATION_DELETE. */
131 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
133 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
134 uint16_t idle_timeout; /* Rule's old idle timeout. */
135 uint16_t hard_timeout; /* Rule's old hard timeout. */
136 enum ofputil_flow_mod_flags flags; /* Rule's old flags. */
137 enum ofperr error; /* 0 if no error. */
140 static struct ofoperation *ofoperation_create(struct ofopgroup *,
142 enum ofoperation_type,
143 enum ofp_flow_removed_reason);
144 static void ofoperation_destroy(struct ofoperation *);
147 static void oftable_init(struct oftable *);
148 static void oftable_destroy(struct oftable *);
150 static void oftable_set_name(struct oftable *, const char *name);
152 static void oftable_disable_eviction(struct oftable *);
153 static void oftable_enable_eviction(struct oftable *,
154 const struct mf_subfield *fields,
157 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
158 static void oftable_remove_rule__(struct ofproto *, struct rule *)
159 OVS_REQUIRES(ofproto_mutex);
160 static void oftable_insert_rule(struct rule *);
162 /* A set of rules within a single OpenFlow table (oftable) that have the same
163 * values for the oftable's eviction_fields. A rule to be evicted, when one is
164 * needed, is taken from the eviction group that contains the greatest number
167 * An oftable owns any number of eviction groups, each of which contains any
170 * Membership in an eviction group is imprecise, based on the hash of the
171 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
172 * That is, if two rules have different eviction_fields, but those
173 * eviction_fields hash to the same value, then they will belong to the same
174 * eviction_group anyway.
176 * (When eviction is not enabled on an oftable, we don't track any eviction
177 * groups, to save time and space.) */
178 struct eviction_group {
179 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
180 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
181 struct heap rules; /* Contains "struct rule"s. */
184 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep);
185 static void ofproto_evict(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
186 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *);
187 static void eviction_group_add_rule(struct rule *);
188 static void eviction_group_remove_rule(struct rule *);
190 /* Criteria that flow_mod and other operations use for selecting rules on
191 * which to operate. */
192 struct rule_criteria {
193 /* An OpenFlow table or 255 for all tables. */
196 /* OpenFlow matching criteria. Interpreted different in "loose" way by
197 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
198 * defined in the OpenFlow spec. */
201 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
202 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
203 * The rule will not be selected if M is 1 and B != C. */
205 ovs_be64 cookie_mask;
207 /* Selection based on actions within a rule:
209 * If out_port != OFPP_ANY, selects only rules that output to out_port.
210 * If out_group != OFPG_ALL, select only rules that output to out_group. */
215 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
216 const struct match *match,
217 unsigned int priority,
218 ovs_be64 cookie, ovs_be64 cookie_mask,
219 ofp_port_t out_port, uint32_t out_group);
220 static void rule_criteria_destroy(struct rule_criteria *);
222 /* A packet that needs to be passed to rule_execute().
224 * (We can't do this immediately from ofopgroup_complete() because that holds
225 * ofproto_mutex, which rule_execute() needs released.) */
226 struct rule_execute {
227 struct list list_node; /* In struct ofproto's "rule_executes" list. */
228 struct rule *rule; /* Owns a reference to the rule. */
230 struct ofpbuf *packet; /* Owns the packet. */
233 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
234 static void destroy_rule_executes(struct ofproto *);
237 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
238 static void ofport_destroy(struct ofport *);
240 static void update_port(struct ofproto *, const char *devname);
241 static int init_ports(struct ofproto *);
242 static void reinit_ports(struct ofproto *);
244 static long long int ofport_get_usage(const struct ofproto *,
245 ofp_port_t ofp_port);
246 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
247 long long int last_used);
248 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
252 * Keeps track of the currently used and recently used ofport values and is
253 * used to prevent immediate recycling of ofport values. */
254 struct ofport_usage {
255 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
256 ofp_port_t ofp_port; /* OpenFlow port number. */
257 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
258 represents in-use ofports. */
262 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
263 static bool rule_is_modifiable(const struct rule *rule,
264 enum ofputil_flow_mod_flags flag);
267 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
268 struct ofputil_flow_mod *,
269 const struct ofp_header *);
270 static void do_add_flow(struct ofproto *, struct ofconn *,
271 const struct ofp_header *request, uint32_t buffer_id,
273 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
274 struct ofputil_flow_mod *,
275 const struct ofp_header *,
276 const struct rule_collection *);
277 static void delete_flow__(struct rule *rule, struct ofopgroup *,
278 enum ofp_flow_removed_reason)
279 OVS_REQUIRES(ofproto_mutex);
280 static bool ofproto_group_exists__(const struct ofproto *ofproto,
282 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
283 static bool ofproto_group_exists(const struct ofproto *ofproto,
285 OVS_EXCLUDED(ofproto->groups_rwlock);
286 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
287 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
288 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
289 struct ofputil_flow_mod *,
290 const struct ofp_header *)
291 OVS_EXCLUDED(ofproto_mutex);
292 static void calc_duration(long long int start, long long int now,
293 uint32_t *sec, uint32_t *nsec);
296 static uint64_t pick_datapath_id(const struct ofproto *);
297 static uint64_t pick_fallback_dpid(void);
298 static void ofproto_destroy__(struct ofproto *);
299 static void update_mtu(struct ofproto *, struct ofport *);
300 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
303 static void ofproto_unixctl_init(void);
305 /* All registered ofproto classes, in probe order. */
306 static const struct ofproto_class **ofproto_classes;
307 static size_t n_ofproto_classes;
308 static size_t allocated_ofproto_classes;
310 /* Global lock that protects all flow table operations. */
311 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
313 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
314 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
316 size_t n_handlers, n_revalidators;
318 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
319 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
321 /* Initial mappings of port to OpenFlow number mappings. */
322 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
324 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
326 /* The default value of true waits for flow restore. */
327 static bool flow_restore_wait = true;
329 /* Must be called to initialize the ofproto library.
331 * The caller may pass in 'iface_hints', which contains an shash of
332 * "iface_hint" elements indexed by the interface's name. The provider
333 * may use these hints to describe the startup configuration in order to
334 * reinitialize its state. The caller owns the provided data, so a
335 * provider will make copies of anything required. An ofproto provider
336 * will remove any existing state that is not described by the hint, and
337 * may choose to remove it all. */
339 ofproto_init(const struct shash *iface_hints)
341 struct shash_node *node;
344 ofproto_class_register(&ofproto_dpif_class);
346 /* Make a local copy, since we don't own 'iface_hints' elements. */
347 SHASH_FOR_EACH(node, iface_hints) {
348 const struct iface_hint *orig_hint = node->data;
349 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
350 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
352 new_hint->br_name = xstrdup(orig_hint->br_name);
353 new_hint->br_type = xstrdup(br_type);
354 new_hint->ofp_port = orig_hint->ofp_port;
356 shash_add(&init_ofp_ports, node->name, new_hint);
359 for (i = 0; i < n_ofproto_classes; i++) {
360 ofproto_classes[i]->init(&init_ofp_ports);
364 /* 'type' should be a normalized datapath type, as returned by
365 * ofproto_normalize_type(). Returns the corresponding ofproto_class
366 * structure, or a null pointer if there is none registered for 'type'. */
367 static const struct ofproto_class *
368 ofproto_class_find__(const char *type)
372 for (i = 0; i < n_ofproto_classes; i++) {
373 const struct ofproto_class *class = ofproto_classes[i];
378 class->enumerate_types(&types);
379 found = sset_contains(&types, type);
380 sset_destroy(&types);
386 VLOG_WARN("unknown datapath type %s", type);
390 /* Registers a new ofproto class. After successful registration, new ofprotos
391 * of that type can be created using ofproto_create(). */
393 ofproto_class_register(const struct ofproto_class *new_class)
397 for (i = 0; i < n_ofproto_classes; i++) {
398 if (ofproto_classes[i] == new_class) {
403 if (n_ofproto_classes >= allocated_ofproto_classes) {
404 ofproto_classes = x2nrealloc(ofproto_classes,
405 &allocated_ofproto_classes,
406 sizeof *ofproto_classes);
408 ofproto_classes[n_ofproto_classes++] = new_class;
412 /* Unregisters a datapath provider. 'type' must have been previously
413 * registered and not currently be in use by any ofprotos. After
414 * unregistration new datapaths of that type cannot be opened using
415 * ofproto_create(). */
417 ofproto_class_unregister(const struct ofproto_class *class)
421 for (i = 0; i < n_ofproto_classes; i++) {
422 if (ofproto_classes[i] == class) {
423 for (i++; i < n_ofproto_classes; i++) {
424 ofproto_classes[i - 1] = ofproto_classes[i];
430 VLOG_WARN("attempted to unregister an ofproto class that is not "
435 /* Clears 'types' and enumerates all registered ofproto types into it. The
436 * caller must first initialize the sset. */
438 ofproto_enumerate_types(struct sset *types)
443 for (i = 0; i < n_ofproto_classes; i++) {
444 ofproto_classes[i]->enumerate_types(types);
448 /* Returns the fully spelled out name for the given ofproto 'type'.
450 * Normalized type string can be compared with strcmp(). Unnormalized type
451 * string might be the same even if they have different spellings. */
453 ofproto_normalize_type(const char *type)
455 return type && type[0] ? type : "system";
458 /* Clears 'names' and enumerates the names of all known created ofprotos with
459 * the given 'type'. The caller must first initialize the sset. Returns 0 if
460 * successful, otherwise a positive errno value.
462 * Some kinds of datapaths might not be practically enumerable. This is not
463 * considered an error. */
465 ofproto_enumerate_names(const char *type, struct sset *names)
467 const struct ofproto_class *class = ofproto_class_find__(type);
468 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
472 ofproto_create(const char *datapath_name, const char *datapath_type,
473 struct ofproto **ofprotop)
475 const struct ofproto_class *class;
476 struct ofproto *ofproto;
482 ofproto_unixctl_init();
484 datapath_type = ofproto_normalize_type(datapath_type);
485 class = ofproto_class_find__(datapath_type);
487 VLOG_WARN("could not create datapath %s of unknown type %s",
488 datapath_name, datapath_type);
492 ofproto = class->alloc();
494 VLOG_ERR("failed to allocate datapath %s of type %s",
495 datapath_name, datapath_type);
500 ovs_mutex_lock(&ofproto_mutex);
501 memset(ofproto, 0, sizeof *ofproto);
502 ofproto->ofproto_class = class;
503 ofproto->name = xstrdup(datapath_name);
504 ofproto->type = xstrdup(datapath_type);
505 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
506 hash_string(ofproto->name, 0));
507 ofproto->datapath_id = 0;
508 ofproto->forward_bpdu = false;
509 ofproto->fallback_dpid = pick_fallback_dpid();
510 ofproto->mfr_desc = NULL;
511 ofproto->hw_desc = NULL;
512 ofproto->sw_desc = NULL;
513 ofproto->serial_desc = NULL;
514 ofproto->dp_desc = NULL;
515 ofproto->frag_handling = OFPC_FRAG_NORMAL;
516 hmap_init(&ofproto->ports);
517 hmap_init(&ofproto->ofport_usage);
518 shash_init(&ofproto->port_by_name);
519 simap_init(&ofproto->ofp_requests);
520 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
521 ofproto->eviction_group_timer = LLONG_MIN;
522 ofproto->tables = NULL;
523 ofproto->n_tables = 0;
524 hindex_init(&ofproto->cookies);
525 list_init(&ofproto->expirable);
526 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
527 ofproto->state = S_OPENFLOW;
528 list_init(&ofproto->pending);
529 ofproto->n_pending = 0;
530 hmap_init(&ofproto->deletions);
531 guarded_list_init(&ofproto->rule_executes);
532 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
533 ofproto->first_op = ofproto->last_op = LLONG_MIN;
534 ofproto->next_op_report = LLONG_MAX;
535 ofproto->op_backoff = LLONG_MIN;
536 ofproto->vlan_bitmap = NULL;
537 ofproto->vlans_changed = false;
538 ofproto->min_mtu = INT_MAX;
539 ovs_rwlock_init(&ofproto->groups_rwlock);
540 hmap_init(&ofproto->groups);
541 ovs_mutex_unlock(&ofproto_mutex);
542 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
543 OFPGFC_SELECT_WEIGHT;
544 ofproto->ogf.max_groups[OFPGT11_ALL] = OFPG_MAX;
545 ofproto->ogf.max_groups[OFPGT11_SELECT] = OFPG_MAX;
546 ofproto->ogf.max_groups[OFPGT11_INDIRECT] = OFPG_MAX;
547 ofproto->ogf.max_groups[OFPGT11_FF] = OFPG_MAX;
548 ofproto->ogf.actions[0] =
549 (1 << OFPAT11_OUTPUT) |
550 (1 << OFPAT11_COPY_TTL_OUT) |
551 (1 << OFPAT11_COPY_TTL_IN) |
552 (1 << OFPAT11_SET_MPLS_TTL) |
553 (1 << OFPAT11_DEC_MPLS_TTL) |
554 (1 << OFPAT11_PUSH_VLAN) |
555 (1 << OFPAT11_POP_VLAN) |
556 (1 << OFPAT11_PUSH_MPLS) |
557 (1 << OFPAT11_POP_MPLS) |
558 (1 << OFPAT11_SET_QUEUE) |
559 (1 << OFPAT11_GROUP) |
560 (1 << OFPAT11_SET_NW_TTL) |
561 (1 << OFPAT11_DEC_NW_TTL) |
562 (1 << OFPAT12_SET_FIELD);
564 * (1 << OFPAT13_PUSH_PBB) |
565 * (1 << OFPAT13_POP_PBB) */
567 error = ofproto->ofproto_class->construct(ofproto);
569 VLOG_ERR("failed to open datapath %s: %s",
570 datapath_name, ovs_strerror(error));
571 ofproto_destroy__(ofproto);
575 /* Check that hidden tables, if any, are at the end. */
576 ovs_assert(ofproto->n_tables);
577 for (i = 0; i + 1 < ofproto->n_tables; i++) {
578 enum oftable_flags flags = ofproto->tables[i].flags;
579 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
581 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
584 ofproto->datapath_id = pick_datapath_id(ofproto);
587 /* Initialize meters table. */
588 if (ofproto->ofproto_class->meter_get_features) {
589 ofproto->ofproto_class->meter_get_features(ofproto,
590 &ofproto->meter_features);
592 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
594 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
595 * sizeof(struct meter *));
601 /* Must be called (only) by an ofproto implementation in its constructor
602 * function. See the large comment on 'construct' in struct ofproto_class for
605 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
607 struct oftable *table;
609 ovs_assert(!ofproto->n_tables);
610 ovs_assert(n_tables >= 1 && n_tables <= 255);
612 ofproto->n_tables = n_tables;
613 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
614 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
619 /* To be optionally called (only) by an ofproto implementation in its
620 * constructor function. See the large comment on 'construct' in struct
621 * ofproto_class for details.
623 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
624 * will then ensure that actions passed into the ofproto implementation will
625 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
626 * function is not called, there will be no such restriction.
628 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
629 * the 'max_ports' restriction. */
631 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
633 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
634 ofproto->max_ports = max_ports;
638 ofproto_get_datapath_id(const struct ofproto *ofproto)
640 return ofproto->datapath_id;
644 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
646 uint64_t old_dpid = p->datapath_id;
647 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
648 if (p->datapath_id != old_dpid) {
649 /* Force all active connections to reconnect, since there is no way to
650 * notify a controller that the datapath ID has changed. */
651 ofproto_reconnect_controllers(p);
656 ofproto_set_controllers(struct ofproto *p,
657 const struct ofproto_controller *controllers,
658 size_t n_controllers, uint32_t allowed_versions)
660 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
665 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
667 connmgr_set_fail_mode(p->connmgr, fail_mode);
670 /* Drops the connections between 'ofproto' and all of its controllers, forcing
671 * them to reconnect. */
673 ofproto_reconnect_controllers(struct ofproto *ofproto)
675 connmgr_reconnect(ofproto->connmgr);
678 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
679 * in-band control should guarantee access, in the same way that in-band
680 * control guarantees access to OpenFlow controllers. */
682 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
683 const struct sockaddr_in *extras, size_t n)
685 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
688 /* Sets the OpenFlow queue used by flows set up by in-band control on
689 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
690 * flows will use the default queue. */
692 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
694 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
697 /* Sets the number of flows at which eviction from the kernel flow table
700 ofproto_set_flow_limit(unsigned limit)
702 ofproto_flow_limit = limit;
705 /* Sets the maximum idle time for flows in the datapath before they are
708 ofproto_set_max_idle(unsigned max_idle)
710 ofproto_max_idle = max_idle;
713 /* If forward_bpdu is true, the NORMAL action will forward frames with
714 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
715 * the NORMAL action will drop these frames. */
717 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
719 bool old_val = ofproto->forward_bpdu;
720 ofproto->forward_bpdu = forward_bpdu;
721 if (old_val != ofproto->forward_bpdu) {
722 if (ofproto->ofproto_class->forward_bpdu_changed) {
723 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
728 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
729 * 'idle_time', in seconds, and the maximum number of MAC table entries to
732 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
735 if (ofproto->ofproto_class->set_mac_table_config) {
736 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
742 ofproto_set_threads(int n_handlers_, int n_revalidators_)
744 int threads = MAX(count_cpu_cores(), 2);
746 n_revalidators = MAX(n_revalidators_, 0);
747 n_handlers = MAX(n_handlers_, 0);
749 if (!n_revalidators) {
750 n_revalidators = n_handlers
751 ? MAX(threads - (int) n_handlers, 1)
756 n_handlers = MAX(threads - (int) n_revalidators, 1);
761 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
764 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
768 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
770 return connmgr_set_snoops(ofproto->connmgr, snoops);
774 ofproto_set_netflow(struct ofproto *ofproto,
775 const struct netflow_options *nf_options)
777 if (nf_options && sset_is_empty(&nf_options->collectors)) {
781 if (ofproto->ofproto_class->set_netflow) {
782 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
784 return nf_options ? EOPNOTSUPP : 0;
789 ofproto_set_sflow(struct ofproto *ofproto,
790 const struct ofproto_sflow_options *oso)
792 if (oso && sset_is_empty(&oso->targets)) {
796 if (ofproto->ofproto_class->set_sflow) {
797 return ofproto->ofproto_class->set_sflow(ofproto, oso);
799 return oso ? EOPNOTSUPP : 0;
804 ofproto_set_ipfix(struct ofproto *ofproto,
805 const struct ofproto_ipfix_bridge_exporter_options *bo,
806 const struct ofproto_ipfix_flow_exporter_options *fo,
809 if (ofproto->ofproto_class->set_ipfix) {
810 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
812 return (bo || fo) ? EOPNOTSUPP : 0;
817 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
819 flow_restore_wait = flow_restore_wait_db;
823 ofproto_get_flow_restore_wait(void)
825 return flow_restore_wait;
829 /* Spanning Tree Protocol (STP) configuration. */
831 /* Configures STP on 'ofproto' using the settings defined in 's'. If
832 * 's' is NULL, disables STP.
834 * Returns 0 if successful, otherwise a positive errno value. */
836 ofproto_set_stp(struct ofproto *ofproto,
837 const struct ofproto_stp_settings *s)
839 return (ofproto->ofproto_class->set_stp
840 ? ofproto->ofproto_class->set_stp(ofproto, s)
844 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
845 * 'enabled' member of 's' is false, then the other members are not
848 * Returns 0 if successful, otherwise a positive errno value. */
850 ofproto_get_stp_status(struct ofproto *ofproto,
851 struct ofproto_stp_status *s)
853 return (ofproto->ofproto_class->get_stp_status
854 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
858 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
859 * in 's'. The caller is responsible for assigning STP port numbers
860 * (using the 'port_num' member in the range of 1 through 255, inclusive)
861 * and ensuring there are no duplicates. If the 's' is NULL, then STP
862 * is disabled on the port.
864 * Returns 0 if successful, otherwise a positive errno value.*/
866 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
867 const struct ofproto_port_stp_settings *s)
869 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
871 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
872 ofproto->name, ofp_port);
876 return (ofproto->ofproto_class->set_stp_port
877 ? ofproto->ofproto_class->set_stp_port(ofport, s)
881 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
882 * 's'. If the 'enabled' member in 's' is false, then the other members
883 * are not meaningful.
885 * Returns 0 if successful, otherwise a positive errno value.*/
887 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
888 struct ofproto_port_stp_status *s)
890 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
892 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
893 "port %"PRIu16, ofproto->name, ofp_port);
897 return (ofproto->ofproto_class->get_stp_port_status
898 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
902 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
903 * 's'. If the 'enabled' member in 's' is false, then the other members
904 * are not meaningful.
906 * Returns 0 if successful, otherwise a positive errno value.*/
908 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
909 struct ofproto_port_stp_stats *s)
911 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
913 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
914 "port %"PRIu16, ofproto->name, ofp_port);
918 return (ofproto->ofproto_class->get_stp_port_stats
919 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
923 /* Queue DSCP configuration. */
925 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
926 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
927 * to implement QoS. Instead, it is used to implement features which require
928 * knowledge of what queues exist on a port, and some basic information about
931 * Returns 0 if successful, otherwise a positive errno value. */
933 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
934 const struct ofproto_port_queue *queues,
937 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
940 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
941 ofproto->name, ofp_port);
945 return (ofproto->ofproto_class->set_queues
946 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
950 /* Connectivity Fault Management configuration. */
952 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
954 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
956 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
957 if (ofport && ofproto->ofproto_class->set_cfm) {
958 ofproto->ofproto_class->set_cfm(ofport, NULL);
962 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
963 * basic configuration from the configuration members in 'cfm', and the remote
964 * maintenance point ID from remote_mpid. Ignores the statistics members of
967 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
969 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
970 const struct cfm_settings *s)
972 struct ofport *ofport;
975 ofport = ofproto_get_port(ofproto, ofp_port);
977 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
978 ofproto->name, ofp_port);
982 /* XXX: For configuration simplicity, we only support one remote_mpid
983 * outside of the CFM module. It's not clear if this is the correct long
984 * term solution or not. */
985 error = (ofproto->ofproto_class->set_cfm
986 ? ofproto->ofproto_class->set_cfm(ofport, s)
989 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
990 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
991 ovs_strerror(error));
995 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
996 * 'ofproto' does not have a port 'ofp_port'. */
998 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
999 const struct smap *cfg)
1001 struct ofport *ofport;
1004 ofport = ofproto_get_port(ofproto, ofp_port);
1006 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1007 ofproto->name, ofp_port);
1011 error = (ofproto->ofproto_class->set_bfd
1012 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1015 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1016 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1017 ovs_strerror(error));
1021 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1022 * success. Returns a negative number if there is no status change since
1023 * last update. Returns a positive errno otherwise. Has no effect if
1024 * 'ofp_port' is not an OpenFlow port in 'ofproto'.
1026 * The caller must provide and own '*status'. */
1028 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1029 struct smap *status)
1031 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1032 return (ofport && ofproto->ofproto_class->get_bfd_status
1033 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1037 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1038 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1039 * 0 if LACP partner information is not current (generally indicating a
1040 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1042 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1044 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1045 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1046 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1052 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1053 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1054 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1055 * configuration plus, if there is more than one slave, a bonding
1058 * If 'aux' is already registered then this function updates its configuration
1059 * to 's'. Otherwise, this function registers a new bundle.
1061 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1064 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1065 const struct ofproto_bundle_settings *s)
1067 return (ofproto->ofproto_class->bundle_set
1068 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1072 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1073 * If no such bundle has been registered, this has no effect. */
1075 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1077 return ofproto_bundle_register(ofproto, aux, NULL);
1081 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1082 * If 'aux' is already registered then this function updates its configuration
1083 * to 's'. Otherwise, this function registers a new mirror. */
1085 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1086 const struct ofproto_mirror_settings *s)
1088 return (ofproto->ofproto_class->mirror_set
1089 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1093 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1094 * If no mirror has been registered, this has no effect. */
1096 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1098 return ofproto_mirror_register(ofproto, aux, NULL);
1101 /* Retrieves statistics from mirror associated with client data pointer
1102 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1103 * 'bytes', respectively. If a particular counters is not supported,
1104 * the appropriate argument is set to UINT64_MAX. */
1106 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1107 uint64_t *packets, uint64_t *bytes)
1109 if (!ofproto->ofproto_class->mirror_get_stats) {
1110 *packets = *bytes = UINT64_MAX;
1114 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1118 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1119 * which all packets are flooded, instead of using MAC learning. If
1120 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1122 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1125 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1127 return (ofproto->ofproto_class->set_flood_vlans
1128 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1132 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1133 * output for a mirror. */
1135 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1137 return (ofproto->ofproto_class->is_mirror_output_bundle
1138 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1142 /* Configuration of OpenFlow tables. */
1144 /* Returns the number of OpenFlow tables in 'ofproto'. */
1146 ofproto_get_n_tables(const struct ofproto *ofproto)
1148 return ofproto->n_tables;
1151 /* Returns the number of Controller visible OpenFlow tables
1152 * in 'ofproto'. This number will exclude Hidden tables.
1153 * This funtion's return value should be less or equal to that of
1154 * ofproto_get_n_tables() . */
1156 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1158 uint8_t n = ofproto->n_tables;
1160 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1161 * if present, are always at the end.) */
1162 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1169 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1170 * settings from 's'. 'table_id' must be in the range 0 through the number of
1171 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1173 * For read-only tables, only the name may be configured. */
1175 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1176 const struct ofproto_table_settings *s)
1178 struct oftable *table;
1180 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1181 table = &ofproto->tables[table_id];
1183 oftable_set_name(table, s->name);
1185 if (table->flags & OFTABLE_READONLY) {
1190 oftable_enable_eviction(table, s->groups, s->n_groups);
1192 oftable_disable_eviction(table);
1195 table->max_flows = s->max_flows;
1196 fat_rwlock_wrlock(&table->cls.rwlock);
1197 if (classifier_count(&table->cls) > table->max_flows
1198 && table->eviction_fields) {
1199 /* 'table' contains more flows than allowed. We might not be able to
1200 * evict them right away because of the asynchronous nature of flow
1201 * table changes. Schedule eviction for later. */
1202 switch (ofproto->state) {
1204 ofproto->state = S_EVICT;
1208 /* We're already deleting flows, nothing more to do. */
1213 classifier_set_prefix_fields(&table->cls,
1214 s->prefix_fields, s->n_prefix_fields);
1216 fat_rwlock_unlock(&table->cls.rwlock);
1220 ofproto_has_snoops(const struct ofproto *ofproto)
1222 return connmgr_has_snoops(ofproto->connmgr);
1226 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1228 connmgr_get_snoops(ofproto->connmgr, snoops);
1232 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1234 OVS_REQUIRES(ofproto_mutex)
1236 struct ofopgroup *group;
1238 ovs_assert(!rule->pending);
1240 group = ofopgroup_create_unattached(ofproto);
1241 delete_flow__(rule, group, reason);
1242 ofopgroup_submit(group);
1245 /* Deletes 'rule' from 'ofproto'.
1247 * Within an ofproto implementation, this function allows an ofproto
1248 * implementation to destroy any rules that remain when its ->destruct()
1249 * function is called. This function is not suitable for use elsewhere in an
1250 * ofproto implementation.
1252 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1253 * Cycle" in ofproto-provider.h. */
1255 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1256 OVS_EXCLUDED(ofproto_mutex)
1258 struct ofopgroup *group;
1260 ovs_mutex_lock(&ofproto_mutex);
1261 ovs_assert(!rule->pending);
1263 group = ofopgroup_create_unattached(ofproto);
1264 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1265 oftable_remove_rule__(ofproto, rule);
1266 ofproto->ofproto_class->rule_delete(rule);
1267 ofopgroup_submit(group);
1269 ovs_mutex_unlock(&ofproto_mutex);
1273 ofproto_flush__(struct ofproto *ofproto)
1274 OVS_EXCLUDED(ofproto_mutex)
1276 struct oftable *table;
1278 if (ofproto->ofproto_class->flush) {
1279 ofproto->ofproto_class->flush(ofproto);
1282 ovs_mutex_lock(&ofproto_mutex);
1283 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1284 struct rule *rule, *next_rule;
1285 struct cls_cursor cursor;
1287 if (table->flags & OFTABLE_HIDDEN) {
1291 fat_rwlock_rdlock(&table->cls.rwlock);
1292 cls_cursor_init(&cursor, &table->cls, NULL);
1293 fat_rwlock_unlock(&table->cls.rwlock);
1294 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1295 if (!rule->pending) {
1296 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1300 ovs_mutex_unlock(&ofproto_mutex);
1303 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1306 ofproto_destroy__(struct ofproto *ofproto)
1307 OVS_EXCLUDED(ofproto_mutex)
1309 struct oftable *table;
1311 ovs_assert(list_is_empty(&ofproto->pending));
1313 destroy_rule_executes(ofproto);
1314 delete_group(ofproto, OFPG_ALL);
1316 guarded_list_destroy(&ofproto->rule_executes);
1317 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1318 hmap_destroy(&ofproto->groups);
1320 connmgr_destroy(ofproto->connmgr);
1322 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1323 free(ofproto->name);
1324 free(ofproto->type);
1325 free(ofproto->mfr_desc);
1326 free(ofproto->hw_desc);
1327 free(ofproto->sw_desc);
1328 free(ofproto->serial_desc);
1329 free(ofproto->dp_desc);
1330 hmap_destroy(&ofproto->ports);
1331 hmap_destroy(&ofproto->ofport_usage);
1332 shash_destroy(&ofproto->port_by_name);
1333 simap_destroy(&ofproto->ofp_requests);
1335 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1336 oftable_destroy(table);
1338 free(ofproto->tables);
1340 hmap_destroy(&ofproto->deletions);
1342 free(ofproto->vlan_bitmap);
1344 ofproto->ofproto_class->dealloc(ofproto);
1348 ofproto_destroy(struct ofproto *p)
1349 OVS_EXCLUDED(ofproto_mutex)
1351 struct ofport *ofport, *next_ofport;
1352 struct ofport_usage *usage, *next_usage;
1359 meter_delete(p, 1, p->meter_features.max_meters);
1360 p->meter_features.max_meters = 0;
1366 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1367 ofport_destroy(ofport);
1370 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1371 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1375 p->ofproto_class->destruct(p);
1376 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1377 ovsrcu_postpone(ofproto_destroy__, p);
1380 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1381 * kernel datapath, for example, this destroys the datapath in the kernel, and
1382 * with the netdev-based datapath, it tears down the data structures that
1383 * represent the datapath.
1385 * The datapath should not be currently open as an ofproto. */
1387 ofproto_delete(const char *name, const char *type)
1389 const struct ofproto_class *class = ofproto_class_find__(type);
1390 return (!class ? EAFNOSUPPORT
1391 : !class->del ? EACCES
1392 : class->del(type, name));
1396 process_port_change(struct ofproto *ofproto, int error, char *devname)
1398 if (error == ENOBUFS) {
1399 reinit_ports(ofproto);
1400 } else if (!error) {
1401 update_port(ofproto, devname);
1407 ofproto_type_run(const char *datapath_type)
1409 const struct ofproto_class *class;
1412 datapath_type = ofproto_normalize_type(datapath_type);
1413 class = ofproto_class_find__(datapath_type);
1415 error = class->type_run ? class->type_run(datapath_type) : 0;
1416 if (error && error != EAGAIN) {
1417 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1418 datapath_type, ovs_strerror(error));
1424 ofproto_type_wait(const char *datapath_type)
1426 const struct ofproto_class *class;
1428 datapath_type = ofproto_normalize_type(datapath_type);
1429 class = ofproto_class_find__(datapath_type);
1431 if (class->type_wait) {
1432 class->type_wait(datapath_type);
1437 any_pending_ops(const struct ofproto *p)
1438 OVS_EXCLUDED(ofproto_mutex)
1442 ovs_mutex_lock(&ofproto_mutex);
1443 b = !list_is_empty(&p->pending);
1444 ovs_mutex_unlock(&ofproto_mutex);
1450 ofproto_run(struct ofproto *p)
1455 error = p->ofproto_class->run(p);
1456 if (error && error != EAGAIN) {
1457 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1460 run_rule_executes(p);
1462 /* Restore the eviction group heap invariant occasionally. */
1463 if (p->eviction_group_timer < time_msec()) {
1466 p->eviction_group_timer = time_msec() + 1000;
1468 for (i = 0; i < p->n_tables; i++) {
1469 struct oftable *table = &p->tables[i];
1470 struct eviction_group *evg;
1471 struct cls_cursor cursor;
1474 if (!table->eviction_fields) {
1478 ovs_mutex_lock(&ofproto_mutex);
1479 fat_rwlock_rdlock(&table->cls.rwlock);
1480 cls_cursor_init(&cursor, &table->cls, NULL);
1481 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1482 if (rule->idle_timeout || rule->hard_timeout) {
1483 if (!rule->eviction_group) {
1484 eviction_group_add_rule(rule);
1486 heap_raw_change(&rule->evg_node,
1487 rule_eviction_priority(p, rule));
1491 fat_rwlock_unlock(&table->cls.rwlock);
1493 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1494 heap_rebuild(&evg->rules);
1496 ovs_mutex_unlock(&ofproto_mutex);
1500 if (p->ofproto_class->port_poll) {
1503 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1504 process_port_change(p, error, devname);
1508 new_seq = seq_read(connectivity_seq_get());
1509 if (new_seq != p->change_seq) {
1510 struct sset devnames;
1511 const char *devname;
1512 struct ofport *ofport;
1514 /* Update OpenFlow port status for any port whose netdev has changed.
1516 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1517 * destroyed, so it's not safe to update ports directly from the
1518 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1519 * need this two-phase approach. */
1520 sset_init(&devnames);
1521 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1522 uint64_t port_change_seq;
1524 port_change_seq = netdev_get_change_seq(ofport->netdev);
1525 if (ofport->change_seq != port_change_seq) {
1526 ofport->change_seq = port_change_seq;
1527 sset_add(&devnames, netdev_get_name(ofport->netdev));
1530 SSET_FOR_EACH (devname, &devnames) {
1531 update_port(p, devname);
1533 sset_destroy(&devnames);
1535 p->change_seq = new_seq;
1540 connmgr_run(p->connmgr, handle_openflow);
1544 connmgr_run(p->connmgr, NULL);
1546 if (!any_pending_ops(p)) {
1547 p->state = S_OPENFLOW;
1552 connmgr_run(p->connmgr, NULL);
1554 if (!any_pending_ops(p)) {
1555 connmgr_flushed(p->connmgr);
1556 p->state = S_OPENFLOW;
1564 if (time_msec() >= p->next_op_report) {
1565 long long int ago = (time_msec() - p->first_op) / 1000;
1566 long long int interval = (p->last_op - p->first_op) / 1000;
1570 ds_put_format(&s, "%d flow_mods ",
1571 p->n_add + p->n_delete + p->n_modify);
1572 if (interval == ago) {
1573 ds_put_format(&s, "in the last %lld s", ago);
1574 } else if (interval) {
1575 ds_put_format(&s, "in the %lld s starting %lld s ago",
1578 ds_put_format(&s, "%lld s ago", ago);
1581 ds_put_cstr(&s, " (");
1583 ds_put_format(&s, "%d adds, ", p->n_add);
1586 ds_put_format(&s, "%d deletes, ", p->n_delete);
1589 ds_put_format(&s, "%d modifications, ", p->n_modify);
1592 ds_put_char(&s, ')');
1594 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1597 p->n_add = p->n_delete = p->n_modify = 0;
1598 p->next_op_report = LLONG_MAX;
1605 ofproto_wait(struct ofproto *p)
1607 p->ofproto_class->wait(p);
1608 if (p->ofproto_class->port_poll_wait) {
1609 p->ofproto_class->port_poll_wait(p);
1611 seq_wait(connectivity_seq_get(), p->change_seq);
1615 connmgr_wait(p->connmgr, true);
1620 connmgr_wait(p->connmgr, false);
1621 if (!any_pending_ops(p)) {
1622 poll_immediate_wake();
1629 ofproto_is_alive(const struct ofproto *p)
1631 return connmgr_has_controllers(p->connmgr);
1634 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1635 * memory_report(). */
1637 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1639 const struct oftable *table;
1640 unsigned int n_rules;
1642 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1644 ovs_mutex_lock(&ofproto_mutex);
1645 simap_increase(usage, "ops",
1646 ofproto->n_pending + hmap_count(&ofproto->deletions));
1647 ovs_mutex_unlock(&ofproto_mutex);
1650 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1651 fat_rwlock_rdlock(&table->cls.rwlock);
1652 n_rules += classifier_count(&table->cls);
1653 fat_rwlock_unlock(&table->cls.rwlock);
1655 simap_increase(usage, "rules", n_rules);
1657 if (ofproto->ofproto_class->get_memory_usage) {
1658 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1661 connmgr_get_memory_usage(ofproto->connmgr, usage);
1665 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1667 const struct ofproto_class *class;
1669 datapath_type = ofproto_normalize_type(datapath_type);
1670 class = ofproto_class_find__(datapath_type);
1672 if (class && class->type_get_memory_usage) {
1673 class->type_get_memory_usage(datapath_type, usage);
1678 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1681 connmgr_get_controller_info(ofproto->connmgr, info);
1685 ofproto_free_ofproto_controller_info(struct shash *info)
1687 connmgr_free_controller_info(info);
1690 /* Makes a deep copy of 'old' into 'port'. */
1692 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1694 port->name = xstrdup(old->name);
1695 port->type = xstrdup(old->type);
1696 port->ofp_port = old->ofp_port;
1699 /* Frees memory allocated to members of 'ofproto_port'.
1701 * Do not call this function on an ofproto_port obtained from
1702 * ofproto_port_dump_next(): that function retains ownership of the data in the
1705 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1707 free(ofproto_port->name);
1708 free(ofproto_port->type);
1711 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1713 * This function provides no status indication. An error status for the entire
1714 * dump operation is provided when it is completed by calling
1715 * ofproto_port_dump_done().
1718 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1719 const struct ofproto *ofproto)
1721 dump->ofproto = ofproto;
1722 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1726 /* Attempts to retrieve another port from 'dump', which must have been created
1727 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1728 * 'port' and returns true. On failure, returns false.
1730 * Failure might indicate an actual error or merely that the last port has been
1731 * dumped. An error status for the entire dump operation is provided when it
1732 * is completed by calling ofproto_port_dump_done().
1734 * The ofproto owns the data stored in 'port'. It will remain valid until at
1735 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1736 * ofproto_port_dump_done(). */
1738 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1739 struct ofproto_port *port)
1741 const struct ofproto *ofproto = dump->ofproto;
1747 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1750 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1756 /* Completes port table dump operation 'dump', which must have been created
1757 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1758 * error-free, otherwise a positive errno value describing the problem. */
1760 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1762 const struct ofproto *ofproto = dump->ofproto;
1764 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1767 return dump->error == EOF ? 0 : dump->error;
1770 /* Returns the type to pass to netdev_open() when a datapath of type
1771 * 'datapath_type' has a port of type 'port_type', for a few special
1772 * cases when a netdev type differs from a port type. For example, when
1773 * using the userspace datapath, a port of type "internal" needs to be
1776 * Returns either 'type' itself or a string literal, which must not be
1779 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1781 const struct ofproto_class *class;
1783 datapath_type = ofproto_normalize_type(datapath_type);
1784 class = ofproto_class_find__(datapath_type);
1789 return (class->port_open_type
1790 ? class->port_open_type(datapath_type, port_type)
1794 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1795 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1796 * the port's OpenFlow port number.
1798 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1799 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1800 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1801 * 'ofp_portp' is non-null). */
1803 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1804 ofp_port_t *ofp_portp)
1806 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1809 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1811 const char *netdev_name = netdev_get_name(netdev);
1813 simap_put(&ofproto->ofp_requests, netdev_name,
1814 ofp_to_u16(ofp_port));
1815 update_port(ofproto, netdev_name);
1818 *ofp_portp = OFPP_NONE;
1820 struct ofproto_port ofproto_port;
1822 error = ofproto_port_query_by_name(ofproto,
1823 netdev_get_name(netdev),
1826 *ofp_portp = ofproto_port.ofp_port;
1827 ofproto_port_destroy(&ofproto_port);
1834 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1835 * initializes '*port' appropriately; on failure, returns a positive errno
1838 * The caller owns the data in 'ofproto_port' and must free it with
1839 * ofproto_port_destroy() when it is no longer needed. */
1841 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1842 struct ofproto_port *port)
1846 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1848 memset(port, 0, sizeof *port);
1853 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1854 * Returns 0 if successful, otherwise a positive errno. */
1856 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1858 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1859 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1860 struct simap_node *ofp_request_node;
1863 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1864 if (ofp_request_node) {
1865 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1868 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1869 if (!error && ofport) {
1870 /* 'name' is the netdev's name and update_port() is going to close the
1871 * netdev. Just in case update_port() refers to 'name' after it
1872 * destroys 'ofport', make a copy of it around the update_port()
1874 char *devname = xstrdup(name);
1875 update_port(ofproto, devname);
1882 flow_mod_init(struct ofputil_flow_mod *fm,
1883 const struct match *match, unsigned int priority,
1884 const struct ofpact *ofpacts, size_t ofpacts_len,
1885 enum ofp_flow_mod_command command)
1887 memset(fm, 0, sizeof *fm);
1889 fm->priority = priority;
1892 fm->modify_cookie = false;
1894 fm->command = command;
1895 fm->idle_timeout = 0;
1896 fm->hard_timeout = 0;
1897 fm->buffer_id = UINT32_MAX;
1898 fm->out_port = OFPP_ANY;
1899 fm->out_group = OFPG_ANY;
1901 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1902 fm->ofpacts_len = ofpacts_len;
1906 simple_flow_mod(struct ofproto *ofproto,
1907 const struct match *match, unsigned int priority,
1908 const struct ofpact *ofpacts, size_t ofpacts_len,
1909 enum ofp_flow_mod_command command)
1911 struct ofputil_flow_mod fm;
1913 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1915 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1918 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1919 * performs the 'n_actions' actions in 'actions'. The new flow will not
1922 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1923 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1924 * controllers; otherwise, it will be hidden.
1926 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1928 * This is a helper function for in-band control and fail-open. */
1930 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1931 unsigned int priority,
1932 const struct ofpact *ofpacts, size_t ofpacts_len)
1933 OVS_EXCLUDED(ofproto_mutex)
1935 const struct rule *rule;
1938 /* First do a cheap check whether the rule we're looking for already exists
1939 * with the actions that we want. If it does, then we're done. */
1940 fat_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1941 rule = rule_from_cls_rule(classifier_find_match_exactly(
1942 &ofproto->tables[0].cls, match, priority));
1944 const struct rule_actions *actions = rule_get_actions(rule);
1945 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1946 ofpacts, ofpacts_len);
1950 fat_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1952 /* If there's no such rule or the rule doesn't have the actions we want,
1953 * fall back to a executing a full flow mod. We can't optimize this at
1954 * all because we didn't take enough locks above to ensure that the flow
1955 * table didn't already change beneath us. */
1957 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1958 OFPFC_MODIFY_STRICT);
1962 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1963 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1964 * operation cannot be initiated now but may be retried later.
1966 * This is a helper function for in-band control and fail-open and the "learn"
1969 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1970 OVS_EXCLUDED(ofproto_mutex)
1972 /* Optimize for the most common case of a repeated learn action.
1973 * If an identical flow already exists we only need to update its
1974 * 'modified' time. */
1975 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1976 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1977 struct oftable *table = &ofproto->tables[fm->table_id];
1981 fat_rwlock_rdlock(&table->cls.rwlock);
1982 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
1986 /* Reading many of the rule fields and writing on 'modified'
1987 * requires the rule->mutex. Also, rule->actions may change
1988 * if rule->mutex is not held. */
1989 const struct rule_actions *actions;
1991 ovs_mutex_lock(&rule->mutex);
1992 actions = rule_get_actions(rule);
1993 if (rule->idle_timeout == fm->idle_timeout
1994 && rule->hard_timeout == fm->hard_timeout
1995 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1996 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1997 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
1998 actions->ofpacts, actions->ofpacts_len)) {
1999 /* Rule already exists and need not change, only update the
2000 modified timestamp. */
2001 rule->modified = time_msec();
2004 ovs_mutex_unlock(&rule->mutex);
2006 fat_rwlock_unlock(&table->cls.rwlock);
2013 return handle_flow_mod__(ofproto, NULL, fm, NULL);
2016 /* Resets the modified time for 'rule' or an equivalent rule. If 'rule' is not
2017 * in the classifier, but an equivalent rule is, unref 'rule' and ref the new
2018 * rule. Otherwise if 'rule' is no longer installed in the classifier,
2021 * Returns the rule whose modified time has been reset. */
2023 ofproto_refresh_rule(struct rule *rule)
2025 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
2026 const struct cls_rule *cr = &rule->cr;
2029 /* do_add_flow() requires that the rule is not installed. We lock the
2030 * ofproto_mutex here so that another thread cannot add the flow before
2031 * we get a chance to add it.*/
2032 ovs_mutex_lock(&ofproto_mutex);
2034 fat_rwlock_rdlock(&table->cls.rwlock);
2035 r = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, cr));
2037 ofproto_rule_ref(r);
2039 fat_rwlock_unlock(&table->cls.rwlock);
2042 do_add_flow(rule->ofproto, NULL, NULL, 0, rule);
2043 } else if (r != rule) {
2044 ofproto_rule_unref(rule);
2047 ovs_mutex_unlock(&ofproto_mutex);
2049 /* Refresh the modified time for the rule. */
2050 ovs_mutex_lock(&rule->mutex);
2051 rule->modified = MAX(rule->modified, time_msec());
2052 ovs_mutex_unlock(&rule->mutex);
2057 /* Searches for a rule with matching criteria exactly equal to 'target' in
2058 * ofproto's table 0 and, if it finds one, deletes it.
2060 * This is a helper function for in-band control and fail-open. */
2062 ofproto_delete_flow(struct ofproto *ofproto,
2063 const struct match *target, unsigned int priority)
2064 OVS_EXCLUDED(ofproto_mutex)
2066 struct classifier *cls = &ofproto->tables[0].cls;
2069 /* First do a cheap check whether the rule we're looking for has already
2070 * been deleted. If so, then we're done. */
2071 fat_rwlock_rdlock(&cls->rwlock);
2072 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2074 fat_rwlock_unlock(&cls->rwlock);
2079 /* Fall back to a executing a full flow mod. We can't optimize this at all
2080 * because we didn't take enough locks above to ensure that the flow table
2081 * didn't already change beneath us. */
2082 return simple_flow_mod(ofproto, target, priority, NULL, 0,
2083 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
2086 /* Starts the process of deleting all of the flows from all of ofproto's flow
2087 * tables and then reintroducing the flows required by in-band control and
2088 * fail-open. The process will complete in a later call to ofproto_run(). */
2090 ofproto_flush_flows(struct ofproto *ofproto)
2092 COVERAGE_INC(ofproto_flush);
2093 ofproto->state = S_FLUSH;
2097 reinit_ports(struct ofproto *p)
2099 struct ofproto_port_dump dump;
2100 struct sset devnames;
2101 struct ofport *ofport;
2102 struct ofproto_port ofproto_port;
2103 const char *devname;
2105 COVERAGE_INC(ofproto_reinit_ports);
2107 sset_init(&devnames);
2108 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2109 sset_add(&devnames, netdev_get_name(ofport->netdev));
2111 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2112 sset_add(&devnames, ofproto_port.name);
2115 SSET_FOR_EACH (devname, &devnames) {
2116 update_port(p, devname);
2118 sset_destroy(&devnames);
2122 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2126 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2127 port_idx = port_idx ? port_idx : UINT16_MAX;
2129 if (port_idx >= ofproto->max_ports
2130 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2131 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2132 long long int last_used_at, lru = LLONG_MAX;
2134 /* Search for a free OpenFlow port number. We try not to
2135 * immediately reuse them to prevent problems due to old
2138 * We limit the automatically assigned port numbers to the lower half
2139 * of the port range, to reserve the upper half for assignment by
2142 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2143 ofproto->alloc_port_no = 1;
2145 last_used_at = ofport_get_usage(ofproto,
2146 u16_to_ofp(ofproto->alloc_port_no));
2147 if (!last_used_at) {
2148 port_idx = ofproto->alloc_port_no;
2150 } else if ( last_used_at < time_msec() - 60*60*1000) {
2151 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2152 * more than an hour ago, consider it usable. */
2153 ofport_remove_usage(ofproto,
2154 u16_to_ofp(ofproto->alloc_port_no));
2155 port_idx = ofproto->alloc_port_no;
2157 } else if (last_used_at < lru) {
2159 lru_ofport = ofproto->alloc_port_no;
2162 if (ofproto->alloc_port_no == end_port_no) {
2164 port_idx = lru_ofport;
2171 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2172 return u16_to_ofp(port_idx);
2176 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2178 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2179 ofport_set_usage(ofproto, ofp_port, time_msec());
2183 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2184 * pointer if the netdev cannot be opened. On success, also fills in
2186 static struct netdev *
2187 ofport_open(struct ofproto *ofproto,
2188 struct ofproto_port *ofproto_port,
2189 struct ofputil_phy_port *pp)
2191 enum netdev_flags flags;
2192 struct netdev *netdev;
2195 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2197 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2198 "cannot be opened (%s)",
2200 ofproto_port->name, ofproto_port->ofp_port,
2201 ofproto_port->name, ovs_strerror(error));
2205 if (ofproto_port->ofp_port == OFPP_NONE) {
2206 if (!strcmp(ofproto->name, ofproto_port->name)) {
2207 ofproto_port->ofp_port = OFPP_LOCAL;
2209 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2210 ofproto_port->name);
2213 pp->port_no = ofproto_port->ofp_port;
2214 netdev_get_etheraddr(netdev, pp->hw_addr);
2215 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2216 netdev_get_flags(netdev, &flags);
2217 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2218 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2219 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2220 &pp->supported, &pp->peer);
2221 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2222 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2227 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2228 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2231 ofport_equal(const struct ofputil_phy_port *a,
2232 const struct ofputil_phy_port *b)
2234 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2235 && a->state == b->state
2236 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2237 && a->curr == b->curr
2238 && a->advertised == b->advertised
2239 && a->supported == b->supported
2240 && a->peer == b->peer
2241 && a->curr_speed == b->curr_speed
2242 && a->max_speed == b->max_speed);
2245 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2246 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2247 * one with the same name or port number). */
2249 ofport_install(struct ofproto *p,
2250 struct netdev *netdev, const struct ofputil_phy_port *pp)
2252 const char *netdev_name = netdev_get_name(netdev);
2253 struct ofport *ofport;
2256 /* Create ofport. */
2257 ofport = p->ofproto_class->port_alloc();
2262 ofport->ofproto = p;
2263 ofport->netdev = netdev;
2264 ofport->change_seq = netdev_get_change_seq(netdev);
2266 ofport->ofp_port = pp->port_no;
2267 ofport->created = time_msec();
2269 /* Add port to 'p'. */
2270 hmap_insert(&p->ports, &ofport->hmap_node,
2271 hash_ofp_port(ofport->ofp_port));
2272 shash_add(&p->port_by_name, netdev_name, ofport);
2274 update_mtu(p, ofport);
2276 /* Let the ofproto_class initialize its private data. */
2277 error = p->ofproto_class->port_construct(ofport);
2281 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2285 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2286 p->name, netdev_name, ovs_strerror(error));
2288 ofport_destroy__(ofport);
2290 netdev_close(netdev);
2294 /* Removes 'ofport' from 'p' and destroys it. */
2296 ofport_remove(struct ofport *ofport)
2298 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2300 ofport_destroy(ofport);
2303 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2306 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2308 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2310 ofport_remove(port);
2314 /* Updates 'port' with new 'pp' description.
2316 * Does not handle a name or port number change. The caller must implement
2317 * such a change as a delete followed by an add. */
2319 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2321 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2322 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2323 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2324 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2325 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2326 port->pp.curr = pp->curr;
2327 port->pp.advertised = pp->advertised;
2328 port->pp.supported = pp->supported;
2329 port->pp.peer = pp->peer;
2330 port->pp.curr_speed = pp->curr_speed;
2331 port->pp.max_speed = pp->max_speed;
2333 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2334 &port->pp, OFPPR_MODIFY);
2337 /* Update OpenFlow 'state' in 'port' and notify controller. */
2339 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2341 if (port->pp.state != state) {
2342 port->pp.state = state;
2343 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2344 &port->pp, OFPPR_MODIFY);
2349 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2351 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2353 if (port->ofproto->ofproto_class->set_realdev) {
2354 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2356 if (port->ofproto->ofproto_class->set_stp_port) {
2357 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2359 if (port->ofproto->ofproto_class->set_cfm) {
2360 port->ofproto->ofproto_class->set_cfm(port, NULL);
2362 if (port->ofproto->ofproto_class->bundle_remove) {
2363 port->ofproto->ofproto_class->bundle_remove(port);
2369 ofport_destroy__(struct ofport *port)
2371 struct ofproto *ofproto = port->ofproto;
2372 const char *name = netdev_get_name(port->netdev);
2374 hmap_remove(&ofproto->ports, &port->hmap_node);
2375 shash_delete(&ofproto->port_by_name,
2376 shash_find(&ofproto->port_by_name, name));
2378 netdev_close(port->netdev);
2379 ofproto->ofproto_class->port_dealloc(port);
2383 ofport_destroy(struct ofport *port)
2386 dealloc_ofp_port(port->ofproto, port->ofp_port);
2387 port->ofproto->ofproto_class->port_destruct(port);
2388 ofport_destroy__(port);
2393 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2395 struct ofport *port;
2397 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2399 if (port->ofp_port == ofp_port) {
2406 static long long int
2407 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2409 struct ofport_usage *usage;
2411 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2412 &ofproto->ofport_usage) {
2413 if (usage->ofp_port == ofp_port) {
2414 return usage->last_used;
2421 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2422 long long int last_used)
2424 struct ofport_usage *usage;
2425 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2426 &ofproto->ofport_usage) {
2427 if (usage->ofp_port == ofp_port) {
2428 usage->last_used = last_used;
2432 ovs_assert(last_used == LLONG_MAX);
2434 usage = xmalloc(sizeof *usage);
2435 usage->ofp_port = ofp_port;
2436 usage->last_used = last_used;
2437 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2438 hash_ofp_port(ofp_port));
2442 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2444 struct ofport_usage *usage;
2445 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2446 &ofproto->ofport_usage) {
2447 if (usage->ofp_port == ofp_port) {
2448 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2456 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2458 struct ofproto *ofproto = port->ofproto;
2461 if (ofproto->ofproto_class->port_get_stats) {
2462 error = ofproto->ofproto_class->port_get_stats(port, stats);
2471 update_port(struct ofproto *ofproto, const char *name)
2473 struct ofproto_port ofproto_port;
2474 struct ofputil_phy_port pp;
2475 struct netdev *netdev;
2476 struct ofport *port;
2478 COVERAGE_INC(ofproto_update_port);
2480 /* Fetch 'name''s location and properties from the datapath. */
2481 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2482 ? ofport_open(ofproto, &ofproto_port, &pp)
2486 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2487 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2488 struct netdev *old_netdev = port->netdev;
2490 /* 'name' hasn't changed location. Any properties changed? */
2491 if (!ofport_equal(&port->pp, &pp)) {
2492 ofport_modified(port, &pp);
2495 update_mtu(ofproto, port);
2497 /* Install the newly opened netdev in case it has changed.
2498 * Don't close the old netdev yet in case port_modified has to
2499 * remove a retained reference to it.*/
2500 port->netdev = netdev;
2501 port->change_seq = netdev_get_change_seq(netdev);
2503 if (port->ofproto->ofproto_class->port_modified) {
2504 port->ofproto->ofproto_class->port_modified(port);
2507 netdev_close(old_netdev);
2509 /* If 'port' is nonnull then its name differs from 'name' and thus
2510 * we should delete it. If we think there's a port named 'name'
2511 * then its port number must be wrong now so delete it too. */
2513 ofport_remove(port);
2515 ofport_remove_with_name(ofproto, name);
2516 ofport_install(ofproto, netdev, &pp);
2519 /* Any port named 'name' is gone now. */
2520 ofport_remove_with_name(ofproto, name);
2522 ofproto_port_destroy(&ofproto_port);
2526 init_ports(struct ofproto *p)
2528 struct ofproto_port_dump dump;
2529 struct ofproto_port ofproto_port;
2530 struct shash_node *node, *next;
2532 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2533 const char *name = ofproto_port.name;
2535 if (shash_find(&p->port_by_name, name)) {
2536 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2539 struct ofputil_phy_port pp;
2540 struct netdev *netdev;
2542 /* Check if an OpenFlow port number had been requested. */
2543 node = shash_find(&init_ofp_ports, name);
2545 const struct iface_hint *iface_hint = node->data;
2546 simap_put(&p->ofp_requests, name,
2547 ofp_to_u16(iface_hint->ofp_port));
2550 netdev = ofport_open(p, &ofproto_port, &pp);
2552 ofport_install(p, netdev, &pp);
2553 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2554 p->alloc_port_no = MAX(p->alloc_port_no,
2555 ofp_to_u16(ofproto_port.ofp_port));
2561 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2562 struct iface_hint *iface_hint = node->data;
2564 if (!strcmp(iface_hint->br_name, p->name)) {
2565 free(iface_hint->br_name);
2566 free(iface_hint->br_type);
2568 shash_delete(&init_ofp_ports, node);
2575 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2576 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2578 find_min_mtu(struct ofproto *p)
2580 struct ofport *ofport;
2583 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2584 struct netdev *netdev = ofport->netdev;
2587 /* Skip any internal ports, since that's what we're trying to
2589 if (!strcmp(netdev_get_type(netdev), "internal")) {
2593 if (netdev_get_mtu(netdev, &dev_mtu)) {
2596 if (!mtu || dev_mtu < mtu) {
2601 return mtu ? mtu: ETH_PAYLOAD_MAX;
2604 /* Update MTU of all datapath devices on 'p' to the minimum of the
2605 * non-datapath ports in event of 'port' added or changed. */
2607 update_mtu(struct ofproto *p, struct ofport *port)
2609 struct ofport *ofport;
2610 struct netdev *netdev = port->netdev;
2611 int dev_mtu, old_min;
2613 if (netdev_get_mtu(netdev, &dev_mtu)) {
2617 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2618 if (dev_mtu > p->min_mtu) {
2619 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2620 dev_mtu = p->min_mtu;
2623 port->mtu = dev_mtu;
2627 /* For non-internal port find new min mtu. */
2628 old_min = p->min_mtu;
2629 port->mtu = dev_mtu;
2630 p->min_mtu = find_min_mtu(p);
2631 if (p->min_mtu == old_min) {
2635 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2636 struct netdev *netdev = ofport->netdev;
2638 if (!strcmp(netdev_get_type(netdev), "internal")) {
2639 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2640 ofport->mtu = p->min_mtu;
2647 ofproto_rule_destroy__(struct rule *rule)
2648 OVS_NO_THREAD_SAFETY_ANALYSIS
2650 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2651 rule_actions_destroy(rule_get_actions(rule));
2652 ovs_mutex_destroy(&rule->mutex);
2653 rule->ofproto->ofproto_class->rule_dealloc(rule);
2657 rule_destroy_cb(struct rule *rule)
2659 rule->ofproto->ofproto_class->rule_destruct(rule);
2660 ofproto_rule_destroy__(rule);
2664 ofproto_rule_ref(struct rule *rule)
2667 ovs_refcount_ref(&rule->ref_count);
2671 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2672 * ref_count reaches 0.
2674 * Use of RCU allows short term use (between RCU quiescent periods) without
2675 * keeping a reference. A reference must be taken if the rule needs to
2676 * stay around accross the RCU quiescent periods. */
2678 ofproto_rule_unref(struct rule *rule)
2680 if (rule && ovs_refcount_unref(&rule->ref_count) == 1) {
2681 ovsrcu_postpone(rule_destroy_cb, rule);
2685 static uint32_t get_provider_meter_id(const struct ofproto *,
2686 uint32_t of_meter_id);
2688 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2689 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2690 const struct rule_actions *
2691 rule_actions_create(const struct ofproto *ofproto,
2692 const struct ofpact *ofpacts, size_t ofpacts_len)
2694 struct rule_actions *actions;
2696 actions = xmalloc(sizeof *actions + ofpacts_len);
2697 actions->ofpacts_len = ofpacts_len;
2698 actions->provider_meter_id
2699 = get_provider_meter_id(ofproto,
2700 ofpacts_get_meter(ofpacts, ofpacts_len));
2701 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2706 /* Free the actions after the RCU quiescent period is reached. */
2708 rule_actions_destroy(const struct rule_actions *actions)
2711 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2715 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2716 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2718 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2719 OVS_REQUIRES(ofproto_mutex)
2721 if (port == OFPP_ANY) {
2724 const struct rule_actions *actions = rule_get_actions(rule);
2725 return ofpacts_output_to_port(actions->ofpacts,
2726 actions->ofpacts_len, port);
2730 /* Returns true if 'rule' has group and equals group_id. */
2732 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2733 OVS_REQUIRES(ofproto_mutex)
2735 if (group_id == OFPG_ANY) {
2738 const struct rule_actions *actions = rule_get_actions(rule);
2739 return ofpacts_output_to_group(actions->ofpacts,
2740 actions->ofpacts_len, group_id);
2744 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2745 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2747 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2748 OVS_REQUIRES(ofproto_mutex)
2750 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2755 case OFOPERATION_ADD:
2756 case OFOPERATION_DELETE:
2759 case OFOPERATION_MODIFY:
2760 case OFOPERATION_REPLACE:
2761 return ofpacts_output_to_port(op->actions->ofpacts,
2762 op->actions->ofpacts_len, out_port);
2769 rule_execute_destroy(struct rule_execute *e)
2771 ofproto_rule_unref(e->rule);
2772 list_remove(&e->list_node);
2776 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2777 * by passing them to the ofproto provider. */
2779 run_rule_executes(struct ofproto *ofproto)
2780 OVS_EXCLUDED(ofproto_mutex)
2782 struct rule_execute *e, *next;
2783 struct list executes;
2785 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2786 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2789 flow_extract(e->packet, NULL, &flow);
2790 flow.in_port.ofp_port = e->in_port;
2791 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2793 rule_execute_destroy(e);
2797 /* Destroys and discards all "rule_execute" operations queued up in
2798 * ofproto->rule_executes. */
2800 destroy_rule_executes(struct ofproto *ofproto)
2802 struct rule_execute *e, *next;
2803 struct list executes;
2805 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2806 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2807 ofpbuf_delete(e->packet);
2808 rule_execute_destroy(e);
2812 /* Returns true if 'rule' should be hidden from the controller.
2814 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2815 * (e.g. by in-band control) and are intentionally hidden from the
2818 ofproto_rule_is_hidden(const struct rule *rule)
2820 return (rule->cr.priority > UINT16_MAX);
2824 oftable_is_modifiable(const struct oftable *table,
2825 enum ofputil_flow_mod_flags flags)
2827 if (flags & OFPUTIL_FF_NO_READONLY) {
2831 return !(table->flags & OFTABLE_READONLY);
2835 rule_is_modifiable(const struct rule *rule, enum ofputil_flow_mod_flags flags)
2837 const struct oftable *rule_table;
2839 rule_table = &rule->ofproto->tables[rule->table_id];
2840 return oftable_is_modifiable(rule_table, flags);
2844 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2846 ofconn_send_reply(ofconn, make_echo_reply(oh));
2851 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2853 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2854 struct ofputil_switch_features features;
2855 struct ofport *port;
2859 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2861 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2863 features.datapath_id = ofproto->datapath_id;
2864 features.n_buffers = pktbuf_capacity();
2865 features.n_tables = ofproto_get_n_visible_tables(ofproto);
2866 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2867 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2869 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2871 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2872 features.auxiliary_id = 0;
2873 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2875 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2876 ofputil_put_switch_features_port(&port->pp, b);
2879 ofconn_send_reply(ofconn, b);
2884 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2886 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2887 struct ofp_switch_config *osc;
2888 enum ofp_config_flags flags;
2892 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2893 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2894 flags = ofproto->frag_handling;
2895 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2896 if (oh->version < OFP13_VERSION
2897 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2898 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2900 osc->flags = htons(flags);
2901 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2902 ofconn_send_reply(ofconn, buf);
2908 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2910 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2911 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2912 uint16_t flags = ntohs(osc->flags);
2914 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2915 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2916 enum ofp_config_flags cur = ofproto->frag_handling;
2917 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2919 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2921 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2922 ofproto->frag_handling = next;
2924 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2926 ofputil_frag_handling_to_string(next));
2930 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2931 ofconn_set_invalid_ttl_to_controller(ofconn,
2932 (oh->version < OFP13_VERSION
2933 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2935 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2940 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2941 * error message code for the caller to propagate upward. Otherwise, returns
2944 * The log message mentions 'msg_type'. */
2946 reject_slave_controller(struct ofconn *ofconn)
2948 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2949 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2950 return OFPERR_OFPBRC_EPERM;
2956 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2959 * - If they use a meter, then 'ofproto' has that meter configured.
2961 * - If they use any groups, then 'ofproto' has that group configured.
2963 * Returns 0 if successful, otherwise an OpenFlow error. */
2965 ofproto_check_ofpacts(struct ofproto *ofproto,
2966 const struct ofpact ofpacts[], size_t ofpacts_len)
2968 const struct ofpact *a;
2971 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2972 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2973 return OFPERR_OFPMMFC_INVALID_METER;
2976 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2977 if (a->type == OFPACT_GROUP
2978 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2979 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2987 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2989 struct ofproto *p = ofconn_get_ofproto(ofconn);
2990 struct ofputil_packet_out po;
2991 struct ofpbuf *payload;
2992 uint64_t ofpacts_stub[1024 / 8];
2993 struct ofpbuf ofpacts;
2997 COVERAGE_INC(ofproto_packet_out);
2999 error = reject_slave_controller(ofconn);
3004 /* Decode message. */
3005 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3006 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
3008 goto exit_free_ofpacts;
3010 if (ofp_to_u16(po.in_port) >= p->max_ports
3011 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
3012 error = OFPERR_OFPBRC_BAD_PORT;
3013 goto exit_free_ofpacts;
3017 if (po.buffer_id != UINT32_MAX) {
3018 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3019 if (error || !payload) {
3020 goto exit_free_ofpacts;
3023 /* Ensure that the L3 header is 32-bit aligned. */
3024 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
3027 /* Verify actions against packet, then send packet if successful. */
3028 flow_extract(payload, NULL, &flow);
3029 flow.in_port.ofp_port = po.in_port;
3030 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3032 error = p->ofproto_class->packet_out(p, payload, &flow,
3033 po.ofpacts, po.ofpacts_len);
3035 ofpbuf_delete(payload);
3038 ofpbuf_uninit(&ofpacts);
3044 update_port_config(struct ofconn *ofconn, struct ofport *port,
3045 enum ofputil_port_config config,
3046 enum ofputil_port_config mask)
3048 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3050 if (toggle & OFPUTIL_PC_PORT_DOWN
3051 && (config & OFPUTIL_PC_PORT_DOWN
3052 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3053 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3054 /* We tried to bring the port up or down, but it failed, so don't
3055 * update the "down" bit. */
3056 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3060 enum ofputil_port_config old_config = port->pp.config;
3061 port->pp.config ^= toggle;
3062 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3063 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3069 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3071 struct ofproto *p = ofconn_get_ofproto(ofconn);
3072 struct ofputil_port_mod pm;
3073 struct ofport *port;
3076 error = reject_slave_controller(ofconn);
3081 error = ofputil_decode_port_mod(oh, &pm);
3086 port = ofproto_get_port(p, pm.port_no);
3088 return OFPERR_OFPPMFC_BAD_PORT;
3089 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3090 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3092 update_port_config(ofconn, port, pm.config, pm.mask);
3094 netdev_set_advertisements(port->netdev, pm.advertise);
3101 handle_desc_stats_request(struct ofconn *ofconn,
3102 const struct ofp_header *request)
3104 static const char *default_mfr_desc = "Nicira, Inc.";
3105 static const char *default_hw_desc = "Open vSwitch";
3106 static const char *default_sw_desc = VERSION;
3107 static const char *default_serial_desc = "None";
3108 static const char *default_dp_desc = "None";
3110 struct ofproto *p = ofconn_get_ofproto(ofconn);
3111 struct ofp_desc_stats *ods;
3114 msg = ofpraw_alloc_stats_reply(request, 0);
3115 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3116 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3117 sizeof ods->mfr_desc);
3118 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3119 sizeof ods->hw_desc);
3120 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3121 sizeof ods->sw_desc);
3122 ovs_strlcpy(ods->serial_num,
3123 p->serial_desc ? p->serial_desc : default_serial_desc,
3124 sizeof ods->serial_num);
3125 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3126 sizeof ods->dp_desc);
3127 ofconn_send_reply(ofconn, msg);
3133 handle_table_stats_request(struct ofconn *ofconn,
3134 const struct ofp_header *request)
3136 struct ofproto *p = ofconn_get_ofproto(ofconn);
3137 struct ofp12_table_stats *ots;
3142 /* Set up default values.
3144 * ofp12_table_stats is used as a generic structure as
3145 * it is able to hold all the fields for ofp10_table_stats
3146 * and ofp11_table_stats (and of course itself).
3148 ots = xcalloc(p->n_tables, sizeof *ots);
3149 for (i = 0; i < p->n_tables; i++) {
3150 ots[i].table_id = i;
3151 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3152 ots[i].match = htonll(OFPXMT13_MASK);
3153 ots[i].wildcards = htonll(OFPXMT13_MASK);
3154 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3155 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3156 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3157 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3158 ots[i].metadata_match = OVS_BE64_MAX;
3159 ots[i].metadata_write = OVS_BE64_MAX;
3160 ots[i].instructions = htonl(OFPIT11_ALL);
3161 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3162 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3163 fat_rwlock_rdlock(&p->tables[i].cls.rwlock);
3164 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3165 fat_rwlock_unlock(&p->tables[i].cls.rwlock);
3168 p->ofproto_class->get_tables(p, ots);
3170 /* Post-process the tables, dropping hidden tables. */
3171 n_tables = p->n_tables;
3172 for (i = 0; i < p->n_tables; i++) {
3173 const struct oftable *table = &p->tables[i];
3175 if (table->flags & OFTABLE_HIDDEN) {
3181 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3184 if (table->max_flows < ntohl(ots[i].max_entries)) {
3185 ots[i].max_entries = htonl(table->max_flows);
3189 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3190 ofconn_send_reply(ofconn, msg);
3198 append_port_stat(struct ofport *port, struct list *replies)
3200 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3202 calc_duration(port->created, time_msec(),
3203 &ops.duration_sec, &ops.duration_nsec);
3205 /* Intentionally ignore return value, since errors will set
3206 * 'stats' to all-1s, which is correct for OpenFlow, and
3207 * netdev_get_stats() will log errors. */
3208 ofproto_port_get_stats(port, &ops.stats);
3210 ofputil_append_port_stat(replies, &ops);
3214 handle_port_stats_request(struct ofconn *ofconn,
3215 const struct ofp_header *request)
3217 struct ofproto *p = ofconn_get_ofproto(ofconn);
3218 struct ofport *port;
3219 struct list replies;
3223 error = ofputil_decode_port_stats_request(request, &port_no);
3228 ofpmp_init(&replies, request);
3229 if (port_no != OFPP_ANY) {
3230 port = ofproto_get_port(p, port_no);
3232 append_port_stat(port, &replies);
3235 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3236 append_port_stat(port, &replies);
3240 ofconn_send_replies(ofconn, &replies);
3245 handle_port_desc_stats_request(struct ofconn *ofconn,
3246 const struct ofp_header *request)
3248 struct ofproto *p = ofconn_get_ofproto(ofconn);
3249 enum ofp_version version;
3250 struct ofport *port;
3251 struct list replies;
3253 ofpmp_init(&replies, request);
3255 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
3256 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3257 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
3260 ofconn_send_replies(ofconn, &replies);
3265 hash_cookie(ovs_be64 cookie)
3267 return hash_uint64((OVS_FORCE uint64_t)cookie);
3271 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3272 OVS_REQUIRES(ofproto_mutex)
3274 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3275 hash_cookie(rule->flow_cookie));
3279 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3280 OVS_REQUIRES(ofproto_mutex)
3282 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3286 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3287 ovs_be64 new_cookie)
3288 OVS_REQUIRES(ofproto_mutex)
3290 if (new_cookie != rule->flow_cookie) {
3291 cookies_remove(ofproto, rule);
3293 ovs_mutex_lock(&rule->mutex);
3294 rule->flow_cookie = new_cookie;
3295 ovs_mutex_unlock(&rule->mutex);
3297 cookies_insert(ofproto, rule);
3302 calc_duration(long long int start, long long int now,
3303 uint32_t *sec, uint32_t *nsec)
3305 long long int msecs = now - start;
3306 *sec = msecs / 1000;
3307 *nsec = (msecs % 1000) * (1000 * 1000);
3310 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3311 * true if 'table_id' is OK, false otherwise. */
3313 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3315 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3318 static struct oftable *
3319 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3321 struct oftable *table;
3323 for (table = &ofproto->tables[table_id];
3324 table < &ofproto->tables[ofproto->n_tables];
3326 if (!(table->flags & OFTABLE_HIDDEN)) {
3334 static struct oftable *
3335 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3337 if (table_id == 0xff) {
3338 return next_visible_table(ofproto, 0);
3339 } else if (table_id < ofproto->n_tables) {
3340 return &ofproto->tables[table_id];
3346 static struct oftable *
3347 next_matching_table(const struct ofproto *ofproto,
3348 const struct oftable *table, uint8_t table_id)
3350 return (table_id == 0xff
3351 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3355 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3357 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3358 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3360 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3361 * only once, for that table. (This can be used to access tables marked
3364 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3365 * entered at all. (Perhaps you should have validated TABLE_ID with
3366 * check_table_id().)
3368 * All parameters are evaluated multiple times.
3370 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3371 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3373 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3375 /* Initializes 'criteria' in a straightforward way based on the other
3378 * For "loose" matching, the 'priority' parameter is unimportant and may be
3381 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3382 const struct match *match, unsigned int priority,
3383 ovs_be64 cookie, ovs_be64 cookie_mask,
3384 ofp_port_t out_port, uint32_t out_group)
3386 criteria->table_id = table_id;
3387 cls_rule_init(&criteria->cr, match, priority);
3388 criteria->cookie = cookie;
3389 criteria->cookie_mask = cookie_mask;
3390 criteria->out_port = out_port;
3391 criteria->out_group = out_group;
3395 rule_criteria_destroy(struct rule_criteria *criteria)
3397 cls_rule_destroy(&criteria->cr);
3401 rule_collection_init(struct rule_collection *rules)
3403 rules->rules = rules->stub;
3405 rules->capacity = ARRAY_SIZE(rules->stub);
3409 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3411 if (rules->n >= rules->capacity) {
3412 size_t old_size, new_size;
3414 old_size = rules->capacity * sizeof *rules->rules;
3415 rules->capacity *= 2;
3416 new_size = rules->capacity * sizeof *rules->rules;
3418 if (rules->rules == rules->stub) {
3419 rules->rules = xmalloc(new_size);
3420 memcpy(rules->rules, rules->stub, old_size);
3422 rules->rules = xrealloc(rules->rules, new_size);
3426 rules->rules[rules->n++] = rule;
3430 rule_collection_ref(struct rule_collection *rules)
3431 OVS_REQUIRES(ofproto_mutex)
3435 for (i = 0; i < rules->n; i++) {
3436 ofproto_rule_ref(rules->rules[i]);
3441 rule_collection_unref(struct rule_collection *rules)
3445 for (i = 0; i < rules->n; i++) {
3446 ofproto_rule_unref(rules->rules[i]);
3451 rule_collection_destroy(struct rule_collection *rules)
3453 if (rules->rules != rules->stub) {
3459 collect_rule(struct rule *rule, const struct rule_criteria *c,
3460 struct rule_collection *rules)
3461 OVS_REQUIRES(ofproto_mutex)
3463 /* We ordinarily want to skip hidden rules, but there has to be a way for
3464 * code internal to OVS to modify and delete them, so if the criteria
3465 * specify a priority that can only be for a hidden flow, then allow hidden
3466 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3467 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3469 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3471 } else if (rule->pending) {
3472 return OFPROTO_POSTPONE;
3474 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3475 && ofproto_rule_has_out_port(rule, c->out_port)
3476 && ofproto_rule_has_out_group(rule, c->out_group)
3477 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3478 rule_collection_add(rules, rule);
3484 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3485 * on classifiers rules are done in the "loose" way required for OpenFlow
3486 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3489 * Hidden rules are always omitted.
3491 * Returns 0 on success, otherwise an OpenFlow error code. */
3493 collect_rules_loose(struct ofproto *ofproto,
3494 const struct rule_criteria *criteria,
3495 struct rule_collection *rules)
3496 OVS_REQUIRES(ofproto_mutex)
3498 struct oftable *table;
3499 enum ofperr error = 0;
3501 rule_collection_init(rules);
3503 if (!check_table_id(ofproto, criteria->table_id)) {
3504 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3508 if (criteria->cookie_mask == OVS_BE64_MAX) {
3511 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3512 hash_cookie(criteria->cookie),
3513 &ofproto->cookies) {
3514 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3515 error = collect_rule(rule, criteria, rules);
3522 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3523 struct cls_cursor cursor;
3526 fat_rwlock_rdlock(&table->cls.rwlock);
3527 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3528 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3529 error = collect_rule(rule, criteria, rules);
3534 fat_rwlock_unlock(&table->cls.rwlock);
3540 rule_collection_destroy(rules);
3545 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3546 * on classifiers rules are done in the "strict" way required for OpenFlow
3547 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3548 * rules on list 'rules'.
3550 * Hidden rules are always omitted.
3552 * Returns 0 on success, otherwise an OpenFlow error code. */
3554 collect_rules_strict(struct ofproto *ofproto,
3555 const struct rule_criteria *criteria,
3556 struct rule_collection *rules)
3557 OVS_REQUIRES(ofproto_mutex)
3559 struct oftable *table;
3562 rule_collection_init(rules);
3564 if (!check_table_id(ofproto, criteria->table_id)) {
3565 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3569 if (criteria->cookie_mask == OVS_BE64_MAX) {
3572 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3573 hash_cookie(criteria->cookie),
3574 &ofproto->cookies) {
3575 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3576 error = collect_rule(rule, criteria, rules);
3583 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3586 fat_rwlock_rdlock(&table->cls.rwlock);
3587 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3588 &table->cls, &criteria->cr));
3589 fat_rwlock_unlock(&table->cls.rwlock);
3591 error = collect_rule(rule, criteria, rules);
3601 rule_collection_destroy(rules);
3606 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3607 * forced into the range of a uint16_t. */
3609 age_secs(long long int age_ms)
3611 return (age_ms < 0 ? 0
3612 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3613 : (unsigned int) age_ms / 1000);
3617 handle_flow_stats_request(struct ofconn *ofconn,
3618 const struct ofp_header *request)
3619 OVS_EXCLUDED(ofproto_mutex)
3621 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3622 struct ofputil_flow_stats_request fsr;
3623 struct rule_criteria criteria;
3624 struct rule_collection rules;
3625 struct list replies;
3629 error = ofputil_decode_flow_stats_request(&fsr, request);
3634 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3635 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3637 ovs_mutex_lock(&ofproto_mutex);
3638 error = collect_rules_loose(ofproto, &criteria, &rules);
3639 rule_criteria_destroy(&criteria);
3641 rule_collection_ref(&rules);
3643 ovs_mutex_unlock(&ofproto_mutex);
3649 ofpmp_init(&replies, request);
3650 for (i = 0; i < rules.n; i++) {
3651 struct rule *rule = rules.rules[i];
3652 long long int now = time_msec();
3653 struct ofputil_flow_stats fs;
3654 long long int created, used, modified;
3655 const struct rule_actions *actions;
3656 enum ofputil_flow_mod_flags flags;
3658 ovs_mutex_lock(&rule->mutex);
3659 fs.cookie = rule->flow_cookie;
3660 fs.idle_timeout = rule->idle_timeout;
3661 fs.hard_timeout = rule->hard_timeout;
3662 created = rule->created;
3663 modified = rule->modified;
3664 actions = rule_get_actions(rule);
3665 flags = rule->flags;
3666 ovs_mutex_unlock(&rule->mutex);
3668 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3669 &fs.byte_count, &used);
3671 minimatch_expand(&rule->cr.match, &fs.match);
3672 fs.table_id = rule->table_id;
3673 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3674 fs.priority = rule->cr.priority;
3675 fs.idle_age = age_secs(now - used);
3676 fs.hard_age = age_secs(now - modified);
3677 fs.ofpacts = actions->ofpacts;
3678 fs.ofpacts_len = actions->ofpacts_len;
3681 ofputil_append_flow_stats_reply(&fs, &replies);
3684 rule_collection_unref(&rules);
3685 rule_collection_destroy(&rules);
3687 ofconn_send_replies(ofconn, &replies);
3693 flow_stats_ds(struct rule *rule, struct ds *results)
3695 uint64_t packet_count, byte_count;
3696 const struct rule_actions *actions;
3697 long long int created, used;
3699 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3700 &byte_count, &used);
3702 ovs_mutex_lock(&rule->mutex);
3703 actions = rule_get_actions(rule);
3704 created = rule->created;
3705 ovs_mutex_unlock(&rule->mutex);
3707 if (rule->table_id != 0) {
3708 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3710 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3711 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3712 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3713 cls_rule_format(&rule->cr, results);
3714 ds_put_char(results, ',');
3716 ds_put_cstr(results, "actions=");
3717 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3719 ds_put_cstr(results, "\n");
3722 /* Adds a pretty-printed description of all flows to 'results', including
3723 * hidden flows (e.g., set up by in-band control). */
3725 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3727 struct oftable *table;
3729 OFPROTO_FOR_EACH_TABLE (table, p) {
3730 struct cls_cursor cursor;
3733 fat_rwlock_rdlock(&table->cls.rwlock);
3734 cls_cursor_init(&cursor, &table->cls, NULL);
3735 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3736 flow_stats_ds(rule, results);
3738 fat_rwlock_unlock(&table->cls.rwlock);
3742 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3743 * '*engine_type' and '*engine_id', respectively. */
3745 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3746 uint8_t *engine_type, uint8_t *engine_id)
3748 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3751 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3752 * Returns 0 if the port's CFM status was successfully stored into
3753 * '*status'. Returns positive errno if the port did not have CFM
3754 * configured. Returns negative number if there is no status change
3755 * since last update.
3757 * The caller must provide and own '*status', and must free 'status->rmps'.
3758 * '*status' is indeterminate if the return value is non-zero. */
3760 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3761 struct ofproto_cfm_status *status)
3763 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3764 return (ofport && ofproto->ofproto_class->get_cfm_status
3765 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
3770 handle_aggregate_stats_request(struct ofconn *ofconn,
3771 const struct ofp_header *oh)
3772 OVS_EXCLUDED(ofproto_mutex)
3774 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3775 struct ofputil_flow_stats_request request;
3776 struct ofputil_aggregate_stats stats;
3777 bool unknown_packets, unknown_bytes;
3778 struct rule_criteria criteria;
3779 struct rule_collection rules;
3780 struct ofpbuf *reply;
3784 error = ofputil_decode_flow_stats_request(&request, oh);
3789 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3790 request.cookie, request.cookie_mask,
3791 request.out_port, request.out_group);
3793 ovs_mutex_lock(&ofproto_mutex);
3794 error = collect_rules_loose(ofproto, &criteria, &rules);
3795 rule_criteria_destroy(&criteria);
3797 rule_collection_ref(&rules);
3799 ovs_mutex_unlock(&ofproto_mutex);
3805 memset(&stats, 0, sizeof stats);
3806 unknown_packets = unknown_bytes = false;
3807 for (i = 0; i < rules.n; i++) {
3808 struct rule *rule = rules.rules[i];
3809 uint64_t packet_count;
3810 uint64_t byte_count;
3813 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3814 &byte_count, &used);
3816 if (packet_count == UINT64_MAX) {
3817 unknown_packets = true;
3819 stats.packet_count += packet_count;
3822 if (byte_count == UINT64_MAX) {
3823 unknown_bytes = true;
3825 stats.byte_count += byte_count;
3830 if (unknown_packets) {
3831 stats.packet_count = UINT64_MAX;
3833 if (unknown_bytes) {
3834 stats.byte_count = UINT64_MAX;
3837 rule_collection_unref(&rules);
3838 rule_collection_destroy(&rules);
3840 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3841 ofconn_send_reply(ofconn, reply);
3846 struct queue_stats_cbdata {
3847 struct ofport *ofport;
3848 struct list replies;
3853 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3854 const struct netdev_queue_stats *stats)
3856 struct ofputil_queue_stats oqs;
3858 oqs.port_no = cbdata->ofport->pp.port_no;
3859 oqs.queue_id = queue_id;
3860 oqs.tx_bytes = stats->tx_bytes;
3861 oqs.tx_packets = stats->tx_packets;
3862 oqs.tx_errors = stats->tx_errors;
3863 if (stats->created != LLONG_MIN) {
3864 calc_duration(stats->created, cbdata->now,
3865 &oqs.duration_sec, &oqs.duration_nsec);
3867 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3869 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3873 handle_queue_stats_dump_cb(uint32_t queue_id,
3874 struct netdev_queue_stats *stats,
3877 struct queue_stats_cbdata *cbdata = cbdata_;
3879 put_queue_stats(cbdata, queue_id, stats);
3883 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3884 struct queue_stats_cbdata *cbdata)
3886 cbdata->ofport = port;
3887 if (queue_id == OFPQ_ALL) {
3888 netdev_dump_queue_stats(port->netdev,
3889 handle_queue_stats_dump_cb, cbdata);
3891 struct netdev_queue_stats stats;
3893 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3894 put_queue_stats(cbdata, queue_id, &stats);
3896 return OFPERR_OFPQOFC_BAD_QUEUE;
3903 handle_queue_stats_request(struct ofconn *ofconn,
3904 const struct ofp_header *rq)
3906 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3907 struct queue_stats_cbdata cbdata;
3908 struct ofport *port;
3910 struct ofputil_queue_stats_request oqsr;
3912 COVERAGE_INC(ofproto_queue_req);
3914 ofpmp_init(&cbdata.replies, rq);
3915 cbdata.now = time_msec();
3917 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3922 if (oqsr.port_no == OFPP_ANY) {
3923 error = OFPERR_OFPQOFC_BAD_QUEUE;
3924 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3925 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3930 port = ofproto_get_port(ofproto, oqsr.port_no);
3932 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3933 : OFPERR_OFPQOFC_BAD_PORT);
3936 ofconn_send_replies(ofconn, &cbdata.replies);
3938 ofpbuf_list_delete(&cbdata.replies);
3945 is_flow_deletion_pending(const struct ofproto *ofproto,
3946 const struct cls_rule *cls_rule,
3948 OVS_REQUIRES(ofproto_mutex)
3950 if (!hmap_is_empty(&ofproto->deletions)) {
3951 struct ofoperation *op;
3953 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3954 cls_rule_hash(cls_rule, table_id),
3955 &ofproto->deletions) {
3956 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3966 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3967 OVS_REQUIRES(ofproto_mutex)
3968 OVS_NO_THREAD_SAFETY_ANALYSIS
3970 return classifier_count(&table->cls) + extra_space > table->max_flows;
3974 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3975 unsigned int extra_space)
3976 OVS_REQUIRES(ofproto_mutex)
3978 while (should_evict_a_rule(table, extra_space)) {
3981 if (!choose_rule_to_evict(table, &rule)) {
3982 return OFPERR_OFPFMFC_TABLE_FULL;
3983 } else if (rule->pending) {
3984 return OFPROTO_POSTPONE;
3986 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3987 delete_flow__(rule, group, OFPRR_EVICTION);
3988 ofopgroup_submit(group);
3995 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3996 * in which no matching flow already exists in the flow table.
3998 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3999 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4000 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4001 * initiated now but may be retried later.
4003 * The caller retains ownership of 'fm->ofpacts'.
4005 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4008 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
4009 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4010 OVS_REQUIRES(ofproto_mutex)
4012 struct oftable *table;
4018 if (!check_table_id(ofproto, fm->table_id)) {
4019 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4024 if (fm->table_id == 0xff) {
4025 if (ofproto->ofproto_class->rule_choose_table) {
4026 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4032 ovs_assert(table_id < ofproto->n_tables);
4036 } else if (fm->table_id < ofproto->n_tables) {
4037 table_id = fm->table_id;
4039 return OFPERR_OFPBRC_BAD_TABLE_ID;
4042 table = &ofproto->tables[table_id];
4044 if (!oftable_is_modifiable(table, fm->flags)) {
4045 return OFPERR_OFPBRC_EPERM;
4048 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4049 if (!match_has_default_hidden_fields(&fm->match)) {
4050 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4051 "non-default values to hidden fields", ofproto->name);
4052 return OFPERR_OFPBRC_EPERM;
4056 cls_rule_init(&cr, &fm->match, fm->priority);
4058 /* Transform "add" into "modify" if there's an existing identical flow. */
4059 fat_rwlock_rdlock(&table->cls.rwlock);
4060 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4061 fat_rwlock_unlock(&table->cls.rwlock);
4063 cls_rule_destroy(&cr);
4064 if (!rule_is_modifiable(rule, fm->flags)) {
4065 return OFPERR_OFPBRC_EPERM;
4066 } else if (rule->pending) {
4067 return OFPROTO_POSTPONE;
4069 struct rule_collection rules;
4071 rule_collection_init(&rules);
4072 rule_collection_add(&rules, rule);
4073 fm->modify_cookie = true;
4074 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4075 rule_collection_destroy(&rules);
4081 /* Serialize against pending deletion. */
4082 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
4083 cls_rule_destroy(&cr);
4084 return OFPROTO_POSTPONE;
4087 /* Check for overlap, if requested. */
4088 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4091 fat_rwlock_rdlock(&table->cls.rwlock);
4092 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4093 fat_rwlock_unlock(&table->cls.rwlock);
4096 cls_rule_destroy(&cr);
4097 return OFPERR_OFPFMFC_OVERLAP;
4101 /* If necessary, evict an existing rule to clear out space. */
4102 error = evict_rules_from_table(ofproto, table, 1);
4104 cls_rule_destroy(&cr);
4108 /* Allocate new rule. */
4109 rule = ofproto->ofproto_class->rule_alloc();
4111 cls_rule_destroy(&cr);
4112 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4113 ofproto->name, ovs_strerror(error));
4117 /* Initialize base state. */
4118 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4119 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4120 ovs_refcount_init(&rule->ref_count);
4121 rule->pending = NULL;
4122 rule->flow_cookie = fm->new_cookie;
4123 rule->created = rule->modified = time_msec();
4125 ovs_mutex_init(&rule->mutex);
4126 ovs_mutex_lock(&rule->mutex);
4127 rule->idle_timeout = fm->idle_timeout;
4128 rule->hard_timeout = fm->hard_timeout;
4129 ovs_mutex_unlock(&rule->mutex);
4131 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4132 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4133 ovsrcu_set(&rule->actions,
4134 rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len));
4135 list_init(&rule->meter_list_node);
4136 rule->eviction_group = NULL;
4137 list_init(&rule->expirable);
4138 rule->monitor_flags = 0;
4139 rule->add_seqno = 0;
4140 rule->modify_seqno = 0;
4142 /* Construct rule, initializing derived state. */
4143 error = ofproto->ofproto_class->rule_construct(rule);
4145 ofproto_rule_destroy__(rule);
4150 do_add_flow(ofproto, ofconn, request, fm->buffer_id, rule);
4156 do_add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
4157 const struct ofp_header *request, uint32_t buffer_id,
4159 OVS_REQUIRES(ofproto_mutex)
4161 struct ofopgroup *group;
4163 oftable_insert_rule(rule);
4165 group = ofopgroup_create(ofproto, ofconn, request, buffer_id);
4166 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4167 ofproto->ofproto_class->rule_insert(rule);
4168 ofopgroup_submit(group);
4171 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4173 /* Modifies the rules listed in 'rules', changing their actions to match those
4176 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4179 * Returns 0 on success, otherwise an OpenFlow error code. */
4181 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4182 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4183 const struct rule_collection *rules)
4184 OVS_REQUIRES(ofproto_mutex)
4186 enum ofoperation_type type;
4187 struct ofopgroup *group;
4191 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4192 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4193 error = OFPERR_OFPBRC_EPERM;
4194 for (i = 0; i < rules->n; i++) {
4195 struct rule *rule = rules->rules[i];
4196 const struct rule_actions *actions;
4197 struct ofoperation *op;
4198 bool actions_changed;
4199 bool reset_counters;
4201 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4203 if (rule_is_modifiable(rule, fm->flags)) {
4204 /* At least one rule is modifiable, don't report EPERM error. */
4210 actions = rule_get_actions(rule);
4211 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4213 actions->ofpacts_len);
4215 op = ofoperation_create(group, rule, type, 0);
4217 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4218 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4220 if (type == OFOPERATION_REPLACE) {
4221 ovs_mutex_lock(&rule->mutex);
4222 rule->idle_timeout = fm->idle_timeout;
4223 rule->hard_timeout = fm->hard_timeout;
4224 ovs_mutex_unlock(&rule->mutex);
4226 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4227 if (fm->idle_timeout || fm->hard_timeout) {
4228 if (!rule->eviction_group) {
4229 eviction_group_add_rule(rule);
4232 eviction_group_remove_rule(rule);
4236 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4237 if (actions_changed || reset_counters) {
4238 const struct rule_actions *new_actions;
4240 op->actions = rule_get_actions(rule);
4241 new_actions = rule_actions_create(ofproto,
4242 fm->ofpacts, fm->ofpacts_len);
4244 ovsrcu_set(&rule->actions, new_actions);
4246 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4249 ofoperation_complete(op, 0);
4252 ofopgroup_submit(group);
4258 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4259 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4260 OVS_REQUIRES(ofproto_mutex)
4262 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4265 return add_flow(ofproto, ofconn, fm, request);
4268 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4271 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4274 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4275 struct ofputil_flow_mod *fm,
4276 const struct ofp_header *request)
4277 OVS_REQUIRES(ofproto_mutex)
4279 struct rule_criteria criteria;
4280 struct rule_collection rules;
4283 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4284 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4285 error = collect_rules_loose(ofproto, &criteria, &rules);
4286 rule_criteria_destroy(&criteria);
4289 error = (rules.n > 0
4290 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4291 : modify_flows_add(ofproto, ofconn, fm, request));
4294 rule_collection_destroy(&rules);
4299 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4302 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4305 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4306 struct ofputil_flow_mod *fm,
4307 const struct ofp_header *request)
4308 OVS_REQUIRES(ofproto_mutex)
4310 struct rule_criteria criteria;
4311 struct rule_collection rules;
4314 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4315 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4316 error = collect_rules_strict(ofproto, &criteria, &rules);
4317 rule_criteria_destroy(&criteria);
4321 error = modify_flows_add(ofproto, ofconn, fm, request);
4322 } else if (rules.n == 1) {
4323 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4327 rule_collection_destroy(&rules);
4332 /* OFPFC_DELETE implementation. */
4335 delete_flow__(struct rule *rule, struct ofopgroup *group,
4336 enum ofp_flow_removed_reason reason)
4337 OVS_REQUIRES(ofproto_mutex)
4339 struct ofproto *ofproto = rule->ofproto;
4341 ofproto_rule_send_removed(rule, reason);
4343 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4344 oftable_remove_rule(rule);
4345 ofproto->ofproto_class->rule_delete(rule);
4348 /* Deletes the rules listed in 'rules'.
4350 * Returns 0 on success, otherwise an OpenFlow error code. */
4352 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4353 const struct ofp_header *request,
4354 const struct rule_collection *rules,
4355 enum ofp_flow_removed_reason reason)
4356 OVS_REQUIRES(ofproto_mutex)
4358 struct ofopgroup *group;
4361 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4362 for (i = 0; i < rules->n; i++) {
4363 delete_flow__(rules->rules[i], group, reason);
4365 ofopgroup_submit(group);
4370 /* Implements OFPFC_DELETE. */
4372 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4373 const struct ofputil_flow_mod *fm,
4374 const struct ofp_header *request)
4375 OVS_REQUIRES(ofproto_mutex)
4377 struct rule_criteria criteria;
4378 struct rule_collection rules;
4381 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4382 fm->cookie, fm->cookie_mask,
4383 fm->out_port, fm->out_group);
4384 error = collect_rules_loose(ofproto, &criteria, &rules);
4385 rule_criteria_destroy(&criteria);
4387 if (!error && rules.n > 0) {
4388 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4390 rule_collection_destroy(&rules);
4395 /* Implements OFPFC_DELETE_STRICT. */
4397 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4398 const struct ofputil_flow_mod *fm,
4399 const struct ofp_header *request)
4400 OVS_REQUIRES(ofproto_mutex)
4402 struct rule_criteria criteria;
4403 struct rule_collection rules;
4406 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4407 fm->cookie, fm->cookie_mask,
4408 fm->out_port, fm->out_group);
4409 error = collect_rules_strict(ofproto, &criteria, &rules);
4410 rule_criteria_destroy(&criteria);
4412 if (!error && rules.n > 0) {
4413 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4415 rule_collection_destroy(&rules);
4421 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4422 OVS_REQUIRES(ofproto_mutex)
4424 struct ofputil_flow_removed fr;
4427 if (ofproto_rule_is_hidden(rule) ||
4428 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4432 minimatch_expand(&rule->cr.match, &fr.match);
4433 fr.priority = rule->cr.priority;
4434 fr.cookie = rule->flow_cookie;
4436 fr.table_id = rule->table_id;
4437 calc_duration(rule->created, time_msec(),
4438 &fr.duration_sec, &fr.duration_nsec);
4439 ovs_mutex_lock(&rule->mutex);
4440 fr.idle_timeout = rule->idle_timeout;
4441 fr.hard_timeout = rule->hard_timeout;
4442 ovs_mutex_unlock(&rule->mutex);
4443 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4444 &fr.byte_count, &used);
4446 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4449 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4450 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4453 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4456 * ofproto implementation ->run() functions should use this function to expire
4457 * OpenFlow flows. */
4459 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4460 OVS_REQUIRES(ofproto_mutex)
4462 struct ofproto *ofproto = rule->ofproto;
4464 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4465 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4467 ofproto_rule_delete__(ofproto, rule, reason);
4470 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4471 * means "infinite". */
4473 reduce_timeout(uint16_t max, uint16_t *timeout)
4475 if (max && (!*timeout || *timeout > max)) {
4480 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4481 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4482 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4484 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4486 ofproto_rule_reduce_timeouts(struct rule *rule,
4487 uint16_t idle_timeout, uint16_t hard_timeout)
4488 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4490 if (!idle_timeout && !hard_timeout) {
4494 ovs_mutex_lock(&ofproto_mutex);
4495 if (list_is_empty(&rule->expirable)) {
4496 list_insert(&rule->ofproto->expirable, &rule->expirable);
4498 ovs_mutex_unlock(&ofproto_mutex);
4500 ovs_mutex_lock(&rule->mutex);
4501 reduce_timeout(idle_timeout, &rule->idle_timeout);
4502 reduce_timeout(hard_timeout, &rule->hard_timeout);
4503 ovs_mutex_unlock(&rule->mutex);
4507 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4508 OVS_EXCLUDED(ofproto_mutex)
4510 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4511 struct ofputil_flow_mod fm;
4512 uint64_t ofpacts_stub[1024 / 8];
4513 struct ofpbuf ofpacts;
4517 error = reject_slave_controller(ofconn);
4522 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4523 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4525 u16_to_ofp(ofproto->max_ports),
4528 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4531 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4534 goto exit_free_ofpacts;
4537 /* Record the operation for logging a summary report. */
4538 switch (fm.command) {
4544 case OFPFC_MODIFY_STRICT:
4545 ofproto->n_modify++;
4549 case OFPFC_DELETE_STRICT:
4550 ofproto->n_delete++;
4555 if (ofproto->next_op_report == LLONG_MAX) {
4556 ofproto->first_op = now;
4557 ofproto->next_op_report = MAX(now + 10 * 1000,
4558 ofproto->op_backoff);
4559 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
4561 ofproto->last_op = now;
4564 ofpbuf_uninit(&ofpacts);
4570 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4571 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4572 OVS_EXCLUDED(ofproto_mutex)
4576 ovs_mutex_lock(&ofproto_mutex);
4577 if (ofproto->n_pending < 50) {
4578 switch (fm->command) {
4580 error = add_flow(ofproto, ofconn, fm, oh);
4584 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4587 case OFPFC_MODIFY_STRICT:
4588 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4592 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4595 case OFPFC_DELETE_STRICT:
4596 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4600 if (fm->command > 0xff) {
4601 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4602 "flow_mod_table_id extension is not enabled",
4605 error = OFPERR_OFPFMFC_BAD_COMMAND;
4609 ovs_assert(!list_is_empty(&ofproto->pending));
4610 error = OFPROTO_POSTPONE;
4612 ovs_mutex_unlock(&ofproto_mutex);
4614 run_rule_executes(ofproto);
4619 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4621 struct ofputil_role_request request;
4622 struct ofputil_role_request reply;
4626 error = ofputil_decode_role_message(oh, &request);
4631 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4632 if (ofconn_get_role(ofconn) != request.role
4633 && ofconn_has_pending_opgroups(ofconn)) {
4634 return OFPROTO_POSTPONE;
4637 if (request.have_generation_id
4638 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4639 return OFPERR_OFPRRFC_STALE;
4642 ofconn_set_role(ofconn, request.role);
4645 reply.role = ofconn_get_role(ofconn);
4646 reply.have_generation_id = ofconn_get_master_election_id(
4647 ofconn, &reply.generation_id);
4648 buf = ofputil_encode_role_reply(oh, &reply);
4649 ofconn_send_reply(ofconn, buf);
4655 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4656 const struct ofp_header *oh)
4658 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4659 enum ofputil_protocol cur, next;
4661 cur = ofconn_get_protocol(ofconn);
4662 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4663 ofconn_set_protocol(ofconn, next);
4669 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4671 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4672 enum ofputil_protocol cur, next;
4673 enum ofputil_protocol next_base;
4675 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4677 return OFPERR_OFPBRC_EPERM;
4680 cur = ofconn_get_protocol(ofconn);
4681 next = ofputil_protocol_set_base(cur, next_base);
4682 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4683 /* Avoid sending async messages in surprising protocol. */
4684 return OFPROTO_POSTPONE;
4687 ofconn_set_protocol(ofconn, next);
4692 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4693 const struct ofp_header *oh)
4695 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4698 format = ntohl(msg->format);
4699 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4700 return OFPERR_OFPBRC_EPERM;
4703 if (format != ofconn_get_packet_in_format(ofconn)
4704 && ofconn_has_pending_opgroups(ofconn)) {
4705 /* Avoid sending async message in surprsing packet in format. */
4706 return OFPROTO_POSTPONE;
4709 ofconn_set_packet_in_format(ofconn, format);
4714 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4716 const struct nx_async_config *msg = ofpmsg_body(oh);
4717 uint32_t master[OAM_N_TYPES];
4718 uint32_t slave[OAM_N_TYPES];
4720 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4721 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4722 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4724 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4725 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4726 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4728 ofconn_set_async_config(ofconn, master, slave);
4729 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4730 !ofconn_get_miss_send_len(ofconn)) {
4731 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4738 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4741 uint32_t master[OAM_N_TYPES];
4742 uint32_t slave[OAM_N_TYPES];
4743 struct nx_async_config *msg;
4745 ofconn_get_async_config(ofconn, master, slave);
4746 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4747 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4749 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4750 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4751 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4753 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4754 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4755 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4757 ofconn_send_reply(ofconn, buf);
4763 handle_nxt_set_controller_id(struct ofconn *ofconn,
4764 const struct ofp_header *oh)
4766 const struct nx_controller_id *nci = ofpmsg_body(oh);
4768 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4769 return OFPERR_NXBRC_MUST_BE_ZERO;
4772 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4777 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4781 if (ofconn_has_pending_opgroups(ofconn)) {
4782 return OFPROTO_POSTPONE;
4785 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4786 ? OFPRAW_OFPT10_BARRIER_REPLY
4787 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4788 ofconn_send_reply(ofconn, buf);
4793 ofproto_compose_flow_refresh_update(const struct rule *rule,
4794 enum nx_flow_monitor_flags flags,
4796 OVS_REQUIRES(ofproto_mutex)
4798 struct ofoperation *op = rule->pending;
4799 const struct rule_actions *actions;
4800 struct ofputil_flow_update fu;
4803 if (op && op->type == OFOPERATION_ADD) {
4804 /* We'll report the final flow when the operation completes. Reporting
4805 * it now would cause a duplicate report later. */
4809 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4810 ? NXFME_ADDED : NXFME_MODIFIED);
4812 ovs_mutex_lock(&rule->mutex);
4813 fu.idle_timeout = rule->idle_timeout;
4814 fu.hard_timeout = rule->hard_timeout;
4815 ovs_mutex_unlock(&rule->mutex);
4816 fu.table_id = rule->table_id;
4817 fu.cookie = rule->flow_cookie;
4818 minimatch_expand(&rule->cr.match, &match);
4820 fu.priority = rule->cr.priority;
4822 if (!(flags & NXFMF_ACTIONS)) {
4825 actions = rule_get_actions(rule);
4827 /* An operation is in progress. Use the previous version of the flow's
4828 * actions, so that when the operation commits we report the change. */
4830 case OFOPERATION_ADD:
4833 case OFOPERATION_MODIFY:
4834 case OFOPERATION_REPLACE:
4835 actions = op->actions ? op->actions : rule_get_actions(rule);
4838 case OFOPERATION_DELETE:
4839 actions = rule_get_actions(rule);
4846 fu.ofpacts = actions ? actions->ofpacts : NULL;
4847 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4849 if (list_is_empty(msgs)) {
4850 ofputil_start_flow_update(msgs);
4852 ofputil_append_flow_update(&fu, msgs);
4856 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4858 OVS_REQUIRES(ofproto_mutex)
4862 for (i = 0; i < rules->n; i++) {
4863 struct rule *rule = rules->rules[i];
4864 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4865 rule->monitor_flags = 0;
4867 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4872 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4873 struct rule *rule, uint64_t seqno,
4874 struct rule_collection *rules)
4875 OVS_REQUIRES(ofproto_mutex)
4877 enum nx_flow_monitor_flags update;
4879 if (ofproto_rule_is_hidden(rule)) {
4884 ? ofoperation_has_out_port(rule->pending, m->out_port)
4885 : ofproto_rule_has_out_port(rule, m->out_port))) {
4890 if (rule->add_seqno > seqno) {
4891 update = NXFMF_ADD | NXFMF_MODIFY;
4892 } else if (rule->modify_seqno > seqno) {
4893 update = NXFMF_MODIFY;
4898 if (!(m->flags & update)) {
4902 update = NXFMF_INITIAL;
4905 if (!rule->monitor_flags) {
4906 rule_collection_add(rules, rule);
4908 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4912 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4914 struct rule_collection *rules)
4915 OVS_REQUIRES(ofproto_mutex)
4917 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4918 const struct ofoperation *op;
4919 const struct oftable *table;
4920 struct cls_rule target;
4922 cls_rule_init_from_minimatch(&target, &m->match, 0);
4923 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4924 struct cls_cursor cursor;
4927 fat_rwlock_rdlock(&table->cls.rwlock);
4928 cls_cursor_init(&cursor, &table->cls, &target);
4929 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4930 ovs_assert(!rule->pending); /* XXX */
4931 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4933 fat_rwlock_unlock(&table->cls.rwlock);
4936 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4937 struct rule *rule = op->rule;
4939 if (((m->table_id == 0xff
4940 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4941 : m->table_id == rule->table_id))
4942 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4943 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4946 cls_rule_destroy(&target);
4950 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4951 struct rule_collection *rules)
4952 OVS_REQUIRES(ofproto_mutex)
4954 if (m->flags & NXFMF_INITIAL) {
4955 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4960 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4961 uint64_t seqno, struct rule_collection *rules)
4962 OVS_REQUIRES(ofproto_mutex)
4964 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4968 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4969 OVS_EXCLUDED(ofproto_mutex)
4971 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4972 struct ofmonitor **monitors;
4973 size_t n_monitors, allocated_monitors;
4974 struct rule_collection rules;
4975 struct list replies;
4981 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4983 n_monitors = allocated_monitors = 0;
4985 ovs_mutex_lock(&ofproto_mutex);
4987 struct ofputil_flow_monitor_request request;
4988 struct ofmonitor *m;
4991 retval = ofputil_decode_flow_monitor_request(&request, &b);
4992 if (retval == EOF) {
4994 } else if (retval) {
4999 if (request.table_id != 0xff
5000 && request.table_id >= ofproto->n_tables) {
5001 error = OFPERR_OFPBRC_BAD_TABLE_ID;
5005 error = ofmonitor_create(&request, ofconn, &m);
5010 if (n_monitors >= allocated_monitors) {
5011 monitors = x2nrealloc(monitors, &allocated_monitors,
5014 monitors[n_monitors++] = m;
5017 rule_collection_init(&rules);
5018 for (i = 0; i < n_monitors; i++) {
5019 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
5022 ofpmp_init(&replies, oh);
5023 ofmonitor_compose_refresh_updates(&rules, &replies);
5024 ovs_mutex_unlock(&ofproto_mutex);
5026 rule_collection_destroy(&rules);
5028 ofconn_send_replies(ofconn, &replies);
5034 for (i = 0; i < n_monitors; i++) {
5035 ofmonitor_destroy(monitors[i]);
5038 ovs_mutex_unlock(&ofproto_mutex);
5044 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5045 OVS_EXCLUDED(ofproto_mutex)
5047 struct ofmonitor *m;
5051 id = ofputil_decode_flow_monitor_cancel(oh);
5053 ovs_mutex_lock(&ofproto_mutex);
5054 m = ofmonitor_lookup(ofconn, id);
5056 ofmonitor_destroy(m);
5059 error = OFPERR_NXBRC_FM_BAD_ID;
5061 ovs_mutex_unlock(&ofproto_mutex);
5066 /* Meters implementation.
5068 * Meter table entry, indexed by the OpenFlow meter_id.
5069 * These are always dynamically allocated to allocate enough space for
5071 * 'created' is used to compute the duration for meter stats.
5072 * 'list rules' is needed so that we can delete the dependent rules when the
5073 * meter table entry is deleted.
5074 * 'provider_meter_id' is for the provider's private use.
5077 long long int created; /* Time created. */
5078 struct list rules; /* List of "struct rule_dpif"s. */
5079 ofproto_meter_id provider_meter_id;
5080 uint16_t flags; /* Meter flags. */
5081 uint16_t n_bands; /* Number of meter bands. */
5082 struct ofputil_meter_band *bands;
5086 * This is used in instruction validation at flow set-up time,
5087 * as flows may not use non-existing meters.
5088 * Return value of UINT32_MAX signifies an invalid meter.
5091 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5093 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5094 const struct meter *meter = ofproto->meters[of_meter_id];
5096 return meter->provider_meter_id.uint32;
5103 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5107 meter->flags = config->flags;
5108 meter->n_bands = config->n_bands;
5109 meter->bands = xmemdup(config->bands,
5110 config->n_bands * sizeof *meter->bands);
5113 static struct meter *
5114 meter_create(const struct ofputil_meter_config *config,
5115 ofproto_meter_id provider_meter_id)
5117 struct meter *meter;
5119 meter = xzalloc(sizeof *meter);
5120 meter->provider_meter_id = provider_meter_id;
5121 meter->created = time_msec();
5122 list_init(&meter->rules);
5124 meter_update(meter, config);
5130 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5131 OVS_REQUIRES(ofproto_mutex)
5134 for (mid = first; mid <= last; ++mid) {
5135 struct meter *meter = ofproto->meters[mid];
5137 ofproto->meters[mid] = NULL;
5138 ofproto->ofproto_class->meter_del(ofproto,
5139 meter->provider_meter_id);
5147 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5149 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5150 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5154 return OFPERR_OFPMMFC_METER_EXISTS;
5157 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5160 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5161 *meterp = meter_create(&mm->meter, provider_meter_id);
5167 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5169 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5171 uint32_t provider_meter_id;
5174 return OFPERR_OFPMMFC_UNKNOWN_METER;
5177 provider_meter_id = meter->provider_meter_id.uint32;
5178 error = ofproto->ofproto_class->meter_set(ofproto,
5179 &meter->provider_meter_id,
5181 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5183 meter_update(meter, &mm->meter);
5189 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5190 struct ofputil_meter_mod *mm)
5191 OVS_EXCLUDED(ofproto_mutex)
5193 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5194 uint32_t meter_id = mm->meter.meter_id;
5195 struct rule_collection rules;
5196 enum ofperr error = 0;
5197 uint32_t first, last;
5199 if (meter_id == OFPM13_ALL) {
5201 last = ofproto->meter_features.max_meters;
5203 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5206 first = last = meter_id;
5209 /* First delete the rules that use this meter. If any of those rules are
5210 * currently being modified, postpone the whole operation until later. */
5211 rule_collection_init(&rules);
5212 ovs_mutex_lock(&ofproto_mutex);
5213 for (meter_id = first; meter_id <= last; ++meter_id) {
5214 struct meter *meter = ofproto->meters[meter_id];
5215 if (meter && !list_is_empty(&meter->rules)) {
5218 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5219 if (rule->pending) {
5220 error = OFPROTO_POSTPONE;
5223 rule_collection_add(&rules, rule);
5228 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5231 /* Delete the meters. */
5232 meter_delete(ofproto, first, last);
5235 ovs_mutex_unlock(&ofproto_mutex);
5236 rule_collection_destroy(&rules);
5242 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5244 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5245 struct ofputil_meter_mod mm;
5246 uint64_t bands_stub[256 / 8];
5247 struct ofpbuf bands;
5251 error = reject_slave_controller(ofconn);
5256 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5258 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5260 goto exit_free_bands;
5263 meter_id = mm.meter.meter_id;
5265 if (mm.command != OFPMC13_DELETE) {
5266 /* Fails also when meters are not implemented by the provider. */
5267 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5268 error = OFPERR_OFPMMFC_INVALID_METER;
5269 goto exit_free_bands;
5270 } else if (meter_id > ofproto->meter_features.max_meters) {
5271 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5272 goto exit_free_bands;
5274 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5275 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5276 goto exit_free_bands;
5280 switch (mm.command) {
5282 error = handle_add_meter(ofproto, &mm);
5285 case OFPMC13_MODIFY:
5286 error = handle_modify_meter(ofproto, &mm);
5289 case OFPMC13_DELETE:
5290 error = handle_delete_meter(ofconn, oh, &mm);
5294 error = OFPERR_OFPMMFC_BAD_COMMAND;
5299 ofpbuf_uninit(&bands);
5304 handle_meter_features_request(struct ofconn *ofconn,
5305 const struct ofp_header *request)
5307 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5308 struct ofputil_meter_features features;
5311 if (ofproto->ofproto_class->meter_get_features) {
5312 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5314 memset(&features, 0, sizeof features);
5316 b = ofputil_encode_meter_features_reply(&features, request);
5318 ofconn_send_reply(ofconn, b);
5323 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5326 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5327 struct list replies;
5328 uint64_t bands_stub[256 / 8];
5329 struct ofpbuf bands;
5330 uint32_t meter_id, first, last;
5332 ofputil_decode_meter_request(request, &meter_id);
5334 if (meter_id == OFPM13_ALL) {
5336 last = ofproto->meter_features.max_meters;
5338 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5339 !ofproto->meters[meter_id]) {
5340 return OFPERR_OFPMMFC_UNKNOWN_METER;
5342 first = last = meter_id;
5345 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5346 ofpmp_init(&replies, request);
5348 for (meter_id = first; meter_id <= last; ++meter_id) {
5349 struct meter *meter = ofproto->meters[meter_id];
5351 continue; /* Skip non-existing meters. */
5353 if (type == OFPTYPE_METER_STATS_REQUEST) {
5354 struct ofputil_meter_stats stats;
5356 stats.meter_id = meter_id;
5358 /* Provider sets the packet and byte counts, we do the rest. */
5359 stats.flow_count = list_size(&meter->rules);
5360 calc_duration(meter->created, time_msec(),
5361 &stats.duration_sec, &stats.duration_nsec);
5362 stats.n_bands = meter->n_bands;
5363 ofpbuf_clear(&bands);
5365 = ofpbuf_put_uninit(&bands,
5366 meter->n_bands * sizeof *stats.bands);
5368 if (!ofproto->ofproto_class->meter_get(ofproto,
5369 meter->provider_meter_id,
5371 ofputil_append_meter_stats(&replies, &stats);
5373 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5374 struct ofputil_meter_config config;
5376 config.meter_id = meter_id;
5377 config.flags = meter->flags;
5378 config.n_bands = meter->n_bands;
5379 config.bands = meter->bands;
5380 ofputil_append_meter_config(&replies, &config);
5384 ofconn_send_replies(ofconn, &replies);
5385 ofpbuf_uninit(&bands);
5390 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5391 struct ofgroup **group)
5392 OVS_TRY_RDLOCK(true, (*group)->rwlock)
5394 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5395 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5396 hash_int(group_id, 0), &ofproto->groups) {
5397 if ((*group)->group_id == group_id) {
5398 ovs_rwlock_rdlock(&(*group)->rwlock);
5399 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5403 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5408 ofproto_group_release(struct ofgroup *group)
5409 OVS_RELEASES(group->rwlock)
5411 ovs_rwlock_unlock(&group->rwlock);
5415 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
5416 struct ofgroup **group)
5417 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
5418 OVS_TRY_WRLOCK(true, (*group)->rwlock)
5420 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5421 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5422 hash_int(group_id, 0), &ofproto->groups) {
5423 if ((*group)->group_id == group_id) {
5424 ovs_rwlock_wrlock(&(*group)->rwlock);
5428 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5433 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5434 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5436 struct ofgroup *grp;
5438 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5439 hash_int(group_id, 0), &ofproto->groups) {
5440 if (grp->group_id == group_id) {
5448 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5449 OVS_EXCLUDED(ofproto->groups_rwlock)
5453 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5454 exists = ofproto_group_exists__(ofproto, group_id);
5455 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5461 group_get_ref_count(struct ofgroup *group)
5462 OVS_EXCLUDED(ofproto_mutex)
5464 struct ofproto *ofproto = group->ofproto;
5465 struct rule_criteria criteria;
5466 struct rule_collection rules;
5471 match_init_catchall(&match);
5472 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5473 OFPP_ANY, group->group_id);
5474 ovs_mutex_lock(&ofproto_mutex);
5475 error = collect_rules_loose(ofproto, &criteria, &rules);
5476 ovs_mutex_unlock(&ofproto_mutex);
5477 rule_criteria_destroy(&criteria);
5479 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5481 rule_collection_destroy(&rules);
5486 append_group_stats(struct ofgroup *group, struct list *replies)
5487 OVS_REQ_RDLOCK(group->rwlock)
5489 struct ofputil_group_stats ogs;
5490 struct ofproto *ofproto = group->ofproto;
5491 long long int now = time_msec();
5494 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5496 /* Provider sets the packet and byte counts, we do the rest. */
5497 ogs.ref_count = group_get_ref_count(group);
5498 ogs.n_buckets = group->n_buckets;
5500 error = (ofproto->ofproto_class->group_get_stats
5501 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5504 ogs.packet_count = UINT64_MAX;
5505 ogs.byte_count = UINT64_MAX;
5506 memset(ogs.bucket_stats, 0xff,
5507 ogs.n_buckets * sizeof *ogs.bucket_stats);
5510 ogs.group_id = group->group_id;
5511 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5513 ofputil_append_group_stats(replies, &ogs);
5515 free(ogs.bucket_stats);
5519 handle_group_stats_request(struct ofconn *ofconn,
5520 const struct ofp_header *request)
5522 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5523 struct list replies;
5525 struct ofgroup *group;
5528 error = ofputil_decode_group_stats_request(request, &group_id);
5533 ofpmp_init(&replies, request);
5535 if (group_id == OFPG_ALL) {
5536 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5537 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5538 ovs_rwlock_rdlock(&group->rwlock);
5539 append_group_stats(group, &replies);
5540 ovs_rwlock_unlock(&group->rwlock);
5542 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5544 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5545 append_group_stats(group, &replies);
5546 ofproto_group_release(group);
5550 ofconn_send_replies(ofconn, &replies);
5556 handle_group_desc_stats_request(struct ofconn *ofconn,
5557 const struct ofp_header *request)
5559 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5560 struct list replies;
5561 struct ofputil_group_desc gds;
5562 struct ofgroup *group;
5564 ofpmp_init(&replies, request);
5566 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5567 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5568 gds.group_id = group->group_id;
5569 gds.type = group->type;
5570 ofputil_append_group_desc_reply(&gds, &group->buckets, &replies);
5572 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5574 ofconn_send_replies(ofconn, &replies);
5580 handle_group_features_stats_request(struct ofconn *ofconn,
5581 const struct ofp_header *request)
5583 struct ofproto *p = ofconn_get_ofproto(ofconn);
5586 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5588 ofconn_send_reply(ofconn, msg);
5595 handle_queue_get_config_request(struct ofconn *ofconn,
5596 const struct ofp_header *oh)
5598 struct ofproto *p = ofconn_get_ofproto(ofconn);
5599 struct netdev_queue_dump queue_dump;
5600 struct ofport *ofport;
5601 unsigned int queue_id;
5602 struct ofpbuf *reply;
5603 struct smap details;
5607 error = ofputil_decode_queue_get_config_request(oh, &request);
5612 ofport = ofproto_get_port(p, request);
5614 return OFPERR_OFPQOFC_BAD_PORT;
5617 reply = ofputil_encode_queue_get_config_reply(oh);
5619 smap_init(&details);
5620 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5621 struct ofputil_queue_config queue;
5623 /* None of the existing queues have compatible properties, so we
5624 * hard-code omitting min_rate and max_rate. */
5625 queue.queue_id = queue_id;
5626 queue.min_rate = UINT16_MAX;
5627 queue.max_rate = UINT16_MAX;
5628 ofputil_append_queue_get_config_reply(reply, &queue);
5630 smap_destroy(&details);
5632 ofconn_send_reply(ofconn, reply);
5637 /* Implements OFPGC11_ADD
5638 * in which no matching flow already exists in the flow table.
5640 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5641 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5642 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5643 * initiated now but may be retried later.
5645 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5646 * ownership remains with the caller.
5648 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5651 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5653 struct ofgroup *ofgroup;
5656 if (gm->group_id > OFPG_MAX) {
5657 return OFPERR_OFPGMFC_INVALID_GROUP;
5659 if (gm->type > OFPGT11_FF) {
5660 return OFPERR_OFPGMFC_BAD_TYPE;
5663 /* Allocate new group and initialize it. */
5664 ofgroup = ofproto->ofproto_class->group_alloc();
5666 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
5667 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5670 ovs_rwlock_init(&ofgroup->rwlock);
5671 ofgroup->ofproto = ofproto;
5672 ofgroup->group_id = gm->group_id;
5673 ofgroup->type = gm->type;
5674 ofgroup->created = ofgroup->modified = time_msec();
5676 list_move(&ofgroup->buckets, &gm->buckets);
5677 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5679 /* Construct called BEFORE any locks are held. */
5680 error = ofproto->ofproto_class->group_construct(ofgroup);
5685 /* We wrlock as late as possible to minimize the time we jam any other
5686 * threads: No visible state changes before acquiring the lock. */
5687 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5689 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5690 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5694 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5695 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5700 /* Insert new group. */
5701 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5702 hash_int(ofgroup->group_id, 0));
5703 ofproto->n_groups[ofgroup->type]++;
5705 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5710 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5711 ofproto->ofproto_class->group_destruct(ofgroup);
5713 ofputil_bucket_list_destroy(&ofgroup->buckets);
5714 ofproto->ofproto_class->group_dealloc(ofgroup);
5719 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5722 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5725 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5727 struct ofgroup *ofgroup;
5728 struct ofgroup *victim;
5731 if (gm->group_id > OFPG_MAX) {
5732 return OFPERR_OFPGMFC_INVALID_GROUP;
5735 if (gm->type > OFPGT11_FF) {
5736 return OFPERR_OFPGMFC_BAD_TYPE;
5739 victim = ofproto->ofproto_class->group_alloc();
5741 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5742 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5745 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5746 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5749 /* Both group's and its container's write locks held now.
5750 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5751 if (ofgroup->type != gm->type
5752 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5753 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5758 list_move(&victim->buckets, &ofgroup->buckets);
5760 ofgroup->type = gm->type;
5761 list_move(&ofgroup->buckets, &gm->buckets);
5762 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5764 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5766 ofputil_bucket_list_destroy(&victim->buckets);
5767 ofproto->n_groups[victim->type]--;
5768 ofproto->n_groups[ofgroup->type]++;
5769 ofgroup->modified = time_msec();
5771 ofputil_bucket_list_destroy(&ofgroup->buckets);
5774 list_move(&ofgroup->buckets, &victim->buckets);
5778 ovs_rwlock_unlock(&ofgroup->rwlock);
5779 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5781 ofproto->ofproto_class->group_dealloc(victim);
5786 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5787 OVS_RELEASES(ofproto->groups_rwlock)
5790 struct ofputil_flow_mod fm;
5792 /* Delete all flow entries containing this group in a group action */
5793 match_init_catchall(&match);
5794 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5795 fm.out_group = ofgroup->group_id;
5796 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5798 /* Must wait until existing readers are done,
5799 * while holding the container's write lock at the same time. */
5800 ovs_rwlock_wrlock(&ofgroup->rwlock);
5801 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5802 /* No-one can find this group any more. */
5803 ofproto->n_groups[ofgroup->type]--;
5804 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5806 ofproto->ofproto_class->group_destruct(ofgroup);
5807 ofputil_bucket_list_destroy(&ofgroup->buckets);
5808 ovs_rwlock_unlock(&ofgroup->rwlock);
5809 ovs_rwlock_destroy(&ofgroup->rwlock);
5810 ofproto->ofproto_class->group_dealloc(ofgroup);
5813 /* Implements OFPGC_DELETE. */
5815 delete_group(struct ofproto *ofproto, uint32_t group_id)
5817 struct ofgroup *ofgroup;
5819 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5820 if (group_id == OFPG_ALL) {
5822 struct hmap_node *node = hmap_first(&ofproto->groups);
5826 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5827 delete_group__(ofproto, ofgroup);
5828 /* Lock for each node separately, so that we will not jam the
5829 * other threads for too long time. */
5830 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5833 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5834 hash_int(group_id, 0), &ofproto->groups) {
5835 if (ofgroup->group_id == group_id) {
5836 delete_group__(ofproto, ofgroup);
5841 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5845 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5847 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5848 struct ofputil_group_mod gm;
5851 error = reject_slave_controller(ofconn);
5856 error = ofputil_decode_group_mod(oh, &gm);
5861 switch (gm.command) {
5863 return add_group(ofproto, &gm);
5865 case OFPGC11_MODIFY:
5866 return modify_group(ofproto, &gm);
5868 case OFPGC11_DELETE:
5869 delete_group(ofproto, gm.group_id);
5873 if (gm.command > OFPGC11_DELETE) {
5874 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5875 ofproto->name, gm.command);
5877 return OFPERR_OFPGMFC_BAD_COMMAND;
5881 enum ofproto_table_config
5882 ofproto_table_get_config(const struct ofproto *ofproto, uint8_t table_id)
5885 atomic_read(&ofproto->tables[table_id].config, &value);
5886 return (enum ofproto_table_config)value;
5890 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5892 /* Only accept currently supported configurations */
5893 if (tm->config & ~OFPTC11_TABLE_MISS_MASK) {
5894 return OFPERR_OFPTMFC_BAD_CONFIG;
5897 if (tm->table_id == OFPTT_ALL) {
5899 for (i = 0; i < ofproto->n_tables; i++) {
5900 atomic_store(&ofproto->tables[i].config,
5901 (unsigned int)tm->config);
5903 } else if (!check_table_id(ofproto, tm->table_id)) {
5904 return OFPERR_OFPTMFC_BAD_TABLE;
5906 atomic_store(&ofproto->tables[tm->table_id].config,
5907 (unsigned int)tm->config);
5914 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5916 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5917 struct ofputil_table_mod tm;
5920 error = reject_slave_controller(ofconn);
5925 error = ofputil_decode_table_mod(oh, &tm);
5930 return table_mod(ofproto, &tm);
5934 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5935 OVS_EXCLUDED(ofproto_mutex)
5937 const struct ofp_header *oh = ofpbuf_data(msg);
5941 error = ofptype_decode(&type, oh);
5945 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5946 && ofpmp_more(oh)) {
5947 /* We have no buffer implementation for multipart requests.
5948 * Report overflow for requests which consists of multiple
5950 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5954 /* OpenFlow requests. */
5955 case OFPTYPE_ECHO_REQUEST:
5956 return handle_echo_request(ofconn, oh);
5958 case OFPTYPE_FEATURES_REQUEST:
5959 return handle_features_request(ofconn, oh);
5961 case OFPTYPE_GET_CONFIG_REQUEST:
5962 return handle_get_config_request(ofconn, oh);
5964 case OFPTYPE_SET_CONFIG:
5965 return handle_set_config(ofconn, oh);
5967 case OFPTYPE_PACKET_OUT:
5968 return handle_packet_out(ofconn, oh);
5970 case OFPTYPE_PORT_MOD:
5971 return handle_port_mod(ofconn, oh);
5973 case OFPTYPE_FLOW_MOD:
5974 return handle_flow_mod(ofconn, oh);
5976 case OFPTYPE_GROUP_MOD:
5977 return handle_group_mod(ofconn, oh);
5979 case OFPTYPE_TABLE_MOD:
5980 return handle_table_mod(ofconn, oh);
5982 case OFPTYPE_METER_MOD:
5983 return handle_meter_mod(ofconn, oh);
5985 case OFPTYPE_BARRIER_REQUEST:
5986 return handle_barrier_request(ofconn, oh);
5988 case OFPTYPE_ROLE_REQUEST:
5989 return handle_role_request(ofconn, oh);
5991 /* OpenFlow replies. */
5992 case OFPTYPE_ECHO_REPLY:
5995 /* Nicira extension requests. */
5996 case OFPTYPE_FLOW_MOD_TABLE_ID:
5997 return handle_nxt_flow_mod_table_id(ofconn, oh);
5999 case OFPTYPE_SET_FLOW_FORMAT:
6000 return handle_nxt_set_flow_format(ofconn, oh);
6002 case OFPTYPE_SET_PACKET_IN_FORMAT:
6003 return handle_nxt_set_packet_in_format(ofconn, oh);
6005 case OFPTYPE_SET_CONTROLLER_ID:
6006 return handle_nxt_set_controller_id(ofconn, oh);
6008 case OFPTYPE_FLOW_AGE:
6009 /* Nothing to do. */
6012 case OFPTYPE_FLOW_MONITOR_CANCEL:
6013 return handle_flow_monitor_cancel(ofconn, oh);
6015 case OFPTYPE_SET_ASYNC_CONFIG:
6016 return handle_nxt_set_async_config(ofconn, oh);
6018 case OFPTYPE_GET_ASYNC_REQUEST:
6019 return handle_nxt_get_async_request(ofconn, oh);
6021 /* Statistics requests. */
6022 case OFPTYPE_DESC_STATS_REQUEST:
6023 return handle_desc_stats_request(ofconn, oh);
6025 case OFPTYPE_FLOW_STATS_REQUEST:
6026 return handle_flow_stats_request(ofconn, oh);
6028 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6029 return handle_aggregate_stats_request(ofconn, oh);
6031 case OFPTYPE_TABLE_STATS_REQUEST:
6032 return handle_table_stats_request(ofconn, oh);
6034 case OFPTYPE_PORT_STATS_REQUEST:
6035 return handle_port_stats_request(ofconn, oh);
6037 case OFPTYPE_QUEUE_STATS_REQUEST:
6038 return handle_queue_stats_request(ofconn, oh);
6040 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6041 return handle_port_desc_stats_request(ofconn, oh);
6043 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6044 return handle_flow_monitor_request(ofconn, oh);
6046 case OFPTYPE_METER_STATS_REQUEST:
6047 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6048 return handle_meter_request(ofconn, oh, type);
6050 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6051 return handle_meter_features_request(ofconn, oh);
6053 case OFPTYPE_GROUP_STATS_REQUEST:
6054 return handle_group_stats_request(ofconn, oh);
6056 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6057 return handle_group_desc_stats_request(ofconn, oh);
6059 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6060 return handle_group_features_stats_request(ofconn, oh);
6062 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6063 return handle_queue_get_config_request(ofconn, oh);
6067 case OFPTYPE_FEATURES_REPLY:
6068 case OFPTYPE_GET_CONFIG_REPLY:
6069 case OFPTYPE_PACKET_IN:
6070 case OFPTYPE_FLOW_REMOVED:
6071 case OFPTYPE_PORT_STATUS:
6072 case OFPTYPE_BARRIER_REPLY:
6073 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6074 case OFPTYPE_DESC_STATS_REPLY:
6075 case OFPTYPE_FLOW_STATS_REPLY:
6076 case OFPTYPE_QUEUE_STATS_REPLY:
6077 case OFPTYPE_PORT_STATS_REPLY:
6078 case OFPTYPE_TABLE_STATS_REPLY:
6079 case OFPTYPE_AGGREGATE_STATS_REPLY:
6080 case OFPTYPE_PORT_DESC_STATS_REPLY:
6081 case OFPTYPE_ROLE_REPLY:
6082 case OFPTYPE_FLOW_MONITOR_PAUSED:
6083 case OFPTYPE_FLOW_MONITOR_RESUMED:
6084 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6085 case OFPTYPE_GET_ASYNC_REPLY:
6086 case OFPTYPE_GROUP_STATS_REPLY:
6087 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6088 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6089 case OFPTYPE_METER_STATS_REPLY:
6090 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6091 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6092 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6093 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6094 case OFPTYPE_ROLE_STATUS:
6096 if (ofpmsg_is_stat_request(oh)) {
6097 return OFPERR_OFPBRC_BAD_STAT;
6099 return OFPERR_OFPBRC_BAD_TYPE;
6105 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6106 OVS_EXCLUDED(ofproto_mutex)
6108 int error = handle_openflow__(ofconn, ofp_msg);
6109 if (error && error != OFPROTO_POSTPONE) {
6110 ofconn_send_error(ofconn, ofpbuf_data(ofp_msg), error);
6112 COVERAGE_INC(ofproto_recv_openflow);
6113 return error != OFPROTO_POSTPONE;
6116 /* Asynchronous operations. */
6118 /* Creates and returns a new ofopgroup that is not associated with any
6119 * OpenFlow connection.
6121 * The caller should add operations to the returned group with
6122 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6123 static struct ofopgroup *
6124 ofopgroup_create_unattached(struct ofproto *ofproto)
6125 OVS_REQUIRES(ofproto_mutex)
6127 struct ofopgroup *group = xzalloc(sizeof *group);
6128 group->ofproto = ofproto;
6129 list_init(&group->ofproto_node);
6130 list_init(&group->ops);
6131 list_init(&group->ofconn_node);
6135 /* Creates and returns a new ofopgroup for 'ofproto'.
6137 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6138 * connection. The 'request' and 'buffer_id' arguments are ignored.
6140 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6141 * If the ofopgroup eventually fails, then the error reply will include
6142 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6143 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6145 * The caller should add operations to the returned group with
6146 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6147 static struct ofopgroup *
6148 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6149 const struct ofp_header *request, uint32_t buffer_id)
6150 OVS_REQUIRES(ofproto_mutex)
6152 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6154 size_t request_len = ntohs(request->length);
6156 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6158 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6159 group->ofconn = ofconn;
6160 group->request = xmemdup(request, MIN(request_len, 64));
6161 group->buffer_id = buffer_id;
6166 /* Submits 'group' for processing.
6168 * If 'group' contains no operations (e.g. none were ever added, or all of the
6169 * ones that were added completed synchronously), then it is destroyed
6170 * immediately. Otherwise it is added to the ofproto's list of pending
6173 ofopgroup_submit(struct ofopgroup *group)
6174 OVS_REQUIRES(ofproto_mutex)
6176 if (!group->n_running) {
6177 ofopgroup_complete(group);
6179 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6180 group->ofproto->n_pending++;
6185 ofopgroup_complete(struct ofopgroup *group)
6186 OVS_REQUIRES(ofproto_mutex)
6188 struct ofproto *ofproto = group->ofproto;
6190 struct ofconn *abbrev_ofconn;
6191 ovs_be32 abbrev_xid;
6193 struct ofoperation *op, *next_op;
6196 ovs_assert(!group->n_running);
6199 LIST_FOR_EACH (op, group_node, &group->ops) {
6206 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6207 LIST_FOR_EACH (op, group_node, &group->ops) {
6208 if (op->type != OFOPERATION_DELETE) {
6209 struct ofpbuf *packet;
6212 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6215 struct rule_execute *re;
6219 ofproto_rule_ref(op->rule);
6221 re = xmalloc(sizeof *re);
6222 re->rule = op->rule;
6223 re->in_port = in_port;
6224 re->packet = packet;
6226 if (!guarded_list_push_back(&ofproto->rule_executes,
6227 &re->list_node, 1024)) {
6228 ofproto_rule_unref(op->rule);
6229 ofpbuf_delete(re->packet);
6238 if (!error && !list_is_empty(&group->ofconn_node)) {
6239 abbrev_ofconn = group->ofconn;
6240 abbrev_xid = group->request->xid;
6242 abbrev_ofconn = NULL;
6243 abbrev_xid = htonl(0);
6245 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6246 struct rule *rule = op->rule;
6248 /* We generally want to report the change to active OpenFlow flow
6249 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6251 - The operation failed.
6253 - The affected rule is not visible to controllers.
6255 - The operation's only effect was to update rule->modified. */
6257 || ofproto_rule_is_hidden(rule)
6258 || (op->type == OFOPERATION_MODIFY
6260 && rule->flow_cookie == op->flow_cookie))) {
6261 /* Check that we can just cast from ofoperation_type to
6262 * nx_flow_update_event. */
6263 enum nx_flow_update_event event_type;
6266 case OFOPERATION_ADD:
6267 case OFOPERATION_REPLACE:
6268 event_type = NXFME_ADDED;
6271 case OFOPERATION_DELETE:
6272 event_type = NXFME_DELETED;
6275 case OFOPERATION_MODIFY:
6276 event_type = NXFME_MODIFIED;
6283 ofmonitor_report(ofproto->connmgr, rule, event_type,
6284 op->reason, abbrev_ofconn, abbrev_xid);
6287 rule->pending = NULL;
6290 case OFOPERATION_ADD:
6294 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6295 if (vid_mask == VLAN_VID_MASK) {
6296 if (ofproto->vlan_bitmap) {
6297 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6298 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6299 bitmap_set1(ofproto->vlan_bitmap, vid);
6300 ofproto->vlans_changed = true;
6303 ofproto->vlans_changed = true;
6307 oftable_remove_rule(rule);
6308 ofproto_rule_unref(rule);
6312 case OFOPERATION_DELETE:
6313 ovs_assert(!op->error);
6314 ofproto_rule_unref(rule);
6318 case OFOPERATION_MODIFY:
6319 case OFOPERATION_REPLACE:
6321 long long int now = time_msec();
6323 ovs_mutex_lock(&rule->mutex);
6324 rule->modified = now;
6325 if (op->type == OFOPERATION_REPLACE) {
6326 rule->created = now;
6328 ovs_mutex_unlock(&rule->mutex);
6330 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6331 ovs_mutex_lock(&rule->mutex);
6332 rule->idle_timeout = op->idle_timeout;
6333 rule->hard_timeout = op->hard_timeout;
6334 ovs_mutex_unlock(&rule->mutex);
6336 const struct rule_actions *old_actions;
6338 ovs_mutex_lock(&rule->mutex);
6339 old_actions = rule_get_actions(rule);
6340 ovsrcu_set(&rule->actions, op->actions);
6341 ovs_mutex_unlock(&rule->mutex);
6344 rule_actions_destroy(old_actions);
6346 rule->flags = op->flags;
6354 ofoperation_destroy(op);
6357 ofmonitor_flush(ofproto->connmgr);
6359 if (!list_is_empty(&group->ofproto_node)) {
6360 ovs_assert(ofproto->n_pending > 0);
6361 ofproto->n_pending--;
6362 list_remove(&group->ofproto_node);
6364 if (!list_is_empty(&group->ofconn_node)) {
6365 list_remove(&group->ofconn_node);
6367 ofconn_send_error(group->ofconn, group->request, error);
6369 connmgr_retry(ofproto->connmgr);
6371 free(group->request);
6375 /* Initiates a new operation on 'rule', of the specified 'type', within
6376 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6378 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6379 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6381 * Returns the newly created ofoperation (which is also available as
6382 * rule->pending). */
6383 static struct ofoperation *
6384 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6385 enum ofoperation_type type,
6386 enum ofp_flow_removed_reason reason)
6387 OVS_REQUIRES(ofproto_mutex)
6389 struct ofproto *ofproto = group->ofproto;
6390 struct ofoperation *op;
6392 ovs_assert(!rule->pending);
6394 op = rule->pending = xzalloc(sizeof *op);
6396 list_push_back(&group->ops, &op->group_node);
6399 op->reason = reason;
6400 op->flow_cookie = rule->flow_cookie;
6401 ovs_mutex_lock(&rule->mutex);
6402 op->idle_timeout = rule->idle_timeout;
6403 op->hard_timeout = rule->hard_timeout;
6404 ovs_mutex_unlock(&rule->mutex);
6405 op->flags = rule->flags;
6409 if (type == OFOPERATION_DELETE) {
6410 hmap_insert(&ofproto->deletions, &op->hmap_node,
6411 cls_rule_hash(&rule->cr, rule->table_id));
6418 ofoperation_destroy(struct ofoperation *op)
6419 OVS_REQUIRES(ofproto_mutex)
6421 struct ofopgroup *group = op->group;
6424 op->rule->pending = NULL;
6426 if (op->type == OFOPERATION_DELETE) {
6427 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6429 list_remove(&op->group_node);
6430 rule_actions_destroy(op->actions);
6434 /* Indicates that 'op' completed with status 'error', which is either 0 to
6435 * indicate success or an OpenFlow error code on failure.
6437 * If 'error' is 0, indicating success, the operation will be committed
6438 * permanently to the flow table.
6440 * If 'error' is nonzero, then generally the operation will be rolled back:
6442 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6443 * restores the original rule. The caller must have uninitialized any
6444 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6445 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6446 * and 7 for the new rule, calling its ->rule_dealloc() function.
6448 * - If 'op' is a "modify flow" operation, ofproto restores the original
6451 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6452 * allowed to fail. It must always succeed.
6454 * Please see the large comment in ofproto/ofproto-provider.h titled
6455 * "Asynchronous Operation Support" for more information. */
6457 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6459 struct ofopgroup *group = op->group;
6461 ovs_assert(group->n_running > 0);
6462 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6465 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6466 /* This function can be called from ->rule_construct(), in which case
6467 * ofproto_mutex is held, or it can be called from ->run(), in which
6468 * case ofproto_mutex is not held. But only in the latter case can we
6469 * arrive here, so we can safely take ofproto_mutex now. */
6470 ovs_mutex_lock(&ofproto_mutex);
6471 ovs_assert(op->rule->pending == op);
6472 ofopgroup_complete(group);
6473 ovs_mutex_unlock(&ofproto_mutex);
6478 pick_datapath_id(const struct ofproto *ofproto)
6480 const struct ofport *port;
6482 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6484 uint8_t ea[ETH_ADDR_LEN];
6487 error = netdev_get_etheraddr(port->netdev, ea);
6489 return eth_addr_to_uint64(ea);
6491 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6492 ofproto->name, netdev_get_name(port->netdev),
6493 ovs_strerror(error));
6495 return ofproto->fallback_dpid;
6499 pick_fallback_dpid(void)
6501 uint8_t ea[ETH_ADDR_LEN];
6502 eth_addr_nicira_random(ea);
6503 return eth_addr_to_uint64(ea);
6506 /* Table overflow policy. */
6508 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6509 * to NULL if the table is not configured to evict rules or if the table
6510 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6511 * or with no timeouts are not evictable.) */
6513 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6514 OVS_REQUIRES(ofproto_mutex)
6516 struct eviction_group *evg;
6519 if (!table->eviction_fields) {
6523 /* In the common case, the outer and inner loops here will each be entered
6526 * - The inner loop normally "return"s in its first iteration. If the
6527 * eviction group has any evictable rules, then it always returns in
6530 * - The outer loop only iterates more than once if the largest eviction
6531 * group has no evictable rules.
6533 * - The outer loop can exit only if table's 'max_flows' is all filled up
6534 * by unevictable rules. */
6535 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6538 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6547 /* Searches 'ofproto' for tables that have more flows than their configured
6548 * maximum and that have flow eviction enabled, and evicts as many flows as
6549 * necessary and currently feasible from them.
6551 * This triggers only when an OpenFlow table has N flows in it and then the
6552 * client configures a maximum number of flows less than N. */
6554 ofproto_evict(struct ofproto *ofproto)
6556 struct oftable *table;
6558 ovs_mutex_lock(&ofproto_mutex);
6559 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6560 evict_rules_from_table(ofproto, table, 0);
6562 ovs_mutex_unlock(&ofproto_mutex);
6565 /* Eviction groups. */
6567 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6568 * rules. The priority contains low-order random bits to ensure that eviction
6569 * groups with the same number of rules are prioritized randomly. */
6571 eviction_group_priority(size_t n_rules)
6573 uint16_t size = MIN(UINT16_MAX, n_rules);
6574 return (size << 16) | random_uint16();
6577 /* Updates 'evg', an eviction_group within 'table', following a change that
6578 * adds or removes rules in 'evg'. */
6580 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6581 OVS_REQUIRES(ofproto_mutex)
6583 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6584 eviction_group_priority(heap_count(&evg->rules)));
6587 /* Destroys 'evg', an eviction_group within 'table':
6589 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6590 * rules themselves, just removes them from the eviction group.)
6592 * - Removes 'evg' from 'table'.
6596 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6597 OVS_REQUIRES(ofproto_mutex)
6599 while (!heap_is_empty(&evg->rules)) {
6602 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6603 rule->eviction_group = NULL;
6605 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6606 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6607 heap_destroy(&evg->rules);
6611 /* Removes 'rule' from its eviction group, if any. */
6613 eviction_group_remove_rule(struct rule *rule)
6614 OVS_REQUIRES(ofproto_mutex)
6616 if (rule->eviction_group) {
6617 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6618 struct eviction_group *evg = rule->eviction_group;
6620 rule->eviction_group = NULL;
6621 heap_remove(&evg->rules, &rule->evg_node);
6622 if (heap_is_empty(&evg->rules)) {
6623 eviction_group_destroy(table, evg);
6625 eviction_group_resized(table, evg);
6630 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6631 * returns the hash value. */
6633 eviction_group_hash_rule(struct rule *rule)
6634 OVS_REQUIRES(ofproto_mutex)
6636 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6637 const struct mf_subfield *sf;
6641 hash = table->eviction_group_id_basis;
6642 miniflow_expand(&rule->cr.match.flow, &flow);
6643 for (sf = table->eviction_fields;
6644 sf < &table->eviction_fields[table->n_eviction_fields];
6647 if (mf_are_prereqs_ok(sf->field, &flow)) {
6648 union mf_value value;
6650 mf_get_value(sf->field, &flow, &value);
6652 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6654 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6655 unsigned int start = sf->ofs + sf->n_bits;
6656 bitwise_zero(&value, sf->field->n_bytes, start,
6657 sf->field->n_bytes * 8 - start);
6659 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6661 hash = hash_int(hash, 0);
6668 /* Returns an eviction group within 'table' with the given 'id', creating one
6670 static struct eviction_group *
6671 eviction_group_find(struct oftable *table, uint32_t id)
6672 OVS_REQUIRES(ofproto_mutex)
6674 struct eviction_group *evg;
6676 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6680 evg = xmalloc(sizeof *evg);
6681 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6682 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6683 eviction_group_priority(0));
6684 heap_init(&evg->rules);
6689 /* Returns an eviction priority for 'rule'. The return value should be
6690 * interpreted so that higher priorities make a rule more attractive candidates
6692 * Called only if have a timeout. */
6694 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6695 OVS_REQUIRES(ofproto_mutex)
6697 long long int expiration = LLONG_MAX;
6698 long long int modified;
6699 uint32_t expiration_offset;
6701 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6702 ovs_mutex_lock(&rule->mutex);
6703 modified = rule->modified;
6704 ovs_mutex_unlock(&rule->mutex);
6706 if (rule->hard_timeout) {
6707 expiration = modified + rule->hard_timeout * 1000;
6709 if (rule->idle_timeout) {
6710 uint64_t packets, bytes;
6712 long long int idle_expiration;
6714 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6715 idle_expiration = used + rule->idle_timeout * 1000;
6716 expiration = MIN(expiration, idle_expiration);
6719 if (expiration == LLONG_MAX) {
6723 /* Calculate the time of expiration as a number of (approximate) seconds
6724 * after program startup.
6726 * This should work OK for program runs that last UINT32_MAX seconds or
6727 * less. Therefore, please restart OVS at least once every 136 years. */
6728 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6730 /* Invert the expiration offset because we're using a max-heap. */
6731 return UINT32_MAX - expiration_offset;
6734 /* Adds 'rule' to an appropriate eviction group for its oftable's
6735 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6736 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6739 * The caller must ensure that 'rule' is not already in an eviction group. */
6741 eviction_group_add_rule(struct rule *rule)
6742 OVS_REQUIRES(ofproto_mutex)
6744 struct ofproto *ofproto = rule->ofproto;
6745 struct oftable *table = &ofproto->tables[rule->table_id];
6748 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6749 * so no additional protection is needed. */
6750 has_timeout = rule->hard_timeout || rule->idle_timeout;
6752 if (table->eviction_fields && has_timeout) {
6753 struct eviction_group *evg;
6755 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6757 rule->eviction_group = evg;
6758 heap_insert(&evg->rules, &rule->evg_node,
6759 rule_eviction_priority(ofproto, rule));
6760 eviction_group_resized(table, evg);
6766 /* Initializes 'table'. */
6768 oftable_init(struct oftable *table)
6770 memset(table, 0, sizeof *table);
6771 classifier_init(&table->cls, flow_segment_u32s);
6772 table->max_flows = UINT_MAX;
6773 atomic_init(&table->config, (unsigned int)OFPROTO_TABLE_MISS_DEFAULT);
6776 /* Destroys 'table', including its classifier and eviction groups.
6778 * The caller is responsible for freeing 'table' itself. */
6780 oftable_destroy(struct oftable *table)
6782 fat_rwlock_rdlock(&table->cls.rwlock);
6783 ovs_assert(classifier_is_empty(&table->cls));
6784 fat_rwlock_unlock(&table->cls.rwlock);
6785 oftable_disable_eviction(table);
6786 classifier_destroy(&table->cls);
6790 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6791 * string, then 'table' will use its default name.
6793 * This only affects the name exposed for a table exposed through the OpenFlow
6794 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6796 oftable_set_name(struct oftable *table, const char *name)
6798 if (name && name[0]) {
6799 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6800 if (!table->name || strncmp(name, table->name, len)) {
6802 table->name = xmemdup0(name, len);
6810 /* oftables support a choice of two policies when adding a rule would cause the
6811 * number of flows in the table to exceed the configured maximum number: either
6812 * they can refuse to add the new flow or they can evict some existing flow.
6813 * This function configures the former policy on 'table'. */
6815 oftable_disable_eviction(struct oftable *table)
6816 OVS_REQUIRES(ofproto_mutex)
6818 if (table->eviction_fields) {
6819 struct eviction_group *evg, *next;
6821 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6822 &table->eviction_groups_by_id) {
6823 eviction_group_destroy(table, evg);
6825 hmap_destroy(&table->eviction_groups_by_id);
6826 heap_destroy(&table->eviction_groups_by_size);
6828 free(table->eviction_fields);
6829 table->eviction_fields = NULL;
6830 table->n_eviction_fields = 0;
6834 /* oftables support a choice of two policies when adding a rule would cause the
6835 * number of flows in the table to exceed the configured maximum number: either
6836 * they can refuse to add the new flow or they can evict some existing flow.
6837 * This function configures the latter policy on 'table', with fairness based
6838 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6839 * 'n_fields' as 0 disables fairness.) */
6841 oftable_enable_eviction(struct oftable *table,
6842 const struct mf_subfield *fields, size_t n_fields)
6843 OVS_REQUIRES(ofproto_mutex)
6845 struct cls_cursor cursor;
6848 if (table->eviction_fields
6849 && n_fields == table->n_eviction_fields
6851 || !memcmp(fields, table->eviction_fields,
6852 n_fields * sizeof *fields))) {
6857 oftable_disable_eviction(table);
6859 table->n_eviction_fields = n_fields;
6860 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6862 table->eviction_group_id_basis = random_uint32();
6863 hmap_init(&table->eviction_groups_by_id);
6864 heap_init(&table->eviction_groups_by_size);
6866 fat_rwlock_rdlock(&table->cls.rwlock);
6867 cls_cursor_init(&cursor, &table->cls, NULL);
6868 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6869 eviction_group_add_rule(rule);
6871 fat_rwlock_unlock(&table->cls.rwlock);
6874 /* Removes 'rule' from the oftable that contains it. */
6876 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6877 OVS_REQUIRES(ofproto_mutex)
6879 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6881 fat_rwlock_wrlock(&cls->rwlock);
6882 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6883 fat_rwlock_unlock(&cls->rwlock);
6885 cookies_remove(ofproto, rule);
6887 eviction_group_remove_rule(rule);
6888 if (!list_is_empty(&rule->expirable)) {
6889 list_remove(&rule->expirable);
6891 if (!list_is_empty(&rule->meter_list_node)) {
6892 list_remove(&rule->meter_list_node);
6893 list_init(&rule->meter_list_node);
6898 oftable_remove_rule(struct rule *rule)
6899 OVS_REQUIRES(ofproto_mutex)
6901 oftable_remove_rule__(rule->ofproto, rule);
6904 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6905 * the same cls_rule. */
6907 oftable_insert_rule(struct rule *rule)
6908 OVS_REQUIRES(ofproto_mutex)
6910 struct ofproto *ofproto = rule->ofproto;
6911 struct oftable *table = &ofproto->tables[rule->table_id];
6912 const struct rule_actions *actions;
6915 ovs_mutex_lock(&rule->mutex);
6916 may_expire = rule->hard_timeout || rule->idle_timeout;
6917 ovs_mutex_unlock(&rule->mutex);
6920 list_insert(&ofproto->expirable, &rule->expirable);
6923 cookies_insert(ofproto, rule);
6925 actions = rule_get_actions(rule);
6926 if (actions->provider_meter_id != UINT32_MAX) {
6927 uint32_t meter_id = ofpacts_get_meter(actions->ofpacts,
6928 actions->ofpacts_len);
6929 struct meter *meter = ofproto->meters[meter_id];
6930 list_insert(&meter->rules, &rule->meter_list_node);
6932 fat_rwlock_wrlock(&table->cls.rwlock);
6933 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6934 fat_rwlock_unlock(&table->cls.rwlock);
6935 eviction_group_add_rule(rule);
6938 /* unixctl commands. */
6941 ofproto_lookup(const char *name)
6943 struct ofproto *ofproto;
6945 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6947 if (!strcmp(ofproto->name, name)) {
6955 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6956 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6958 struct ofproto *ofproto;
6962 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6963 ds_put_format(&results, "%s\n", ofproto->name);
6965 unixctl_command_reply(conn, ds_cstr(&results));
6966 ds_destroy(&results);
6970 ofproto_unixctl_init(void)
6972 static bool registered;
6978 unixctl_command_register("ofproto/list", "", 0, 0,
6979 ofproto_unixctl_list, NULL);
6982 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6984 * This is deprecated. It is only for compatibility with broken device drivers
6985 * in old versions of Linux that do not properly support VLANs when VLAN
6986 * devices are not used. When broken device drivers are no longer in
6987 * widespread use, we will delete these interfaces. */
6989 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6990 * (exactly) by an OpenFlow rule in 'ofproto'. */
6992 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6995 struct cls_rule target;
6996 const struct oftable *oftable;
6998 match_init_catchall(&match);
6999 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7000 cls_rule_init(&target, &match, 0);
7002 free(ofproto->vlan_bitmap);
7003 ofproto->vlan_bitmap = bitmap_allocate(4096);
7004 ofproto->vlans_changed = false;
7006 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7007 struct cls_cursor cursor;
7010 fat_rwlock_rdlock(&oftable->cls.rwlock);
7011 cls_cursor_init(&cursor, &oftable->cls, &target);
7012 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
7013 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7014 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7016 bitmap_set1(vlan_bitmap, vid);
7017 bitmap_set1(ofproto->vlan_bitmap, vid);
7020 fat_rwlock_unlock(&oftable->cls.rwlock);
7024 /* Returns true if new VLANs have come into use by the flow table since the
7025 * last call to ofproto_get_vlan_usage().
7027 * We don't track when old VLANs stop being used. */
7029 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7031 return ofproto->vlans_changed;
7034 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7035 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7036 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7037 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7038 * then the VLAN device is un-enslaved. */
7040 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7041 ofp_port_t realdev_ofp_port, int vid)
7043 struct ofport *ofport;
7046 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7048 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7050 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7051 ofproto->name, vlandev_ofp_port);
7055 if (!ofproto->ofproto_class->set_realdev) {
7056 if (!vlandev_ofp_port) {
7059 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7063 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7065 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7066 ofproto->name, vlandev_ofp_port,
7067 netdev_get_name(ofport->netdev), ovs_strerror(error));