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 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_destroy__(struct rule *);
263 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
264 static bool rule_is_modifiable(const struct rule *);
267 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
268 struct ofputil_flow_mod *,
269 const struct ofp_header *);
270 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
271 struct ofputil_flow_mod *,
272 const struct ofp_header *,
273 const struct rule_collection *);
274 static void delete_flow__(struct rule *rule, struct ofopgroup *,
275 enum ofp_flow_removed_reason)
276 OVS_REQUIRES(ofproto_mutex);
277 static bool ofproto_group_exists__(const struct ofproto *ofproto,
279 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
280 static bool ofproto_group_exists(const struct ofproto *ofproto,
282 OVS_EXCLUDED(ofproto->groups_rwlock);
283 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
284 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
285 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
286 struct ofputil_flow_mod *,
287 const struct ofp_header *)
288 OVS_EXCLUDED(ofproto_mutex);
289 static void calc_duration(long long int start, long long int now,
290 uint32_t *sec, uint32_t *nsec);
293 static uint64_t pick_datapath_id(const struct ofproto *);
294 static uint64_t pick_fallback_dpid(void);
295 static void ofproto_destroy__(struct ofproto *);
296 static void update_mtu(struct ofproto *, struct ofport *);
297 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
300 static void ofproto_unixctl_init(void);
302 /* All registered ofproto classes, in probe order. */
303 static const struct ofproto_class **ofproto_classes;
304 static size_t n_ofproto_classes;
305 static size_t allocated_ofproto_classes;
307 /* Global lock that protects all flow table operations. */
308 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
310 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
311 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
313 size_t n_handlers, n_revalidators;
315 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
316 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
318 /* Initial mappings of port to OpenFlow number mappings. */
319 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
321 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
323 /* The default value of true waits for flow restore. */
324 static bool flow_restore_wait = true;
326 /* Must be called to initialize the ofproto library.
328 * The caller may pass in 'iface_hints', which contains an shash of
329 * "iface_hint" elements indexed by the interface's name. The provider
330 * may use these hints to describe the startup configuration in order to
331 * reinitialize its state. The caller owns the provided data, so a
332 * provider will make copies of anything required. An ofproto provider
333 * will remove any existing state that is not described by the hint, and
334 * may choose to remove it all. */
336 ofproto_init(const struct shash *iface_hints)
338 struct shash_node *node;
341 ofproto_class_register(&ofproto_dpif_class);
343 /* Make a local copy, since we don't own 'iface_hints' elements. */
344 SHASH_FOR_EACH(node, iface_hints) {
345 const struct iface_hint *orig_hint = node->data;
346 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
347 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
349 new_hint->br_name = xstrdup(orig_hint->br_name);
350 new_hint->br_type = xstrdup(br_type);
351 new_hint->ofp_port = orig_hint->ofp_port;
353 shash_add(&init_ofp_ports, node->name, new_hint);
356 for (i = 0; i < n_ofproto_classes; i++) {
357 ofproto_classes[i]->init(&init_ofp_ports);
361 /* 'type' should be a normalized datapath type, as returned by
362 * ofproto_normalize_type(). Returns the corresponding ofproto_class
363 * structure, or a null pointer if there is none registered for 'type'. */
364 static const struct ofproto_class *
365 ofproto_class_find__(const char *type)
369 for (i = 0; i < n_ofproto_classes; i++) {
370 const struct ofproto_class *class = ofproto_classes[i];
375 class->enumerate_types(&types);
376 found = sset_contains(&types, type);
377 sset_destroy(&types);
383 VLOG_WARN("unknown datapath type %s", type);
387 /* Registers a new ofproto class. After successful registration, new ofprotos
388 * of that type can be created using ofproto_create(). */
390 ofproto_class_register(const struct ofproto_class *new_class)
394 for (i = 0; i < n_ofproto_classes; i++) {
395 if (ofproto_classes[i] == new_class) {
400 if (n_ofproto_classes >= allocated_ofproto_classes) {
401 ofproto_classes = x2nrealloc(ofproto_classes,
402 &allocated_ofproto_classes,
403 sizeof *ofproto_classes);
405 ofproto_classes[n_ofproto_classes++] = new_class;
409 /* Unregisters a datapath provider. 'type' must have been previously
410 * registered and not currently be in use by any ofprotos. After
411 * unregistration new datapaths of that type cannot be opened using
412 * ofproto_create(). */
414 ofproto_class_unregister(const struct ofproto_class *class)
418 for (i = 0; i < n_ofproto_classes; i++) {
419 if (ofproto_classes[i] == class) {
420 for (i++; i < n_ofproto_classes; i++) {
421 ofproto_classes[i - 1] = ofproto_classes[i];
427 VLOG_WARN("attempted to unregister an ofproto class that is not "
432 /* Clears 'types' and enumerates all registered ofproto types into it. The
433 * caller must first initialize the sset. */
435 ofproto_enumerate_types(struct sset *types)
440 for (i = 0; i < n_ofproto_classes; i++) {
441 ofproto_classes[i]->enumerate_types(types);
445 /* Returns the fully spelled out name for the given ofproto 'type'.
447 * Normalized type string can be compared with strcmp(). Unnormalized type
448 * string might be the same even if they have different spellings. */
450 ofproto_normalize_type(const char *type)
452 return type && type[0] ? type : "system";
455 /* Clears 'names' and enumerates the names of all known created ofprotos with
456 * the given 'type'. The caller must first initialize the sset. Returns 0 if
457 * successful, otherwise a positive errno value.
459 * Some kinds of datapaths might not be practically enumerable. This is not
460 * considered an error. */
462 ofproto_enumerate_names(const char *type, struct sset *names)
464 const struct ofproto_class *class = ofproto_class_find__(type);
465 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
469 ofproto_create(const char *datapath_name, const char *datapath_type,
470 struct ofproto **ofprotop)
472 const struct ofproto_class *class;
473 struct ofproto *ofproto;
479 ofproto_unixctl_init();
481 datapath_type = ofproto_normalize_type(datapath_type);
482 class = ofproto_class_find__(datapath_type);
484 VLOG_WARN("could not create datapath %s of unknown type %s",
485 datapath_name, datapath_type);
489 ofproto = class->alloc();
491 VLOG_ERR("failed to allocate datapath %s of type %s",
492 datapath_name, datapath_type);
497 ovs_mutex_lock(&ofproto_mutex);
498 memset(ofproto, 0, sizeof *ofproto);
499 ofproto->ofproto_class = class;
500 ofproto->name = xstrdup(datapath_name);
501 ofproto->type = xstrdup(datapath_type);
502 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
503 hash_string(ofproto->name, 0));
504 ofproto->datapath_id = 0;
505 ofproto->forward_bpdu = false;
506 ofproto->fallback_dpid = pick_fallback_dpid();
507 ofproto->mfr_desc = NULL;
508 ofproto->hw_desc = NULL;
509 ofproto->sw_desc = NULL;
510 ofproto->serial_desc = NULL;
511 ofproto->dp_desc = NULL;
512 ofproto->frag_handling = OFPC_FRAG_NORMAL;
513 hmap_init(&ofproto->ports);
514 hmap_init(&ofproto->ofport_usage);
515 shash_init(&ofproto->port_by_name);
516 simap_init(&ofproto->ofp_requests);
517 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
518 ofproto->eviction_group_timer = LLONG_MIN;
519 ofproto->tables = NULL;
520 ofproto->n_tables = 0;
521 hindex_init(&ofproto->cookies);
522 list_init(&ofproto->expirable);
523 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
524 ofproto->state = S_OPENFLOW;
525 list_init(&ofproto->pending);
526 ofproto->n_pending = 0;
527 hmap_init(&ofproto->deletions);
528 guarded_list_init(&ofproto->rule_executes);
529 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
530 ofproto->first_op = ofproto->last_op = LLONG_MIN;
531 ofproto->next_op_report = LLONG_MAX;
532 ofproto->op_backoff = LLONG_MIN;
533 ofproto->vlan_bitmap = NULL;
534 ofproto->vlans_changed = false;
535 ofproto->min_mtu = INT_MAX;
536 ovs_rwlock_init(&ofproto->groups_rwlock);
537 hmap_init(&ofproto->groups);
538 ovs_mutex_unlock(&ofproto_mutex);
539 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
540 OFPGFC_SELECT_WEIGHT;
541 ofproto->ogf.max_groups[OFPGT11_ALL] = OFPG_MAX;
542 ofproto->ogf.max_groups[OFPGT11_SELECT] = OFPG_MAX;
543 ofproto->ogf.max_groups[OFPGT11_INDIRECT] = OFPG_MAX;
544 ofproto->ogf.max_groups[OFPGT11_FF] = OFPG_MAX;
545 ofproto->ogf.actions[0] =
546 (1 << OFPAT11_OUTPUT) |
547 (1 << OFPAT11_COPY_TTL_OUT) |
548 (1 << OFPAT11_COPY_TTL_IN) |
549 (1 << OFPAT11_SET_MPLS_TTL) |
550 (1 << OFPAT11_DEC_MPLS_TTL) |
551 (1 << OFPAT11_PUSH_VLAN) |
552 (1 << OFPAT11_POP_VLAN) |
553 (1 << OFPAT11_PUSH_MPLS) |
554 (1 << OFPAT11_POP_MPLS) |
555 (1 << OFPAT11_SET_QUEUE) |
556 (1 << OFPAT11_GROUP) |
557 (1 << OFPAT11_SET_NW_TTL) |
558 (1 << OFPAT11_DEC_NW_TTL) |
559 (1 << OFPAT12_SET_FIELD);
561 * (1 << OFPAT13_PUSH_PBB) |
562 * (1 << OFPAT13_POP_PBB) */
564 error = ofproto->ofproto_class->construct(ofproto);
566 VLOG_ERR("failed to open datapath %s: %s",
567 datapath_name, ovs_strerror(error));
568 ofproto_destroy__(ofproto);
572 /* Check that hidden tables, if any, are at the end. */
573 ovs_assert(ofproto->n_tables);
574 for (i = 0; i + 1 < ofproto->n_tables; i++) {
575 enum oftable_flags flags = ofproto->tables[i].flags;
576 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
578 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
581 ofproto->datapath_id = pick_datapath_id(ofproto);
584 /* Initialize meters table. */
585 if (ofproto->ofproto_class->meter_get_features) {
586 ofproto->ofproto_class->meter_get_features(ofproto,
587 &ofproto->meter_features);
589 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
591 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
592 * sizeof(struct meter *));
598 /* Must be called (only) by an ofproto implementation in its constructor
599 * function. See the large comment on 'construct' in struct ofproto_class for
602 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
604 struct oftable *table;
606 ovs_assert(!ofproto->n_tables);
607 ovs_assert(n_tables >= 1 && n_tables <= 255);
609 ofproto->n_tables = n_tables;
610 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
611 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
616 /* To be optionally called (only) by an ofproto implementation in its
617 * constructor function. See the large comment on 'construct' in struct
618 * ofproto_class for details.
620 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
621 * will then ensure that actions passed into the ofproto implementation will
622 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
623 * function is not called, there will be no such restriction.
625 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
626 * the 'max_ports' restriction. */
628 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
630 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
631 ofproto->max_ports = max_ports;
635 ofproto_get_datapath_id(const struct ofproto *ofproto)
637 return ofproto->datapath_id;
641 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
643 uint64_t old_dpid = p->datapath_id;
644 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
645 if (p->datapath_id != old_dpid) {
646 /* Force all active connections to reconnect, since there is no way to
647 * notify a controller that the datapath ID has changed. */
648 ofproto_reconnect_controllers(p);
653 ofproto_set_controllers(struct ofproto *p,
654 const struct ofproto_controller *controllers,
655 size_t n_controllers, uint32_t allowed_versions)
657 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
662 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
664 connmgr_set_fail_mode(p->connmgr, fail_mode);
667 /* Drops the connections between 'ofproto' and all of its controllers, forcing
668 * them to reconnect. */
670 ofproto_reconnect_controllers(struct ofproto *ofproto)
672 connmgr_reconnect(ofproto->connmgr);
675 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
676 * in-band control should guarantee access, in the same way that in-band
677 * control guarantees access to OpenFlow controllers. */
679 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
680 const struct sockaddr_in *extras, size_t n)
682 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
685 /* Sets the OpenFlow queue used by flows set up by in-band control on
686 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
687 * flows will use the default queue. */
689 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
691 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
694 /* Sets the number of flows at which eviction from the kernel flow table
697 ofproto_set_flow_limit(unsigned limit)
699 ofproto_flow_limit = limit;
702 /* Sets the maximum idle time for flows in the datapath before they are
705 ofproto_set_max_idle(unsigned max_idle)
707 ofproto_max_idle = max_idle;
710 /* If forward_bpdu is true, the NORMAL action will forward frames with
711 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
712 * the NORMAL action will drop these frames. */
714 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
716 bool old_val = ofproto->forward_bpdu;
717 ofproto->forward_bpdu = forward_bpdu;
718 if (old_val != ofproto->forward_bpdu) {
719 if (ofproto->ofproto_class->forward_bpdu_changed) {
720 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
725 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
726 * 'idle_time', in seconds, and the maximum number of MAC table entries to
729 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
732 if (ofproto->ofproto_class->set_mac_table_config) {
733 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
739 ofproto_set_threads(int n_handlers_, int n_revalidators_)
741 int threads = MAX(count_cpu_cores(), 2);
743 n_revalidators = MAX(n_revalidators_, 0);
744 n_handlers = MAX(n_handlers_, 0);
746 if (!n_revalidators) {
747 n_revalidators = n_handlers
748 ? MAX(threads - (int) n_handlers, 1)
753 n_handlers = MAX(threads - (int) n_revalidators, 1);
758 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
761 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
765 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
767 return connmgr_set_snoops(ofproto->connmgr, snoops);
771 ofproto_set_netflow(struct ofproto *ofproto,
772 const struct netflow_options *nf_options)
774 if (nf_options && sset_is_empty(&nf_options->collectors)) {
778 if (ofproto->ofproto_class->set_netflow) {
779 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
781 return nf_options ? EOPNOTSUPP : 0;
786 ofproto_set_sflow(struct ofproto *ofproto,
787 const struct ofproto_sflow_options *oso)
789 if (oso && sset_is_empty(&oso->targets)) {
793 if (ofproto->ofproto_class->set_sflow) {
794 return ofproto->ofproto_class->set_sflow(ofproto, oso);
796 return oso ? EOPNOTSUPP : 0;
801 ofproto_set_ipfix(struct ofproto *ofproto,
802 const struct ofproto_ipfix_bridge_exporter_options *bo,
803 const struct ofproto_ipfix_flow_exporter_options *fo,
806 if (ofproto->ofproto_class->set_ipfix) {
807 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
809 return (bo || fo) ? EOPNOTSUPP : 0;
814 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
816 flow_restore_wait = flow_restore_wait_db;
820 ofproto_get_flow_restore_wait(void)
822 return flow_restore_wait;
826 /* Spanning Tree Protocol (STP) configuration. */
828 /* Configures STP on 'ofproto' using the settings defined in 's'. If
829 * 's' is NULL, disables STP.
831 * Returns 0 if successful, otherwise a positive errno value. */
833 ofproto_set_stp(struct ofproto *ofproto,
834 const struct ofproto_stp_settings *s)
836 return (ofproto->ofproto_class->set_stp
837 ? ofproto->ofproto_class->set_stp(ofproto, s)
841 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
842 * 'enabled' member of 's' is false, then the other members are not
845 * Returns 0 if successful, otherwise a positive errno value. */
847 ofproto_get_stp_status(struct ofproto *ofproto,
848 struct ofproto_stp_status *s)
850 return (ofproto->ofproto_class->get_stp_status
851 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
855 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
856 * in 's'. The caller is responsible for assigning STP port numbers
857 * (using the 'port_num' member in the range of 1 through 255, inclusive)
858 * and ensuring there are no duplicates. If the 's' is NULL, then STP
859 * is disabled on the port.
861 * Returns 0 if successful, otherwise a positive errno value.*/
863 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
864 const struct ofproto_port_stp_settings *s)
866 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
868 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
869 ofproto->name, ofp_port);
873 return (ofproto->ofproto_class->set_stp_port
874 ? ofproto->ofproto_class->set_stp_port(ofport, s)
878 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
879 * 's'. If the 'enabled' member in 's' is false, then the other members
880 * are not meaningful.
882 * Returns 0 if successful, otherwise a positive errno value.*/
884 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
885 struct ofproto_port_stp_status *s)
887 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
889 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
890 "port %"PRIu16, ofproto->name, ofp_port);
894 return (ofproto->ofproto_class->get_stp_port_status
895 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
899 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
900 * 's'. If the 'enabled' member in 's' is false, then the other members
901 * are not meaningful.
903 * Returns 0 if successful, otherwise a positive errno value.*/
905 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
906 struct ofproto_port_stp_stats *s)
908 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
910 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
911 "port %"PRIu16, ofproto->name, ofp_port);
915 return (ofproto->ofproto_class->get_stp_port_stats
916 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
920 /* Queue DSCP configuration. */
922 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
923 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
924 * to implement QoS. Instead, it is used to implement features which require
925 * knowledge of what queues exist on a port, and some basic information about
928 * Returns 0 if successful, otherwise a positive errno value. */
930 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
931 const struct ofproto_port_queue *queues,
934 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
937 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
938 ofproto->name, ofp_port);
942 return (ofproto->ofproto_class->set_queues
943 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
947 /* Connectivity Fault Management configuration. */
949 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
951 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
953 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
954 if (ofport && ofproto->ofproto_class->set_cfm) {
955 ofproto->ofproto_class->set_cfm(ofport, NULL);
959 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
960 * basic configuration from the configuration members in 'cfm', and the remote
961 * maintenance point ID from remote_mpid. Ignores the statistics members of
964 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
966 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
967 const struct cfm_settings *s)
969 struct ofport *ofport;
972 ofport = ofproto_get_port(ofproto, ofp_port);
974 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
975 ofproto->name, ofp_port);
979 /* XXX: For configuration simplicity, we only support one remote_mpid
980 * outside of the CFM module. It's not clear if this is the correct long
981 * term solution or not. */
982 error = (ofproto->ofproto_class->set_cfm
983 ? ofproto->ofproto_class->set_cfm(ofport, s)
986 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
987 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
988 ovs_strerror(error));
992 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
993 * 'ofproto' does not have a port 'ofp_port'. */
995 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
996 const struct smap *cfg)
998 struct ofport *ofport;
1001 ofport = ofproto_get_port(ofproto, ofp_port);
1003 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1004 ofproto->name, ofp_port);
1008 error = (ofproto->ofproto_class->set_bfd
1009 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1012 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1013 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1014 ovs_strerror(error));
1018 /* Populates 'status' with key value pairs indicating the status of the BFD
1019 * session on 'ofp_port'. This information is intended to be populated in the
1020 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
1023 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1024 struct smap *status)
1026 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1027 return (ofport && ofproto->ofproto_class->get_bfd_status
1028 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1032 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1033 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1034 * 0 if LACP partner information is not current (generally indicating a
1035 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1037 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1039 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1040 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1041 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1047 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1048 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1049 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1050 * configuration plus, if there is more than one slave, a bonding
1053 * If 'aux' is already registered then this function updates its configuration
1054 * to 's'. Otherwise, this function registers a new bundle.
1056 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1059 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1060 const struct ofproto_bundle_settings *s)
1062 return (ofproto->ofproto_class->bundle_set
1063 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1067 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1068 * If no such bundle has been registered, this has no effect. */
1070 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1072 return ofproto_bundle_register(ofproto, aux, NULL);
1076 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1077 * If 'aux' is already registered then this function updates its configuration
1078 * to 's'. Otherwise, this function registers a new mirror. */
1080 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1081 const struct ofproto_mirror_settings *s)
1083 return (ofproto->ofproto_class->mirror_set
1084 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1088 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1089 * If no mirror has been registered, this has no effect. */
1091 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1093 return ofproto_mirror_register(ofproto, aux, NULL);
1096 /* Retrieves statistics from mirror associated with client data pointer
1097 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1098 * 'bytes', respectively. If a particular counters is not supported,
1099 * the appropriate argument is set to UINT64_MAX. */
1101 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1102 uint64_t *packets, uint64_t *bytes)
1104 if (!ofproto->ofproto_class->mirror_get_stats) {
1105 *packets = *bytes = UINT64_MAX;
1109 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1113 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1114 * which all packets are flooded, instead of using MAC learning. If
1115 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1117 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1120 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1122 return (ofproto->ofproto_class->set_flood_vlans
1123 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1127 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1128 * output for a mirror. */
1130 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1132 return (ofproto->ofproto_class->is_mirror_output_bundle
1133 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1137 /* Configuration of OpenFlow tables. */
1139 /* Returns the number of OpenFlow tables in 'ofproto'. */
1141 ofproto_get_n_tables(const struct ofproto *ofproto)
1143 return ofproto->n_tables;
1146 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1147 * settings from 's'. 'table_id' must be in the range 0 through the number of
1148 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1150 * For read-only tables, only the name may be configured. */
1152 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1153 const struct ofproto_table_settings *s)
1155 struct oftable *table;
1157 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1158 table = &ofproto->tables[table_id];
1160 oftable_set_name(table, s->name);
1162 if (table->flags & OFTABLE_READONLY) {
1167 oftable_enable_eviction(table, s->groups, s->n_groups);
1169 oftable_disable_eviction(table);
1172 table->max_flows = s->max_flows;
1173 fat_rwlock_wrlock(&table->cls.rwlock);
1174 if (classifier_count(&table->cls) > table->max_flows
1175 && table->eviction_fields) {
1176 /* 'table' contains more flows than allowed. We might not be able to
1177 * evict them right away because of the asynchronous nature of flow
1178 * table changes. Schedule eviction for later. */
1179 switch (ofproto->state) {
1181 ofproto->state = S_EVICT;
1185 /* We're already deleting flows, nothing more to do. */
1190 classifier_set_prefix_fields(&table->cls,
1191 s->prefix_fields, s->n_prefix_fields);
1193 fat_rwlock_unlock(&table->cls.rwlock);
1197 ofproto_has_snoops(const struct ofproto *ofproto)
1199 return connmgr_has_snoops(ofproto->connmgr);
1203 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1205 connmgr_get_snoops(ofproto->connmgr, snoops);
1209 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1211 OVS_REQUIRES(ofproto_mutex)
1213 struct ofopgroup *group;
1215 ovs_assert(!rule->pending);
1217 group = ofopgroup_create_unattached(ofproto);
1218 delete_flow__(rule, group, reason);
1219 ofopgroup_submit(group);
1222 /* Deletes 'rule' from 'ofproto'.
1224 * Within an ofproto implementation, this function allows an ofproto
1225 * implementation to destroy any rules that remain when its ->destruct()
1226 * function is called. This function is not suitable for use elsewhere in an
1227 * ofproto implementation.
1229 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1230 * Cycle" in ofproto-provider.h. */
1232 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1233 OVS_EXCLUDED(ofproto_mutex)
1235 struct ofopgroup *group;
1237 ovs_mutex_lock(&ofproto_mutex);
1238 ovs_assert(!rule->pending);
1240 group = ofopgroup_create_unattached(ofproto);
1241 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1242 oftable_remove_rule__(ofproto, rule);
1243 ofproto->ofproto_class->rule_delete(rule);
1244 ofopgroup_submit(group);
1246 ovs_mutex_unlock(&ofproto_mutex);
1250 ofproto_flush__(struct ofproto *ofproto)
1251 OVS_EXCLUDED(ofproto_mutex)
1253 struct oftable *table;
1255 if (ofproto->ofproto_class->flush) {
1256 ofproto->ofproto_class->flush(ofproto);
1259 ovs_mutex_lock(&ofproto_mutex);
1260 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1261 struct rule *rule, *next_rule;
1262 struct cls_cursor cursor;
1264 if (table->flags & OFTABLE_HIDDEN) {
1268 fat_rwlock_rdlock(&table->cls.rwlock);
1269 cls_cursor_init(&cursor, &table->cls, NULL);
1270 fat_rwlock_unlock(&table->cls.rwlock);
1271 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1272 if (!rule->pending) {
1273 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1277 ovs_mutex_unlock(&ofproto_mutex);
1280 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1283 ofproto_destroy__(struct ofproto *ofproto)
1284 OVS_EXCLUDED(ofproto_mutex)
1286 struct oftable *table;
1288 ovs_assert(list_is_empty(&ofproto->pending));
1290 destroy_rule_executes(ofproto);
1291 guarded_list_destroy(&ofproto->rule_executes);
1293 delete_group(ofproto, OFPG_ALL);
1294 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1295 hmap_destroy(&ofproto->groups);
1297 connmgr_destroy(ofproto->connmgr);
1299 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1300 free(ofproto->name);
1301 free(ofproto->type);
1302 free(ofproto->mfr_desc);
1303 free(ofproto->hw_desc);
1304 free(ofproto->sw_desc);
1305 free(ofproto->serial_desc);
1306 free(ofproto->dp_desc);
1307 hmap_destroy(&ofproto->ports);
1308 hmap_destroy(&ofproto->ofport_usage);
1309 shash_destroy(&ofproto->port_by_name);
1310 simap_destroy(&ofproto->ofp_requests);
1312 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1313 oftable_destroy(table);
1315 free(ofproto->tables);
1317 hmap_destroy(&ofproto->deletions);
1319 free(ofproto->vlan_bitmap);
1321 ofproto->ofproto_class->dealloc(ofproto);
1325 ofproto_destroy(struct ofproto *p)
1326 OVS_EXCLUDED(ofproto_mutex)
1328 struct ofport *ofport, *next_ofport;
1329 struct ofport_usage *usage, *next_usage;
1336 meter_delete(p, 1, p->meter_features.max_meters);
1337 p->meter_features.max_meters = 0;
1343 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1344 ofport_destroy(ofport);
1347 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1348 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1352 p->ofproto_class->destruct(p);
1353 ofproto_destroy__(p);
1356 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1357 * kernel datapath, for example, this destroys the datapath in the kernel, and
1358 * with the netdev-based datapath, it tears down the data structures that
1359 * represent the datapath.
1361 * The datapath should not be currently open as an ofproto. */
1363 ofproto_delete(const char *name, const char *type)
1365 const struct ofproto_class *class = ofproto_class_find__(type);
1366 return (!class ? EAFNOSUPPORT
1367 : !class->del ? EACCES
1368 : class->del(type, name));
1372 process_port_change(struct ofproto *ofproto, int error, char *devname)
1374 if (error == ENOBUFS) {
1375 reinit_ports(ofproto);
1376 } else if (!error) {
1377 update_port(ofproto, devname);
1383 ofproto_type_run(const char *datapath_type)
1385 const struct ofproto_class *class;
1388 datapath_type = ofproto_normalize_type(datapath_type);
1389 class = ofproto_class_find__(datapath_type);
1391 error = class->type_run ? class->type_run(datapath_type) : 0;
1392 if (error && error != EAGAIN) {
1393 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1394 datapath_type, ovs_strerror(error));
1400 ofproto_type_wait(const char *datapath_type)
1402 const struct ofproto_class *class;
1404 datapath_type = ofproto_normalize_type(datapath_type);
1405 class = ofproto_class_find__(datapath_type);
1407 if (class->type_wait) {
1408 class->type_wait(datapath_type);
1413 any_pending_ops(const struct ofproto *p)
1414 OVS_EXCLUDED(ofproto_mutex)
1418 ovs_mutex_lock(&ofproto_mutex);
1419 b = !list_is_empty(&p->pending);
1420 ovs_mutex_unlock(&ofproto_mutex);
1426 ofproto_run(struct ofproto *p)
1431 error = p->ofproto_class->run(p);
1432 if (error && error != EAGAIN) {
1433 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1436 run_rule_executes(p);
1438 /* Restore the eviction group heap invariant occasionally. */
1439 if (p->eviction_group_timer < time_msec()) {
1442 p->eviction_group_timer = time_msec() + 1000;
1444 for (i = 0; i < p->n_tables; i++) {
1445 struct oftable *table = &p->tables[i];
1446 struct eviction_group *evg;
1447 struct cls_cursor cursor;
1450 if (!table->eviction_fields) {
1454 ovs_mutex_lock(&ofproto_mutex);
1455 fat_rwlock_rdlock(&table->cls.rwlock);
1456 cls_cursor_init(&cursor, &table->cls, NULL);
1457 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1458 if (rule->idle_timeout || rule->hard_timeout) {
1459 if (!rule->eviction_group) {
1460 eviction_group_add_rule(rule);
1462 heap_raw_change(&rule->evg_node,
1463 rule_eviction_priority(p, rule));
1467 fat_rwlock_unlock(&table->cls.rwlock);
1469 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1470 heap_rebuild(&evg->rules);
1472 ovs_mutex_unlock(&ofproto_mutex);
1476 if (p->ofproto_class->port_poll) {
1479 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1480 process_port_change(p, error, devname);
1484 new_seq = seq_read(connectivity_seq_get());
1485 if (new_seq != p->change_seq) {
1486 struct sset devnames;
1487 const char *devname;
1488 struct ofport *ofport;
1490 /* Update OpenFlow port status for any port whose netdev has changed.
1492 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1493 * destroyed, so it's not safe to update ports directly from the
1494 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1495 * need this two-phase approach. */
1496 sset_init(&devnames);
1497 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1498 sset_add(&devnames, netdev_get_name(ofport->netdev));
1500 SSET_FOR_EACH (devname, &devnames) {
1501 update_port(p, devname);
1503 sset_destroy(&devnames);
1505 p->change_seq = new_seq;
1510 connmgr_run(p->connmgr, handle_openflow);
1514 connmgr_run(p->connmgr, NULL);
1516 if (!any_pending_ops(p)) {
1517 p->state = S_OPENFLOW;
1522 connmgr_run(p->connmgr, NULL);
1524 if (!any_pending_ops(p)) {
1525 connmgr_flushed(p->connmgr);
1526 p->state = S_OPENFLOW;
1534 if (time_msec() >= p->next_op_report) {
1535 long long int ago = (time_msec() - p->first_op) / 1000;
1536 long long int interval = (p->last_op - p->first_op) / 1000;
1540 ds_put_format(&s, "%d flow_mods ",
1541 p->n_add + p->n_delete + p->n_modify);
1542 if (interval == ago) {
1543 ds_put_format(&s, "in the last %lld s", ago);
1544 } else if (interval) {
1545 ds_put_format(&s, "in the %lld s starting %lld s ago",
1548 ds_put_format(&s, "%lld s ago", ago);
1551 ds_put_cstr(&s, " (");
1553 ds_put_format(&s, "%d adds, ", p->n_add);
1556 ds_put_format(&s, "%d deletes, ", p->n_delete);
1559 ds_put_format(&s, "%d modifications, ", p->n_modify);
1562 ds_put_char(&s, ')');
1564 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1567 p->n_add = p->n_delete = p->n_modify = 0;
1568 p->next_op_report = LLONG_MAX;
1575 ofproto_wait(struct ofproto *p)
1577 p->ofproto_class->wait(p);
1578 if (p->ofproto_class->port_poll_wait) {
1579 p->ofproto_class->port_poll_wait(p);
1581 seq_wait(connectivity_seq_get(), p->change_seq);
1585 connmgr_wait(p->connmgr, true);
1590 connmgr_wait(p->connmgr, false);
1591 if (!any_pending_ops(p)) {
1592 poll_immediate_wake();
1599 ofproto_is_alive(const struct ofproto *p)
1601 return connmgr_has_controllers(p->connmgr);
1604 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1605 * memory_report(). */
1607 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1609 const struct oftable *table;
1610 unsigned int n_rules;
1612 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1614 ovs_mutex_lock(&ofproto_mutex);
1615 simap_increase(usage, "ops",
1616 ofproto->n_pending + hmap_count(&ofproto->deletions));
1617 ovs_mutex_unlock(&ofproto_mutex);
1620 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1621 fat_rwlock_rdlock(&table->cls.rwlock);
1622 n_rules += classifier_count(&table->cls);
1623 fat_rwlock_unlock(&table->cls.rwlock);
1625 simap_increase(usage, "rules", n_rules);
1627 if (ofproto->ofproto_class->get_memory_usage) {
1628 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1631 connmgr_get_memory_usage(ofproto->connmgr, usage);
1635 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1637 const struct ofproto_class *class;
1639 datapath_type = ofproto_normalize_type(datapath_type);
1640 class = ofproto_class_find__(datapath_type);
1642 if (class && class->type_get_memory_usage) {
1643 class->type_get_memory_usage(datapath_type, usage);
1648 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1651 connmgr_get_controller_info(ofproto->connmgr, info);
1655 ofproto_free_ofproto_controller_info(struct shash *info)
1657 connmgr_free_controller_info(info);
1660 /* Makes a deep copy of 'old' into 'port'. */
1662 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1664 port->name = xstrdup(old->name);
1665 port->type = xstrdup(old->type);
1666 port->ofp_port = old->ofp_port;
1669 /* Frees memory allocated to members of 'ofproto_port'.
1671 * Do not call this function on an ofproto_port obtained from
1672 * ofproto_port_dump_next(): that function retains ownership of the data in the
1675 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1677 free(ofproto_port->name);
1678 free(ofproto_port->type);
1681 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1683 * This function provides no status indication. An error status for the entire
1684 * dump operation is provided when it is completed by calling
1685 * ofproto_port_dump_done().
1688 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1689 const struct ofproto *ofproto)
1691 dump->ofproto = ofproto;
1692 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1696 /* Attempts to retrieve another port from 'dump', which must have been created
1697 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1698 * 'port' and returns true. On failure, returns false.
1700 * Failure might indicate an actual error or merely that the last port has been
1701 * dumped. An error status for the entire dump operation is provided when it
1702 * is completed by calling ofproto_port_dump_done().
1704 * The ofproto owns the data stored in 'port'. It will remain valid until at
1705 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1706 * ofproto_port_dump_done(). */
1708 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1709 struct ofproto_port *port)
1711 const struct ofproto *ofproto = dump->ofproto;
1717 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1720 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1726 /* Completes port table dump operation 'dump', which must have been created
1727 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1728 * error-free, otherwise a positive errno value describing the problem. */
1730 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1732 const struct ofproto *ofproto = dump->ofproto;
1734 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1737 return dump->error == EOF ? 0 : dump->error;
1740 /* Returns the type to pass to netdev_open() when a datapath of type
1741 * 'datapath_type' has a port of type 'port_type', for a few special
1742 * cases when a netdev type differs from a port type. For example, when
1743 * using the userspace datapath, a port of type "internal" needs to be
1746 * Returns either 'type' itself or a string literal, which must not be
1749 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1751 const struct ofproto_class *class;
1753 datapath_type = ofproto_normalize_type(datapath_type);
1754 class = ofproto_class_find__(datapath_type);
1759 return (class->port_open_type
1760 ? class->port_open_type(datapath_type, port_type)
1764 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1765 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1766 * the port's OpenFlow port number.
1768 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1769 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1770 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1771 * 'ofp_portp' is non-null). */
1773 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1774 ofp_port_t *ofp_portp)
1776 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1779 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1781 const char *netdev_name = netdev_get_name(netdev);
1783 simap_put(&ofproto->ofp_requests, netdev_name,
1784 ofp_to_u16(ofp_port));
1785 update_port(ofproto, netdev_name);
1788 *ofp_portp = OFPP_NONE;
1790 struct ofproto_port ofproto_port;
1792 error = ofproto_port_query_by_name(ofproto,
1793 netdev_get_name(netdev),
1796 *ofp_portp = ofproto_port.ofp_port;
1797 ofproto_port_destroy(&ofproto_port);
1804 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1805 * initializes '*port' appropriately; on failure, returns a positive errno
1808 * The caller owns the data in 'ofproto_port' and must free it with
1809 * ofproto_port_destroy() when it is no longer needed. */
1811 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1812 struct ofproto_port *port)
1816 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1818 memset(port, 0, sizeof *port);
1823 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1824 * Returns 0 if successful, otherwise a positive errno. */
1826 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1828 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1829 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1830 struct simap_node *ofp_request_node;
1833 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1834 if (ofp_request_node) {
1835 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1838 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1839 if (!error && ofport) {
1840 /* 'name' is the netdev's name and update_port() is going to close the
1841 * netdev. Just in case update_port() refers to 'name' after it
1842 * destroys 'ofport', make a copy of it around the update_port()
1844 char *devname = xstrdup(name);
1845 update_port(ofproto, devname);
1852 flow_mod_init(struct ofputil_flow_mod *fm,
1853 const struct match *match, unsigned int priority,
1854 const struct ofpact *ofpacts, size_t ofpacts_len,
1855 enum ofp_flow_mod_command command)
1857 memset(fm, 0, sizeof *fm);
1859 fm->priority = priority;
1862 fm->modify_cookie = false;
1864 fm->command = command;
1865 fm->idle_timeout = 0;
1866 fm->hard_timeout = 0;
1867 fm->buffer_id = UINT32_MAX;
1868 fm->out_port = OFPP_ANY;
1869 fm->out_group = OFPG_ANY;
1871 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1872 fm->ofpacts_len = ofpacts_len;
1876 simple_flow_mod(struct ofproto *ofproto,
1877 const struct match *match, unsigned int priority,
1878 const struct ofpact *ofpacts, size_t ofpacts_len,
1879 enum ofp_flow_mod_command command)
1881 struct ofputil_flow_mod fm;
1883 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1885 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1888 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1889 * performs the 'n_actions' actions in 'actions'. The new flow will not
1892 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1893 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1894 * controllers; otherwise, it will be hidden.
1896 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1898 * This is a helper function for in-band control and fail-open. */
1900 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1901 unsigned int priority,
1902 const struct ofpact *ofpacts, size_t ofpacts_len)
1903 OVS_EXCLUDED(ofproto_mutex)
1905 const struct rule *rule;
1908 /* First do a cheap check whether the rule we're looking for already exists
1909 * with the actions that we want. If it does, then we're done. */
1910 fat_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1911 rule = rule_from_cls_rule(classifier_find_match_exactly(
1912 &ofproto->tables[0].cls, match, priority));
1914 struct rule_actions *actions = rule_get_actions(rule);
1915 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1916 ofpacts, ofpacts_len);
1920 fat_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1922 /* If there's no such rule or the rule doesn't have the actions we want,
1923 * fall back to a executing a full flow mod. We can't optimize this at
1924 * all because we didn't take enough locks above to ensure that the flow
1925 * table didn't already change beneath us. */
1927 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1928 OFPFC_MODIFY_STRICT);
1932 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1933 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1934 * operation cannot be initiated now but may be retried later.
1936 * This is a helper function for in-band control and fail-open and the "learn"
1939 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1940 OVS_EXCLUDED(ofproto_mutex)
1942 /* Optimize for the most common case of a repeated learn action.
1943 * If an identical flow already exists we only need to update its
1944 * 'modified' time. */
1945 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1946 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1947 struct oftable *table = &ofproto->tables[fm->table_id];
1948 struct cls_rule match_rule;
1952 cls_rule_init(&match_rule, &fm->match, fm->priority);
1953 fat_rwlock_rdlock(&table->cls.rwlock);
1954 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
1957 /* Reading many of the rule fields and writing on 'modified'
1958 * requires the rule->mutex. Also, rule->actions may change
1959 * if rule->mutex is not held. */
1960 const struct rule_actions *actions;
1962 ovs_mutex_lock(&rule->mutex);
1963 actions = rule_get_actions(rule);
1964 if (rule->idle_timeout == fm->idle_timeout
1965 && rule->hard_timeout == fm->hard_timeout
1966 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1967 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1968 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
1969 actions->ofpacts, actions->ofpacts_len)) {
1970 /* Rule already exists and need not change, only update the
1971 modified timestamp. */
1972 rule->modified = time_msec();
1975 ovs_mutex_unlock(&rule->mutex);
1977 fat_rwlock_unlock(&table->cls.rwlock);
1984 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1987 /* Searches for a rule with matching criteria exactly equal to 'target' in
1988 * ofproto's table 0 and, if it finds one, deletes it.
1990 * This is a helper function for in-band control and fail-open. */
1992 ofproto_delete_flow(struct ofproto *ofproto,
1993 const struct match *target, unsigned int priority)
1994 OVS_EXCLUDED(ofproto_mutex)
1996 struct classifier *cls = &ofproto->tables[0].cls;
1999 /* First do a cheap check whether the rule we're looking for has already
2000 * been deleted. If so, then we're done. */
2001 fat_rwlock_rdlock(&cls->rwlock);
2002 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2004 fat_rwlock_unlock(&cls->rwlock);
2009 /* Fall back to a executing a full flow mod. We can't optimize this at all
2010 * because we didn't take enough locks above to ensure that the flow table
2011 * didn't already change beneath us. */
2012 return simple_flow_mod(ofproto, target, priority, NULL, 0,
2013 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
2016 /* Starts the process of deleting all of the flows from all of ofproto's flow
2017 * tables and then reintroducing the flows required by in-band control and
2018 * fail-open. The process will complete in a later call to ofproto_run(). */
2020 ofproto_flush_flows(struct ofproto *ofproto)
2022 COVERAGE_INC(ofproto_flush);
2023 ofproto->state = S_FLUSH;
2027 reinit_ports(struct ofproto *p)
2029 struct ofproto_port_dump dump;
2030 struct sset devnames;
2031 struct ofport *ofport;
2032 struct ofproto_port ofproto_port;
2033 const char *devname;
2035 COVERAGE_INC(ofproto_reinit_ports);
2037 sset_init(&devnames);
2038 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2039 sset_add(&devnames, netdev_get_name(ofport->netdev));
2041 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2042 sset_add(&devnames, ofproto_port.name);
2045 SSET_FOR_EACH (devname, &devnames) {
2046 update_port(p, devname);
2048 sset_destroy(&devnames);
2052 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2056 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2057 port_idx = port_idx ? port_idx : UINT16_MAX;
2059 if (port_idx >= ofproto->max_ports
2060 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2061 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2062 long long int last_used_at, lru = LLONG_MAX;
2064 /* Search for a free OpenFlow port number. We try not to
2065 * immediately reuse them to prevent problems due to old
2068 * We limit the automatically assigned port numbers to the lower half
2069 * of the port range, to reserve the upper half for assignment by
2072 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2073 ofproto->alloc_port_no = 1;
2075 last_used_at = ofport_get_usage(ofproto,
2076 u16_to_ofp(ofproto->alloc_port_no));
2077 if (!last_used_at) {
2078 port_idx = ofproto->alloc_port_no;
2080 } else if ( last_used_at < time_msec() - 60*60*1000) {
2081 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2082 * more than an hour ago, consider it usable. */
2083 ofport_remove_usage(ofproto,
2084 u16_to_ofp(ofproto->alloc_port_no));
2085 port_idx = ofproto->alloc_port_no;
2087 } else if (last_used_at < lru) {
2089 lru_ofport = ofproto->alloc_port_no;
2092 if (ofproto->alloc_port_no == end_port_no) {
2094 port_idx = lru_ofport;
2101 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2102 return u16_to_ofp(port_idx);
2106 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2108 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2109 ofport_set_usage(ofproto, ofp_port, time_msec());
2113 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2114 * pointer if the netdev cannot be opened. On success, also fills in
2116 static struct netdev *
2117 ofport_open(struct ofproto *ofproto,
2118 struct ofproto_port *ofproto_port,
2119 struct ofputil_phy_port *pp)
2121 enum netdev_flags flags;
2122 struct netdev *netdev;
2125 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2127 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2128 "cannot be opened (%s)",
2130 ofproto_port->name, ofproto_port->ofp_port,
2131 ofproto_port->name, ovs_strerror(error));
2135 if (ofproto_port->ofp_port == OFPP_NONE) {
2136 if (!strcmp(ofproto->name, ofproto_port->name)) {
2137 ofproto_port->ofp_port = OFPP_LOCAL;
2139 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2140 ofproto_port->name);
2143 pp->port_no = ofproto_port->ofp_port;
2144 netdev_get_etheraddr(netdev, pp->hw_addr);
2145 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2146 netdev_get_flags(netdev, &flags);
2147 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2148 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2149 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2150 &pp->supported, &pp->peer);
2151 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2152 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2157 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2158 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2161 ofport_equal(const struct ofputil_phy_port *a,
2162 const struct ofputil_phy_port *b)
2164 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2165 && a->state == b->state
2166 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2167 && a->curr == b->curr
2168 && a->advertised == b->advertised
2169 && a->supported == b->supported
2170 && a->peer == b->peer
2171 && a->curr_speed == b->curr_speed
2172 && a->max_speed == b->max_speed);
2175 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2176 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2177 * one with the same name or port number). */
2179 ofport_install(struct ofproto *p,
2180 struct netdev *netdev, const struct ofputil_phy_port *pp)
2182 const char *netdev_name = netdev_get_name(netdev);
2183 struct ofport *ofport;
2186 /* Create ofport. */
2187 ofport = p->ofproto_class->port_alloc();
2192 ofport->ofproto = p;
2193 ofport->netdev = netdev;
2195 ofport->ofp_port = pp->port_no;
2196 ofport->created = time_msec();
2198 /* Add port to 'p'. */
2199 hmap_insert(&p->ports, &ofport->hmap_node,
2200 hash_ofp_port(ofport->ofp_port));
2201 shash_add(&p->port_by_name, netdev_name, ofport);
2203 update_mtu(p, ofport);
2205 /* Let the ofproto_class initialize its private data. */
2206 error = p->ofproto_class->port_construct(ofport);
2210 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2214 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2215 p->name, netdev_name, ovs_strerror(error));
2217 ofport_destroy__(ofport);
2219 netdev_close(netdev);
2223 /* Removes 'ofport' from 'p' and destroys it. */
2225 ofport_remove(struct ofport *ofport)
2227 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2229 ofport_destroy(ofport);
2232 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2235 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2237 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2239 ofport_remove(port);
2243 /* Updates 'port' with new 'pp' description.
2245 * Does not handle a name or port number change. The caller must implement
2246 * such a change as a delete followed by an add. */
2248 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2250 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2251 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2252 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2253 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2254 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2255 port->pp.curr = pp->curr;
2256 port->pp.advertised = pp->advertised;
2257 port->pp.supported = pp->supported;
2258 port->pp.peer = pp->peer;
2259 port->pp.curr_speed = pp->curr_speed;
2260 port->pp.max_speed = pp->max_speed;
2262 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2263 &port->pp, OFPPR_MODIFY);
2266 /* Update OpenFlow 'state' in 'port' and notify controller. */
2268 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2270 if (port->pp.state != state) {
2271 port->pp.state = state;
2272 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2273 &port->pp, OFPPR_MODIFY);
2278 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2280 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2282 if (port->ofproto->ofproto_class->set_realdev) {
2283 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2285 if (port->ofproto->ofproto_class->set_stp_port) {
2286 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2288 if (port->ofproto->ofproto_class->set_cfm) {
2289 port->ofproto->ofproto_class->set_cfm(port, NULL);
2291 if (port->ofproto->ofproto_class->bundle_remove) {
2292 port->ofproto->ofproto_class->bundle_remove(port);
2298 ofport_destroy__(struct ofport *port)
2300 struct ofproto *ofproto = port->ofproto;
2301 const char *name = netdev_get_name(port->netdev);
2303 hmap_remove(&ofproto->ports, &port->hmap_node);
2304 shash_delete(&ofproto->port_by_name,
2305 shash_find(&ofproto->port_by_name, name));
2307 netdev_close(port->netdev);
2308 ofproto->ofproto_class->port_dealloc(port);
2312 ofport_destroy(struct ofport *port)
2315 dealloc_ofp_port(port->ofproto, port->ofp_port);
2316 port->ofproto->ofproto_class->port_destruct(port);
2317 ofport_destroy__(port);
2322 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2324 struct ofport *port;
2326 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2328 if (port->ofp_port == ofp_port) {
2335 static long long int
2336 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2338 struct ofport_usage *usage;
2340 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2341 &ofproto->ofport_usage) {
2342 if (usage->ofp_port == ofp_port) {
2343 return usage->last_used;
2350 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2351 long long int last_used)
2353 struct ofport_usage *usage;
2354 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2355 &ofproto->ofport_usage) {
2356 if (usage->ofp_port == ofp_port) {
2357 usage->last_used = last_used;
2361 ovs_assert(last_used == LLONG_MAX);
2363 usage = xmalloc(sizeof *usage);
2364 usage->ofp_port = ofp_port;
2365 usage->last_used = last_used;
2366 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2367 hash_ofp_port(ofp_port));
2371 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2373 struct ofport_usage *usage;
2374 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2375 &ofproto->ofport_usage) {
2376 if (usage->ofp_port == ofp_port) {
2377 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2385 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2387 struct ofproto *ofproto = port->ofproto;
2390 if (ofproto->ofproto_class->port_get_stats) {
2391 error = ofproto->ofproto_class->port_get_stats(port, stats);
2400 update_port(struct ofproto *ofproto, const char *name)
2402 struct ofproto_port ofproto_port;
2403 struct ofputil_phy_port pp;
2404 struct netdev *netdev;
2405 struct ofport *port;
2407 COVERAGE_INC(ofproto_update_port);
2409 /* Fetch 'name''s location and properties from the datapath. */
2410 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2411 ? ofport_open(ofproto, &ofproto_port, &pp)
2415 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2416 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2417 struct netdev *old_netdev = port->netdev;
2419 /* 'name' hasn't changed location. Any properties changed? */
2420 if (!ofport_equal(&port->pp, &pp)) {
2421 ofport_modified(port, &pp);
2424 update_mtu(ofproto, port);
2426 /* Install the newly opened netdev in case it has changed.
2427 * Don't close the old netdev yet in case port_modified has to
2428 * remove a retained reference to it.*/
2429 port->netdev = netdev;
2431 if (port->ofproto->ofproto_class->port_modified) {
2432 port->ofproto->ofproto_class->port_modified(port);
2435 netdev_close(old_netdev);
2437 /* If 'port' is nonnull then its name differs from 'name' and thus
2438 * we should delete it. If we think there's a port named 'name'
2439 * then its port number must be wrong now so delete it too. */
2441 ofport_remove(port);
2443 ofport_remove_with_name(ofproto, name);
2444 ofport_install(ofproto, netdev, &pp);
2447 /* Any port named 'name' is gone now. */
2448 ofport_remove_with_name(ofproto, name);
2450 ofproto_port_destroy(&ofproto_port);
2454 init_ports(struct ofproto *p)
2456 struct ofproto_port_dump dump;
2457 struct ofproto_port ofproto_port;
2458 struct shash_node *node, *next;
2460 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2461 const char *name = ofproto_port.name;
2463 if (shash_find(&p->port_by_name, name)) {
2464 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2467 struct ofputil_phy_port pp;
2468 struct netdev *netdev;
2470 /* Check if an OpenFlow port number had been requested. */
2471 node = shash_find(&init_ofp_ports, name);
2473 const struct iface_hint *iface_hint = node->data;
2474 simap_put(&p->ofp_requests, name,
2475 ofp_to_u16(iface_hint->ofp_port));
2478 netdev = ofport_open(p, &ofproto_port, &pp);
2480 ofport_install(p, netdev, &pp);
2481 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2482 p->alloc_port_no = MAX(p->alloc_port_no,
2483 ofp_to_u16(ofproto_port.ofp_port));
2489 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2490 struct iface_hint *iface_hint = node->data;
2492 if (!strcmp(iface_hint->br_name, p->name)) {
2493 free(iface_hint->br_name);
2494 free(iface_hint->br_type);
2496 shash_delete(&init_ofp_ports, node);
2503 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2504 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2506 find_min_mtu(struct ofproto *p)
2508 struct ofport *ofport;
2511 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2512 struct netdev *netdev = ofport->netdev;
2515 /* Skip any internal ports, since that's what we're trying to
2517 if (!strcmp(netdev_get_type(netdev), "internal")) {
2521 if (netdev_get_mtu(netdev, &dev_mtu)) {
2524 if (!mtu || dev_mtu < mtu) {
2529 return mtu ? mtu: ETH_PAYLOAD_MAX;
2532 /* Update MTU of all datapath devices on 'p' to the minimum of the
2533 * non-datapath ports in event of 'port' added or changed. */
2535 update_mtu(struct ofproto *p, struct ofport *port)
2537 struct ofport *ofport;
2538 struct netdev *netdev = port->netdev;
2539 int dev_mtu, old_min;
2541 if (netdev_get_mtu(netdev, &dev_mtu)) {
2545 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2546 if (dev_mtu > p->min_mtu) {
2547 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2548 dev_mtu = p->min_mtu;
2551 port->mtu = dev_mtu;
2555 /* For non-internal port find new min mtu. */
2556 old_min = p->min_mtu;
2557 port->mtu = dev_mtu;
2558 p->min_mtu = find_min_mtu(p);
2559 if (p->min_mtu == old_min) {
2563 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2564 struct netdev *netdev = ofport->netdev;
2566 if (!strcmp(netdev_get_type(netdev), "internal")) {
2567 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2568 ofport->mtu = p->min_mtu;
2575 ofproto_rule_ref(struct rule *rule)
2578 ovs_refcount_ref(&rule->ref_count);
2583 ofproto_rule_unref(struct rule *rule)
2585 if (rule && ovs_refcount_unref(&rule->ref_count) == 1) {
2586 rule->ofproto->ofproto_class->rule_destruct(rule);
2587 ofproto_rule_destroy__(rule);
2592 ofproto_rule_destroy__(struct rule *rule)
2593 OVS_NO_THREAD_SAFETY_ANALYSIS
2595 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2596 rule_actions_destroy(rule_get_actions(rule));
2597 ovs_mutex_destroy(&rule->mutex);
2598 rule->ofproto->ofproto_class->rule_dealloc(rule);
2601 static uint32_t get_provider_meter_id(const struct ofproto *,
2602 uint32_t of_meter_id);
2604 /* Creates and returns a new 'struct rule_actions', with a ref_count of 1,
2605 * whose actions are a copy of from the 'ofpacts_len' bytes of 'ofpacts'. */
2606 struct rule_actions *
2607 rule_actions_create(const struct ofproto *ofproto,
2608 const struct ofpact *ofpacts, size_t ofpacts_len)
2610 struct rule_actions *actions;
2612 actions = xmalloc(sizeof *actions);
2613 actions->ofpacts = xmemdup(ofpacts, ofpacts_len);
2614 actions->ofpacts_len = ofpacts_len;
2615 actions->provider_meter_id
2616 = get_provider_meter_id(ofproto,
2617 ofpacts_get_meter(ofpacts, ofpacts_len));
2623 rule_actions_destroy_cb(struct rule_actions *actions)
2625 free(actions->ofpacts);
2629 /* Decrements 'actions''s ref_count and frees 'actions' if the ref_count
2632 rule_actions_destroy(struct rule_actions *actions)
2635 ovsrcu_postpone(rule_actions_destroy_cb, actions);
2639 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2640 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2642 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2643 OVS_REQUIRES(ofproto_mutex)
2645 if (port == OFPP_ANY) {
2648 const struct rule_actions *actions = rule_get_actions(rule);
2649 return ofpacts_output_to_port(actions->ofpacts,
2650 actions->ofpacts_len, port);
2654 /* Returns true if 'rule' has group and equals group_id. */
2656 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2657 OVS_REQUIRES(ofproto_mutex)
2659 if (group_id == OFPG_ANY) {
2662 const struct rule_actions *actions = rule_get_actions(rule);
2663 return ofpacts_output_to_group(actions->ofpacts,
2664 actions->ofpacts_len, group_id);
2668 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2669 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2671 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2672 OVS_REQUIRES(ofproto_mutex)
2674 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2679 case OFOPERATION_ADD:
2680 case OFOPERATION_DELETE:
2683 case OFOPERATION_MODIFY:
2684 case OFOPERATION_REPLACE:
2685 return ofpacts_output_to_port(op->actions->ofpacts,
2686 op->actions->ofpacts_len, out_port);
2693 rule_execute_destroy(struct rule_execute *e)
2695 ofproto_rule_unref(e->rule);
2696 list_remove(&e->list_node);
2700 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2701 * by passing them to the ofproto provider. */
2703 run_rule_executes(struct ofproto *ofproto)
2704 OVS_EXCLUDED(ofproto_mutex)
2706 struct rule_execute *e, *next;
2707 struct list executes;
2709 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2710 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2713 flow_extract(e->packet, NULL, &flow);
2714 flow.in_port.ofp_port = e->in_port;
2715 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2717 rule_execute_destroy(e);
2721 /* Destroys and discards all "rule_execute" operations queued up in
2722 * ofproto->rule_executes. */
2724 destroy_rule_executes(struct ofproto *ofproto)
2726 struct rule_execute *e, *next;
2727 struct list executes;
2729 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2730 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2731 ofpbuf_delete(e->packet);
2732 rule_execute_destroy(e);
2736 /* Returns true if 'rule' should be hidden from the controller.
2738 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2739 * (e.g. by in-band control) and are intentionally hidden from the
2742 ofproto_rule_is_hidden(const struct rule *rule)
2744 return rule->cr.priority > UINT16_MAX;
2747 static enum oftable_flags
2748 rule_get_flags(const struct rule *rule)
2750 return rule->ofproto->tables[rule->table_id].flags;
2754 rule_is_modifiable(const struct rule *rule)
2756 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2760 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2762 ofconn_send_reply(ofconn, make_echo_reply(oh));
2767 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2769 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2770 struct ofputil_switch_features features;
2771 struct ofport *port;
2777 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2779 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2781 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2782 * if present, are always at the end.) */
2783 n_tables = ofproto->n_tables;
2784 for (i = 0; i < ofproto->n_tables; i++) {
2785 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2791 features.datapath_id = ofproto->datapath_id;
2792 features.n_buffers = pktbuf_capacity();
2793 features.n_tables = n_tables;
2794 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2795 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2797 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2799 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2800 features.auxiliary_id = 0;
2801 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2803 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2804 ofputil_put_switch_features_port(&port->pp, b);
2807 ofconn_send_reply(ofconn, b);
2812 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2814 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2815 struct ofp_switch_config *osc;
2816 enum ofp_config_flags flags;
2820 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2821 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2822 flags = ofproto->frag_handling;
2823 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2824 if (oh->version < OFP13_VERSION
2825 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2826 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2828 osc->flags = htons(flags);
2829 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2830 ofconn_send_reply(ofconn, buf);
2836 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2838 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2839 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2840 uint16_t flags = ntohs(osc->flags);
2842 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2843 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2844 enum ofp_config_flags cur = ofproto->frag_handling;
2845 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2847 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2849 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2850 ofproto->frag_handling = next;
2852 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2854 ofputil_frag_handling_to_string(next));
2858 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2859 ofconn_set_invalid_ttl_to_controller(ofconn,
2860 (oh->version < OFP13_VERSION
2861 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2863 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2868 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2869 * error message code for the caller to propagate upward. Otherwise, returns
2872 * The log message mentions 'msg_type'. */
2874 reject_slave_controller(struct ofconn *ofconn)
2876 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2877 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2878 return OFPERR_OFPBRC_EPERM;
2884 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2887 * - If they use a meter, then 'ofproto' has that meter configured.
2889 * - If they use any groups, then 'ofproto' has that group configured.
2891 * Returns 0 if successful, otherwise an OpenFlow error. */
2893 ofproto_check_ofpacts(struct ofproto *ofproto,
2894 const struct ofpact ofpacts[], size_t ofpacts_len)
2896 const struct ofpact *a;
2899 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2900 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2901 return OFPERR_OFPMMFC_INVALID_METER;
2904 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2905 if (a->type == OFPACT_GROUP
2906 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2907 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2915 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2917 struct ofproto *p = ofconn_get_ofproto(ofconn);
2918 struct ofputil_packet_out po;
2919 struct ofpbuf *payload;
2920 uint64_t ofpacts_stub[1024 / 8];
2921 struct ofpbuf ofpacts;
2925 COVERAGE_INC(ofproto_packet_out);
2927 error = reject_slave_controller(ofconn);
2932 /* Decode message. */
2933 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2934 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2936 goto exit_free_ofpacts;
2938 if (ofp_to_u16(po.in_port) >= p->max_ports
2939 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2940 error = OFPERR_OFPBRC_BAD_PORT;
2941 goto exit_free_ofpacts;
2945 if (po.buffer_id != UINT32_MAX) {
2946 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2947 if (error || !payload) {
2948 goto exit_free_ofpacts;
2951 /* Ensure that the L3 header is 32-bit aligned. */
2952 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2955 /* Verify actions against packet, then send packet if successful. */
2956 flow_extract(payload, NULL, &flow);
2957 flow.in_port.ofp_port = po.in_port;
2958 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
2960 error = p->ofproto_class->packet_out(p, payload, &flow,
2961 po.ofpacts, po.ofpacts_len);
2963 ofpbuf_delete(payload);
2966 ofpbuf_uninit(&ofpacts);
2972 update_port_config(struct ofconn *ofconn, struct ofport *port,
2973 enum ofputil_port_config config,
2974 enum ofputil_port_config mask)
2976 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
2978 if (toggle & OFPUTIL_PC_PORT_DOWN
2979 && (config & OFPUTIL_PC_PORT_DOWN
2980 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
2981 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
2982 /* We tried to bring the port up or down, but it failed, so don't
2983 * update the "down" bit. */
2984 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2988 enum ofputil_port_config old_config = port->pp.config;
2989 port->pp.config ^= toggle;
2990 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2991 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
2997 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2999 struct ofproto *p = ofconn_get_ofproto(ofconn);
3000 struct ofputil_port_mod pm;
3001 struct ofport *port;
3004 error = reject_slave_controller(ofconn);
3009 error = ofputil_decode_port_mod(oh, &pm);
3014 port = ofproto_get_port(p, pm.port_no);
3016 return OFPERR_OFPPMFC_BAD_PORT;
3017 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3018 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3020 update_port_config(ofconn, port, pm.config, pm.mask);
3022 netdev_set_advertisements(port->netdev, pm.advertise);
3029 handle_desc_stats_request(struct ofconn *ofconn,
3030 const struct ofp_header *request)
3032 static const char *default_mfr_desc = "Nicira, Inc.";
3033 static const char *default_hw_desc = "Open vSwitch";
3034 static const char *default_sw_desc = VERSION;
3035 static const char *default_serial_desc = "None";
3036 static const char *default_dp_desc = "None";
3038 struct ofproto *p = ofconn_get_ofproto(ofconn);
3039 struct ofp_desc_stats *ods;
3042 msg = ofpraw_alloc_stats_reply(request, 0);
3043 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3044 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3045 sizeof ods->mfr_desc);
3046 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3047 sizeof ods->hw_desc);
3048 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3049 sizeof ods->sw_desc);
3050 ovs_strlcpy(ods->serial_num,
3051 p->serial_desc ? p->serial_desc : default_serial_desc,
3052 sizeof ods->serial_num);
3053 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3054 sizeof ods->dp_desc);
3055 ofconn_send_reply(ofconn, msg);
3061 handle_table_stats_request(struct ofconn *ofconn,
3062 const struct ofp_header *request)
3064 struct ofproto *p = ofconn_get_ofproto(ofconn);
3065 struct ofp12_table_stats *ots;
3070 /* Set up default values.
3072 * ofp12_table_stats is used as a generic structure as
3073 * it is able to hold all the fields for ofp10_table_stats
3074 * and ofp11_table_stats (and of course itself).
3076 ots = xcalloc(p->n_tables, sizeof *ots);
3077 for (i = 0; i < p->n_tables; i++) {
3078 ots[i].table_id = i;
3079 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3080 ots[i].match = htonll(OFPXMT13_MASK);
3081 ots[i].wildcards = htonll(OFPXMT13_MASK);
3082 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3083 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3084 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3085 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3086 ots[i].metadata_match = OVS_BE64_MAX;
3087 ots[i].metadata_write = OVS_BE64_MAX;
3088 ots[i].instructions = htonl(OFPIT11_ALL);
3089 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3090 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3091 fat_rwlock_rdlock(&p->tables[i].cls.rwlock);
3092 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3093 fat_rwlock_unlock(&p->tables[i].cls.rwlock);
3096 p->ofproto_class->get_tables(p, ots);
3098 /* Post-process the tables, dropping hidden tables. */
3099 n_tables = p->n_tables;
3100 for (i = 0; i < p->n_tables; i++) {
3101 const struct oftable *table = &p->tables[i];
3103 if (table->flags & OFTABLE_HIDDEN) {
3109 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3112 if (table->max_flows < ntohl(ots[i].max_entries)) {
3113 ots[i].max_entries = htonl(table->max_flows);
3117 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3118 ofconn_send_reply(ofconn, msg);
3126 append_port_stat(struct ofport *port, struct list *replies)
3128 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3130 calc_duration(port->created, time_msec(),
3131 &ops.duration_sec, &ops.duration_nsec);
3133 /* Intentionally ignore return value, since errors will set
3134 * 'stats' to all-1s, which is correct for OpenFlow, and
3135 * netdev_get_stats() will log errors. */
3136 ofproto_port_get_stats(port, &ops.stats);
3138 ofputil_append_port_stat(replies, &ops);
3142 handle_port_stats_request(struct ofconn *ofconn,
3143 const struct ofp_header *request)
3145 struct ofproto *p = ofconn_get_ofproto(ofconn);
3146 struct ofport *port;
3147 struct list replies;
3151 error = ofputil_decode_port_stats_request(request, &port_no);
3156 ofpmp_init(&replies, request);
3157 if (port_no != OFPP_ANY) {
3158 port = ofproto_get_port(p, port_no);
3160 append_port_stat(port, &replies);
3163 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3164 append_port_stat(port, &replies);
3168 ofconn_send_replies(ofconn, &replies);
3173 handle_port_desc_stats_request(struct ofconn *ofconn,
3174 const struct ofp_header *request)
3176 struct ofproto *p = ofconn_get_ofproto(ofconn);
3177 enum ofp_version version;
3178 struct ofport *port;
3179 struct list replies;
3181 ofpmp_init(&replies, request);
3183 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
3184 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3185 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
3188 ofconn_send_replies(ofconn, &replies);
3193 hash_cookie(ovs_be64 cookie)
3195 return hash_2words((OVS_FORCE uint64_t)cookie >> 32,
3196 (OVS_FORCE uint64_t)cookie);
3200 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3201 OVS_REQUIRES(ofproto_mutex)
3203 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3204 hash_cookie(rule->flow_cookie));
3208 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3209 OVS_REQUIRES(ofproto_mutex)
3211 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3215 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3216 ovs_be64 new_cookie)
3217 OVS_REQUIRES(ofproto_mutex)
3219 if (new_cookie != rule->flow_cookie) {
3220 cookies_remove(ofproto, rule);
3222 ovs_mutex_lock(&rule->mutex);
3223 rule->flow_cookie = new_cookie;
3224 ovs_mutex_unlock(&rule->mutex);
3226 cookies_insert(ofproto, rule);
3231 calc_duration(long long int start, long long int now,
3232 uint32_t *sec, uint32_t *nsec)
3234 long long int msecs = now - start;
3235 *sec = msecs / 1000;
3236 *nsec = (msecs % 1000) * (1000 * 1000);
3239 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3240 * true if 'table_id' is OK, false otherwise. */
3242 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3244 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3247 static struct oftable *
3248 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3250 struct oftable *table;
3252 for (table = &ofproto->tables[table_id];
3253 table < &ofproto->tables[ofproto->n_tables];
3255 if (!(table->flags & OFTABLE_HIDDEN)) {
3263 static struct oftable *
3264 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3266 if (table_id == 0xff) {
3267 return next_visible_table(ofproto, 0);
3268 } else if (table_id < ofproto->n_tables) {
3269 return &ofproto->tables[table_id];
3275 static struct oftable *
3276 next_matching_table(const struct ofproto *ofproto,
3277 const struct oftable *table, uint8_t table_id)
3279 return (table_id == 0xff
3280 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3284 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3286 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3287 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3289 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3290 * only once, for that table. (This can be used to access tables marked
3293 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3294 * entered at all. (Perhaps you should have validated TABLE_ID with
3295 * check_table_id().)
3297 * All parameters are evaluated multiple times.
3299 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3300 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3302 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3304 /* Initializes 'criteria' in a straightforward way based on the other
3307 * For "loose" matching, the 'priority' parameter is unimportant and may be
3310 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3311 const struct match *match, unsigned int priority,
3312 ovs_be64 cookie, ovs_be64 cookie_mask,
3313 ofp_port_t out_port, uint32_t out_group)
3315 criteria->table_id = table_id;
3316 cls_rule_init(&criteria->cr, match, priority);
3317 criteria->cookie = cookie;
3318 criteria->cookie_mask = cookie_mask;
3319 criteria->out_port = out_port;
3320 criteria->out_group = out_group;
3324 rule_criteria_destroy(struct rule_criteria *criteria)
3326 cls_rule_destroy(&criteria->cr);
3330 rule_collection_init(struct rule_collection *rules)
3332 rules->rules = rules->stub;
3334 rules->capacity = ARRAY_SIZE(rules->stub);
3338 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3340 if (rules->n >= rules->capacity) {
3341 size_t old_size, new_size;
3343 old_size = rules->capacity * sizeof *rules->rules;
3344 rules->capacity *= 2;
3345 new_size = rules->capacity * sizeof *rules->rules;
3347 if (rules->rules == rules->stub) {
3348 rules->rules = xmalloc(new_size);
3349 memcpy(rules->rules, rules->stub, old_size);
3351 rules->rules = xrealloc(rules->rules, new_size);
3355 rules->rules[rules->n++] = rule;
3359 rule_collection_ref(struct rule_collection *rules)
3360 OVS_REQUIRES(ofproto_mutex)
3364 for (i = 0; i < rules->n; i++) {
3365 ofproto_rule_ref(rules->rules[i]);
3370 rule_collection_unref(struct rule_collection *rules)
3374 for (i = 0; i < rules->n; i++) {
3375 ofproto_rule_unref(rules->rules[i]);
3380 rule_collection_destroy(struct rule_collection *rules)
3382 if (rules->rules != rules->stub) {
3388 collect_rule(struct rule *rule, const struct rule_criteria *c,
3389 struct rule_collection *rules)
3390 OVS_REQUIRES(ofproto_mutex)
3392 /* We ordinarily want to skip hidden rules, but there has to be a way for
3393 * code internal to OVS to modify and delete them, so if the criteria
3394 * specify a priority that can only be for a hidden flow, then allow hidden
3395 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3396 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3398 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3400 } else if (rule->pending) {
3401 return OFPROTO_POSTPONE;
3403 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3404 && ofproto_rule_has_out_port(rule, c->out_port)
3405 && ofproto_rule_has_out_group(rule, c->out_group)
3406 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3407 rule_collection_add(rules, rule);
3413 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3414 * on classifiers rules are done in the "loose" way required for OpenFlow
3415 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3418 * Hidden rules are always omitted.
3420 * Returns 0 on success, otherwise an OpenFlow error code. */
3422 collect_rules_loose(struct ofproto *ofproto,
3423 const struct rule_criteria *criteria,
3424 struct rule_collection *rules)
3425 OVS_REQUIRES(ofproto_mutex)
3427 struct oftable *table;
3428 enum ofperr error = 0;
3430 rule_collection_init(rules);
3432 if (!check_table_id(ofproto, criteria->table_id)) {
3433 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3437 if (criteria->cookie_mask == OVS_BE64_MAX) {
3440 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3441 hash_cookie(criteria->cookie),
3442 &ofproto->cookies) {
3443 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3444 error = collect_rule(rule, criteria, rules);
3451 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3452 struct cls_cursor cursor;
3455 fat_rwlock_rdlock(&table->cls.rwlock);
3456 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3457 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3458 error = collect_rule(rule, criteria, rules);
3463 fat_rwlock_unlock(&table->cls.rwlock);
3469 rule_collection_destroy(rules);
3474 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3475 * on classifiers rules are done in the "strict" way required for OpenFlow
3476 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3477 * rules on list 'rules'.
3479 * Hidden rules are always omitted.
3481 * Returns 0 on success, otherwise an OpenFlow error code. */
3483 collect_rules_strict(struct ofproto *ofproto,
3484 const struct rule_criteria *criteria,
3485 struct rule_collection *rules)
3486 OVS_REQUIRES(ofproto_mutex)
3488 struct oftable *table;
3491 rule_collection_init(rules);
3493 if (!check_table_id(ofproto, criteria->table_id)) {
3494 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3498 if (criteria->cookie_mask == OVS_BE64_MAX) {
3501 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3502 hash_cookie(criteria->cookie),
3503 &ofproto->cookies) {
3504 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3505 error = collect_rule(rule, criteria, rules);
3512 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3515 fat_rwlock_rdlock(&table->cls.rwlock);
3516 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3517 &table->cls, &criteria->cr));
3518 fat_rwlock_unlock(&table->cls.rwlock);
3520 error = collect_rule(rule, criteria, rules);
3530 rule_collection_destroy(rules);
3535 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3536 * forced into the range of a uint16_t. */
3538 age_secs(long long int age_ms)
3540 return (age_ms < 0 ? 0
3541 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3542 : (unsigned int) age_ms / 1000);
3546 handle_flow_stats_request(struct ofconn *ofconn,
3547 const struct ofp_header *request)
3548 OVS_EXCLUDED(ofproto_mutex)
3550 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3551 struct ofputil_flow_stats_request fsr;
3552 struct rule_criteria criteria;
3553 struct rule_collection rules;
3554 struct list replies;
3558 error = ofputil_decode_flow_stats_request(&fsr, request);
3563 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3564 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3566 ovs_mutex_lock(&ofproto_mutex);
3567 error = collect_rules_loose(ofproto, &criteria, &rules);
3568 rule_criteria_destroy(&criteria);
3570 rule_collection_ref(&rules);
3572 ovs_mutex_unlock(&ofproto_mutex);
3578 ofpmp_init(&replies, request);
3579 for (i = 0; i < rules.n; i++) {
3580 struct rule *rule = rules.rules[i];
3581 long long int now = time_msec();
3582 struct ofputil_flow_stats fs;
3583 long long int created, used, modified;
3584 struct rule_actions *actions;
3585 enum ofputil_flow_mod_flags flags;
3587 ovs_mutex_lock(&rule->mutex);
3588 fs.cookie = rule->flow_cookie;
3589 fs.idle_timeout = rule->idle_timeout;
3590 fs.hard_timeout = rule->hard_timeout;
3591 created = rule->created;
3592 modified = rule->modified;
3593 actions = rule_get_actions(rule);
3594 flags = rule->flags;
3595 ovs_mutex_unlock(&rule->mutex);
3597 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3598 &fs.byte_count, &used);
3600 minimatch_expand(&rule->cr.match, &fs.match);
3601 fs.table_id = rule->table_id;
3602 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3603 fs.priority = rule->cr.priority;
3604 fs.idle_age = age_secs(now - used);
3605 fs.hard_age = age_secs(now - modified);
3606 fs.ofpacts = actions->ofpacts;
3607 fs.ofpacts_len = actions->ofpacts_len;
3610 ofputil_append_flow_stats_reply(&fs, &replies);
3613 rule_collection_unref(&rules);
3614 rule_collection_destroy(&rules);
3616 ofconn_send_replies(ofconn, &replies);
3622 flow_stats_ds(struct rule *rule, struct ds *results)
3624 uint64_t packet_count, byte_count;
3625 struct rule_actions *actions;
3626 long long int created, used;
3628 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3629 &byte_count, &used);
3631 ovs_mutex_lock(&rule->mutex);
3632 actions = rule_get_actions(rule);
3633 created = rule->created;
3634 ovs_mutex_unlock(&rule->mutex);
3636 if (rule->table_id != 0) {
3637 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3639 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3640 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3641 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3642 cls_rule_format(&rule->cr, results);
3643 ds_put_char(results, ',');
3645 ds_put_cstr(results, "actions=");
3646 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3648 ds_put_cstr(results, "\n");
3651 /* Adds a pretty-printed description of all flows to 'results', including
3652 * hidden flows (e.g., set up by in-band control). */
3654 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3656 struct oftable *table;
3658 OFPROTO_FOR_EACH_TABLE (table, p) {
3659 struct cls_cursor cursor;
3662 fat_rwlock_rdlock(&table->cls.rwlock);
3663 cls_cursor_init(&cursor, &table->cls, NULL);
3664 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3665 flow_stats_ds(rule, results);
3667 fat_rwlock_unlock(&table->cls.rwlock);
3671 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3672 * '*engine_type' and '*engine_id', respectively. */
3674 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3675 uint8_t *engine_type, uint8_t *engine_id)
3677 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3680 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3681 * true if the port's CFM status was successfully stored into '*status'.
3682 * Returns false if the port did not have CFM configured, in which case
3683 * '*status' is indeterminate.
3685 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3687 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3688 struct ofproto_cfm_status *status)
3690 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3692 && ofproto->ofproto_class->get_cfm_status
3693 && ofproto->ofproto_class->get_cfm_status(ofport, status));
3697 handle_aggregate_stats_request(struct ofconn *ofconn,
3698 const struct ofp_header *oh)
3699 OVS_EXCLUDED(ofproto_mutex)
3701 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3702 struct ofputil_flow_stats_request request;
3703 struct ofputil_aggregate_stats stats;
3704 bool unknown_packets, unknown_bytes;
3705 struct rule_criteria criteria;
3706 struct rule_collection rules;
3707 struct ofpbuf *reply;
3711 error = ofputil_decode_flow_stats_request(&request, oh);
3716 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3717 request.cookie, request.cookie_mask,
3718 request.out_port, request.out_group);
3720 ovs_mutex_lock(&ofproto_mutex);
3721 error = collect_rules_loose(ofproto, &criteria, &rules);
3722 rule_criteria_destroy(&criteria);
3724 rule_collection_ref(&rules);
3726 ovs_mutex_unlock(&ofproto_mutex);
3732 memset(&stats, 0, sizeof stats);
3733 unknown_packets = unknown_bytes = false;
3734 for (i = 0; i < rules.n; i++) {
3735 struct rule *rule = rules.rules[i];
3736 uint64_t packet_count;
3737 uint64_t byte_count;
3740 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3741 &byte_count, &used);
3743 if (packet_count == UINT64_MAX) {
3744 unknown_packets = true;
3746 stats.packet_count += packet_count;
3749 if (byte_count == UINT64_MAX) {
3750 unknown_bytes = true;
3752 stats.byte_count += byte_count;
3757 if (unknown_packets) {
3758 stats.packet_count = UINT64_MAX;
3760 if (unknown_bytes) {
3761 stats.byte_count = UINT64_MAX;
3764 rule_collection_unref(&rules);
3765 rule_collection_destroy(&rules);
3767 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3768 ofconn_send_reply(ofconn, reply);
3773 struct queue_stats_cbdata {
3774 struct ofport *ofport;
3775 struct list replies;
3780 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3781 const struct netdev_queue_stats *stats)
3783 struct ofputil_queue_stats oqs;
3785 oqs.port_no = cbdata->ofport->pp.port_no;
3786 oqs.queue_id = queue_id;
3787 oqs.tx_bytes = stats->tx_bytes;
3788 oqs.tx_packets = stats->tx_packets;
3789 oqs.tx_errors = stats->tx_errors;
3790 if (stats->created != LLONG_MIN) {
3791 calc_duration(stats->created, cbdata->now,
3792 &oqs.duration_sec, &oqs.duration_nsec);
3794 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3796 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3800 handle_queue_stats_dump_cb(uint32_t queue_id,
3801 struct netdev_queue_stats *stats,
3804 struct queue_stats_cbdata *cbdata = cbdata_;
3806 put_queue_stats(cbdata, queue_id, stats);
3810 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3811 struct queue_stats_cbdata *cbdata)
3813 cbdata->ofport = port;
3814 if (queue_id == OFPQ_ALL) {
3815 netdev_dump_queue_stats(port->netdev,
3816 handle_queue_stats_dump_cb, cbdata);
3818 struct netdev_queue_stats stats;
3820 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3821 put_queue_stats(cbdata, queue_id, &stats);
3823 return OFPERR_OFPQOFC_BAD_QUEUE;
3830 handle_queue_stats_request(struct ofconn *ofconn,
3831 const struct ofp_header *rq)
3833 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3834 struct queue_stats_cbdata cbdata;
3835 struct ofport *port;
3837 struct ofputil_queue_stats_request oqsr;
3839 COVERAGE_INC(ofproto_queue_req);
3841 ofpmp_init(&cbdata.replies, rq);
3842 cbdata.now = time_msec();
3844 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3849 if (oqsr.port_no == OFPP_ANY) {
3850 error = OFPERR_OFPQOFC_BAD_QUEUE;
3851 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3852 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3857 port = ofproto_get_port(ofproto, oqsr.port_no);
3859 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3860 : OFPERR_OFPQOFC_BAD_PORT);
3863 ofconn_send_replies(ofconn, &cbdata.replies);
3865 ofpbuf_list_delete(&cbdata.replies);
3872 is_flow_deletion_pending(const struct ofproto *ofproto,
3873 const struct cls_rule *cls_rule,
3875 OVS_REQUIRES(ofproto_mutex)
3877 if (!hmap_is_empty(&ofproto->deletions)) {
3878 struct ofoperation *op;
3880 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3881 cls_rule_hash(cls_rule, table_id),
3882 &ofproto->deletions) {
3883 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3893 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3894 OVS_REQUIRES(ofproto_mutex)
3895 OVS_NO_THREAD_SAFETY_ANALYSIS
3897 return classifier_count(&table->cls) + extra_space > table->max_flows;
3901 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3902 unsigned int extra_space)
3903 OVS_REQUIRES(ofproto_mutex)
3905 while (should_evict_a_rule(table, extra_space)) {
3908 if (!choose_rule_to_evict(table, &rule)) {
3909 return OFPERR_OFPFMFC_TABLE_FULL;
3910 } else if (rule->pending) {
3911 return OFPROTO_POSTPONE;
3913 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3914 delete_flow__(rule, group, OFPRR_EVICTION);
3915 ofopgroup_submit(group);
3922 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3923 * in which no matching flow already exists in the flow table.
3925 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3926 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3927 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3928 * initiated now but may be retried later.
3930 * The caller retains ownership of 'fm->ofpacts'.
3932 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3935 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3936 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3937 OVS_REQUIRES(ofproto_mutex)
3939 struct oftable *table;
3940 struct ofopgroup *group;
3946 if (!check_table_id(ofproto, fm->table_id)) {
3947 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3952 if (fm->table_id == 0xff) {
3953 if (ofproto->ofproto_class->rule_choose_table) {
3954 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3960 ovs_assert(table_id < ofproto->n_tables);
3964 } else if (fm->table_id < ofproto->n_tables) {
3965 table_id = fm->table_id;
3967 return OFPERR_OFPBRC_BAD_TABLE_ID;
3970 table = &ofproto->tables[table_id];
3972 if (table->flags & OFTABLE_READONLY) {
3973 return OFPERR_OFPBRC_EPERM;
3976 cls_rule_init(&cr, &fm->match, fm->priority);
3978 /* Transform "add" into "modify" if there's an existing identical flow. */
3979 fat_rwlock_rdlock(&table->cls.rwlock);
3980 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
3981 fat_rwlock_unlock(&table->cls.rwlock);
3983 cls_rule_destroy(&cr);
3984 if (!rule_is_modifiable(rule)) {
3985 return OFPERR_OFPBRC_EPERM;
3986 } else if (rule->pending) {
3987 return OFPROTO_POSTPONE;
3989 struct rule_collection rules;
3991 rule_collection_init(&rules);
3992 rule_collection_add(&rules, rule);
3993 fm->modify_cookie = true;
3994 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
3995 rule_collection_destroy(&rules);
4001 /* Serialize against pending deletion. */
4002 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
4003 cls_rule_destroy(&cr);
4004 return OFPROTO_POSTPONE;
4007 /* Check for overlap, if requested. */
4008 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4011 fat_rwlock_rdlock(&table->cls.rwlock);
4012 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4013 fat_rwlock_unlock(&table->cls.rwlock);
4016 cls_rule_destroy(&cr);
4017 return OFPERR_OFPFMFC_OVERLAP;
4021 /* If necessary, evict an existing rule to clear out space. */
4022 error = evict_rules_from_table(ofproto, table, 1);
4024 cls_rule_destroy(&cr);
4028 /* Allocate new rule. */
4029 rule = ofproto->ofproto_class->rule_alloc();
4031 cls_rule_destroy(&cr);
4032 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4033 ofproto->name, ovs_strerror(error));
4037 /* Initialize base state. */
4038 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4039 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4040 ovs_refcount_init(&rule->ref_count);
4041 rule->pending = NULL;
4042 rule->flow_cookie = fm->new_cookie;
4043 rule->created = rule->modified = time_msec();
4045 ovs_mutex_init(&rule->mutex);
4046 ovs_mutex_lock(&rule->mutex);
4047 rule->idle_timeout = fm->idle_timeout;
4048 rule->hard_timeout = fm->hard_timeout;
4049 ovs_mutex_unlock(&rule->mutex);
4051 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4052 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4053 ovsrcu_set(&rule->actions,
4054 rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len));
4055 list_init(&rule->meter_list_node);
4056 rule->eviction_group = NULL;
4057 list_init(&rule->expirable);
4058 rule->monitor_flags = 0;
4059 rule->add_seqno = 0;
4060 rule->modify_seqno = 0;
4062 /* Construct rule, initializing derived state. */
4063 error = ofproto->ofproto_class->rule_construct(rule);
4065 ofproto_rule_destroy__(rule);
4070 oftable_insert_rule(rule);
4072 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4073 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4074 ofproto->ofproto_class->rule_insert(rule);
4075 ofopgroup_submit(group);
4080 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4082 /* Modifies the rules listed in 'rules', changing their actions to match those
4085 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4088 * Returns 0 on success, otherwise an OpenFlow error code. */
4090 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4091 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4092 const struct rule_collection *rules)
4093 OVS_REQUIRES(ofproto_mutex)
4095 enum ofoperation_type type;
4096 struct ofopgroup *group;
4100 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4101 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4102 error = OFPERR_OFPBRC_EPERM;
4103 for (i = 0; i < rules->n; i++) {
4104 struct rule *rule = rules->rules[i];
4105 const struct rule_actions *actions;
4106 struct ofoperation *op;
4107 bool actions_changed;
4108 bool reset_counters;
4110 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4112 if (rule_is_modifiable(rule)) {
4113 /* At least one rule is modifiable, don't report EPERM error. */
4119 actions = rule_get_actions(rule);
4120 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4122 actions->ofpacts_len);
4124 op = ofoperation_create(group, rule, type, 0);
4126 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4127 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4129 if (type == OFOPERATION_REPLACE) {
4130 ovs_mutex_lock(&rule->mutex);
4131 rule->idle_timeout = fm->idle_timeout;
4132 rule->hard_timeout = fm->hard_timeout;
4133 ovs_mutex_unlock(&rule->mutex);
4135 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4136 if (fm->idle_timeout || fm->hard_timeout) {
4137 if (!rule->eviction_group) {
4138 eviction_group_add_rule(rule);
4141 eviction_group_remove_rule(rule);
4145 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4146 if (actions_changed || reset_counters) {
4147 struct rule_actions *new_actions;
4149 op->actions = rule_get_actions(rule);
4150 new_actions = rule_actions_create(ofproto,
4151 fm->ofpacts, fm->ofpacts_len);
4153 ovsrcu_set(&rule->actions, new_actions);
4155 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4158 ofoperation_complete(op, 0);
4161 ofopgroup_submit(group);
4167 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4168 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4169 OVS_REQUIRES(ofproto_mutex)
4171 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4174 return add_flow(ofproto, ofconn, fm, request);
4177 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4180 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4183 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4184 struct ofputil_flow_mod *fm,
4185 const struct ofp_header *request)
4186 OVS_REQUIRES(ofproto_mutex)
4188 struct rule_criteria criteria;
4189 struct rule_collection rules;
4192 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4193 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4194 error = collect_rules_loose(ofproto, &criteria, &rules);
4195 rule_criteria_destroy(&criteria);
4198 error = (rules.n > 0
4199 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4200 : modify_flows_add(ofproto, ofconn, fm, request));
4203 rule_collection_destroy(&rules);
4208 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4211 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4214 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4215 struct ofputil_flow_mod *fm,
4216 const struct ofp_header *request)
4217 OVS_REQUIRES(ofproto_mutex)
4219 struct rule_criteria criteria;
4220 struct rule_collection rules;
4223 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4224 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4225 error = collect_rules_strict(ofproto, &criteria, &rules);
4226 rule_criteria_destroy(&criteria);
4230 error = modify_flows_add(ofproto, ofconn, fm, request);
4231 } else if (rules.n == 1) {
4232 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4236 rule_collection_destroy(&rules);
4241 /* OFPFC_DELETE implementation. */
4244 delete_flow__(struct rule *rule, struct ofopgroup *group,
4245 enum ofp_flow_removed_reason reason)
4246 OVS_REQUIRES(ofproto_mutex)
4248 struct ofproto *ofproto = rule->ofproto;
4250 ofproto_rule_send_removed(rule, reason);
4252 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4253 oftable_remove_rule(rule);
4254 ofproto->ofproto_class->rule_delete(rule);
4257 /* Deletes the rules listed in 'rules'.
4259 * Returns 0 on success, otherwise an OpenFlow error code. */
4261 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4262 const struct ofp_header *request,
4263 const struct rule_collection *rules,
4264 enum ofp_flow_removed_reason reason)
4265 OVS_REQUIRES(ofproto_mutex)
4267 struct ofopgroup *group;
4270 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4271 for (i = 0; i < rules->n; i++) {
4272 delete_flow__(rules->rules[i], group, reason);
4274 ofopgroup_submit(group);
4279 /* Implements OFPFC_DELETE. */
4281 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4282 const struct ofputil_flow_mod *fm,
4283 const struct ofp_header *request)
4284 OVS_REQUIRES(ofproto_mutex)
4286 struct rule_criteria criteria;
4287 struct rule_collection rules;
4290 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4291 fm->cookie, fm->cookie_mask,
4292 fm->out_port, fm->out_group);
4293 error = collect_rules_loose(ofproto, &criteria, &rules);
4294 rule_criteria_destroy(&criteria);
4296 if (!error && rules.n > 0) {
4297 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4299 rule_collection_destroy(&rules);
4304 /* Implements OFPFC_DELETE_STRICT. */
4306 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4307 const struct ofputil_flow_mod *fm,
4308 const struct ofp_header *request)
4309 OVS_REQUIRES(ofproto_mutex)
4311 struct rule_criteria criteria;
4312 struct rule_collection rules;
4315 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4316 fm->cookie, fm->cookie_mask,
4317 fm->out_port, fm->out_group);
4318 error = collect_rules_strict(ofproto, &criteria, &rules);
4319 rule_criteria_destroy(&criteria);
4321 if (!error && rules.n > 0) {
4322 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4324 rule_collection_destroy(&rules);
4330 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4331 OVS_REQUIRES(ofproto_mutex)
4333 struct ofputil_flow_removed fr;
4336 if (ofproto_rule_is_hidden(rule) ||
4337 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4341 minimatch_expand(&rule->cr.match, &fr.match);
4342 fr.priority = rule->cr.priority;
4343 fr.cookie = rule->flow_cookie;
4345 fr.table_id = rule->table_id;
4346 calc_duration(rule->created, time_msec(),
4347 &fr.duration_sec, &fr.duration_nsec);
4348 ovs_mutex_lock(&rule->mutex);
4349 fr.idle_timeout = rule->idle_timeout;
4350 fr.hard_timeout = rule->hard_timeout;
4351 ovs_mutex_unlock(&rule->mutex);
4352 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4353 &fr.byte_count, &used);
4355 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4358 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4359 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4362 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4365 * ofproto implementation ->run() functions should use this function to expire
4366 * OpenFlow flows. */
4368 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4369 OVS_REQUIRES(ofproto_mutex)
4371 struct ofproto *ofproto = rule->ofproto;
4373 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4374 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4376 ofproto_rule_delete__(ofproto, rule, reason);
4379 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4380 * means "infinite". */
4382 reduce_timeout(uint16_t max, uint16_t *timeout)
4384 if (max && (!*timeout || *timeout > max)) {
4389 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4390 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4391 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4393 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4395 ofproto_rule_reduce_timeouts(struct rule *rule,
4396 uint16_t idle_timeout, uint16_t hard_timeout)
4397 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4399 if (!idle_timeout && !hard_timeout) {
4403 ovs_mutex_lock(&ofproto_mutex);
4404 if (list_is_empty(&rule->expirable)) {
4405 list_insert(&rule->ofproto->expirable, &rule->expirable);
4407 ovs_mutex_unlock(&ofproto_mutex);
4409 ovs_mutex_lock(&rule->mutex);
4410 reduce_timeout(idle_timeout, &rule->idle_timeout);
4411 reduce_timeout(hard_timeout, &rule->hard_timeout);
4412 ovs_mutex_unlock(&rule->mutex);
4416 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4417 OVS_EXCLUDED(ofproto_mutex)
4419 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4420 struct ofputil_flow_mod fm;
4421 uint64_t ofpacts_stub[1024 / 8];
4422 struct ofpbuf ofpacts;
4426 error = reject_slave_controller(ofconn);
4431 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4432 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4434 u16_to_ofp(ofproto->max_ports),
4437 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4440 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4443 goto exit_free_ofpacts;
4446 /* Record the operation for logging a summary report. */
4447 switch (fm.command) {
4453 case OFPFC_MODIFY_STRICT:
4454 ofproto->n_modify++;
4458 case OFPFC_DELETE_STRICT:
4459 ofproto->n_delete++;
4464 if (ofproto->next_op_report == LLONG_MAX) {
4465 ofproto->first_op = now;
4466 ofproto->next_op_report = MAX(now + 10 * 1000,
4467 ofproto->op_backoff);
4468 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
4470 ofproto->last_op = now;
4473 ofpbuf_uninit(&ofpacts);
4479 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4480 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4481 OVS_EXCLUDED(ofproto_mutex)
4485 ovs_mutex_lock(&ofproto_mutex);
4486 if (ofproto->n_pending < 50) {
4487 switch (fm->command) {
4489 error = add_flow(ofproto, ofconn, fm, oh);
4493 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4496 case OFPFC_MODIFY_STRICT:
4497 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4501 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4504 case OFPFC_DELETE_STRICT:
4505 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4509 if (fm->command > 0xff) {
4510 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4511 "flow_mod_table_id extension is not enabled",
4514 error = OFPERR_OFPFMFC_BAD_COMMAND;
4518 ovs_assert(!list_is_empty(&ofproto->pending));
4519 error = OFPROTO_POSTPONE;
4521 ovs_mutex_unlock(&ofproto_mutex);
4523 run_rule_executes(ofproto);
4528 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4530 struct ofputil_role_request request;
4531 struct ofputil_role_request reply;
4535 error = ofputil_decode_role_message(oh, &request);
4540 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4541 if (ofconn_get_role(ofconn) != request.role
4542 && ofconn_has_pending_opgroups(ofconn)) {
4543 return OFPROTO_POSTPONE;
4546 if (request.have_generation_id
4547 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4548 return OFPERR_OFPRRFC_STALE;
4551 ofconn_set_role(ofconn, request.role);
4554 reply.role = ofconn_get_role(ofconn);
4555 reply.have_generation_id = ofconn_get_master_election_id(
4556 ofconn, &reply.generation_id);
4557 buf = ofputil_encode_role_reply(oh, &reply);
4558 ofconn_send_reply(ofconn, buf);
4564 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4565 const struct ofp_header *oh)
4567 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4568 enum ofputil_protocol cur, next;
4570 cur = ofconn_get_protocol(ofconn);
4571 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4572 ofconn_set_protocol(ofconn, next);
4578 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4580 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4581 enum ofputil_protocol cur, next;
4582 enum ofputil_protocol next_base;
4584 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4586 return OFPERR_OFPBRC_EPERM;
4589 cur = ofconn_get_protocol(ofconn);
4590 next = ofputil_protocol_set_base(cur, next_base);
4591 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4592 /* Avoid sending async messages in surprising protocol. */
4593 return OFPROTO_POSTPONE;
4596 ofconn_set_protocol(ofconn, next);
4601 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4602 const struct ofp_header *oh)
4604 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4607 format = ntohl(msg->format);
4608 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4609 return OFPERR_OFPBRC_EPERM;
4612 if (format != ofconn_get_packet_in_format(ofconn)
4613 && ofconn_has_pending_opgroups(ofconn)) {
4614 /* Avoid sending async message in surprsing packet in format. */
4615 return OFPROTO_POSTPONE;
4618 ofconn_set_packet_in_format(ofconn, format);
4623 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4625 const struct nx_async_config *msg = ofpmsg_body(oh);
4626 uint32_t master[OAM_N_TYPES];
4627 uint32_t slave[OAM_N_TYPES];
4629 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4630 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4631 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4633 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4634 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4635 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4637 ofconn_set_async_config(ofconn, master, slave);
4638 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4639 !ofconn_get_miss_send_len(ofconn)) {
4640 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4647 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4650 uint32_t master[OAM_N_TYPES];
4651 uint32_t slave[OAM_N_TYPES];
4652 struct nx_async_config *msg;
4654 ofconn_get_async_config(ofconn, master, slave);
4655 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4656 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4658 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4659 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4660 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4662 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4663 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4664 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4666 ofconn_send_reply(ofconn, buf);
4672 handle_nxt_set_controller_id(struct ofconn *ofconn,
4673 const struct ofp_header *oh)
4675 const struct nx_controller_id *nci = ofpmsg_body(oh);
4677 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4678 return OFPERR_NXBRC_MUST_BE_ZERO;
4681 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4686 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4690 if (ofconn_has_pending_opgroups(ofconn)) {
4691 return OFPROTO_POSTPONE;
4694 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4695 ? OFPRAW_OFPT10_BARRIER_REPLY
4696 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4697 ofconn_send_reply(ofconn, buf);
4702 ofproto_compose_flow_refresh_update(const struct rule *rule,
4703 enum nx_flow_monitor_flags flags,
4705 OVS_REQUIRES(ofproto_mutex)
4707 struct ofoperation *op = rule->pending;
4708 const struct rule_actions *actions;
4709 struct ofputil_flow_update fu;
4712 if (op && op->type == OFOPERATION_ADD) {
4713 /* We'll report the final flow when the operation completes. Reporting
4714 * it now would cause a duplicate report later. */
4718 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4719 ? NXFME_ADDED : NXFME_MODIFIED);
4721 ovs_mutex_lock(&rule->mutex);
4722 fu.idle_timeout = rule->idle_timeout;
4723 fu.hard_timeout = rule->hard_timeout;
4724 ovs_mutex_unlock(&rule->mutex);
4725 fu.table_id = rule->table_id;
4726 fu.cookie = rule->flow_cookie;
4727 minimatch_expand(&rule->cr.match, &match);
4729 fu.priority = rule->cr.priority;
4731 if (!(flags & NXFMF_ACTIONS)) {
4734 actions = rule_get_actions(rule);
4736 /* An operation is in progress. Use the previous version of the flow's
4737 * actions, so that when the operation commits we report the change. */
4739 case OFOPERATION_ADD:
4742 case OFOPERATION_MODIFY:
4743 case OFOPERATION_REPLACE:
4744 actions = op->actions ? op->actions : rule_get_actions(rule);
4747 case OFOPERATION_DELETE:
4748 actions = rule_get_actions(rule);
4755 fu.ofpacts = actions ? actions->ofpacts : NULL;
4756 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4758 if (list_is_empty(msgs)) {
4759 ofputil_start_flow_update(msgs);
4761 ofputil_append_flow_update(&fu, msgs);
4765 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4767 OVS_REQUIRES(ofproto_mutex)
4771 for (i = 0; i < rules->n; i++) {
4772 struct rule *rule = rules->rules[i];
4773 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4774 rule->monitor_flags = 0;
4776 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4781 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4782 struct rule *rule, uint64_t seqno,
4783 struct rule_collection *rules)
4784 OVS_REQUIRES(ofproto_mutex)
4786 enum nx_flow_monitor_flags update;
4788 if (ofproto_rule_is_hidden(rule)) {
4793 ? ofoperation_has_out_port(rule->pending, m->out_port)
4794 : ofproto_rule_has_out_port(rule, m->out_port))) {
4799 if (rule->add_seqno > seqno) {
4800 update = NXFMF_ADD | NXFMF_MODIFY;
4801 } else if (rule->modify_seqno > seqno) {
4802 update = NXFMF_MODIFY;
4807 if (!(m->flags & update)) {
4811 update = NXFMF_INITIAL;
4814 if (!rule->monitor_flags) {
4815 rule_collection_add(rules, rule);
4817 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4821 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4823 struct rule_collection *rules)
4824 OVS_REQUIRES(ofproto_mutex)
4826 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4827 const struct ofoperation *op;
4828 const struct oftable *table;
4829 struct cls_rule target;
4831 cls_rule_init_from_minimatch(&target, &m->match, 0);
4832 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4833 struct cls_cursor cursor;
4836 fat_rwlock_rdlock(&table->cls.rwlock);
4837 cls_cursor_init(&cursor, &table->cls, &target);
4838 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4839 ovs_assert(!rule->pending); /* XXX */
4840 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4842 fat_rwlock_unlock(&table->cls.rwlock);
4845 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4846 struct rule *rule = op->rule;
4848 if (((m->table_id == 0xff
4849 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4850 : m->table_id == rule->table_id))
4851 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4852 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4855 cls_rule_destroy(&target);
4859 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4860 struct rule_collection *rules)
4861 OVS_REQUIRES(ofproto_mutex)
4863 if (m->flags & NXFMF_INITIAL) {
4864 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4869 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4870 uint64_t seqno, struct rule_collection *rules)
4871 OVS_REQUIRES(ofproto_mutex)
4873 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4877 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4878 OVS_EXCLUDED(ofproto_mutex)
4880 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4881 struct ofmonitor **monitors;
4882 size_t n_monitors, allocated_monitors;
4883 struct rule_collection rules;
4884 struct list replies;
4890 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4892 n_monitors = allocated_monitors = 0;
4894 ovs_mutex_lock(&ofproto_mutex);
4896 struct ofputil_flow_monitor_request request;
4897 struct ofmonitor *m;
4900 retval = ofputil_decode_flow_monitor_request(&request, &b);
4901 if (retval == EOF) {
4903 } else if (retval) {
4908 if (request.table_id != 0xff
4909 && request.table_id >= ofproto->n_tables) {
4910 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4914 error = ofmonitor_create(&request, ofconn, &m);
4919 if (n_monitors >= allocated_monitors) {
4920 monitors = x2nrealloc(monitors, &allocated_monitors,
4923 monitors[n_monitors++] = m;
4926 rule_collection_init(&rules);
4927 for (i = 0; i < n_monitors; i++) {
4928 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4931 ofpmp_init(&replies, oh);
4932 ofmonitor_compose_refresh_updates(&rules, &replies);
4933 ovs_mutex_unlock(&ofproto_mutex);
4935 rule_collection_destroy(&rules);
4937 ofconn_send_replies(ofconn, &replies);
4943 for (i = 0; i < n_monitors; i++) {
4944 ofmonitor_destroy(monitors[i]);
4947 ovs_mutex_unlock(&ofproto_mutex);
4953 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4954 OVS_EXCLUDED(ofproto_mutex)
4956 struct ofmonitor *m;
4960 id = ofputil_decode_flow_monitor_cancel(oh);
4962 ovs_mutex_lock(&ofproto_mutex);
4963 m = ofmonitor_lookup(ofconn, id);
4965 ofmonitor_destroy(m);
4968 error = OFPERR_NXBRC_FM_BAD_ID;
4970 ovs_mutex_unlock(&ofproto_mutex);
4975 /* Meters implementation.
4977 * Meter table entry, indexed by the OpenFlow meter_id.
4978 * These are always dynamically allocated to allocate enough space for
4980 * 'created' is used to compute the duration for meter stats.
4981 * 'list rules' is needed so that we can delete the dependent rules when the
4982 * meter table entry is deleted.
4983 * 'provider_meter_id' is for the provider's private use.
4986 long long int created; /* Time created. */
4987 struct list rules; /* List of "struct rule_dpif"s. */
4988 ofproto_meter_id provider_meter_id;
4989 uint16_t flags; /* Meter flags. */
4990 uint16_t n_bands; /* Number of meter bands. */
4991 struct ofputil_meter_band *bands;
4995 * This is used in instruction validation at flow set-up time,
4996 * as flows may not use non-existing meters.
4997 * Return value of UINT32_MAX signifies an invalid meter.
5000 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5002 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5003 const struct meter *meter = ofproto->meters[of_meter_id];
5005 return meter->provider_meter_id.uint32;
5012 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5016 meter->flags = config->flags;
5017 meter->n_bands = config->n_bands;
5018 meter->bands = xmemdup(config->bands,
5019 config->n_bands * sizeof *meter->bands);
5022 static struct meter *
5023 meter_create(const struct ofputil_meter_config *config,
5024 ofproto_meter_id provider_meter_id)
5026 struct meter *meter;
5028 meter = xzalloc(sizeof *meter);
5029 meter->provider_meter_id = provider_meter_id;
5030 meter->created = time_msec();
5031 list_init(&meter->rules);
5033 meter_update(meter, config);
5039 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5040 OVS_REQUIRES(ofproto_mutex)
5043 for (mid = first; mid <= last; ++mid) {
5044 struct meter *meter = ofproto->meters[mid];
5046 ofproto->meters[mid] = NULL;
5047 ofproto->ofproto_class->meter_del(ofproto,
5048 meter->provider_meter_id);
5056 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5058 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5059 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5063 return OFPERR_OFPMMFC_METER_EXISTS;
5066 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5069 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5070 *meterp = meter_create(&mm->meter, provider_meter_id);
5076 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5078 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5080 uint32_t provider_meter_id;
5083 return OFPERR_OFPMMFC_UNKNOWN_METER;
5086 provider_meter_id = meter->provider_meter_id.uint32;
5087 error = ofproto->ofproto_class->meter_set(ofproto,
5088 &meter->provider_meter_id,
5090 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5092 meter_update(meter, &mm->meter);
5098 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5099 struct ofputil_meter_mod *mm)
5100 OVS_EXCLUDED(ofproto_mutex)
5102 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5103 uint32_t meter_id = mm->meter.meter_id;
5104 struct rule_collection rules;
5105 enum ofperr error = 0;
5106 uint32_t first, last;
5108 if (meter_id == OFPM13_ALL) {
5110 last = ofproto->meter_features.max_meters;
5112 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5115 first = last = meter_id;
5118 /* First delete the rules that use this meter. If any of those rules are
5119 * currently being modified, postpone the whole operation until later. */
5120 rule_collection_init(&rules);
5121 ovs_mutex_lock(&ofproto_mutex);
5122 for (meter_id = first; meter_id <= last; ++meter_id) {
5123 struct meter *meter = ofproto->meters[meter_id];
5124 if (meter && !list_is_empty(&meter->rules)) {
5127 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5128 if (rule->pending) {
5129 error = OFPROTO_POSTPONE;
5132 rule_collection_add(&rules, rule);
5137 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5140 /* Delete the meters. */
5141 meter_delete(ofproto, first, last);
5144 ovs_mutex_unlock(&ofproto_mutex);
5145 rule_collection_destroy(&rules);
5151 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5153 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5154 struct ofputil_meter_mod mm;
5155 uint64_t bands_stub[256 / 8];
5156 struct ofpbuf bands;
5160 error = reject_slave_controller(ofconn);
5165 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5167 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5169 goto exit_free_bands;
5172 meter_id = mm.meter.meter_id;
5174 if (mm.command != OFPMC13_DELETE) {
5175 /* Fails also when meters are not implemented by the provider. */
5176 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5177 error = OFPERR_OFPMMFC_INVALID_METER;
5178 goto exit_free_bands;
5179 } else if (meter_id > ofproto->meter_features.max_meters) {
5180 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5181 goto exit_free_bands;
5183 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5184 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5185 goto exit_free_bands;
5189 switch (mm.command) {
5191 error = handle_add_meter(ofproto, &mm);
5194 case OFPMC13_MODIFY:
5195 error = handle_modify_meter(ofproto, &mm);
5198 case OFPMC13_DELETE:
5199 error = handle_delete_meter(ofconn, oh, &mm);
5203 error = OFPERR_OFPMMFC_BAD_COMMAND;
5208 ofpbuf_uninit(&bands);
5213 handle_meter_features_request(struct ofconn *ofconn,
5214 const struct ofp_header *request)
5216 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5217 struct ofputil_meter_features features;
5220 if (ofproto->ofproto_class->meter_get_features) {
5221 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5223 memset(&features, 0, sizeof features);
5225 b = ofputil_encode_meter_features_reply(&features, request);
5227 ofconn_send_reply(ofconn, b);
5232 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5235 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5236 struct list replies;
5237 uint64_t bands_stub[256 / 8];
5238 struct ofpbuf bands;
5239 uint32_t meter_id, first, last;
5241 ofputil_decode_meter_request(request, &meter_id);
5243 if (meter_id == OFPM13_ALL) {
5245 last = ofproto->meter_features.max_meters;
5247 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5248 !ofproto->meters[meter_id]) {
5249 return OFPERR_OFPMMFC_UNKNOWN_METER;
5251 first = last = meter_id;
5254 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5255 ofpmp_init(&replies, request);
5257 for (meter_id = first; meter_id <= last; ++meter_id) {
5258 struct meter *meter = ofproto->meters[meter_id];
5260 continue; /* Skip non-existing meters. */
5262 if (type == OFPTYPE_METER_STATS_REQUEST) {
5263 struct ofputil_meter_stats stats;
5265 stats.meter_id = meter_id;
5267 /* Provider sets the packet and byte counts, we do the rest. */
5268 stats.flow_count = list_size(&meter->rules);
5269 calc_duration(meter->created, time_msec(),
5270 &stats.duration_sec, &stats.duration_nsec);
5271 stats.n_bands = meter->n_bands;
5272 ofpbuf_clear(&bands);
5274 = ofpbuf_put_uninit(&bands,
5275 meter->n_bands * sizeof *stats.bands);
5277 if (!ofproto->ofproto_class->meter_get(ofproto,
5278 meter->provider_meter_id,
5280 ofputil_append_meter_stats(&replies, &stats);
5282 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5283 struct ofputil_meter_config config;
5285 config.meter_id = meter_id;
5286 config.flags = meter->flags;
5287 config.n_bands = meter->n_bands;
5288 config.bands = meter->bands;
5289 ofputil_append_meter_config(&replies, &config);
5293 ofconn_send_replies(ofconn, &replies);
5294 ofpbuf_uninit(&bands);
5299 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5300 struct ofgroup **group)
5301 OVS_TRY_RDLOCK(true, (*group)->rwlock)
5303 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5304 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5305 hash_int(group_id, 0), &ofproto->groups) {
5306 if ((*group)->group_id == group_id) {
5307 ovs_rwlock_rdlock(&(*group)->rwlock);
5308 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5312 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5317 ofproto_group_release(struct ofgroup *group)
5318 OVS_RELEASES(group->rwlock)
5320 ovs_rwlock_unlock(&group->rwlock);
5324 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
5325 struct ofgroup **group)
5326 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
5327 OVS_TRY_WRLOCK(true, (*group)->rwlock)
5329 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5330 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5331 hash_int(group_id, 0), &ofproto->groups) {
5332 if ((*group)->group_id == group_id) {
5333 ovs_rwlock_wrlock(&(*group)->rwlock);
5337 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5342 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5343 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5345 struct ofgroup *grp;
5347 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5348 hash_int(group_id, 0), &ofproto->groups) {
5349 if (grp->group_id == group_id) {
5357 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5358 OVS_EXCLUDED(ofproto->groups_rwlock)
5362 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5363 exists = ofproto_group_exists__(ofproto, group_id);
5364 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5370 group_get_ref_count(struct ofgroup *group)
5371 OVS_EXCLUDED(ofproto_mutex)
5373 struct ofproto *ofproto = group->ofproto;
5374 struct rule_criteria criteria;
5375 struct rule_collection rules;
5380 match_init_catchall(&match);
5381 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5382 OFPP_ANY, group->group_id);
5383 ovs_mutex_lock(&ofproto_mutex);
5384 error = collect_rules_loose(ofproto, &criteria, &rules);
5385 ovs_mutex_unlock(&ofproto_mutex);
5386 rule_criteria_destroy(&criteria);
5388 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5390 rule_collection_destroy(&rules);
5395 append_group_stats(struct ofgroup *group, struct list *replies)
5396 OVS_REQ_RDLOCK(group->rwlock)
5398 struct ofputil_group_stats ogs;
5399 struct ofproto *ofproto = group->ofproto;
5400 long long int now = time_msec();
5403 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5405 /* Provider sets the packet and byte counts, we do the rest. */
5406 ogs.ref_count = group_get_ref_count(group);
5407 ogs.n_buckets = group->n_buckets;
5409 error = (ofproto->ofproto_class->group_get_stats
5410 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5413 ogs.packet_count = UINT64_MAX;
5414 ogs.byte_count = UINT64_MAX;
5415 memset(ogs.bucket_stats, 0xff,
5416 ogs.n_buckets * sizeof *ogs.bucket_stats);
5419 ogs.group_id = group->group_id;
5420 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5422 ofputil_append_group_stats(replies, &ogs);
5424 free(ogs.bucket_stats);
5428 handle_group_stats_request(struct ofconn *ofconn,
5429 const struct ofp_header *request)
5431 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5432 struct list replies;
5434 struct ofgroup *group;
5437 error = ofputil_decode_group_stats_request(request, &group_id);
5442 ofpmp_init(&replies, request);
5444 if (group_id == OFPG_ALL) {
5445 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5446 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5447 ovs_rwlock_rdlock(&group->rwlock);
5448 append_group_stats(group, &replies);
5449 ovs_rwlock_unlock(&group->rwlock);
5451 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5453 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5454 append_group_stats(group, &replies);
5455 ofproto_group_release(group);
5459 ofconn_send_replies(ofconn, &replies);
5465 handle_group_desc_stats_request(struct ofconn *ofconn,
5466 const struct ofp_header *request)
5468 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5469 struct list replies;
5470 struct ofputil_group_desc gds;
5471 struct ofgroup *group;
5473 ofpmp_init(&replies, request);
5475 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5476 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5477 gds.group_id = group->group_id;
5478 gds.type = group->type;
5479 ofputil_append_group_desc_reply(&gds, &group->buckets, &replies);
5481 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5483 ofconn_send_replies(ofconn, &replies);
5489 handle_group_features_stats_request(struct ofconn *ofconn,
5490 const struct ofp_header *request)
5492 struct ofproto *p = ofconn_get_ofproto(ofconn);
5495 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5497 ofconn_send_reply(ofconn, msg);
5504 handle_queue_get_config_request(struct ofconn *ofconn,
5505 const struct ofp_header *oh)
5507 struct ofproto *p = ofconn_get_ofproto(ofconn);
5508 struct netdev_queue_dump queue_dump;
5509 struct ofport *ofport;
5510 unsigned int queue_id;
5511 struct ofpbuf *reply;
5512 struct smap details;
5516 error = ofputil_decode_queue_get_config_request(oh, &request);
5521 ofport = ofproto_get_port(p, request);
5523 return OFPERR_OFPQOFC_BAD_PORT;
5526 reply = ofputil_encode_queue_get_config_reply(oh);
5528 smap_init(&details);
5529 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5530 struct ofputil_queue_config queue;
5532 /* None of the existing queues have compatible properties, so we
5533 * hard-code omitting min_rate and max_rate. */
5534 queue.queue_id = queue_id;
5535 queue.min_rate = UINT16_MAX;
5536 queue.max_rate = UINT16_MAX;
5537 ofputil_append_queue_get_config_reply(reply, &queue);
5539 smap_destroy(&details);
5541 ofconn_send_reply(ofconn, reply);
5546 /* Implements OFPGC11_ADD
5547 * in which no matching flow already exists in the flow table.
5549 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5550 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5551 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5552 * initiated now but may be retried later.
5554 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5555 * ownership remains with the caller.
5557 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5560 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5562 struct ofgroup *ofgroup;
5565 if (gm->group_id > OFPG_MAX) {
5566 return OFPERR_OFPGMFC_INVALID_GROUP;
5568 if (gm->type > OFPGT11_FF) {
5569 return OFPERR_OFPGMFC_BAD_TYPE;
5572 /* Allocate new group and initialize it. */
5573 ofgroup = ofproto->ofproto_class->group_alloc();
5575 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
5576 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5579 ovs_rwlock_init(&ofgroup->rwlock);
5580 ofgroup->ofproto = ofproto;
5581 ofgroup->group_id = gm->group_id;
5582 ofgroup->type = gm->type;
5583 ofgroup->created = ofgroup->modified = time_msec();
5585 list_move(&ofgroup->buckets, &gm->buckets);
5586 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5588 /* Construct called BEFORE any locks are held. */
5589 error = ofproto->ofproto_class->group_construct(ofgroup);
5594 /* We wrlock as late as possible to minimize the time we jam any other
5595 * threads: No visible state changes before acquiring the lock. */
5596 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5598 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5599 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5603 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5604 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5609 /* Insert new group. */
5610 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5611 hash_int(ofgroup->group_id, 0));
5612 ofproto->n_groups[ofgroup->type]++;
5614 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5619 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5620 ofproto->ofproto_class->group_destruct(ofgroup);
5622 ofputil_bucket_list_destroy(&ofgroup->buckets);
5623 ofproto->ofproto_class->group_dealloc(ofgroup);
5628 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5631 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5634 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5636 struct ofgroup *ofgroup;
5637 struct ofgroup *victim;
5640 if (gm->group_id > OFPG_MAX) {
5641 return OFPERR_OFPGMFC_INVALID_GROUP;
5644 if (gm->type > OFPGT11_FF) {
5645 return OFPERR_OFPGMFC_BAD_TYPE;
5648 victim = ofproto->ofproto_class->group_alloc();
5650 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5651 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5654 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5655 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5658 /* Both group's and its container's write locks held now.
5659 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5660 if (ofgroup->type != gm->type
5661 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5662 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5667 list_move(&victim->buckets, &ofgroup->buckets);
5669 ofgroup->type = gm->type;
5670 list_move(&ofgroup->buckets, &gm->buckets);
5671 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5673 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5675 ofputil_bucket_list_destroy(&victim->buckets);
5676 ofproto->n_groups[victim->type]--;
5677 ofproto->n_groups[ofgroup->type]++;
5678 ofgroup->modified = time_msec();
5680 ofputil_bucket_list_destroy(&ofgroup->buckets);
5683 list_move(&ofgroup->buckets, &victim->buckets);
5687 ovs_rwlock_unlock(&ofgroup->rwlock);
5688 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5690 ofproto->ofproto_class->group_dealloc(victim);
5695 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5696 OVS_RELEASES(ofproto->groups_rwlock)
5699 struct ofputil_flow_mod fm;
5701 /* Delete all flow entries containing this group in a group action */
5702 match_init_catchall(&match);
5703 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5704 fm.out_group = ofgroup->group_id;
5705 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5707 /* Must wait until existing readers are done,
5708 * while holding the container's write lock at the same time. */
5709 ovs_rwlock_wrlock(&ofgroup->rwlock);
5710 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5711 /* No-one can find this group any more. */
5712 ofproto->n_groups[ofgroup->type]--;
5713 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5715 ofproto->ofproto_class->group_destruct(ofgroup);
5716 ofputil_bucket_list_destroy(&ofgroup->buckets);
5717 ovs_rwlock_unlock(&ofgroup->rwlock);
5718 ovs_rwlock_destroy(&ofgroup->rwlock);
5719 ofproto->ofproto_class->group_dealloc(ofgroup);
5722 /* Implements OFPGC_DELETE. */
5724 delete_group(struct ofproto *ofproto, uint32_t group_id)
5726 struct ofgroup *ofgroup;
5728 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5729 if (group_id == OFPG_ALL) {
5731 struct hmap_node *node = hmap_first(&ofproto->groups);
5735 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5736 delete_group__(ofproto, ofgroup);
5737 /* Lock for each node separately, so that we will not jam the
5738 * other threads for too long time. */
5739 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5742 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5743 hash_int(group_id, 0), &ofproto->groups) {
5744 if (ofgroup->group_id == group_id) {
5745 delete_group__(ofproto, ofgroup);
5750 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5754 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5756 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5757 struct ofputil_group_mod gm;
5760 error = reject_slave_controller(ofconn);
5765 error = ofputil_decode_group_mod(oh, &gm);
5770 switch (gm.command) {
5772 return add_group(ofproto, &gm);
5774 case OFPGC11_MODIFY:
5775 return modify_group(ofproto, &gm);
5777 case OFPGC11_DELETE:
5778 delete_group(ofproto, gm.group_id);
5782 if (gm.command > OFPGC11_DELETE) {
5783 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5784 ofproto->name, gm.command);
5786 return OFPERR_OFPGMFC_BAD_COMMAND;
5790 enum ofp_table_config
5791 table_get_config(const struct ofproto *ofproto, uint8_t table_id)
5794 atomic_read(&ofproto->tables[table_id].config, &value);
5795 return (enum ofp_table_config)value;
5799 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5801 /* Only accept currently supported configurations */
5802 if (tm->config & ~OFPTC11_TABLE_MISS_MASK) {
5803 return OFPERR_OFPTMFC_BAD_CONFIG;
5806 if (tm->table_id == OFPTT_ALL) {
5808 for (i = 0; i < ofproto->n_tables; i++) {
5809 atomic_store(&ofproto->tables[i].config,
5810 (unsigned int)tm->config);
5812 } else if (!check_table_id(ofproto, tm->table_id)) {
5813 return OFPERR_OFPTMFC_BAD_TABLE;
5815 atomic_store(&ofproto->tables[tm->table_id].config,
5816 (unsigned int)tm->config);
5823 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5825 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5826 struct ofputil_table_mod tm;
5829 error = reject_slave_controller(ofconn);
5834 error = ofputil_decode_table_mod(oh, &tm);
5839 return table_mod(ofproto, &tm);
5843 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5844 OVS_EXCLUDED(ofproto_mutex)
5846 const struct ofp_header *oh = msg->data;
5850 error = ofptype_decode(&type, oh);
5854 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5855 && ofpmp_more(oh)) {
5856 /* We have no buffer implementation for multipart requests.
5857 * Report overflow for requests which consists of multiple
5859 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5863 /* OpenFlow requests. */
5864 case OFPTYPE_ECHO_REQUEST:
5865 return handle_echo_request(ofconn, oh);
5867 case OFPTYPE_FEATURES_REQUEST:
5868 return handle_features_request(ofconn, oh);
5870 case OFPTYPE_GET_CONFIG_REQUEST:
5871 return handle_get_config_request(ofconn, oh);
5873 case OFPTYPE_SET_CONFIG:
5874 return handle_set_config(ofconn, oh);
5876 case OFPTYPE_PACKET_OUT:
5877 return handle_packet_out(ofconn, oh);
5879 case OFPTYPE_PORT_MOD:
5880 return handle_port_mod(ofconn, oh);
5882 case OFPTYPE_FLOW_MOD:
5883 return handle_flow_mod(ofconn, oh);
5885 case OFPTYPE_GROUP_MOD:
5886 return handle_group_mod(ofconn, oh);
5888 case OFPTYPE_TABLE_MOD:
5889 return handle_table_mod(ofconn, oh);
5891 case OFPTYPE_METER_MOD:
5892 return handle_meter_mod(ofconn, oh);
5894 case OFPTYPE_BARRIER_REQUEST:
5895 return handle_barrier_request(ofconn, oh);
5897 case OFPTYPE_ROLE_REQUEST:
5898 return handle_role_request(ofconn, oh);
5900 /* OpenFlow replies. */
5901 case OFPTYPE_ECHO_REPLY:
5904 /* Nicira extension requests. */
5905 case OFPTYPE_FLOW_MOD_TABLE_ID:
5906 return handle_nxt_flow_mod_table_id(ofconn, oh);
5908 case OFPTYPE_SET_FLOW_FORMAT:
5909 return handle_nxt_set_flow_format(ofconn, oh);
5911 case OFPTYPE_SET_PACKET_IN_FORMAT:
5912 return handle_nxt_set_packet_in_format(ofconn, oh);
5914 case OFPTYPE_SET_CONTROLLER_ID:
5915 return handle_nxt_set_controller_id(ofconn, oh);
5917 case OFPTYPE_FLOW_AGE:
5918 /* Nothing to do. */
5921 case OFPTYPE_FLOW_MONITOR_CANCEL:
5922 return handle_flow_monitor_cancel(ofconn, oh);
5924 case OFPTYPE_SET_ASYNC_CONFIG:
5925 return handle_nxt_set_async_config(ofconn, oh);
5927 case OFPTYPE_GET_ASYNC_REQUEST:
5928 return handle_nxt_get_async_request(ofconn, oh);
5930 /* Statistics requests. */
5931 case OFPTYPE_DESC_STATS_REQUEST:
5932 return handle_desc_stats_request(ofconn, oh);
5934 case OFPTYPE_FLOW_STATS_REQUEST:
5935 return handle_flow_stats_request(ofconn, oh);
5937 case OFPTYPE_AGGREGATE_STATS_REQUEST:
5938 return handle_aggregate_stats_request(ofconn, oh);
5940 case OFPTYPE_TABLE_STATS_REQUEST:
5941 return handle_table_stats_request(ofconn, oh);
5943 case OFPTYPE_PORT_STATS_REQUEST:
5944 return handle_port_stats_request(ofconn, oh);
5946 case OFPTYPE_QUEUE_STATS_REQUEST:
5947 return handle_queue_stats_request(ofconn, oh);
5949 case OFPTYPE_PORT_DESC_STATS_REQUEST:
5950 return handle_port_desc_stats_request(ofconn, oh);
5952 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
5953 return handle_flow_monitor_request(ofconn, oh);
5955 case OFPTYPE_METER_STATS_REQUEST:
5956 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
5957 return handle_meter_request(ofconn, oh, type);
5959 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
5960 return handle_meter_features_request(ofconn, oh);
5962 case OFPTYPE_GROUP_STATS_REQUEST:
5963 return handle_group_stats_request(ofconn, oh);
5965 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
5966 return handle_group_desc_stats_request(ofconn, oh);
5968 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
5969 return handle_group_features_stats_request(ofconn, oh);
5971 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
5972 return handle_queue_get_config_request(ofconn, oh);
5976 case OFPTYPE_FEATURES_REPLY:
5977 case OFPTYPE_GET_CONFIG_REPLY:
5978 case OFPTYPE_PACKET_IN:
5979 case OFPTYPE_FLOW_REMOVED:
5980 case OFPTYPE_PORT_STATUS:
5981 case OFPTYPE_BARRIER_REPLY:
5982 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
5983 case OFPTYPE_DESC_STATS_REPLY:
5984 case OFPTYPE_FLOW_STATS_REPLY:
5985 case OFPTYPE_QUEUE_STATS_REPLY:
5986 case OFPTYPE_PORT_STATS_REPLY:
5987 case OFPTYPE_TABLE_STATS_REPLY:
5988 case OFPTYPE_AGGREGATE_STATS_REPLY:
5989 case OFPTYPE_PORT_DESC_STATS_REPLY:
5990 case OFPTYPE_ROLE_REPLY:
5991 case OFPTYPE_FLOW_MONITOR_PAUSED:
5992 case OFPTYPE_FLOW_MONITOR_RESUMED:
5993 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
5994 case OFPTYPE_GET_ASYNC_REPLY:
5995 case OFPTYPE_GROUP_STATS_REPLY:
5996 case OFPTYPE_GROUP_DESC_STATS_REPLY:
5997 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
5998 case OFPTYPE_METER_STATS_REPLY:
5999 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6000 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6001 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6002 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6003 case OFPTYPE_ROLE_STATUS:
6005 if (ofpmsg_is_stat_request(oh)) {
6006 return OFPERR_OFPBRC_BAD_STAT;
6008 return OFPERR_OFPBRC_BAD_TYPE;
6014 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6015 OVS_EXCLUDED(ofproto_mutex)
6017 int error = handle_openflow__(ofconn, ofp_msg);
6018 if (error && error != OFPROTO_POSTPONE) {
6019 ofconn_send_error(ofconn, ofp_msg->data, error);
6021 COVERAGE_INC(ofproto_recv_openflow);
6022 return error != OFPROTO_POSTPONE;
6025 /* Asynchronous operations. */
6027 /* Creates and returns a new ofopgroup that is not associated with any
6028 * OpenFlow connection.
6030 * The caller should add operations to the returned group with
6031 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6032 static struct ofopgroup *
6033 ofopgroup_create_unattached(struct ofproto *ofproto)
6034 OVS_REQUIRES(ofproto_mutex)
6036 struct ofopgroup *group = xzalloc(sizeof *group);
6037 group->ofproto = ofproto;
6038 list_init(&group->ofproto_node);
6039 list_init(&group->ops);
6040 list_init(&group->ofconn_node);
6044 /* Creates and returns a new ofopgroup for 'ofproto'.
6046 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6047 * connection. The 'request' and 'buffer_id' arguments are ignored.
6049 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6050 * If the ofopgroup eventually fails, then the error reply will include
6051 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6052 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6054 * The caller should add operations to the returned group with
6055 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6056 static struct ofopgroup *
6057 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6058 const struct ofp_header *request, uint32_t buffer_id)
6059 OVS_REQUIRES(ofproto_mutex)
6061 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6063 size_t request_len = ntohs(request->length);
6065 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6067 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6068 group->ofconn = ofconn;
6069 group->request = xmemdup(request, MIN(request_len, 64));
6070 group->buffer_id = buffer_id;
6075 /* Submits 'group' for processing.
6077 * If 'group' contains no operations (e.g. none were ever added, or all of the
6078 * ones that were added completed synchronously), then it is destroyed
6079 * immediately. Otherwise it is added to the ofproto's list of pending
6082 ofopgroup_submit(struct ofopgroup *group)
6083 OVS_REQUIRES(ofproto_mutex)
6085 if (!group->n_running) {
6086 ofopgroup_complete(group);
6088 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6089 group->ofproto->n_pending++;
6094 ofopgroup_complete(struct ofopgroup *group)
6095 OVS_REQUIRES(ofproto_mutex)
6097 struct ofproto *ofproto = group->ofproto;
6099 struct ofconn *abbrev_ofconn;
6100 ovs_be32 abbrev_xid;
6102 struct ofoperation *op, *next_op;
6105 ovs_assert(!group->n_running);
6108 LIST_FOR_EACH (op, group_node, &group->ops) {
6115 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6116 LIST_FOR_EACH (op, group_node, &group->ops) {
6117 if (op->type != OFOPERATION_DELETE) {
6118 struct ofpbuf *packet;
6121 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6124 struct rule_execute *re;
6128 ofproto_rule_ref(op->rule);
6130 re = xmalloc(sizeof *re);
6131 re->rule = op->rule;
6132 re->in_port = in_port;
6133 re->packet = packet;
6135 if (!guarded_list_push_back(&ofproto->rule_executes,
6136 &re->list_node, 1024)) {
6137 ofproto_rule_unref(op->rule);
6138 ofpbuf_delete(re->packet);
6147 if (!error && !list_is_empty(&group->ofconn_node)) {
6148 abbrev_ofconn = group->ofconn;
6149 abbrev_xid = group->request->xid;
6151 abbrev_ofconn = NULL;
6152 abbrev_xid = htonl(0);
6154 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6155 struct rule *rule = op->rule;
6157 /* We generally want to report the change to active OpenFlow flow
6158 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6160 - The operation failed.
6162 - The affected rule is not visible to controllers.
6164 - The operation's only effect was to update rule->modified. */
6166 || ofproto_rule_is_hidden(rule)
6167 || (op->type == OFOPERATION_MODIFY
6169 && rule->flow_cookie == op->flow_cookie))) {
6170 /* Check that we can just cast from ofoperation_type to
6171 * nx_flow_update_event. */
6172 enum nx_flow_update_event event_type;
6175 case OFOPERATION_ADD:
6176 case OFOPERATION_REPLACE:
6177 event_type = NXFME_ADDED;
6180 case OFOPERATION_DELETE:
6181 event_type = NXFME_DELETED;
6184 case OFOPERATION_MODIFY:
6185 event_type = NXFME_MODIFIED;
6192 ofmonitor_report(ofproto->connmgr, rule, event_type,
6193 op->reason, abbrev_ofconn, abbrev_xid);
6196 rule->pending = NULL;
6199 case OFOPERATION_ADD:
6203 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6204 if (vid_mask == VLAN_VID_MASK) {
6205 if (ofproto->vlan_bitmap) {
6206 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6207 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6208 bitmap_set1(ofproto->vlan_bitmap, vid);
6209 ofproto->vlans_changed = true;
6212 ofproto->vlans_changed = true;
6216 oftable_remove_rule(rule);
6217 ofproto_rule_unref(rule);
6221 case OFOPERATION_DELETE:
6222 ovs_assert(!op->error);
6223 ofproto_rule_unref(rule);
6227 case OFOPERATION_MODIFY:
6228 case OFOPERATION_REPLACE:
6230 long long int now = time_msec();
6232 ovs_mutex_lock(&rule->mutex);
6233 rule->modified = now;
6234 if (op->type == OFOPERATION_REPLACE) {
6235 rule->created = now;
6237 ovs_mutex_unlock(&rule->mutex);
6239 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6240 ovs_mutex_lock(&rule->mutex);
6241 rule->idle_timeout = op->idle_timeout;
6242 rule->hard_timeout = op->hard_timeout;
6243 ovs_mutex_unlock(&rule->mutex);
6245 struct rule_actions *old_actions;
6247 ovs_mutex_lock(&rule->mutex);
6248 old_actions = rule_get_actions(rule);
6249 ovsrcu_set(&rule->actions, op->actions);
6250 ovs_mutex_unlock(&rule->mutex);
6253 rule_actions_destroy(old_actions);
6255 rule->flags = op->flags;
6263 ofoperation_destroy(op);
6266 ofmonitor_flush(ofproto->connmgr);
6268 if (!list_is_empty(&group->ofproto_node)) {
6269 ovs_assert(ofproto->n_pending > 0);
6270 ofproto->n_pending--;
6271 list_remove(&group->ofproto_node);
6273 if (!list_is_empty(&group->ofconn_node)) {
6274 list_remove(&group->ofconn_node);
6276 ofconn_send_error(group->ofconn, group->request, error);
6278 connmgr_retry(ofproto->connmgr);
6280 free(group->request);
6284 /* Initiates a new operation on 'rule', of the specified 'type', within
6285 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6287 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6288 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6290 * Returns the newly created ofoperation (which is also available as
6291 * rule->pending). */
6292 static struct ofoperation *
6293 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6294 enum ofoperation_type type,
6295 enum ofp_flow_removed_reason reason)
6296 OVS_REQUIRES(ofproto_mutex)
6298 struct ofproto *ofproto = group->ofproto;
6299 struct ofoperation *op;
6301 ovs_assert(!rule->pending);
6303 op = rule->pending = xzalloc(sizeof *op);
6305 list_push_back(&group->ops, &op->group_node);
6308 op->reason = reason;
6309 op->flow_cookie = rule->flow_cookie;
6310 ovs_mutex_lock(&rule->mutex);
6311 op->idle_timeout = rule->idle_timeout;
6312 op->hard_timeout = rule->hard_timeout;
6313 ovs_mutex_unlock(&rule->mutex);
6314 op->flags = rule->flags;
6318 if (type == OFOPERATION_DELETE) {
6319 hmap_insert(&ofproto->deletions, &op->hmap_node,
6320 cls_rule_hash(&rule->cr, rule->table_id));
6327 ofoperation_destroy(struct ofoperation *op)
6328 OVS_REQUIRES(ofproto_mutex)
6330 struct ofopgroup *group = op->group;
6333 op->rule->pending = NULL;
6335 if (op->type == OFOPERATION_DELETE) {
6336 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6338 list_remove(&op->group_node);
6339 rule_actions_destroy(op->actions);
6343 /* Indicates that 'op' completed with status 'error', which is either 0 to
6344 * indicate success or an OpenFlow error code on failure.
6346 * If 'error' is 0, indicating success, the operation will be committed
6347 * permanently to the flow table.
6349 * If 'error' is nonzero, then generally the operation will be rolled back:
6351 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6352 * restores the original rule. The caller must have uninitialized any
6353 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6354 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6355 * and 7 for the new rule, calling its ->rule_dealloc() function.
6357 * - If 'op' is a "modify flow" operation, ofproto restores the original
6360 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6361 * allowed to fail. It must always succeed.
6363 * Please see the large comment in ofproto/ofproto-provider.h titled
6364 * "Asynchronous Operation Support" for more information. */
6366 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6368 struct ofopgroup *group = op->group;
6370 ovs_assert(group->n_running > 0);
6371 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6374 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6375 /* This function can be called from ->rule_construct(), in which case
6376 * ofproto_mutex is held, or it can be called from ->run(), in which
6377 * case ofproto_mutex is not held. But only in the latter case can we
6378 * arrive here, so we can safely take ofproto_mutex now. */
6379 ovs_mutex_lock(&ofproto_mutex);
6380 ovs_assert(op->rule->pending == op);
6381 ofopgroup_complete(group);
6382 ovs_mutex_unlock(&ofproto_mutex);
6387 pick_datapath_id(const struct ofproto *ofproto)
6389 const struct ofport *port;
6391 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6393 uint8_t ea[ETH_ADDR_LEN];
6396 error = netdev_get_etheraddr(port->netdev, ea);
6398 return eth_addr_to_uint64(ea);
6400 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6401 ofproto->name, netdev_get_name(port->netdev),
6402 ovs_strerror(error));
6404 return ofproto->fallback_dpid;
6408 pick_fallback_dpid(void)
6410 uint8_t ea[ETH_ADDR_LEN];
6411 eth_addr_nicira_random(ea);
6412 return eth_addr_to_uint64(ea);
6415 /* Table overflow policy. */
6417 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6418 * to NULL if the table is not configured to evict rules or if the table
6419 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6420 * or with no timeouts are not evictable.) */
6422 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6423 OVS_REQUIRES(ofproto_mutex)
6425 struct eviction_group *evg;
6428 if (!table->eviction_fields) {
6432 /* In the common case, the outer and inner loops here will each be entered
6435 * - The inner loop normally "return"s in its first iteration. If the
6436 * eviction group has any evictable rules, then it always returns in
6439 * - The outer loop only iterates more than once if the largest eviction
6440 * group has no evictable rules.
6442 * - The outer loop can exit only if table's 'max_flows' is all filled up
6443 * by unevictable rules. */
6444 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6447 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6456 /* Searches 'ofproto' for tables that have more flows than their configured
6457 * maximum and that have flow eviction enabled, and evicts as many flows as
6458 * necessary and currently feasible from them.
6460 * This triggers only when an OpenFlow table has N flows in it and then the
6461 * client configures a maximum number of flows less than N. */
6463 ofproto_evict(struct ofproto *ofproto)
6465 struct oftable *table;
6467 ovs_mutex_lock(&ofproto_mutex);
6468 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6469 evict_rules_from_table(ofproto, table, 0);
6471 ovs_mutex_unlock(&ofproto_mutex);
6474 /* Eviction groups. */
6476 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6477 * rules. The priority contains low-order random bits to ensure that eviction
6478 * groups with the same number of rules are prioritized randomly. */
6480 eviction_group_priority(size_t n_rules)
6482 uint16_t size = MIN(UINT16_MAX, n_rules);
6483 return (size << 16) | random_uint16();
6486 /* Updates 'evg', an eviction_group within 'table', following a change that
6487 * adds or removes rules in 'evg'. */
6489 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6490 OVS_REQUIRES(ofproto_mutex)
6492 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6493 eviction_group_priority(heap_count(&evg->rules)));
6496 /* Destroys 'evg', an eviction_group within 'table':
6498 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6499 * rules themselves, just removes them from the eviction group.)
6501 * - Removes 'evg' from 'table'.
6505 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6506 OVS_REQUIRES(ofproto_mutex)
6508 while (!heap_is_empty(&evg->rules)) {
6511 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6512 rule->eviction_group = NULL;
6514 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6515 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6516 heap_destroy(&evg->rules);
6520 /* Removes 'rule' from its eviction group, if any. */
6522 eviction_group_remove_rule(struct rule *rule)
6523 OVS_REQUIRES(ofproto_mutex)
6525 if (rule->eviction_group) {
6526 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6527 struct eviction_group *evg = rule->eviction_group;
6529 rule->eviction_group = NULL;
6530 heap_remove(&evg->rules, &rule->evg_node);
6531 if (heap_is_empty(&evg->rules)) {
6532 eviction_group_destroy(table, evg);
6534 eviction_group_resized(table, evg);
6539 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6540 * returns the hash value. */
6542 eviction_group_hash_rule(struct rule *rule)
6543 OVS_REQUIRES(ofproto_mutex)
6545 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6546 const struct mf_subfield *sf;
6550 hash = table->eviction_group_id_basis;
6551 miniflow_expand(&rule->cr.match.flow, &flow);
6552 for (sf = table->eviction_fields;
6553 sf < &table->eviction_fields[table->n_eviction_fields];
6556 if (mf_are_prereqs_ok(sf->field, &flow)) {
6557 union mf_value value;
6559 mf_get_value(sf->field, &flow, &value);
6561 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6563 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6564 unsigned int start = sf->ofs + sf->n_bits;
6565 bitwise_zero(&value, sf->field->n_bytes, start,
6566 sf->field->n_bytes * 8 - start);
6568 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6570 hash = hash_int(hash, 0);
6577 /* Returns an eviction group within 'table' with the given 'id', creating one
6579 static struct eviction_group *
6580 eviction_group_find(struct oftable *table, uint32_t id)
6581 OVS_REQUIRES(ofproto_mutex)
6583 struct eviction_group *evg;
6585 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6589 evg = xmalloc(sizeof *evg);
6590 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6591 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6592 eviction_group_priority(0));
6593 heap_init(&evg->rules);
6598 /* Returns an eviction priority for 'rule'. The return value should be
6599 * interpreted so that higher priorities make a rule more attractive candidates
6601 * Called only if have a timeout. */
6603 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6604 OVS_REQUIRES(ofproto_mutex)
6606 long long int expiration = LLONG_MAX;
6607 long long int modified;
6608 uint32_t expiration_offset;
6610 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6611 ovs_mutex_lock(&rule->mutex);
6612 modified = rule->modified;
6613 ovs_mutex_unlock(&rule->mutex);
6615 if (rule->hard_timeout) {
6616 expiration = modified + rule->hard_timeout * 1000;
6618 if (rule->idle_timeout) {
6619 uint64_t packets, bytes;
6621 long long int idle_expiration;
6623 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6624 idle_expiration = used + rule->idle_timeout * 1000;
6625 expiration = MIN(expiration, idle_expiration);
6628 if (expiration == LLONG_MAX) {
6632 /* Calculate the time of expiration as a number of (approximate) seconds
6633 * after program startup.
6635 * This should work OK for program runs that last UINT32_MAX seconds or
6636 * less. Therefore, please restart OVS at least once every 136 years. */
6637 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6639 /* Invert the expiration offset because we're using a max-heap. */
6640 return UINT32_MAX - expiration_offset;
6643 /* Adds 'rule' to an appropriate eviction group for its oftable's
6644 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6645 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6648 * The caller must ensure that 'rule' is not already in an eviction group. */
6650 eviction_group_add_rule(struct rule *rule)
6651 OVS_REQUIRES(ofproto_mutex)
6653 struct ofproto *ofproto = rule->ofproto;
6654 struct oftable *table = &ofproto->tables[rule->table_id];
6657 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6658 * so no additional protection is needed. */
6659 has_timeout = rule->hard_timeout || rule->idle_timeout;
6661 if (table->eviction_fields && has_timeout) {
6662 struct eviction_group *evg;
6664 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6666 rule->eviction_group = evg;
6667 heap_insert(&evg->rules, &rule->evg_node,
6668 rule_eviction_priority(ofproto, rule));
6669 eviction_group_resized(table, evg);
6675 /* Initializes 'table'. */
6677 oftable_init(struct oftable *table)
6679 memset(table, 0, sizeof *table);
6680 classifier_init(&table->cls, flow_segment_u32s);
6681 table->max_flows = UINT_MAX;
6682 atomic_init(&table->config, (unsigned int)OFPTC11_TABLE_MISS_CONTROLLER);
6685 /* Destroys 'table', including its classifier and eviction groups.
6687 * The caller is responsible for freeing 'table' itself. */
6689 oftable_destroy(struct oftable *table)
6691 fat_rwlock_rdlock(&table->cls.rwlock);
6692 ovs_assert(classifier_is_empty(&table->cls));
6693 fat_rwlock_unlock(&table->cls.rwlock);
6694 oftable_disable_eviction(table);
6695 classifier_destroy(&table->cls);
6699 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6700 * string, then 'table' will use its default name.
6702 * This only affects the name exposed for a table exposed through the OpenFlow
6703 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6705 oftable_set_name(struct oftable *table, const char *name)
6707 if (name && name[0]) {
6708 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6709 if (!table->name || strncmp(name, table->name, len)) {
6711 table->name = xmemdup0(name, len);
6719 /* oftables support a choice of two policies when adding a rule would cause the
6720 * number of flows in the table to exceed the configured maximum number: either
6721 * they can refuse to add the new flow or they can evict some existing flow.
6722 * This function configures the former policy on 'table'. */
6724 oftable_disable_eviction(struct oftable *table)
6725 OVS_REQUIRES(ofproto_mutex)
6727 if (table->eviction_fields) {
6728 struct eviction_group *evg, *next;
6730 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6731 &table->eviction_groups_by_id) {
6732 eviction_group_destroy(table, evg);
6734 hmap_destroy(&table->eviction_groups_by_id);
6735 heap_destroy(&table->eviction_groups_by_size);
6737 free(table->eviction_fields);
6738 table->eviction_fields = NULL;
6739 table->n_eviction_fields = 0;
6743 /* oftables support a choice of two policies when adding a rule would cause the
6744 * number of flows in the table to exceed the configured maximum number: either
6745 * they can refuse to add the new flow or they can evict some existing flow.
6746 * This function configures the latter policy on 'table', with fairness based
6747 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6748 * 'n_fields' as 0 disables fairness.) */
6750 oftable_enable_eviction(struct oftable *table,
6751 const struct mf_subfield *fields, size_t n_fields)
6752 OVS_REQUIRES(ofproto_mutex)
6754 struct cls_cursor cursor;
6757 if (table->eviction_fields
6758 && n_fields == table->n_eviction_fields
6760 || !memcmp(fields, table->eviction_fields,
6761 n_fields * sizeof *fields))) {
6766 oftable_disable_eviction(table);
6768 table->n_eviction_fields = n_fields;
6769 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6771 table->eviction_group_id_basis = random_uint32();
6772 hmap_init(&table->eviction_groups_by_id);
6773 heap_init(&table->eviction_groups_by_size);
6775 fat_rwlock_rdlock(&table->cls.rwlock);
6776 cls_cursor_init(&cursor, &table->cls, NULL);
6777 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6778 eviction_group_add_rule(rule);
6780 fat_rwlock_unlock(&table->cls.rwlock);
6783 /* Removes 'rule' from the oftable that contains it. */
6785 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6786 OVS_REQUIRES(ofproto_mutex)
6788 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6790 fat_rwlock_wrlock(&cls->rwlock);
6791 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6792 fat_rwlock_unlock(&cls->rwlock);
6794 cookies_remove(ofproto, rule);
6796 eviction_group_remove_rule(rule);
6797 if (!list_is_empty(&rule->expirable)) {
6798 list_remove(&rule->expirable);
6800 if (!list_is_empty(&rule->meter_list_node)) {
6801 list_remove(&rule->meter_list_node);
6802 list_init(&rule->meter_list_node);
6807 oftable_remove_rule(struct rule *rule)
6808 OVS_REQUIRES(ofproto_mutex)
6810 oftable_remove_rule__(rule->ofproto, rule);
6813 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6814 * the same cls_rule. */
6816 oftable_insert_rule(struct rule *rule)
6817 OVS_REQUIRES(ofproto_mutex)
6819 struct ofproto *ofproto = rule->ofproto;
6820 struct oftable *table = &ofproto->tables[rule->table_id];
6821 struct rule_actions *actions;
6824 ovs_mutex_lock(&rule->mutex);
6825 may_expire = rule->hard_timeout || rule->idle_timeout;
6826 ovs_mutex_unlock(&rule->mutex);
6829 list_insert(&ofproto->expirable, &rule->expirable);
6832 cookies_insert(ofproto, rule);
6834 actions = rule_get_actions(rule);
6835 if (actions->provider_meter_id != UINT32_MAX) {
6836 uint32_t meter_id = ofpacts_get_meter(actions->ofpacts,
6837 actions->ofpacts_len);
6838 struct meter *meter = ofproto->meters[meter_id];
6839 list_insert(&meter->rules, &rule->meter_list_node);
6841 fat_rwlock_wrlock(&table->cls.rwlock);
6842 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6843 fat_rwlock_unlock(&table->cls.rwlock);
6844 eviction_group_add_rule(rule);
6847 /* unixctl commands. */
6850 ofproto_lookup(const char *name)
6852 struct ofproto *ofproto;
6854 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6856 if (!strcmp(ofproto->name, name)) {
6864 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6865 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6867 struct ofproto *ofproto;
6871 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6872 ds_put_format(&results, "%s\n", ofproto->name);
6874 unixctl_command_reply(conn, ds_cstr(&results));
6875 ds_destroy(&results);
6879 ofproto_unixctl_init(void)
6881 static bool registered;
6887 unixctl_command_register("ofproto/list", "", 0, 0,
6888 ofproto_unixctl_list, NULL);
6891 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6893 * This is deprecated. It is only for compatibility with broken device drivers
6894 * in old versions of Linux that do not properly support VLANs when VLAN
6895 * devices are not used. When broken device drivers are no longer in
6896 * widespread use, we will delete these interfaces. */
6898 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6899 * (exactly) by an OpenFlow rule in 'ofproto'. */
6901 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6903 const struct oftable *oftable;
6905 free(ofproto->vlan_bitmap);
6906 ofproto->vlan_bitmap = bitmap_allocate(4096);
6907 ofproto->vlans_changed = false;
6909 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6910 const struct cls_subtable *table;
6912 fat_rwlock_rdlock(&oftable->cls.rwlock);
6913 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.subtables) {
6914 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
6915 const struct cls_rule *rule;
6917 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
6918 uint16_t vid = miniflow_get_vid(&rule->match.flow);
6919 bitmap_set1(vlan_bitmap, vid);
6920 bitmap_set1(ofproto->vlan_bitmap, vid);
6924 fat_rwlock_unlock(&oftable->cls.rwlock);
6928 /* Returns true if new VLANs have come into use by the flow table since the
6929 * last call to ofproto_get_vlan_usage().
6931 * We don't track when old VLANs stop being used. */
6933 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
6935 return ofproto->vlans_changed;
6938 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6939 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6940 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6941 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6942 * then the VLAN device is un-enslaved. */
6944 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
6945 ofp_port_t realdev_ofp_port, int vid)
6947 struct ofport *ofport;
6950 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
6952 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
6954 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
6955 ofproto->name, vlandev_ofp_port);
6959 if (!ofproto->ofproto_class->set_realdev) {
6960 if (!vlandev_ofp_port) {
6963 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
6967 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
6969 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
6970 ofproto->name, vlandev_ofp_port,
6971 netdev_get_name(ofport->netdev), ovs_strerror(error));