2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
50 #include "poll-loop.h"
58 #include "unaligned.h"
63 VLOG_DEFINE_THIS_MODULE(ofproto);
65 COVERAGE_DEFINE(ofproto_flush);
66 COVERAGE_DEFINE(ofproto_packet_out);
67 COVERAGE_DEFINE(ofproto_queue_req);
68 COVERAGE_DEFINE(ofproto_recv_openflow);
69 COVERAGE_DEFINE(ofproto_reinit_ports);
70 COVERAGE_DEFINE(ofproto_update_port);
73 S_OPENFLOW, /* Processing OpenFlow commands. */
74 S_EVICT, /* Evicting flows from over-limit tables. */
75 S_FLUSH, /* Deleting all flow table rules. */
78 enum ofoperation_type {
85 /* A single OpenFlow request can execute any number of operations. The
86 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
87 * ofconn to which an error reply should be sent if necessary.
89 * ofproto initiates some operations internally. These operations are still
90 * assigned to groups but will not have an associated ofconn. */
92 struct ofproto *ofproto; /* Owning ofproto. */
93 struct list ofproto_node; /* In ofproto's "pending" list. */
94 struct list ops; /* List of "struct ofoperation"s. */
95 int n_running; /* Number of ops still pending. */
97 /* Data needed to send OpenFlow reply on failure or to send a buffered
100 * If list_is_empty(ofconn_node) then this ofopgroup never had an
101 * associated ofconn or its ofconn's connection dropped after it initiated
102 * the operation. In the latter case 'ofconn' is a wild pointer that
103 * refers to freed memory, so the 'ofconn' member must be used only if
104 * !list_is_empty(ofconn_node).
106 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
107 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
108 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
109 uint32_t buffer_id; /* Buffer id from original request. */
112 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
113 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
114 const struct ofp_header *,
116 static void ofopgroup_submit(struct ofopgroup *);
117 static void ofopgroup_complete(struct ofopgroup *);
119 /* A single flow table operation. */
121 struct ofopgroup *group; /* Owning group. */
122 struct list group_node; /* In ofopgroup's "ops" list. */
123 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
124 struct rule *rule; /* Rule being operated upon. */
125 enum ofoperation_type type; /* Type of operation. */
127 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
129 const struct rule_actions *actions;
131 /* OFOPERATION_DELETE. */
132 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
134 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
135 uint16_t idle_timeout; /* Rule's old idle timeout. */
136 uint16_t hard_timeout; /* Rule's old hard timeout. */
137 enum ofputil_flow_mod_flags flags; /* Rule's old flags. */
138 enum ofperr error; /* 0 if no error. */
141 static struct ofoperation *ofoperation_create(struct ofopgroup *,
143 enum ofoperation_type,
144 enum ofp_flow_removed_reason);
145 static void ofoperation_destroy(struct ofoperation *);
148 static void oftable_init(struct oftable *);
149 static void oftable_destroy(struct oftable *);
151 static void oftable_set_name(struct oftable *, const char *name);
153 static void oftable_disable_eviction(struct oftable *);
154 static void oftable_enable_eviction(struct oftable *,
155 const struct mf_subfield *fields,
158 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
159 static void oftable_remove_rule__(struct ofproto *, struct rule *)
160 OVS_REQUIRES(ofproto_mutex);
161 static void oftable_insert_rule(struct rule *);
163 /* A set of rules within a single OpenFlow table (oftable) that have the same
164 * values for the oftable's eviction_fields. A rule to be evicted, when one is
165 * needed, is taken from the eviction group that contains the greatest number
168 * An oftable owns any number of eviction groups, each of which contains any
171 * Membership in an eviction group is imprecise, based on the hash of the
172 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
173 * That is, if two rules have different eviction_fields, but those
174 * eviction_fields hash to the same value, then they will belong to the same
175 * eviction_group anyway.
177 * (When eviction is not enabled on an oftable, we don't track any eviction
178 * groups, to save time and space.) */
179 struct eviction_group {
180 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
181 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
182 struct heap rules; /* Contains "struct rule"s. */
185 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep);
186 static void ofproto_evict(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
187 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *);
188 static void eviction_group_add_rule(struct rule *);
189 static void eviction_group_remove_rule(struct rule *);
191 /* Criteria that flow_mod and other operations use for selecting rules on
192 * which to operate. */
193 struct rule_criteria {
194 /* An OpenFlow table or 255 for all tables. */
197 /* OpenFlow matching criteria. Interpreted different in "loose" way by
198 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
199 * defined in the OpenFlow spec. */
202 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
203 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
204 * The rule will not be selected if M is 1 and B != C. */
206 ovs_be64 cookie_mask;
208 /* Selection based on actions within a rule:
210 * If out_port != OFPP_ANY, selects only rules that output to out_port.
211 * If out_group != OFPG_ALL, select only rules that output to out_group. */
216 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
217 const struct match *match,
218 unsigned int priority,
219 ovs_be64 cookie, ovs_be64 cookie_mask,
220 ofp_port_t out_port, uint32_t out_group);
221 static void rule_criteria_destroy(struct rule_criteria *);
223 /* A packet that needs to be passed to rule_execute().
225 * (We can't do this immediately from ofopgroup_complete() because that holds
226 * ofproto_mutex, which rule_execute() needs released.) */
227 struct rule_execute {
228 struct list list_node; /* In struct ofproto's "rule_executes" list. */
229 struct rule *rule; /* Owns a reference to the rule. */
231 struct ofpbuf *packet; /* Owns the packet. */
234 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
235 static void destroy_rule_executes(struct ofproto *);
238 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
239 static void ofport_destroy(struct ofport *);
241 static void update_port(struct ofproto *, const char *devname);
242 static int init_ports(struct ofproto *);
243 static void reinit_ports(struct ofproto *);
245 static long long int ofport_get_usage(const struct ofproto *,
246 ofp_port_t ofp_port);
247 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
248 long long int last_used);
249 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
253 * Keeps track of the currently used and recently used ofport values and is
254 * used to prevent immediate recycling of ofport values. */
255 struct ofport_usage {
256 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
257 ofp_port_t ofp_port; /* OpenFlow port number. */
258 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
259 represents in-use ofports. */
263 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
264 static bool rule_is_modifiable(const struct rule *rule,
265 enum ofputil_flow_mod_flags flag);
268 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
269 struct ofputil_flow_mod *,
270 const struct ofp_header *);
271 static void do_add_flow(struct ofproto *, struct ofconn *,
272 const struct ofp_header *request, uint32_t buffer_id,
274 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
275 struct ofputil_flow_mod *,
276 const struct ofp_header *,
277 const struct rule_collection *);
278 static void delete_flow__(struct rule *rule, struct ofopgroup *,
279 enum ofp_flow_removed_reason)
280 OVS_REQUIRES(ofproto_mutex);
281 static bool ofproto_group_exists__(const struct ofproto *ofproto,
283 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
284 static bool ofproto_group_exists(const struct ofproto *ofproto,
286 OVS_EXCLUDED(ofproto->groups_rwlock);
287 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
288 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
289 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
290 struct ofputil_flow_mod *,
291 const struct ofp_header *)
292 OVS_EXCLUDED(ofproto_mutex);
293 static void calc_duration(long long int start, long long int now,
294 uint32_t *sec, uint32_t *nsec);
297 static uint64_t pick_datapath_id(const struct ofproto *);
298 static uint64_t pick_fallback_dpid(void);
299 static void ofproto_destroy__(struct ofproto *);
300 static void update_mtu(struct ofproto *, struct ofport *);
301 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
304 static void ofproto_unixctl_init(void);
306 /* All registered ofproto classes, in probe order. */
307 static const struct ofproto_class **ofproto_classes;
308 static size_t n_ofproto_classes;
309 static size_t allocated_ofproto_classes;
311 /* Global lock that protects all flow table operations. */
312 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
314 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
315 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
317 size_t n_handlers, n_revalidators;
319 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
320 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
322 /* Initial mappings of port to OpenFlow number mappings. */
323 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
325 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
327 /* The default value of true waits for flow restore. */
328 static bool flow_restore_wait = true;
330 /* Must be called to initialize the ofproto library.
332 * The caller may pass in 'iface_hints', which contains an shash of
333 * "iface_hint" elements indexed by the interface's name. The provider
334 * may use these hints to describe the startup configuration in order to
335 * reinitialize its state. The caller owns the provided data, so a
336 * provider will make copies of anything required. An ofproto provider
337 * will remove any existing state that is not described by the hint, and
338 * may choose to remove it all. */
340 ofproto_init(const struct shash *iface_hints)
342 struct shash_node *node;
345 ofproto_class_register(&ofproto_dpif_class);
347 /* Make a local copy, since we don't own 'iface_hints' elements. */
348 SHASH_FOR_EACH(node, iface_hints) {
349 const struct iface_hint *orig_hint = node->data;
350 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
351 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
353 new_hint->br_name = xstrdup(orig_hint->br_name);
354 new_hint->br_type = xstrdup(br_type);
355 new_hint->ofp_port = orig_hint->ofp_port;
357 shash_add(&init_ofp_ports, node->name, new_hint);
360 for (i = 0; i < n_ofproto_classes; i++) {
361 ofproto_classes[i]->init(&init_ofp_ports);
365 /* 'type' should be a normalized datapath type, as returned by
366 * ofproto_normalize_type(). Returns the corresponding ofproto_class
367 * structure, or a null pointer if there is none registered for 'type'. */
368 static const struct ofproto_class *
369 ofproto_class_find__(const char *type)
373 for (i = 0; i < n_ofproto_classes; i++) {
374 const struct ofproto_class *class = ofproto_classes[i];
379 class->enumerate_types(&types);
380 found = sset_contains(&types, type);
381 sset_destroy(&types);
387 VLOG_WARN("unknown datapath type %s", type);
391 /* Registers a new ofproto class. After successful registration, new ofprotos
392 * of that type can be created using ofproto_create(). */
394 ofproto_class_register(const struct ofproto_class *new_class)
398 for (i = 0; i < n_ofproto_classes; i++) {
399 if (ofproto_classes[i] == new_class) {
404 if (n_ofproto_classes >= allocated_ofproto_classes) {
405 ofproto_classes = x2nrealloc(ofproto_classes,
406 &allocated_ofproto_classes,
407 sizeof *ofproto_classes);
409 ofproto_classes[n_ofproto_classes++] = new_class;
413 /* Unregisters a datapath provider. 'type' must have been previously
414 * registered and not currently be in use by any ofprotos. After
415 * unregistration new datapaths of that type cannot be opened using
416 * ofproto_create(). */
418 ofproto_class_unregister(const struct ofproto_class *class)
422 for (i = 0; i < n_ofproto_classes; i++) {
423 if (ofproto_classes[i] == class) {
424 for (i++; i < n_ofproto_classes; i++) {
425 ofproto_classes[i - 1] = ofproto_classes[i];
431 VLOG_WARN("attempted to unregister an ofproto class that is not "
436 /* Clears 'types' and enumerates all registered ofproto types into it. The
437 * caller must first initialize the sset. */
439 ofproto_enumerate_types(struct sset *types)
444 for (i = 0; i < n_ofproto_classes; i++) {
445 ofproto_classes[i]->enumerate_types(types);
449 /* Returns the fully spelled out name for the given ofproto 'type'.
451 * Normalized type string can be compared with strcmp(). Unnormalized type
452 * string might be the same even if they have different spellings. */
454 ofproto_normalize_type(const char *type)
456 return type && type[0] ? type : "system";
459 /* Clears 'names' and enumerates the names of all known created ofprotos with
460 * the given 'type'. The caller must first initialize the sset. Returns 0 if
461 * successful, otherwise a positive errno value.
463 * Some kinds of datapaths might not be practically enumerable. This is not
464 * considered an error. */
466 ofproto_enumerate_names(const char *type, struct sset *names)
468 const struct ofproto_class *class = ofproto_class_find__(type);
469 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
473 ofproto_create(const char *datapath_name, const char *datapath_type,
474 struct ofproto **ofprotop)
476 const struct ofproto_class *class;
477 struct ofproto *ofproto;
483 ofproto_unixctl_init();
485 datapath_type = ofproto_normalize_type(datapath_type);
486 class = ofproto_class_find__(datapath_type);
488 VLOG_WARN("could not create datapath %s of unknown type %s",
489 datapath_name, datapath_type);
493 ofproto = class->alloc();
495 VLOG_ERR("failed to allocate datapath %s of type %s",
496 datapath_name, datapath_type);
501 ovs_mutex_lock(&ofproto_mutex);
502 memset(ofproto, 0, sizeof *ofproto);
503 ofproto->ofproto_class = class;
504 ofproto->name = xstrdup(datapath_name);
505 ofproto->type = xstrdup(datapath_type);
506 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
507 hash_string(ofproto->name, 0));
508 ofproto->datapath_id = 0;
509 ofproto->forward_bpdu = false;
510 ofproto->fallback_dpid = pick_fallback_dpid();
511 ofproto->mfr_desc = NULL;
512 ofproto->hw_desc = NULL;
513 ofproto->sw_desc = NULL;
514 ofproto->serial_desc = NULL;
515 ofproto->dp_desc = NULL;
516 ofproto->frag_handling = OFPC_FRAG_NORMAL;
517 hmap_init(&ofproto->ports);
518 hmap_init(&ofproto->ofport_usage);
519 shash_init(&ofproto->port_by_name);
520 simap_init(&ofproto->ofp_requests);
521 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
522 ofproto->eviction_group_timer = LLONG_MIN;
523 ofproto->tables = NULL;
524 ofproto->n_tables = 0;
525 hindex_init(&ofproto->cookies);
526 list_init(&ofproto->expirable);
527 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
528 ofproto->state = S_OPENFLOW;
529 list_init(&ofproto->pending);
530 ofproto->n_pending = 0;
531 hmap_init(&ofproto->deletions);
532 guarded_list_init(&ofproto->rule_executes);
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 the status of BFD on 'ofport'. Returns 0 on
1019 * success. Returns a negative number if there is no status change since
1020 * last update. Returns a positive errno otherwise. Has no effect if
1021 * 'ofp_port' is not an OpenFlow port in 'ofproto'.
1023 * The caller must provide and own '*status'. */
1025 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1026 struct smap *status)
1028 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1029 return (ofport && ofproto->ofproto_class->get_bfd_status
1030 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1034 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1035 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1036 * 0 if LACP partner information is not current (generally indicating a
1037 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1039 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1041 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1042 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1043 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1049 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1050 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1051 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1052 * configuration plus, if there is more than one slave, a bonding
1055 * If 'aux' is already registered then this function updates its configuration
1056 * to 's'. Otherwise, this function registers a new bundle.
1058 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1061 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1062 const struct ofproto_bundle_settings *s)
1064 return (ofproto->ofproto_class->bundle_set
1065 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1069 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1070 * If no such bundle has been registered, this has no effect. */
1072 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1074 return ofproto_bundle_register(ofproto, aux, NULL);
1078 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1079 * If 'aux' is already registered then this function updates its configuration
1080 * to 's'. Otherwise, this function registers a new mirror. */
1082 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1083 const struct ofproto_mirror_settings *s)
1085 return (ofproto->ofproto_class->mirror_set
1086 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1090 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1091 * If no mirror has been registered, this has no effect. */
1093 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1095 return ofproto_mirror_register(ofproto, aux, NULL);
1098 /* Retrieves statistics from mirror associated with client data pointer
1099 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1100 * 'bytes', respectively. If a particular counters is not supported,
1101 * the appropriate argument is set to UINT64_MAX. */
1103 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1104 uint64_t *packets, uint64_t *bytes)
1106 if (!ofproto->ofproto_class->mirror_get_stats) {
1107 *packets = *bytes = UINT64_MAX;
1111 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1115 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1116 * which all packets are flooded, instead of using MAC learning. If
1117 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1119 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1122 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1124 return (ofproto->ofproto_class->set_flood_vlans
1125 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1129 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1130 * output for a mirror. */
1132 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1134 return (ofproto->ofproto_class->is_mirror_output_bundle
1135 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1139 /* Configuration of OpenFlow tables. */
1141 /* Returns the number of OpenFlow tables in 'ofproto'. */
1143 ofproto_get_n_tables(const struct ofproto *ofproto)
1145 return ofproto->n_tables;
1148 /* Returns the number of Controller visible OpenFlow tables
1149 * in 'ofproto'. This number will exclude Hidden tables.
1150 * This funtion's return value should be less or equal to that of
1151 * ofproto_get_n_tables() . */
1153 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1155 uint8_t n = ofproto->n_tables;
1157 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1158 * if present, are always at the end.) */
1159 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1166 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1167 * settings from 's'. 'table_id' must be in the range 0 through the number of
1168 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1170 * For read-only tables, only the name may be configured. */
1172 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1173 const struct ofproto_table_settings *s)
1175 struct oftable *table;
1177 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1178 table = &ofproto->tables[table_id];
1180 oftable_set_name(table, s->name);
1182 if (table->flags & OFTABLE_READONLY) {
1187 oftable_enable_eviction(table, s->groups, s->n_groups);
1189 oftable_disable_eviction(table);
1192 table->max_flows = s->max_flows;
1193 fat_rwlock_wrlock(&table->cls.rwlock);
1194 if (classifier_count(&table->cls) > table->max_flows
1195 && table->eviction_fields) {
1196 /* 'table' contains more flows than allowed. We might not be able to
1197 * evict them right away because of the asynchronous nature of flow
1198 * table changes. Schedule eviction for later. */
1199 switch (ofproto->state) {
1201 ofproto->state = S_EVICT;
1205 /* We're already deleting flows, nothing more to do. */
1210 classifier_set_prefix_fields(&table->cls,
1211 s->prefix_fields, s->n_prefix_fields);
1213 fat_rwlock_unlock(&table->cls.rwlock);
1217 ofproto_has_snoops(const struct ofproto *ofproto)
1219 return connmgr_has_snoops(ofproto->connmgr);
1223 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1225 connmgr_get_snoops(ofproto->connmgr, snoops);
1229 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1231 OVS_REQUIRES(ofproto_mutex)
1233 struct ofopgroup *group;
1235 ovs_assert(!rule->pending);
1237 group = ofopgroup_create_unattached(ofproto);
1238 delete_flow__(rule, group, reason);
1239 ofopgroup_submit(group);
1242 /* Deletes 'rule' from 'ofproto'.
1244 * Within an ofproto implementation, this function allows an ofproto
1245 * implementation to destroy any rules that remain when its ->destruct()
1246 * function is called. This function is not suitable for use elsewhere in an
1247 * ofproto implementation.
1249 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1250 * Cycle" in ofproto-provider.h. */
1252 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1253 OVS_EXCLUDED(ofproto_mutex)
1255 struct ofopgroup *group;
1257 ovs_mutex_lock(&ofproto_mutex);
1258 ovs_assert(!rule->pending);
1260 group = ofopgroup_create_unattached(ofproto);
1261 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1262 oftable_remove_rule__(ofproto, rule);
1263 ofproto->ofproto_class->rule_delete(rule);
1264 ofopgroup_submit(group);
1266 ovs_mutex_unlock(&ofproto_mutex);
1270 ofproto_flush__(struct ofproto *ofproto)
1271 OVS_EXCLUDED(ofproto_mutex)
1273 struct oftable *table;
1275 if (ofproto->ofproto_class->flush) {
1276 ofproto->ofproto_class->flush(ofproto);
1279 ovs_mutex_lock(&ofproto_mutex);
1280 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1281 struct rule *rule, *next_rule;
1282 struct cls_cursor cursor;
1284 if (table->flags & OFTABLE_HIDDEN) {
1288 fat_rwlock_rdlock(&table->cls.rwlock);
1289 cls_cursor_init(&cursor, &table->cls, NULL);
1290 fat_rwlock_unlock(&table->cls.rwlock);
1291 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1292 if (!rule->pending) {
1293 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1297 ovs_mutex_unlock(&ofproto_mutex);
1300 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1303 ofproto_destroy__(struct ofproto *ofproto)
1304 OVS_EXCLUDED(ofproto_mutex)
1306 struct oftable *table;
1308 ovs_assert(list_is_empty(&ofproto->pending));
1310 destroy_rule_executes(ofproto);
1311 delete_group(ofproto, OFPG_ALL);
1313 guarded_list_destroy(&ofproto->rule_executes);
1314 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1315 hmap_destroy(&ofproto->groups);
1317 connmgr_destroy(ofproto->connmgr);
1319 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1320 free(ofproto->name);
1321 free(ofproto->type);
1322 free(ofproto->mfr_desc);
1323 free(ofproto->hw_desc);
1324 free(ofproto->sw_desc);
1325 free(ofproto->serial_desc);
1326 free(ofproto->dp_desc);
1327 hmap_destroy(&ofproto->ports);
1328 hmap_destroy(&ofproto->ofport_usage);
1329 shash_destroy(&ofproto->port_by_name);
1330 simap_destroy(&ofproto->ofp_requests);
1332 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1333 oftable_destroy(table);
1335 free(ofproto->tables);
1337 hmap_destroy(&ofproto->deletions);
1339 free(ofproto->vlan_bitmap);
1341 ofproto->ofproto_class->dealloc(ofproto);
1345 ofproto_destroy(struct ofproto *p)
1346 OVS_EXCLUDED(ofproto_mutex)
1348 struct ofport *ofport, *next_ofport;
1349 struct ofport_usage *usage, *next_usage;
1356 meter_delete(p, 1, p->meter_features.max_meters);
1357 p->meter_features.max_meters = 0;
1363 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1364 ofport_destroy(ofport);
1367 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1368 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1372 p->ofproto_class->destruct(p);
1373 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1374 ovsrcu_postpone(ofproto_destroy__, p);
1377 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1378 * kernel datapath, for example, this destroys the datapath in the kernel, and
1379 * with the netdev-based datapath, it tears down the data structures that
1380 * represent the datapath.
1382 * The datapath should not be currently open as an ofproto. */
1384 ofproto_delete(const char *name, const char *type)
1386 const struct ofproto_class *class = ofproto_class_find__(type);
1387 return (!class ? EAFNOSUPPORT
1388 : !class->del ? EACCES
1389 : class->del(type, name));
1393 process_port_change(struct ofproto *ofproto, int error, char *devname)
1395 if (error == ENOBUFS) {
1396 reinit_ports(ofproto);
1397 } else if (!error) {
1398 update_port(ofproto, devname);
1404 ofproto_type_run(const char *datapath_type)
1406 const struct ofproto_class *class;
1409 datapath_type = ofproto_normalize_type(datapath_type);
1410 class = ofproto_class_find__(datapath_type);
1412 error = class->type_run ? class->type_run(datapath_type) : 0;
1413 if (error && error != EAGAIN) {
1414 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1415 datapath_type, ovs_strerror(error));
1421 ofproto_type_wait(const char *datapath_type)
1423 const struct ofproto_class *class;
1425 datapath_type = ofproto_normalize_type(datapath_type);
1426 class = ofproto_class_find__(datapath_type);
1428 if (class->type_wait) {
1429 class->type_wait(datapath_type);
1434 any_pending_ops(const struct ofproto *p)
1435 OVS_EXCLUDED(ofproto_mutex)
1439 ovs_mutex_lock(&ofproto_mutex);
1440 b = !list_is_empty(&p->pending);
1441 ovs_mutex_unlock(&ofproto_mutex);
1447 ofproto_run(struct ofproto *p)
1452 error = p->ofproto_class->run(p);
1453 if (error && error != EAGAIN) {
1454 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1457 run_rule_executes(p);
1459 /* Restore the eviction group heap invariant occasionally. */
1460 if (p->eviction_group_timer < time_msec()) {
1463 p->eviction_group_timer = time_msec() + 1000;
1465 for (i = 0; i < p->n_tables; i++) {
1466 struct oftable *table = &p->tables[i];
1467 struct eviction_group *evg;
1468 struct cls_cursor cursor;
1471 if (!table->eviction_fields) {
1475 ovs_mutex_lock(&ofproto_mutex);
1476 fat_rwlock_rdlock(&table->cls.rwlock);
1477 cls_cursor_init(&cursor, &table->cls, NULL);
1478 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1479 if (rule->idle_timeout || rule->hard_timeout) {
1480 if (!rule->eviction_group) {
1481 eviction_group_add_rule(rule);
1483 heap_raw_change(&rule->evg_node,
1484 rule_eviction_priority(p, rule));
1488 fat_rwlock_unlock(&table->cls.rwlock);
1490 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1491 heap_rebuild(&evg->rules);
1493 ovs_mutex_unlock(&ofproto_mutex);
1497 if (p->ofproto_class->port_poll) {
1500 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1501 process_port_change(p, error, devname);
1505 new_seq = seq_read(connectivity_seq_get());
1506 if (new_seq != p->change_seq) {
1507 struct sset devnames;
1508 const char *devname;
1509 struct ofport *ofport;
1511 /* Update OpenFlow port status for any port whose netdev has changed.
1513 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1514 * destroyed, so it's not safe to update ports directly from the
1515 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1516 * need this two-phase approach. */
1517 sset_init(&devnames);
1518 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1519 uint64_t port_change_seq;
1521 port_change_seq = netdev_get_change_seq(ofport->netdev);
1522 if (ofport->change_seq != port_change_seq) {
1523 ofport->change_seq = port_change_seq;
1524 sset_add(&devnames, netdev_get_name(ofport->netdev));
1527 SSET_FOR_EACH (devname, &devnames) {
1528 update_port(p, devname);
1530 sset_destroy(&devnames);
1532 p->change_seq = new_seq;
1537 connmgr_run(p->connmgr, handle_openflow);
1541 connmgr_run(p->connmgr, NULL);
1543 if (!any_pending_ops(p)) {
1544 p->state = S_OPENFLOW;
1549 connmgr_run(p->connmgr, NULL);
1551 if (!any_pending_ops(p)) {
1552 connmgr_flushed(p->connmgr);
1553 p->state = S_OPENFLOW;
1565 ofproto_wait(struct ofproto *p)
1567 p->ofproto_class->wait(p);
1568 if (p->ofproto_class->port_poll_wait) {
1569 p->ofproto_class->port_poll_wait(p);
1571 seq_wait(connectivity_seq_get(), p->change_seq);
1575 connmgr_wait(p->connmgr, true);
1580 connmgr_wait(p->connmgr, false);
1581 if (!any_pending_ops(p)) {
1582 poll_immediate_wake();
1589 ofproto_is_alive(const struct ofproto *p)
1591 return connmgr_has_controllers(p->connmgr);
1594 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1595 * memory_report(). */
1597 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1599 const struct oftable *table;
1600 unsigned int n_rules;
1602 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1604 ovs_mutex_lock(&ofproto_mutex);
1605 simap_increase(usage, "ops",
1606 ofproto->n_pending + hmap_count(&ofproto->deletions));
1607 ovs_mutex_unlock(&ofproto_mutex);
1610 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1611 fat_rwlock_rdlock(&table->cls.rwlock);
1612 n_rules += classifier_count(&table->cls);
1613 fat_rwlock_unlock(&table->cls.rwlock);
1615 simap_increase(usage, "rules", n_rules);
1617 if (ofproto->ofproto_class->get_memory_usage) {
1618 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1621 connmgr_get_memory_usage(ofproto->connmgr, usage);
1625 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1627 const struct ofproto_class *class;
1629 datapath_type = ofproto_normalize_type(datapath_type);
1630 class = ofproto_class_find__(datapath_type);
1632 if (class && class->type_get_memory_usage) {
1633 class->type_get_memory_usage(datapath_type, usage);
1638 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1641 connmgr_get_controller_info(ofproto->connmgr, info);
1645 ofproto_free_ofproto_controller_info(struct shash *info)
1647 connmgr_free_controller_info(info);
1650 /* Makes a deep copy of 'old' into 'port'. */
1652 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1654 port->name = xstrdup(old->name);
1655 port->type = xstrdup(old->type);
1656 port->ofp_port = old->ofp_port;
1659 /* Frees memory allocated to members of 'ofproto_port'.
1661 * Do not call this function on an ofproto_port obtained from
1662 * ofproto_port_dump_next(): that function retains ownership of the data in the
1665 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1667 free(ofproto_port->name);
1668 free(ofproto_port->type);
1671 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1673 * This function provides no status indication. An error status for the entire
1674 * dump operation is provided when it is completed by calling
1675 * ofproto_port_dump_done().
1678 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1679 const struct ofproto *ofproto)
1681 dump->ofproto = ofproto;
1682 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1686 /* Attempts to retrieve another port from 'dump', which must have been created
1687 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1688 * 'port' and returns true. On failure, returns false.
1690 * Failure might indicate an actual error or merely that the last port has been
1691 * dumped. An error status for the entire dump operation is provided when it
1692 * is completed by calling ofproto_port_dump_done().
1694 * The ofproto owns the data stored in 'port'. It will remain valid until at
1695 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1696 * ofproto_port_dump_done(). */
1698 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1699 struct ofproto_port *port)
1701 const struct ofproto *ofproto = dump->ofproto;
1707 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1710 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1716 /* Completes port table dump operation 'dump', which must have been created
1717 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1718 * error-free, otherwise a positive errno value describing the problem. */
1720 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1722 const struct ofproto *ofproto = dump->ofproto;
1724 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1727 return dump->error == EOF ? 0 : dump->error;
1730 /* Returns the type to pass to netdev_open() when a datapath of type
1731 * 'datapath_type' has a port of type 'port_type', for a few special
1732 * cases when a netdev type differs from a port type. For example, when
1733 * using the userspace datapath, a port of type "internal" needs to be
1736 * Returns either 'type' itself or a string literal, which must not be
1739 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1741 const struct ofproto_class *class;
1743 datapath_type = ofproto_normalize_type(datapath_type);
1744 class = ofproto_class_find__(datapath_type);
1749 return (class->port_open_type
1750 ? class->port_open_type(datapath_type, port_type)
1754 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1755 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1756 * the port's OpenFlow port number.
1758 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1759 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1760 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1761 * 'ofp_portp' is non-null). */
1763 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1764 ofp_port_t *ofp_portp)
1766 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1769 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1771 const char *netdev_name = netdev_get_name(netdev);
1773 simap_put(&ofproto->ofp_requests, netdev_name,
1774 ofp_to_u16(ofp_port));
1775 update_port(ofproto, netdev_name);
1778 *ofp_portp = OFPP_NONE;
1780 struct ofproto_port ofproto_port;
1782 error = ofproto_port_query_by_name(ofproto,
1783 netdev_get_name(netdev),
1786 *ofp_portp = ofproto_port.ofp_port;
1787 ofproto_port_destroy(&ofproto_port);
1794 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1795 * initializes '*port' appropriately; on failure, returns a positive errno
1798 * The caller owns the data in 'ofproto_port' and must free it with
1799 * ofproto_port_destroy() when it is no longer needed. */
1801 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1802 struct ofproto_port *port)
1806 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1808 memset(port, 0, sizeof *port);
1813 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1814 * Returns 0 if successful, otherwise a positive errno. */
1816 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1818 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1819 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1820 struct simap_node *ofp_request_node;
1823 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1824 if (ofp_request_node) {
1825 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1828 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1829 if (!error && ofport) {
1830 /* 'name' is the netdev's name and update_port() is going to close the
1831 * netdev. Just in case update_port() refers to 'name' after it
1832 * destroys 'ofport', make a copy of it around the update_port()
1834 char *devname = xstrdup(name);
1835 update_port(ofproto, devname);
1842 flow_mod_init(struct ofputil_flow_mod *fm,
1843 const struct match *match, unsigned int priority,
1844 const struct ofpact *ofpacts, size_t ofpacts_len,
1845 enum ofp_flow_mod_command command)
1847 memset(fm, 0, sizeof *fm);
1849 fm->priority = priority;
1852 fm->modify_cookie = false;
1854 fm->command = command;
1855 fm->idle_timeout = 0;
1856 fm->hard_timeout = 0;
1857 fm->buffer_id = UINT32_MAX;
1858 fm->out_port = OFPP_ANY;
1859 fm->out_group = OFPG_ANY;
1861 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1862 fm->ofpacts_len = ofpacts_len;
1866 simple_flow_mod(struct ofproto *ofproto,
1867 const struct match *match, unsigned int priority,
1868 const struct ofpact *ofpacts, size_t ofpacts_len,
1869 enum ofp_flow_mod_command command)
1871 struct ofputil_flow_mod fm;
1873 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1875 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1878 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1879 * performs the 'n_actions' actions in 'actions'. The new flow will not
1882 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1883 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1884 * controllers; otherwise, it will be hidden.
1886 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1888 * This is a helper function for in-band control and fail-open. */
1890 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1891 unsigned int priority,
1892 const struct ofpact *ofpacts, size_t ofpacts_len)
1893 OVS_EXCLUDED(ofproto_mutex)
1895 const struct rule *rule;
1898 /* First do a cheap check whether the rule we're looking for already exists
1899 * with the actions that we want. If it does, then we're done. */
1900 fat_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1901 rule = rule_from_cls_rule(classifier_find_match_exactly(
1902 &ofproto->tables[0].cls, match, priority));
1904 const struct rule_actions *actions = rule_get_actions(rule);
1905 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1906 ofpacts, ofpacts_len);
1910 fat_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1912 /* If there's no such rule or the rule doesn't have the actions we want,
1913 * fall back to a executing a full flow mod. We can't optimize this at
1914 * all because we didn't take enough locks above to ensure that the flow
1915 * table didn't already change beneath us. */
1917 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1918 OFPFC_MODIFY_STRICT);
1922 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1923 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1924 * operation cannot be initiated now but may be retried later.
1926 * This is a helper function for in-band control and fail-open and the "learn"
1929 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1930 OVS_EXCLUDED(ofproto_mutex)
1932 /* Optimize for the most common case of a repeated learn action.
1933 * If an identical flow already exists we only need to update its
1934 * 'modified' time. */
1935 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1936 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1937 struct oftable *table = &ofproto->tables[fm->table_id];
1941 fat_rwlock_rdlock(&table->cls.rwlock);
1942 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
1946 /* Reading many of the rule fields and writing on 'modified'
1947 * requires the rule->mutex. Also, rule->actions may change
1948 * if rule->mutex is not held. */
1949 const struct rule_actions *actions;
1951 ovs_mutex_lock(&rule->mutex);
1952 actions = rule_get_actions(rule);
1953 if (rule->idle_timeout == fm->idle_timeout
1954 && rule->hard_timeout == fm->hard_timeout
1955 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1956 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1957 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
1958 actions->ofpacts, actions->ofpacts_len)) {
1959 /* Rule already exists and need not change, only update the
1960 modified timestamp. */
1961 rule->modified = time_msec();
1964 ovs_mutex_unlock(&rule->mutex);
1966 fat_rwlock_unlock(&table->cls.rwlock);
1973 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1976 /* Resets the modified time for 'rule' or an equivalent rule. If 'rule' is not
1977 * in the classifier, but an equivalent rule is, unref 'rule' and ref the new
1978 * rule. Otherwise if 'rule' is no longer installed in the classifier,
1981 * Returns the rule whose modified time has been reset. */
1983 ofproto_refresh_rule(struct rule *rule)
1985 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
1986 const struct cls_rule *cr = &rule->cr;
1989 /* do_add_flow() requires that the rule is not installed. We lock the
1990 * ofproto_mutex here so that another thread cannot add the flow before
1991 * we get a chance to add it.*/
1992 ovs_mutex_lock(&ofproto_mutex);
1994 fat_rwlock_rdlock(&table->cls.rwlock);
1995 r = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, cr));
1997 ofproto_rule_ref(r);
1999 fat_rwlock_unlock(&table->cls.rwlock);
2002 do_add_flow(rule->ofproto, NULL, NULL, 0, rule);
2003 } else if (r != rule) {
2004 ofproto_rule_unref(rule);
2007 ovs_mutex_unlock(&ofproto_mutex);
2009 /* Refresh the modified time for the rule. */
2010 ovs_mutex_lock(&rule->mutex);
2011 rule->modified = MAX(rule->modified, time_msec());
2012 ovs_mutex_unlock(&rule->mutex);
2017 /* Searches for a rule with matching criteria exactly equal to 'target' in
2018 * ofproto's table 0 and, if it finds one, deletes it.
2020 * This is a helper function for in-band control and fail-open. */
2022 ofproto_delete_flow(struct ofproto *ofproto,
2023 const struct match *target, unsigned int priority)
2024 OVS_EXCLUDED(ofproto_mutex)
2026 struct classifier *cls = &ofproto->tables[0].cls;
2029 /* First do a cheap check whether the rule we're looking for has already
2030 * been deleted. If so, then we're done. */
2031 fat_rwlock_rdlock(&cls->rwlock);
2032 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2034 fat_rwlock_unlock(&cls->rwlock);
2039 /* Fall back to a executing a full flow mod. We can't optimize this at all
2040 * because we didn't take enough locks above to ensure that the flow table
2041 * didn't already change beneath us. */
2042 return simple_flow_mod(ofproto, target, priority, NULL, 0,
2043 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
2046 /* Starts the process of deleting all of the flows from all of ofproto's flow
2047 * tables and then reintroducing the flows required by in-band control and
2048 * fail-open. The process will complete in a later call to ofproto_run(). */
2050 ofproto_flush_flows(struct ofproto *ofproto)
2052 COVERAGE_INC(ofproto_flush);
2053 ofproto->state = S_FLUSH;
2057 reinit_ports(struct ofproto *p)
2059 struct ofproto_port_dump dump;
2060 struct sset devnames;
2061 struct ofport *ofport;
2062 struct ofproto_port ofproto_port;
2063 const char *devname;
2065 COVERAGE_INC(ofproto_reinit_ports);
2067 sset_init(&devnames);
2068 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2069 sset_add(&devnames, netdev_get_name(ofport->netdev));
2071 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2072 sset_add(&devnames, ofproto_port.name);
2075 SSET_FOR_EACH (devname, &devnames) {
2076 update_port(p, devname);
2078 sset_destroy(&devnames);
2082 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2086 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2087 port_idx = port_idx ? port_idx : UINT16_MAX;
2089 if (port_idx >= ofproto->max_ports
2090 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2091 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2092 long long int last_used_at, lru = LLONG_MAX;
2094 /* Search for a free OpenFlow port number. We try not to
2095 * immediately reuse them to prevent problems due to old
2098 * We limit the automatically assigned port numbers to the lower half
2099 * of the port range, to reserve the upper half for assignment by
2102 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2103 ofproto->alloc_port_no = 1;
2105 last_used_at = ofport_get_usage(ofproto,
2106 u16_to_ofp(ofproto->alloc_port_no));
2107 if (!last_used_at) {
2108 port_idx = ofproto->alloc_port_no;
2110 } else if ( last_used_at < time_msec() - 60*60*1000) {
2111 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2112 * more than an hour ago, consider it usable. */
2113 ofport_remove_usage(ofproto,
2114 u16_to_ofp(ofproto->alloc_port_no));
2115 port_idx = ofproto->alloc_port_no;
2117 } else if (last_used_at < lru) {
2119 lru_ofport = ofproto->alloc_port_no;
2122 if (ofproto->alloc_port_no == end_port_no) {
2124 port_idx = lru_ofport;
2131 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2132 return u16_to_ofp(port_idx);
2136 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2138 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2139 ofport_set_usage(ofproto, ofp_port, time_msec());
2143 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2144 * pointer if the netdev cannot be opened. On success, also fills in
2146 static struct netdev *
2147 ofport_open(struct ofproto *ofproto,
2148 struct ofproto_port *ofproto_port,
2149 struct ofputil_phy_port *pp)
2151 enum netdev_flags flags;
2152 struct netdev *netdev;
2155 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2157 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2158 "cannot be opened (%s)",
2160 ofproto_port->name, ofproto_port->ofp_port,
2161 ofproto_port->name, ovs_strerror(error));
2165 if (ofproto_port->ofp_port == OFPP_NONE) {
2166 if (!strcmp(ofproto->name, ofproto_port->name)) {
2167 ofproto_port->ofp_port = OFPP_LOCAL;
2169 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2170 ofproto_port->name);
2173 pp->port_no = ofproto_port->ofp_port;
2174 netdev_get_etheraddr(netdev, pp->hw_addr);
2175 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2176 netdev_get_flags(netdev, &flags);
2177 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2178 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2179 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2180 &pp->supported, &pp->peer);
2181 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2182 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2187 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2188 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2191 ofport_equal(const struct ofputil_phy_port *a,
2192 const struct ofputil_phy_port *b)
2194 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2195 && a->state == b->state
2196 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2197 && a->curr == b->curr
2198 && a->advertised == b->advertised
2199 && a->supported == b->supported
2200 && a->peer == b->peer
2201 && a->curr_speed == b->curr_speed
2202 && a->max_speed == b->max_speed);
2205 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2206 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2207 * one with the same name or port number). */
2209 ofport_install(struct ofproto *p,
2210 struct netdev *netdev, const struct ofputil_phy_port *pp)
2212 const char *netdev_name = netdev_get_name(netdev);
2213 struct ofport *ofport;
2216 /* Create ofport. */
2217 ofport = p->ofproto_class->port_alloc();
2222 ofport->ofproto = p;
2223 ofport->netdev = netdev;
2224 ofport->change_seq = netdev_get_change_seq(netdev);
2226 ofport->ofp_port = pp->port_no;
2227 ofport->created = time_msec();
2229 /* Add port to 'p'. */
2230 hmap_insert(&p->ports, &ofport->hmap_node,
2231 hash_ofp_port(ofport->ofp_port));
2232 shash_add(&p->port_by_name, netdev_name, ofport);
2234 update_mtu(p, ofport);
2236 /* Let the ofproto_class initialize its private data. */
2237 error = p->ofproto_class->port_construct(ofport);
2241 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2245 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2246 p->name, netdev_name, ovs_strerror(error));
2248 ofport_destroy__(ofport);
2250 netdev_close(netdev);
2254 /* Removes 'ofport' from 'p' and destroys it. */
2256 ofport_remove(struct ofport *ofport)
2258 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2260 ofport_destroy(ofport);
2263 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2266 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2268 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2270 ofport_remove(port);
2274 /* Updates 'port' with new 'pp' description.
2276 * Does not handle a name or port number change. The caller must implement
2277 * such a change as a delete followed by an add. */
2279 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2281 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2282 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2283 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2284 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2285 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2286 port->pp.curr = pp->curr;
2287 port->pp.advertised = pp->advertised;
2288 port->pp.supported = pp->supported;
2289 port->pp.peer = pp->peer;
2290 port->pp.curr_speed = pp->curr_speed;
2291 port->pp.max_speed = pp->max_speed;
2293 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2294 &port->pp, OFPPR_MODIFY);
2297 /* Update OpenFlow 'state' in 'port' and notify controller. */
2299 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2301 if (port->pp.state != state) {
2302 port->pp.state = state;
2303 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2304 &port->pp, OFPPR_MODIFY);
2309 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2311 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2313 if (port->ofproto->ofproto_class->set_realdev) {
2314 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2316 if (port->ofproto->ofproto_class->set_stp_port) {
2317 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2319 if (port->ofproto->ofproto_class->set_cfm) {
2320 port->ofproto->ofproto_class->set_cfm(port, NULL);
2322 if (port->ofproto->ofproto_class->bundle_remove) {
2323 port->ofproto->ofproto_class->bundle_remove(port);
2329 ofport_destroy__(struct ofport *port)
2331 struct ofproto *ofproto = port->ofproto;
2332 const char *name = netdev_get_name(port->netdev);
2334 hmap_remove(&ofproto->ports, &port->hmap_node);
2335 shash_delete(&ofproto->port_by_name,
2336 shash_find(&ofproto->port_by_name, name));
2338 netdev_close(port->netdev);
2339 ofproto->ofproto_class->port_dealloc(port);
2343 ofport_destroy(struct ofport *port)
2346 dealloc_ofp_port(port->ofproto, port->ofp_port);
2347 port->ofproto->ofproto_class->port_destruct(port);
2348 ofport_destroy__(port);
2353 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2355 struct ofport *port;
2357 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2359 if (port->ofp_port == ofp_port) {
2366 static long long int
2367 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2369 struct ofport_usage *usage;
2371 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2372 &ofproto->ofport_usage) {
2373 if (usage->ofp_port == ofp_port) {
2374 return usage->last_used;
2381 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2382 long long int last_used)
2384 struct ofport_usage *usage;
2385 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2386 &ofproto->ofport_usage) {
2387 if (usage->ofp_port == ofp_port) {
2388 usage->last_used = last_used;
2392 ovs_assert(last_used == LLONG_MAX);
2394 usage = xmalloc(sizeof *usage);
2395 usage->ofp_port = ofp_port;
2396 usage->last_used = last_used;
2397 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2398 hash_ofp_port(ofp_port));
2402 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2404 struct ofport_usage *usage;
2405 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2406 &ofproto->ofport_usage) {
2407 if (usage->ofp_port == ofp_port) {
2408 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2416 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2418 struct ofproto *ofproto = port->ofproto;
2421 if (ofproto->ofproto_class->port_get_stats) {
2422 error = ofproto->ofproto_class->port_get_stats(port, stats);
2431 update_port(struct ofproto *ofproto, const char *name)
2433 struct ofproto_port ofproto_port;
2434 struct ofputil_phy_port pp;
2435 struct netdev *netdev;
2436 struct ofport *port;
2438 COVERAGE_INC(ofproto_update_port);
2440 /* Fetch 'name''s location and properties from the datapath. */
2441 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2442 ? ofport_open(ofproto, &ofproto_port, &pp)
2446 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2447 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2448 struct netdev *old_netdev = port->netdev;
2450 /* 'name' hasn't changed location. Any properties changed? */
2451 if (!ofport_equal(&port->pp, &pp)) {
2452 ofport_modified(port, &pp);
2455 update_mtu(ofproto, port);
2457 /* Install the newly opened netdev in case it has changed.
2458 * Don't close the old netdev yet in case port_modified has to
2459 * remove a retained reference to it.*/
2460 port->netdev = netdev;
2461 port->change_seq = netdev_get_change_seq(netdev);
2463 if (port->ofproto->ofproto_class->port_modified) {
2464 port->ofproto->ofproto_class->port_modified(port);
2467 netdev_close(old_netdev);
2469 /* If 'port' is nonnull then its name differs from 'name' and thus
2470 * we should delete it. If we think there's a port named 'name'
2471 * then its port number must be wrong now so delete it too. */
2473 ofport_remove(port);
2475 ofport_remove_with_name(ofproto, name);
2476 ofport_install(ofproto, netdev, &pp);
2479 /* Any port named 'name' is gone now. */
2480 ofport_remove_with_name(ofproto, name);
2482 ofproto_port_destroy(&ofproto_port);
2486 init_ports(struct ofproto *p)
2488 struct ofproto_port_dump dump;
2489 struct ofproto_port ofproto_port;
2490 struct shash_node *node, *next;
2492 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2493 const char *name = ofproto_port.name;
2495 if (shash_find(&p->port_by_name, name)) {
2496 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2499 struct ofputil_phy_port pp;
2500 struct netdev *netdev;
2502 /* Check if an OpenFlow port number had been requested. */
2503 node = shash_find(&init_ofp_ports, name);
2505 const struct iface_hint *iface_hint = node->data;
2506 simap_put(&p->ofp_requests, name,
2507 ofp_to_u16(iface_hint->ofp_port));
2510 netdev = ofport_open(p, &ofproto_port, &pp);
2512 ofport_install(p, netdev, &pp);
2513 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2514 p->alloc_port_no = MAX(p->alloc_port_no,
2515 ofp_to_u16(ofproto_port.ofp_port));
2521 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2522 struct iface_hint *iface_hint = node->data;
2524 if (!strcmp(iface_hint->br_name, p->name)) {
2525 free(iface_hint->br_name);
2526 free(iface_hint->br_type);
2528 shash_delete(&init_ofp_ports, node);
2535 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2536 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2538 find_min_mtu(struct ofproto *p)
2540 struct ofport *ofport;
2543 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2544 struct netdev *netdev = ofport->netdev;
2547 /* Skip any internal ports, since that's what we're trying to
2549 if (!strcmp(netdev_get_type(netdev), "internal")) {
2553 if (netdev_get_mtu(netdev, &dev_mtu)) {
2556 if (!mtu || dev_mtu < mtu) {
2561 return mtu ? mtu: ETH_PAYLOAD_MAX;
2564 /* Update MTU of all datapath devices on 'p' to the minimum of the
2565 * non-datapath ports in event of 'port' added or changed. */
2567 update_mtu(struct ofproto *p, struct ofport *port)
2569 struct ofport *ofport;
2570 struct netdev *netdev = port->netdev;
2571 int dev_mtu, old_min;
2573 if (netdev_get_mtu(netdev, &dev_mtu)) {
2577 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2578 if (dev_mtu > p->min_mtu) {
2579 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2580 dev_mtu = p->min_mtu;
2583 port->mtu = dev_mtu;
2587 /* For non-internal port find new min mtu. */
2588 old_min = p->min_mtu;
2589 port->mtu = dev_mtu;
2590 p->min_mtu = find_min_mtu(p);
2591 if (p->min_mtu == old_min) {
2595 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2596 struct netdev *netdev = ofport->netdev;
2598 if (!strcmp(netdev_get_type(netdev), "internal")) {
2599 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2600 ofport->mtu = p->min_mtu;
2607 ofproto_rule_destroy__(struct rule *rule)
2608 OVS_NO_THREAD_SAFETY_ANALYSIS
2610 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2611 rule_actions_destroy(rule_get_actions(rule));
2612 ovs_mutex_destroy(&rule->mutex);
2613 rule->ofproto->ofproto_class->rule_dealloc(rule);
2617 rule_destroy_cb(struct rule *rule)
2619 rule->ofproto->ofproto_class->rule_destruct(rule);
2620 ofproto_rule_destroy__(rule);
2624 ofproto_rule_ref(struct rule *rule)
2627 ovs_refcount_ref(&rule->ref_count);
2631 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2632 * ref_count reaches 0.
2634 * Use of RCU allows short term use (between RCU quiescent periods) without
2635 * keeping a reference. A reference must be taken if the rule needs to
2636 * stay around accross the RCU quiescent periods. */
2638 ofproto_rule_unref(struct rule *rule)
2640 if (rule && ovs_refcount_unref(&rule->ref_count) == 1) {
2641 ovsrcu_postpone(rule_destroy_cb, rule);
2645 static uint32_t get_provider_meter_id(const struct ofproto *,
2646 uint32_t of_meter_id);
2648 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2649 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2650 const struct rule_actions *
2651 rule_actions_create(const struct ofproto *ofproto,
2652 const struct ofpact *ofpacts, size_t ofpacts_len)
2654 struct rule_actions *actions;
2656 actions = xmalloc(sizeof *actions + ofpacts_len);
2657 actions->ofpacts_len = ofpacts_len;
2658 actions->provider_meter_id
2659 = get_provider_meter_id(ofproto,
2660 ofpacts_get_meter(ofpacts, ofpacts_len));
2661 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2666 /* Free the actions after the RCU quiescent period is reached. */
2668 rule_actions_destroy(const struct rule_actions *actions)
2671 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2675 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2676 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2678 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2679 OVS_REQUIRES(ofproto_mutex)
2681 if (port == OFPP_ANY) {
2684 const struct rule_actions *actions = rule_get_actions(rule);
2685 return ofpacts_output_to_port(actions->ofpacts,
2686 actions->ofpacts_len, port);
2690 /* Returns true if 'rule' has group and equals group_id. */
2692 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2693 OVS_REQUIRES(ofproto_mutex)
2695 if (group_id == OFPG_ANY) {
2698 const struct rule_actions *actions = rule_get_actions(rule);
2699 return ofpacts_output_to_group(actions->ofpacts,
2700 actions->ofpacts_len, group_id);
2704 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2705 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2707 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2708 OVS_REQUIRES(ofproto_mutex)
2710 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2715 case OFOPERATION_ADD:
2716 case OFOPERATION_DELETE:
2719 case OFOPERATION_MODIFY:
2720 case OFOPERATION_REPLACE:
2721 return ofpacts_output_to_port(op->actions->ofpacts,
2722 op->actions->ofpacts_len, out_port);
2729 rule_execute_destroy(struct rule_execute *e)
2731 ofproto_rule_unref(e->rule);
2732 list_remove(&e->list_node);
2736 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2737 * by passing them to the ofproto provider. */
2739 run_rule_executes(struct ofproto *ofproto)
2740 OVS_EXCLUDED(ofproto_mutex)
2742 struct rule_execute *e, *next;
2743 struct list executes;
2745 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2746 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2749 flow_extract(e->packet, NULL, &flow);
2750 flow.in_port.ofp_port = e->in_port;
2751 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2753 rule_execute_destroy(e);
2757 /* Destroys and discards all "rule_execute" operations queued up in
2758 * ofproto->rule_executes. */
2760 destroy_rule_executes(struct ofproto *ofproto)
2762 struct rule_execute *e, *next;
2763 struct list executes;
2765 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2766 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2767 ofpbuf_delete(e->packet);
2768 rule_execute_destroy(e);
2772 /* Returns true if 'rule' should be hidden from the controller.
2774 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2775 * (e.g. by in-band control) and are intentionally hidden from the
2778 ofproto_rule_is_hidden(const struct rule *rule)
2780 return (rule->cr.priority > UINT16_MAX);
2784 oftable_is_modifiable(const struct oftable *table,
2785 enum ofputil_flow_mod_flags flags)
2787 if (flags & OFPUTIL_FF_NO_READONLY) {
2791 return !(table->flags & OFTABLE_READONLY);
2795 rule_is_modifiable(const struct rule *rule, enum ofputil_flow_mod_flags flags)
2797 const struct oftable *rule_table;
2799 rule_table = &rule->ofproto->tables[rule->table_id];
2800 return oftable_is_modifiable(rule_table, flags);
2804 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2806 ofconn_send_reply(ofconn, make_echo_reply(oh));
2811 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2813 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2814 struct ofputil_switch_features features;
2815 struct ofport *port;
2819 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2821 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2823 features.datapath_id = ofproto->datapath_id;
2824 features.n_buffers = pktbuf_capacity();
2825 features.n_tables = ofproto_get_n_visible_tables(ofproto);
2826 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2827 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2829 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2831 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2832 features.auxiliary_id = 0;
2833 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2835 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2836 ofputil_put_switch_features_port(&port->pp, b);
2839 ofconn_send_reply(ofconn, b);
2844 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2846 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2847 struct ofp_switch_config *osc;
2848 enum ofp_config_flags flags;
2852 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2853 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2854 flags = ofproto->frag_handling;
2855 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2856 if (oh->version < OFP13_VERSION
2857 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2858 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2860 osc->flags = htons(flags);
2861 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2862 ofconn_send_reply(ofconn, buf);
2868 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2870 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2871 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2872 uint16_t flags = ntohs(osc->flags);
2874 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2875 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2876 enum ofp_config_flags cur = ofproto->frag_handling;
2877 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2879 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2881 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2882 ofproto->frag_handling = next;
2884 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2886 ofputil_frag_handling_to_string(next));
2890 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2891 ofconn_set_invalid_ttl_to_controller(ofconn,
2892 (oh->version < OFP13_VERSION
2893 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2895 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2900 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2901 * error message code for the caller to propagate upward. Otherwise, returns
2904 * The log message mentions 'msg_type'. */
2906 reject_slave_controller(struct ofconn *ofconn)
2908 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2909 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2910 return OFPERR_OFPBRC_EPERM;
2916 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2919 * - If they use a meter, then 'ofproto' has that meter configured.
2921 * - If they use any groups, then 'ofproto' has that group configured.
2923 * Returns 0 if successful, otherwise an OpenFlow error. */
2925 ofproto_check_ofpacts(struct ofproto *ofproto,
2926 const struct ofpact ofpacts[], size_t ofpacts_len)
2928 const struct ofpact *a;
2931 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2932 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2933 return OFPERR_OFPMMFC_INVALID_METER;
2936 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2937 if (a->type == OFPACT_GROUP
2938 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2939 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2947 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2949 struct ofproto *p = ofconn_get_ofproto(ofconn);
2950 struct ofputil_packet_out po;
2951 struct ofpbuf *payload;
2952 uint64_t ofpacts_stub[1024 / 8];
2953 struct ofpbuf ofpacts;
2957 COVERAGE_INC(ofproto_packet_out);
2959 error = reject_slave_controller(ofconn);
2964 /* Decode message. */
2965 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2966 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2968 goto exit_free_ofpacts;
2970 if (ofp_to_u16(po.in_port) >= p->max_ports
2971 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2972 error = OFPERR_OFPBRC_BAD_PORT;
2973 goto exit_free_ofpacts;
2977 if (po.buffer_id != UINT32_MAX) {
2978 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2979 if (error || !payload) {
2980 goto exit_free_ofpacts;
2983 /* Ensure that the L3 header is 32-bit aligned. */
2984 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2987 /* Verify actions against packet, then send packet if successful. */
2988 flow_extract(payload, NULL, &flow);
2989 flow.in_port.ofp_port = po.in_port;
2990 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
2992 error = p->ofproto_class->packet_out(p, payload, &flow,
2993 po.ofpacts, po.ofpacts_len);
2995 ofpbuf_delete(payload);
2998 ofpbuf_uninit(&ofpacts);
3004 update_port_config(struct ofconn *ofconn, struct ofport *port,
3005 enum ofputil_port_config config,
3006 enum ofputil_port_config mask)
3008 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3010 if (toggle & OFPUTIL_PC_PORT_DOWN
3011 && (config & OFPUTIL_PC_PORT_DOWN
3012 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3013 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3014 /* We tried to bring the port up or down, but it failed, so don't
3015 * update the "down" bit. */
3016 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3020 enum ofputil_port_config old_config = port->pp.config;
3021 port->pp.config ^= toggle;
3022 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3023 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3029 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3031 struct ofproto *p = ofconn_get_ofproto(ofconn);
3032 struct ofputil_port_mod pm;
3033 struct ofport *port;
3036 error = reject_slave_controller(ofconn);
3041 error = ofputil_decode_port_mod(oh, &pm, false);
3046 port = ofproto_get_port(p, pm.port_no);
3048 return OFPERR_OFPPMFC_BAD_PORT;
3049 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3050 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3052 update_port_config(ofconn, port, pm.config, pm.mask);
3054 netdev_set_advertisements(port->netdev, pm.advertise);
3061 handle_desc_stats_request(struct ofconn *ofconn,
3062 const struct ofp_header *request)
3064 static const char *default_mfr_desc = "Nicira, Inc.";
3065 static const char *default_hw_desc = "Open vSwitch";
3066 static const char *default_sw_desc = VERSION;
3067 static const char *default_serial_desc = "None";
3068 static const char *default_dp_desc = "None";
3070 struct ofproto *p = ofconn_get_ofproto(ofconn);
3071 struct ofp_desc_stats *ods;
3074 msg = ofpraw_alloc_stats_reply(request, 0);
3075 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3076 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3077 sizeof ods->mfr_desc);
3078 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3079 sizeof ods->hw_desc);
3080 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3081 sizeof ods->sw_desc);
3082 ovs_strlcpy(ods->serial_num,
3083 p->serial_desc ? p->serial_desc : default_serial_desc,
3084 sizeof ods->serial_num);
3085 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3086 sizeof ods->dp_desc);
3087 ofconn_send_reply(ofconn, msg);
3093 handle_table_stats_request(struct ofconn *ofconn,
3094 const struct ofp_header *request)
3096 struct ofproto *p = ofconn_get_ofproto(ofconn);
3097 struct ofp12_table_stats *ots;
3102 /* Set up default values.
3104 * ofp12_table_stats is used as a generic structure as
3105 * it is able to hold all the fields for ofp10_table_stats
3106 * and ofp11_table_stats (and of course itself).
3108 ots = xcalloc(p->n_tables, sizeof *ots);
3109 for (i = 0; i < p->n_tables; i++) {
3110 ots[i].table_id = i;
3111 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3112 ots[i].match = htonll(OFPXMT13_MASK);
3113 ots[i].wildcards = htonll(OFPXMT13_MASK);
3114 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3115 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3116 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3117 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3118 ots[i].metadata_match = OVS_BE64_MAX;
3119 ots[i].metadata_write = OVS_BE64_MAX;
3120 ots[i].instructions = htonl(OFPIT11_ALL);
3121 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3122 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3123 fat_rwlock_rdlock(&p->tables[i].cls.rwlock);
3124 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3125 fat_rwlock_unlock(&p->tables[i].cls.rwlock);
3128 p->ofproto_class->get_tables(p, ots);
3130 /* Post-process the tables, dropping hidden tables. */
3131 n_tables = p->n_tables;
3132 for (i = 0; i < p->n_tables; i++) {
3133 const struct oftable *table = &p->tables[i];
3135 if (table->flags & OFTABLE_HIDDEN) {
3141 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3144 if (table->max_flows < ntohl(ots[i].max_entries)) {
3145 ots[i].max_entries = htonl(table->max_flows);
3149 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3150 ofconn_send_reply(ofconn, msg);
3158 append_port_stat(struct ofport *port, struct list *replies)
3160 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3162 calc_duration(port->created, time_msec(),
3163 &ops.duration_sec, &ops.duration_nsec);
3165 /* Intentionally ignore return value, since errors will set
3166 * 'stats' to all-1s, which is correct for OpenFlow, and
3167 * netdev_get_stats() will log errors. */
3168 ofproto_port_get_stats(port, &ops.stats);
3170 ofputil_append_port_stat(replies, &ops);
3174 handle_port_request(struct ofconn *ofconn,
3175 const struct ofp_header *request, ofp_port_t port_no,
3176 void (*cb)(struct ofport *, struct list *replies))
3178 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3179 struct ofport *port;
3180 struct list replies;
3182 ofpmp_init(&replies, request);
3183 if (port_no != OFPP_ANY) {
3184 port = ofproto_get_port(ofproto, port_no);
3189 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3194 ofconn_send_replies(ofconn, &replies);
3198 handle_port_stats_request(struct ofconn *ofconn,
3199 const struct ofp_header *request)
3204 error = ofputil_decode_port_stats_request(request, &port_no);
3206 handle_port_request(ofconn, request, port_no, append_port_stat);
3212 append_port_desc(struct ofport *port, struct list *replies)
3214 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3218 handle_port_desc_stats_request(struct ofconn *ofconn,
3219 const struct ofp_header *request)
3224 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3226 handle_port_request(ofconn, request, port_no, append_port_desc);
3232 hash_cookie(ovs_be64 cookie)
3234 return hash_uint64((OVS_FORCE uint64_t)cookie);
3238 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3239 OVS_REQUIRES(ofproto_mutex)
3241 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3242 hash_cookie(rule->flow_cookie));
3246 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3247 OVS_REQUIRES(ofproto_mutex)
3249 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3253 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3254 ovs_be64 new_cookie)
3255 OVS_REQUIRES(ofproto_mutex)
3257 if (new_cookie != rule->flow_cookie) {
3258 cookies_remove(ofproto, rule);
3260 ovs_mutex_lock(&rule->mutex);
3261 rule->flow_cookie = new_cookie;
3262 ovs_mutex_unlock(&rule->mutex);
3264 cookies_insert(ofproto, rule);
3269 calc_duration(long long int start, long long int now,
3270 uint32_t *sec, uint32_t *nsec)
3272 long long int msecs = now - start;
3273 *sec = msecs / 1000;
3274 *nsec = (msecs % 1000) * (1000 * 1000);
3277 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3278 * true if 'table_id' is OK, false otherwise. */
3280 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3282 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3285 static struct oftable *
3286 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3288 struct oftable *table;
3290 for (table = &ofproto->tables[table_id];
3291 table < &ofproto->tables[ofproto->n_tables];
3293 if (!(table->flags & OFTABLE_HIDDEN)) {
3301 static struct oftable *
3302 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3304 if (table_id == 0xff) {
3305 return next_visible_table(ofproto, 0);
3306 } else if (table_id < ofproto->n_tables) {
3307 return &ofproto->tables[table_id];
3313 static struct oftable *
3314 next_matching_table(const struct ofproto *ofproto,
3315 const struct oftable *table, uint8_t table_id)
3317 return (table_id == 0xff
3318 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3322 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3324 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3325 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3327 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3328 * only once, for that table. (This can be used to access tables marked
3331 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3332 * entered at all. (Perhaps you should have validated TABLE_ID with
3333 * check_table_id().)
3335 * All parameters are evaluated multiple times.
3337 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3338 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3340 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3342 /* Initializes 'criteria' in a straightforward way based on the other
3345 * For "loose" matching, the 'priority' parameter is unimportant and may be
3348 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3349 const struct match *match, unsigned int priority,
3350 ovs_be64 cookie, ovs_be64 cookie_mask,
3351 ofp_port_t out_port, uint32_t out_group)
3353 criteria->table_id = table_id;
3354 cls_rule_init(&criteria->cr, match, priority);
3355 criteria->cookie = cookie;
3356 criteria->cookie_mask = cookie_mask;
3357 criteria->out_port = out_port;
3358 criteria->out_group = out_group;
3362 rule_criteria_destroy(struct rule_criteria *criteria)
3364 cls_rule_destroy(&criteria->cr);
3368 rule_collection_init(struct rule_collection *rules)
3370 rules->rules = rules->stub;
3372 rules->capacity = ARRAY_SIZE(rules->stub);
3376 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3378 if (rules->n >= rules->capacity) {
3379 size_t old_size, new_size;
3381 old_size = rules->capacity * sizeof *rules->rules;
3382 rules->capacity *= 2;
3383 new_size = rules->capacity * sizeof *rules->rules;
3385 if (rules->rules == rules->stub) {
3386 rules->rules = xmalloc(new_size);
3387 memcpy(rules->rules, rules->stub, old_size);
3389 rules->rules = xrealloc(rules->rules, new_size);
3393 rules->rules[rules->n++] = rule;
3397 rule_collection_ref(struct rule_collection *rules)
3398 OVS_REQUIRES(ofproto_mutex)
3402 for (i = 0; i < rules->n; i++) {
3403 ofproto_rule_ref(rules->rules[i]);
3408 rule_collection_unref(struct rule_collection *rules)
3412 for (i = 0; i < rules->n; i++) {
3413 ofproto_rule_unref(rules->rules[i]);
3418 rule_collection_destroy(struct rule_collection *rules)
3420 if (rules->rules != rules->stub) {
3426 collect_rule(struct rule *rule, const struct rule_criteria *c,
3427 struct rule_collection *rules)
3428 OVS_REQUIRES(ofproto_mutex)
3430 /* We ordinarily want to skip hidden rules, but there has to be a way for
3431 * code internal to OVS to modify and delete them, so if the criteria
3432 * specify a priority that can only be for a hidden flow, then allow hidden
3433 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3434 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3436 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3438 } else if (rule->pending) {
3439 return OFPROTO_POSTPONE;
3441 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3442 && ofproto_rule_has_out_port(rule, c->out_port)
3443 && ofproto_rule_has_out_group(rule, c->out_group)
3444 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3445 rule_collection_add(rules, rule);
3451 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3452 * on classifiers rules are done in the "loose" way required for OpenFlow
3453 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3456 * Hidden rules are always omitted.
3458 * Returns 0 on success, otherwise an OpenFlow error code. */
3460 collect_rules_loose(struct ofproto *ofproto,
3461 const struct rule_criteria *criteria,
3462 struct rule_collection *rules)
3463 OVS_REQUIRES(ofproto_mutex)
3465 struct oftable *table;
3466 enum ofperr error = 0;
3468 rule_collection_init(rules);
3470 if (!check_table_id(ofproto, criteria->table_id)) {
3471 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3475 if (criteria->cookie_mask == OVS_BE64_MAX) {
3478 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3479 hash_cookie(criteria->cookie),
3480 &ofproto->cookies) {
3481 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3482 error = collect_rule(rule, criteria, rules);
3489 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3490 struct cls_cursor cursor;
3493 fat_rwlock_rdlock(&table->cls.rwlock);
3494 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3495 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3496 error = collect_rule(rule, criteria, rules);
3501 fat_rwlock_unlock(&table->cls.rwlock);
3507 rule_collection_destroy(rules);
3512 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3513 * on classifiers rules are done in the "strict" way required for OpenFlow
3514 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3515 * rules on list 'rules'.
3517 * Hidden rules are always omitted.
3519 * Returns 0 on success, otherwise an OpenFlow error code. */
3521 collect_rules_strict(struct ofproto *ofproto,
3522 const struct rule_criteria *criteria,
3523 struct rule_collection *rules)
3524 OVS_REQUIRES(ofproto_mutex)
3526 struct oftable *table;
3529 rule_collection_init(rules);
3531 if (!check_table_id(ofproto, criteria->table_id)) {
3532 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3536 if (criteria->cookie_mask == OVS_BE64_MAX) {
3539 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3540 hash_cookie(criteria->cookie),
3541 &ofproto->cookies) {
3542 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3543 error = collect_rule(rule, criteria, rules);
3550 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3553 fat_rwlock_rdlock(&table->cls.rwlock);
3554 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3555 &table->cls, &criteria->cr));
3556 fat_rwlock_unlock(&table->cls.rwlock);
3558 error = collect_rule(rule, criteria, rules);
3568 rule_collection_destroy(rules);
3573 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3574 * forced into the range of a uint16_t. */
3576 age_secs(long long int age_ms)
3578 return (age_ms < 0 ? 0
3579 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3580 : (unsigned int) age_ms / 1000);
3584 handle_flow_stats_request(struct ofconn *ofconn,
3585 const struct ofp_header *request)
3586 OVS_EXCLUDED(ofproto_mutex)
3588 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3589 struct ofputil_flow_stats_request fsr;
3590 struct rule_criteria criteria;
3591 struct rule_collection rules;
3592 struct list replies;
3596 error = ofputil_decode_flow_stats_request(&fsr, request);
3601 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3602 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3604 ovs_mutex_lock(&ofproto_mutex);
3605 error = collect_rules_loose(ofproto, &criteria, &rules);
3606 rule_criteria_destroy(&criteria);
3608 rule_collection_ref(&rules);
3610 ovs_mutex_unlock(&ofproto_mutex);
3616 ofpmp_init(&replies, request);
3617 for (i = 0; i < rules.n; i++) {
3618 struct rule *rule = rules.rules[i];
3619 long long int now = time_msec();
3620 struct ofputil_flow_stats fs;
3621 long long int created, used, modified;
3622 const struct rule_actions *actions;
3623 enum ofputil_flow_mod_flags flags;
3625 ovs_mutex_lock(&rule->mutex);
3626 fs.cookie = rule->flow_cookie;
3627 fs.idle_timeout = rule->idle_timeout;
3628 fs.hard_timeout = rule->hard_timeout;
3629 created = rule->created;
3630 modified = rule->modified;
3631 actions = rule_get_actions(rule);
3632 flags = rule->flags;
3633 ovs_mutex_unlock(&rule->mutex);
3635 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3636 &fs.byte_count, &used);
3638 minimatch_expand(&rule->cr.match, &fs.match);
3639 fs.table_id = rule->table_id;
3640 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3641 fs.priority = rule->cr.priority;
3642 fs.idle_age = age_secs(now - used);
3643 fs.hard_age = age_secs(now - modified);
3644 fs.ofpacts = actions->ofpacts;
3645 fs.ofpacts_len = actions->ofpacts_len;
3648 ofputil_append_flow_stats_reply(&fs, &replies);
3651 rule_collection_unref(&rules);
3652 rule_collection_destroy(&rules);
3654 ofconn_send_replies(ofconn, &replies);
3660 flow_stats_ds(struct rule *rule, struct ds *results)
3662 uint64_t packet_count, byte_count;
3663 const struct rule_actions *actions;
3664 long long int created, used;
3666 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3667 &byte_count, &used);
3669 ovs_mutex_lock(&rule->mutex);
3670 actions = rule_get_actions(rule);
3671 created = rule->created;
3672 ovs_mutex_unlock(&rule->mutex);
3674 if (rule->table_id != 0) {
3675 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3677 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3678 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3679 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3680 cls_rule_format(&rule->cr, results);
3681 ds_put_char(results, ',');
3683 ds_put_cstr(results, "actions=");
3684 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3686 ds_put_cstr(results, "\n");
3689 /* Adds a pretty-printed description of all flows to 'results', including
3690 * hidden flows (e.g., set up by in-band control). */
3692 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3694 struct oftable *table;
3696 OFPROTO_FOR_EACH_TABLE (table, p) {
3697 struct cls_cursor cursor;
3700 fat_rwlock_rdlock(&table->cls.rwlock);
3701 cls_cursor_init(&cursor, &table->cls, NULL);
3702 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3703 flow_stats_ds(rule, results);
3705 fat_rwlock_unlock(&table->cls.rwlock);
3709 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3710 * '*engine_type' and '*engine_id', respectively. */
3712 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3713 uint8_t *engine_type, uint8_t *engine_id)
3715 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3718 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3719 * Returns 0 if the port's CFM status was successfully stored into
3720 * '*status'. Returns positive errno if the port did not have CFM
3721 * configured. Returns negative number if there is no status change
3722 * since last update.
3724 * The caller must provide and own '*status', and must free 'status->rmps'.
3725 * '*status' is indeterminate if the return value is non-zero. */
3727 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3728 struct ofproto_cfm_status *status)
3730 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3731 return (ofport && ofproto->ofproto_class->get_cfm_status
3732 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
3737 handle_aggregate_stats_request(struct ofconn *ofconn,
3738 const struct ofp_header *oh)
3739 OVS_EXCLUDED(ofproto_mutex)
3741 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3742 struct ofputil_flow_stats_request request;
3743 struct ofputil_aggregate_stats stats;
3744 bool unknown_packets, unknown_bytes;
3745 struct rule_criteria criteria;
3746 struct rule_collection rules;
3747 struct ofpbuf *reply;
3751 error = ofputil_decode_flow_stats_request(&request, oh);
3756 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3757 request.cookie, request.cookie_mask,
3758 request.out_port, request.out_group);
3760 ovs_mutex_lock(&ofproto_mutex);
3761 error = collect_rules_loose(ofproto, &criteria, &rules);
3762 rule_criteria_destroy(&criteria);
3764 rule_collection_ref(&rules);
3766 ovs_mutex_unlock(&ofproto_mutex);
3772 memset(&stats, 0, sizeof stats);
3773 unknown_packets = unknown_bytes = false;
3774 for (i = 0; i < rules.n; i++) {
3775 struct rule *rule = rules.rules[i];
3776 uint64_t packet_count;
3777 uint64_t byte_count;
3780 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3781 &byte_count, &used);
3783 if (packet_count == UINT64_MAX) {
3784 unknown_packets = true;
3786 stats.packet_count += packet_count;
3789 if (byte_count == UINT64_MAX) {
3790 unknown_bytes = true;
3792 stats.byte_count += byte_count;
3797 if (unknown_packets) {
3798 stats.packet_count = UINT64_MAX;
3800 if (unknown_bytes) {
3801 stats.byte_count = UINT64_MAX;
3804 rule_collection_unref(&rules);
3805 rule_collection_destroy(&rules);
3807 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3808 ofconn_send_reply(ofconn, reply);
3813 struct queue_stats_cbdata {
3814 struct ofport *ofport;
3815 struct list replies;
3820 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3821 const struct netdev_queue_stats *stats)
3823 struct ofputil_queue_stats oqs;
3825 oqs.port_no = cbdata->ofport->pp.port_no;
3826 oqs.queue_id = queue_id;
3827 oqs.tx_bytes = stats->tx_bytes;
3828 oqs.tx_packets = stats->tx_packets;
3829 oqs.tx_errors = stats->tx_errors;
3830 if (stats->created != LLONG_MIN) {
3831 calc_duration(stats->created, cbdata->now,
3832 &oqs.duration_sec, &oqs.duration_nsec);
3834 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3836 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3840 handle_queue_stats_dump_cb(uint32_t queue_id,
3841 struct netdev_queue_stats *stats,
3844 struct queue_stats_cbdata *cbdata = cbdata_;
3846 put_queue_stats(cbdata, queue_id, stats);
3850 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3851 struct queue_stats_cbdata *cbdata)
3853 cbdata->ofport = port;
3854 if (queue_id == OFPQ_ALL) {
3855 netdev_dump_queue_stats(port->netdev,
3856 handle_queue_stats_dump_cb, cbdata);
3858 struct netdev_queue_stats stats;
3860 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3861 put_queue_stats(cbdata, queue_id, &stats);
3863 return OFPERR_OFPQOFC_BAD_QUEUE;
3870 handle_queue_stats_request(struct ofconn *ofconn,
3871 const struct ofp_header *rq)
3873 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3874 struct queue_stats_cbdata cbdata;
3875 struct ofport *port;
3877 struct ofputil_queue_stats_request oqsr;
3879 COVERAGE_INC(ofproto_queue_req);
3881 ofpmp_init(&cbdata.replies, rq);
3882 cbdata.now = time_msec();
3884 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3889 if (oqsr.port_no == OFPP_ANY) {
3890 error = OFPERR_OFPQOFC_BAD_QUEUE;
3891 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3892 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3897 port = ofproto_get_port(ofproto, oqsr.port_no);
3899 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3900 : OFPERR_OFPQOFC_BAD_PORT);
3903 ofconn_send_replies(ofconn, &cbdata.replies);
3905 ofpbuf_list_delete(&cbdata.replies);
3912 is_flow_deletion_pending(const struct ofproto *ofproto,
3913 const struct cls_rule *cls_rule,
3915 OVS_REQUIRES(ofproto_mutex)
3917 if (!hmap_is_empty(&ofproto->deletions)) {
3918 struct ofoperation *op;
3920 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3921 cls_rule_hash(cls_rule, table_id),
3922 &ofproto->deletions) {
3923 if (op->rule->table_id == table_id
3924 && cls_rule_equal(cls_rule, &op->rule->cr)) {
3934 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3935 OVS_REQUIRES(ofproto_mutex)
3936 OVS_NO_THREAD_SAFETY_ANALYSIS
3938 return classifier_count(&table->cls) + extra_space > table->max_flows;
3942 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3943 unsigned int extra_space)
3944 OVS_REQUIRES(ofproto_mutex)
3946 while (should_evict_a_rule(table, extra_space)) {
3949 if (!choose_rule_to_evict(table, &rule)) {
3950 return OFPERR_OFPFMFC_TABLE_FULL;
3951 } else if (rule->pending) {
3952 return OFPROTO_POSTPONE;
3954 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3955 delete_flow__(rule, group, OFPRR_EVICTION);
3956 ofopgroup_submit(group);
3963 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3964 * in which no matching flow already exists in the flow table.
3966 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3967 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3968 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3969 * initiated now but may be retried later.
3971 * The caller retains ownership of 'fm->ofpacts'.
3973 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3976 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3977 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3978 OVS_REQUIRES(ofproto_mutex)
3980 struct oftable *table;
3986 if (!check_table_id(ofproto, fm->table_id)) {
3987 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3992 if (fm->table_id == 0xff) {
3993 if (ofproto->ofproto_class->rule_choose_table) {
3994 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4000 ovs_assert(table_id < ofproto->n_tables);
4004 } else if (fm->table_id < ofproto->n_tables) {
4005 table_id = fm->table_id;
4007 return OFPERR_OFPBRC_BAD_TABLE_ID;
4010 table = &ofproto->tables[table_id];
4012 if (!oftable_is_modifiable(table, fm->flags)) {
4013 return OFPERR_OFPBRC_EPERM;
4016 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4017 if (!match_has_default_hidden_fields(&fm->match)) {
4018 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4019 "non-default values to hidden fields", ofproto->name);
4020 return OFPERR_OFPBRC_EPERM;
4024 cls_rule_init(&cr, &fm->match, fm->priority);
4026 /* Transform "add" into "modify" if there's an existing identical flow. */
4027 fat_rwlock_rdlock(&table->cls.rwlock);
4028 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4029 fat_rwlock_unlock(&table->cls.rwlock);
4031 cls_rule_destroy(&cr);
4032 if (!rule_is_modifiable(rule, fm->flags)) {
4033 return OFPERR_OFPBRC_EPERM;
4034 } else if (rule->pending) {
4035 return OFPROTO_POSTPONE;
4037 struct rule_collection rules;
4039 rule_collection_init(&rules);
4040 rule_collection_add(&rules, rule);
4041 fm->modify_cookie = true;
4042 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4043 rule_collection_destroy(&rules);
4049 /* Serialize against pending deletion. */
4050 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
4051 cls_rule_destroy(&cr);
4052 return OFPROTO_POSTPONE;
4055 /* Check for overlap, if requested. */
4056 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4059 fat_rwlock_rdlock(&table->cls.rwlock);
4060 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4061 fat_rwlock_unlock(&table->cls.rwlock);
4064 cls_rule_destroy(&cr);
4065 return OFPERR_OFPFMFC_OVERLAP;
4069 /* If necessary, evict an existing rule to clear out space. */
4070 error = evict_rules_from_table(ofproto, table, 1);
4072 cls_rule_destroy(&cr);
4076 /* Allocate new rule. */
4077 rule = ofproto->ofproto_class->rule_alloc();
4079 cls_rule_destroy(&cr);
4080 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4081 ofproto->name, ovs_strerror(error));
4085 /* Initialize base state. */
4086 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4087 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4088 ovs_refcount_init(&rule->ref_count);
4089 rule->pending = NULL;
4090 rule->flow_cookie = fm->new_cookie;
4091 rule->created = rule->modified = time_msec();
4093 ovs_mutex_init(&rule->mutex);
4094 ovs_mutex_lock(&rule->mutex);
4095 rule->idle_timeout = fm->idle_timeout;
4096 rule->hard_timeout = fm->hard_timeout;
4097 ovs_mutex_unlock(&rule->mutex);
4099 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4100 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4101 ovsrcu_set(&rule->actions,
4102 rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len));
4103 list_init(&rule->meter_list_node);
4104 rule->eviction_group = NULL;
4105 list_init(&rule->expirable);
4106 rule->monitor_flags = 0;
4107 rule->add_seqno = 0;
4108 rule->modify_seqno = 0;
4110 /* Construct rule, initializing derived state. */
4111 error = ofproto->ofproto_class->rule_construct(rule);
4113 ofproto_rule_destroy__(rule);
4118 do_add_flow(ofproto, ofconn, request, fm->buffer_id, rule);
4124 do_add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
4125 const struct ofp_header *request, uint32_t buffer_id,
4127 OVS_REQUIRES(ofproto_mutex)
4129 struct ofopgroup *group;
4131 oftable_insert_rule(rule);
4133 group = ofopgroup_create(ofproto, ofconn, request, buffer_id);
4134 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4135 ofproto->ofproto_class->rule_insert(rule);
4136 ofopgroup_submit(group);
4139 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4141 /* Modifies the rules listed in 'rules', changing their actions to match those
4144 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4147 * Returns 0 on success, otherwise an OpenFlow error code. */
4149 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4150 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4151 const struct rule_collection *rules)
4152 OVS_REQUIRES(ofproto_mutex)
4154 enum ofoperation_type type;
4155 struct ofopgroup *group;
4159 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4160 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4161 error = OFPERR_OFPBRC_EPERM;
4162 for (i = 0; i < rules->n; i++) {
4163 struct rule *rule = rules->rules[i];
4164 const struct rule_actions *actions;
4165 struct ofoperation *op;
4166 bool actions_changed;
4167 bool reset_counters;
4169 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4171 if (rule_is_modifiable(rule, fm->flags)) {
4172 /* At least one rule is modifiable, don't report EPERM error. */
4178 actions = rule_get_actions(rule);
4179 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4181 actions->ofpacts_len);
4183 op = ofoperation_create(group, rule, type, 0);
4185 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4186 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4188 if (type == OFOPERATION_REPLACE) {
4189 ovs_mutex_lock(&rule->mutex);
4190 rule->idle_timeout = fm->idle_timeout;
4191 rule->hard_timeout = fm->hard_timeout;
4192 ovs_mutex_unlock(&rule->mutex);
4194 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4195 if (fm->idle_timeout || fm->hard_timeout) {
4196 if (!rule->eviction_group) {
4197 eviction_group_add_rule(rule);
4200 eviction_group_remove_rule(rule);
4204 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4205 if (actions_changed || reset_counters) {
4206 const struct rule_actions *new_actions;
4208 op->actions = rule_get_actions(rule);
4209 new_actions = rule_actions_create(ofproto,
4210 fm->ofpacts, fm->ofpacts_len);
4212 ovsrcu_set(&rule->actions, new_actions);
4214 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4217 ofoperation_complete(op, 0);
4220 ofopgroup_submit(group);
4226 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4227 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4228 OVS_REQUIRES(ofproto_mutex)
4230 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4233 return add_flow(ofproto, ofconn, fm, request);
4236 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4239 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4242 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4243 struct ofputil_flow_mod *fm,
4244 const struct ofp_header *request)
4245 OVS_REQUIRES(ofproto_mutex)
4247 struct rule_criteria criteria;
4248 struct rule_collection rules;
4251 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4252 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4253 error = collect_rules_loose(ofproto, &criteria, &rules);
4254 rule_criteria_destroy(&criteria);
4257 error = (rules.n > 0
4258 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4259 : modify_flows_add(ofproto, ofconn, fm, request));
4262 rule_collection_destroy(&rules);
4267 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4270 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4273 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4274 struct ofputil_flow_mod *fm,
4275 const struct ofp_header *request)
4276 OVS_REQUIRES(ofproto_mutex)
4278 struct rule_criteria criteria;
4279 struct rule_collection rules;
4282 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4283 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4284 error = collect_rules_strict(ofproto, &criteria, &rules);
4285 rule_criteria_destroy(&criteria);
4289 error = modify_flows_add(ofproto, ofconn, fm, request);
4290 } else if (rules.n == 1) {
4291 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4295 rule_collection_destroy(&rules);
4300 /* OFPFC_DELETE implementation. */
4303 delete_flow__(struct rule *rule, struct ofopgroup *group,
4304 enum ofp_flow_removed_reason reason)
4305 OVS_REQUIRES(ofproto_mutex)
4307 struct ofproto *ofproto = rule->ofproto;
4309 ofproto_rule_send_removed(rule, reason);
4311 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4312 oftable_remove_rule(rule);
4313 ofproto->ofproto_class->rule_delete(rule);
4316 /* Deletes the rules listed in 'rules'.
4318 * Returns 0 on success, otherwise an OpenFlow error code. */
4320 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4321 const struct ofp_header *request,
4322 const struct rule_collection *rules,
4323 enum ofp_flow_removed_reason reason)
4324 OVS_REQUIRES(ofproto_mutex)
4326 struct ofopgroup *group;
4329 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4330 for (i = 0; i < rules->n; i++) {
4331 delete_flow__(rules->rules[i], group, reason);
4333 ofopgroup_submit(group);
4338 /* Implements OFPFC_DELETE. */
4340 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4341 const struct ofputil_flow_mod *fm,
4342 const struct ofp_header *request)
4343 OVS_REQUIRES(ofproto_mutex)
4345 struct rule_criteria criteria;
4346 struct rule_collection rules;
4349 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4350 fm->cookie, fm->cookie_mask,
4351 fm->out_port, fm->out_group);
4352 error = collect_rules_loose(ofproto, &criteria, &rules);
4353 rule_criteria_destroy(&criteria);
4355 if (!error && rules.n > 0) {
4356 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4358 rule_collection_destroy(&rules);
4363 /* Implements OFPFC_DELETE_STRICT. */
4365 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4366 const struct ofputil_flow_mod *fm,
4367 const struct ofp_header *request)
4368 OVS_REQUIRES(ofproto_mutex)
4370 struct rule_criteria criteria;
4371 struct rule_collection rules;
4374 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4375 fm->cookie, fm->cookie_mask,
4376 fm->out_port, fm->out_group);
4377 error = collect_rules_strict(ofproto, &criteria, &rules);
4378 rule_criteria_destroy(&criteria);
4380 if (!error && rules.n > 0) {
4381 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4383 rule_collection_destroy(&rules);
4389 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4390 OVS_REQUIRES(ofproto_mutex)
4392 struct ofputil_flow_removed fr;
4395 if (ofproto_rule_is_hidden(rule) ||
4396 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4400 minimatch_expand(&rule->cr.match, &fr.match);
4401 fr.priority = rule->cr.priority;
4402 fr.cookie = rule->flow_cookie;
4404 fr.table_id = rule->table_id;
4405 calc_duration(rule->created, time_msec(),
4406 &fr.duration_sec, &fr.duration_nsec);
4407 ovs_mutex_lock(&rule->mutex);
4408 fr.idle_timeout = rule->idle_timeout;
4409 fr.hard_timeout = rule->hard_timeout;
4410 ovs_mutex_unlock(&rule->mutex);
4411 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4412 &fr.byte_count, &used);
4414 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4417 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4418 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4421 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4424 * ofproto implementation ->run() functions should use this function to expire
4425 * OpenFlow flows. */
4427 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4428 OVS_REQUIRES(ofproto_mutex)
4430 struct ofproto *ofproto = rule->ofproto;
4432 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4433 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4435 ofproto_rule_delete__(ofproto, rule, reason);
4438 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4439 * means "infinite". */
4441 reduce_timeout(uint16_t max, uint16_t *timeout)
4443 if (max && (!*timeout || *timeout > max)) {
4448 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4449 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4450 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4452 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4454 ofproto_rule_reduce_timeouts(struct rule *rule,
4455 uint16_t idle_timeout, uint16_t hard_timeout)
4456 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4458 if (!idle_timeout && !hard_timeout) {
4462 ovs_mutex_lock(&ofproto_mutex);
4463 if (list_is_empty(&rule->expirable)) {
4464 list_insert(&rule->ofproto->expirable, &rule->expirable);
4466 ovs_mutex_unlock(&ofproto_mutex);
4468 ovs_mutex_lock(&rule->mutex);
4469 reduce_timeout(idle_timeout, &rule->idle_timeout);
4470 reduce_timeout(hard_timeout, &rule->hard_timeout);
4471 ovs_mutex_unlock(&rule->mutex);
4475 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4476 OVS_EXCLUDED(ofproto_mutex)
4478 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4479 struct ofputil_flow_mod fm;
4480 uint64_t ofpacts_stub[1024 / 8];
4481 struct ofpbuf ofpacts;
4484 error = reject_slave_controller(ofconn);
4489 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4490 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4492 u16_to_ofp(ofproto->max_ports),
4495 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4498 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4501 goto exit_free_ofpacts;
4504 ofconn_report_flow_mod(ofconn, fm.command);
4507 ofpbuf_uninit(&ofpacts);
4513 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4514 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4515 OVS_EXCLUDED(ofproto_mutex)
4519 ovs_mutex_lock(&ofproto_mutex);
4520 if (ofproto->n_pending < 50) {
4521 switch (fm->command) {
4523 error = add_flow(ofproto, ofconn, fm, oh);
4527 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4530 case OFPFC_MODIFY_STRICT:
4531 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4535 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4538 case OFPFC_DELETE_STRICT:
4539 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4543 if (fm->command > 0xff) {
4544 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4545 "flow_mod_table_id extension is not enabled",
4548 error = OFPERR_OFPFMFC_BAD_COMMAND;
4552 ovs_assert(!list_is_empty(&ofproto->pending));
4553 error = OFPROTO_POSTPONE;
4555 ovs_mutex_unlock(&ofproto_mutex);
4557 run_rule_executes(ofproto);
4562 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4564 struct ofputil_role_request request;
4565 struct ofputil_role_request reply;
4569 error = ofputil_decode_role_message(oh, &request);
4574 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4575 if (ofconn_get_role(ofconn) != request.role
4576 && ofconn_has_pending_opgroups(ofconn)) {
4577 return OFPROTO_POSTPONE;
4580 if (request.have_generation_id
4581 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4582 return OFPERR_OFPRRFC_STALE;
4585 ofconn_set_role(ofconn, request.role);
4588 reply.role = ofconn_get_role(ofconn);
4589 reply.have_generation_id = ofconn_get_master_election_id(
4590 ofconn, &reply.generation_id);
4591 buf = ofputil_encode_role_reply(oh, &reply);
4592 ofconn_send_reply(ofconn, buf);
4598 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4599 const struct ofp_header *oh)
4601 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4602 enum ofputil_protocol cur, next;
4604 cur = ofconn_get_protocol(ofconn);
4605 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4606 ofconn_set_protocol(ofconn, next);
4612 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4614 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4615 enum ofputil_protocol cur, next;
4616 enum ofputil_protocol next_base;
4618 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4620 return OFPERR_OFPBRC_EPERM;
4623 cur = ofconn_get_protocol(ofconn);
4624 next = ofputil_protocol_set_base(cur, next_base);
4625 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4626 /* Avoid sending async messages in surprising protocol. */
4627 return OFPROTO_POSTPONE;
4630 ofconn_set_protocol(ofconn, next);
4635 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4636 const struct ofp_header *oh)
4638 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4641 format = ntohl(msg->format);
4642 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4643 return OFPERR_OFPBRC_EPERM;
4646 if (format != ofconn_get_packet_in_format(ofconn)
4647 && ofconn_has_pending_opgroups(ofconn)) {
4648 /* Avoid sending async message in surprsing packet in format. */
4649 return OFPROTO_POSTPONE;
4652 ofconn_set_packet_in_format(ofconn, format);
4657 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4659 const struct nx_async_config *msg = ofpmsg_body(oh);
4660 uint32_t master[OAM_N_TYPES];
4661 uint32_t slave[OAM_N_TYPES];
4663 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4664 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4665 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4667 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4668 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4669 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4671 ofconn_set_async_config(ofconn, master, slave);
4672 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4673 !ofconn_get_miss_send_len(ofconn)) {
4674 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4681 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4684 uint32_t master[OAM_N_TYPES];
4685 uint32_t slave[OAM_N_TYPES];
4686 struct nx_async_config *msg;
4688 ofconn_get_async_config(ofconn, master, slave);
4689 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4690 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4692 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4693 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4694 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4696 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4697 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4698 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4700 ofconn_send_reply(ofconn, buf);
4706 handle_nxt_set_controller_id(struct ofconn *ofconn,
4707 const struct ofp_header *oh)
4709 const struct nx_controller_id *nci = ofpmsg_body(oh);
4711 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4712 return OFPERR_NXBRC_MUST_BE_ZERO;
4715 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4720 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4724 if (ofconn_has_pending_opgroups(ofconn)) {
4725 return OFPROTO_POSTPONE;
4728 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4729 ? OFPRAW_OFPT10_BARRIER_REPLY
4730 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4731 ofconn_send_reply(ofconn, buf);
4736 ofproto_compose_flow_refresh_update(const struct rule *rule,
4737 enum nx_flow_monitor_flags flags,
4739 OVS_REQUIRES(ofproto_mutex)
4741 struct ofoperation *op = rule->pending;
4742 const struct rule_actions *actions;
4743 struct ofputil_flow_update fu;
4746 if (op && op->type == OFOPERATION_ADD) {
4747 /* We'll report the final flow when the operation completes. Reporting
4748 * it now would cause a duplicate report later. */
4752 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4753 ? NXFME_ADDED : NXFME_MODIFIED);
4755 ovs_mutex_lock(&rule->mutex);
4756 fu.idle_timeout = rule->idle_timeout;
4757 fu.hard_timeout = rule->hard_timeout;
4758 ovs_mutex_unlock(&rule->mutex);
4759 fu.table_id = rule->table_id;
4760 fu.cookie = rule->flow_cookie;
4761 minimatch_expand(&rule->cr.match, &match);
4763 fu.priority = rule->cr.priority;
4765 if (!(flags & NXFMF_ACTIONS)) {
4768 actions = rule_get_actions(rule);
4770 /* An operation is in progress. Use the previous version of the flow's
4771 * actions, so that when the operation commits we report the change. */
4773 case OFOPERATION_ADD:
4776 case OFOPERATION_MODIFY:
4777 case OFOPERATION_REPLACE:
4778 actions = op->actions ? op->actions : rule_get_actions(rule);
4781 case OFOPERATION_DELETE:
4782 actions = rule_get_actions(rule);
4789 fu.ofpacts = actions ? actions->ofpacts : NULL;
4790 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4792 if (list_is_empty(msgs)) {
4793 ofputil_start_flow_update(msgs);
4795 ofputil_append_flow_update(&fu, msgs);
4799 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4801 OVS_REQUIRES(ofproto_mutex)
4805 for (i = 0; i < rules->n; i++) {
4806 struct rule *rule = rules->rules[i];
4807 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4808 rule->monitor_flags = 0;
4810 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4815 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4816 struct rule *rule, uint64_t seqno,
4817 struct rule_collection *rules)
4818 OVS_REQUIRES(ofproto_mutex)
4820 enum nx_flow_monitor_flags update;
4822 if (ofproto_rule_is_hidden(rule)) {
4827 ? ofoperation_has_out_port(rule->pending, m->out_port)
4828 : ofproto_rule_has_out_port(rule, m->out_port))) {
4833 if (rule->add_seqno > seqno) {
4834 update = NXFMF_ADD | NXFMF_MODIFY;
4835 } else if (rule->modify_seqno > seqno) {
4836 update = NXFMF_MODIFY;
4841 if (!(m->flags & update)) {
4845 update = NXFMF_INITIAL;
4848 if (!rule->monitor_flags) {
4849 rule_collection_add(rules, rule);
4851 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4855 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4857 struct rule_collection *rules)
4858 OVS_REQUIRES(ofproto_mutex)
4860 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4861 const struct ofoperation *op;
4862 const struct oftable *table;
4863 struct cls_rule target;
4865 cls_rule_init_from_minimatch(&target, &m->match, 0);
4866 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4867 struct cls_cursor cursor;
4870 fat_rwlock_rdlock(&table->cls.rwlock);
4871 cls_cursor_init(&cursor, &table->cls, &target);
4872 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4873 ovs_assert(!rule->pending); /* XXX */
4874 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4876 fat_rwlock_unlock(&table->cls.rwlock);
4879 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4880 struct rule *rule = op->rule;
4882 if (((m->table_id == 0xff
4883 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4884 : m->table_id == rule->table_id))
4885 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4886 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4889 cls_rule_destroy(&target);
4893 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4894 struct rule_collection *rules)
4895 OVS_REQUIRES(ofproto_mutex)
4897 if (m->flags & NXFMF_INITIAL) {
4898 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4903 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4904 uint64_t seqno, struct rule_collection *rules)
4905 OVS_REQUIRES(ofproto_mutex)
4907 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4911 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4912 OVS_EXCLUDED(ofproto_mutex)
4914 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4915 struct ofmonitor **monitors;
4916 size_t n_monitors, allocated_monitors;
4917 struct rule_collection rules;
4918 struct list replies;
4924 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4926 n_monitors = allocated_monitors = 0;
4928 ovs_mutex_lock(&ofproto_mutex);
4930 struct ofputil_flow_monitor_request request;
4931 struct ofmonitor *m;
4934 retval = ofputil_decode_flow_monitor_request(&request, &b);
4935 if (retval == EOF) {
4937 } else if (retval) {
4942 if (request.table_id != 0xff
4943 && request.table_id >= ofproto->n_tables) {
4944 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4948 error = ofmonitor_create(&request, ofconn, &m);
4953 if (n_monitors >= allocated_monitors) {
4954 monitors = x2nrealloc(monitors, &allocated_monitors,
4957 monitors[n_monitors++] = m;
4960 rule_collection_init(&rules);
4961 for (i = 0; i < n_monitors; i++) {
4962 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4965 ofpmp_init(&replies, oh);
4966 ofmonitor_compose_refresh_updates(&rules, &replies);
4967 ovs_mutex_unlock(&ofproto_mutex);
4969 rule_collection_destroy(&rules);
4971 ofconn_send_replies(ofconn, &replies);
4977 for (i = 0; i < n_monitors; i++) {
4978 ofmonitor_destroy(monitors[i]);
4981 ovs_mutex_unlock(&ofproto_mutex);
4987 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4988 OVS_EXCLUDED(ofproto_mutex)
4990 struct ofmonitor *m;
4994 id = ofputil_decode_flow_monitor_cancel(oh);
4996 ovs_mutex_lock(&ofproto_mutex);
4997 m = ofmonitor_lookup(ofconn, id);
4999 ofmonitor_destroy(m);
5002 error = OFPERR_NXBRC_FM_BAD_ID;
5004 ovs_mutex_unlock(&ofproto_mutex);
5009 /* Meters implementation.
5011 * Meter table entry, indexed by the OpenFlow meter_id.
5012 * These are always dynamically allocated to allocate enough space for
5014 * 'created' is used to compute the duration for meter stats.
5015 * 'list rules' is needed so that we can delete the dependent rules when the
5016 * meter table entry is deleted.
5017 * 'provider_meter_id' is for the provider's private use.
5020 long long int created; /* Time created. */
5021 struct list rules; /* List of "struct rule_dpif"s. */
5022 ofproto_meter_id provider_meter_id;
5023 uint16_t flags; /* Meter flags. */
5024 uint16_t n_bands; /* Number of meter bands. */
5025 struct ofputil_meter_band *bands;
5029 * This is used in instruction validation at flow set-up time,
5030 * as flows may not use non-existing meters.
5031 * Return value of UINT32_MAX signifies an invalid meter.
5034 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5036 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5037 const struct meter *meter = ofproto->meters[of_meter_id];
5039 return meter->provider_meter_id.uint32;
5046 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5050 meter->flags = config->flags;
5051 meter->n_bands = config->n_bands;
5052 meter->bands = xmemdup(config->bands,
5053 config->n_bands * sizeof *meter->bands);
5056 static struct meter *
5057 meter_create(const struct ofputil_meter_config *config,
5058 ofproto_meter_id provider_meter_id)
5060 struct meter *meter;
5062 meter = xzalloc(sizeof *meter);
5063 meter->provider_meter_id = provider_meter_id;
5064 meter->created = time_msec();
5065 list_init(&meter->rules);
5067 meter_update(meter, config);
5073 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5074 OVS_REQUIRES(ofproto_mutex)
5077 for (mid = first; mid <= last; ++mid) {
5078 struct meter *meter = ofproto->meters[mid];
5080 ofproto->meters[mid] = NULL;
5081 ofproto->ofproto_class->meter_del(ofproto,
5082 meter->provider_meter_id);
5090 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5092 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5093 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5097 return OFPERR_OFPMMFC_METER_EXISTS;
5100 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5103 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5104 *meterp = meter_create(&mm->meter, provider_meter_id);
5110 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5112 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5114 uint32_t provider_meter_id;
5117 return OFPERR_OFPMMFC_UNKNOWN_METER;
5120 provider_meter_id = meter->provider_meter_id.uint32;
5121 error = ofproto->ofproto_class->meter_set(ofproto,
5122 &meter->provider_meter_id,
5124 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5126 meter_update(meter, &mm->meter);
5132 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5133 struct ofputil_meter_mod *mm)
5134 OVS_EXCLUDED(ofproto_mutex)
5136 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5137 uint32_t meter_id = mm->meter.meter_id;
5138 struct rule_collection rules;
5139 enum ofperr error = 0;
5140 uint32_t first, last;
5142 if (meter_id == OFPM13_ALL) {
5144 last = ofproto->meter_features.max_meters;
5146 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5149 first = last = meter_id;
5152 /* First delete the rules that use this meter. If any of those rules are
5153 * currently being modified, postpone the whole operation until later. */
5154 rule_collection_init(&rules);
5155 ovs_mutex_lock(&ofproto_mutex);
5156 for (meter_id = first; meter_id <= last; ++meter_id) {
5157 struct meter *meter = ofproto->meters[meter_id];
5158 if (meter && !list_is_empty(&meter->rules)) {
5161 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5162 if (rule->pending) {
5163 error = OFPROTO_POSTPONE;
5166 rule_collection_add(&rules, rule);
5171 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5174 /* Delete the meters. */
5175 meter_delete(ofproto, first, last);
5178 ovs_mutex_unlock(&ofproto_mutex);
5179 rule_collection_destroy(&rules);
5185 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5187 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5188 struct ofputil_meter_mod mm;
5189 uint64_t bands_stub[256 / 8];
5190 struct ofpbuf bands;
5194 error = reject_slave_controller(ofconn);
5199 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5201 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5203 goto exit_free_bands;
5206 meter_id = mm.meter.meter_id;
5208 if (mm.command != OFPMC13_DELETE) {
5209 /* Fails also when meters are not implemented by the provider. */
5210 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5211 error = OFPERR_OFPMMFC_INVALID_METER;
5212 goto exit_free_bands;
5213 } else if (meter_id > ofproto->meter_features.max_meters) {
5214 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5215 goto exit_free_bands;
5217 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5218 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5219 goto exit_free_bands;
5223 switch (mm.command) {
5225 error = handle_add_meter(ofproto, &mm);
5228 case OFPMC13_MODIFY:
5229 error = handle_modify_meter(ofproto, &mm);
5232 case OFPMC13_DELETE:
5233 error = handle_delete_meter(ofconn, oh, &mm);
5237 error = OFPERR_OFPMMFC_BAD_COMMAND;
5242 ofpbuf_uninit(&bands);
5247 handle_meter_features_request(struct ofconn *ofconn,
5248 const struct ofp_header *request)
5250 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5251 struct ofputil_meter_features features;
5254 if (ofproto->ofproto_class->meter_get_features) {
5255 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5257 memset(&features, 0, sizeof features);
5259 b = ofputil_encode_meter_features_reply(&features, request);
5261 ofconn_send_reply(ofconn, b);
5266 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5269 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5270 struct list replies;
5271 uint64_t bands_stub[256 / 8];
5272 struct ofpbuf bands;
5273 uint32_t meter_id, first, last;
5275 ofputil_decode_meter_request(request, &meter_id);
5277 if (meter_id == OFPM13_ALL) {
5279 last = ofproto->meter_features.max_meters;
5281 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5282 !ofproto->meters[meter_id]) {
5283 return OFPERR_OFPMMFC_UNKNOWN_METER;
5285 first = last = meter_id;
5288 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5289 ofpmp_init(&replies, request);
5291 for (meter_id = first; meter_id <= last; ++meter_id) {
5292 struct meter *meter = ofproto->meters[meter_id];
5294 continue; /* Skip non-existing meters. */
5296 if (type == OFPTYPE_METER_STATS_REQUEST) {
5297 struct ofputil_meter_stats stats;
5299 stats.meter_id = meter_id;
5301 /* Provider sets the packet and byte counts, we do the rest. */
5302 stats.flow_count = list_size(&meter->rules);
5303 calc_duration(meter->created, time_msec(),
5304 &stats.duration_sec, &stats.duration_nsec);
5305 stats.n_bands = meter->n_bands;
5306 ofpbuf_clear(&bands);
5308 = ofpbuf_put_uninit(&bands,
5309 meter->n_bands * sizeof *stats.bands);
5311 if (!ofproto->ofproto_class->meter_get(ofproto,
5312 meter->provider_meter_id,
5314 ofputil_append_meter_stats(&replies, &stats);
5316 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5317 struct ofputil_meter_config config;
5319 config.meter_id = meter_id;
5320 config.flags = meter->flags;
5321 config.n_bands = meter->n_bands;
5322 config.bands = meter->bands;
5323 ofputil_append_meter_config(&replies, &config);
5327 ofconn_send_replies(ofconn, &replies);
5328 ofpbuf_uninit(&bands);
5333 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5334 struct ofgroup **group)
5335 OVS_TRY_RDLOCK(true, (*group)->rwlock)
5337 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5338 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5339 hash_int(group_id, 0), &ofproto->groups) {
5340 if ((*group)->group_id == group_id) {
5341 ovs_rwlock_rdlock(&(*group)->rwlock);
5342 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5346 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5351 ofproto_group_release(struct ofgroup *group)
5352 OVS_RELEASES(group->rwlock)
5354 ovs_rwlock_unlock(&group->rwlock);
5358 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
5359 struct ofgroup **group)
5360 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
5361 OVS_TRY_WRLOCK(true, (*group)->rwlock)
5363 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5364 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5365 hash_int(group_id, 0), &ofproto->groups) {
5366 if ((*group)->group_id == group_id) {
5367 ovs_rwlock_wrlock(&(*group)->rwlock);
5371 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5376 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5377 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5379 struct ofgroup *grp;
5381 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5382 hash_int(group_id, 0), &ofproto->groups) {
5383 if (grp->group_id == group_id) {
5391 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5392 OVS_EXCLUDED(ofproto->groups_rwlock)
5396 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5397 exists = ofproto_group_exists__(ofproto, group_id);
5398 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5404 group_get_ref_count(struct ofgroup *group)
5405 OVS_EXCLUDED(ofproto_mutex)
5407 struct ofproto *ofproto = group->ofproto;
5408 struct rule_criteria criteria;
5409 struct rule_collection rules;
5414 match_init_catchall(&match);
5415 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5416 OFPP_ANY, group->group_id);
5417 ovs_mutex_lock(&ofproto_mutex);
5418 error = collect_rules_loose(ofproto, &criteria, &rules);
5419 ovs_mutex_unlock(&ofproto_mutex);
5420 rule_criteria_destroy(&criteria);
5422 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5424 rule_collection_destroy(&rules);
5429 append_group_stats(struct ofgroup *group, struct list *replies)
5430 OVS_REQ_RDLOCK(group->rwlock)
5432 struct ofputil_group_stats ogs;
5433 struct ofproto *ofproto = group->ofproto;
5434 long long int now = time_msec();
5437 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5439 /* Provider sets the packet and byte counts, we do the rest. */
5440 ogs.ref_count = group_get_ref_count(group);
5441 ogs.n_buckets = group->n_buckets;
5443 error = (ofproto->ofproto_class->group_get_stats
5444 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5447 ogs.packet_count = UINT64_MAX;
5448 ogs.byte_count = UINT64_MAX;
5449 memset(ogs.bucket_stats, 0xff,
5450 ogs.n_buckets * sizeof *ogs.bucket_stats);
5453 ogs.group_id = group->group_id;
5454 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5456 ofputil_append_group_stats(replies, &ogs);
5458 free(ogs.bucket_stats);
5462 handle_group_request(struct ofconn *ofconn,
5463 const struct ofp_header *request, uint32_t group_id,
5464 void (*cb)(struct ofgroup *, struct list *replies))
5466 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5467 struct ofgroup *group;
5468 struct list replies;
5470 ofpmp_init(&replies, request);
5471 if (group_id == OFPG_ALL) {
5472 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5473 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5474 ovs_rwlock_rdlock(&group->rwlock);
5475 cb(group, &replies);
5476 ovs_rwlock_unlock(&group->rwlock);
5478 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5480 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5481 cb(group, &replies);
5482 ofproto_group_release(group);
5485 ofconn_send_replies(ofconn, &replies);
5489 handle_group_stats_request(struct ofconn *ofconn,
5490 const struct ofp_header *request)
5495 error = ofputil_decode_group_stats_request(request, &group_id);
5500 handle_group_request(ofconn, request, group_id, append_group_stats);
5505 append_group_desc(struct ofgroup *group, struct list *replies)
5507 struct ofputil_group_desc gds;
5509 gds.group_id = group->group_id;
5510 gds.type = group->type;
5511 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5515 handle_group_desc_stats_request(struct ofconn *ofconn,
5516 const struct ofp_header *request)
5518 handle_group_request(ofconn, request,
5519 ofputil_decode_group_desc_request(request),
5525 handle_group_features_stats_request(struct ofconn *ofconn,
5526 const struct ofp_header *request)
5528 struct ofproto *p = ofconn_get_ofproto(ofconn);
5531 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5533 ofconn_send_reply(ofconn, msg);
5540 handle_queue_get_config_request(struct ofconn *ofconn,
5541 const struct ofp_header *oh)
5543 struct ofproto *p = ofconn_get_ofproto(ofconn);
5544 struct netdev_queue_dump queue_dump;
5545 struct ofport *ofport;
5546 unsigned int queue_id;
5547 struct ofpbuf *reply;
5548 struct smap details;
5552 error = ofputil_decode_queue_get_config_request(oh, &request);
5557 ofport = ofproto_get_port(p, request);
5559 return OFPERR_OFPQOFC_BAD_PORT;
5562 reply = ofputil_encode_queue_get_config_reply(oh);
5564 smap_init(&details);
5565 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5566 struct ofputil_queue_config queue;
5568 /* None of the existing queues have compatible properties, so we
5569 * hard-code omitting min_rate and max_rate. */
5570 queue.queue_id = queue_id;
5571 queue.min_rate = UINT16_MAX;
5572 queue.max_rate = UINT16_MAX;
5573 ofputil_append_queue_get_config_reply(reply, &queue);
5575 smap_destroy(&details);
5577 ofconn_send_reply(ofconn, reply);
5582 /* Implements OFPGC11_ADD
5583 * in which no matching flow already exists in the flow table.
5585 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5586 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5587 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5588 * initiated now but may be retried later.
5590 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5591 * ownership remains with the caller.
5593 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5596 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5598 struct ofgroup *ofgroup;
5601 if (gm->group_id > OFPG_MAX) {
5602 return OFPERR_OFPGMFC_INVALID_GROUP;
5604 if (gm->type > OFPGT11_FF) {
5605 return OFPERR_OFPGMFC_BAD_TYPE;
5608 /* Allocate new group and initialize it. */
5609 ofgroup = ofproto->ofproto_class->group_alloc();
5611 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
5612 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5615 ovs_rwlock_init(&ofgroup->rwlock);
5616 ofgroup->ofproto = ofproto;
5617 ofgroup->group_id = gm->group_id;
5618 ofgroup->type = gm->type;
5619 ofgroup->created = ofgroup->modified = time_msec();
5621 list_move(&ofgroup->buckets, &gm->buckets);
5622 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5624 /* Construct called BEFORE any locks are held. */
5625 error = ofproto->ofproto_class->group_construct(ofgroup);
5630 /* We wrlock as late as possible to minimize the time we jam any other
5631 * threads: No visible state changes before acquiring the lock. */
5632 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5634 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5635 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5639 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5640 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5645 /* Insert new group. */
5646 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5647 hash_int(ofgroup->group_id, 0));
5648 ofproto->n_groups[ofgroup->type]++;
5650 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5655 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5656 ofproto->ofproto_class->group_destruct(ofgroup);
5658 ofputil_bucket_list_destroy(&ofgroup->buckets);
5659 ofproto->ofproto_class->group_dealloc(ofgroup);
5664 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5667 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5670 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5672 struct ofgroup *ofgroup;
5673 struct ofgroup *victim;
5676 if (gm->group_id > OFPG_MAX) {
5677 return OFPERR_OFPGMFC_INVALID_GROUP;
5680 if (gm->type > OFPGT11_FF) {
5681 return OFPERR_OFPGMFC_BAD_TYPE;
5684 victim = ofproto->ofproto_class->group_alloc();
5686 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5687 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5690 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5691 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5694 /* Both group's and its container's write locks held now.
5695 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5696 if (ofgroup->type != gm->type
5697 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5698 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5703 list_move(&victim->buckets, &ofgroup->buckets);
5705 ofgroup->type = gm->type;
5706 list_move(&ofgroup->buckets, &gm->buckets);
5707 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5709 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5711 ofputil_bucket_list_destroy(&victim->buckets);
5712 ofproto->n_groups[victim->type]--;
5713 ofproto->n_groups[ofgroup->type]++;
5714 ofgroup->modified = time_msec();
5716 ofputil_bucket_list_destroy(&ofgroup->buckets);
5719 list_move(&ofgroup->buckets, &victim->buckets);
5723 ovs_rwlock_unlock(&ofgroup->rwlock);
5724 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5726 ofproto->ofproto_class->group_dealloc(victim);
5731 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5732 OVS_RELEASES(ofproto->groups_rwlock)
5735 struct ofputil_flow_mod fm;
5737 /* Delete all flow entries containing this group in a group action */
5738 match_init_catchall(&match);
5739 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5740 fm.out_group = ofgroup->group_id;
5741 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5743 /* Must wait until existing readers are done,
5744 * while holding the container's write lock at the same time. */
5745 ovs_rwlock_wrlock(&ofgroup->rwlock);
5746 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5747 /* No-one can find this group any more. */
5748 ofproto->n_groups[ofgroup->type]--;
5749 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5751 ofproto->ofproto_class->group_destruct(ofgroup);
5752 ofputil_bucket_list_destroy(&ofgroup->buckets);
5753 ovs_rwlock_unlock(&ofgroup->rwlock);
5754 ovs_rwlock_destroy(&ofgroup->rwlock);
5755 ofproto->ofproto_class->group_dealloc(ofgroup);
5758 /* Implements OFPGC_DELETE. */
5760 delete_group(struct ofproto *ofproto, uint32_t group_id)
5762 struct ofgroup *ofgroup;
5764 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5765 if (group_id == OFPG_ALL) {
5767 struct hmap_node *node = hmap_first(&ofproto->groups);
5771 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5772 delete_group__(ofproto, ofgroup);
5773 /* Lock for each node separately, so that we will not jam the
5774 * other threads for too long time. */
5775 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5778 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5779 hash_int(group_id, 0), &ofproto->groups) {
5780 if (ofgroup->group_id == group_id) {
5781 delete_group__(ofproto, ofgroup);
5786 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5790 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5792 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5793 struct ofputil_group_mod gm;
5796 error = reject_slave_controller(ofconn);
5801 error = ofputil_decode_group_mod(oh, &gm);
5806 switch (gm.command) {
5808 return add_group(ofproto, &gm);
5810 case OFPGC11_MODIFY:
5811 return modify_group(ofproto, &gm);
5813 case OFPGC11_DELETE:
5814 delete_group(ofproto, gm.group_id);
5818 if (gm.command > OFPGC11_DELETE) {
5819 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5820 ofproto->name, gm.command);
5822 return OFPERR_OFPGMFC_BAD_COMMAND;
5826 enum ofproto_table_config
5827 ofproto_table_get_config(const struct ofproto *ofproto, uint8_t table_id)
5830 atomic_read(&ofproto->tables[table_id].config, &value);
5831 return (enum ofproto_table_config)value;
5835 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5837 /* Only accept currently supported configurations */
5838 if (tm->config & ~OFPTC11_TABLE_MISS_MASK) {
5839 return OFPERR_OFPTMFC_BAD_CONFIG;
5842 if (tm->table_id == OFPTT_ALL) {
5844 for (i = 0; i < ofproto->n_tables; i++) {
5845 atomic_store(&ofproto->tables[i].config,
5846 (unsigned int)tm->config);
5848 } else if (!check_table_id(ofproto, tm->table_id)) {
5849 return OFPERR_OFPTMFC_BAD_TABLE;
5851 atomic_store(&ofproto->tables[tm->table_id].config,
5852 (unsigned int)tm->config);
5859 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5861 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5862 struct ofputil_table_mod tm;
5865 error = reject_slave_controller(ofconn);
5870 error = ofputil_decode_table_mod(oh, &tm);
5875 return table_mod(ofproto, &tm);
5879 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
5882 struct ofputil_bundle_ctrl_msg bctrl;
5884 struct ofputil_bundle_ctrl_msg reply;
5886 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
5891 reply.bundle_id = bctrl.bundle_id;
5893 switch (bctrl.type) {
5894 case OFPBCT_OPEN_REQUEST:
5895 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
5896 reply.type = OFPBCT_OPEN_REPLY;
5898 case OFPBCT_CLOSE_REQUEST:
5899 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
5900 reply.type = OFPBCT_CLOSE_REPLY;;
5902 case OFPBCT_COMMIT_REQUEST:
5903 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
5904 reply.type = OFPBCT_COMMIT_REPLY;
5906 case OFPBCT_DISCARD_REQUEST:
5907 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
5908 reply.type = OFPBCT_DISCARD_REPLY;
5911 case OFPBCT_OPEN_REPLY:
5912 case OFPBCT_CLOSE_REPLY:
5913 case OFPBCT_COMMIT_REPLY:
5914 case OFPBCT_DISCARD_REPLY:
5915 return OFPERR_OFPBFC_BAD_TYPE;
5920 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
5921 ofconn_send_reply(ofconn, buf);
5928 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
5931 struct ofputil_bundle_add_msg badd;
5933 error = ofputil_decode_bundle_add(oh, &badd);
5938 return ofp_bundle_add_message(ofconn, &badd);
5942 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5943 OVS_EXCLUDED(ofproto_mutex)
5945 const struct ofp_header *oh = ofpbuf_data(msg);
5949 error = ofptype_decode(&type, oh);
5953 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5954 && ofpmp_more(oh)) {
5955 /* We have no buffer implementation for multipart requests.
5956 * Report overflow for requests which consists of multiple
5958 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5962 /* OpenFlow requests. */
5963 case OFPTYPE_ECHO_REQUEST:
5964 return handle_echo_request(ofconn, oh);
5966 case OFPTYPE_FEATURES_REQUEST:
5967 return handle_features_request(ofconn, oh);
5969 case OFPTYPE_GET_CONFIG_REQUEST:
5970 return handle_get_config_request(ofconn, oh);
5972 case OFPTYPE_SET_CONFIG:
5973 return handle_set_config(ofconn, oh);
5975 case OFPTYPE_PACKET_OUT:
5976 return handle_packet_out(ofconn, oh);
5978 case OFPTYPE_PORT_MOD:
5979 return handle_port_mod(ofconn, oh);
5981 case OFPTYPE_FLOW_MOD:
5982 return handle_flow_mod(ofconn, oh);
5984 case OFPTYPE_GROUP_MOD:
5985 return handle_group_mod(ofconn, oh);
5987 case OFPTYPE_TABLE_MOD:
5988 return handle_table_mod(ofconn, oh);
5990 case OFPTYPE_METER_MOD:
5991 return handle_meter_mod(ofconn, oh);
5993 case OFPTYPE_BARRIER_REQUEST:
5994 return handle_barrier_request(ofconn, oh);
5996 case OFPTYPE_ROLE_REQUEST:
5997 return handle_role_request(ofconn, oh);
5999 /* OpenFlow replies. */
6000 case OFPTYPE_ECHO_REPLY:
6003 /* Nicira extension requests. */
6004 case OFPTYPE_FLOW_MOD_TABLE_ID:
6005 return handle_nxt_flow_mod_table_id(ofconn, oh);
6007 case OFPTYPE_SET_FLOW_FORMAT:
6008 return handle_nxt_set_flow_format(ofconn, oh);
6010 case OFPTYPE_SET_PACKET_IN_FORMAT:
6011 return handle_nxt_set_packet_in_format(ofconn, oh);
6013 case OFPTYPE_SET_CONTROLLER_ID:
6014 return handle_nxt_set_controller_id(ofconn, oh);
6016 case OFPTYPE_FLOW_AGE:
6017 /* Nothing to do. */
6020 case OFPTYPE_FLOW_MONITOR_CANCEL:
6021 return handle_flow_monitor_cancel(ofconn, oh);
6023 case OFPTYPE_SET_ASYNC_CONFIG:
6024 return handle_nxt_set_async_config(ofconn, oh);
6026 case OFPTYPE_GET_ASYNC_REQUEST:
6027 return handle_nxt_get_async_request(ofconn, oh);
6029 /* Statistics requests. */
6030 case OFPTYPE_DESC_STATS_REQUEST:
6031 return handle_desc_stats_request(ofconn, oh);
6033 case OFPTYPE_FLOW_STATS_REQUEST:
6034 return handle_flow_stats_request(ofconn, oh);
6036 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6037 return handle_aggregate_stats_request(ofconn, oh);
6039 case OFPTYPE_TABLE_STATS_REQUEST:
6040 return handle_table_stats_request(ofconn, oh);
6042 case OFPTYPE_PORT_STATS_REQUEST:
6043 return handle_port_stats_request(ofconn, oh);
6045 case OFPTYPE_QUEUE_STATS_REQUEST:
6046 return handle_queue_stats_request(ofconn, oh);
6048 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6049 return handle_port_desc_stats_request(ofconn, oh);
6051 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6052 return handle_flow_monitor_request(ofconn, oh);
6054 case OFPTYPE_METER_STATS_REQUEST:
6055 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6056 return handle_meter_request(ofconn, oh, type);
6058 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6059 return handle_meter_features_request(ofconn, oh);
6061 case OFPTYPE_GROUP_STATS_REQUEST:
6062 return handle_group_stats_request(ofconn, oh);
6064 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6065 return handle_group_desc_stats_request(ofconn, oh);
6067 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6068 return handle_group_features_stats_request(ofconn, oh);
6070 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6071 return handle_queue_get_config_request(ofconn, oh);
6073 case OFPTYPE_BUNDLE_CONTROL:
6074 return handle_bundle_control(ofconn, oh);
6076 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6077 return handle_bundle_add(ofconn, oh);
6081 case OFPTYPE_FEATURES_REPLY:
6082 case OFPTYPE_GET_CONFIG_REPLY:
6083 case OFPTYPE_PACKET_IN:
6084 case OFPTYPE_FLOW_REMOVED:
6085 case OFPTYPE_PORT_STATUS:
6086 case OFPTYPE_BARRIER_REPLY:
6087 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6088 case OFPTYPE_DESC_STATS_REPLY:
6089 case OFPTYPE_FLOW_STATS_REPLY:
6090 case OFPTYPE_QUEUE_STATS_REPLY:
6091 case OFPTYPE_PORT_STATS_REPLY:
6092 case OFPTYPE_TABLE_STATS_REPLY:
6093 case OFPTYPE_AGGREGATE_STATS_REPLY:
6094 case OFPTYPE_PORT_DESC_STATS_REPLY:
6095 case OFPTYPE_ROLE_REPLY:
6096 case OFPTYPE_FLOW_MONITOR_PAUSED:
6097 case OFPTYPE_FLOW_MONITOR_RESUMED:
6098 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6099 case OFPTYPE_GET_ASYNC_REPLY:
6100 case OFPTYPE_GROUP_STATS_REPLY:
6101 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6102 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6103 case OFPTYPE_METER_STATS_REPLY:
6104 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6105 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6106 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6107 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6108 case OFPTYPE_ROLE_STATUS:
6110 if (ofpmsg_is_stat_request(oh)) {
6111 return OFPERR_OFPBRC_BAD_STAT;
6113 return OFPERR_OFPBRC_BAD_TYPE;
6119 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6120 OVS_EXCLUDED(ofproto_mutex)
6122 int error = handle_openflow__(ofconn, ofp_msg);
6123 if (error && error != OFPROTO_POSTPONE) {
6124 ofconn_send_error(ofconn, ofpbuf_data(ofp_msg), error);
6126 COVERAGE_INC(ofproto_recv_openflow);
6127 return error != OFPROTO_POSTPONE;
6130 /* Asynchronous operations. */
6132 /* Creates and returns a new ofopgroup that is not associated with any
6133 * OpenFlow connection.
6135 * The caller should add operations to the returned group with
6136 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6137 static struct ofopgroup *
6138 ofopgroup_create_unattached(struct ofproto *ofproto)
6139 OVS_REQUIRES(ofproto_mutex)
6141 struct ofopgroup *group = xzalloc(sizeof *group);
6142 group->ofproto = ofproto;
6143 list_init(&group->ofproto_node);
6144 list_init(&group->ops);
6145 list_init(&group->ofconn_node);
6149 /* Creates and returns a new ofopgroup for 'ofproto'.
6151 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6152 * connection. The 'request' and 'buffer_id' arguments are ignored.
6154 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6155 * If the ofopgroup eventually fails, then the error reply will include
6156 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6157 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6159 * The caller should add operations to the returned group with
6160 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6161 static struct ofopgroup *
6162 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6163 const struct ofp_header *request, uint32_t buffer_id)
6164 OVS_REQUIRES(ofproto_mutex)
6166 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6168 size_t request_len = ntohs(request->length);
6170 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6172 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6173 group->ofconn = ofconn;
6174 group->request = xmemdup(request, MIN(request_len, 64));
6175 group->buffer_id = buffer_id;
6180 /* Submits 'group' for processing.
6182 * If 'group' contains no operations (e.g. none were ever added, or all of the
6183 * ones that were added completed synchronously), then it is destroyed
6184 * immediately. Otherwise it is added to the ofproto's list of pending
6187 ofopgroup_submit(struct ofopgroup *group)
6188 OVS_REQUIRES(ofproto_mutex)
6190 if (!group->n_running) {
6191 ofopgroup_complete(group);
6193 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6194 group->ofproto->n_pending++;
6199 ofopgroup_complete(struct ofopgroup *group)
6200 OVS_REQUIRES(ofproto_mutex)
6202 struct ofproto *ofproto = group->ofproto;
6204 struct ofconn *abbrev_ofconn;
6205 ovs_be32 abbrev_xid;
6207 struct ofoperation *op, *next_op;
6210 ovs_assert(!group->n_running);
6213 LIST_FOR_EACH (op, group_node, &group->ops) {
6220 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6221 LIST_FOR_EACH (op, group_node, &group->ops) {
6222 if (op->type != OFOPERATION_DELETE) {
6223 struct ofpbuf *packet;
6226 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6229 struct rule_execute *re;
6233 ofproto_rule_ref(op->rule);
6235 re = xmalloc(sizeof *re);
6236 re->rule = op->rule;
6237 re->in_port = in_port;
6238 re->packet = packet;
6240 if (!guarded_list_push_back(&ofproto->rule_executes,
6241 &re->list_node, 1024)) {
6242 ofproto_rule_unref(op->rule);
6243 ofpbuf_delete(re->packet);
6252 if (!error && !list_is_empty(&group->ofconn_node)) {
6253 abbrev_ofconn = group->ofconn;
6254 abbrev_xid = group->request->xid;
6256 abbrev_ofconn = NULL;
6257 abbrev_xid = htonl(0);
6259 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6260 struct rule *rule = op->rule;
6262 /* We generally want to report the change to active OpenFlow flow
6263 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6265 - The operation failed.
6267 - The affected rule is not visible to controllers.
6269 - The operation's only effect was to update rule->modified. */
6271 || ofproto_rule_is_hidden(rule)
6272 || (op->type == OFOPERATION_MODIFY
6274 && rule->flow_cookie == op->flow_cookie))) {
6275 /* Check that we can just cast from ofoperation_type to
6276 * nx_flow_update_event. */
6277 enum nx_flow_update_event event_type;
6280 case OFOPERATION_ADD:
6281 case OFOPERATION_REPLACE:
6282 event_type = NXFME_ADDED;
6285 case OFOPERATION_DELETE:
6286 event_type = NXFME_DELETED;
6289 case OFOPERATION_MODIFY:
6290 event_type = NXFME_MODIFIED;
6297 ofmonitor_report(ofproto->connmgr, rule, event_type,
6298 op->reason, abbrev_ofconn, abbrev_xid);
6301 rule->pending = NULL;
6304 case OFOPERATION_ADD:
6308 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6309 if (vid_mask == VLAN_VID_MASK) {
6310 if (ofproto->vlan_bitmap) {
6311 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6312 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6313 bitmap_set1(ofproto->vlan_bitmap, vid);
6314 ofproto->vlans_changed = true;
6317 ofproto->vlans_changed = true;
6321 oftable_remove_rule(rule);
6322 ofproto_rule_unref(rule);
6326 case OFOPERATION_DELETE:
6327 ovs_assert(!op->error);
6328 ofproto_rule_unref(rule);
6332 case OFOPERATION_MODIFY:
6333 case OFOPERATION_REPLACE:
6335 long long int now = time_msec();
6337 ovs_mutex_lock(&rule->mutex);
6338 rule->modified = now;
6339 if (op->type == OFOPERATION_REPLACE) {
6340 rule->created = now;
6342 ovs_mutex_unlock(&rule->mutex);
6344 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6345 ovs_mutex_lock(&rule->mutex);
6346 rule->idle_timeout = op->idle_timeout;
6347 rule->hard_timeout = op->hard_timeout;
6348 ovs_mutex_unlock(&rule->mutex);
6350 const struct rule_actions *old_actions;
6352 ovs_mutex_lock(&rule->mutex);
6353 old_actions = rule_get_actions(rule);
6354 ovsrcu_set(&rule->actions, op->actions);
6355 ovs_mutex_unlock(&rule->mutex);
6358 rule_actions_destroy(old_actions);
6360 rule->flags = op->flags;
6368 ofoperation_destroy(op);
6371 ofmonitor_flush(ofproto->connmgr);
6373 if (!list_is_empty(&group->ofproto_node)) {
6374 ovs_assert(ofproto->n_pending > 0);
6375 ofproto->n_pending--;
6376 list_remove(&group->ofproto_node);
6378 if (!list_is_empty(&group->ofconn_node)) {
6379 list_remove(&group->ofconn_node);
6381 ofconn_send_error(group->ofconn, group->request, error);
6383 connmgr_retry(ofproto->connmgr);
6385 free(group->request);
6389 /* Initiates a new operation on 'rule', of the specified 'type', within
6390 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6392 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6393 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6395 * Returns the newly created ofoperation (which is also available as
6396 * rule->pending). */
6397 static struct ofoperation *
6398 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6399 enum ofoperation_type type,
6400 enum ofp_flow_removed_reason reason)
6401 OVS_REQUIRES(ofproto_mutex)
6403 struct ofproto *ofproto = group->ofproto;
6404 struct ofoperation *op;
6406 ovs_assert(!rule->pending);
6408 op = rule->pending = xzalloc(sizeof *op);
6410 list_push_back(&group->ops, &op->group_node);
6413 op->reason = reason;
6414 op->flow_cookie = rule->flow_cookie;
6415 ovs_mutex_lock(&rule->mutex);
6416 op->idle_timeout = rule->idle_timeout;
6417 op->hard_timeout = rule->hard_timeout;
6418 ovs_mutex_unlock(&rule->mutex);
6419 op->flags = rule->flags;
6423 if (type == OFOPERATION_DELETE) {
6424 hmap_insert(&ofproto->deletions, &op->hmap_node,
6425 cls_rule_hash(&rule->cr, rule->table_id));
6432 ofoperation_destroy(struct ofoperation *op)
6433 OVS_REQUIRES(ofproto_mutex)
6435 struct ofopgroup *group = op->group;
6438 op->rule->pending = NULL;
6440 if (op->type == OFOPERATION_DELETE) {
6441 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6443 list_remove(&op->group_node);
6444 rule_actions_destroy(op->actions);
6448 /* Indicates that 'op' completed with status 'error', which is either 0 to
6449 * indicate success or an OpenFlow error code on failure.
6451 * If 'error' is 0, indicating success, the operation will be committed
6452 * permanently to the flow table.
6454 * If 'error' is nonzero, then generally the operation will be rolled back:
6456 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6457 * restores the original rule. The caller must have uninitialized any
6458 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6459 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6460 * and 7 for the new rule, calling its ->rule_dealloc() function.
6462 * - If 'op' is a "modify flow" operation, ofproto restores the original
6465 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6466 * allowed to fail. It must always succeed.
6468 * Please see the large comment in ofproto/ofproto-provider.h titled
6469 * "Asynchronous Operation Support" for more information. */
6471 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6473 struct ofopgroup *group = op->group;
6475 ovs_assert(group->n_running > 0);
6476 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6479 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6480 /* This function can be called from ->rule_construct(), in which case
6481 * ofproto_mutex is held, or it can be called from ->run(), in which
6482 * case ofproto_mutex is not held. But only in the latter case can we
6483 * arrive here, so we can safely take ofproto_mutex now. */
6484 ovs_mutex_lock(&ofproto_mutex);
6485 ovs_assert(op->rule->pending == op);
6486 ofopgroup_complete(group);
6487 ovs_mutex_unlock(&ofproto_mutex);
6492 pick_datapath_id(const struct ofproto *ofproto)
6494 const struct ofport *port;
6496 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6498 uint8_t ea[ETH_ADDR_LEN];
6501 error = netdev_get_etheraddr(port->netdev, ea);
6503 return eth_addr_to_uint64(ea);
6505 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6506 ofproto->name, netdev_get_name(port->netdev),
6507 ovs_strerror(error));
6509 return ofproto->fallback_dpid;
6513 pick_fallback_dpid(void)
6515 uint8_t ea[ETH_ADDR_LEN];
6516 eth_addr_nicira_random(ea);
6517 return eth_addr_to_uint64(ea);
6520 /* Table overflow policy. */
6522 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6523 * to NULL if the table is not configured to evict rules or if the table
6524 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6525 * or with no timeouts are not evictable.) */
6527 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6528 OVS_REQUIRES(ofproto_mutex)
6530 struct eviction_group *evg;
6533 if (!table->eviction_fields) {
6537 /* In the common case, the outer and inner loops here will each be entered
6540 * - The inner loop normally "return"s in its first iteration. If the
6541 * eviction group has any evictable rules, then it always returns in
6544 * - The outer loop only iterates more than once if the largest eviction
6545 * group has no evictable rules.
6547 * - The outer loop can exit only if table's 'max_flows' is all filled up
6548 * by unevictable rules. */
6549 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6552 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6561 /* Searches 'ofproto' for tables that have more flows than their configured
6562 * maximum and that have flow eviction enabled, and evicts as many flows as
6563 * necessary and currently feasible from them.
6565 * This triggers only when an OpenFlow table has N flows in it and then the
6566 * client configures a maximum number of flows less than N. */
6568 ofproto_evict(struct ofproto *ofproto)
6570 struct oftable *table;
6572 ovs_mutex_lock(&ofproto_mutex);
6573 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6574 evict_rules_from_table(ofproto, table, 0);
6576 ovs_mutex_unlock(&ofproto_mutex);
6579 /* Eviction groups. */
6581 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6582 * rules. The priority contains low-order random bits to ensure that eviction
6583 * groups with the same number of rules are prioritized randomly. */
6585 eviction_group_priority(size_t n_rules)
6587 uint16_t size = MIN(UINT16_MAX, n_rules);
6588 return (size << 16) | random_uint16();
6591 /* Updates 'evg', an eviction_group within 'table', following a change that
6592 * adds or removes rules in 'evg'. */
6594 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6595 OVS_REQUIRES(ofproto_mutex)
6597 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6598 eviction_group_priority(heap_count(&evg->rules)));
6601 /* Destroys 'evg', an eviction_group within 'table':
6603 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6604 * rules themselves, just removes them from the eviction group.)
6606 * - Removes 'evg' from 'table'.
6610 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6611 OVS_REQUIRES(ofproto_mutex)
6613 while (!heap_is_empty(&evg->rules)) {
6616 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6617 rule->eviction_group = NULL;
6619 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6620 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6621 heap_destroy(&evg->rules);
6625 /* Removes 'rule' from its eviction group, if any. */
6627 eviction_group_remove_rule(struct rule *rule)
6628 OVS_REQUIRES(ofproto_mutex)
6630 if (rule->eviction_group) {
6631 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6632 struct eviction_group *evg = rule->eviction_group;
6634 rule->eviction_group = NULL;
6635 heap_remove(&evg->rules, &rule->evg_node);
6636 if (heap_is_empty(&evg->rules)) {
6637 eviction_group_destroy(table, evg);
6639 eviction_group_resized(table, evg);
6644 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6645 * returns the hash value. */
6647 eviction_group_hash_rule(struct rule *rule)
6648 OVS_REQUIRES(ofproto_mutex)
6650 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6651 const struct mf_subfield *sf;
6655 hash = table->eviction_group_id_basis;
6656 miniflow_expand(&rule->cr.match.flow, &flow);
6657 for (sf = table->eviction_fields;
6658 sf < &table->eviction_fields[table->n_eviction_fields];
6661 if (mf_are_prereqs_ok(sf->field, &flow)) {
6662 union mf_value value;
6664 mf_get_value(sf->field, &flow, &value);
6666 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6668 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6669 unsigned int start = sf->ofs + sf->n_bits;
6670 bitwise_zero(&value, sf->field->n_bytes, start,
6671 sf->field->n_bytes * 8 - start);
6673 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6675 hash = hash_int(hash, 0);
6682 /* Returns an eviction group within 'table' with the given 'id', creating one
6684 static struct eviction_group *
6685 eviction_group_find(struct oftable *table, uint32_t id)
6686 OVS_REQUIRES(ofproto_mutex)
6688 struct eviction_group *evg;
6690 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6694 evg = xmalloc(sizeof *evg);
6695 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6696 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6697 eviction_group_priority(0));
6698 heap_init(&evg->rules);
6703 /* Returns an eviction priority for 'rule'. The return value should be
6704 * interpreted so that higher priorities make a rule more attractive candidates
6706 * Called only if have a timeout. */
6708 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6709 OVS_REQUIRES(ofproto_mutex)
6711 long long int expiration = LLONG_MAX;
6712 long long int modified;
6713 uint32_t expiration_offset;
6715 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6716 ovs_mutex_lock(&rule->mutex);
6717 modified = rule->modified;
6718 ovs_mutex_unlock(&rule->mutex);
6720 if (rule->hard_timeout) {
6721 expiration = modified + rule->hard_timeout * 1000;
6723 if (rule->idle_timeout) {
6724 uint64_t packets, bytes;
6726 long long int idle_expiration;
6728 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6729 idle_expiration = used + rule->idle_timeout * 1000;
6730 expiration = MIN(expiration, idle_expiration);
6733 if (expiration == LLONG_MAX) {
6737 /* Calculate the time of expiration as a number of (approximate) seconds
6738 * after program startup.
6740 * This should work OK for program runs that last UINT32_MAX seconds or
6741 * less. Therefore, please restart OVS at least once every 136 years. */
6742 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6744 /* Invert the expiration offset because we're using a max-heap. */
6745 return UINT32_MAX - expiration_offset;
6748 /* Adds 'rule' to an appropriate eviction group for its oftable's
6749 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6750 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6753 * The caller must ensure that 'rule' is not already in an eviction group. */
6755 eviction_group_add_rule(struct rule *rule)
6756 OVS_REQUIRES(ofproto_mutex)
6758 struct ofproto *ofproto = rule->ofproto;
6759 struct oftable *table = &ofproto->tables[rule->table_id];
6762 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6763 * so no additional protection is needed. */
6764 has_timeout = rule->hard_timeout || rule->idle_timeout;
6766 if (table->eviction_fields && has_timeout) {
6767 struct eviction_group *evg;
6769 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6771 rule->eviction_group = evg;
6772 heap_insert(&evg->rules, &rule->evg_node,
6773 rule_eviction_priority(ofproto, rule));
6774 eviction_group_resized(table, evg);
6780 /* Initializes 'table'. */
6782 oftable_init(struct oftable *table)
6784 memset(table, 0, sizeof *table);
6785 classifier_init(&table->cls, flow_segment_u32s);
6786 table->max_flows = UINT_MAX;
6787 atomic_init(&table->config, (unsigned int)OFPROTO_TABLE_MISS_DEFAULT);
6790 /* Destroys 'table', including its classifier and eviction groups.
6792 * The caller is responsible for freeing 'table' itself. */
6794 oftable_destroy(struct oftable *table)
6796 fat_rwlock_rdlock(&table->cls.rwlock);
6797 ovs_assert(classifier_is_empty(&table->cls));
6798 fat_rwlock_unlock(&table->cls.rwlock);
6799 oftable_disable_eviction(table);
6800 classifier_destroy(&table->cls);
6804 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6805 * string, then 'table' will use its default name.
6807 * This only affects the name exposed for a table exposed through the OpenFlow
6808 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6810 oftable_set_name(struct oftable *table, const char *name)
6812 if (name && name[0]) {
6813 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6814 if (!table->name || strncmp(name, table->name, len)) {
6816 table->name = xmemdup0(name, len);
6824 /* oftables support a choice of two policies when adding a rule would cause the
6825 * number of flows in the table to exceed the configured maximum number: either
6826 * they can refuse to add the new flow or they can evict some existing flow.
6827 * This function configures the former policy on 'table'. */
6829 oftable_disable_eviction(struct oftable *table)
6830 OVS_REQUIRES(ofproto_mutex)
6832 if (table->eviction_fields) {
6833 struct eviction_group *evg, *next;
6835 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6836 &table->eviction_groups_by_id) {
6837 eviction_group_destroy(table, evg);
6839 hmap_destroy(&table->eviction_groups_by_id);
6840 heap_destroy(&table->eviction_groups_by_size);
6842 free(table->eviction_fields);
6843 table->eviction_fields = NULL;
6844 table->n_eviction_fields = 0;
6848 /* oftables support a choice of two policies when adding a rule would cause the
6849 * number of flows in the table to exceed the configured maximum number: either
6850 * they can refuse to add the new flow or they can evict some existing flow.
6851 * This function configures the latter policy on 'table', with fairness based
6852 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6853 * 'n_fields' as 0 disables fairness.) */
6855 oftable_enable_eviction(struct oftable *table,
6856 const struct mf_subfield *fields, size_t n_fields)
6857 OVS_REQUIRES(ofproto_mutex)
6859 struct cls_cursor cursor;
6862 if (table->eviction_fields
6863 && n_fields == table->n_eviction_fields
6865 || !memcmp(fields, table->eviction_fields,
6866 n_fields * sizeof *fields))) {
6871 oftable_disable_eviction(table);
6873 table->n_eviction_fields = n_fields;
6874 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6876 table->eviction_group_id_basis = random_uint32();
6877 hmap_init(&table->eviction_groups_by_id);
6878 heap_init(&table->eviction_groups_by_size);
6880 fat_rwlock_rdlock(&table->cls.rwlock);
6881 cls_cursor_init(&cursor, &table->cls, NULL);
6882 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6883 eviction_group_add_rule(rule);
6885 fat_rwlock_unlock(&table->cls.rwlock);
6888 /* Removes 'rule' from the oftable that contains it. */
6890 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6891 OVS_REQUIRES(ofproto_mutex)
6893 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6895 fat_rwlock_wrlock(&cls->rwlock);
6896 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6897 fat_rwlock_unlock(&cls->rwlock);
6899 cookies_remove(ofproto, rule);
6901 eviction_group_remove_rule(rule);
6902 if (!list_is_empty(&rule->expirable)) {
6903 list_remove(&rule->expirable);
6905 if (!list_is_empty(&rule->meter_list_node)) {
6906 list_remove(&rule->meter_list_node);
6907 list_init(&rule->meter_list_node);
6912 oftable_remove_rule(struct rule *rule)
6913 OVS_REQUIRES(ofproto_mutex)
6915 oftable_remove_rule__(rule->ofproto, rule);
6918 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6919 * the same cls_rule. */
6921 oftable_insert_rule(struct rule *rule)
6922 OVS_REQUIRES(ofproto_mutex)
6924 struct ofproto *ofproto = rule->ofproto;
6925 struct oftable *table = &ofproto->tables[rule->table_id];
6926 const struct rule_actions *actions;
6929 ovs_mutex_lock(&rule->mutex);
6930 may_expire = rule->hard_timeout || rule->idle_timeout;
6931 ovs_mutex_unlock(&rule->mutex);
6934 list_insert(&ofproto->expirable, &rule->expirable);
6937 cookies_insert(ofproto, rule);
6939 actions = rule_get_actions(rule);
6940 if (actions->provider_meter_id != UINT32_MAX) {
6941 uint32_t meter_id = ofpacts_get_meter(actions->ofpacts,
6942 actions->ofpacts_len);
6943 struct meter *meter = ofproto->meters[meter_id];
6944 list_insert(&meter->rules, &rule->meter_list_node);
6946 fat_rwlock_wrlock(&table->cls.rwlock);
6947 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6948 fat_rwlock_unlock(&table->cls.rwlock);
6949 eviction_group_add_rule(rule);
6952 /* unixctl commands. */
6955 ofproto_lookup(const char *name)
6957 struct ofproto *ofproto;
6959 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6961 if (!strcmp(ofproto->name, name)) {
6969 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6970 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6972 struct ofproto *ofproto;
6976 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6977 ds_put_format(&results, "%s\n", ofproto->name);
6979 unixctl_command_reply(conn, ds_cstr(&results));
6980 ds_destroy(&results);
6984 ofproto_unixctl_init(void)
6986 static bool registered;
6992 unixctl_command_register("ofproto/list", "", 0, 0,
6993 ofproto_unixctl_list, NULL);
6996 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6998 * This is deprecated. It is only for compatibility with broken device drivers
6999 * in old versions of Linux that do not properly support VLANs when VLAN
7000 * devices are not used. When broken device drivers are no longer in
7001 * widespread use, we will delete these interfaces. */
7003 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7004 * (exactly) by an OpenFlow rule in 'ofproto'. */
7006 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7009 struct cls_rule target;
7010 const struct oftable *oftable;
7012 match_init_catchall(&match);
7013 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7014 cls_rule_init(&target, &match, 0);
7016 free(ofproto->vlan_bitmap);
7017 ofproto->vlan_bitmap = bitmap_allocate(4096);
7018 ofproto->vlans_changed = false;
7020 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7021 struct cls_cursor cursor;
7024 fat_rwlock_rdlock(&oftable->cls.rwlock);
7025 cls_cursor_init(&cursor, &oftable->cls, &target);
7026 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
7027 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7028 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7030 bitmap_set1(vlan_bitmap, vid);
7031 bitmap_set1(ofproto->vlan_bitmap, vid);
7034 fat_rwlock_unlock(&oftable->cls.rwlock);
7038 /* Returns true if new VLANs have come into use by the flow table since the
7039 * last call to ofproto_get_vlan_usage().
7041 * We don't track when old VLANs stop being used. */
7043 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7045 return ofproto->vlans_changed;
7048 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7049 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7050 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7051 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7052 * then the VLAN device is un-enslaved. */
7054 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7055 ofp_port_t realdev_ofp_port, int vid)
7057 struct ofport *ofport;
7060 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7062 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7064 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7065 ofproto->name, vlandev_ofp_port);
7069 if (!ofproto->ofproto_class->set_realdev) {
7070 if (!vlandev_ofp_port) {
7073 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7077 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7079 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7080 ofproto->name, vlandev_ofp_port,
7081 netdev_get_name(ofport->netdev), ovs_strerror(error));