2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 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"
49 #include "poll-loop.h"
57 #include "unaligned.h"
61 VLOG_DEFINE_THIS_MODULE(ofproto);
63 COVERAGE_DEFINE(ofproto_flush);
64 COVERAGE_DEFINE(ofproto_packet_out);
65 COVERAGE_DEFINE(ofproto_queue_req);
66 COVERAGE_DEFINE(ofproto_recv_openflow);
67 COVERAGE_DEFINE(ofproto_reinit_ports);
68 COVERAGE_DEFINE(ofproto_update_port);
71 S_OPENFLOW, /* Processing OpenFlow commands. */
72 S_EVICT, /* Evicting flows from over-limit tables. */
73 S_FLUSH, /* Deleting all flow table rules. */
76 enum ofoperation_type {
83 /* A single OpenFlow request can execute any number of operations. The
84 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
85 * ofconn to which an error reply should be sent if necessary.
87 * ofproto initiates some operations internally. These operations are still
88 * assigned to groups but will not have an associated ofconn. */
90 struct ofproto *ofproto; /* Owning ofproto. */
91 struct list ofproto_node; /* In ofproto's "pending" list. */
92 struct list ops; /* List of "struct ofoperation"s. */
93 int n_running; /* Number of ops still pending. */
95 /* Data needed to send OpenFlow reply on failure or to send a buffered
98 * If list_is_empty(ofconn_node) then this ofopgroup never had an
99 * associated ofconn or its ofconn's connection dropped after it initiated
100 * the operation. In the latter case 'ofconn' is a wild pointer that
101 * refers to freed memory, so the 'ofconn' member must be used only if
102 * !list_is_empty(ofconn_node).
104 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
105 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
106 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
107 uint32_t buffer_id; /* Buffer id from original request. */
110 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
111 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
112 const struct ofp_header *,
114 static void ofopgroup_submit(struct ofopgroup *);
115 static void ofopgroup_complete(struct ofopgroup *);
117 /* A single flow table operation. */
119 struct ofopgroup *group; /* Owning group. */
120 struct list group_node; /* In ofopgroup's "ops" list. */
121 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
122 struct rule *rule; /* Rule being operated upon. */
123 enum ofoperation_type type; /* Type of operation. */
125 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
127 struct rule_actions *actions;
129 /* OFOPERATION_DELETE. */
130 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
132 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
133 uint16_t idle_timeout; /* Rule's old idle timeout. */
134 uint16_t hard_timeout; /* Rule's old hard timeout. */
135 enum ofputil_flow_mod_flags flags; /* Rule's old flags. */
136 enum ofperr error; /* 0 if no error. */
139 static struct ofoperation *ofoperation_create(struct ofopgroup *,
141 enum ofoperation_type,
142 enum ofp_flow_removed_reason);
143 static void ofoperation_destroy(struct ofoperation *);
146 static void oftable_init(struct oftable *);
147 static void oftable_destroy(struct oftable *);
149 static void oftable_set_name(struct oftable *, const char *name);
151 static void oftable_disable_eviction(struct oftable *);
152 static void oftable_enable_eviction(struct oftable *,
153 const struct mf_subfield *fields,
156 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
157 static void oftable_remove_rule__(struct ofproto *, struct rule *)
158 OVS_REQUIRES(ofproto_mutex);
159 static void oftable_insert_rule(struct rule *);
161 /* A set of rules within a single OpenFlow table (oftable) that have the same
162 * values for the oftable's eviction_fields. A rule to be evicted, when one is
163 * needed, is taken from the eviction group that contains the greatest number
166 * An oftable owns any number of eviction groups, each of which contains any
169 * Membership in an eviction group is imprecise, based on the hash of the
170 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
171 * That is, if two rules have different eviction_fields, but those
172 * eviction_fields hash to the same value, then they will belong to the same
173 * eviction_group anyway.
175 * (When eviction is not enabled on an oftable, we don't track any eviction
176 * groups, to save time and space.) */
177 struct eviction_group {
178 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
179 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
180 struct heap rules; /* Contains "struct rule"s. */
183 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep);
184 static void ofproto_evict(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
185 static uint32_t rule_eviction_priority(struct rule *);
186 static void eviction_group_add_rule(struct rule *);
187 static void eviction_group_remove_rule(struct rule *);
189 /* Criteria that flow_mod and other operations use for selecting rules on
190 * which to operate. */
191 struct rule_criteria {
192 /* An OpenFlow table or 255 for all tables. */
195 /* OpenFlow matching criteria. Interpreted different in "loose" way by
196 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
197 * defined in the OpenFlow spec. */
200 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
201 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
202 * The rule will not be selected if M is 1 and B != C. */
204 ovs_be64 cookie_mask;
206 /* Selection based on actions within a rule:
208 * If out_port != OFPP_ANY, selects only rules that output to out_port.
209 * If out_group != OFPG_ALL, select only rules that output to out_group. */
214 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
215 const struct match *match,
216 unsigned int priority,
217 ovs_be64 cookie, ovs_be64 cookie_mask,
218 ofp_port_t out_port, uint32_t out_group);
219 static void rule_criteria_destroy(struct rule_criteria *);
221 /* A packet that needs to be passed to rule_execute().
223 * (We can't do this immediately from ofopgroup_complete() because that holds
224 * ofproto_mutex, which rule_execute() needs released.) */
225 struct rule_execute {
226 struct list list_node; /* In struct ofproto's "rule_executes" list. */
227 struct rule *rule; /* Owns a reference to the rule. */
229 struct ofpbuf *packet; /* Owns the packet. */
232 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
233 static void destroy_rule_executes(struct ofproto *);
236 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
237 static void ofport_destroy(struct ofport *);
239 static void update_port(struct ofproto *, const char *devname);
240 static int init_ports(struct ofproto *);
241 static void reinit_ports(struct ofproto *);
243 static long long int ofport_get_usage(const struct ofproto *,
244 ofp_port_t ofp_port);
245 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
246 long long int last_used);
247 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
251 * Keeps track of the currently used and recently used ofport values and is
252 * used to prevent immediate recycling of ofport values. */
253 struct ofport_usage {
254 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
255 ofp_port_t ofp_port; /* OpenFlow port number. */
256 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
257 represents in-use ofports. */
261 static void ofproto_rule_destroy__(struct rule *);
262 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
263 static bool rule_is_modifiable(const struct rule *);
266 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
267 struct ofputil_flow_mod *,
268 const struct ofp_header *);
269 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
270 struct ofputil_flow_mod *,
271 const struct ofp_header *,
272 const struct rule_collection *);
273 static void delete_flow__(struct rule *rule, struct ofopgroup *,
274 enum ofp_flow_removed_reason)
275 OVS_REQUIRES(ofproto_mutex);
276 static bool ofproto_group_exists__(const struct ofproto *ofproto,
278 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
279 static bool ofproto_group_exists(const struct ofproto *ofproto,
281 OVS_EXCLUDED(ofproto->groups_rwlock);
282 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
283 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
284 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
285 struct ofputil_flow_mod *,
286 const struct ofp_header *)
287 OVS_EXCLUDED(ofproto_mutex);
288 static void calc_duration(long long int start, long long int now,
289 uint32_t *sec, uint32_t *nsec);
292 static uint64_t pick_datapath_id(const struct ofproto *);
293 static uint64_t pick_fallback_dpid(void);
294 static void ofproto_destroy__(struct ofproto *);
295 static void update_mtu(struct ofproto *, struct ofport *);
296 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
299 static void ofproto_unixctl_init(void);
301 /* All registered ofproto classes, in probe order. */
302 static const struct ofproto_class **ofproto_classes;
303 static size_t n_ofproto_classes;
304 static size_t allocated_ofproto_classes;
306 /* Global lock that protects all flow table operations. */
307 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
309 unsigned flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT;
310 unsigned n_handler_threads;
311 enum ofproto_flow_miss_model flow_miss_model = OFPROTO_HANDLE_MISS_AUTO;
313 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
314 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
316 /* Initial mappings of port to OpenFlow number mappings. */
317 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
319 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
321 /* The default value of true waits for flow restore. */
322 static bool flow_restore_wait = true;
324 /* Must be called to initialize the ofproto library.
326 * The caller may pass in 'iface_hints', which contains an shash of
327 * "iface_hint" elements indexed by the interface's name. The provider
328 * may use these hints to describe the startup configuration in order to
329 * reinitialize its state. The caller owns the provided data, so a
330 * provider will make copies of anything required. An ofproto provider
331 * will remove any existing state that is not described by the hint, and
332 * may choose to remove it all. */
334 ofproto_init(const struct shash *iface_hints)
336 struct shash_node *node;
339 ofproto_class_register(&ofproto_dpif_class);
341 /* Make a local copy, since we don't own 'iface_hints' elements. */
342 SHASH_FOR_EACH(node, iface_hints) {
343 const struct iface_hint *orig_hint = node->data;
344 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
345 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
347 new_hint->br_name = xstrdup(orig_hint->br_name);
348 new_hint->br_type = xstrdup(br_type);
349 new_hint->ofp_port = orig_hint->ofp_port;
351 shash_add(&init_ofp_ports, node->name, new_hint);
354 for (i = 0; i < n_ofproto_classes; i++) {
355 ofproto_classes[i]->init(&init_ofp_ports);
359 /* 'type' should be a normalized datapath type, as returned by
360 * ofproto_normalize_type(). Returns the corresponding ofproto_class
361 * structure, or a null pointer if there is none registered for 'type'. */
362 static const struct ofproto_class *
363 ofproto_class_find__(const char *type)
367 for (i = 0; i < n_ofproto_classes; i++) {
368 const struct ofproto_class *class = ofproto_classes[i];
373 class->enumerate_types(&types);
374 found = sset_contains(&types, type);
375 sset_destroy(&types);
381 VLOG_WARN("unknown datapath type %s", type);
385 /* Registers a new ofproto class. After successful registration, new ofprotos
386 * of that type can be created using ofproto_create(). */
388 ofproto_class_register(const struct ofproto_class *new_class)
392 for (i = 0; i < n_ofproto_classes; i++) {
393 if (ofproto_classes[i] == new_class) {
398 if (n_ofproto_classes >= allocated_ofproto_classes) {
399 ofproto_classes = x2nrealloc(ofproto_classes,
400 &allocated_ofproto_classes,
401 sizeof *ofproto_classes);
403 ofproto_classes[n_ofproto_classes++] = new_class;
407 /* Unregisters a datapath provider. 'type' must have been previously
408 * registered and not currently be in use by any ofprotos. After
409 * unregistration new datapaths of that type cannot be opened using
410 * ofproto_create(). */
412 ofproto_class_unregister(const struct ofproto_class *class)
416 for (i = 0; i < n_ofproto_classes; i++) {
417 if (ofproto_classes[i] == class) {
418 for (i++; i < n_ofproto_classes; i++) {
419 ofproto_classes[i - 1] = ofproto_classes[i];
425 VLOG_WARN("attempted to unregister an ofproto class that is not "
430 /* Clears 'types' and enumerates all registered ofproto types into it. The
431 * caller must first initialize the sset. */
433 ofproto_enumerate_types(struct sset *types)
438 for (i = 0; i < n_ofproto_classes; i++) {
439 ofproto_classes[i]->enumerate_types(types);
443 /* Returns the fully spelled out name for the given ofproto 'type'.
445 * Normalized type string can be compared with strcmp(). Unnormalized type
446 * string might be the same even if they have different spellings. */
448 ofproto_normalize_type(const char *type)
450 return type && type[0] ? type : "system";
453 /* Clears 'names' and enumerates the names of all known created ofprotos with
454 * the given 'type'. The caller must first initialize the sset. Returns 0 if
455 * successful, otherwise a positive errno value.
457 * Some kinds of datapaths might not be practically enumerable. This is not
458 * considered an error. */
460 ofproto_enumerate_names(const char *type, struct sset *names)
462 const struct ofproto_class *class = ofproto_class_find__(type);
463 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
467 ofproto_create(const char *datapath_name, const char *datapath_type,
468 struct ofproto **ofprotop)
470 const struct ofproto_class *class;
471 struct ofproto *ofproto;
477 ofproto_unixctl_init();
479 datapath_type = ofproto_normalize_type(datapath_type);
480 class = ofproto_class_find__(datapath_type);
482 VLOG_WARN("could not create datapath %s of unknown type %s",
483 datapath_name, datapath_type);
487 ofproto = class->alloc();
489 VLOG_ERR("failed to allocate datapath %s of type %s",
490 datapath_name, datapath_type);
495 ovs_mutex_lock(&ofproto_mutex);
496 memset(ofproto, 0, sizeof *ofproto);
497 ofproto->ofproto_class = class;
498 ofproto->name = xstrdup(datapath_name);
499 ofproto->type = xstrdup(datapath_type);
500 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
501 hash_string(ofproto->name, 0));
502 ofproto->datapath_id = 0;
503 ofproto->forward_bpdu = false;
504 ofproto->fallback_dpid = pick_fallback_dpid();
505 ofproto->mfr_desc = NULL;
506 ofproto->hw_desc = NULL;
507 ofproto->sw_desc = NULL;
508 ofproto->serial_desc = NULL;
509 ofproto->dp_desc = NULL;
510 ofproto->frag_handling = OFPC_FRAG_NORMAL;
511 hmap_init(&ofproto->ports);
512 hmap_init(&ofproto->ofport_usage);
513 shash_init(&ofproto->port_by_name);
514 simap_init(&ofproto->ofp_requests);
515 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
516 ofproto->eviction_group_timer = LLONG_MIN;
517 ofproto->tables = NULL;
518 ofproto->n_tables = 0;
519 hindex_init(&ofproto->cookies);
520 list_init(&ofproto->expirable);
521 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
522 ofproto->state = S_OPENFLOW;
523 list_init(&ofproto->pending);
524 ofproto->n_pending = 0;
525 hmap_init(&ofproto->deletions);
526 guarded_list_init(&ofproto->rule_executes);
527 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
528 ofproto->first_op = ofproto->last_op = LLONG_MIN;
529 ofproto->next_op_report = LLONG_MAX;
530 ofproto->op_backoff = LLONG_MIN;
531 ofproto->vlan_bitmap = NULL;
532 ofproto->vlans_changed = false;
533 ofproto->min_mtu = INT_MAX;
534 ovs_rwlock_init(&ofproto->groups_rwlock);
535 hmap_init(&ofproto->groups);
536 ovs_mutex_unlock(&ofproto_mutex);
537 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
538 OFPGFC_SELECT_WEIGHT;
539 ofproto->ogf.max_groups[OFPGT11_ALL] = OFPG_MAX;
540 ofproto->ogf.max_groups[OFPGT11_SELECT] = OFPG_MAX;
541 ofproto->ogf.max_groups[OFPGT11_INDIRECT] = OFPG_MAX;
542 ofproto->ogf.max_groups[OFPGT11_FF] = OFPG_MAX;
543 ofproto->ogf.actions[0] =
544 (1 << OFPAT11_OUTPUT) |
545 (1 << OFPAT11_COPY_TTL_OUT) |
546 (1 << OFPAT11_COPY_TTL_IN) |
547 (1 << OFPAT11_SET_MPLS_TTL) |
548 (1 << OFPAT11_DEC_MPLS_TTL) |
549 (1 << OFPAT11_PUSH_VLAN) |
550 (1 << OFPAT11_POP_VLAN) |
551 (1 << OFPAT11_PUSH_MPLS) |
552 (1 << OFPAT11_POP_MPLS) |
553 (1 << OFPAT11_SET_QUEUE) |
554 (1 << OFPAT11_GROUP) |
555 (1 << OFPAT11_SET_NW_TTL) |
556 (1 << OFPAT11_DEC_NW_TTL) |
557 (1 << OFPAT12_SET_FIELD);
559 * (1 << OFPAT13_PUSH_PBB) |
560 * (1 << OFPAT13_POP_PBB) */
562 error = ofproto->ofproto_class->construct(ofproto);
564 VLOG_ERR("failed to open datapath %s: %s",
565 datapath_name, ovs_strerror(error));
566 ofproto_destroy__(ofproto);
570 /* Check that hidden tables, if any, are at the end. */
571 ovs_assert(ofproto->n_tables);
572 for (i = 0; i + 1 < ofproto->n_tables; i++) {
573 enum oftable_flags flags = ofproto->tables[i].flags;
574 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
576 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
579 ofproto->datapath_id = pick_datapath_id(ofproto);
582 /* Initialize meters table. */
583 if (ofproto->ofproto_class->meter_get_features) {
584 ofproto->ofproto_class->meter_get_features(ofproto,
585 &ofproto->meter_features);
587 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
589 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
590 * sizeof(struct meter *));
596 /* Must be called (only) by an ofproto implementation in its constructor
597 * function. See the large comment on 'construct' in struct ofproto_class for
600 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
602 struct oftable *table;
604 ovs_assert(!ofproto->n_tables);
605 ovs_assert(n_tables >= 1 && n_tables <= 255);
607 ofproto->n_tables = n_tables;
608 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
609 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
614 /* To be optionally called (only) by an ofproto implementation in its
615 * constructor function. See the large comment on 'construct' in struct
616 * ofproto_class for details.
618 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
619 * will then ensure that actions passed into the ofproto implementation will
620 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
621 * function is not called, there will be no such restriction.
623 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
624 * the 'max_ports' restriction. */
626 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
628 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
629 ofproto->max_ports = max_ports;
633 ofproto_get_datapath_id(const struct ofproto *ofproto)
635 return ofproto->datapath_id;
639 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
641 uint64_t old_dpid = p->datapath_id;
642 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
643 if (p->datapath_id != old_dpid) {
644 /* Force all active connections to reconnect, since there is no way to
645 * notify a controller that the datapath ID has changed. */
646 ofproto_reconnect_controllers(p);
651 ofproto_set_controllers(struct ofproto *p,
652 const struct ofproto_controller *controllers,
653 size_t n_controllers, uint32_t allowed_versions)
655 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
660 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
662 connmgr_set_fail_mode(p->connmgr, fail_mode);
665 /* Drops the connections between 'ofproto' and all of its controllers, forcing
666 * them to reconnect. */
668 ofproto_reconnect_controllers(struct ofproto *ofproto)
670 connmgr_reconnect(ofproto->connmgr);
673 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
674 * in-band control should guarantee access, in the same way that in-band
675 * control guarantees access to OpenFlow controllers. */
677 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
678 const struct sockaddr_in *extras, size_t n)
680 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
683 /* Sets the OpenFlow queue used by flows set up by in-band control on
684 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
685 * flows will use the default queue. */
687 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
689 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
692 /* Sets the number of flows at which eviction from the kernel flow table
695 ofproto_set_flow_eviction_threshold(unsigned threshold)
697 flow_eviction_threshold = MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN,
701 /* Sets the path for handling flow misses. */
703 ofproto_set_flow_miss_model(unsigned model)
705 flow_miss_model = model;
708 /* If forward_bpdu is true, the NORMAL action will forward frames with
709 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
710 * the NORMAL action will drop these frames. */
712 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
714 bool old_val = ofproto->forward_bpdu;
715 ofproto->forward_bpdu = forward_bpdu;
716 if (old_val != ofproto->forward_bpdu) {
717 if (ofproto->ofproto_class->forward_bpdu_changed) {
718 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
723 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
724 * 'idle_time', in seconds, and the maximum number of MAC table entries to
727 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
730 if (ofproto->ofproto_class->set_mac_table_config) {
731 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
736 /* Sets number of upcall handler threads. The default is
737 * (number of online cores - 2). */
739 ofproto_set_n_handler_threads(unsigned limit)
742 n_handler_threads = limit;
744 int n_proc = count_cpu_cores();
745 n_handler_threads = n_proc > 2 ? n_proc - 2 : 1;
750 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
753 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
757 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
759 return connmgr_set_snoops(ofproto->connmgr, snoops);
763 ofproto_set_netflow(struct ofproto *ofproto,
764 const struct netflow_options *nf_options)
766 if (nf_options && sset_is_empty(&nf_options->collectors)) {
770 if (ofproto->ofproto_class->set_netflow) {
771 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
773 return nf_options ? EOPNOTSUPP : 0;
778 ofproto_set_sflow(struct ofproto *ofproto,
779 const struct ofproto_sflow_options *oso)
781 if (oso && sset_is_empty(&oso->targets)) {
785 if (ofproto->ofproto_class->set_sflow) {
786 return ofproto->ofproto_class->set_sflow(ofproto, oso);
788 return oso ? EOPNOTSUPP : 0;
793 ofproto_set_ipfix(struct ofproto *ofproto,
794 const struct ofproto_ipfix_bridge_exporter_options *bo,
795 const struct ofproto_ipfix_flow_exporter_options *fo,
798 if (ofproto->ofproto_class->set_ipfix) {
799 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
801 return (bo || fo) ? EOPNOTSUPP : 0;
806 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
808 flow_restore_wait = flow_restore_wait_db;
812 ofproto_get_flow_restore_wait(void)
814 return flow_restore_wait;
818 /* Spanning Tree Protocol (STP) configuration. */
820 /* Configures STP on 'ofproto' using the settings defined in 's'. If
821 * 's' is NULL, disables STP.
823 * Returns 0 if successful, otherwise a positive errno value. */
825 ofproto_set_stp(struct ofproto *ofproto,
826 const struct ofproto_stp_settings *s)
828 return (ofproto->ofproto_class->set_stp
829 ? ofproto->ofproto_class->set_stp(ofproto, s)
833 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
834 * 'enabled' member of 's' is false, then the other members are not
837 * Returns 0 if successful, otherwise a positive errno value. */
839 ofproto_get_stp_status(struct ofproto *ofproto,
840 struct ofproto_stp_status *s)
842 return (ofproto->ofproto_class->get_stp_status
843 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
847 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
848 * in 's'. The caller is responsible for assigning STP port numbers
849 * (using the 'port_num' member in the range of 1 through 255, inclusive)
850 * and ensuring there are no duplicates. If the 's' is NULL, then STP
851 * is disabled on the port.
853 * Returns 0 if successful, otherwise a positive errno value.*/
855 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
856 const struct ofproto_port_stp_settings *s)
858 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
860 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
861 ofproto->name, ofp_port);
865 return (ofproto->ofproto_class->set_stp_port
866 ? ofproto->ofproto_class->set_stp_port(ofport, s)
870 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
871 * 's'. If the 'enabled' member in 's' is false, then the other members
872 * are not meaningful.
874 * Returns 0 if successful, otherwise a positive errno value.*/
876 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
877 struct ofproto_port_stp_status *s)
879 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
881 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
882 "port %"PRIu16, ofproto->name, ofp_port);
886 return (ofproto->ofproto_class->get_stp_port_status
887 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
891 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
892 * 's'. If the 'enabled' member in 's' is false, then the other members
893 * are not meaningful.
895 * Returns 0 if successful, otherwise a positive errno value.*/
897 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
898 struct ofproto_port_stp_stats *s)
900 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
902 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
903 "port %"PRIu16, ofproto->name, ofp_port);
907 return (ofproto->ofproto_class->get_stp_port_stats
908 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
912 /* Queue DSCP configuration. */
914 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
915 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
916 * to implement QoS. Instead, it is used to implement features which require
917 * knowledge of what queues exist on a port, and some basic information about
920 * Returns 0 if successful, otherwise a positive errno value. */
922 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
923 const struct ofproto_port_queue *queues,
926 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
929 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
930 ofproto->name, ofp_port);
934 return (ofproto->ofproto_class->set_queues
935 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
939 /* Connectivity Fault Management configuration. */
941 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
943 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
945 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
946 if (ofport && ofproto->ofproto_class->set_cfm) {
947 ofproto->ofproto_class->set_cfm(ofport, NULL);
951 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
952 * basic configuration from the configuration members in 'cfm', and the remote
953 * maintenance point ID from remote_mpid. Ignores the statistics members of
956 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
958 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
959 const struct cfm_settings *s)
961 struct ofport *ofport;
964 ofport = ofproto_get_port(ofproto, ofp_port);
966 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
967 ofproto->name, ofp_port);
971 /* XXX: For configuration simplicity, we only support one remote_mpid
972 * outside of the CFM module. It's not clear if this is the correct long
973 * term solution or not. */
974 error = (ofproto->ofproto_class->set_cfm
975 ? ofproto->ofproto_class->set_cfm(ofport, s)
978 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
979 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
980 ovs_strerror(error));
984 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
985 * 'ofproto' does not have a port 'ofp_port'. */
987 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
988 const struct smap *cfg)
990 struct ofport *ofport;
993 ofport = ofproto_get_port(ofproto, ofp_port);
995 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
996 ofproto->name, ofp_port);
1000 error = (ofproto->ofproto_class->set_bfd
1001 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1004 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1005 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1006 ovs_strerror(error));
1010 /* Populates 'status' with key value pairs indicating the status of the BFD
1011 * session on 'ofp_port'. This information is intended to be populated in the
1012 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
1015 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1016 struct smap *status)
1018 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1019 return (ofport && ofproto->ofproto_class->get_bfd_status
1020 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1024 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1025 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1026 * 0 if LACP partner information is not current (generally indicating a
1027 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1029 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1031 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1032 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1033 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1039 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1040 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1041 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1042 * configuration plus, if there is more than one slave, a bonding
1045 * If 'aux' is already registered then this function updates its configuration
1046 * to 's'. Otherwise, this function registers a new bundle.
1048 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1051 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1052 const struct ofproto_bundle_settings *s)
1054 return (ofproto->ofproto_class->bundle_set
1055 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1059 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1060 * If no such bundle has been registered, this has no effect. */
1062 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1064 return ofproto_bundle_register(ofproto, aux, NULL);
1068 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1069 * If 'aux' is already registered then this function updates its configuration
1070 * to 's'. Otherwise, this function registers a new mirror. */
1072 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1073 const struct ofproto_mirror_settings *s)
1075 return (ofproto->ofproto_class->mirror_set
1076 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1080 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1081 * If no mirror has been registered, this has no effect. */
1083 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1085 return ofproto_mirror_register(ofproto, aux, NULL);
1088 /* Retrieves statistics from mirror associated with client data pointer
1089 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1090 * 'bytes', respectively. If a particular counters is not supported,
1091 * the appropriate argument is set to UINT64_MAX. */
1093 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1094 uint64_t *packets, uint64_t *bytes)
1096 if (!ofproto->ofproto_class->mirror_get_stats) {
1097 *packets = *bytes = UINT64_MAX;
1101 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1105 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1106 * which all packets are flooded, instead of using MAC learning. If
1107 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1109 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1112 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1114 return (ofproto->ofproto_class->set_flood_vlans
1115 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1119 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1120 * output for a mirror. */
1122 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1124 return (ofproto->ofproto_class->is_mirror_output_bundle
1125 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1129 /* Configuration of OpenFlow tables. */
1131 /* Returns the number of OpenFlow tables in 'ofproto'. */
1133 ofproto_get_n_tables(const struct ofproto *ofproto)
1135 return ofproto->n_tables;
1138 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1139 * settings from 's'. 'table_id' must be in the range 0 through the number of
1140 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1142 * For read-only tables, only the name may be configured. */
1144 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1145 const struct ofproto_table_settings *s)
1147 struct oftable *table;
1149 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1150 table = &ofproto->tables[table_id];
1152 oftable_set_name(table, s->name);
1154 if (table->flags & OFTABLE_READONLY) {
1159 oftable_enable_eviction(table, s->groups, s->n_groups);
1161 oftable_disable_eviction(table);
1164 table->max_flows = s->max_flows;
1165 ovs_rwlock_wrlock(&table->cls.rwlock);
1166 if (classifier_count(&table->cls) > table->max_flows
1167 && table->eviction_fields) {
1168 /* 'table' contains more flows than allowed. We might not be able to
1169 * evict them right away because of the asynchronous nature of flow
1170 * table changes. Schedule eviction for later. */
1171 switch (ofproto->state) {
1173 ofproto->state = S_EVICT;
1177 /* We're already deleting flows, nothing more to do. */
1182 classifier_set_prefix_fields(&table->cls,
1183 s->prefix_fields, s->n_prefix_fields);
1185 ovs_rwlock_unlock(&table->cls.rwlock);
1189 ofproto_has_snoops(const struct ofproto *ofproto)
1191 return connmgr_has_snoops(ofproto->connmgr);
1195 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1197 connmgr_get_snoops(ofproto->connmgr, snoops);
1201 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1203 OVS_REQUIRES(ofproto_mutex)
1205 struct ofopgroup *group;
1207 ovs_assert(!rule->pending);
1209 group = ofopgroup_create_unattached(ofproto);
1210 delete_flow__(rule, group, reason);
1211 ofopgroup_submit(group);
1214 /* Deletes 'rule' from 'cls' within 'ofproto'.
1216 * Within an ofproto implementation, this function allows an ofproto
1217 * implementation to destroy any rules that remain when its ->destruct()
1218 * function is called. This function is not suitable for use elsewhere in an
1219 * ofproto implementation.
1221 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1222 * Cycle" in ofproto-provider.h. */
1224 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1225 OVS_EXCLUDED(ofproto_mutex)
1227 struct ofopgroup *group;
1229 ovs_mutex_lock(&ofproto_mutex);
1230 ovs_assert(!rule->pending);
1232 group = ofopgroup_create_unattached(ofproto);
1233 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1234 oftable_remove_rule__(ofproto, rule);
1235 ofproto->ofproto_class->rule_delete(rule);
1236 ofopgroup_submit(group);
1238 ovs_mutex_unlock(&ofproto_mutex);
1242 ofproto_flush__(struct ofproto *ofproto)
1243 OVS_EXCLUDED(ofproto_mutex)
1245 struct oftable *table;
1247 if (ofproto->ofproto_class->flush) {
1248 ofproto->ofproto_class->flush(ofproto);
1251 ovs_mutex_lock(&ofproto_mutex);
1252 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1253 struct rule *rule, *next_rule;
1254 struct cls_cursor cursor;
1256 if (table->flags & OFTABLE_HIDDEN) {
1260 ovs_rwlock_rdlock(&table->cls.rwlock);
1261 cls_cursor_init(&cursor, &table->cls, NULL);
1262 ovs_rwlock_unlock(&table->cls.rwlock);
1263 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1264 if (!rule->pending) {
1265 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1269 ovs_mutex_unlock(&ofproto_mutex);
1272 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1275 ofproto_destroy__(struct ofproto *ofproto)
1276 OVS_EXCLUDED(ofproto_mutex)
1278 struct oftable *table;
1280 ovs_assert(list_is_empty(&ofproto->pending));
1282 destroy_rule_executes(ofproto);
1283 guarded_list_destroy(&ofproto->rule_executes);
1285 delete_group(ofproto, OFPG_ALL);
1286 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1287 hmap_destroy(&ofproto->groups);
1289 connmgr_destroy(ofproto->connmgr);
1291 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1292 free(ofproto->name);
1293 free(ofproto->type);
1294 free(ofproto->mfr_desc);
1295 free(ofproto->hw_desc);
1296 free(ofproto->sw_desc);
1297 free(ofproto->serial_desc);
1298 free(ofproto->dp_desc);
1299 hmap_destroy(&ofproto->ports);
1300 hmap_destroy(&ofproto->ofport_usage);
1301 shash_destroy(&ofproto->port_by_name);
1302 simap_destroy(&ofproto->ofp_requests);
1304 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1305 oftable_destroy(table);
1307 free(ofproto->tables);
1309 hmap_destroy(&ofproto->deletions);
1311 free(ofproto->vlan_bitmap);
1313 ofproto->ofproto_class->dealloc(ofproto);
1317 ofproto_destroy(struct ofproto *p)
1318 OVS_EXCLUDED(ofproto_mutex)
1320 struct ofport *ofport, *next_ofport;
1321 struct ofport_usage *usage, *next_usage;
1328 meter_delete(p, 1, p->meter_features.max_meters);
1329 p->meter_features.max_meters = 0;
1335 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1336 ofport_destroy(ofport);
1339 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1340 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1344 p->ofproto_class->destruct(p);
1345 ofproto_destroy__(p);
1348 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1349 * kernel datapath, for example, this destroys the datapath in the kernel, and
1350 * with the netdev-based datapath, it tears down the data structures that
1351 * represent the datapath.
1353 * The datapath should not be currently open as an ofproto. */
1355 ofproto_delete(const char *name, const char *type)
1357 const struct ofproto_class *class = ofproto_class_find__(type);
1358 return (!class ? EAFNOSUPPORT
1359 : !class->del ? EACCES
1360 : class->del(type, name));
1364 process_port_change(struct ofproto *ofproto, int error, char *devname)
1366 if (error == ENOBUFS) {
1367 reinit_ports(ofproto);
1368 } else if (!error) {
1369 update_port(ofproto, devname);
1375 ofproto_type_run(const char *datapath_type)
1377 const struct ofproto_class *class;
1380 datapath_type = ofproto_normalize_type(datapath_type);
1381 class = ofproto_class_find__(datapath_type);
1383 error = class->type_run ? class->type_run(datapath_type) : 0;
1384 if (error && error != EAGAIN) {
1385 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1386 datapath_type, ovs_strerror(error));
1392 ofproto_type_wait(const char *datapath_type)
1394 const struct ofproto_class *class;
1396 datapath_type = ofproto_normalize_type(datapath_type);
1397 class = ofproto_class_find__(datapath_type);
1399 if (class->type_wait) {
1400 class->type_wait(datapath_type);
1405 any_pending_ops(const struct ofproto *p)
1406 OVS_EXCLUDED(ofproto_mutex)
1410 ovs_mutex_lock(&ofproto_mutex);
1411 b = !list_is_empty(&p->pending);
1412 ovs_mutex_unlock(&ofproto_mutex);
1418 ofproto_run(struct ofproto *p)
1423 error = p->ofproto_class->run(p);
1424 if (error && error != EAGAIN) {
1425 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1428 run_rule_executes(p);
1430 /* Restore the eviction group heap invariant occasionally. */
1431 if (p->eviction_group_timer < time_msec()) {
1434 p->eviction_group_timer = time_msec() + 1000;
1436 for (i = 0; i < p->n_tables; i++) {
1437 struct oftable *table = &p->tables[i];
1438 struct eviction_group *evg;
1439 struct cls_cursor cursor;
1442 if (!table->eviction_fields) {
1446 ovs_mutex_lock(&ofproto_mutex);
1447 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1448 heap_rebuild(&evg->rules);
1451 ovs_rwlock_rdlock(&table->cls.rwlock);
1452 cls_cursor_init(&cursor, &table->cls, NULL);
1453 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1454 if (!rule->eviction_group
1455 && (rule->idle_timeout || rule->hard_timeout)) {
1456 eviction_group_add_rule(rule);
1459 ovs_rwlock_unlock(&table->cls.rwlock);
1460 ovs_mutex_unlock(&ofproto_mutex);
1464 if (p->ofproto_class->port_poll) {
1467 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1468 process_port_change(p, error, devname);
1472 new_seq = seq_read(connectivity_seq_get());
1473 if (new_seq != p->change_seq) {
1474 struct sset devnames;
1475 const char *devname;
1476 struct ofport *ofport;
1478 /* Update OpenFlow port status for any port whose netdev has changed.
1480 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1481 * destroyed, so it's not safe to update ports directly from the
1482 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1483 * need this two-phase approach. */
1484 sset_init(&devnames);
1485 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1486 sset_add(&devnames, netdev_get_name(ofport->netdev));
1488 SSET_FOR_EACH (devname, &devnames) {
1489 update_port(p, devname);
1491 sset_destroy(&devnames);
1493 p->change_seq = new_seq;
1498 connmgr_run(p->connmgr, handle_openflow);
1502 connmgr_run(p->connmgr, NULL);
1504 if (!any_pending_ops(p)) {
1505 p->state = S_OPENFLOW;
1510 connmgr_run(p->connmgr, NULL);
1512 if (!any_pending_ops(p)) {
1513 connmgr_flushed(p->connmgr);
1514 p->state = S_OPENFLOW;
1522 if (time_msec() >= p->next_op_report) {
1523 long long int ago = (time_msec() - p->first_op) / 1000;
1524 long long int interval = (p->last_op - p->first_op) / 1000;
1528 ds_put_format(&s, "%d flow_mods ",
1529 p->n_add + p->n_delete + p->n_modify);
1530 if (interval == ago) {
1531 ds_put_format(&s, "in the last %lld s", ago);
1532 } else if (interval) {
1533 ds_put_format(&s, "in the %lld s starting %lld s ago",
1536 ds_put_format(&s, "%lld s ago", ago);
1539 ds_put_cstr(&s, " (");
1541 ds_put_format(&s, "%d adds, ", p->n_add);
1544 ds_put_format(&s, "%d deletes, ", p->n_delete);
1547 ds_put_format(&s, "%d modifications, ", p->n_modify);
1550 ds_put_char(&s, ')');
1552 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1555 p->n_add = p->n_delete = p->n_modify = 0;
1556 p->next_op_report = LLONG_MAX;
1563 ofproto_wait(struct ofproto *p)
1565 p->ofproto_class->wait(p);
1566 if (p->ofproto_class->port_poll_wait) {
1567 p->ofproto_class->port_poll_wait(p);
1569 seq_wait(connectivity_seq_get(), p->change_seq);
1573 connmgr_wait(p->connmgr, true);
1578 connmgr_wait(p->connmgr, false);
1579 if (!any_pending_ops(p)) {
1580 poll_immediate_wake();
1587 ofproto_is_alive(const struct ofproto *p)
1589 return connmgr_has_controllers(p->connmgr);
1592 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1593 * memory_report(). */
1595 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1597 const struct oftable *table;
1598 unsigned int n_rules;
1600 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1602 ovs_mutex_lock(&ofproto_mutex);
1603 simap_increase(usage, "ops",
1604 ofproto->n_pending + hmap_count(&ofproto->deletions));
1605 ovs_mutex_unlock(&ofproto_mutex);
1608 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1609 ovs_rwlock_rdlock(&table->cls.rwlock);
1610 n_rules += classifier_count(&table->cls);
1611 ovs_rwlock_unlock(&table->cls.rwlock);
1613 simap_increase(usage, "rules", n_rules);
1615 if (ofproto->ofproto_class->get_memory_usage) {
1616 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1619 connmgr_get_memory_usage(ofproto->connmgr, usage);
1623 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1625 const struct ofproto_class *class;
1627 datapath_type = ofproto_normalize_type(datapath_type);
1628 class = ofproto_class_find__(datapath_type);
1630 if (class && class->type_get_memory_usage) {
1631 class->type_get_memory_usage(datapath_type, usage);
1636 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1639 connmgr_get_controller_info(ofproto->connmgr, info);
1643 ofproto_free_ofproto_controller_info(struct shash *info)
1645 connmgr_free_controller_info(info);
1648 /* Makes a deep copy of 'old' into 'port'. */
1650 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1652 port->name = xstrdup(old->name);
1653 port->type = xstrdup(old->type);
1654 port->ofp_port = old->ofp_port;
1657 /* Frees memory allocated to members of 'ofproto_port'.
1659 * Do not call this function on an ofproto_port obtained from
1660 * ofproto_port_dump_next(): that function retains ownership of the data in the
1663 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1665 free(ofproto_port->name);
1666 free(ofproto_port->type);
1669 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1671 * This function provides no status indication. An error status for the entire
1672 * dump operation is provided when it is completed by calling
1673 * ofproto_port_dump_done().
1676 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1677 const struct ofproto *ofproto)
1679 dump->ofproto = ofproto;
1680 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1684 /* Attempts to retrieve another port from 'dump', which must have been created
1685 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1686 * 'port' and returns true. On failure, returns false.
1688 * Failure might indicate an actual error or merely that the last port has been
1689 * dumped. An error status for the entire dump operation is provided when it
1690 * is completed by calling ofproto_port_dump_done().
1692 * The ofproto owns the data stored in 'port'. It will remain valid until at
1693 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1694 * ofproto_port_dump_done(). */
1696 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1697 struct ofproto_port *port)
1699 const struct ofproto *ofproto = dump->ofproto;
1705 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1708 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1714 /* Completes port table dump operation 'dump', which must have been created
1715 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1716 * error-free, otherwise a positive errno value describing the problem. */
1718 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1720 const struct ofproto *ofproto = dump->ofproto;
1722 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1725 return dump->error == EOF ? 0 : dump->error;
1728 /* Returns the type to pass to netdev_open() when a datapath of type
1729 * 'datapath_type' has a port of type 'port_type', for a few special
1730 * cases when a netdev type differs from a port type. For example, when
1731 * using the userspace datapath, a port of type "internal" needs to be
1734 * Returns either 'type' itself or a string literal, which must not be
1737 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1739 const struct ofproto_class *class;
1741 datapath_type = ofproto_normalize_type(datapath_type);
1742 class = ofproto_class_find__(datapath_type);
1747 return (class->port_open_type
1748 ? class->port_open_type(datapath_type, port_type)
1752 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1753 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1754 * the port's OpenFlow port number.
1756 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1757 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1758 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1759 * 'ofp_portp' is non-null). */
1761 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1762 ofp_port_t *ofp_portp)
1764 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1767 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1769 const char *netdev_name = netdev_get_name(netdev);
1771 simap_put(&ofproto->ofp_requests, netdev_name,
1772 ofp_to_u16(ofp_port));
1773 update_port(ofproto, netdev_name);
1776 *ofp_portp = OFPP_NONE;
1778 struct ofproto_port ofproto_port;
1780 error = ofproto_port_query_by_name(ofproto,
1781 netdev_get_name(netdev),
1784 *ofp_portp = ofproto_port.ofp_port;
1785 ofproto_port_destroy(&ofproto_port);
1792 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1793 * initializes '*port' appropriately; on failure, returns a positive errno
1796 * The caller owns the data in 'ofproto_port' and must free it with
1797 * ofproto_port_destroy() when it is no longer needed. */
1799 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1800 struct ofproto_port *port)
1804 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1806 memset(port, 0, sizeof *port);
1811 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1812 * Returns 0 if successful, otherwise a positive errno. */
1814 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1816 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1817 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1818 struct simap_node *ofp_request_node;
1821 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1822 if (ofp_request_node) {
1823 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1826 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1827 if (!error && ofport) {
1828 /* 'name' is the netdev's name and update_port() is going to close the
1829 * netdev. Just in case update_port() refers to 'name' after it
1830 * destroys 'ofport', make a copy of it around the update_port()
1832 char *devname = xstrdup(name);
1833 update_port(ofproto, devname);
1840 flow_mod_init(struct ofputil_flow_mod *fm,
1841 const struct match *match, unsigned int priority,
1842 const struct ofpact *ofpacts, size_t ofpacts_len,
1843 enum ofp_flow_mod_command command)
1845 memset(fm, 0, sizeof *fm);
1847 fm->priority = priority;
1850 fm->modify_cookie = false;
1852 fm->command = command;
1853 fm->idle_timeout = 0;
1854 fm->hard_timeout = 0;
1855 fm->buffer_id = UINT32_MAX;
1856 fm->out_port = OFPP_ANY;
1857 fm->out_group = OFPG_ANY;
1859 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1860 fm->ofpacts_len = ofpacts_len;
1864 simple_flow_mod(struct ofproto *ofproto,
1865 const struct match *match, unsigned int priority,
1866 const struct ofpact *ofpacts, size_t ofpacts_len,
1867 enum ofp_flow_mod_command command)
1869 struct ofputil_flow_mod fm;
1871 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1873 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1876 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1877 * performs the 'n_actions' actions in 'actions'. The new flow will not
1880 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1881 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1882 * controllers; otherwise, it will be hidden.
1884 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1886 * This is a helper function for in-band control and fail-open. */
1888 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1889 unsigned int priority,
1890 const struct ofpact *ofpacts, size_t ofpacts_len)
1891 OVS_EXCLUDED(ofproto_mutex)
1893 const struct rule *rule;
1896 /* First do a cheap check whether the rule we're looking for already exists
1897 * with the actions that we want. If it does, then we're done. */
1898 ovs_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1899 rule = rule_from_cls_rule(classifier_find_match_exactly(
1900 &ofproto->tables[0].cls, match, priority));
1902 ovs_mutex_lock(&rule->mutex);
1903 must_add = !ofpacts_equal(rule->actions->ofpacts,
1904 rule->actions->ofpacts_len,
1905 ofpacts, ofpacts_len);
1906 ovs_mutex_unlock(&rule->mutex);
1910 ovs_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1912 /* If there's no such rule or the rule doesn't have the actions we want,
1913 * fall back to a executing a full flow mod. We can't optimize this at
1914 * all because we didn't take enough locks above to ensure that the flow
1915 * table didn't already change beneath us. */
1917 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1918 OFPFC_MODIFY_STRICT);
1922 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1923 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1924 * operation cannot be initiated now but may be retried later.
1926 * This is a helper function for in-band control and fail-open and the "learn"
1929 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1930 OVS_EXCLUDED(ofproto_mutex)
1932 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1935 /* Searches for a rule with matching criteria exactly equal to 'target' in
1936 * ofproto's table 0 and, if it finds one, deletes it.
1938 * This is a helper function for in-band control and fail-open. */
1940 ofproto_delete_flow(struct ofproto *ofproto,
1941 const struct match *target, unsigned int priority)
1942 OVS_EXCLUDED(ofproto_mutex)
1944 struct classifier *cls = &ofproto->tables[0].cls;
1947 /* First do a cheap check whether the rule we're looking for has already
1948 * been deleted. If so, then we're done. */
1949 ovs_rwlock_rdlock(&cls->rwlock);
1950 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
1952 ovs_rwlock_unlock(&cls->rwlock);
1957 /* Fall back to a executing a full flow mod. We can't optimize this at all
1958 * because we didn't take enough locks above to ensure that the flow table
1959 * didn't already change beneath us. */
1960 return simple_flow_mod(ofproto, target, priority, NULL, 0,
1961 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
1964 /* Starts the process of deleting all of the flows from all of ofproto's flow
1965 * tables and then reintroducing the flows required by in-band control and
1966 * fail-open. The process will complete in a later call to ofproto_run(). */
1968 ofproto_flush_flows(struct ofproto *ofproto)
1970 COVERAGE_INC(ofproto_flush);
1971 ofproto->state = S_FLUSH;
1975 reinit_ports(struct ofproto *p)
1977 struct ofproto_port_dump dump;
1978 struct sset devnames;
1979 struct ofport *ofport;
1980 struct ofproto_port ofproto_port;
1981 const char *devname;
1983 COVERAGE_INC(ofproto_reinit_ports);
1985 sset_init(&devnames);
1986 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1987 sset_add(&devnames, netdev_get_name(ofport->netdev));
1989 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1990 sset_add(&devnames, ofproto_port.name);
1993 SSET_FOR_EACH (devname, &devnames) {
1994 update_port(p, devname);
1996 sset_destroy(&devnames);
2000 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2004 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2005 port_idx = port_idx ? port_idx : UINT16_MAX;
2007 if (port_idx >= ofproto->max_ports
2008 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2009 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2010 long long int last_used_at, lru = LLONG_MAX;
2012 /* Search for a free OpenFlow port number. We try not to
2013 * immediately reuse them to prevent problems due to old
2016 * We limit the automatically assigned port numbers to the lower half
2017 * of the port range, to reserve the upper half for assignment by
2020 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2021 ofproto->alloc_port_no = 1;
2023 last_used_at = ofport_get_usage(ofproto,
2024 u16_to_ofp(ofproto->alloc_port_no));
2025 if (!last_used_at) {
2026 port_idx = ofproto->alloc_port_no;
2028 } else if ( last_used_at < time_msec() - 60*60*1000) {
2029 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2030 * more than an hour ago, consider it usable. */
2031 ofport_remove_usage(ofproto,
2032 u16_to_ofp(ofproto->alloc_port_no));
2033 port_idx = ofproto->alloc_port_no;
2035 } else if (last_used_at < lru) {
2037 lru_ofport = ofproto->alloc_port_no;
2040 if (ofproto->alloc_port_no == end_port_no) {
2042 port_idx = lru_ofport;
2049 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2050 return u16_to_ofp(port_idx);
2054 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2056 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2057 ofport_set_usage(ofproto, ofp_port, time_msec());
2061 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2062 * pointer if the netdev cannot be opened. On success, also fills in
2064 static struct netdev *
2065 ofport_open(struct ofproto *ofproto,
2066 struct ofproto_port *ofproto_port,
2067 struct ofputil_phy_port *pp)
2069 enum netdev_flags flags;
2070 struct netdev *netdev;
2073 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2075 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2076 "cannot be opened (%s)",
2078 ofproto_port->name, ofproto_port->ofp_port,
2079 ofproto_port->name, ovs_strerror(error));
2083 if (ofproto_port->ofp_port == OFPP_NONE) {
2084 if (!strcmp(ofproto->name, ofproto_port->name)) {
2085 ofproto_port->ofp_port = OFPP_LOCAL;
2087 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2088 ofproto_port->name);
2091 pp->port_no = ofproto_port->ofp_port;
2092 netdev_get_etheraddr(netdev, pp->hw_addr);
2093 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2094 netdev_get_flags(netdev, &flags);
2095 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2096 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2097 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2098 &pp->supported, &pp->peer);
2099 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2100 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2105 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2106 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2109 ofport_equal(const struct ofputil_phy_port *a,
2110 const struct ofputil_phy_port *b)
2112 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2113 && a->state == b->state
2114 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2115 && a->curr == b->curr
2116 && a->advertised == b->advertised
2117 && a->supported == b->supported
2118 && a->peer == b->peer
2119 && a->curr_speed == b->curr_speed
2120 && a->max_speed == b->max_speed);
2123 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2124 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2125 * one with the same name or port number). */
2127 ofport_install(struct ofproto *p,
2128 struct netdev *netdev, const struct ofputil_phy_port *pp)
2130 const char *netdev_name = netdev_get_name(netdev);
2131 struct ofport *ofport;
2134 /* Create ofport. */
2135 ofport = p->ofproto_class->port_alloc();
2140 ofport->ofproto = p;
2141 ofport->netdev = netdev;
2143 ofport->ofp_port = pp->port_no;
2144 ofport->created = time_msec();
2146 /* Add port to 'p'. */
2147 hmap_insert(&p->ports, &ofport->hmap_node,
2148 hash_ofp_port(ofport->ofp_port));
2149 shash_add(&p->port_by_name, netdev_name, ofport);
2151 update_mtu(p, ofport);
2153 /* Let the ofproto_class initialize its private data. */
2154 error = p->ofproto_class->port_construct(ofport);
2158 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
2162 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2163 p->name, netdev_name, ovs_strerror(error));
2165 ofport_destroy__(ofport);
2167 netdev_close(netdev);
2171 /* Removes 'ofport' from 'p' and destroys it. */
2173 ofport_remove(struct ofport *ofport)
2175 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
2177 ofport_destroy(ofport);
2180 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2183 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2185 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2187 ofport_remove(port);
2191 /* Updates 'port' with new 'pp' description.
2193 * Does not handle a name or port number change. The caller must implement
2194 * such a change as a delete followed by an add. */
2196 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2198 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2199 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2200 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2201 port->pp.state = pp->state;
2202 port->pp.curr = pp->curr;
2203 port->pp.advertised = pp->advertised;
2204 port->pp.supported = pp->supported;
2205 port->pp.peer = pp->peer;
2206 port->pp.curr_speed = pp->curr_speed;
2207 port->pp.max_speed = pp->max_speed;
2209 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
2212 /* Update OpenFlow 'state' in 'port' and notify controller. */
2214 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2216 if (port->pp.state != state) {
2217 port->pp.state = state;
2218 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
2224 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2226 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2228 if (port->ofproto->ofproto_class->set_realdev) {
2229 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2231 if (port->ofproto->ofproto_class->set_stp_port) {
2232 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2234 if (port->ofproto->ofproto_class->set_cfm) {
2235 port->ofproto->ofproto_class->set_cfm(port, NULL);
2237 if (port->ofproto->ofproto_class->bundle_remove) {
2238 port->ofproto->ofproto_class->bundle_remove(port);
2244 ofport_destroy__(struct ofport *port)
2246 struct ofproto *ofproto = port->ofproto;
2247 const char *name = netdev_get_name(port->netdev);
2249 hmap_remove(&ofproto->ports, &port->hmap_node);
2250 shash_delete(&ofproto->port_by_name,
2251 shash_find(&ofproto->port_by_name, name));
2253 netdev_close(port->netdev);
2254 ofproto->ofproto_class->port_dealloc(port);
2258 ofport_destroy(struct ofport *port)
2261 dealloc_ofp_port(port->ofproto, port->ofp_port);
2262 port->ofproto->ofproto_class->port_destruct(port);
2263 ofport_destroy__(port);
2268 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2270 struct ofport *port;
2272 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2274 if (port->ofp_port == ofp_port) {
2281 static long long int
2282 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2284 struct ofport_usage *usage;
2286 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2287 &ofproto->ofport_usage) {
2288 if (usage->ofp_port == ofp_port) {
2289 return usage->last_used;
2296 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2297 long long int last_used)
2299 struct ofport_usage *usage;
2300 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2301 &ofproto->ofport_usage) {
2302 if (usage->ofp_port == ofp_port) {
2303 usage->last_used = last_used;
2307 ovs_assert(last_used == LLONG_MAX);
2309 usage = xmalloc(sizeof *usage);
2310 usage->ofp_port = ofp_port;
2311 usage->last_used = last_used;
2312 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2313 hash_ofp_port(ofp_port));
2317 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2319 struct ofport_usage *usage;
2320 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2321 &ofproto->ofport_usage) {
2322 if (usage->ofp_port == ofp_port) {
2323 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2331 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2333 struct ofproto *ofproto = port->ofproto;
2336 if (ofproto->ofproto_class->port_get_stats) {
2337 error = ofproto->ofproto_class->port_get_stats(port, stats);
2346 update_port(struct ofproto *ofproto, const char *name)
2348 struct ofproto_port ofproto_port;
2349 struct ofputil_phy_port pp;
2350 struct netdev *netdev;
2351 struct ofport *port;
2353 COVERAGE_INC(ofproto_update_port);
2355 /* Fetch 'name''s location and properties from the datapath. */
2356 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2357 ? ofport_open(ofproto, &ofproto_port, &pp)
2361 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2362 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2363 struct netdev *old_netdev = port->netdev;
2365 /* 'name' hasn't changed location. Any properties changed? */
2366 if (!ofport_equal(&port->pp, &pp)) {
2367 ofport_modified(port, &pp);
2370 update_mtu(ofproto, port);
2372 /* Install the newly opened netdev in case it has changed.
2373 * Don't close the old netdev yet in case port_modified has to
2374 * remove a retained reference to it.*/
2375 port->netdev = netdev;
2377 if (port->ofproto->ofproto_class->port_modified) {
2378 port->ofproto->ofproto_class->port_modified(port);
2381 netdev_close(old_netdev);
2383 /* If 'port' is nonnull then its name differs from 'name' and thus
2384 * we should delete it. If we think there's a port named 'name'
2385 * then its port number must be wrong now so delete it too. */
2387 ofport_remove(port);
2389 ofport_remove_with_name(ofproto, name);
2390 ofport_install(ofproto, netdev, &pp);
2393 /* Any port named 'name' is gone now. */
2394 ofport_remove_with_name(ofproto, name);
2396 ofproto_port_destroy(&ofproto_port);
2400 init_ports(struct ofproto *p)
2402 struct ofproto_port_dump dump;
2403 struct ofproto_port ofproto_port;
2404 struct shash_node *node, *next;
2406 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2407 const char *name = ofproto_port.name;
2409 if (shash_find(&p->port_by_name, name)) {
2410 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2413 struct ofputil_phy_port pp;
2414 struct netdev *netdev;
2416 /* Check if an OpenFlow port number had been requested. */
2417 node = shash_find(&init_ofp_ports, name);
2419 const struct iface_hint *iface_hint = node->data;
2420 simap_put(&p->ofp_requests, name,
2421 ofp_to_u16(iface_hint->ofp_port));
2424 netdev = ofport_open(p, &ofproto_port, &pp);
2426 ofport_install(p, netdev, &pp);
2427 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2428 p->alloc_port_no = MAX(p->alloc_port_no,
2429 ofp_to_u16(ofproto_port.ofp_port));
2435 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2436 struct iface_hint *iface_hint = node->data;
2438 if (!strcmp(iface_hint->br_name, p->name)) {
2439 free(iface_hint->br_name);
2440 free(iface_hint->br_type);
2442 shash_delete(&init_ofp_ports, node);
2449 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2450 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2452 find_min_mtu(struct ofproto *p)
2454 struct ofport *ofport;
2457 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2458 struct netdev *netdev = ofport->netdev;
2461 /* Skip any internal ports, since that's what we're trying to
2463 if (!strcmp(netdev_get_type(netdev), "internal")) {
2467 if (netdev_get_mtu(netdev, &dev_mtu)) {
2470 if (!mtu || dev_mtu < mtu) {
2475 return mtu ? mtu: ETH_PAYLOAD_MAX;
2478 /* Update MTU of all datapath devices on 'p' to the minimum of the
2479 * non-datapath ports in event of 'port' added or changed. */
2481 update_mtu(struct ofproto *p, struct ofport *port)
2483 struct ofport *ofport;
2484 struct netdev *netdev = port->netdev;
2485 int dev_mtu, old_min;
2487 if (netdev_get_mtu(netdev, &dev_mtu)) {
2491 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2492 if (dev_mtu > p->min_mtu) {
2493 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2494 dev_mtu = p->min_mtu;
2497 port->mtu = dev_mtu;
2501 /* For non-internal port find new min mtu. */
2502 old_min = p->min_mtu;
2503 port->mtu = dev_mtu;
2504 p->min_mtu = find_min_mtu(p);
2505 if (p->min_mtu == old_min) {
2509 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2510 struct netdev *netdev = ofport->netdev;
2512 if (!strcmp(netdev_get_type(netdev), "internal")) {
2513 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2514 ofport->mtu = p->min_mtu;
2521 ofproto_rule_ref(struct rule *rule)
2526 atomic_add(&rule->ref_count, 1, &orig);
2527 ovs_assert(orig != 0);
2532 ofproto_rule_unref(struct rule *rule)
2537 atomic_sub(&rule->ref_count, 1, &orig);
2539 rule->ofproto->ofproto_class->rule_destruct(rule);
2540 ofproto_rule_destroy__(rule);
2542 ovs_assert(orig != 0);
2547 struct rule_actions *
2548 rule_get_actions(const struct rule *rule)
2549 OVS_EXCLUDED(rule->mutex)
2551 struct rule_actions *actions;
2553 ovs_mutex_lock(&rule->mutex);
2554 actions = rule_get_actions__(rule);
2555 ovs_mutex_unlock(&rule->mutex);
2560 struct rule_actions *
2561 rule_get_actions__(const struct rule *rule)
2562 OVS_REQUIRES(rule->mutex)
2564 rule_actions_ref(rule->actions);
2565 return rule->actions;
2569 ofproto_rule_destroy__(struct rule *rule)
2570 OVS_NO_THREAD_SAFETY_ANALYSIS
2572 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2573 rule_actions_unref(rule->actions);
2574 ovs_mutex_destroy(&rule->mutex);
2575 rule->ofproto->ofproto_class->rule_dealloc(rule);
2578 static uint32_t get_provider_meter_id(const struct ofproto *,
2579 uint32_t of_meter_id);
2581 /* Creates and returns a new 'struct rule_actions', with a ref_count of 1,
2582 * whose actions are a copy of from the 'ofpacts_len' bytes of 'ofpacts'. */
2583 struct rule_actions *
2584 rule_actions_create(const struct ofproto *ofproto,
2585 const struct ofpact *ofpacts, size_t ofpacts_len)
2587 struct rule_actions *actions;
2589 actions = xmalloc(sizeof *actions);
2590 atomic_init(&actions->ref_count, 1);
2591 actions->ofpacts = xmemdup(ofpacts, ofpacts_len);
2592 actions->ofpacts_len = ofpacts_len;
2593 actions->provider_meter_id
2594 = get_provider_meter_id(ofproto,
2595 ofpacts_get_meter(ofpacts, ofpacts_len));
2600 /* Increments 'actions''s ref_count. */
2602 rule_actions_ref(struct rule_actions *actions)
2607 atomic_add(&actions->ref_count, 1, &orig);
2608 ovs_assert(orig != 0);
2612 /* Decrements 'actions''s ref_count and frees 'actions' if the ref_count
2615 rule_actions_unref(struct rule_actions *actions)
2620 atomic_sub(&actions->ref_count, 1, &orig);
2622 free(actions->ofpacts);
2625 ovs_assert(orig != 0);
2630 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2631 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2633 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2634 OVS_REQUIRES(ofproto_mutex)
2636 return (port == OFPP_ANY
2637 || ofpacts_output_to_port(rule->actions->ofpacts,
2638 rule->actions->ofpacts_len, port));
2641 /* Returns true if 'rule' has group and equals group_id. */
2643 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2644 OVS_REQUIRES(ofproto_mutex)
2646 return (group_id == OFPG11_ANY
2647 || ofpacts_output_to_group(rule->actions->ofpacts,
2648 rule->actions->ofpacts_len, group_id));
2651 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2652 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2654 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2655 OVS_REQUIRES(ofproto_mutex)
2657 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2662 case OFOPERATION_ADD:
2663 case OFOPERATION_DELETE:
2666 case OFOPERATION_MODIFY:
2667 case OFOPERATION_REPLACE:
2668 return ofpacts_output_to_port(op->actions->ofpacts,
2669 op->actions->ofpacts_len, out_port);
2676 rule_execute_destroy(struct rule_execute *e)
2678 ofproto_rule_unref(e->rule);
2679 list_remove(&e->list_node);
2683 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2684 * by passing them to the ofproto provider. */
2686 run_rule_executes(struct ofproto *ofproto)
2687 OVS_EXCLUDED(ofproto_mutex)
2689 struct rule_execute *e, *next;
2690 struct list executes;
2692 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2693 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2694 union flow_in_port in_port_;
2697 in_port_.ofp_port = e->in_port;
2698 flow_extract(e->packet, 0, 0, NULL, &in_port_, &flow);
2699 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2701 rule_execute_destroy(e);
2705 /* Destroys and discards all "rule_execute" operations queued up in
2706 * ofproto->rule_executes. */
2708 destroy_rule_executes(struct ofproto *ofproto)
2710 struct rule_execute *e, *next;
2711 struct list executes;
2713 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2714 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2715 ofpbuf_delete(e->packet);
2716 rule_execute_destroy(e);
2720 /* Returns true if 'rule' should be hidden from the controller.
2722 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2723 * (e.g. by in-band control) and are intentionally hidden from the
2726 ofproto_rule_is_hidden(const struct rule *rule)
2728 return rule->cr.priority > UINT16_MAX;
2731 static enum oftable_flags
2732 rule_get_flags(const struct rule *rule)
2734 return rule->ofproto->tables[rule->table_id].flags;
2738 rule_is_modifiable(const struct rule *rule)
2740 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2744 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2746 ofconn_send_reply(ofconn, make_echo_reply(oh));
2751 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2753 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2754 struct ofputil_switch_features features;
2755 struct ofport *port;
2761 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2763 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2765 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2766 * if present, are always at the end.) */
2767 n_tables = ofproto->n_tables;
2768 for (i = 0; i < ofproto->n_tables; i++) {
2769 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2775 features.datapath_id = ofproto->datapath_id;
2776 features.n_buffers = pktbuf_capacity();
2777 features.n_tables = n_tables;
2778 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2779 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2781 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2783 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2784 features.auxiliary_id = 0;
2785 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2787 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2788 ofputil_put_switch_features_port(&port->pp, b);
2791 ofconn_send_reply(ofconn, b);
2796 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2798 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2799 struct ofp_switch_config *osc;
2800 enum ofp_config_flags flags;
2804 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2805 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2806 flags = ofproto->frag_handling;
2807 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2808 if (oh->version < OFP13_VERSION
2809 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2810 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2812 osc->flags = htons(flags);
2813 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2814 ofconn_send_reply(ofconn, buf);
2820 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2822 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2823 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2824 uint16_t flags = ntohs(osc->flags);
2826 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2827 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2828 enum ofp_config_flags cur = ofproto->frag_handling;
2829 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2831 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2833 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2834 ofproto->frag_handling = next;
2836 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2838 ofputil_frag_handling_to_string(next));
2842 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2843 ofconn_set_invalid_ttl_to_controller(ofconn,
2844 (oh->version < OFP13_VERSION
2845 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2847 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2852 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2853 * error message code for the caller to propagate upward. Otherwise, returns
2856 * The log message mentions 'msg_type'. */
2858 reject_slave_controller(struct ofconn *ofconn)
2860 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2861 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2862 return OFPERR_OFPBRC_EPERM;
2868 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2871 * - If they use a meter, then 'ofproto' has that meter configured.
2873 * - If they use any groups, then 'ofproto' has that group configured.
2875 * Returns 0 if successful, otherwise an OpenFlow error. */
2877 ofproto_check_ofpacts(struct ofproto *ofproto,
2878 const struct ofpact ofpacts[], size_t ofpacts_len)
2880 const struct ofpact *a;
2883 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2884 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2885 return OFPERR_OFPMMFC_INVALID_METER;
2888 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2889 if (a->type == OFPACT_GROUP
2890 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2891 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2899 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2901 struct ofproto *p = ofconn_get_ofproto(ofconn);
2902 struct ofputil_packet_out po;
2903 struct ofpbuf *payload;
2904 uint64_t ofpacts_stub[1024 / 8];
2905 struct ofpbuf ofpacts;
2907 union flow_in_port in_port_;
2910 COVERAGE_INC(ofproto_packet_out);
2912 error = reject_slave_controller(ofconn);
2917 /* Decode message. */
2918 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2919 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2921 goto exit_free_ofpacts;
2923 if (ofp_to_u16(po.in_port) >= p->max_ports
2924 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2925 error = OFPERR_OFPBRC_BAD_PORT;
2926 goto exit_free_ofpacts;
2930 if (po.buffer_id != UINT32_MAX) {
2931 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2932 if (error || !payload) {
2933 goto exit_free_ofpacts;
2936 /* Ensure that the L3 header is 32-bit aligned. */
2937 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2940 /* Verify actions against packet, then send packet if successful. */
2941 in_port_.ofp_port = po.in_port;
2942 flow_extract(payload, 0, 0, NULL, &in_port_, &flow);
2943 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
2945 error = p->ofproto_class->packet_out(p, payload, &flow,
2946 po.ofpacts, po.ofpacts_len);
2948 ofpbuf_delete(payload);
2951 ofpbuf_uninit(&ofpacts);
2957 update_port_config(struct ofport *port,
2958 enum ofputil_port_config config,
2959 enum ofputil_port_config mask)
2961 enum ofputil_port_config old_config = port->pp.config;
2962 enum ofputil_port_config toggle;
2964 toggle = (config ^ port->pp.config) & mask;
2965 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2966 if (config & OFPUTIL_PC_PORT_DOWN) {
2967 netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL);
2969 netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL);
2971 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2974 port->pp.config ^= toggle;
2975 if (port->pp.config != old_config) {
2976 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2981 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2983 struct ofproto *p = ofconn_get_ofproto(ofconn);
2984 struct ofputil_port_mod pm;
2985 struct ofport *port;
2988 error = reject_slave_controller(ofconn);
2993 error = ofputil_decode_port_mod(oh, &pm);
2998 port = ofproto_get_port(p, pm.port_no);
3000 return OFPERR_OFPPMFC_BAD_PORT;
3001 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3002 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3004 update_port_config(port, pm.config, pm.mask);
3006 netdev_set_advertisements(port->netdev, pm.advertise);
3013 handle_desc_stats_request(struct ofconn *ofconn,
3014 const struct ofp_header *request)
3016 static const char *default_mfr_desc = "Nicira, Inc.";
3017 static const char *default_hw_desc = "Open vSwitch";
3018 static const char *default_sw_desc = VERSION;
3019 static const char *default_serial_desc = "None";
3020 static const char *default_dp_desc = "None";
3022 struct ofproto *p = ofconn_get_ofproto(ofconn);
3023 struct ofp_desc_stats *ods;
3026 msg = ofpraw_alloc_stats_reply(request, 0);
3027 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3028 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3029 sizeof ods->mfr_desc);
3030 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3031 sizeof ods->hw_desc);
3032 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3033 sizeof ods->sw_desc);
3034 ovs_strlcpy(ods->serial_num,
3035 p->serial_desc ? p->serial_desc : default_serial_desc,
3036 sizeof ods->serial_num);
3037 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3038 sizeof ods->dp_desc);
3039 ofconn_send_reply(ofconn, msg);
3045 handle_table_stats_request(struct ofconn *ofconn,
3046 const struct ofp_header *request)
3048 struct ofproto *p = ofconn_get_ofproto(ofconn);
3049 struct ofp12_table_stats *ots;
3054 /* Set up default values.
3056 * ofp12_table_stats is used as a generic structure as
3057 * it is able to hold all the fields for ofp10_table_stats
3058 * and ofp11_table_stats (and of course itself).
3060 ots = xcalloc(p->n_tables, sizeof *ots);
3061 for (i = 0; i < p->n_tables; i++) {
3062 ots[i].table_id = i;
3063 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3064 ots[i].match = htonll(OFPXMT13_MASK);
3065 ots[i].wildcards = htonll(OFPXMT13_MASK);
3066 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3067 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3068 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3069 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3070 ots[i].metadata_match = OVS_BE64_MAX;
3071 ots[i].metadata_write = OVS_BE64_MAX;
3072 ots[i].instructions = htonl(OFPIT11_ALL);
3073 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3074 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3075 ovs_rwlock_rdlock(&p->tables[i].cls.rwlock);
3076 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3077 ovs_rwlock_unlock(&p->tables[i].cls.rwlock);
3080 p->ofproto_class->get_tables(p, ots);
3082 /* Post-process the tables, dropping hidden tables. */
3083 n_tables = p->n_tables;
3084 for (i = 0; i < p->n_tables; i++) {
3085 const struct oftable *table = &p->tables[i];
3087 if (table->flags & OFTABLE_HIDDEN) {
3093 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3096 if (table->max_flows < ntohl(ots[i].max_entries)) {
3097 ots[i].max_entries = htonl(table->max_flows);
3101 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3102 ofconn_send_reply(ofconn, msg);
3110 append_port_stat(struct ofport *port, struct list *replies)
3112 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3114 calc_duration(port->created, time_msec(),
3115 &ops.duration_sec, &ops.duration_nsec);
3117 /* Intentionally ignore return value, since errors will set
3118 * 'stats' to all-1s, which is correct for OpenFlow, and
3119 * netdev_get_stats() will log errors. */
3120 ofproto_port_get_stats(port, &ops.stats);
3122 ofputil_append_port_stat(replies, &ops);
3126 handle_port_stats_request(struct ofconn *ofconn,
3127 const struct ofp_header *request)
3129 struct ofproto *p = ofconn_get_ofproto(ofconn);
3130 struct ofport *port;
3131 struct list replies;
3135 error = ofputil_decode_port_stats_request(request, &port_no);
3140 ofpmp_init(&replies, request);
3141 if (port_no != OFPP_ANY) {
3142 port = ofproto_get_port(p, port_no);
3144 append_port_stat(port, &replies);
3147 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3148 append_port_stat(port, &replies);
3152 ofconn_send_replies(ofconn, &replies);
3157 handle_port_desc_stats_request(struct ofconn *ofconn,
3158 const struct ofp_header *request)
3160 struct ofproto *p = ofconn_get_ofproto(ofconn);
3161 enum ofp_version version;
3162 struct ofport *port;
3163 struct list replies;
3165 ofpmp_init(&replies, request);
3167 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
3168 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3169 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
3172 ofconn_send_replies(ofconn, &replies);
3177 hash_cookie(ovs_be64 cookie)
3179 return hash_2words((OVS_FORCE uint64_t)cookie >> 32,
3180 (OVS_FORCE uint64_t)cookie);
3184 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3185 OVS_REQUIRES(ofproto_mutex)
3187 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3188 hash_cookie(rule->flow_cookie));
3192 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3193 OVS_REQUIRES(ofproto_mutex)
3195 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3199 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3200 ovs_be64 new_cookie)
3201 OVS_REQUIRES(ofproto_mutex)
3203 if (new_cookie != rule->flow_cookie) {
3204 cookies_remove(ofproto, rule);
3206 ovs_mutex_lock(&rule->mutex);
3207 rule->flow_cookie = new_cookie;
3208 ovs_mutex_unlock(&rule->mutex);
3210 cookies_insert(ofproto, rule);
3215 calc_duration(long long int start, long long int now,
3216 uint32_t *sec, uint32_t *nsec)
3218 long long int msecs = now - start;
3219 *sec = msecs / 1000;
3220 *nsec = (msecs % 1000) * (1000 * 1000);
3223 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3224 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
3226 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3228 return (table_id == 0xff || table_id < ofproto->n_tables
3230 : OFPERR_OFPBRC_BAD_TABLE_ID);
3234 static struct oftable *
3235 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3237 struct oftable *table;
3239 for (table = &ofproto->tables[table_id];
3240 table < &ofproto->tables[ofproto->n_tables];
3242 if (!(table->flags & OFTABLE_HIDDEN)) {
3250 static struct oftable *
3251 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3253 if (table_id == 0xff) {
3254 return next_visible_table(ofproto, 0);
3255 } else if (table_id < ofproto->n_tables) {
3256 return &ofproto->tables[table_id];
3262 static struct oftable *
3263 next_matching_table(const struct ofproto *ofproto,
3264 const struct oftable *table, uint8_t table_id)
3266 return (table_id == 0xff
3267 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3271 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3273 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3274 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3276 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3277 * only once, for that table. (This can be used to access tables marked
3280 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3281 * entered at all. (Perhaps you should have validated TABLE_ID with
3282 * check_table_id().)
3284 * All parameters are evaluated multiple times.
3286 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3287 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3289 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3291 /* Initializes 'criteria' in a straightforward way based on the other
3294 * For "loose" matching, the 'priority' parameter is unimportant and may be
3297 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3298 const struct match *match, unsigned int priority,
3299 ovs_be64 cookie, ovs_be64 cookie_mask,
3300 ofp_port_t out_port, uint32_t out_group)
3302 criteria->table_id = table_id;
3303 cls_rule_init(&criteria->cr, match, priority);
3304 criteria->cookie = cookie;
3305 criteria->cookie_mask = cookie_mask;
3306 criteria->out_port = out_port;
3307 criteria->out_group = out_group;
3311 rule_criteria_destroy(struct rule_criteria *criteria)
3313 cls_rule_destroy(&criteria->cr);
3317 rule_collection_init(struct rule_collection *rules)
3319 rules->rules = rules->stub;
3321 rules->capacity = ARRAY_SIZE(rules->stub);
3325 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3327 if (rules->n >= rules->capacity) {
3328 size_t old_size, new_size;
3330 old_size = rules->capacity * sizeof *rules->rules;
3331 rules->capacity *= 2;
3332 new_size = rules->capacity * sizeof *rules->rules;
3334 if (rules->rules == rules->stub) {
3335 rules->rules = xmalloc(new_size);
3336 memcpy(rules->rules, rules->stub, old_size);
3338 rules->rules = xrealloc(rules->rules, new_size);
3342 rules->rules[rules->n++] = rule;
3346 rule_collection_ref(struct rule_collection *rules)
3347 OVS_REQUIRES(ofproto_mutex)
3351 for (i = 0; i < rules->n; i++) {
3352 ofproto_rule_ref(rules->rules[i]);
3357 rule_collection_unref(struct rule_collection *rules)
3361 for (i = 0; i < rules->n; i++) {
3362 ofproto_rule_unref(rules->rules[i]);
3367 rule_collection_destroy(struct rule_collection *rules)
3369 if (rules->rules != rules->stub) {
3375 collect_rule(struct rule *rule, const struct rule_criteria *c,
3376 struct rule_collection *rules)
3377 OVS_REQUIRES(ofproto_mutex)
3379 /* We ordinarily want to skip hidden rules, but there has to be a way for
3380 * code internal to OVS to modify and delete them, so if the criteria
3381 * specify a priority that can only be for a hidden flow, then allow hidden
3382 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3383 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3385 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3387 } else if (rule->pending) {
3388 return OFPROTO_POSTPONE;
3390 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3391 && ofproto_rule_has_out_port(rule, c->out_port)
3392 && ofproto_rule_has_out_group(rule, c->out_group)
3393 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3394 rule_collection_add(rules, rule);
3400 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3401 * on classifiers rules are done in the "loose" way required for OpenFlow
3402 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3405 * Hidden rules are always omitted.
3407 * Returns 0 on success, otherwise an OpenFlow error code. */
3409 collect_rules_loose(struct ofproto *ofproto,
3410 const struct rule_criteria *criteria,
3411 struct rule_collection *rules)
3412 OVS_REQUIRES(ofproto_mutex)
3414 struct oftable *table;
3417 rule_collection_init(rules);
3419 error = check_table_id(ofproto, criteria->table_id);
3424 if (criteria->cookie_mask == OVS_BE64_MAX) {
3427 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3428 hash_cookie(criteria->cookie),
3429 &ofproto->cookies) {
3430 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3431 error = collect_rule(rule, criteria, rules);
3438 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3439 struct cls_cursor cursor;
3442 ovs_rwlock_rdlock(&table->cls.rwlock);
3443 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3444 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3445 error = collect_rule(rule, criteria, rules);
3450 ovs_rwlock_unlock(&table->cls.rwlock);
3456 rule_collection_destroy(rules);
3461 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3462 * on classifiers rules are done in the "strict" way required for OpenFlow
3463 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3464 * rules on list 'rules'.
3466 * Hidden rules are always omitted.
3468 * Returns 0 on success, otherwise an OpenFlow error code. */
3470 collect_rules_strict(struct ofproto *ofproto,
3471 const struct rule_criteria *criteria,
3472 struct rule_collection *rules)
3473 OVS_REQUIRES(ofproto_mutex)
3475 struct oftable *table;
3478 rule_collection_init(rules);
3480 error = check_table_id(ofproto, criteria->table_id);
3485 if (criteria->cookie_mask == OVS_BE64_MAX) {
3488 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3489 hash_cookie(criteria->cookie),
3490 &ofproto->cookies) {
3491 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3492 error = collect_rule(rule, criteria, rules);
3499 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3502 ovs_rwlock_rdlock(&table->cls.rwlock);
3503 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3504 &table->cls, &criteria->cr));
3505 ovs_rwlock_unlock(&table->cls.rwlock);
3507 error = collect_rule(rule, criteria, rules);
3517 rule_collection_destroy(rules);
3522 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3523 * forced into the range of a uint16_t. */
3525 age_secs(long long int age_ms)
3527 return (age_ms < 0 ? 0
3528 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3529 : (unsigned int) age_ms / 1000);
3533 handle_flow_stats_request(struct ofconn *ofconn,
3534 const struct ofp_header *request)
3535 OVS_EXCLUDED(ofproto_mutex)
3537 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3538 struct ofputil_flow_stats_request fsr;
3539 struct rule_criteria criteria;
3540 struct rule_collection rules;
3541 struct list replies;
3545 error = ofputil_decode_flow_stats_request(&fsr, request);
3550 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3551 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3553 ovs_mutex_lock(&ofproto_mutex);
3554 error = collect_rules_loose(ofproto, &criteria, &rules);
3555 rule_criteria_destroy(&criteria);
3557 rule_collection_ref(&rules);
3559 ovs_mutex_unlock(&ofproto_mutex);
3565 ofpmp_init(&replies, request);
3566 for (i = 0; i < rules.n; i++) {
3567 struct rule *rule = rules.rules[i];
3568 long long int now = time_msec();
3569 struct ofputil_flow_stats fs;
3570 long long int created, used, modified;
3571 struct rule_actions *actions;
3572 enum ofputil_flow_mod_flags flags;
3574 ovs_mutex_lock(&rule->mutex);
3575 fs.cookie = rule->flow_cookie;
3576 fs.idle_timeout = rule->idle_timeout;
3577 fs.hard_timeout = rule->hard_timeout;
3578 created = rule->created;
3580 modified = rule->modified;
3581 actions = rule_get_actions__(rule);
3582 flags = rule->flags;
3583 ovs_mutex_unlock(&rule->mutex);
3585 minimatch_expand(&rule->cr.match, &fs.match);
3586 fs.table_id = rule->table_id;
3587 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3588 fs.priority = rule->cr.priority;
3589 fs.idle_age = age_secs(now - used);
3590 fs.hard_age = age_secs(now - modified);
3591 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3593 fs.ofpacts = actions->ofpacts;
3594 fs.ofpacts_len = actions->ofpacts_len;
3597 ofputil_append_flow_stats_reply(&fs, &replies);
3599 rule_actions_unref(actions);
3602 rule_collection_unref(&rules);
3603 rule_collection_destroy(&rules);
3605 ofconn_send_replies(ofconn, &replies);
3611 flow_stats_ds(struct rule *rule, struct ds *results)
3613 uint64_t packet_count, byte_count;
3614 struct rule_actions *actions;
3615 long long int created;
3617 rule->ofproto->ofproto_class->rule_get_stats(rule,
3618 &packet_count, &byte_count);
3620 ovs_mutex_lock(&rule->mutex);
3621 actions = rule_get_actions__(rule);
3622 created = rule->created;
3623 ovs_mutex_unlock(&rule->mutex);
3625 if (rule->table_id != 0) {
3626 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3628 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3629 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3630 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3631 cls_rule_format(&rule->cr, results);
3632 ds_put_char(results, ',');
3634 ds_put_cstr(results, "actions=");
3635 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3637 ds_put_cstr(results, "\n");
3639 rule_actions_unref(actions);
3642 /* Adds a pretty-printed description of all flows to 'results', including
3643 * hidden flows (e.g., set up by in-band control). */
3645 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3647 struct oftable *table;
3649 OFPROTO_FOR_EACH_TABLE (table, p) {
3650 struct cls_cursor cursor;
3653 ovs_rwlock_rdlock(&table->cls.rwlock);
3654 cls_cursor_init(&cursor, &table->cls, NULL);
3655 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3656 flow_stats_ds(rule, results);
3658 ovs_rwlock_unlock(&table->cls.rwlock);
3662 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3663 * '*engine_type' and '*engine_id', respectively. */
3665 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3666 uint8_t *engine_type, uint8_t *engine_id)
3668 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3671 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3672 * true if the port's CFM status was successfully stored into '*status'.
3673 * Returns false if the port did not have CFM configured, in which case
3674 * '*status' is indeterminate.
3676 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3678 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3679 struct ofproto_cfm_status *status)
3681 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3683 && ofproto->ofproto_class->get_cfm_status
3684 && ofproto->ofproto_class->get_cfm_status(ofport, status));
3688 handle_aggregate_stats_request(struct ofconn *ofconn,
3689 const struct ofp_header *oh)
3690 OVS_EXCLUDED(ofproto_mutex)
3692 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3693 struct ofputil_flow_stats_request request;
3694 struct ofputil_aggregate_stats stats;
3695 bool unknown_packets, unknown_bytes;
3696 struct rule_criteria criteria;
3697 struct rule_collection rules;
3698 struct ofpbuf *reply;
3702 error = ofputil_decode_flow_stats_request(&request, oh);
3707 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3708 request.cookie, request.cookie_mask,
3709 request.out_port, request.out_group);
3711 ovs_mutex_lock(&ofproto_mutex);
3712 error = collect_rules_loose(ofproto, &criteria, &rules);
3713 rule_criteria_destroy(&criteria);
3715 rule_collection_ref(&rules);
3717 ovs_mutex_unlock(&ofproto_mutex);
3723 memset(&stats, 0, sizeof stats);
3724 unknown_packets = unknown_bytes = false;
3725 for (i = 0; i < rules.n; i++) {
3726 struct rule *rule = rules.rules[i];
3727 uint64_t packet_count;
3728 uint64_t byte_count;
3730 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3733 if (packet_count == UINT64_MAX) {
3734 unknown_packets = true;
3736 stats.packet_count += packet_count;
3739 if (byte_count == UINT64_MAX) {
3740 unknown_bytes = true;
3742 stats.byte_count += byte_count;
3747 if (unknown_packets) {
3748 stats.packet_count = UINT64_MAX;
3750 if (unknown_bytes) {
3751 stats.byte_count = UINT64_MAX;
3754 rule_collection_unref(&rules);
3755 rule_collection_destroy(&rules);
3757 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3758 ofconn_send_reply(ofconn, reply);
3763 struct queue_stats_cbdata {
3764 struct ofport *ofport;
3765 struct list replies;
3770 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3771 const struct netdev_queue_stats *stats)
3773 struct ofputil_queue_stats oqs;
3775 oqs.port_no = cbdata->ofport->pp.port_no;
3776 oqs.queue_id = queue_id;
3777 oqs.tx_bytes = stats->tx_bytes;
3778 oqs.tx_packets = stats->tx_packets;
3779 oqs.tx_errors = stats->tx_errors;
3780 if (stats->created != LLONG_MIN) {
3781 calc_duration(stats->created, cbdata->now,
3782 &oqs.duration_sec, &oqs.duration_nsec);
3784 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3786 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3790 handle_queue_stats_dump_cb(uint32_t queue_id,
3791 struct netdev_queue_stats *stats,
3794 struct queue_stats_cbdata *cbdata = cbdata_;
3796 put_queue_stats(cbdata, queue_id, stats);
3800 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3801 struct queue_stats_cbdata *cbdata)
3803 cbdata->ofport = port;
3804 if (queue_id == OFPQ_ALL) {
3805 netdev_dump_queue_stats(port->netdev,
3806 handle_queue_stats_dump_cb, cbdata);
3808 struct netdev_queue_stats stats;
3810 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3811 put_queue_stats(cbdata, queue_id, &stats);
3813 return OFPERR_OFPQOFC_BAD_QUEUE;
3820 handle_queue_stats_request(struct ofconn *ofconn,
3821 const struct ofp_header *rq)
3823 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3824 struct queue_stats_cbdata cbdata;
3825 struct ofport *port;
3827 struct ofputil_queue_stats_request oqsr;
3829 COVERAGE_INC(ofproto_queue_req);
3831 ofpmp_init(&cbdata.replies, rq);
3832 cbdata.now = time_msec();
3834 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3839 if (oqsr.port_no == OFPP_ANY) {
3840 error = OFPERR_OFPQOFC_BAD_QUEUE;
3841 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3842 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3847 port = ofproto_get_port(ofproto, oqsr.port_no);
3849 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3850 : OFPERR_OFPQOFC_BAD_PORT);
3853 ofconn_send_replies(ofconn, &cbdata.replies);
3855 ofpbuf_list_delete(&cbdata.replies);
3862 is_flow_deletion_pending(const struct ofproto *ofproto,
3863 const struct cls_rule *cls_rule,
3865 OVS_REQUIRES(ofproto_mutex)
3867 if (!hmap_is_empty(&ofproto->deletions)) {
3868 struct ofoperation *op;
3870 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3871 cls_rule_hash(cls_rule, table_id),
3872 &ofproto->deletions) {
3873 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3883 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3884 OVS_REQUIRES(ofproto_mutex)
3885 OVS_NO_THREAD_SAFETY_ANALYSIS
3887 return classifier_count(&table->cls) + extra_space > table->max_flows;
3891 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3892 unsigned int extra_space)
3893 OVS_REQUIRES(ofproto_mutex)
3895 while (should_evict_a_rule(table, extra_space)) {
3898 if (!choose_rule_to_evict(table, &rule)) {
3899 return OFPERR_OFPFMFC_TABLE_FULL;
3900 } else if (rule->pending) {
3901 return OFPROTO_POSTPONE;
3903 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3904 delete_flow__(rule, group, OFPRR_EVICTION);
3905 ofopgroup_submit(group);
3912 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3913 * in which no matching flow already exists in the flow table.
3915 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3916 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3917 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3918 * initiated now but may be retried later.
3920 * The caller retains ownership of 'fm->ofpacts'.
3922 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3925 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3926 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3927 OVS_REQUIRES(ofproto_mutex)
3929 struct oftable *table;
3930 struct ofopgroup *group;
3936 error = check_table_id(ofproto, fm->table_id);
3942 if (fm->table_id == 0xff) {
3943 if (ofproto->ofproto_class->rule_choose_table) {
3944 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3950 ovs_assert(table_id < ofproto->n_tables);
3954 } else if (fm->table_id < ofproto->n_tables) {
3955 table_id = fm->table_id;
3957 return OFPERR_OFPBRC_BAD_TABLE_ID;
3960 table = &ofproto->tables[table_id];
3962 if (table->flags & OFTABLE_READONLY) {
3963 return OFPERR_OFPBRC_EPERM;
3966 cls_rule_init(&cr, &fm->match, fm->priority);
3968 /* Transform "add" into "modify" if there's an existing identical flow. */
3969 ovs_rwlock_rdlock(&table->cls.rwlock);
3970 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
3971 ovs_rwlock_unlock(&table->cls.rwlock);
3973 cls_rule_destroy(&cr);
3974 if (!rule_is_modifiable(rule)) {
3975 return OFPERR_OFPBRC_EPERM;
3976 } else if (rule->pending) {
3977 return OFPROTO_POSTPONE;
3979 struct rule_collection rules;
3981 rule_collection_init(&rules);
3982 rule_collection_add(&rules, rule);
3983 fm->modify_cookie = true;
3984 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
3985 rule_collection_destroy(&rules);
3991 /* Serialize against pending deletion. */
3992 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
3993 cls_rule_destroy(&cr);
3994 return OFPROTO_POSTPONE;
3997 /* Check for overlap, if requested. */
3998 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4001 ovs_rwlock_rdlock(&table->cls.rwlock);
4002 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4003 ovs_rwlock_unlock(&table->cls.rwlock);
4006 cls_rule_destroy(&cr);
4007 return OFPERR_OFPFMFC_OVERLAP;
4011 /* If necessary, evict an existing rule to clear out space. */
4012 error = evict_rules_from_table(ofproto, table, 1);
4014 cls_rule_destroy(&cr);
4018 /* Allocate new rule. */
4019 rule = ofproto->ofproto_class->rule_alloc();
4021 cls_rule_destroy(&cr);
4022 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4023 ofproto->name, ovs_strerror(error));
4027 /* Initialize base state. */
4028 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4029 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4030 atomic_init(&rule->ref_count, 1);
4031 rule->pending = NULL;
4032 rule->flow_cookie = fm->new_cookie;
4033 rule->created = rule->modified = rule->used = time_msec();
4035 ovs_mutex_init(&rule->mutex);
4036 ovs_mutex_lock(&rule->mutex);
4037 rule->idle_timeout = fm->idle_timeout;
4038 rule->hard_timeout = fm->hard_timeout;
4039 ovs_mutex_unlock(&rule->mutex);
4041 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4042 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4043 rule->actions = rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len);
4044 list_init(&rule->meter_list_node);
4045 rule->eviction_group = NULL;
4046 list_init(&rule->expirable);
4047 rule->monitor_flags = 0;
4048 rule->add_seqno = 0;
4049 rule->modify_seqno = 0;
4051 /* Construct rule, initializing derived state. */
4052 error = ofproto->ofproto_class->rule_construct(rule);
4054 ofproto_rule_destroy__(rule);
4059 oftable_insert_rule(rule);
4061 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4062 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4063 ofproto->ofproto_class->rule_insert(rule);
4064 ofopgroup_submit(group);
4069 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4071 /* Modifies the rules listed in 'rules', changing their actions to match those
4074 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4077 * Returns 0 on success, otherwise an OpenFlow error code. */
4079 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4080 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4081 const struct rule_collection *rules)
4082 OVS_REQUIRES(ofproto_mutex)
4084 enum ofoperation_type type;
4085 struct ofopgroup *group;
4089 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4090 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4091 error = OFPERR_OFPBRC_EPERM;
4092 for (i = 0; i < rules->n; i++) {
4093 struct rule *rule = rules->rules[i];
4094 struct ofoperation *op;
4095 bool actions_changed;
4096 bool reset_counters;
4098 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4100 if (rule_is_modifiable(rule)) {
4101 /* At least one rule is modifiable, don't report EPERM error. */
4107 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4108 rule->actions->ofpacts,
4109 rule->actions->ofpacts_len);
4111 op = ofoperation_create(group, rule, type, 0);
4113 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4114 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4116 if (type == OFOPERATION_REPLACE) {
4117 ovs_mutex_lock(&rule->mutex);
4118 rule->idle_timeout = fm->idle_timeout;
4119 rule->hard_timeout = fm->hard_timeout;
4120 ovs_mutex_unlock(&rule->mutex);
4122 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4123 if (fm->idle_timeout || fm->hard_timeout) {
4124 if (!rule->eviction_group) {
4125 eviction_group_add_rule(rule);
4128 eviction_group_remove_rule(rule);
4132 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4133 if (actions_changed || reset_counters) {
4134 struct rule_actions *new_actions;
4136 op->actions = rule->actions;
4137 new_actions = rule_actions_create(ofproto,
4138 fm->ofpacts, fm->ofpacts_len);
4140 ovs_mutex_lock(&rule->mutex);
4141 rule->actions = new_actions;
4142 ovs_mutex_unlock(&rule->mutex);
4144 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4147 ofoperation_complete(op, 0);
4150 ofopgroup_submit(group);
4156 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4157 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4158 OVS_REQUIRES(ofproto_mutex)
4160 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4163 return add_flow(ofproto, ofconn, fm, request);
4166 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4169 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4172 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4173 struct ofputil_flow_mod *fm,
4174 const struct ofp_header *request)
4175 OVS_REQUIRES(ofproto_mutex)
4177 struct rule_criteria criteria;
4178 struct rule_collection rules;
4181 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4182 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4183 error = collect_rules_loose(ofproto, &criteria, &rules);
4184 rule_criteria_destroy(&criteria);
4187 error = (rules.n > 0
4188 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4189 : modify_flows_add(ofproto, ofconn, fm, request));
4192 rule_collection_destroy(&rules);
4197 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4200 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4203 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4204 struct ofputil_flow_mod *fm,
4205 const struct ofp_header *request)
4206 OVS_REQUIRES(ofproto_mutex)
4208 struct rule_criteria criteria;
4209 struct rule_collection rules;
4212 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4213 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4214 error = collect_rules_strict(ofproto, &criteria, &rules);
4215 rule_criteria_destroy(&criteria);
4219 error = modify_flows_add(ofproto, ofconn, fm, request);
4220 } else if (rules.n == 1) {
4221 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4225 rule_collection_destroy(&rules);
4230 /* OFPFC_DELETE implementation. */
4233 delete_flow__(struct rule *rule, struct ofopgroup *group,
4234 enum ofp_flow_removed_reason reason)
4235 OVS_REQUIRES(ofproto_mutex)
4237 struct ofproto *ofproto = rule->ofproto;
4239 ofproto_rule_send_removed(rule, reason);
4241 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4242 oftable_remove_rule(rule);
4243 ofproto->ofproto_class->rule_delete(rule);
4246 /* Deletes the rules listed in 'rules'.
4248 * Returns 0 on success, otherwise an OpenFlow error code. */
4250 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4251 const struct ofp_header *request,
4252 const struct rule_collection *rules,
4253 enum ofp_flow_removed_reason reason)
4254 OVS_REQUIRES(ofproto_mutex)
4256 struct ofopgroup *group;
4259 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4260 for (i = 0; i < rules->n; i++) {
4261 delete_flow__(rules->rules[i], group, reason);
4263 ofopgroup_submit(group);
4268 /* Implements OFPFC_DELETE. */
4270 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4271 const struct ofputil_flow_mod *fm,
4272 const struct ofp_header *request)
4273 OVS_REQUIRES(ofproto_mutex)
4275 struct rule_criteria criteria;
4276 struct rule_collection rules;
4279 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4280 fm->cookie, fm->cookie_mask,
4281 fm->out_port, fm->out_group);
4282 error = collect_rules_loose(ofproto, &criteria, &rules);
4283 rule_criteria_destroy(&criteria);
4285 if (!error && rules.n > 0) {
4286 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4288 rule_collection_destroy(&rules);
4293 /* Implements OFPFC_DELETE_STRICT. */
4295 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4296 const struct ofputil_flow_mod *fm,
4297 const struct ofp_header *request)
4298 OVS_REQUIRES(ofproto_mutex)
4300 struct rule_criteria criteria;
4301 struct rule_collection rules;
4304 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4305 fm->cookie, fm->cookie_mask,
4306 fm->out_port, fm->out_group);
4307 error = collect_rules_strict(ofproto, &criteria, &rules);
4308 rule_criteria_destroy(&criteria);
4310 if (!error && rules.n > 0) {
4311 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4313 rule_collection_destroy(&rules);
4319 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4320 OVS_REQUIRES(ofproto_mutex)
4322 struct ofputil_flow_removed fr;
4324 if (ofproto_rule_is_hidden(rule) ||
4325 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4329 minimatch_expand(&rule->cr.match, &fr.match);
4330 fr.priority = rule->cr.priority;
4331 fr.cookie = rule->flow_cookie;
4333 fr.table_id = rule->table_id;
4334 calc_duration(rule->created, time_msec(),
4335 &fr.duration_sec, &fr.duration_nsec);
4336 ovs_mutex_lock(&rule->mutex);
4337 fr.idle_timeout = rule->idle_timeout;
4338 fr.hard_timeout = rule->hard_timeout;
4339 ovs_mutex_unlock(&rule->mutex);
4340 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4343 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4346 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4347 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4350 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4353 * ofproto implementation ->run() functions should use this function to expire
4354 * OpenFlow flows. */
4356 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4357 OVS_REQUIRES(ofproto_mutex)
4359 struct ofproto *ofproto = rule->ofproto;
4361 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4362 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4364 ofproto_rule_delete__(ofproto, rule, reason);
4367 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4368 * means "infinite". */
4370 reduce_timeout(uint16_t max, uint16_t *timeout)
4372 if (max && (!*timeout || *timeout > max)) {
4377 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4378 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4379 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4381 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4383 ofproto_rule_reduce_timeouts(struct rule *rule,
4384 uint16_t idle_timeout, uint16_t hard_timeout)
4385 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4387 if (!idle_timeout && !hard_timeout) {
4391 ovs_mutex_lock(&ofproto_mutex);
4392 if (list_is_empty(&rule->expirable)) {
4393 list_insert(&rule->ofproto->expirable, &rule->expirable);
4395 ovs_mutex_unlock(&ofproto_mutex);
4397 ovs_mutex_lock(&rule->mutex);
4398 reduce_timeout(idle_timeout, &rule->idle_timeout);
4399 reduce_timeout(hard_timeout, &rule->hard_timeout);
4400 ovs_mutex_unlock(&rule->mutex);
4404 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4405 OVS_EXCLUDED(ofproto_mutex)
4407 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4408 struct ofputil_flow_mod fm;
4409 uint64_t ofpacts_stub[1024 / 8];
4410 struct ofpbuf ofpacts;
4414 error = reject_slave_controller(ofconn);
4419 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4420 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4422 u16_to_ofp(ofproto->max_ports),
4425 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4428 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4431 goto exit_free_ofpacts;
4434 /* Record the operation for logging a summary report. */
4435 switch (fm.command) {
4441 case OFPFC_MODIFY_STRICT:
4442 ofproto->n_modify++;
4446 case OFPFC_DELETE_STRICT:
4447 ofproto->n_delete++;
4452 if (ofproto->next_op_report == LLONG_MAX) {
4453 ofproto->first_op = now;
4454 ofproto->next_op_report = MAX(now + 10 * 1000,
4455 ofproto->op_backoff);
4456 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
4458 ofproto->last_op = now;
4461 ofpbuf_uninit(&ofpacts);
4467 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4468 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4469 OVS_EXCLUDED(ofproto_mutex)
4473 ovs_mutex_lock(&ofproto_mutex);
4474 if (ofproto->n_pending < 50) {
4475 switch (fm->command) {
4477 error = add_flow(ofproto, ofconn, fm, oh);
4481 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4484 case OFPFC_MODIFY_STRICT:
4485 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4489 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4492 case OFPFC_DELETE_STRICT:
4493 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4497 if (fm->command > 0xff) {
4498 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4499 "flow_mod_table_id extension is not enabled",
4502 error = OFPERR_OFPFMFC_BAD_COMMAND;
4506 ovs_assert(!list_is_empty(&ofproto->pending));
4507 error = OFPROTO_POSTPONE;
4509 ovs_mutex_unlock(&ofproto_mutex);
4511 run_rule_executes(ofproto);
4516 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4518 struct ofputil_role_request request;
4519 struct ofputil_role_request reply;
4523 error = ofputil_decode_role_message(oh, &request);
4528 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4529 if (ofconn_get_role(ofconn) != request.role
4530 && ofconn_has_pending_opgroups(ofconn)) {
4531 return OFPROTO_POSTPONE;
4534 if (request.have_generation_id
4535 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4536 return OFPERR_OFPRRFC_STALE;
4539 ofconn_set_role(ofconn, request.role);
4542 reply.role = ofconn_get_role(ofconn);
4543 reply.have_generation_id = ofconn_get_master_election_id(
4544 ofconn, &reply.generation_id);
4545 buf = ofputil_encode_role_reply(oh, &reply);
4546 ofconn_send_reply(ofconn, buf);
4552 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4553 const struct ofp_header *oh)
4555 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4556 enum ofputil_protocol cur, next;
4558 cur = ofconn_get_protocol(ofconn);
4559 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4560 ofconn_set_protocol(ofconn, next);
4566 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4568 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4569 enum ofputil_protocol cur, next;
4570 enum ofputil_protocol next_base;
4572 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4574 return OFPERR_OFPBRC_EPERM;
4577 cur = ofconn_get_protocol(ofconn);
4578 next = ofputil_protocol_set_base(cur, next_base);
4579 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4580 /* Avoid sending async messages in surprising protocol. */
4581 return OFPROTO_POSTPONE;
4584 ofconn_set_protocol(ofconn, next);
4589 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4590 const struct ofp_header *oh)
4592 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4595 format = ntohl(msg->format);
4596 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4597 return OFPERR_OFPBRC_EPERM;
4600 if (format != ofconn_get_packet_in_format(ofconn)
4601 && ofconn_has_pending_opgroups(ofconn)) {
4602 /* Avoid sending async message in surprsing packet in format. */
4603 return OFPROTO_POSTPONE;
4606 ofconn_set_packet_in_format(ofconn, format);
4611 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4613 const struct nx_async_config *msg = ofpmsg_body(oh);
4614 uint32_t master[OAM_N_TYPES];
4615 uint32_t slave[OAM_N_TYPES];
4617 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4618 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4619 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4621 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4622 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4623 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4625 ofconn_set_async_config(ofconn, master, slave);
4626 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4627 !ofconn_get_miss_send_len(ofconn)) {
4628 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4635 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4638 uint32_t master[OAM_N_TYPES];
4639 uint32_t slave[OAM_N_TYPES];
4640 struct nx_async_config *msg;
4642 ofconn_get_async_config(ofconn, master, slave);
4643 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4644 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4646 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4647 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4648 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4650 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4651 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4652 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4654 ofconn_send_reply(ofconn, buf);
4660 handle_nxt_set_controller_id(struct ofconn *ofconn,
4661 const struct ofp_header *oh)
4663 const struct nx_controller_id *nci = ofpmsg_body(oh);
4665 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4666 return OFPERR_NXBRC_MUST_BE_ZERO;
4669 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4674 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4678 if (ofconn_has_pending_opgroups(ofconn)) {
4679 return OFPROTO_POSTPONE;
4682 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4683 ? OFPRAW_OFPT10_BARRIER_REPLY
4684 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4685 ofconn_send_reply(ofconn, buf);
4690 ofproto_compose_flow_refresh_update(const struct rule *rule,
4691 enum nx_flow_monitor_flags flags,
4693 OVS_REQUIRES(ofproto_mutex)
4695 struct ofoperation *op = rule->pending;
4696 const struct rule_actions *actions;
4697 struct ofputil_flow_update fu;
4700 if (op && op->type == OFOPERATION_ADD) {
4701 /* We'll report the final flow when the operation completes. Reporting
4702 * it now would cause a duplicate report later. */
4706 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4707 ? NXFME_ADDED : NXFME_MODIFIED);
4709 ovs_mutex_lock(&rule->mutex);
4710 fu.idle_timeout = rule->idle_timeout;
4711 fu.hard_timeout = rule->hard_timeout;
4712 ovs_mutex_unlock(&rule->mutex);
4713 fu.table_id = rule->table_id;
4714 fu.cookie = rule->flow_cookie;
4715 minimatch_expand(&rule->cr.match, &match);
4717 fu.priority = rule->cr.priority;
4719 if (!(flags & NXFMF_ACTIONS)) {
4722 actions = rule->actions;
4724 /* An operation is in progress. Use the previous version of the flow's
4725 * actions, so that when the operation commits we report the change. */
4727 case OFOPERATION_ADD:
4730 case OFOPERATION_MODIFY:
4731 case OFOPERATION_REPLACE:
4732 actions = op->actions ? op->actions : rule->actions;
4735 case OFOPERATION_DELETE:
4736 actions = rule->actions;
4743 fu.ofpacts = actions ? actions->ofpacts : NULL;
4744 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4746 if (list_is_empty(msgs)) {
4747 ofputil_start_flow_update(msgs);
4749 ofputil_append_flow_update(&fu, msgs);
4753 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4755 OVS_REQUIRES(ofproto_mutex)
4759 for (i = 0; i < rules->n; i++) {
4760 struct rule *rule = rules->rules[i];
4761 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4762 rule->monitor_flags = 0;
4764 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4769 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4770 struct rule *rule, uint64_t seqno,
4771 struct rule_collection *rules)
4772 OVS_REQUIRES(ofproto_mutex)
4774 enum nx_flow_monitor_flags update;
4776 if (ofproto_rule_is_hidden(rule)) {
4781 ? ofoperation_has_out_port(rule->pending, m->out_port)
4782 : ofproto_rule_has_out_port(rule, m->out_port))) {
4787 if (rule->add_seqno > seqno) {
4788 update = NXFMF_ADD | NXFMF_MODIFY;
4789 } else if (rule->modify_seqno > seqno) {
4790 update = NXFMF_MODIFY;
4795 if (!(m->flags & update)) {
4799 update = NXFMF_INITIAL;
4802 if (!rule->monitor_flags) {
4803 rule_collection_add(rules, rule);
4805 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4809 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4811 struct rule_collection *rules)
4812 OVS_REQUIRES(ofproto_mutex)
4814 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4815 const struct ofoperation *op;
4816 const struct oftable *table;
4817 struct cls_rule target;
4819 cls_rule_init_from_minimatch(&target, &m->match, 0);
4820 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4821 struct cls_cursor cursor;
4824 ovs_rwlock_rdlock(&table->cls.rwlock);
4825 cls_cursor_init(&cursor, &table->cls, &target);
4826 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4827 ovs_assert(!rule->pending); /* XXX */
4828 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4830 ovs_rwlock_unlock(&table->cls.rwlock);
4833 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4834 struct rule *rule = op->rule;
4836 if (((m->table_id == 0xff
4837 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4838 : m->table_id == rule->table_id))
4839 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4840 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4843 cls_rule_destroy(&target);
4847 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4848 struct rule_collection *rules)
4849 OVS_REQUIRES(ofproto_mutex)
4851 if (m->flags & NXFMF_INITIAL) {
4852 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4857 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4858 uint64_t seqno, struct rule_collection *rules)
4859 OVS_REQUIRES(ofproto_mutex)
4861 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4865 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4866 OVS_EXCLUDED(ofproto_mutex)
4868 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4869 struct ofmonitor **monitors;
4870 size_t n_monitors, allocated_monitors;
4871 struct rule_collection rules;
4872 struct list replies;
4878 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4880 n_monitors = allocated_monitors = 0;
4882 ovs_mutex_lock(&ofproto_mutex);
4884 struct ofputil_flow_monitor_request request;
4885 struct ofmonitor *m;
4888 retval = ofputil_decode_flow_monitor_request(&request, &b);
4889 if (retval == EOF) {
4891 } else if (retval) {
4896 if (request.table_id != 0xff
4897 && request.table_id >= ofproto->n_tables) {
4898 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4902 error = ofmonitor_create(&request, ofconn, &m);
4907 if (n_monitors >= allocated_monitors) {
4908 monitors = x2nrealloc(monitors, &allocated_monitors,
4911 monitors[n_monitors++] = m;
4914 rule_collection_init(&rules);
4915 for (i = 0; i < n_monitors; i++) {
4916 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4919 ofpmp_init(&replies, oh);
4920 ofmonitor_compose_refresh_updates(&rules, &replies);
4921 ovs_mutex_unlock(&ofproto_mutex);
4923 rule_collection_destroy(&rules);
4925 ofconn_send_replies(ofconn, &replies);
4931 for (i = 0; i < n_monitors; i++) {
4932 ofmonitor_destroy(monitors[i]);
4935 ovs_mutex_unlock(&ofproto_mutex);
4941 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4942 OVS_EXCLUDED(ofproto_mutex)
4944 struct ofmonitor *m;
4948 id = ofputil_decode_flow_monitor_cancel(oh);
4950 ovs_mutex_lock(&ofproto_mutex);
4951 m = ofmonitor_lookup(ofconn, id);
4953 ofmonitor_destroy(m);
4956 error = OFPERR_NXBRC_FM_BAD_ID;
4958 ovs_mutex_unlock(&ofproto_mutex);
4963 /* Meters implementation.
4965 * Meter table entry, indexed by the OpenFlow meter_id.
4966 * These are always dynamically allocated to allocate enough space for
4968 * 'created' is used to compute the duration for meter stats.
4969 * 'list rules' is needed so that we can delete the dependent rules when the
4970 * meter table entry is deleted.
4971 * 'provider_meter_id' is for the provider's private use.
4974 long long int created; /* Time created. */
4975 struct list rules; /* List of "struct rule_dpif"s. */
4976 ofproto_meter_id provider_meter_id;
4977 uint16_t flags; /* Meter flags. */
4978 uint16_t n_bands; /* Number of meter bands. */
4979 struct ofputil_meter_band *bands;
4983 * This is used in instruction validation at flow set-up time,
4984 * as flows may not use non-existing meters.
4985 * Return value of UINT32_MAX signifies an invalid meter.
4988 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
4990 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
4991 const struct meter *meter = ofproto->meters[of_meter_id];
4993 return meter->provider_meter_id.uint32;
5000 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5004 meter->flags = config->flags;
5005 meter->n_bands = config->n_bands;
5006 meter->bands = xmemdup(config->bands,
5007 config->n_bands * sizeof *meter->bands);
5010 static struct meter *
5011 meter_create(const struct ofputil_meter_config *config,
5012 ofproto_meter_id provider_meter_id)
5014 struct meter *meter;
5016 meter = xzalloc(sizeof *meter);
5017 meter->provider_meter_id = provider_meter_id;
5018 meter->created = time_msec();
5019 list_init(&meter->rules);
5021 meter_update(meter, config);
5027 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5028 OVS_REQUIRES(ofproto_mutex)
5031 for (mid = first; mid <= last; ++mid) {
5032 struct meter *meter = ofproto->meters[mid];
5034 ofproto->meters[mid] = NULL;
5035 ofproto->ofproto_class->meter_del(ofproto,
5036 meter->provider_meter_id);
5044 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5046 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5047 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5051 return OFPERR_OFPMMFC_METER_EXISTS;
5054 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5057 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5058 *meterp = meter_create(&mm->meter, provider_meter_id);
5064 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5066 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5068 uint32_t provider_meter_id;
5071 return OFPERR_OFPMMFC_UNKNOWN_METER;
5074 provider_meter_id = meter->provider_meter_id.uint32;
5075 error = ofproto->ofproto_class->meter_set(ofproto,
5076 &meter->provider_meter_id,
5078 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5080 meter_update(meter, &mm->meter);
5086 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5087 struct ofputil_meter_mod *mm)
5088 OVS_EXCLUDED(ofproto_mutex)
5090 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5091 uint32_t meter_id = mm->meter.meter_id;
5092 struct rule_collection rules;
5093 enum ofperr error = 0;
5094 uint32_t first, last;
5096 if (meter_id == OFPM13_ALL) {
5098 last = ofproto->meter_features.max_meters;
5100 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5103 first = last = meter_id;
5106 /* First delete the rules that use this meter. If any of those rules are
5107 * currently being modified, postpone the whole operation until later. */
5108 rule_collection_init(&rules);
5109 ovs_mutex_lock(&ofproto_mutex);
5110 for (meter_id = first; meter_id <= last; ++meter_id) {
5111 struct meter *meter = ofproto->meters[meter_id];
5112 if (meter && !list_is_empty(&meter->rules)) {
5115 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5116 if (rule->pending) {
5117 error = OFPROTO_POSTPONE;
5120 rule_collection_add(&rules, rule);
5125 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5128 /* Delete the meters. */
5129 meter_delete(ofproto, first, last);
5132 ovs_mutex_unlock(&ofproto_mutex);
5133 rule_collection_destroy(&rules);
5139 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5141 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5142 struct ofputil_meter_mod mm;
5143 uint64_t bands_stub[256 / 8];
5144 struct ofpbuf bands;
5148 error = reject_slave_controller(ofconn);
5153 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5155 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5157 goto exit_free_bands;
5160 meter_id = mm.meter.meter_id;
5162 if (mm.command != OFPMC13_DELETE) {
5163 /* Fails also when meters are not implemented by the provider. */
5164 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5165 error = OFPERR_OFPMMFC_INVALID_METER;
5166 goto exit_free_bands;
5167 } else if (meter_id > ofproto->meter_features.max_meters) {
5168 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5169 goto exit_free_bands;
5171 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5172 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5173 goto exit_free_bands;
5177 switch (mm.command) {
5179 error = handle_add_meter(ofproto, &mm);
5182 case OFPMC13_MODIFY:
5183 error = handle_modify_meter(ofproto, &mm);
5186 case OFPMC13_DELETE:
5187 error = handle_delete_meter(ofconn, oh, &mm);
5191 error = OFPERR_OFPMMFC_BAD_COMMAND;
5196 ofpbuf_uninit(&bands);
5201 handle_meter_features_request(struct ofconn *ofconn,
5202 const struct ofp_header *request)
5204 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5205 struct ofputil_meter_features features;
5208 if (ofproto->ofproto_class->meter_get_features) {
5209 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5211 memset(&features, 0, sizeof features);
5213 b = ofputil_encode_meter_features_reply(&features, request);
5215 ofconn_send_reply(ofconn, b);
5220 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5223 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5224 struct list replies;
5225 uint64_t bands_stub[256 / 8];
5226 struct ofpbuf bands;
5227 uint32_t meter_id, first, last;
5229 ofputil_decode_meter_request(request, &meter_id);
5231 if (meter_id == OFPM13_ALL) {
5233 last = ofproto->meter_features.max_meters;
5235 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5236 !ofproto->meters[meter_id]) {
5237 return OFPERR_OFPMMFC_UNKNOWN_METER;
5239 first = last = meter_id;
5242 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5243 ofpmp_init(&replies, request);
5245 for (meter_id = first; meter_id <= last; ++meter_id) {
5246 struct meter *meter = ofproto->meters[meter_id];
5248 continue; /* Skip non-existing meters. */
5250 if (type == OFPTYPE_METER_STATS_REQUEST) {
5251 struct ofputil_meter_stats stats;
5253 stats.meter_id = meter_id;
5255 /* Provider sets the packet and byte counts, we do the rest. */
5256 stats.flow_count = list_size(&meter->rules);
5257 calc_duration(meter->created, time_msec(),
5258 &stats.duration_sec, &stats.duration_nsec);
5259 stats.n_bands = meter->n_bands;
5260 ofpbuf_clear(&bands);
5262 = ofpbuf_put_uninit(&bands,
5263 meter->n_bands * sizeof *stats.bands);
5265 if (!ofproto->ofproto_class->meter_get(ofproto,
5266 meter->provider_meter_id,
5268 ofputil_append_meter_stats(&replies, &stats);
5270 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5271 struct ofputil_meter_config config;
5273 config.meter_id = meter_id;
5274 config.flags = meter->flags;
5275 config.n_bands = meter->n_bands;
5276 config.bands = meter->bands;
5277 ofputil_append_meter_config(&replies, &config);
5281 ofconn_send_replies(ofconn, &replies);
5282 ofpbuf_uninit(&bands);
5287 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5288 struct ofgroup **group)
5289 OVS_TRY_RDLOCK(true, (*group)->rwlock)
5291 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5292 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5293 hash_int(group_id, 0), &ofproto->groups) {
5294 if ((*group)->group_id == group_id) {
5295 ovs_rwlock_rdlock(&(*group)->rwlock);
5296 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5300 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5305 ofproto_group_release(struct ofgroup *group)
5306 OVS_RELEASES(group->rwlock)
5308 ovs_rwlock_unlock(&group->rwlock);
5312 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
5313 struct ofgroup **group)
5314 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
5315 OVS_TRY_WRLOCK(true, (*group)->rwlock)
5317 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5318 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5319 hash_int(group_id, 0), &ofproto->groups) {
5320 if ((*group)->group_id == group_id) {
5321 ovs_rwlock_wrlock(&(*group)->rwlock);
5325 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5330 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5331 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5333 struct ofgroup *grp;
5335 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5336 hash_int(group_id, 0), &ofproto->groups) {
5337 if (grp->group_id == group_id) {
5345 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5346 OVS_EXCLUDED(ofproto->groups_rwlock)
5350 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5351 exists = ofproto_group_exists__(ofproto, group_id);
5352 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5358 group_get_ref_count(struct ofgroup *group)
5359 OVS_EXCLUDED(ofproto_mutex)
5361 struct ofproto *ofproto = group->ofproto;
5362 struct rule_criteria criteria;
5363 struct rule_collection rules;
5368 match_init_catchall(&match);
5369 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5370 OFPP_ANY, group->group_id);
5371 ovs_mutex_lock(&ofproto_mutex);
5372 error = collect_rules_loose(ofproto, &criteria, &rules);
5373 ovs_mutex_unlock(&ofproto_mutex);
5374 rule_criteria_destroy(&criteria);
5376 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5378 rule_collection_destroy(&rules);
5383 append_group_stats(struct ofgroup *group, struct list *replies)
5384 OVS_REQ_RDLOCK(group->rwlock)
5386 struct ofputil_group_stats ogs;
5387 struct ofproto *ofproto = group->ofproto;
5388 long long int now = time_msec();
5391 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5393 /* Provider sets the packet and byte counts, we do the rest. */
5394 ogs.ref_count = group_get_ref_count(group);
5395 ogs.n_buckets = group->n_buckets;
5397 error = (ofproto->ofproto_class->group_get_stats
5398 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5401 ogs.packet_count = UINT64_MAX;
5402 ogs.byte_count = UINT64_MAX;
5403 memset(ogs.bucket_stats, 0xff,
5404 ogs.n_buckets * sizeof *ogs.bucket_stats);
5407 ogs.group_id = group->group_id;
5408 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5410 ofputil_append_group_stats(replies, &ogs);
5412 free(ogs.bucket_stats);
5416 handle_group_stats_request(struct ofconn *ofconn,
5417 const struct ofp_header *request)
5419 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5420 struct list replies;
5422 struct ofgroup *group;
5425 error = ofputil_decode_group_stats_request(request, &group_id);
5430 ofpmp_init(&replies, request);
5432 if (group_id == OFPG_ALL) {
5433 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5434 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5435 ovs_rwlock_rdlock(&group->rwlock);
5436 append_group_stats(group, &replies);
5437 ovs_rwlock_unlock(&group->rwlock);
5439 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5441 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5442 append_group_stats(group, &replies);
5443 ofproto_group_release(group);
5447 ofconn_send_replies(ofconn, &replies);
5453 handle_group_desc_stats_request(struct ofconn *ofconn,
5454 const struct ofp_header *request)
5456 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5457 struct list replies;
5458 struct ofputil_group_desc gds;
5459 struct ofgroup *group;
5461 ofpmp_init(&replies, request);
5463 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5464 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5465 gds.group_id = group->group_id;
5466 gds.type = group->type;
5467 ofputil_append_group_desc_reply(&gds, &group->buckets, &replies);
5469 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5471 ofconn_send_replies(ofconn, &replies);
5477 handle_group_features_stats_request(struct ofconn *ofconn,
5478 const struct ofp_header *request)
5480 struct ofproto *p = ofconn_get_ofproto(ofconn);
5483 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5485 ofconn_send_reply(ofconn, msg);
5492 handle_queue_get_config_request(struct ofconn *ofconn,
5493 const struct ofp_header *oh)
5495 struct ofproto *p = ofconn_get_ofproto(ofconn);
5496 struct netdev_queue_dump queue_dump;
5497 struct ofport *ofport;
5498 unsigned int queue_id;
5499 struct ofpbuf *reply;
5500 struct smap details;
5504 error = ofputil_decode_queue_get_config_request(oh, &request);
5509 ofport = ofproto_get_port(p, request);
5511 return OFPERR_OFPQOFC_BAD_PORT;
5514 reply = ofputil_encode_queue_get_config_reply(oh);
5516 smap_init(&details);
5517 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5518 struct ofputil_queue_config queue;
5520 /* None of the existing queues have compatible properties, so we
5521 * hard-code omitting min_rate and max_rate. */
5522 queue.queue_id = queue_id;
5523 queue.min_rate = UINT16_MAX;
5524 queue.max_rate = UINT16_MAX;
5525 ofputil_append_queue_get_config_reply(reply, &queue);
5527 smap_destroy(&details);
5529 ofconn_send_reply(ofconn, reply);
5534 /* Implements OFPGC11_ADD
5535 * in which no matching flow already exists in the flow table.
5537 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5538 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5539 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5540 * initiated now but may be retried later.
5542 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5543 * ownership remains with the caller.
5545 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5548 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5550 struct ofgroup *ofgroup;
5553 if (gm->group_id > OFPG_MAX) {
5554 return OFPERR_OFPGMFC_INVALID_GROUP;
5556 if (gm->type > OFPGT11_FF) {
5557 return OFPERR_OFPGMFC_BAD_TYPE;
5560 /* Allocate new group and initialize it. */
5561 ofgroup = ofproto->ofproto_class->group_alloc();
5563 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
5564 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5567 ovs_rwlock_init(&ofgroup->rwlock);
5568 ofgroup->ofproto = ofproto;
5569 ofgroup->group_id = gm->group_id;
5570 ofgroup->type = gm->type;
5571 ofgroup->created = ofgroup->modified = time_msec();
5573 list_move(&ofgroup->buckets, &gm->buckets);
5574 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5576 /* Construct called BEFORE any locks are held. */
5577 error = ofproto->ofproto_class->group_construct(ofgroup);
5582 /* We wrlock as late as possible to minimize the time we jam any other
5583 * threads: No visible state changes before acquiring the lock. */
5584 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5586 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5587 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5591 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5592 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5597 /* Insert new group. */
5598 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5599 hash_int(ofgroup->group_id, 0));
5600 ofproto->n_groups[ofgroup->type]++;
5602 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5607 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5608 ofproto->ofproto_class->group_destruct(ofgroup);
5610 ofputil_bucket_list_destroy(&ofgroup->buckets);
5611 ofproto->ofproto_class->group_dealloc(ofgroup);
5616 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5619 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5622 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5624 struct ofgroup *ofgroup;
5625 struct ofgroup *victim;
5628 if (gm->group_id > OFPG_MAX) {
5629 return OFPERR_OFPGMFC_INVALID_GROUP;
5632 if (gm->type > OFPGT11_FF) {
5633 return OFPERR_OFPGMFC_BAD_TYPE;
5636 victim = ofproto->ofproto_class->group_alloc();
5638 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5639 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5642 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5643 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5646 /* Both group's and its container's write locks held now.
5647 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5648 if (ofgroup->type != gm->type
5649 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5650 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5655 list_move(&victim->buckets, &ofgroup->buckets);
5657 ofgroup->type = gm->type;
5658 list_move(&ofgroup->buckets, &gm->buckets);
5659 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5661 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5663 ofputil_bucket_list_destroy(&victim->buckets);
5664 ofproto->n_groups[victim->type]--;
5665 ofproto->n_groups[ofgroup->type]++;
5666 ofgroup->modified = time_msec();
5668 ofputil_bucket_list_destroy(&ofgroup->buckets);
5671 list_move(&ofgroup->buckets, &victim->buckets);
5675 ovs_rwlock_unlock(&ofgroup->rwlock);
5676 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5678 ofproto->ofproto_class->group_dealloc(victim);
5683 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5684 OVS_RELEASES(ofproto->groups_rwlock)
5687 struct ofputil_flow_mod fm;
5689 /* Delete all flow entries containing this group in a group action */
5690 match_init_catchall(&match);
5691 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5692 fm.out_group = ofgroup->group_id;
5693 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5695 /* Must wait until existing readers are done,
5696 * while holding the container's write lock at the same time. */
5697 ovs_rwlock_wrlock(&ofgroup->rwlock);
5698 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5699 /* No-one can find this group any more. */
5700 ofproto->n_groups[ofgroup->type]--;
5701 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5703 ofproto->ofproto_class->group_destruct(ofgroup);
5704 ofputil_bucket_list_destroy(&ofgroup->buckets);
5705 ovs_rwlock_unlock(&ofgroup->rwlock);
5706 ovs_rwlock_destroy(&ofgroup->rwlock);
5707 ofproto->ofproto_class->group_dealloc(ofgroup);
5710 /* Implements OFPGC_DELETE. */
5712 delete_group(struct ofproto *ofproto, uint32_t group_id)
5714 struct ofgroup *ofgroup;
5716 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5717 if (group_id == OFPG_ALL) {
5719 struct hmap_node *node = hmap_first(&ofproto->groups);
5723 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5724 delete_group__(ofproto, ofgroup);
5725 /* Lock for each node separately, so that we will not jam the
5726 * other threads for too long time. */
5727 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5730 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5731 hash_int(group_id, 0), &ofproto->groups) {
5732 if (ofgroup->group_id == group_id) {
5733 delete_group__(ofproto, ofgroup);
5738 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5742 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5744 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5745 struct ofputil_group_mod gm;
5748 error = reject_slave_controller(ofconn);
5753 error = ofputil_decode_group_mod(oh, &gm);
5758 switch (gm.command) {
5760 return add_group(ofproto, &gm);
5762 case OFPGC11_MODIFY:
5763 return modify_group(ofproto, &gm);
5765 case OFPGC11_DELETE:
5766 delete_group(ofproto, gm.group_id);
5770 if (gm.command > OFPGC11_DELETE) {
5771 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5772 ofproto->name, gm.command);
5774 return OFPERR_OFPGMFC_BAD_COMMAND;
5779 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5781 struct ofputil_table_mod tm;
5784 error = reject_slave_controller(ofconn);
5789 error = ofputil_decode_table_mod(oh, &tm);
5794 /* XXX Actual table mod support is not implemented yet. */
5799 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5800 OVS_EXCLUDED(ofproto_mutex)
5802 const struct ofp_header *oh = msg->data;
5806 error = ofptype_decode(&type, oh);
5810 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5811 && ofpmp_more(oh)) {
5812 /* We have no buffer implementation for multipart requests.
5813 * Report overflow for requests which consists of multiple
5815 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5819 /* OpenFlow requests. */
5820 case OFPTYPE_ECHO_REQUEST:
5821 return handle_echo_request(ofconn, oh);
5823 case OFPTYPE_FEATURES_REQUEST:
5824 return handle_features_request(ofconn, oh);
5826 case OFPTYPE_GET_CONFIG_REQUEST:
5827 return handle_get_config_request(ofconn, oh);
5829 case OFPTYPE_SET_CONFIG:
5830 return handle_set_config(ofconn, oh);
5832 case OFPTYPE_PACKET_OUT:
5833 return handle_packet_out(ofconn, oh);
5835 case OFPTYPE_PORT_MOD:
5836 return handle_port_mod(ofconn, oh);
5838 case OFPTYPE_FLOW_MOD:
5839 return handle_flow_mod(ofconn, oh);
5841 case OFPTYPE_GROUP_MOD:
5842 return handle_group_mod(ofconn, oh);
5844 case OFPTYPE_TABLE_MOD:
5845 return handle_table_mod(ofconn, oh);
5847 case OFPTYPE_METER_MOD:
5848 return handle_meter_mod(ofconn, oh);
5850 case OFPTYPE_BARRIER_REQUEST:
5851 return handle_barrier_request(ofconn, oh);
5853 case OFPTYPE_ROLE_REQUEST:
5854 return handle_role_request(ofconn, oh);
5856 /* OpenFlow replies. */
5857 case OFPTYPE_ECHO_REPLY:
5860 /* Nicira extension requests. */
5861 case OFPTYPE_FLOW_MOD_TABLE_ID:
5862 return handle_nxt_flow_mod_table_id(ofconn, oh);
5864 case OFPTYPE_SET_FLOW_FORMAT:
5865 return handle_nxt_set_flow_format(ofconn, oh);
5867 case OFPTYPE_SET_PACKET_IN_FORMAT:
5868 return handle_nxt_set_packet_in_format(ofconn, oh);
5870 case OFPTYPE_SET_CONTROLLER_ID:
5871 return handle_nxt_set_controller_id(ofconn, oh);
5873 case OFPTYPE_FLOW_AGE:
5874 /* Nothing to do. */
5877 case OFPTYPE_FLOW_MONITOR_CANCEL:
5878 return handle_flow_monitor_cancel(ofconn, oh);
5880 case OFPTYPE_SET_ASYNC_CONFIG:
5881 return handle_nxt_set_async_config(ofconn, oh);
5883 case OFPTYPE_GET_ASYNC_REQUEST:
5884 return handle_nxt_get_async_request(ofconn, oh);
5886 /* Statistics requests. */
5887 case OFPTYPE_DESC_STATS_REQUEST:
5888 return handle_desc_stats_request(ofconn, oh);
5890 case OFPTYPE_FLOW_STATS_REQUEST:
5891 return handle_flow_stats_request(ofconn, oh);
5893 case OFPTYPE_AGGREGATE_STATS_REQUEST:
5894 return handle_aggregate_stats_request(ofconn, oh);
5896 case OFPTYPE_TABLE_STATS_REQUEST:
5897 return handle_table_stats_request(ofconn, oh);
5899 case OFPTYPE_PORT_STATS_REQUEST:
5900 return handle_port_stats_request(ofconn, oh);
5902 case OFPTYPE_QUEUE_STATS_REQUEST:
5903 return handle_queue_stats_request(ofconn, oh);
5905 case OFPTYPE_PORT_DESC_STATS_REQUEST:
5906 return handle_port_desc_stats_request(ofconn, oh);
5908 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
5909 return handle_flow_monitor_request(ofconn, oh);
5911 case OFPTYPE_METER_STATS_REQUEST:
5912 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
5913 return handle_meter_request(ofconn, oh, type);
5915 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
5916 return handle_meter_features_request(ofconn, oh);
5918 case OFPTYPE_GROUP_STATS_REQUEST:
5919 return handle_group_stats_request(ofconn, oh);
5921 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
5922 return handle_group_desc_stats_request(ofconn, oh);
5924 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
5925 return handle_group_features_stats_request(ofconn, oh);
5927 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
5928 return handle_queue_get_config_request(ofconn, oh);
5932 case OFPTYPE_FEATURES_REPLY:
5933 case OFPTYPE_GET_CONFIG_REPLY:
5934 case OFPTYPE_PACKET_IN:
5935 case OFPTYPE_FLOW_REMOVED:
5936 case OFPTYPE_PORT_STATUS:
5937 case OFPTYPE_BARRIER_REPLY:
5938 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
5939 case OFPTYPE_DESC_STATS_REPLY:
5940 case OFPTYPE_FLOW_STATS_REPLY:
5941 case OFPTYPE_QUEUE_STATS_REPLY:
5942 case OFPTYPE_PORT_STATS_REPLY:
5943 case OFPTYPE_TABLE_STATS_REPLY:
5944 case OFPTYPE_AGGREGATE_STATS_REPLY:
5945 case OFPTYPE_PORT_DESC_STATS_REPLY:
5946 case OFPTYPE_ROLE_REPLY:
5947 case OFPTYPE_FLOW_MONITOR_PAUSED:
5948 case OFPTYPE_FLOW_MONITOR_RESUMED:
5949 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
5950 case OFPTYPE_GET_ASYNC_REPLY:
5951 case OFPTYPE_GROUP_STATS_REPLY:
5952 case OFPTYPE_GROUP_DESC_STATS_REPLY:
5953 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
5954 case OFPTYPE_METER_STATS_REPLY:
5955 case OFPTYPE_METER_CONFIG_STATS_REPLY:
5956 case OFPTYPE_METER_FEATURES_STATS_REPLY:
5957 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
5958 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
5959 case OFPTYPE_ROLE_STATUS:
5961 if (ofpmsg_is_stat_request(oh)) {
5962 return OFPERR_OFPBRC_BAD_STAT;
5964 return OFPERR_OFPBRC_BAD_TYPE;
5970 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
5971 OVS_EXCLUDED(ofproto_mutex)
5973 int error = handle_openflow__(ofconn, ofp_msg);
5974 if (error && error != OFPROTO_POSTPONE) {
5975 ofconn_send_error(ofconn, ofp_msg->data, error);
5977 COVERAGE_INC(ofproto_recv_openflow);
5978 return error != OFPROTO_POSTPONE;
5981 /* Asynchronous operations. */
5983 /* Creates and returns a new ofopgroup that is not associated with any
5984 * OpenFlow connection.
5986 * The caller should add operations to the returned group with
5987 * ofoperation_create() and then submit it with ofopgroup_submit(). */
5988 static struct ofopgroup *
5989 ofopgroup_create_unattached(struct ofproto *ofproto)
5990 OVS_REQUIRES(ofproto_mutex)
5992 struct ofopgroup *group = xzalloc(sizeof *group);
5993 group->ofproto = ofproto;
5994 list_init(&group->ofproto_node);
5995 list_init(&group->ops);
5996 list_init(&group->ofconn_node);
6000 /* Creates and returns a new ofopgroup for 'ofproto'.
6002 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6003 * connection. The 'request' and 'buffer_id' arguments are ignored.
6005 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6006 * If the ofopgroup eventually fails, then the error reply will include
6007 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6008 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6010 * The caller should add operations to the returned group with
6011 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6012 static struct ofopgroup *
6013 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6014 const struct ofp_header *request, uint32_t buffer_id)
6015 OVS_REQUIRES(ofproto_mutex)
6017 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6019 size_t request_len = ntohs(request->length);
6021 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6023 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6024 group->ofconn = ofconn;
6025 group->request = xmemdup(request, MIN(request_len, 64));
6026 group->buffer_id = buffer_id;
6031 /* Submits 'group' for processing.
6033 * If 'group' contains no operations (e.g. none were ever added, or all of the
6034 * ones that were added completed synchronously), then it is destroyed
6035 * immediately. Otherwise it is added to the ofproto's list of pending
6038 ofopgroup_submit(struct ofopgroup *group)
6039 OVS_REQUIRES(ofproto_mutex)
6041 if (!group->n_running) {
6042 ofopgroup_complete(group);
6044 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6045 group->ofproto->n_pending++;
6050 ofopgroup_complete(struct ofopgroup *group)
6051 OVS_REQUIRES(ofproto_mutex)
6053 struct ofproto *ofproto = group->ofproto;
6055 struct ofconn *abbrev_ofconn;
6056 ovs_be32 abbrev_xid;
6058 struct ofoperation *op, *next_op;
6061 ovs_assert(!group->n_running);
6064 LIST_FOR_EACH (op, group_node, &group->ops) {
6071 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6072 LIST_FOR_EACH (op, group_node, &group->ops) {
6073 if (op->type != OFOPERATION_DELETE) {
6074 struct ofpbuf *packet;
6077 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6080 struct rule_execute *re;
6084 ofproto_rule_ref(op->rule);
6086 re = xmalloc(sizeof *re);
6087 re->rule = op->rule;
6088 re->in_port = in_port;
6089 re->packet = packet;
6091 if (!guarded_list_push_back(&ofproto->rule_executes,
6092 &re->list_node, 1024)) {
6093 ofproto_rule_unref(op->rule);
6094 ofpbuf_delete(re->packet);
6103 if (!error && !list_is_empty(&group->ofconn_node)) {
6104 abbrev_ofconn = group->ofconn;
6105 abbrev_xid = group->request->xid;
6107 abbrev_ofconn = NULL;
6108 abbrev_xid = htonl(0);
6110 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6111 struct rule *rule = op->rule;
6113 /* We generally want to report the change to active OpenFlow flow
6114 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6116 - The operation failed.
6118 - The affected rule is not visible to controllers.
6120 - The operation's only effect was to update rule->modified. */
6122 || ofproto_rule_is_hidden(rule)
6123 || (op->type == OFOPERATION_MODIFY
6125 && rule->flow_cookie == op->flow_cookie))) {
6126 /* Check that we can just cast from ofoperation_type to
6127 * nx_flow_update_event. */
6128 enum nx_flow_update_event event_type;
6131 case OFOPERATION_ADD:
6132 case OFOPERATION_REPLACE:
6133 event_type = NXFME_ADDED;
6136 case OFOPERATION_DELETE:
6137 event_type = NXFME_DELETED;
6140 case OFOPERATION_MODIFY:
6141 event_type = NXFME_MODIFIED;
6148 ofmonitor_report(ofproto->connmgr, rule, event_type,
6149 op->reason, abbrev_ofconn, abbrev_xid);
6152 rule->pending = NULL;
6155 case OFOPERATION_ADD:
6159 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6160 if (vid_mask == VLAN_VID_MASK) {
6161 if (ofproto->vlan_bitmap) {
6162 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6163 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6164 bitmap_set1(ofproto->vlan_bitmap, vid);
6165 ofproto->vlans_changed = true;
6168 ofproto->vlans_changed = true;
6172 oftable_remove_rule(rule);
6173 ofproto_rule_unref(rule);
6177 case OFOPERATION_DELETE:
6178 ovs_assert(!op->error);
6179 ofproto_rule_unref(rule);
6183 case OFOPERATION_MODIFY:
6184 case OFOPERATION_REPLACE:
6186 long long int now = time_msec();
6188 rule->modified = now;
6189 if (op->type == OFOPERATION_REPLACE) {
6190 rule->created = rule->used = now;
6193 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6194 ovs_mutex_lock(&rule->mutex);
6195 rule->idle_timeout = op->idle_timeout;
6196 rule->hard_timeout = op->hard_timeout;
6197 ovs_mutex_unlock(&rule->mutex);
6199 struct rule_actions *old_actions;
6201 ovs_mutex_lock(&rule->mutex);
6202 old_actions = rule->actions;
6203 rule->actions = op->actions;
6204 ovs_mutex_unlock(&rule->mutex);
6207 rule_actions_unref(old_actions);
6209 rule->flags = op->flags;
6217 ofoperation_destroy(op);
6220 ofmonitor_flush(ofproto->connmgr);
6222 if (!list_is_empty(&group->ofproto_node)) {
6223 ovs_assert(ofproto->n_pending > 0);
6224 ofproto->n_pending--;
6225 list_remove(&group->ofproto_node);
6227 if (!list_is_empty(&group->ofconn_node)) {
6228 list_remove(&group->ofconn_node);
6230 ofconn_send_error(group->ofconn, group->request, error);
6232 connmgr_retry(ofproto->connmgr);
6234 free(group->request);
6238 /* Initiates a new operation on 'rule', of the specified 'type', within
6239 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6241 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6242 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6244 * Returns the newly created ofoperation (which is also available as
6245 * rule->pending). */
6246 static struct ofoperation *
6247 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6248 enum ofoperation_type type,
6249 enum ofp_flow_removed_reason reason)
6250 OVS_REQUIRES(ofproto_mutex)
6252 struct ofproto *ofproto = group->ofproto;
6253 struct ofoperation *op;
6255 ovs_assert(!rule->pending);
6257 op = rule->pending = xzalloc(sizeof *op);
6259 list_push_back(&group->ops, &op->group_node);
6262 op->reason = reason;
6263 op->flow_cookie = rule->flow_cookie;
6264 ovs_mutex_lock(&rule->mutex);
6265 op->idle_timeout = rule->idle_timeout;
6266 op->hard_timeout = rule->hard_timeout;
6267 ovs_mutex_unlock(&rule->mutex);
6268 op->flags = rule->flags;
6272 if (type == OFOPERATION_DELETE) {
6273 hmap_insert(&ofproto->deletions, &op->hmap_node,
6274 cls_rule_hash(&rule->cr, rule->table_id));
6281 ofoperation_destroy(struct ofoperation *op)
6282 OVS_REQUIRES(ofproto_mutex)
6284 struct ofopgroup *group = op->group;
6287 op->rule->pending = NULL;
6289 if (op->type == OFOPERATION_DELETE) {
6290 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6292 list_remove(&op->group_node);
6293 rule_actions_unref(op->actions);
6297 /* Indicates that 'op' completed with status 'error', which is either 0 to
6298 * indicate success or an OpenFlow error code on failure.
6300 * If 'error' is 0, indicating success, the operation will be committed
6301 * permanently to the flow table.
6303 * If 'error' is nonzero, then generally the operation will be rolled back:
6305 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6306 * restores the original rule. The caller must have uninitialized any
6307 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6308 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6309 * and 7 for the new rule, calling its ->rule_dealloc() function.
6311 * - If 'op' is a "modify flow" operation, ofproto restores the original
6314 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6315 * allowed to fail. It must always succeed.
6317 * Please see the large comment in ofproto/ofproto-provider.h titled
6318 * "Asynchronous Operation Support" for more information. */
6320 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6322 struct ofopgroup *group = op->group;
6324 ovs_assert(group->n_running > 0);
6325 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6328 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6329 /* This function can be called from ->rule_construct(), in which case
6330 * ofproto_mutex is held, or it can be called from ->run(), in which
6331 * case ofproto_mutex is not held. But only in the latter case can we
6332 * arrive here, so we can safely take ofproto_mutex now. */
6333 ovs_mutex_lock(&ofproto_mutex);
6334 ovs_assert(op->rule->pending == op);
6335 ofopgroup_complete(group);
6336 ovs_mutex_unlock(&ofproto_mutex);
6341 pick_datapath_id(const struct ofproto *ofproto)
6343 const struct ofport *port;
6345 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6347 uint8_t ea[ETH_ADDR_LEN];
6350 error = netdev_get_etheraddr(port->netdev, ea);
6352 return eth_addr_to_uint64(ea);
6354 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6355 ofproto->name, netdev_get_name(port->netdev),
6356 ovs_strerror(error));
6358 return ofproto->fallback_dpid;
6362 pick_fallback_dpid(void)
6364 uint8_t ea[ETH_ADDR_LEN];
6365 eth_addr_nicira_random(ea);
6366 return eth_addr_to_uint64(ea);
6369 /* Table overflow policy. */
6371 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6372 * to NULL if the table is not configured to evict rules or if the table
6373 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6374 * or with no timeouts are not evictable.) */
6376 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6377 OVS_REQUIRES(ofproto_mutex)
6379 struct eviction_group *evg;
6382 if (!table->eviction_fields) {
6386 /* In the common case, the outer and inner loops here will each be entered
6389 * - The inner loop normally "return"s in its first iteration. If the
6390 * eviction group has any evictable rules, then it always returns in
6393 * - The outer loop only iterates more than once if the largest eviction
6394 * group has no evictable rules.
6396 * - The outer loop can exit only if table's 'max_flows' is all filled up
6397 * by unevictable rules. */
6398 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6401 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6410 /* Searches 'ofproto' for tables that have more flows than their configured
6411 * maximum and that have flow eviction enabled, and evicts as many flows as
6412 * necessary and currently feasible from them.
6414 * This triggers only when an OpenFlow table has N flows in it and then the
6415 * client configures a maximum number of flows less than N. */
6417 ofproto_evict(struct ofproto *ofproto)
6419 struct oftable *table;
6421 ovs_mutex_lock(&ofproto_mutex);
6422 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6423 evict_rules_from_table(ofproto, table, 0);
6425 ovs_mutex_unlock(&ofproto_mutex);
6428 /* Eviction groups. */
6430 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6431 * rules. The priority contains low-order random bits to ensure that eviction
6432 * groups with the same number of rules are prioritized randomly. */
6434 eviction_group_priority(size_t n_rules)
6436 uint16_t size = MIN(UINT16_MAX, n_rules);
6437 return (size << 16) | random_uint16();
6440 /* Updates 'evg', an eviction_group within 'table', following a change that
6441 * adds or removes rules in 'evg'. */
6443 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6444 OVS_REQUIRES(ofproto_mutex)
6446 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6447 eviction_group_priority(heap_count(&evg->rules)));
6450 /* Destroys 'evg', an eviction_group within 'table':
6452 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6453 * rules themselves, just removes them from the eviction group.)
6455 * - Removes 'evg' from 'table'.
6459 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6460 OVS_REQUIRES(ofproto_mutex)
6462 while (!heap_is_empty(&evg->rules)) {
6465 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6466 rule->eviction_group = NULL;
6468 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6469 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6470 heap_destroy(&evg->rules);
6474 /* Removes 'rule' from its eviction group, if any. */
6476 eviction_group_remove_rule(struct rule *rule)
6477 OVS_REQUIRES(ofproto_mutex)
6479 if (rule->eviction_group) {
6480 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6481 struct eviction_group *evg = rule->eviction_group;
6483 rule->eviction_group = NULL;
6484 heap_remove(&evg->rules, &rule->evg_node);
6485 if (heap_is_empty(&evg->rules)) {
6486 eviction_group_destroy(table, evg);
6488 eviction_group_resized(table, evg);
6493 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6494 * returns the hash value. */
6496 eviction_group_hash_rule(struct rule *rule)
6497 OVS_REQUIRES(ofproto_mutex)
6499 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6500 const struct mf_subfield *sf;
6504 hash = table->eviction_group_id_basis;
6505 miniflow_expand(&rule->cr.match.flow, &flow);
6506 for (sf = table->eviction_fields;
6507 sf < &table->eviction_fields[table->n_eviction_fields];
6510 if (mf_are_prereqs_ok(sf->field, &flow)) {
6511 union mf_value value;
6513 mf_get_value(sf->field, &flow, &value);
6515 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6517 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6518 unsigned int start = sf->ofs + sf->n_bits;
6519 bitwise_zero(&value, sf->field->n_bytes, start,
6520 sf->field->n_bytes * 8 - start);
6522 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6524 hash = hash_int(hash, 0);
6531 /* Returns an eviction group within 'table' with the given 'id', creating one
6533 static struct eviction_group *
6534 eviction_group_find(struct oftable *table, uint32_t id)
6535 OVS_REQUIRES(ofproto_mutex)
6537 struct eviction_group *evg;
6539 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6543 evg = xmalloc(sizeof *evg);
6544 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6545 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6546 eviction_group_priority(0));
6547 heap_init(&evg->rules);
6552 /* Returns an eviction priority for 'rule'. The return value should be
6553 * interpreted so that higher priorities make a rule more attractive candidates
6556 rule_eviction_priority(struct rule *rule)
6557 OVS_REQUIRES(ofproto_mutex)
6559 long long int hard_expiration;
6560 long long int idle_expiration;
6561 long long int expiration;
6562 uint32_t expiration_offset;
6564 /* Calculate time of expiration. */
6565 ovs_mutex_lock(&rule->mutex);
6566 hard_expiration = (rule->hard_timeout
6567 ? rule->modified + rule->hard_timeout * 1000
6569 idle_expiration = (rule->idle_timeout
6570 ? rule->used + rule->idle_timeout * 1000
6572 expiration = MIN(hard_expiration, idle_expiration);
6573 ovs_mutex_unlock(&rule->mutex);
6574 if (expiration == LLONG_MAX) {
6578 /* Calculate the time of expiration as a number of (approximate) seconds
6579 * after program startup.
6581 * This should work OK for program runs that last UINT32_MAX seconds or
6582 * less. Therefore, please restart OVS at least once every 136 years. */
6583 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6585 /* Invert the expiration offset because we're using a max-heap. */
6586 return UINT32_MAX - expiration_offset;
6589 /* Adds 'rule' to an appropriate eviction group for its oftable's
6590 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6591 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6594 * The caller must ensure that 'rule' is not already in an eviction group. */
6596 eviction_group_add_rule(struct rule *rule)
6597 OVS_REQUIRES(ofproto_mutex)
6599 struct ofproto *ofproto = rule->ofproto;
6600 struct oftable *table = &ofproto->tables[rule->table_id];
6603 ovs_mutex_lock(&rule->mutex);
6604 has_timeout = rule->hard_timeout || rule->idle_timeout;
6605 ovs_mutex_unlock(&rule->mutex);
6607 if (table->eviction_fields && has_timeout) {
6608 struct eviction_group *evg;
6610 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6612 rule->eviction_group = evg;
6613 heap_insert(&evg->rules, &rule->evg_node,
6614 rule_eviction_priority(rule));
6615 eviction_group_resized(table, evg);
6621 /* Initializes 'table'. */
6623 oftable_init(struct oftable *table)
6625 memset(table, 0, sizeof *table);
6626 classifier_init(&table->cls, flow_segment_u32s);
6627 table->max_flows = UINT_MAX;
6630 /* Destroys 'table', including its classifier and eviction groups.
6632 * The caller is responsible for freeing 'table' itself. */
6634 oftable_destroy(struct oftable *table)
6636 ovs_rwlock_rdlock(&table->cls.rwlock);
6637 ovs_assert(classifier_is_empty(&table->cls));
6638 ovs_rwlock_unlock(&table->cls.rwlock);
6639 oftable_disable_eviction(table);
6640 classifier_destroy(&table->cls);
6644 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6645 * string, then 'table' will use its default name.
6647 * This only affects the name exposed for a table exposed through the OpenFlow
6648 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6650 oftable_set_name(struct oftable *table, const char *name)
6652 if (name && name[0]) {
6653 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6654 if (!table->name || strncmp(name, table->name, len)) {
6656 table->name = xmemdup0(name, len);
6664 /* oftables support a choice of two policies when adding a rule would cause the
6665 * number of flows in the table to exceed the configured maximum number: either
6666 * they can refuse to add the new flow or they can evict some existing flow.
6667 * This function configures the former policy on 'table'. */
6669 oftable_disable_eviction(struct oftable *table)
6670 OVS_REQUIRES(ofproto_mutex)
6672 if (table->eviction_fields) {
6673 struct eviction_group *evg, *next;
6675 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6676 &table->eviction_groups_by_id) {
6677 eviction_group_destroy(table, evg);
6679 hmap_destroy(&table->eviction_groups_by_id);
6680 heap_destroy(&table->eviction_groups_by_size);
6682 free(table->eviction_fields);
6683 table->eviction_fields = NULL;
6684 table->n_eviction_fields = 0;
6688 /* oftables support a choice of two policies when adding a rule would cause the
6689 * number of flows in the table to exceed the configured maximum number: either
6690 * they can refuse to add the new flow or they can evict some existing flow.
6691 * This function configures the latter policy on 'table', with fairness based
6692 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6693 * 'n_fields' as 0 disables fairness.) */
6695 oftable_enable_eviction(struct oftable *table,
6696 const struct mf_subfield *fields, size_t n_fields)
6697 OVS_REQUIRES(ofproto_mutex)
6699 struct cls_cursor cursor;
6702 if (table->eviction_fields
6703 && n_fields == table->n_eviction_fields
6705 || !memcmp(fields, table->eviction_fields,
6706 n_fields * sizeof *fields))) {
6711 oftable_disable_eviction(table);
6713 table->n_eviction_fields = n_fields;
6714 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6716 table->eviction_group_id_basis = random_uint32();
6717 hmap_init(&table->eviction_groups_by_id);
6718 heap_init(&table->eviction_groups_by_size);
6720 ovs_rwlock_rdlock(&table->cls.rwlock);
6721 cls_cursor_init(&cursor, &table->cls, NULL);
6722 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6723 eviction_group_add_rule(rule);
6725 ovs_rwlock_unlock(&table->cls.rwlock);
6728 /* Removes 'rule' from the oftable that contains it. */
6730 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6731 OVS_REQUIRES(ofproto_mutex)
6733 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6735 ovs_rwlock_wrlock(&cls->rwlock);
6736 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6737 ovs_rwlock_unlock(&cls->rwlock);
6739 cookies_remove(ofproto, rule);
6741 eviction_group_remove_rule(rule);
6742 if (!list_is_empty(&rule->expirable)) {
6743 list_remove(&rule->expirable);
6745 if (!list_is_empty(&rule->meter_list_node)) {
6746 list_remove(&rule->meter_list_node);
6747 list_init(&rule->meter_list_node);
6752 oftable_remove_rule(struct rule *rule)
6753 OVS_REQUIRES(ofproto_mutex)
6755 oftable_remove_rule__(rule->ofproto, rule);
6758 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6759 * the same cls_rule. */
6761 oftable_insert_rule(struct rule *rule)
6762 OVS_REQUIRES(ofproto_mutex)
6764 struct ofproto *ofproto = rule->ofproto;
6765 struct oftable *table = &ofproto->tables[rule->table_id];
6768 ovs_mutex_lock(&rule->mutex);
6769 may_expire = rule->hard_timeout || rule->idle_timeout;
6770 ovs_mutex_unlock(&rule->mutex);
6773 list_insert(&ofproto->expirable, &rule->expirable);
6776 cookies_insert(ofproto, rule);
6778 if (rule->actions->provider_meter_id != UINT32_MAX) {
6779 uint32_t meter_id = ofpacts_get_meter(rule->actions->ofpacts,
6780 rule->actions->ofpacts_len);
6781 struct meter *meter = ofproto->meters[meter_id];
6782 list_insert(&meter->rules, &rule->meter_list_node);
6784 ovs_rwlock_wrlock(&table->cls.rwlock);
6785 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6786 ovs_rwlock_unlock(&table->cls.rwlock);
6787 eviction_group_add_rule(rule);
6790 /* unixctl commands. */
6793 ofproto_lookup(const char *name)
6795 struct ofproto *ofproto;
6797 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6799 if (!strcmp(ofproto->name, name)) {
6807 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6808 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6810 struct ofproto *ofproto;
6814 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6815 ds_put_format(&results, "%s\n", ofproto->name);
6817 unixctl_command_reply(conn, ds_cstr(&results));
6818 ds_destroy(&results);
6822 ofproto_unixctl_init(void)
6824 static bool registered;
6830 unixctl_command_register("ofproto/list", "", 0, 0,
6831 ofproto_unixctl_list, NULL);
6834 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6836 * This is deprecated. It is only for compatibility with broken device drivers
6837 * in old versions of Linux that do not properly support VLANs when VLAN
6838 * devices are not used. When broken device drivers are no longer in
6839 * widespread use, we will delete these interfaces. */
6841 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6842 * (exactly) by an OpenFlow rule in 'ofproto'. */
6844 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6846 const struct oftable *oftable;
6848 free(ofproto->vlan_bitmap);
6849 ofproto->vlan_bitmap = bitmap_allocate(4096);
6850 ofproto->vlans_changed = false;
6852 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6853 const struct cls_subtable *table;
6855 ovs_rwlock_rdlock(&oftable->cls.rwlock);
6856 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.subtables) {
6857 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
6858 const struct cls_rule *rule;
6860 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
6861 uint16_t vid = miniflow_get_vid(&rule->match.flow);
6862 bitmap_set1(vlan_bitmap, vid);
6863 bitmap_set1(ofproto->vlan_bitmap, vid);
6867 ovs_rwlock_unlock(&oftable->cls.rwlock);
6871 /* Returns true if new VLANs have come into use by the flow table since the
6872 * last call to ofproto_get_vlan_usage().
6874 * We don't track when old VLANs stop being used. */
6876 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
6878 return ofproto->vlans_changed;
6881 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6882 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6883 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6884 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6885 * then the VLAN device is un-enslaved. */
6887 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
6888 ofp_port_t realdev_ofp_port, int vid)
6890 struct ofport *ofport;
6893 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
6895 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
6897 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
6898 ofproto->name, vlandev_ofp_port);
6902 if (!ofproto->ofproto_class->set_realdev) {
6903 if (!vlandev_ofp_port) {
6906 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
6910 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
6912 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
6913 ofproto->name, vlandev_ofp_port,
6914 netdev_get_name(ofport->netdev), ovs_strerror(error));