2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
50 #include "poll-loop.h"
58 #include "unaligned.h"
62 VLOG_DEFINE_THIS_MODULE(ofproto);
64 COVERAGE_DEFINE(ofproto_flush);
65 COVERAGE_DEFINE(ofproto_packet_out);
66 COVERAGE_DEFINE(ofproto_queue_req);
67 COVERAGE_DEFINE(ofproto_recv_openflow);
68 COVERAGE_DEFINE(ofproto_reinit_ports);
69 COVERAGE_DEFINE(ofproto_update_port);
72 S_OPENFLOW, /* Processing OpenFlow commands. */
73 S_EVICT, /* Evicting flows from over-limit tables. */
74 S_FLUSH, /* Deleting all flow table rules. */
77 enum ofoperation_type {
84 /* A single OpenFlow request can execute any number of operations. The
85 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
86 * ofconn to which an error reply should be sent if necessary.
88 * ofproto initiates some operations internally. These operations are still
89 * assigned to groups but will not have an associated ofconn. */
91 struct ofproto *ofproto; /* Owning ofproto. */
92 struct list ofproto_node; /* In ofproto's "pending" list. */
93 struct list ops; /* List of "struct ofoperation"s. */
94 int n_running; /* Number of ops still pending. */
96 /* Data needed to send OpenFlow reply on failure or to send a buffered
99 * If list_is_empty(ofconn_node) then this ofopgroup never had an
100 * associated ofconn or its ofconn's connection dropped after it initiated
101 * the operation. In the latter case 'ofconn' is a wild pointer that
102 * refers to freed memory, so the 'ofconn' member must be used only if
103 * !list_is_empty(ofconn_node).
105 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
106 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
107 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
108 uint32_t buffer_id; /* Buffer id from original request. */
111 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
112 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
113 const struct ofp_header *,
115 static void ofopgroup_submit(struct ofopgroup *);
116 static void ofopgroup_complete(struct ofopgroup *);
118 /* A single flow table operation. */
120 struct ofopgroup *group; /* Owning group. */
121 struct list group_node; /* In ofopgroup's "ops" list. */
122 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
123 struct rule *rule; /* Rule being operated upon. */
124 enum ofoperation_type type; /* Type of operation. */
126 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
128 struct rule_actions *actions;
130 /* OFOPERATION_DELETE. */
131 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
133 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
134 uint16_t idle_timeout; /* Rule's old idle timeout. */
135 uint16_t hard_timeout; /* Rule's old hard timeout. */
136 enum ofputil_flow_mod_flags flags; /* Rule's old flags. */
137 enum ofperr error; /* 0 if no error. */
140 static struct ofoperation *ofoperation_create(struct ofopgroup *,
142 enum ofoperation_type,
143 enum ofp_flow_removed_reason);
144 static void ofoperation_destroy(struct ofoperation *);
147 static void oftable_init(struct oftable *);
148 static void oftable_destroy(struct oftable *);
150 static void oftable_set_name(struct oftable *, const char *name);
152 static void oftable_disable_eviction(struct oftable *);
153 static void oftable_enable_eviction(struct oftable *,
154 const struct mf_subfield *fields,
157 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
158 static void oftable_remove_rule__(struct ofproto *, struct rule *)
159 OVS_REQUIRES(ofproto_mutex);
160 static void oftable_insert_rule(struct rule *);
162 /* A set of rules within a single OpenFlow table (oftable) that have the same
163 * values for the oftable's eviction_fields. A rule to be evicted, when one is
164 * needed, is taken from the eviction group that contains the greatest number
167 * An oftable owns any number of eviction groups, each of which contains any
170 * Membership in an eviction group is imprecise, based on the hash of the
171 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
172 * That is, if two rules have different eviction_fields, but those
173 * eviction_fields hash to the same value, then they will belong to the same
174 * eviction_group anyway.
176 * (When eviction is not enabled on an oftable, we don't track any eviction
177 * groups, to save time and space.) */
178 struct eviction_group {
179 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
180 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
181 struct heap rules; /* Contains "struct rule"s. */
184 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep);
185 static void ofproto_evict(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
186 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *);
187 static void eviction_group_add_rule(struct rule *);
188 static void eviction_group_remove_rule(struct rule *);
190 /* Criteria that flow_mod and other operations use for selecting rules on
191 * which to operate. */
192 struct rule_criteria {
193 /* An OpenFlow table or 255 for all tables. */
196 /* OpenFlow matching criteria. Interpreted different in "loose" way by
197 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
198 * defined in the OpenFlow spec. */
201 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
202 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
203 * The rule will not be selected if M is 1 and B != C. */
205 ovs_be64 cookie_mask;
207 /* Selection based on actions within a rule:
209 * If out_port != OFPP_ANY, selects only rules that output to out_port.
210 * If out_group != OFPG_ALL, select only rules that output to out_group. */
215 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
216 const struct match *match,
217 unsigned int priority,
218 ovs_be64 cookie, ovs_be64 cookie_mask,
219 ofp_port_t out_port, uint32_t out_group);
220 static void rule_criteria_destroy(struct rule_criteria *);
222 /* A packet that needs to be passed to rule_execute().
224 * (We can't do this immediately from ofopgroup_complete() because that holds
225 * ofproto_mutex, which rule_execute() needs released.) */
226 struct rule_execute {
227 struct list list_node; /* In struct ofproto's "rule_executes" list. */
228 struct rule *rule; /* Owns a reference to the rule. */
230 struct ofpbuf *packet; /* Owns the packet. */
233 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
234 static void destroy_rule_executes(struct ofproto *);
237 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
238 static void ofport_destroy(struct ofport *);
240 static void update_port(struct ofproto *, const char *devname);
241 static int init_ports(struct ofproto *);
242 static void reinit_ports(struct ofproto *);
244 static long long int ofport_get_usage(const struct ofproto *,
245 ofp_port_t ofp_port);
246 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
247 long long int last_used);
248 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
252 * Keeps track of the currently used and recently used ofport values and is
253 * used to prevent immediate recycling of ofport values. */
254 struct ofport_usage {
255 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
256 ofp_port_t ofp_port; /* OpenFlow port number. */
257 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
258 represents in-use ofports. */
262 static void ofproto_rule_destroy__(struct rule *);
263 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
264 static bool rule_is_modifiable(const struct rule *rule,
265 enum ofputil_flow_mod_flags flag);
268 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
269 struct ofputil_flow_mod *,
270 const struct ofp_header *);
271 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
272 struct ofputil_flow_mod *,
273 const struct ofp_header *,
274 const struct rule_collection *);
275 static void delete_flow__(struct rule *rule, struct ofopgroup *,
276 enum ofp_flow_removed_reason)
277 OVS_REQUIRES(ofproto_mutex);
278 static bool ofproto_group_exists__(const struct ofproto *ofproto,
280 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
281 static bool ofproto_group_exists(const struct ofproto *ofproto,
283 OVS_EXCLUDED(ofproto->groups_rwlock);
284 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
285 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
286 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
287 struct ofputil_flow_mod *,
288 const struct ofp_header *)
289 OVS_EXCLUDED(ofproto_mutex);
290 static void calc_duration(long long int start, long long int now,
291 uint32_t *sec, uint32_t *nsec);
294 static uint64_t pick_datapath_id(const struct ofproto *);
295 static uint64_t pick_fallback_dpid(void);
296 static void ofproto_destroy__(struct ofproto *);
297 static void update_mtu(struct ofproto *, struct ofport *);
298 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
301 static void ofproto_unixctl_init(void);
303 /* All registered ofproto classes, in probe order. */
304 static const struct ofproto_class **ofproto_classes;
305 static size_t n_ofproto_classes;
306 static size_t allocated_ofproto_classes;
308 /* Global lock that protects all flow table operations. */
309 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
311 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
312 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
314 size_t n_handlers, n_revalidators;
316 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
317 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
319 /* Initial mappings of port to OpenFlow number mappings. */
320 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
322 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
324 /* The default value of true waits for flow restore. */
325 static bool flow_restore_wait = true;
327 /* Must be called to initialize the ofproto library.
329 * The caller may pass in 'iface_hints', which contains an shash of
330 * "iface_hint" elements indexed by the interface's name. The provider
331 * may use these hints to describe the startup configuration in order to
332 * reinitialize its state. The caller owns the provided data, so a
333 * provider will make copies of anything required. An ofproto provider
334 * will remove any existing state that is not described by the hint, and
335 * may choose to remove it all. */
337 ofproto_init(const struct shash *iface_hints)
339 struct shash_node *node;
342 ofproto_class_register(&ofproto_dpif_class);
344 /* Make a local copy, since we don't own 'iface_hints' elements. */
345 SHASH_FOR_EACH(node, iface_hints) {
346 const struct iface_hint *orig_hint = node->data;
347 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
348 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
350 new_hint->br_name = xstrdup(orig_hint->br_name);
351 new_hint->br_type = xstrdup(br_type);
352 new_hint->ofp_port = orig_hint->ofp_port;
354 shash_add(&init_ofp_ports, node->name, new_hint);
357 for (i = 0; i < n_ofproto_classes; i++) {
358 ofproto_classes[i]->init(&init_ofp_ports);
362 /* 'type' should be a normalized datapath type, as returned by
363 * ofproto_normalize_type(). Returns the corresponding ofproto_class
364 * structure, or a null pointer if there is none registered for 'type'. */
365 static const struct ofproto_class *
366 ofproto_class_find__(const char *type)
370 for (i = 0; i < n_ofproto_classes; i++) {
371 const struct ofproto_class *class = ofproto_classes[i];
376 class->enumerate_types(&types);
377 found = sset_contains(&types, type);
378 sset_destroy(&types);
384 VLOG_WARN("unknown datapath type %s", type);
388 /* Registers a new ofproto class. After successful registration, new ofprotos
389 * of that type can be created using ofproto_create(). */
391 ofproto_class_register(const struct ofproto_class *new_class)
395 for (i = 0; i < n_ofproto_classes; i++) {
396 if (ofproto_classes[i] == new_class) {
401 if (n_ofproto_classes >= allocated_ofproto_classes) {
402 ofproto_classes = x2nrealloc(ofproto_classes,
403 &allocated_ofproto_classes,
404 sizeof *ofproto_classes);
406 ofproto_classes[n_ofproto_classes++] = new_class;
410 /* Unregisters a datapath provider. 'type' must have been previously
411 * registered and not currently be in use by any ofprotos. After
412 * unregistration new datapaths of that type cannot be opened using
413 * ofproto_create(). */
415 ofproto_class_unregister(const struct ofproto_class *class)
419 for (i = 0; i < n_ofproto_classes; i++) {
420 if (ofproto_classes[i] == class) {
421 for (i++; i < n_ofproto_classes; i++) {
422 ofproto_classes[i - 1] = ofproto_classes[i];
428 VLOG_WARN("attempted to unregister an ofproto class that is not "
433 /* Clears 'types' and enumerates all registered ofproto types into it. The
434 * caller must first initialize the sset. */
436 ofproto_enumerate_types(struct sset *types)
441 for (i = 0; i < n_ofproto_classes; i++) {
442 ofproto_classes[i]->enumerate_types(types);
446 /* Returns the fully spelled out name for the given ofproto 'type'.
448 * Normalized type string can be compared with strcmp(). Unnormalized type
449 * string might be the same even if they have different spellings. */
451 ofproto_normalize_type(const char *type)
453 return type && type[0] ? type : "system";
456 /* Clears 'names' and enumerates the names of all known created ofprotos with
457 * the given 'type'. The caller must first initialize the sset. Returns 0 if
458 * successful, otherwise a positive errno value.
460 * Some kinds of datapaths might not be practically enumerable. This is not
461 * considered an error. */
463 ofproto_enumerate_names(const char *type, struct sset *names)
465 const struct ofproto_class *class = ofproto_class_find__(type);
466 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
470 ofproto_create(const char *datapath_name, const char *datapath_type,
471 struct ofproto **ofprotop)
473 const struct ofproto_class *class;
474 struct ofproto *ofproto;
480 ofproto_unixctl_init();
482 datapath_type = ofproto_normalize_type(datapath_type);
483 class = ofproto_class_find__(datapath_type);
485 VLOG_WARN("could not create datapath %s of unknown type %s",
486 datapath_name, datapath_type);
490 ofproto = class->alloc();
492 VLOG_ERR("failed to allocate datapath %s of type %s",
493 datapath_name, datapath_type);
498 ovs_mutex_lock(&ofproto_mutex);
499 memset(ofproto, 0, sizeof *ofproto);
500 ofproto->ofproto_class = class;
501 ofproto->name = xstrdup(datapath_name);
502 ofproto->type = xstrdup(datapath_type);
503 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
504 hash_string(ofproto->name, 0));
505 ofproto->datapath_id = 0;
506 ofproto->forward_bpdu = false;
507 ofproto->fallback_dpid = pick_fallback_dpid();
508 ofproto->mfr_desc = NULL;
509 ofproto->hw_desc = NULL;
510 ofproto->sw_desc = NULL;
511 ofproto->serial_desc = NULL;
512 ofproto->dp_desc = NULL;
513 ofproto->frag_handling = OFPC_FRAG_NORMAL;
514 hmap_init(&ofproto->ports);
515 hmap_init(&ofproto->ofport_usage);
516 shash_init(&ofproto->port_by_name);
517 simap_init(&ofproto->ofp_requests);
518 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
519 ofproto->eviction_group_timer = LLONG_MIN;
520 ofproto->tables = NULL;
521 ofproto->n_tables = 0;
522 hindex_init(&ofproto->cookies);
523 list_init(&ofproto->expirable);
524 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
525 ofproto->state = S_OPENFLOW;
526 list_init(&ofproto->pending);
527 ofproto->n_pending = 0;
528 hmap_init(&ofproto->deletions);
529 guarded_list_init(&ofproto->rule_executes);
530 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
531 ofproto->first_op = ofproto->last_op = LLONG_MIN;
532 ofproto->next_op_report = LLONG_MAX;
533 ofproto->op_backoff = LLONG_MIN;
534 ofproto->vlan_bitmap = NULL;
535 ofproto->vlans_changed = false;
536 ofproto->min_mtu = INT_MAX;
537 ovs_rwlock_init(&ofproto->groups_rwlock);
538 hmap_init(&ofproto->groups);
539 ovs_mutex_unlock(&ofproto_mutex);
540 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
541 OFPGFC_SELECT_WEIGHT;
542 ofproto->ogf.max_groups[OFPGT11_ALL] = OFPG_MAX;
543 ofproto->ogf.max_groups[OFPGT11_SELECT] = OFPG_MAX;
544 ofproto->ogf.max_groups[OFPGT11_INDIRECT] = OFPG_MAX;
545 ofproto->ogf.max_groups[OFPGT11_FF] = OFPG_MAX;
546 ofproto->ogf.actions[0] =
547 (1 << OFPAT11_OUTPUT) |
548 (1 << OFPAT11_COPY_TTL_OUT) |
549 (1 << OFPAT11_COPY_TTL_IN) |
550 (1 << OFPAT11_SET_MPLS_TTL) |
551 (1 << OFPAT11_DEC_MPLS_TTL) |
552 (1 << OFPAT11_PUSH_VLAN) |
553 (1 << OFPAT11_POP_VLAN) |
554 (1 << OFPAT11_PUSH_MPLS) |
555 (1 << OFPAT11_POP_MPLS) |
556 (1 << OFPAT11_SET_QUEUE) |
557 (1 << OFPAT11_GROUP) |
558 (1 << OFPAT11_SET_NW_TTL) |
559 (1 << OFPAT11_DEC_NW_TTL) |
560 (1 << OFPAT12_SET_FIELD);
562 * (1 << OFPAT13_PUSH_PBB) |
563 * (1 << OFPAT13_POP_PBB) */
565 error = ofproto->ofproto_class->construct(ofproto);
567 VLOG_ERR("failed to open datapath %s: %s",
568 datapath_name, ovs_strerror(error));
569 ofproto_destroy__(ofproto);
573 /* Check that hidden tables, if any, are at the end. */
574 ovs_assert(ofproto->n_tables);
575 for (i = 0; i + 1 < ofproto->n_tables; i++) {
576 enum oftable_flags flags = ofproto->tables[i].flags;
577 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
579 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
582 ofproto->datapath_id = pick_datapath_id(ofproto);
585 /* Initialize meters table. */
586 if (ofproto->ofproto_class->meter_get_features) {
587 ofproto->ofproto_class->meter_get_features(ofproto,
588 &ofproto->meter_features);
590 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
592 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
593 * sizeof(struct meter *));
599 /* Must be called (only) by an ofproto implementation in its constructor
600 * function. See the large comment on 'construct' in struct ofproto_class for
603 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
605 struct oftable *table;
607 ovs_assert(!ofproto->n_tables);
608 ovs_assert(n_tables >= 1 && n_tables <= 255);
610 ofproto->n_tables = n_tables;
611 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
612 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
617 /* To be optionally called (only) by an ofproto implementation in its
618 * constructor function. See the large comment on 'construct' in struct
619 * ofproto_class for details.
621 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
622 * will then ensure that actions passed into the ofproto implementation will
623 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
624 * function is not called, there will be no such restriction.
626 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
627 * the 'max_ports' restriction. */
629 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
631 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
632 ofproto->max_ports = max_ports;
636 ofproto_get_datapath_id(const struct ofproto *ofproto)
638 return ofproto->datapath_id;
642 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
644 uint64_t old_dpid = p->datapath_id;
645 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
646 if (p->datapath_id != old_dpid) {
647 /* Force all active connections to reconnect, since there is no way to
648 * notify a controller that the datapath ID has changed. */
649 ofproto_reconnect_controllers(p);
654 ofproto_set_controllers(struct ofproto *p,
655 const struct ofproto_controller *controllers,
656 size_t n_controllers, uint32_t allowed_versions)
658 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
663 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
665 connmgr_set_fail_mode(p->connmgr, fail_mode);
668 /* Drops the connections between 'ofproto' and all of its controllers, forcing
669 * them to reconnect. */
671 ofproto_reconnect_controllers(struct ofproto *ofproto)
673 connmgr_reconnect(ofproto->connmgr);
676 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
677 * in-band control should guarantee access, in the same way that in-band
678 * control guarantees access to OpenFlow controllers. */
680 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
681 const struct sockaddr_in *extras, size_t n)
683 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
686 /* Sets the OpenFlow queue used by flows set up by in-band control on
687 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
688 * flows will use the default queue. */
690 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
692 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
695 /* Sets the number of flows at which eviction from the kernel flow table
698 ofproto_set_flow_limit(unsigned limit)
700 ofproto_flow_limit = limit;
703 /* Sets the maximum idle time for flows in the datapath before they are
706 ofproto_set_max_idle(unsigned max_idle)
708 ofproto_max_idle = max_idle;
711 /* If forward_bpdu is true, the NORMAL action will forward frames with
712 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
713 * the NORMAL action will drop these frames. */
715 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
717 bool old_val = ofproto->forward_bpdu;
718 ofproto->forward_bpdu = forward_bpdu;
719 if (old_val != ofproto->forward_bpdu) {
720 if (ofproto->ofproto_class->forward_bpdu_changed) {
721 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
726 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
727 * 'idle_time', in seconds, and the maximum number of MAC table entries to
730 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
733 if (ofproto->ofproto_class->set_mac_table_config) {
734 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
740 ofproto_set_threads(int n_handlers_, int n_revalidators_)
742 int threads = MAX(count_cpu_cores(), 2);
744 n_revalidators = MAX(n_revalidators_, 0);
745 n_handlers = MAX(n_handlers_, 0);
747 if (!n_revalidators) {
748 n_revalidators = n_handlers
749 ? MAX(threads - (int) n_handlers, 1)
754 n_handlers = MAX(threads - (int) n_revalidators, 1);
759 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
762 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
766 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
768 return connmgr_set_snoops(ofproto->connmgr, snoops);
772 ofproto_set_netflow(struct ofproto *ofproto,
773 const struct netflow_options *nf_options)
775 if (nf_options && sset_is_empty(&nf_options->collectors)) {
779 if (ofproto->ofproto_class->set_netflow) {
780 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
782 return nf_options ? EOPNOTSUPP : 0;
787 ofproto_set_sflow(struct ofproto *ofproto,
788 const struct ofproto_sflow_options *oso)
790 if (oso && sset_is_empty(&oso->targets)) {
794 if (ofproto->ofproto_class->set_sflow) {
795 return ofproto->ofproto_class->set_sflow(ofproto, oso);
797 return oso ? EOPNOTSUPP : 0;
802 ofproto_set_ipfix(struct ofproto *ofproto,
803 const struct ofproto_ipfix_bridge_exporter_options *bo,
804 const struct ofproto_ipfix_flow_exporter_options *fo,
807 if (ofproto->ofproto_class->set_ipfix) {
808 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
810 return (bo || fo) ? EOPNOTSUPP : 0;
815 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
817 flow_restore_wait = flow_restore_wait_db;
821 ofproto_get_flow_restore_wait(void)
823 return flow_restore_wait;
827 /* Spanning Tree Protocol (STP) configuration. */
829 /* Configures STP on 'ofproto' using the settings defined in 's'. If
830 * 's' is NULL, disables STP.
832 * Returns 0 if successful, otherwise a positive errno value. */
834 ofproto_set_stp(struct ofproto *ofproto,
835 const struct ofproto_stp_settings *s)
837 return (ofproto->ofproto_class->set_stp
838 ? ofproto->ofproto_class->set_stp(ofproto, s)
842 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
843 * 'enabled' member of 's' is false, then the other members are not
846 * Returns 0 if successful, otherwise a positive errno value. */
848 ofproto_get_stp_status(struct ofproto *ofproto,
849 struct ofproto_stp_status *s)
851 return (ofproto->ofproto_class->get_stp_status
852 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
856 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
857 * in 's'. The caller is responsible for assigning STP port numbers
858 * (using the 'port_num' member in the range of 1 through 255, inclusive)
859 * and ensuring there are no duplicates. If the 's' is NULL, then STP
860 * is disabled on the port.
862 * Returns 0 if successful, otherwise a positive errno value.*/
864 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
865 const struct ofproto_port_stp_settings *s)
867 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
869 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
870 ofproto->name, ofp_port);
874 return (ofproto->ofproto_class->set_stp_port
875 ? ofproto->ofproto_class->set_stp_port(ofport, s)
879 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
880 * 's'. If the 'enabled' member in 's' is false, then the other members
881 * are not meaningful.
883 * Returns 0 if successful, otherwise a positive errno value.*/
885 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
886 struct ofproto_port_stp_status *s)
888 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
890 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
891 "port %"PRIu16, ofproto->name, ofp_port);
895 return (ofproto->ofproto_class->get_stp_port_status
896 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
900 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
901 * 's'. If the 'enabled' member in 's' is false, then the other members
902 * are not meaningful.
904 * Returns 0 if successful, otherwise a positive errno value.*/
906 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
907 struct ofproto_port_stp_stats *s)
909 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
911 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
912 "port %"PRIu16, ofproto->name, ofp_port);
916 return (ofproto->ofproto_class->get_stp_port_stats
917 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
921 /* Queue DSCP configuration. */
923 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
924 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
925 * to implement QoS. Instead, it is used to implement features which require
926 * knowledge of what queues exist on a port, and some basic information about
929 * Returns 0 if successful, otherwise a positive errno value. */
931 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
932 const struct ofproto_port_queue *queues,
935 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
938 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
939 ofproto->name, ofp_port);
943 return (ofproto->ofproto_class->set_queues
944 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
948 /* Connectivity Fault Management configuration. */
950 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
952 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
954 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
955 if (ofport && ofproto->ofproto_class->set_cfm) {
956 ofproto->ofproto_class->set_cfm(ofport, NULL);
960 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
961 * basic configuration from the configuration members in 'cfm', and the remote
962 * maintenance point ID from remote_mpid. Ignores the statistics members of
965 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
967 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
968 const struct cfm_settings *s)
970 struct ofport *ofport;
973 ofport = ofproto_get_port(ofproto, ofp_port);
975 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
976 ofproto->name, ofp_port);
980 /* XXX: For configuration simplicity, we only support one remote_mpid
981 * outside of the CFM module. It's not clear if this is the correct long
982 * term solution or not. */
983 error = (ofproto->ofproto_class->set_cfm
984 ? ofproto->ofproto_class->set_cfm(ofport, s)
987 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
988 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
989 ovs_strerror(error));
993 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
994 * 'ofproto' does not have a port 'ofp_port'. */
996 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
997 const struct smap *cfg)
999 struct ofport *ofport;
1002 ofport = ofproto_get_port(ofproto, ofp_port);
1004 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1005 ofproto->name, ofp_port);
1009 error = (ofproto->ofproto_class->set_bfd
1010 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1013 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1014 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1015 ovs_strerror(error));
1019 /* Populates 'status' with key value pairs indicating the status of the BFD
1020 * session on 'ofp_port'. This information is intended to be populated in the
1021 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
1024 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1025 struct smap *status)
1027 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1028 return (ofport && ofproto->ofproto_class->get_bfd_status
1029 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1033 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1034 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1035 * 0 if LACP partner information is not current (generally indicating a
1036 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1038 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1040 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1041 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1042 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1048 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1049 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1050 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1051 * configuration plus, if there is more than one slave, a bonding
1054 * If 'aux' is already registered then this function updates its configuration
1055 * to 's'. Otherwise, this function registers a new bundle.
1057 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1060 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1061 const struct ofproto_bundle_settings *s)
1063 return (ofproto->ofproto_class->bundle_set
1064 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1068 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1069 * If no such bundle has been registered, this has no effect. */
1071 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1073 return ofproto_bundle_register(ofproto, aux, NULL);
1077 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1078 * If 'aux' is already registered then this function updates its configuration
1079 * to 's'. Otherwise, this function registers a new mirror. */
1081 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1082 const struct ofproto_mirror_settings *s)
1084 return (ofproto->ofproto_class->mirror_set
1085 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1089 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1090 * If no mirror has been registered, this has no effect. */
1092 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1094 return ofproto_mirror_register(ofproto, aux, NULL);
1097 /* Retrieves statistics from mirror associated with client data pointer
1098 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1099 * 'bytes', respectively. If a particular counters is not supported,
1100 * the appropriate argument is set to UINT64_MAX. */
1102 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1103 uint64_t *packets, uint64_t *bytes)
1105 if (!ofproto->ofproto_class->mirror_get_stats) {
1106 *packets = *bytes = UINT64_MAX;
1110 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1114 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1115 * which all packets are flooded, instead of using MAC learning. If
1116 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1118 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1121 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1123 return (ofproto->ofproto_class->set_flood_vlans
1124 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1128 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1129 * output for a mirror. */
1131 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1133 return (ofproto->ofproto_class->is_mirror_output_bundle
1134 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1138 /* Configuration of OpenFlow tables. */
1140 /* Returns the number of OpenFlow tables in 'ofproto'. */
1142 ofproto_get_n_tables(const struct ofproto *ofproto)
1144 return ofproto->n_tables;
1147 /* Returns the number of Controller visible OpenFlow tables
1148 * in 'ofproto'. This number will exclude Hidden tables.
1149 * This funtion's return value should be less or equal to that of
1150 * ofproto_get_n_tables() . */
1152 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1154 uint8_t n = ofproto->n_tables;
1156 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1157 * if present, are always at the end.) */
1158 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1165 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1166 * settings from 's'. 'table_id' must be in the range 0 through the number of
1167 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1169 * For read-only tables, only the name may be configured. */
1171 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1172 const struct ofproto_table_settings *s)
1174 struct oftable *table;
1176 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1177 table = &ofproto->tables[table_id];
1179 oftable_set_name(table, s->name);
1181 if (table->flags & OFTABLE_READONLY) {
1186 oftable_enable_eviction(table, s->groups, s->n_groups);
1188 oftable_disable_eviction(table);
1191 table->max_flows = s->max_flows;
1192 fat_rwlock_wrlock(&table->cls.rwlock);
1193 if (classifier_count(&table->cls) > table->max_flows
1194 && table->eviction_fields) {
1195 /* 'table' contains more flows than allowed. We might not be able to
1196 * evict them right away because of the asynchronous nature of flow
1197 * table changes. Schedule eviction for later. */
1198 switch (ofproto->state) {
1200 ofproto->state = S_EVICT;
1204 /* We're already deleting flows, nothing more to do. */
1209 classifier_set_prefix_fields(&table->cls,
1210 s->prefix_fields, s->n_prefix_fields);
1212 fat_rwlock_unlock(&table->cls.rwlock);
1216 ofproto_has_snoops(const struct ofproto *ofproto)
1218 return connmgr_has_snoops(ofproto->connmgr);
1222 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1224 connmgr_get_snoops(ofproto->connmgr, snoops);
1228 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1230 OVS_REQUIRES(ofproto_mutex)
1232 struct ofopgroup *group;
1234 ovs_assert(!rule->pending);
1236 group = ofopgroup_create_unattached(ofproto);
1237 delete_flow__(rule, group, reason);
1238 ofopgroup_submit(group);
1241 /* Deletes 'rule' from 'ofproto'.
1243 * Within an ofproto implementation, this function allows an ofproto
1244 * implementation to destroy any rules that remain when its ->destruct()
1245 * function is called. This function is not suitable for use elsewhere in an
1246 * ofproto implementation.
1248 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1249 * Cycle" in ofproto-provider.h. */
1251 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1252 OVS_EXCLUDED(ofproto_mutex)
1254 struct ofopgroup *group;
1256 ovs_mutex_lock(&ofproto_mutex);
1257 ovs_assert(!rule->pending);
1259 group = ofopgroup_create_unattached(ofproto);
1260 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1261 oftable_remove_rule__(ofproto, rule);
1262 ofproto->ofproto_class->rule_delete(rule);
1263 ofopgroup_submit(group);
1265 ovs_mutex_unlock(&ofproto_mutex);
1269 ofproto_flush__(struct ofproto *ofproto)
1270 OVS_EXCLUDED(ofproto_mutex)
1272 struct oftable *table;
1274 if (ofproto->ofproto_class->flush) {
1275 ofproto->ofproto_class->flush(ofproto);
1278 ovs_mutex_lock(&ofproto_mutex);
1279 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1280 struct rule *rule, *next_rule;
1281 struct cls_cursor cursor;
1283 if (table->flags & OFTABLE_HIDDEN) {
1287 fat_rwlock_rdlock(&table->cls.rwlock);
1288 cls_cursor_init(&cursor, &table->cls, NULL);
1289 fat_rwlock_unlock(&table->cls.rwlock);
1290 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1291 if (!rule->pending) {
1292 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1296 ovs_mutex_unlock(&ofproto_mutex);
1299 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1302 ofproto_destroy__(struct ofproto *ofproto)
1303 OVS_EXCLUDED(ofproto_mutex)
1305 struct oftable *table;
1307 ovs_assert(list_is_empty(&ofproto->pending));
1309 destroy_rule_executes(ofproto);
1310 guarded_list_destroy(&ofproto->rule_executes);
1312 delete_group(ofproto, OFPG_ALL);
1313 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1314 hmap_destroy(&ofproto->groups);
1316 connmgr_destroy(ofproto->connmgr);
1318 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1319 free(ofproto->name);
1320 free(ofproto->type);
1321 free(ofproto->mfr_desc);
1322 free(ofproto->hw_desc);
1323 free(ofproto->sw_desc);
1324 free(ofproto->serial_desc);
1325 free(ofproto->dp_desc);
1326 hmap_destroy(&ofproto->ports);
1327 hmap_destroy(&ofproto->ofport_usage);
1328 shash_destroy(&ofproto->port_by_name);
1329 simap_destroy(&ofproto->ofp_requests);
1331 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1332 oftable_destroy(table);
1334 free(ofproto->tables);
1336 hmap_destroy(&ofproto->deletions);
1338 free(ofproto->vlan_bitmap);
1340 ofproto->ofproto_class->dealloc(ofproto);
1344 ofproto_destroy(struct ofproto *p)
1345 OVS_EXCLUDED(ofproto_mutex)
1347 struct ofport *ofport, *next_ofport;
1348 struct ofport_usage *usage, *next_usage;
1355 meter_delete(p, 1, p->meter_features.max_meters);
1356 p->meter_features.max_meters = 0;
1362 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1363 ofport_destroy(ofport);
1366 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1367 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1371 p->ofproto_class->destruct(p);
1372 ofproto_destroy__(p);
1375 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1376 * kernel datapath, for example, this destroys the datapath in the kernel, and
1377 * with the netdev-based datapath, it tears down the data structures that
1378 * represent the datapath.
1380 * The datapath should not be currently open as an ofproto. */
1382 ofproto_delete(const char *name, const char *type)
1384 const struct ofproto_class *class = ofproto_class_find__(type);
1385 return (!class ? EAFNOSUPPORT
1386 : !class->del ? EACCES
1387 : class->del(type, name));
1391 process_port_change(struct ofproto *ofproto, int error, char *devname)
1393 if (error == ENOBUFS) {
1394 reinit_ports(ofproto);
1395 } else if (!error) {
1396 update_port(ofproto, devname);
1402 ofproto_type_run(const char *datapath_type)
1404 const struct ofproto_class *class;
1407 datapath_type = ofproto_normalize_type(datapath_type);
1408 class = ofproto_class_find__(datapath_type);
1410 error = class->type_run ? class->type_run(datapath_type) : 0;
1411 if (error && error != EAGAIN) {
1412 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1413 datapath_type, ovs_strerror(error));
1419 ofproto_type_wait(const char *datapath_type)
1421 const struct ofproto_class *class;
1423 datapath_type = ofproto_normalize_type(datapath_type);
1424 class = ofproto_class_find__(datapath_type);
1426 if (class->type_wait) {
1427 class->type_wait(datapath_type);
1432 any_pending_ops(const struct ofproto *p)
1433 OVS_EXCLUDED(ofproto_mutex)
1437 ovs_mutex_lock(&ofproto_mutex);
1438 b = !list_is_empty(&p->pending);
1439 ovs_mutex_unlock(&ofproto_mutex);
1445 ofproto_run(struct ofproto *p)
1450 error = p->ofproto_class->run(p);
1451 if (error && error != EAGAIN) {
1452 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1455 run_rule_executes(p);
1457 /* Restore the eviction group heap invariant occasionally. */
1458 if (p->eviction_group_timer < time_msec()) {
1461 p->eviction_group_timer = time_msec() + 1000;
1463 for (i = 0; i < p->n_tables; i++) {
1464 struct oftable *table = &p->tables[i];
1465 struct eviction_group *evg;
1466 struct cls_cursor cursor;
1469 if (!table->eviction_fields) {
1473 ovs_mutex_lock(&ofproto_mutex);
1474 fat_rwlock_rdlock(&table->cls.rwlock);
1475 cls_cursor_init(&cursor, &table->cls, NULL);
1476 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1477 if (rule->idle_timeout || rule->hard_timeout) {
1478 if (!rule->eviction_group) {
1479 eviction_group_add_rule(rule);
1481 heap_raw_change(&rule->evg_node,
1482 rule_eviction_priority(p, rule));
1486 fat_rwlock_unlock(&table->cls.rwlock);
1488 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1489 heap_rebuild(&evg->rules);
1491 ovs_mutex_unlock(&ofproto_mutex);
1495 if (p->ofproto_class->port_poll) {
1498 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1499 process_port_change(p, error, devname);
1503 new_seq = seq_read(connectivity_seq_get());
1504 if (new_seq != p->change_seq) {
1505 struct sset devnames;
1506 const char *devname;
1507 struct ofport *ofport;
1509 /* Update OpenFlow port status for any port whose netdev has changed.
1511 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1512 * destroyed, so it's not safe to update ports directly from the
1513 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1514 * need this two-phase approach. */
1515 sset_init(&devnames);
1516 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1517 uint64_t port_change_seq;
1519 port_change_seq = netdev_get_change_seq(ofport->netdev);
1520 if (ofport->change_seq != port_change_seq) {
1521 ofport->change_seq = port_change_seq;
1522 sset_add(&devnames, netdev_get_name(ofport->netdev));
1525 SSET_FOR_EACH (devname, &devnames) {
1526 update_port(p, devname);
1528 sset_destroy(&devnames);
1530 p->change_seq = new_seq;
1535 connmgr_run(p->connmgr, handle_openflow);
1539 connmgr_run(p->connmgr, NULL);
1541 if (!any_pending_ops(p)) {
1542 p->state = S_OPENFLOW;
1547 connmgr_run(p->connmgr, NULL);
1549 if (!any_pending_ops(p)) {
1550 connmgr_flushed(p->connmgr);
1551 p->state = S_OPENFLOW;
1559 if (time_msec() >= p->next_op_report) {
1560 long long int ago = (time_msec() - p->first_op) / 1000;
1561 long long int interval = (p->last_op - p->first_op) / 1000;
1565 ds_put_format(&s, "%d flow_mods ",
1566 p->n_add + p->n_delete + p->n_modify);
1567 if (interval == ago) {
1568 ds_put_format(&s, "in the last %lld s", ago);
1569 } else if (interval) {
1570 ds_put_format(&s, "in the %lld s starting %lld s ago",
1573 ds_put_format(&s, "%lld s ago", ago);
1576 ds_put_cstr(&s, " (");
1578 ds_put_format(&s, "%d adds, ", p->n_add);
1581 ds_put_format(&s, "%d deletes, ", p->n_delete);
1584 ds_put_format(&s, "%d modifications, ", p->n_modify);
1587 ds_put_char(&s, ')');
1589 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1592 p->n_add = p->n_delete = p->n_modify = 0;
1593 p->next_op_report = LLONG_MAX;
1600 ofproto_wait(struct ofproto *p)
1602 p->ofproto_class->wait(p);
1603 if (p->ofproto_class->port_poll_wait) {
1604 p->ofproto_class->port_poll_wait(p);
1606 seq_wait(connectivity_seq_get(), p->change_seq);
1610 connmgr_wait(p->connmgr, true);
1615 connmgr_wait(p->connmgr, false);
1616 if (!any_pending_ops(p)) {
1617 poll_immediate_wake();
1624 ofproto_is_alive(const struct ofproto *p)
1626 return connmgr_has_controllers(p->connmgr);
1629 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1630 * memory_report(). */
1632 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1634 const struct oftable *table;
1635 unsigned int n_rules;
1637 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1639 ovs_mutex_lock(&ofproto_mutex);
1640 simap_increase(usage, "ops",
1641 ofproto->n_pending + hmap_count(&ofproto->deletions));
1642 ovs_mutex_unlock(&ofproto_mutex);
1645 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1646 fat_rwlock_rdlock(&table->cls.rwlock);
1647 n_rules += classifier_count(&table->cls);
1648 fat_rwlock_unlock(&table->cls.rwlock);
1650 simap_increase(usage, "rules", n_rules);
1652 if (ofproto->ofproto_class->get_memory_usage) {
1653 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1656 connmgr_get_memory_usage(ofproto->connmgr, usage);
1660 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1662 const struct ofproto_class *class;
1664 datapath_type = ofproto_normalize_type(datapath_type);
1665 class = ofproto_class_find__(datapath_type);
1667 if (class && class->type_get_memory_usage) {
1668 class->type_get_memory_usage(datapath_type, usage);
1673 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1676 connmgr_get_controller_info(ofproto->connmgr, info);
1680 ofproto_free_ofproto_controller_info(struct shash *info)
1682 connmgr_free_controller_info(info);
1685 /* Makes a deep copy of 'old' into 'port'. */
1687 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1689 port->name = xstrdup(old->name);
1690 port->type = xstrdup(old->type);
1691 port->ofp_port = old->ofp_port;
1694 /* Frees memory allocated to members of 'ofproto_port'.
1696 * Do not call this function on an ofproto_port obtained from
1697 * ofproto_port_dump_next(): that function retains ownership of the data in the
1700 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1702 free(ofproto_port->name);
1703 free(ofproto_port->type);
1706 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1708 * This function provides no status indication. An error status for the entire
1709 * dump operation is provided when it is completed by calling
1710 * ofproto_port_dump_done().
1713 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1714 const struct ofproto *ofproto)
1716 dump->ofproto = ofproto;
1717 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1721 /* Attempts to retrieve another port from 'dump', which must have been created
1722 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1723 * 'port' and returns true. On failure, returns false.
1725 * Failure might indicate an actual error or merely that the last port has been
1726 * dumped. An error status for the entire dump operation is provided when it
1727 * is completed by calling ofproto_port_dump_done().
1729 * The ofproto owns the data stored in 'port'. It will remain valid until at
1730 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1731 * ofproto_port_dump_done(). */
1733 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1734 struct ofproto_port *port)
1736 const struct ofproto *ofproto = dump->ofproto;
1742 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1745 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1751 /* Completes port table dump operation 'dump', which must have been created
1752 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1753 * error-free, otherwise a positive errno value describing the problem. */
1755 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1757 const struct ofproto *ofproto = dump->ofproto;
1759 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1762 return dump->error == EOF ? 0 : dump->error;
1765 /* Returns the type to pass to netdev_open() when a datapath of type
1766 * 'datapath_type' has a port of type 'port_type', for a few special
1767 * cases when a netdev type differs from a port type. For example, when
1768 * using the userspace datapath, a port of type "internal" needs to be
1771 * Returns either 'type' itself or a string literal, which must not be
1774 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1776 const struct ofproto_class *class;
1778 datapath_type = ofproto_normalize_type(datapath_type);
1779 class = ofproto_class_find__(datapath_type);
1784 return (class->port_open_type
1785 ? class->port_open_type(datapath_type, port_type)
1789 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1790 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1791 * the port's OpenFlow port number.
1793 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1794 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1795 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1796 * 'ofp_portp' is non-null). */
1798 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1799 ofp_port_t *ofp_portp)
1801 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1804 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1806 const char *netdev_name = netdev_get_name(netdev);
1808 simap_put(&ofproto->ofp_requests, netdev_name,
1809 ofp_to_u16(ofp_port));
1810 update_port(ofproto, netdev_name);
1813 *ofp_portp = OFPP_NONE;
1815 struct ofproto_port ofproto_port;
1817 error = ofproto_port_query_by_name(ofproto,
1818 netdev_get_name(netdev),
1821 *ofp_portp = ofproto_port.ofp_port;
1822 ofproto_port_destroy(&ofproto_port);
1829 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1830 * initializes '*port' appropriately; on failure, returns a positive errno
1833 * The caller owns the data in 'ofproto_port' and must free it with
1834 * ofproto_port_destroy() when it is no longer needed. */
1836 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1837 struct ofproto_port *port)
1841 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1843 memset(port, 0, sizeof *port);
1848 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1849 * Returns 0 if successful, otherwise a positive errno. */
1851 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1853 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1854 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1855 struct simap_node *ofp_request_node;
1858 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1859 if (ofp_request_node) {
1860 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1863 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1864 if (!error && ofport) {
1865 /* 'name' is the netdev's name and update_port() is going to close the
1866 * netdev. Just in case update_port() refers to 'name' after it
1867 * destroys 'ofport', make a copy of it around the update_port()
1869 char *devname = xstrdup(name);
1870 update_port(ofproto, devname);
1877 flow_mod_init(struct ofputil_flow_mod *fm,
1878 const struct match *match, unsigned int priority,
1879 const struct ofpact *ofpacts, size_t ofpacts_len,
1880 enum ofp_flow_mod_command command)
1882 memset(fm, 0, sizeof *fm);
1884 fm->priority = priority;
1887 fm->modify_cookie = false;
1889 fm->command = command;
1890 fm->idle_timeout = 0;
1891 fm->hard_timeout = 0;
1892 fm->buffer_id = UINT32_MAX;
1893 fm->out_port = OFPP_ANY;
1894 fm->out_group = OFPG_ANY;
1896 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1897 fm->ofpacts_len = ofpacts_len;
1901 simple_flow_mod(struct ofproto *ofproto,
1902 const struct match *match, unsigned int priority,
1903 const struct ofpact *ofpacts, size_t ofpacts_len,
1904 enum ofp_flow_mod_command command)
1906 struct ofputil_flow_mod fm;
1908 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1910 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1913 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1914 * performs the 'n_actions' actions in 'actions'. The new flow will not
1917 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1918 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1919 * controllers; otherwise, it will be hidden.
1921 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1923 * This is a helper function for in-band control and fail-open. */
1925 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1926 unsigned int priority,
1927 const struct ofpact *ofpacts, size_t ofpacts_len)
1928 OVS_EXCLUDED(ofproto_mutex)
1930 const struct rule *rule;
1933 /* First do a cheap check whether the rule we're looking for already exists
1934 * with the actions that we want. If it does, then we're done. */
1935 fat_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1936 rule = rule_from_cls_rule(classifier_find_match_exactly(
1937 &ofproto->tables[0].cls, match, priority));
1939 struct rule_actions *actions = rule_get_actions(rule);
1940 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1941 ofpacts, ofpacts_len);
1945 fat_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1947 /* If there's no such rule or the rule doesn't have the actions we want,
1948 * fall back to a executing a full flow mod. We can't optimize this at
1949 * all because we didn't take enough locks above to ensure that the flow
1950 * table didn't already change beneath us. */
1952 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1953 OFPFC_MODIFY_STRICT);
1957 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1958 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1959 * operation cannot be initiated now but may be retried later.
1961 * This is a helper function for in-band control and fail-open and the "learn"
1964 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1965 OVS_EXCLUDED(ofproto_mutex)
1967 /* Optimize for the most common case of a repeated learn action.
1968 * If an identical flow already exists we only need to update its
1969 * 'modified' time. */
1970 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1971 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1972 struct oftable *table = &ofproto->tables[fm->table_id];
1973 struct cls_rule match_rule;
1977 cls_rule_init(&match_rule, &fm->match, fm->priority);
1978 fat_rwlock_rdlock(&table->cls.rwlock);
1979 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
1982 /* Reading many of the rule fields and writing on 'modified'
1983 * requires the rule->mutex. Also, rule->actions may change
1984 * if rule->mutex is not held. */
1985 const struct rule_actions *actions;
1987 ovs_mutex_lock(&rule->mutex);
1988 actions = rule_get_actions(rule);
1989 if (rule->idle_timeout == fm->idle_timeout
1990 && rule->hard_timeout == fm->hard_timeout
1991 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1992 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1993 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
1994 actions->ofpacts, actions->ofpacts_len)) {
1995 /* Rule already exists and need not change, only update the
1996 modified timestamp. */
1997 rule->modified = time_msec();
2000 ovs_mutex_unlock(&rule->mutex);
2002 fat_rwlock_unlock(&table->cls.rwlock);
2009 return handle_flow_mod__(ofproto, NULL, fm, NULL);
2012 /* Searches for a rule with matching criteria exactly equal to 'target' in
2013 * ofproto's table 0 and, if it finds one, deletes it.
2015 * This is a helper function for in-band control and fail-open. */
2017 ofproto_delete_flow(struct ofproto *ofproto,
2018 const struct match *target, unsigned int priority)
2019 OVS_EXCLUDED(ofproto_mutex)
2021 struct classifier *cls = &ofproto->tables[0].cls;
2024 /* First do a cheap check whether the rule we're looking for has already
2025 * been deleted. If so, then we're done. */
2026 fat_rwlock_rdlock(&cls->rwlock);
2027 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2029 fat_rwlock_unlock(&cls->rwlock);
2034 /* Fall back to a executing a full flow mod. We can't optimize this at all
2035 * because we didn't take enough locks above to ensure that the flow table
2036 * didn't already change beneath us. */
2037 return simple_flow_mod(ofproto, target, priority, NULL, 0,
2038 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
2041 /* Starts the process of deleting all of the flows from all of ofproto's flow
2042 * tables and then reintroducing the flows required by in-band control and
2043 * fail-open. The process will complete in a later call to ofproto_run(). */
2045 ofproto_flush_flows(struct ofproto *ofproto)
2047 COVERAGE_INC(ofproto_flush);
2048 ofproto->state = S_FLUSH;
2052 reinit_ports(struct ofproto *p)
2054 struct ofproto_port_dump dump;
2055 struct sset devnames;
2056 struct ofport *ofport;
2057 struct ofproto_port ofproto_port;
2058 const char *devname;
2060 COVERAGE_INC(ofproto_reinit_ports);
2062 sset_init(&devnames);
2063 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2064 sset_add(&devnames, netdev_get_name(ofport->netdev));
2066 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2067 sset_add(&devnames, ofproto_port.name);
2070 SSET_FOR_EACH (devname, &devnames) {
2071 update_port(p, devname);
2073 sset_destroy(&devnames);
2077 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2081 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2082 port_idx = port_idx ? port_idx : UINT16_MAX;
2084 if (port_idx >= ofproto->max_ports
2085 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2086 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2087 long long int last_used_at, lru = LLONG_MAX;
2089 /* Search for a free OpenFlow port number. We try not to
2090 * immediately reuse them to prevent problems due to old
2093 * We limit the automatically assigned port numbers to the lower half
2094 * of the port range, to reserve the upper half for assignment by
2097 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2098 ofproto->alloc_port_no = 1;
2100 last_used_at = ofport_get_usage(ofproto,
2101 u16_to_ofp(ofproto->alloc_port_no));
2102 if (!last_used_at) {
2103 port_idx = ofproto->alloc_port_no;
2105 } else if ( last_used_at < time_msec() - 60*60*1000) {
2106 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2107 * more than an hour ago, consider it usable. */
2108 ofport_remove_usage(ofproto,
2109 u16_to_ofp(ofproto->alloc_port_no));
2110 port_idx = ofproto->alloc_port_no;
2112 } else if (last_used_at < lru) {
2114 lru_ofport = ofproto->alloc_port_no;
2117 if (ofproto->alloc_port_no == end_port_no) {
2119 port_idx = lru_ofport;
2126 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2127 return u16_to_ofp(port_idx);
2131 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2133 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2134 ofport_set_usage(ofproto, ofp_port, time_msec());
2138 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2139 * pointer if the netdev cannot be opened. On success, also fills in
2141 static struct netdev *
2142 ofport_open(struct ofproto *ofproto,
2143 struct ofproto_port *ofproto_port,
2144 struct ofputil_phy_port *pp)
2146 enum netdev_flags flags;
2147 struct netdev *netdev;
2150 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2152 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2153 "cannot be opened (%s)",
2155 ofproto_port->name, ofproto_port->ofp_port,
2156 ofproto_port->name, ovs_strerror(error));
2160 if (ofproto_port->ofp_port == OFPP_NONE) {
2161 if (!strcmp(ofproto->name, ofproto_port->name)) {
2162 ofproto_port->ofp_port = OFPP_LOCAL;
2164 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2165 ofproto_port->name);
2168 pp->port_no = ofproto_port->ofp_port;
2169 netdev_get_etheraddr(netdev, pp->hw_addr);
2170 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2171 netdev_get_flags(netdev, &flags);
2172 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2173 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2174 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2175 &pp->supported, &pp->peer);
2176 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2177 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2182 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2183 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2186 ofport_equal(const struct ofputil_phy_port *a,
2187 const struct ofputil_phy_port *b)
2189 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2190 && a->state == b->state
2191 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2192 && a->curr == b->curr
2193 && a->advertised == b->advertised
2194 && a->supported == b->supported
2195 && a->peer == b->peer
2196 && a->curr_speed == b->curr_speed
2197 && a->max_speed == b->max_speed);
2200 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2201 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2202 * one with the same name or port number). */
2204 ofport_install(struct ofproto *p,
2205 struct netdev *netdev, const struct ofputil_phy_port *pp)
2207 const char *netdev_name = netdev_get_name(netdev);
2208 struct ofport *ofport;
2211 /* Create ofport. */
2212 ofport = p->ofproto_class->port_alloc();
2217 ofport->ofproto = p;
2218 ofport->netdev = netdev;
2219 ofport->change_seq = netdev_get_change_seq(netdev);
2221 ofport->ofp_port = pp->port_no;
2222 ofport->created = time_msec();
2224 /* Add port to 'p'. */
2225 hmap_insert(&p->ports, &ofport->hmap_node,
2226 hash_ofp_port(ofport->ofp_port));
2227 shash_add(&p->port_by_name, netdev_name, ofport);
2229 update_mtu(p, ofport);
2231 /* Let the ofproto_class initialize its private data. */
2232 error = p->ofproto_class->port_construct(ofport);
2236 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2240 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2241 p->name, netdev_name, ovs_strerror(error));
2243 ofport_destroy__(ofport);
2245 netdev_close(netdev);
2249 /* Removes 'ofport' from 'p' and destroys it. */
2251 ofport_remove(struct ofport *ofport)
2253 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2255 ofport_destroy(ofport);
2258 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2261 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2263 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2265 ofport_remove(port);
2269 /* Updates 'port' with new 'pp' description.
2271 * Does not handle a name or port number change. The caller must implement
2272 * such a change as a delete followed by an add. */
2274 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2276 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2277 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2278 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2279 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2280 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2281 port->pp.curr = pp->curr;
2282 port->pp.advertised = pp->advertised;
2283 port->pp.supported = pp->supported;
2284 port->pp.peer = pp->peer;
2285 port->pp.curr_speed = pp->curr_speed;
2286 port->pp.max_speed = pp->max_speed;
2288 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2289 &port->pp, OFPPR_MODIFY);
2292 /* Update OpenFlow 'state' in 'port' and notify controller. */
2294 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2296 if (port->pp.state != state) {
2297 port->pp.state = state;
2298 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2299 &port->pp, OFPPR_MODIFY);
2304 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2306 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2308 if (port->ofproto->ofproto_class->set_realdev) {
2309 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2311 if (port->ofproto->ofproto_class->set_stp_port) {
2312 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2314 if (port->ofproto->ofproto_class->set_cfm) {
2315 port->ofproto->ofproto_class->set_cfm(port, NULL);
2317 if (port->ofproto->ofproto_class->bundle_remove) {
2318 port->ofproto->ofproto_class->bundle_remove(port);
2324 ofport_destroy__(struct ofport *port)
2326 struct ofproto *ofproto = port->ofproto;
2327 const char *name = netdev_get_name(port->netdev);
2329 hmap_remove(&ofproto->ports, &port->hmap_node);
2330 shash_delete(&ofproto->port_by_name,
2331 shash_find(&ofproto->port_by_name, name));
2333 netdev_close(port->netdev);
2334 ofproto->ofproto_class->port_dealloc(port);
2338 ofport_destroy(struct ofport *port)
2341 dealloc_ofp_port(port->ofproto, port->ofp_port);
2342 port->ofproto->ofproto_class->port_destruct(port);
2343 ofport_destroy__(port);
2348 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2350 struct ofport *port;
2352 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2354 if (port->ofp_port == ofp_port) {
2361 static long long int
2362 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2364 struct ofport_usage *usage;
2366 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2367 &ofproto->ofport_usage) {
2368 if (usage->ofp_port == ofp_port) {
2369 return usage->last_used;
2376 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2377 long long int last_used)
2379 struct ofport_usage *usage;
2380 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2381 &ofproto->ofport_usage) {
2382 if (usage->ofp_port == ofp_port) {
2383 usage->last_used = last_used;
2387 ovs_assert(last_used == LLONG_MAX);
2389 usage = xmalloc(sizeof *usage);
2390 usage->ofp_port = ofp_port;
2391 usage->last_used = last_used;
2392 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2393 hash_ofp_port(ofp_port));
2397 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2399 struct ofport_usage *usage;
2400 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2401 &ofproto->ofport_usage) {
2402 if (usage->ofp_port == ofp_port) {
2403 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2411 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2413 struct ofproto *ofproto = port->ofproto;
2416 if (ofproto->ofproto_class->port_get_stats) {
2417 error = ofproto->ofproto_class->port_get_stats(port, stats);
2426 update_port(struct ofproto *ofproto, const char *name)
2428 struct ofproto_port ofproto_port;
2429 struct ofputil_phy_port pp;
2430 struct netdev *netdev;
2431 struct ofport *port;
2433 COVERAGE_INC(ofproto_update_port);
2435 /* Fetch 'name''s location and properties from the datapath. */
2436 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2437 ? ofport_open(ofproto, &ofproto_port, &pp)
2441 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2442 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2443 struct netdev *old_netdev = port->netdev;
2445 /* 'name' hasn't changed location. Any properties changed? */
2446 if (!ofport_equal(&port->pp, &pp)) {
2447 ofport_modified(port, &pp);
2450 update_mtu(ofproto, port);
2452 /* Install the newly opened netdev in case it has changed.
2453 * Don't close the old netdev yet in case port_modified has to
2454 * remove a retained reference to it.*/
2455 port->netdev = netdev;
2456 port->change_seq = netdev_get_change_seq(netdev);
2458 if (port->ofproto->ofproto_class->port_modified) {
2459 port->ofproto->ofproto_class->port_modified(port);
2462 netdev_close(old_netdev);
2464 /* If 'port' is nonnull then its name differs from 'name' and thus
2465 * we should delete it. If we think there's a port named 'name'
2466 * then its port number must be wrong now so delete it too. */
2468 ofport_remove(port);
2470 ofport_remove_with_name(ofproto, name);
2471 ofport_install(ofproto, netdev, &pp);
2474 /* Any port named 'name' is gone now. */
2475 ofport_remove_with_name(ofproto, name);
2477 ofproto_port_destroy(&ofproto_port);
2481 init_ports(struct ofproto *p)
2483 struct ofproto_port_dump dump;
2484 struct ofproto_port ofproto_port;
2485 struct shash_node *node, *next;
2487 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2488 const char *name = ofproto_port.name;
2490 if (shash_find(&p->port_by_name, name)) {
2491 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2494 struct ofputil_phy_port pp;
2495 struct netdev *netdev;
2497 /* Check if an OpenFlow port number had been requested. */
2498 node = shash_find(&init_ofp_ports, name);
2500 const struct iface_hint *iface_hint = node->data;
2501 simap_put(&p->ofp_requests, name,
2502 ofp_to_u16(iface_hint->ofp_port));
2505 netdev = ofport_open(p, &ofproto_port, &pp);
2507 ofport_install(p, netdev, &pp);
2508 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2509 p->alloc_port_no = MAX(p->alloc_port_no,
2510 ofp_to_u16(ofproto_port.ofp_port));
2516 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2517 struct iface_hint *iface_hint = node->data;
2519 if (!strcmp(iface_hint->br_name, p->name)) {
2520 free(iface_hint->br_name);
2521 free(iface_hint->br_type);
2523 shash_delete(&init_ofp_ports, node);
2530 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2531 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2533 find_min_mtu(struct ofproto *p)
2535 struct ofport *ofport;
2538 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2539 struct netdev *netdev = ofport->netdev;
2542 /* Skip any internal ports, since that's what we're trying to
2544 if (!strcmp(netdev_get_type(netdev), "internal")) {
2548 if (netdev_get_mtu(netdev, &dev_mtu)) {
2551 if (!mtu || dev_mtu < mtu) {
2556 return mtu ? mtu: ETH_PAYLOAD_MAX;
2559 /* Update MTU of all datapath devices on 'p' to the minimum of the
2560 * non-datapath ports in event of 'port' added or changed. */
2562 update_mtu(struct ofproto *p, struct ofport *port)
2564 struct ofport *ofport;
2565 struct netdev *netdev = port->netdev;
2566 int dev_mtu, old_min;
2568 if (netdev_get_mtu(netdev, &dev_mtu)) {
2572 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2573 if (dev_mtu > p->min_mtu) {
2574 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2575 dev_mtu = p->min_mtu;
2578 port->mtu = dev_mtu;
2582 /* For non-internal port find new min mtu. */
2583 old_min = p->min_mtu;
2584 port->mtu = dev_mtu;
2585 p->min_mtu = find_min_mtu(p);
2586 if (p->min_mtu == old_min) {
2590 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2591 struct netdev *netdev = ofport->netdev;
2593 if (!strcmp(netdev_get_type(netdev), "internal")) {
2594 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2595 ofport->mtu = p->min_mtu;
2602 ofproto_rule_ref(struct rule *rule)
2605 ovs_refcount_ref(&rule->ref_count);
2610 ofproto_rule_unref(struct rule *rule)
2612 if (rule && ovs_refcount_unref(&rule->ref_count) == 1) {
2613 rule->ofproto->ofproto_class->rule_destruct(rule);
2614 ofproto_rule_destroy__(rule);
2619 ofproto_rule_destroy__(struct rule *rule)
2620 OVS_NO_THREAD_SAFETY_ANALYSIS
2622 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2623 rule_actions_destroy(rule_get_actions(rule));
2624 ovs_mutex_destroy(&rule->mutex);
2625 rule->ofproto->ofproto_class->rule_dealloc(rule);
2628 static uint32_t get_provider_meter_id(const struct ofproto *,
2629 uint32_t of_meter_id);
2631 /* Creates and returns a new 'struct rule_actions', with a ref_count of 1,
2632 * whose actions are a copy of from the 'ofpacts_len' bytes of 'ofpacts'. */
2633 struct rule_actions *
2634 rule_actions_create(const struct ofproto *ofproto,
2635 const struct ofpact *ofpacts, size_t ofpacts_len)
2637 struct rule_actions *actions;
2639 actions = xmalloc(sizeof *actions);
2640 actions->ofpacts = xmemdup(ofpacts, ofpacts_len);
2641 actions->ofpacts_len = ofpacts_len;
2642 actions->provider_meter_id
2643 = get_provider_meter_id(ofproto,
2644 ofpacts_get_meter(ofpacts, ofpacts_len));
2650 rule_actions_destroy_cb(struct rule_actions *actions)
2652 free(actions->ofpacts);
2656 /* Decrements 'actions''s ref_count and frees 'actions' if the ref_count
2659 rule_actions_destroy(struct rule_actions *actions)
2662 ovsrcu_postpone(rule_actions_destroy_cb, actions);
2666 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2667 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2669 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2670 OVS_REQUIRES(ofproto_mutex)
2672 if (port == OFPP_ANY) {
2675 const struct rule_actions *actions = rule_get_actions(rule);
2676 return ofpacts_output_to_port(actions->ofpacts,
2677 actions->ofpacts_len, port);
2681 /* Returns true if 'rule' has group and equals group_id. */
2683 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2684 OVS_REQUIRES(ofproto_mutex)
2686 if (group_id == OFPG_ANY) {
2689 const struct rule_actions *actions = rule_get_actions(rule);
2690 return ofpacts_output_to_group(actions->ofpacts,
2691 actions->ofpacts_len, group_id);
2695 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2696 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2698 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2699 OVS_REQUIRES(ofproto_mutex)
2701 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2706 case OFOPERATION_ADD:
2707 case OFOPERATION_DELETE:
2710 case OFOPERATION_MODIFY:
2711 case OFOPERATION_REPLACE:
2712 return ofpacts_output_to_port(op->actions->ofpacts,
2713 op->actions->ofpacts_len, out_port);
2720 rule_execute_destroy(struct rule_execute *e)
2722 ofproto_rule_unref(e->rule);
2723 list_remove(&e->list_node);
2727 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2728 * by passing them to the ofproto provider. */
2730 run_rule_executes(struct ofproto *ofproto)
2731 OVS_EXCLUDED(ofproto_mutex)
2733 struct rule_execute *e, *next;
2734 struct list executes;
2736 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2737 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2740 flow_extract(e->packet, NULL, &flow);
2741 flow.in_port.ofp_port = e->in_port;
2742 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2744 rule_execute_destroy(e);
2748 /* Destroys and discards all "rule_execute" operations queued up in
2749 * ofproto->rule_executes. */
2751 destroy_rule_executes(struct ofproto *ofproto)
2753 struct rule_execute *e, *next;
2754 struct list executes;
2756 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2757 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2758 ofpbuf_delete(e->packet);
2759 rule_execute_destroy(e);
2763 /* Returns true if 'rule' should be hidden from the controller.
2765 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2766 * (e.g. by in-band control) and are intentionally hidden from the
2769 ofproto_rule_is_hidden(const struct rule *rule)
2771 return (rule->cr.priority > UINT16_MAX);
2775 oftable_is_modifiable(const struct oftable *table,
2776 enum ofputil_flow_mod_flags flags)
2778 if (flags & OFPUTIL_FF_NO_READONLY) {
2782 return !(table->flags & OFTABLE_READONLY);
2786 rule_is_modifiable(const struct rule *rule, enum ofputil_flow_mod_flags flags)
2788 const struct oftable *rule_table;
2790 rule_table = &rule->ofproto->tables[rule->table_id];
2791 return oftable_is_modifiable(rule_table, flags);
2795 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2797 ofconn_send_reply(ofconn, make_echo_reply(oh));
2802 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2804 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2805 struct ofputil_switch_features features;
2806 struct ofport *port;
2810 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2812 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2814 features.datapath_id = ofproto->datapath_id;
2815 features.n_buffers = pktbuf_capacity();
2816 features.n_tables = ofproto_get_n_visible_tables(ofproto);
2817 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2818 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2820 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2822 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2823 features.auxiliary_id = 0;
2824 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2826 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2827 ofputil_put_switch_features_port(&port->pp, b);
2830 ofconn_send_reply(ofconn, b);
2835 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2837 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2838 struct ofp_switch_config *osc;
2839 enum ofp_config_flags flags;
2843 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2844 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2845 flags = ofproto->frag_handling;
2846 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2847 if (oh->version < OFP13_VERSION
2848 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2849 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2851 osc->flags = htons(flags);
2852 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2853 ofconn_send_reply(ofconn, buf);
2859 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2861 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2862 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2863 uint16_t flags = ntohs(osc->flags);
2865 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2866 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2867 enum ofp_config_flags cur = ofproto->frag_handling;
2868 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2870 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2872 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2873 ofproto->frag_handling = next;
2875 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2877 ofputil_frag_handling_to_string(next));
2881 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2882 ofconn_set_invalid_ttl_to_controller(ofconn,
2883 (oh->version < OFP13_VERSION
2884 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2886 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2891 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2892 * error message code for the caller to propagate upward. Otherwise, returns
2895 * The log message mentions 'msg_type'. */
2897 reject_slave_controller(struct ofconn *ofconn)
2899 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2900 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2901 return OFPERR_OFPBRC_EPERM;
2907 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2910 * - If they use a meter, then 'ofproto' has that meter configured.
2912 * - If they use any groups, then 'ofproto' has that group configured.
2914 * Returns 0 if successful, otherwise an OpenFlow error. */
2916 ofproto_check_ofpacts(struct ofproto *ofproto,
2917 const struct ofpact ofpacts[], size_t ofpacts_len)
2919 const struct ofpact *a;
2922 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2923 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2924 return OFPERR_OFPMMFC_INVALID_METER;
2927 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2928 if (a->type == OFPACT_GROUP
2929 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2930 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2938 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2940 struct ofproto *p = ofconn_get_ofproto(ofconn);
2941 struct ofputil_packet_out po;
2942 struct ofpbuf *payload;
2943 uint64_t ofpacts_stub[1024 / 8];
2944 struct ofpbuf ofpacts;
2948 COVERAGE_INC(ofproto_packet_out);
2950 error = reject_slave_controller(ofconn);
2955 /* Decode message. */
2956 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2957 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2959 goto exit_free_ofpacts;
2961 if (ofp_to_u16(po.in_port) >= p->max_ports
2962 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2963 error = OFPERR_OFPBRC_BAD_PORT;
2964 goto exit_free_ofpacts;
2968 if (po.buffer_id != UINT32_MAX) {
2969 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2970 if (error || !payload) {
2971 goto exit_free_ofpacts;
2974 /* Ensure that the L3 header is 32-bit aligned. */
2975 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2978 /* Verify actions against packet, then send packet if successful. */
2979 flow_extract(payload, NULL, &flow);
2980 flow.in_port.ofp_port = po.in_port;
2981 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
2983 error = p->ofproto_class->packet_out(p, payload, &flow,
2984 po.ofpacts, po.ofpacts_len);
2986 ofpbuf_delete(payload);
2989 ofpbuf_uninit(&ofpacts);
2995 update_port_config(struct ofconn *ofconn, struct ofport *port,
2996 enum ofputil_port_config config,
2997 enum ofputil_port_config mask)
2999 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3001 if (toggle & OFPUTIL_PC_PORT_DOWN
3002 && (config & OFPUTIL_PC_PORT_DOWN
3003 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3004 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3005 /* We tried to bring the port up or down, but it failed, so don't
3006 * update the "down" bit. */
3007 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3011 enum ofputil_port_config old_config = port->pp.config;
3012 port->pp.config ^= toggle;
3013 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3014 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3020 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3022 struct ofproto *p = ofconn_get_ofproto(ofconn);
3023 struct ofputil_port_mod pm;
3024 struct ofport *port;
3027 error = reject_slave_controller(ofconn);
3032 error = ofputil_decode_port_mod(oh, &pm);
3037 port = ofproto_get_port(p, pm.port_no);
3039 return OFPERR_OFPPMFC_BAD_PORT;
3040 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3041 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3043 update_port_config(ofconn, port, pm.config, pm.mask);
3045 netdev_set_advertisements(port->netdev, pm.advertise);
3052 handle_desc_stats_request(struct ofconn *ofconn,
3053 const struct ofp_header *request)
3055 static const char *default_mfr_desc = "Nicira, Inc.";
3056 static const char *default_hw_desc = "Open vSwitch";
3057 static const char *default_sw_desc = VERSION;
3058 static const char *default_serial_desc = "None";
3059 static const char *default_dp_desc = "None";
3061 struct ofproto *p = ofconn_get_ofproto(ofconn);
3062 struct ofp_desc_stats *ods;
3065 msg = ofpraw_alloc_stats_reply(request, 0);
3066 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3067 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3068 sizeof ods->mfr_desc);
3069 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3070 sizeof ods->hw_desc);
3071 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3072 sizeof ods->sw_desc);
3073 ovs_strlcpy(ods->serial_num,
3074 p->serial_desc ? p->serial_desc : default_serial_desc,
3075 sizeof ods->serial_num);
3076 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3077 sizeof ods->dp_desc);
3078 ofconn_send_reply(ofconn, msg);
3084 handle_table_stats_request(struct ofconn *ofconn,
3085 const struct ofp_header *request)
3087 struct ofproto *p = ofconn_get_ofproto(ofconn);
3088 struct ofp12_table_stats *ots;
3093 /* Set up default values.
3095 * ofp12_table_stats is used as a generic structure as
3096 * it is able to hold all the fields for ofp10_table_stats
3097 * and ofp11_table_stats (and of course itself).
3099 ots = xcalloc(p->n_tables, sizeof *ots);
3100 for (i = 0; i < p->n_tables; i++) {
3101 ots[i].table_id = i;
3102 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3103 ots[i].match = htonll(OFPXMT13_MASK);
3104 ots[i].wildcards = htonll(OFPXMT13_MASK);
3105 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3106 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3107 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3108 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3109 ots[i].metadata_match = OVS_BE64_MAX;
3110 ots[i].metadata_write = OVS_BE64_MAX;
3111 ots[i].instructions = htonl(OFPIT11_ALL);
3112 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3113 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3114 fat_rwlock_rdlock(&p->tables[i].cls.rwlock);
3115 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3116 fat_rwlock_unlock(&p->tables[i].cls.rwlock);
3119 p->ofproto_class->get_tables(p, ots);
3121 /* Post-process the tables, dropping hidden tables. */
3122 n_tables = p->n_tables;
3123 for (i = 0; i < p->n_tables; i++) {
3124 const struct oftable *table = &p->tables[i];
3126 if (table->flags & OFTABLE_HIDDEN) {
3132 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3135 if (table->max_flows < ntohl(ots[i].max_entries)) {
3136 ots[i].max_entries = htonl(table->max_flows);
3140 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3141 ofconn_send_reply(ofconn, msg);
3149 append_port_stat(struct ofport *port, struct list *replies)
3151 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3153 calc_duration(port->created, time_msec(),
3154 &ops.duration_sec, &ops.duration_nsec);
3156 /* Intentionally ignore return value, since errors will set
3157 * 'stats' to all-1s, which is correct for OpenFlow, and
3158 * netdev_get_stats() will log errors. */
3159 ofproto_port_get_stats(port, &ops.stats);
3161 ofputil_append_port_stat(replies, &ops);
3165 handle_port_stats_request(struct ofconn *ofconn,
3166 const struct ofp_header *request)
3168 struct ofproto *p = ofconn_get_ofproto(ofconn);
3169 struct ofport *port;
3170 struct list replies;
3174 error = ofputil_decode_port_stats_request(request, &port_no);
3179 ofpmp_init(&replies, request);
3180 if (port_no != OFPP_ANY) {
3181 port = ofproto_get_port(p, port_no);
3183 append_port_stat(port, &replies);
3186 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3187 append_port_stat(port, &replies);
3191 ofconn_send_replies(ofconn, &replies);
3196 handle_port_desc_stats_request(struct ofconn *ofconn,
3197 const struct ofp_header *request)
3199 struct ofproto *p = ofconn_get_ofproto(ofconn);
3200 enum ofp_version version;
3201 struct ofport *port;
3202 struct list replies;
3204 ofpmp_init(&replies, request);
3206 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
3207 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3208 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
3211 ofconn_send_replies(ofconn, &replies);
3216 hash_cookie(ovs_be64 cookie)
3218 return hash_uint64((OVS_FORCE uint64_t)cookie);
3222 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3223 OVS_REQUIRES(ofproto_mutex)
3225 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3226 hash_cookie(rule->flow_cookie));
3230 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3231 OVS_REQUIRES(ofproto_mutex)
3233 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3237 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3238 ovs_be64 new_cookie)
3239 OVS_REQUIRES(ofproto_mutex)
3241 if (new_cookie != rule->flow_cookie) {
3242 cookies_remove(ofproto, rule);
3244 ovs_mutex_lock(&rule->mutex);
3245 rule->flow_cookie = new_cookie;
3246 ovs_mutex_unlock(&rule->mutex);
3248 cookies_insert(ofproto, rule);
3253 calc_duration(long long int start, long long int now,
3254 uint32_t *sec, uint32_t *nsec)
3256 long long int msecs = now - start;
3257 *sec = msecs / 1000;
3258 *nsec = (msecs % 1000) * (1000 * 1000);
3261 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3262 * true if 'table_id' is OK, false otherwise. */
3264 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3266 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3269 static struct oftable *
3270 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3272 struct oftable *table;
3274 for (table = &ofproto->tables[table_id];
3275 table < &ofproto->tables[ofproto->n_tables];
3277 if (!(table->flags & OFTABLE_HIDDEN)) {
3285 static struct oftable *
3286 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3288 if (table_id == 0xff) {
3289 return next_visible_table(ofproto, 0);
3290 } else if (table_id < ofproto->n_tables) {
3291 return &ofproto->tables[table_id];
3297 static struct oftable *
3298 next_matching_table(const struct ofproto *ofproto,
3299 const struct oftable *table, uint8_t table_id)
3301 return (table_id == 0xff
3302 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3306 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3308 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3309 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3311 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3312 * only once, for that table. (This can be used to access tables marked
3315 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3316 * entered at all. (Perhaps you should have validated TABLE_ID with
3317 * check_table_id().)
3319 * All parameters are evaluated multiple times.
3321 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3322 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3324 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3326 /* Initializes 'criteria' in a straightforward way based on the other
3329 * For "loose" matching, the 'priority' parameter is unimportant and may be
3332 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3333 const struct match *match, unsigned int priority,
3334 ovs_be64 cookie, ovs_be64 cookie_mask,
3335 ofp_port_t out_port, uint32_t out_group)
3337 criteria->table_id = table_id;
3338 cls_rule_init(&criteria->cr, match, priority);
3339 criteria->cookie = cookie;
3340 criteria->cookie_mask = cookie_mask;
3341 criteria->out_port = out_port;
3342 criteria->out_group = out_group;
3346 rule_criteria_destroy(struct rule_criteria *criteria)
3348 cls_rule_destroy(&criteria->cr);
3352 rule_collection_init(struct rule_collection *rules)
3354 rules->rules = rules->stub;
3356 rules->capacity = ARRAY_SIZE(rules->stub);
3360 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3362 if (rules->n >= rules->capacity) {
3363 size_t old_size, new_size;
3365 old_size = rules->capacity * sizeof *rules->rules;
3366 rules->capacity *= 2;
3367 new_size = rules->capacity * sizeof *rules->rules;
3369 if (rules->rules == rules->stub) {
3370 rules->rules = xmalloc(new_size);
3371 memcpy(rules->rules, rules->stub, old_size);
3373 rules->rules = xrealloc(rules->rules, new_size);
3377 rules->rules[rules->n++] = rule;
3381 rule_collection_ref(struct rule_collection *rules)
3382 OVS_REQUIRES(ofproto_mutex)
3386 for (i = 0; i < rules->n; i++) {
3387 ofproto_rule_ref(rules->rules[i]);
3392 rule_collection_unref(struct rule_collection *rules)
3396 for (i = 0; i < rules->n; i++) {
3397 ofproto_rule_unref(rules->rules[i]);
3402 rule_collection_destroy(struct rule_collection *rules)
3404 if (rules->rules != rules->stub) {
3410 collect_rule(struct rule *rule, const struct rule_criteria *c,
3411 struct rule_collection *rules)
3412 OVS_REQUIRES(ofproto_mutex)
3414 /* We ordinarily want to skip hidden rules, but there has to be a way for
3415 * code internal to OVS to modify and delete them, so if the criteria
3416 * specify a priority that can only be for a hidden flow, then allow hidden
3417 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3418 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3420 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3422 } else if (rule->pending) {
3423 return OFPROTO_POSTPONE;
3425 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3426 && ofproto_rule_has_out_port(rule, c->out_port)
3427 && ofproto_rule_has_out_group(rule, c->out_group)
3428 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3429 rule_collection_add(rules, rule);
3435 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3436 * on classifiers rules are done in the "loose" way required for OpenFlow
3437 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3440 * Hidden rules are always omitted.
3442 * Returns 0 on success, otherwise an OpenFlow error code. */
3444 collect_rules_loose(struct ofproto *ofproto,
3445 const struct rule_criteria *criteria,
3446 struct rule_collection *rules)
3447 OVS_REQUIRES(ofproto_mutex)
3449 struct oftable *table;
3450 enum ofperr error = 0;
3452 rule_collection_init(rules);
3454 if (!check_table_id(ofproto, criteria->table_id)) {
3455 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3459 if (criteria->cookie_mask == OVS_BE64_MAX) {
3462 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3463 hash_cookie(criteria->cookie),
3464 &ofproto->cookies) {
3465 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3466 error = collect_rule(rule, criteria, rules);
3473 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3474 struct cls_cursor cursor;
3477 fat_rwlock_rdlock(&table->cls.rwlock);
3478 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3479 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3480 error = collect_rule(rule, criteria, rules);
3485 fat_rwlock_unlock(&table->cls.rwlock);
3491 rule_collection_destroy(rules);
3496 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3497 * on classifiers rules are done in the "strict" way required for OpenFlow
3498 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3499 * rules on list 'rules'.
3501 * Hidden rules are always omitted.
3503 * Returns 0 on success, otherwise an OpenFlow error code. */
3505 collect_rules_strict(struct ofproto *ofproto,
3506 const struct rule_criteria *criteria,
3507 struct rule_collection *rules)
3508 OVS_REQUIRES(ofproto_mutex)
3510 struct oftable *table;
3513 rule_collection_init(rules);
3515 if (!check_table_id(ofproto, criteria->table_id)) {
3516 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3520 if (criteria->cookie_mask == OVS_BE64_MAX) {
3523 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3524 hash_cookie(criteria->cookie),
3525 &ofproto->cookies) {
3526 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3527 error = collect_rule(rule, criteria, rules);
3534 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3537 fat_rwlock_rdlock(&table->cls.rwlock);
3538 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3539 &table->cls, &criteria->cr));
3540 fat_rwlock_unlock(&table->cls.rwlock);
3542 error = collect_rule(rule, criteria, rules);
3552 rule_collection_destroy(rules);
3557 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3558 * forced into the range of a uint16_t. */
3560 age_secs(long long int age_ms)
3562 return (age_ms < 0 ? 0
3563 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3564 : (unsigned int) age_ms / 1000);
3568 handle_flow_stats_request(struct ofconn *ofconn,
3569 const struct ofp_header *request)
3570 OVS_EXCLUDED(ofproto_mutex)
3572 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3573 struct ofputil_flow_stats_request fsr;
3574 struct rule_criteria criteria;
3575 struct rule_collection rules;
3576 struct list replies;
3580 error = ofputil_decode_flow_stats_request(&fsr, request);
3585 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3586 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3588 ovs_mutex_lock(&ofproto_mutex);
3589 error = collect_rules_loose(ofproto, &criteria, &rules);
3590 rule_criteria_destroy(&criteria);
3592 rule_collection_ref(&rules);
3594 ovs_mutex_unlock(&ofproto_mutex);
3600 ofpmp_init(&replies, request);
3601 for (i = 0; i < rules.n; i++) {
3602 struct rule *rule = rules.rules[i];
3603 long long int now = time_msec();
3604 struct ofputil_flow_stats fs;
3605 long long int created, used, modified;
3606 struct rule_actions *actions;
3607 enum ofputil_flow_mod_flags flags;
3609 ovs_mutex_lock(&rule->mutex);
3610 fs.cookie = rule->flow_cookie;
3611 fs.idle_timeout = rule->idle_timeout;
3612 fs.hard_timeout = rule->hard_timeout;
3613 created = rule->created;
3614 modified = rule->modified;
3615 actions = rule_get_actions(rule);
3616 flags = rule->flags;
3617 ovs_mutex_unlock(&rule->mutex);
3619 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3620 &fs.byte_count, &used);
3622 minimatch_expand(&rule->cr.match, &fs.match);
3623 fs.table_id = rule->table_id;
3624 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3625 fs.priority = rule->cr.priority;
3626 fs.idle_age = age_secs(now - used);
3627 fs.hard_age = age_secs(now - modified);
3628 fs.ofpacts = actions->ofpacts;
3629 fs.ofpacts_len = actions->ofpacts_len;
3632 ofputil_append_flow_stats_reply(&fs, &replies);
3635 rule_collection_unref(&rules);
3636 rule_collection_destroy(&rules);
3638 ofconn_send_replies(ofconn, &replies);
3644 flow_stats_ds(struct rule *rule, struct ds *results)
3646 uint64_t packet_count, byte_count;
3647 struct rule_actions *actions;
3648 long long int created, used;
3650 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3651 &byte_count, &used);
3653 ovs_mutex_lock(&rule->mutex);
3654 actions = rule_get_actions(rule);
3655 created = rule->created;
3656 ovs_mutex_unlock(&rule->mutex);
3658 if (rule->table_id != 0) {
3659 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3661 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3662 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3663 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3664 cls_rule_format(&rule->cr, results);
3665 ds_put_char(results, ',');
3667 ds_put_cstr(results, "actions=");
3668 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3670 ds_put_cstr(results, "\n");
3673 /* Adds a pretty-printed description of all flows to 'results', including
3674 * hidden flows (e.g., set up by in-band control). */
3676 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3678 struct oftable *table;
3680 OFPROTO_FOR_EACH_TABLE (table, p) {
3681 struct cls_cursor cursor;
3684 fat_rwlock_rdlock(&table->cls.rwlock);
3685 cls_cursor_init(&cursor, &table->cls, NULL);
3686 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3687 flow_stats_ds(rule, results);
3689 fat_rwlock_unlock(&table->cls.rwlock);
3693 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3694 * '*engine_type' and '*engine_id', respectively. */
3696 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3697 uint8_t *engine_type, uint8_t *engine_id)
3699 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3702 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3703 * true if the port's CFM status was successfully stored into '*status'.
3704 * Returns false if the port did not have CFM configured, in which case
3705 * '*status' is indeterminate.
3707 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3709 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3710 struct ofproto_cfm_status *status)
3712 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3714 && ofproto->ofproto_class->get_cfm_status
3715 && ofproto->ofproto_class->get_cfm_status(ofport, status));
3719 handle_aggregate_stats_request(struct ofconn *ofconn,
3720 const struct ofp_header *oh)
3721 OVS_EXCLUDED(ofproto_mutex)
3723 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3724 struct ofputil_flow_stats_request request;
3725 struct ofputil_aggregate_stats stats;
3726 bool unknown_packets, unknown_bytes;
3727 struct rule_criteria criteria;
3728 struct rule_collection rules;
3729 struct ofpbuf *reply;
3733 error = ofputil_decode_flow_stats_request(&request, oh);
3738 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3739 request.cookie, request.cookie_mask,
3740 request.out_port, request.out_group);
3742 ovs_mutex_lock(&ofproto_mutex);
3743 error = collect_rules_loose(ofproto, &criteria, &rules);
3744 rule_criteria_destroy(&criteria);
3746 rule_collection_ref(&rules);
3748 ovs_mutex_unlock(&ofproto_mutex);
3754 memset(&stats, 0, sizeof stats);
3755 unknown_packets = unknown_bytes = false;
3756 for (i = 0; i < rules.n; i++) {
3757 struct rule *rule = rules.rules[i];
3758 uint64_t packet_count;
3759 uint64_t byte_count;
3762 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3763 &byte_count, &used);
3765 if (packet_count == UINT64_MAX) {
3766 unknown_packets = true;
3768 stats.packet_count += packet_count;
3771 if (byte_count == UINT64_MAX) {
3772 unknown_bytes = true;
3774 stats.byte_count += byte_count;
3779 if (unknown_packets) {
3780 stats.packet_count = UINT64_MAX;
3782 if (unknown_bytes) {
3783 stats.byte_count = UINT64_MAX;
3786 rule_collection_unref(&rules);
3787 rule_collection_destroy(&rules);
3789 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3790 ofconn_send_reply(ofconn, reply);
3795 struct queue_stats_cbdata {
3796 struct ofport *ofport;
3797 struct list replies;
3802 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3803 const struct netdev_queue_stats *stats)
3805 struct ofputil_queue_stats oqs;
3807 oqs.port_no = cbdata->ofport->pp.port_no;
3808 oqs.queue_id = queue_id;
3809 oqs.tx_bytes = stats->tx_bytes;
3810 oqs.tx_packets = stats->tx_packets;
3811 oqs.tx_errors = stats->tx_errors;
3812 if (stats->created != LLONG_MIN) {
3813 calc_duration(stats->created, cbdata->now,
3814 &oqs.duration_sec, &oqs.duration_nsec);
3816 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3818 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3822 handle_queue_stats_dump_cb(uint32_t queue_id,
3823 struct netdev_queue_stats *stats,
3826 struct queue_stats_cbdata *cbdata = cbdata_;
3828 put_queue_stats(cbdata, queue_id, stats);
3832 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3833 struct queue_stats_cbdata *cbdata)
3835 cbdata->ofport = port;
3836 if (queue_id == OFPQ_ALL) {
3837 netdev_dump_queue_stats(port->netdev,
3838 handle_queue_stats_dump_cb, cbdata);
3840 struct netdev_queue_stats stats;
3842 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3843 put_queue_stats(cbdata, queue_id, &stats);
3845 return OFPERR_OFPQOFC_BAD_QUEUE;
3852 handle_queue_stats_request(struct ofconn *ofconn,
3853 const struct ofp_header *rq)
3855 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3856 struct queue_stats_cbdata cbdata;
3857 struct ofport *port;
3859 struct ofputil_queue_stats_request oqsr;
3861 COVERAGE_INC(ofproto_queue_req);
3863 ofpmp_init(&cbdata.replies, rq);
3864 cbdata.now = time_msec();
3866 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3871 if (oqsr.port_no == OFPP_ANY) {
3872 error = OFPERR_OFPQOFC_BAD_QUEUE;
3873 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3874 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3879 port = ofproto_get_port(ofproto, oqsr.port_no);
3881 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3882 : OFPERR_OFPQOFC_BAD_PORT);
3885 ofconn_send_replies(ofconn, &cbdata.replies);
3887 ofpbuf_list_delete(&cbdata.replies);
3894 is_flow_deletion_pending(const struct ofproto *ofproto,
3895 const struct cls_rule *cls_rule,
3897 OVS_REQUIRES(ofproto_mutex)
3899 if (!hmap_is_empty(&ofproto->deletions)) {
3900 struct ofoperation *op;
3902 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3903 cls_rule_hash(cls_rule, table_id),
3904 &ofproto->deletions) {
3905 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3915 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3916 OVS_REQUIRES(ofproto_mutex)
3917 OVS_NO_THREAD_SAFETY_ANALYSIS
3919 return classifier_count(&table->cls) + extra_space > table->max_flows;
3923 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3924 unsigned int extra_space)
3925 OVS_REQUIRES(ofproto_mutex)
3927 while (should_evict_a_rule(table, extra_space)) {
3930 if (!choose_rule_to_evict(table, &rule)) {
3931 return OFPERR_OFPFMFC_TABLE_FULL;
3932 } else if (rule->pending) {
3933 return OFPROTO_POSTPONE;
3935 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3936 delete_flow__(rule, group, OFPRR_EVICTION);
3937 ofopgroup_submit(group);
3944 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3945 * in which no matching flow already exists in the flow table.
3947 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3948 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3949 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3950 * initiated now but may be retried later.
3952 * The caller retains ownership of 'fm->ofpacts'.
3954 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3957 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3958 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3959 OVS_REQUIRES(ofproto_mutex)
3961 struct oftable *table;
3962 struct ofopgroup *group;
3968 if (!check_table_id(ofproto, fm->table_id)) {
3969 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3974 if (fm->table_id == 0xff) {
3975 if (ofproto->ofproto_class->rule_choose_table) {
3976 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3982 ovs_assert(table_id < ofproto->n_tables);
3986 } else if (fm->table_id < ofproto->n_tables) {
3987 table_id = fm->table_id;
3989 return OFPERR_OFPBRC_BAD_TABLE_ID;
3992 table = &ofproto->tables[table_id];
3994 if (!oftable_is_modifiable(table, fm->flags)) {
3995 return OFPERR_OFPBRC_EPERM;
3998 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
3999 if (!match_has_default_hidden_fields(&fm->match)) {
4000 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4001 "non-default values to hidden fields", ofproto->name);
4002 return OFPERR_OFPBRC_EPERM;
4006 cls_rule_init(&cr, &fm->match, fm->priority);
4008 /* Transform "add" into "modify" if there's an existing identical flow. */
4009 fat_rwlock_rdlock(&table->cls.rwlock);
4010 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4011 fat_rwlock_unlock(&table->cls.rwlock);
4013 cls_rule_destroy(&cr);
4014 if (!rule_is_modifiable(rule, fm->flags)) {
4015 return OFPERR_OFPBRC_EPERM;
4016 } else if (rule->pending) {
4017 return OFPROTO_POSTPONE;
4019 struct rule_collection rules;
4021 rule_collection_init(&rules);
4022 rule_collection_add(&rules, rule);
4023 fm->modify_cookie = true;
4024 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4025 rule_collection_destroy(&rules);
4031 /* Serialize against pending deletion. */
4032 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
4033 cls_rule_destroy(&cr);
4034 return OFPROTO_POSTPONE;
4037 /* Check for overlap, if requested. */
4038 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4041 fat_rwlock_rdlock(&table->cls.rwlock);
4042 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4043 fat_rwlock_unlock(&table->cls.rwlock);
4046 cls_rule_destroy(&cr);
4047 return OFPERR_OFPFMFC_OVERLAP;
4051 /* If necessary, evict an existing rule to clear out space. */
4052 error = evict_rules_from_table(ofproto, table, 1);
4054 cls_rule_destroy(&cr);
4058 /* Allocate new rule. */
4059 rule = ofproto->ofproto_class->rule_alloc();
4061 cls_rule_destroy(&cr);
4062 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4063 ofproto->name, ovs_strerror(error));
4067 /* Initialize base state. */
4068 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4069 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4070 ovs_refcount_init(&rule->ref_count);
4071 rule->pending = NULL;
4072 rule->flow_cookie = fm->new_cookie;
4073 rule->created = rule->modified = time_msec();
4075 ovs_mutex_init(&rule->mutex);
4076 ovs_mutex_lock(&rule->mutex);
4077 rule->idle_timeout = fm->idle_timeout;
4078 rule->hard_timeout = fm->hard_timeout;
4079 ovs_mutex_unlock(&rule->mutex);
4081 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4082 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4083 ovsrcu_set(&rule->actions,
4084 rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len));
4085 list_init(&rule->meter_list_node);
4086 rule->eviction_group = NULL;
4087 list_init(&rule->expirable);
4088 rule->monitor_flags = 0;
4089 rule->add_seqno = 0;
4090 rule->modify_seqno = 0;
4092 /* Construct rule, initializing derived state. */
4093 error = ofproto->ofproto_class->rule_construct(rule);
4095 ofproto_rule_destroy__(rule);
4100 oftable_insert_rule(rule);
4102 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4103 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4104 ofproto->ofproto_class->rule_insert(rule);
4105 ofopgroup_submit(group);
4110 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4112 /* Modifies the rules listed in 'rules', changing their actions to match those
4115 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4118 * Returns 0 on success, otherwise an OpenFlow error code. */
4120 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4121 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4122 const struct rule_collection *rules)
4123 OVS_REQUIRES(ofproto_mutex)
4125 enum ofoperation_type type;
4126 struct ofopgroup *group;
4130 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4131 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4132 error = OFPERR_OFPBRC_EPERM;
4133 for (i = 0; i < rules->n; i++) {
4134 struct rule *rule = rules->rules[i];
4135 const struct rule_actions *actions;
4136 struct ofoperation *op;
4137 bool actions_changed;
4138 bool reset_counters;
4140 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4142 if (rule_is_modifiable(rule, fm->flags)) {
4143 /* At least one rule is modifiable, don't report EPERM error. */
4149 actions = rule_get_actions(rule);
4150 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4152 actions->ofpacts_len);
4154 op = ofoperation_create(group, rule, type, 0);
4156 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4157 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4159 if (type == OFOPERATION_REPLACE) {
4160 ovs_mutex_lock(&rule->mutex);
4161 rule->idle_timeout = fm->idle_timeout;
4162 rule->hard_timeout = fm->hard_timeout;
4163 ovs_mutex_unlock(&rule->mutex);
4165 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4166 if (fm->idle_timeout || fm->hard_timeout) {
4167 if (!rule->eviction_group) {
4168 eviction_group_add_rule(rule);
4171 eviction_group_remove_rule(rule);
4175 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4176 if (actions_changed || reset_counters) {
4177 struct rule_actions *new_actions;
4179 op->actions = rule_get_actions(rule);
4180 new_actions = rule_actions_create(ofproto,
4181 fm->ofpacts, fm->ofpacts_len);
4183 ovsrcu_set(&rule->actions, new_actions);
4185 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4188 ofoperation_complete(op, 0);
4191 ofopgroup_submit(group);
4197 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4198 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4199 OVS_REQUIRES(ofproto_mutex)
4201 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4204 return add_flow(ofproto, ofconn, fm, request);
4207 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4210 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4213 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4214 struct ofputil_flow_mod *fm,
4215 const struct ofp_header *request)
4216 OVS_REQUIRES(ofproto_mutex)
4218 struct rule_criteria criteria;
4219 struct rule_collection rules;
4222 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4223 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4224 error = collect_rules_loose(ofproto, &criteria, &rules);
4225 rule_criteria_destroy(&criteria);
4228 error = (rules.n > 0
4229 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4230 : modify_flows_add(ofproto, ofconn, fm, request));
4233 rule_collection_destroy(&rules);
4238 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4241 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4244 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4245 struct ofputil_flow_mod *fm,
4246 const struct ofp_header *request)
4247 OVS_REQUIRES(ofproto_mutex)
4249 struct rule_criteria criteria;
4250 struct rule_collection rules;
4253 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4254 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4255 error = collect_rules_strict(ofproto, &criteria, &rules);
4256 rule_criteria_destroy(&criteria);
4260 error = modify_flows_add(ofproto, ofconn, fm, request);
4261 } else if (rules.n == 1) {
4262 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4266 rule_collection_destroy(&rules);
4271 /* OFPFC_DELETE implementation. */
4274 delete_flow__(struct rule *rule, struct ofopgroup *group,
4275 enum ofp_flow_removed_reason reason)
4276 OVS_REQUIRES(ofproto_mutex)
4278 struct ofproto *ofproto = rule->ofproto;
4280 ofproto_rule_send_removed(rule, reason);
4282 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4283 oftable_remove_rule(rule);
4284 ofproto->ofproto_class->rule_delete(rule);
4287 /* Deletes the rules listed in 'rules'.
4289 * Returns 0 on success, otherwise an OpenFlow error code. */
4291 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4292 const struct ofp_header *request,
4293 const struct rule_collection *rules,
4294 enum ofp_flow_removed_reason reason)
4295 OVS_REQUIRES(ofproto_mutex)
4297 struct ofopgroup *group;
4300 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4301 for (i = 0; i < rules->n; i++) {
4302 delete_flow__(rules->rules[i], group, reason);
4304 ofopgroup_submit(group);
4309 /* Implements OFPFC_DELETE. */
4311 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4312 const struct ofputil_flow_mod *fm,
4313 const struct ofp_header *request)
4314 OVS_REQUIRES(ofproto_mutex)
4316 struct rule_criteria criteria;
4317 struct rule_collection rules;
4320 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4321 fm->cookie, fm->cookie_mask,
4322 fm->out_port, fm->out_group);
4323 error = collect_rules_loose(ofproto, &criteria, &rules);
4324 rule_criteria_destroy(&criteria);
4326 if (!error && rules.n > 0) {
4327 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4329 rule_collection_destroy(&rules);
4334 /* Implements OFPFC_DELETE_STRICT. */
4336 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4337 const struct ofputil_flow_mod *fm,
4338 const struct ofp_header *request)
4339 OVS_REQUIRES(ofproto_mutex)
4341 struct rule_criteria criteria;
4342 struct rule_collection rules;
4345 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4346 fm->cookie, fm->cookie_mask,
4347 fm->out_port, fm->out_group);
4348 error = collect_rules_strict(ofproto, &criteria, &rules);
4349 rule_criteria_destroy(&criteria);
4351 if (!error && rules.n > 0) {
4352 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4354 rule_collection_destroy(&rules);
4360 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4361 OVS_REQUIRES(ofproto_mutex)
4363 struct ofputil_flow_removed fr;
4366 if (ofproto_rule_is_hidden(rule) ||
4367 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4371 minimatch_expand(&rule->cr.match, &fr.match);
4372 fr.priority = rule->cr.priority;
4373 fr.cookie = rule->flow_cookie;
4375 fr.table_id = rule->table_id;
4376 calc_duration(rule->created, time_msec(),
4377 &fr.duration_sec, &fr.duration_nsec);
4378 ovs_mutex_lock(&rule->mutex);
4379 fr.idle_timeout = rule->idle_timeout;
4380 fr.hard_timeout = rule->hard_timeout;
4381 ovs_mutex_unlock(&rule->mutex);
4382 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4383 &fr.byte_count, &used);
4385 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4388 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4389 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4392 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4395 * ofproto implementation ->run() functions should use this function to expire
4396 * OpenFlow flows. */
4398 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4399 OVS_REQUIRES(ofproto_mutex)
4401 struct ofproto *ofproto = rule->ofproto;
4403 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4404 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4406 ofproto_rule_delete__(ofproto, rule, reason);
4409 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4410 * means "infinite". */
4412 reduce_timeout(uint16_t max, uint16_t *timeout)
4414 if (max && (!*timeout || *timeout > max)) {
4419 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4420 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4421 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4423 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4425 ofproto_rule_reduce_timeouts(struct rule *rule,
4426 uint16_t idle_timeout, uint16_t hard_timeout)
4427 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4429 if (!idle_timeout && !hard_timeout) {
4433 ovs_mutex_lock(&ofproto_mutex);
4434 if (list_is_empty(&rule->expirable)) {
4435 list_insert(&rule->ofproto->expirable, &rule->expirable);
4437 ovs_mutex_unlock(&ofproto_mutex);
4439 ovs_mutex_lock(&rule->mutex);
4440 reduce_timeout(idle_timeout, &rule->idle_timeout);
4441 reduce_timeout(hard_timeout, &rule->hard_timeout);
4442 ovs_mutex_unlock(&rule->mutex);
4446 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4447 OVS_EXCLUDED(ofproto_mutex)
4449 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4450 struct ofputil_flow_mod fm;
4451 uint64_t ofpacts_stub[1024 / 8];
4452 struct ofpbuf ofpacts;
4456 error = reject_slave_controller(ofconn);
4461 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4462 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4464 u16_to_ofp(ofproto->max_ports),
4467 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4470 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4473 goto exit_free_ofpacts;
4476 /* Record the operation for logging a summary report. */
4477 switch (fm.command) {
4483 case OFPFC_MODIFY_STRICT:
4484 ofproto->n_modify++;
4488 case OFPFC_DELETE_STRICT:
4489 ofproto->n_delete++;
4494 if (ofproto->next_op_report == LLONG_MAX) {
4495 ofproto->first_op = now;
4496 ofproto->next_op_report = MAX(now + 10 * 1000,
4497 ofproto->op_backoff);
4498 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
4500 ofproto->last_op = now;
4503 ofpbuf_uninit(&ofpacts);
4509 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4510 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4511 OVS_EXCLUDED(ofproto_mutex)
4515 ovs_mutex_lock(&ofproto_mutex);
4516 if (ofproto->n_pending < 50) {
4517 switch (fm->command) {
4519 error = add_flow(ofproto, ofconn, fm, oh);
4523 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4526 case OFPFC_MODIFY_STRICT:
4527 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4531 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4534 case OFPFC_DELETE_STRICT:
4535 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4539 if (fm->command > 0xff) {
4540 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4541 "flow_mod_table_id extension is not enabled",
4544 error = OFPERR_OFPFMFC_BAD_COMMAND;
4548 ovs_assert(!list_is_empty(&ofproto->pending));
4549 error = OFPROTO_POSTPONE;
4551 ovs_mutex_unlock(&ofproto_mutex);
4553 run_rule_executes(ofproto);
4558 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4560 struct ofputil_role_request request;
4561 struct ofputil_role_request reply;
4565 error = ofputil_decode_role_message(oh, &request);
4570 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4571 if (ofconn_get_role(ofconn) != request.role
4572 && ofconn_has_pending_opgroups(ofconn)) {
4573 return OFPROTO_POSTPONE;
4576 if (request.have_generation_id
4577 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4578 return OFPERR_OFPRRFC_STALE;
4581 ofconn_set_role(ofconn, request.role);
4584 reply.role = ofconn_get_role(ofconn);
4585 reply.have_generation_id = ofconn_get_master_election_id(
4586 ofconn, &reply.generation_id);
4587 buf = ofputil_encode_role_reply(oh, &reply);
4588 ofconn_send_reply(ofconn, buf);
4594 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4595 const struct ofp_header *oh)
4597 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4598 enum ofputil_protocol cur, next;
4600 cur = ofconn_get_protocol(ofconn);
4601 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4602 ofconn_set_protocol(ofconn, next);
4608 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4610 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4611 enum ofputil_protocol cur, next;
4612 enum ofputil_protocol next_base;
4614 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4616 return OFPERR_OFPBRC_EPERM;
4619 cur = ofconn_get_protocol(ofconn);
4620 next = ofputil_protocol_set_base(cur, next_base);
4621 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4622 /* Avoid sending async messages in surprising protocol. */
4623 return OFPROTO_POSTPONE;
4626 ofconn_set_protocol(ofconn, next);
4631 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4632 const struct ofp_header *oh)
4634 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4637 format = ntohl(msg->format);
4638 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4639 return OFPERR_OFPBRC_EPERM;
4642 if (format != ofconn_get_packet_in_format(ofconn)
4643 && ofconn_has_pending_opgroups(ofconn)) {
4644 /* Avoid sending async message in surprsing packet in format. */
4645 return OFPROTO_POSTPONE;
4648 ofconn_set_packet_in_format(ofconn, format);
4653 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4655 const struct nx_async_config *msg = ofpmsg_body(oh);
4656 uint32_t master[OAM_N_TYPES];
4657 uint32_t slave[OAM_N_TYPES];
4659 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4660 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4661 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4663 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4664 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4665 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4667 ofconn_set_async_config(ofconn, master, slave);
4668 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4669 !ofconn_get_miss_send_len(ofconn)) {
4670 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4677 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4680 uint32_t master[OAM_N_TYPES];
4681 uint32_t slave[OAM_N_TYPES];
4682 struct nx_async_config *msg;
4684 ofconn_get_async_config(ofconn, master, slave);
4685 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4686 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4688 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4689 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4690 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4692 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4693 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4694 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4696 ofconn_send_reply(ofconn, buf);
4702 handle_nxt_set_controller_id(struct ofconn *ofconn,
4703 const struct ofp_header *oh)
4705 const struct nx_controller_id *nci = ofpmsg_body(oh);
4707 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4708 return OFPERR_NXBRC_MUST_BE_ZERO;
4711 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4716 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4720 if (ofconn_has_pending_opgroups(ofconn)) {
4721 return OFPROTO_POSTPONE;
4724 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4725 ? OFPRAW_OFPT10_BARRIER_REPLY
4726 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4727 ofconn_send_reply(ofconn, buf);
4732 ofproto_compose_flow_refresh_update(const struct rule *rule,
4733 enum nx_flow_monitor_flags flags,
4735 OVS_REQUIRES(ofproto_mutex)
4737 struct ofoperation *op = rule->pending;
4738 const struct rule_actions *actions;
4739 struct ofputil_flow_update fu;
4742 if (op && op->type == OFOPERATION_ADD) {
4743 /* We'll report the final flow when the operation completes. Reporting
4744 * it now would cause a duplicate report later. */
4748 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4749 ? NXFME_ADDED : NXFME_MODIFIED);
4751 ovs_mutex_lock(&rule->mutex);
4752 fu.idle_timeout = rule->idle_timeout;
4753 fu.hard_timeout = rule->hard_timeout;
4754 ovs_mutex_unlock(&rule->mutex);
4755 fu.table_id = rule->table_id;
4756 fu.cookie = rule->flow_cookie;
4757 minimatch_expand(&rule->cr.match, &match);
4759 fu.priority = rule->cr.priority;
4761 if (!(flags & NXFMF_ACTIONS)) {
4764 actions = rule_get_actions(rule);
4766 /* An operation is in progress. Use the previous version of the flow's
4767 * actions, so that when the operation commits we report the change. */
4769 case OFOPERATION_ADD:
4772 case OFOPERATION_MODIFY:
4773 case OFOPERATION_REPLACE:
4774 actions = op->actions ? op->actions : rule_get_actions(rule);
4777 case OFOPERATION_DELETE:
4778 actions = rule_get_actions(rule);
4785 fu.ofpacts = actions ? actions->ofpacts : NULL;
4786 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4788 if (list_is_empty(msgs)) {
4789 ofputil_start_flow_update(msgs);
4791 ofputil_append_flow_update(&fu, msgs);
4795 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4797 OVS_REQUIRES(ofproto_mutex)
4801 for (i = 0; i < rules->n; i++) {
4802 struct rule *rule = rules->rules[i];
4803 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4804 rule->monitor_flags = 0;
4806 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4811 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4812 struct rule *rule, uint64_t seqno,
4813 struct rule_collection *rules)
4814 OVS_REQUIRES(ofproto_mutex)
4816 enum nx_flow_monitor_flags update;
4818 if (ofproto_rule_is_hidden(rule)) {
4823 ? ofoperation_has_out_port(rule->pending, m->out_port)
4824 : ofproto_rule_has_out_port(rule, m->out_port))) {
4829 if (rule->add_seqno > seqno) {
4830 update = NXFMF_ADD | NXFMF_MODIFY;
4831 } else if (rule->modify_seqno > seqno) {
4832 update = NXFMF_MODIFY;
4837 if (!(m->flags & update)) {
4841 update = NXFMF_INITIAL;
4844 if (!rule->monitor_flags) {
4845 rule_collection_add(rules, rule);
4847 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4851 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4853 struct rule_collection *rules)
4854 OVS_REQUIRES(ofproto_mutex)
4856 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4857 const struct ofoperation *op;
4858 const struct oftable *table;
4859 struct cls_rule target;
4861 cls_rule_init_from_minimatch(&target, &m->match, 0);
4862 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4863 struct cls_cursor cursor;
4866 fat_rwlock_rdlock(&table->cls.rwlock);
4867 cls_cursor_init(&cursor, &table->cls, &target);
4868 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4869 ovs_assert(!rule->pending); /* XXX */
4870 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4872 fat_rwlock_unlock(&table->cls.rwlock);
4875 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4876 struct rule *rule = op->rule;
4878 if (((m->table_id == 0xff
4879 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4880 : m->table_id == rule->table_id))
4881 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4882 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4885 cls_rule_destroy(&target);
4889 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4890 struct rule_collection *rules)
4891 OVS_REQUIRES(ofproto_mutex)
4893 if (m->flags & NXFMF_INITIAL) {
4894 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4899 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4900 uint64_t seqno, struct rule_collection *rules)
4901 OVS_REQUIRES(ofproto_mutex)
4903 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4907 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4908 OVS_EXCLUDED(ofproto_mutex)
4910 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4911 struct ofmonitor **monitors;
4912 size_t n_monitors, allocated_monitors;
4913 struct rule_collection rules;
4914 struct list replies;
4920 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4922 n_monitors = allocated_monitors = 0;
4924 ovs_mutex_lock(&ofproto_mutex);
4926 struct ofputil_flow_monitor_request request;
4927 struct ofmonitor *m;
4930 retval = ofputil_decode_flow_monitor_request(&request, &b);
4931 if (retval == EOF) {
4933 } else if (retval) {
4938 if (request.table_id != 0xff
4939 && request.table_id >= ofproto->n_tables) {
4940 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4944 error = ofmonitor_create(&request, ofconn, &m);
4949 if (n_monitors >= allocated_monitors) {
4950 monitors = x2nrealloc(monitors, &allocated_monitors,
4953 monitors[n_monitors++] = m;
4956 rule_collection_init(&rules);
4957 for (i = 0; i < n_monitors; i++) {
4958 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4961 ofpmp_init(&replies, oh);
4962 ofmonitor_compose_refresh_updates(&rules, &replies);
4963 ovs_mutex_unlock(&ofproto_mutex);
4965 rule_collection_destroy(&rules);
4967 ofconn_send_replies(ofconn, &replies);
4973 for (i = 0; i < n_monitors; i++) {
4974 ofmonitor_destroy(monitors[i]);
4977 ovs_mutex_unlock(&ofproto_mutex);
4983 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4984 OVS_EXCLUDED(ofproto_mutex)
4986 struct ofmonitor *m;
4990 id = ofputil_decode_flow_monitor_cancel(oh);
4992 ovs_mutex_lock(&ofproto_mutex);
4993 m = ofmonitor_lookup(ofconn, id);
4995 ofmonitor_destroy(m);
4998 error = OFPERR_NXBRC_FM_BAD_ID;
5000 ovs_mutex_unlock(&ofproto_mutex);
5005 /* Meters implementation.
5007 * Meter table entry, indexed by the OpenFlow meter_id.
5008 * These are always dynamically allocated to allocate enough space for
5010 * 'created' is used to compute the duration for meter stats.
5011 * 'list rules' is needed so that we can delete the dependent rules when the
5012 * meter table entry is deleted.
5013 * 'provider_meter_id' is for the provider's private use.
5016 long long int created; /* Time created. */
5017 struct list rules; /* List of "struct rule_dpif"s. */
5018 ofproto_meter_id provider_meter_id;
5019 uint16_t flags; /* Meter flags. */
5020 uint16_t n_bands; /* Number of meter bands. */
5021 struct ofputil_meter_band *bands;
5025 * This is used in instruction validation at flow set-up time,
5026 * as flows may not use non-existing meters.
5027 * Return value of UINT32_MAX signifies an invalid meter.
5030 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5032 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5033 const struct meter *meter = ofproto->meters[of_meter_id];
5035 return meter->provider_meter_id.uint32;
5042 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5046 meter->flags = config->flags;
5047 meter->n_bands = config->n_bands;
5048 meter->bands = xmemdup(config->bands,
5049 config->n_bands * sizeof *meter->bands);
5052 static struct meter *
5053 meter_create(const struct ofputil_meter_config *config,
5054 ofproto_meter_id provider_meter_id)
5056 struct meter *meter;
5058 meter = xzalloc(sizeof *meter);
5059 meter->provider_meter_id = provider_meter_id;
5060 meter->created = time_msec();
5061 list_init(&meter->rules);
5063 meter_update(meter, config);
5069 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5070 OVS_REQUIRES(ofproto_mutex)
5073 for (mid = first; mid <= last; ++mid) {
5074 struct meter *meter = ofproto->meters[mid];
5076 ofproto->meters[mid] = NULL;
5077 ofproto->ofproto_class->meter_del(ofproto,
5078 meter->provider_meter_id);
5086 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5088 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5089 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5093 return OFPERR_OFPMMFC_METER_EXISTS;
5096 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5099 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5100 *meterp = meter_create(&mm->meter, provider_meter_id);
5106 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5108 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5110 uint32_t provider_meter_id;
5113 return OFPERR_OFPMMFC_UNKNOWN_METER;
5116 provider_meter_id = meter->provider_meter_id.uint32;
5117 error = ofproto->ofproto_class->meter_set(ofproto,
5118 &meter->provider_meter_id,
5120 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5122 meter_update(meter, &mm->meter);
5128 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5129 struct ofputil_meter_mod *mm)
5130 OVS_EXCLUDED(ofproto_mutex)
5132 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5133 uint32_t meter_id = mm->meter.meter_id;
5134 struct rule_collection rules;
5135 enum ofperr error = 0;
5136 uint32_t first, last;
5138 if (meter_id == OFPM13_ALL) {
5140 last = ofproto->meter_features.max_meters;
5142 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5145 first = last = meter_id;
5148 /* First delete the rules that use this meter. If any of those rules are
5149 * currently being modified, postpone the whole operation until later. */
5150 rule_collection_init(&rules);
5151 ovs_mutex_lock(&ofproto_mutex);
5152 for (meter_id = first; meter_id <= last; ++meter_id) {
5153 struct meter *meter = ofproto->meters[meter_id];
5154 if (meter && !list_is_empty(&meter->rules)) {
5157 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5158 if (rule->pending) {
5159 error = OFPROTO_POSTPONE;
5162 rule_collection_add(&rules, rule);
5167 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5170 /* Delete the meters. */
5171 meter_delete(ofproto, first, last);
5174 ovs_mutex_unlock(&ofproto_mutex);
5175 rule_collection_destroy(&rules);
5181 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5183 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5184 struct ofputil_meter_mod mm;
5185 uint64_t bands_stub[256 / 8];
5186 struct ofpbuf bands;
5190 error = reject_slave_controller(ofconn);
5195 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5197 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5199 goto exit_free_bands;
5202 meter_id = mm.meter.meter_id;
5204 if (mm.command != OFPMC13_DELETE) {
5205 /* Fails also when meters are not implemented by the provider. */
5206 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5207 error = OFPERR_OFPMMFC_INVALID_METER;
5208 goto exit_free_bands;
5209 } else if (meter_id > ofproto->meter_features.max_meters) {
5210 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5211 goto exit_free_bands;
5213 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5214 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5215 goto exit_free_bands;
5219 switch (mm.command) {
5221 error = handle_add_meter(ofproto, &mm);
5224 case OFPMC13_MODIFY:
5225 error = handle_modify_meter(ofproto, &mm);
5228 case OFPMC13_DELETE:
5229 error = handle_delete_meter(ofconn, oh, &mm);
5233 error = OFPERR_OFPMMFC_BAD_COMMAND;
5238 ofpbuf_uninit(&bands);
5243 handle_meter_features_request(struct ofconn *ofconn,
5244 const struct ofp_header *request)
5246 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5247 struct ofputil_meter_features features;
5250 if (ofproto->ofproto_class->meter_get_features) {
5251 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5253 memset(&features, 0, sizeof features);
5255 b = ofputil_encode_meter_features_reply(&features, request);
5257 ofconn_send_reply(ofconn, b);
5262 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5265 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5266 struct list replies;
5267 uint64_t bands_stub[256 / 8];
5268 struct ofpbuf bands;
5269 uint32_t meter_id, first, last;
5271 ofputil_decode_meter_request(request, &meter_id);
5273 if (meter_id == OFPM13_ALL) {
5275 last = ofproto->meter_features.max_meters;
5277 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5278 !ofproto->meters[meter_id]) {
5279 return OFPERR_OFPMMFC_UNKNOWN_METER;
5281 first = last = meter_id;
5284 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5285 ofpmp_init(&replies, request);
5287 for (meter_id = first; meter_id <= last; ++meter_id) {
5288 struct meter *meter = ofproto->meters[meter_id];
5290 continue; /* Skip non-existing meters. */
5292 if (type == OFPTYPE_METER_STATS_REQUEST) {
5293 struct ofputil_meter_stats stats;
5295 stats.meter_id = meter_id;
5297 /* Provider sets the packet and byte counts, we do the rest. */
5298 stats.flow_count = list_size(&meter->rules);
5299 calc_duration(meter->created, time_msec(),
5300 &stats.duration_sec, &stats.duration_nsec);
5301 stats.n_bands = meter->n_bands;
5302 ofpbuf_clear(&bands);
5304 = ofpbuf_put_uninit(&bands,
5305 meter->n_bands * sizeof *stats.bands);
5307 if (!ofproto->ofproto_class->meter_get(ofproto,
5308 meter->provider_meter_id,
5310 ofputil_append_meter_stats(&replies, &stats);
5312 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5313 struct ofputil_meter_config config;
5315 config.meter_id = meter_id;
5316 config.flags = meter->flags;
5317 config.n_bands = meter->n_bands;
5318 config.bands = meter->bands;
5319 ofputil_append_meter_config(&replies, &config);
5323 ofconn_send_replies(ofconn, &replies);
5324 ofpbuf_uninit(&bands);
5329 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5330 struct ofgroup **group)
5331 OVS_TRY_RDLOCK(true, (*group)->rwlock)
5333 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5334 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5335 hash_int(group_id, 0), &ofproto->groups) {
5336 if ((*group)->group_id == group_id) {
5337 ovs_rwlock_rdlock(&(*group)->rwlock);
5338 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5342 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5347 ofproto_group_release(struct ofgroup *group)
5348 OVS_RELEASES(group->rwlock)
5350 ovs_rwlock_unlock(&group->rwlock);
5354 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
5355 struct ofgroup **group)
5356 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
5357 OVS_TRY_WRLOCK(true, (*group)->rwlock)
5359 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5360 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5361 hash_int(group_id, 0), &ofproto->groups) {
5362 if ((*group)->group_id == group_id) {
5363 ovs_rwlock_wrlock(&(*group)->rwlock);
5367 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5372 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5373 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5375 struct ofgroup *grp;
5377 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5378 hash_int(group_id, 0), &ofproto->groups) {
5379 if (grp->group_id == group_id) {
5387 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5388 OVS_EXCLUDED(ofproto->groups_rwlock)
5392 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5393 exists = ofproto_group_exists__(ofproto, group_id);
5394 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5400 group_get_ref_count(struct ofgroup *group)
5401 OVS_EXCLUDED(ofproto_mutex)
5403 struct ofproto *ofproto = group->ofproto;
5404 struct rule_criteria criteria;
5405 struct rule_collection rules;
5410 match_init_catchall(&match);
5411 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5412 OFPP_ANY, group->group_id);
5413 ovs_mutex_lock(&ofproto_mutex);
5414 error = collect_rules_loose(ofproto, &criteria, &rules);
5415 ovs_mutex_unlock(&ofproto_mutex);
5416 rule_criteria_destroy(&criteria);
5418 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5420 rule_collection_destroy(&rules);
5425 append_group_stats(struct ofgroup *group, struct list *replies)
5426 OVS_REQ_RDLOCK(group->rwlock)
5428 struct ofputil_group_stats ogs;
5429 struct ofproto *ofproto = group->ofproto;
5430 long long int now = time_msec();
5433 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5435 /* Provider sets the packet and byte counts, we do the rest. */
5436 ogs.ref_count = group_get_ref_count(group);
5437 ogs.n_buckets = group->n_buckets;
5439 error = (ofproto->ofproto_class->group_get_stats
5440 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5443 ogs.packet_count = UINT64_MAX;
5444 ogs.byte_count = UINT64_MAX;
5445 memset(ogs.bucket_stats, 0xff,
5446 ogs.n_buckets * sizeof *ogs.bucket_stats);
5449 ogs.group_id = group->group_id;
5450 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5452 ofputil_append_group_stats(replies, &ogs);
5454 free(ogs.bucket_stats);
5458 handle_group_stats_request(struct ofconn *ofconn,
5459 const struct ofp_header *request)
5461 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5462 struct list replies;
5464 struct ofgroup *group;
5467 error = ofputil_decode_group_stats_request(request, &group_id);
5472 ofpmp_init(&replies, request);
5474 if (group_id == OFPG_ALL) {
5475 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5476 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5477 ovs_rwlock_rdlock(&group->rwlock);
5478 append_group_stats(group, &replies);
5479 ovs_rwlock_unlock(&group->rwlock);
5481 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5483 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5484 append_group_stats(group, &replies);
5485 ofproto_group_release(group);
5489 ofconn_send_replies(ofconn, &replies);
5495 handle_group_desc_stats_request(struct ofconn *ofconn,
5496 const struct ofp_header *request)
5498 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5499 struct list replies;
5500 struct ofputil_group_desc gds;
5501 struct ofgroup *group;
5503 ofpmp_init(&replies, request);
5505 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5506 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5507 gds.group_id = group->group_id;
5508 gds.type = group->type;
5509 ofputil_append_group_desc_reply(&gds, &group->buckets, &replies);
5511 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5513 ofconn_send_replies(ofconn, &replies);
5519 handle_group_features_stats_request(struct ofconn *ofconn,
5520 const struct ofp_header *request)
5522 struct ofproto *p = ofconn_get_ofproto(ofconn);
5525 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5527 ofconn_send_reply(ofconn, msg);
5534 handle_queue_get_config_request(struct ofconn *ofconn,
5535 const struct ofp_header *oh)
5537 struct ofproto *p = ofconn_get_ofproto(ofconn);
5538 struct netdev_queue_dump queue_dump;
5539 struct ofport *ofport;
5540 unsigned int queue_id;
5541 struct ofpbuf *reply;
5542 struct smap details;
5546 error = ofputil_decode_queue_get_config_request(oh, &request);
5551 ofport = ofproto_get_port(p, request);
5553 return OFPERR_OFPQOFC_BAD_PORT;
5556 reply = ofputil_encode_queue_get_config_reply(oh);
5558 smap_init(&details);
5559 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5560 struct ofputil_queue_config queue;
5562 /* None of the existing queues have compatible properties, so we
5563 * hard-code omitting min_rate and max_rate. */
5564 queue.queue_id = queue_id;
5565 queue.min_rate = UINT16_MAX;
5566 queue.max_rate = UINT16_MAX;
5567 ofputil_append_queue_get_config_reply(reply, &queue);
5569 smap_destroy(&details);
5571 ofconn_send_reply(ofconn, reply);
5576 /* Implements OFPGC11_ADD
5577 * in which no matching flow already exists in the flow table.
5579 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5580 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5581 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5582 * initiated now but may be retried later.
5584 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5585 * ownership remains with the caller.
5587 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5590 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5592 struct ofgroup *ofgroup;
5595 if (gm->group_id > OFPG_MAX) {
5596 return OFPERR_OFPGMFC_INVALID_GROUP;
5598 if (gm->type > OFPGT11_FF) {
5599 return OFPERR_OFPGMFC_BAD_TYPE;
5602 /* Allocate new group and initialize it. */
5603 ofgroup = ofproto->ofproto_class->group_alloc();
5605 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
5606 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5609 ovs_rwlock_init(&ofgroup->rwlock);
5610 ofgroup->ofproto = ofproto;
5611 ofgroup->group_id = gm->group_id;
5612 ofgroup->type = gm->type;
5613 ofgroup->created = ofgroup->modified = time_msec();
5615 list_move(&ofgroup->buckets, &gm->buckets);
5616 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5618 /* Construct called BEFORE any locks are held. */
5619 error = ofproto->ofproto_class->group_construct(ofgroup);
5624 /* We wrlock as late as possible to minimize the time we jam any other
5625 * threads: No visible state changes before acquiring the lock. */
5626 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5628 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5629 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5633 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5634 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5639 /* Insert new group. */
5640 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5641 hash_int(ofgroup->group_id, 0));
5642 ofproto->n_groups[ofgroup->type]++;
5644 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5649 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5650 ofproto->ofproto_class->group_destruct(ofgroup);
5652 ofputil_bucket_list_destroy(&ofgroup->buckets);
5653 ofproto->ofproto_class->group_dealloc(ofgroup);
5658 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5661 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5664 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5666 struct ofgroup *ofgroup;
5667 struct ofgroup *victim;
5670 if (gm->group_id > OFPG_MAX) {
5671 return OFPERR_OFPGMFC_INVALID_GROUP;
5674 if (gm->type > OFPGT11_FF) {
5675 return OFPERR_OFPGMFC_BAD_TYPE;
5678 victim = ofproto->ofproto_class->group_alloc();
5680 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5681 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5684 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5685 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5688 /* Both group's and its container's write locks held now.
5689 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5690 if (ofgroup->type != gm->type
5691 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5692 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5697 list_move(&victim->buckets, &ofgroup->buckets);
5699 ofgroup->type = gm->type;
5700 list_move(&ofgroup->buckets, &gm->buckets);
5701 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5703 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5705 ofputil_bucket_list_destroy(&victim->buckets);
5706 ofproto->n_groups[victim->type]--;
5707 ofproto->n_groups[ofgroup->type]++;
5708 ofgroup->modified = time_msec();
5710 ofputil_bucket_list_destroy(&ofgroup->buckets);
5713 list_move(&ofgroup->buckets, &victim->buckets);
5717 ovs_rwlock_unlock(&ofgroup->rwlock);
5718 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5720 ofproto->ofproto_class->group_dealloc(victim);
5725 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5726 OVS_RELEASES(ofproto->groups_rwlock)
5729 struct ofputil_flow_mod fm;
5731 /* Delete all flow entries containing this group in a group action */
5732 match_init_catchall(&match);
5733 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5734 fm.out_group = ofgroup->group_id;
5735 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5737 /* Must wait until existing readers are done,
5738 * while holding the container's write lock at the same time. */
5739 ovs_rwlock_wrlock(&ofgroup->rwlock);
5740 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5741 /* No-one can find this group any more. */
5742 ofproto->n_groups[ofgroup->type]--;
5743 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5745 ofproto->ofproto_class->group_destruct(ofgroup);
5746 ofputil_bucket_list_destroy(&ofgroup->buckets);
5747 ovs_rwlock_unlock(&ofgroup->rwlock);
5748 ovs_rwlock_destroy(&ofgroup->rwlock);
5749 ofproto->ofproto_class->group_dealloc(ofgroup);
5752 /* Implements OFPGC_DELETE. */
5754 delete_group(struct ofproto *ofproto, uint32_t group_id)
5756 struct ofgroup *ofgroup;
5758 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5759 if (group_id == OFPG_ALL) {
5761 struct hmap_node *node = hmap_first(&ofproto->groups);
5765 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5766 delete_group__(ofproto, ofgroup);
5767 /* Lock for each node separately, so that we will not jam the
5768 * other threads for too long time. */
5769 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5772 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5773 hash_int(group_id, 0), &ofproto->groups) {
5774 if (ofgroup->group_id == group_id) {
5775 delete_group__(ofproto, ofgroup);
5780 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5784 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5786 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5787 struct ofputil_group_mod gm;
5790 error = reject_slave_controller(ofconn);
5795 error = ofputil_decode_group_mod(oh, &gm);
5800 switch (gm.command) {
5802 return add_group(ofproto, &gm);
5804 case OFPGC11_MODIFY:
5805 return modify_group(ofproto, &gm);
5807 case OFPGC11_DELETE:
5808 delete_group(ofproto, gm.group_id);
5812 if (gm.command > OFPGC11_DELETE) {
5813 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5814 ofproto->name, gm.command);
5816 return OFPERR_OFPGMFC_BAD_COMMAND;
5820 enum ofproto_table_config
5821 ofproto_table_get_config(const struct ofproto *ofproto, uint8_t table_id)
5824 atomic_read(&ofproto->tables[table_id].config, &value);
5825 return (enum ofproto_table_config)value;
5829 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5831 /* Only accept currently supported configurations */
5832 if (tm->config & ~OFPTC11_TABLE_MISS_MASK) {
5833 return OFPERR_OFPTMFC_BAD_CONFIG;
5836 if (tm->table_id == OFPTT_ALL) {
5838 for (i = 0; i < ofproto->n_tables; i++) {
5839 atomic_store(&ofproto->tables[i].config,
5840 (unsigned int)tm->config);
5842 } else if (!check_table_id(ofproto, tm->table_id)) {
5843 return OFPERR_OFPTMFC_BAD_TABLE;
5845 atomic_store(&ofproto->tables[tm->table_id].config,
5846 (unsigned int)tm->config);
5853 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5855 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5856 struct ofputil_table_mod tm;
5859 error = reject_slave_controller(ofconn);
5864 error = ofputil_decode_table_mod(oh, &tm);
5869 return table_mod(ofproto, &tm);
5873 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5874 OVS_EXCLUDED(ofproto_mutex)
5876 const struct ofp_header *oh = ofpbuf_data(msg);
5880 error = ofptype_decode(&type, oh);
5884 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5885 && ofpmp_more(oh)) {
5886 /* We have no buffer implementation for multipart requests.
5887 * Report overflow for requests which consists of multiple
5889 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5893 /* OpenFlow requests. */
5894 case OFPTYPE_ECHO_REQUEST:
5895 return handle_echo_request(ofconn, oh);
5897 case OFPTYPE_FEATURES_REQUEST:
5898 return handle_features_request(ofconn, oh);
5900 case OFPTYPE_GET_CONFIG_REQUEST:
5901 return handle_get_config_request(ofconn, oh);
5903 case OFPTYPE_SET_CONFIG:
5904 return handle_set_config(ofconn, oh);
5906 case OFPTYPE_PACKET_OUT:
5907 return handle_packet_out(ofconn, oh);
5909 case OFPTYPE_PORT_MOD:
5910 return handle_port_mod(ofconn, oh);
5912 case OFPTYPE_FLOW_MOD:
5913 return handle_flow_mod(ofconn, oh);
5915 case OFPTYPE_GROUP_MOD:
5916 return handle_group_mod(ofconn, oh);
5918 case OFPTYPE_TABLE_MOD:
5919 return handle_table_mod(ofconn, oh);
5921 case OFPTYPE_METER_MOD:
5922 return handle_meter_mod(ofconn, oh);
5924 case OFPTYPE_BARRIER_REQUEST:
5925 return handle_barrier_request(ofconn, oh);
5927 case OFPTYPE_ROLE_REQUEST:
5928 return handle_role_request(ofconn, oh);
5930 /* OpenFlow replies. */
5931 case OFPTYPE_ECHO_REPLY:
5934 /* Nicira extension requests. */
5935 case OFPTYPE_FLOW_MOD_TABLE_ID:
5936 return handle_nxt_flow_mod_table_id(ofconn, oh);
5938 case OFPTYPE_SET_FLOW_FORMAT:
5939 return handle_nxt_set_flow_format(ofconn, oh);
5941 case OFPTYPE_SET_PACKET_IN_FORMAT:
5942 return handle_nxt_set_packet_in_format(ofconn, oh);
5944 case OFPTYPE_SET_CONTROLLER_ID:
5945 return handle_nxt_set_controller_id(ofconn, oh);
5947 case OFPTYPE_FLOW_AGE:
5948 /* Nothing to do. */
5951 case OFPTYPE_FLOW_MONITOR_CANCEL:
5952 return handle_flow_monitor_cancel(ofconn, oh);
5954 case OFPTYPE_SET_ASYNC_CONFIG:
5955 return handle_nxt_set_async_config(ofconn, oh);
5957 case OFPTYPE_GET_ASYNC_REQUEST:
5958 return handle_nxt_get_async_request(ofconn, oh);
5960 /* Statistics requests. */
5961 case OFPTYPE_DESC_STATS_REQUEST:
5962 return handle_desc_stats_request(ofconn, oh);
5964 case OFPTYPE_FLOW_STATS_REQUEST:
5965 return handle_flow_stats_request(ofconn, oh);
5967 case OFPTYPE_AGGREGATE_STATS_REQUEST:
5968 return handle_aggregate_stats_request(ofconn, oh);
5970 case OFPTYPE_TABLE_STATS_REQUEST:
5971 return handle_table_stats_request(ofconn, oh);
5973 case OFPTYPE_PORT_STATS_REQUEST:
5974 return handle_port_stats_request(ofconn, oh);
5976 case OFPTYPE_QUEUE_STATS_REQUEST:
5977 return handle_queue_stats_request(ofconn, oh);
5979 case OFPTYPE_PORT_DESC_STATS_REQUEST:
5980 return handle_port_desc_stats_request(ofconn, oh);
5982 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
5983 return handle_flow_monitor_request(ofconn, oh);
5985 case OFPTYPE_METER_STATS_REQUEST:
5986 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
5987 return handle_meter_request(ofconn, oh, type);
5989 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
5990 return handle_meter_features_request(ofconn, oh);
5992 case OFPTYPE_GROUP_STATS_REQUEST:
5993 return handle_group_stats_request(ofconn, oh);
5995 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
5996 return handle_group_desc_stats_request(ofconn, oh);
5998 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
5999 return handle_group_features_stats_request(ofconn, oh);
6001 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6002 return handle_queue_get_config_request(ofconn, oh);
6006 case OFPTYPE_FEATURES_REPLY:
6007 case OFPTYPE_GET_CONFIG_REPLY:
6008 case OFPTYPE_PACKET_IN:
6009 case OFPTYPE_FLOW_REMOVED:
6010 case OFPTYPE_PORT_STATUS:
6011 case OFPTYPE_BARRIER_REPLY:
6012 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6013 case OFPTYPE_DESC_STATS_REPLY:
6014 case OFPTYPE_FLOW_STATS_REPLY:
6015 case OFPTYPE_QUEUE_STATS_REPLY:
6016 case OFPTYPE_PORT_STATS_REPLY:
6017 case OFPTYPE_TABLE_STATS_REPLY:
6018 case OFPTYPE_AGGREGATE_STATS_REPLY:
6019 case OFPTYPE_PORT_DESC_STATS_REPLY:
6020 case OFPTYPE_ROLE_REPLY:
6021 case OFPTYPE_FLOW_MONITOR_PAUSED:
6022 case OFPTYPE_FLOW_MONITOR_RESUMED:
6023 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6024 case OFPTYPE_GET_ASYNC_REPLY:
6025 case OFPTYPE_GROUP_STATS_REPLY:
6026 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6027 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6028 case OFPTYPE_METER_STATS_REPLY:
6029 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6030 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6031 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6032 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6033 case OFPTYPE_ROLE_STATUS:
6035 if (ofpmsg_is_stat_request(oh)) {
6036 return OFPERR_OFPBRC_BAD_STAT;
6038 return OFPERR_OFPBRC_BAD_TYPE;
6044 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6045 OVS_EXCLUDED(ofproto_mutex)
6047 int error = handle_openflow__(ofconn, ofp_msg);
6048 if (error && error != OFPROTO_POSTPONE) {
6049 ofconn_send_error(ofconn, ofpbuf_data(ofp_msg), error);
6051 COVERAGE_INC(ofproto_recv_openflow);
6052 return error != OFPROTO_POSTPONE;
6055 /* Asynchronous operations. */
6057 /* Creates and returns a new ofopgroup that is not associated with any
6058 * OpenFlow connection.
6060 * The caller should add operations to the returned group with
6061 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6062 static struct ofopgroup *
6063 ofopgroup_create_unattached(struct ofproto *ofproto)
6064 OVS_REQUIRES(ofproto_mutex)
6066 struct ofopgroup *group = xzalloc(sizeof *group);
6067 group->ofproto = ofproto;
6068 list_init(&group->ofproto_node);
6069 list_init(&group->ops);
6070 list_init(&group->ofconn_node);
6074 /* Creates and returns a new ofopgroup for 'ofproto'.
6076 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6077 * connection. The 'request' and 'buffer_id' arguments are ignored.
6079 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6080 * If the ofopgroup eventually fails, then the error reply will include
6081 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6082 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6084 * The caller should add operations to the returned group with
6085 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6086 static struct ofopgroup *
6087 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6088 const struct ofp_header *request, uint32_t buffer_id)
6089 OVS_REQUIRES(ofproto_mutex)
6091 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6093 size_t request_len = ntohs(request->length);
6095 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6097 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6098 group->ofconn = ofconn;
6099 group->request = xmemdup(request, MIN(request_len, 64));
6100 group->buffer_id = buffer_id;
6105 /* Submits 'group' for processing.
6107 * If 'group' contains no operations (e.g. none were ever added, or all of the
6108 * ones that were added completed synchronously), then it is destroyed
6109 * immediately. Otherwise it is added to the ofproto's list of pending
6112 ofopgroup_submit(struct ofopgroup *group)
6113 OVS_REQUIRES(ofproto_mutex)
6115 if (!group->n_running) {
6116 ofopgroup_complete(group);
6118 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6119 group->ofproto->n_pending++;
6124 ofopgroup_complete(struct ofopgroup *group)
6125 OVS_REQUIRES(ofproto_mutex)
6127 struct ofproto *ofproto = group->ofproto;
6129 struct ofconn *abbrev_ofconn;
6130 ovs_be32 abbrev_xid;
6132 struct ofoperation *op, *next_op;
6135 ovs_assert(!group->n_running);
6138 LIST_FOR_EACH (op, group_node, &group->ops) {
6145 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6146 LIST_FOR_EACH (op, group_node, &group->ops) {
6147 if (op->type != OFOPERATION_DELETE) {
6148 struct ofpbuf *packet;
6151 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6154 struct rule_execute *re;
6158 ofproto_rule_ref(op->rule);
6160 re = xmalloc(sizeof *re);
6161 re->rule = op->rule;
6162 re->in_port = in_port;
6163 re->packet = packet;
6165 if (!guarded_list_push_back(&ofproto->rule_executes,
6166 &re->list_node, 1024)) {
6167 ofproto_rule_unref(op->rule);
6168 ofpbuf_delete(re->packet);
6177 if (!error && !list_is_empty(&group->ofconn_node)) {
6178 abbrev_ofconn = group->ofconn;
6179 abbrev_xid = group->request->xid;
6181 abbrev_ofconn = NULL;
6182 abbrev_xid = htonl(0);
6184 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6185 struct rule *rule = op->rule;
6187 /* We generally want to report the change to active OpenFlow flow
6188 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6190 - The operation failed.
6192 - The affected rule is not visible to controllers.
6194 - The operation's only effect was to update rule->modified. */
6196 || ofproto_rule_is_hidden(rule)
6197 || (op->type == OFOPERATION_MODIFY
6199 && rule->flow_cookie == op->flow_cookie))) {
6200 /* Check that we can just cast from ofoperation_type to
6201 * nx_flow_update_event. */
6202 enum nx_flow_update_event event_type;
6205 case OFOPERATION_ADD:
6206 case OFOPERATION_REPLACE:
6207 event_type = NXFME_ADDED;
6210 case OFOPERATION_DELETE:
6211 event_type = NXFME_DELETED;
6214 case OFOPERATION_MODIFY:
6215 event_type = NXFME_MODIFIED;
6222 ofmonitor_report(ofproto->connmgr, rule, event_type,
6223 op->reason, abbrev_ofconn, abbrev_xid);
6226 rule->pending = NULL;
6229 case OFOPERATION_ADD:
6233 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6234 if (vid_mask == VLAN_VID_MASK) {
6235 if (ofproto->vlan_bitmap) {
6236 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6237 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6238 bitmap_set1(ofproto->vlan_bitmap, vid);
6239 ofproto->vlans_changed = true;
6242 ofproto->vlans_changed = true;
6246 oftable_remove_rule(rule);
6247 ofproto_rule_unref(rule);
6251 case OFOPERATION_DELETE:
6252 ovs_assert(!op->error);
6253 ofproto_rule_unref(rule);
6257 case OFOPERATION_MODIFY:
6258 case OFOPERATION_REPLACE:
6260 long long int now = time_msec();
6262 ovs_mutex_lock(&rule->mutex);
6263 rule->modified = now;
6264 if (op->type == OFOPERATION_REPLACE) {
6265 rule->created = now;
6267 ovs_mutex_unlock(&rule->mutex);
6269 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6270 ovs_mutex_lock(&rule->mutex);
6271 rule->idle_timeout = op->idle_timeout;
6272 rule->hard_timeout = op->hard_timeout;
6273 ovs_mutex_unlock(&rule->mutex);
6275 struct rule_actions *old_actions;
6277 ovs_mutex_lock(&rule->mutex);
6278 old_actions = rule_get_actions(rule);
6279 ovsrcu_set(&rule->actions, op->actions);
6280 ovs_mutex_unlock(&rule->mutex);
6283 rule_actions_destroy(old_actions);
6285 rule->flags = op->flags;
6293 ofoperation_destroy(op);
6296 ofmonitor_flush(ofproto->connmgr);
6298 if (!list_is_empty(&group->ofproto_node)) {
6299 ovs_assert(ofproto->n_pending > 0);
6300 ofproto->n_pending--;
6301 list_remove(&group->ofproto_node);
6303 if (!list_is_empty(&group->ofconn_node)) {
6304 list_remove(&group->ofconn_node);
6306 ofconn_send_error(group->ofconn, group->request, error);
6308 connmgr_retry(ofproto->connmgr);
6310 free(group->request);
6314 /* Initiates a new operation on 'rule', of the specified 'type', within
6315 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6317 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6318 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6320 * Returns the newly created ofoperation (which is also available as
6321 * rule->pending). */
6322 static struct ofoperation *
6323 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6324 enum ofoperation_type type,
6325 enum ofp_flow_removed_reason reason)
6326 OVS_REQUIRES(ofproto_mutex)
6328 struct ofproto *ofproto = group->ofproto;
6329 struct ofoperation *op;
6331 ovs_assert(!rule->pending);
6333 op = rule->pending = xzalloc(sizeof *op);
6335 list_push_back(&group->ops, &op->group_node);
6338 op->reason = reason;
6339 op->flow_cookie = rule->flow_cookie;
6340 ovs_mutex_lock(&rule->mutex);
6341 op->idle_timeout = rule->idle_timeout;
6342 op->hard_timeout = rule->hard_timeout;
6343 ovs_mutex_unlock(&rule->mutex);
6344 op->flags = rule->flags;
6348 if (type == OFOPERATION_DELETE) {
6349 hmap_insert(&ofproto->deletions, &op->hmap_node,
6350 cls_rule_hash(&rule->cr, rule->table_id));
6357 ofoperation_destroy(struct ofoperation *op)
6358 OVS_REQUIRES(ofproto_mutex)
6360 struct ofopgroup *group = op->group;
6363 op->rule->pending = NULL;
6365 if (op->type == OFOPERATION_DELETE) {
6366 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6368 list_remove(&op->group_node);
6369 rule_actions_destroy(op->actions);
6373 /* Indicates that 'op' completed with status 'error', which is either 0 to
6374 * indicate success or an OpenFlow error code on failure.
6376 * If 'error' is 0, indicating success, the operation will be committed
6377 * permanently to the flow table.
6379 * If 'error' is nonzero, then generally the operation will be rolled back:
6381 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6382 * restores the original rule. The caller must have uninitialized any
6383 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6384 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6385 * and 7 for the new rule, calling its ->rule_dealloc() function.
6387 * - If 'op' is a "modify flow" operation, ofproto restores the original
6390 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6391 * allowed to fail. It must always succeed.
6393 * Please see the large comment in ofproto/ofproto-provider.h titled
6394 * "Asynchronous Operation Support" for more information. */
6396 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6398 struct ofopgroup *group = op->group;
6400 ovs_assert(group->n_running > 0);
6401 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6404 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6405 /* This function can be called from ->rule_construct(), in which case
6406 * ofproto_mutex is held, or it can be called from ->run(), in which
6407 * case ofproto_mutex is not held. But only in the latter case can we
6408 * arrive here, so we can safely take ofproto_mutex now. */
6409 ovs_mutex_lock(&ofproto_mutex);
6410 ovs_assert(op->rule->pending == op);
6411 ofopgroup_complete(group);
6412 ovs_mutex_unlock(&ofproto_mutex);
6417 pick_datapath_id(const struct ofproto *ofproto)
6419 const struct ofport *port;
6421 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6423 uint8_t ea[ETH_ADDR_LEN];
6426 error = netdev_get_etheraddr(port->netdev, ea);
6428 return eth_addr_to_uint64(ea);
6430 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6431 ofproto->name, netdev_get_name(port->netdev),
6432 ovs_strerror(error));
6434 return ofproto->fallback_dpid;
6438 pick_fallback_dpid(void)
6440 uint8_t ea[ETH_ADDR_LEN];
6441 eth_addr_nicira_random(ea);
6442 return eth_addr_to_uint64(ea);
6445 /* Table overflow policy. */
6447 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6448 * to NULL if the table is not configured to evict rules or if the table
6449 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6450 * or with no timeouts are not evictable.) */
6452 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6453 OVS_REQUIRES(ofproto_mutex)
6455 struct eviction_group *evg;
6458 if (!table->eviction_fields) {
6462 /* In the common case, the outer and inner loops here will each be entered
6465 * - The inner loop normally "return"s in its first iteration. If the
6466 * eviction group has any evictable rules, then it always returns in
6469 * - The outer loop only iterates more than once if the largest eviction
6470 * group has no evictable rules.
6472 * - The outer loop can exit only if table's 'max_flows' is all filled up
6473 * by unevictable rules. */
6474 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6477 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6486 /* Searches 'ofproto' for tables that have more flows than their configured
6487 * maximum and that have flow eviction enabled, and evicts as many flows as
6488 * necessary and currently feasible from them.
6490 * This triggers only when an OpenFlow table has N flows in it and then the
6491 * client configures a maximum number of flows less than N. */
6493 ofproto_evict(struct ofproto *ofproto)
6495 struct oftable *table;
6497 ovs_mutex_lock(&ofproto_mutex);
6498 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6499 evict_rules_from_table(ofproto, table, 0);
6501 ovs_mutex_unlock(&ofproto_mutex);
6504 /* Eviction groups. */
6506 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6507 * rules. The priority contains low-order random bits to ensure that eviction
6508 * groups with the same number of rules are prioritized randomly. */
6510 eviction_group_priority(size_t n_rules)
6512 uint16_t size = MIN(UINT16_MAX, n_rules);
6513 return (size << 16) | random_uint16();
6516 /* Updates 'evg', an eviction_group within 'table', following a change that
6517 * adds or removes rules in 'evg'. */
6519 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6520 OVS_REQUIRES(ofproto_mutex)
6522 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6523 eviction_group_priority(heap_count(&evg->rules)));
6526 /* Destroys 'evg', an eviction_group within 'table':
6528 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6529 * rules themselves, just removes them from the eviction group.)
6531 * - Removes 'evg' from 'table'.
6535 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6536 OVS_REQUIRES(ofproto_mutex)
6538 while (!heap_is_empty(&evg->rules)) {
6541 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6542 rule->eviction_group = NULL;
6544 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6545 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6546 heap_destroy(&evg->rules);
6550 /* Removes 'rule' from its eviction group, if any. */
6552 eviction_group_remove_rule(struct rule *rule)
6553 OVS_REQUIRES(ofproto_mutex)
6555 if (rule->eviction_group) {
6556 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6557 struct eviction_group *evg = rule->eviction_group;
6559 rule->eviction_group = NULL;
6560 heap_remove(&evg->rules, &rule->evg_node);
6561 if (heap_is_empty(&evg->rules)) {
6562 eviction_group_destroy(table, evg);
6564 eviction_group_resized(table, evg);
6569 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6570 * returns the hash value. */
6572 eviction_group_hash_rule(struct rule *rule)
6573 OVS_REQUIRES(ofproto_mutex)
6575 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6576 const struct mf_subfield *sf;
6580 hash = table->eviction_group_id_basis;
6581 miniflow_expand(&rule->cr.match.flow, &flow);
6582 for (sf = table->eviction_fields;
6583 sf < &table->eviction_fields[table->n_eviction_fields];
6586 if (mf_are_prereqs_ok(sf->field, &flow)) {
6587 union mf_value value;
6589 mf_get_value(sf->field, &flow, &value);
6591 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6593 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6594 unsigned int start = sf->ofs + sf->n_bits;
6595 bitwise_zero(&value, sf->field->n_bytes, start,
6596 sf->field->n_bytes * 8 - start);
6598 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6600 hash = hash_int(hash, 0);
6607 /* Returns an eviction group within 'table' with the given 'id', creating one
6609 static struct eviction_group *
6610 eviction_group_find(struct oftable *table, uint32_t id)
6611 OVS_REQUIRES(ofproto_mutex)
6613 struct eviction_group *evg;
6615 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6619 evg = xmalloc(sizeof *evg);
6620 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6621 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6622 eviction_group_priority(0));
6623 heap_init(&evg->rules);
6628 /* Returns an eviction priority for 'rule'. The return value should be
6629 * interpreted so that higher priorities make a rule more attractive candidates
6631 * Called only if have a timeout. */
6633 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6634 OVS_REQUIRES(ofproto_mutex)
6636 long long int expiration = LLONG_MAX;
6637 long long int modified;
6638 uint32_t expiration_offset;
6640 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6641 ovs_mutex_lock(&rule->mutex);
6642 modified = rule->modified;
6643 ovs_mutex_unlock(&rule->mutex);
6645 if (rule->hard_timeout) {
6646 expiration = modified + rule->hard_timeout * 1000;
6648 if (rule->idle_timeout) {
6649 uint64_t packets, bytes;
6651 long long int idle_expiration;
6653 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6654 idle_expiration = used + rule->idle_timeout * 1000;
6655 expiration = MIN(expiration, idle_expiration);
6658 if (expiration == LLONG_MAX) {
6662 /* Calculate the time of expiration as a number of (approximate) seconds
6663 * after program startup.
6665 * This should work OK for program runs that last UINT32_MAX seconds or
6666 * less. Therefore, please restart OVS at least once every 136 years. */
6667 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6669 /* Invert the expiration offset because we're using a max-heap. */
6670 return UINT32_MAX - expiration_offset;
6673 /* Adds 'rule' to an appropriate eviction group for its oftable's
6674 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6675 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6678 * The caller must ensure that 'rule' is not already in an eviction group. */
6680 eviction_group_add_rule(struct rule *rule)
6681 OVS_REQUIRES(ofproto_mutex)
6683 struct ofproto *ofproto = rule->ofproto;
6684 struct oftable *table = &ofproto->tables[rule->table_id];
6687 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6688 * so no additional protection is needed. */
6689 has_timeout = rule->hard_timeout || rule->idle_timeout;
6691 if (table->eviction_fields && has_timeout) {
6692 struct eviction_group *evg;
6694 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6696 rule->eviction_group = evg;
6697 heap_insert(&evg->rules, &rule->evg_node,
6698 rule_eviction_priority(ofproto, rule));
6699 eviction_group_resized(table, evg);
6705 /* Initializes 'table'. */
6707 oftable_init(struct oftable *table)
6709 memset(table, 0, sizeof *table);
6710 classifier_init(&table->cls, flow_segment_u32s);
6711 table->max_flows = UINT_MAX;
6712 atomic_init(&table->config, (unsigned int)OFPROTO_TABLE_MISS_DEFAULT);
6715 /* Destroys 'table', including its classifier and eviction groups.
6717 * The caller is responsible for freeing 'table' itself. */
6719 oftable_destroy(struct oftable *table)
6721 fat_rwlock_rdlock(&table->cls.rwlock);
6722 ovs_assert(classifier_is_empty(&table->cls));
6723 fat_rwlock_unlock(&table->cls.rwlock);
6724 oftable_disable_eviction(table);
6725 classifier_destroy(&table->cls);
6729 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6730 * string, then 'table' will use its default name.
6732 * This only affects the name exposed for a table exposed through the OpenFlow
6733 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6735 oftable_set_name(struct oftable *table, const char *name)
6737 if (name && name[0]) {
6738 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6739 if (!table->name || strncmp(name, table->name, len)) {
6741 table->name = xmemdup0(name, len);
6749 /* oftables support a choice of two policies when adding a rule would cause the
6750 * number of flows in the table to exceed the configured maximum number: either
6751 * they can refuse to add the new flow or they can evict some existing flow.
6752 * This function configures the former policy on 'table'. */
6754 oftable_disable_eviction(struct oftable *table)
6755 OVS_REQUIRES(ofproto_mutex)
6757 if (table->eviction_fields) {
6758 struct eviction_group *evg, *next;
6760 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6761 &table->eviction_groups_by_id) {
6762 eviction_group_destroy(table, evg);
6764 hmap_destroy(&table->eviction_groups_by_id);
6765 heap_destroy(&table->eviction_groups_by_size);
6767 free(table->eviction_fields);
6768 table->eviction_fields = NULL;
6769 table->n_eviction_fields = 0;
6773 /* oftables support a choice of two policies when adding a rule would cause the
6774 * number of flows in the table to exceed the configured maximum number: either
6775 * they can refuse to add the new flow or they can evict some existing flow.
6776 * This function configures the latter policy on 'table', with fairness based
6777 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6778 * 'n_fields' as 0 disables fairness.) */
6780 oftable_enable_eviction(struct oftable *table,
6781 const struct mf_subfield *fields, size_t n_fields)
6782 OVS_REQUIRES(ofproto_mutex)
6784 struct cls_cursor cursor;
6787 if (table->eviction_fields
6788 && n_fields == table->n_eviction_fields
6790 || !memcmp(fields, table->eviction_fields,
6791 n_fields * sizeof *fields))) {
6796 oftable_disable_eviction(table);
6798 table->n_eviction_fields = n_fields;
6799 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6801 table->eviction_group_id_basis = random_uint32();
6802 hmap_init(&table->eviction_groups_by_id);
6803 heap_init(&table->eviction_groups_by_size);
6805 fat_rwlock_rdlock(&table->cls.rwlock);
6806 cls_cursor_init(&cursor, &table->cls, NULL);
6807 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6808 eviction_group_add_rule(rule);
6810 fat_rwlock_unlock(&table->cls.rwlock);
6813 /* Removes 'rule' from the oftable that contains it. */
6815 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6816 OVS_REQUIRES(ofproto_mutex)
6818 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6820 fat_rwlock_wrlock(&cls->rwlock);
6821 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6822 fat_rwlock_unlock(&cls->rwlock);
6824 cookies_remove(ofproto, rule);
6826 eviction_group_remove_rule(rule);
6827 if (!list_is_empty(&rule->expirable)) {
6828 list_remove(&rule->expirable);
6830 if (!list_is_empty(&rule->meter_list_node)) {
6831 list_remove(&rule->meter_list_node);
6832 list_init(&rule->meter_list_node);
6837 oftable_remove_rule(struct rule *rule)
6838 OVS_REQUIRES(ofproto_mutex)
6840 oftable_remove_rule__(rule->ofproto, rule);
6843 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6844 * the same cls_rule. */
6846 oftable_insert_rule(struct rule *rule)
6847 OVS_REQUIRES(ofproto_mutex)
6849 struct ofproto *ofproto = rule->ofproto;
6850 struct oftable *table = &ofproto->tables[rule->table_id];
6851 struct rule_actions *actions;
6854 ovs_mutex_lock(&rule->mutex);
6855 may_expire = rule->hard_timeout || rule->idle_timeout;
6856 ovs_mutex_unlock(&rule->mutex);
6859 list_insert(&ofproto->expirable, &rule->expirable);
6862 cookies_insert(ofproto, rule);
6864 actions = rule_get_actions(rule);
6865 if (actions->provider_meter_id != UINT32_MAX) {
6866 uint32_t meter_id = ofpacts_get_meter(actions->ofpacts,
6867 actions->ofpacts_len);
6868 struct meter *meter = ofproto->meters[meter_id];
6869 list_insert(&meter->rules, &rule->meter_list_node);
6871 fat_rwlock_wrlock(&table->cls.rwlock);
6872 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6873 fat_rwlock_unlock(&table->cls.rwlock);
6874 eviction_group_add_rule(rule);
6877 /* unixctl commands. */
6880 ofproto_lookup(const char *name)
6882 struct ofproto *ofproto;
6884 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6886 if (!strcmp(ofproto->name, name)) {
6894 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6895 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6897 struct ofproto *ofproto;
6901 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6902 ds_put_format(&results, "%s\n", ofproto->name);
6904 unixctl_command_reply(conn, ds_cstr(&results));
6905 ds_destroy(&results);
6909 ofproto_unixctl_init(void)
6911 static bool registered;
6917 unixctl_command_register("ofproto/list", "", 0, 0,
6918 ofproto_unixctl_list, NULL);
6921 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6923 * This is deprecated. It is only for compatibility with broken device drivers
6924 * in old versions of Linux that do not properly support VLANs when VLAN
6925 * devices are not used. When broken device drivers are no longer in
6926 * widespread use, we will delete these interfaces. */
6928 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6929 * (exactly) by an OpenFlow rule in 'ofproto'. */
6931 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6933 const struct oftable *oftable;
6935 free(ofproto->vlan_bitmap);
6936 ofproto->vlan_bitmap = bitmap_allocate(4096);
6937 ofproto->vlans_changed = false;
6939 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6940 const struct cls_subtable *table;
6942 fat_rwlock_rdlock(&oftable->cls.rwlock);
6943 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.subtables) {
6944 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
6945 const struct cls_rule *rule;
6947 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
6948 uint16_t vid = miniflow_get_vid(&rule->match.flow);
6949 bitmap_set1(vlan_bitmap, vid);
6950 bitmap_set1(ofproto->vlan_bitmap, vid);
6954 fat_rwlock_unlock(&oftable->cls.rwlock);
6958 /* Returns true if new VLANs have come into use by the flow table since the
6959 * last call to ofproto_get_vlan_usage().
6961 * We don't track when old VLANs stop being used. */
6963 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
6965 return ofproto->vlans_changed;
6968 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6969 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6970 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6971 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6972 * then the VLAN device is un-enslaved. */
6974 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
6975 ofp_port_t realdev_ofp_port, int vid)
6977 struct ofport *ofport;
6980 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
6982 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
6984 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
6985 ofproto->name, vlandev_ofp_port);
6989 if (!ofproto->ofproto_class->set_realdev) {
6990 if (!vlandev_ofp_port) {
6993 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
6997 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
6999 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7000 ofproto->name, vlandev_ofp_port,
7001 netdev_get_name(ofport->netdev), ovs_strerror(error));