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"
30 #include "dynamic-string.h"
33 #include "meta-flow.h"
36 #include "ofp-actions.h"
37 #include "ofp-errors.h"
39 #include "ofp-print.h"
42 #include "ofproto-provider.h"
43 #include "openflow/nicira-ext.h"
44 #include "openflow/openflow.h"
48 #include "poll-loop.h"
55 #include "unaligned.h"
59 VLOG_DEFINE_THIS_MODULE(ofproto);
61 COVERAGE_DEFINE(ofproto_flush);
62 COVERAGE_DEFINE(ofproto_packet_out);
63 COVERAGE_DEFINE(ofproto_queue_req);
64 COVERAGE_DEFINE(ofproto_recv_openflow);
65 COVERAGE_DEFINE(ofproto_reinit_ports);
66 COVERAGE_DEFINE(ofproto_update_port);
69 S_OPENFLOW, /* Processing OpenFlow commands. */
70 S_EVICT, /* Evicting flows from over-limit tables. */
71 S_FLUSH, /* Deleting all flow table rules. */
74 enum ofoperation_type {
81 /* A single OpenFlow request can execute any number of operations. The
82 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
83 * ofconn to which an error reply should be sent if necessary.
85 * ofproto initiates some operations internally. These operations are still
86 * assigned to groups but will not have an associated ofconn. */
88 struct ofproto *ofproto; /* Owning ofproto. */
89 struct list ofproto_node; /* In ofproto's "pending" list. */
90 struct list ops; /* List of "struct ofoperation"s. */
91 int n_running; /* Number of ops still pending. */
93 /* Data needed to send OpenFlow reply on failure or to send a buffered
96 * If list_is_empty(ofconn_node) then this ofopgroup never had an
97 * associated ofconn or its ofconn's connection dropped after it initiated
98 * the operation. In the latter case 'ofconn' is a wild pointer that
99 * refers to freed memory, so the 'ofconn' member must be used only if
100 * !list_is_empty(ofconn_node).
102 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
103 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
104 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
105 uint32_t buffer_id; /* Buffer id from original request. */
108 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
109 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
110 const struct ofp_header *,
112 static void ofopgroup_submit(struct ofopgroup *);
113 static void ofopgroup_complete(struct ofopgroup *);
115 /* A single flow table operation. */
117 struct ofopgroup *group; /* Owning group. */
118 struct list group_node; /* In ofopgroup's "ops" list. */
119 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
120 struct rule *rule; /* Rule being operated upon. */
121 enum ofoperation_type type; /* Type of operation. */
123 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
125 struct rule_actions *actions;
127 /* OFOPERATION_DELETE. */
128 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
130 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
131 uint16_t idle_timeout; /* Rule's old idle timeout. */
132 uint16_t hard_timeout; /* Rule's old hard timeout. */
133 enum ofputil_flow_mod_flags flags; /* Rule's old flags. */
134 enum ofperr error; /* 0 if no error. */
137 static struct ofoperation *ofoperation_create(struct ofopgroup *,
139 enum ofoperation_type,
140 enum ofp_flow_removed_reason);
141 static void ofoperation_destroy(struct ofoperation *);
144 static void oftable_init(struct oftable *);
145 static void oftable_destroy(struct oftable *);
147 static void oftable_set_name(struct oftable *, const char *name);
149 static void oftable_disable_eviction(struct oftable *);
150 static void oftable_enable_eviction(struct oftable *,
151 const struct mf_subfield *fields,
154 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
155 static void oftable_remove_rule__(struct ofproto *, struct rule *)
156 OVS_REQUIRES(ofproto_mutex);
157 static void oftable_insert_rule(struct rule *);
159 /* A set of rules within a single OpenFlow table (oftable) that have the same
160 * values for the oftable's eviction_fields. A rule to be evicted, when one is
161 * needed, is taken from the eviction group that contains the greatest number
164 * An oftable owns any number of eviction groups, each of which contains any
167 * Membership in an eviction group is imprecise, based on the hash of the
168 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
169 * That is, if two rules have different eviction_fields, but those
170 * eviction_fields hash to the same value, then they will belong to the same
171 * eviction_group anyway.
173 * (When eviction is not enabled on an oftable, we don't track any eviction
174 * groups, to save time and space.) */
175 struct eviction_group {
176 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
177 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
178 struct heap rules; /* Contains "struct rule"s. */
181 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep);
182 static void ofproto_evict(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
183 static uint32_t rule_eviction_priority(struct rule *);
184 static void eviction_group_add_rule(struct rule *);
185 static void eviction_group_remove_rule(struct rule *);
187 /* Criteria that flow_mod and other operations use for selecting rules on
188 * which to operate. */
189 struct rule_criteria {
190 /* An OpenFlow table or 255 for all tables. */
193 /* OpenFlow matching criteria. Interpreted different in "loose" way by
194 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
195 * defined in the OpenFlow spec. */
198 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
199 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
200 * The rule will not be selected if M is 1 and B != C. */
202 ovs_be64 cookie_mask;
204 /* Selection based on actions within a rule:
206 * If out_port != OFPP_ANY, selects only rules that output to out_port.
207 * If out_group != OFPG_ALL, select only rules that output to out_group. */
212 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
213 const struct match *match,
214 unsigned int priority,
215 ovs_be64 cookie, ovs_be64 cookie_mask,
216 ofp_port_t out_port, uint32_t out_group);
217 static void rule_criteria_destroy(struct rule_criteria *);
219 /* A packet that needs to be passed to rule_execute().
221 * (We can't do this immediately from ofopgroup_complete() because that holds
222 * ofproto_mutex, which rule_execute() needs released.) */
223 struct rule_execute {
224 struct list list_node; /* In struct ofproto's "rule_executes" list. */
225 struct rule *rule; /* Owns a reference to the rule. */
227 struct ofpbuf *packet; /* Owns the packet. */
230 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
231 static void destroy_rule_executes(struct ofproto *);
234 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
235 static void ofport_destroy(struct ofport *);
237 static void update_port(struct ofproto *, const char *devname);
238 static int init_ports(struct ofproto *);
239 static void reinit_ports(struct ofproto *);
241 static long long int ofport_get_usage(const struct ofproto *,
242 ofp_port_t ofp_port);
243 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
244 long long int last_used);
245 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
249 * Keeps track of the currently used and recently used ofport values and is
250 * used to prevent immediate recycling of ofport values. */
251 struct ofport_usage {
252 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
253 ofp_port_t ofp_port; /* OpenFlow port number. */
254 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
255 represents in-use ofports. */
259 static void ofproto_rule_destroy__(struct rule *);
260 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
261 static bool rule_is_modifiable(const struct rule *);
264 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
265 struct ofputil_flow_mod *,
266 const struct ofp_header *);
267 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
268 struct ofputil_flow_mod *,
269 const struct ofp_header *,
270 const struct rule_collection *);
271 static void delete_flow__(struct rule *rule, struct ofopgroup *,
272 enum ofp_flow_removed_reason)
273 OVS_REQUIRES(ofproto_mutex);
274 static bool ofproto_group_exists__(const struct ofproto *ofproto,
276 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
277 static bool ofproto_group_exists(const struct ofproto *ofproto,
279 OVS_EXCLUDED(ofproto->groups_rwlock);
280 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
281 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
282 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
283 struct ofputil_flow_mod *,
284 const struct ofp_header *)
285 OVS_EXCLUDED(ofproto_mutex);
286 static void calc_duration(long long int start, long long int now,
287 uint32_t *sec, uint32_t *nsec);
290 static uint64_t pick_datapath_id(const struct ofproto *);
291 static uint64_t pick_fallback_dpid(void);
292 static void ofproto_destroy__(struct ofproto *);
293 static void update_mtu(struct ofproto *, struct ofport *);
294 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
297 static void ofproto_unixctl_init(void);
299 /* All registered ofproto classes, in probe order. */
300 static const struct ofproto_class **ofproto_classes;
301 static size_t n_ofproto_classes;
302 static size_t allocated_ofproto_classes;
304 /* Global lock that protects all flow table operations. */
305 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
307 unsigned flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT;
308 unsigned n_handler_threads;
309 enum ofproto_flow_miss_model flow_miss_model = OFPROTO_HANDLE_MISS_AUTO;
311 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
312 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
314 /* Initial mappings of port to OpenFlow number mappings. */
315 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
317 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
319 /* The default value of true waits for flow restore. */
320 static bool flow_restore_wait = true;
322 /* Must be called to initialize the ofproto library.
324 * The caller may pass in 'iface_hints', which contains an shash of
325 * "iface_hint" elements indexed by the interface's name. The provider
326 * may use these hints to describe the startup configuration in order to
327 * reinitialize its state. The caller owns the provided data, so a
328 * provider will make copies of anything required. An ofproto provider
329 * will remove any existing state that is not described by the hint, and
330 * may choose to remove it all. */
332 ofproto_init(const struct shash *iface_hints)
334 struct shash_node *node;
337 ofproto_class_register(&ofproto_dpif_class);
339 /* Make a local copy, since we don't own 'iface_hints' elements. */
340 SHASH_FOR_EACH(node, iface_hints) {
341 const struct iface_hint *orig_hint = node->data;
342 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
343 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
345 new_hint->br_name = xstrdup(orig_hint->br_name);
346 new_hint->br_type = xstrdup(br_type);
347 new_hint->ofp_port = orig_hint->ofp_port;
349 shash_add(&init_ofp_ports, node->name, new_hint);
352 for (i = 0; i < n_ofproto_classes; i++) {
353 ofproto_classes[i]->init(&init_ofp_ports);
357 /* 'type' should be a normalized datapath type, as returned by
358 * ofproto_normalize_type(). Returns the corresponding ofproto_class
359 * structure, or a null pointer if there is none registered for 'type'. */
360 static const struct ofproto_class *
361 ofproto_class_find__(const char *type)
365 for (i = 0; i < n_ofproto_classes; i++) {
366 const struct ofproto_class *class = ofproto_classes[i];
371 class->enumerate_types(&types);
372 found = sset_contains(&types, type);
373 sset_destroy(&types);
379 VLOG_WARN("unknown datapath type %s", type);
383 /* Registers a new ofproto class. After successful registration, new ofprotos
384 * of that type can be created using ofproto_create(). */
386 ofproto_class_register(const struct ofproto_class *new_class)
390 for (i = 0; i < n_ofproto_classes; i++) {
391 if (ofproto_classes[i] == new_class) {
396 if (n_ofproto_classes >= allocated_ofproto_classes) {
397 ofproto_classes = x2nrealloc(ofproto_classes,
398 &allocated_ofproto_classes,
399 sizeof *ofproto_classes);
401 ofproto_classes[n_ofproto_classes++] = new_class;
405 /* Unregisters a datapath provider. 'type' must have been previously
406 * registered and not currently be in use by any ofprotos. After
407 * unregistration new datapaths of that type cannot be opened using
408 * ofproto_create(). */
410 ofproto_class_unregister(const struct ofproto_class *class)
414 for (i = 0; i < n_ofproto_classes; i++) {
415 if (ofproto_classes[i] == class) {
416 for (i++; i < n_ofproto_classes; i++) {
417 ofproto_classes[i - 1] = ofproto_classes[i];
423 VLOG_WARN("attempted to unregister an ofproto class that is not "
428 /* Clears 'types' and enumerates all registered ofproto types into it. The
429 * caller must first initialize the sset. */
431 ofproto_enumerate_types(struct sset *types)
435 for (i = 0; i < n_ofproto_classes; i++) {
436 ofproto_classes[i]->enumerate_types(types);
440 /* Returns the fully spelled out name for the given ofproto 'type'.
442 * Normalized type string can be compared with strcmp(). Unnormalized type
443 * string might be the same even if they have different spellings. */
445 ofproto_normalize_type(const char *type)
447 return type && type[0] ? type : "system";
450 /* Clears 'names' and enumerates the names of all known created ofprotos with
451 * the given 'type'. The caller must first initialize the sset. Returns 0 if
452 * successful, otherwise a positive errno value.
454 * Some kinds of datapaths might not be practically enumerable. This is not
455 * considered an error. */
457 ofproto_enumerate_names(const char *type, struct sset *names)
459 const struct ofproto_class *class = ofproto_class_find__(type);
460 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
464 ofproto_create(const char *datapath_name, const char *datapath_type,
465 struct ofproto **ofprotop)
467 const struct ofproto_class *class;
468 struct ofproto *ofproto;
474 ofproto_unixctl_init();
476 datapath_type = ofproto_normalize_type(datapath_type);
477 class = ofproto_class_find__(datapath_type);
479 VLOG_WARN("could not create datapath %s of unknown type %s",
480 datapath_name, datapath_type);
484 ofproto = class->alloc();
486 VLOG_ERR("failed to allocate datapath %s of type %s",
487 datapath_name, datapath_type);
492 ovs_mutex_lock(&ofproto_mutex);
493 memset(ofproto, 0, sizeof *ofproto);
494 ofproto->ofproto_class = class;
495 ofproto->name = xstrdup(datapath_name);
496 ofproto->type = xstrdup(datapath_type);
497 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
498 hash_string(ofproto->name, 0));
499 ofproto->datapath_id = 0;
500 ofproto->forward_bpdu = false;
501 ofproto->fallback_dpid = pick_fallback_dpid();
502 ofproto->mfr_desc = NULL;
503 ofproto->hw_desc = NULL;
504 ofproto->sw_desc = NULL;
505 ofproto->serial_desc = NULL;
506 ofproto->dp_desc = NULL;
507 ofproto->frag_handling = OFPC_FRAG_NORMAL;
508 hmap_init(&ofproto->ports);
509 hmap_init(&ofproto->ofport_usage);
510 shash_init(&ofproto->port_by_name);
511 simap_init(&ofproto->ofp_requests);
512 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
513 ofproto->eviction_group_timer = LLONG_MIN;
514 ofproto->tables = NULL;
515 ofproto->n_tables = 0;
516 hindex_init(&ofproto->cookies);
517 list_init(&ofproto->expirable);
518 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
519 ofproto->state = S_OPENFLOW;
520 list_init(&ofproto->pending);
521 ofproto->n_pending = 0;
522 hmap_init(&ofproto->deletions);
523 guarded_list_init(&ofproto->rule_executes);
524 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
525 ofproto->first_op = ofproto->last_op = LLONG_MIN;
526 ofproto->next_op_report = LLONG_MAX;
527 ofproto->op_backoff = LLONG_MIN;
528 ofproto->vlan_bitmap = NULL;
529 ofproto->vlans_changed = false;
530 ofproto->min_mtu = INT_MAX;
531 ovs_rwlock_init(&ofproto->groups_rwlock);
532 hmap_init(&ofproto->groups);
533 ovs_mutex_unlock(&ofproto_mutex);
534 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
535 OFPGFC_SELECT_WEIGHT;
536 ofproto->ogf.max_groups[OFPGT11_ALL] = OFPG_MAX;
537 ofproto->ogf.max_groups[OFPGT11_SELECT] = OFPG_MAX;
538 ofproto->ogf.max_groups[OFPGT11_INDIRECT] = OFPG_MAX;
539 ofproto->ogf.max_groups[OFPGT11_FF] = OFPG_MAX;
540 ofproto->ogf.actions[0] =
541 (1 << OFPAT11_OUTPUT) |
542 (1 << OFPAT11_COPY_TTL_OUT) |
543 (1 << OFPAT11_COPY_TTL_IN) |
544 (1 << OFPAT11_SET_MPLS_TTL) |
545 (1 << OFPAT11_DEC_MPLS_TTL) |
546 (1 << OFPAT11_PUSH_VLAN) |
547 (1 << OFPAT11_POP_VLAN) |
548 (1 << OFPAT11_PUSH_MPLS) |
549 (1 << OFPAT11_POP_MPLS) |
550 (1 << OFPAT11_SET_QUEUE) |
551 (1 << OFPAT11_GROUP) |
552 (1 << OFPAT11_SET_NW_TTL) |
553 (1 << OFPAT11_DEC_NW_TTL) |
554 (1 << OFPAT12_SET_FIELD);
556 * (1 << OFPAT13_PUSH_PBB) |
557 * (1 << OFPAT13_POP_PBB) */
559 error = ofproto->ofproto_class->construct(ofproto);
561 VLOG_ERR("failed to open datapath %s: %s",
562 datapath_name, ovs_strerror(error));
563 ofproto_destroy__(ofproto);
567 /* Check that hidden tables, if any, are at the end. */
568 ovs_assert(ofproto->n_tables);
569 for (i = 0; i + 1 < ofproto->n_tables; i++) {
570 enum oftable_flags flags = ofproto->tables[i].flags;
571 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
573 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
576 ofproto->datapath_id = pick_datapath_id(ofproto);
579 /* Initialize meters table. */
580 if (ofproto->ofproto_class->meter_get_features) {
581 ofproto->ofproto_class->meter_get_features(ofproto,
582 &ofproto->meter_features);
584 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
586 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
587 * sizeof(struct meter *));
593 /* Must be called (only) by an ofproto implementation in its constructor
594 * function. See the large comment on 'construct' in struct ofproto_class for
597 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
599 struct oftable *table;
601 ovs_assert(!ofproto->n_tables);
602 ovs_assert(n_tables >= 1 && n_tables <= 255);
604 ofproto->n_tables = n_tables;
605 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
606 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
611 /* To be optionally called (only) by an ofproto implementation in its
612 * constructor function. See the large comment on 'construct' in struct
613 * ofproto_class for details.
615 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
616 * will then ensure that actions passed into the ofproto implementation will
617 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
618 * function is not called, there will be no such restriction.
620 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
621 * the 'max_ports' restriction. */
623 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
625 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
626 ofproto->max_ports = max_ports;
630 ofproto_get_datapath_id(const struct ofproto *ofproto)
632 return ofproto->datapath_id;
636 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
638 uint64_t old_dpid = p->datapath_id;
639 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
640 if (p->datapath_id != old_dpid) {
641 /* Force all active connections to reconnect, since there is no way to
642 * notify a controller that the datapath ID has changed. */
643 ofproto_reconnect_controllers(p);
648 ofproto_set_controllers(struct ofproto *p,
649 const struct ofproto_controller *controllers,
650 size_t n_controllers, uint32_t allowed_versions)
652 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
657 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
659 connmgr_set_fail_mode(p->connmgr, fail_mode);
662 /* Drops the connections between 'ofproto' and all of its controllers, forcing
663 * them to reconnect. */
665 ofproto_reconnect_controllers(struct ofproto *ofproto)
667 connmgr_reconnect(ofproto->connmgr);
670 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
671 * in-band control should guarantee access, in the same way that in-band
672 * control guarantees access to OpenFlow controllers. */
674 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
675 const struct sockaddr_in *extras, size_t n)
677 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
680 /* Sets the OpenFlow queue used by flows set up by in-band control on
681 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
682 * flows will use the default queue. */
684 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
686 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
689 /* Sets the number of flows at which eviction from the kernel flow table
692 ofproto_set_flow_eviction_threshold(unsigned threshold)
694 flow_eviction_threshold = MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN,
698 /* Sets the path for handling flow misses. */
700 ofproto_set_flow_miss_model(unsigned model)
702 flow_miss_model = model;
705 /* If forward_bpdu is true, the NORMAL action will forward frames with
706 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
707 * the NORMAL action will drop these frames. */
709 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
711 bool old_val = ofproto->forward_bpdu;
712 ofproto->forward_bpdu = forward_bpdu;
713 if (old_val != ofproto->forward_bpdu) {
714 if (ofproto->ofproto_class->forward_bpdu_changed) {
715 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
720 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
721 * 'idle_time', in seconds, and the maximum number of MAC table entries to
724 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
727 if (ofproto->ofproto_class->set_mac_table_config) {
728 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
733 /* Sets number of upcall handler threads. The default is
734 * (number of online cores - 2). */
736 ofproto_set_n_handler_threads(unsigned limit)
739 n_handler_threads = limit;
741 int n_proc = count_cpu_cores();
742 n_handler_threads = n_proc > 2 ? n_proc - 2 : 1;
747 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
750 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
754 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
756 return connmgr_set_snoops(ofproto->connmgr, snoops);
760 ofproto_set_netflow(struct ofproto *ofproto,
761 const struct netflow_options *nf_options)
763 if (nf_options && sset_is_empty(&nf_options->collectors)) {
767 if (ofproto->ofproto_class->set_netflow) {
768 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
770 return nf_options ? EOPNOTSUPP : 0;
775 ofproto_set_sflow(struct ofproto *ofproto,
776 const struct ofproto_sflow_options *oso)
778 if (oso && sset_is_empty(&oso->targets)) {
782 if (ofproto->ofproto_class->set_sflow) {
783 return ofproto->ofproto_class->set_sflow(ofproto, oso);
785 return oso ? EOPNOTSUPP : 0;
790 ofproto_set_ipfix(struct ofproto *ofproto,
791 const struct ofproto_ipfix_bridge_exporter_options *bo,
792 const struct ofproto_ipfix_flow_exporter_options *fo,
795 if (ofproto->ofproto_class->set_ipfix) {
796 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
798 return (bo || fo) ? EOPNOTSUPP : 0;
803 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
805 flow_restore_wait = flow_restore_wait_db;
809 ofproto_get_flow_restore_wait(void)
811 return flow_restore_wait;
815 /* Spanning Tree Protocol (STP) configuration. */
817 /* Configures STP on 'ofproto' using the settings defined in 's'. If
818 * 's' is NULL, disables STP.
820 * Returns 0 if successful, otherwise a positive errno value. */
822 ofproto_set_stp(struct ofproto *ofproto,
823 const struct ofproto_stp_settings *s)
825 return (ofproto->ofproto_class->set_stp
826 ? ofproto->ofproto_class->set_stp(ofproto, s)
830 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
831 * 'enabled' member of 's' is false, then the other members are not
834 * Returns 0 if successful, otherwise a positive errno value. */
836 ofproto_get_stp_status(struct ofproto *ofproto,
837 struct ofproto_stp_status *s)
839 return (ofproto->ofproto_class->get_stp_status
840 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
844 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
845 * in 's'. The caller is responsible for assigning STP port numbers
846 * (using the 'port_num' member in the range of 1 through 255, inclusive)
847 * and ensuring there are no duplicates. If the 's' is NULL, then STP
848 * is disabled on the port.
850 * Returns 0 if successful, otherwise a positive errno value.*/
852 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
853 const struct ofproto_port_stp_settings *s)
855 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
857 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
858 ofproto->name, ofp_port);
862 return (ofproto->ofproto_class->set_stp_port
863 ? ofproto->ofproto_class->set_stp_port(ofport, s)
867 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
868 * 's'. If the 'enabled' member in 's' is false, then the other members
869 * are not meaningful.
871 * Returns 0 if successful, otherwise a positive errno value.*/
873 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
874 struct ofproto_port_stp_status *s)
876 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
878 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
879 "port %"PRIu16, ofproto->name, ofp_port);
883 return (ofproto->ofproto_class->get_stp_port_status
884 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
888 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
889 * 's'. If the 'enabled' member in 's' is false, then the other members
890 * are not meaningful.
892 * Returns 0 if successful, otherwise a positive errno value.*/
894 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
895 struct ofproto_port_stp_stats *s)
897 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
899 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
900 "port %"PRIu16, ofproto->name, ofp_port);
904 return (ofproto->ofproto_class->get_stp_port_stats
905 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
909 /* Queue DSCP configuration. */
911 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
912 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
913 * to implement QoS. Instead, it is used to implement features which require
914 * knowledge of what queues exist on a port, and some basic information about
917 * Returns 0 if successful, otherwise a positive errno value. */
919 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
920 const struct ofproto_port_queue *queues,
923 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
926 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
927 ofproto->name, ofp_port);
931 return (ofproto->ofproto_class->set_queues
932 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
936 /* Connectivity Fault Management configuration. */
938 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
940 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
942 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
943 if (ofport && ofproto->ofproto_class->set_cfm) {
944 ofproto->ofproto_class->set_cfm(ofport, NULL);
948 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
949 * basic configuration from the configuration members in 'cfm', and the remote
950 * maintenance point ID from remote_mpid. Ignores the statistics members of
953 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
955 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
956 const struct cfm_settings *s)
958 struct ofport *ofport;
961 ofport = ofproto_get_port(ofproto, ofp_port);
963 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
964 ofproto->name, ofp_port);
968 /* XXX: For configuration simplicity, we only support one remote_mpid
969 * outside of the CFM module. It's not clear if this is the correct long
970 * term solution or not. */
971 error = (ofproto->ofproto_class->set_cfm
972 ? ofproto->ofproto_class->set_cfm(ofport, s)
975 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
976 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
977 ovs_strerror(error));
981 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
982 * 'ofproto' does not have a port 'ofp_port'. */
984 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
985 const struct smap *cfg)
987 struct ofport *ofport;
990 ofport = ofproto_get_port(ofproto, ofp_port);
992 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
993 ofproto->name, ofp_port);
997 error = (ofproto->ofproto_class->set_bfd
998 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1001 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1002 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1003 ovs_strerror(error));
1007 /* Populates 'status' with key value pairs indicating the status of the BFD
1008 * session on 'ofp_port'. This information is intended to be populated in the
1009 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
1012 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1013 struct smap *status)
1015 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1016 return (ofport && ofproto->ofproto_class->get_bfd_status
1017 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1021 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1022 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1023 * 0 if LACP partner information is not current (generally indicating a
1024 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1026 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1028 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1029 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1030 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1036 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1037 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1038 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1039 * configuration plus, if there is more than one slave, a bonding
1042 * If 'aux' is already registered then this function updates its configuration
1043 * to 's'. Otherwise, this function registers a new bundle.
1045 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1048 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1049 const struct ofproto_bundle_settings *s)
1051 return (ofproto->ofproto_class->bundle_set
1052 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1056 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1057 * If no such bundle has been registered, this has no effect. */
1059 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1061 return ofproto_bundle_register(ofproto, aux, NULL);
1065 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1066 * If 'aux' is already registered then this function updates its configuration
1067 * to 's'. Otherwise, this function registers a new mirror. */
1069 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1070 const struct ofproto_mirror_settings *s)
1072 return (ofproto->ofproto_class->mirror_set
1073 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1077 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1078 * If no mirror has been registered, this has no effect. */
1080 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1082 return ofproto_mirror_register(ofproto, aux, NULL);
1085 /* Retrieves statistics from mirror associated with client data pointer
1086 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1087 * 'bytes', respectively. If a particular counters is not supported,
1088 * the appropriate argument is set to UINT64_MAX. */
1090 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1091 uint64_t *packets, uint64_t *bytes)
1093 if (!ofproto->ofproto_class->mirror_get_stats) {
1094 *packets = *bytes = UINT64_MAX;
1098 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1102 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1103 * which all packets are flooded, instead of using MAC learning. If
1104 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1106 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1109 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1111 return (ofproto->ofproto_class->set_flood_vlans
1112 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1116 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1117 * output for a mirror. */
1119 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1121 return (ofproto->ofproto_class->is_mirror_output_bundle
1122 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1126 /* Configuration of OpenFlow tables. */
1128 /* Returns the number of OpenFlow tables in 'ofproto'. */
1130 ofproto_get_n_tables(const struct ofproto *ofproto)
1132 return ofproto->n_tables;
1135 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1136 * settings from 's'. 'table_id' must be in the range 0 through the number of
1137 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1139 * For read-only tables, only the name may be configured. */
1141 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1142 const struct ofproto_table_settings *s)
1144 struct oftable *table;
1146 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1147 table = &ofproto->tables[table_id];
1149 oftable_set_name(table, s->name);
1151 if (table->flags & OFTABLE_READONLY) {
1156 oftable_enable_eviction(table, s->groups, s->n_groups);
1158 oftable_disable_eviction(table);
1161 table->max_flows = s->max_flows;
1162 ovs_rwlock_rdlock(&table->cls.rwlock);
1163 if (classifier_count(&table->cls) > table->max_flows
1164 && table->eviction_fields) {
1165 /* 'table' contains more flows than allowed. We might not be able to
1166 * evict them right away because of the asynchronous nature of flow
1167 * table changes. Schedule eviction for later. */
1168 switch (ofproto->state) {
1170 ofproto->state = S_EVICT;
1174 /* We're already deleting flows, nothing more to do. */
1178 ovs_rwlock_unlock(&table->cls.rwlock);
1182 ofproto_has_snoops(const struct ofproto *ofproto)
1184 return connmgr_has_snoops(ofproto->connmgr);
1188 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1190 connmgr_get_snoops(ofproto->connmgr, snoops);
1194 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1196 OVS_REQUIRES(ofproto_mutex)
1198 struct ofopgroup *group;
1200 ovs_assert(!rule->pending);
1202 group = ofopgroup_create_unattached(ofproto);
1203 delete_flow__(rule, group, reason);
1204 ofopgroup_submit(group);
1207 /* Deletes 'rule' from 'cls' within 'ofproto'.
1209 * Within an ofproto implementation, this function allows an ofproto
1210 * implementation to destroy any rules that remain when its ->destruct()
1211 * function is called. This function is not suitable for use elsewhere in an
1212 * ofproto implementation.
1214 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1215 * Cycle" in ofproto-provider.h. */
1217 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1218 OVS_EXCLUDED(ofproto_mutex)
1220 struct ofopgroup *group;
1222 ovs_mutex_lock(&ofproto_mutex);
1223 ovs_assert(!rule->pending);
1225 group = ofopgroup_create_unattached(ofproto);
1226 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1227 oftable_remove_rule__(ofproto, rule);
1228 ofproto->ofproto_class->rule_delete(rule);
1229 ofopgroup_submit(group);
1231 ovs_mutex_unlock(&ofproto_mutex);
1235 ofproto_flush__(struct ofproto *ofproto)
1236 OVS_EXCLUDED(ofproto_mutex)
1238 struct oftable *table;
1240 if (ofproto->ofproto_class->flush) {
1241 ofproto->ofproto_class->flush(ofproto);
1244 ovs_mutex_lock(&ofproto_mutex);
1245 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1246 struct rule *rule, *next_rule;
1247 struct cls_cursor cursor;
1249 if (table->flags & OFTABLE_HIDDEN) {
1253 ovs_rwlock_rdlock(&table->cls.rwlock);
1254 cls_cursor_init(&cursor, &table->cls, NULL);
1255 ovs_rwlock_unlock(&table->cls.rwlock);
1256 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1257 if (!rule->pending) {
1258 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1262 ovs_mutex_unlock(&ofproto_mutex);
1265 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1268 ofproto_destroy__(struct ofproto *ofproto)
1269 OVS_EXCLUDED(ofproto_mutex)
1271 struct oftable *table;
1273 ovs_assert(list_is_empty(&ofproto->pending));
1275 destroy_rule_executes(ofproto);
1276 guarded_list_destroy(&ofproto->rule_executes);
1278 delete_group(ofproto, OFPG_ALL);
1279 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1280 hmap_destroy(&ofproto->groups);
1282 connmgr_destroy(ofproto->connmgr);
1284 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1285 free(ofproto->name);
1286 free(ofproto->type);
1287 free(ofproto->mfr_desc);
1288 free(ofproto->hw_desc);
1289 free(ofproto->sw_desc);
1290 free(ofproto->serial_desc);
1291 free(ofproto->dp_desc);
1292 hmap_destroy(&ofproto->ports);
1293 hmap_destroy(&ofproto->ofport_usage);
1294 shash_destroy(&ofproto->port_by_name);
1295 simap_destroy(&ofproto->ofp_requests);
1297 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1298 oftable_destroy(table);
1300 free(ofproto->tables);
1302 hmap_destroy(&ofproto->deletions);
1304 free(ofproto->vlan_bitmap);
1306 ofproto->ofproto_class->dealloc(ofproto);
1310 ofproto_destroy(struct ofproto *p)
1311 OVS_EXCLUDED(ofproto_mutex)
1313 struct ofport *ofport, *next_ofport;
1314 struct ofport_usage *usage, *next_usage;
1321 meter_delete(p, 1, p->meter_features.max_meters);
1322 p->meter_features.max_meters = 0;
1328 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1329 ofport_destroy(ofport);
1332 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1333 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1337 p->ofproto_class->destruct(p);
1338 ofproto_destroy__(p);
1341 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1342 * kernel datapath, for example, this destroys the datapath in the kernel, and
1343 * with the netdev-based datapath, it tears down the data structures that
1344 * represent the datapath.
1346 * The datapath should not be currently open as an ofproto. */
1348 ofproto_delete(const char *name, const char *type)
1350 const struct ofproto_class *class = ofproto_class_find__(type);
1351 return (!class ? EAFNOSUPPORT
1352 : !class->del ? EACCES
1353 : class->del(type, name));
1357 process_port_change(struct ofproto *ofproto, int error, char *devname)
1359 if (error == ENOBUFS) {
1360 reinit_ports(ofproto);
1361 } else if (!error) {
1362 update_port(ofproto, devname);
1368 ofproto_type_run(const char *datapath_type)
1370 const struct ofproto_class *class;
1373 datapath_type = ofproto_normalize_type(datapath_type);
1374 class = ofproto_class_find__(datapath_type);
1376 error = class->type_run ? class->type_run(datapath_type) : 0;
1377 if (error && error != EAGAIN) {
1378 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1379 datapath_type, ovs_strerror(error));
1385 ofproto_type_run_fast(const char *datapath_type)
1387 const struct ofproto_class *class;
1390 datapath_type = ofproto_normalize_type(datapath_type);
1391 class = ofproto_class_find__(datapath_type);
1393 error = class->type_run_fast ? class->type_run_fast(datapath_type) : 0;
1394 if (error && error != EAGAIN) {
1395 VLOG_ERR_RL(&rl, "%s: type_run_fast failed (%s)",
1396 datapath_type, ovs_strerror(error));
1402 ofproto_type_wait(const char *datapath_type)
1404 const struct ofproto_class *class;
1406 datapath_type = ofproto_normalize_type(datapath_type);
1407 class = ofproto_class_find__(datapath_type);
1409 if (class->type_wait) {
1410 class->type_wait(datapath_type);
1415 any_pending_ops(const struct ofproto *p)
1416 OVS_EXCLUDED(ofproto_mutex)
1420 ovs_mutex_lock(&ofproto_mutex);
1421 b = !list_is_empty(&p->pending);
1422 ovs_mutex_unlock(&ofproto_mutex);
1428 ofproto_run(struct ofproto *p)
1430 struct sset changed_netdevs;
1431 const char *changed_netdev;
1432 struct ofport *ofport;
1435 error = p->ofproto_class->run(p);
1436 if (error && error != EAGAIN) {
1437 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1440 run_rule_executes(p);
1442 /* Restore the eviction group heap invariant occasionally. */
1443 if (p->eviction_group_timer < time_msec()) {
1446 p->eviction_group_timer = time_msec() + 1000;
1448 for (i = 0; i < p->n_tables; i++) {
1449 struct oftable *table = &p->tables[i];
1450 struct eviction_group *evg;
1451 struct cls_cursor cursor;
1454 if (!table->eviction_fields) {
1458 ovs_mutex_lock(&ofproto_mutex);
1459 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1460 heap_rebuild(&evg->rules);
1463 ovs_rwlock_rdlock(&table->cls.rwlock);
1464 cls_cursor_init(&cursor, &table->cls, NULL);
1465 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1466 if (!rule->eviction_group
1467 && (rule->idle_timeout || rule->hard_timeout)) {
1468 eviction_group_add_rule(rule);
1471 ovs_rwlock_unlock(&table->cls.rwlock);
1472 ovs_mutex_unlock(&ofproto_mutex);
1476 if (p->ofproto_class->port_poll) {
1479 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1480 process_port_change(p, error, devname);
1484 /* Update OpenFlow port status for any port whose netdev has changed.
1486 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1487 * destroyed, so it's not safe to update ports directly from the
1488 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1489 * need this two-phase approach. */
1490 sset_init(&changed_netdevs);
1491 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1492 unsigned int change_seq = netdev_change_seq(ofport->netdev);
1493 if (ofport->change_seq != change_seq) {
1494 ofport->change_seq = change_seq;
1495 sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1498 SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1499 update_port(p, changed_netdev);
1501 sset_destroy(&changed_netdevs);
1505 connmgr_run(p->connmgr, handle_openflow);
1509 connmgr_run(p->connmgr, NULL);
1511 if (!any_pending_ops(p)) {
1512 p->state = S_OPENFLOW;
1517 connmgr_run(p->connmgr, NULL);
1519 if (!any_pending_ops(p)) {
1520 connmgr_flushed(p->connmgr);
1521 p->state = S_OPENFLOW;
1529 if (time_msec() >= p->next_op_report) {
1530 long long int ago = (time_msec() - p->first_op) / 1000;
1531 long long int interval = (p->last_op - p->first_op) / 1000;
1535 ds_put_format(&s, "%d flow_mods ",
1536 p->n_add + p->n_delete + p->n_modify);
1537 if (interval == ago) {
1538 ds_put_format(&s, "in the last %lld s", ago);
1539 } else if (interval) {
1540 ds_put_format(&s, "in the %lld s starting %lld s ago",
1543 ds_put_format(&s, "%lld s ago", ago);
1546 ds_put_cstr(&s, " (");
1548 ds_put_format(&s, "%d adds, ", p->n_add);
1551 ds_put_format(&s, "%d deletes, ", p->n_delete);
1554 ds_put_format(&s, "%d modifications, ", p->n_modify);
1557 ds_put_char(&s, ')');
1559 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1562 p->n_add = p->n_delete = p->n_modify = 0;
1563 p->next_op_report = LLONG_MAX;
1569 /* Performs periodic activity required by 'ofproto' that needs to be done
1570 * with the least possible latency.
1572 * It makes sense to call this function a couple of times per poll loop, to
1573 * provide a significant performance boost on some benchmarks with the
1574 * ofproto-dpif implementation. */
1576 ofproto_run_fast(struct ofproto *p)
1580 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1581 if (error && error != EAGAIN) {
1582 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1583 p->name, ovs_strerror(error));
1589 ofproto_wait(struct ofproto *p)
1591 struct ofport *ofport;
1593 p->ofproto_class->wait(p);
1594 if (p->ofproto_class->port_poll_wait) {
1595 p->ofproto_class->port_poll_wait(p);
1598 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1599 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1600 poll_immediate_wake();
1606 connmgr_wait(p->connmgr, true);
1611 connmgr_wait(p->connmgr, false);
1612 if (!any_pending_ops(p)) {
1613 poll_immediate_wake();
1620 ofproto_is_alive(const struct ofproto *p)
1622 return connmgr_has_controllers(p->connmgr);
1625 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1626 * memory_report(). */
1628 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1630 const struct oftable *table;
1631 unsigned int n_rules;
1633 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1635 ovs_mutex_lock(&ofproto_mutex);
1636 simap_increase(usage, "ops",
1637 ofproto->n_pending + hmap_count(&ofproto->deletions));
1638 ovs_mutex_unlock(&ofproto_mutex);
1641 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1642 ovs_rwlock_rdlock(&table->cls.rwlock);
1643 n_rules += classifier_count(&table->cls);
1644 ovs_rwlock_unlock(&table->cls.rwlock);
1646 simap_increase(usage, "rules", n_rules);
1648 if (ofproto->ofproto_class->get_memory_usage) {
1649 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1652 connmgr_get_memory_usage(ofproto->connmgr, usage);
1656 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1659 connmgr_get_controller_info(ofproto->connmgr, info);
1663 ofproto_free_ofproto_controller_info(struct shash *info)
1665 connmgr_free_controller_info(info);
1668 /* Makes a deep copy of 'old' into 'port'. */
1670 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1672 port->name = xstrdup(old->name);
1673 port->type = xstrdup(old->type);
1674 port->ofp_port = old->ofp_port;
1677 /* Frees memory allocated to members of 'ofproto_port'.
1679 * Do not call this function on an ofproto_port obtained from
1680 * ofproto_port_dump_next(): that function retains ownership of the data in the
1683 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1685 free(ofproto_port->name);
1686 free(ofproto_port->type);
1689 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1691 * This function provides no status indication. An error status for the entire
1692 * dump operation is provided when it is completed by calling
1693 * ofproto_port_dump_done().
1696 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1697 const struct ofproto *ofproto)
1699 dump->ofproto = ofproto;
1700 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1704 /* Attempts to retrieve another port from 'dump', which must have been created
1705 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1706 * 'port' and returns true. On failure, returns false.
1708 * Failure might indicate an actual error or merely that the last port has been
1709 * dumped. An error status for the entire dump operation is provided when it
1710 * is completed by calling ofproto_port_dump_done().
1712 * The ofproto owns the data stored in 'port'. It will remain valid until at
1713 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1714 * ofproto_port_dump_done(). */
1716 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1717 struct ofproto_port *port)
1719 const struct ofproto *ofproto = dump->ofproto;
1725 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1728 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1734 /* Completes port table dump operation 'dump', which must have been created
1735 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1736 * error-free, otherwise a positive errno value describing the problem. */
1738 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1740 const struct ofproto *ofproto = dump->ofproto;
1742 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1745 return dump->error == EOF ? 0 : dump->error;
1748 /* Returns the type to pass to netdev_open() when a datapath of type
1749 * 'datapath_type' has a port of type 'port_type', for a few special
1750 * cases when a netdev type differs from a port type. For example, when
1751 * using the userspace datapath, a port of type "internal" needs to be
1754 * Returns either 'type' itself or a string literal, which must not be
1757 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1759 const struct ofproto_class *class;
1761 datapath_type = ofproto_normalize_type(datapath_type);
1762 class = ofproto_class_find__(datapath_type);
1767 return (class->port_open_type
1768 ? class->port_open_type(datapath_type, port_type)
1772 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1773 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1774 * the port's OpenFlow port number.
1776 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1777 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1778 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1779 * 'ofp_portp' is non-null). */
1781 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1782 ofp_port_t *ofp_portp)
1784 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1787 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1789 const char *netdev_name = netdev_get_name(netdev);
1791 simap_put(&ofproto->ofp_requests, netdev_name,
1792 ofp_to_u16(ofp_port));
1793 update_port(ofproto, netdev_name);
1796 *ofp_portp = OFPP_NONE;
1798 struct ofproto_port ofproto_port;
1800 error = ofproto_port_query_by_name(ofproto,
1801 netdev_get_name(netdev),
1804 *ofp_portp = ofproto_port.ofp_port;
1805 ofproto_port_destroy(&ofproto_port);
1812 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1813 * initializes '*port' appropriately; on failure, returns a positive errno
1816 * The caller owns the data in 'ofproto_port' and must free it with
1817 * ofproto_port_destroy() when it is no longer needed. */
1819 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1820 struct ofproto_port *port)
1824 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1826 memset(port, 0, sizeof *port);
1831 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1832 * Returns 0 if successful, otherwise a positive errno. */
1834 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1836 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1837 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1838 struct simap_node *ofp_request_node;
1841 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1842 if (ofp_request_node) {
1843 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1846 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1847 if (!error && ofport) {
1848 /* 'name' is the netdev's name and update_port() is going to close the
1849 * netdev. Just in case update_port() refers to 'name' after it
1850 * destroys 'ofport', make a copy of it around the update_port()
1852 char *devname = xstrdup(name);
1853 update_port(ofproto, devname);
1860 flow_mod_init(struct ofputil_flow_mod *fm,
1861 const struct match *match, unsigned int priority,
1862 const struct ofpact *ofpacts, size_t ofpacts_len,
1863 enum ofp_flow_mod_command command)
1865 memset(fm, 0, sizeof *fm);
1867 fm->priority = priority;
1870 fm->modify_cookie = false;
1872 fm->command = command;
1873 fm->idle_timeout = 0;
1874 fm->hard_timeout = 0;
1875 fm->buffer_id = UINT32_MAX;
1876 fm->out_port = OFPP_ANY;
1877 fm->out_group = OFPG_ANY;
1879 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1880 fm->ofpacts_len = ofpacts_len;
1884 simple_flow_mod(struct ofproto *ofproto,
1885 const struct match *match, unsigned int priority,
1886 const struct ofpact *ofpacts, size_t ofpacts_len,
1887 enum ofp_flow_mod_command command)
1889 struct ofputil_flow_mod fm;
1891 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1893 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1896 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1897 * performs the 'n_actions' actions in 'actions'. The new flow will not
1900 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1901 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1902 * controllers; otherwise, it will be hidden.
1904 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1906 * This is a helper function for in-band control and fail-open. */
1908 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1909 unsigned int priority,
1910 const struct ofpact *ofpacts, size_t ofpacts_len)
1911 OVS_EXCLUDED(ofproto_mutex)
1913 const struct rule *rule;
1916 /* First do a cheap check whether the rule we're looking for already exists
1917 * with the actions that we want. If it does, then we're done. */
1918 ovs_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1919 rule = rule_from_cls_rule(classifier_find_match_exactly(
1920 &ofproto->tables[0].cls, match, priority));
1922 ovs_mutex_lock(&rule->mutex);
1923 must_add = !ofpacts_equal(rule->actions->ofpacts,
1924 rule->actions->ofpacts_len,
1925 ofpacts, ofpacts_len);
1926 ovs_mutex_unlock(&rule->mutex);
1930 ovs_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1932 /* If there's no such rule or the rule doesn't have the actions we want,
1933 * fall back to a executing a full flow mod. We can't optimize this at
1934 * all because we didn't take enough locks above to ensure that the flow
1935 * table didn't already change beneath us. */
1937 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1938 OFPFC_MODIFY_STRICT);
1942 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1943 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1944 * operation cannot be initiated now but may be retried later.
1946 * This is a helper function for in-band control and fail-open and the "learn"
1949 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1950 OVS_EXCLUDED(ofproto_mutex)
1952 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1955 /* Searches for a rule with matching criteria exactly equal to 'target' in
1956 * ofproto's table 0 and, if it finds one, deletes it.
1958 * This is a helper function for in-band control and fail-open. */
1960 ofproto_delete_flow(struct ofproto *ofproto,
1961 const struct match *target, unsigned int priority)
1962 OVS_EXCLUDED(ofproto_mutex)
1964 struct classifier *cls = &ofproto->tables[0].cls;
1967 /* First do a cheap check whether the rule we're looking for has already
1968 * been deleted. If so, then we're done. */
1969 ovs_rwlock_rdlock(&cls->rwlock);
1970 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
1972 ovs_rwlock_unlock(&cls->rwlock);
1977 /* Fall back to a executing a full flow mod. We can't optimize this at all
1978 * because we didn't take enough locks above to ensure that the flow table
1979 * didn't already change beneath us. */
1980 return simple_flow_mod(ofproto, target, priority, NULL, 0,
1981 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
1984 /* Starts the process of deleting all of the flows from all of ofproto's flow
1985 * tables and then reintroducing the flows required by in-band control and
1986 * fail-open. The process will complete in a later call to ofproto_run(). */
1988 ofproto_flush_flows(struct ofproto *ofproto)
1990 COVERAGE_INC(ofproto_flush);
1991 ofproto->state = S_FLUSH;
1995 reinit_ports(struct ofproto *p)
1997 struct ofproto_port_dump dump;
1998 struct sset devnames;
1999 struct ofport *ofport;
2000 struct ofproto_port ofproto_port;
2001 const char *devname;
2003 COVERAGE_INC(ofproto_reinit_ports);
2005 sset_init(&devnames);
2006 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2007 sset_add(&devnames, netdev_get_name(ofport->netdev));
2009 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2010 sset_add(&devnames, ofproto_port.name);
2013 SSET_FOR_EACH (devname, &devnames) {
2014 update_port(p, devname);
2016 sset_destroy(&devnames);
2020 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2024 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2025 port_idx = port_idx ? port_idx : UINT16_MAX;
2027 if (port_idx >= ofproto->max_ports
2028 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2029 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2030 long long int last_used_at, lru = LLONG_MAX;
2032 /* Search for a free OpenFlow port number. We try not to
2033 * immediately reuse them to prevent problems due to old
2036 * We limit the automatically assigned port numbers to the lower half
2037 * of the port range, to reserve the upper half for assignment by
2040 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2041 ofproto->alloc_port_no = 1;
2043 last_used_at = ofport_get_usage(ofproto,
2044 u16_to_ofp(ofproto->alloc_port_no));
2045 if (!last_used_at) {
2046 port_idx = ofproto->alloc_port_no;
2048 } else if ( last_used_at < time_msec() - 60*60*1000) {
2049 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2050 * more than an hour ago, consider it usable. */
2051 ofport_remove_usage(ofproto,
2052 u16_to_ofp(ofproto->alloc_port_no));
2053 port_idx = ofproto->alloc_port_no;
2055 } else if (last_used_at < lru) {
2057 lru_ofport = ofproto->alloc_port_no;
2060 if (ofproto->alloc_port_no == end_port_no) {
2062 port_idx = lru_ofport;
2069 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2070 return u16_to_ofp(port_idx);
2074 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2076 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2077 ofport_set_usage(ofproto, ofp_port, time_msec());
2081 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2082 * pointer if the netdev cannot be opened. On success, also fills in
2084 static struct netdev *
2085 ofport_open(struct ofproto *ofproto,
2086 struct ofproto_port *ofproto_port,
2087 struct ofputil_phy_port *pp)
2089 enum netdev_flags flags;
2090 struct netdev *netdev;
2093 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2095 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2096 "cannot be opened (%s)",
2098 ofproto_port->name, ofproto_port->ofp_port,
2099 ofproto_port->name, ovs_strerror(error));
2103 if (ofproto_port->ofp_port == OFPP_NONE) {
2104 if (!strcmp(ofproto->name, ofproto_port->name)) {
2105 ofproto_port->ofp_port = OFPP_LOCAL;
2107 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2108 ofproto_port->name);
2111 pp->port_no = ofproto_port->ofp_port;
2112 netdev_get_etheraddr(netdev, pp->hw_addr);
2113 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2114 netdev_get_flags(netdev, &flags);
2115 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2116 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2117 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2118 &pp->supported, &pp->peer);
2119 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2120 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2125 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2126 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2129 ofport_equal(const struct ofputil_phy_port *a,
2130 const struct ofputil_phy_port *b)
2132 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2133 && a->state == b->state
2134 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2135 && a->curr == b->curr
2136 && a->advertised == b->advertised
2137 && a->supported == b->supported
2138 && a->peer == b->peer
2139 && a->curr_speed == b->curr_speed
2140 && a->max_speed == b->max_speed);
2143 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2144 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2145 * one with the same name or port number). */
2147 ofport_install(struct ofproto *p,
2148 struct netdev *netdev, const struct ofputil_phy_port *pp)
2150 const char *netdev_name = netdev_get_name(netdev);
2151 struct ofport *ofport;
2154 /* Create ofport. */
2155 ofport = p->ofproto_class->port_alloc();
2160 ofport->ofproto = p;
2161 ofport->netdev = netdev;
2162 ofport->change_seq = netdev_change_seq(netdev);
2164 ofport->ofp_port = pp->port_no;
2165 ofport->created = time_msec();
2167 /* Add port to 'p'. */
2168 hmap_insert(&p->ports, &ofport->hmap_node,
2169 hash_ofp_port(ofport->ofp_port));
2170 shash_add(&p->port_by_name, netdev_name, ofport);
2172 update_mtu(p, ofport);
2174 /* Let the ofproto_class initialize its private data. */
2175 error = p->ofproto_class->port_construct(ofport);
2179 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
2183 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2184 p->name, netdev_name, ovs_strerror(error));
2186 ofport_destroy__(ofport);
2188 netdev_close(netdev);
2192 /* Removes 'ofport' from 'p' and destroys it. */
2194 ofport_remove(struct ofport *ofport)
2196 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
2198 ofport_destroy(ofport);
2201 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2204 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2206 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2208 ofport_remove(port);
2212 /* Updates 'port' with new 'pp' description.
2214 * Does not handle a name or port number change. The caller must implement
2215 * such a change as a delete followed by an add. */
2217 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2219 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2220 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2221 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2222 port->pp.state = pp->state;
2223 port->pp.curr = pp->curr;
2224 port->pp.advertised = pp->advertised;
2225 port->pp.supported = pp->supported;
2226 port->pp.peer = pp->peer;
2227 port->pp.curr_speed = pp->curr_speed;
2228 port->pp.max_speed = pp->max_speed;
2230 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
2233 /* Update OpenFlow 'state' in 'port' and notify controller. */
2235 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2237 if (port->pp.state != state) {
2238 port->pp.state = state;
2239 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
2245 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2247 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2249 if (port->ofproto->ofproto_class->set_realdev) {
2250 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2252 if (port->ofproto->ofproto_class->set_stp_port) {
2253 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2255 if (port->ofproto->ofproto_class->set_cfm) {
2256 port->ofproto->ofproto_class->set_cfm(port, NULL);
2258 if (port->ofproto->ofproto_class->bundle_remove) {
2259 port->ofproto->ofproto_class->bundle_remove(port);
2265 ofport_destroy__(struct ofport *port)
2267 struct ofproto *ofproto = port->ofproto;
2268 const char *name = netdev_get_name(port->netdev);
2270 hmap_remove(&ofproto->ports, &port->hmap_node);
2271 shash_delete(&ofproto->port_by_name,
2272 shash_find(&ofproto->port_by_name, name));
2274 netdev_close(port->netdev);
2275 ofproto->ofproto_class->port_dealloc(port);
2279 ofport_destroy(struct ofport *port)
2282 dealloc_ofp_port(port->ofproto, port->ofp_port);
2283 port->ofproto->ofproto_class->port_destruct(port);
2284 ofport_destroy__(port);
2289 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2291 struct ofport *port;
2293 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2295 if (port->ofp_port == ofp_port) {
2302 static long long int
2303 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2305 struct ofport_usage *usage;
2307 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2308 &ofproto->ofport_usage) {
2309 if (usage->ofp_port == ofp_port) {
2310 return usage->last_used;
2317 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2318 long long int last_used)
2320 struct ofport_usage *usage;
2321 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2322 &ofproto->ofport_usage) {
2323 if (usage->ofp_port == ofp_port) {
2324 usage->last_used = last_used;
2328 ovs_assert(last_used == LLONG_MAX);
2330 usage = xmalloc(sizeof *usage);
2331 usage->ofp_port = ofp_port;
2332 usage->last_used = last_used;
2333 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2334 hash_ofp_port(ofp_port));
2338 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2340 struct ofport_usage *usage;
2341 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2342 &ofproto->ofport_usage) {
2343 if (usage->ofp_port == ofp_port) {
2344 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2352 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2354 struct ofproto *ofproto = port->ofproto;
2357 if (ofproto->ofproto_class->port_get_stats) {
2358 error = ofproto->ofproto_class->port_get_stats(port, stats);
2367 update_port(struct ofproto *ofproto, const char *name)
2369 struct ofproto_port ofproto_port;
2370 struct ofputil_phy_port pp;
2371 struct netdev *netdev;
2372 struct ofport *port;
2374 COVERAGE_INC(ofproto_update_port);
2376 /* Fetch 'name''s location and properties from the datapath. */
2377 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2378 ? ofport_open(ofproto, &ofproto_port, &pp)
2382 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2383 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2384 struct netdev *old_netdev = port->netdev;
2386 /* 'name' hasn't changed location. Any properties changed? */
2387 if (!ofport_equal(&port->pp, &pp)) {
2388 ofport_modified(port, &pp);
2391 update_mtu(ofproto, port);
2393 /* Install the newly opened netdev in case it has changed.
2394 * Don't close the old netdev yet in case port_modified has to
2395 * remove a retained reference to it.*/
2396 port->netdev = netdev;
2397 port->change_seq = netdev_change_seq(netdev);
2399 if (port->ofproto->ofproto_class->port_modified) {
2400 port->ofproto->ofproto_class->port_modified(port);
2403 netdev_close(old_netdev);
2405 /* If 'port' is nonnull then its name differs from 'name' and thus
2406 * we should delete it. If we think there's a port named 'name'
2407 * then its port number must be wrong now so delete it too. */
2409 ofport_remove(port);
2411 ofport_remove_with_name(ofproto, name);
2412 ofport_install(ofproto, netdev, &pp);
2415 /* Any port named 'name' is gone now. */
2416 ofport_remove_with_name(ofproto, name);
2418 ofproto_port_destroy(&ofproto_port);
2422 init_ports(struct ofproto *p)
2424 struct ofproto_port_dump dump;
2425 struct ofproto_port ofproto_port;
2426 struct shash_node *node, *next;
2428 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2429 const char *name = ofproto_port.name;
2431 if (shash_find(&p->port_by_name, name)) {
2432 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2435 struct ofputil_phy_port pp;
2436 struct netdev *netdev;
2438 /* Check if an OpenFlow port number had been requested. */
2439 node = shash_find(&init_ofp_ports, name);
2441 const struct iface_hint *iface_hint = node->data;
2442 simap_put(&p->ofp_requests, name,
2443 ofp_to_u16(iface_hint->ofp_port));
2446 netdev = ofport_open(p, &ofproto_port, &pp);
2448 ofport_install(p, netdev, &pp);
2449 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2450 p->alloc_port_no = MAX(p->alloc_port_no,
2451 ofp_to_u16(ofproto_port.ofp_port));
2457 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2458 struct iface_hint *iface_hint = node->data;
2460 if (!strcmp(iface_hint->br_name, p->name)) {
2461 free(iface_hint->br_name);
2462 free(iface_hint->br_type);
2464 shash_delete(&init_ofp_ports, node);
2471 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2472 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2474 find_min_mtu(struct ofproto *p)
2476 struct ofport *ofport;
2479 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2480 struct netdev *netdev = ofport->netdev;
2483 /* Skip any internal ports, since that's what we're trying to
2485 if (!strcmp(netdev_get_type(netdev), "internal")) {
2489 if (netdev_get_mtu(netdev, &dev_mtu)) {
2492 if (!mtu || dev_mtu < mtu) {
2497 return mtu ? mtu: ETH_PAYLOAD_MAX;
2500 /* Update MTU of all datapath devices on 'p' to the minimum of the
2501 * non-datapath ports in event of 'port' added or changed. */
2503 update_mtu(struct ofproto *p, struct ofport *port)
2505 struct ofport *ofport;
2506 struct netdev *netdev = port->netdev;
2507 int dev_mtu, old_min;
2509 if (netdev_get_mtu(netdev, &dev_mtu)) {
2513 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2514 if (dev_mtu > p->min_mtu) {
2515 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2516 dev_mtu = p->min_mtu;
2519 port->mtu = dev_mtu;
2523 /* For non-internal port find new min mtu. */
2524 old_min = p->min_mtu;
2525 port->mtu = dev_mtu;
2526 p->min_mtu = find_min_mtu(p);
2527 if (p->min_mtu == old_min) {
2531 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2532 struct netdev *netdev = ofport->netdev;
2534 if (!strcmp(netdev_get_type(netdev), "internal")) {
2535 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2536 ofport->mtu = p->min_mtu;
2543 ofproto_rule_ref(struct rule *rule)
2548 atomic_add(&rule->ref_count, 1, &orig);
2549 ovs_assert(orig != 0);
2554 ofproto_rule_unref(struct rule *rule)
2559 atomic_sub(&rule->ref_count, 1, &orig);
2561 rule->ofproto->ofproto_class->rule_destruct(rule);
2562 ofproto_rule_destroy__(rule);
2564 ovs_assert(orig != 0);
2569 struct rule_actions *
2570 rule_get_actions(const struct rule *rule)
2571 OVS_EXCLUDED(rule->mutex)
2573 struct rule_actions *actions;
2575 ovs_mutex_lock(&rule->mutex);
2576 actions = rule_get_actions__(rule);
2577 ovs_mutex_unlock(&rule->mutex);
2582 struct rule_actions *
2583 rule_get_actions__(const struct rule *rule)
2584 OVS_REQUIRES(rule->mutex)
2586 rule_actions_ref(rule->actions);
2587 return rule->actions;
2591 ofproto_rule_destroy__(struct rule *rule)
2592 OVS_NO_THREAD_SAFETY_ANALYSIS
2594 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2595 rule_actions_unref(rule->actions);
2596 ovs_mutex_destroy(&rule->mutex);
2597 rule->ofproto->ofproto_class->rule_dealloc(rule);
2600 static uint32_t get_provider_meter_id(const struct ofproto *,
2601 uint32_t of_meter_id);
2603 /* Creates and returns a new 'struct rule_actions', with a ref_count of 1,
2604 * whose actions are a copy of from the 'ofpacts_len' bytes of 'ofpacts'. */
2605 struct rule_actions *
2606 rule_actions_create(const struct ofproto *ofproto,
2607 const struct ofpact *ofpacts, size_t ofpacts_len)
2609 struct rule_actions *actions;
2611 actions = xmalloc(sizeof *actions);
2612 atomic_init(&actions->ref_count, 1);
2613 actions->ofpacts = xmemdup(ofpacts, ofpacts_len);
2614 actions->ofpacts_len = ofpacts_len;
2615 actions->provider_meter_id
2616 = get_provider_meter_id(ofproto,
2617 ofpacts_get_meter(ofpacts, ofpacts_len));
2622 /* Increments 'actions''s ref_count. */
2624 rule_actions_ref(struct rule_actions *actions)
2629 atomic_add(&actions->ref_count, 1, &orig);
2630 ovs_assert(orig != 0);
2634 /* Decrements 'actions''s ref_count and frees 'actions' if the ref_count
2637 rule_actions_unref(struct rule_actions *actions)
2642 atomic_sub(&actions->ref_count, 1, &orig);
2644 free(actions->ofpacts);
2647 ovs_assert(orig != 0);
2652 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2653 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2655 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2656 OVS_REQUIRES(ofproto_mutex)
2658 return (port == OFPP_ANY
2659 || ofpacts_output_to_port(rule->actions->ofpacts,
2660 rule->actions->ofpacts_len, port));
2663 /* Returns true if 'rule' has group and equals group_id. */
2665 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2666 OVS_REQUIRES(ofproto_mutex)
2668 return (group_id == OFPG11_ANY
2669 || ofpacts_output_to_group(rule->actions->ofpacts,
2670 rule->actions->ofpacts_len, group_id));
2673 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2674 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2676 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2677 OVS_REQUIRES(ofproto_mutex)
2679 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2684 case OFOPERATION_ADD:
2685 case OFOPERATION_DELETE:
2688 case OFOPERATION_MODIFY:
2689 case OFOPERATION_REPLACE:
2690 return ofpacts_output_to_port(op->actions->ofpacts,
2691 op->actions->ofpacts_len, out_port);
2698 rule_execute_destroy(struct rule_execute *e)
2700 ofproto_rule_unref(e->rule);
2701 list_remove(&e->list_node);
2705 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2706 * by passing them to the ofproto provider. */
2708 run_rule_executes(struct ofproto *ofproto)
2709 OVS_EXCLUDED(ofproto_mutex)
2711 struct rule_execute *e, *next;
2712 struct list executes;
2714 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2715 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2716 union flow_in_port in_port_;
2719 in_port_.ofp_port = e->in_port;
2720 flow_extract(e->packet, 0, 0, NULL, &in_port_, &flow);
2721 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2723 rule_execute_destroy(e);
2727 /* Destroys and discards all "rule_execute" operations queued up in
2728 * ofproto->rule_executes. */
2730 destroy_rule_executes(struct ofproto *ofproto)
2732 struct rule_execute *e, *next;
2733 struct list executes;
2735 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2736 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2737 ofpbuf_delete(e->packet);
2738 rule_execute_destroy(e);
2742 /* Returns true if 'rule' should be hidden from the controller.
2744 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2745 * (e.g. by in-band control) and are intentionally hidden from the
2748 ofproto_rule_is_hidden(const struct rule *rule)
2750 return rule->cr.priority > UINT16_MAX;
2753 static enum oftable_flags
2754 rule_get_flags(const struct rule *rule)
2756 return rule->ofproto->tables[rule->table_id].flags;
2760 rule_is_modifiable(const struct rule *rule)
2762 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2766 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2768 ofconn_send_reply(ofconn, make_echo_reply(oh));
2773 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2775 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2776 struct ofputil_switch_features features;
2777 struct ofport *port;
2783 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2785 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2787 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2788 * if present, are always at the end.) */
2789 n_tables = ofproto->n_tables;
2790 for (i = 0; i < ofproto->n_tables; i++) {
2791 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2797 features.datapath_id = ofproto->datapath_id;
2798 features.n_buffers = pktbuf_capacity();
2799 features.n_tables = n_tables;
2800 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2801 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2803 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2805 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2806 features.auxiliary_id = 0;
2807 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2809 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2810 ofputil_put_switch_features_port(&port->pp, b);
2813 ofconn_send_reply(ofconn, b);
2818 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2820 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2821 struct ofp_switch_config *osc;
2822 enum ofp_config_flags flags;
2826 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2827 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2828 flags = ofproto->frag_handling;
2829 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2830 if (oh->version < OFP13_VERSION
2831 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2832 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2834 osc->flags = htons(flags);
2835 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2836 ofconn_send_reply(ofconn, buf);
2842 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2844 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2845 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2846 uint16_t flags = ntohs(osc->flags);
2848 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2849 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2850 enum ofp_config_flags cur = ofproto->frag_handling;
2851 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2853 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2855 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2856 ofproto->frag_handling = next;
2858 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2860 ofputil_frag_handling_to_string(next));
2864 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2865 ofconn_set_invalid_ttl_to_controller(ofconn,
2866 (oh->version < OFP13_VERSION
2867 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2869 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2874 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2875 * error message code for the caller to propagate upward. Otherwise, returns
2878 * The log message mentions 'msg_type'. */
2880 reject_slave_controller(struct ofconn *ofconn)
2882 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2883 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2884 return OFPERR_OFPBRC_EPERM;
2890 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2893 * - If they use a meter, then 'ofproto' has that meter configured.
2895 * - If they use any groups, then 'ofproto' has that group configured.
2897 * Returns 0 if successful, otherwise an OpenFlow error. */
2899 ofproto_check_ofpacts(struct ofproto *ofproto,
2900 const struct ofpact ofpacts[], size_t ofpacts_len)
2902 const struct ofpact *a;
2905 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2906 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2907 return OFPERR_OFPMMFC_INVALID_METER;
2910 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2911 if (a->type == OFPACT_GROUP
2912 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2913 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2921 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2923 struct ofproto *p = ofconn_get_ofproto(ofconn);
2924 struct ofputil_packet_out po;
2925 struct ofpbuf *payload;
2926 uint64_t ofpacts_stub[1024 / 8];
2927 struct ofpbuf ofpacts;
2929 union flow_in_port in_port_;
2932 COVERAGE_INC(ofproto_packet_out);
2934 error = reject_slave_controller(ofconn);
2939 /* Decode message. */
2940 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2941 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2943 goto exit_free_ofpacts;
2945 if (ofp_to_u16(po.in_port) >= p->max_ports
2946 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2947 error = OFPERR_OFPBRC_BAD_PORT;
2948 goto exit_free_ofpacts;
2952 if (po.buffer_id != UINT32_MAX) {
2953 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2954 if (error || !payload) {
2955 goto exit_free_ofpacts;
2958 /* Ensure that the L3 header is 32-bit aligned. */
2959 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2962 /* Verify actions against packet, then send packet if successful. */
2963 in_port_.ofp_port = po.in_port;
2964 flow_extract(payload, 0, 0, NULL, &in_port_, &flow);
2965 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
2967 error = p->ofproto_class->packet_out(p, payload, &flow,
2968 po.ofpacts, po.ofpacts_len);
2970 ofpbuf_delete(payload);
2973 ofpbuf_uninit(&ofpacts);
2979 update_port_config(struct ofport *port,
2980 enum ofputil_port_config config,
2981 enum ofputil_port_config mask)
2983 enum ofputil_port_config old_config = port->pp.config;
2984 enum ofputil_port_config toggle;
2986 toggle = (config ^ port->pp.config) & mask;
2987 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2988 if (config & OFPUTIL_PC_PORT_DOWN) {
2989 netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL);
2991 netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL);
2993 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2996 port->pp.config ^= toggle;
2997 if (port->pp.config != old_config) {
2998 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3003 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3005 struct ofproto *p = ofconn_get_ofproto(ofconn);
3006 struct ofputil_port_mod pm;
3007 struct ofport *port;
3010 error = reject_slave_controller(ofconn);
3015 error = ofputil_decode_port_mod(oh, &pm);
3020 port = ofproto_get_port(p, pm.port_no);
3022 return OFPERR_OFPPMFC_BAD_PORT;
3023 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3024 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3026 update_port_config(port, pm.config, pm.mask);
3028 netdev_set_advertisements(port->netdev, pm.advertise);
3035 handle_desc_stats_request(struct ofconn *ofconn,
3036 const struct ofp_header *request)
3038 static const char *default_mfr_desc = "Nicira, Inc.";
3039 static const char *default_hw_desc = "Open vSwitch";
3040 static const char *default_sw_desc = VERSION;
3041 static const char *default_serial_desc = "None";
3042 static const char *default_dp_desc = "None";
3044 struct ofproto *p = ofconn_get_ofproto(ofconn);
3045 struct ofp_desc_stats *ods;
3048 msg = ofpraw_alloc_stats_reply(request, 0);
3049 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3050 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3051 sizeof ods->mfr_desc);
3052 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3053 sizeof ods->hw_desc);
3054 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3055 sizeof ods->sw_desc);
3056 ovs_strlcpy(ods->serial_num,
3057 p->serial_desc ? p->serial_desc : default_serial_desc,
3058 sizeof ods->serial_num);
3059 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3060 sizeof ods->dp_desc);
3061 ofconn_send_reply(ofconn, msg);
3067 handle_table_stats_request(struct ofconn *ofconn,
3068 const struct ofp_header *request)
3070 struct ofproto *p = ofconn_get_ofproto(ofconn);
3071 struct ofp12_table_stats *ots;
3076 /* Set up default values.
3078 * ofp12_table_stats is used as a generic structure as
3079 * it is able to hold all the fields for ofp10_table_stats
3080 * and ofp11_table_stats (and of course itself).
3082 ots = xcalloc(p->n_tables, sizeof *ots);
3083 for (i = 0; i < p->n_tables; i++) {
3084 ots[i].table_id = i;
3085 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3086 ots[i].match = htonll(OFPXMT13_MASK);
3087 ots[i].wildcards = htonll(OFPXMT13_MASK);
3088 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3089 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3090 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3091 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3092 ots[i].metadata_match = OVS_BE64_MAX;
3093 ots[i].metadata_write = OVS_BE64_MAX;
3094 ots[i].instructions = htonl(OFPIT11_ALL);
3095 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3096 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3097 ovs_rwlock_rdlock(&p->tables[i].cls.rwlock);
3098 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3099 ovs_rwlock_unlock(&p->tables[i].cls.rwlock);
3102 p->ofproto_class->get_tables(p, ots);
3104 /* Post-process the tables, dropping hidden tables. */
3105 n_tables = p->n_tables;
3106 for (i = 0; i < p->n_tables; i++) {
3107 const struct oftable *table = &p->tables[i];
3109 if (table->flags & OFTABLE_HIDDEN) {
3115 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3118 if (table->max_flows < ntohl(ots[i].max_entries)) {
3119 ots[i].max_entries = htonl(table->max_flows);
3123 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3124 ofconn_send_reply(ofconn, msg);
3132 append_port_stat(struct ofport *port, struct list *replies)
3134 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3136 calc_duration(port->created, time_msec(),
3137 &ops.duration_sec, &ops.duration_nsec);
3139 /* Intentionally ignore return value, since errors will set
3140 * 'stats' to all-1s, which is correct for OpenFlow, and
3141 * netdev_get_stats() will log errors. */
3142 ofproto_port_get_stats(port, &ops.stats);
3144 ofputil_append_port_stat(replies, &ops);
3148 handle_port_stats_request(struct ofconn *ofconn,
3149 const struct ofp_header *request)
3151 struct ofproto *p = ofconn_get_ofproto(ofconn);
3152 struct ofport *port;
3153 struct list replies;
3157 error = ofputil_decode_port_stats_request(request, &port_no);
3162 ofpmp_init(&replies, request);
3163 if (port_no != OFPP_ANY) {
3164 port = ofproto_get_port(p, port_no);
3166 append_port_stat(port, &replies);
3169 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3170 append_port_stat(port, &replies);
3174 ofconn_send_replies(ofconn, &replies);
3179 handle_port_desc_stats_request(struct ofconn *ofconn,
3180 const struct ofp_header *request)
3182 struct ofproto *p = ofconn_get_ofproto(ofconn);
3183 enum ofp_version version;
3184 struct ofport *port;
3185 struct list replies;
3187 ofpmp_init(&replies, request);
3189 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
3190 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3191 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
3194 ofconn_send_replies(ofconn, &replies);
3199 hash_cookie(ovs_be64 cookie)
3201 return hash_2words((OVS_FORCE uint64_t)cookie >> 32,
3202 (OVS_FORCE uint64_t)cookie);
3206 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3207 OVS_REQUIRES(ofproto_mutex)
3209 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3210 hash_cookie(rule->flow_cookie));
3214 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3215 OVS_REQUIRES(ofproto_mutex)
3217 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3221 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3222 ovs_be64 new_cookie)
3223 OVS_REQUIRES(ofproto_mutex)
3225 if (new_cookie != rule->flow_cookie) {
3226 cookies_remove(ofproto, rule);
3228 ovs_mutex_lock(&rule->mutex);
3229 rule->flow_cookie = new_cookie;
3230 ovs_mutex_unlock(&rule->mutex);
3232 cookies_insert(ofproto, rule);
3237 calc_duration(long long int start, long long int now,
3238 uint32_t *sec, uint32_t *nsec)
3240 long long int msecs = now - start;
3241 *sec = msecs / 1000;
3242 *nsec = (msecs % 1000) * (1000 * 1000);
3245 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3246 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
3248 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3250 return (table_id == 0xff || table_id < ofproto->n_tables
3252 : OFPERR_OFPBRC_BAD_TABLE_ID);
3256 static struct oftable *
3257 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3259 struct oftable *table;
3261 for (table = &ofproto->tables[table_id];
3262 table < &ofproto->tables[ofproto->n_tables];
3264 if (!(table->flags & OFTABLE_HIDDEN)) {
3272 static struct oftable *
3273 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3275 if (table_id == 0xff) {
3276 return next_visible_table(ofproto, 0);
3277 } else if (table_id < ofproto->n_tables) {
3278 return &ofproto->tables[table_id];
3284 static struct oftable *
3285 next_matching_table(const struct ofproto *ofproto,
3286 const struct oftable *table, uint8_t table_id)
3288 return (table_id == 0xff
3289 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3293 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3295 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3296 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3298 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3299 * only once, for that table. (This can be used to access tables marked
3302 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3303 * entered at all. (Perhaps you should have validated TABLE_ID with
3304 * check_table_id().)
3306 * All parameters are evaluated multiple times.
3308 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3309 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3311 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3313 /* Initializes 'criteria' in a straightforward way based on the other
3316 * For "loose" matching, the 'priority' parameter is unimportant and may be
3319 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3320 const struct match *match, unsigned int priority,
3321 ovs_be64 cookie, ovs_be64 cookie_mask,
3322 ofp_port_t out_port, uint32_t out_group)
3324 criteria->table_id = table_id;
3325 cls_rule_init(&criteria->cr, match, priority);
3326 criteria->cookie = cookie;
3327 criteria->cookie_mask = cookie_mask;
3328 criteria->out_port = out_port;
3329 criteria->out_group = out_group;
3333 rule_criteria_destroy(struct rule_criteria *criteria)
3335 cls_rule_destroy(&criteria->cr);
3339 rule_collection_init(struct rule_collection *rules)
3341 rules->rules = rules->stub;
3343 rules->capacity = ARRAY_SIZE(rules->stub);
3347 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3349 if (rules->n >= rules->capacity) {
3350 size_t old_size, new_size;
3352 old_size = rules->capacity * sizeof *rules->rules;
3353 rules->capacity *= 2;
3354 new_size = rules->capacity * sizeof *rules->rules;
3356 if (rules->rules == rules->stub) {
3357 rules->rules = xmalloc(new_size);
3358 memcpy(rules->rules, rules->stub, old_size);
3360 rules->rules = xrealloc(rules->rules, new_size);
3364 rules->rules[rules->n++] = rule;
3368 rule_collection_ref(struct rule_collection *rules)
3369 OVS_REQUIRES(ofproto_mutex)
3373 for (i = 0; i < rules->n; i++) {
3374 ofproto_rule_ref(rules->rules[i]);
3379 rule_collection_unref(struct rule_collection *rules)
3383 for (i = 0; i < rules->n; i++) {
3384 ofproto_rule_unref(rules->rules[i]);
3389 rule_collection_destroy(struct rule_collection *rules)
3391 if (rules->rules != rules->stub) {
3397 collect_rule(struct rule *rule, const struct rule_criteria *c,
3398 struct rule_collection *rules)
3399 OVS_REQUIRES(ofproto_mutex)
3401 /* We ordinarily want to skip hidden rules, but there has to be a way for
3402 * code internal to OVS to modify and delete them, so if the criteria
3403 * specify a priority that can only be for a hidden flow, then allow hidden
3404 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3405 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3407 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3409 } else if (rule->pending) {
3410 return OFPROTO_POSTPONE;
3412 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3413 && ofproto_rule_has_out_port(rule, c->out_port)
3414 && ofproto_rule_has_out_group(rule, c->out_group)
3415 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3416 rule_collection_add(rules, rule);
3422 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3423 * on classifiers rules are done in the "loose" way required for OpenFlow
3424 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3427 * Hidden rules are always omitted.
3429 * Returns 0 on success, otherwise an OpenFlow error code. */
3431 collect_rules_loose(struct ofproto *ofproto,
3432 const struct rule_criteria *criteria,
3433 struct rule_collection *rules)
3434 OVS_REQUIRES(ofproto_mutex)
3436 struct oftable *table;
3439 rule_collection_init(rules);
3441 error = check_table_id(ofproto, criteria->table_id);
3446 if (criteria->cookie_mask == OVS_BE64_MAX) {
3449 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3450 hash_cookie(criteria->cookie),
3451 &ofproto->cookies) {
3452 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3453 error = collect_rule(rule, criteria, rules);
3460 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3461 struct cls_cursor cursor;
3464 ovs_rwlock_rdlock(&table->cls.rwlock);
3465 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3466 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3467 error = collect_rule(rule, criteria, rules);
3472 ovs_rwlock_unlock(&table->cls.rwlock);
3478 rule_collection_destroy(rules);
3483 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3484 * on classifiers rules are done in the "strict" way required for OpenFlow
3485 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3486 * rules on list 'rules'.
3488 * Hidden rules are always omitted.
3490 * Returns 0 on success, otherwise an OpenFlow error code. */
3492 collect_rules_strict(struct ofproto *ofproto,
3493 const struct rule_criteria *criteria,
3494 struct rule_collection *rules)
3495 OVS_REQUIRES(ofproto_mutex)
3497 struct oftable *table;
3500 rule_collection_init(rules);
3502 error = check_table_id(ofproto, criteria->table_id);
3507 if (criteria->cookie_mask == OVS_BE64_MAX) {
3510 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3511 hash_cookie(criteria->cookie),
3512 &ofproto->cookies) {
3513 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3514 error = collect_rule(rule, criteria, rules);
3521 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3524 ovs_rwlock_rdlock(&table->cls.rwlock);
3525 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3526 &table->cls, &criteria->cr));
3527 ovs_rwlock_unlock(&table->cls.rwlock);
3529 error = collect_rule(rule, criteria, rules);
3539 rule_collection_destroy(rules);
3544 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3545 * forced into the range of a uint16_t. */
3547 age_secs(long long int age_ms)
3549 return (age_ms < 0 ? 0
3550 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3551 : (unsigned int) age_ms / 1000);
3555 handle_flow_stats_request(struct ofconn *ofconn,
3556 const struct ofp_header *request)
3557 OVS_EXCLUDED(ofproto_mutex)
3559 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3560 struct ofputil_flow_stats_request fsr;
3561 struct rule_criteria criteria;
3562 struct rule_collection rules;
3563 struct list replies;
3567 error = ofputil_decode_flow_stats_request(&fsr, request);
3572 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3573 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3575 ovs_mutex_lock(&ofproto_mutex);
3576 error = collect_rules_loose(ofproto, &criteria, &rules);
3577 rule_criteria_destroy(&criteria);
3579 rule_collection_ref(&rules);
3581 ovs_mutex_unlock(&ofproto_mutex);
3587 ofpmp_init(&replies, request);
3588 for (i = 0; i < rules.n; i++) {
3589 struct rule *rule = rules.rules[i];
3590 long long int now = time_msec();
3591 struct ofputil_flow_stats fs;
3592 long long int created, used, modified;
3593 struct rule_actions *actions;
3594 enum ofputil_flow_mod_flags flags;
3596 ovs_mutex_lock(&rule->mutex);
3597 fs.cookie = rule->flow_cookie;
3598 fs.idle_timeout = rule->idle_timeout;
3599 fs.hard_timeout = rule->hard_timeout;
3600 created = rule->created;
3602 modified = rule->modified;
3603 actions = rule_get_actions__(rule);
3604 flags = rule->flags;
3605 ovs_mutex_unlock(&rule->mutex);
3607 minimatch_expand(&rule->cr.match, &fs.match);
3608 fs.table_id = rule->table_id;
3609 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3610 fs.priority = rule->cr.priority;
3611 fs.idle_age = age_secs(now - used);
3612 fs.hard_age = age_secs(now - modified);
3613 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3615 fs.ofpacts = actions->ofpacts;
3616 fs.ofpacts_len = actions->ofpacts_len;
3619 ofputil_append_flow_stats_reply(&fs, &replies);
3621 rule_actions_unref(actions);
3624 rule_collection_unref(&rules);
3625 rule_collection_destroy(&rules);
3627 ofconn_send_replies(ofconn, &replies);
3633 flow_stats_ds(struct rule *rule, struct ds *results)
3635 uint64_t packet_count, byte_count;
3636 struct rule_actions *actions;
3637 long long int created;
3639 rule->ofproto->ofproto_class->rule_get_stats(rule,
3640 &packet_count, &byte_count);
3642 ovs_mutex_lock(&rule->mutex);
3643 actions = rule_get_actions__(rule);
3644 created = rule->created;
3645 ovs_mutex_unlock(&rule->mutex);
3647 if (rule->table_id != 0) {
3648 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3650 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3651 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3652 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3653 cls_rule_format(&rule->cr, results);
3654 ds_put_char(results, ',');
3656 ds_put_cstr(results, "actions=");
3657 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3659 ds_put_cstr(results, "\n");
3661 rule_actions_unref(actions);
3664 /* Adds a pretty-printed description of all flows to 'results', including
3665 * hidden flows (e.g., set up by in-band control). */
3667 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3669 struct oftable *table;
3671 OFPROTO_FOR_EACH_TABLE (table, p) {
3672 struct cls_cursor cursor;
3675 ovs_rwlock_rdlock(&table->cls.rwlock);
3676 cls_cursor_init(&cursor, &table->cls, NULL);
3677 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3678 flow_stats_ds(rule, results);
3680 ovs_rwlock_unlock(&table->cls.rwlock);
3684 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3685 * '*engine_type' and '*engine_id', respectively. */
3687 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3688 uint8_t *engine_type, uint8_t *engine_id)
3690 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3693 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3694 * true if the port's CFM status was successfully stored into '*status'.
3695 * Returns false if the port did not have CFM configured, in which case
3696 * '*status' is indeterminate.
3698 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3700 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3701 struct ofproto_cfm_status *status)
3703 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3705 && ofproto->ofproto_class->get_cfm_status
3706 && ofproto->ofproto_class->get_cfm_status(ofport, status));
3710 handle_aggregate_stats_request(struct ofconn *ofconn,
3711 const struct ofp_header *oh)
3712 OVS_EXCLUDED(ofproto_mutex)
3714 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3715 struct ofputil_flow_stats_request request;
3716 struct ofputil_aggregate_stats stats;
3717 bool unknown_packets, unknown_bytes;
3718 struct rule_criteria criteria;
3719 struct rule_collection rules;
3720 struct ofpbuf *reply;
3724 error = ofputil_decode_flow_stats_request(&request, oh);
3729 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3730 request.cookie, request.cookie_mask,
3731 request.out_port, request.out_group);
3733 ovs_mutex_lock(&ofproto_mutex);
3734 error = collect_rules_loose(ofproto, &criteria, &rules);
3735 rule_criteria_destroy(&criteria);
3737 rule_collection_ref(&rules);
3739 ovs_mutex_unlock(&ofproto_mutex);
3745 memset(&stats, 0, sizeof stats);
3746 unknown_packets = unknown_bytes = false;
3747 for (i = 0; i < rules.n; i++) {
3748 struct rule *rule = rules.rules[i];
3749 uint64_t packet_count;
3750 uint64_t byte_count;
3752 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3755 if (packet_count == UINT64_MAX) {
3756 unknown_packets = true;
3758 stats.packet_count += packet_count;
3761 if (byte_count == UINT64_MAX) {
3762 unknown_bytes = true;
3764 stats.byte_count += byte_count;
3769 if (unknown_packets) {
3770 stats.packet_count = UINT64_MAX;
3772 if (unknown_bytes) {
3773 stats.byte_count = UINT64_MAX;
3776 rule_collection_unref(&rules);
3777 rule_collection_destroy(&rules);
3779 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3780 ofconn_send_reply(ofconn, reply);
3785 struct queue_stats_cbdata {
3786 struct ofport *ofport;
3787 struct list replies;
3792 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3793 const struct netdev_queue_stats *stats)
3795 struct ofputil_queue_stats oqs;
3797 oqs.port_no = cbdata->ofport->pp.port_no;
3798 oqs.queue_id = queue_id;
3799 oqs.tx_bytes = stats->tx_bytes;
3800 oqs.tx_packets = stats->tx_packets;
3801 oqs.tx_errors = stats->tx_errors;
3802 if (stats->created != LLONG_MIN) {
3803 calc_duration(stats->created, cbdata->now,
3804 &oqs.duration_sec, &oqs.duration_nsec);
3806 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3808 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3812 handle_queue_stats_dump_cb(uint32_t queue_id,
3813 struct netdev_queue_stats *stats,
3816 struct queue_stats_cbdata *cbdata = cbdata_;
3818 put_queue_stats(cbdata, queue_id, stats);
3822 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3823 struct queue_stats_cbdata *cbdata)
3825 cbdata->ofport = port;
3826 if (queue_id == OFPQ_ALL) {
3827 netdev_dump_queue_stats(port->netdev,
3828 handle_queue_stats_dump_cb, cbdata);
3830 struct netdev_queue_stats stats;
3832 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3833 put_queue_stats(cbdata, queue_id, &stats);
3835 return OFPERR_OFPQOFC_BAD_QUEUE;
3842 handle_queue_stats_request(struct ofconn *ofconn,
3843 const struct ofp_header *rq)
3845 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3846 struct queue_stats_cbdata cbdata;
3847 struct ofport *port;
3849 struct ofputil_queue_stats_request oqsr;
3851 COVERAGE_INC(ofproto_queue_req);
3853 ofpmp_init(&cbdata.replies, rq);
3854 cbdata.now = time_msec();
3856 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3861 if (oqsr.port_no == OFPP_ANY) {
3862 error = OFPERR_OFPQOFC_BAD_QUEUE;
3863 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3864 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3869 port = ofproto_get_port(ofproto, oqsr.port_no);
3871 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3872 : OFPERR_OFPQOFC_BAD_PORT);
3875 ofconn_send_replies(ofconn, &cbdata.replies);
3877 ofpbuf_list_delete(&cbdata.replies);
3884 is_flow_deletion_pending(const struct ofproto *ofproto,
3885 const struct cls_rule *cls_rule,
3887 OVS_REQUIRES(ofproto_mutex)
3889 if (!hmap_is_empty(&ofproto->deletions)) {
3890 struct ofoperation *op;
3892 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3893 cls_rule_hash(cls_rule, table_id),
3894 &ofproto->deletions) {
3895 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3905 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3906 OVS_REQUIRES(ofproto_mutex)
3907 OVS_NO_THREAD_SAFETY_ANALYSIS
3909 return classifier_count(&table->cls) + extra_space > table->max_flows;
3913 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3914 unsigned int extra_space)
3915 OVS_REQUIRES(ofproto_mutex)
3917 while (should_evict_a_rule(table, extra_space)) {
3920 if (!choose_rule_to_evict(table, &rule)) {
3921 return OFPERR_OFPFMFC_TABLE_FULL;
3922 } else if (rule->pending) {
3923 return OFPROTO_POSTPONE;
3925 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3926 delete_flow__(rule, group, OFPRR_EVICTION);
3927 ofopgroup_submit(group);
3934 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3935 * in which no matching flow already exists in the flow table.
3937 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3938 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3939 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3940 * initiated now but may be retried later.
3942 * The caller retains ownership of 'fm->ofpacts'.
3944 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3947 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3948 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3949 OVS_REQUIRES(ofproto_mutex)
3951 struct oftable *table;
3952 struct ofopgroup *group;
3958 error = check_table_id(ofproto, fm->table_id);
3964 if (fm->table_id == 0xff) {
3965 if (ofproto->ofproto_class->rule_choose_table) {
3966 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3972 ovs_assert(table_id < ofproto->n_tables);
3976 } else if (fm->table_id < ofproto->n_tables) {
3977 table_id = fm->table_id;
3979 return OFPERR_OFPBRC_BAD_TABLE_ID;
3982 table = &ofproto->tables[table_id];
3984 if (table->flags & OFTABLE_READONLY) {
3985 return OFPERR_OFPBRC_EPERM;
3988 cls_rule_init(&cr, &fm->match, fm->priority);
3990 /* Transform "add" into "modify" if there's an existing identical flow. */
3991 ovs_rwlock_rdlock(&table->cls.rwlock);
3992 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
3993 ovs_rwlock_unlock(&table->cls.rwlock);
3995 cls_rule_destroy(&cr);
3996 if (!rule_is_modifiable(rule)) {
3997 return OFPERR_OFPBRC_EPERM;
3998 } else if (rule->pending) {
3999 return OFPROTO_POSTPONE;
4001 struct rule_collection rules;
4003 rule_collection_init(&rules);
4004 rule_collection_add(&rules, rule);
4005 fm->modify_cookie = true;
4006 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4007 rule_collection_destroy(&rules);
4013 /* Serialize against pending deletion. */
4014 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
4015 cls_rule_destroy(&cr);
4016 return OFPROTO_POSTPONE;
4019 /* Check for overlap, if requested. */
4020 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4023 ovs_rwlock_rdlock(&table->cls.rwlock);
4024 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4025 ovs_rwlock_unlock(&table->cls.rwlock);
4028 cls_rule_destroy(&cr);
4029 return OFPERR_OFPFMFC_OVERLAP;
4033 /* If necessary, evict an existing rule to clear out space. */
4034 error = evict_rules_from_table(ofproto, table, 1);
4036 cls_rule_destroy(&cr);
4040 /* Allocate new rule. */
4041 rule = ofproto->ofproto_class->rule_alloc();
4043 cls_rule_destroy(&cr);
4044 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4045 ofproto->name, ovs_strerror(error));
4049 /* Initialize base state. */
4050 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4051 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4052 atomic_init(&rule->ref_count, 1);
4053 rule->pending = NULL;
4054 rule->flow_cookie = fm->new_cookie;
4055 rule->created = rule->modified = rule->used = time_msec();
4057 ovs_mutex_init(&rule->mutex);
4058 ovs_mutex_lock(&rule->mutex);
4059 rule->idle_timeout = fm->idle_timeout;
4060 rule->hard_timeout = fm->hard_timeout;
4061 ovs_mutex_unlock(&rule->mutex);
4063 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4064 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4065 rule->actions = rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len);
4066 list_init(&rule->meter_list_node);
4067 rule->eviction_group = NULL;
4068 list_init(&rule->expirable);
4069 rule->monitor_flags = 0;
4070 rule->add_seqno = 0;
4071 rule->modify_seqno = 0;
4073 /* Construct rule, initializing derived state. */
4074 error = ofproto->ofproto_class->rule_construct(rule);
4076 ofproto_rule_destroy__(rule);
4081 oftable_insert_rule(rule);
4083 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4084 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4085 ofproto->ofproto_class->rule_insert(rule);
4086 ofopgroup_submit(group);
4091 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4093 /* Modifies the rules listed in 'rules', changing their actions to match those
4096 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4099 * Returns 0 on success, otherwise an OpenFlow error code. */
4101 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4102 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4103 const struct rule_collection *rules)
4104 OVS_REQUIRES(ofproto_mutex)
4106 enum ofoperation_type type;
4107 struct ofopgroup *group;
4111 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4112 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4113 error = OFPERR_OFPBRC_EPERM;
4114 for (i = 0; i < rules->n; i++) {
4115 struct rule *rule = rules->rules[i];
4116 struct ofoperation *op;
4117 bool actions_changed;
4118 bool reset_counters;
4120 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4122 if (rule_is_modifiable(rule)) {
4123 /* At least one rule is modifiable, don't report EPERM error. */
4129 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4130 rule->actions->ofpacts,
4131 rule->actions->ofpacts_len);
4133 op = ofoperation_create(group, rule, type, 0);
4135 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4136 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4138 if (type == OFOPERATION_REPLACE) {
4139 ovs_mutex_lock(&rule->mutex);
4140 rule->idle_timeout = fm->idle_timeout;
4141 rule->hard_timeout = fm->hard_timeout;
4142 ovs_mutex_unlock(&rule->mutex);
4144 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4145 if (fm->idle_timeout || fm->hard_timeout) {
4146 if (!rule->eviction_group) {
4147 eviction_group_add_rule(rule);
4150 eviction_group_remove_rule(rule);
4154 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4155 if (actions_changed || reset_counters) {
4156 struct rule_actions *new_actions;
4158 op->actions = rule->actions;
4159 new_actions = rule_actions_create(ofproto,
4160 fm->ofpacts, fm->ofpacts_len);
4162 ovs_mutex_lock(&rule->mutex);
4163 rule->actions = new_actions;
4164 ovs_mutex_unlock(&rule->mutex);
4166 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4169 ofoperation_complete(op, 0);
4172 ofopgroup_submit(group);
4178 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4179 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4180 OVS_REQUIRES(ofproto_mutex)
4182 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4185 return add_flow(ofproto, ofconn, fm, request);
4188 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4191 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4194 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4195 struct ofputil_flow_mod *fm,
4196 const struct ofp_header *request)
4197 OVS_REQUIRES(ofproto_mutex)
4199 struct rule_criteria criteria;
4200 struct rule_collection rules;
4203 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4204 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4205 error = collect_rules_loose(ofproto, &criteria, &rules);
4206 rule_criteria_destroy(&criteria);
4209 error = (rules.n > 0
4210 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4211 : modify_flows_add(ofproto, ofconn, fm, request));
4214 rule_collection_destroy(&rules);
4219 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4222 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4225 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4226 struct ofputil_flow_mod *fm,
4227 const struct ofp_header *request)
4228 OVS_REQUIRES(ofproto_mutex)
4230 struct rule_criteria criteria;
4231 struct rule_collection rules;
4234 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4235 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4236 error = collect_rules_strict(ofproto, &criteria, &rules);
4237 rule_criteria_destroy(&criteria);
4241 error = modify_flows_add(ofproto, ofconn, fm, request);
4242 } else if (rules.n == 1) {
4243 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4247 rule_collection_destroy(&rules);
4252 /* OFPFC_DELETE implementation. */
4255 delete_flow__(struct rule *rule, struct ofopgroup *group,
4256 enum ofp_flow_removed_reason reason)
4257 OVS_REQUIRES(ofproto_mutex)
4259 struct ofproto *ofproto = rule->ofproto;
4261 ofproto_rule_send_removed(rule, reason);
4263 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4264 oftable_remove_rule(rule);
4265 ofproto->ofproto_class->rule_delete(rule);
4268 /* Deletes the rules listed in 'rules'.
4270 * Returns 0 on success, otherwise an OpenFlow error code. */
4272 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4273 const struct ofp_header *request,
4274 const struct rule_collection *rules,
4275 enum ofp_flow_removed_reason reason)
4276 OVS_REQUIRES(ofproto_mutex)
4278 struct ofopgroup *group;
4281 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4282 for (i = 0; i < rules->n; i++) {
4283 delete_flow__(rules->rules[i], group, reason);
4285 ofopgroup_submit(group);
4290 /* Implements OFPFC_DELETE. */
4292 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4293 const struct ofputil_flow_mod *fm,
4294 const struct ofp_header *request)
4295 OVS_REQUIRES(ofproto_mutex)
4297 struct rule_criteria criteria;
4298 struct rule_collection rules;
4301 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4302 fm->cookie, fm->cookie_mask,
4303 fm->out_port, fm->out_group);
4304 error = collect_rules_loose(ofproto, &criteria, &rules);
4305 rule_criteria_destroy(&criteria);
4307 if (!error && rules.n > 0) {
4308 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4310 rule_collection_destroy(&rules);
4315 /* Implements OFPFC_DELETE_STRICT. */
4317 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4318 const struct ofputil_flow_mod *fm,
4319 const struct ofp_header *request)
4320 OVS_REQUIRES(ofproto_mutex)
4322 struct rule_criteria criteria;
4323 struct rule_collection rules;
4326 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4327 fm->cookie, fm->cookie_mask,
4328 fm->out_port, fm->out_group);
4329 error = collect_rules_strict(ofproto, &criteria, &rules);
4330 rule_criteria_destroy(&criteria);
4332 if (!error && rules.n > 0) {
4333 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4335 rule_collection_destroy(&rules);
4341 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4342 OVS_REQUIRES(ofproto_mutex)
4344 struct ofputil_flow_removed fr;
4346 if (ofproto_rule_is_hidden(rule) ||
4347 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4351 minimatch_expand(&rule->cr.match, &fr.match);
4352 fr.priority = rule->cr.priority;
4353 fr.cookie = rule->flow_cookie;
4355 fr.table_id = rule->table_id;
4356 calc_duration(rule->created, time_msec(),
4357 &fr.duration_sec, &fr.duration_nsec);
4358 ovs_mutex_lock(&rule->mutex);
4359 fr.idle_timeout = rule->idle_timeout;
4360 fr.hard_timeout = rule->hard_timeout;
4361 ovs_mutex_unlock(&rule->mutex);
4362 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4365 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4368 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4369 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4372 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4375 * ofproto implementation ->run() functions should use this function to expire
4376 * OpenFlow flows. */
4378 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4379 OVS_REQUIRES(ofproto_mutex)
4381 struct ofproto *ofproto = rule->ofproto;
4383 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4384 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4386 ofproto_rule_delete__(ofproto, rule, reason);
4389 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4390 * means "infinite". */
4392 reduce_timeout(uint16_t max, uint16_t *timeout)
4394 if (max && (!*timeout || *timeout > max)) {
4399 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4400 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4401 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4403 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4405 ofproto_rule_reduce_timeouts(struct rule *rule,
4406 uint16_t idle_timeout, uint16_t hard_timeout)
4407 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4409 if (!idle_timeout && !hard_timeout) {
4413 ovs_mutex_lock(&ofproto_mutex);
4414 if (list_is_empty(&rule->expirable)) {
4415 list_insert(&rule->ofproto->expirable, &rule->expirable);
4417 ovs_mutex_unlock(&ofproto_mutex);
4419 ovs_mutex_lock(&rule->mutex);
4420 reduce_timeout(idle_timeout, &rule->idle_timeout);
4421 reduce_timeout(hard_timeout, &rule->hard_timeout);
4422 ovs_mutex_unlock(&rule->mutex);
4426 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4427 OVS_EXCLUDED(ofproto_mutex)
4429 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4430 struct ofputil_flow_mod fm;
4431 uint64_t ofpacts_stub[1024 / 8];
4432 struct ofpbuf ofpacts;
4436 error = reject_slave_controller(ofconn);
4441 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4442 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4444 u16_to_ofp(ofproto->max_ports),
4447 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4450 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4453 goto exit_free_ofpacts;
4456 /* Record the operation for logging a summary report. */
4457 switch (fm.command) {
4463 case OFPFC_MODIFY_STRICT:
4464 ofproto->n_modify++;
4468 case OFPFC_DELETE_STRICT:
4469 ofproto->n_delete++;
4474 if (ofproto->next_op_report == LLONG_MAX) {
4475 ofproto->first_op = now;
4476 ofproto->next_op_report = MAX(now + 10 * 1000,
4477 ofproto->op_backoff);
4478 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
4480 ofproto->last_op = now;
4483 ofpbuf_uninit(&ofpacts);
4489 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4490 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4491 OVS_EXCLUDED(ofproto_mutex)
4495 ovs_mutex_lock(&ofproto_mutex);
4496 if (ofproto->n_pending < 50) {
4497 switch (fm->command) {
4499 error = add_flow(ofproto, ofconn, fm, oh);
4503 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4506 case OFPFC_MODIFY_STRICT:
4507 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4511 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4514 case OFPFC_DELETE_STRICT:
4515 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4519 if (fm->command > 0xff) {
4520 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4521 "flow_mod_table_id extension is not enabled",
4524 error = OFPERR_OFPFMFC_BAD_COMMAND;
4528 ovs_assert(!list_is_empty(&ofproto->pending));
4529 error = OFPROTO_POSTPONE;
4531 ovs_mutex_unlock(&ofproto_mutex);
4533 run_rule_executes(ofproto);
4538 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4540 struct ofputil_role_request request;
4541 struct ofputil_role_request reply;
4545 error = ofputil_decode_role_message(oh, &request);
4550 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4551 if (ofconn_get_role(ofconn) != request.role
4552 && ofconn_has_pending_opgroups(ofconn)) {
4553 return OFPROTO_POSTPONE;
4556 if (request.have_generation_id
4557 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4558 return OFPERR_OFPRRFC_STALE;
4561 ofconn_set_role(ofconn, request.role);
4564 reply.role = ofconn_get_role(ofconn);
4565 reply.have_generation_id = ofconn_get_master_election_id(
4566 ofconn, &reply.generation_id);
4567 buf = ofputil_encode_role_reply(oh, &reply);
4568 ofconn_send_reply(ofconn, buf);
4574 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4575 const struct ofp_header *oh)
4577 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4578 enum ofputil_protocol cur, next;
4580 cur = ofconn_get_protocol(ofconn);
4581 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4582 ofconn_set_protocol(ofconn, next);
4588 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4590 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4591 enum ofputil_protocol cur, next;
4592 enum ofputil_protocol next_base;
4594 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4596 return OFPERR_OFPBRC_EPERM;
4599 cur = ofconn_get_protocol(ofconn);
4600 next = ofputil_protocol_set_base(cur, next_base);
4601 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4602 /* Avoid sending async messages in surprising protocol. */
4603 return OFPROTO_POSTPONE;
4606 ofconn_set_protocol(ofconn, next);
4611 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4612 const struct ofp_header *oh)
4614 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4617 format = ntohl(msg->format);
4618 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4619 return OFPERR_OFPBRC_EPERM;
4622 if (format != ofconn_get_packet_in_format(ofconn)
4623 && ofconn_has_pending_opgroups(ofconn)) {
4624 /* Avoid sending async message in surprsing packet in format. */
4625 return OFPROTO_POSTPONE;
4628 ofconn_set_packet_in_format(ofconn, format);
4633 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4635 const struct nx_async_config *msg = ofpmsg_body(oh);
4636 uint32_t master[OAM_N_TYPES];
4637 uint32_t slave[OAM_N_TYPES];
4639 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4640 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4641 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4643 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4644 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4645 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4647 ofconn_set_async_config(ofconn, master, slave);
4648 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4649 !ofconn_get_miss_send_len(ofconn)) {
4650 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4657 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4660 uint32_t master[OAM_N_TYPES];
4661 uint32_t slave[OAM_N_TYPES];
4662 struct nx_async_config *msg;
4664 ofconn_get_async_config(ofconn, master, slave);
4665 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4666 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4668 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4669 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4670 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4672 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4673 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4674 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4676 ofconn_send_reply(ofconn, buf);
4682 handle_nxt_set_controller_id(struct ofconn *ofconn,
4683 const struct ofp_header *oh)
4685 const struct nx_controller_id *nci = ofpmsg_body(oh);
4687 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4688 return OFPERR_NXBRC_MUST_BE_ZERO;
4691 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4696 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4700 if (ofconn_has_pending_opgroups(ofconn)) {
4701 return OFPROTO_POSTPONE;
4704 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4705 ? OFPRAW_OFPT10_BARRIER_REPLY
4706 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4707 ofconn_send_reply(ofconn, buf);
4712 ofproto_compose_flow_refresh_update(const struct rule *rule,
4713 enum nx_flow_monitor_flags flags,
4715 OVS_REQUIRES(ofproto_mutex)
4717 struct ofoperation *op = rule->pending;
4718 const struct rule_actions *actions;
4719 struct ofputil_flow_update fu;
4722 if (op && op->type == OFOPERATION_ADD) {
4723 /* We'll report the final flow when the operation completes. Reporting
4724 * it now would cause a duplicate report later. */
4728 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4729 ? NXFME_ADDED : NXFME_MODIFIED);
4731 ovs_mutex_lock(&rule->mutex);
4732 fu.idle_timeout = rule->idle_timeout;
4733 fu.hard_timeout = rule->hard_timeout;
4734 ovs_mutex_unlock(&rule->mutex);
4735 fu.table_id = rule->table_id;
4736 fu.cookie = rule->flow_cookie;
4737 minimatch_expand(&rule->cr.match, &match);
4739 fu.priority = rule->cr.priority;
4741 if (!(flags & NXFMF_ACTIONS)) {
4744 actions = rule->actions;
4746 /* An operation is in progress. Use the previous version of the flow's
4747 * actions, so that when the operation commits we report the change. */
4749 case OFOPERATION_ADD:
4752 case OFOPERATION_MODIFY:
4753 case OFOPERATION_REPLACE:
4754 actions = op->actions ? op->actions : rule->actions;
4757 case OFOPERATION_DELETE:
4758 actions = rule->actions;
4765 fu.ofpacts = actions ? actions->ofpacts : NULL;
4766 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4768 if (list_is_empty(msgs)) {
4769 ofputil_start_flow_update(msgs);
4771 ofputil_append_flow_update(&fu, msgs);
4775 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4777 OVS_REQUIRES(ofproto_mutex)
4781 for (i = 0; i < rules->n; i++) {
4782 struct rule *rule = rules->rules[i];
4783 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4784 rule->monitor_flags = 0;
4786 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4791 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4792 struct rule *rule, uint64_t seqno,
4793 struct rule_collection *rules)
4794 OVS_REQUIRES(ofproto_mutex)
4796 enum nx_flow_monitor_flags update;
4798 if (ofproto_rule_is_hidden(rule)) {
4803 ? ofoperation_has_out_port(rule->pending, m->out_port)
4804 : ofproto_rule_has_out_port(rule, m->out_port))) {
4809 if (rule->add_seqno > seqno) {
4810 update = NXFMF_ADD | NXFMF_MODIFY;
4811 } else if (rule->modify_seqno > seqno) {
4812 update = NXFMF_MODIFY;
4817 if (!(m->flags & update)) {
4821 update = NXFMF_INITIAL;
4824 if (!rule->monitor_flags) {
4825 rule_collection_add(rules, rule);
4827 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4831 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4833 struct rule_collection *rules)
4834 OVS_REQUIRES(ofproto_mutex)
4836 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4837 const struct ofoperation *op;
4838 const struct oftable *table;
4839 struct cls_rule target;
4841 cls_rule_init_from_minimatch(&target, &m->match, 0);
4842 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4843 struct cls_cursor cursor;
4846 ovs_rwlock_rdlock(&table->cls.rwlock);
4847 cls_cursor_init(&cursor, &table->cls, &target);
4848 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4849 ovs_assert(!rule->pending); /* XXX */
4850 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4852 ovs_rwlock_unlock(&table->cls.rwlock);
4855 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4856 struct rule *rule = op->rule;
4858 if (((m->table_id == 0xff
4859 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4860 : m->table_id == rule->table_id))
4861 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4862 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4865 cls_rule_destroy(&target);
4869 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4870 struct rule_collection *rules)
4871 OVS_REQUIRES(ofproto_mutex)
4873 if (m->flags & NXFMF_INITIAL) {
4874 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4879 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4880 uint64_t seqno, struct rule_collection *rules)
4881 OVS_REQUIRES(ofproto_mutex)
4883 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4887 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4888 OVS_EXCLUDED(ofproto_mutex)
4890 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4891 struct ofmonitor **monitors;
4892 size_t n_monitors, allocated_monitors;
4893 struct rule_collection rules;
4894 struct list replies;
4900 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4902 n_monitors = allocated_monitors = 0;
4904 ovs_mutex_lock(&ofproto_mutex);
4906 struct ofputil_flow_monitor_request request;
4907 struct ofmonitor *m;
4910 retval = ofputil_decode_flow_monitor_request(&request, &b);
4911 if (retval == EOF) {
4913 } else if (retval) {
4918 if (request.table_id != 0xff
4919 && request.table_id >= ofproto->n_tables) {
4920 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4924 error = ofmonitor_create(&request, ofconn, &m);
4929 if (n_monitors >= allocated_monitors) {
4930 monitors = x2nrealloc(monitors, &allocated_monitors,
4933 monitors[n_monitors++] = m;
4936 rule_collection_init(&rules);
4937 for (i = 0; i < n_monitors; i++) {
4938 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4941 ofpmp_init(&replies, oh);
4942 ofmonitor_compose_refresh_updates(&rules, &replies);
4943 ovs_mutex_unlock(&ofproto_mutex);
4945 rule_collection_destroy(&rules);
4947 ofconn_send_replies(ofconn, &replies);
4953 for (i = 0; i < n_monitors; i++) {
4954 ofmonitor_destroy(monitors[i]);
4957 ovs_mutex_unlock(&ofproto_mutex);
4963 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4964 OVS_EXCLUDED(ofproto_mutex)
4966 struct ofmonitor *m;
4970 id = ofputil_decode_flow_monitor_cancel(oh);
4972 ovs_mutex_lock(&ofproto_mutex);
4973 m = ofmonitor_lookup(ofconn, id);
4975 ofmonitor_destroy(m);
4978 error = OFPERR_NXBRC_FM_BAD_ID;
4980 ovs_mutex_unlock(&ofproto_mutex);
4985 /* Meters implementation.
4987 * Meter table entry, indexed by the OpenFlow meter_id.
4988 * These are always dynamically allocated to allocate enough space for
4990 * 'created' is used to compute the duration for meter stats.
4991 * 'list rules' is needed so that we can delete the dependent rules when the
4992 * meter table entry is deleted.
4993 * 'provider_meter_id' is for the provider's private use.
4996 long long int created; /* Time created. */
4997 struct list rules; /* List of "struct rule_dpif"s. */
4998 ofproto_meter_id provider_meter_id;
4999 uint16_t flags; /* Meter flags. */
5000 uint16_t n_bands; /* Number of meter bands. */
5001 struct ofputil_meter_band *bands;
5005 * This is used in instruction validation at flow set-up time,
5006 * as flows may not use non-existing meters.
5007 * Return value of UINT32_MAX signifies an invalid meter.
5010 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5012 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5013 const struct meter *meter = ofproto->meters[of_meter_id];
5015 return meter->provider_meter_id.uint32;
5022 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5026 meter->flags = config->flags;
5027 meter->n_bands = config->n_bands;
5028 meter->bands = xmemdup(config->bands,
5029 config->n_bands * sizeof *meter->bands);
5032 static struct meter *
5033 meter_create(const struct ofputil_meter_config *config,
5034 ofproto_meter_id provider_meter_id)
5036 struct meter *meter;
5038 meter = xzalloc(sizeof *meter);
5039 meter->provider_meter_id = provider_meter_id;
5040 meter->created = time_msec();
5041 list_init(&meter->rules);
5043 meter_update(meter, config);
5049 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5050 OVS_REQUIRES(ofproto_mutex)
5053 for (mid = first; mid <= last; ++mid) {
5054 struct meter *meter = ofproto->meters[mid];
5056 ofproto->meters[mid] = NULL;
5057 ofproto->ofproto_class->meter_del(ofproto,
5058 meter->provider_meter_id);
5066 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5068 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5069 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5073 return OFPERR_OFPMMFC_METER_EXISTS;
5076 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5079 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5080 *meterp = meter_create(&mm->meter, provider_meter_id);
5086 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5088 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5090 uint32_t provider_meter_id;
5093 return OFPERR_OFPMMFC_UNKNOWN_METER;
5096 provider_meter_id = meter->provider_meter_id.uint32;
5097 error = ofproto->ofproto_class->meter_set(ofproto,
5098 &meter->provider_meter_id,
5100 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5102 meter_update(meter, &mm->meter);
5108 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5109 struct ofputil_meter_mod *mm)
5110 OVS_EXCLUDED(ofproto_mutex)
5112 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5113 uint32_t meter_id = mm->meter.meter_id;
5114 struct rule_collection rules;
5115 enum ofperr error = 0;
5116 uint32_t first, last;
5118 if (meter_id == OFPM13_ALL) {
5120 last = ofproto->meter_features.max_meters;
5122 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5125 first = last = meter_id;
5128 /* First delete the rules that use this meter. If any of those rules are
5129 * currently being modified, postpone the whole operation until later. */
5130 rule_collection_init(&rules);
5131 ovs_mutex_lock(&ofproto_mutex);
5132 for (meter_id = first; meter_id <= last; ++meter_id) {
5133 struct meter *meter = ofproto->meters[meter_id];
5134 if (meter && !list_is_empty(&meter->rules)) {
5137 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5138 if (rule->pending) {
5139 error = OFPROTO_POSTPONE;
5142 rule_collection_add(&rules, rule);
5147 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5150 /* Delete the meters. */
5151 meter_delete(ofproto, first, last);
5154 ovs_mutex_unlock(&ofproto_mutex);
5155 rule_collection_destroy(&rules);
5161 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5163 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5164 struct ofputil_meter_mod mm;
5165 uint64_t bands_stub[256 / 8];
5166 struct ofpbuf bands;
5170 error = reject_slave_controller(ofconn);
5175 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5177 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5179 goto exit_free_bands;
5182 meter_id = mm.meter.meter_id;
5184 if (mm.command != OFPMC13_DELETE) {
5185 /* Fails also when meters are not implemented by the provider. */
5186 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5187 error = OFPERR_OFPMMFC_INVALID_METER;
5188 goto exit_free_bands;
5189 } else if (meter_id > ofproto->meter_features.max_meters) {
5190 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5191 goto exit_free_bands;
5193 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5194 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5195 goto exit_free_bands;
5199 switch (mm.command) {
5201 error = handle_add_meter(ofproto, &mm);
5204 case OFPMC13_MODIFY:
5205 error = handle_modify_meter(ofproto, &mm);
5208 case OFPMC13_DELETE:
5209 error = handle_delete_meter(ofconn, oh, &mm);
5213 error = OFPERR_OFPMMFC_BAD_COMMAND;
5218 ofpbuf_uninit(&bands);
5223 handle_meter_features_request(struct ofconn *ofconn,
5224 const struct ofp_header *request)
5226 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5227 struct ofputil_meter_features features;
5230 if (ofproto->ofproto_class->meter_get_features) {
5231 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5233 memset(&features, 0, sizeof features);
5235 b = ofputil_encode_meter_features_reply(&features, request);
5237 ofconn_send_reply(ofconn, b);
5242 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5245 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5246 struct list replies;
5247 uint64_t bands_stub[256 / 8];
5248 struct ofpbuf bands;
5249 uint32_t meter_id, first, last;
5251 ofputil_decode_meter_request(request, &meter_id);
5253 if (meter_id == OFPM13_ALL) {
5255 last = ofproto->meter_features.max_meters;
5257 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5258 !ofproto->meters[meter_id]) {
5259 return OFPERR_OFPMMFC_UNKNOWN_METER;
5261 first = last = meter_id;
5264 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5265 ofpmp_init(&replies, request);
5267 for (meter_id = first; meter_id <= last; ++meter_id) {
5268 struct meter *meter = ofproto->meters[meter_id];
5270 continue; /* Skip non-existing meters. */
5272 if (type == OFPTYPE_METER_STATS_REQUEST) {
5273 struct ofputil_meter_stats stats;
5275 stats.meter_id = meter_id;
5277 /* Provider sets the packet and byte counts, we do the rest. */
5278 stats.flow_count = list_size(&meter->rules);
5279 calc_duration(meter->created, time_msec(),
5280 &stats.duration_sec, &stats.duration_nsec);
5281 stats.n_bands = meter->n_bands;
5282 ofpbuf_clear(&bands);
5284 = ofpbuf_put_uninit(&bands,
5285 meter->n_bands * sizeof *stats.bands);
5287 if (!ofproto->ofproto_class->meter_get(ofproto,
5288 meter->provider_meter_id,
5290 ofputil_append_meter_stats(&replies, &stats);
5292 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5293 struct ofputil_meter_config config;
5295 config.meter_id = meter_id;
5296 config.flags = meter->flags;
5297 config.n_bands = meter->n_bands;
5298 config.bands = meter->bands;
5299 ofputil_append_meter_config(&replies, &config);
5303 ofconn_send_replies(ofconn, &replies);
5304 ofpbuf_uninit(&bands);
5309 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5310 struct ofgroup **group)
5311 OVS_TRY_RDLOCK(true, (*group)->rwlock)
5313 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5314 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5315 hash_int(group_id, 0), &ofproto->groups) {
5316 if ((*group)->group_id == group_id) {
5317 ovs_rwlock_rdlock(&(*group)->rwlock);
5318 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5322 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5327 ofproto_group_release(struct ofgroup *group)
5328 OVS_RELEASES(group->rwlock)
5330 ovs_rwlock_unlock(&group->rwlock);
5334 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
5335 struct ofgroup **group)
5336 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
5337 OVS_TRY_WRLOCK(true, (*group)->rwlock)
5339 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5340 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5341 hash_int(group_id, 0), &ofproto->groups) {
5342 if ((*group)->group_id == group_id) {
5343 ovs_rwlock_wrlock(&(*group)->rwlock);
5347 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5352 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5353 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5355 struct ofgroup *grp;
5357 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5358 hash_int(group_id, 0), &ofproto->groups) {
5359 if (grp->group_id == group_id) {
5367 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5368 OVS_EXCLUDED(ofproto->groups_rwlock)
5372 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5373 exists = ofproto_group_exists__(ofproto, group_id);
5374 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5380 group_get_ref_count(struct ofgroup *group)
5381 OVS_EXCLUDED(ofproto_mutex)
5383 struct ofproto *ofproto = group->ofproto;
5384 struct rule_criteria criteria;
5385 struct rule_collection rules;
5390 match_init_catchall(&match);
5391 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5392 OFPP_ANY, group->group_id);
5393 ovs_mutex_lock(&ofproto_mutex);
5394 error = collect_rules_loose(ofproto, &criteria, &rules);
5395 ovs_mutex_unlock(&ofproto_mutex);
5396 rule_criteria_destroy(&criteria);
5398 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5400 rule_collection_destroy(&rules);
5405 append_group_stats(struct ofgroup *group, struct list *replies)
5406 OVS_REQ_RDLOCK(group->rwlock)
5408 struct ofputil_group_stats ogs;
5409 struct ofproto *ofproto = group->ofproto;
5410 long long int now = time_msec();
5413 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5415 /* Provider sets the packet and byte counts, we do the rest. */
5416 ogs.ref_count = group_get_ref_count(group);
5417 ogs.n_buckets = group->n_buckets;
5419 error = (ofproto->ofproto_class->group_get_stats
5420 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5423 ogs.packet_count = UINT64_MAX;
5424 ogs.byte_count = UINT64_MAX;
5425 memset(ogs.bucket_stats, 0xff,
5426 ogs.n_buckets * sizeof *ogs.bucket_stats);
5429 ogs.group_id = group->group_id;
5430 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5432 ofputil_append_group_stats(replies, &ogs);
5434 free(ogs.bucket_stats);
5438 handle_group_stats_request(struct ofconn *ofconn,
5439 const struct ofp_header *request)
5441 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5442 struct list replies;
5444 struct ofgroup *group;
5447 error = ofputil_decode_group_stats_request(request, &group_id);
5452 ofpmp_init(&replies, request);
5454 if (group_id == OFPG_ALL) {
5455 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5456 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5457 ovs_rwlock_rdlock(&group->rwlock);
5458 append_group_stats(group, &replies);
5459 ovs_rwlock_unlock(&group->rwlock);
5461 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5463 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5464 append_group_stats(group, &replies);
5465 ofproto_group_release(group);
5469 ofconn_send_replies(ofconn, &replies);
5475 handle_group_desc_stats_request(struct ofconn *ofconn,
5476 const struct ofp_header *request)
5478 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5479 struct list replies;
5480 struct ofputil_group_desc gds;
5481 struct ofgroup *group;
5483 ofpmp_init(&replies, request);
5485 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5486 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5487 gds.group_id = group->group_id;
5488 gds.type = group->type;
5489 ofputil_append_group_desc_reply(&gds, &group->buckets, &replies);
5491 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5493 ofconn_send_replies(ofconn, &replies);
5499 handle_group_features_stats_request(struct ofconn *ofconn,
5500 const struct ofp_header *request)
5502 struct ofproto *p = ofconn_get_ofproto(ofconn);
5505 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5507 ofconn_send_reply(ofconn, msg);
5514 handle_queue_get_config_request(struct ofconn *ofconn,
5515 const struct ofp_header *oh)
5517 struct ofproto *p = ofconn_get_ofproto(ofconn);
5518 struct netdev_queue_dump queue_dump;
5519 struct ofport *ofport;
5520 unsigned int queue_id;
5521 struct ofpbuf *reply;
5522 struct smap details;
5526 error = ofputil_decode_queue_get_config_request(oh, &request);
5531 ofport = ofproto_get_port(p, request);
5533 return OFPERR_OFPQOFC_BAD_PORT;
5536 reply = ofputil_encode_queue_get_config_reply(oh);
5538 smap_init(&details);
5539 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5540 struct ofputil_queue_config queue;
5542 /* None of the existing queues have compatible properties, so we
5543 * hard-code omitting min_rate and max_rate. */
5544 queue.queue_id = queue_id;
5545 queue.min_rate = UINT16_MAX;
5546 queue.max_rate = UINT16_MAX;
5547 ofputil_append_queue_get_config_reply(reply, &queue);
5549 smap_destroy(&details);
5551 ofconn_send_reply(ofconn, reply);
5556 /* Implements OFPGC11_ADD
5557 * in which no matching flow already exists in the flow table.
5559 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5560 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5561 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5562 * initiated now but may be retried later.
5564 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5565 * ownership remains with the caller.
5567 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5570 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5572 struct ofgroup *ofgroup;
5575 if (gm->group_id > OFPG_MAX) {
5576 return OFPERR_OFPGMFC_INVALID_GROUP;
5578 if (gm->type > OFPGT11_FF) {
5579 return OFPERR_OFPGMFC_BAD_TYPE;
5582 /* Allocate new group and initialize it. */
5583 ofgroup = ofproto->ofproto_class->group_alloc();
5585 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
5586 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5589 ovs_rwlock_init(&ofgroup->rwlock);
5590 ofgroup->ofproto = ofproto;
5591 ofgroup->group_id = gm->group_id;
5592 ofgroup->type = gm->type;
5593 ofgroup->created = ofgroup->modified = time_msec();
5595 list_move(&ofgroup->buckets, &gm->buckets);
5596 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5598 /* Construct called BEFORE any locks are held. */
5599 error = ofproto->ofproto_class->group_construct(ofgroup);
5604 /* We wrlock as late as possible to minimize the time we jam any other
5605 * threads: No visible state changes before acquiring the lock. */
5606 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5608 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5609 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5613 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5614 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5619 /* Insert new group. */
5620 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5621 hash_int(ofgroup->group_id, 0));
5622 ofproto->n_groups[ofgroup->type]++;
5624 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5629 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5630 ofproto->ofproto_class->group_destruct(ofgroup);
5632 ofputil_bucket_list_destroy(&ofgroup->buckets);
5633 ofproto->ofproto_class->group_dealloc(ofgroup);
5638 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5641 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5644 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5646 struct ofgroup *ofgroup;
5647 struct ofgroup *victim;
5650 if (gm->group_id > OFPG_MAX) {
5651 return OFPERR_OFPGMFC_INVALID_GROUP;
5654 if (gm->type > OFPGT11_FF) {
5655 return OFPERR_OFPGMFC_BAD_TYPE;
5658 victim = ofproto->ofproto_class->group_alloc();
5660 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5661 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5664 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5665 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5668 /* Both group's and its container's write locks held now.
5669 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5670 if (ofgroup->type != gm->type
5671 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5672 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5677 list_move(&victim->buckets, &ofgroup->buckets);
5679 ofgroup->type = gm->type;
5680 list_move(&ofgroup->buckets, &gm->buckets);
5681 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5683 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5685 ofputil_bucket_list_destroy(&victim->buckets);
5686 ofproto->n_groups[victim->type]--;
5687 ofproto->n_groups[ofgroup->type]++;
5688 ofgroup->modified = time_msec();
5690 ofputil_bucket_list_destroy(&ofgroup->buckets);
5693 list_move(&ofgroup->buckets, &victim->buckets);
5697 ovs_rwlock_unlock(&ofgroup->rwlock);
5698 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5700 ofproto->ofproto_class->group_dealloc(victim);
5705 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5706 OVS_RELEASES(ofproto->groups_rwlock)
5709 struct ofputil_flow_mod fm;
5711 /* Delete all flow entries containing this group in a group action */
5712 match_init_catchall(&match);
5713 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5714 fm.out_group = ofgroup->group_id;
5715 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5717 /* Must wait until existing readers are done,
5718 * while holding the container's write lock at the same time. */
5719 ovs_rwlock_wrlock(&ofgroup->rwlock);
5720 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5721 /* No-one can find this group any more. */
5722 ofproto->n_groups[ofgroup->type]--;
5723 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5725 ofproto->ofproto_class->group_destruct(ofgroup);
5726 ofputil_bucket_list_destroy(&ofgroup->buckets);
5727 ovs_rwlock_unlock(&ofgroup->rwlock);
5728 ovs_rwlock_destroy(&ofgroup->rwlock);
5729 ofproto->ofproto_class->group_dealloc(ofgroup);
5732 /* Implements OFPGC_DELETE. */
5734 delete_group(struct ofproto *ofproto, uint32_t group_id)
5736 struct ofgroup *ofgroup;
5738 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5739 if (group_id == OFPG_ALL) {
5741 struct hmap_node *node = hmap_first(&ofproto->groups);
5745 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5746 delete_group__(ofproto, ofgroup);
5747 /* Lock for each node separately, so that we will not jam the
5748 * other threads for too long time. */
5749 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5752 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5753 hash_int(group_id, 0), &ofproto->groups) {
5754 if (ofgroup->group_id == group_id) {
5755 delete_group__(ofproto, ofgroup);
5760 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5764 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5766 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5767 struct ofputil_group_mod gm;
5770 error = reject_slave_controller(ofconn);
5775 error = ofputil_decode_group_mod(oh, &gm);
5780 switch (gm.command) {
5782 return add_group(ofproto, &gm);
5784 case OFPGC11_MODIFY:
5785 return modify_group(ofproto, &gm);
5787 case OFPGC11_DELETE:
5788 delete_group(ofproto, gm.group_id);
5792 if (gm.command > OFPGC11_DELETE) {
5793 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5794 ofproto->name, gm.command);
5796 return OFPERR_OFPGMFC_BAD_COMMAND;
5801 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5803 struct ofputil_table_mod tm;
5806 error = reject_slave_controller(ofconn);
5811 error = ofputil_decode_table_mod(oh, &tm);
5816 /* XXX Actual table mod support is not implemented yet. */
5821 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5822 OVS_EXCLUDED(ofproto_mutex)
5824 const struct ofp_header *oh = msg->data;
5828 error = ofptype_decode(&type, oh);
5832 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5833 && ofpmp_more(oh)) {
5834 /* We have no buffer implementation for multipart requests.
5835 * Report overflow for requests which consists of multiple
5837 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5841 /* OpenFlow requests. */
5842 case OFPTYPE_ECHO_REQUEST:
5843 return handle_echo_request(ofconn, oh);
5845 case OFPTYPE_FEATURES_REQUEST:
5846 return handle_features_request(ofconn, oh);
5848 case OFPTYPE_GET_CONFIG_REQUEST:
5849 return handle_get_config_request(ofconn, oh);
5851 case OFPTYPE_SET_CONFIG:
5852 return handle_set_config(ofconn, oh);
5854 case OFPTYPE_PACKET_OUT:
5855 return handle_packet_out(ofconn, oh);
5857 case OFPTYPE_PORT_MOD:
5858 return handle_port_mod(ofconn, oh);
5860 case OFPTYPE_FLOW_MOD:
5861 return handle_flow_mod(ofconn, oh);
5863 case OFPTYPE_GROUP_MOD:
5864 return handle_group_mod(ofconn, oh);
5866 case OFPTYPE_TABLE_MOD:
5867 return handle_table_mod(ofconn, oh);
5869 case OFPTYPE_METER_MOD:
5870 return handle_meter_mod(ofconn, oh);
5872 case OFPTYPE_BARRIER_REQUEST:
5873 return handle_barrier_request(ofconn, oh);
5875 case OFPTYPE_ROLE_REQUEST:
5876 return handle_role_request(ofconn, oh);
5878 /* OpenFlow replies. */
5879 case OFPTYPE_ECHO_REPLY:
5882 /* Nicira extension requests. */
5883 case OFPTYPE_FLOW_MOD_TABLE_ID:
5884 return handle_nxt_flow_mod_table_id(ofconn, oh);
5886 case OFPTYPE_SET_FLOW_FORMAT:
5887 return handle_nxt_set_flow_format(ofconn, oh);
5889 case OFPTYPE_SET_PACKET_IN_FORMAT:
5890 return handle_nxt_set_packet_in_format(ofconn, oh);
5892 case OFPTYPE_SET_CONTROLLER_ID:
5893 return handle_nxt_set_controller_id(ofconn, oh);
5895 case OFPTYPE_FLOW_AGE:
5896 /* Nothing to do. */
5899 case OFPTYPE_FLOW_MONITOR_CANCEL:
5900 return handle_flow_monitor_cancel(ofconn, oh);
5902 case OFPTYPE_SET_ASYNC_CONFIG:
5903 return handle_nxt_set_async_config(ofconn, oh);
5905 case OFPTYPE_GET_ASYNC_REQUEST:
5906 return handle_nxt_get_async_request(ofconn, oh);
5908 /* Statistics requests. */
5909 case OFPTYPE_DESC_STATS_REQUEST:
5910 return handle_desc_stats_request(ofconn, oh);
5912 case OFPTYPE_FLOW_STATS_REQUEST:
5913 return handle_flow_stats_request(ofconn, oh);
5915 case OFPTYPE_AGGREGATE_STATS_REQUEST:
5916 return handle_aggregate_stats_request(ofconn, oh);
5918 case OFPTYPE_TABLE_STATS_REQUEST:
5919 return handle_table_stats_request(ofconn, oh);
5921 case OFPTYPE_PORT_STATS_REQUEST:
5922 return handle_port_stats_request(ofconn, oh);
5924 case OFPTYPE_QUEUE_STATS_REQUEST:
5925 return handle_queue_stats_request(ofconn, oh);
5927 case OFPTYPE_PORT_DESC_STATS_REQUEST:
5928 return handle_port_desc_stats_request(ofconn, oh);
5930 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
5931 return handle_flow_monitor_request(ofconn, oh);
5933 case OFPTYPE_METER_STATS_REQUEST:
5934 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
5935 return handle_meter_request(ofconn, oh, type);
5937 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
5938 return handle_meter_features_request(ofconn, oh);
5940 case OFPTYPE_GROUP_STATS_REQUEST:
5941 return handle_group_stats_request(ofconn, oh);
5943 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
5944 return handle_group_desc_stats_request(ofconn, oh);
5946 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
5947 return handle_group_features_stats_request(ofconn, oh);
5949 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
5950 return handle_queue_get_config_request(ofconn, oh);
5954 case OFPTYPE_FEATURES_REPLY:
5955 case OFPTYPE_GET_CONFIG_REPLY:
5956 case OFPTYPE_PACKET_IN:
5957 case OFPTYPE_FLOW_REMOVED:
5958 case OFPTYPE_PORT_STATUS:
5959 case OFPTYPE_BARRIER_REPLY:
5960 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
5961 case OFPTYPE_DESC_STATS_REPLY:
5962 case OFPTYPE_FLOW_STATS_REPLY:
5963 case OFPTYPE_QUEUE_STATS_REPLY:
5964 case OFPTYPE_PORT_STATS_REPLY:
5965 case OFPTYPE_TABLE_STATS_REPLY:
5966 case OFPTYPE_AGGREGATE_STATS_REPLY:
5967 case OFPTYPE_PORT_DESC_STATS_REPLY:
5968 case OFPTYPE_ROLE_REPLY:
5969 case OFPTYPE_FLOW_MONITOR_PAUSED:
5970 case OFPTYPE_FLOW_MONITOR_RESUMED:
5971 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
5972 case OFPTYPE_GET_ASYNC_REPLY:
5973 case OFPTYPE_GROUP_STATS_REPLY:
5974 case OFPTYPE_GROUP_DESC_STATS_REPLY:
5975 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
5976 case OFPTYPE_METER_STATS_REPLY:
5977 case OFPTYPE_METER_CONFIG_STATS_REPLY:
5978 case OFPTYPE_METER_FEATURES_STATS_REPLY:
5979 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
5980 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
5981 case OFPTYPE_ROLE_STATUS:
5983 if (ofpmsg_is_stat_request(oh)) {
5984 return OFPERR_OFPBRC_BAD_STAT;
5986 return OFPERR_OFPBRC_BAD_TYPE;
5992 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
5993 OVS_EXCLUDED(ofproto_mutex)
5995 int error = handle_openflow__(ofconn, ofp_msg);
5996 if (error && error != OFPROTO_POSTPONE) {
5997 ofconn_send_error(ofconn, ofp_msg->data, error);
5999 COVERAGE_INC(ofproto_recv_openflow);
6000 return error != OFPROTO_POSTPONE;
6003 /* Asynchronous operations. */
6005 /* Creates and returns a new ofopgroup that is not associated with any
6006 * OpenFlow connection.
6008 * The caller should add operations to the returned group with
6009 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6010 static struct ofopgroup *
6011 ofopgroup_create_unattached(struct ofproto *ofproto)
6012 OVS_REQUIRES(ofproto_mutex)
6014 struct ofopgroup *group = xzalloc(sizeof *group);
6015 group->ofproto = ofproto;
6016 list_init(&group->ofproto_node);
6017 list_init(&group->ops);
6018 list_init(&group->ofconn_node);
6022 /* Creates and returns a new ofopgroup for 'ofproto'.
6024 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6025 * connection. The 'request' and 'buffer_id' arguments are ignored.
6027 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6028 * If the ofopgroup eventually fails, then the error reply will include
6029 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6030 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6032 * The caller should add operations to the returned group with
6033 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6034 static struct ofopgroup *
6035 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6036 const struct ofp_header *request, uint32_t buffer_id)
6037 OVS_REQUIRES(ofproto_mutex)
6039 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6041 size_t request_len = ntohs(request->length);
6043 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6045 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6046 group->ofconn = ofconn;
6047 group->request = xmemdup(request, MIN(request_len, 64));
6048 group->buffer_id = buffer_id;
6053 /* Submits 'group' for processing.
6055 * If 'group' contains no operations (e.g. none were ever added, or all of the
6056 * ones that were added completed synchronously), then it is destroyed
6057 * immediately. Otherwise it is added to the ofproto's list of pending
6060 ofopgroup_submit(struct ofopgroup *group)
6061 OVS_REQUIRES(ofproto_mutex)
6063 if (!group->n_running) {
6064 ofopgroup_complete(group);
6066 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6067 group->ofproto->n_pending++;
6072 ofopgroup_complete(struct ofopgroup *group)
6073 OVS_REQUIRES(ofproto_mutex)
6075 struct ofproto *ofproto = group->ofproto;
6077 struct ofconn *abbrev_ofconn;
6078 ovs_be32 abbrev_xid;
6080 struct ofoperation *op, *next_op;
6083 ovs_assert(!group->n_running);
6086 LIST_FOR_EACH (op, group_node, &group->ops) {
6093 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6094 LIST_FOR_EACH (op, group_node, &group->ops) {
6095 if (op->type != OFOPERATION_DELETE) {
6096 struct ofpbuf *packet;
6099 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6102 struct rule_execute *re;
6106 ofproto_rule_ref(op->rule);
6108 re = xmalloc(sizeof *re);
6109 re->rule = op->rule;
6110 re->in_port = in_port;
6111 re->packet = packet;
6113 if (!guarded_list_push_back(&ofproto->rule_executes,
6114 &re->list_node, 1024)) {
6115 ofproto_rule_unref(op->rule);
6116 ofpbuf_delete(re->packet);
6125 if (!error && !list_is_empty(&group->ofconn_node)) {
6126 abbrev_ofconn = group->ofconn;
6127 abbrev_xid = group->request->xid;
6129 abbrev_ofconn = NULL;
6130 abbrev_xid = htonl(0);
6132 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6133 struct rule *rule = op->rule;
6135 /* We generally want to report the change to active OpenFlow flow
6136 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6138 - The operation failed.
6140 - The affected rule is not visible to controllers.
6142 - The operation's only effect was to update rule->modified. */
6144 || ofproto_rule_is_hidden(rule)
6145 || (op->type == OFOPERATION_MODIFY
6147 && rule->flow_cookie == op->flow_cookie))) {
6148 /* Check that we can just cast from ofoperation_type to
6149 * nx_flow_update_event. */
6150 enum nx_flow_update_event event_type;
6153 case OFOPERATION_ADD:
6154 case OFOPERATION_REPLACE:
6155 event_type = NXFME_ADDED;
6158 case OFOPERATION_DELETE:
6159 event_type = NXFME_DELETED;
6162 case OFOPERATION_MODIFY:
6163 event_type = NXFME_MODIFIED;
6170 ofmonitor_report(ofproto->connmgr, rule, event_type,
6171 op->reason, abbrev_ofconn, abbrev_xid);
6174 rule->pending = NULL;
6177 case OFOPERATION_ADD:
6181 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6182 if (vid_mask == VLAN_VID_MASK) {
6183 if (ofproto->vlan_bitmap) {
6184 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6185 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6186 bitmap_set1(ofproto->vlan_bitmap, vid);
6187 ofproto->vlans_changed = true;
6190 ofproto->vlans_changed = true;
6194 oftable_remove_rule(rule);
6195 ofproto_rule_unref(rule);
6199 case OFOPERATION_DELETE:
6200 ovs_assert(!op->error);
6201 ofproto_rule_unref(rule);
6205 case OFOPERATION_MODIFY:
6206 case OFOPERATION_REPLACE:
6208 long long int now = time_msec();
6210 rule->modified = now;
6211 if (op->type == OFOPERATION_REPLACE) {
6212 rule->created = rule->used = now;
6215 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6216 ovs_mutex_lock(&rule->mutex);
6217 rule->idle_timeout = op->idle_timeout;
6218 rule->hard_timeout = op->hard_timeout;
6219 ovs_mutex_unlock(&rule->mutex);
6221 struct rule_actions *old_actions;
6223 ovs_mutex_lock(&rule->mutex);
6224 old_actions = rule->actions;
6225 rule->actions = op->actions;
6226 ovs_mutex_unlock(&rule->mutex);
6229 rule_actions_unref(old_actions);
6231 rule->flags = op->flags;
6239 ofoperation_destroy(op);
6242 ofmonitor_flush(ofproto->connmgr);
6244 if (!list_is_empty(&group->ofproto_node)) {
6245 ovs_assert(ofproto->n_pending > 0);
6246 ofproto->n_pending--;
6247 list_remove(&group->ofproto_node);
6249 if (!list_is_empty(&group->ofconn_node)) {
6250 list_remove(&group->ofconn_node);
6252 ofconn_send_error(group->ofconn, group->request, error);
6254 connmgr_retry(ofproto->connmgr);
6256 free(group->request);
6260 /* Initiates a new operation on 'rule', of the specified 'type', within
6261 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6263 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6264 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6266 * Returns the newly created ofoperation (which is also available as
6267 * rule->pending). */
6268 static struct ofoperation *
6269 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6270 enum ofoperation_type type,
6271 enum ofp_flow_removed_reason reason)
6272 OVS_REQUIRES(ofproto_mutex)
6274 struct ofproto *ofproto = group->ofproto;
6275 struct ofoperation *op;
6277 ovs_assert(!rule->pending);
6279 op = rule->pending = xzalloc(sizeof *op);
6281 list_push_back(&group->ops, &op->group_node);
6284 op->reason = reason;
6285 op->flow_cookie = rule->flow_cookie;
6286 ovs_mutex_lock(&rule->mutex);
6287 op->idle_timeout = rule->idle_timeout;
6288 op->hard_timeout = rule->hard_timeout;
6289 ovs_mutex_unlock(&rule->mutex);
6290 op->flags = rule->flags;
6294 if (type == OFOPERATION_DELETE) {
6295 hmap_insert(&ofproto->deletions, &op->hmap_node,
6296 cls_rule_hash(&rule->cr, rule->table_id));
6303 ofoperation_destroy(struct ofoperation *op)
6304 OVS_REQUIRES(ofproto_mutex)
6306 struct ofopgroup *group = op->group;
6309 op->rule->pending = NULL;
6311 if (op->type == OFOPERATION_DELETE) {
6312 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6314 list_remove(&op->group_node);
6315 rule_actions_unref(op->actions);
6319 /* Indicates that 'op' completed with status 'error', which is either 0 to
6320 * indicate success or an OpenFlow error code on failure.
6322 * If 'error' is 0, indicating success, the operation will be committed
6323 * permanently to the flow table.
6325 * If 'error' is nonzero, then generally the operation will be rolled back:
6327 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6328 * restores the original rule. The caller must have uninitialized any
6329 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6330 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6331 * and 7 for the new rule, calling its ->rule_dealloc() function.
6333 * - If 'op' is a "modify flow" operation, ofproto restores the original
6336 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6337 * allowed to fail. It must always succeed.
6339 * Please see the large comment in ofproto/ofproto-provider.h titled
6340 * "Asynchronous Operation Support" for more information. */
6342 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6344 struct ofopgroup *group = op->group;
6346 ovs_assert(group->n_running > 0);
6347 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6350 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6351 /* This function can be called from ->rule_construct(), in which case
6352 * ofproto_mutex is held, or it can be called from ->run(), in which
6353 * case ofproto_mutex is not held. But only in the latter case can we
6354 * arrive here, so we can safely take ofproto_mutex now. */
6355 ovs_mutex_lock(&ofproto_mutex);
6356 ovs_assert(op->rule->pending == op);
6357 ofopgroup_complete(group);
6358 ovs_mutex_unlock(&ofproto_mutex);
6363 pick_datapath_id(const struct ofproto *ofproto)
6365 const struct ofport *port;
6367 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6369 uint8_t ea[ETH_ADDR_LEN];
6372 error = netdev_get_etheraddr(port->netdev, ea);
6374 return eth_addr_to_uint64(ea);
6376 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6377 ofproto->name, netdev_get_name(port->netdev),
6378 ovs_strerror(error));
6380 return ofproto->fallback_dpid;
6384 pick_fallback_dpid(void)
6386 uint8_t ea[ETH_ADDR_LEN];
6387 eth_addr_nicira_random(ea);
6388 return eth_addr_to_uint64(ea);
6391 /* Table overflow policy. */
6393 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6394 * to NULL if the table is not configured to evict rules or if the table
6395 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6396 * or with no timeouts are not evictable.) */
6398 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6399 OVS_REQUIRES(ofproto_mutex)
6401 struct eviction_group *evg;
6404 if (!table->eviction_fields) {
6408 /* In the common case, the outer and inner loops here will each be entered
6411 * - The inner loop normally "return"s in its first iteration. If the
6412 * eviction group has any evictable rules, then it always returns in
6415 * - The outer loop only iterates more than once if the largest eviction
6416 * group has no evictable rules.
6418 * - The outer loop can exit only if table's 'max_flows' is all filled up
6419 * by unevictable rules. */
6420 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6423 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6432 /* Searches 'ofproto' for tables that have more flows than their configured
6433 * maximum and that have flow eviction enabled, and evicts as many flows as
6434 * necessary and currently feasible from them.
6436 * This triggers only when an OpenFlow table has N flows in it and then the
6437 * client configures a maximum number of flows less than N. */
6439 ofproto_evict(struct ofproto *ofproto)
6441 struct oftable *table;
6443 ovs_mutex_lock(&ofproto_mutex);
6444 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6445 evict_rules_from_table(ofproto, table, 0);
6447 ovs_mutex_unlock(&ofproto_mutex);
6450 /* Eviction groups. */
6452 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6453 * rules. The priority contains low-order random bits to ensure that eviction
6454 * groups with the same number of rules are prioritized randomly. */
6456 eviction_group_priority(size_t n_rules)
6458 uint16_t size = MIN(UINT16_MAX, n_rules);
6459 return (size << 16) | random_uint16();
6462 /* Updates 'evg', an eviction_group within 'table', following a change that
6463 * adds or removes rules in 'evg'. */
6465 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6466 OVS_REQUIRES(ofproto_mutex)
6468 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6469 eviction_group_priority(heap_count(&evg->rules)));
6472 /* Destroys 'evg', an eviction_group within 'table':
6474 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6475 * rules themselves, just removes them from the eviction group.)
6477 * - Removes 'evg' from 'table'.
6481 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6482 OVS_REQUIRES(ofproto_mutex)
6484 while (!heap_is_empty(&evg->rules)) {
6487 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6488 rule->eviction_group = NULL;
6490 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6491 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6492 heap_destroy(&evg->rules);
6496 /* Removes 'rule' from its eviction group, if any. */
6498 eviction_group_remove_rule(struct rule *rule)
6499 OVS_REQUIRES(ofproto_mutex)
6501 if (rule->eviction_group) {
6502 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6503 struct eviction_group *evg = rule->eviction_group;
6505 rule->eviction_group = NULL;
6506 heap_remove(&evg->rules, &rule->evg_node);
6507 if (heap_is_empty(&evg->rules)) {
6508 eviction_group_destroy(table, evg);
6510 eviction_group_resized(table, evg);
6515 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6516 * returns the hash value. */
6518 eviction_group_hash_rule(struct rule *rule)
6519 OVS_REQUIRES(ofproto_mutex)
6521 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6522 const struct mf_subfield *sf;
6526 hash = table->eviction_group_id_basis;
6527 miniflow_expand(&rule->cr.match.flow, &flow);
6528 for (sf = table->eviction_fields;
6529 sf < &table->eviction_fields[table->n_eviction_fields];
6532 if (mf_are_prereqs_ok(sf->field, &flow)) {
6533 union mf_value value;
6535 mf_get_value(sf->field, &flow, &value);
6537 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6539 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6540 unsigned int start = sf->ofs + sf->n_bits;
6541 bitwise_zero(&value, sf->field->n_bytes, start,
6542 sf->field->n_bytes * 8 - start);
6544 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6546 hash = hash_int(hash, 0);
6553 /* Returns an eviction group within 'table' with the given 'id', creating one
6555 static struct eviction_group *
6556 eviction_group_find(struct oftable *table, uint32_t id)
6557 OVS_REQUIRES(ofproto_mutex)
6559 struct eviction_group *evg;
6561 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6565 evg = xmalloc(sizeof *evg);
6566 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6567 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6568 eviction_group_priority(0));
6569 heap_init(&evg->rules);
6574 /* Returns an eviction priority for 'rule'. The return value should be
6575 * interpreted so that higher priorities make a rule more attractive candidates
6578 rule_eviction_priority(struct rule *rule)
6579 OVS_REQUIRES(ofproto_mutex)
6581 long long int hard_expiration;
6582 long long int idle_expiration;
6583 long long int expiration;
6584 uint32_t expiration_offset;
6586 /* Calculate time of expiration. */
6587 ovs_mutex_lock(&rule->mutex);
6588 hard_expiration = (rule->hard_timeout
6589 ? rule->modified + rule->hard_timeout * 1000
6591 idle_expiration = (rule->idle_timeout
6592 ? rule->used + rule->idle_timeout * 1000
6594 expiration = MIN(hard_expiration, idle_expiration);
6595 ovs_mutex_unlock(&rule->mutex);
6596 if (expiration == LLONG_MAX) {
6600 /* Calculate the time of expiration as a number of (approximate) seconds
6601 * after program startup.
6603 * This should work OK for program runs that last UINT32_MAX seconds or
6604 * less. Therefore, please restart OVS at least once every 136 years. */
6605 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6607 /* Invert the expiration offset because we're using a max-heap. */
6608 return UINT32_MAX - expiration_offset;
6611 /* Adds 'rule' to an appropriate eviction group for its oftable's
6612 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6613 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6616 * The caller must ensure that 'rule' is not already in an eviction group. */
6618 eviction_group_add_rule(struct rule *rule)
6619 OVS_REQUIRES(ofproto_mutex)
6621 struct ofproto *ofproto = rule->ofproto;
6622 struct oftable *table = &ofproto->tables[rule->table_id];
6625 ovs_mutex_lock(&rule->mutex);
6626 has_timeout = rule->hard_timeout || rule->idle_timeout;
6627 ovs_mutex_unlock(&rule->mutex);
6629 if (table->eviction_fields && has_timeout) {
6630 struct eviction_group *evg;
6632 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6634 rule->eviction_group = evg;
6635 heap_insert(&evg->rules, &rule->evg_node,
6636 rule_eviction_priority(rule));
6637 eviction_group_resized(table, evg);
6643 /* Initializes 'table'. */
6645 oftable_init(struct oftable *table)
6647 memset(table, 0, sizeof *table);
6648 classifier_init(&table->cls, flow_segment_u32s);
6649 table->max_flows = UINT_MAX;
6652 /* Destroys 'table', including its classifier and eviction groups.
6654 * The caller is responsible for freeing 'table' itself. */
6656 oftable_destroy(struct oftable *table)
6658 ovs_rwlock_rdlock(&table->cls.rwlock);
6659 ovs_assert(classifier_is_empty(&table->cls));
6660 ovs_rwlock_unlock(&table->cls.rwlock);
6661 oftable_disable_eviction(table);
6662 classifier_destroy(&table->cls);
6666 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6667 * string, then 'table' will use its default name.
6669 * This only affects the name exposed for a table exposed through the OpenFlow
6670 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6672 oftable_set_name(struct oftable *table, const char *name)
6674 if (name && name[0]) {
6675 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6676 if (!table->name || strncmp(name, table->name, len)) {
6678 table->name = xmemdup0(name, len);
6686 /* oftables support a choice of two policies when adding a rule would cause the
6687 * number of flows in the table to exceed the configured maximum number: either
6688 * they can refuse to add the new flow or they can evict some existing flow.
6689 * This function configures the former policy on 'table'. */
6691 oftable_disable_eviction(struct oftable *table)
6692 OVS_REQUIRES(ofproto_mutex)
6694 if (table->eviction_fields) {
6695 struct eviction_group *evg, *next;
6697 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6698 &table->eviction_groups_by_id) {
6699 eviction_group_destroy(table, evg);
6701 hmap_destroy(&table->eviction_groups_by_id);
6702 heap_destroy(&table->eviction_groups_by_size);
6704 free(table->eviction_fields);
6705 table->eviction_fields = NULL;
6706 table->n_eviction_fields = 0;
6710 /* oftables support a choice of two policies when adding a rule would cause the
6711 * number of flows in the table to exceed the configured maximum number: either
6712 * they can refuse to add the new flow or they can evict some existing flow.
6713 * This function configures the latter policy on 'table', with fairness based
6714 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6715 * 'n_fields' as 0 disables fairness.) */
6717 oftable_enable_eviction(struct oftable *table,
6718 const struct mf_subfield *fields, size_t n_fields)
6719 OVS_REQUIRES(ofproto_mutex)
6721 struct cls_cursor cursor;
6724 if (table->eviction_fields
6725 && n_fields == table->n_eviction_fields
6727 || !memcmp(fields, table->eviction_fields,
6728 n_fields * sizeof *fields))) {
6733 oftable_disable_eviction(table);
6735 table->n_eviction_fields = n_fields;
6736 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6738 table->eviction_group_id_basis = random_uint32();
6739 hmap_init(&table->eviction_groups_by_id);
6740 heap_init(&table->eviction_groups_by_size);
6742 ovs_rwlock_rdlock(&table->cls.rwlock);
6743 cls_cursor_init(&cursor, &table->cls, NULL);
6744 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6745 eviction_group_add_rule(rule);
6747 ovs_rwlock_unlock(&table->cls.rwlock);
6750 /* Removes 'rule' from the oftable that contains it. */
6752 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6753 OVS_REQUIRES(ofproto_mutex)
6755 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6757 ovs_rwlock_wrlock(&cls->rwlock);
6758 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6759 ovs_rwlock_unlock(&cls->rwlock);
6761 cookies_remove(ofproto, rule);
6763 eviction_group_remove_rule(rule);
6764 if (!list_is_empty(&rule->expirable)) {
6765 list_remove(&rule->expirable);
6767 if (!list_is_empty(&rule->meter_list_node)) {
6768 list_remove(&rule->meter_list_node);
6769 list_init(&rule->meter_list_node);
6774 oftable_remove_rule(struct rule *rule)
6775 OVS_REQUIRES(ofproto_mutex)
6777 oftable_remove_rule__(rule->ofproto, rule);
6780 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6781 * the same cls_rule. */
6783 oftable_insert_rule(struct rule *rule)
6784 OVS_REQUIRES(ofproto_mutex)
6786 struct ofproto *ofproto = rule->ofproto;
6787 struct oftable *table = &ofproto->tables[rule->table_id];
6790 ovs_mutex_lock(&rule->mutex);
6791 may_expire = rule->hard_timeout || rule->idle_timeout;
6792 ovs_mutex_unlock(&rule->mutex);
6795 list_insert(&ofproto->expirable, &rule->expirable);
6798 cookies_insert(ofproto, rule);
6800 if (rule->actions->provider_meter_id != UINT32_MAX) {
6801 uint32_t meter_id = ofpacts_get_meter(rule->actions->ofpacts,
6802 rule->actions->ofpacts_len);
6803 struct meter *meter = ofproto->meters[meter_id];
6804 list_insert(&meter->rules, &rule->meter_list_node);
6806 ovs_rwlock_wrlock(&table->cls.rwlock);
6807 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6808 ovs_rwlock_unlock(&table->cls.rwlock);
6809 eviction_group_add_rule(rule);
6812 /* unixctl commands. */
6815 ofproto_lookup(const char *name)
6817 struct ofproto *ofproto;
6819 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6821 if (!strcmp(ofproto->name, name)) {
6829 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6830 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6832 struct ofproto *ofproto;
6836 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6837 ds_put_format(&results, "%s\n", ofproto->name);
6839 unixctl_command_reply(conn, ds_cstr(&results));
6840 ds_destroy(&results);
6844 ofproto_unixctl_init(void)
6846 static bool registered;
6852 unixctl_command_register("ofproto/list", "", 0, 0,
6853 ofproto_unixctl_list, NULL);
6856 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6858 * This is deprecated. It is only for compatibility with broken device drivers
6859 * in old versions of Linux that do not properly support VLANs when VLAN
6860 * devices are not used. When broken device drivers are no longer in
6861 * widespread use, we will delete these interfaces. */
6863 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6864 * (exactly) by an OpenFlow rule in 'ofproto'. */
6866 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6868 const struct oftable *oftable;
6870 free(ofproto->vlan_bitmap);
6871 ofproto->vlan_bitmap = bitmap_allocate(4096);
6872 ofproto->vlans_changed = false;
6874 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6875 const struct cls_subtable *table;
6877 ovs_rwlock_rdlock(&oftable->cls.rwlock);
6878 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.subtables) {
6879 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
6880 const struct cls_rule *rule;
6882 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
6883 uint16_t vid = miniflow_get_vid(&rule->match.flow);
6884 bitmap_set1(vlan_bitmap, vid);
6885 bitmap_set1(ofproto->vlan_bitmap, vid);
6889 ovs_rwlock_unlock(&oftable->cls.rwlock);
6893 /* Returns true if new VLANs have come into use by the flow table since the
6894 * last call to ofproto_get_vlan_usage().
6896 * We don't track when old VLANs stop being used. */
6898 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
6900 return ofproto->vlans_changed;
6903 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6904 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6905 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6906 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6907 * then the VLAN device is un-enslaved. */
6909 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
6910 ofp_port_t realdev_ofp_port, int vid)
6912 struct ofport *ofport;
6915 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
6917 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
6919 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
6920 ofproto->name, vlandev_ofp_port);
6924 if (!ofproto->ofproto_class->set_realdev) {
6925 if (!vlandev_ofp_port) {
6928 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
6932 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
6934 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
6935 ofproto->name, vlandev_ofp_port,
6936 netdev_get_name(ofport->netdev), ovs_strerror(error));