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'. If 'force' is set to
1019 * true, status will be returned even if there is no status change since last
1022 * Returns 0 on success. Returns a negative number if there is no status change
1023 * since last update and 'force' is set to false. Returns a positive errno
1024 * otherwise. Has no effect if 'ofp_port' is not an OpenFlow port in 'ofproto'.
1026 * The caller must provide and own '*status'. */
1028 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1029 bool force, struct smap *status)
1031 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1032 return (ofport && ofproto->ofproto_class->get_bfd_status
1033 ? ofproto->ofproto_class->get_bfd_status(ofport, force, status)
1037 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1038 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1039 * 0 if LACP partner information is not current (generally indicating a
1040 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1042 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1044 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1045 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1046 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1052 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1053 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1054 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1055 * configuration plus, if there is more than one slave, a bonding
1058 * If 'aux' is already registered then this function updates its configuration
1059 * to 's'. Otherwise, this function registers a new bundle.
1061 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1064 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1065 const struct ofproto_bundle_settings *s)
1067 return (ofproto->ofproto_class->bundle_set
1068 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1072 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1073 * If no such bundle has been registered, this has no effect. */
1075 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1077 return ofproto_bundle_register(ofproto, aux, NULL);
1081 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1082 * If 'aux' is already registered then this function updates its configuration
1083 * to 's'. Otherwise, this function registers a new mirror. */
1085 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1086 const struct ofproto_mirror_settings *s)
1088 return (ofproto->ofproto_class->mirror_set
1089 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1093 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1094 * If no mirror has been registered, this has no effect. */
1096 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1098 return ofproto_mirror_register(ofproto, aux, NULL);
1101 /* Retrieves statistics from mirror associated with client data pointer
1102 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1103 * 'bytes', respectively. If a particular counters is not supported,
1104 * the appropriate argument is set to UINT64_MAX. */
1106 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1107 uint64_t *packets, uint64_t *bytes)
1109 if (!ofproto->ofproto_class->mirror_get_stats) {
1110 *packets = *bytes = UINT64_MAX;
1114 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1118 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1119 * which all packets are flooded, instead of using MAC learning. If
1120 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1122 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1125 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1127 return (ofproto->ofproto_class->set_flood_vlans
1128 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1132 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1133 * output for a mirror. */
1135 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1137 return (ofproto->ofproto_class->is_mirror_output_bundle
1138 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1142 /* Configuration of OpenFlow tables. */
1144 /* Returns the number of OpenFlow tables in 'ofproto'. */
1146 ofproto_get_n_tables(const struct ofproto *ofproto)
1148 return ofproto->n_tables;
1151 /* Returns the number of Controller visible OpenFlow tables
1152 * in 'ofproto'. This number will exclude Hidden tables.
1153 * This funtion's return value should be less or equal to that of
1154 * ofproto_get_n_tables() . */
1156 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1158 uint8_t n = ofproto->n_tables;
1160 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1161 * if present, are always at the end.) */
1162 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1169 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1170 * settings from 's'. 'table_id' must be in the range 0 through the number of
1171 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1173 * For read-only tables, only the name may be configured. */
1175 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1176 const struct ofproto_table_settings *s)
1178 struct oftable *table;
1180 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1181 table = &ofproto->tables[table_id];
1183 oftable_set_name(table, s->name);
1185 if (table->flags & OFTABLE_READONLY) {
1190 oftable_enable_eviction(table, s->groups, s->n_groups);
1192 oftable_disable_eviction(table);
1195 table->max_flows = s->max_flows;
1196 fat_rwlock_wrlock(&table->cls.rwlock);
1197 if (classifier_count(&table->cls) > table->max_flows
1198 && table->eviction_fields) {
1199 /* 'table' contains more flows than allowed. We might not be able to
1200 * evict them right away because of the asynchronous nature of flow
1201 * table changes. Schedule eviction for later. */
1202 switch (ofproto->state) {
1204 ofproto->state = S_EVICT;
1208 /* We're already deleting flows, nothing more to do. */
1213 classifier_set_prefix_fields(&table->cls,
1214 s->prefix_fields, s->n_prefix_fields);
1216 fat_rwlock_unlock(&table->cls.rwlock);
1220 ofproto_has_snoops(const struct ofproto *ofproto)
1222 return connmgr_has_snoops(ofproto->connmgr);
1226 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1228 connmgr_get_snoops(ofproto->connmgr, snoops);
1232 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1234 OVS_REQUIRES(ofproto_mutex)
1236 struct ofopgroup *group;
1238 ovs_assert(!rule->pending);
1240 group = ofopgroup_create_unattached(ofproto);
1241 delete_flow__(rule, group, reason);
1242 ofopgroup_submit(group);
1245 /* Deletes 'rule' from 'ofproto'.
1247 * Within an ofproto implementation, this function allows an ofproto
1248 * implementation to destroy any rules that remain when its ->destruct()
1249 * function is called. This function is not suitable for use elsewhere in an
1250 * ofproto implementation.
1252 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1253 * Cycle" in ofproto-provider.h. */
1255 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1256 OVS_EXCLUDED(ofproto_mutex)
1258 struct ofopgroup *group;
1260 ovs_mutex_lock(&ofproto_mutex);
1261 ovs_assert(!rule->pending);
1263 group = ofopgroup_create_unattached(ofproto);
1264 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1265 oftable_remove_rule__(ofproto, rule);
1266 ofproto->ofproto_class->rule_delete(rule);
1267 ofopgroup_submit(group);
1269 ovs_mutex_unlock(&ofproto_mutex);
1273 ofproto_flush__(struct ofproto *ofproto)
1274 OVS_EXCLUDED(ofproto_mutex)
1276 struct oftable *table;
1278 if (ofproto->ofproto_class->flush) {
1279 ofproto->ofproto_class->flush(ofproto);
1282 ovs_mutex_lock(&ofproto_mutex);
1283 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1284 struct rule *rule, *next_rule;
1285 struct cls_cursor cursor;
1287 if (table->flags & OFTABLE_HIDDEN) {
1291 fat_rwlock_rdlock(&table->cls.rwlock);
1292 cls_cursor_init(&cursor, &table->cls, NULL);
1293 fat_rwlock_unlock(&table->cls.rwlock);
1294 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1295 if (!rule->pending) {
1296 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1300 ovs_mutex_unlock(&ofproto_mutex);
1303 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1306 ofproto_destroy__(struct ofproto *ofproto)
1307 OVS_EXCLUDED(ofproto_mutex)
1309 struct oftable *table;
1311 ovs_assert(list_is_empty(&ofproto->pending));
1313 destroy_rule_executes(ofproto);
1314 delete_group(ofproto, OFPG_ALL);
1316 guarded_list_destroy(&ofproto->rule_executes);
1317 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1318 hmap_destroy(&ofproto->groups);
1320 connmgr_destroy(ofproto->connmgr);
1322 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1323 free(ofproto->name);
1324 free(ofproto->type);
1325 free(ofproto->mfr_desc);
1326 free(ofproto->hw_desc);
1327 free(ofproto->sw_desc);
1328 free(ofproto->serial_desc);
1329 free(ofproto->dp_desc);
1330 hmap_destroy(&ofproto->ports);
1331 hmap_destroy(&ofproto->ofport_usage);
1332 shash_destroy(&ofproto->port_by_name);
1333 simap_destroy(&ofproto->ofp_requests);
1335 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1336 oftable_destroy(table);
1338 free(ofproto->tables);
1340 hmap_destroy(&ofproto->deletions);
1342 free(ofproto->vlan_bitmap);
1344 ofproto->ofproto_class->dealloc(ofproto);
1348 ofproto_destroy(struct ofproto *p)
1349 OVS_EXCLUDED(ofproto_mutex)
1351 struct ofport *ofport, *next_ofport;
1352 struct ofport_usage *usage, *next_usage;
1359 meter_delete(p, 1, p->meter_features.max_meters);
1360 p->meter_features.max_meters = 0;
1366 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1367 ofport_destroy(ofport);
1370 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1371 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1375 p->ofproto_class->destruct(p);
1376 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1377 ovsrcu_postpone(ofproto_destroy__, p);
1380 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1381 * kernel datapath, for example, this destroys the datapath in the kernel, and
1382 * with the netdev-based datapath, it tears down the data structures that
1383 * represent the datapath.
1385 * The datapath should not be currently open as an ofproto. */
1387 ofproto_delete(const char *name, const char *type)
1389 const struct ofproto_class *class = ofproto_class_find__(type);
1390 return (!class ? EAFNOSUPPORT
1391 : !class->del ? EACCES
1392 : class->del(type, name));
1396 process_port_change(struct ofproto *ofproto, int error, char *devname)
1398 if (error == ENOBUFS) {
1399 reinit_ports(ofproto);
1400 } else if (!error) {
1401 update_port(ofproto, devname);
1407 ofproto_type_run(const char *datapath_type)
1409 const struct ofproto_class *class;
1412 datapath_type = ofproto_normalize_type(datapath_type);
1413 class = ofproto_class_find__(datapath_type);
1415 error = class->type_run ? class->type_run(datapath_type) : 0;
1416 if (error && error != EAGAIN) {
1417 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1418 datapath_type, ovs_strerror(error));
1424 ofproto_type_wait(const char *datapath_type)
1426 const struct ofproto_class *class;
1428 datapath_type = ofproto_normalize_type(datapath_type);
1429 class = ofproto_class_find__(datapath_type);
1431 if (class->type_wait) {
1432 class->type_wait(datapath_type);
1437 any_pending_ops(const struct ofproto *p)
1438 OVS_EXCLUDED(ofproto_mutex)
1442 ovs_mutex_lock(&ofproto_mutex);
1443 b = !list_is_empty(&p->pending);
1444 ovs_mutex_unlock(&ofproto_mutex);
1450 ofproto_run(struct ofproto *p)
1455 error = p->ofproto_class->run(p);
1456 if (error && error != EAGAIN) {
1457 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1460 run_rule_executes(p);
1462 /* Restore the eviction group heap invariant occasionally. */
1463 if (p->eviction_group_timer < time_msec()) {
1466 p->eviction_group_timer = time_msec() + 1000;
1468 for (i = 0; i < p->n_tables; i++) {
1469 struct oftable *table = &p->tables[i];
1470 struct eviction_group *evg;
1471 struct cls_cursor cursor;
1474 if (!table->eviction_fields) {
1478 ovs_mutex_lock(&ofproto_mutex);
1479 fat_rwlock_rdlock(&table->cls.rwlock);
1480 cls_cursor_init(&cursor, &table->cls, NULL);
1481 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1482 if (rule->idle_timeout || rule->hard_timeout) {
1483 if (!rule->eviction_group) {
1484 eviction_group_add_rule(rule);
1486 heap_raw_change(&rule->evg_node,
1487 rule_eviction_priority(p, rule));
1491 fat_rwlock_unlock(&table->cls.rwlock);
1493 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1494 heap_rebuild(&evg->rules);
1496 ovs_mutex_unlock(&ofproto_mutex);
1500 if (p->ofproto_class->port_poll) {
1503 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1504 process_port_change(p, error, devname);
1508 new_seq = seq_read(connectivity_seq_get());
1509 if (new_seq != p->change_seq) {
1510 struct sset devnames;
1511 const char *devname;
1512 struct ofport *ofport;
1514 /* Update OpenFlow port status for any port whose netdev has changed.
1516 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1517 * destroyed, so it's not safe to update ports directly from the
1518 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1519 * need this two-phase approach. */
1520 sset_init(&devnames);
1521 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1522 uint64_t port_change_seq;
1524 port_change_seq = netdev_get_change_seq(ofport->netdev);
1525 if (ofport->change_seq != port_change_seq) {
1526 ofport->change_seq = port_change_seq;
1527 sset_add(&devnames, netdev_get_name(ofport->netdev));
1530 SSET_FOR_EACH (devname, &devnames) {
1531 update_port(p, devname);
1533 sset_destroy(&devnames);
1535 p->change_seq = new_seq;
1540 connmgr_run(p->connmgr, handle_openflow);
1544 connmgr_run(p->connmgr, NULL);
1546 if (!any_pending_ops(p)) {
1547 p->state = S_OPENFLOW;
1552 connmgr_run(p->connmgr, NULL);
1554 if (!any_pending_ops(p)) {
1555 connmgr_flushed(p->connmgr);
1556 p->state = S_OPENFLOW;
1568 ofproto_wait(struct ofproto *p)
1570 p->ofproto_class->wait(p);
1571 if (p->ofproto_class->port_poll_wait) {
1572 p->ofproto_class->port_poll_wait(p);
1574 seq_wait(connectivity_seq_get(), p->change_seq);
1578 connmgr_wait(p->connmgr, true);
1583 connmgr_wait(p->connmgr, false);
1584 if (!any_pending_ops(p)) {
1585 poll_immediate_wake();
1592 ofproto_is_alive(const struct ofproto *p)
1594 return connmgr_has_controllers(p->connmgr);
1597 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1598 * memory_report(). */
1600 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1602 const struct oftable *table;
1603 unsigned int n_rules;
1605 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1607 ovs_mutex_lock(&ofproto_mutex);
1608 simap_increase(usage, "ops",
1609 ofproto->n_pending + hmap_count(&ofproto->deletions));
1610 ovs_mutex_unlock(&ofproto_mutex);
1613 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1614 fat_rwlock_rdlock(&table->cls.rwlock);
1615 n_rules += classifier_count(&table->cls);
1616 fat_rwlock_unlock(&table->cls.rwlock);
1618 simap_increase(usage, "rules", n_rules);
1620 if (ofproto->ofproto_class->get_memory_usage) {
1621 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1624 connmgr_get_memory_usage(ofproto->connmgr, usage);
1628 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1630 const struct ofproto_class *class;
1632 datapath_type = ofproto_normalize_type(datapath_type);
1633 class = ofproto_class_find__(datapath_type);
1635 if (class && class->type_get_memory_usage) {
1636 class->type_get_memory_usage(datapath_type, usage);
1641 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1644 connmgr_get_controller_info(ofproto->connmgr, info);
1648 ofproto_free_ofproto_controller_info(struct shash *info)
1650 connmgr_free_controller_info(info);
1653 /* Makes a deep copy of 'old' into 'port'. */
1655 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1657 port->name = xstrdup(old->name);
1658 port->type = xstrdup(old->type);
1659 port->ofp_port = old->ofp_port;
1662 /* Frees memory allocated to members of 'ofproto_port'.
1664 * Do not call this function on an ofproto_port obtained from
1665 * ofproto_port_dump_next(): that function retains ownership of the data in the
1668 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1670 free(ofproto_port->name);
1671 free(ofproto_port->type);
1674 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1676 * This function provides no status indication. An error status for the entire
1677 * dump operation is provided when it is completed by calling
1678 * ofproto_port_dump_done().
1681 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1682 const struct ofproto *ofproto)
1684 dump->ofproto = ofproto;
1685 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1689 /* Attempts to retrieve another port from 'dump', which must have been created
1690 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1691 * 'port' and returns true. On failure, returns false.
1693 * Failure might indicate an actual error or merely that the last port has been
1694 * dumped. An error status for the entire dump operation is provided when it
1695 * is completed by calling ofproto_port_dump_done().
1697 * The ofproto owns the data stored in 'port'. It will remain valid until at
1698 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1699 * ofproto_port_dump_done(). */
1701 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1702 struct ofproto_port *port)
1704 const struct ofproto *ofproto = dump->ofproto;
1710 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1713 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1719 /* Completes port table dump operation 'dump', which must have been created
1720 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1721 * error-free, otherwise a positive errno value describing the problem. */
1723 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1725 const struct ofproto *ofproto = dump->ofproto;
1727 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1730 return dump->error == EOF ? 0 : dump->error;
1733 /* Returns the type to pass to netdev_open() when a datapath of type
1734 * 'datapath_type' has a port of type 'port_type', for a few special
1735 * cases when a netdev type differs from a port type. For example, when
1736 * using the userspace datapath, a port of type "internal" needs to be
1739 * Returns either 'type' itself or a string literal, which must not be
1742 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1744 const struct ofproto_class *class;
1746 datapath_type = ofproto_normalize_type(datapath_type);
1747 class = ofproto_class_find__(datapath_type);
1752 return (class->port_open_type
1753 ? class->port_open_type(datapath_type, port_type)
1757 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1758 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1759 * the port's OpenFlow port number.
1761 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1762 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1763 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1764 * 'ofp_portp' is non-null). */
1766 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1767 ofp_port_t *ofp_portp)
1769 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1772 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1774 const char *netdev_name = netdev_get_name(netdev);
1776 simap_put(&ofproto->ofp_requests, netdev_name,
1777 ofp_to_u16(ofp_port));
1778 update_port(ofproto, netdev_name);
1781 *ofp_portp = OFPP_NONE;
1783 struct ofproto_port ofproto_port;
1785 error = ofproto_port_query_by_name(ofproto,
1786 netdev_get_name(netdev),
1789 *ofp_portp = ofproto_port.ofp_port;
1790 ofproto_port_destroy(&ofproto_port);
1797 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1798 * initializes '*port' appropriately; on failure, returns a positive errno
1801 * The caller owns the data in 'ofproto_port' and must free it with
1802 * ofproto_port_destroy() when it is no longer needed. */
1804 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1805 struct ofproto_port *port)
1809 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1811 memset(port, 0, sizeof *port);
1816 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1817 * Returns 0 if successful, otherwise a positive errno. */
1819 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1821 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1822 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1823 struct simap_node *ofp_request_node;
1826 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1827 if (ofp_request_node) {
1828 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1831 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1832 if (!error && ofport) {
1833 /* 'name' is the netdev's name and update_port() is going to close the
1834 * netdev. Just in case update_port() refers to 'name' after it
1835 * destroys 'ofport', make a copy of it around the update_port()
1837 char *devname = xstrdup(name);
1838 update_port(ofproto, devname);
1845 flow_mod_init(struct ofputil_flow_mod *fm,
1846 const struct match *match, unsigned int priority,
1847 const struct ofpact *ofpacts, size_t ofpacts_len,
1848 enum ofp_flow_mod_command command)
1850 memset(fm, 0, sizeof *fm);
1852 fm->priority = priority;
1855 fm->modify_cookie = false;
1857 fm->command = command;
1858 fm->idle_timeout = 0;
1859 fm->hard_timeout = 0;
1860 fm->buffer_id = UINT32_MAX;
1861 fm->out_port = OFPP_ANY;
1862 fm->out_group = OFPG_ANY;
1864 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1865 fm->ofpacts_len = ofpacts_len;
1869 simple_flow_mod(struct ofproto *ofproto,
1870 const struct match *match, unsigned int priority,
1871 const struct ofpact *ofpacts, size_t ofpacts_len,
1872 enum ofp_flow_mod_command command)
1874 struct ofputil_flow_mod fm;
1876 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1878 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1881 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1882 * performs the 'n_actions' actions in 'actions'. The new flow will not
1885 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1886 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1887 * controllers; otherwise, it will be hidden.
1889 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1891 * This is a helper function for in-band control and fail-open. */
1893 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1894 unsigned int priority,
1895 const struct ofpact *ofpacts, size_t ofpacts_len)
1896 OVS_EXCLUDED(ofproto_mutex)
1898 const struct rule *rule;
1901 /* First do a cheap check whether the rule we're looking for already exists
1902 * with the actions that we want. If it does, then we're done. */
1903 fat_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1904 rule = rule_from_cls_rule(classifier_find_match_exactly(
1905 &ofproto->tables[0].cls, match, priority));
1907 const struct rule_actions *actions = rule_get_actions(rule);
1908 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1909 ofpacts, ofpacts_len);
1913 fat_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1915 /* If there's no such rule or the rule doesn't have the actions we want,
1916 * fall back to a executing a full flow mod. We can't optimize this at
1917 * all because we didn't take enough locks above to ensure that the flow
1918 * table didn't already change beneath us. */
1920 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1921 OFPFC_MODIFY_STRICT);
1925 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1926 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1927 * operation cannot be initiated now but may be retried later.
1929 * This is a helper function for in-band control and fail-open and the "learn"
1932 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1933 OVS_EXCLUDED(ofproto_mutex)
1935 /* Optimize for the most common case of a repeated learn action.
1936 * If an identical flow already exists we only need to update its
1937 * 'modified' time. */
1938 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1939 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1940 struct oftable *table = &ofproto->tables[fm->table_id];
1944 fat_rwlock_rdlock(&table->cls.rwlock);
1945 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
1949 /* Reading many of the rule fields and writing on 'modified'
1950 * requires the rule->mutex. Also, rule->actions may change
1951 * if rule->mutex is not held. */
1952 const struct rule_actions *actions;
1954 ovs_mutex_lock(&rule->mutex);
1955 actions = rule_get_actions(rule);
1956 if (rule->idle_timeout == fm->idle_timeout
1957 && rule->hard_timeout == fm->hard_timeout
1958 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1959 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1960 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
1961 actions->ofpacts, actions->ofpacts_len)) {
1962 /* Rule already exists and need not change, only update the
1963 modified timestamp. */
1964 rule->modified = time_msec();
1967 ovs_mutex_unlock(&rule->mutex);
1969 fat_rwlock_unlock(&table->cls.rwlock);
1976 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1979 /* Resets the modified time for 'rule' or an equivalent rule. If 'rule' is not
1980 * in the classifier, but an equivalent rule is, unref 'rule' and ref the new
1981 * rule. Otherwise if 'rule' is no longer installed in the classifier,
1984 * Returns the rule whose modified time has been reset. */
1986 ofproto_refresh_rule(struct rule *rule)
1988 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
1989 const struct cls_rule *cr = &rule->cr;
1992 /* do_add_flow() requires that the rule is not installed. We lock the
1993 * ofproto_mutex here so that another thread cannot add the flow before
1994 * we get a chance to add it.*/
1995 ovs_mutex_lock(&ofproto_mutex);
1997 fat_rwlock_rdlock(&table->cls.rwlock);
1998 r = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, cr));
2000 ofproto_rule_ref(r);
2002 fat_rwlock_unlock(&table->cls.rwlock);
2005 do_add_flow(rule->ofproto, NULL, NULL, 0, rule);
2006 } else if (r != rule) {
2007 ofproto_rule_unref(rule);
2010 ovs_mutex_unlock(&ofproto_mutex);
2012 /* Refresh the modified time for the rule. */
2013 ovs_mutex_lock(&rule->mutex);
2014 rule->modified = MAX(rule->modified, time_msec());
2015 ovs_mutex_unlock(&rule->mutex);
2020 /* Searches for a rule with matching criteria exactly equal to 'target' in
2021 * ofproto's table 0 and, if it finds one, deletes it.
2023 * This is a helper function for in-band control and fail-open. */
2025 ofproto_delete_flow(struct ofproto *ofproto,
2026 const struct match *target, unsigned int priority)
2027 OVS_EXCLUDED(ofproto_mutex)
2029 struct classifier *cls = &ofproto->tables[0].cls;
2032 /* First do a cheap check whether the rule we're looking for has already
2033 * been deleted. If so, then we're done. */
2034 fat_rwlock_rdlock(&cls->rwlock);
2035 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2037 fat_rwlock_unlock(&cls->rwlock);
2042 /* Fall back to a executing a full flow mod. We can't optimize this at all
2043 * because we didn't take enough locks above to ensure that the flow table
2044 * didn't already change beneath us. */
2045 return simple_flow_mod(ofproto, target, priority, NULL, 0,
2046 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
2049 /* Starts the process of deleting all of the flows from all of ofproto's flow
2050 * tables and then reintroducing the flows required by in-band control and
2051 * fail-open. The process will complete in a later call to ofproto_run(). */
2053 ofproto_flush_flows(struct ofproto *ofproto)
2055 COVERAGE_INC(ofproto_flush);
2056 ofproto->state = S_FLUSH;
2060 reinit_ports(struct ofproto *p)
2062 struct ofproto_port_dump dump;
2063 struct sset devnames;
2064 struct ofport *ofport;
2065 struct ofproto_port ofproto_port;
2066 const char *devname;
2068 COVERAGE_INC(ofproto_reinit_ports);
2070 sset_init(&devnames);
2071 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2072 sset_add(&devnames, netdev_get_name(ofport->netdev));
2074 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2075 sset_add(&devnames, ofproto_port.name);
2078 SSET_FOR_EACH (devname, &devnames) {
2079 update_port(p, devname);
2081 sset_destroy(&devnames);
2085 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2089 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2090 port_idx = port_idx ? port_idx : UINT16_MAX;
2092 if (port_idx >= ofproto->max_ports
2093 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2094 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2095 long long int last_used_at, lru = LLONG_MAX;
2097 /* Search for a free OpenFlow port number. We try not to
2098 * immediately reuse them to prevent problems due to old
2101 * We limit the automatically assigned port numbers to the lower half
2102 * of the port range, to reserve the upper half for assignment by
2105 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2106 ofproto->alloc_port_no = 1;
2108 last_used_at = ofport_get_usage(ofproto,
2109 u16_to_ofp(ofproto->alloc_port_no));
2110 if (!last_used_at) {
2111 port_idx = ofproto->alloc_port_no;
2113 } else if ( last_used_at < time_msec() - 60*60*1000) {
2114 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2115 * more than an hour ago, consider it usable. */
2116 ofport_remove_usage(ofproto,
2117 u16_to_ofp(ofproto->alloc_port_no));
2118 port_idx = ofproto->alloc_port_no;
2120 } else if (last_used_at < lru) {
2122 lru_ofport = ofproto->alloc_port_no;
2125 if (ofproto->alloc_port_no == end_port_no) {
2127 port_idx = lru_ofport;
2134 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2135 return u16_to_ofp(port_idx);
2139 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2141 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2142 ofport_set_usage(ofproto, ofp_port, time_msec());
2146 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2147 * pointer if the netdev cannot be opened. On success, also fills in
2149 static struct netdev *
2150 ofport_open(struct ofproto *ofproto,
2151 struct ofproto_port *ofproto_port,
2152 struct ofputil_phy_port *pp)
2154 enum netdev_flags flags;
2155 struct netdev *netdev;
2158 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2160 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2161 "cannot be opened (%s)",
2163 ofproto_port->name, ofproto_port->ofp_port,
2164 ofproto_port->name, ovs_strerror(error));
2168 if (ofproto_port->ofp_port == OFPP_NONE) {
2169 if (!strcmp(ofproto->name, ofproto_port->name)) {
2170 ofproto_port->ofp_port = OFPP_LOCAL;
2172 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2173 ofproto_port->name);
2176 pp->port_no = ofproto_port->ofp_port;
2177 netdev_get_etheraddr(netdev, pp->hw_addr);
2178 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2179 netdev_get_flags(netdev, &flags);
2180 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2181 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2182 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2183 &pp->supported, &pp->peer);
2184 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2185 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2190 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2191 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2194 ofport_equal(const struct ofputil_phy_port *a,
2195 const struct ofputil_phy_port *b)
2197 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2198 && a->state == b->state
2199 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2200 && a->curr == b->curr
2201 && a->advertised == b->advertised
2202 && a->supported == b->supported
2203 && a->peer == b->peer
2204 && a->curr_speed == b->curr_speed
2205 && a->max_speed == b->max_speed);
2208 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2209 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2210 * one with the same name or port number). */
2212 ofport_install(struct ofproto *p,
2213 struct netdev *netdev, const struct ofputil_phy_port *pp)
2215 const char *netdev_name = netdev_get_name(netdev);
2216 struct ofport *ofport;
2219 /* Create ofport. */
2220 ofport = p->ofproto_class->port_alloc();
2225 ofport->ofproto = p;
2226 ofport->netdev = netdev;
2227 ofport->change_seq = netdev_get_change_seq(netdev);
2229 ofport->ofp_port = pp->port_no;
2230 ofport->created = time_msec();
2232 /* Add port to 'p'. */
2233 hmap_insert(&p->ports, &ofport->hmap_node,
2234 hash_ofp_port(ofport->ofp_port));
2235 shash_add(&p->port_by_name, netdev_name, ofport);
2237 update_mtu(p, ofport);
2239 /* Let the ofproto_class initialize its private data. */
2240 error = p->ofproto_class->port_construct(ofport);
2244 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2248 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2249 p->name, netdev_name, ovs_strerror(error));
2251 ofport_destroy__(ofport);
2253 netdev_close(netdev);
2257 /* Removes 'ofport' from 'p' and destroys it. */
2259 ofport_remove(struct ofport *ofport)
2261 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2263 ofport_destroy(ofport);
2266 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2269 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2271 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2273 ofport_remove(port);
2277 /* Updates 'port' with new 'pp' description.
2279 * Does not handle a name or port number change. The caller must implement
2280 * such a change as a delete followed by an add. */
2282 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2284 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2285 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2286 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2287 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2288 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2289 port->pp.curr = pp->curr;
2290 port->pp.advertised = pp->advertised;
2291 port->pp.supported = pp->supported;
2292 port->pp.peer = pp->peer;
2293 port->pp.curr_speed = pp->curr_speed;
2294 port->pp.max_speed = pp->max_speed;
2296 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2297 &port->pp, OFPPR_MODIFY);
2300 /* Update OpenFlow 'state' in 'port' and notify controller. */
2302 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2304 if (port->pp.state != state) {
2305 port->pp.state = state;
2306 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2307 &port->pp, OFPPR_MODIFY);
2312 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2314 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2316 if (port->ofproto->ofproto_class->set_realdev) {
2317 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2319 if (port->ofproto->ofproto_class->set_stp_port) {
2320 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2322 if (port->ofproto->ofproto_class->set_cfm) {
2323 port->ofproto->ofproto_class->set_cfm(port, NULL);
2325 if (port->ofproto->ofproto_class->bundle_remove) {
2326 port->ofproto->ofproto_class->bundle_remove(port);
2332 ofport_destroy__(struct ofport *port)
2334 struct ofproto *ofproto = port->ofproto;
2335 const char *name = netdev_get_name(port->netdev);
2337 hmap_remove(&ofproto->ports, &port->hmap_node);
2338 shash_delete(&ofproto->port_by_name,
2339 shash_find(&ofproto->port_by_name, name));
2341 netdev_close(port->netdev);
2342 ofproto->ofproto_class->port_dealloc(port);
2346 ofport_destroy(struct ofport *port)
2349 dealloc_ofp_port(port->ofproto, port->ofp_port);
2350 port->ofproto->ofproto_class->port_destruct(port);
2351 ofport_destroy__(port);
2356 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2358 struct ofport *port;
2360 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2362 if (port->ofp_port == ofp_port) {
2369 static long long int
2370 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2372 struct ofport_usage *usage;
2374 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2375 &ofproto->ofport_usage) {
2376 if (usage->ofp_port == ofp_port) {
2377 return usage->last_used;
2384 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2385 long long int last_used)
2387 struct ofport_usage *usage;
2388 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2389 &ofproto->ofport_usage) {
2390 if (usage->ofp_port == ofp_port) {
2391 usage->last_used = last_used;
2395 ovs_assert(last_used == LLONG_MAX);
2397 usage = xmalloc(sizeof *usage);
2398 usage->ofp_port = ofp_port;
2399 usage->last_used = last_used;
2400 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2401 hash_ofp_port(ofp_port));
2405 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2407 struct ofport_usage *usage;
2408 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2409 &ofproto->ofport_usage) {
2410 if (usage->ofp_port == ofp_port) {
2411 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2419 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2421 struct ofproto *ofproto = port->ofproto;
2424 if (ofproto->ofproto_class->port_get_stats) {
2425 error = ofproto->ofproto_class->port_get_stats(port, stats);
2434 update_port(struct ofproto *ofproto, const char *name)
2436 struct ofproto_port ofproto_port;
2437 struct ofputil_phy_port pp;
2438 struct netdev *netdev;
2439 struct ofport *port;
2441 COVERAGE_INC(ofproto_update_port);
2443 /* Fetch 'name''s location and properties from the datapath. */
2444 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2445 ? ofport_open(ofproto, &ofproto_port, &pp)
2449 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2450 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2451 struct netdev *old_netdev = port->netdev;
2453 /* 'name' hasn't changed location. Any properties changed? */
2454 if (!ofport_equal(&port->pp, &pp)) {
2455 ofport_modified(port, &pp);
2458 update_mtu(ofproto, port);
2460 /* Install the newly opened netdev in case it has changed.
2461 * Don't close the old netdev yet in case port_modified has to
2462 * remove a retained reference to it.*/
2463 port->netdev = netdev;
2464 port->change_seq = netdev_get_change_seq(netdev);
2466 if (port->ofproto->ofproto_class->port_modified) {
2467 port->ofproto->ofproto_class->port_modified(port);
2470 netdev_close(old_netdev);
2472 /* If 'port' is nonnull then its name differs from 'name' and thus
2473 * we should delete it. If we think there's a port named 'name'
2474 * then its port number must be wrong now so delete it too. */
2476 ofport_remove(port);
2478 ofport_remove_with_name(ofproto, name);
2479 ofport_install(ofproto, netdev, &pp);
2482 /* Any port named 'name' is gone now. */
2483 ofport_remove_with_name(ofproto, name);
2485 ofproto_port_destroy(&ofproto_port);
2489 init_ports(struct ofproto *p)
2491 struct ofproto_port_dump dump;
2492 struct ofproto_port ofproto_port;
2493 struct shash_node *node, *next;
2495 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2496 const char *name = ofproto_port.name;
2498 if (shash_find(&p->port_by_name, name)) {
2499 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2502 struct ofputil_phy_port pp;
2503 struct netdev *netdev;
2505 /* Check if an OpenFlow port number had been requested. */
2506 node = shash_find(&init_ofp_ports, name);
2508 const struct iface_hint *iface_hint = node->data;
2509 simap_put(&p->ofp_requests, name,
2510 ofp_to_u16(iface_hint->ofp_port));
2513 netdev = ofport_open(p, &ofproto_port, &pp);
2515 ofport_install(p, netdev, &pp);
2516 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2517 p->alloc_port_no = MAX(p->alloc_port_no,
2518 ofp_to_u16(ofproto_port.ofp_port));
2524 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2525 struct iface_hint *iface_hint = node->data;
2527 if (!strcmp(iface_hint->br_name, p->name)) {
2528 free(iface_hint->br_name);
2529 free(iface_hint->br_type);
2531 shash_delete(&init_ofp_ports, node);
2538 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2539 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2541 find_min_mtu(struct ofproto *p)
2543 struct ofport *ofport;
2546 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2547 struct netdev *netdev = ofport->netdev;
2550 /* Skip any internal ports, since that's what we're trying to
2552 if (!strcmp(netdev_get_type(netdev), "internal")) {
2556 if (netdev_get_mtu(netdev, &dev_mtu)) {
2559 if (!mtu || dev_mtu < mtu) {
2564 return mtu ? mtu: ETH_PAYLOAD_MAX;
2567 /* Update MTU of all datapath devices on 'p' to the minimum of the
2568 * non-datapath ports in event of 'port' added or changed. */
2570 update_mtu(struct ofproto *p, struct ofport *port)
2572 struct ofport *ofport;
2573 struct netdev *netdev = port->netdev;
2574 int dev_mtu, old_min;
2576 if (netdev_get_mtu(netdev, &dev_mtu)) {
2580 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2581 if (dev_mtu > p->min_mtu) {
2582 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2583 dev_mtu = p->min_mtu;
2586 port->mtu = dev_mtu;
2590 /* For non-internal port find new min mtu. */
2591 old_min = p->min_mtu;
2592 port->mtu = dev_mtu;
2593 p->min_mtu = find_min_mtu(p);
2594 if (p->min_mtu == old_min) {
2598 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2599 struct netdev *netdev = ofport->netdev;
2601 if (!strcmp(netdev_get_type(netdev), "internal")) {
2602 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2603 ofport->mtu = p->min_mtu;
2610 ofproto_rule_destroy__(struct rule *rule)
2611 OVS_NO_THREAD_SAFETY_ANALYSIS
2613 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2614 rule_actions_destroy(rule_get_actions(rule));
2615 ovs_mutex_destroy(&rule->mutex);
2616 rule->ofproto->ofproto_class->rule_dealloc(rule);
2620 rule_destroy_cb(struct rule *rule)
2622 rule->ofproto->ofproto_class->rule_destruct(rule);
2623 ofproto_rule_destroy__(rule);
2627 ofproto_rule_ref(struct rule *rule)
2630 ovs_refcount_ref(&rule->ref_count);
2634 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2635 * ref_count reaches 0.
2637 * Use of RCU allows short term use (between RCU quiescent periods) without
2638 * keeping a reference. A reference must be taken if the rule needs to
2639 * stay around accross the RCU quiescent periods. */
2641 ofproto_rule_unref(struct rule *rule)
2643 if (rule && ovs_refcount_unref(&rule->ref_count) == 1) {
2644 ovsrcu_postpone(rule_destroy_cb, rule);
2648 static uint32_t get_provider_meter_id(const struct ofproto *,
2649 uint32_t of_meter_id);
2651 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2652 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2653 const struct rule_actions *
2654 rule_actions_create(const struct ofproto *ofproto,
2655 const struct ofpact *ofpacts, size_t ofpacts_len)
2657 struct rule_actions *actions;
2659 actions = xmalloc(sizeof *actions + ofpacts_len);
2660 actions->ofpacts_len = ofpacts_len;
2661 actions->provider_meter_id
2662 = get_provider_meter_id(ofproto,
2663 ofpacts_get_meter(ofpacts, ofpacts_len));
2664 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2669 /* Free the actions after the RCU quiescent period is reached. */
2671 rule_actions_destroy(const struct rule_actions *actions)
2674 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2678 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2679 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2681 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2682 OVS_REQUIRES(ofproto_mutex)
2684 if (port == OFPP_ANY) {
2687 const struct rule_actions *actions = rule_get_actions(rule);
2688 return ofpacts_output_to_port(actions->ofpacts,
2689 actions->ofpacts_len, port);
2693 /* Returns true if 'rule' has group and equals group_id. */
2695 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2696 OVS_REQUIRES(ofproto_mutex)
2698 if (group_id == OFPG_ANY) {
2701 const struct rule_actions *actions = rule_get_actions(rule);
2702 return ofpacts_output_to_group(actions->ofpacts,
2703 actions->ofpacts_len, group_id);
2707 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2708 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2710 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2711 OVS_REQUIRES(ofproto_mutex)
2713 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2718 case OFOPERATION_ADD:
2719 case OFOPERATION_DELETE:
2722 case OFOPERATION_MODIFY:
2723 case OFOPERATION_REPLACE:
2724 return ofpacts_output_to_port(op->actions->ofpacts,
2725 op->actions->ofpacts_len, out_port);
2732 rule_execute_destroy(struct rule_execute *e)
2734 ofproto_rule_unref(e->rule);
2735 list_remove(&e->list_node);
2739 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2740 * by passing them to the ofproto provider. */
2742 run_rule_executes(struct ofproto *ofproto)
2743 OVS_EXCLUDED(ofproto_mutex)
2745 struct rule_execute *e, *next;
2746 struct list executes;
2748 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2749 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2752 flow_extract(e->packet, NULL, &flow);
2753 flow.in_port.ofp_port = e->in_port;
2754 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2756 rule_execute_destroy(e);
2760 /* Destroys and discards all "rule_execute" operations queued up in
2761 * ofproto->rule_executes. */
2763 destroy_rule_executes(struct ofproto *ofproto)
2765 struct rule_execute *e, *next;
2766 struct list executes;
2768 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2769 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2770 ofpbuf_delete(e->packet);
2771 rule_execute_destroy(e);
2775 /* Returns true if 'rule' should be hidden from the controller.
2777 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2778 * (e.g. by in-band control) and are intentionally hidden from the
2781 ofproto_rule_is_hidden(const struct rule *rule)
2783 return (rule->cr.priority > UINT16_MAX);
2787 oftable_is_modifiable(const struct oftable *table,
2788 enum ofputil_flow_mod_flags flags)
2790 if (flags & OFPUTIL_FF_NO_READONLY) {
2794 return !(table->flags & OFTABLE_READONLY);
2798 rule_is_modifiable(const struct rule *rule, enum ofputil_flow_mod_flags flags)
2800 const struct oftable *rule_table;
2802 rule_table = &rule->ofproto->tables[rule->table_id];
2803 return oftable_is_modifiable(rule_table, flags);
2807 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2809 ofconn_send_reply(ofconn, make_echo_reply(oh));
2814 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2816 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2817 struct ofputil_switch_features features;
2818 struct ofport *port;
2822 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2824 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2826 features.datapath_id = ofproto->datapath_id;
2827 features.n_buffers = pktbuf_capacity();
2828 features.n_tables = ofproto_get_n_visible_tables(ofproto);
2829 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2830 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2832 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2834 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2835 features.auxiliary_id = 0;
2836 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2838 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2839 ofputil_put_switch_features_port(&port->pp, b);
2842 ofconn_send_reply(ofconn, b);
2847 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2849 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2850 struct ofp_switch_config *osc;
2851 enum ofp_config_flags flags;
2855 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2856 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2857 flags = ofproto->frag_handling;
2858 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2859 if (oh->version < OFP13_VERSION
2860 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2861 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2863 osc->flags = htons(flags);
2864 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2865 ofconn_send_reply(ofconn, buf);
2871 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2873 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2874 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2875 uint16_t flags = ntohs(osc->flags);
2877 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2878 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2879 enum ofp_config_flags cur = ofproto->frag_handling;
2880 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2882 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2884 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2885 ofproto->frag_handling = next;
2887 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2889 ofputil_frag_handling_to_string(next));
2893 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2894 ofconn_set_invalid_ttl_to_controller(ofconn,
2895 (oh->version < OFP13_VERSION
2896 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2898 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2903 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2904 * error message code for the caller to propagate upward. Otherwise, returns
2907 * The log message mentions 'msg_type'. */
2909 reject_slave_controller(struct ofconn *ofconn)
2911 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2912 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2913 return OFPERR_OFPBRC_EPERM;
2919 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2922 * - If they use a meter, then 'ofproto' has that meter configured.
2924 * - If they use any groups, then 'ofproto' has that group configured.
2926 * Returns 0 if successful, otherwise an OpenFlow error. */
2928 ofproto_check_ofpacts(struct ofproto *ofproto,
2929 const struct ofpact ofpacts[], size_t ofpacts_len)
2931 const struct ofpact *a;
2934 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2935 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2936 return OFPERR_OFPMMFC_INVALID_METER;
2939 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2940 if (a->type == OFPACT_GROUP
2941 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2942 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2950 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2952 struct ofproto *p = ofconn_get_ofproto(ofconn);
2953 struct ofputil_packet_out po;
2954 struct ofpbuf *payload;
2955 uint64_t ofpacts_stub[1024 / 8];
2956 struct ofpbuf ofpacts;
2960 COVERAGE_INC(ofproto_packet_out);
2962 error = reject_slave_controller(ofconn);
2967 /* Decode message. */
2968 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2969 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2971 goto exit_free_ofpacts;
2973 if (ofp_to_u16(po.in_port) >= p->max_ports
2974 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2975 error = OFPERR_OFPBRC_BAD_PORT;
2976 goto exit_free_ofpacts;
2980 if (po.buffer_id != UINT32_MAX) {
2981 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2982 if (error || !payload) {
2983 goto exit_free_ofpacts;
2986 /* Ensure that the L3 header is 32-bit aligned. */
2987 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2990 /* Verify actions against packet, then send packet if successful. */
2991 flow_extract(payload, NULL, &flow);
2992 flow.in_port.ofp_port = po.in_port;
2993 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
2995 error = p->ofproto_class->packet_out(p, payload, &flow,
2996 po.ofpacts, po.ofpacts_len);
2998 ofpbuf_delete(payload);
3001 ofpbuf_uninit(&ofpacts);
3007 update_port_config(struct ofconn *ofconn, struct ofport *port,
3008 enum ofputil_port_config config,
3009 enum ofputil_port_config mask)
3011 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3013 if (toggle & OFPUTIL_PC_PORT_DOWN
3014 && (config & OFPUTIL_PC_PORT_DOWN
3015 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3016 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3017 /* We tried to bring the port up or down, but it failed, so don't
3018 * update the "down" bit. */
3019 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3023 enum ofputil_port_config old_config = port->pp.config;
3024 port->pp.config ^= toggle;
3025 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3026 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3032 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3034 struct ofproto *p = ofconn_get_ofproto(ofconn);
3035 struct ofputil_port_mod pm;
3036 struct ofport *port;
3039 error = reject_slave_controller(ofconn);
3044 error = ofputil_decode_port_mod(oh, &pm, false);
3049 port = ofproto_get_port(p, pm.port_no);
3051 return OFPERR_OFPPMFC_BAD_PORT;
3052 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3053 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3055 update_port_config(ofconn, port, pm.config, pm.mask);
3057 netdev_set_advertisements(port->netdev, pm.advertise);
3064 handle_desc_stats_request(struct ofconn *ofconn,
3065 const struct ofp_header *request)
3067 static const char *default_mfr_desc = "Nicira, Inc.";
3068 static const char *default_hw_desc = "Open vSwitch";
3069 static const char *default_sw_desc = VERSION;
3070 static const char *default_serial_desc = "None";
3071 static const char *default_dp_desc = "None";
3073 struct ofproto *p = ofconn_get_ofproto(ofconn);
3074 struct ofp_desc_stats *ods;
3077 msg = ofpraw_alloc_stats_reply(request, 0);
3078 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3079 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3080 sizeof ods->mfr_desc);
3081 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3082 sizeof ods->hw_desc);
3083 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3084 sizeof ods->sw_desc);
3085 ovs_strlcpy(ods->serial_num,
3086 p->serial_desc ? p->serial_desc : default_serial_desc,
3087 sizeof ods->serial_num);
3088 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3089 sizeof ods->dp_desc);
3090 ofconn_send_reply(ofconn, msg);
3096 handle_table_stats_request(struct ofconn *ofconn,
3097 const struct ofp_header *request)
3099 struct ofproto *p = ofconn_get_ofproto(ofconn);
3100 struct ofp12_table_stats *ots;
3105 /* Set up default values.
3107 * ofp12_table_stats is used as a generic structure as
3108 * it is able to hold all the fields for ofp10_table_stats
3109 * and ofp11_table_stats (and of course itself).
3111 ots = xcalloc(p->n_tables, sizeof *ots);
3112 for (i = 0; i < p->n_tables; i++) {
3113 ots[i].table_id = i;
3114 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3115 ots[i].match = htonll(OFPXMT13_MASK);
3116 ots[i].wildcards = htonll(OFPXMT13_MASK);
3117 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3118 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3119 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3120 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3121 ots[i].metadata_match = OVS_BE64_MAX;
3122 ots[i].metadata_write = OVS_BE64_MAX;
3123 ots[i].instructions = htonl(OFPIT11_ALL);
3124 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3125 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3126 fat_rwlock_rdlock(&p->tables[i].cls.rwlock);
3127 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3128 fat_rwlock_unlock(&p->tables[i].cls.rwlock);
3131 p->ofproto_class->get_tables(p, ots);
3133 /* Post-process the tables, dropping hidden tables. */
3134 n_tables = p->n_tables;
3135 for (i = 0; i < p->n_tables; i++) {
3136 const struct oftable *table = &p->tables[i];
3138 if (table->flags & OFTABLE_HIDDEN) {
3144 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3147 if (table->max_flows < ntohl(ots[i].max_entries)) {
3148 ots[i].max_entries = htonl(table->max_flows);
3152 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3153 ofconn_send_reply(ofconn, msg);
3161 append_port_stat(struct ofport *port, struct list *replies)
3163 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3165 calc_duration(port->created, time_msec(),
3166 &ops.duration_sec, &ops.duration_nsec);
3168 /* Intentionally ignore return value, since errors will set
3169 * 'stats' to all-1s, which is correct for OpenFlow, and
3170 * netdev_get_stats() will log errors. */
3171 ofproto_port_get_stats(port, &ops.stats);
3173 ofputil_append_port_stat(replies, &ops);
3177 handle_port_request(struct ofconn *ofconn,
3178 const struct ofp_header *request, ofp_port_t port_no,
3179 void (*cb)(struct ofport *, struct list *replies))
3181 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3182 struct ofport *port;
3183 struct list replies;
3185 ofpmp_init(&replies, request);
3186 if (port_no != OFPP_ANY) {
3187 port = ofproto_get_port(ofproto, port_no);
3192 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3197 ofconn_send_replies(ofconn, &replies);
3201 handle_port_stats_request(struct ofconn *ofconn,
3202 const struct ofp_header *request)
3207 error = ofputil_decode_port_stats_request(request, &port_no);
3209 handle_port_request(ofconn, request, port_no, append_port_stat);
3215 append_port_desc(struct ofport *port, struct list *replies)
3217 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3221 handle_port_desc_stats_request(struct ofconn *ofconn,
3222 const struct ofp_header *request)
3227 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3229 handle_port_request(ofconn, request, port_no, append_port_desc);
3235 hash_cookie(ovs_be64 cookie)
3237 return hash_uint64((OVS_FORCE uint64_t)cookie);
3241 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3242 OVS_REQUIRES(ofproto_mutex)
3244 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3245 hash_cookie(rule->flow_cookie));
3249 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3250 OVS_REQUIRES(ofproto_mutex)
3252 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3256 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3257 ovs_be64 new_cookie)
3258 OVS_REQUIRES(ofproto_mutex)
3260 if (new_cookie != rule->flow_cookie) {
3261 cookies_remove(ofproto, rule);
3263 ovs_mutex_lock(&rule->mutex);
3264 rule->flow_cookie = new_cookie;
3265 ovs_mutex_unlock(&rule->mutex);
3267 cookies_insert(ofproto, rule);
3272 calc_duration(long long int start, long long int now,
3273 uint32_t *sec, uint32_t *nsec)
3275 long long int msecs = now - start;
3276 *sec = msecs / 1000;
3277 *nsec = (msecs % 1000) * (1000 * 1000);
3280 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3281 * true if 'table_id' is OK, false otherwise. */
3283 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3285 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3288 static struct oftable *
3289 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3291 struct oftable *table;
3293 for (table = &ofproto->tables[table_id];
3294 table < &ofproto->tables[ofproto->n_tables];
3296 if (!(table->flags & OFTABLE_HIDDEN)) {
3304 static struct oftable *
3305 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3307 if (table_id == 0xff) {
3308 return next_visible_table(ofproto, 0);
3309 } else if (table_id < ofproto->n_tables) {
3310 return &ofproto->tables[table_id];
3316 static struct oftable *
3317 next_matching_table(const struct ofproto *ofproto,
3318 const struct oftable *table, uint8_t table_id)
3320 return (table_id == 0xff
3321 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3325 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3327 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3328 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3330 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3331 * only once, for that table. (This can be used to access tables marked
3334 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3335 * entered at all. (Perhaps you should have validated TABLE_ID with
3336 * check_table_id().)
3338 * All parameters are evaluated multiple times.
3340 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3341 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3343 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3345 /* Initializes 'criteria' in a straightforward way based on the other
3348 * For "loose" matching, the 'priority' parameter is unimportant and may be
3351 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3352 const struct match *match, unsigned int priority,
3353 ovs_be64 cookie, ovs_be64 cookie_mask,
3354 ofp_port_t out_port, uint32_t out_group)
3356 criteria->table_id = table_id;
3357 cls_rule_init(&criteria->cr, match, priority);
3358 criteria->cookie = cookie;
3359 criteria->cookie_mask = cookie_mask;
3360 criteria->out_port = out_port;
3361 criteria->out_group = out_group;
3365 rule_criteria_destroy(struct rule_criteria *criteria)
3367 cls_rule_destroy(&criteria->cr);
3371 rule_collection_init(struct rule_collection *rules)
3373 rules->rules = rules->stub;
3375 rules->capacity = ARRAY_SIZE(rules->stub);
3379 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3381 if (rules->n >= rules->capacity) {
3382 size_t old_size, new_size;
3384 old_size = rules->capacity * sizeof *rules->rules;
3385 rules->capacity *= 2;
3386 new_size = rules->capacity * sizeof *rules->rules;
3388 if (rules->rules == rules->stub) {
3389 rules->rules = xmalloc(new_size);
3390 memcpy(rules->rules, rules->stub, old_size);
3392 rules->rules = xrealloc(rules->rules, new_size);
3396 rules->rules[rules->n++] = rule;
3400 rule_collection_ref(struct rule_collection *rules)
3401 OVS_REQUIRES(ofproto_mutex)
3405 for (i = 0; i < rules->n; i++) {
3406 ofproto_rule_ref(rules->rules[i]);
3411 rule_collection_unref(struct rule_collection *rules)
3415 for (i = 0; i < rules->n; i++) {
3416 ofproto_rule_unref(rules->rules[i]);
3421 rule_collection_destroy(struct rule_collection *rules)
3423 if (rules->rules != rules->stub) {
3429 collect_rule(struct rule *rule, const struct rule_criteria *c,
3430 struct rule_collection *rules)
3431 OVS_REQUIRES(ofproto_mutex)
3433 /* We ordinarily want to skip hidden rules, but there has to be a way for
3434 * code internal to OVS to modify and delete them, so if the criteria
3435 * specify a priority that can only be for a hidden flow, then allow hidden
3436 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3437 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3439 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3441 } else if (rule->pending) {
3442 return OFPROTO_POSTPONE;
3444 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3445 && ofproto_rule_has_out_port(rule, c->out_port)
3446 && ofproto_rule_has_out_group(rule, c->out_group)
3447 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3448 rule_collection_add(rules, rule);
3454 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3455 * on classifiers rules are done in the "loose" way required for OpenFlow
3456 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3459 * Hidden rules are always omitted.
3461 * Returns 0 on success, otherwise an OpenFlow error code. */
3463 collect_rules_loose(struct ofproto *ofproto,
3464 const struct rule_criteria *criteria,
3465 struct rule_collection *rules)
3466 OVS_REQUIRES(ofproto_mutex)
3468 struct oftable *table;
3469 enum ofperr error = 0;
3471 rule_collection_init(rules);
3473 if (!check_table_id(ofproto, criteria->table_id)) {
3474 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3478 if (criteria->cookie_mask == OVS_BE64_MAX) {
3481 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3482 hash_cookie(criteria->cookie),
3483 &ofproto->cookies) {
3484 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3485 error = collect_rule(rule, criteria, rules);
3492 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3493 struct cls_cursor cursor;
3496 fat_rwlock_rdlock(&table->cls.rwlock);
3497 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3498 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3499 error = collect_rule(rule, criteria, rules);
3504 fat_rwlock_unlock(&table->cls.rwlock);
3510 rule_collection_destroy(rules);
3515 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3516 * on classifiers rules are done in the "strict" way required for OpenFlow
3517 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3518 * rules on list 'rules'.
3520 * Hidden rules are always omitted.
3522 * Returns 0 on success, otherwise an OpenFlow error code. */
3524 collect_rules_strict(struct ofproto *ofproto,
3525 const struct rule_criteria *criteria,
3526 struct rule_collection *rules)
3527 OVS_REQUIRES(ofproto_mutex)
3529 struct oftable *table;
3532 rule_collection_init(rules);
3534 if (!check_table_id(ofproto, criteria->table_id)) {
3535 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3539 if (criteria->cookie_mask == OVS_BE64_MAX) {
3542 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3543 hash_cookie(criteria->cookie),
3544 &ofproto->cookies) {
3545 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3546 error = collect_rule(rule, criteria, rules);
3553 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3556 fat_rwlock_rdlock(&table->cls.rwlock);
3557 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3558 &table->cls, &criteria->cr));
3559 fat_rwlock_unlock(&table->cls.rwlock);
3561 error = collect_rule(rule, criteria, rules);
3571 rule_collection_destroy(rules);
3576 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3577 * forced into the range of a uint16_t. */
3579 age_secs(long long int age_ms)
3581 return (age_ms < 0 ? 0
3582 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3583 : (unsigned int) age_ms / 1000);
3587 handle_flow_stats_request(struct ofconn *ofconn,
3588 const struct ofp_header *request)
3589 OVS_EXCLUDED(ofproto_mutex)
3591 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3592 struct ofputil_flow_stats_request fsr;
3593 struct rule_criteria criteria;
3594 struct rule_collection rules;
3595 struct list replies;
3599 error = ofputil_decode_flow_stats_request(&fsr, request);
3604 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3605 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3607 ovs_mutex_lock(&ofproto_mutex);
3608 error = collect_rules_loose(ofproto, &criteria, &rules);
3609 rule_criteria_destroy(&criteria);
3611 rule_collection_ref(&rules);
3613 ovs_mutex_unlock(&ofproto_mutex);
3619 ofpmp_init(&replies, request);
3620 for (i = 0; i < rules.n; i++) {
3621 struct rule *rule = rules.rules[i];
3622 long long int now = time_msec();
3623 struct ofputil_flow_stats fs;
3624 long long int created, used, modified;
3625 const struct rule_actions *actions;
3626 enum ofputil_flow_mod_flags flags;
3628 ovs_mutex_lock(&rule->mutex);
3629 fs.cookie = rule->flow_cookie;
3630 fs.idle_timeout = rule->idle_timeout;
3631 fs.hard_timeout = rule->hard_timeout;
3632 created = rule->created;
3633 modified = rule->modified;
3634 actions = rule_get_actions(rule);
3635 flags = rule->flags;
3636 ovs_mutex_unlock(&rule->mutex);
3638 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3639 &fs.byte_count, &used);
3641 minimatch_expand(&rule->cr.match, &fs.match);
3642 fs.table_id = rule->table_id;
3643 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3644 fs.priority = rule->cr.priority;
3645 fs.idle_age = age_secs(now - used);
3646 fs.hard_age = age_secs(now - modified);
3647 fs.ofpacts = actions->ofpacts;
3648 fs.ofpacts_len = actions->ofpacts_len;
3651 ofputil_append_flow_stats_reply(&fs, &replies);
3654 rule_collection_unref(&rules);
3655 rule_collection_destroy(&rules);
3657 ofconn_send_replies(ofconn, &replies);
3663 flow_stats_ds(struct rule *rule, struct ds *results)
3665 uint64_t packet_count, byte_count;
3666 const struct rule_actions *actions;
3667 long long int created, used;
3669 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3670 &byte_count, &used);
3672 ovs_mutex_lock(&rule->mutex);
3673 actions = rule_get_actions(rule);
3674 created = rule->created;
3675 ovs_mutex_unlock(&rule->mutex);
3677 if (rule->table_id != 0) {
3678 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3680 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3681 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3682 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3683 cls_rule_format(&rule->cr, results);
3684 ds_put_char(results, ',');
3686 ds_put_cstr(results, "actions=");
3687 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3689 ds_put_cstr(results, "\n");
3692 /* Adds a pretty-printed description of all flows to 'results', including
3693 * hidden flows (e.g., set up by in-band control). */
3695 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3697 struct oftable *table;
3699 OFPROTO_FOR_EACH_TABLE (table, p) {
3700 struct cls_cursor cursor;
3703 fat_rwlock_rdlock(&table->cls.rwlock);
3704 cls_cursor_init(&cursor, &table->cls, NULL);
3705 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3706 flow_stats_ds(rule, results);
3708 fat_rwlock_unlock(&table->cls.rwlock);
3712 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3713 * '*engine_type' and '*engine_id', respectively. */
3715 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3716 uint8_t *engine_type, uint8_t *engine_id)
3718 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3721 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto' and stores
3722 * the port's CFM status in '*status'. If 'force' is set to true, status will
3723 * be returned even if there is no status change since last update.
3725 * Returns 0 on success. Returns a negative number if there is no status
3726 * change since last update and 'force' is set to false. Returns positive errno
3727 * if the port did not have CFM configured.
3729 * The caller must provide and own '*status', and must free 'status->rmps'.
3730 * '*status' is indeterminate if the return value is non-zero. */
3732 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3733 bool force, struct ofproto_cfm_status *status)
3735 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3736 return (ofport && ofproto->ofproto_class->get_cfm_status
3737 ? ofproto->ofproto_class->get_cfm_status(ofport, force, status)
3742 handle_aggregate_stats_request(struct ofconn *ofconn,
3743 const struct ofp_header *oh)
3744 OVS_EXCLUDED(ofproto_mutex)
3746 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3747 struct ofputil_flow_stats_request request;
3748 struct ofputil_aggregate_stats stats;
3749 bool unknown_packets, unknown_bytes;
3750 struct rule_criteria criteria;
3751 struct rule_collection rules;
3752 struct ofpbuf *reply;
3756 error = ofputil_decode_flow_stats_request(&request, oh);
3761 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3762 request.cookie, request.cookie_mask,
3763 request.out_port, request.out_group);
3765 ovs_mutex_lock(&ofproto_mutex);
3766 error = collect_rules_loose(ofproto, &criteria, &rules);
3767 rule_criteria_destroy(&criteria);
3769 rule_collection_ref(&rules);
3771 ovs_mutex_unlock(&ofproto_mutex);
3777 memset(&stats, 0, sizeof stats);
3778 unknown_packets = unknown_bytes = false;
3779 for (i = 0; i < rules.n; i++) {
3780 struct rule *rule = rules.rules[i];
3781 uint64_t packet_count;
3782 uint64_t byte_count;
3785 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3786 &byte_count, &used);
3788 if (packet_count == UINT64_MAX) {
3789 unknown_packets = true;
3791 stats.packet_count += packet_count;
3794 if (byte_count == UINT64_MAX) {
3795 unknown_bytes = true;
3797 stats.byte_count += byte_count;
3802 if (unknown_packets) {
3803 stats.packet_count = UINT64_MAX;
3805 if (unknown_bytes) {
3806 stats.byte_count = UINT64_MAX;
3809 rule_collection_unref(&rules);
3810 rule_collection_destroy(&rules);
3812 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3813 ofconn_send_reply(ofconn, reply);
3818 struct queue_stats_cbdata {
3819 struct ofport *ofport;
3820 struct list replies;
3825 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3826 const struct netdev_queue_stats *stats)
3828 struct ofputil_queue_stats oqs;
3830 oqs.port_no = cbdata->ofport->pp.port_no;
3831 oqs.queue_id = queue_id;
3832 oqs.tx_bytes = stats->tx_bytes;
3833 oqs.tx_packets = stats->tx_packets;
3834 oqs.tx_errors = stats->tx_errors;
3835 if (stats->created != LLONG_MIN) {
3836 calc_duration(stats->created, cbdata->now,
3837 &oqs.duration_sec, &oqs.duration_nsec);
3839 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3841 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3845 handle_queue_stats_dump_cb(uint32_t queue_id,
3846 struct netdev_queue_stats *stats,
3849 struct queue_stats_cbdata *cbdata = cbdata_;
3851 put_queue_stats(cbdata, queue_id, stats);
3855 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3856 struct queue_stats_cbdata *cbdata)
3858 cbdata->ofport = port;
3859 if (queue_id == OFPQ_ALL) {
3860 netdev_dump_queue_stats(port->netdev,
3861 handle_queue_stats_dump_cb, cbdata);
3863 struct netdev_queue_stats stats;
3865 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3866 put_queue_stats(cbdata, queue_id, &stats);
3868 return OFPERR_OFPQOFC_BAD_QUEUE;
3875 handle_queue_stats_request(struct ofconn *ofconn,
3876 const struct ofp_header *rq)
3878 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3879 struct queue_stats_cbdata cbdata;
3880 struct ofport *port;
3882 struct ofputil_queue_stats_request oqsr;
3884 COVERAGE_INC(ofproto_queue_req);
3886 ofpmp_init(&cbdata.replies, rq);
3887 cbdata.now = time_msec();
3889 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3894 if (oqsr.port_no == OFPP_ANY) {
3895 error = OFPERR_OFPQOFC_BAD_QUEUE;
3896 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3897 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3902 port = ofproto_get_port(ofproto, oqsr.port_no);
3904 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3905 : OFPERR_OFPQOFC_BAD_PORT);
3908 ofconn_send_replies(ofconn, &cbdata.replies);
3910 ofpbuf_list_delete(&cbdata.replies);
3917 is_flow_deletion_pending(const struct ofproto *ofproto,
3918 const struct cls_rule *cls_rule,
3920 OVS_REQUIRES(ofproto_mutex)
3922 if (!hmap_is_empty(&ofproto->deletions)) {
3923 struct ofoperation *op;
3925 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3926 cls_rule_hash(cls_rule, table_id),
3927 &ofproto->deletions) {
3928 if (op->rule->table_id == table_id
3929 && cls_rule_equal(cls_rule, &op->rule->cr)) {
3939 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3940 OVS_REQUIRES(ofproto_mutex)
3941 OVS_NO_THREAD_SAFETY_ANALYSIS
3943 return classifier_count(&table->cls) + extra_space > table->max_flows;
3947 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3948 unsigned int extra_space)
3949 OVS_REQUIRES(ofproto_mutex)
3951 while (should_evict_a_rule(table, extra_space)) {
3954 if (!choose_rule_to_evict(table, &rule)) {
3955 return OFPERR_OFPFMFC_TABLE_FULL;
3956 } else if (rule->pending) {
3957 return OFPROTO_POSTPONE;
3959 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3960 delete_flow__(rule, group, OFPRR_EVICTION);
3961 ofopgroup_submit(group);
3968 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3969 * in which no matching flow already exists in the flow table.
3971 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3972 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3973 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3974 * initiated now but may be retried later.
3976 * The caller retains ownership of 'fm->ofpacts'.
3978 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3981 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3982 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3983 OVS_REQUIRES(ofproto_mutex)
3985 struct oftable *table;
3991 if (!check_table_id(ofproto, fm->table_id)) {
3992 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3997 if (fm->table_id == 0xff) {
3998 if (ofproto->ofproto_class->rule_choose_table) {
3999 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4005 ovs_assert(table_id < ofproto->n_tables);
4009 } else if (fm->table_id < ofproto->n_tables) {
4010 table_id = fm->table_id;
4012 return OFPERR_OFPBRC_BAD_TABLE_ID;
4015 table = &ofproto->tables[table_id];
4017 if (!oftable_is_modifiable(table, fm->flags)) {
4018 return OFPERR_OFPBRC_EPERM;
4021 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4022 if (!match_has_default_hidden_fields(&fm->match)) {
4023 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4024 "non-default values to hidden fields", ofproto->name);
4025 return OFPERR_OFPBRC_EPERM;
4029 cls_rule_init(&cr, &fm->match, fm->priority);
4031 /* Transform "add" into "modify" if there's an existing identical flow. */
4032 fat_rwlock_rdlock(&table->cls.rwlock);
4033 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4034 fat_rwlock_unlock(&table->cls.rwlock);
4036 cls_rule_destroy(&cr);
4037 if (!rule_is_modifiable(rule, fm->flags)) {
4038 return OFPERR_OFPBRC_EPERM;
4039 } else if (rule->pending) {
4040 return OFPROTO_POSTPONE;
4042 struct rule_collection rules;
4044 rule_collection_init(&rules);
4045 rule_collection_add(&rules, rule);
4046 fm->modify_cookie = true;
4047 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4048 rule_collection_destroy(&rules);
4054 /* Serialize against pending deletion. */
4055 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
4056 cls_rule_destroy(&cr);
4057 return OFPROTO_POSTPONE;
4060 /* Check for overlap, if requested. */
4061 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4064 fat_rwlock_rdlock(&table->cls.rwlock);
4065 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4066 fat_rwlock_unlock(&table->cls.rwlock);
4069 cls_rule_destroy(&cr);
4070 return OFPERR_OFPFMFC_OVERLAP;
4074 /* If necessary, evict an existing rule to clear out space. */
4075 error = evict_rules_from_table(ofproto, table, 1);
4077 cls_rule_destroy(&cr);
4081 /* Allocate new rule. */
4082 rule = ofproto->ofproto_class->rule_alloc();
4084 cls_rule_destroy(&cr);
4085 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4086 ofproto->name, ovs_strerror(error));
4090 /* Initialize base state. */
4091 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4092 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4093 ovs_refcount_init(&rule->ref_count);
4094 rule->pending = NULL;
4095 rule->flow_cookie = fm->new_cookie;
4096 rule->created = rule->modified = time_msec();
4098 ovs_mutex_init(&rule->mutex);
4099 ovs_mutex_lock(&rule->mutex);
4100 rule->idle_timeout = fm->idle_timeout;
4101 rule->hard_timeout = fm->hard_timeout;
4102 ovs_mutex_unlock(&rule->mutex);
4104 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4105 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4106 ovsrcu_set(&rule->actions,
4107 rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len));
4108 list_init(&rule->meter_list_node);
4109 rule->eviction_group = NULL;
4110 list_init(&rule->expirable);
4111 rule->monitor_flags = 0;
4112 rule->add_seqno = 0;
4113 rule->modify_seqno = 0;
4115 /* Construct rule, initializing derived state. */
4116 error = ofproto->ofproto_class->rule_construct(rule);
4118 ofproto_rule_destroy__(rule);
4123 do_add_flow(ofproto, ofconn, request, fm->buffer_id, rule);
4129 do_add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
4130 const struct ofp_header *request, uint32_t buffer_id,
4132 OVS_REQUIRES(ofproto_mutex)
4134 struct ofopgroup *group;
4136 oftable_insert_rule(rule);
4138 group = ofopgroup_create(ofproto, ofconn, request, buffer_id);
4139 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4140 ofproto->ofproto_class->rule_insert(rule);
4141 ofopgroup_submit(group);
4144 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4146 /* Modifies the rules listed in 'rules', changing their actions to match those
4149 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4152 * Returns 0 on success, otherwise an OpenFlow error code. */
4154 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4155 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4156 const struct rule_collection *rules)
4157 OVS_REQUIRES(ofproto_mutex)
4159 enum ofoperation_type type;
4160 struct ofopgroup *group;
4164 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4165 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4166 error = OFPERR_OFPBRC_EPERM;
4167 for (i = 0; i < rules->n; i++) {
4168 struct rule *rule = rules->rules[i];
4169 const struct rule_actions *actions;
4170 struct ofoperation *op;
4171 bool actions_changed;
4172 bool reset_counters;
4174 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4176 if (rule_is_modifiable(rule, fm->flags)) {
4177 /* At least one rule is modifiable, don't report EPERM error. */
4183 actions = rule_get_actions(rule);
4184 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4186 actions->ofpacts_len);
4188 op = ofoperation_create(group, rule, type, 0);
4190 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4191 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4193 if (type == OFOPERATION_REPLACE) {
4194 ovs_mutex_lock(&rule->mutex);
4195 rule->idle_timeout = fm->idle_timeout;
4196 rule->hard_timeout = fm->hard_timeout;
4197 ovs_mutex_unlock(&rule->mutex);
4199 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4200 if (fm->idle_timeout || fm->hard_timeout) {
4201 if (!rule->eviction_group) {
4202 eviction_group_add_rule(rule);
4205 eviction_group_remove_rule(rule);
4209 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4210 if (actions_changed || reset_counters) {
4211 const struct rule_actions *new_actions;
4213 op->actions = rule_get_actions(rule);
4214 new_actions = rule_actions_create(ofproto,
4215 fm->ofpacts, fm->ofpacts_len);
4217 ovsrcu_set(&rule->actions, new_actions);
4219 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4222 ofoperation_complete(op, 0);
4225 ofopgroup_submit(group);
4231 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4232 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4233 OVS_REQUIRES(ofproto_mutex)
4235 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4238 return add_flow(ofproto, ofconn, fm, request);
4241 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4244 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4247 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4248 struct ofputil_flow_mod *fm,
4249 const struct ofp_header *request)
4250 OVS_REQUIRES(ofproto_mutex)
4252 struct rule_criteria criteria;
4253 struct rule_collection rules;
4256 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4257 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4258 error = collect_rules_loose(ofproto, &criteria, &rules);
4259 rule_criteria_destroy(&criteria);
4262 error = (rules.n > 0
4263 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4264 : modify_flows_add(ofproto, ofconn, fm, request));
4267 rule_collection_destroy(&rules);
4272 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4275 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4278 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4279 struct ofputil_flow_mod *fm,
4280 const struct ofp_header *request)
4281 OVS_REQUIRES(ofproto_mutex)
4283 struct rule_criteria criteria;
4284 struct rule_collection rules;
4287 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4288 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4289 error = collect_rules_strict(ofproto, &criteria, &rules);
4290 rule_criteria_destroy(&criteria);
4294 error = modify_flows_add(ofproto, ofconn, fm, request);
4295 } else if (rules.n == 1) {
4296 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4300 rule_collection_destroy(&rules);
4305 /* OFPFC_DELETE implementation. */
4308 delete_flow__(struct rule *rule, struct ofopgroup *group,
4309 enum ofp_flow_removed_reason reason)
4310 OVS_REQUIRES(ofproto_mutex)
4312 struct ofproto *ofproto = rule->ofproto;
4314 ofproto_rule_send_removed(rule, reason);
4316 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4317 oftable_remove_rule(rule);
4318 ofproto->ofproto_class->rule_delete(rule);
4321 /* Deletes the rules listed in 'rules'.
4323 * Returns 0 on success, otherwise an OpenFlow error code. */
4325 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4326 const struct ofp_header *request,
4327 const struct rule_collection *rules,
4328 enum ofp_flow_removed_reason reason)
4329 OVS_REQUIRES(ofproto_mutex)
4331 struct ofopgroup *group;
4334 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4335 for (i = 0; i < rules->n; i++) {
4336 delete_flow__(rules->rules[i], group, reason);
4338 ofopgroup_submit(group);
4343 /* Implements OFPFC_DELETE. */
4345 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4346 const struct ofputil_flow_mod *fm,
4347 const struct ofp_header *request)
4348 OVS_REQUIRES(ofproto_mutex)
4350 struct rule_criteria criteria;
4351 struct rule_collection rules;
4354 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4355 fm->cookie, fm->cookie_mask,
4356 fm->out_port, fm->out_group);
4357 error = collect_rules_loose(ofproto, &criteria, &rules);
4358 rule_criteria_destroy(&criteria);
4360 if (!error && rules.n > 0) {
4361 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4363 rule_collection_destroy(&rules);
4368 /* Implements OFPFC_DELETE_STRICT. */
4370 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4371 const struct ofputil_flow_mod *fm,
4372 const struct ofp_header *request)
4373 OVS_REQUIRES(ofproto_mutex)
4375 struct rule_criteria criteria;
4376 struct rule_collection rules;
4379 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4380 fm->cookie, fm->cookie_mask,
4381 fm->out_port, fm->out_group);
4382 error = collect_rules_strict(ofproto, &criteria, &rules);
4383 rule_criteria_destroy(&criteria);
4385 if (!error && rules.n > 0) {
4386 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4388 rule_collection_destroy(&rules);
4394 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4395 OVS_REQUIRES(ofproto_mutex)
4397 struct ofputil_flow_removed fr;
4400 if (ofproto_rule_is_hidden(rule) ||
4401 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4405 minimatch_expand(&rule->cr.match, &fr.match);
4406 fr.priority = rule->cr.priority;
4407 fr.cookie = rule->flow_cookie;
4409 fr.table_id = rule->table_id;
4410 calc_duration(rule->created, time_msec(),
4411 &fr.duration_sec, &fr.duration_nsec);
4412 ovs_mutex_lock(&rule->mutex);
4413 fr.idle_timeout = rule->idle_timeout;
4414 fr.hard_timeout = rule->hard_timeout;
4415 ovs_mutex_unlock(&rule->mutex);
4416 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4417 &fr.byte_count, &used);
4419 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4422 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4423 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4426 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4429 * ofproto implementation ->run() functions should use this function to expire
4430 * OpenFlow flows. */
4432 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4433 OVS_REQUIRES(ofproto_mutex)
4435 struct ofproto *ofproto = rule->ofproto;
4437 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4438 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4440 ofproto_rule_delete__(ofproto, rule, reason);
4443 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4444 * means "infinite". */
4446 reduce_timeout(uint16_t max, uint16_t *timeout)
4448 if (max && (!*timeout || *timeout > max)) {
4453 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4454 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4455 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4457 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4459 ofproto_rule_reduce_timeouts(struct rule *rule,
4460 uint16_t idle_timeout, uint16_t hard_timeout)
4461 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4463 if (!idle_timeout && !hard_timeout) {
4467 ovs_mutex_lock(&ofproto_mutex);
4468 if (list_is_empty(&rule->expirable)) {
4469 list_insert(&rule->ofproto->expirable, &rule->expirable);
4471 ovs_mutex_unlock(&ofproto_mutex);
4473 ovs_mutex_lock(&rule->mutex);
4474 reduce_timeout(idle_timeout, &rule->idle_timeout);
4475 reduce_timeout(hard_timeout, &rule->hard_timeout);
4476 ovs_mutex_unlock(&rule->mutex);
4480 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4481 OVS_EXCLUDED(ofproto_mutex)
4483 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4484 struct ofputil_flow_mod fm;
4485 uint64_t ofpacts_stub[1024 / 8];
4486 struct ofpbuf ofpacts;
4489 error = reject_slave_controller(ofconn);
4494 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4495 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4497 u16_to_ofp(ofproto->max_ports),
4500 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4503 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4506 goto exit_free_ofpacts;
4509 ofconn_report_flow_mod(ofconn, fm.command);
4512 ofpbuf_uninit(&ofpacts);
4518 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4519 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4520 OVS_EXCLUDED(ofproto_mutex)
4524 ovs_mutex_lock(&ofproto_mutex);
4525 if (ofproto->n_pending < 50) {
4526 switch (fm->command) {
4528 error = add_flow(ofproto, ofconn, fm, oh);
4532 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4535 case OFPFC_MODIFY_STRICT:
4536 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4540 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4543 case OFPFC_DELETE_STRICT:
4544 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4548 if (fm->command > 0xff) {
4549 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4550 "flow_mod_table_id extension is not enabled",
4553 error = OFPERR_OFPFMFC_BAD_COMMAND;
4557 ovs_assert(!list_is_empty(&ofproto->pending));
4558 error = OFPROTO_POSTPONE;
4560 ovs_mutex_unlock(&ofproto_mutex);
4562 run_rule_executes(ofproto);
4567 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4569 struct ofputil_role_request request;
4570 struct ofputil_role_request reply;
4574 error = ofputil_decode_role_message(oh, &request);
4579 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4580 if (ofconn_get_role(ofconn) != request.role
4581 && ofconn_has_pending_opgroups(ofconn)) {
4582 return OFPROTO_POSTPONE;
4585 if (request.have_generation_id
4586 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4587 return OFPERR_OFPRRFC_STALE;
4590 ofconn_set_role(ofconn, request.role);
4593 reply.role = ofconn_get_role(ofconn);
4594 reply.have_generation_id = ofconn_get_master_election_id(
4595 ofconn, &reply.generation_id);
4596 buf = ofputil_encode_role_reply(oh, &reply);
4597 ofconn_send_reply(ofconn, buf);
4603 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4604 const struct ofp_header *oh)
4606 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4607 enum ofputil_protocol cur, next;
4609 cur = ofconn_get_protocol(ofconn);
4610 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4611 ofconn_set_protocol(ofconn, next);
4617 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4619 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4620 enum ofputil_protocol cur, next;
4621 enum ofputil_protocol next_base;
4623 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4625 return OFPERR_OFPBRC_EPERM;
4628 cur = ofconn_get_protocol(ofconn);
4629 next = ofputil_protocol_set_base(cur, next_base);
4630 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4631 /* Avoid sending async messages in surprising protocol. */
4632 return OFPROTO_POSTPONE;
4635 ofconn_set_protocol(ofconn, next);
4640 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4641 const struct ofp_header *oh)
4643 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4646 format = ntohl(msg->format);
4647 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4648 return OFPERR_OFPBRC_EPERM;
4651 if (format != ofconn_get_packet_in_format(ofconn)
4652 && ofconn_has_pending_opgroups(ofconn)) {
4653 /* Avoid sending async message in surprsing packet in format. */
4654 return OFPROTO_POSTPONE;
4657 ofconn_set_packet_in_format(ofconn, format);
4662 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4664 const struct nx_async_config *msg = ofpmsg_body(oh);
4665 uint32_t master[OAM_N_TYPES];
4666 uint32_t slave[OAM_N_TYPES];
4668 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4669 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4670 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4672 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4673 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4674 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4676 ofconn_set_async_config(ofconn, master, slave);
4677 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4678 !ofconn_get_miss_send_len(ofconn)) {
4679 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4686 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4689 uint32_t master[OAM_N_TYPES];
4690 uint32_t slave[OAM_N_TYPES];
4691 struct nx_async_config *msg;
4693 ofconn_get_async_config(ofconn, master, slave);
4694 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4695 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4697 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4698 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4699 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4701 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4702 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4703 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4705 ofconn_send_reply(ofconn, buf);
4711 handle_nxt_set_controller_id(struct ofconn *ofconn,
4712 const struct ofp_header *oh)
4714 const struct nx_controller_id *nci = ofpmsg_body(oh);
4716 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4717 return OFPERR_NXBRC_MUST_BE_ZERO;
4720 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4725 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4729 if (ofconn_has_pending_opgroups(ofconn)) {
4730 return OFPROTO_POSTPONE;
4733 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4734 ? OFPRAW_OFPT10_BARRIER_REPLY
4735 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4736 ofconn_send_reply(ofconn, buf);
4741 ofproto_compose_flow_refresh_update(const struct rule *rule,
4742 enum nx_flow_monitor_flags flags,
4744 OVS_REQUIRES(ofproto_mutex)
4746 struct ofoperation *op = rule->pending;
4747 const struct rule_actions *actions;
4748 struct ofputil_flow_update fu;
4751 if (op && op->type == OFOPERATION_ADD) {
4752 /* We'll report the final flow when the operation completes. Reporting
4753 * it now would cause a duplicate report later. */
4757 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4758 ? NXFME_ADDED : NXFME_MODIFIED);
4760 ovs_mutex_lock(&rule->mutex);
4761 fu.idle_timeout = rule->idle_timeout;
4762 fu.hard_timeout = rule->hard_timeout;
4763 ovs_mutex_unlock(&rule->mutex);
4764 fu.table_id = rule->table_id;
4765 fu.cookie = rule->flow_cookie;
4766 minimatch_expand(&rule->cr.match, &match);
4768 fu.priority = rule->cr.priority;
4770 if (!(flags & NXFMF_ACTIONS)) {
4773 actions = rule_get_actions(rule);
4775 /* An operation is in progress. Use the previous version of the flow's
4776 * actions, so that when the operation commits we report the change. */
4778 case OFOPERATION_ADD:
4781 case OFOPERATION_MODIFY:
4782 case OFOPERATION_REPLACE:
4783 actions = op->actions ? op->actions : rule_get_actions(rule);
4786 case OFOPERATION_DELETE:
4787 actions = rule_get_actions(rule);
4794 fu.ofpacts = actions ? actions->ofpacts : NULL;
4795 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4797 if (list_is_empty(msgs)) {
4798 ofputil_start_flow_update(msgs);
4800 ofputil_append_flow_update(&fu, msgs);
4804 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4806 OVS_REQUIRES(ofproto_mutex)
4810 for (i = 0; i < rules->n; i++) {
4811 struct rule *rule = rules->rules[i];
4812 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4813 rule->monitor_flags = 0;
4815 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4820 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4821 struct rule *rule, uint64_t seqno,
4822 struct rule_collection *rules)
4823 OVS_REQUIRES(ofproto_mutex)
4825 enum nx_flow_monitor_flags update;
4827 if (ofproto_rule_is_hidden(rule)) {
4832 ? ofoperation_has_out_port(rule->pending, m->out_port)
4833 : ofproto_rule_has_out_port(rule, m->out_port))) {
4838 if (rule->add_seqno > seqno) {
4839 update = NXFMF_ADD | NXFMF_MODIFY;
4840 } else if (rule->modify_seqno > seqno) {
4841 update = NXFMF_MODIFY;
4846 if (!(m->flags & update)) {
4850 update = NXFMF_INITIAL;
4853 if (!rule->monitor_flags) {
4854 rule_collection_add(rules, rule);
4856 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4860 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4862 struct rule_collection *rules)
4863 OVS_REQUIRES(ofproto_mutex)
4865 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4866 const struct ofoperation *op;
4867 const struct oftable *table;
4868 struct cls_rule target;
4870 cls_rule_init_from_minimatch(&target, &m->match, 0);
4871 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4872 struct cls_cursor cursor;
4875 fat_rwlock_rdlock(&table->cls.rwlock);
4876 cls_cursor_init(&cursor, &table->cls, &target);
4877 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4878 ovs_assert(!rule->pending); /* XXX */
4879 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4881 fat_rwlock_unlock(&table->cls.rwlock);
4884 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4885 struct rule *rule = op->rule;
4887 if (((m->table_id == 0xff
4888 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4889 : m->table_id == rule->table_id))
4890 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4891 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4894 cls_rule_destroy(&target);
4898 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4899 struct rule_collection *rules)
4900 OVS_REQUIRES(ofproto_mutex)
4902 if (m->flags & NXFMF_INITIAL) {
4903 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4908 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4909 uint64_t seqno, struct rule_collection *rules)
4910 OVS_REQUIRES(ofproto_mutex)
4912 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4916 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4917 OVS_EXCLUDED(ofproto_mutex)
4919 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4920 struct ofmonitor **monitors;
4921 size_t n_monitors, allocated_monitors;
4922 struct rule_collection rules;
4923 struct list replies;
4929 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4931 n_monitors = allocated_monitors = 0;
4933 ovs_mutex_lock(&ofproto_mutex);
4935 struct ofputil_flow_monitor_request request;
4936 struct ofmonitor *m;
4939 retval = ofputil_decode_flow_monitor_request(&request, &b);
4940 if (retval == EOF) {
4942 } else if (retval) {
4947 if (request.table_id != 0xff
4948 && request.table_id >= ofproto->n_tables) {
4949 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4953 error = ofmonitor_create(&request, ofconn, &m);
4958 if (n_monitors >= allocated_monitors) {
4959 monitors = x2nrealloc(monitors, &allocated_monitors,
4962 monitors[n_monitors++] = m;
4965 rule_collection_init(&rules);
4966 for (i = 0; i < n_monitors; i++) {
4967 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4970 ofpmp_init(&replies, oh);
4971 ofmonitor_compose_refresh_updates(&rules, &replies);
4972 ovs_mutex_unlock(&ofproto_mutex);
4974 rule_collection_destroy(&rules);
4976 ofconn_send_replies(ofconn, &replies);
4982 for (i = 0; i < n_monitors; i++) {
4983 ofmonitor_destroy(monitors[i]);
4986 ovs_mutex_unlock(&ofproto_mutex);
4992 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4993 OVS_EXCLUDED(ofproto_mutex)
4995 struct ofmonitor *m;
4999 id = ofputil_decode_flow_monitor_cancel(oh);
5001 ovs_mutex_lock(&ofproto_mutex);
5002 m = ofmonitor_lookup(ofconn, id);
5004 ofmonitor_destroy(m);
5007 error = OFPERR_NXBRC_FM_BAD_ID;
5009 ovs_mutex_unlock(&ofproto_mutex);
5014 /* Meters implementation.
5016 * Meter table entry, indexed by the OpenFlow meter_id.
5017 * These are always dynamically allocated to allocate enough space for
5019 * 'created' is used to compute the duration for meter stats.
5020 * 'list rules' is needed so that we can delete the dependent rules when the
5021 * meter table entry is deleted.
5022 * 'provider_meter_id' is for the provider's private use.
5025 long long int created; /* Time created. */
5026 struct list rules; /* List of "struct rule_dpif"s. */
5027 ofproto_meter_id provider_meter_id;
5028 uint16_t flags; /* Meter flags. */
5029 uint16_t n_bands; /* Number of meter bands. */
5030 struct ofputil_meter_band *bands;
5034 * This is used in instruction validation at flow set-up time,
5035 * as flows may not use non-existing meters.
5036 * Return value of UINT32_MAX signifies an invalid meter.
5039 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5041 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5042 const struct meter *meter = ofproto->meters[of_meter_id];
5044 return meter->provider_meter_id.uint32;
5051 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5055 meter->flags = config->flags;
5056 meter->n_bands = config->n_bands;
5057 meter->bands = xmemdup(config->bands,
5058 config->n_bands * sizeof *meter->bands);
5061 static struct meter *
5062 meter_create(const struct ofputil_meter_config *config,
5063 ofproto_meter_id provider_meter_id)
5065 struct meter *meter;
5067 meter = xzalloc(sizeof *meter);
5068 meter->provider_meter_id = provider_meter_id;
5069 meter->created = time_msec();
5070 list_init(&meter->rules);
5072 meter_update(meter, config);
5078 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5079 OVS_REQUIRES(ofproto_mutex)
5082 for (mid = first; mid <= last; ++mid) {
5083 struct meter *meter = ofproto->meters[mid];
5085 ofproto->meters[mid] = NULL;
5086 ofproto->ofproto_class->meter_del(ofproto,
5087 meter->provider_meter_id);
5095 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5097 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5098 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5102 return OFPERR_OFPMMFC_METER_EXISTS;
5105 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5108 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5109 *meterp = meter_create(&mm->meter, provider_meter_id);
5115 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5117 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5119 uint32_t provider_meter_id;
5122 return OFPERR_OFPMMFC_UNKNOWN_METER;
5125 provider_meter_id = meter->provider_meter_id.uint32;
5126 error = ofproto->ofproto_class->meter_set(ofproto,
5127 &meter->provider_meter_id,
5129 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5131 meter_update(meter, &mm->meter);
5137 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5138 struct ofputil_meter_mod *mm)
5139 OVS_EXCLUDED(ofproto_mutex)
5141 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5142 uint32_t meter_id = mm->meter.meter_id;
5143 struct rule_collection rules;
5144 enum ofperr error = 0;
5145 uint32_t first, last;
5147 if (meter_id == OFPM13_ALL) {
5149 last = ofproto->meter_features.max_meters;
5151 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5154 first = last = meter_id;
5157 /* First delete the rules that use this meter. If any of those rules are
5158 * currently being modified, postpone the whole operation until later. */
5159 rule_collection_init(&rules);
5160 ovs_mutex_lock(&ofproto_mutex);
5161 for (meter_id = first; meter_id <= last; ++meter_id) {
5162 struct meter *meter = ofproto->meters[meter_id];
5163 if (meter && !list_is_empty(&meter->rules)) {
5166 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5167 if (rule->pending) {
5168 error = OFPROTO_POSTPONE;
5171 rule_collection_add(&rules, rule);
5176 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5179 /* Delete the meters. */
5180 meter_delete(ofproto, first, last);
5183 ovs_mutex_unlock(&ofproto_mutex);
5184 rule_collection_destroy(&rules);
5190 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5192 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5193 struct ofputil_meter_mod mm;
5194 uint64_t bands_stub[256 / 8];
5195 struct ofpbuf bands;
5199 error = reject_slave_controller(ofconn);
5204 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5206 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5208 goto exit_free_bands;
5211 meter_id = mm.meter.meter_id;
5213 if (mm.command != OFPMC13_DELETE) {
5214 /* Fails also when meters are not implemented by the provider. */
5215 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5216 error = OFPERR_OFPMMFC_INVALID_METER;
5217 goto exit_free_bands;
5218 } else if (meter_id > ofproto->meter_features.max_meters) {
5219 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5220 goto exit_free_bands;
5222 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5223 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5224 goto exit_free_bands;
5228 switch (mm.command) {
5230 error = handle_add_meter(ofproto, &mm);
5233 case OFPMC13_MODIFY:
5234 error = handle_modify_meter(ofproto, &mm);
5237 case OFPMC13_DELETE:
5238 error = handle_delete_meter(ofconn, oh, &mm);
5242 error = OFPERR_OFPMMFC_BAD_COMMAND;
5247 ofpbuf_uninit(&bands);
5252 handle_meter_features_request(struct ofconn *ofconn,
5253 const struct ofp_header *request)
5255 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5256 struct ofputil_meter_features features;
5259 if (ofproto->ofproto_class->meter_get_features) {
5260 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5262 memset(&features, 0, sizeof features);
5264 b = ofputil_encode_meter_features_reply(&features, request);
5266 ofconn_send_reply(ofconn, b);
5271 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5274 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5275 struct list replies;
5276 uint64_t bands_stub[256 / 8];
5277 struct ofpbuf bands;
5278 uint32_t meter_id, first, last;
5280 ofputil_decode_meter_request(request, &meter_id);
5282 if (meter_id == OFPM13_ALL) {
5284 last = ofproto->meter_features.max_meters;
5286 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5287 !ofproto->meters[meter_id]) {
5288 return OFPERR_OFPMMFC_UNKNOWN_METER;
5290 first = last = meter_id;
5293 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5294 ofpmp_init(&replies, request);
5296 for (meter_id = first; meter_id <= last; ++meter_id) {
5297 struct meter *meter = ofproto->meters[meter_id];
5299 continue; /* Skip non-existing meters. */
5301 if (type == OFPTYPE_METER_STATS_REQUEST) {
5302 struct ofputil_meter_stats stats;
5304 stats.meter_id = meter_id;
5306 /* Provider sets the packet and byte counts, we do the rest. */
5307 stats.flow_count = list_size(&meter->rules);
5308 calc_duration(meter->created, time_msec(),
5309 &stats.duration_sec, &stats.duration_nsec);
5310 stats.n_bands = meter->n_bands;
5311 ofpbuf_clear(&bands);
5313 = ofpbuf_put_uninit(&bands,
5314 meter->n_bands * sizeof *stats.bands);
5316 if (!ofproto->ofproto_class->meter_get(ofproto,
5317 meter->provider_meter_id,
5319 ofputil_append_meter_stats(&replies, &stats);
5321 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5322 struct ofputil_meter_config config;
5324 config.meter_id = meter_id;
5325 config.flags = meter->flags;
5326 config.n_bands = meter->n_bands;
5327 config.bands = meter->bands;
5328 ofputil_append_meter_config(&replies, &config);
5332 ofconn_send_replies(ofconn, &replies);
5333 ofpbuf_uninit(&bands);
5338 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5339 struct ofgroup **group)
5340 OVS_TRY_RDLOCK(true, (*group)->rwlock)
5342 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5343 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5344 hash_int(group_id, 0), &ofproto->groups) {
5345 if ((*group)->group_id == group_id) {
5346 ovs_rwlock_rdlock(&(*group)->rwlock);
5347 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5351 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5356 ofproto_group_release(struct ofgroup *group)
5357 OVS_RELEASES(group->rwlock)
5359 ovs_rwlock_unlock(&group->rwlock);
5363 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
5364 struct ofgroup **group)
5365 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
5366 OVS_TRY_WRLOCK(true, (*group)->rwlock)
5368 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5369 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5370 hash_int(group_id, 0), &ofproto->groups) {
5371 if ((*group)->group_id == group_id) {
5372 ovs_rwlock_wrlock(&(*group)->rwlock);
5376 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5381 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5382 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5384 struct ofgroup *grp;
5386 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5387 hash_int(group_id, 0), &ofproto->groups) {
5388 if (grp->group_id == group_id) {
5396 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5397 OVS_EXCLUDED(ofproto->groups_rwlock)
5401 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5402 exists = ofproto_group_exists__(ofproto, group_id);
5403 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5409 group_get_ref_count(struct ofgroup *group)
5410 OVS_EXCLUDED(ofproto_mutex)
5412 struct ofproto *ofproto = group->ofproto;
5413 struct rule_criteria criteria;
5414 struct rule_collection rules;
5419 match_init_catchall(&match);
5420 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5421 OFPP_ANY, group->group_id);
5422 ovs_mutex_lock(&ofproto_mutex);
5423 error = collect_rules_loose(ofproto, &criteria, &rules);
5424 ovs_mutex_unlock(&ofproto_mutex);
5425 rule_criteria_destroy(&criteria);
5427 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5429 rule_collection_destroy(&rules);
5434 append_group_stats(struct ofgroup *group, struct list *replies)
5435 OVS_REQ_RDLOCK(group->rwlock)
5437 struct ofputil_group_stats ogs;
5438 struct ofproto *ofproto = group->ofproto;
5439 long long int now = time_msec();
5442 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5444 /* Provider sets the packet and byte counts, we do the rest. */
5445 ogs.ref_count = group_get_ref_count(group);
5446 ogs.n_buckets = group->n_buckets;
5448 error = (ofproto->ofproto_class->group_get_stats
5449 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5452 ogs.packet_count = UINT64_MAX;
5453 ogs.byte_count = UINT64_MAX;
5454 memset(ogs.bucket_stats, 0xff,
5455 ogs.n_buckets * sizeof *ogs.bucket_stats);
5458 ogs.group_id = group->group_id;
5459 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5461 ofputil_append_group_stats(replies, &ogs);
5463 free(ogs.bucket_stats);
5467 handle_group_request(struct ofconn *ofconn,
5468 const struct ofp_header *request, uint32_t group_id,
5469 void (*cb)(struct ofgroup *, struct list *replies))
5471 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5472 struct ofgroup *group;
5473 struct list replies;
5475 ofpmp_init(&replies, request);
5476 if (group_id == OFPG_ALL) {
5477 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5478 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5479 ovs_rwlock_rdlock(&group->rwlock);
5480 cb(group, &replies);
5481 ovs_rwlock_unlock(&group->rwlock);
5483 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5485 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5486 cb(group, &replies);
5487 ofproto_group_release(group);
5490 ofconn_send_replies(ofconn, &replies);
5494 handle_group_stats_request(struct ofconn *ofconn,
5495 const struct ofp_header *request)
5500 error = ofputil_decode_group_stats_request(request, &group_id);
5505 handle_group_request(ofconn, request, group_id, append_group_stats);
5510 append_group_desc(struct ofgroup *group, struct list *replies)
5512 struct ofputil_group_desc gds;
5514 gds.group_id = group->group_id;
5515 gds.type = group->type;
5516 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5520 handle_group_desc_stats_request(struct ofconn *ofconn,
5521 const struct ofp_header *request)
5523 handle_group_request(ofconn, request,
5524 ofputil_decode_group_desc_request(request),
5530 handle_group_features_stats_request(struct ofconn *ofconn,
5531 const struct ofp_header *request)
5533 struct ofproto *p = ofconn_get_ofproto(ofconn);
5536 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5538 ofconn_send_reply(ofconn, msg);
5545 handle_queue_get_config_request(struct ofconn *ofconn,
5546 const struct ofp_header *oh)
5548 struct ofproto *p = ofconn_get_ofproto(ofconn);
5549 struct netdev_queue_dump queue_dump;
5550 struct ofport *ofport;
5551 unsigned int queue_id;
5552 struct ofpbuf *reply;
5553 struct smap details;
5557 error = ofputil_decode_queue_get_config_request(oh, &request);
5562 ofport = ofproto_get_port(p, request);
5564 return OFPERR_OFPQOFC_BAD_PORT;
5567 reply = ofputil_encode_queue_get_config_reply(oh);
5569 smap_init(&details);
5570 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5571 struct ofputil_queue_config queue;
5573 /* None of the existing queues have compatible properties, so we
5574 * hard-code omitting min_rate and max_rate. */
5575 queue.queue_id = queue_id;
5576 queue.min_rate = UINT16_MAX;
5577 queue.max_rate = UINT16_MAX;
5578 ofputil_append_queue_get_config_reply(reply, &queue);
5580 smap_destroy(&details);
5582 ofconn_send_reply(ofconn, reply);
5587 /* Implements OFPGC11_ADD
5588 * in which no matching flow already exists in the flow table.
5590 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5591 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5592 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5593 * initiated now but may be retried later.
5595 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5596 * ownership remains with the caller.
5598 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5601 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5603 struct ofgroup *ofgroup;
5606 if (gm->group_id > OFPG_MAX) {
5607 return OFPERR_OFPGMFC_INVALID_GROUP;
5609 if (gm->type > OFPGT11_FF) {
5610 return OFPERR_OFPGMFC_BAD_TYPE;
5613 /* Allocate new group and initialize it. */
5614 ofgroup = ofproto->ofproto_class->group_alloc();
5616 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
5617 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5620 ovs_rwlock_init(&ofgroup->rwlock);
5621 ofgroup->ofproto = ofproto;
5622 ofgroup->group_id = gm->group_id;
5623 ofgroup->type = gm->type;
5624 ofgroup->created = ofgroup->modified = time_msec();
5626 list_move(&ofgroup->buckets, &gm->buckets);
5627 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5629 /* Construct called BEFORE any locks are held. */
5630 error = ofproto->ofproto_class->group_construct(ofgroup);
5635 /* We wrlock as late as possible to minimize the time we jam any other
5636 * threads: No visible state changes before acquiring the lock. */
5637 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5639 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5640 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5644 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5645 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5650 /* Insert new group. */
5651 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5652 hash_int(ofgroup->group_id, 0));
5653 ofproto->n_groups[ofgroup->type]++;
5655 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5660 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5661 ofproto->ofproto_class->group_destruct(ofgroup);
5663 ofputil_bucket_list_destroy(&ofgroup->buckets);
5664 ofproto->ofproto_class->group_dealloc(ofgroup);
5669 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5672 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5675 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5677 struct ofgroup *ofgroup;
5678 struct ofgroup *victim;
5681 if (gm->group_id > OFPG_MAX) {
5682 return OFPERR_OFPGMFC_INVALID_GROUP;
5685 if (gm->type > OFPGT11_FF) {
5686 return OFPERR_OFPGMFC_BAD_TYPE;
5689 victim = ofproto->ofproto_class->group_alloc();
5691 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5692 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5695 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5696 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5699 /* Both group's and its container's write locks held now.
5700 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5701 if (ofgroup->type != gm->type
5702 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5703 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5708 list_move(&victim->buckets, &ofgroup->buckets);
5710 ofgroup->type = gm->type;
5711 list_move(&ofgroup->buckets, &gm->buckets);
5712 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5714 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5716 ofputil_bucket_list_destroy(&victim->buckets);
5717 ofproto->n_groups[victim->type]--;
5718 ofproto->n_groups[ofgroup->type]++;
5719 ofgroup->modified = time_msec();
5721 ofputil_bucket_list_destroy(&ofgroup->buckets);
5724 list_move(&ofgroup->buckets, &victim->buckets);
5728 ovs_rwlock_unlock(&ofgroup->rwlock);
5729 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5731 ofproto->ofproto_class->group_dealloc(victim);
5736 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5737 OVS_RELEASES(ofproto->groups_rwlock)
5740 struct ofputil_flow_mod fm;
5742 /* Delete all flow entries containing this group in a group action */
5743 match_init_catchall(&match);
5744 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5745 fm.out_group = ofgroup->group_id;
5746 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5748 /* Must wait until existing readers are done,
5749 * while holding the container's write lock at the same time. */
5750 ovs_rwlock_wrlock(&ofgroup->rwlock);
5751 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5752 /* No-one can find this group any more. */
5753 ofproto->n_groups[ofgroup->type]--;
5754 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5756 ofproto->ofproto_class->group_destruct(ofgroup);
5757 ofputil_bucket_list_destroy(&ofgroup->buckets);
5758 ovs_rwlock_unlock(&ofgroup->rwlock);
5759 ovs_rwlock_destroy(&ofgroup->rwlock);
5760 ofproto->ofproto_class->group_dealloc(ofgroup);
5763 /* Implements OFPGC_DELETE. */
5765 delete_group(struct ofproto *ofproto, uint32_t group_id)
5767 struct ofgroup *ofgroup;
5769 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5770 if (group_id == OFPG_ALL) {
5772 struct hmap_node *node = hmap_first(&ofproto->groups);
5776 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5777 delete_group__(ofproto, ofgroup);
5778 /* Lock for each node separately, so that we will not jam the
5779 * other threads for too long time. */
5780 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5783 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5784 hash_int(group_id, 0), &ofproto->groups) {
5785 if (ofgroup->group_id == group_id) {
5786 delete_group__(ofproto, ofgroup);
5791 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5795 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5797 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5798 struct ofputil_group_mod gm;
5801 error = reject_slave_controller(ofconn);
5806 error = ofputil_decode_group_mod(oh, &gm);
5811 switch (gm.command) {
5813 return add_group(ofproto, &gm);
5815 case OFPGC11_MODIFY:
5816 return modify_group(ofproto, &gm);
5818 case OFPGC11_DELETE:
5819 delete_group(ofproto, gm.group_id);
5823 if (gm.command > OFPGC11_DELETE) {
5824 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5825 ofproto->name, gm.command);
5827 return OFPERR_OFPGMFC_BAD_COMMAND;
5831 enum ofproto_table_config
5832 ofproto_table_get_config(const struct ofproto *ofproto, uint8_t table_id)
5835 atomic_read(&ofproto->tables[table_id].config, &value);
5836 return (enum ofproto_table_config)value;
5840 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5842 /* Only accept currently supported configurations */
5843 if (tm->config & ~OFPTC11_TABLE_MISS_MASK) {
5844 return OFPERR_OFPTMFC_BAD_CONFIG;
5847 if (tm->table_id == OFPTT_ALL) {
5849 for (i = 0; i < ofproto->n_tables; i++) {
5850 atomic_store(&ofproto->tables[i].config,
5851 (unsigned int)tm->config);
5853 } else if (!check_table_id(ofproto, tm->table_id)) {
5854 return OFPERR_OFPTMFC_BAD_TABLE;
5856 atomic_store(&ofproto->tables[tm->table_id].config,
5857 (unsigned int)tm->config);
5864 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5866 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5867 struct ofputil_table_mod tm;
5870 error = reject_slave_controller(ofconn);
5875 error = ofputil_decode_table_mod(oh, &tm);
5880 return table_mod(ofproto, &tm);
5884 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
5887 struct ofputil_bundle_ctrl_msg bctrl;
5889 struct ofputil_bundle_ctrl_msg reply;
5891 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
5896 reply.bundle_id = bctrl.bundle_id;
5898 switch (bctrl.type) {
5899 case OFPBCT_OPEN_REQUEST:
5900 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
5901 reply.type = OFPBCT_OPEN_REPLY;
5903 case OFPBCT_CLOSE_REQUEST:
5904 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
5905 reply.type = OFPBCT_CLOSE_REPLY;;
5907 case OFPBCT_COMMIT_REQUEST:
5908 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
5909 reply.type = OFPBCT_COMMIT_REPLY;
5911 case OFPBCT_DISCARD_REQUEST:
5912 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
5913 reply.type = OFPBCT_DISCARD_REPLY;
5916 case OFPBCT_OPEN_REPLY:
5917 case OFPBCT_CLOSE_REPLY:
5918 case OFPBCT_COMMIT_REPLY:
5919 case OFPBCT_DISCARD_REPLY:
5920 return OFPERR_OFPBFC_BAD_TYPE;
5925 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
5926 ofconn_send_reply(ofconn, buf);
5933 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
5936 struct ofputil_bundle_add_msg badd;
5938 error = ofputil_decode_bundle_add(oh, &badd);
5943 return ofp_bundle_add_message(ofconn, &badd);
5947 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5948 OVS_EXCLUDED(ofproto_mutex)
5950 const struct ofp_header *oh = ofpbuf_data(msg);
5954 error = ofptype_decode(&type, oh);
5958 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5959 && ofpmp_more(oh)) {
5960 /* We have no buffer implementation for multipart requests.
5961 * Report overflow for requests which consists of multiple
5963 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5967 /* OpenFlow requests. */
5968 case OFPTYPE_ECHO_REQUEST:
5969 return handle_echo_request(ofconn, oh);
5971 case OFPTYPE_FEATURES_REQUEST:
5972 return handle_features_request(ofconn, oh);
5974 case OFPTYPE_GET_CONFIG_REQUEST:
5975 return handle_get_config_request(ofconn, oh);
5977 case OFPTYPE_SET_CONFIG:
5978 return handle_set_config(ofconn, oh);
5980 case OFPTYPE_PACKET_OUT:
5981 return handle_packet_out(ofconn, oh);
5983 case OFPTYPE_PORT_MOD:
5984 return handle_port_mod(ofconn, oh);
5986 case OFPTYPE_FLOW_MOD:
5987 return handle_flow_mod(ofconn, oh);
5989 case OFPTYPE_GROUP_MOD:
5990 return handle_group_mod(ofconn, oh);
5992 case OFPTYPE_TABLE_MOD:
5993 return handle_table_mod(ofconn, oh);
5995 case OFPTYPE_METER_MOD:
5996 return handle_meter_mod(ofconn, oh);
5998 case OFPTYPE_BARRIER_REQUEST:
5999 return handle_barrier_request(ofconn, oh);
6001 case OFPTYPE_ROLE_REQUEST:
6002 return handle_role_request(ofconn, oh);
6004 /* OpenFlow replies. */
6005 case OFPTYPE_ECHO_REPLY:
6008 /* Nicira extension requests. */
6009 case OFPTYPE_FLOW_MOD_TABLE_ID:
6010 return handle_nxt_flow_mod_table_id(ofconn, oh);
6012 case OFPTYPE_SET_FLOW_FORMAT:
6013 return handle_nxt_set_flow_format(ofconn, oh);
6015 case OFPTYPE_SET_PACKET_IN_FORMAT:
6016 return handle_nxt_set_packet_in_format(ofconn, oh);
6018 case OFPTYPE_SET_CONTROLLER_ID:
6019 return handle_nxt_set_controller_id(ofconn, oh);
6021 case OFPTYPE_FLOW_AGE:
6022 /* Nothing to do. */
6025 case OFPTYPE_FLOW_MONITOR_CANCEL:
6026 return handle_flow_monitor_cancel(ofconn, oh);
6028 case OFPTYPE_SET_ASYNC_CONFIG:
6029 return handle_nxt_set_async_config(ofconn, oh);
6031 case OFPTYPE_GET_ASYNC_REQUEST:
6032 return handle_nxt_get_async_request(ofconn, oh);
6034 /* Statistics requests. */
6035 case OFPTYPE_DESC_STATS_REQUEST:
6036 return handle_desc_stats_request(ofconn, oh);
6038 case OFPTYPE_FLOW_STATS_REQUEST:
6039 return handle_flow_stats_request(ofconn, oh);
6041 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6042 return handle_aggregate_stats_request(ofconn, oh);
6044 case OFPTYPE_TABLE_STATS_REQUEST:
6045 return handle_table_stats_request(ofconn, oh);
6047 case OFPTYPE_PORT_STATS_REQUEST:
6048 return handle_port_stats_request(ofconn, oh);
6050 case OFPTYPE_QUEUE_STATS_REQUEST:
6051 return handle_queue_stats_request(ofconn, oh);
6053 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6054 return handle_port_desc_stats_request(ofconn, oh);
6056 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6057 return handle_flow_monitor_request(ofconn, oh);
6059 case OFPTYPE_METER_STATS_REQUEST:
6060 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6061 return handle_meter_request(ofconn, oh, type);
6063 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6064 return handle_meter_features_request(ofconn, oh);
6066 case OFPTYPE_GROUP_STATS_REQUEST:
6067 return handle_group_stats_request(ofconn, oh);
6069 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6070 return handle_group_desc_stats_request(ofconn, oh);
6072 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6073 return handle_group_features_stats_request(ofconn, oh);
6075 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6076 return handle_queue_get_config_request(ofconn, oh);
6078 case OFPTYPE_BUNDLE_CONTROL:
6079 return handle_bundle_control(ofconn, oh);
6081 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6082 return handle_bundle_add(ofconn, oh);
6086 case OFPTYPE_FEATURES_REPLY:
6087 case OFPTYPE_GET_CONFIG_REPLY:
6088 case OFPTYPE_PACKET_IN:
6089 case OFPTYPE_FLOW_REMOVED:
6090 case OFPTYPE_PORT_STATUS:
6091 case OFPTYPE_BARRIER_REPLY:
6092 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6093 case OFPTYPE_DESC_STATS_REPLY:
6094 case OFPTYPE_FLOW_STATS_REPLY:
6095 case OFPTYPE_QUEUE_STATS_REPLY:
6096 case OFPTYPE_PORT_STATS_REPLY:
6097 case OFPTYPE_TABLE_STATS_REPLY:
6098 case OFPTYPE_AGGREGATE_STATS_REPLY:
6099 case OFPTYPE_PORT_DESC_STATS_REPLY:
6100 case OFPTYPE_ROLE_REPLY:
6101 case OFPTYPE_FLOW_MONITOR_PAUSED:
6102 case OFPTYPE_FLOW_MONITOR_RESUMED:
6103 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6104 case OFPTYPE_GET_ASYNC_REPLY:
6105 case OFPTYPE_GROUP_STATS_REPLY:
6106 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6107 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6108 case OFPTYPE_METER_STATS_REPLY:
6109 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6110 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6111 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6112 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6113 case OFPTYPE_ROLE_STATUS:
6115 if (ofpmsg_is_stat_request(oh)) {
6116 return OFPERR_OFPBRC_BAD_STAT;
6118 return OFPERR_OFPBRC_BAD_TYPE;
6124 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6125 OVS_EXCLUDED(ofproto_mutex)
6127 int error = handle_openflow__(ofconn, ofp_msg);
6128 if (error && error != OFPROTO_POSTPONE) {
6129 ofconn_send_error(ofconn, ofpbuf_data(ofp_msg), error);
6131 COVERAGE_INC(ofproto_recv_openflow);
6132 return error != OFPROTO_POSTPONE;
6135 /* Asynchronous operations. */
6137 /* Creates and returns a new ofopgroup that is not associated with any
6138 * OpenFlow connection.
6140 * The caller should add operations to the returned group with
6141 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6142 static struct ofopgroup *
6143 ofopgroup_create_unattached(struct ofproto *ofproto)
6144 OVS_REQUIRES(ofproto_mutex)
6146 struct ofopgroup *group = xzalloc(sizeof *group);
6147 group->ofproto = ofproto;
6148 list_init(&group->ofproto_node);
6149 list_init(&group->ops);
6150 list_init(&group->ofconn_node);
6154 /* Creates and returns a new ofopgroup for 'ofproto'.
6156 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6157 * connection. The 'request' and 'buffer_id' arguments are ignored.
6159 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6160 * If the ofopgroup eventually fails, then the error reply will include
6161 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6162 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6164 * The caller should add operations to the returned group with
6165 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6166 static struct ofopgroup *
6167 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6168 const struct ofp_header *request, uint32_t buffer_id)
6169 OVS_REQUIRES(ofproto_mutex)
6171 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6173 size_t request_len = ntohs(request->length);
6175 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6177 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6178 group->ofconn = ofconn;
6179 group->request = xmemdup(request, MIN(request_len, 64));
6180 group->buffer_id = buffer_id;
6185 /* Submits 'group' for processing.
6187 * If 'group' contains no operations (e.g. none were ever added, or all of the
6188 * ones that were added completed synchronously), then it is destroyed
6189 * immediately. Otherwise it is added to the ofproto's list of pending
6192 ofopgroup_submit(struct ofopgroup *group)
6193 OVS_REQUIRES(ofproto_mutex)
6195 if (!group->n_running) {
6196 ofopgroup_complete(group);
6198 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6199 group->ofproto->n_pending++;
6204 ofopgroup_complete(struct ofopgroup *group)
6205 OVS_REQUIRES(ofproto_mutex)
6207 struct ofproto *ofproto = group->ofproto;
6209 struct ofconn *abbrev_ofconn;
6210 ovs_be32 abbrev_xid;
6212 struct ofoperation *op, *next_op;
6215 ovs_assert(!group->n_running);
6218 LIST_FOR_EACH (op, group_node, &group->ops) {
6225 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6226 LIST_FOR_EACH (op, group_node, &group->ops) {
6227 if (op->type != OFOPERATION_DELETE) {
6228 struct ofpbuf *packet;
6231 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6234 struct rule_execute *re;
6238 ofproto_rule_ref(op->rule);
6240 re = xmalloc(sizeof *re);
6241 re->rule = op->rule;
6242 re->in_port = in_port;
6243 re->packet = packet;
6245 if (!guarded_list_push_back(&ofproto->rule_executes,
6246 &re->list_node, 1024)) {
6247 ofproto_rule_unref(op->rule);
6248 ofpbuf_delete(re->packet);
6257 if (!error && !list_is_empty(&group->ofconn_node)) {
6258 abbrev_ofconn = group->ofconn;
6259 abbrev_xid = group->request->xid;
6261 abbrev_ofconn = NULL;
6262 abbrev_xid = htonl(0);
6264 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6265 struct rule *rule = op->rule;
6267 /* We generally want to report the change to active OpenFlow flow
6268 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6270 - The operation failed.
6272 - The affected rule is not visible to controllers.
6274 - The operation's only effect was to update rule->modified. */
6276 || ofproto_rule_is_hidden(rule)
6277 || (op->type == OFOPERATION_MODIFY
6279 && rule->flow_cookie == op->flow_cookie))) {
6280 /* Check that we can just cast from ofoperation_type to
6281 * nx_flow_update_event. */
6282 enum nx_flow_update_event event_type;
6285 case OFOPERATION_ADD:
6286 case OFOPERATION_REPLACE:
6287 event_type = NXFME_ADDED;
6290 case OFOPERATION_DELETE:
6291 event_type = NXFME_DELETED;
6294 case OFOPERATION_MODIFY:
6295 event_type = NXFME_MODIFIED;
6302 ofmonitor_report(ofproto->connmgr, rule, event_type,
6303 op->reason, abbrev_ofconn, abbrev_xid);
6306 rule->pending = NULL;
6309 case OFOPERATION_ADD:
6313 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6314 if (vid_mask == VLAN_VID_MASK) {
6315 if (ofproto->vlan_bitmap) {
6316 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6317 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6318 bitmap_set1(ofproto->vlan_bitmap, vid);
6319 ofproto->vlans_changed = true;
6322 ofproto->vlans_changed = true;
6326 oftable_remove_rule(rule);
6327 ofproto_rule_unref(rule);
6331 case OFOPERATION_DELETE:
6332 ovs_assert(!op->error);
6333 ofproto_rule_unref(rule);
6337 case OFOPERATION_MODIFY:
6338 case OFOPERATION_REPLACE:
6340 long long int now = time_msec();
6342 ovs_mutex_lock(&rule->mutex);
6343 rule->modified = now;
6344 if (op->type == OFOPERATION_REPLACE) {
6345 rule->created = now;
6347 ovs_mutex_unlock(&rule->mutex);
6349 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6350 ovs_mutex_lock(&rule->mutex);
6351 rule->idle_timeout = op->idle_timeout;
6352 rule->hard_timeout = op->hard_timeout;
6353 ovs_mutex_unlock(&rule->mutex);
6355 const struct rule_actions *old_actions;
6357 ovs_mutex_lock(&rule->mutex);
6358 old_actions = rule_get_actions(rule);
6359 ovsrcu_set(&rule->actions, op->actions);
6360 ovs_mutex_unlock(&rule->mutex);
6363 rule_actions_destroy(old_actions);
6365 rule->flags = op->flags;
6373 ofoperation_destroy(op);
6376 ofmonitor_flush(ofproto->connmgr);
6378 if (!list_is_empty(&group->ofproto_node)) {
6379 ovs_assert(ofproto->n_pending > 0);
6380 ofproto->n_pending--;
6381 list_remove(&group->ofproto_node);
6383 if (!list_is_empty(&group->ofconn_node)) {
6384 list_remove(&group->ofconn_node);
6386 ofconn_send_error(group->ofconn, group->request, error);
6388 connmgr_retry(ofproto->connmgr);
6390 free(group->request);
6394 /* Initiates a new operation on 'rule', of the specified 'type', within
6395 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6397 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6398 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6400 * Returns the newly created ofoperation (which is also available as
6401 * rule->pending). */
6402 static struct ofoperation *
6403 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6404 enum ofoperation_type type,
6405 enum ofp_flow_removed_reason reason)
6406 OVS_REQUIRES(ofproto_mutex)
6408 struct ofproto *ofproto = group->ofproto;
6409 struct ofoperation *op;
6411 ovs_assert(!rule->pending);
6413 op = rule->pending = xzalloc(sizeof *op);
6415 list_push_back(&group->ops, &op->group_node);
6418 op->reason = reason;
6419 op->flow_cookie = rule->flow_cookie;
6420 ovs_mutex_lock(&rule->mutex);
6421 op->idle_timeout = rule->idle_timeout;
6422 op->hard_timeout = rule->hard_timeout;
6423 ovs_mutex_unlock(&rule->mutex);
6424 op->flags = rule->flags;
6428 if (type == OFOPERATION_DELETE) {
6429 hmap_insert(&ofproto->deletions, &op->hmap_node,
6430 cls_rule_hash(&rule->cr, rule->table_id));
6437 ofoperation_destroy(struct ofoperation *op)
6438 OVS_REQUIRES(ofproto_mutex)
6440 struct ofopgroup *group = op->group;
6443 op->rule->pending = NULL;
6445 if (op->type == OFOPERATION_DELETE) {
6446 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6448 list_remove(&op->group_node);
6449 rule_actions_destroy(op->actions);
6453 /* Indicates that 'op' completed with status 'error', which is either 0 to
6454 * indicate success or an OpenFlow error code on failure.
6456 * If 'error' is 0, indicating success, the operation will be committed
6457 * permanently to the flow table.
6459 * If 'error' is nonzero, then generally the operation will be rolled back:
6461 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6462 * restores the original rule. The caller must have uninitialized any
6463 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6464 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6465 * and 7 for the new rule, calling its ->rule_dealloc() function.
6467 * - If 'op' is a "modify flow" operation, ofproto restores the original
6470 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6471 * allowed to fail. It must always succeed.
6473 * Please see the large comment in ofproto/ofproto-provider.h titled
6474 * "Asynchronous Operation Support" for more information. */
6476 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6478 struct ofopgroup *group = op->group;
6480 ovs_assert(group->n_running > 0);
6481 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6484 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6485 /* This function can be called from ->rule_construct(), in which case
6486 * ofproto_mutex is held, or it can be called from ->run(), in which
6487 * case ofproto_mutex is not held. But only in the latter case can we
6488 * arrive here, so we can safely take ofproto_mutex now. */
6489 ovs_mutex_lock(&ofproto_mutex);
6490 ovs_assert(op->rule->pending == op);
6491 ofopgroup_complete(group);
6492 ovs_mutex_unlock(&ofproto_mutex);
6497 pick_datapath_id(const struct ofproto *ofproto)
6499 const struct ofport *port;
6501 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6503 uint8_t ea[ETH_ADDR_LEN];
6506 error = netdev_get_etheraddr(port->netdev, ea);
6508 return eth_addr_to_uint64(ea);
6510 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6511 ofproto->name, netdev_get_name(port->netdev),
6512 ovs_strerror(error));
6514 return ofproto->fallback_dpid;
6518 pick_fallback_dpid(void)
6520 uint8_t ea[ETH_ADDR_LEN];
6521 eth_addr_nicira_random(ea);
6522 return eth_addr_to_uint64(ea);
6525 /* Table overflow policy. */
6527 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6528 * to NULL if the table is not configured to evict rules or if the table
6529 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6530 * or with no timeouts are not evictable.) */
6532 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6533 OVS_REQUIRES(ofproto_mutex)
6535 struct eviction_group *evg;
6538 if (!table->eviction_fields) {
6542 /* In the common case, the outer and inner loops here will each be entered
6545 * - The inner loop normally "return"s in its first iteration. If the
6546 * eviction group has any evictable rules, then it always returns in
6549 * - The outer loop only iterates more than once if the largest eviction
6550 * group has no evictable rules.
6552 * - The outer loop can exit only if table's 'max_flows' is all filled up
6553 * by unevictable rules. */
6554 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6557 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6566 /* Searches 'ofproto' for tables that have more flows than their configured
6567 * maximum and that have flow eviction enabled, and evicts as many flows as
6568 * necessary and currently feasible from them.
6570 * This triggers only when an OpenFlow table has N flows in it and then the
6571 * client configures a maximum number of flows less than N. */
6573 ofproto_evict(struct ofproto *ofproto)
6575 struct oftable *table;
6577 ovs_mutex_lock(&ofproto_mutex);
6578 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6579 evict_rules_from_table(ofproto, table, 0);
6581 ovs_mutex_unlock(&ofproto_mutex);
6584 /* Eviction groups. */
6586 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6587 * rules. The priority contains low-order random bits to ensure that eviction
6588 * groups with the same number of rules are prioritized randomly. */
6590 eviction_group_priority(size_t n_rules)
6592 uint16_t size = MIN(UINT16_MAX, n_rules);
6593 return (size << 16) | random_uint16();
6596 /* Updates 'evg', an eviction_group within 'table', following a change that
6597 * adds or removes rules in 'evg'. */
6599 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6600 OVS_REQUIRES(ofproto_mutex)
6602 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6603 eviction_group_priority(heap_count(&evg->rules)));
6606 /* Destroys 'evg', an eviction_group within 'table':
6608 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6609 * rules themselves, just removes them from the eviction group.)
6611 * - Removes 'evg' from 'table'.
6615 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6616 OVS_REQUIRES(ofproto_mutex)
6618 while (!heap_is_empty(&evg->rules)) {
6621 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6622 rule->eviction_group = NULL;
6624 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6625 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6626 heap_destroy(&evg->rules);
6630 /* Removes 'rule' from its eviction group, if any. */
6632 eviction_group_remove_rule(struct rule *rule)
6633 OVS_REQUIRES(ofproto_mutex)
6635 if (rule->eviction_group) {
6636 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6637 struct eviction_group *evg = rule->eviction_group;
6639 rule->eviction_group = NULL;
6640 heap_remove(&evg->rules, &rule->evg_node);
6641 if (heap_is_empty(&evg->rules)) {
6642 eviction_group_destroy(table, evg);
6644 eviction_group_resized(table, evg);
6649 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6650 * returns the hash value. */
6652 eviction_group_hash_rule(struct rule *rule)
6653 OVS_REQUIRES(ofproto_mutex)
6655 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6656 const struct mf_subfield *sf;
6660 hash = table->eviction_group_id_basis;
6661 miniflow_expand(&rule->cr.match.flow, &flow);
6662 for (sf = table->eviction_fields;
6663 sf < &table->eviction_fields[table->n_eviction_fields];
6666 if (mf_are_prereqs_ok(sf->field, &flow)) {
6667 union mf_value value;
6669 mf_get_value(sf->field, &flow, &value);
6671 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6673 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6674 unsigned int start = sf->ofs + sf->n_bits;
6675 bitwise_zero(&value, sf->field->n_bytes, start,
6676 sf->field->n_bytes * 8 - start);
6678 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6680 hash = hash_int(hash, 0);
6687 /* Returns an eviction group within 'table' with the given 'id', creating one
6689 static struct eviction_group *
6690 eviction_group_find(struct oftable *table, uint32_t id)
6691 OVS_REQUIRES(ofproto_mutex)
6693 struct eviction_group *evg;
6695 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6699 evg = xmalloc(sizeof *evg);
6700 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6701 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6702 eviction_group_priority(0));
6703 heap_init(&evg->rules);
6708 /* Returns an eviction priority for 'rule'. The return value should be
6709 * interpreted so that higher priorities make a rule more attractive candidates
6711 * Called only if have a timeout. */
6713 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6714 OVS_REQUIRES(ofproto_mutex)
6716 long long int expiration = LLONG_MAX;
6717 long long int modified;
6718 uint32_t expiration_offset;
6720 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6721 ovs_mutex_lock(&rule->mutex);
6722 modified = rule->modified;
6723 ovs_mutex_unlock(&rule->mutex);
6725 if (rule->hard_timeout) {
6726 expiration = modified + rule->hard_timeout * 1000;
6728 if (rule->idle_timeout) {
6729 uint64_t packets, bytes;
6731 long long int idle_expiration;
6733 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6734 idle_expiration = used + rule->idle_timeout * 1000;
6735 expiration = MIN(expiration, idle_expiration);
6738 if (expiration == LLONG_MAX) {
6742 /* Calculate the time of expiration as a number of (approximate) seconds
6743 * after program startup.
6745 * This should work OK for program runs that last UINT32_MAX seconds or
6746 * less. Therefore, please restart OVS at least once every 136 years. */
6747 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6749 /* Invert the expiration offset because we're using a max-heap. */
6750 return UINT32_MAX - expiration_offset;
6753 /* Adds 'rule' to an appropriate eviction group for its oftable's
6754 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6755 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6758 * The caller must ensure that 'rule' is not already in an eviction group. */
6760 eviction_group_add_rule(struct rule *rule)
6761 OVS_REQUIRES(ofproto_mutex)
6763 struct ofproto *ofproto = rule->ofproto;
6764 struct oftable *table = &ofproto->tables[rule->table_id];
6767 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6768 * so no additional protection is needed. */
6769 has_timeout = rule->hard_timeout || rule->idle_timeout;
6771 if (table->eviction_fields && has_timeout) {
6772 struct eviction_group *evg;
6774 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6776 rule->eviction_group = evg;
6777 heap_insert(&evg->rules, &rule->evg_node,
6778 rule_eviction_priority(ofproto, rule));
6779 eviction_group_resized(table, evg);
6785 /* Initializes 'table'. */
6787 oftable_init(struct oftable *table)
6789 memset(table, 0, sizeof *table);
6790 classifier_init(&table->cls, flow_segment_u32s);
6791 table->max_flows = UINT_MAX;
6792 atomic_init(&table->config, (unsigned int)OFPROTO_TABLE_MISS_DEFAULT);
6795 /* Destroys 'table', including its classifier and eviction groups.
6797 * The caller is responsible for freeing 'table' itself. */
6799 oftable_destroy(struct oftable *table)
6801 fat_rwlock_rdlock(&table->cls.rwlock);
6802 ovs_assert(classifier_is_empty(&table->cls));
6803 fat_rwlock_unlock(&table->cls.rwlock);
6804 oftable_disable_eviction(table);
6805 classifier_destroy(&table->cls);
6809 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6810 * string, then 'table' will use its default name.
6812 * This only affects the name exposed for a table exposed through the OpenFlow
6813 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6815 oftable_set_name(struct oftable *table, const char *name)
6817 if (name && name[0]) {
6818 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6819 if (!table->name || strncmp(name, table->name, len)) {
6821 table->name = xmemdup0(name, len);
6829 /* oftables support a choice of two policies when adding a rule would cause the
6830 * number of flows in the table to exceed the configured maximum number: either
6831 * they can refuse to add the new flow or they can evict some existing flow.
6832 * This function configures the former policy on 'table'. */
6834 oftable_disable_eviction(struct oftable *table)
6835 OVS_REQUIRES(ofproto_mutex)
6837 if (table->eviction_fields) {
6838 struct eviction_group *evg, *next;
6840 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6841 &table->eviction_groups_by_id) {
6842 eviction_group_destroy(table, evg);
6844 hmap_destroy(&table->eviction_groups_by_id);
6845 heap_destroy(&table->eviction_groups_by_size);
6847 free(table->eviction_fields);
6848 table->eviction_fields = NULL;
6849 table->n_eviction_fields = 0;
6853 /* oftables support a choice of two policies when adding a rule would cause the
6854 * number of flows in the table to exceed the configured maximum number: either
6855 * they can refuse to add the new flow or they can evict some existing flow.
6856 * This function configures the latter policy on 'table', with fairness based
6857 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6858 * 'n_fields' as 0 disables fairness.) */
6860 oftable_enable_eviction(struct oftable *table,
6861 const struct mf_subfield *fields, size_t n_fields)
6862 OVS_REQUIRES(ofproto_mutex)
6864 struct cls_cursor cursor;
6867 if (table->eviction_fields
6868 && n_fields == table->n_eviction_fields
6870 || !memcmp(fields, table->eviction_fields,
6871 n_fields * sizeof *fields))) {
6876 oftable_disable_eviction(table);
6878 table->n_eviction_fields = n_fields;
6879 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6881 table->eviction_group_id_basis = random_uint32();
6882 hmap_init(&table->eviction_groups_by_id);
6883 heap_init(&table->eviction_groups_by_size);
6885 fat_rwlock_rdlock(&table->cls.rwlock);
6886 cls_cursor_init(&cursor, &table->cls, NULL);
6887 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6888 eviction_group_add_rule(rule);
6890 fat_rwlock_unlock(&table->cls.rwlock);
6893 /* Removes 'rule' from the oftable that contains it. */
6895 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6896 OVS_REQUIRES(ofproto_mutex)
6898 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6900 fat_rwlock_wrlock(&cls->rwlock);
6901 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6902 fat_rwlock_unlock(&cls->rwlock);
6904 cookies_remove(ofproto, rule);
6906 eviction_group_remove_rule(rule);
6907 if (!list_is_empty(&rule->expirable)) {
6908 list_remove(&rule->expirable);
6910 if (!list_is_empty(&rule->meter_list_node)) {
6911 list_remove(&rule->meter_list_node);
6912 list_init(&rule->meter_list_node);
6917 oftable_remove_rule(struct rule *rule)
6918 OVS_REQUIRES(ofproto_mutex)
6920 oftable_remove_rule__(rule->ofproto, rule);
6923 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6924 * the same cls_rule. */
6926 oftable_insert_rule(struct rule *rule)
6927 OVS_REQUIRES(ofproto_mutex)
6929 struct ofproto *ofproto = rule->ofproto;
6930 struct oftable *table = &ofproto->tables[rule->table_id];
6931 const struct rule_actions *actions;
6934 ovs_mutex_lock(&rule->mutex);
6935 may_expire = rule->hard_timeout || rule->idle_timeout;
6936 ovs_mutex_unlock(&rule->mutex);
6939 list_insert(&ofproto->expirable, &rule->expirable);
6942 cookies_insert(ofproto, rule);
6944 actions = rule_get_actions(rule);
6945 if (actions->provider_meter_id != UINT32_MAX) {
6946 uint32_t meter_id = ofpacts_get_meter(actions->ofpacts,
6947 actions->ofpacts_len);
6948 struct meter *meter = ofproto->meters[meter_id];
6949 list_insert(&meter->rules, &rule->meter_list_node);
6951 fat_rwlock_wrlock(&table->cls.rwlock);
6952 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6953 fat_rwlock_unlock(&table->cls.rwlock);
6954 eviction_group_add_rule(rule);
6957 /* unixctl commands. */
6960 ofproto_lookup(const char *name)
6962 struct ofproto *ofproto;
6964 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6966 if (!strcmp(ofproto->name, name)) {
6974 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6975 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6977 struct ofproto *ofproto;
6981 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6982 ds_put_format(&results, "%s\n", ofproto->name);
6984 unixctl_command_reply(conn, ds_cstr(&results));
6985 ds_destroy(&results);
6989 ofproto_unixctl_init(void)
6991 static bool registered;
6997 unixctl_command_register("ofproto/list", "", 0, 0,
6998 ofproto_unixctl_list, NULL);
7001 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7003 * This is deprecated. It is only for compatibility with broken device drivers
7004 * in old versions of Linux that do not properly support VLANs when VLAN
7005 * devices are not used. When broken device drivers are no longer in
7006 * widespread use, we will delete these interfaces. */
7008 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7009 * (exactly) by an OpenFlow rule in 'ofproto'. */
7011 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7014 struct cls_rule target;
7015 const struct oftable *oftable;
7017 match_init_catchall(&match);
7018 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7019 cls_rule_init(&target, &match, 0);
7021 free(ofproto->vlan_bitmap);
7022 ofproto->vlan_bitmap = bitmap_allocate(4096);
7023 ofproto->vlans_changed = false;
7025 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7026 struct cls_cursor cursor;
7029 fat_rwlock_rdlock(&oftable->cls.rwlock);
7030 cls_cursor_init(&cursor, &oftable->cls, &target);
7031 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
7032 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7033 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7035 bitmap_set1(vlan_bitmap, vid);
7036 bitmap_set1(ofproto->vlan_bitmap, vid);
7039 fat_rwlock_unlock(&oftable->cls.rwlock);
7043 /* Returns true if new VLANs have come into use by the flow table since the
7044 * last call to ofproto_get_vlan_usage().
7046 * We don't track when old VLANs stop being used. */
7048 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7050 return ofproto->vlans_changed;
7053 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7054 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7055 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7056 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7057 * then the VLAN device is un-enslaved. */
7059 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7060 ofp_port_t realdev_ofp_port, int vid)
7062 struct ofport *ofport;
7065 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7067 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7069 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7070 ofproto->name, vlandev_ofp_port);
7074 if (!ofproto->ofproto_class->set_realdev) {
7075 if (!vlandev_ofp_port) {
7078 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7082 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7084 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7085 ofproto->name, vlandev_ofp_port,
7086 netdev_get_name(ofport->netdev), ovs_strerror(error));