2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
50 #include "poll-loop.h"
58 #include "unaligned.h"
63 VLOG_DEFINE_THIS_MODULE(ofproto);
65 COVERAGE_DEFINE(ofproto_flush);
66 COVERAGE_DEFINE(ofproto_packet_out);
67 COVERAGE_DEFINE(ofproto_queue_req);
68 COVERAGE_DEFINE(ofproto_recv_openflow);
69 COVERAGE_DEFINE(ofproto_reinit_ports);
70 COVERAGE_DEFINE(ofproto_update_port);
72 /* Default fields to use for prefix tries in each flow table, unless something
73 * else is configured. */
74 const enum mf_field_id default_prefix_fields[2] =
75 { MFF_IPV4_DST, MFF_IPV4_SRC };
78 S_OPENFLOW, /* Processing OpenFlow commands. */
79 S_EVICT, /* Evicting flows from over-limit tables. */
80 S_FLUSH, /* Deleting all flow table rules. */
83 enum ofoperation_type {
90 /* A single OpenFlow request can execute any number of operations. The
91 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
92 * ofconn to which an error reply should be sent if necessary.
94 * ofproto initiates some operations internally. These operations are still
95 * assigned to groups but will not have an associated ofconn. */
97 struct ofproto *ofproto; /* Owning ofproto. */
98 struct list ofproto_node; /* In ofproto's "pending" list. */
99 struct list ops; /* List of "struct ofoperation"s. */
100 int n_running; /* Number of ops still pending. */
102 /* Data needed to send OpenFlow reply on failure or to send a buffered
105 * If list_is_empty(ofconn_node) then this ofopgroup never had an
106 * associated ofconn or its ofconn's connection dropped after it initiated
107 * the operation. In the latter case 'ofconn' is a wild pointer that
108 * refers to freed memory, so the 'ofconn' member must be used only if
109 * !list_is_empty(ofconn_node).
111 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
112 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
113 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
114 uint32_t buffer_id; /* Buffer id from original request. */
117 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
118 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
119 const struct ofp_header *,
121 static void ofopgroup_submit(struct ofopgroup *);
122 static void ofopgroup_complete(struct ofopgroup *);
124 /* A single flow table operation. */
126 struct ofopgroup *group; /* Owning group. */
127 struct list group_node; /* In ofopgroup's "ops" list. */
128 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
129 struct rule *rule; /* Rule being operated upon. */
130 enum ofoperation_type type; /* Type of operation. */
132 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
134 const struct rule_actions *actions;
136 /* OFOPERATION_DELETE. */
137 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
139 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
140 uint16_t idle_timeout; /* Rule's old idle timeout. */
141 uint16_t hard_timeout; /* Rule's old hard timeout. */
142 enum ofputil_flow_mod_flags flags; /* Rule's old flags. */
143 enum ofperr error; /* 0 if no error. */
146 static struct ofoperation *ofoperation_create(struct ofopgroup *,
148 enum ofoperation_type,
149 enum ofp_flow_removed_reason);
150 static void ofoperation_destroy(struct ofoperation *);
153 static void oftable_init(struct oftable *);
154 static void oftable_destroy(struct oftable *);
156 static void oftable_set_name(struct oftable *, const char *name);
158 static void oftable_disable_eviction(struct oftable *);
159 static void oftable_enable_eviction(struct oftable *,
160 const struct mf_subfield *fields,
163 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
164 static void oftable_remove_rule__(struct ofproto *, struct rule *)
165 OVS_REQUIRES(ofproto_mutex);
166 static void oftable_insert_rule(struct rule *);
168 /* A set of rules within a single OpenFlow table (oftable) that have the same
169 * values for the oftable's eviction_fields. A rule to be evicted, when one is
170 * needed, is taken from the eviction group that contains the greatest number
173 * An oftable owns any number of eviction groups, each of which contains any
176 * Membership in an eviction group is imprecise, based on the hash of the
177 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
178 * That is, if two rules have different eviction_fields, but those
179 * eviction_fields hash to the same value, then they will belong to the same
180 * eviction_group anyway.
182 * (When eviction is not enabled on an oftable, we don't track any eviction
183 * groups, to save time and space.) */
184 struct eviction_group {
185 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
186 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
187 struct heap rules; /* Contains "struct rule"s. */
190 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep);
191 static void ofproto_evict(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
192 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *);
193 static void eviction_group_add_rule(struct rule *);
194 static void eviction_group_remove_rule(struct rule *);
196 /* Criteria that flow_mod and other operations use for selecting rules on
197 * which to operate. */
198 struct rule_criteria {
199 /* An OpenFlow table or 255 for all tables. */
202 /* OpenFlow matching criteria. Interpreted different in "loose" way by
203 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
204 * defined in the OpenFlow spec. */
207 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
208 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
209 * The rule will not be selected if M is 1 and B != C. */
211 ovs_be64 cookie_mask;
213 /* Selection based on actions within a rule:
215 * If out_port != OFPP_ANY, selects only rules that output to out_port.
216 * If out_group != OFPG_ALL, select only rules that output to out_group. */
221 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
222 const struct match *match,
223 unsigned int priority,
224 ovs_be64 cookie, ovs_be64 cookie_mask,
225 ofp_port_t out_port, uint32_t out_group);
226 static void rule_criteria_destroy(struct rule_criteria *);
228 /* A packet that needs to be passed to rule_execute().
230 * (We can't do this immediately from ofopgroup_complete() because that holds
231 * ofproto_mutex, which rule_execute() needs released.) */
232 struct rule_execute {
233 struct list list_node; /* In struct ofproto's "rule_executes" list. */
234 struct rule *rule; /* Owns a reference to the rule. */
236 struct ofpbuf *packet; /* Owns the packet. */
239 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
240 static void destroy_rule_executes(struct ofproto *);
243 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
244 static void ofport_destroy(struct ofport *);
246 static void update_port(struct ofproto *, const char *devname);
247 static int init_ports(struct ofproto *);
248 static void reinit_ports(struct ofproto *);
250 static long long int ofport_get_usage(const struct ofproto *,
251 ofp_port_t ofp_port);
252 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
253 long long int last_used);
254 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
258 * Keeps track of the currently used and recently used ofport values and is
259 * used to prevent immediate recycling of ofport values. */
260 struct ofport_usage {
261 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
262 ofp_port_t ofp_port; /* OpenFlow port number. */
263 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
264 represents in-use ofports. */
268 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
269 static bool rule_is_modifiable(const struct rule *rule,
270 enum ofputil_flow_mod_flags flag);
273 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
274 struct ofputil_flow_mod *,
275 const struct ofp_header *);
276 static void do_add_flow(struct ofproto *, struct ofconn *,
277 const struct ofp_header *request, uint32_t buffer_id,
279 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
280 struct ofputil_flow_mod *,
281 const struct ofp_header *,
282 const struct rule_collection *);
283 static void delete_flow__(struct rule *rule, struct ofopgroup *,
284 enum ofp_flow_removed_reason)
285 OVS_REQUIRES(ofproto_mutex);
286 static bool ofproto_group_exists__(const struct ofproto *ofproto,
288 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
289 static bool ofproto_group_exists(const struct ofproto *ofproto,
291 OVS_EXCLUDED(ofproto->groups_rwlock);
292 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
293 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
294 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
295 struct ofputil_flow_mod *,
296 const struct ofp_header *)
297 OVS_EXCLUDED(ofproto_mutex);
298 static void calc_duration(long long int start, long long int now,
299 uint32_t *sec, uint32_t *nsec);
302 static uint64_t pick_datapath_id(const struct ofproto *);
303 static uint64_t pick_fallback_dpid(void);
304 static void ofproto_destroy__(struct ofproto *);
305 static void update_mtu(struct ofproto *, struct ofport *);
306 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
309 static void ofproto_unixctl_init(void);
311 /* All registered ofproto classes, in probe order. */
312 static const struct ofproto_class **ofproto_classes;
313 static size_t n_ofproto_classes;
314 static size_t allocated_ofproto_classes;
316 /* Global lock that protects all flow table operations. */
317 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
319 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
320 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
322 size_t n_handlers, n_revalidators;
324 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
325 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
327 /* Initial mappings of port to OpenFlow number mappings. */
328 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
330 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
332 /* The default value of true waits for flow restore. */
333 static bool flow_restore_wait = true;
335 /* Must be called to initialize the ofproto library.
337 * The caller may pass in 'iface_hints', which contains an shash of
338 * "iface_hint" elements indexed by the interface's name. The provider
339 * may use these hints to describe the startup configuration in order to
340 * reinitialize its state. The caller owns the provided data, so a
341 * provider will make copies of anything required. An ofproto provider
342 * will remove any existing state that is not described by the hint, and
343 * may choose to remove it all. */
345 ofproto_init(const struct shash *iface_hints)
347 struct shash_node *node;
350 ofproto_class_register(&ofproto_dpif_class);
352 /* Make a local copy, since we don't own 'iface_hints' elements. */
353 SHASH_FOR_EACH(node, iface_hints) {
354 const struct iface_hint *orig_hint = node->data;
355 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
356 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
358 new_hint->br_name = xstrdup(orig_hint->br_name);
359 new_hint->br_type = xstrdup(br_type);
360 new_hint->ofp_port = orig_hint->ofp_port;
362 shash_add(&init_ofp_ports, node->name, new_hint);
365 for (i = 0; i < n_ofproto_classes; i++) {
366 ofproto_classes[i]->init(&init_ofp_ports);
370 /* 'type' should be a normalized datapath type, as returned by
371 * ofproto_normalize_type(). Returns the corresponding ofproto_class
372 * structure, or a null pointer if there is none registered for 'type'. */
373 static const struct ofproto_class *
374 ofproto_class_find__(const char *type)
378 for (i = 0; i < n_ofproto_classes; i++) {
379 const struct ofproto_class *class = ofproto_classes[i];
384 class->enumerate_types(&types);
385 found = sset_contains(&types, type);
386 sset_destroy(&types);
392 VLOG_WARN("unknown datapath type %s", type);
396 /* Registers a new ofproto class. After successful registration, new ofprotos
397 * of that type can be created using ofproto_create(). */
399 ofproto_class_register(const struct ofproto_class *new_class)
403 for (i = 0; i < n_ofproto_classes; i++) {
404 if (ofproto_classes[i] == new_class) {
409 if (n_ofproto_classes >= allocated_ofproto_classes) {
410 ofproto_classes = x2nrealloc(ofproto_classes,
411 &allocated_ofproto_classes,
412 sizeof *ofproto_classes);
414 ofproto_classes[n_ofproto_classes++] = new_class;
418 /* Unregisters a datapath provider. 'type' must have been previously
419 * registered and not currently be in use by any ofprotos. After
420 * unregistration new datapaths of that type cannot be opened using
421 * ofproto_create(). */
423 ofproto_class_unregister(const struct ofproto_class *class)
427 for (i = 0; i < n_ofproto_classes; i++) {
428 if (ofproto_classes[i] == class) {
429 for (i++; i < n_ofproto_classes; i++) {
430 ofproto_classes[i - 1] = ofproto_classes[i];
436 VLOG_WARN("attempted to unregister an ofproto class that is not "
441 /* Clears 'types' and enumerates all registered ofproto types into it. The
442 * caller must first initialize the sset. */
444 ofproto_enumerate_types(struct sset *types)
449 for (i = 0; i < n_ofproto_classes; i++) {
450 ofproto_classes[i]->enumerate_types(types);
454 /* Returns the fully spelled out name for the given ofproto 'type'.
456 * Normalized type string can be compared with strcmp(). Unnormalized type
457 * string might be the same even if they have different spellings. */
459 ofproto_normalize_type(const char *type)
461 return type && type[0] ? type : "system";
464 /* Clears 'names' and enumerates the names of all known created ofprotos with
465 * the given 'type'. The caller must first initialize the sset. Returns 0 if
466 * successful, otherwise a positive errno value.
468 * Some kinds of datapaths might not be practically enumerable. This is not
469 * considered an error. */
471 ofproto_enumerate_names(const char *type, struct sset *names)
473 const struct ofproto_class *class = ofproto_class_find__(type);
474 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
478 ofproto_create(const char *datapath_name, const char *datapath_type,
479 struct ofproto **ofprotop)
481 const struct ofproto_class *class;
482 struct ofproto *ofproto;
488 ofproto_unixctl_init();
490 datapath_type = ofproto_normalize_type(datapath_type);
491 class = ofproto_class_find__(datapath_type);
493 VLOG_WARN("could not create datapath %s of unknown type %s",
494 datapath_name, datapath_type);
498 ofproto = class->alloc();
500 VLOG_ERR("failed to allocate datapath %s of type %s",
501 datapath_name, datapath_type);
506 ovs_mutex_lock(&ofproto_mutex);
507 memset(ofproto, 0, sizeof *ofproto);
508 ofproto->ofproto_class = class;
509 ofproto->name = xstrdup(datapath_name);
510 ofproto->type = xstrdup(datapath_type);
511 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
512 hash_string(ofproto->name, 0));
513 ofproto->datapath_id = 0;
514 ofproto->forward_bpdu = false;
515 ofproto->fallback_dpid = pick_fallback_dpid();
516 ofproto->mfr_desc = NULL;
517 ofproto->hw_desc = NULL;
518 ofproto->sw_desc = NULL;
519 ofproto->serial_desc = NULL;
520 ofproto->dp_desc = NULL;
521 ofproto->frag_handling = OFPC_FRAG_NORMAL;
522 hmap_init(&ofproto->ports);
523 hmap_init(&ofproto->ofport_usage);
524 shash_init(&ofproto->port_by_name);
525 simap_init(&ofproto->ofp_requests);
526 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
527 ofproto->eviction_group_timer = LLONG_MIN;
528 ofproto->tables = NULL;
529 ofproto->n_tables = 0;
530 hindex_init(&ofproto->cookies);
531 list_init(&ofproto->expirable);
532 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
533 ofproto->state = S_OPENFLOW;
534 list_init(&ofproto->pending);
535 ofproto->n_pending = 0;
536 hmap_init(&ofproto->deletions);
537 guarded_list_init(&ofproto->rule_executes);
538 ofproto->vlan_bitmap = NULL;
539 ofproto->vlans_changed = false;
540 ofproto->min_mtu = INT_MAX;
541 ovs_rwlock_init(&ofproto->groups_rwlock);
542 hmap_init(&ofproto->groups);
543 ovs_mutex_unlock(&ofproto_mutex);
544 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
545 OFPGFC_SELECT_WEIGHT;
546 ofproto->ogf.max_groups[OFPGT11_ALL] = OFPG_MAX;
547 ofproto->ogf.max_groups[OFPGT11_SELECT] = OFPG_MAX;
548 ofproto->ogf.max_groups[OFPGT11_INDIRECT] = OFPG_MAX;
549 ofproto->ogf.max_groups[OFPGT11_FF] = OFPG_MAX;
550 ofproto->ogf.actions[0] =
551 (1 << OFPAT11_OUTPUT) |
552 (1 << OFPAT11_COPY_TTL_OUT) |
553 (1 << OFPAT11_COPY_TTL_IN) |
554 (1 << OFPAT11_SET_MPLS_TTL) |
555 (1 << OFPAT11_DEC_MPLS_TTL) |
556 (1 << OFPAT11_PUSH_VLAN) |
557 (1 << OFPAT11_POP_VLAN) |
558 (1 << OFPAT11_PUSH_MPLS) |
559 (1 << OFPAT11_POP_MPLS) |
560 (1 << OFPAT11_SET_QUEUE) |
561 (1 << OFPAT11_GROUP) |
562 (1 << OFPAT11_SET_NW_TTL) |
563 (1 << OFPAT11_DEC_NW_TTL) |
564 (1 << OFPAT12_SET_FIELD);
566 * (1 << OFPAT13_PUSH_PBB) |
567 * (1 << OFPAT13_POP_PBB) */
569 error = ofproto->ofproto_class->construct(ofproto);
571 VLOG_ERR("failed to open datapath %s: %s",
572 datapath_name, ovs_strerror(error));
573 ofproto_destroy__(ofproto);
577 /* Check that hidden tables, if any, are at the end. */
578 ovs_assert(ofproto->n_tables);
579 for (i = 0; i + 1 < ofproto->n_tables; i++) {
580 enum oftable_flags flags = ofproto->tables[i].flags;
581 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
583 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
586 ofproto->datapath_id = pick_datapath_id(ofproto);
589 /* Initialize meters table. */
590 if (ofproto->ofproto_class->meter_get_features) {
591 ofproto->ofproto_class->meter_get_features(ofproto,
592 &ofproto->meter_features);
594 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
596 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
597 * sizeof(struct meter *));
603 /* Must be called (only) by an ofproto implementation in its constructor
604 * function. See the large comment on 'construct' in struct ofproto_class for
607 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
609 struct oftable *table;
611 ovs_assert(!ofproto->n_tables);
612 ovs_assert(n_tables >= 1 && n_tables <= 255);
614 ofproto->n_tables = n_tables;
615 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
616 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
621 /* To be optionally called (only) by an ofproto implementation in its
622 * constructor function. See the large comment on 'construct' in struct
623 * ofproto_class for details.
625 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
626 * will then ensure that actions passed into the ofproto implementation will
627 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
628 * function is not called, there will be no such restriction.
630 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
631 * the 'max_ports' restriction. */
633 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
635 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
636 ofproto->max_ports = max_ports;
640 ofproto_get_datapath_id(const struct ofproto *ofproto)
642 return ofproto->datapath_id;
646 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
648 uint64_t old_dpid = p->datapath_id;
649 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
650 if (p->datapath_id != old_dpid) {
651 /* Force all active connections to reconnect, since there is no way to
652 * notify a controller that the datapath ID has changed. */
653 ofproto_reconnect_controllers(p);
658 ofproto_set_controllers(struct ofproto *p,
659 const struct ofproto_controller *controllers,
660 size_t n_controllers, uint32_t allowed_versions)
662 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
667 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
669 connmgr_set_fail_mode(p->connmgr, fail_mode);
672 /* Drops the connections between 'ofproto' and all of its controllers, forcing
673 * them to reconnect. */
675 ofproto_reconnect_controllers(struct ofproto *ofproto)
677 connmgr_reconnect(ofproto->connmgr);
680 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
681 * in-band control should guarantee access, in the same way that in-band
682 * control guarantees access to OpenFlow controllers. */
684 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
685 const struct sockaddr_in *extras, size_t n)
687 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
690 /* Sets the OpenFlow queue used by flows set up by in-band control on
691 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
692 * flows will use the default queue. */
694 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
696 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
699 /* Sets the number of flows at which eviction from the kernel flow table
702 ofproto_set_flow_limit(unsigned limit)
704 ofproto_flow_limit = limit;
707 /* Sets the maximum idle time for flows in the datapath before they are
710 ofproto_set_max_idle(unsigned max_idle)
712 ofproto_max_idle = max_idle;
715 /* If forward_bpdu is true, the NORMAL action will forward frames with
716 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
717 * the NORMAL action will drop these frames. */
719 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
721 bool old_val = ofproto->forward_bpdu;
722 ofproto->forward_bpdu = forward_bpdu;
723 if (old_val != ofproto->forward_bpdu) {
724 if (ofproto->ofproto_class->forward_bpdu_changed) {
725 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
730 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
731 * 'idle_time', in seconds, and the maximum number of MAC table entries to
734 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
737 if (ofproto->ofproto_class->set_mac_table_config) {
738 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
744 ofproto_set_threads(int n_handlers_, int n_revalidators_)
746 int threads = MAX(count_cpu_cores(), 2);
748 n_revalidators = MAX(n_revalidators_, 0);
749 n_handlers = MAX(n_handlers_, 0);
751 if (!n_revalidators) {
752 n_revalidators = n_handlers
753 ? MAX(threads - (int) n_handlers, 1)
758 n_handlers = MAX(threads - (int) n_revalidators, 1);
763 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
766 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
770 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
772 return connmgr_set_snoops(ofproto->connmgr, snoops);
776 ofproto_set_netflow(struct ofproto *ofproto,
777 const struct netflow_options *nf_options)
779 if (nf_options && sset_is_empty(&nf_options->collectors)) {
783 if (ofproto->ofproto_class->set_netflow) {
784 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
786 return nf_options ? EOPNOTSUPP : 0;
791 ofproto_set_sflow(struct ofproto *ofproto,
792 const struct ofproto_sflow_options *oso)
794 if (oso && sset_is_empty(&oso->targets)) {
798 if (ofproto->ofproto_class->set_sflow) {
799 return ofproto->ofproto_class->set_sflow(ofproto, oso);
801 return oso ? EOPNOTSUPP : 0;
806 ofproto_set_ipfix(struct ofproto *ofproto,
807 const struct ofproto_ipfix_bridge_exporter_options *bo,
808 const struct ofproto_ipfix_flow_exporter_options *fo,
811 if (ofproto->ofproto_class->set_ipfix) {
812 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
814 return (bo || fo) ? EOPNOTSUPP : 0;
819 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
821 flow_restore_wait = flow_restore_wait_db;
825 ofproto_get_flow_restore_wait(void)
827 return flow_restore_wait;
831 /* Spanning Tree Protocol (STP) configuration. */
833 /* Configures STP on 'ofproto' using the settings defined in 's'. If
834 * 's' is NULL, disables STP.
836 * Returns 0 if successful, otherwise a positive errno value. */
838 ofproto_set_stp(struct ofproto *ofproto,
839 const struct ofproto_stp_settings *s)
841 return (ofproto->ofproto_class->set_stp
842 ? ofproto->ofproto_class->set_stp(ofproto, s)
846 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
847 * 'enabled' member of 's' is false, then the other members are not
850 * Returns 0 if successful, otherwise a positive errno value. */
852 ofproto_get_stp_status(struct ofproto *ofproto,
853 struct ofproto_stp_status *s)
855 return (ofproto->ofproto_class->get_stp_status
856 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
860 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
861 * in 's'. The caller is responsible for assigning STP port numbers
862 * (using the 'port_num' member in the range of 1 through 255, inclusive)
863 * and ensuring there are no duplicates. If the 's' is NULL, then STP
864 * is disabled on the port.
866 * Returns 0 if successful, otherwise a positive errno value.*/
868 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
869 const struct ofproto_port_stp_settings *s)
871 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
873 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
874 ofproto->name, ofp_port);
878 return (ofproto->ofproto_class->set_stp_port
879 ? ofproto->ofproto_class->set_stp_port(ofport, s)
883 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
884 * 's'. If the 'enabled' member in 's' is false, then the other members
885 * are not meaningful.
887 * Returns 0 if successful, otherwise a positive errno value.*/
889 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
890 struct ofproto_port_stp_status *s)
892 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
894 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
895 "port %"PRIu16, ofproto->name, ofp_port);
899 return (ofproto->ofproto_class->get_stp_port_status
900 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
904 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
905 * 's'. If the 'enabled' member in 's' is false, then the other members
906 * are not meaningful.
908 * Returns 0 if successful, otherwise a positive errno value.*/
910 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
911 struct ofproto_port_stp_stats *s)
913 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
915 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
916 "port %"PRIu16, ofproto->name, ofp_port);
920 return (ofproto->ofproto_class->get_stp_port_stats
921 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
925 /* Queue DSCP configuration. */
927 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
928 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
929 * to implement QoS. Instead, it is used to implement features which require
930 * knowledge of what queues exist on a port, and some basic information about
933 * Returns 0 if successful, otherwise a positive errno value. */
935 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
936 const struct ofproto_port_queue *queues,
939 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
942 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
943 ofproto->name, ofp_port);
947 return (ofproto->ofproto_class->set_queues
948 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
952 /* Connectivity Fault Management configuration. */
954 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
956 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
958 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
959 if (ofport && ofproto->ofproto_class->set_cfm) {
960 ofproto->ofproto_class->set_cfm(ofport, NULL);
964 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
965 * basic configuration from the configuration members in 'cfm', and the remote
966 * maintenance point ID from remote_mpid. Ignores the statistics members of
969 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
971 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
972 const struct cfm_settings *s)
974 struct ofport *ofport;
977 ofport = ofproto_get_port(ofproto, ofp_port);
979 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
980 ofproto->name, ofp_port);
984 /* XXX: For configuration simplicity, we only support one remote_mpid
985 * outside of the CFM module. It's not clear if this is the correct long
986 * term solution or not. */
987 error = (ofproto->ofproto_class->set_cfm
988 ? ofproto->ofproto_class->set_cfm(ofport, s)
991 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
992 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
993 ovs_strerror(error));
997 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
998 * 'ofproto' does not have a port 'ofp_port'. */
1000 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
1001 const struct smap *cfg)
1003 struct ofport *ofport;
1006 ofport = ofproto_get_port(ofproto, ofp_port);
1008 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1009 ofproto->name, ofp_port);
1013 error = (ofproto->ofproto_class->set_bfd
1014 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1017 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1018 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1019 ovs_strerror(error));
1023 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1024 * success. Returns a negative number if there is no status change since
1025 * last update. Returns a positive errno otherwise. Has no effect if
1026 * 'ofp_port' is not an OpenFlow port in 'ofproto'.
1028 * The caller must provide and own '*status'. */
1030 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1031 struct smap *status)
1033 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1034 return (ofport && ofproto->ofproto_class->get_bfd_status
1035 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
1039 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1040 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1041 * 0 if LACP partner information is not current (generally indicating a
1042 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1044 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1046 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1047 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1048 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1054 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1055 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1056 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1057 * configuration plus, if there is more than one slave, a bonding
1060 * If 'aux' is already registered then this function updates its configuration
1061 * to 's'. Otherwise, this function registers a new bundle.
1063 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1066 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1067 const struct ofproto_bundle_settings *s)
1069 return (ofproto->ofproto_class->bundle_set
1070 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1074 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1075 * If no such bundle has been registered, this has no effect. */
1077 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1079 return ofproto_bundle_register(ofproto, aux, NULL);
1083 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1084 * If 'aux' is already registered then this function updates its configuration
1085 * to 's'. Otherwise, this function registers a new mirror. */
1087 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1088 const struct ofproto_mirror_settings *s)
1090 return (ofproto->ofproto_class->mirror_set
1091 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1095 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1096 * If no mirror has been registered, this has no effect. */
1098 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1100 return ofproto_mirror_register(ofproto, aux, NULL);
1103 /* Retrieves statistics from mirror associated with client data pointer
1104 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1105 * 'bytes', respectively. If a particular counters is not supported,
1106 * the appropriate argument is set to UINT64_MAX. */
1108 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1109 uint64_t *packets, uint64_t *bytes)
1111 if (!ofproto->ofproto_class->mirror_get_stats) {
1112 *packets = *bytes = UINT64_MAX;
1116 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1120 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1121 * which all packets are flooded, instead of using MAC learning. If
1122 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1124 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1127 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1129 return (ofproto->ofproto_class->set_flood_vlans
1130 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1134 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1135 * output for a mirror. */
1137 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1139 return (ofproto->ofproto_class->is_mirror_output_bundle
1140 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1144 /* Configuration of OpenFlow tables. */
1146 /* Returns the number of OpenFlow tables in 'ofproto'. */
1148 ofproto_get_n_tables(const struct ofproto *ofproto)
1150 return ofproto->n_tables;
1153 /* Returns the number of Controller visible OpenFlow tables
1154 * in 'ofproto'. This number will exclude Hidden tables.
1155 * This funtion's return value should be less or equal to that of
1156 * ofproto_get_n_tables() . */
1158 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1160 uint8_t n = ofproto->n_tables;
1162 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1163 * if present, are always at the end.) */
1164 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1171 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1172 * settings from 's'. 'table_id' must be in the range 0 through the number of
1173 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1175 * For read-only tables, only the name may be configured. */
1177 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1178 const struct ofproto_table_settings *s)
1180 struct oftable *table;
1182 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1183 table = &ofproto->tables[table_id];
1185 oftable_set_name(table, s->name);
1187 if (table->flags & OFTABLE_READONLY) {
1192 oftable_enable_eviction(table, s->groups, s->n_groups);
1194 oftable_disable_eviction(table);
1197 table->max_flows = s->max_flows;
1198 fat_rwlock_wrlock(&table->cls.rwlock);
1199 if (classifier_count(&table->cls) > table->max_flows
1200 && table->eviction_fields) {
1201 /* 'table' contains more flows than allowed. We might not be able to
1202 * evict them right away because of the asynchronous nature of flow
1203 * table changes. Schedule eviction for later. */
1204 switch (ofproto->state) {
1206 ofproto->state = S_EVICT;
1210 /* We're already deleting flows, nothing more to do. */
1215 classifier_set_prefix_fields(&table->cls,
1216 s->prefix_fields, s->n_prefix_fields);
1218 fat_rwlock_unlock(&table->cls.rwlock);
1222 ofproto_has_snoops(const struct ofproto *ofproto)
1224 return connmgr_has_snoops(ofproto->connmgr);
1228 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1230 connmgr_get_snoops(ofproto->connmgr, snoops);
1234 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1236 OVS_REQUIRES(ofproto_mutex)
1238 struct ofopgroup *group;
1240 ovs_assert(!rule->pending);
1242 group = ofopgroup_create_unattached(ofproto);
1243 delete_flow__(rule, group, reason);
1244 ofopgroup_submit(group);
1247 /* Deletes 'rule' from 'ofproto'.
1249 * Within an ofproto implementation, this function allows an ofproto
1250 * implementation to destroy any rules that remain when its ->destruct()
1251 * function is called. This function is not suitable for use elsewhere in an
1252 * ofproto implementation.
1254 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1255 * Cycle" in ofproto-provider.h. */
1257 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1258 OVS_EXCLUDED(ofproto_mutex)
1260 struct ofopgroup *group;
1262 ovs_mutex_lock(&ofproto_mutex);
1263 ovs_assert(!rule->pending);
1265 group = ofopgroup_create_unattached(ofproto);
1266 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1267 oftable_remove_rule__(ofproto, rule);
1268 ofproto->ofproto_class->rule_delete(rule);
1269 ofopgroup_submit(group);
1271 ovs_mutex_unlock(&ofproto_mutex);
1275 ofproto_flush__(struct ofproto *ofproto)
1276 OVS_EXCLUDED(ofproto_mutex)
1278 struct oftable *table;
1280 if (ofproto->ofproto_class->flush) {
1281 ofproto->ofproto_class->flush(ofproto);
1284 ovs_mutex_lock(&ofproto_mutex);
1285 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1286 struct rule *rule, *next_rule;
1287 struct cls_cursor cursor;
1289 if (table->flags & OFTABLE_HIDDEN) {
1293 fat_rwlock_rdlock(&table->cls.rwlock);
1294 cls_cursor_init(&cursor, &table->cls, NULL);
1295 fat_rwlock_unlock(&table->cls.rwlock);
1296 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1297 if (!rule->pending) {
1298 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1302 ovs_mutex_unlock(&ofproto_mutex);
1305 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1308 ofproto_destroy__(struct ofproto *ofproto)
1309 OVS_EXCLUDED(ofproto_mutex)
1311 struct oftable *table;
1313 ovs_assert(list_is_empty(&ofproto->pending));
1315 destroy_rule_executes(ofproto);
1316 delete_group(ofproto, OFPG_ALL);
1318 guarded_list_destroy(&ofproto->rule_executes);
1319 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1320 hmap_destroy(&ofproto->groups);
1322 connmgr_destroy(ofproto->connmgr);
1324 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1325 free(ofproto->name);
1326 free(ofproto->type);
1327 free(ofproto->mfr_desc);
1328 free(ofproto->hw_desc);
1329 free(ofproto->sw_desc);
1330 free(ofproto->serial_desc);
1331 free(ofproto->dp_desc);
1332 hmap_destroy(&ofproto->ports);
1333 hmap_destroy(&ofproto->ofport_usage);
1334 shash_destroy(&ofproto->port_by_name);
1335 simap_destroy(&ofproto->ofp_requests);
1337 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1338 oftable_destroy(table);
1340 free(ofproto->tables);
1342 hmap_destroy(&ofproto->deletions);
1344 free(ofproto->vlan_bitmap);
1346 ofproto->ofproto_class->dealloc(ofproto);
1350 ofproto_destroy(struct ofproto *p)
1351 OVS_EXCLUDED(ofproto_mutex)
1353 struct ofport *ofport, *next_ofport;
1354 struct ofport_usage *usage, *next_usage;
1361 meter_delete(p, 1, p->meter_features.max_meters);
1362 p->meter_features.max_meters = 0;
1368 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1369 ofport_destroy(ofport);
1372 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1373 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1377 p->ofproto_class->destruct(p);
1378 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1379 ovsrcu_postpone(ofproto_destroy__, p);
1382 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1383 * kernel datapath, for example, this destroys the datapath in the kernel, and
1384 * with the netdev-based datapath, it tears down the data structures that
1385 * represent the datapath.
1387 * The datapath should not be currently open as an ofproto. */
1389 ofproto_delete(const char *name, const char *type)
1391 const struct ofproto_class *class = ofproto_class_find__(type);
1392 return (!class ? EAFNOSUPPORT
1393 : !class->del ? EACCES
1394 : class->del(type, name));
1398 process_port_change(struct ofproto *ofproto, int error, char *devname)
1400 if (error == ENOBUFS) {
1401 reinit_ports(ofproto);
1402 } else if (!error) {
1403 update_port(ofproto, devname);
1409 ofproto_type_run(const char *datapath_type)
1411 const struct ofproto_class *class;
1414 datapath_type = ofproto_normalize_type(datapath_type);
1415 class = ofproto_class_find__(datapath_type);
1417 error = class->type_run ? class->type_run(datapath_type) : 0;
1418 if (error && error != EAGAIN) {
1419 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1420 datapath_type, ovs_strerror(error));
1426 ofproto_type_wait(const char *datapath_type)
1428 const struct ofproto_class *class;
1430 datapath_type = ofproto_normalize_type(datapath_type);
1431 class = ofproto_class_find__(datapath_type);
1433 if (class->type_wait) {
1434 class->type_wait(datapath_type);
1439 any_pending_ops(const struct ofproto *p)
1440 OVS_EXCLUDED(ofproto_mutex)
1444 ovs_mutex_lock(&ofproto_mutex);
1445 b = !list_is_empty(&p->pending);
1446 ovs_mutex_unlock(&ofproto_mutex);
1452 ofproto_run(struct ofproto *p)
1457 error = p->ofproto_class->run(p);
1458 if (error && error != EAGAIN) {
1459 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1462 run_rule_executes(p);
1464 /* Restore the eviction group heap invariant occasionally. */
1465 if (p->eviction_group_timer < time_msec()) {
1468 p->eviction_group_timer = time_msec() + 1000;
1470 for (i = 0; i < p->n_tables; i++) {
1471 struct oftable *table = &p->tables[i];
1472 struct eviction_group *evg;
1473 struct cls_cursor cursor;
1476 if (!table->eviction_fields) {
1480 ovs_mutex_lock(&ofproto_mutex);
1481 fat_rwlock_rdlock(&table->cls.rwlock);
1482 cls_cursor_init(&cursor, &table->cls, NULL);
1483 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1484 if (rule->idle_timeout || rule->hard_timeout) {
1485 if (!rule->eviction_group) {
1486 eviction_group_add_rule(rule);
1488 heap_raw_change(&rule->evg_node,
1489 rule_eviction_priority(p, rule));
1493 fat_rwlock_unlock(&table->cls.rwlock);
1495 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1496 heap_rebuild(&evg->rules);
1498 ovs_mutex_unlock(&ofproto_mutex);
1502 if (p->ofproto_class->port_poll) {
1505 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1506 process_port_change(p, error, devname);
1510 new_seq = seq_read(connectivity_seq_get());
1511 if (new_seq != p->change_seq) {
1512 struct sset devnames;
1513 const char *devname;
1514 struct ofport *ofport;
1516 /* Update OpenFlow port status for any port whose netdev has changed.
1518 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1519 * destroyed, so it's not safe to update ports directly from the
1520 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1521 * need this two-phase approach. */
1522 sset_init(&devnames);
1523 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1524 uint64_t port_change_seq;
1526 port_change_seq = netdev_get_change_seq(ofport->netdev);
1527 if (ofport->change_seq != port_change_seq) {
1528 ofport->change_seq = port_change_seq;
1529 sset_add(&devnames, netdev_get_name(ofport->netdev));
1532 SSET_FOR_EACH (devname, &devnames) {
1533 update_port(p, devname);
1535 sset_destroy(&devnames);
1537 p->change_seq = new_seq;
1542 connmgr_run(p->connmgr, handle_openflow);
1546 connmgr_run(p->connmgr, NULL);
1548 if (!any_pending_ops(p)) {
1549 p->state = S_OPENFLOW;
1554 connmgr_run(p->connmgr, NULL);
1556 if (!any_pending_ops(p)) {
1557 connmgr_flushed(p->connmgr);
1558 p->state = S_OPENFLOW;
1570 ofproto_wait(struct ofproto *p)
1572 p->ofproto_class->wait(p);
1573 if (p->ofproto_class->port_poll_wait) {
1574 p->ofproto_class->port_poll_wait(p);
1576 seq_wait(connectivity_seq_get(), p->change_seq);
1580 connmgr_wait(p->connmgr, true);
1585 connmgr_wait(p->connmgr, false);
1586 if (!any_pending_ops(p)) {
1587 poll_immediate_wake();
1594 ofproto_is_alive(const struct ofproto *p)
1596 return connmgr_has_controllers(p->connmgr);
1599 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1600 * memory_report(). */
1602 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1604 const struct oftable *table;
1605 unsigned int n_rules;
1607 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1609 ovs_mutex_lock(&ofproto_mutex);
1610 simap_increase(usage, "ops",
1611 ofproto->n_pending + hmap_count(&ofproto->deletions));
1612 ovs_mutex_unlock(&ofproto_mutex);
1615 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1616 fat_rwlock_rdlock(&table->cls.rwlock);
1617 n_rules += classifier_count(&table->cls);
1618 fat_rwlock_unlock(&table->cls.rwlock);
1620 simap_increase(usage, "rules", n_rules);
1622 if (ofproto->ofproto_class->get_memory_usage) {
1623 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1626 connmgr_get_memory_usage(ofproto->connmgr, usage);
1630 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1632 const struct ofproto_class *class;
1634 datapath_type = ofproto_normalize_type(datapath_type);
1635 class = ofproto_class_find__(datapath_type);
1637 if (class && class->type_get_memory_usage) {
1638 class->type_get_memory_usage(datapath_type, usage);
1643 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1646 connmgr_get_controller_info(ofproto->connmgr, info);
1650 ofproto_free_ofproto_controller_info(struct shash *info)
1652 connmgr_free_controller_info(info);
1655 /* Makes a deep copy of 'old' into 'port'. */
1657 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1659 port->name = xstrdup(old->name);
1660 port->type = xstrdup(old->type);
1661 port->ofp_port = old->ofp_port;
1664 /* Frees memory allocated to members of 'ofproto_port'.
1666 * Do not call this function on an ofproto_port obtained from
1667 * ofproto_port_dump_next(): that function retains ownership of the data in the
1670 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1672 free(ofproto_port->name);
1673 free(ofproto_port->type);
1676 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1678 * This function provides no status indication. An error status for the entire
1679 * dump operation is provided when it is completed by calling
1680 * ofproto_port_dump_done().
1683 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1684 const struct ofproto *ofproto)
1686 dump->ofproto = ofproto;
1687 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1691 /* Attempts to retrieve another port from 'dump', which must have been created
1692 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1693 * 'port' and returns true. On failure, returns false.
1695 * Failure might indicate an actual error or merely that the last port has been
1696 * dumped. An error status for the entire dump operation is provided when it
1697 * is completed by calling ofproto_port_dump_done().
1699 * The ofproto owns the data stored in 'port'. It will remain valid until at
1700 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1701 * ofproto_port_dump_done(). */
1703 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1704 struct ofproto_port *port)
1706 const struct ofproto *ofproto = dump->ofproto;
1712 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1715 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1721 /* Completes port table dump operation 'dump', which must have been created
1722 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1723 * error-free, otherwise a positive errno value describing the problem. */
1725 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1727 const struct ofproto *ofproto = dump->ofproto;
1729 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1732 return dump->error == EOF ? 0 : dump->error;
1735 /* Returns the type to pass to netdev_open() when a datapath of type
1736 * 'datapath_type' has a port of type 'port_type', for a few special
1737 * cases when a netdev type differs from a port type. For example, when
1738 * using the userspace datapath, a port of type "internal" needs to be
1741 * Returns either 'type' itself or a string literal, which must not be
1744 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1746 const struct ofproto_class *class;
1748 datapath_type = ofproto_normalize_type(datapath_type);
1749 class = ofproto_class_find__(datapath_type);
1754 return (class->port_open_type
1755 ? class->port_open_type(datapath_type, port_type)
1759 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1760 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1761 * the port's OpenFlow port number.
1763 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1764 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1765 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1766 * 'ofp_portp' is non-null). */
1768 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1769 ofp_port_t *ofp_portp)
1771 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1774 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1776 const char *netdev_name = netdev_get_name(netdev);
1778 simap_put(&ofproto->ofp_requests, netdev_name,
1779 ofp_to_u16(ofp_port));
1780 update_port(ofproto, netdev_name);
1783 *ofp_portp = OFPP_NONE;
1785 struct ofproto_port ofproto_port;
1787 error = ofproto_port_query_by_name(ofproto,
1788 netdev_get_name(netdev),
1791 *ofp_portp = ofproto_port.ofp_port;
1792 ofproto_port_destroy(&ofproto_port);
1799 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1800 * initializes '*port' appropriately; on failure, returns a positive errno
1803 * The caller owns the data in 'ofproto_port' and must free it with
1804 * ofproto_port_destroy() when it is no longer needed. */
1806 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1807 struct ofproto_port *port)
1811 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1813 memset(port, 0, sizeof *port);
1818 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1819 * Returns 0 if successful, otherwise a positive errno. */
1821 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1823 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1824 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1825 struct simap_node *ofp_request_node;
1828 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1829 if (ofp_request_node) {
1830 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1833 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1834 if (!error && ofport) {
1835 /* 'name' is the netdev's name and update_port() is going to close the
1836 * netdev. Just in case update_port() refers to 'name' after it
1837 * destroys 'ofport', make a copy of it around the update_port()
1839 char *devname = xstrdup(name);
1840 update_port(ofproto, devname);
1847 flow_mod_init(struct ofputil_flow_mod *fm,
1848 const struct match *match, unsigned int priority,
1849 const struct ofpact *ofpacts, size_t ofpacts_len,
1850 enum ofp_flow_mod_command command)
1852 memset(fm, 0, sizeof *fm);
1854 fm->priority = priority;
1857 fm->modify_cookie = false;
1859 fm->command = command;
1860 fm->idle_timeout = 0;
1861 fm->hard_timeout = 0;
1862 fm->buffer_id = UINT32_MAX;
1863 fm->out_port = OFPP_ANY;
1864 fm->out_group = OFPG_ANY;
1866 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1867 fm->ofpacts_len = ofpacts_len;
1871 simple_flow_mod(struct ofproto *ofproto,
1872 const struct match *match, unsigned int priority,
1873 const struct ofpact *ofpacts, size_t ofpacts_len,
1874 enum ofp_flow_mod_command command)
1876 struct ofputil_flow_mod fm;
1878 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1880 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1883 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1884 * performs the 'n_actions' actions in 'actions'. The new flow will not
1887 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1888 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1889 * controllers; otherwise, it will be hidden.
1891 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1893 * This is a helper function for in-band control and fail-open. */
1895 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1896 unsigned int priority,
1897 const struct ofpact *ofpacts, size_t ofpacts_len)
1898 OVS_EXCLUDED(ofproto_mutex)
1900 const struct rule *rule;
1903 /* First do a cheap check whether the rule we're looking for already exists
1904 * with the actions that we want. If it does, then we're done. */
1905 fat_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1906 rule = rule_from_cls_rule(classifier_find_match_exactly(
1907 &ofproto->tables[0].cls, match, priority));
1909 const struct rule_actions *actions = rule_get_actions(rule);
1910 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1911 ofpacts, ofpacts_len);
1915 fat_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1917 /* If there's no such rule or the rule doesn't have the actions we want,
1918 * fall back to a executing a full flow mod. We can't optimize this at
1919 * all because we didn't take enough locks above to ensure that the flow
1920 * table didn't already change beneath us. */
1922 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1923 OFPFC_MODIFY_STRICT);
1927 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1928 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1929 * operation cannot be initiated now but may be retried later.
1931 * This is a helper function for in-band control and fail-open and the "learn"
1934 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1935 OVS_EXCLUDED(ofproto_mutex)
1937 /* Optimize for the most common case of a repeated learn action.
1938 * If an identical flow already exists we only need to update its
1939 * 'modified' time. */
1940 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1941 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1942 struct oftable *table = &ofproto->tables[fm->table_id];
1946 fat_rwlock_rdlock(&table->cls.rwlock);
1947 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
1951 /* Reading many of the rule fields and writing on 'modified'
1952 * requires the rule->mutex. Also, rule->actions may change
1953 * if rule->mutex is not held. */
1954 const struct rule_actions *actions;
1956 ovs_mutex_lock(&rule->mutex);
1957 actions = rule_get_actions(rule);
1958 if (rule->idle_timeout == fm->idle_timeout
1959 && rule->hard_timeout == fm->hard_timeout
1960 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1961 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1962 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
1963 actions->ofpacts, actions->ofpacts_len)) {
1964 /* Rule already exists and need not change, only update the
1965 modified timestamp. */
1966 rule->modified = time_msec();
1969 ovs_mutex_unlock(&rule->mutex);
1971 fat_rwlock_unlock(&table->cls.rwlock);
1978 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1981 /* Resets the modified time for 'rule' or an equivalent rule. If 'rule' is not
1982 * in the classifier, but an equivalent rule is, unref 'rule' and ref the new
1983 * rule. Otherwise if 'rule' is no longer installed in the classifier,
1986 * Returns the rule whose modified time has been reset. */
1988 ofproto_refresh_rule(struct rule *rule)
1990 const struct oftable *table = &rule->ofproto->tables[rule->table_id];
1991 const struct cls_rule *cr = &rule->cr;
1994 /* do_add_flow() requires that the rule is not installed. We lock the
1995 * ofproto_mutex here so that another thread cannot add the flow before
1996 * we get a chance to add it.*/
1997 ovs_mutex_lock(&ofproto_mutex);
1999 fat_rwlock_rdlock(&table->cls.rwlock);
2000 r = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, cr));
2002 ofproto_rule_ref(r);
2004 fat_rwlock_unlock(&table->cls.rwlock);
2007 do_add_flow(rule->ofproto, NULL, NULL, 0, rule);
2008 } else if (r != rule) {
2009 ofproto_rule_unref(rule);
2012 ovs_mutex_unlock(&ofproto_mutex);
2014 /* Refresh the modified time for the rule. */
2015 ovs_mutex_lock(&rule->mutex);
2016 rule->modified = MAX(rule->modified, time_msec());
2017 ovs_mutex_unlock(&rule->mutex);
2022 /* Searches for a rule with matching criteria exactly equal to 'target' in
2023 * ofproto's table 0 and, if it finds one, deletes it.
2025 * This is a helper function for in-band control and fail-open. */
2027 ofproto_delete_flow(struct ofproto *ofproto,
2028 const struct match *target, unsigned int priority)
2029 OVS_EXCLUDED(ofproto_mutex)
2031 struct classifier *cls = &ofproto->tables[0].cls;
2034 /* First do a cheap check whether the rule we're looking for has already
2035 * been deleted. If so, then we're done. */
2036 fat_rwlock_rdlock(&cls->rwlock);
2037 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2039 fat_rwlock_unlock(&cls->rwlock);
2044 /* Fall back to a executing a full flow mod. We can't optimize this at all
2045 * because we didn't take enough locks above to ensure that the flow table
2046 * didn't already change beneath us. */
2047 return simple_flow_mod(ofproto, target, priority, NULL, 0,
2048 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
2051 /* Starts the process of deleting all of the flows from all of ofproto's flow
2052 * tables and then reintroducing the flows required by in-band control and
2053 * fail-open. The process will complete in a later call to ofproto_run(). */
2055 ofproto_flush_flows(struct ofproto *ofproto)
2057 COVERAGE_INC(ofproto_flush);
2058 ofproto->state = S_FLUSH;
2062 reinit_ports(struct ofproto *p)
2064 struct ofproto_port_dump dump;
2065 struct sset devnames;
2066 struct ofport *ofport;
2067 struct ofproto_port ofproto_port;
2068 const char *devname;
2070 COVERAGE_INC(ofproto_reinit_ports);
2072 sset_init(&devnames);
2073 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2074 sset_add(&devnames, netdev_get_name(ofport->netdev));
2076 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2077 sset_add(&devnames, ofproto_port.name);
2080 SSET_FOR_EACH (devname, &devnames) {
2081 update_port(p, devname);
2083 sset_destroy(&devnames);
2087 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2091 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2092 port_idx = port_idx ? port_idx : UINT16_MAX;
2094 if (port_idx >= ofproto->max_ports
2095 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2096 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2097 long long int last_used_at, lru = LLONG_MAX;
2099 /* Search for a free OpenFlow port number. We try not to
2100 * immediately reuse them to prevent problems due to old
2103 * We limit the automatically assigned port numbers to the lower half
2104 * of the port range, to reserve the upper half for assignment by
2107 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2108 ofproto->alloc_port_no = 1;
2110 last_used_at = ofport_get_usage(ofproto,
2111 u16_to_ofp(ofproto->alloc_port_no));
2112 if (!last_used_at) {
2113 port_idx = ofproto->alloc_port_no;
2115 } else if ( last_used_at < time_msec() - 60*60*1000) {
2116 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2117 * more than an hour ago, consider it usable. */
2118 ofport_remove_usage(ofproto,
2119 u16_to_ofp(ofproto->alloc_port_no));
2120 port_idx = ofproto->alloc_port_no;
2122 } else if (last_used_at < lru) {
2124 lru_ofport = ofproto->alloc_port_no;
2127 if (ofproto->alloc_port_no == end_port_no) {
2129 port_idx = lru_ofport;
2136 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2137 return u16_to_ofp(port_idx);
2141 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2143 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2144 ofport_set_usage(ofproto, ofp_port, time_msec());
2148 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2149 * pointer if the netdev cannot be opened. On success, also fills in
2151 static struct netdev *
2152 ofport_open(struct ofproto *ofproto,
2153 struct ofproto_port *ofproto_port,
2154 struct ofputil_phy_port *pp)
2156 enum netdev_flags flags;
2157 struct netdev *netdev;
2160 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2162 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2163 "cannot be opened (%s)",
2165 ofproto_port->name, ofproto_port->ofp_port,
2166 ofproto_port->name, ovs_strerror(error));
2170 if (ofproto_port->ofp_port == OFPP_NONE) {
2171 if (!strcmp(ofproto->name, ofproto_port->name)) {
2172 ofproto_port->ofp_port = OFPP_LOCAL;
2174 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2175 ofproto_port->name);
2178 pp->port_no = ofproto_port->ofp_port;
2179 netdev_get_etheraddr(netdev, pp->hw_addr);
2180 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2181 netdev_get_flags(netdev, &flags);
2182 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2183 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2184 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2185 &pp->supported, &pp->peer);
2186 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2187 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2192 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2193 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2196 ofport_equal(const struct ofputil_phy_port *a,
2197 const struct ofputil_phy_port *b)
2199 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2200 && a->state == b->state
2201 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2202 && a->curr == b->curr
2203 && a->advertised == b->advertised
2204 && a->supported == b->supported
2205 && a->peer == b->peer
2206 && a->curr_speed == b->curr_speed
2207 && a->max_speed == b->max_speed);
2210 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2211 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2212 * one with the same name or port number). */
2214 ofport_install(struct ofproto *p,
2215 struct netdev *netdev, const struct ofputil_phy_port *pp)
2217 const char *netdev_name = netdev_get_name(netdev);
2218 struct ofport *ofport;
2221 /* Create ofport. */
2222 ofport = p->ofproto_class->port_alloc();
2227 ofport->ofproto = p;
2228 ofport->netdev = netdev;
2229 ofport->change_seq = netdev_get_change_seq(netdev);
2231 ofport->ofp_port = pp->port_no;
2232 ofport->created = time_msec();
2234 /* Add port to 'p'. */
2235 hmap_insert(&p->ports, &ofport->hmap_node,
2236 hash_ofp_port(ofport->ofp_port));
2237 shash_add(&p->port_by_name, netdev_name, ofport);
2239 update_mtu(p, ofport);
2241 /* Let the ofproto_class initialize its private data. */
2242 error = p->ofproto_class->port_construct(ofport);
2246 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2250 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2251 p->name, netdev_name, ovs_strerror(error));
2253 ofport_destroy__(ofport);
2255 netdev_close(netdev);
2259 /* Removes 'ofport' from 'p' and destroys it. */
2261 ofport_remove(struct ofport *ofport)
2263 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2265 ofport_destroy(ofport);
2268 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2271 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2273 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2275 ofport_remove(port);
2279 /* Updates 'port' with new 'pp' description.
2281 * Does not handle a name or port number change. The caller must implement
2282 * such a change as a delete followed by an add. */
2284 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2286 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2287 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2288 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2289 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2290 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2291 port->pp.curr = pp->curr;
2292 port->pp.advertised = pp->advertised;
2293 port->pp.supported = pp->supported;
2294 port->pp.peer = pp->peer;
2295 port->pp.curr_speed = pp->curr_speed;
2296 port->pp.max_speed = pp->max_speed;
2298 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2299 &port->pp, OFPPR_MODIFY);
2302 /* Update OpenFlow 'state' in 'port' and notify controller. */
2304 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2306 if (port->pp.state != state) {
2307 port->pp.state = state;
2308 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2309 &port->pp, OFPPR_MODIFY);
2314 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2316 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2318 if (port->ofproto->ofproto_class->set_realdev) {
2319 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2321 if (port->ofproto->ofproto_class->set_stp_port) {
2322 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2324 if (port->ofproto->ofproto_class->set_cfm) {
2325 port->ofproto->ofproto_class->set_cfm(port, NULL);
2327 if (port->ofproto->ofproto_class->bundle_remove) {
2328 port->ofproto->ofproto_class->bundle_remove(port);
2334 ofport_destroy__(struct ofport *port)
2336 struct ofproto *ofproto = port->ofproto;
2337 const char *name = netdev_get_name(port->netdev);
2339 hmap_remove(&ofproto->ports, &port->hmap_node);
2340 shash_delete(&ofproto->port_by_name,
2341 shash_find(&ofproto->port_by_name, name));
2343 netdev_close(port->netdev);
2344 ofproto->ofproto_class->port_dealloc(port);
2348 ofport_destroy(struct ofport *port)
2351 dealloc_ofp_port(port->ofproto, port->ofp_port);
2352 port->ofproto->ofproto_class->port_destruct(port);
2353 ofport_destroy__(port);
2358 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2360 struct ofport *port;
2362 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2364 if (port->ofp_port == ofp_port) {
2371 static long long int
2372 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2374 struct ofport_usage *usage;
2376 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2377 &ofproto->ofport_usage) {
2378 if (usage->ofp_port == ofp_port) {
2379 return usage->last_used;
2386 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2387 long long int last_used)
2389 struct ofport_usage *usage;
2390 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2391 &ofproto->ofport_usage) {
2392 if (usage->ofp_port == ofp_port) {
2393 usage->last_used = last_used;
2397 ovs_assert(last_used == LLONG_MAX);
2399 usage = xmalloc(sizeof *usage);
2400 usage->ofp_port = ofp_port;
2401 usage->last_used = last_used;
2402 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2403 hash_ofp_port(ofp_port));
2407 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2409 struct ofport_usage *usage;
2410 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2411 &ofproto->ofport_usage) {
2412 if (usage->ofp_port == ofp_port) {
2413 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2421 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2423 struct ofproto *ofproto = port->ofproto;
2426 if (ofproto->ofproto_class->port_get_stats) {
2427 error = ofproto->ofproto_class->port_get_stats(port, stats);
2436 update_port(struct ofproto *ofproto, const char *name)
2438 struct ofproto_port ofproto_port;
2439 struct ofputil_phy_port pp;
2440 struct netdev *netdev;
2441 struct ofport *port;
2443 COVERAGE_INC(ofproto_update_port);
2445 /* Fetch 'name''s location and properties from the datapath. */
2446 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2447 ? ofport_open(ofproto, &ofproto_port, &pp)
2451 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2452 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2453 struct netdev *old_netdev = port->netdev;
2455 /* 'name' hasn't changed location. Any properties changed? */
2456 if (!ofport_equal(&port->pp, &pp)) {
2457 ofport_modified(port, &pp);
2460 update_mtu(ofproto, port);
2462 /* Install the newly opened netdev in case it has changed.
2463 * Don't close the old netdev yet in case port_modified has to
2464 * remove a retained reference to it.*/
2465 port->netdev = netdev;
2466 port->change_seq = netdev_get_change_seq(netdev);
2468 if (port->ofproto->ofproto_class->port_modified) {
2469 port->ofproto->ofproto_class->port_modified(port);
2472 netdev_close(old_netdev);
2474 /* If 'port' is nonnull then its name differs from 'name' and thus
2475 * we should delete it. If we think there's a port named 'name'
2476 * then its port number must be wrong now so delete it too. */
2478 ofport_remove(port);
2480 ofport_remove_with_name(ofproto, name);
2481 ofport_install(ofproto, netdev, &pp);
2484 /* Any port named 'name' is gone now. */
2485 ofport_remove_with_name(ofproto, name);
2487 ofproto_port_destroy(&ofproto_port);
2491 init_ports(struct ofproto *p)
2493 struct ofproto_port_dump dump;
2494 struct ofproto_port ofproto_port;
2495 struct shash_node *node, *next;
2497 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2498 const char *name = ofproto_port.name;
2500 if (shash_find(&p->port_by_name, name)) {
2501 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2504 struct ofputil_phy_port pp;
2505 struct netdev *netdev;
2507 /* Check if an OpenFlow port number had been requested. */
2508 node = shash_find(&init_ofp_ports, name);
2510 const struct iface_hint *iface_hint = node->data;
2511 simap_put(&p->ofp_requests, name,
2512 ofp_to_u16(iface_hint->ofp_port));
2515 netdev = ofport_open(p, &ofproto_port, &pp);
2517 ofport_install(p, netdev, &pp);
2518 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2519 p->alloc_port_no = MAX(p->alloc_port_no,
2520 ofp_to_u16(ofproto_port.ofp_port));
2526 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2527 struct iface_hint *iface_hint = node->data;
2529 if (!strcmp(iface_hint->br_name, p->name)) {
2530 free(iface_hint->br_name);
2531 free(iface_hint->br_type);
2533 shash_delete(&init_ofp_ports, node);
2540 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2541 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2543 find_min_mtu(struct ofproto *p)
2545 struct ofport *ofport;
2548 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2549 struct netdev *netdev = ofport->netdev;
2552 /* Skip any internal ports, since that's what we're trying to
2554 if (!strcmp(netdev_get_type(netdev), "internal")) {
2558 if (netdev_get_mtu(netdev, &dev_mtu)) {
2561 if (!mtu || dev_mtu < mtu) {
2566 return mtu ? mtu: ETH_PAYLOAD_MAX;
2569 /* Update MTU of all datapath devices on 'p' to the minimum of the
2570 * non-datapath ports in event of 'port' added or changed. */
2572 update_mtu(struct ofproto *p, struct ofport *port)
2574 struct ofport *ofport;
2575 struct netdev *netdev = port->netdev;
2576 int dev_mtu, old_min;
2578 if (netdev_get_mtu(netdev, &dev_mtu)) {
2582 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2583 if (dev_mtu > p->min_mtu) {
2584 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2585 dev_mtu = p->min_mtu;
2588 port->mtu = dev_mtu;
2592 /* For non-internal port find new min mtu. */
2593 old_min = p->min_mtu;
2594 port->mtu = dev_mtu;
2595 p->min_mtu = find_min_mtu(p);
2596 if (p->min_mtu == old_min) {
2600 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2601 struct netdev *netdev = ofport->netdev;
2603 if (!strcmp(netdev_get_type(netdev), "internal")) {
2604 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2605 ofport->mtu = p->min_mtu;
2612 ofproto_rule_destroy__(struct rule *rule)
2613 OVS_NO_THREAD_SAFETY_ANALYSIS
2615 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2616 rule_actions_destroy(rule_get_actions(rule));
2617 ovs_mutex_destroy(&rule->mutex);
2618 rule->ofproto->ofproto_class->rule_dealloc(rule);
2622 rule_destroy_cb(struct rule *rule)
2624 rule->ofproto->ofproto_class->rule_destruct(rule);
2625 ofproto_rule_destroy__(rule);
2629 ofproto_rule_ref(struct rule *rule)
2632 ovs_refcount_ref(&rule->ref_count);
2636 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2637 * ref_count reaches 0.
2639 * Use of RCU allows short term use (between RCU quiescent periods) without
2640 * keeping a reference. A reference must be taken if the rule needs to
2641 * stay around accross the RCU quiescent periods. */
2643 ofproto_rule_unref(struct rule *rule)
2645 if (rule && ovs_refcount_unref(&rule->ref_count) == 1) {
2646 ovsrcu_postpone(rule_destroy_cb, rule);
2651 ofproto_group_ref(struct ofgroup *group)
2654 ovs_refcount_ref(&group->ref_count);
2659 ofproto_group_unref(struct ofgroup *group)
2661 if (group && ovs_refcount_unref(&group->ref_count) == 1) {
2662 group->ofproto->ofproto_class->group_destruct(group);
2663 ofputil_bucket_list_destroy(&group->buckets);
2664 group->ofproto->ofproto_class->group_dealloc(group);
2668 static uint32_t get_provider_meter_id(const struct ofproto *,
2669 uint32_t of_meter_id);
2671 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2672 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2673 const struct rule_actions *
2674 rule_actions_create(const struct ofproto *ofproto,
2675 const struct ofpact *ofpacts, size_t ofpacts_len)
2677 struct rule_actions *actions;
2679 actions = xmalloc(sizeof *actions + ofpacts_len);
2680 actions->ofpacts_len = ofpacts_len;
2681 actions->provider_meter_id
2682 = get_provider_meter_id(ofproto,
2683 ofpacts_get_meter(ofpacts, ofpacts_len));
2684 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2689 /* Free the actions after the RCU quiescent period is reached. */
2691 rule_actions_destroy(const struct rule_actions *actions)
2694 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2698 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2699 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2701 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2702 OVS_REQUIRES(ofproto_mutex)
2704 if (port == OFPP_ANY) {
2707 const struct rule_actions *actions = rule_get_actions(rule);
2708 return ofpacts_output_to_port(actions->ofpacts,
2709 actions->ofpacts_len, port);
2713 /* Returns true if 'rule' has group and equals group_id. */
2715 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2716 OVS_REQUIRES(ofproto_mutex)
2718 if (group_id == OFPG_ANY) {
2721 const struct rule_actions *actions = rule_get_actions(rule);
2722 return ofpacts_output_to_group(actions->ofpacts,
2723 actions->ofpacts_len, group_id);
2727 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2728 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2730 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2731 OVS_REQUIRES(ofproto_mutex)
2733 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2738 case OFOPERATION_ADD:
2739 case OFOPERATION_DELETE:
2742 case OFOPERATION_MODIFY:
2743 case OFOPERATION_REPLACE:
2744 return ofpacts_output_to_port(op->actions->ofpacts,
2745 op->actions->ofpacts_len, out_port);
2752 rule_execute_destroy(struct rule_execute *e)
2754 ofproto_rule_unref(e->rule);
2755 list_remove(&e->list_node);
2759 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2760 * by passing them to the ofproto provider. */
2762 run_rule_executes(struct ofproto *ofproto)
2763 OVS_EXCLUDED(ofproto_mutex)
2765 struct rule_execute *e, *next;
2766 struct list executes;
2768 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2769 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2772 flow_extract(e->packet, NULL, &flow);
2773 flow.in_port.ofp_port = e->in_port;
2774 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2776 rule_execute_destroy(e);
2780 /* Destroys and discards all "rule_execute" operations queued up in
2781 * ofproto->rule_executes. */
2783 destroy_rule_executes(struct ofproto *ofproto)
2785 struct rule_execute *e, *next;
2786 struct list executes;
2788 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2789 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2790 ofpbuf_delete(e->packet);
2791 rule_execute_destroy(e);
2795 /* Returns true if 'rule' should be hidden from the controller.
2797 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2798 * (e.g. by in-band control) and are intentionally hidden from the
2801 ofproto_rule_is_hidden(const struct rule *rule)
2803 return (rule->cr.priority > UINT16_MAX);
2807 oftable_is_modifiable(const struct oftable *table,
2808 enum ofputil_flow_mod_flags flags)
2810 if (flags & OFPUTIL_FF_NO_READONLY) {
2814 return !(table->flags & OFTABLE_READONLY);
2818 rule_is_modifiable(const struct rule *rule, enum ofputil_flow_mod_flags flags)
2820 const struct oftable *rule_table;
2822 rule_table = &rule->ofproto->tables[rule->table_id];
2823 return oftable_is_modifiable(rule_table, flags);
2827 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2829 ofconn_send_reply(ofconn, make_echo_reply(oh));
2834 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2836 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2837 struct ofputil_switch_features features;
2838 struct ofport *port;
2842 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2844 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2846 features.datapath_id = ofproto->datapath_id;
2847 features.n_buffers = pktbuf_capacity();
2848 features.n_tables = ofproto_get_n_visible_tables(ofproto);
2849 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2850 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2852 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2854 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2855 features.auxiliary_id = 0;
2856 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2858 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2859 ofputil_put_switch_features_port(&port->pp, b);
2862 ofconn_send_reply(ofconn, b);
2867 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2869 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2870 struct ofp_switch_config *osc;
2871 enum ofp_config_flags flags;
2875 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2876 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2877 flags = ofproto->frag_handling;
2878 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2879 if (oh->version < OFP13_VERSION
2880 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2881 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2883 osc->flags = htons(flags);
2884 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2885 ofconn_send_reply(ofconn, buf);
2891 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2893 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2894 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2895 uint16_t flags = ntohs(osc->flags);
2897 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2898 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2899 enum ofp_config_flags cur = ofproto->frag_handling;
2900 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2902 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2904 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2905 ofproto->frag_handling = next;
2907 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2909 ofputil_frag_handling_to_string(next));
2913 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2914 ofconn_set_invalid_ttl_to_controller(ofconn,
2915 (oh->version < OFP13_VERSION
2916 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2918 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2923 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2924 * error message code for the caller to propagate upward. Otherwise, returns
2927 * The log message mentions 'msg_type'. */
2929 reject_slave_controller(struct ofconn *ofconn)
2931 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2932 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2933 return OFPERR_OFPBRC_EPERM;
2939 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2942 * - If they use a meter, then 'ofproto' has that meter configured.
2944 * - If they use any groups, then 'ofproto' has that group configured.
2946 * Returns 0 if successful, otherwise an OpenFlow error. */
2948 ofproto_check_ofpacts(struct ofproto *ofproto,
2949 const struct ofpact ofpacts[], size_t ofpacts_len)
2951 const struct ofpact *a;
2954 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2955 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2956 return OFPERR_OFPMMFC_INVALID_METER;
2959 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2960 if (a->type == OFPACT_GROUP
2961 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2962 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2970 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2972 struct ofproto *p = ofconn_get_ofproto(ofconn);
2973 struct ofputil_packet_out po;
2974 struct ofpbuf *payload;
2975 uint64_t ofpacts_stub[1024 / 8];
2976 struct ofpbuf ofpacts;
2980 COVERAGE_INC(ofproto_packet_out);
2982 error = reject_slave_controller(ofconn);
2987 /* Decode message. */
2988 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2989 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2991 goto exit_free_ofpacts;
2993 if (ofp_to_u16(po.in_port) >= p->max_ports
2994 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2995 error = OFPERR_OFPBRC_BAD_PORT;
2996 goto exit_free_ofpacts;
3000 if (po.buffer_id != UINT32_MAX) {
3001 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
3002 if (error || !payload) {
3003 goto exit_free_ofpacts;
3006 /* Ensure that the L3 header is 32-bit aligned. */
3007 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
3010 /* Verify actions against packet, then send packet if successful. */
3011 flow_extract(payload, NULL, &flow);
3012 flow.in_port.ofp_port = po.in_port;
3013 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
3015 error = p->ofproto_class->packet_out(p, payload, &flow,
3016 po.ofpacts, po.ofpacts_len);
3018 ofpbuf_delete(payload);
3021 ofpbuf_uninit(&ofpacts);
3027 update_port_config(struct ofconn *ofconn, struct ofport *port,
3028 enum ofputil_port_config config,
3029 enum ofputil_port_config mask)
3031 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
3033 if (toggle & OFPUTIL_PC_PORT_DOWN
3034 && (config & OFPUTIL_PC_PORT_DOWN
3035 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
3036 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
3037 /* We tried to bring the port up or down, but it failed, so don't
3038 * update the "down" bit. */
3039 toggle &= ~OFPUTIL_PC_PORT_DOWN;
3043 enum ofputil_port_config old_config = port->pp.config;
3044 port->pp.config ^= toggle;
3045 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
3046 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3052 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3054 struct ofproto *p = ofconn_get_ofproto(ofconn);
3055 struct ofputil_port_mod pm;
3056 struct ofport *port;
3059 error = reject_slave_controller(ofconn);
3064 error = ofputil_decode_port_mod(oh, &pm, false);
3069 port = ofproto_get_port(p, pm.port_no);
3071 return OFPERR_OFPPMFC_BAD_PORT;
3072 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3073 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3075 update_port_config(ofconn, port, pm.config, pm.mask);
3077 netdev_set_advertisements(port->netdev, pm.advertise);
3084 handle_desc_stats_request(struct ofconn *ofconn,
3085 const struct ofp_header *request)
3087 static const char *default_mfr_desc = "Nicira, Inc.";
3088 static const char *default_hw_desc = "Open vSwitch";
3089 static const char *default_sw_desc = VERSION;
3090 static const char *default_serial_desc = "None";
3091 static const char *default_dp_desc = "None";
3093 struct ofproto *p = ofconn_get_ofproto(ofconn);
3094 struct ofp_desc_stats *ods;
3097 msg = ofpraw_alloc_stats_reply(request, 0);
3098 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3099 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3100 sizeof ods->mfr_desc);
3101 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3102 sizeof ods->hw_desc);
3103 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3104 sizeof ods->sw_desc);
3105 ovs_strlcpy(ods->serial_num,
3106 p->serial_desc ? p->serial_desc : default_serial_desc,
3107 sizeof ods->serial_num);
3108 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3109 sizeof ods->dp_desc);
3110 ofconn_send_reply(ofconn, msg);
3116 handle_table_stats_request(struct ofconn *ofconn,
3117 const struct ofp_header *request)
3119 struct ofproto *p = ofconn_get_ofproto(ofconn);
3120 struct ofp12_table_stats *ots;
3125 /* Set up default values.
3127 * ofp12_table_stats is used as a generic structure as
3128 * it is able to hold all the fields for ofp10_table_stats
3129 * and ofp11_table_stats (and of course itself).
3131 ots = xcalloc(p->n_tables, sizeof *ots);
3132 for (i = 0; i < p->n_tables; i++) {
3133 ots[i].table_id = i;
3134 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3135 ots[i].match = htonll(OFPXMT13_MASK);
3136 ots[i].wildcards = htonll(OFPXMT13_MASK);
3137 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3138 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3139 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3140 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3141 ots[i].metadata_match = OVS_BE64_MAX;
3142 ots[i].metadata_write = OVS_BE64_MAX;
3143 ots[i].instructions = htonl(OFPIT11_ALL);
3144 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3145 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3146 fat_rwlock_rdlock(&p->tables[i].cls.rwlock);
3147 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3148 fat_rwlock_unlock(&p->tables[i].cls.rwlock);
3151 p->ofproto_class->get_tables(p, ots);
3153 /* Post-process the tables, dropping hidden tables. */
3154 n_tables = p->n_tables;
3155 for (i = 0; i < p->n_tables; i++) {
3156 const struct oftable *table = &p->tables[i];
3158 if (table->flags & OFTABLE_HIDDEN) {
3164 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3167 if (table->max_flows < ntohl(ots[i].max_entries)) {
3168 ots[i].max_entries = htonl(table->max_flows);
3172 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3173 ofconn_send_reply(ofconn, msg);
3181 append_port_stat(struct ofport *port, struct list *replies)
3183 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3185 calc_duration(port->created, time_msec(),
3186 &ops.duration_sec, &ops.duration_nsec);
3188 /* Intentionally ignore return value, since errors will set
3189 * 'stats' to all-1s, which is correct for OpenFlow, and
3190 * netdev_get_stats() will log errors. */
3191 ofproto_port_get_stats(port, &ops.stats);
3193 ofputil_append_port_stat(replies, &ops);
3197 handle_port_request(struct ofconn *ofconn,
3198 const struct ofp_header *request, ofp_port_t port_no,
3199 void (*cb)(struct ofport *, struct list *replies))
3201 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3202 struct ofport *port;
3203 struct list replies;
3205 ofpmp_init(&replies, request);
3206 if (port_no != OFPP_ANY) {
3207 port = ofproto_get_port(ofproto, port_no);
3212 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3217 ofconn_send_replies(ofconn, &replies);
3221 handle_port_stats_request(struct ofconn *ofconn,
3222 const struct ofp_header *request)
3227 error = ofputil_decode_port_stats_request(request, &port_no);
3229 handle_port_request(ofconn, request, port_no, append_port_stat);
3235 append_port_desc(struct ofport *port, struct list *replies)
3237 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3241 handle_port_desc_stats_request(struct ofconn *ofconn,
3242 const struct ofp_header *request)
3247 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3249 handle_port_request(ofconn, request, port_no, append_port_desc);
3255 hash_cookie(ovs_be64 cookie)
3257 return hash_uint64((OVS_FORCE uint64_t)cookie);
3261 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3262 OVS_REQUIRES(ofproto_mutex)
3264 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3265 hash_cookie(rule->flow_cookie));
3269 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3270 OVS_REQUIRES(ofproto_mutex)
3272 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3276 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3277 ovs_be64 new_cookie)
3278 OVS_REQUIRES(ofproto_mutex)
3280 if (new_cookie != rule->flow_cookie) {
3281 cookies_remove(ofproto, rule);
3283 ovs_mutex_lock(&rule->mutex);
3284 rule->flow_cookie = new_cookie;
3285 ovs_mutex_unlock(&rule->mutex);
3287 cookies_insert(ofproto, rule);
3292 calc_duration(long long int start, long long int now,
3293 uint32_t *sec, uint32_t *nsec)
3295 long long int msecs = now - start;
3296 *sec = msecs / 1000;
3297 *nsec = (msecs % 1000) * (1000 * 1000);
3300 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3301 * true if 'table_id' is OK, false otherwise. */
3303 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3305 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3308 static struct oftable *
3309 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3311 struct oftable *table;
3313 for (table = &ofproto->tables[table_id];
3314 table < &ofproto->tables[ofproto->n_tables];
3316 if (!(table->flags & OFTABLE_HIDDEN)) {
3324 static struct oftable *
3325 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3327 if (table_id == 0xff) {
3328 return next_visible_table(ofproto, 0);
3329 } else if (table_id < ofproto->n_tables) {
3330 return &ofproto->tables[table_id];
3336 static struct oftable *
3337 next_matching_table(const struct ofproto *ofproto,
3338 const struct oftable *table, uint8_t table_id)
3340 return (table_id == 0xff
3341 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3345 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3347 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3348 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3350 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3351 * only once, for that table. (This can be used to access tables marked
3354 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3355 * entered at all. (Perhaps you should have validated TABLE_ID with
3356 * check_table_id().)
3358 * All parameters are evaluated multiple times.
3360 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3361 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3363 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3365 /* Initializes 'criteria' in a straightforward way based on the other
3368 * For "loose" matching, the 'priority' parameter is unimportant and may be
3371 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3372 const struct match *match, unsigned int priority,
3373 ovs_be64 cookie, ovs_be64 cookie_mask,
3374 ofp_port_t out_port, uint32_t out_group)
3376 criteria->table_id = table_id;
3377 cls_rule_init(&criteria->cr, match, priority);
3378 criteria->cookie = cookie;
3379 criteria->cookie_mask = cookie_mask;
3380 criteria->out_port = out_port;
3381 criteria->out_group = out_group;
3385 rule_criteria_destroy(struct rule_criteria *criteria)
3387 cls_rule_destroy(&criteria->cr);
3391 rule_collection_init(struct rule_collection *rules)
3393 rules->rules = rules->stub;
3395 rules->capacity = ARRAY_SIZE(rules->stub);
3399 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3401 if (rules->n >= rules->capacity) {
3402 size_t old_size, new_size;
3404 old_size = rules->capacity * sizeof *rules->rules;
3405 rules->capacity *= 2;
3406 new_size = rules->capacity * sizeof *rules->rules;
3408 if (rules->rules == rules->stub) {
3409 rules->rules = xmalloc(new_size);
3410 memcpy(rules->rules, rules->stub, old_size);
3412 rules->rules = xrealloc(rules->rules, new_size);
3416 rules->rules[rules->n++] = rule;
3420 rule_collection_ref(struct rule_collection *rules)
3421 OVS_REQUIRES(ofproto_mutex)
3425 for (i = 0; i < rules->n; i++) {
3426 ofproto_rule_ref(rules->rules[i]);
3431 rule_collection_unref(struct rule_collection *rules)
3435 for (i = 0; i < rules->n; i++) {
3436 ofproto_rule_unref(rules->rules[i]);
3441 rule_collection_destroy(struct rule_collection *rules)
3443 if (rules->rules != rules->stub) {
3449 collect_rule(struct rule *rule, const struct rule_criteria *c,
3450 struct rule_collection *rules)
3451 OVS_REQUIRES(ofproto_mutex)
3453 /* We ordinarily want to skip hidden rules, but there has to be a way for
3454 * code internal to OVS to modify and delete them, so if the criteria
3455 * specify a priority that can only be for a hidden flow, then allow hidden
3456 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3457 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3459 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3461 } else if (rule->pending) {
3462 return OFPROTO_POSTPONE;
3464 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3465 && ofproto_rule_has_out_port(rule, c->out_port)
3466 && ofproto_rule_has_out_group(rule, c->out_group)
3467 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3468 rule_collection_add(rules, rule);
3474 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3475 * on classifiers rules are done in the "loose" way required for OpenFlow
3476 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3479 * Hidden rules are always omitted.
3481 * Returns 0 on success, otherwise an OpenFlow error code. */
3483 collect_rules_loose(struct ofproto *ofproto,
3484 const struct rule_criteria *criteria,
3485 struct rule_collection *rules)
3486 OVS_REQUIRES(ofproto_mutex)
3488 struct oftable *table;
3489 enum ofperr error = 0;
3491 rule_collection_init(rules);
3493 if (!check_table_id(ofproto, criteria->table_id)) {
3494 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3498 if (criteria->cookie_mask == OVS_BE64_MAX) {
3501 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3502 hash_cookie(criteria->cookie),
3503 &ofproto->cookies) {
3504 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3505 error = collect_rule(rule, criteria, rules);
3512 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3513 struct cls_cursor cursor;
3516 fat_rwlock_rdlock(&table->cls.rwlock);
3517 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3518 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3519 error = collect_rule(rule, criteria, rules);
3524 fat_rwlock_unlock(&table->cls.rwlock);
3530 rule_collection_destroy(rules);
3535 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3536 * on classifiers rules are done in the "strict" way required for OpenFlow
3537 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3538 * rules on list 'rules'.
3540 * Hidden rules are always omitted.
3542 * Returns 0 on success, otherwise an OpenFlow error code. */
3544 collect_rules_strict(struct ofproto *ofproto,
3545 const struct rule_criteria *criteria,
3546 struct rule_collection *rules)
3547 OVS_REQUIRES(ofproto_mutex)
3549 struct oftable *table;
3552 rule_collection_init(rules);
3554 if (!check_table_id(ofproto, criteria->table_id)) {
3555 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3559 if (criteria->cookie_mask == OVS_BE64_MAX) {
3562 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3563 hash_cookie(criteria->cookie),
3564 &ofproto->cookies) {
3565 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3566 error = collect_rule(rule, criteria, rules);
3573 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3576 fat_rwlock_rdlock(&table->cls.rwlock);
3577 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3578 &table->cls, &criteria->cr));
3579 fat_rwlock_unlock(&table->cls.rwlock);
3581 error = collect_rule(rule, criteria, rules);
3591 rule_collection_destroy(rules);
3596 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3597 * forced into the range of a uint16_t. */
3599 age_secs(long long int age_ms)
3601 return (age_ms < 0 ? 0
3602 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3603 : (unsigned int) age_ms / 1000);
3607 handle_flow_stats_request(struct ofconn *ofconn,
3608 const struct ofp_header *request)
3609 OVS_EXCLUDED(ofproto_mutex)
3611 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3612 struct ofputil_flow_stats_request fsr;
3613 struct rule_criteria criteria;
3614 struct rule_collection rules;
3615 struct list replies;
3619 error = ofputil_decode_flow_stats_request(&fsr, request);
3624 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3625 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3627 ovs_mutex_lock(&ofproto_mutex);
3628 error = collect_rules_loose(ofproto, &criteria, &rules);
3629 rule_criteria_destroy(&criteria);
3631 rule_collection_ref(&rules);
3633 ovs_mutex_unlock(&ofproto_mutex);
3639 ofpmp_init(&replies, request);
3640 for (i = 0; i < rules.n; i++) {
3641 struct rule *rule = rules.rules[i];
3642 long long int now = time_msec();
3643 struct ofputil_flow_stats fs;
3644 long long int created, used, modified;
3645 const struct rule_actions *actions;
3646 enum ofputil_flow_mod_flags flags;
3648 ovs_mutex_lock(&rule->mutex);
3649 fs.cookie = rule->flow_cookie;
3650 fs.idle_timeout = rule->idle_timeout;
3651 fs.hard_timeout = rule->hard_timeout;
3652 created = rule->created;
3653 modified = rule->modified;
3654 actions = rule_get_actions(rule);
3655 flags = rule->flags;
3656 ovs_mutex_unlock(&rule->mutex);
3658 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3659 &fs.byte_count, &used);
3661 minimatch_expand(&rule->cr.match, &fs.match);
3662 fs.table_id = rule->table_id;
3663 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3664 fs.priority = rule->cr.priority;
3665 fs.idle_age = age_secs(now - used);
3666 fs.hard_age = age_secs(now - modified);
3667 fs.ofpacts = actions->ofpacts;
3668 fs.ofpacts_len = actions->ofpacts_len;
3671 ofputil_append_flow_stats_reply(&fs, &replies);
3674 rule_collection_unref(&rules);
3675 rule_collection_destroy(&rules);
3677 ofconn_send_replies(ofconn, &replies);
3683 flow_stats_ds(struct rule *rule, struct ds *results)
3685 uint64_t packet_count, byte_count;
3686 const struct rule_actions *actions;
3687 long long int created, used;
3689 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3690 &byte_count, &used);
3692 ovs_mutex_lock(&rule->mutex);
3693 actions = rule_get_actions(rule);
3694 created = rule->created;
3695 ovs_mutex_unlock(&rule->mutex);
3697 if (rule->table_id != 0) {
3698 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3700 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3701 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3702 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3703 cls_rule_format(&rule->cr, results);
3704 ds_put_char(results, ',');
3706 ds_put_cstr(results, "actions=");
3707 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3709 ds_put_cstr(results, "\n");
3712 /* Adds a pretty-printed description of all flows to 'results', including
3713 * hidden flows (e.g., set up by in-band control). */
3715 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3717 struct oftable *table;
3719 OFPROTO_FOR_EACH_TABLE (table, p) {
3720 struct cls_cursor cursor;
3723 fat_rwlock_rdlock(&table->cls.rwlock);
3724 cls_cursor_init(&cursor, &table->cls, NULL);
3725 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3726 flow_stats_ds(rule, results);
3728 fat_rwlock_unlock(&table->cls.rwlock);
3732 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3733 * '*engine_type' and '*engine_id', respectively. */
3735 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3736 uint8_t *engine_type, uint8_t *engine_id)
3738 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3741 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3742 * Returns 0 if the port's CFM status was successfully stored into
3743 * '*status'. Returns positive errno if the port did not have CFM
3744 * configured. Returns negative number if there is no status change
3745 * since last update.
3747 * The caller must provide and own '*status', and must free 'status->rmps'.
3748 * '*status' is indeterminate if the return value is non-zero. */
3750 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3751 struct ofproto_cfm_status *status)
3753 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3754 return (ofport && ofproto->ofproto_class->get_cfm_status
3755 ? ofproto->ofproto_class->get_cfm_status(ofport, status)
3760 handle_aggregate_stats_request(struct ofconn *ofconn,
3761 const struct ofp_header *oh)
3762 OVS_EXCLUDED(ofproto_mutex)
3764 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3765 struct ofputil_flow_stats_request request;
3766 struct ofputil_aggregate_stats stats;
3767 bool unknown_packets, unknown_bytes;
3768 struct rule_criteria criteria;
3769 struct rule_collection rules;
3770 struct ofpbuf *reply;
3774 error = ofputil_decode_flow_stats_request(&request, oh);
3779 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3780 request.cookie, request.cookie_mask,
3781 request.out_port, request.out_group);
3783 ovs_mutex_lock(&ofproto_mutex);
3784 error = collect_rules_loose(ofproto, &criteria, &rules);
3785 rule_criteria_destroy(&criteria);
3787 rule_collection_ref(&rules);
3789 ovs_mutex_unlock(&ofproto_mutex);
3795 memset(&stats, 0, sizeof stats);
3796 unknown_packets = unknown_bytes = false;
3797 for (i = 0; i < rules.n; i++) {
3798 struct rule *rule = rules.rules[i];
3799 uint64_t packet_count;
3800 uint64_t byte_count;
3803 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3804 &byte_count, &used);
3806 if (packet_count == UINT64_MAX) {
3807 unknown_packets = true;
3809 stats.packet_count += packet_count;
3812 if (byte_count == UINT64_MAX) {
3813 unknown_bytes = true;
3815 stats.byte_count += byte_count;
3820 if (unknown_packets) {
3821 stats.packet_count = UINT64_MAX;
3823 if (unknown_bytes) {
3824 stats.byte_count = UINT64_MAX;
3827 rule_collection_unref(&rules);
3828 rule_collection_destroy(&rules);
3830 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3831 ofconn_send_reply(ofconn, reply);
3836 struct queue_stats_cbdata {
3837 struct ofport *ofport;
3838 struct list replies;
3843 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3844 const struct netdev_queue_stats *stats)
3846 struct ofputil_queue_stats oqs;
3848 oqs.port_no = cbdata->ofport->pp.port_no;
3849 oqs.queue_id = queue_id;
3850 oqs.tx_bytes = stats->tx_bytes;
3851 oqs.tx_packets = stats->tx_packets;
3852 oqs.tx_errors = stats->tx_errors;
3853 if (stats->created != LLONG_MIN) {
3854 calc_duration(stats->created, cbdata->now,
3855 &oqs.duration_sec, &oqs.duration_nsec);
3857 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3859 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3863 handle_queue_stats_dump_cb(uint32_t queue_id,
3864 struct netdev_queue_stats *stats,
3867 struct queue_stats_cbdata *cbdata = cbdata_;
3869 put_queue_stats(cbdata, queue_id, stats);
3873 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3874 struct queue_stats_cbdata *cbdata)
3876 cbdata->ofport = port;
3877 if (queue_id == OFPQ_ALL) {
3878 netdev_dump_queue_stats(port->netdev,
3879 handle_queue_stats_dump_cb, cbdata);
3881 struct netdev_queue_stats stats;
3883 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3884 put_queue_stats(cbdata, queue_id, &stats);
3886 return OFPERR_OFPQOFC_BAD_QUEUE;
3893 handle_queue_stats_request(struct ofconn *ofconn,
3894 const struct ofp_header *rq)
3896 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3897 struct queue_stats_cbdata cbdata;
3898 struct ofport *port;
3900 struct ofputil_queue_stats_request oqsr;
3902 COVERAGE_INC(ofproto_queue_req);
3904 ofpmp_init(&cbdata.replies, rq);
3905 cbdata.now = time_msec();
3907 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3912 if (oqsr.port_no == OFPP_ANY) {
3913 error = OFPERR_OFPQOFC_BAD_QUEUE;
3914 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3915 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3920 port = ofproto_get_port(ofproto, oqsr.port_no);
3922 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3923 : OFPERR_OFPQOFC_BAD_PORT);
3926 ofconn_send_replies(ofconn, &cbdata.replies);
3928 ofpbuf_list_delete(&cbdata.replies);
3935 is_flow_deletion_pending(const struct ofproto *ofproto,
3936 const struct cls_rule *cls_rule,
3938 OVS_REQUIRES(ofproto_mutex)
3940 if (!hmap_is_empty(&ofproto->deletions)) {
3941 struct ofoperation *op;
3943 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3944 cls_rule_hash(cls_rule, table_id),
3945 &ofproto->deletions) {
3946 if (op->rule->table_id == table_id
3947 && cls_rule_equal(cls_rule, &op->rule->cr)) {
3957 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3958 OVS_REQUIRES(ofproto_mutex)
3959 OVS_NO_THREAD_SAFETY_ANALYSIS
3961 return classifier_count(&table->cls) + extra_space > table->max_flows;
3965 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3966 unsigned int extra_space)
3967 OVS_REQUIRES(ofproto_mutex)
3969 while (should_evict_a_rule(table, extra_space)) {
3972 if (!choose_rule_to_evict(table, &rule)) {
3973 return OFPERR_OFPFMFC_TABLE_FULL;
3974 } else if (rule->pending) {
3975 return OFPROTO_POSTPONE;
3977 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3978 delete_flow__(rule, group, OFPRR_EVICTION);
3979 ofopgroup_submit(group);
3986 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3987 * in which no matching flow already exists in the flow table.
3989 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3990 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3991 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3992 * initiated now but may be retried later.
3994 * The caller retains ownership of 'fm->ofpacts'.
3996 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3999 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
4000 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4001 OVS_REQUIRES(ofproto_mutex)
4003 struct oftable *table;
4009 if (!check_table_id(ofproto, fm->table_id)) {
4010 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4015 if (fm->table_id == 0xff) {
4016 if (ofproto->ofproto_class->rule_choose_table) {
4017 error = ofproto->ofproto_class->rule_choose_table(ofproto,
4023 ovs_assert(table_id < ofproto->n_tables);
4027 } else if (fm->table_id < ofproto->n_tables) {
4028 table_id = fm->table_id;
4030 return OFPERR_OFPBRC_BAD_TABLE_ID;
4033 table = &ofproto->tables[table_id];
4035 if (!oftable_is_modifiable(table, fm->flags)) {
4036 return OFPERR_OFPBRC_EPERM;
4039 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
4040 if (!match_has_default_hidden_fields(&fm->match)) {
4041 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
4042 "non-default values to hidden fields", ofproto->name);
4043 return OFPERR_OFPBRC_EPERM;
4047 cls_rule_init(&cr, &fm->match, fm->priority);
4049 /* Transform "add" into "modify" if there's an existing identical flow. */
4050 fat_rwlock_rdlock(&table->cls.rwlock);
4051 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4052 fat_rwlock_unlock(&table->cls.rwlock);
4054 cls_rule_destroy(&cr);
4055 if (!rule_is_modifiable(rule, fm->flags)) {
4056 return OFPERR_OFPBRC_EPERM;
4057 } else if (rule->pending) {
4058 return OFPROTO_POSTPONE;
4060 struct rule_collection rules;
4062 rule_collection_init(&rules);
4063 rule_collection_add(&rules, rule);
4064 fm->modify_cookie = true;
4065 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4066 rule_collection_destroy(&rules);
4072 /* Serialize against pending deletion. */
4073 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
4074 cls_rule_destroy(&cr);
4075 return OFPROTO_POSTPONE;
4078 /* Check for overlap, if requested. */
4079 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4082 fat_rwlock_rdlock(&table->cls.rwlock);
4083 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4084 fat_rwlock_unlock(&table->cls.rwlock);
4087 cls_rule_destroy(&cr);
4088 return OFPERR_OFPFMFC_OVERLAP;
4092 /* If necessary, evict an existing rule to clear out space. */
4093 error = evict_rules_from_table(ofproto, table, 1);
4095 cls_rule_destroy(&cr);
4099 /* Allocate new rule. */
4100 rule = ofproto->ofproto_class->rule_alloc();
4102 cls_rule_destroy(&cr);
4103 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4104 ofproto->name, ovs_strerror(error));
4108 /* Initialize base state. */
4109 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4110 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4111 ovs_refcount_init(&rule->ref_count);
4112 rule->pending = NULL;
4113 rule->flow_cookie = fm->new_cookie;
4114 rule->created = rule->modified = time_msec();
4116 ovs_mutex_init(&rule->mutex);
4117 ovs_mutex_lock(&rule->mutex);
4118 rule->idle_timeout = fm->idle_timeout;
4119 rule->hard_timeout = fm->hard_timeout;
4120 ovs_mutex_unlock(&rule->mutex);
4122 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4123 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4124 ovsrcu_set(&rule->actions,
4125 rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len));
4126 list_init(&rule->meter_list_node);
4127 rule->eviction_group = NULL;
4128 list_init(&rule->expirable);
4129 rule->monitor_flags = 0;
4130 rule->add_seqno = 0;
4131 rule->modify_seqno = 0;
4133 /* Construct rule, initializing derived state. */
4134 error = ofproto->ofproto_class->rule_construct(rule);
4136 ofproto_rule_destroy__(rule);
4141 do_add_flow(ofproto, ofconn, request, fm->buffer_id, rule);
4147 do_add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
4148 const struct ofp_header *request, uint32_t buffer_id,
4150 OVS_REQUIRES(ofproto_mutex)
4152 struct ofopgroup *group;
4154 oftable_insert_rule(rule);
4156 group = ofopgroup_create(ofproto, ofconn, request, buffer_id);
4157 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4158 ofproto->ofproto_class->rule_insert(rule);
4159 ofopgroup_submit(group);
4162 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4164 /* Modifies the rules listed in 'rules', changing their actions to match those
4167 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4170 * Returns 0 on success, otherwise an OpenFlow error code. */
4172 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4173 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4174 const struct rule_collection *rules)
4175 OVS_REQUIRES(ofproto_mutex)
4177 enum ofoperation_type type;
4178 struct ofopgroup *group;
4182 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4183 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4184 error = OFPERR_OFPBRC_EPERM;
4185 for (i = 0; i < rules->n; i++) {
4186 struct rule *rule = rules->rules[i];
4187 const struct rule_actions *actions;
4188 struct ofoperation *op;
4189 bool actions_changed;
4190 bool reset_counters;
4192 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4194 if (rule_is_modifiable(rule, fm->flags)) {
4195 /* At least one rule is modifiable, don't report EPERM error. */
4201 actions = rule_get_actions(rule);
4202 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4204 actions->ofpacts_len);
4206 op = ofoperation_create(group, rule, type, 0);
4208 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4209 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4211 if (type == OFOPERATION_REPLACE) {
4212 ovs_mutex_lock(&rule->mutex);
4213 rule->idle_timeout = fm->idle_timeout;
4214 rule->hard_timeout = fm->hard_timeout;
4215 ovs_mutex_unlock(&rule->mutex);
4217 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4218 if (fm->idle_timeout || fm->hard_timeout) {
4219 if (!rule->eviction_group) {
4220 eviction_group_add_rule(rule);
4223 eviction_group_remove_rule(rule);
4227 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4228 if (actions_changed || reset_counters) {
4229 const struct rule_actions *new_actions;
4231 op->actions = rule_get_actions(rule);
4232 new_actions = rule_actions_create(ofproto,
4233 fm->ofpacts, fm->ofpacts_len);
4235 ovsrcu_set(&rule->actions, new_actions);
4237 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4240 ofoperation_complete(op, 0);
4243 ofopgroup_submit(group);
4249 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4250 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4251 OVS_REQUIRES(ofproto_mutex)
4253 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4256 return add_flow(ofproto, ofconn, fm, request);
4259 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4262 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4265 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4266 struct ofputil_flow_mod *fm,
4267 const struct ofp_header *request)
4268 OVS_REQUIRES(ofproto_mutex)
4270 struct rule_criteria criteria;
4271 struct rule_collection rules;
4274 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4275 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4276 error = collect_rules_loose(ofproto, &criteria, &rules);
4277 rule_criteria_destroy(&criteria);
4280 error = (rules.n > 0
4281 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4282 : modify_flows_add(ofproto, ofconn, fm, request));
4285 rule_collection_destroy(&rules);
4290 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4293 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4296 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4297 struct ofputil_flow_mod *fm,
4298 const struct ofp_header *request)
4299 OVS_REQUIRES(ofproto_mutex)
4301 struct rule_criteria criteria;
4302 struct rule_collection rules;
4305 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4306 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4307 error = collect_rules_strict(ofproto, &criteria, &rules);
4308 rule_criteria_destroy(&criteria);
4312 error = modify_flows_add(ofproto, ofconn, fm, request);
4313 } else if (rules.n == 1) {
4314 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4318 rule_collection_destroy(&rules);
4323 /* OFPFC_DELETE implementation. */
4326 delete_flow__(struct rule *rule, struct ofopgroup *group,
4327 enum ofp_flow_removed_reason reason)
4328 OVS_REQUIRES(ofproto_mutex)
4330 struct ofproto *ofproto = rule->ofproto;
4332 ofproto_rule_send_removed(rule, reason);
4334 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4335 oftable_remove_rule(rule);
4336 ofproto->ofproto_class->rule_delete(rule);
4339 /* Deletes the rules listed in 'rules'.
4341 * Returns 0 on success, otherwise an OpenFlow error code. */
4343 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4344 const struct ofp_header *request,
4345 const struct rule_collection *rules,
4346 enum ofp_flow_removed_reason reason)
4347 OVS_REQUIRES(ofproto_mutex)
4349 struct ofopgroup *group;
4352 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4353 for (i = 0; i < rules->n; i++) {
4354 delete_flow__(rules->rules[i], group, reason);
4356 ofopgroup_submit(group);
4361 /* Implements OFPFC_DELETE. */
4363 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4364 const struct ofputil_flow_mod *fm,
4365 const struct ofp_header *request)
4366 OVS_REQUIRES(ofproto_mutex)
4368 struct rule_criteria criteria;
4369 struct rule_collection rules;
4372 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4373 fm->cookie, fm->cookie_mask,
4374 fm->out_port, fm->out_group);
4375 error = collect_rules_loose(ofproto, &criteria, &rules);
4376 rule_criteria_destroy(&criteria);
4378 if (!error && rules.n > 0) {
4379 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4381 rule_collection_destroy(&rules);
4386 /* Implements OFPFC_DELETE_STRICT. */
4388 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4389 const struct ofputil_flow_mod *fm,
4390 const struct ofp_header *request)
4391 OVS_REQUIRES(ofproto_mutex)
4393 struct rule_criteria criteria;
4394 struct rule_collection rules;
4397 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4398 fm->cookie, fm->cookie_mask,
4399 fm->out_port, fm->out_group);
4400 error = collect_rules_strict(ofproto, &criteria, &rules);
4401 rule_criteria_destroy(&criteria);
4403 if (!error && rules.n > 0) {
4404 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4406 rule_collection_destroy(&rules);
4412 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4413 OVS_REQUIRES(ofproto_mutex)
4415 struct ofputil_flow_removed fr;
4418 if (ofproto_rule_is_hidden(rule) ||
4419 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4423 minimatch_expand(&rule->cr.match, &fr.match);
4424 fr.priority = rule->cr.priority;
4425 fr.cookie = rule->flow_cookie;
4427 fr.table_id = rule->table_id;
4428 calc_duration(rule->created, time_msec(),
4429 &fr.duration_sec, &fr.duration_nsec);
4430 ovs_mutex_lock(&rule->mutex);
4431 fr.idle_timeout = rule->idle_timeout;
4432 fr.hard_timeout = rule->hard_timeout;
4433 ovs_mutex_unlock(&rule->mutex);
4434 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4435 &fr.byte_count, &used);
4437 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4440 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4441 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4444 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4447 * ofproto implementation ->run() functions should use this function to expire
4448 * OpenFlow flows. */
4450 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4451 OVS_REQUIRES(ofproto_mutex)
4453 struct ofproto *ofproto = rule->ofproto;
4455 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4456 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4458 ofproto_rule_delete__(ofproto, rule, reason);
4461 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4462 * means "infinite". */
4464 reduce_timeout(uint16_t max, uint16_t *timeout)
4466 if (max && (!*timeout || *timeout > max)) {
4471 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4472 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4473 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4475 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4477 ofproto_rule_reduce_timeouts(struct rule *rule,
4478 uint16_t idle_timeout, uint16_t hard_timeout)
4479 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4481 if (!idle_timeout && !hard_timeout) {
4485 ovs_mutex_lock(&ofproto_mutex);
4486 if (list_is_empty(&rule->expirable)) {
4487 list_insert(&rule->ofproto->expirable, &rule->expirable);
4489 ovs_mutex_unlock(&ofproto_mutex);
4491 ovs_mutex_lock(&rule->mutex);
4492 reduce_timeout(idle_timeout, &rule->idle_timeout);
4493 reduce_timeout(hard_timeout, &rule->hard_timeout);
4494 ovs_mutex_unlock(&rule->mutex);
4498 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4499 OVS_EXCLUDED(ofproto_mutex)
4501 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4502 struct ofputil_flow_mod fm;
4503 uint64_t ofpacts_stub[1024 / 8];
4504 struct ofpbuf ofpacts;
4507 error = reject_slave_controller(ofconn);
4512 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4513 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4515 u16_to_ofp(ofproto->max_ports),
4518 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4521 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4524 goto exit_free_ofpacts;
4527 ofconn_report_flow_mod(ofconn, fm.command);
4530 ofpbuf_uninit(&ofpacts);
4536 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4537 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4538 OVS_EXCLUDED(ofproto_mutex)
4542 ovs_mutex_lock(&ofproto_mutex);
4543 if (ofproto->n_pending < 50) {
4544 switch (fm->command) {
4546 error = add_flow(ofproto, ofconn, fm, oh);
4550 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4553 case OFPFC_MODIFY_STRICT:
4554 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4558 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4561 case OFPFC_DELETE_STRICT:
4562 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4566 if (fm->command > 0xff) {
4567 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4568 "flow_mod_table_id extension is not enabled",
4571 error = OFPERR_OFPFMFC_BAD_COMMAND;
4575 ovs_assert(!list_is_empty(&ofproto->pending));
4576 error = OFPROTO_POSTPONE;
4578 ovs_mutex_unlock(&ofproto_mutex);
4580 run_rule_executes(ofproto);
4585 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4587 struct ofputil_role_request request;
4588 struct ofputil_role_request reply;
4592 error = ofputil_decode_role_message(oh, &request);
4597 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4598 if (ofconn_get_role(ofconn) != request.role
4599 && ofconn_has_pending_opgroups(ofconn)) {
4600 return OFPROTO_POSTPONE;
4603 if (request.have_generation_id
4604 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4605 return OFPERR_OFPRRFC_STALE;
4608 ofconn_set_role(ofconn, request.role);
4611 reply.role = ofconn_get_role(ofconn);
4612 reply.have_generation_id = ofconn_get_master_election_id(
4613 ofconn, &reply.generation_id);
4614 buf = ofputil_encode_role_reply(oh, &reply);
4615 ofconn_send_reply(ofconn, buf);
4621 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4622 const struct ofp_header *oh)
4624 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4625 enum ofputil_protocol cur, next;
4627 cur = ofconn_get_protocol(ofconn);
4628 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4629 ofconn_set_protocol(ofconn, next);
4635 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4637 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4638 enum ofputil_protocol cur, next;
4639 enum ofputil_protocol next_base;
4641 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4643 return OFPERR_OFPBRC_EPERM;
4646 cur = ofconn_get_protocol(ofconn);
4647 next = ofputil_protocol_set_base(cur, next_base);
4648 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4649 /* Avoid sending async messages in surprising protocol. */
4650 return OFPROTO_POSTPONE;
4653 ofconn_set_protocol(ofconn, next);
4658 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4659 const struct ofp_header *oh)
4661 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4664 format = ntohl(msg->format);
4665 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4666 return OFPERR_OFPBRC_EPERM;
4669 if (format != ofconn_get_packet_in_format(ofconn)
4670 && ofconn_has_pending_opgroups(ofconn)) {
4671 /* Avoid sending async message in surprsing packet in format. */
4672 return OFPROTO_POSTPONE;
4675 ofconn_set_packet_in_format(ofconn, format);
4680 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4682 const struct nx_async_config *msg = ofpmsg_body(oh);
4683 uint32_t master[OAM_N_TYPES];
4684 uint32_t slave[OAM_N_TYPES];
4686 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4687 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4688 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4690 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4691 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4692 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4694 ofconn_set_async_config(ofconn, master, slave);
4695 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4696 !ofconn_get_miss_send_len(ofconn)) {
4697 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4704 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4707 uint32_t master[OAM_N_TYPES];
4708 uint32_t slave[OAM_N_TYPES];
4709 struct nx_async_config *msg;
4711 ofconn_get_async_config(ofconn, master, slave);
4712 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4713 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4715 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4716 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4717 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4719 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4720 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4721 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4723 ofconn_send_reply(ofconn, buf);
4729 handle_nxt_set_controller_id(struct ofconn *ofconn,
4730 const struct ofp_header *oh)
4732 const struct nx_controller_id *nci = ofpmsg_body(oh);
4734 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4735 return OFPERR_NXBRC_MUST_BE_ZERO;
4738 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4743 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4747 if (ofconn_has_pending_opgroups(ofconn)) {
4748 return OFPROTO_POSTPONE;
4751 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4752 ? OFPRAW_OFPT10_BARRIER_REPLY
4753 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4754 ofconn_send_reply(ofconn, buf);
4759 ofproto_compose_flow_refresh_update(const struct rule *rule,
4760 enum nx_flow_monitor_flags flags,
4762 OVS_REQUIRES(ofproto_mutex)
4764 struct ofoperation *op = rule->pending;
4765 const struct rule_actions *actions;
4766 struct ofputil_flow_update fu;
4769 if (op && op->type == OFOPERATION_ADD) {
4770 /* We'll report the final flow when the operation completes. Reporting
4771 * it now would cause a duplicate report later. */
4775 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4776 ? NXFME_ADDED : NXFME_MODIFIED);
4778 ovs_mutex_lock(&rule->mutex);
4779 fu.idle_timeout = rule->idle_timeout;
4780 fu.hard_timeout = rule->hard_timeout;
4781 ovs_mutex_unlock(&rule->mutex);
4782 fu.table_id = rule->table_id;
4783 fu.cookie = rule->flow_cookie;
4784 minimatch_expand(&rule->cr.match, &match);
4786 fu.priority = rule->cr.priority;
4788 if (!(flags & NXFMF_ACTIONS)) {
4791 actions = rule_get_actions(rule);
4793 /* An operation is in progress. Use the previous version of the flow's
4794 * actions, so that when the operation commits we report the change. */
4796 case OFOPERATION_ADD:
4799 case OFOPERATION_MODIFY:
4800 case OFOPERATION_REPLACE:
4801 actions = op->actions ? op->actions : rule_get_actions(rule);
4804 case OFOPERATION_DELETE:
4805 actions = rule_get_actions(rule);
4812 fu.ofpacts = actions ? actions->ofpacts : NULL;
4813 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4815 if (list_is_empty(msgs)) {
4816 ofputil_start_flow_update(msgs);
4818 ofputil_append_flow_update(&fu, msgs);
4822 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4824 OVS_REQUIRES(ofproto_mutex)
4828 for (i = 0; i < rules->n; i++) {
4829 struct rule *rule = rules->rules[i];
4830 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4831 rule->monitor_flags = 0;
4833 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4838 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4839 struct rule *rule, uint64_t seqno,
4840 struct rule_collection *rules)
4841 OVS_REQUIRES(ofproto_mutex)
4843 enum nx_flow_monitor_flags update;
4845 if (ofproto_rule_is_hidden(rule)) {
4850 ? ofoperation_has_out_port(rule->pending, m->out_port)
4851 : ofproto_rule_has_out_port(rule, m->out_port))) {
4856 if (rule->add_seqno > seqno) {
4857 update = NXFMF_ADD | NXFMF_MODIFY;
4858 } else if (rule->modify_seqno > seqno) {
4859 update = NXFMF_MODIFY;
4864 if (!(m->flags & update)) {
4868 update = NXFMF_INITIAL;
4871 if (!rule->monitor_flags) {
4872 rule_collection_add(rules, rule);
4874 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4878 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4880 struct rule_collection *rules)
4881 OVS_REQUIRES(ofproto_mutex)
4883 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4884 const struct ofoperation *op;
4885 const struct oftable *table;
4886 struct cls_rule target;
4888 cls_rule_init_from_minimatch(&target, &m->match, 0);
4889 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4890 struct cls_cursor cursor;
4893 fat_rwlock_rdlock(&table->cls.rwlock);
4894 cls_cursor_init(&cursor, &table->cls, &target);
4895 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4896 ovs_assert(!rule->pending); /* XXX */
4897 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4899 fat_rwlock_unlock(&table->cls.rwlock);
4902 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4903 struct rule *rule = op->rule;
4905 if (((m->table_id == 0xff
4906 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4907 : m->table_id == rule->table_id))
4908 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4909 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4912 cls_rule_destroy(&target);
4916 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4917 struct rule_collection *rules)
4918 OVS_REQUIRES(ofproto_mutex)
4920 if (m->flags & NXFMF_INITIAL) {
4921 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4926 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4927 uint64_t seqno, struct rule_collection *rules)
4928 OVS_REQUIRES(ofproto_mutex)
4930 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4934 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4935 OVS_EXCLUDED(ofproto_mutex)
4937 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4938 struct ofmonitor **monitors;
4939 size_t n_monitors, allocated_monitors;
4940 struct rule_collection rules;
4941 struct list replies;
4947 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4949 n_monitors = allocated_monitors = 0;
4951 ovs_mutex_lock(&ofproto_mutex);
4953 struct ofputil_flow_monitor_request request;
4954 struct ofmonitor *m;
4957 retval = ofputil_decode_flow_monitor_request(&request, &b);
4958 if (retval == EOF) {
4960 } else if (retval) {
4965 if (request.table_id != 0xff
4966 && request.table_id >= ofproto->n_tables) {
4967 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4971 error = ofmonitor_create(&request, ofconn, &m);
4976 if (n_monitors >= allocated_monitors) {
4977 monitors = x2nrealloc(monitors, &allocated_monitors,
4980 monitors[n_monitors++] = m;
4983 rule_collection_init(&rules);
4984 for (i = 0; i < n_monitors; i++) {
4985 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4988 ofpmp_init(&replies, oh);
4989 ofmonitor_compose_refresh_updates(&rules, &replies);
4990 ovs_mutex_unlock(&ofproto_mutex);
4992 rule_collection_destroy(&rules);
4994 ofconn_send_replies(ofconn, &replies);
5000 for (i = 0; i < n_monitors; i++) {
5001 ofmonitor_destroy(monitors[i]);
5004 ovs_mutex_unlock(&ofproto_mutex);
5010 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
5011 OVS_EXCLUDED(ofproto_mutex)
5013 struct ofmonitor *m;
5017 id = ofputil_decode_flow_monitor_cancel(oh);
5019 ovs_mutex_lock(&ofproto_mutex);
5020 m = ofmonitor_lookup(ofconn, id);
5022 ofmonitor_destroy(m);
5025 error = OFPERR_NXBRC_FM_BAD_ID;
5027 ovs_mutex_unlock(&ofproto_mutex);
5032 /* Meters implementation.
5034 * Meter table entry, indexed by the OpenFlow meter_id.
5035 * 'created' is used to compute the duration for meter stats.
5036 * 'list rules' is needed so that we can delete the dependent rules when the
5037 * meter table entry is deleted.
5038 * 'provider_meter_id' is for the provider's private use.
5041 long long int created; /* Time created. */
5042 struct list rules; /* List of "struct rule_dpif"s. */
5043 ofproto_meter_id provider_meter_id;
5044 uint16_t flags; /* Meter flags. */
5045 uint16_t n_bands; /* Number of meter bands. */
5046 struct ofputil_meter_band *bands;
5050 * This is used in instruction validation at flow set-up time,
5051 * as flows may not use non-existing meters.
5052 * Return value of UINT32_MAX signifies an invalid meter.
5055 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5057 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5058 const struct meter *meter = ofproto->meters[of_meter_id];
5060 return meter->provider_meter_id.uint32;
5067 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5071 meter->flags = config->flags;
5072 meter->n_bands = config->n_bands;
5073 meter->bands = xmemdup(config->bands,
5074 config->n_bands * sizeof *meter->bands);
5077 static struct meter *
5078 meter_create(const struct ofputil_meter_config *config,
5079 ofproto_meter_id provider_meter_id)
5081 struct meter *meter;
5083 meter = xzalloc(sizeof *meter);
5084 meter->provider_meter_id = provider_meter_id;
5085 meter->created = time_msec();
5086 list_init(&meter->rules);
5088 meter_update(meter, config);
5094 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5095 OVS_REQUIRES(ofproto_mutex)
5098 for (mid = first; mid <= last; ++mid) {
5099 struct meter *meter = ofproto->meters[mid];
5101 ofproto->meters[mid] = NULL;
5102 ofproto->ofproto_class->meter_del(ofproto,
5103 meter->provider_meter_id);
5111 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5113 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5114 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5118 return OFPERR_OFPMMFC_METER_EXISTS;
5121 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5124 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5125 *meterp = meter_create(&mm->meter, provider_meter_id);
5131 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5133 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5135 uint32_t provider_meter_id;
5138 return OFPERR_OFPMMFC_UNKNOWN_METER;
5141 provider_meter_id = meter->provider_meter_id.uint32;
5142 error = ofproto->ofproto_class->meter_set(ofproto,
5143 &meter->provider_meter_id,
5145 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5147 meter_update(meter, &mm->meter);
5153 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5154 struct ofputil_meter_mod *mm)
5155 OVS_EXCLUDED(ofproto_mutex)
5157 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5158 uint32_t meter_id = mm->meter.meter_id;
5159 struct rule_collection rules;
5160 enum ofperr error = 0;
5161 uint32_t first, last;
5163 if (meter_id == OFPM13_ALL) {
5165 last = ofproto->meter_features.max_meters;
5167 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5170 first = last = meter_id;
5173 /* First delete the rules that use this meter. If any of those rules are
5174 * currently being modified, postpone the whole operation until later. */
5175 rule_collection_init(&rules);
5176 ovs_mutex_lock(&ofproto_mutex);
5177 for (meter_id = first; meter_id <= last; ++meter_id) {
5178 struct meter *meter = ofproto->meters[meter_id];
5179 if (meter && !list_is_empty(&meter->rules)) {
5182 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5183 if (rule->pending) {
5184 error = OFPROTO_POSTPONE;
5187 rule_collection_add(&rules, rule);
5192 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5195 /* Delete the meters. */
5196 meter_delete(ofproto, first, last);
5199 ovs_mutex_unlock(&ofproto_mutex);
5200 rule_collection_destroy(&rules);
5206 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5208 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5209 struct ofputil_meter_mod mm;
5210 uint64_t bands_stub[256 / 8];
5211 struct ofpbuf bands;
5215 error = reject_slave_controller(ofconn);
5220 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5222 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5224 goto exit_free_bands;
5227 meter_id = mm.meter.meter_id;
5229 if (mm.command != OFPMC13_DELETE) {
5230 /* Fails also when meters are not implemented by the provider. */
5231 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5232 error = OFPERR_OFPMMFC_INVALID_METER;
5233 goto exit_free_bands;
5234 } else if (meter_id > ofproto->meter_features.max_meters) {
5235 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5236 goto exit_free_bands;
5238 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5239 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5240 goto exit_free_bands;
5244 switch (mm.command) {
5246 error = handle_add_meter(ofproto, &mm);
5249 case OFPMC13_MODIFY:
5250 error = handle_modify_meter(ofproto, &mm);
5253 case OFPMC13_DELETE:
5254 error = handle_delete_meter(ofconn, oh, &mm);
5258 error = OFPERR_OFPMMFC_BAD_COMMAND;
5263 ofpbuf_uninit(&bands);
5268 handle_meter_features_request(struct ofconn *ofconn,
5269 const struct ofp_header *request)
5271 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5272 struct ofputil_meter_features features;
5275 if (ofproto->ofproto_class->meter_get_features) {
5276 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5278 memset(&features, 0, sizeof features);
5280 b = ofputil_encode_meter_features_reply(&features, request);
5282 ofconn_send_reply(ofconn, b);
5287 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5290 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5291 struct list replies;
5292 uint64_t bands_stub[256 / 8];
5293 struct ofpbuf bands;
5294 uint32_t meter_id, first, last;
5296 ofputil_decode_meter_request(request, &meter_id);
5298 if (meter_id == OFPM13_ALL) {
5300 last = ofproto->meter_features.max_meters;
5302 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5303 !ofproto->meters[meter_id]) {
5304 return OFPERR_OFPMMFC_UNKNOWN_METER;
5306 first = last = meter_id;
5309 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5310 ofpmp_init(&replies, request);
5312 for (meter_id = first; meter_id <= last; ++meter_id) {
5313 struct meter *meter = ofproto->meters[meter_id];
5315 continue; /* Skip non-existing meters. */
5317 if (type == OFPTYPE_METER_STATS_REQUEST) {
5318 struct ofputil_meter_stats stats;
5320 stats.meter_id = meter_id;
5322 /* Provider sets the packet and byte counts, we do the rest. */
5323 stats.flow_count = list_size(&meter->rules);
5324 calc_duration(meter->created, time_msec(),
5325 &stats.duration_sec, &stats.duration_nsec);
5326 stats.n_bands = meter->n_bands;
5327 ofpbuf_clear(&bands);
5329 = ofpbuf_put_uninit(&bands,
5330 meter->n_bands * sizeof *stats.bands);
5332 if (!ofproto->ofproto_class->meter_get(ofproto,
5333 meter->provider_meter_id,
5335 ofputil_append_meter_stats(&replies, &stats);
5337 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5338 struct ofputil_meter_config config;
5340 config.meter_id = meter_id;
5341 config.flags = meter->flags;
5342 config.n_bands = meter->n_bands;
5343 config.bands = meter->bands;
5344 ofputil_append_meter_config(&replies, &config);
5348 ofconn_send_replies(ofconn, &replies);
5349 ofpbuf_uninit(&bands);
5354 ofproto_group_lookup__(const struct ofproto *ofproto, uint32_t group_id,
5355 struct ofgroup **group)
5356 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5358 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5359 hash_int(group_id, 0), &ofproto->groups) {
5360 if ((*group)->group_id == group_id) {
5368 /* If the group exists, this function increments the groups's reference count.
5370 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5371 * a reference to the group. */
5373 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5374 struct ofgroup **group)
5378 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5379 found = ofproto_group_lookup__(ofproto, group_id, group);
5381 ofproto_group_ref(*group);
5383 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5388 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5389 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5391 struct ofgroup *grp;
5393 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5394 hash_int(group_id, 0), &ofproto->groups) {
5395 if (grp->group_id == group_id) {
5403 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5404 OVS_EXCLUDED(ofproto->groups_rwlock)
5408 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5409 exists = ofproto_group_exists__(ofproto, group_id);
5410 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5416 group_get_ref_count(struct ofgroup *group)
5417 OVS_EXCLUDED(ofproto_mutex)
5419 struct ofproto *ofproto = CONST_CAST(struct ofproto *, group->ofproto);
5420 struct rule_criteria criteria;
5421 struct rule_collection rules;
5426 match_init_catchall(&match);
5427 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5428 OFPP_ANY, group->group_id);
5429 ovs_mutex_lock(&ofproto_mutex);
5430 error = collect_rules_loose(ofproto, &criteria, &rules);
5431 ovs_mutex_unlock(&ofproto_mutex);
5432 rule_criteria_destroy(&criteria);
5434 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5436 rule_collection_destroy(&rules);
5441 append_group_stats(struct ofgroup *group, struct list *replies)
5443 struct ofputil_group_stats ogs;
5444 const struct ofproto *ofproto = group->ofproto;
5445 long long int now = time_msec();
5448 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5450 /* Provider sets the packet and byte counts, we do the rest. */
5451 ogs.ref_count = group_get_ref_count(group);
5452 ogs.n_buckets = group->n_buckets;
5454 error = (ofproto->ofproto_class->group_get_stats
5455 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5458 ogs.packet_count = UINT64_MAX;
5459 ogs.byte_count = UINT64_MAX;
5460 memset(ogs.bucket_stats, 0xff,
5461 ogs.n_buckets * sizeof *ogs.bucket_stats);
5464 ogs.group_id = group->group_id;
5465 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5467 ofputil_append_group_stats(replies, &ogs);
5469 free(ogs.bucket_stats);
5473 handle_group_request(struct ofconn *ofconn,
5474 const struct ofp_header *request, uint32_t group_id,
5475 void (*cb)(struct ofgroup *, struct list *replies))
5477 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5478 struct ofgroup *group;
5479 struct list replies;
5481 ofpmp_init(&replies, request);
5482 if (group_id == OFPG_ALL) {
5483 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5484 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5485 cb(group, &replies);
5487 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5489 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5490 cb(group, &replies);
5491 ofproto_group_unref(group);
5494 ofconn_send_replies(ofconn, &replies);
5498 handle_group_stats_request(struct ofconn *ofconn,
5499 const struct ofp_header *request)
5504 error = ofputil_decode_group_stats_request(request, &group_id);
5509 handle_group_request(ofconn, request, group_id, append_group_stats);
5514 append_group_desc(struct ofgroup *group, struct list *replies)
5516 struct ofputil_group_desc gds;
5518 gds.group_id = group->group_id;
5519 gds.type = group->type;
5520 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5524 handle_group_desc_stats_request(struct ofconn *ofconn,
5525 const struct ofp_header *request)
5527 handle_group_request(ofconn, request,
5528 ofputil_decode_group_desc_request(request),
5534 handle_group_features_stats_request(struct ofconn *ofconn,
5535 const struct ofp_header *request)
5537 struct ofproto *p = ofconn_get_ofproto(ofconn);
5540 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5542 ofconn_send_reply(ofconn, msg);
5549 handle_queue_get_config_request(struct ofconn *ofconn,
5550 const struct ofp_header *oh)
5552 struct ofproto *p = ofconn_get_ofproto(ofconn);
5553 struct netdev_queue_dump queue_dump;
5554 struct ofport *ofport;
5555 unsigned int queue_id;
5556 struct ofpbuf *reply;
5557 struct smap details;
5561 error = ofputil_decode_queue_get_config_request(oh, &request);
5566 ofport = ofproto_get_port(p, request);
5568 return OFPERR_OFPQOFC_BAD_PORT;
5571 reply = ofputil_encode_queue_get_config_reply(oh);
5573 smap_init(&details);
5574 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5575 struct ofputil_queue_config queue;
5577 /* None of the existing queues have compatible properties, so we
5578 * hard-code omitting min_rate and max_rate. */
5579 queue.queue_id = queue_id;
5580 queue.min_rate = UINT16_MAX;
5581 queue.max_rate = UINT16_MAX;
5582 ofputil_append_queue_get_config_reply(reply, &queue);
5584 smap_destroy(&details);
5586 ofconn_send_reply(ofconn, reply);
5592 init_group(struct ofproto *ofproto, struct ofputil_group_mod *gm,
5593 struct ofgroup **ofgroup)
5596 const long long int now = time_msec();
5598 if (gm->group_id > OFPG_MAX) {
5599 return OFPERR_OFPGMFC_INVALID_GROUP;
5601 if (gm->type > OFPGT11_FF) {
5602 return OFPERR_OFPGMFC_BAD_TYPE;
5605 *ofgroup = ofproto->ofproto_class->group_alloc();
5607 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5608 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5611 (*ofgroup)->ofproto = ofproto;
5612 *CONST_CAST(uint32_t *, &((*ofgroup)->group_id)) = gm->group_id;
5613 *CONST_CAST(enum ofp11_group_type *, &(*ofgroup)->type) = gm->type;
5614 *CONST_CAST(long long int *, &((*ofgroup)->created)) = now;
5615 *CONST_CAST(long long int *, &((*ofgroup)->modified)) = now;
5616 ovs_refcount_init(&(*ofgroup)->ref_count);
5618 list_move(&(*ofgroup)->buckets, &gm->buckets);
5619 *CONST_CAST(uint32_t *, &(*ofgroup)->n_buckets) =
5620 list_size(&(*ofgroup)->buckets);
5622 /* Construct called BEFORE any locks are held. */
5623 error = ofproto->ofproto_class->group_construct(*ofgroup);
5625 ofputil_bucket_list_destroy(&(*ofgroup)->buckets);
5626 ofproto->ofproto_class->group_dealloc(*ofgroup);
5631 /* Implements OFPGC11_ADD
5632 * in which no matching flow already exists in the flow table.
5634 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5635 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5636 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5637 * initiated now but may be retried later.
5639 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5640 * ownership remains with the caller.
5642 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5645 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5647 struct ofgroup *ofgroup;
5650 /* Allocate new group and initialize it. */
5651 error = init_group(ofproto, gm, &ofgroup);
5656 /* We wrlock as late as possible to minimize the time we jam any other
5657 * threads: No visible state changes before acquiring the lock. */
5658 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5660 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5661 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5665 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5666 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5671 /* Insert new group. */
5672 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5673 hash_int(ofgroup->group_id, 0));
5674 ofproto->n_groups[ofgroup->type]++;
5676 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5681 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5682 ofproto->ofproto_class->group_destruct(ofgroup);
5683 ofputil_bucket_list_destroy(&ofgroup->buckets);
5684 ofproto->ofproto_class->group_dealloc(ofgroup);
5689 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5692 * Note that the group is re-created and then replaces the old group in
5693 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
5694 * the xlate module hold a pointer to the group.
5696 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5699 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5701 struct ofgroup *ofgroup, *new_ofgroup, *retiring;
5704 error = init_group(ofproto, gm, &new_ofgroup);
5709 retiring = new_ofgroup;
5711 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5712 if (!ofproto_group_lookup__(ofproto, gm->group_id, &ofgroup)) {
5713 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5717 /* Ofproto's group write lock is held now. */
5718 if (ofgroup->type != gm->type
5719 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5720 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5724 /* The group creation time does not change during modification. */
5725 *CONST_CAST(long long int *, &(new_ofgroup->created)) = ofgroup->created;
5726 *CONST_CAST(long long int *, &(new_ofgroup->modified)) = time_msec();
5728 error = ofproto->ofproto_class->group_modify(new_ofgroup);
5734 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
5735 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5736 hmap_insert(&ofproto->groups, &new_ofgroup->hmap_node,
5737 hash_int(new_ofgroup->group_id, 0));
5738 if (ofgroup->type != new_ofgroup->type) {
5739 ofproto->n_groups[ofgroup->type]--;
5740 ofproto->n_groups[new_ofgroup->type]++;
5744 ofproto_group_unref(retiring);
5745 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5750 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5751 OVS_RELEASES(ofproto->groups_rwlock)
5754 struct ofputil_flow_mod fm;
5756 /* Delete all flow entries containing this group in a group action */
5757 match_init_catchall(&match);
5758 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5759 fm.out_group = ofgroup->group_id;
5760 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5762 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5763 /* No-one can find this group any more. */
5764 ofproto->n_groups[ofgroup->type]--;
5765 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5766 ofproto_group_unref(ofgroup);
5769 /* Implements OFPGC_DELETE. */
5771 delete_group(struct ofproto *ofproto, uint32_t group_id)
5773 struct ofgroup *ofgroup;
5775 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5776 if (group_id == OFPG_ALL) {
5778 struct hmap_node *node = hmap_first(&ofproto->groups);
5782 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5783 delete_group__(ofproto, ofgroup);
5784 /* Lock for each node separately, so that we will not jam the
5785 * other threads for too long time. */
5786 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5789 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5790 hash_int(group_id, 0), &ofproto->groups) {
5791 if (ofgroup->group_id == group_id) {
5792 delete_group__(ofproto, ofgroup);
5797 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5801 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5803 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5804 struct ofputil_group_mod gm;
5807 error = reject_slave_controller(ofconn);
5812 error = ofputil_decode_group_mod(oh, &gm);
5817 switch (gm.command) {
5819 return add_group(ofproto, &gm);
5821 case OFPGC11_MODIFY:
5822 return modify_group(ofproto, &gm);
5824 case OFPGC11_DELETE:
5825 delete_group(ofproto, gm.group_id);
5829 if (gm.command > OFPGC11_DELETE) {
5830 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5831 ofproto->name, gm.command);
5833 return OFPERR_OFPGMFC_BAD_COMMAND;
5837 enum ofproto_table_config
5838 ofproto_table_get_config(const struct ofproto *ofproto, uint8_t table_id)
5841 atomic_read(&ofproto->tables[table_id].config, &value);
5842 return (enum ofproto_table_config)value;
5846 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5848 /* Only accept currently supported configurations */
5849 if (tm->config & ~OFPTC11_TABLE_MISS_MASK) {
5850 return OFPERR_OFPTMFC_BAD_CONFIG;
5853 if (tm->table_id == OFPTT_ALL) {
5855 for (i = 0; i < ofproto->n_tables; i++) {
5856 atomic_store(&ofproto->tables[i].config,
5857 (unsigned int)tm->config);
5859 } else if (!check_table_id(ofproto, tm->table_id)) {
5860 return OFPERR_OFPTMFC_BAD_TABLE;
5862 atomic_store(&ofproto->tables[tm->table_id].config,
5863 (unsigned int)tm->config);
5870 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5872 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5873 struct ofputil_table_mod tm;
5876 error = reject_slave_controller(ofconn);
5881 error = ofputil_decode_table_mod(oh, &tm);
5886 return table_mod(ofproto, &tm);
5890 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
5893 struct ofputil_bundle_ctrl_msg bctrl;
5895 struct ofputil_bundle_ctrl_msg reply;
5897 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
5902 reply.bundle_id = bctrl.bundle_id;
5904 switch (bctrl.type) {
5905 case OFPBCT_OPEN_REQUEST:
5906 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
5907 reply.type = OFPBCT_OPEN_REPLY;
5909 case OFPBCT_CLOSE_REQUEST:
5910 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
5911 reply.type = OFPBCT_CLOSE_REPLY;;
5913 case OFPBCT_COMMIT_REQUEST:
5914 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
5915 reply.type = OFPBCT_COMMIT_REPLY;
5917 case OFPBCT_DISCARD_REQUEST:
5918 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
5919 reply.type = OFPBCT_DISCARD_REPLY;
5922 case OFPBCT_OPEN_REPLY:
5923 case OFPBCT_CLOSE_REPLY:
5924 case OFPBCT_COMMIT_REPLY:
5925 case OFPBCT_DISCARD_REPLY:
5926 return OFPERR_OFPBFC_BAD_TYPE;
5931 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
5932 ofconn_send_reply(ofconn, buf);
5939 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
5942 struct ofputil_bundle_add_msg badd;
5944 error = ofputil_decode_bundle_add(oh, &badd);
5949 return ofp_bundle_add_message(ofconn, &badd);
5953 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5954 OVS_EXCLUDED(ofproto_mutex)
5956 const struct ofp_header *oh = ofpbuf_data(msg);
5960 error = ofptype_decode(&type, oh);
5964 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5965 && ofpmp_more(oh)) {
5966 /* We have no buffer implementation for multipart requests.
5967 * Report overflow for requests which consists of multiple
5969 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5973 /* OpenFlow requests. */
5974 case OFPTYPE_ECHO_REQUEST:
5975 return handle_echo_request(ofconn, oh);
5977 case OFPTYPE_FEATURES_REQUEST:
5978 return handle_features_request(ofconn, oh);
5980 case OFPTYPE_GET_CONFIG_REQUEST:
5981 return handle_get_config_request(ofconn, oh);
5983 case OFPTYPE_SET_CONFIG:
5984 return handle_set_config(ofconn, oh);
5986 case OFPTYPE_PACKET_OUT:
5987 return handle_packet_out(ofconn, oh);
5989 case OFPTYPE_PORT_MOD:
5990 return handle_port_mod(ofconn, oh);
5992 case OFPTYPE_FLOW_MOD:
5993 return handle_flow_mod(ofconn, oh);
5995 case OFPTYPE_GROUP_MOD:
5996 return handle_group_mod(ofconn, oh);
5998 case OFPTYPE_TABLE_MOD:
5999 return handle_table_mod(ofconn, oh);
6001 case OFPTYPE_METER_MOD:
6002 return handle_meter_mod(ofconn, oh);
6004 case OFPTYPE_BARRIER_REQUEST:
6005 return handle_barrier_request(ofconn, oh);
6007 case OFPTYPE_ROLE_REQUEST:
6008 return handle_role_request(ofconn, oh);
6010 /* OpenFlow replies. */
6011 case OFPTYPE_ECHO_REPLY:
6014 /* Nicira extension requests. */
6015 case OFPTYPE_FLOW_MOD_TABLE_ID:
6016 return handle_nxt_flow_mod_table_id(ofconn, oh);
6018 case OFPTYPE_SET_FLOW_FORMAT:
6019 return handle_nxt_set_flow_format(ofconn, oh);
6021 case OFPTYPE_SET_PACKET_IN_FORMAT:
6022 return handle_nxt_set_packet_in_format(ofconn, oh);
6024 case OFPTYPE_SET_CONTROLLER_ID:
6025 return handle_nxt_set_controller_id(ofconn, oh);
6027 case OFPTYPE_FLOW_AGE:
6028 /* Nothing to do. */
6031 case OFPTYPE_FLOW_MONITOR_CANCEL:
6032 return handle_flow_monitor_cancel(ofconn, oh);
6034 case OFPTYPE_SET_ASYNC_CONFIG:
6035 return handle_nxt_set_async_config(ofconn, oh);
6037 case OFPTYPE_GET_ASYNC_REQUEST:
6038 return handle_nxt_get_async_request(ofconn, oh);
6040 /* Statistics requests. */
6041 case OFPTYPE_DESC_STATS_REQUEST:
6042 return handle_desc_stats_request(ofconn, oh);
6044 case OFPTYPE_FLOW_STATS_REQUEST:
6045 return handle_flow_stats_request(ofconn, oh);
6047 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6048 return handle_aggregate_stats_request(ofconn, oh);
6050 case OFPTYPE_TABLE_STATS_REQUEST:
6051 return handle_table_stats_request(ofconn, oh);
6053 case OFPTYPE_PORT_STATS_REQUEST:
6054 return handle_port_stats_request(ofconn, oh);
6056 case OFPTYPE_QUEUE_STATS_REQUEST:
6057 return handle_queue_stats_request(ofconn, oh);
6059 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6060 return handle_port_desc_stats_request(ofconn, oh);
6062 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6063 return handle_flow_monitor_request(ofconn, oh);
6065 case OFPTYPE_METER_STATS_REQUEST:
6066 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6067 return handle_meter_request(ofconn, oh, type);
6069 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6070 return handle_meter_features_request(ofconn, oh);
6072 case OFPTYPE_GROUP_STATS_REQUEST:
6073 return handle_group_stats_request(ofconn, oh);
6075 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6076 return handle_group_desc_stats_request(ofconn, oh);
6078 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6079 return handle_group_features_stats_request(ofconn, oh);
6081 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6082 return handle_queue_get_config_request(ofconn, oh);
6084 case OFPTYPE_BUNDLE_CONTROL:
6085 return handle_bundle_control(ofconn, oh);
6087 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6088 return handle_bundle_add(ofconn, oh);
6092 case OFPTYPE_FEATURES_REPLY:
6093 case OFPTYPE_GET_CONFIG_REPLY:
6094 case OFPTYPE_PACKET_IN:
6095 case OFPTYPE_FLOW_REMOVED:
6096 case OFPTYPE_PORT_STATUS:
6097 case OFPTYPE_BARRIER_REPLY:
6098 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6099 case OFPTYPE_DESC_STATS_REPLY:
6100 case OFPTYPE_FLOW_STATS_REPLY:
6101 case OFPTYPE_QUEUE_STATS_REPLY:
6102 case OFPTYPE_PORT_STATS_REPLY:
6103 case OFPTYPE_TABLE_STATS_REPLY:
6104 case OFPTYPE_AGGREGATE_STATS_REPLY:
6105 case OFPTYPE_PORT_DESC_STATS_REPLY:
6106 case OFPTYPE_ROLE_REPLY:
6107 case OFPTYPE_FLOW_MONITOR_PAUSED:
6108 case OFPTYPE_FLOW_MONITOR_RESUMED:
6109 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6110 case OFPTYPE_GET_ASYNC_REPLY:
6111 case OFPTYPE_GROUP_STATS_REPLY:
6112 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6113 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6114 case OFPTYPE_METER_STATS_REPLY:
6115 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6116 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6117 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6118 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6119 case OFPTYPE_ROLE_STATUS:
6121 if (ofpmsg_is_stat_request(oh)) {
6122 return OFPERR_OFPBRC_BAD_STAT;
6124 return OFPERR_OFPBRC_BAD_TYPE;
6130 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6131 OVS_EXCLUDED(ofproto_mutex)
6133 int error = handle_openflow__(ofconn, ofp_msg);
6134 if (error && error != OFPROTO_POSTPONE) {
6135 ofconn_send_error(ofconn, ofpbuf_data(ofp_msg), error);
6137 COVERAGE_INC(ofproto_recv_openflow);
6138 return error != OFPROTO_POSTPONE;
6141 /* Asynchronous operations. */
6143 /* Creates and returns a new ofopgroup that is not associated with any
6144 * OpenFlow connection.
6146 * The caller should add operations to the returned group with
6147 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6148 static struct ofopgroup *
6149 ofopgroup_create_unattached(struct ofproto *ofproto)
6150 OVS_REQUIRES(ofproto_mutex)
6152 struct ofopgroup *group = xzalloc(sizeof *group);
6153 group->ofproto = ofproto;
6154 list_init(&group->ofproto_node);
6155 list_init(&group->ops);
6156 list_init(&group->ofconn_node);
6160 /* Creates and returns a new ofopgroup for 'ofproto'.
6162 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6163 * connection. The 'request' and 'buffer_id' arguments are ignored.
6165 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6166 * If the ofopgroup eventually fails, then the error reply will include
6167 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6168 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6170 * The caller should add operations to the returned group with
6171 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6172 static struct ofopgroup *
6173 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6174 const struct ofp_header *request, uint32_t buffer_id)
6175 OVS_REQUIRES(ofproto_mutex)
6177 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6179 size_t request_len = ntohs(request->length);
6181 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6183 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6184 group->ofconn = ofconn;
6185 group->request = xmemdup(request, MIN(request_len, 64));
6186 group->buffer_id = buffer_id;
6191 /* Submits 'group' for processing.
6193 * If 'group' contains no operations (e.g. none were ever added, or all of the
6194 * ones that were added completed synchronously), then it is destroyed
6195 * immediately. Otherwise it is added to the ofproto's list of pending
6198 ofopgroup_submit(struct ofopgroup *group)
6199 OVS_REQUIRES(ofproto_mutex)
6201 if (!group->n_running) {
6202 ofopgroup_complete(group);
6204 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6205 group->ofproto->n_pending++;
6210 ofopgroup_complete(struct ofopgroup *group)
6211 OVS_REQUIRES(ofproto_mutex)
6213 struct ofproto *ofproto = group->ofproto;
6215 struct ofconn *abbrev_ofconn;
6216 ovs_be32 abbrev_xid;
6218 struct ofoperation *op, *next_op;
6221 ovs_assert(!group->n_running);
6224 LIST_FOR_EACH (op, group_node, &group->ops) {
6231 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6232 LIST_FOR_EACH (op, group_node, &group->ops) {
6233 if (op->type != OFOPERATION_DELETE) {
6234 struct ofpbuf *packet;
6237 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6240 struct rule_execute *re;
6244 ofproto_rule_ref(op->rule);
6246 re = xmalloc(sizeof *re);
6247 re->rule = op->rule;
6248 re->in_port = in_port;
6249 re->packet = packet;
6251 if (!guarded_list_push_back(&ofproto->rule_executes,
6252 &re->list_node, 1024)) {
6253 ofproto_rule_unref(op->rule);
6254 ofpbuf_delete(re->packet);
6263 if (!error && !list_is_empty(&group->ofconn_node)) {
6264 abbrev_ofconn = group->ofconn;
6265 abbrev_xid = group->request->xid;
6267 abbrev_ofconn = NULL;
6268 abbrev_xid = htonl(0);
6270 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6271 struct rule *rule = op->rule;
6273 /* We generally want to report the change to active OpenFlow flow
6274 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6276 - The operation failed.
6278 - The affected rule is not visible to controllers.
6280 - The operation's only effect was to update rule->modified. */
6282 || ofproto_rule_is_hidden(rule)
6283 || (op->type == OFOPERATION_MODIFY
6285 && rule->flow_cookie == op->flow_cookie))) {
6286 /* Check that we can just cast from ofoperation_type to
6287 * nx_flow_update_event. */
6288 enum nx_flow_update_event event_type;
6291 case OFOPERATION_ADD:
6292 case OFOPERATION_REPLACE:
6293 event_type = NXFME_ADDED;
6296 case OFOPERATION_DELETE:
6297 event_type = NXFME_DELETED;
6300 case OFOPERATION_MODIFY:
6301 event_type = NXFME_MODIFIED;
6308 ofmonitor_report(ofproto->connmgr, rule, event_type,
6309 op->reason, abbrev_ofconn, abbrev_xid);
6312 rule->pending = NULL;
6315 case OFOPERATION_ADD:
6319 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6320 if (vid_mask == VLAN_VID_MASK) {
6321 if (ofproto->vlan_bitmap) {
6322 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6323 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6324 bitmap_set1(ofproto->vlan_bitmap, vid);
6325 ofproto->vlans_changed = true;
6328 ofproto->vlans_changed = true;
6332 oftable_remove_rule(rule);
6333 ofproto_rule_unref(rule);
6337 case OFOPERATION_DELETE:
6338 ovs_assert(!op->error);
6339 ofproto_rule_unref(rule);
6343 case OFOPERATION_MODIFY:
6344 case OFOPERATION_REPLACE:
6346 long long int now = time_msec();
6348 ovs_mutex_lock(&rule->mutex);
6349 rule->modified = now;
6350 if (op->type == OFOPERATION_REPLACE) {
6351 rule->created = now;
6353 ovs_mutex_unlock(&rule->mutex);
6355 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6356 ovs_mutex_lock(&rule->mutex);
6357 rule->idle_timeout = op->idle_timeout;
6358 rule->hard_timeout = op->hard_timeout;
6359 ovs_mutex_unlock(&rule->mutex);
6361 const struct rule_actions *old_actions;
6363 ovs_mutex_lock(&rule->mutex);
6364 old_actions = rule_get_actions(rule);
6365 ovsrcu_set(&rule->actions, op->actions);
6366 ovs_mutex_unlock(&rule->mutex);
6369 rule_actions_destroy(old_actions);
6371 rule->flags = op->flags;
6379 ofoperation_destroy(op);
6382 ofmonitor_flush(ofproto->connmgr);
6384 if (!list_is_empty(&group->ofproto_node)) {
6385 ovs_assert(ofproto->n_pending > 0);
6386 ofproto->n_pending--;
6387 list_remove(&group->ofproto_node);
6389 if (!list_is_empty(&group->ofconn_node)) {
6390 list_remove(&group->ofconn_node);
6392 ofconn_send_error(group->ofconn, group->request, error);
6394 connmgr_retry(ofproto->connmgr);
6396 free(group->request);
6400 /* Initiates a new operation on 'rule', of the specified 'type', within
6401 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6403 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6404 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6406 * Returns the newly created ofoperation (which is also available as
6407 * rule->pending). */
6408 static struct ofoperation *
6409 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6410 enum ofoperation_type type,
6411 enum ofp_flow_removed_reason reason)
6412 OVS_REQUIRES(ofproto_mutex)
6414 struct ofproto *ofproto = group->ofproto;
6415 struct ofoperation *op;
6417 ovs_assert(!rule->pending);
6419 op = rule->pending = xzalloc(sizeof *op);
6421 list_push_back(&group->ops, &op->group_node);
6424 op->reason = reason;
6425 op->flow_cookie = rule->flow_cookie;
6426 ovs_mutex_lock(&rule->mutex);
6427 op->idle_timeout = rule->idle_timeout;
6428 op->hard_timeout = rule->hard_timeout;
6429 ovs_mutex_unlock(&rule->mutex);
6430 op->flags = rule->flags;
6434 if (type == OFOPERATION_DELETE) {
6435 hmap_insert(&ofproto->deletions, &op->hmap_node,
6436 cls_rule_hash(&rule->cr, rule->table_id));
6443 ofoperation_destroy(struct ofoperation *op)
6444 OVS_REQUIRES(ofproto_mutex)
6446 struct ofopgroup *group = op->group;
6449 op->rule->pending = NULL;
6451 if (op->type == OFOPERATION_DELETE) {
6452 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6454 list_remove(&op->group_node);
6455 rule_actions_destroy(op->actions);
6459 /* Indicates that 'op' completed with status 'error', which is either 0 to
6460 * indicate success or an OpenFlow error code on failure.
6462 * If 'error' is 0, indicating success, the operation will be committed
6463 * permanently to the flow table.
6465 * If 'error' is nonzero, then generally the operation will be rolled back:
6467 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6468 * restores the original rule. The caller must have uninitialized any
6469 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6470 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6471 * and 7 for the new rule, calling its ->rule_dealloc() function.
6473 * - If 'op' is a "modify flow" operation, ofproto restores the original
6476 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6477 * allowed to fail. It must always succeed.
6479 * Please see the large comment in ofproto/ofproto-provider.h titled
6480 * "Asynchronous Operation Support" for more information. */
6482 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6484 struct ofopgroup *group = op->group;
6486 ovs_assert(group->n_running > 0);
6487 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6490 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6491 /* This function can be called from ->rule_construct(), in which case
6492 * ofproto_mutex is held, or it can be called from ->run(), in which
6493 * case ofproto_mutex is not held. But only in the latter case can we
6494 * arrive here, so we can safely take ofproto_mutex now. */
6495 ovs_mutex_lock(&ofproto_mutex);
6496 ovs_assert(op->rule->pending == op);
6497 ofopgroup_complete(group);
6498 ovs_mutex_unlock(&ofproto_mutex);
6503 pick_datapath_id(const struct ofproto *ofproto)
6505 const struct ofport *port;
6507 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6509 uint8_t ea[ETH_ADDR_LEN];
6512 error = netdev_get_etheraddr(port->netdev, ea);
6514 return eth_addr_to_uint64(ea);
6516 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6517 ofproto->name, netdev_get_name(port->netdev),
6518 ovs_strerror(error));
6520 return ofproto->fallback_dpid;
6524 pick_fallback_dpid(void)
6526 uint8_t ea[ETH_ADDR_LEN];
6527 eth_addr_nicira_random(ea);
6528 return eth_addr_to_uint64(ea);
6531 /* Table overflow policy. */
6533 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6534 * to NULL if the table is not configured to evict rules or if the table
6535 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6536 * or with no timeouts are not evictable.) */
6538 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6539 OVS_REQUIRES(ofproto_mutex)
6541 struct eviction_group *evg;
6544 if (!table->eviction_fields) {
6548 /* In the common case, the outer and inner loops here will each be entered
6551 * - The inner loop normally "return"s in its first iteration. If the
6552 * eviction group has any evictable rules, then it always returns in
6555 * - The outer loop only iterates more than once if the largest eviction
6556 * group has no evictable rules.
6558 * - The outer loop can exit only if table's 'max_flows' is all filled up
6559 * by unevictable rules. */
6560 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6563 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6572 /* Searches 'ofproto' for tables that have more flows than their configured
6573 * maximum and that have flow eviction enabled, and evicts as many flows as
6574 * necessary and currently feasible from them.
6576 * This triggers only when an OpenFlow table has N flows in it and then the
6577 * client configures a maximum number of flows less than N. */
6579 ofproto_evict(struct ofproto *ofproto)
6581 struct oftable *table;
6583 ovs_mutex_lock(&ofproto_mutex);
6584 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6585 evict_rules_from_table(ofproto, table, 0);
6587 ovs_mutex_unlock(&ofproto_mutex);
6590 /* Eviction groups. */
6592 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6593 * rules. The priority contains low-order random bits to ensure that eviction
6594 * groups with the same number of rules are prioritized randomly. */
6596 eviction_group_priority(size_t n_rules)
6598 uint16_t size = MIN(UINT16_MAX, n_rules);
6599 return (size << 16) | random_uint16();
6602 /* Updates 'evg', an eviction_group within 'table', following a change that
6603 * adds or removes rules in 'evg'. */
6605 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6606 OVS_REQUIRES(ofproto_mutex)
6608 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6609 eviction_group_priority(heap_count(&evg->rules)));
6612 /* Destroys 'evg', an eviction_group within 'table':
6614 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6615 * rules themselves, just removes them from the eviction group.)
6617 * - Removes 'evg' from 'table'.
6621 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6622 OVS_REQUIRES(ofproto_mutex)
6624 while (!heap_is_empty(&evg->rules)) {
6627 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6628 rule->eviction_group = NULL;
6630 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6631 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6632 heap_destroy(&evg->rules);
6636 /* Removes 'rule' from its eviction group, if any. */
6638 eviction_group_remove_rule(struct rule *rule)
6639 OVS_REQUIRES(ofproto_mutex)
6641 if (rule->eviction_group) {
6642 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6643 struct eviction_group *evg = rule->eviction_group;
6645 rule->eviction_group = NULL;
6646 heap_remove(&evg->rules, &rule->evg_node);
6647 if (heap_is_empty(&evg->rules)) {
6648 eviction_group_destroy(table, evg);
6650 eviction_group_resized(table, evg);
6655 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6656 * returns the hash value. */
6658 eviction_group_hash_rule(struct rule *rule)
6659 OVS_REQUIRES(ofproto_mutex)
6661 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6662 const struct mf_subfield *sf;
6666 hash = table->eviction_group_id_basis;
6667 miniflow_expand(&rule->cr.match.flow, &flow);
6668 for (sf = table->eviction_fields;
6669 sf < &table->eviction_fields[table->n_eviction_fields];
6672 if (mf_are_prereqs_ok(sf->field, &flow)) {
6673 union mf_value value;
6675 mf_get_value(sf->field, &flow, &value);
6677 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6679 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6680 unsigned int start = sf->ofs + sf->n_bits;
6681 bitwise_zero(&value, sf->field->n_bytes, start,
6682 sf->field->n_bytes * 8 - start);
6684 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6686 hash = hash_int(hash, 0);
6693 /* Returns an eviction group within 'table' with the given 'id', creating one
6695 static struct eviction_group *
6696 eviction_group_find(struct oftable *table, uint32_t id)
6697 OVS_REQUIRES(ofproto_mutex)
6699 struct eviction_group *evg;
6701 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6705 evg = xmalloc(sizeof *evg);
6706 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6707 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6708 eviction_group_priority(0));
6709 heap_init(&evg->rules);
6714 /* Returns an eviction priority for 'rule'. The return value should be
6715 * interpreted so that higher priorities make a rule more attractive candidates
6717 * Called only if have a timeout. */
6719 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6720 OVS_REQUIRES(ofproto_mutex)
6722 long long int expiration = LLONG_MAX;
6723 long long int modified;
6724 uint32_t expiration_offset;
6726 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6727 ovs_mutex_lock(&rule->mutex);
6728 modified = rule->modified;
6729 ovs_mutex_unlock(&rule->mutex);
6731 if (rule->hard_timeout) {
6732 expiration = modified + rule->hard_timeout * 1000;
6734 if (rule->idle_timeout) {
6735 uint64_t packets, bytes;
6737 long long int idle_expiration;
6739 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6740 idle_expiration = used + rule->idle_timeout * 1000;
6741 expiration = MIN(expiration, idle_expiration);
6744 if (expiration == LLONG_MAX) {
6748 /* Calculate the time of expiration as a number of (approximate) seconds
6749 * after program startup.
6751 * This should work OK for program runs that last UINT32_MAX seconds or
6752 * less. Therefore, please restart OVS at least once every 136 years. */
6753 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6755 /* Invert the expiration offset because we're using a max-heap. */
6756 return UINT32_MAX - expiration_offset;
6759 /* Adds 'rule' to an appropriate eviction group for its oftable's
6760 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6761 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6764 * The caller must ensure that 'rule' is not already in an eviction group. */
6766 eviction_group_add_rule(struct rule *rule)
6767 OVS_REQUIRES(ofproto_mutex)
6769 struct ofproto *ofproto = rule->ofproto;
6770 struct oftable *table = &ofproto->tables[rule->table_id];
6773 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6774 * so no additional protection is needed. */
6775 has_timeout = rule->hard_timeout || rule->idle_timeout;
6777 if (table->eviction_fields && has_timeout) {
6778 struct eviction_group *evg;
6780 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6782 rule->eviction_group = evg;
6783 heap_insert(&evg->rules, &rule->evg_node,
6784 rule_eviction_priority(ofproto, rule));
6785 eviction_group_resized(table, evg);
6791 /* Initializes 'table'. */
6793 oftable_init(struct oftable *table)
6795 memset(table, 0, sizeof *table);
6796 classifier_init(&table->cls, flow_segment_u32s);
6797 table->max_flows = UINT_MAX;
6798 atomic_init(&table->config, (unsigned int)OFPROTO_TABLE_MISS_DEFAULT);
6800 fat_rwlock_wrlock(&table->cls.rwlock);
6801 classifier_set_prefix_fields(&table->cls, default_prefix_fields,
6802 ARRAY_SIZE(default_prefix_fields));
6803 fat_rwlock_unlock(&table->cls.rwlock);
6805 atomic_init(&table->n_matched, 0);
6806 atomic_init(&table->n_missed, 0);
6809 /* Destroys 'table', including its classifier and eviction groups.
6811 * The caller is responsible for freeing 'table' itself. */
6813 oftable_destroy(struct oftable *table)
6815 fat_rwlock_rdlock(&table->cls.rwlock);
6816 ovs_assert(classifier_is_empty(&table->cls));
6817 fat_rwlock_unlock(&table->cls.rwlock);
6818 oftable_disable_eviction(table);
6819 classifier_destroy(&table->cls);
6823 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6824 * string, then 'table' will use its default name.
6826 * This only affects the name exposed for a table exposed through the OpenFlow
6827 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6829 oftable_set_name(struct oftable *table, const char *name)
6831 if (name && name[0]) {
6832 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6833 if (!table->name || strncmp(name, table->name, len)) {
6835 table->name = xmemdup0(name, len);
6843 /* oftables support a choice of two policies when adding a rule would cause the
6844 * number of flows in the table to exceed the configured maximum number: either
6845 * they can refuse to add the new flow or they can evict some existing flow.
6846 * This function configures the former policy on 'table'. */
6848 oftable_disable_eviction(struct oftable *table)
6849 OVS_REQUIRES(ofproto_mutex)
6851 if (table->eviction_fields) {
6852 struct eviction_group *evg, *next;
6854 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6855 &table->eviction_groups_by_id) {
6856 eviction_group_destroy(table, evg);
6858 hmap_destroy(&table->eviction_groups_by_id);
6859 heap_destroy(&table->eviction_groups_by_size);
6861 free(table->eviction_fields);
6862 table->eviction_fields = NULL;
6863 table->n_eviction_fields = 0;
6867 /* oftables support a choice of two policies when adding a rule would cause the
6868 * number of flows in the table to exceed the configured maximum number: either
6869 * they can refuse to add the new flow or they can evict some existing flow.
6870 * This function configures the latter policy on 'table', with fairness based
6871 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6872 * 'n_fields' as 0 disables fairness.) */
6874 oftable_enable_eviction(struct oftable *table,
6875 const struct mf_subfield *fields, size_t n_fields)
6876 OVS_REQUIRES(ofproto_mutex)
6878 struct cls_cursor cursor;
6881 if (table->eviction_fields
6882 && n_fields == table->n_eviction_fields
6884 || !memcmp(fields, table->eviction_fields,
6885 n_fields * sizeof *fields))) {
6890 oftable_disable_eviction(table);
6892 table->n_eviction_fields = n_fields;
6893 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6895 table->eviction_group_id_basis = random_uint32();
6896 hmap_init(&table->eviction_groups_by_id);
6897 heap_init(&table->eviction_groups_by_size);
6899 fat_rwlock_rdlock(&table->cls.rwlock);
6900 cls_cursor_init(&cursor, &table->cls, NULL);
6901 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6902 eviction_group_add_rule(rule);
6904 fat_rwlock_unlock(&table->cls.rwlock);
6907 /* Removes 'rule' from the oftable that contains it. */
6909 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6910 OVS_REQUIRES(ofproto_mutex)
6912 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6914 fat_rwlock_wrlock(&cls->rwlock);
6915 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6916 fat_rwlock_unlock(&cls->rwlock);
6918 cookies_remove(ofproto, rule);
6920 eviction_group_remove_rule(rule);
6921 if (!list_is_empty(&rule->expirable)) {
6922 list_remove(&rule->expirable);
6924 if (!list_is_empty(&rule->meter_list_node)) {
6925 list_remove(&rule->meter_list_node);
6926 list_init(&rule->meter_list_node);
6931 oftable_remove_rule(struct rule *rule)
6932 OVS_REQUIRES(ofproto_mutex)
6934 oftable_remove_rule__(rule->ofproto, rule);
6937 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6938 * the same cls_rule. */
6940 oftable_insert_rule(struct rule *rule)
6941 OVS_REQUIRES(ofproto_mutex)
6943 struct ofproto *ofproto = rule->ofproto;
6944 struct oftable *table = &ofproto->tables[rule->table_id];
6945 const struct rule_actions *actions;
6948 ovs_mutex_lock(&rule->mutex);
6949 may_expire = rule->hard_timeout || rule->idle_timeout;
6950 ovs_mutex_unlock(&rule->mutex);
6953 list_insert(&ofproto->expirable, &rule->expirable);
6956 cookies_insert(ofproto, rule);
6958 actions = rule_get_actions(rule);
6959 if (actions->provider_meter_id != UINT32_MAX) {
6960 uint32_t meter_id = ofpacts_get_meter(actions->ofpacts,
6961 actions->ofpacts_len);
6962 struct meter *meter = ofproto->meters[meter_id];
6963 list_insert(&meter->rules, &rule->meter_list_node);
6965 fat_rwlock_wrlock(&table->cls.rwlock);
6966 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6967 fat_rwlock_unlock(&table->cls.rwlock);
6968 eviction_group_add_rule(rule);
6971 /* unixctl commands. */
6974 ofproto_lookup(const char *name)
6976 struct ofproto *ofproto;
6978 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6980 if (!strcmp(ofproto->name, name)) {
6988 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6989 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6991 struct ofproto *ofproto;
6995 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6996 ds_put_format(&results, "%s\n", ofproto->name);
6998 unixctl_command_reply(conn, ds_cstr(&results));
6999 ds_destroy(&results);
7003 ofproto_unixctl_init(void)
7005 static bool registered;
7011 unixctl_command_register("ofproto/list", "", 0, 0,
7012 ofproto_unixctl_list, NULL);
7015 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7017 * This is deprecated. It is only for compatibility with broken device drivers
7018 * in old versions of Linux that do not properly support VLANs when VLAN
7019 * devices are not used. When broken device drivers are no longer in
7020 * widespread use, we will delete these interfaces. */
7022 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7023 * (exactly) by an OpenFlow rule in 'ofproto'. */
7025 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
7028 struct cls_rule target;
7029 const struct oftable *oftable;
7031 match_init_catchall(&match);
7032 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
7033 cls_rule_init(&target, &match, 0);
7035 free(ofproto->vlan_bitmap);
7036 ofproto->vlan_bitmap = bitmap_allocate(4096);
7037 ofproto->vlans_changed = false;
7039 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
7040 struct cls_cursor cursor;
7043 fat_rwlock_rdlock(&oftable->cls.rwlock);
7044 cls_cursor_init(&cursor, &oftable->cls, &target);
7045 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
7046 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7047 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7049 bitmap_set1(vlan_bitmap, vid);
7050 bitmap_set1(ofproto->vlan_bitmap, vid);
7053 fat_rwlock_unlock(&oftable->cls.rwlock);
7057 /* Returns true if new VLANs have come into use by the flow table since the
7058 * last call to ofproto_get_vlan_usage().
7060 * We don't track when old VLANs stop being used. */
7062 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7064 return ofproto->vlans_changed;
7067 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7068 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7069 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7070 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7071 * then the VLAN device is un-enslaved. */
7073 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7074 ofp_port_t realdev_ofp_port, int vid)
7076 struct ofport *ofport;
7079 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7081 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7083 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7084 ofproto->name, vlandev_ofp_port);
7088 if (!ofproto->ofproto_class->set_realdev) {
7089 if (!vlandev_ofp_port) {
7092 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7096 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7098 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7099 ofproto->name, vlandev_ofp_port,
7100 netdev_get_name(ofport->netdev), ovs_strerror(error));