2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
50 #include "poll-loop.h"
58 #include "unaligned.h"
63 VLOG_DEFINE_THIS_MODULE(ofproto);
65 COVERAGE_DEFINE(ofproto_flush);
66 COVERAGE_DEFINE(ofproto_packet_out);
67 COVERAGE_DEFINE(ofproto_queue_req);
68 COVERAGE_DEFINE(ofproto_recv_openflow);
69 COVERAGE_DEFINE(ofproto_reinit_ports);
70 COVERAGE_DEFINE(ofproto_update_port);
73 S_OPENFLOW, /* Processing OpenFlow commands. */
74 S_EVICT, /* Evicting flows from over-limit tables. */
75 S_FLUSH, /* Deleting all flow table rules. */
78 enum ofoperation_type {
85 /* A single OpenFlow request can execute any number of operations. The
86 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
87 * ofconn to which an error reply should be sent if necessary.
89 * ofproto initiates some operations internally. These operations are still
90 * assigned to groups but will not have an associated ofconn. */
92 struct ofproto *ofproto; /* Owning ofproto. */
93 struct list ofproto_node; /* In ofproto's "pending" list. */
94 struct list ops; /* List of "struct ofoperation"s. */
95 int n_running; /* Number of ops still pending. */
97 /* Data needed to send OpenFlow reply on failure or to send a buffered
100 * If list_is_empty(ofconn_node) then this ofopgroup never had an
101 * associated ofconn or its ofconn's connection dropped after it initiated
102 * the operation. In the latter case 'ofconn' is a wild pointer that
103 * refers to freed memory, so the 'ofconn' member must be used only if
104 * !list_is_empty(ofconn_node).
106 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
107 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
108 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
109 uint32_t buffer_id; /* Buffer id from original request. */
112 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
113 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
114 const struct ofp_header *,
116 static void ofopgroup_submit(struct ofopgroup *);
117 static void ofopgroup_complete(struct ofopgroup *);
119 /* A single flow table operation. */
121 struct ofopgroup *group; /* Owning group. */
122 struct list group_node; /* In ofopgroup's "ops" list. */
123 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
124 struct rule *rule; /* Rule being operated upon. */
125 enum ofoperation_type type; /* Type of operation. */
127 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
129 const struct rule_actions *actions;
131 /* OFOPERATION_DELETE. */
132 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
134 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
135 uint16_t idle_timeout; /* Rule's old idle timeout. */
136 uint16_t hard_timeout; /* Rule's old hard timeout. */
137 enum ofputil_flow_mod_flags flags; /* Rule's old flags. */
138 enum ofperr error; /* 0 if no error. */
141 static struct ofoperation *ofoperation_create(struct ofopgroup *,
143 enum ofoperation_type,
144 enum ofp_flow_removed_reason);
145 static void ofoperation_destroy(struct ofoperation *);
148 static void oftable_init(struct oftable *);
149 static void oftable_destroy(struct oftable *);
151 static void oftable_set_name(struct oftable *, const char *name);
153 static void oftable_disable_eviction(struct oftable *);
154 static void oftable_enable_eviction(struct oftable *,
155 const struct mf_subfield *fields,
158 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
159 static void oftable_remove_rule__(struct ofproto *, struct rule *)
160 OVS_REQUIRES(ofproto_mutex);
161 static void oftable_insert_rule(struct rule *);
163 /* A set of rules within a single OpenFlow table (oftable) that have the same
164 * values for the oftable's eviction_fields. A rule to be evicted, when one is
165 * needed, is taken from the eviction group that contains the greatest number
168 * An oftable owns any number of eviction groups, each of which contains any
171 * Membership in an eviction group is imprecise, based on the hash of the
172 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
173 * That is, if two rules have different eviction_fields, but those
174 * eviction_fields hash to the same value, then they will belong to the same
175 * eviction_group anyway.
177 * (When eviction is not enabled on an oftable, we don't track any eviction
178 * groups, to save time and space.) */
179 struct eviction_group {
180 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
181 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
182 struct heap rules; /* Contains "struct rule"s. */
185 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep);
186 static void ofproto_evict(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
187 static uint32_t rule_eviction_priority(struct ofproto *ofproto, struct rule *);
188 static void eviction_group_add_rule(struct rule *);
189 static void eviction_group_remove_rule(struct rule *);
191 /* Criteria that flow_mod and other operations use for selecting rules on
192 * which to operate. */
193 struct rule_criteria {
194 /* An OpenFlow table or 255 for all tables. */
197 /* OpenFlow matching criteria. Interpreted different in "loose" way by
198 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
199 * defined in the OpenFlow spec. */
202 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
203 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
204 * The rule will not be selected if M is 1 and B != C. */
206 ovs_be64 cookie_mask;
208 /* Selection based on actions within a rule:
210 * If out_port != OFPP_ANY, selects only rules that output to out_port.
211 * If out_group != OFPG_ALL, select only rules that output to out_group. */
216 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
217 const struct match *match,
218 unsigned int priority,
219 ovs_be64 cookie, ovs_be64 cookie_mask,
220 ofp_port_t out_port, uint32_t out_group);
221 static void rule_criteria_destroy(struct rule_criteria *);
223 /* A packet that needs to be passed to rule_execute().
225 * (We can't do this immediately from ofopgroup_complete() because that holds
226 * ofproto_mutex, which rule_execute() needs released.) */
227 struct rule_execute {
228 struct list list_node; /* In struct ofproto's "rule_executes" list. */
229 struct rule *rule; /* Owns a reference to the rule. */
231 struct ofpbuf *packet; /* Owns the packet. */
234 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
235 static void destroy_rule_executes(struct ofproto *);
238 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
239 static void ofport_destroy(struct ofport *);
241 static void update_port(struct ofproto *, const char *devname);
242 static int init_ports(struct ofproto *);
243 static void reinit_ports(struct ofproto *);
245 static long long int ofport_get_usage(const struct ofproto *,
246 ofp_port_t ofp_port);
247 static void ofport_set_usage(struct ofproto *, ofp_port_t ofp_port,
248 long long int last_used);
249 static void ofport_remove_usage(struct ofproto *, ofp_port_t ofp_port);
253 * Keeps track of the currently used and recently used ofport values and is
254 * used to prevent immediate recycling of ofport values. */
255 struct ofport_usage {
256 struct hmap_node hmap_node; /* In struct ofproto's "ofport_usage" hmap. */
257 ofp_port_t ofp_port; /* OpenFlow port number. */
258 long long int last_used; /* Last time the 'ofp_port' was used. LLONG_MAX
259 represents in-use ofports. */
263 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
264 static bool rule_is_modifiable(const struct rule *rule,
265 enum ofputil_flow_mod_flags flag);
268 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
269 struct ofputil_flow_mod *,
270 const struct ofp_header *);
271 static void do_add_flow(struct ofproto *, struct ofconn *,
272 const struct ofp_header *request, uint32_t buffer_id,
274 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
275 struct ofputil_flow_mod *,
276 const struct ofp_header *,
277 const struct rule_collection *);
278 static void delete_flow__(struct rule *rule, struct ofopgroup *,
279 enum ofp_flow_removed_reason)
280 OVS_REQUIRES(ofproto_mutex);
281 static bool ofproto_group_exists__(const struct ofproto *ofproto,
283 OVS_REQ_RDLOCK(ofproto->groups_rwlock);
284 static bool ofproto_group_exists(const struct ofproto *ofproto,
286 OVS_EXCLUDED(ofproto->groups_rwlock);
287 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
288 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
289 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
290 struct ofputil_flow_mod *,
291 const struct ofp_header *)
292 OVS_EXCLUDED(ofproto_mutex);
293 static void calc_duration(long long int start, long long int now,
294 uint32_t *sec, uint32_t *nsec);
297 static uint64_t pick_datapath_id(const struct ofproto *);
298 static uint64_t pick_fallback_dpid(void);
299 static void ofproto_destroy__(struct ofproto *);
300 static void update_mtu(struct ofproto *, struct ofport *);
301 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
304 static void ofproto_unixctl_init(void);
306 /* All registered ofproto classes, in probe order. */
307 static const struct ofproto_class **ofproto_classes;
308 static size_t n_ofproto_classes;
309 static size_t allocated_ofproto_classes;
311 /* Global lock that protects all flow table operations. */
312 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
314 unsigned ofproto_flow_limit = OFPROTO_FLOW_LIMIT_DEFAULT;
315 unsigned ofproto_max_idle = OFPROTO_MAX_IDLE_DEFAULT;
317 size_t n_handlers, n_revalidators;
319 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
320 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
322 /* Initial mappings of port to OpenFlow number mappings. */
323 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
325 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
327 /* The default value of true waits for flow restore. */
328 static bool flow_restore_wait = true;
330 /* Must be called to initialize the ofproto library.
332 * The caller may pass in 'iface_hints', which contains an shash of
333 * "iface_hint" elements indexed by the interface's name. The provider
334 * may use these hints to describe the startup configuration in order to
335 * reinitialize its state. The caller owns the provided data, so a
336 * provider will make copies of anything required. An ofproto provider
337 * will remove any existing state that is not described by the hint, and
338 * may choose to remove it all. */
340 ofproto_init(const struct shash *iface_hints)
342 struct shash_node *node;
345 ofproto_class_register(&ofproto_dpif_class);
347 /* Make a local copy, since we don't own 'iface_hints' elements. */
348 SHASH_FOR_EACH(node, iface_hints) {
349 const struct iface_hint *orig_hint = node->data;
350 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
351 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
353 new_hint->br_name = xstrdup(orig_hint->br_name);
354 new_hint->br_type = xstrdup(br_type);
355 new_hint->ofp_port = orig_hint->ofp_port;
357 shash_add(&init_ofp_ports, node->name, new_hint);
360 for (i = 0; i < n_ofproto_classes; i++) {
361 ofproto_classes[i]->init(&init_ofp_ports);
365 /* 'type' should be a normalized datapath type, as returned by
366 * ofproto_normalize_type(). Returns the corresponding ofproto_class
367 * structure, or a null pointer if there is none registered for 'type'. */
368 static const struct ofproto_class *
369 ofproto_class_find__(const char *type)
373 for (i = 0; i < n_ofproto_classes; i++) {
374 const struct ofproto_class *class = ofproto_classes[i];
379 class->enumerate_types(&types);
380 found = sset_contains(&types, type);
381 sset_destroy(&types);
387 VLOG_WARN("unknown datapath type %s", type);
391 /* Registers a new ofproto class. After successful registration, new ofprotos
392 * of that type can be created using ofproto_create(). */
394 ofproto_class_register(const struct ofproto_class *new_class)
398 for (i = 0; i < n_ofproto_classes; i++) {
399 if (ofproto_classes[i] == new_class) {
404 if (n_ofproto_classes >= allocated_ofproto_classes) {
405 ofproto_classes = x2nrealloc(ofproto_classes,
406 &allocated_ofproto_classes,
407 sizeof *ofproto_classes);
409 ofproto_classes[n_ofproto_classes++] = new_class;
413 /* Unregisters a datapath provider. 'type' must have been previously
414 * registered and not currently be in use by any ofprotos. After
415 * unregistration new datapaths of that type cannot be opened using
416 * ofproto_create(). */
418 ofproto_class_unregister(const struct ofproto_class *class)
422 for (i = 0; i < n_ofproto_classes; i++) {
423 if (ofproto_classes[i] == class) {
424 for (i++; i < n_ofproto_classes; i++) {
425 ofproto_classes[i - 1] = ofproto_classes[i];
431 VLOG_WARN("attempted to unregister an ofproto class that is not "
436 /* Clears 'types' and enumerates all registered ofproto types into it. The
437 * caller must first initialize the sset. */
439 ofproto_enumerate_types(struct sset *types)
444 for (i = 0; i < n_ofproto_classes; i++) {
445 ofproto_classes[i]->enumerate_types(types);
449 /* Returns the fully spelled out name for the given ofproto 'type'.
451 * Normalized type string can be compared with strcmp(). Unnormalized type
452 * string might be the same even if they have different spellings. */
454 ofproto_normalize_type(const char *type)
456 return type && type[0] ? type : "system";
459 /* Clears 'names' and enumerates the names of all known created ofprotos with
460 * the given 'type'. The caller must first initialize the sset. Returns 0 if
461 * successful, otherwise a positive errno value.
463 * Some kinds of datapaths might not be practically enumerable. This is not
464 * considered an error. */
466 ofproto_enumerate_names(const char *type, struct sset *names)
468 const struct ofproto_class *class = ofproto_class_find__(type);
469 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
473 ofproto_create(const char *datapath_name, const char *datapath_type,
474 struct ofproto **ofprotop)
476 const struct ofproto_class *class;
477 struct ofproto *ofproto;
483 ofproto_unixctl_init();
485 datapath_type = ofproto_normalize_type(datapath_type);
486 class = ofproto_class_find__(datapath_type);
488 VLOG_WARN("could not create datapath %s of unknown type %s",
489 datapath_name, datapath_type);
493 ofproto = class->alloc();
495 VLOG_ERR("failed to allocate datapath %s of type %s",
496 datapath_name, datapath_type);
501 ovs_mutex_lock(&ofproto_mutex);
502 memset(ofproto, 0, sizeof *ofproto);
503 ofproto->ofproto_class = class;
504 ofproto->name = xstrdup(datapath_name);
505 ofproto->type = xstrdup(datapath_type);
506 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
507 hash_string(ofproto->name, 0));
508 ofproto->datapath_id = 0;
509 ofproto->forward_bpdu = false;
510 ofproto->fallback_dpid = pick_fallback_dpid();
511 ofproto->mfr_desc = NULL;
512 ofproto->hw_desc = NULL;
513 ofproto->sw_desc = NULL;
514 ofproto->serial_desc = NULL;
515 ofproto->dp_desc = NULL;
516 ofproto->frag_handling = OFPC_FRAG_NORMAL;
517 hmap_init(&ofproto->ports);
518 hmap_init(&ofproto->ofport_usage);
519 shash_init(&ofproto->port_by_name);
520 simap_init(&ofproto->ofp_requests);
521 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
522 ofproto->eviction_group_timer = LLONG_MIN;
523 ofproto->tables = NULL;
524 ofproto->n_tables = 0;
525 hindex_init(&ofproto->cookies);
526 list_init(&ofproto->expirable);
527 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
528 ofproto->state = S_OPENFLOW;
529 list_init(&ofproto->pending);
530 ofproto->n_pending = 0;
531 hmap_init(&ofproto->deletions);
532 guarded_list_init(&ofproto->rule_executes);
533 ofproto->vlan_bitmap = NULL;
534 ofproto->vlans_changed = false;
535 ofproto->min_mtu = INT_MAX;
536 ovs_rwlock_init(&ofproto->groups_rwlock);
537 hmap_init(&ofproto->groups);
538 ovs_mutex_unlock(&ofproto_mutex);
539 ofproto->ogf.capabilities = OFPGFC_CHAINING | OFPGFC_SELECT_LIVENESS |
540 OFPGFC_SELECT_WEIGHT;
541 ofproto->ogf.max_groups[OFPGT11_ALL] = OFPG_MAX;
542 ofproto->ogf.max_groups[OFPGT11_SELECT] = OFPG_MAX;
543 ofproto->ogf.max_groups[OFPGT11_INDIRECT] = OFPG_MAX;
544 ofproto->ogf.max_groups[OFPGT11_FF] = OFPG_MAX;
545 ofproto->ogf.actions[0] =
546 (1 << OFPAT11_OUTPUT) |
547 (1 << OFPAT11_COPY_TTL_OUT) |
548 (1 << OFPAT11_COPY_TTL_IN) |
549 (1 << OFPAT11_SET_MPLS_TTL) |
550 (1 << OFPAT11_DEC_MPLS_TTL) |
551 (1 << OFPAT11_PUSH_VLAN) |
552 (1 << OFPAT11_POP_VLAN) |
553 (1 << OFPAT11_PUSH_MPLS) |
554 (1 << OFPAT11_POP_MPLS) |
555 (1 << OFPAT11_SET_QUEUE) |
556 (1 << OFPAT11_GROUP) |
557 (1 << OFPAT11_SET_NW_TTL) |
558 (1 << OFPAT11_DEC_NW_TTL) |
559 (1 << OFPAT12_SET_FIELD);
561 * (1 << OFPAT13_PUSH_PBB) |
562 * (1 << OFPAT13_POP_PBB) */
564 error = ofproto->ofproto_class->construct(ofproto);
566 VLOG_ERR("failed to open datapath %s: %s",
567 datapath_name, ovs_strerror(error));
568 ofproto_destroy__(ofproto);
572 /* Check that hidden tables, if any, are at the end. */
573 ovs_assert(ofproto->n_tables);
574 for (i = 0; i + 1 < ofproto->n_tables; i++) {
575 enum oftable_flags flags = ofproto->tables[i].flags;
576 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
578 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
581 ofproto->datapath_id = pick_datapath_id(ofproto);
584 /* Initialize meters table. */
585 if (ofproto->ofproto_class->meter_get_features) {
586 ofproto->ofproto_class->meter_get_features(ofproto,
587 &ofproto->meter_features);
589 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
591 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
592 * sizeof(struct meter *));
598 /* Must be called (only) by an ofproto implementation in its constructor
599 * function. See the large comment on 'construct' in struct ofproto_class for
602 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
604 struct oftable *table;
606 ovs_assert(!ofproto->n_tables);
607 ovs_assert(n_tables >= 1 && n_tables <= 255);
609 ofproto->n_tables = n_tables;
610 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
611 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
616 /* To be optionally called (only) by an ofproto implementation in its
617 * constructor function. See the large comment on 'construct' in struct
618 * ofproto_class for details.
620 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
621 * will then ensure that actions passed into the ofproto implementation will
622 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
623 * function is not called, there will be no such restriction.
625 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
626 * the 'max_ports' restriction. */
628 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
630 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
631 ofproto->max_ports = max_ports;
635 ofproto_get_datapath_id(const struct ofproto *ofproto)
637 return ofproto->datapath_id;
641 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
643 uint64_t old_dpid = p->datapath_id;
644 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
645 if (p->datapath_id != old_dpid) {
646 /* Force all active connections to reconnect, since there is no way to
647 * notify a controller that the datapath ID has changed. */
648 ofproto_reconnect_controllers(p);
653 ofproto_set_controllers(struct ofproto *p,
654 const struct ofproto_controller *controllers,
655 size_t n_controllers, uint32_t allowed_versions)
657 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
662 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
664 connmgr_set_fail_mode(p->connmgr, fail_mode);
667 /* Drops the connections between 'ofproto' and all of its controllers, forcing
668 * them to reconnect. */
670 ofproto_reconnect_controllers(struct ofproto *ofproto)
672 connmgr_reconnect(ofproto->connmgr);
675 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
676 * in-band control should guarantee access, in the same way that in-band
677 * control guarantees access to OpenFlow controllers. */
679 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
680 const struct sockaddr_in *extras, size_t n)
682 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
685 /* Sets the OpenFlow queue used by flows set up by in-band control on
686 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
687 * flows will use the default queue. */
689 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
691 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
694 /* Sets the number of flows at which eviction from the kernel flow table
697 ofproto_set_flow_limit(unsigned limit)
699 ofproto_flow_limit = limit;
702 /* Sets the maximum idle time for flows in the datapath before they are
705 ofproto_set_max_idle(unsigned max_idle)
707 ofproto_max_idle = max_idle;
710 /* If forward_bpdu is true, the NORMAL action will forward frames with
711 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
712 * the NORMAL action will drop these frames. */
714 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
716 bool old_val = ofproto->forward_bpdu;
717 ofproto->forward_bpdu = forward_bpdu;
718 if (old_val != ofproto->forward_bpdu) {
719 if (ofproto->ofproto_class->forward_bpdu_changed) {
720 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
725 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
726 * 'idle_time', in seconds, and the maximum number of MAC table entries to
729 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
732 if (ofproto->ofproto_class->set_mac_table_config) {
733 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
739 ofproto_set_threads(int n_handlers_, int n_revalidators_)
741 int threads = MAX(count_cpu_cores(), 2);
743 n_revalidators = MAX(n_revalidators_, 0);
744 n_handlers = MAX(n_handlers_, 0);
746 if (!n_revalidators) {
747 n_revalidators = n_handlers
748 ? MAX(threads - (int) n_handlers, 1)
753 n_handlers = MAX(threads - (int) n_revalidators, 1);
758 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
761 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
765 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
767 return connmgr_set_snoops(ofproto->connmgr, snoops);
771 ofproto_set_netflow(struct ofproto *ofproto,
772 const struct netflow_options *nf_options)
774 if (nf_options && sset_is_empty(&nf_options->collectors)) {
778 if (ofproto->ofproto_class->set_netflow) {
779 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
781 return nf_options ? EOPNOTSUPP : 0;
786 ofproto_set_sflow(struct ofproto *ofproto,
787 const struct ofproto_sflow_options *oso)
789 if (oso && sset_is_empty(&oso->targets)) {
793 if (ofproto->ofproto_class->set_sflow) {
794 return ofproto->ofproto_class->set_sflow(ofproto, oso);
796 return oso ? EOPNOTSUPP : 0;
801 ofproto_set_ipfix(struct ofproto *ofproto,
802 const struct ofproto_ipfix_bridge_exporter_options *bo,
803 const struct ofproto_ipfix_flow_exporter_options *fo,
806 if (ofproto->ofproto_class->set_ipfix) {
807 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
809 return (bo || fo) ? EOPNOTSUPP : 0;
814 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
816 flow_restore_wait = flow_restore_wait_db;
820 ofproto_get_flow_restore_wait(void)
822 return flow_restore_wait;
826 /* Spanning Tree Protocol (STP) configuration. */
828 /* Configures STP on 'ofproto' using the settings defined in 's'. If
829 * 's' is NULL, disables STP.
831 * Returns 0 if successful, otherwise a positive errno value. */
833 ofproto_set_stp(struct ofproto *ofproto,
834 const struct ofproto_stp_settings *s)
836 return (ofproto->ofproto_class->set_stp
837 ? ofproto->ofproto_class->set_stp(ofproto, s)
841 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
842 * 'enabled' member of 's' is false, then the other members are not
845 * Returns 0 if successful, otherwise a positive errno value. */
847 ofproto_get_stp_status(struct ofproto *ofproto,
848 struct ofproto_stp_status *s)
850 return (ofproto->ofproto_class->get_stp_status
851 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
855 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
856 * in 's'. The caller is responsible for assigning STP port numbers
857 * (using the 'port_num' member in the range of 1 through 255, inclusive)
858 * and ensuring there are no duplicates. If the 's' is NULL, then STP
859 * is disabled on the port.
861 * Returns 0 if successful, otherwise a positive errno value.*/
863 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
864 const struct ofproto_port_stp_settings *s)
866 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
868 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
869 ofproto->name, ofp_port);
873 return (ofproto->ofproto_class->set_stp_port
874 ? ofproto->ofproto_class->set_stp_port(ofport, s)
878 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
879 * 's'. If the 'enabled' member in 's' is false, then the other members
880 * are not meaningful.
882 * Returns 0 if successful, otherwise a positive errno value.*/
884 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
885 struct ofproto_port_stp_status *s)
887 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
889 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
890 "port %"PRIu16, ofproto->name, ofp_port);
894 return (ofproto->ofproto_class->get_stp_port_status
895 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
899 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
900 * 's'. If the 'enabled' member in 's' is false, then the other members
901 * are not meaningful.
903 * Returns 0 if successful, otherwise a positive errno value.*/
905 ofproto_port_get_stp_stats(struct ofproto *ofproto, ofp_port_t ofp_port,
906 struct ofproto_port_stp_stats *s)
908 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
910 VLOG_WARN_RL(&rl, "%s: cannot get STP stats on nonexistent "
911 "port %"PRIu16, ofproto->name, ofp_port);
915 return (ofproto->ofproto_class->get_stp_port_stats
916 ? ofproto->ofproto_class->get_stp_port_stats(ofport, s)
920 /* Queue DSCP configuration. */
922 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
923 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
924 * to implement QoS. Instead, it is used to implement features which require
925 * knowledge of what queues exist on a port, and some basic information about
928 * Returns 0 if successful, otherwise a positive errno value. */
930 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
931 const struct ofproto_port_queue *queues,
934 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
937 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
938 ofproto->name, ofp_port);
942 return (ofproto->ofproto_class->set_queues
943 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
947 /* Connectivity Fault Management configuration. */
949 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
951 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
953 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
954 if (ofport && ofproto->ofproto_class->set_cfm) {
955 ofproto->ofproto_class->set_cfm(ofport, NULL);
959 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
960 * basic configuration from the configuration members in 'cfm', and the remote
961 * maintenance point ID from remote_mpid. Ignores the statistics members of
964 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
966 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
967 const struct cfm_settings *s)
969 struct ofport *ofport;
972 ofport = ofproto_get_port(ofproto, ofp_port);
974 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
975 ofproto->name, ofp_port);
979 /* XXX: For configuration simplicity, we only support one remote_mpid
980 * outside of the CFM module. It's not clear if this is the correct long
981 * term solution or not. */
982 error = (ofproto->ofproto_class->set_cfm
983 ? ofproto->ofproto_class->set_cfm(ofport, s)
986 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
987 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
988 ovs_strerror(error));
992 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
993 * 'ofproto' does not have a port 'ofp_port'. */
995 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
996 const struct smap *cfg)
998 struct ofport *ofport;
1001 ofport = ofproto_get_port(ofproto, ofp_port);
1003 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
1004 ofproto->name, ofp_port);
1008 error = (ofproto->ofproto_class->set_bfd
1009 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
1012 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
1013 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
1014 ovs_strerror(error));
1018 /* Populates 'status' with the status of BFD on 'ofport'. If 'force' is set to
1019 * true, status will be returned even if there is no status change since last
1022 * Returns 0 on success. Returns a negative number if there is no status change
1023 * since last update and 'force' is set to false. Returns a positive errno
1024 * otherwise. Has no effect if 'ofp_port' is not an OpenFlow port in 'ofproto'.
1026 * The caller must provide and own '*status'. */
1028 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
1029 bool force, struct smap *status)
1031 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1032 return (ofport && ofproto->ofproto_class->get_bfd_status
1033 ? ofproto->ofproto_class->get_bfd_status(ofport, force, status)
1037 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1038 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1039 * 0 if LACP partner information is not current (generally indicating a
1040 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1042 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
1044 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1045 return (ofport && ofproto->ofproto_class->port_is_lacp_current
1046 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
1052 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1053 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1054 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1055 * configuration plus, if there is more than one slave, a bonding
1058 * If 'aux' is already registered then this function updates its configuration
1059 * to 's'. Otherwise, this function registers a new bundle.
1061 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1064 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
1065 const struct ofproto_bundle_settings *s)
1067 return (ofproto->ofproto_class->bundle_set
1068 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
1072 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1073 * If no such bundle has been registered, this has no effect. */
1075 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
1077 return ofproto_bundle_register(ofproto, aux, NULL);
1081 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1082 * If 'aux' is already registered then this function updates its configuration
1083 * to 's'. Otherwise, this function registers a new mirror. */
1085 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1086 const struct ofproto_mirror_settings *s)
1088 return (ofproto->ofproto_class->mirror_set
1089 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1093 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1094 * If no mirror has been registered, this has no effect. */
1096 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1098 return ofproto_mirror_register(ofproto, aux, NULL);
1101 /* Retrieves statistics from mirror associated with client data pointer
1102 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1103 * 'bytes', respectively. If a particular counters is not supported,
1104 * the appropriate argument is set to UINT64_MAX. */
1106 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1107 uint64_t *packets, uint64_t *bytes)
1109 if (!ofproto->ofproto_class->mirror_get_stats) {
1110 *packets = *bytes = UINT64_MAX;
1114 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1118 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1119 * which all packets are flooded, instead of using MAC learning. If
1120 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1122 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1125 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1127 return (ofproto->ofproto_class->set_flood_vlans
1128 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1132 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1133 * output for a mirror. */
1135 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1137 return (ofproto->ofproto_class->is_mirror_output_bundle
1138 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1142 /* Configuration of OpenFlow tables. */
1144 /* Returns the number of OpenFlow tables in 'ofproto'. */
1146 ofproto_get_n_tables(const struct ofproto *ofproto)
1148 return ofproto->n_tables;
1151 /* Returns the number of Controller visible OpenFlow tables
1152 * in 'ofproto'. This number will exclude Hidden tables.
1153 * This funtion's return value should be less or equal to that of
1154 * ofproto_get_n_tables() . */
1156 ofproto_get_n_visible_tables(const struct ofproto *ofproto)
1158 uint8_t n = ofproto->n_tables;
1160 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1161 * if present, are always at the end.) */
1162 while(n && (ofproto->tables[n - 1].flags & OFTABLE_HIDDEN)) {
1169 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1170 * settings from 's'. 'table_id' must be in the range 0 through the number of
1171 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1173 * For read-only tables, only the name may be configured. */
1175 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1176 const struct ofproto_table_settings *s)
1178 struct oftable *table;
1180 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1181 table = &ofproto->tables[table_id];
1183 oftable_set_name(table, s->name);
1185 if (table->flags & OFTABLE_READONLY) {
1190 oftable_enable_eviction(table, s->groups, s->n_groups);
1192 oftable_disable_eviction(table);
1195 table->max_flows = s->max_flows;
1196 fat_rwlock_wrlock(&table->cls.rwlock);
1197 if (classifier_count(&table->cls) > table->max_flows
1198 && table->eviction_fields) {
1199 /* 'table' contains more flows than allowed. We might not be able to
1200 * evict them right away because of the asynchronous nature of flow
1201 * table changes. Schedule eviction for later. */
1202 switch (ofproto->state) {
1204 ofproto->state = S_EVICT;
1208 /* We're already deleting flows, nothing more to do. */
1213 classifier_set_prefix_fields(&table->cls,
1214 s->prefix_fields, s->n_prefix_fields);
1216 fat_rwlock_unlock(&table->cls.rwlock);
1220 ofproto_has_snoops(const struct ofproto *ofproto)
1222 return connmgr_has_snoops(ofproto->connmgr);
1226 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1228 connmgr_get_snoops(ofproto->connmgr, snoops);
1232 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1234 OVS_REQUIRES(ofproto_mutex)
1236 struct ofopgroup *group;
1238 ovs_assert(!rule->pending);
1240 group = ofopgroup_create_unattached(ofproto);
1241 delete_flow__(rule, group, reason);
1242 ofopgroup_submit(group);
1245 /* Deletes 'rule' from 'ofproto'.
1247 * Within an ofproto implementation, this function allows an ofproto
1248 * implementation to destroy any rules that remain when its ->destruct()
1249 * function is called. This function is not suitable for use elsewhere in an
1250 * ofproto implementation.
1252 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1253 * Cycle" in ofproto-provider.h. */
1255 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1256 OVS_EXCLUDED(ofproto_mutex)
1258 struct ofopgroup *group;
1260 ovs_mutex_lock(&ofproto_mutex);
1261 ovs_assert(!rule->pending);
1263 group = ofopgroup_create_unattached(ofproto);
1264 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1265 oftable_remove_rule__(ofproto, rule);
1266 ofproto->ofproto_class->rule_delete(rule);
1267 ofopgroup_submit(group);
1269 ovs_mutex_unlock(&ofproto_mutex);
1273 ofproto_flush__(struct ofproto *ofproto)
1274 OVS_EXCLUDED(ofproto_mutex)
1276 struct oftable *table;
1278 if (ofproto->ofproto_class->flush) {
1279 ofproto->ofproto_class->flush(ofproto);
1282 ovs_mutex_lock(&ofproto_mutex);
1283 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1284 struct rule *rule, *next_rule;
1285 struct cls_cursor cursor;
1287 if (table->flags & OFTABLE_HIDDEN) {
1291 fat_rwlock_rdlock(&table->cls.rwlock);
1292 cls_cursor_init(&cursor, &table->cls, NULL);
1293 fat_rwlock_unlock(&table->cls.rwlock);
1294 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1295 if (!rule->pending) {
1296 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1300 ovs_mutex_unlock(&ofproto_mutex);
1303 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1306 ofproto_destroy__(struct ofproto *ofproto)
1307 OVS_EXCLUDED(ofproto_mutex)
1309 struct oftable *table;
1311 ovs_assert(list_is_empty(&ofproto->pending));
1313 destroy_rule_executes(ofproto);
1314 delete_group(ofproto, OFPG_ALL);
1316 guarded_list_destroy(&ofproto->rule_executes);
1317 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1318 hmap_destroy(&ofproto->groups);
1320 connmgr_destroy(ofproto->connmgr);
1322 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1323 free(ofproto->name);
1324 free(ofproto->type);
1325 free(ofproto->mfr_desc);
1326 free(ofproto->hw_desc);
1327 free(ofproto->sw_desc);
1328 free(ofproto->serial_desc);
1329 free(ofproto->dp_desc);
1330 hmap_destroy(&ofproto->ports);
1331 hmap_destroy(&ofproto->ofport_usage);
1332 shash_destroy(&ofproto->port_by_name);
1333 simap_destroy(&ofproto->ofp_requests);
1335 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1336 oftable_destroy(table);
1338 free(ofproto->tables);
1340 hmap_destroy(&ofproto->deletions);
1342 ovs_assert(hindex_is_empty(&ofproto->cookies));
1343 hindex_destroy(&ofproto->cookies);
1345 free(ofproto->vlan_bitmap);
1347 ofproto->ofproto_class->dealloc(ofproto);
1351 ofproto_destroy(struct ofproto *p)
1352 OVS_EXCLUDED(ofproto_mutex)
1354 struct ofport *ofport, *next_ofport;
1355 struct ofport_usage *usage, *next_usage;
1362 meter_delete(p, 1, p->meter_features.max_meters);
1363 p->meter_features.max_meters = 0;
1369 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1370 ofport_destroy(ofport);
1373 HMAP_FOR_EACH_SAFE (usage, next_usage, hmap_node, &p->ofport_usage) {
1374 hmap_remove(&p->ofport_usage, &usage->hmap_node);
1378 p->ofproto_class->destruct(p);
1379 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1380 ovsrcu_postpone(ofproto_destroy__, p);
1383 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1384 * kernel datapath, for example, this destroys the datapath in the kernel, and
1385 * with the netdev-based datapath, it tears down the data structures that
1386 * represent the datapath.
1388 * The datapath should not be currently open as an ofproto. */
1390 ofproto_delete(const char *name, const char *type)
1392 const struct ofproto_class *class = ofproto_class_find__(type);
1393 return (!class ? EAFNOSUPPORT
1394 : !class->del ? EACCES
1395 : class->del(type, name));
1399 process_port_change(struct ofproto *ofproto, int error, char *devname)
1401 if (error == ENOBUFS) {
1402 reinit_ports(ofproto);
1403 } else if (!error) {
1404 update_port(ofproto, devname);
1410 ofproto_type_run(const char *datapath_type)
1412 const struct ofproto_class *class;
1415 datapath_type = ofproto_normalize_type(datapath_type);
1416 class = ofproto_class_find__(datapath_type);
1418 error = class->type_run ? class->type_run(datapath_type) : 0;
1419 if (error && error != EAGAIN) {
1420 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1421 datapath_type, ovs_strerror(error));
1427 ofproto_type_wait(const char *datapath_type)
1429 const struct ofproto_class *class;
1431 datapath_type = ofproto_normalize_type(datapath_type);
1432 class = ofproto_class_find__(datapath_type);
1434 if (class->type_wait) {
1435 class->type_wait(datapath_type);
1440 any_pending_ops(const struct ofproto *p)
1441 OVS_EXCLUDED(ofproto_mutex)
1445 ovs_mutex_lock(&ofproto_mutex);
1446 b = !list_is_empty(&p->pending);
1447 ovs_mutex_unlock(&ofproto_mutex);
1453 ofproto_run(struct ofproto *p)
1458 error = p->ofproto_class->run(p);
1459 if (error && error != EAGAIN) {
1460 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1463 run_rule_executes(p);
1465 /* Restore the eviction group heap invariant occasionally. */
1466 if (p->eviction_group_timer < time_msec()) {
1469 p->eviction_group_timer = time_msec() + 1000;
1471 for (i = 0; i < p->n_tables; i++) {
1472 struct oftable *table = &p->tables[i];
1473 struct eviction_group *evg;
1474 struct cls_cursor cursor;
1477 if (!table->eviction_fields) {
1481 ovs_mutex_lock(&ofproto_mutex);
1482 fat_rwlock_rdlock(&table->cls.rwlock);
1484 if (classifier_count(&table->cls) > 100000) {
1485 static struct vlog_rate_limit count_rl =
1486 VLOG_RATE_LIMIT_INIT(1, 1);
1487 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1488 " number of rules: %d", i,
1489 classifier_count(&table->cls));
1492 cls_cursor_init(&cursor, &table->cls, NULL);
1493 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1494 if (rule->idle_timeout || rule->hard_timeout) {
1495 if (!rule->eviction_group) {
1496 eviction_group_add_rule(rule);
1498 heap_raw_change(&rule->evg_node,
1499 rule_eviction_priority(p, rule));
1503 fat_rwlock_unlock(&table->cls.rwlock);
1505 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1506 heap_rebuild(&evg->rules);
1508 ovs_mutex_unlock(&ofproto_mutex);
1512 if (p->ofproto_class->port_poll) {
1515 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1516 process_port_change(p, error, devname);
1520 new_seq = seq_read(connectivity_seq_get());
1521 if (new_seq != p->change_seq) {
1522 struct sset devnames;
1523 const char *devname;
1524 struct ofport *ofport;
1526 /* Update OpenFlow port status for any port whose netdev has changed.
1528 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1529 * destroyed, so it's not safe to update ports directly from the
1530 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1531 * need this two-phase approach. */
1532 sset_init(&devnames);
1533 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1534 uint64_t port_change_seq;
1536 port_change_seq = netdev_get_change_seq(ofport->netdev);
1537 if (ofport->change_seq != port_change_seq) {
1538 ofport->change_seq = port_change_seq;
1539 sset_add(&devnames, netdev_get_name(ofport->netdev));
1542 SSET_FOR_EACH (devname, &devnames) {
1543 update_port(p, devname);
1545 sset_destroy(&devnames);
1547 p->change_seq = new_seq;
1552 connmgr_run(p->connmgr, handle_openflow);
1556 connmgr_run(p->connmgr, NULL);
1558 if (!any_pending_ops(p)) {
1559 p->state = S_OPENFLOW;
1564 connmgr_run(p->connmgr, NULL);
1566 if (!any_pending_ops(p)) {
1567 connmgr_flushed(p->connmgr);
1568 p->state = S_OPENFLOW;
1580 ofproto_wait(struct ofproto *p)
1582 p->ofproto_class->wait(p);
1583 if (p->ofproto_class->port_poll_wait) {
1584 p->ofproto_class->port_poll_wait(p);
1586 seq_wait(connectivity_seq_get(), p->change_seq);
1590 connmgr_wait(p->connmgr, true);
1595 connmgr_wait(p->connmgr, false);
1596 if (!any_pending_ops(p)) {
1597 poll_immediate_wake();
1604 ofproto_is_alive(const struct ofproto *p)
1606 return connmgr_has_controllers(p->connmgr);
1609 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1610 * memory_report(). */
1612 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1614 const struct oftable *table;
1615 unsigned int n_rules;
1617 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1619 ovs_mutex_lock(&ofproto_mutex);
1620 simap_increase(usage, "ops",
1621 ofproto->n_pending + hmap_count(&ofproto->deletions));
1622 ovs_mutex_unlock(&ofproto_mutex);
1625 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1626 fat_rwlock_rdlock(&table->cls.rwlock);
1627 n_rules += classifier_count(&table->cls);
1628 fat_rwlock_unlock(&table->cls.rwlock);
1630 simap_increase(usage, "rules", n_rules);
1632 if (ofproto->ofproto_class->get_memory_usage) {
1633 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1636 connmgr_get_memory_usage(ofproto->connmgr, usage);
1640 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1642 const struct ofproto_class *class;
1644 datapath_type = ofproto_normalize_type(datapath_type);
1645 class = ofproto_class_find__(datapath_type);
1647 if (class && class->type_get_memory_usage) {
1648 class->type_get_memory_usage(datapath_type, usage);
1653 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1656 connmgr_get_controller_info(ofproto->connmgr, info);
1660 ofproto_free_ofproto_controller_info(struct shash *info)
1662 connmgr_free_controller_info(info);
1665 /* Makes a deep copy of 'old' into 'port'. */
1667 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1669 port->name = xstrdup(old->name);
1670 port->type = xstrdup(old->type);
1671 port->ofp_port = old->ofp_port;
1674 /* Frees memory allocated to members of 'ofproto_port'.
1676 * Do not call this function on an ofproto_port obtained from
1677 * ofproto_port_dump_next(): that function retains ownership of the data in the
1680 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1682 free(ofproto_port->name);
1683 free(ofproto_port->type);
1686 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1688 * This function provides no status indication. An error status for the entire
1689 * dump operation is provided when it is completed by calling
1690 * ofproto_port_dump_done().
1693 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1694 const struct ofproto *ofproto)
1696 dump->ofproto = ofproto;
1697 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1701 /* Attempts to retrieve another port from 'dump', which must have been created
1702 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1703 * 'port' and returns true. On failure, returns false.
1705 * Failure might indicate an actual error or merely that the last port has been
1706 * dumped. An error status for the entire dump operation is provided when it
1707 * is completed by calling ofproto_port_dump_done().
1709 * The ofproto owns the data stored in 'port'. It will remain valid until at
1710 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1711 * ofproto_port_dump_done(). */
1713 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1714 struct ofproto_port *port)
1716 const struct ofproto *ofproto = dump->ofproto;
1722 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1725 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1731 /* Completes port table dump operation 'dump', which must have been created
1732 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1733 * error-free, otherwise a positive errno value describing the problem. */
1735 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1737 const struct ofproto *ofproto = dump->ofproto;
1739 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1742 return dump->error == EOF ? 0 : dump->error;
1745 /* Returns the type to pass to netdev_open() when a datapath of type
1746 * 'datapath_type' has a port of type 'port_type', for a few special
1747 * cases when a netdev type differs from a port type. For example, when
1748 * using the userspace datapath, a port of type "internal" needs to be
1751 * Returns either 'type' itself or a string literal, which must not be
1754 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1756 const struct ofproto_class *class;
1758 datapath_type = ofproto_normalize_type(datapath_type);
1759 class = ofproto_class_find__(datapath_type);
1764 return (class->port_open_type
1765 ? class->port_open_type(datapath_type, port_type)
1769 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1770 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1771 * the port's OpenFlow port number.
1773 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1774 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1775 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1776 * 'ofp_portp' is non-null). */
1778 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1779 ofp_port_t *ofp_portp)
1781 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1784 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1786 const char *netdev_name = netdev_get_name(netdev);
1788 simap_put(&ofproto->ofp_requests, netdev_name,
1789 ofp_to_u16(ofp_port));
1790 update_port(ofproto, netdev_name);
1793 *ofp_portp = OFPP_NONE;
1795 struct ofproto_port ofproto_port;
1797 error = ofproto_port_query_by_name(ofproto,
1798 netdev_get_name(netdev),
1801 *ofp_portp = ofproto_port.ofp_port;
1802 ofproto_port_destroy(&ofproto_port);
1809 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1810 * initializes '*port' appropriately; on failure, returns a positive errno
1813 * The caller owns the data in 'ofproto_port' and must free it with
1814 * ofproto_port_destroy() when it is no longer needed. */
1816 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1817 struct ofproto_port *port)
1821 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1823 memset(port, 0, sizeof *port);
1828 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1829 * Returns 0 if successful, otherwise a positive errno. */
1831 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1833 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1834 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1835 struct simap_node *ofp_request_node;
1838 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1839 if (ofp_request_node) {
1840 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1843 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1844 if (!error && ofport) {
1845 /* 'name' is the netdev's name and update_port() is going to close the
1846 * netdev. Just in case update_port() refers to 'name' after it
1847 * destroys 'ofport', make a copy of it around the update_port()
1849 char *devname = xstrdup(name);
1850 update_port(ofproto, devname);
1857 flow_mod_init(struct ofputil_flow_mod *fm,
1858 const struct match *match, unsigned int priority,
1859 const struct ofpact *ofpacts, size_t ofpacts_len,
1860 enum ofp_flow_mod_command command)
1862 memset(fm, 0, sizeof *fm);
1864 fm->priority = priority;
1867 fm->modify_cookie = false;
1869 fm->command = command;
1870 fm->idle_timeout = 0;
1871 fm->hard_timeout = 0;
1872 fm->buffer_id = UINT32_MAX;
1873 fm->out_port = OFPP_ANY;
1874 fm->out_group = OFPG_ANY;
1876 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1877 fm->ofpacts_len = ofpacts_len;
1881 simple_flow_mod(struct ofproto *ofproto,
1882 const struct match *match, unsigned int priority,
1883 const struct ofpact *ofpacts, size_t ofpacts_len,
1884 enum ofp_flow_mod_command command)
1886 struct ofputil_flow_mod fm;
1888 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1890 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1893 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1894 * performs the 'n_actions' actions in 'actions'. The new flow will not
1897 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1898 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1899 * controllers; otherwise, it will be hidden.
1901 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1903 * This is a helper function for in-band control and fail-open. */
1905 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1906 unsigned int priority,
1907 const struct ofpact *ofpacts, size_t ofpacts_len)
1908 OVS_EXCLUDED(ofproto_mutex)
1910 const struct rule *rule;
1913 /* First do a cheap check whether the rule we're looking for already exists
1914 * with the actions that we want. If it does, then we're done. */
1915 fat_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1916 rule = rule_from_cls_rule(classifier_find_match_exactly(
1917 &ofproto->tables[0].cls, match, priority));
1919 const struct rule_actions *actions = rule_get_actions(rule);
1920 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1921 ofpacts, ofpacts_len);
1925 fat_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1927 /* If there's no such rule or the rule doesn't have the actions we want,
1928 * fall back to a executing a full flow mod. We can't optimize this at
1929 * all because we didn't take enough locks above to ensure that the flow
1930 * table didn't already change beneath us. */
1932 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1933 OFPFC_MODIFY_STRICT);
1937 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1938 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1939 * operation cannot be initiated now but may be retried later.
1941 * This is a helper function for in-band control and fail-open and the "learn"
1944 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1945 OVS_EXCLUDED(ofproto_mutex)
1947 /* Optimize for the most common case of a repeated learn action.
1948 * If an identical flow already exists we only need to update its
1949 * 'modified' time. */
1950 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1951 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1952 struct oftable *table = &ofproto->tables[fm->table_id];
1956 fat_rwlock_rdlock(&table->cls.rwlock);
1957 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
1961 /* Reading many of the rule fields and writing on 'modified'
1962 * requires the rule->mutex. Also, rule->actions may change
1963 * if rule->mutex is not held. */
1964 const struct rule_actions *actions;
1966 ovs_mutex_lock(&rule->mutex);
1967 actions = rule_get_actions(rule);
1968 if (rule->idle_timeout == fm->idle_timeout
1969 && rule->hard_timeout == fm->hard_timeout
1970 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1971 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1972 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
1973 actions->ofpacts, actions->ofpacts_len)) {
1974 /* Rule already exists and need not change, only update the
1975 modified timestamp. */
1976 rule->modified = time_msec();
1979 ovs_mutex_unlock(&rule->mutex);
1981 fat_rwlock_unlock(&table->cls.rwlock);
1988 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1991 /* Searches for a rule with matching criteria exactly equal to 'target' in
1992 * ofproto's table 0 and, if it finds one, deletes it.
1994 * This is a helper function for in-band control and fail-open. */
1996 ofproto_delete_flow(struct ofproto *ofproto,
1997 const struct match *target, unsigned int priority)
1998 OVS_EXCLUDED(ofproto_mutex)
2000 struct classifier *cls = &ofproto->tables[0].cls;
2003 /* First do a cheap check whether the rule we're looking for has already
2004 * been deleted. If so, then we're done. */
2005 fat_rwlock_rdlock(&cls->rwlock);
2006 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2008 fat_rwlock_unlock(&cls->rwlock);
2013 /* Fall back to a executing a full flow mod. We can't optimize this at all
2014 * because we didn't take enough locks above to ensure that the flow table
2015 * didn't already change beneath us. */
2016 return simple_flow_mod(ofproto, target, priority, NULL, 0,
2017 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
2020 /* Starts the process of deleting all of the flows from all of ofproto's flow
2021 * tables and then reintroducing the flows required by in-band control and
2022 * fail-open. The process will complete in a later call to ofproto_run(). */
2024 ofproto_flush_flows(struct ofproto *ofproto)
2026 COVERAGE_INC(ofproto_flush);
2027 ofproto->state = S_FLUSH;
2031 reinit_ports(struct ofproto *p)
2033 struct ofproto_port_dump dump;
2034 struct sset devnames;
2035 struct ofport *ofport;
2036 struct ofproto_port ofproto_port;
2037 const char *devname;
2039 COVERAGE_INC(ofproto_reinit_ports);
2041 sset_init(&devnames);
2042 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2043 sset_add(&devnames, netdev_get_name(ofport->netdev));
2045 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2046 sset_add(&devnames, ofproto_port.name);
2049 SSET_FOR_EACH (devname, &devnames) {
2050 update_port(p, devname);
2052 sset_destroy(&devnames);
2056 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2060 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2061 port_idx = port_idx ? port_idx : UINT16_MAX;
2063 if (port_idx >= ofproto->max_ports
2064 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2065 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2066 long long int last_used_at, lru = LLONG_MAX;
2068 /* Search for a free OpenFlow port number. We try not to
2069 * immediately reuse them to prevent problems due to old
2072 * We limit the automatically assigned port numbers to the lower half
2073 * of the port range, to reserve the upper half for assignment by
2076 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2077 ofproto->alloc_port_no = 1;
2079 last_used_at = ofport_get_usage(ofproto,
2080 u16_to_ofp(ofproto->alloc_port_no));
2081 if (!last_used_at) {
2082 port_idx = ofproto->alloc_port_no;
2084 } else if ( last_used_at < time_msec() - 60*60*1000) {
2085 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2086 * more than an hour ago, consider it usable. */
2087 ofport_remove_usage(ofproto,
2088 u16_to_ofp(ofproto->alloc_port_no));
2089 port_idx = ofproto->alloc_port_no;
2091 } else if (last_used_at < lru) {
2093 lru_ofport = ofproto->alloc_port_no;
2096 if (ofproto->alloc_port_no == end_port_no) {
2098 port_idx = lru_ofport;
2105 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2106 return u16_to_ofp(port_idx);
2110 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2112 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2113 ofport_set_usage(ofproto, ofp_port, time_msec());
2117 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2118 * pointer if the netdev cannot be opened. On success, also fills in
2120 static struct netdev *
2121 ofport_open(struct ofproto *ofproto,
2122 struct ofproto_port *ofproto_port,
2123 struct ofputil_phy_port *pp)
2125 enum netdev_flags flags;
2126 struct netdev *netdev;
2129 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2131 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2132 "cannot be opened (%s)",
2134 ofproto_port->name, ofproto_port->ofp_port,
2135 ofproto_port->name, ovs_strerror(error));
2139 if (ofproto_port->ofp_port == OFPP_NONE) {
2140 if (!strcmp(ofproto->name, ofproto_port->name)) {
2141 ofproto_port->ofp_port = OFPP_LOCAL;
2143 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2144 ofproto_port->name);
2147 pp->port_no = ofproto_port->ofp_port;
2148 netdev_get_etheraddr(netdev, pp->hw_addr);
2149 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2150 netdev_get_flags(netdev, &flags);
2151 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2152 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2153 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2154 &pp->supported, &pp->peer);
2155 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2156 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2161 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2162 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2165 ofport_equal(const struct ofputil_phy_port *a,
2166 const struct ofputil_phy_port *b)
2168 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2169 && a->state == b->state
2170 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2171 && a->curr == b->curr
2172 && a->advertised == b->advertised
2173 && a->supported == b->supported
2174 && a->peer == b->peer
2175 && a->curr_speed == b->curr_speed
2176 && a->max_speed == b->max_speed);
2179 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2180 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2181 * one with the same name or port number). */
2183 ofport_install(struct ofproto *p,
2184 struct netdev *netdev, const struct ofputil_phy_port *pp)
2186 const char *netdev_name = netdev_get_name(netdev);
2187 struct ofport *ofport;
2190 /* Create ofport. */
2191 ofport = p->ofproto_class->port_alloc();
2196 ofport->ofproto = p;
2197 ofport->netdev = netdev;
2198 ofport->change_seq = netdev_get_change_seq(netdev);
2200 ofport->ofp_port = pp->port_no;
2201 ofport->created = time_msec();
2203 /* Add port to 'p'. */
2204 hmap_insert(&p->ports, &ofport->hmap_node,
2205 hash_ofp_port(ofport->ofp_port));
2206 shash_add(&p->port_by_name, netdev_name, ofport);
2208 update_mtu(p, ofport);
2210 /* Let the ofproto_class initialize its private data. */
2211 error = p->ofproto_class->port_construct(ofport);
2215 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2219 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2220 p->name, netdev_name, ovs_strerror(error));
2222 ofport_destroy__(ofport);
2224 netdev_close(netdev);
2228 /* Removes 'ofport' from 'p' and destroys it. */
2230 ofport_remove(struct ofport *ofport)
2232 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2234 ofport_destroy(ofport);
2237 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2240 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2242 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2244 ofport_remove(port);
2248 /* Updates 'port' with new 'pp' description.
2250 * Does not handle a name or port number change. The caller must implement
2251 * such a change as a delete followed by an add. */
2253 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2255 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2256 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2257 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2258 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2259 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2260 port->pp.curr = pp->curr;
2261 port->pp.advertised = pp->advertised;
2262 port->pp.supported = pp->supported;
2263 port->pp.peer = pp->peer;
2264 port->pp.curr_speed = pp->curr_speed;
2265 port->pp.max_speed = pp->max_speed;
2267 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2268 &port->pp, OFPPR_MODIFY);
2271 /* Update OpenFlow 'state' in 'port' and notify controller. */
2273 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2275 if (port->pp.state != state) {
2276 port->pp.state = state;
2277 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2278 &port->pp, OFPPR_MODIFY);
2283 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2285 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2287 if (port->ofproto->ofproto_class->set_realdev) {
2288 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2290 if (port->ofproto->ofproto_class->set_stp_port) {
2291 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2293 if (port->ofproto->ofproto_class->set_cfm) {
2294 port->ofproto->ofproto_class->set_cfm(port, NULL);
2296 if (port->ofproto->ofproto_class->bundle_remove) {
2297 port->ofproto->ofproto_class->bundle_remove(port);
2303 ofport_destroy__(struct ofport *port)
2305 struct ofproto *ofproto = port->ofproto;
2306 const char *name = netdev_get_name(port->netdev);
2308 hmap_remove(&ofproto->ports, &port->hmap_node);
2309 shash_delete(&ofproto->port_by_name,
2310 shash_find(&ofproto->port_by_name, name));
2312 netdev_close(port->netdev);
2313 ofproto->ofproto_class->port_dealloc(port);
2317 ofport_destroy(struct ofport *port)
2320 dealloc_ofp_port(port->ofproto, port->ofp_port);
2321 port->ofproto->ofproto_class->port_destruct(port);
2322 ofport_destroy__(port);
2327 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2329 struct ofport *port;
2331 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2333 if (port->ofp_port == ofp_port) {
2340 static long long int
2341 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2343 struct ofport_usage *usage;
2345 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2346 &ofproto->ofport_usage) {
2347 if (usage->ofp_port == ofp_port) {
2348 return usage->last_used;
2355 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2356 long long int last_used)
2358 struct ofport_usage *usage;
2359 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2360 &ofproto->ofport_usage) {
2361 if (usage->ofp_port == ofp_port) {
2362 usage->last_used = last_used;
2366 ovs_assert(last_used == LLONG_MAX);
2368 usage = xmalloc(sizeof *usage);
2369 usage->ofp_port = ofp_port;
2370 usage->last_used = last_used;
2371 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2372 hash_ofp_port(ofp_port));
2376 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2378 struct ofport_usage *usage;
2379 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2380 &ofproto->ofport_usage) {
2381 if (usage->ofp_port == ofp_port) {
2382 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2390 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2392 struct ofproto *ofproto = port->ofproto;
2395 if (ofproto->ofproto_class->port_get_stats) {
2396 error = ofproto->ofproto_class->port_get_stats(port, stats);
2405 update_port(struct ofproto *ofproto, const char *name)
2407 struct ofproto_port ofproto_port;
2408 struct ofputil_phy_port pp;
2409 struct netdev *netdev;
2410 struct ofport *port;
2412 COVERAGE_INC(ofproto_update_port);
2414 /* Fetch 'name''s location and properties from the datapath. */
2415 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2416 ? ofport_open(ofproto, &ofproto_port, &pp)
2420 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2421 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2422 struct netdev *old_netdev = port->netdev;
2424 /* 'name' hasn't changed location. Any properties changed? */
2425 if (!ofport_equal(&port->pp, &pp)) {
2426 ofport_modified(port, &pp);
2429 update_mtu(ofproto, port);
2431 /* Install the newly opened netdev in case it has changed.
2432 * Don't close the old netdev yet in case port_modified has to
2433 * remove a retained reference to it.*/
2434 port->netdev = netdev;
2435 port->change_seq = netdev_get_change_seq(netdev);
2437 if (port->ofproto->ofproto_class->port_modified) {
2438 port->ofproto->ofproto_class->port_modified(port);
2441 netdev_close(old_netdev);
2443 /* If 'port' is nonnull then its name differs from 'name' and thus
2444 * we should delete it. If we think there's a port named 'name'
2445 * then its port number must be wrong now so delete it too. */
2447 ofport_remove(port);
2449 ofport_remove_with_name(ofproto, name);
2450 ofport_install(ofproto, netdev, &pp);
2453 /* Any port named 'name' is gone now. */
2454 ofport_remove_with_name(ofproto, name);
2456 ofproto_port_destroy(&ofproto_port);
2460 init_ports(struct ofproto *p)
2462 struct ofproto_port_dump dump;
2463 struct ofproto_port ofproto_port;
2464 struct shash_node *node, *next;
2466 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2467 const char *name = ofproto_port.name;
2469 if (shash_find(&p->port_by_name, name)) {
2470 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2473 struct ofputil_phy_port pp;
2474 struct netdev *netdev;
2476 /* Check if an OpenFlow port number had been requested. */
2477 node = shash_find(&init_ofp_ports, name);
2479 const struct iface_hint *iface_hint = node->data;
2480 simap_put(&p->ofp_requests, name,
2481 ofp_to_u16(iface_hint->ofp_port));
2484 netdev = ofport_open(p, &ofproto_port, &pp);
2486 ofport_install(p, netdev, &pp);
2487 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2488 p->alloc_port_no = MAX(p->alloc_port_no,
2489 ofp_to_u16(ofproto_port.ofp_port));
2495 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2496 struct iface_hint *iface_hint = node->data;
2498 if (!strcmp(iface_hint->br_name, p->name)) {
2499 free(iface_hint->br_name);
2500 free(iface_hint->br_type);
2502 shash_delete(&init_ofp_ports, node);
2509 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2510 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2512 find_min_mtu(struct ofproto *p)
2514 struct ofport *ofport;
2517 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2518 struct netdev *netdev = ofport->netdev;
2521 /* Skip any internal ports, since that's what we're trying to
2523 if (!strcmp(netdev_get_type(netdev), "internal")) {
2527 if (netdev_get_mtu(netdev, &dev_mtu)) {
2530 if (!mtu || dev_mtu < mtu) {
2535 return mtu ? mtu: ETH_PAYLOAD_MAX;
2538 /* Update MTU of all datapath devices on 'p' to the minimum of the
2539 * non-datapath ports in event of 'port' added or changed. */
2541 update_mtu(struct ofproto *p, struct ofport *port)
2543 struct ofport *ofport;
2544 struct netdev *netdev = port->netdev;
2545 int dev_mtu, old_min;
2547 if (netdev_get_mtu(netdev, &dev_mtu)) {
2551 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2552 if (dev_mtu > p->min_mtu) {
2553 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2554 dev_mtu = p->min_mtu;
2557 port->mtu = dev_mtu;
2561 /* For non-internal port find new min mtu. */
2562 old_min = p->min_mtu;
2563 port->mtu = dev_mtu;
2564 p->min_mtu = find_min_mtu(p);
2565 if (p->min_mtu == old_min) {
2569 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2570 struct netdev *netdev = ofport->netdev;
2572 if (!strcmp(netdev_get_type(netdev), "internal")) {
2573 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2574 ofport->mtu = p->min_mtu;
2581 ofproto_rule_destroy__(struct rule *rule)
2582 OVS_NO_THREAD_SAFETY_ANALYSIS
2584 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2585 rule_actions_destroy(rule_get_actions(rule));
2586 ovs_mutex_destroy(&rule->mutex);
2587 rule->ofproto->ofproto_class->rule_dealloc(rule);
2591 rule_destroy_cb(struct rule *rule)
2593 rule->ofproto->ofproto_class->rule_destruct(rule);
2594 ofproto_rule_destroy__(rule);
2598 ofproto_rule_ref(struct rule *rule)
2601 ovs_refcount_ref(&rule->ref_count);
2605 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2606 * ref_count reaches 0.
2608 * Use of RCU allows short term use (between RCU quiescent periods) without
2609 * keeping a reference. A reference must be taken if the rule needs to
2610 * stay around accross the RCU quiescent periods. */
2612 ofproto_rule_unref(struct rule *rule)
2614 if (rule && ovs_refcount_unref(&rule->ref_count) == 1) {
2615 ovsrcu_postpone(rule_destroy_cb, rule);
2619 static uint32_t get_provider_meter_id(const struct ofproto *,
2620 uint32_t of_meter_id);
2622 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2623 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2624 const struct rule_actions *
2625 rule_actions_create(const struct ofproto *ofproto,
2626 const struct ofpact *ofpacts, size_t ofpacts_len)
2628 struct rule_actions *actions;
2630 actions = xmalloc(sizeof *actions + ofpacts_len);
2631 actions->ofpacts_len = ofpacts_len;
2632 actions->provider_meter_id
2633 = get_provider_meter_id(ofproto,
2634 ofpacts_get_meter(ofpacts, ofpacts_len));
2635 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2640 /* Free the actions after the RCU quiescent period is reached. */
2642 rule_actions_destroy(const struct rule_actions *actions)
2645 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2649 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2650 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2652 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2653 OVS_REQUIRES(ofproto_mutex)
2655 if (port == OFPP_ANY) {
2658 const struct rule_actions *actions = rule_get_actions(rule);
2659 return ofpacts_output_to_port(actions->ofpacts,
2660 actions->ofpacts_len, port);
2664 /* Returns true if 'rule' has group and equals group_id. */
2666 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2667 OVS_REQUIRES(ofproto_mutex)
2669 if (group_id == OFPG_ANY) {
2672 const struct rule_actions *actions = rule_get_actions(rule);
2673 return ofpacts_output_to_group(actions->ofpacts,
2674 actions->ofpacts_len, group_id);
2678 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2679 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2681 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2682 OVS_REQUIRES(ofproto_mutex)
2684 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2689 case OFOPERATION_ADD:
2690 case OFOPERATION_DELETE:
2693 case OFOPERATION_MODIFY:
2694 case OFOPERATION_REPLACE:
2695 return ofpacts_output_to_port(op->actions->ofpacts,
2696 op->actions->ofpacts_len, out_port);
2703 rule_execute_destroy(struct rule_execute *e)
2705 ofproto_rule_unref(e->rule);
2706 list_remove(&e->list_node);
2710 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2711 * by passing them to the ofproto provider. */
2713 run_rule_executes(struct ofproto *ofproto)
2714 OVS_EXCLUDED(ofproto_mutex)
2716 struct rule_execute *e, *next;
2717 struct list executes;
2719 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2720 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2723 flow_extract(e->packet, NULL, &flow);
2724 flow.in_port.ofp_port = e->in_port;
2725 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2727 rule_execute_destroy(e);
2731 /* Destroys and discards all "rule_execute" operations queued up in
2732 * ofproto->rule_executes. */
2734 destroy_rule_executes(struct ofproto *ofproto)
2736 struct rule_execute *e, *next;
2737 struct list executes;
2739 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2740 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2741 ofpbuf_delete(e->packet);
2742 rule_execute_destroy(e);
2746 /* Returns true if 'rule' should be hidden from the controller.
2748 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2749 * (e.g. by in-band control) and are intentionally hidden from the
2752 ofproto_rule_is_hidden(const struct rule *rule)
2754 return (rule->cr.priority > UINT16_MAX);
2758 oftable_is_modifiable(const struct oftable *table,
2759 enum ofputil_flow_mod_flags flags)
2761 if (flags & OFPUTIL_FF_NO_READONLY) {
2765 return !(table->flags & OFTABLE_READONLY);
2769 rule_is_modifiable(const struct rule *rule, enum ofputil_flow_mod_flags flags)
2771 const struct oftable *rule_table;
2773 rule_table = &rule->ofproto->tables[rule->table_id];
2774 return oftable_is_modifiable(rule_table, flags);
2778 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2780 ofconn_send_reply(ofconn, make_echo_reply(oh));
2785 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2787 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2788 struct ofputil_switch_features features;
2789 struct ofport *port;
2793 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2795 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2797 features.datapath_id = ofproto->datapath_id;
2798 features.n_buffers = pktbuf_capacity();
2799 features.n_tables = ofproto_get_n_visible_tables(ofproto);
2800 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2801 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2803 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2805 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2806 features.auxiliary_id = 0;
2807 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2809 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2810 ofputil_put_switch_features_port(&port->pp, b);
2813 ofconn_send_reply(ofconn, b);
2818 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2820 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2821 struct ofp_switch_config *osc;
2822 enum ofp_config_flags flags;
2826 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2827 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2828 flags = ofproto->frag_handling;
2829 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2830 if (oh->version < OFP13_VERSION
2831 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2832 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2834 osc->flags = htons(flags);
2835 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2836 ofconn_send_reply(ofconn, buf);
2842 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2844 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2845 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2846 uint16_t flags = ntohs(osc->flags);
2848 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2849 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2850 enum ofp_config_flags cur = ofproto->frag_handling;
2851 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2853 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2855 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2856 ofproto->frag_handling = next;
2858 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2860 ofputil_frag_handling_to_string(next));
2864 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2865 ofconn_set_invalid_ttl_to_controller(ofconn,
2866 (oh->version < OFP13_VERSION
2867 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2869 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2874 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2875 * error message code for the caller to propagate upward. Otherwise, returns
2878 * The log message mentions 'msg_type'. */
2880 reject_slave_controller(struct ofconn *ofconn)
2882 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2883 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2884 return OFPERR_OFPBRC_EPERM;
2890 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2893 * - If they use a meter, then 'ofproto' has that meter configured.
2895 * - If they use any groups, then 'ofproto' has that group configured.
2897 * Returns 0 if successful, otherwise an OpenFlow error. */
2899 ofproto_check_ofpacts(struct ofproto *ofproto,
2900 const struct ofpact ofpacts[], size_t ofpacts_len)
2902 const struct ofpact *a;
2905 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2906 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2907 return OFPERR_OFPMMFC_INVALID_METER;
2910 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2911 if (a->type == OFPACT_GROUP
2912 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2913 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2921 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2923 struct ofproto *p = ofconn_get_ofproto(ofconn);
2924 struct ofputil_packet_out po;
2925 struct ofpbuf *payload;
2926 uint64_t ofpacts_stub[1024 / 8];
2927 struct ofpbuf ofpacts;
2931 COVERAGE_INC(ofproto_packet_out);
2933 error = reject_slave_controller(ofconn);
2938 /* Decode message. */
2939 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2940 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2942 goto exit_free_ofpacts;
2944 if (ofp_to_u16(po.in_port) >= p->max_ports
2945 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2946 error = OFPERR_OFPBRC_BAD_PORT;
2947 goto exit_free_ofpacts;
2951 if (po.buffer_id != UINT32_MAX) {
2952 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2953 if (error || !payload) {
2954 goto exit_free_ofpacts;
2957 /* Ensure that the L3 header is 32-bit aligned. */
2958 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2961 /* Verify actions against packet, then send packet if successful. */
2962 flow_extract(payload, NULL, &flow);
2963 flow.in_port.ofp_port = po.in_port;
2964 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
2966 error = p->ofproto_class->packet_out(p, payload, &flow,
2967 po.ofpacts, po.ofpacts_len);
2969 ofpbuf_delete(payload);
2972 ofpbuf_uninit(&ofpacts);
2978 update_port_config(struct ofconn *ofconn, struct ofport *port,
2979 enum ofputil_port_config config,
2980 enum ofputil_port_config mask)
2982 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
2984 if (toggle & OFPUTIL_PC_PORT_DOWN
2985 && (config & OFPUTIL_PC_PORT_DOWN
2986 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
2987 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
2988 /* We tried to bring the port up or down, but it failed, so don't
2989 * update the "down" bit. */
2990 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2994 enum ofputil_port_config old_config = port->pp.config;
2995 port->pp.config ^= toggle;
2996 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2997 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3003 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3005 struct ofproto *p = ofconn_get_ofproto(ofconn);
3006 struct ofputil_port_mod pm;
3007 struct ofport *port;
3010 error = reject_slave_controller(ofconn);
3015 error = ofputil_decode_port_mod(oh, &pm, false);
3020 port = ofproto_get_port(p, pm.port_no);
3022 return OFPERR_OFPPMFC_BAD_PORT;
3023 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3024 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3026 update_port_config(ofconn, port, pm.config, pm.mask);
3028 netdev_set_advertisements(port->netdev, pm.advertise);
3035 handle_desc_stats_request(struct ofconn *ofconn,
3036 const struct ofp_header *request)
3038 static const char *default_mfr_desc = "Nicira, Inc.";
3039 static const char *default_hw_desc = "Open vSwitch";
3040 static const char *default_sw_desc = VERSION;
3041 static const char *default_serial_desc = "None";
3042 static const char *default_dp_desc = "None";
3044 struct ofproto *p = ofconn_get_ofproto(ofconn);
3045 struct ofp_desc_stats *ods;
3048 msg = ofpraw_alloc_stats_reply(request, 0);
3049 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3050 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3051 sizeof ods->mfr_desc);
3052 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3053 sizeof ods->hw_desc);
3054 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3055 sizeof ods->sw_desc);
3056 ovs_strlcpy(ods->serial_num,
3057 p->serial_desc ? p->serial_desc : default_serial_desc,
3058 sizeof ods->serial_num);
3059 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3060 sizeof ods->dp_desc);
3061 ofconn_send_reply(ofconn, msg);
3067 handle_table_stats_request(struct ofconn *ofconn,
3068 const struct ofp_header *request)
3070 struct ofproto *p = ofconn_get_ofproto(ofconn);
3071 struct ofp12_table_stats *ots;
3076 /* Set up default values.
3078 * ofp12_table_stats is used as a generic structure as
3079 * it is able to hold all the fields for ofp10_table_stats
3080 * and ofp11_table_stats (and of course itself).
3082 ots = xcalloc(p->n_tables, sizeof *ots);
3083 for (i = 0; i < p->n_tables; i++) {
3084 ots[i].table_id = i;
3085 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3086 ots[i].match = htonll(OFPXMT13_MASK);
3087 ots[i].wildcards = htonll(OFPXMT13_MASK);
3088 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3089 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3090 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3091 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3092 ots[i].metadata_match = OVS_BE64_MAX;
3093 ots[i].metadata_write = OVS_BE64_MAX;
3094 ots[i].instructions = htonl(OFPIT11_ALL);
3095 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3096 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3097 fat_rwlock_rdlock(&p->tables[i].cls.rwlock);
3098 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3099 fat_rwlock_unlock(&p->tables[i].cls.rwlock);
3102 p->ofproto_class->get_tables(p, ots);
3104 /* Post-process the tables, dropping hidden tables. */
3105 n_tables = p->n_tables;
3106 for (i = 0; i < p->n_tables; i++) {
3107 const struct oftable *table = &p->tables[i];
3109 if (table->flags & OFTABLE_HIDDEN) {
3115 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3118 if (table->max_flows < ntohl(ots[i].max_entries)) {
3119 ots[i].max_entries = htonl(table->max_flows);
3123 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3124 ofconn_send_reply(ofconn, msg);
3132 append_port_stat(struct ofport *port, struct list *replies)
3134 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3136 calc_duration(port->created, time_msec(),
3137 &ops.duration_sec, &ops.duration_nsec);
3139 /* Intentionally ignore return value, since errors will set
3140 * 'stats' to all-1s, which is correct for OpenFlow, and
3141 * netdev_get_stats() will log errors. */
3142 ofproto_port_get_stats(port, &ops.stats);
3144 ofputil_append_port_stat(replies, &ops);
3148 handle_port_request(struct ofconn *ofconn,
3149 const struct ofp_header *request, ofp_port_t port_no,
3150 void (*cb)(struct ofport *, struct list *replies))
3152 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3153 struct ofport *port;
3154 struct list replies;
3156 ofpmp_init(&replies, request);
3157 if (port_no != OFPP_ANY) {
3158 port = ofproto_get_port(ofproto, port_no);
3163 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3168 ofconn_send_replies(ofconn, &replies);
3172 handle_port_stats_request(struct ofconn *ofconn,
3173 const struct ofp_header *request)
3178 error = ofputil_decode_port_stats_request(request, &port_no);
3180 handle_port_request(ofconn, request, port_no, append_port_stat);
3186 append_port_desc(struct ofport *port, struct list *replies)
3188 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3192 handle_port_desc_stats_request(struct ofconn *ofconn,
3193 const struct ofp_header *request)
3198 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3200 handle_port_request(ofconn, request, port_no, append_port_desc);
3206 hash_cookie(ovs_be64 cookie)
3208 return hash_uint64((OVS_FORCE uint64_t)cookie);
3212 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3213 OVS_REQUIRES(ofproto_mutex)
3215 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3216 hash_cookie(rule->flow_cookie));
3220 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3221 OVS_REQUIRES(ofproto_mutex)
3223 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3227 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3228 ovs_be64 new_cookie)
3229 OVS_REQUIRES(ofproto_mutex)
3231 if (new_cookie != rule->flow_cookie) {
3232 cookies_remove(ofproto, rule);
3234 ovs_mutex_lock(&rule->mutex);
3235 rule->flow_cookie = new_cookie;
3236 ovs_mutex_unlock(&rule->mutex);
3238 cookies_insert(ofproto, rule);
3243 calc_duration(long long int start, long long int now,
3244 uint32_t *sec, uint32_t *nsec)
3246 long long int msecs = now - start;
3247 *sec = msecs / 1000;
3248 *nsec = (msecs % 1000) * (1000 * 1000);
3251 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3252 * true if 'table_id' is OK, false otherwise. */
3254 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3256 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3259 static struct oftable *
3260 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3262 struct oftable *table;
3264 for (table = &ofproto->tables[table_id];
3265 table < &ofproto->tables[ofproto->n_tables];
3267 if (!(table->flags & OFTABLE_HIDDEN)) {
3275 static struct oftable *
3276 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3278 if (table_id == 0xff) {
3279 return next_visible_table(ofproto, 0);
3280 } else if (table_id < ofproto->n_tables) {
3281 return &ofproto->tables[table_id];
3287 static struct oftable *
3288 next_matching_table(const struct ofproto *ofproto,
3289 const struct oftable *table, uint8_t table_id)
3291 return (table_id == 0xff
3292 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3296 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3298 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3299 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3301 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3302 * only once, for that table. (This can be used to access tables marked
3305 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3306 * entered at all. (Perhaps you should have validated TABLE_ID with
3307 * check_table_id().)
3309 * All parameters are evaluated multiple times.
3311 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3312 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3314 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3316 /* Initializes 'criteria' in a straightforward way based on the other
3319 * For "loose" matching, the 'priority' parameter is unimportant and may be
3322 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3323 const struct match *match, unsigned int priority,
3324 ovs_be64 cookie, ovs_be64 cookie_mask,
3325 ofp_port_t out_port, uint32_t out_group)
3327 criteria->table_id = table_id;
3328 cls_rule_init(&criteria->cr, match, priority);
3329 criteria->cookie = cookie;
3330 criteria->cookie_mask = cookie_mask;
3331 criteria->out_port = out_port;
3332 criteria->out_group = out_group;
3336 rule_criteria_destroy(struct rule_criteria *criteria)
3338 cls_rule_destroy(&criteria->cr);
3342 rule_collection_init(struct rule_collection *rules)
3344 rules->rules = rules->stub;
3346 rules->capacity = ARRAY_SIZE(rules->stub);
3350 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3352 if (rules->n >= rules->capacity) {
3353 size_t old_size, new_size;
3355 old_size = rules->capacity * sizeof *rules->rules;
3356 rules->capacity *= 2;
3357 new_size = rules->capacity * sizeof *rules->rules;
3359 if (rules->rules == rules->stub) {
3360 rules->rules = xmalloc(new_size);
3361 memcpy(rules->rules, rules->stub, old_size);
3363 rules->rules = xrealloc(rules->rules, new_size);
3367 rules->rules[rules->n++] = rule;
3371 rule_collection_ref(struct rule_collection *rules)
3372 OVS_REQUIRES(ofproto_mutex)
3376 for (i = 0; i < rules->n; i++) {
3377 ofproto_rule_ref(rules->rules[i]);
3382 rule_collection_unref(struct rule_collection *rules)
3386 for (i = 0; i < rules->n; i++) {
3387 ofproto_rule_unref(rules->rules[i]);
3392 rule_collection_destroy(struct rule_collection *rules)
3394 if (rules->rules != rules->stub) {
3400 collect_rule(struct rule *rule, const struct rule_criteria *c,
3401 struct rule_collection *rules)
3402 OVS_REQUIRES(ofproto_mutex)
3404 /* We ordinarily want to skip hidden rules, but there has to be a way for
3405 * code internal to OVS to modify and delete them, so if the criteria
3406 * specify a priority that can only be for a hidden flow, then allow hidden
3407 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3408 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3410 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3412 } else if (rule->pending) {
3413 return OFPROTO_POSTPONE;
3415 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3416 && ofproto_rule_has_out_port(rule, c->out_port)
3417 && ofproto_rule_has_out_group(rule, c->out_group)
3418 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3419 rule_collection_add(rules, rule);
3425 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3426 * on classifiers rules are done in the "loose" way required for OpenFlow
3427 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3430 * Hidden rules are always omitted.
3432 * Returns 0 on success, otherwise an OpenFlow error code. */
3434 collect_rules_loose(struct ofproto *ofproto,
3435 const struct rule_criteria *criteria,
3436 struct rule_collection *rules)
3437 OVS_REQUIRES(ofproto_mutex)
3439 struct oftable *table;
3440 enum ofperr error = 0;
3442 rule_collection_init(rules);
3444 if (!check_table_id(ofproto, criteria->table_id)) {
3445 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3449 if (criteria->cookie_mask == OVS_BE64_MAX) {
3452 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3453 hash_cookie(criteria->cookie),
3454 &ofproto->cookies) {
3455 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3456 error = collect_rule(rule, criteria, rules);
3463 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3464 struct cls_cursor cursor;
3467 fat_rwlock_rdlock(&table->cls.rwlock);
3468 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3469 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3470 error = collect_rule(rule, criteria, rules);
3475 fat_rwlock_unlock(&table->cls.rwlock);
3481 rule_collection_destroy(rules);
3486 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3487 * on classifiers rules are done in the "strict" way required for OpenFlow
3488 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3489 * rules on list 'rules'.
3491 * Hidden rules are always omitted.
3493 * Returns 0 on success, otherwise an OpenFlow error code. */
3495 collect_rules_strict(struct ofproto *ofproto,
3496 const struct rule_criteria *criteria,
3497 struct rule_collection *rules)
3498 OVS_REQUIRES(ofproto_mutex)
3500 struct oftable *table;
3503 rule_collection_init(rules);
3505 if (!check_table_id(ofproto, criteria->table_id)) {
3506 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3510 if (criteria->cookie_mask == OVS_BE64_MAX) {
3513 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3514 hash_cookie(criteria->cookie),
3515 &ofproto->cookies) {
3516 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3517 error = collect_rule(rule, criteria, rules);
3524 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3527 fat_rwlock_rdlock(&table->cls.rwlock);
3528 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3529 &table->cls, &criteria->cr));
3530 fat_rwlock_unlock(&table->cls.rwlock);
3532 error = collect_rule(rule, criteria, rules);
3542 rule_collection_destroy(rules);
3547 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3548 * forced into the range of a uint16_t. */
3550 age_secs(long long int age_ms)
3552 return (age_ms < 0 ? 0
3553 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3554 : (unsigned int) age_ms / 1000);
3558 handle_flow_stats_request(struct ofconn *ofconn,
3559 const struct ofp_header *request)
3560 OVS_EXCLUDED(ofproto_mutex)
3562 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3563 struct ofputil_flow_stats_request fsr;
3564 struct rule_criteria criteria;
3565 struct rule_collection rules;
3566 struct list replies;
3570 error = ofputil_decode_flow_stats_request(&fsr, request);
3575 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3576 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3578 ovs_mutex_lock(&ofproto_mutex);
3579 error = collect_rules_loose(ofproto, &criteria, &rules);
3580 rule_criteria_destroy(&criteria);
3582 rule_collection_ref(&rules);
3584 ovs_mutex_unlock(&ofproto_mutex);
3590 ofpmp_init(&replies, request);
3591 for (i = 0; i < rules.n; i++) {
3592 struct rule *rule = rules.rules[i];
3593 long long int now = time_msec();
3594 struct ofputil_flow_stats fs;
3595 long long int created, used, modified;
3596 const struct rule_actions *actions;
3597 enum ofputil_flow_mod_flags flags;
3599 ovs_mutex_lock(&rule->mutex);
3600 fs.cookie = rule->flow_cookie;
3601 fs.idle_timeout = rule->idle_timeout;
3602 fs.hard_timeout = rule->hard_timeout;
3603 created = rule->created;
3604 modified = rule->modified;
3605 actions = rule_get_actions(rule);
3606 flags = rule->flags;
3607 ovs_mutex_unlock(&rule->mutex);
3609 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3610 &fs.byte_count, &used);
3612 minimatch_expand(&rule->cr.match, &fs.match);
3613 fs.table_id = rule->table_id;
3614 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3615 fs.priority = rule->cr.priority;
3616 fs.idle_age = age_secs(now - used);
3617 fs.hard_age = age_secs(now - modified);
3618 fs.ofpacts = actions->ofpacts;
3619 fs.ofpacts_len = actions->ofpacts_len;
3622 ofputil_append_flow_stats_reply(&fs, &replies);
3625 rule_collection_unref(&rules);
3626 rule_collection_destroy(&rules);
3628 ofconn_send_replies(ofconn, &replies);
3634 flow_stats_ds(struct rule *rule, struct ds *results)
3636 uint64_t packet_count, byte_count;
3637 const struct rule_actions *actions;
3638 long long int created, used;
3640 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3641 &byte_count, &used);
3643 ovs_mutex_lock(&rule->mutex);
3644 actions = rule_get_actions(rule);
3645 created = rule->created;
3646 ovs_mutex_unlock(&rule->mutex);
3648 if (rule->table_id != 0) {
3649 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3651 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3652 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3653 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3654 cls_rule_format(&rule->cr, results);
3655 ds_put_char(results, ',');
3657 ds_put_cstr(results, "actions=");
3658 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3660 ds_put_cstr(results, "\n");
3663 /* Adds a pretty-printed description of all flows to 'results', including
3664 * hidden flows (e.g., set up by in-band control). */
3666 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3668 struct oftable *table;
3670 OFPROTO_FOR_EACH_TABLE (table, p) {
3671 struct cls_cursor cursor;
3674 fat_rwlock_rdlock(&table->cls.rwlock);
3675 cls_cursor_init(&cursor, &table->cls, NULL);
3676 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3677 flow_stats_ds(rule, results);
3679 fat_rwlock_unlock(&table->cls.rwlock);
3683 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3684 * '*engine_type' and '*engine_id', respectively. */
3686 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3687 uint8_t *engine_type, uint8_t *engine_id)
3689 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3692 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto' and stores
3693 * the port's CFM status in '*status'. If 'force' is set to true, status will
3694 * be returned even if there is no status change since last update.
3696 * Returns 0 on success. Returns a negative number if there is no status
3697 * change since last update and 'force' is set to false. Returns positive errno
3698 * if the port did not have CFM configured.
3700 * The caller must provide and own '*status', and must free 'status->rmps'.
3701 * '*status' is indeterminate if the return value is non-zero. */
3703 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3704 bool force, struct ofproto_cfm_status *status)
3706 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3707 return (ofport && ofproto->ofproto_class->get_cfm_status
3708 ? ofproto->ofproto_class->get_cfm_status(ofport, force, status)
3713 handle_aggregate_stats_request(struct ofconn *ofconn,
3714 const struct ofp_header *oh)
3715 OVS_EXCLUDED(ofproto_mutex)
3717 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3718 struct ofputil_flow_stats_request request;
3719 struct ofputil_aggregate_stats stats;
3720 bool unknown_packets, unknown_bytes;
3721 struct rule_criteria criteria;
3722 struct rule_collection rules;
3723 struct ofpbuf *reply;
3727 error = ofputil_decode_flow_stats_request(&request, oh);
3732 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3733 request.cookie, request.cookie_mask,
3734 request.out_port, request.out_group);
3736 ovs_mutex_lock(&ofproto_mutex);
3737 error = collect_rules_loose(ofproto, &criteria, &rules);
3738 rule_criteria_destroy(&criteria);
3740 rule_collection_ref(&rules);
3742 ovs_mutex_unlock(&ofproto_mutex);
3748 memset(&stats, 0, sizeof stats);
3749 unknown_packets = unknown_bytes = false;
3750 for (i = 0; i < rules.n; i++) {
3751 struct rule *rule = rules.rules[i];
3752 uint64_t packet_count;
3753 uint64_t byte_count;
3756 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3757 &byte_count, &used);
3759 if (packet_count == UINT64_MAX) {
3760 unknown_packets = true;
3762 stats.packet_count += packet_count;
3765 if (byte_count == UINT64_MAX) {
3766 unknown_bytes = true;
3768 stats.byte_count += byte_count;
3773 if (unknown_packets) {
3774 stats.packet_count = UINT64_MAX;
3776 if (unknown_bytes) {
3777 stats.byte_count = UINT64_MAX;
3780 rule_collection_unref(&rules);
3781 rule_collection_destroy(&rules);
3783 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3784 ofconn_send_reply(ofconn, reply);
3789 struct queue_stats_cbdata {
3790 struct ofport *ofport;
3791 struct list replies;
3796 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3797 const struct netdev_queue_stats *stats)
3799 struct ofputil_queue_stats oqs;
3801 oqs.port_no = cbdata->ofport->pp.port_no;
3802 oqs.queue_id = queue_id;
3803 oqs.tx_bytes = stats->tx_bytes;
3804 oqs.tx_packets = stats->tx_packets;
3805 oqs.tx_errors = stats->tx_errors;
3806 if (stats->created != LLONG_MIN) {
3807 calc_duration(stats->created, cbdata->now,
3808 &oqs.duration_sec, &oqs.duration_nsec);
3810 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3812 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3816 handle_queue_stats_dump_cb(uint32_t queue_id,
3817 struct netdev_queue_stats *stats,
3820 struct queue_stats_cbdata *cbdata = cbdata_;
3822 put_queue_stats(cbdata, queue_id, stats);
3826 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3827 struct queue_stats_cbdata *cbdata)
3829 cbdata->ofport = port;
3830 if (queue_id == OFPQ_ALL) {
3831 netdev_dump_queue_stats(port->netdev,
3832 handle_queue_stats_dump_cb, cbdata);
3834 struct netdev_queue_stats stats;
3836 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3837 put_queue_stats(cbdata, queue_id, &stats);
3839 return OFPERR_OFPQOFC_BAD_QUEUE;
3846 handle_queue_stats_request(struct ofconn *ofconn,
3847 const struct ofp_header *rq)
3849 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3850 struct queue_stats_cbdata cbdata;
3851 struct ofport *port;
3853 struct ofputil_queue_stats_request oqsr;
3855 COVERAGE_INC(ofproto_queue_req);
3857 ofpmp_init(&cbdata.replies, rq);
3858 cbdata.now = time_msec();
3860 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3865 if (oqsr.port_no == OFPP_ANY) {
3866 error = OFPERR_OFPQOFC_BAD_QUEUE;
3867 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3868 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3873 port = ofproto_get_port(ofproto, oqsr.port_no);
3875 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3876 : OFPERR_OFPQOFC_BAD_PORT);
3879 ofconn_send_replies(ofconn, &cbdata.replies);
3881 ofpbuf_list_delete(&cbdata.replies);
3888 is_flow_deletion_pending(const struct ofproto *ofproto,
3889 const struct cls_rule *cls_rule,
3891 OVS_REQUIRES(ofproto_mutex)
3893 if (!hmap_is_empty(&ofproto->deletions)) {
3894 struct ofoperation *op;
3896 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3897 cls_rule_hash(cls_rule, table_id),
3898 &ofproto->deletions) {
3899 if (op->rule->table_id == table_id
3900 && cls_rule_equal(cls_rule, &op->rule->cr)) {
3910 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3911 OVS_REQUIRES(ofproto_mutex)
3912 OVS_NO_THREAD_SAFETY_ANALYSIS
3914 return classifier_count(&table->cls) + extra_space > table->max_flows;
3918 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3919 unsigned int extra_space)
3920 OVS_REQUIRES(ofproto_mutex)
3922 while (should_evict_a_rule(table, extra_space)) {
3925 if (!choose_rule_to_evict(table, &rule)) {
3926 return OFPERR_OFPFMFC_TABLE_FULL;
3927 } else if (rule->pending) {
3928 return OFPROTO_POSTPONE;
3930 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3931 delete_flow__(rule, group, OFPRR_EVICTION);
3932 ofopgroup_submit(group);
3939 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3940 * in which no matching flow already exists in the flow table.
3942 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3943 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3944 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3945 * initiated now but may be retried later.
3947 * The caller retains ownership of 'fm->ofpacts'.
3949 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3952 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3953 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3954 OVS_REQUIRES(ofproto_mutex)
3956 struct oftable *table;
3962 if (!check_table_id(ofproto, fm->table_id)) {
3963 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3968 if (fm->table_id == 0xff) {
3969 if (ofproto->ofproto_class->rule_choose_table) {
3970 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3976 ovs_assert(table_id < ofproto->n_tables);
3980 } else if (fm->table_id < ofproto->n_tables) {
3981 table_id = fm->table_id;
3983 return OFPERR_OFPBRC_BAD_TABLE_ID;
3986 table = &ofproto->tables[table_id];
3988 if (!oftable_is_modifiable(table, fm->flags)) {
3989 return OFPERR_OFPBRC_EPERM;
3992 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
3993 if (!match_has_default_hidden_fields(&fm->match)) {
3994 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
3995 "non-default values to hidden fields", ofproto->name);
3996 return OFPERR_OFPBRC_EPERM;
4000 cls_rule_init(&cr, &fm->match, fm->priority);
4002 /* Transform "add" into "modify" if there's an existing identical flow. */
4003 fat_rwlock_rdlock(&table->cls.rwlock);
4004 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4005 fat_rwlock_unlock(&table->cls.rwlock);
4007 cls_rule_destroy(&cr);
4008 if (!rule_is_modifiable(rule, fm->flags)) {
4009 return OFPERR_OFPBRC_EPERM;
4010 } else if (rule->pending) {
4011 return OFPROTO_POSTPONE;
4013 struct rule_collection rules;
4015 rule_collection_init(&rules);
4016 rule_collection_add(&rules, rule);
4017 fm->modify_cookie = true;
4018 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4019 rule_collection_destroy(&rules);
4025 /* Serialize against pending deletion. */
4026 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
4027 cls_rule_destroy(&cr);
4028 return OFPROTO_POSTPONE;
4031 /* Check for overlap, if requested. */
4032 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4035 fat_rwlock_rdlock(&table->cls.rwlock);
4036 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4037 fat_rwlock_unlock(&table->cls.rwlock);
4040 cls_rule_destroy(&cr);
4041 return OFPERR_OFPFMFC_OVERLAP;
4045 /* If necessary, evict an existing rule to clear out space. */
4046 error = evict_rules_from_table(ofproto, table, 1);
4048 cls_rule_destroy(&cr);
4052 /* Allocate new rule. */
4053 rule = ofproto->ofproto_class->rule_alloc();
4055 cls_rule_destroy(&cr);
4056 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4057 ofproto->name, ovs_strerror(error));
4061 /* Initialize base state. */
4062 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4063 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4064 ovs_refcount_init(&rule->ref_count);
4065 rule->pending = NULL;
4066 rule->flow_cookie = fm->new_cookie;
4067 rule->created = rule->modified = time_msec();
4069 ovs_mutex_init(&rule->mutex);
4070 ovs_mutex_lock(&rule->mutex);
4071 rule->idle_timeout = fm->idle_timeout;
4072 rule->hard_timeout = fm->hard_timeout;
4073 ovs_mutex_unlock(&rule->mutex);
4075 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4076 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4077 ovsrcu_set(&rule->actions,
4078 rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len));
4079 list_init(&rule->meter_list_node);
4080 rule->eviction_group = NULL;
4081 list_init(&rule->expirable);
4082 rule->monitor_flags = 0;
4083 rule->add_seqno = 0;
4084 rule->modify_seqno = 0;
4086 /* Construct rule, initializing derived state. */
4087 error = ofproto->ofproto_class->rule_construct(rule);
4089 ofproto_rule_destroy__(rule);
4094 do_add_flow(ofproto, ofconn, request, fm->buffer_id, rule);
4100 do_add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
4101 const struct ofp_header *request, uint32_t buffer_id,
4103 OVS_REQUIRES(ofproto_mutex)
4105 struct ofopgroup *group;
4107 oftable_insert_rule(rule);
4109 group = ofopgroup_create(ofproto, ofconn, request, buffer_id);
4110 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4111 ofproto->ofproto_class->rule_insert(rule);
4112 ofopgroup_submit(group);
4115 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4117 /* Modifies the rules listed in 'rules', changing their actions to match those
4120 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4123 * Returns 0 on success, otherwise an OpenFlow error code. */
4125 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4126 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4127 const struct rule_collection *rules)
4128 OVS_REQUIRES(ofproto_mutex)
4130 enum ofoperation_type type;
4131 struct ofopgroup *group;
4135 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4136 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4137 error = OFPERR_OFPBRC_EPERM;
4138 for (i = 0; i < rules->n; i++) {
4139 struct rule *rule = rules->rules[i];
4140 const struct rule_actions *actions;
4141 struct ofoperation *op;
4142 bool actions_changed;
4143 bool reset_counters;
4145 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4147 if (rule_is_modifiable(rule, fm->flags)) {
4148 /* At least one rule is modifiable, don't report EPERM error. */
4154 actions = rule_get_actions(rule);
4155 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4157 actions->ofpacts_len);
4159 op = ofoperation_create(group, rule, type, 0);
4161 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4162 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4164 if (type == OFOPERATION_REPLACE) {
4165 ovs_mutex_lock(&rule->mutex);
4166 rule->idle_timeout = fm->idle_timeout;
4167 rule->hard_timeout = fm->hard_timeout;
4168 ovs_mutex_unlock(&rule->mutex);
4170 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4171 if (fm->idle_timeout || fm->hard_timeout) {
4172 if (!rule->eviction_group) {
4173 eviction_group_add_rule(rule);
4176 eviction_group_remove_rule(rule);
4180 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4181 if (actions_changed || reset_counters) {
4182 const struct rule_actions *new_actions;
4184 op->actions = rule_get_actions(rule);
4185 new_actions = rule_actions_create(ofproto,
4186 fm->ofpacts, fm->ofpacts_len);
4188 ovsrcu_set(&rule->actions, new_actions);
4190 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4193 ofoperation_complete(op, 0);
4196 ofopgroup_submit(group);
4202 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4203 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4204 OVS_REQUIRES(ofproto_mutex)
4206 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4209 return add_flow(ofproto, ofconn, fm, request);
4212 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4215 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4218 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4219 struct ofputil_flow_mod *fm,
4220 const struct ofp_header *request)
4221 OVS_REQUIRES(ofproto_mutex)
4223 struct rule_criteria criteria;
4224 struct rule_collection rules;
4227 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4228 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4229 error = collect_rules_loose(ofproto, &criteria, &rules);
4230 rule_criteria_destroy(&criteria);
4233 error = (rules.n > 0
4234 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4235 : modify_flows_add(ofproto, ofconn, fm, request));
4238 rule_collection_destroy(&rules);
4243 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4246 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4249 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4250 struct ofputil_flow_mod *fm,
4251 const struct ofp_header *request)
4252 OVS_REQUIRES(ofproto_mutex)
4254 struct rule_criteria criteria;
4255 struct rule_collection rules;
4258 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4259 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4260 error = collect_rules_strict(ofproto, &criteria, &rules);
4261 rule_criteria_destroy(&criteria);
4265 error = modify_flows_add(ofproto, ofconn, fm, request);
4266 } else if (rules.n == 1) {
4267 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4271 rule_collection_destroy(&rules);
4276 /* OFPFC_DELETE implementation. */
4279 delete_flow__(struct rule *rule, struct ofopgroup *group,
4280 enum ofp_flow_removed_reason reason)
4281 OVS_REQUIRES(ofproto_mutex)
4283 struct ofproto *ofproto = rule->ofproto;
4285 ofproto_rule_send_removed(rule, reason);
4287 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4288 oftable_remove_rule(rule);
4289 ofproto->ofproto_class->rule_delete(rule);
4292 /* Deletes the rules listed in 'rules'.
4294 * Returns 0 on success, otherwise an OpenFlow error code. */
4296 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4297 const struct ofp_header *request,
4298 const struct rule_collection *rules,
4299 enum ofp_flow_removed_reason reason)
4300 OVS_REQUIRES(ofproto_mutex)
4302 struct ofopgroup *group;
4305 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4306 for (i = 0; i < rules->n; i++) {
4307 delete_flow__(rules->rules[i], group, reason);
4309 ofopgroup_submit(group);
4314 /* Implements OFPFC_DELETE. */
4316 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4317 const struct ofputil_flow_mod *fm,
4318 const struct ofp_header *request)
4319 OVS_REQUIRES(ofproto_mutex)
4321 struct rule_criteria criteria;
4322 struct rule_collection rules;
4325 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4326 fm->cookie, fm->cookie_mask,
4327 fm->out_port, fm->out_group);
4328 error = collect_rules_loose(ofproto, &criteria, &rules);
4329 rule_criteria_destroy(&criteria);
4331 if (!error && rules.n > 0) {
4332 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4334 rule_collection_destroy(&rules);
4339 /* Implements OFPFC_DELETE_STRICT. */
4341 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4342 const struct ofputil_flow_mod *fm,
4343 const struct ofp_header *request)
4344 OVS_REQUIRES(ofproto_mutex)
4346 struct rule_criteria criteria;
4347 struct rule_collection rules;
4350 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4351 fm->cookie, fm->cookie_mask,
4352 fm->out_port, fm->out_group);
4353 error = collect_rules_strict(ofproto, &criteria, &rules);
4354 rule_criteria_destroy(&criteria);
4356 if (!error && rules.n > 0) {
4357 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4359 rule_collection_destroy(&rules);
4365 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4366 OVS_REQUIRES(ofproto_mutex)
4368 struct ofputil_flow_removed fr;
4371 if (ofproto_rule_is_hidden(rule) ||
4372 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4376 minimatch_expand(&rule->cr.match, &fr.match);
4377 fr.priority = rule->cr.priority;
4378 fr.cookie = rule->flow_cookie;
4380 fr.table_id = rule->table_id;
4381 calc_duration(rule->created, time_msec(),
4382 &fr.duration_sec, &fr.duration_nsec);
4383 ovs_mutex_lock(&rule->mutex);
4384 fr.idle_timeout = rule->idle_timeout;
4385 fr.hard_timeout = rule->hard_timeout;
4386 ovs_mutex_unlock(&rule->mutex);
4387 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4388 &fr.byte_count, &used);
4390 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4393 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4394 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4397 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4400 * ofproto implementation ->run() functions should use this function to expire
4401 * OpenFlow flows. */
4403 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4404 OVS_REQUIRES(ofproto_mutex)
4406 struct ofproto *ofproto = rule->ofproto;
4408 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4409 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4411 ofproto_rule_delete__(ofproto, rule, reason);
4414 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4415 * means "infinite". */
4417 reduce_timeout(uint16_t max, uint16_t *timeout)
4419 if (max && (!*timeout || *timeout > max)) {
4424 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4425 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4426 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4428 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4430 ofproto_rule_reduce_timeouts(struct rule *rule,
4431 uint16_t idle_timeout, uint16_t hard_timeout)
4432 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4434 if (!idle_timeout && !hard_timeout) {
4438 ovs_mutex_lock(&ofproto_mutex);
4439 if (list_is_empty(&rule->expirable)) {
4440 list_insert(&rule->ofproto->expirable, &rule->expirable);
4442 ovs_mutex_unlock(&ofproto_mutex);
4444 ovs_mutex_lock(&rule->mutex);
4445 reduce_timeout(idle_timeout, &rule->idle_timeout);
4446 reduce_timeout(hard_timeout, &rule->hard_timeout);
4447 ovs_mutex_unlock(&rule->mutex);
4451 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4452 OVS_EXCLUDED(ofproto_mutex)
4454 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4455 struct ofputil_flow_mod fm;
4456 uint64_t ofpacts_stub[1024 / 8];
4457 struct ofpbuf ofpacts;
4460 error = reject_slave_controller(ofconn);
4465 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4466 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4468 u16_to_ofp(ofproto->max_ports),
4471 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4474 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4477 goto exit_free_ofpacts;
4480 ofconn_report_flow_mod(ofconn, fm.command);
4483 ofpbuf_uninit(&ofpacts);
4489 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4490 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4491 OVS_EXCLUDED(ofproto_mutex)
4495 ovs_mutex_lock(&ofproto_mutex);
4496 if (ofproto->n_pending < 50) {
4497 switch (fm->command) {
4499 error = add_flow(ofproto, ofconn, fm, oh);
4503 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4506 case OFPFC_MODIFY_STRICT:
4507 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4511 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4514 case OFPFC_DELETE_STRICT:
4515 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4519 if (fm->command > 0xff) {
4520 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4521 "flow_mod_table_id extension is not enabled",
4524 error = OFPERR_OFPFMFC_BAD_COMMAND;
4528 ovs_assert(!list_is_empty(&ofproto->pending));
4529 error = OFPROTO_POSTPONE;
4531 ovs_mutex_unlock(&ofproto_mutex);
4533 run_rule_executes(ofproto);
4538 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4540 struct ofputil_role_request request;
4541 struct ofputil_role_request reply;
4545 error = ofputil_decode_role_message(oh, &request);
4550 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4551 if (ofconn_get_role(ofconn) != request.role
4552 && ofconn_has_pending_opgroups(ofconn)) {
4553 return OFPROTO_POSTPONE;
4556 if (request.have_generation_id
4557 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4558 return OFPERR_OFPRRFC_STALE;
4561 ofconn_set_role(ofconn, request.role);
4564 reply.role = ofconn_get_role(ofconn);
4565 reply.have_generation_id = ofconn_get_master_election_id(
4566 ofconn, &reply.generation_id);
4567 buf = ofputil_encode_role_reply(oh, &reply);
4568 ofconn_send_reply(ofconn, buf);
4574 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4575 const struct ofp_header *oh)
4577 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4578 enum ofputil_protocol cur, next;
4580 cur = ofconn_get_protocol(ofconn);
4581 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4582 ofconn_set_protocol(ofconn, next);
4588 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4590 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4591 enum ofputil_protocol cur, next;
4592 enum ofputil_protocol next_base;
4594 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4596 return OFPERR_OFPBRC_EPERM;
4599 cur = ofconn_get_protocol(ofconn);
4600 next = ofputil_protocol_set_base(cur, next_base);
4601 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4602 /* Avoid sending async messages in surprising protocol. */
4603 return OFPROTO_POSTPONE;
4606 ofconn_set_protocol(ofconn, next);
4611 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4612 const struct ofp_header *oh)
4614 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4617 format = ntohl(msg->format);
4618 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4619 return OFPERR_OFPBRC_EPERM;
4622 if (format != ofconn_get_packet_in_format(ofconn)
4623 && ofconn_has_pending_opgroups(ofconn)) {
4624 /* Avoid sending async message in surprsing packet in format. */
4625 return OFPROTO_POSTPONE;
4628 ofconn_set_packet_in_format(ofconn, format);
4633 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4635 const struct nx_async_config *msg = ofpmsg_body(oh);
4636 uint32_t master[OAM_N_TYPES];
4637 uint32_t slave[OAM_N_TYPES];
4639 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4640 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4641 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4643 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4644 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4645 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4647 ofconn_set_async_config(ofconn, master, slave);
4648 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4649 !ofconn_get_miss_send_len(ofconn)) {
4650 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4657 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4660 uint32_t master[OAM_N_TYPES];
4661 uint32_t slave[OAM_N_TYPES];
4662 struct nx_async_config *msg;
4664 ofconn_get_async_config(ofconn, master, slave);
4665 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4666 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4668 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4669 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4670 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4672 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4673 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4674 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4676 ofconn_send_reply(ofconn, buf);
4682 handle_nxt_set_controller_id(struct ofconn *ofconn,
4683 const struct ofp_header *oh)
4685 const struct nx_controller_id *nci = ofpmsg_body(oh);
4687 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4688 return OFPERR_NXBRC_MUST_BE_ZERO;
4691 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4696 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4700 if (ofconn_has_pending_opgroups(ofconn)) {
4701 return OFPROTO_POSTPONE;
4704 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4705 ? OFPRAW_OFPT10_BARRIER_REPLY
4706 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4707 ofconn_send_reply(ofconn, buf);
4712 ofproto_compose_flow_refresh_update(const struct rule *rule,
4713 enum nx_flow_monitor_flags flags,
4715 OVS_REQUIRES(ofproto_mutex)
4717 struct ofoperation *op = rule->pending;
4718 const struct rule_actions *actions;
4719 struct ofputil_flow_update fu;
4722 if (op && op->type == OFOPERATION_ADD) {
4723 /* We'll report the final flow when the operation completes. Reporting
4724 * it now would cause a duplicate report later. */
4728 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4729 ? NXFME_ADDED : NXFME_MODIFIED);
4731 ovs_mutex_lock(&rule->mutex);
4732 fu.idle_timeout = rule->idle_timeout;
4733 fu.hard_timeout = rule->hard_timeout;
4734 ovs_mutex_unlock(&rule->mutex);
4735 fu.table_id = rule->table_id;
4736 fu.cookie = rule->flow_cookie;
4737 minimatch_expand(&rule->cr.match, &match);
4739 fu.priority = rule->cr.priority;
4741 if (!(flags & NXFMF_ACTIONS)) {
4744 actions = rule_get_actions(rule);
4746 /* An operation is in progress. Use the previous version of the flow's
4747 * actions, so that when the operation commits we report the change. */
4749 case OFOPERATION_ADD:
4752 case OFOPERATION_MODIFY:
4753 case OFOPERATION_REPLACE:
4754 actions = op->actions ? op->actions : rule_get_actions(rule);
4757 case OFOPERATION_DELETE:
4758 actions = rule_get_actions(rule);
4765 fu.ofpacts = actions ? actions->ofpacts : NULL;
4766 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4768 if (list_is_empty(msgs)) {
4769 ofputil_start_flow_update(msgs);
4771 ofputil_append_flow_update(&fu, msgs);
4775 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4777 OVS_REQUIRES(ofproto_mutex)
4781 for (i = 0; i < rules->n; i++) {
4782 struct rule *rule = rules->rules[i];
4783 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4784 rule->monitor_flags = 0;
4786 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4791 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4792 struct rule *rule, uint64_t seqno,
4793 struct rule_collection *rules)
4794 OVS_REQUIRES(ofproto_mutex)
4796 enum nx_flow_monitor_flags update;
4798 if (ofproto_rule_is_hidden(rule)) {
4803 ? ofoperation_has_out_port(rule->pending, m->out_port)
4804 : ofproto_rule_has_out_port(rule, m->out_port))) {
4809 if (rule->add_seqno > seqno) {
4810 update = NXFMF_ADD | NXFMF_MODIFY;
4811 } else if (rule->modify_seqno > seqno) {
4812 update = NXFMF_MODIFY;
4817 if (!(m->flags & update)) {
4821 update = NXFMF_INITIAL;
4824 if (!rule->monitor_flags) {
4825 rule_collection_add(rules, rule);
4827 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4831 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4833 struct rule_collection *rules)
4834 OVS_REQUIRES(ofproto_mutex)
4836 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4837 const struct ofoperation *op;
4838 const struct oftable *table;
4839 struct cls_rule target;
4841 cls_rule_init_from_minimatch(&target, &m->match, 0);
4842 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4843 struct cls_cursor cursor;
4846 fat_rwlock_rdlock(&table->cls.rwlock);
4847 cls_cursor_init(&cursor, &table->cls, &target);
4848 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4849 ovs_assert(!rule->pending); /* XXX */
4850 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4852 fat_rwlock_unlock(&table->cls.rwlock);
4855 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4856 struct rule *rule = op->rule;
4858 if (((m->table_id == 0xff
4859 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4860 : m->table_id == rule->table_id))
4861 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4862 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4865 cls_rule_destroy(&target);
4869 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4870 struct rule_collection *rules)
4871 OVS_REQUIRES(ofproto_mutex)
4873 if (m->flags & NXFMF_INITIAL) {
4874 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4879 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4880 uint64_t seqno, struct rule_collection *rules)
4881 OVS_REQUIRES(ofproto_mutex)
4883 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4887 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4888 OVS_EXCLUDED(ofproto_mutex)
4890 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4891 struct ofmonitor **monitors;
4892 size_t n_monitors, allocated_monitors;
4893 struct rule_collection rules;
4894 struct list replies;
4900 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4902 n_monitors = allocated_monitors = 0;
4904 ovs_mutex_lock(&ofproto_mutex);
4906 struct ofputil_flow_monitor_request request;
4907 struct ofmonitor *m;
4910 retval = ofputil_decode_flow_monitor_request(&request, &b);
4911 if (retval == EOF) {
4913 } else if (retval) {
4918 if (request.table_id != 0xff
4919 && request.table_id >= ofproto->n_tables) {
4920 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4924 error = ofmonitor_create(&request, ofconn, &m);
4929 if (n_monitors >= allocated_monitors) {
4930 monitors = x2nrealloc(monitors, &allocated_monitors,
4933 monitors[n_monitors++] = m;
4936 rule_collection_init(&rules);
4937 for (i = 0; i < n_monitors; i++) {
4938 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4941 ofpmp_init(&replies, oh);
4942 ofmonitor_compose_refresh_updates(&rules, &replies);
4943 ovs_mutex_unlock(&ofproto_mutex);
4945 rule_collection_destroy(&rules);
4947 ofconn_send_replies(ofconn, &replies);
4953 for (i = 0; i < n_monitors; i++) {
4954 ofmonitor_destroy(monitors[i]);
4957 ovs_mutex_unlock(&ofproto_mutex);
4963 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4964 OVS_EXCLUDED(ofproto_mutex)
4966 struct ofmonitor *m;
4970 id = ofputil_decode_flow_monitor_cancel(oh);
4972 ovs_mutex_lock(&ofproto_mutex);
4973 m = ofmonitor_lookup(ofconn, id);
4975 ofmonitor_destroy(m);
4978 error = OFPERR_NXBRC_FM_BAD_ID;
4980 ovs_mutex_unlock(&ofproto_mutex);
4985 /* Meters implementation.
4987 * Meter table entry, indexed by the OpenFlow meter_id.
4988 * These are always dynamically allocated to allocate enough space for
4990 * 'created' is used to compute the duration for meter stats.
4991 * 'list rules' is needed so that we can delete the dependent rules when the
4992 * meter table entry is deleted.
4993 * 'provider_meter_id' is for the provider's private use.
4996 long long int created; /* Time created. */
4997 struct list rules; /* List of "struct rule_dpif"s. */
4998 ofproto_meter_id provider_meter_id;
4999 uint16_t flags; /* Meter flags. */
5000 uint16_t n_bands; /* Number of meter bands. */
5001 struct ofputil_meter_band *bands;
5005 * This is used in instruction validation at flow set-up time,
5006 * as flows may not use non-existing meters.
5007 * Return value of UINT32_MAX signifies an invalid meter.
5010 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5012 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5013 const struct meter *meter = ofproto->meters[of_meter_id];
5015 return meter->provider_meter_id.uint32;
5022 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5026 meter->flags = config->flags;
5027 meter->n_bands = config->n_bands;
5028 meter->bands = xmemdup(config->bands,
5029 config->n_bands * sizeof *meter->bands);
5032 static struct meter *
5033 meter_create(const struct ofputil_meter_config *config,
5034 ofproto_meter_id provider_meter_id)
5036 struct meter *meter;
5038 meter = xzalloc(sizeof *meter);
5039 meter->provider_meter_id = provider_meter_id;
5040 meter->created = time_msec();
5041 list_init(&meter->rules);
5043 meter_update(meter, config);
5049 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5050 OVS_REQUIRES(ofproto_mutex)
5053 for (mid = first; mid <= last; ++mid) {
5054 struct meter *meter = ofproto->meters[mid];
5056 ofproto->meters[mid] = NULL;
5057 ofproto->ofproto_class->meter_del(ofproto,
5058 meter->provider_meter_id);
5066 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5068 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5069 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5073 return OFPERR_OFPMMFC_METER_EXISTS;
5076 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5079 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5080 *meterp = meter_create(&mm->meter, provider_meter_id);
5086 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5088 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5090 uint32_t provider_meter_id;
5093 return OFPERR_OFPMMFC_UNKNOWN_METER;
5096 provider_meter_id = meter->provider_meter_id.uint32;
5097 error = ofproto->ofproto_class->meter_set(ofproto,
5098 &meter->provider_meter_id,
5100 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5102 meter_update(meter, &mm->meter);
5108 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5109 struct ofputil_meter_mod *mm)
5110 OVS_EXCLUDED(ofproto_mutex)
5112 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5113 uint32_t meter_id = mm->meter.meter_id;
5114 struct rule_collection rules;
5115 enum ofperr error = 0;
5116 uint32_t first, last;
5118 if (meter_id == OFPM13_ALL) {
5120 last = ofproto->meter_features.max_meters;
5122 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5125 first = last = meter_id;
5128 /* First delete the rules that use this meter. If any of those rules are
5129 * currently being modified, postpone the whole operation until later. */
5130 rule_collection_init(&rules);
5131 ovs_mutex_lock(&ofproto_mutex);
5132 for (meter_id = first; meter_id <= last; ++meter_id) {
5133 struct meter *meter = ofproto->meters[meter_id];
5134 if (meter && !list_is_empty(&meter->rules)) {
5137 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5138 if (rule->pending) {
5139 error = OFPROTO_POSTPONE;
5142 rule_collection_add(&rules, rule);
5147 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5150 /* Delete the meters. */
5151 meter_delete(ofproto, first, last);
5154 ovs_mutex_unlock(&ofproto_mutex);
5155 rule_collection_destroy(&rules);
5161 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5163 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5164 struct ofputil_meter_mod mm;
5165 uint64_t bands_stub[256 / 8];
5166 struct ofpbuf bands;
5170 error = reject_slave_controller(ofconn);
5175 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5177 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5179 goto exit_free_bands;
5182 meter_id = mm.meter.meter_id;
5184 if (mm.command != OFPMC13_DELETE) {
5185 /* Fails also when meters are not implemented by the provider. */
5186 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5187 error = OFPERR_OFPMMFC_INVALID_METER;
5188 goto exit_free_bands;
5189 } else if (meter_id > ofproto->meter_features.max_meters) {
5190 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5191 goto exit_free_bands;
5193 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5194 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5195 goto exit_free_bands;
5199 switch (mm.command) {
5201 error = handle_add_meter(ofproto, &mm);
5204 case OFPMC13_MODIFY:
5205 error = handle_modify_meter(ofproto, &mm);
5208 case OFPMC13_DELETE:
5209 error = handle_delete_meter(ofconn, oh, &mm);
5213 error = OFPERR_OFPMMFC_BAD_COMMAND;
5218 ofpbuf_uninit(&bands);
5223 handle_meter_features_request(struct ofconn *ofconn,
5224 const struct ofp_header *request)
5226 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5227 struct ofputil_meter_features features;
5230 if (ofproto->ofproto_class->meter_get_features) {
5231 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5233 memset(&features, 0, sizeof features);
5235 b = ofputil_encode_meter_features_reply(&features, request);
5237 ofconn_send_reply(ofconn, b);
5242 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5245 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5246 struct list replies;
5247 uint64_t bands_stub[256 / 8];
5248 struct ofpbuf bands;
5249 uint32_t meter_id, first, last;
5251 ofputil_decode_meter_request(request, &meter_id);
5253 if (meter_id == OFPM13_ALL) {
5255 last = ofproto->meter_features.max_meters;
5257 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5258 !ofproto->meters[meter_id]) {
5259 return OFPERR_OFPMMFC_UNKNOWN_METER;
5261 first = last = meter_id;
5264 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5265 ofpmp_init(&replies, request);
5267 for (meter_id = first; meter_id <= last; ++meter_id) {
5268 struct meter *meter = ofproto->meters[meter_id];
5270 continue; /* Skip non-existing meters. */
5272 if (type == OFPTYPE_METER_STATS_REQUEST) {
5273 struct ofputil_meter_stats stats;
5275 stats.meter_id = meter_id;
5277 /* Provider sets the packet and byte counts, we do the rest. */
5278 stats.flow_count = list_size(&meter->rules);
5279 calc_duration(meter->created, time_msec(),
5280 &stats.duration_sec, &stats.duration_nsec);
5281 stats.n_bands = meter->n_bands;
5282 ofpbuf_clear(&bands);
5284 = ofpbuf_put_uninit(&bands,
5285 meter->n_bands * sizeof *stats.bands);
5287 if (!ofproto->ofproto_class->meter_get(ofproto,
5288 meter->provider_meter_id,
5290 ofputil_append_meter_stats(&replies, &stats);
5292 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5293 struct ofputil_meter_config config;
5295 config.meter_id = meter_id;
5296 config.flags = meter->flags;
5297 config.n_bands = meter->n_bands;
5298 config.bands = meter->bands;
5299 ofputil_append_meter_config(&replies, &config);
5303 ofconn_send_replies(ofconn, &replies);
5304 ofpbuf_uninit(&bands);
5309 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5310 struct ofgroup **group)
5311 OVS_TRY_RDLOCK(true, (*group)->rwlock)
5313 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5314 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5315 hash_int(group_id, 0), &ofproto->groups) {
5316 if ((*group)->group_id == group_id) {
5317 ovs_rwlock_rdlock(&(*group)->rwlock);
5318 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5322 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5327 ofproto_group_release(struct ofgroup *group)
5328 OVS_RELEASES(group->rwlock)
5330 ovs_rwlock_unlock(&group->rwlock);
5334 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
5335 struct ofgroup **group)
5336 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
5337 OVS_TRY_WRLOCK(true, (*group)->rwlock)
5339 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5340 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5341 hash_int(group_id, 0), &ofproto->groups) {
5342 if ((*group)->group_id == group_id) {
5343 ovs_rwlock_wrlock(&(*group)->rwlock);
5347 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5352 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5353 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5355 struct ofgroup *grp;
5357 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5358 hash_int(group_id, 0), &ofproto->groups) {
5359 if (grp->group_id == group_id) {
5367 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5368 OVS_EXCLUDED(ofproto->groups_rwlock)
5372 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5373 exists = ofproto_group_exists__(ofproto, group_id);
5374 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5380 group_get_ref_count(struct ofgroup *group)
5381 OVS_EXCLUDED(ofproto_mutex)
5383 struct ofproto *ofproto = group->ofproto;
5384 struct rule_criteria criteria;
5385 struct rule_collection rules;
5390 match_init_catchall(&match);
5391 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5392 OFPP_ANY, group->group_id);
5393 ovs_mutex_lock(&ofproto_mutex);
5394 error = collect_rules_loose(ofproto, &criteria, &rules);
5395 ovs_mutex_unlock(&ofproto_mutex);
5396 rule_criteria_destroy(&criteria);
5398 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5400 rule_collection_destroy(&rules);
5405 append_group_stats(struct ofgroup *group, struct list *replies)
5406 OVS_REQ_RDLOCK(group->rwlock)
5408 struct ofputil_group_stats ogs;
5409 struct ofproto *ofproto = group->ofproto;
5410 long long int now = time_msec();
5413 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5415 /* Provider sets the packet and byte counts, we do the rest. */
5416 ogs.ref_count = group_get_ref_count(group);
5417 ogs.n_buckets = group->n_buckets;
5419 error = (ofproto->ofproto_class->group_get_stats
5420 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5423 ogs.packet_count = UINT64_MAX;
5424 ogs.byte_count = UINT64_MAX;
5425 memset(ogs.bucket_stats, 0xff,
5426 ogs.n_buckets * sizeof *ogs.bucket_stats);
5429 ogs.group_id = group->group_id;
5430 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5432 ofputil_append_group_stats(replies, &ogs);
5434 free(ogs.bucket_stats);
5438 handle_group_request(struct ofconn *ofconn,
5439 const struct ofp_header *request, uint32_t group_id,
5440 void (*cb)(struct ofgroup *, struct list *replies))
5442 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5443 struct ofgroup *group;
5444 struct list replies;
5446 ofpmp_init(&replies, request);
5447 if (group_id == OFPG_ALL) {
5448 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5449 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5450 ovs_rwlock_rdlock(&group->rwlock);
5451 cb(group, &replies);
5452 ovs_rwlock_unlock(&group->rwlock);
5454 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5456 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5457 cb(group, &replies);
5458 ofproto_group_release(group);
5461 ofconn_send_replies(ofconn, &replies);
5465 handle_group_stats_request(struct ofconn *ofconn,
5466 const struct ofp_header *request)
5471 error = ofputil_decode_group_stats_request(request, &group_id);
5476 handle_group_request(ofconn, request, group_id, append_group_stats);
5481 append_group_desc(struct ofgroup *group, struct list *replies)
5483 struct ofputil_group_desc gds;
5485 gds.group_id = group->group_id;
5486 gds.type = group->type;
5487 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5491 handle_group_desc_stats_request(struct ofconn *ofconn,
5492 const struct ofp_header *request)
5494 handle_group_request(ofconn, request,
5495 ofputil_decode_group_desc_request(request),
5501 handle_group_features_stats_request(struct ofconn *ofconn,
5502 const struct ofp_header *request)
5504 struct ofproto *p = ofconn_get_ofproto(ofconn);
5507 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5509 ofconn_send_reply(ofconn, msg);
5516 handle_queue_get_config_request(struct ofconn *ofconn,
5517 const struct ofp_header *oh)
5519 struct ofproto *p = ofconn_get_ofproto(ofconn);
5520 struct netdev_queue_dump queue_dump;
5521 struct ofport *ofport;
5522 unsigned int queue_id;
5523 struct ofpbuf *reply;
5524 struct smap details;
5528 error = ofputil_decode_queue_get_config_request(oh, &request);
5533 ofport = ofproto_get_port(p, request);
5535 return OFPERR_OFPQOFC_BAD_PORT;
5538 reply = ofputil_encode_queue_get_config_reply(oh);
5540 smap_init(&details);
5541 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5542 struct ofputil_queue_config queue;
5544 /* None of the existing queues have compatible properties, so we
5545 * hard-code omitting min_rate and max_rate. */
5546 queue.queue_id = queue_id;
5547 queue.min_rate = UINT16_MAX;
5548 queue.max_rate = UINT16_MAX;
5549 ofputil_append_queue_get_config_reply(reply, &queue);
5551 smap_destroy(&details);
5553 ofconn_send_reply(ofconn, reply);
5558 /* Implements OFPGC11_ADD
5559 * in which no matching flow already exists in the flow table.
5561 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5562 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5563 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5564 * initiated now but may be retried later.
5566 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5567 * ownership remains with the caller.
5569 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5572 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5574 struct ofgroup *ofgroup;
5577 if (gm->group_id > OFPG_MAX) {
5578 return OFPERR_OFPGMFC_INVALID_GROUP;
5580 if (gm->type > OFPGT11_FF) {
5581 return OFPERR_OFPGMFC_BAD_TYPE;
5584 /* Allocate new group and initialize it. */
5585 ofgroup = ofproto->ofproto_class->group_alloc();
5587 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
5588 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5591 ovs_rwlock_init(&ofgroup->rwlock);
5592 ofgroup->ofproto = ofproto;
5593 ofgroup->group_id = gm->group_id;
5594 ofgroup->type = gm->type;
5595 ofgroup->created = ofgroup->modified = time_msec();
5597 list_move(&ofgroup->buckets, &gm->buckets);
5598 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5600 /* Construct called BEFORE any locks are held. */
5601 error = ofproto->ofproto_class->group_construct(ofgroup);
5606 /* We wrlock as late as possible to minimize the time we jam any other
5607 * threads: No visible state changes before acquiring the lock. */
5608 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5610 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5611 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5615 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5616 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5621 /* Insert new group. */
5622 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5623 hash_int(ofgroup->group_id, 0));
5624 ofproto->n_groups[ofgroup->type]++;
5626 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5631 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5632 ofproto->ofproto_class->group_destruct(ofgroup);
5634 ofputil_bucket_list_destroy(&ofgroup->buckets);
5635 ofproto->ofproto_class->group_dealloc(ofgroup);
5640 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5643 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5646 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5648 struct ofgroup *ofgroup;
5649 struct ofgroup *victim;
5652 if (gm->group_id > OFPG_MAX) {
5653 return OFPERR_OFPGMFC_INVALID_GROUP;
5656 if (gm->type > OFPGT11_FF) {
5657 return OFPERR_OFPGMFC_BAD_TYPE;
5660 victim = ofproto->ofproto_class->group_alloc();
5662 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5663 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5666 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5667 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5670 /* Both group's and its container's write locks held now.
5671 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5672 if (ofgroup->type != gm->type
5673 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5674 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5679 list_move(&victim->buckets, &ofgroup->buckets);
5681 ofgroup->type = gm->type;
5682 list_move(&ofgroup->buckets, &gm->buckets);
5683 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5685 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5687 ofputil_bucket_list_destroy(&victim->buckets);
5688 ofproto->n_groups[victim->type]--;
5689 ofproto->n_groups[ofgroup->type]++;
5690 ofgroup->modified = time_msec();
5692 ofputil_bucket_list_destroy(&ofgroup->buckets);
5695 list_move(&ofgroup->buckets, &victim->buckets);
5699 ovs_rwlock_unlock(&ofgroup->rwlock);
5700 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5702 ofproto->ofproto_class->group_dealloc(victim);
5707 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5708 OVS_RELEASES(ofproto->groups_rwlock)
5711 struct ofputil_flow_mod fm;
5713 /* Delete all flow entries containing this group in a group action */
5714 match_init_catchall(&match);
5715 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5716 fm.out_group = ofgroup->group_id;
5717 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5719 /* Must wait until existing readers are done,
5720 * while holding the container's write lock at the same time. */
5721 ovs_rwlock_wrlock(&ofgroup->rwlock);
5722 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5723 /* No-one can find this group any more. */
5724 ofproto->n_groups[ofgroup->type]--;
5725 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5727 ofproto->ofproto_class->group_destruct(ofgroup);
5728 ofputil_bucket_list_destroy(&ofgroup->buckets);
5729 ovs_rwlock_unlock(&ofgroup->rwlock);
5730 ovs_rwlock_destroy(&ofgroup->rwlock);
5731 ofproto->ofproto_class->group_dealloc(ofgroup);
5734 /* Implements OFPGC_DELETE. */
5736 delete_group(struct ofproto *ofproto, uint32_t group_id)
5738 struct ofgroup *ofgroup;
5740 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5741 if (group_id == OFPG_ALL) {
5743 struct hmap_node *node = hmap_first(&ofproto->groups);
5747 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5748 delete_group__(ofproto, ofgroup);
5749 /* Lock for each node separately, so that we will not jam the
5750 * other threads for too long time. */
5751 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5754 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5755 hash_int(group_id, 0), &ofproto->groups) {
5756 if (ofgroup->group_id == group_id) {
5757 delete_group__(ofproto, ofgroup);
5762 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5766 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5768 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5769 struct ofputil_group_mod gm;
5772 error = reject_slave_controller(ofconn);
5777 error = ofputil_decode_group_mod(oh, &gm);
5782 switch (gm.command) {
5784 return add_group(ofproto, &gm);
5786 case OFPGC11_MODIFY:
5787 return modify_group(ofproto, &gm);
5789 case OFPGC11_DELETE:
5790 delete_group(ofproto, gm.group_id);
5794 if (gm.command > OFPGC11_DELETE) {
5795 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5796 ofproto->name, gm.command);
5798 return OFPERR_OFPGMFC_BAD_COMMAND;
5802 enum ofproto_table_config
5803 ofproto_table_get_config(const struct ofproto *ofproto, uint8_t table_id)
5806 atomic_read(&ofproto->tables[table_id].config, &value);
5807 return (enum ofproto_table_config)value;
5811 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5813 /* Only accept currently supported configurations */
5814 if (tm->config & ~OFPTC11_TABLE_MISS_MASK) {
5815 return OFPERR_OFPTMFC_BAD_CONFIG;
5818 if (tm->table_id == OFPTT_ALL) {
5820 for (i = 0; i < ofproto->n_tables; i++) {
5821 atomic_store(&ofproto->tables[i].config,
5822 (unsigned int)tm->config);
5824 } else if (!check_table_id(ofproto, tm->table_id)) {
5825 return OFPERR_OFPTMFC_BAD_TABLE;
5827 atomic_store(&ofproto->tables[tm->table_id].config,
5828 (unsigned int)tm->config);
5835 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5837 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5838 struct ofputil_table_mod tm;
5841 error = reject_slave_controller(ofconn);
5846 error = ofputil_decode_table_mod(oh, &tm);
5851 return table_mod(ofproto, &tm);
5855 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
5858 struct ofputil_bundle_ctrl_msg bctrl;
5860 struct ofputil_bundle_ctrl_msg reply;
5862 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
5867 reply.bundle_id = bctrl.bundle_id;
5869 switch (bctrl.type) {
5870 case OFPBCT_OPEN_REQUEST:
5871 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
5872 reply.type = OFPBCT_OPEN_REPLY;
5874 case OFPBCT_CLOSE_REQUEST:
5875 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
5876 reply.type = OFPBCT_CLOSE_REPLY;;
5878 case OFPBCT_COMMIT_REQUEST:
5879 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
5880 reply.type = OFPBCT_COMMIT_REPLY;
5882 case OFPBCT_DISCARD_REQUEST:
5883 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
5884 reply.type = OFPBCT_DISCARD_REPLY;
5887 case OFPBCT_OPEN_REPLY:
5888 case OFPBCT_CLOSE_REPLY:
5889 case OFPBCT_COMMIT_REPLY:
5890 case OFPBCT_DISCARD_REPLY:
5891 return OFPERR_OFPBFC_BAD_TYPE;
5896 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
5897 ofconn_send_reply(ofconn, buf);
5904 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
5907 struct ofputil_bundle_add_msg badd;
5909 error = ofputil_decode_bundle_add(oh, &badd);
5914 return ofp_bundle_add_message(ofconn, &badd);
5918 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5919 OVS_EXCLUDED(ofproto_mutex)
5921 const struct ofp_header *oh = ofpbuf_data(msg);
5925 error = ofptype_decode(&type, oh);
5929 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5930 && ofpmp_more(oh)) {
5931 /* We have no buffer implementation for multipart requests.
5932 * Report overflow for requests which consists of multiple
5934 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5938 /* OpenFlow requests. */
5939 case OFPTYPE_ECHO_REQUEST:
5940 return handle_echo_request(ofconn, oh);
5942 case OFPTYPE_FEATURES_REQUEST:
5943 return handle_features_request(ofconn, oh);
5945 case OFPTYPE_GET_CONFIG_REQUEST:
5946 return handle_get_config_request(ofconn, oh);
5948 case OFPTYPE_SET_CONFIG:
5949 return handle_set_config(ofconn, oh);
5951 case OFPTYPE_PACKET_OUT:
5952 return handle_packet_out(ofconn, oh);
5954 case OFPTYPE_PORT_MOD:
5955 return handle_port_mod(ofconn, oh);
5957 case OFPTYPE_FLOW_MOD:
5958 return handle_flow_mod(ofconn, oh);
5960 case OFPTYPE_GROUP_MOD:
5961 return handle_group_mod(ofconn, oh);
5963 case OFPTYPE_TABLE_MOD:
5964 return handle_table_mod(ofconn, oh);
5966 case OFPTYPE_METER_MOD:
5967 return handle_meter_mod(ofconn, oh);
5969 case OFPTYPE_BARRIER_REQUEST:
5970 return handle_barrier_request(ofconn, oh);
5972 case OFPTYPE_ROLE_REQUEST:
5973 return handle_role_request(ofconn, oh);
5975 /* OpenFlow replies. */
5976 case OFPTYPE_ECHO_REPLY:
5979 /* Nicira extension requests. */
5980 case OFPTYPE_FLOW_MOD_TABLE_ID:
5981 return handle_nxt_flow_mod_table_id(ofconn, oh);
5983 case OFPTYPE_SET_FLOW_FORMAT:
5984 return handle_nxt_set_flow_format(ofconn, oh);
5986 case OFPTYPE_SET_PACKET_IN_FORMAT:
5987 return handle_nxt_set_packet_in_format(ofconn, oh);
5989 case OFPTYPE_SET_CONTROLLER_ID:
5990 return handle_nxt_set_controller_id(ofconn, oh);
5992 case OFPTYPE_FLOW_AGE:
5993 /* Nothing to do. */
5996 case OFPTYPE_FLOW_MONITOR_CANCEL:
5997 return handle_flow_monitor_cancel(ofconn, oh);
5999 case OFPTYPE_SET_ASYNC_CONFIG:
6000 return handle_nxt_set_async_config(ofconn, oh);
6002 case OFPTYPE_GET_ASYNC_REQUEST:
6003 return handle_nxt_get_async_request(ofconn, oh);
6005 /* Statistics requests. */
6006 case OFPTYPE_DESC_STATS_REQUEST:
6007 return handle_desc_stats_request(ofconn, oh);
6009 case OFPTYPE_FLOW_STATS_REQUEST:
6010 return handle_flow_stats_request(ofconn, oh);
6012 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6013 return handle_aggregate_stats_request(ofconn, oh);
6015 case OFPTYPE_TABLE_STATS_REQUEST:
6016 return handle_table_stats_request(ofconn, oh);
6018 case OFPTYPE_PORT_STATS_REQUEST:
6019 return handle_port_stats_request(ofconn, oh);
6021 case OFPTYPE_QUEUE_STATS_REQUEST:
6022 return handle_queue_stats_request(ofconn, oh);
6024 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6025 return handle_port_desc_stats_request(ofconn, oh);
6027 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6028 return handle_flow_monitor_request(ofconn, oh);
6030 case OFPTYPE_METER_STATS_REQUEST:
6031 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6032 return handle_meter_request(ofconn, oh, type);
6034 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6035 return handle_meter_features_request(ofconn, oh);
6037 case OFPTYPE_GROUP_STATS_REQUEST:
6038 return handle_group_stats_request(ofconn, oh);
6040 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6041 return handle_group_desc_stats_request(ofconn, oh);
6043 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6044 return handle_group_features_stats_request(ofconn, oh);
6046 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6047 return handle_queue_get_config_request(ofconn, oh);
6049 case OFPTYPE_BUNDLE_CONTROL:
6050 return handle_bundle_control(ofconn, oh);
6052 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6053 return handle_bundle_add(ofconn, oh);
6057 case OFPTYPE_FEATURES_REPLY:
6058 case OFPTYPE_GET_CONFIG_REPLY:
6059 case OFPTYPE_PACKET_IN:
6060 case OFPTYPE_FLOW_REMOVED:
6061 case OFPTYPE_PORT_STATUS:
6062 case OFPTYPE_BARRIER_REPLY:
6063 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6064 case OFPTYPE_DESC_STATS_REPLY:
6065 case OFPTYPE_FLOW_STATS_REPLY:
6066 case OFPTYPE_QUEUE_STATS_REPLY:
6067 case OFPTYPE_PORT_STATS_REPLY:
6068 case OFPTYPE_TABLE_STATS_REPLY:
6069 case OFPTYPE_AGGREGATE_STATS_REPLY:
6070 case OFPTYPE_PORT_DESC_STATS_REPLY:
6071 case OFPTYPE_ROLE_REPLY:
6072 case OFPTYPE_FLOW_MONITOR_PAUSED:
6073 case OFPTYPE_FLOW_MONITOR_RESUMED:
6074 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6075 case OFPTYPE_GET_ASYNC_REPLY:
6076 case OFPTYPE_GROUP_STATS_REPLY:
6077 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6078 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6079 case OFPTYPE_METER_STATS_REPLY:
6080 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6081 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6082 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6083 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6084 case OFPTYPE_ROLE_STATUS:
6086 if (ofpmsg_is_stat_request(oh)) {
6087 return OFPERR_OFPBRC_BAD_STAT;
6089 return OFPERR_OFPBRC_BAD_TYPE;
6095 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6096 OVS_EXCLUDED(ofproto_mutex)
6098 int error = handle_openflow__(ofconn, ofp_msg);
6099 if (error && error != OFPROTO_POSTPONE) {
6100 ofconn_send_error(ofconn, ofpbuf_data(ofp_msg), error);
6102 COVERAGE_INC(ofproto_recv_openflow);
6103 return error != OFPROTO_POSTPONE;
6106 /* Asynchronous operations. */
6108 /* Creates and returns a new ofopgroup that is not associated with any
6109 * OpenFlow connection.
6111 * The caller should add operations to the returned group with
6112 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6113 static struct ofopgroup *
6114 ofopgroup_create_unattached(struct ofproto *ofproto)
6115 OVS_REQUIRES(ofproto_mutex)
6117 struct ofopgroup *group = xzalloc(sizeof *group);
6118 group->ofproto = ofproto;
6119 list_init(&group->ofproto_node);
6120 list_init(&group->ops);
6121 list_init(&group->ofconn_node);
6125 /* Creates and returns a new ofopgroup for 'ofproto'.
6127 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6128 * connection. The 'request' and 'buffer_id' arguments are ignored.
6130 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6131 * If the ofopgroup eventually fails, then the error reply will include
6132 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6133 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6135 * The caller should add operations to the returned group with
6136 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6137 static struct ofopgroup *
6138 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6139 const struct ofp_header *request, uint32_t buffer_id)
6140 OVS_REQUIRES(ofproto_mutex)
6142 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6144 size_t request_len = ntohs(request->length);
6146 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6148 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6149 group->ofconn = ofconn;
6150 group->request = xmemdup(request, MIN(request_len, 64));
6151 group->buffer_id = buffer_id;
6156 /* Submits 'group' for processing.
6158 * If 'group' contains no operations (e.g. none were ever added, or all of the
6159 * ones that were added completed synchronously), then it is destroyed
6160 * immediately. Otherwise it is added to the ofproto's list of pending
6163 ofopgroup_submit(struct ofopgroup *group)
6164 OVS_REQUIRES(ofproto_mutex)
6166 if (!group->n_running) {
6167 ofopgroup_complete(group);
6169 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6170 group->ofproto->n_pending++;
6175 ofopgroup_complete(struct ofopgroup *group)
6176 OVS_REQUIRES(ofproto_mutex)
6178 struct ofproto *ofproto = group->ofproto;
6180 struct ofconn *abbrev_ofconn;
6181 ovs_be32 abbrev_xid;
6183 struct ofoperation *op, *next_op;
6186 ovs_assert(!group->n_running);
6189 LIST_FOR_EACH (op, group_node, &group->ops) {
6196 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6197 LIST_FOR_EACH (op, group_node, &group->ops) {
6198 if (op->type != OFOPERATION_DELETE) {
6199 struct ofpbuf *packet;
6202 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6205 struct rule_execute *re;
6209 ofproto_rule_ref(op->rule);
6211 re = xmalloc(sizeof *re);
6212 re->rule = op->rule;
6213 re->in_port = in_port;
6214 re->packet = packet;
6216 if (!guarded_list_push_back(&ofproto->rule_executes,
6217 &re->list_node, 1024)) {
6218 ofproto_rule_unref(op->rule);
6219 ofpbuf_delete(re->packet);
6228 if (!error && !list_is_empty(&group->ofconn_node)) {
6229 abbrev_ofconn = group->ofconn;
6230 abbrev_xid = group->request->xid;
6232 abbrev_ofconn = NULL;
6233 abbrev_xid = htonl(0);
6235 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6236 struct rule *rule = op->rule;
6238 /* We generally want to report the change to active OpenFlow flow
6239 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6241 - The operation failed.
6243 - The affected rule is not visible to controllers.
6245 - The operation's only effect was to update rule->modified. */
6247 || ofproto_rule_is_hidden(rule)
6248 || (op->type == OFOPERATION_MODIFY
6250 && rule->flow_cookie == op->flow_cookie))) {
6251 /* Check that we can just cast from ofoperation_type to
6252 * nx_flow_update_event. */
6253 enum nx_flow_update_event event_type;
6256 case OFOPERATION_ADD:
6257 case OFOPERATION_REPLACE:
6258 event_type = NXFME_ADDED;
6261 case OFOPERATION_DELETE:
6262 event_type = NXFME_DELETED;
6265 case OFOPERATION_MODIFY:
6266 event_type = NXFME_MODIFIED;
6273 ofmonitor_report(ofproto->connmgr, rule, event_type,
6274 op->reason, abbrev_ofconn, abbrev_xid);
6277 rule->pending = NULL;
6280 case OFOPERATION_ADD:
6284 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6285 if (vid_mask == VLAN_VID_MASK) {
6286 if (ofproto->vlan_bitmap) {
6287 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6288 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6289 bitmap_set1(ofproto->vlan_bitmap, vid);
6290 ofproto->vlans_changed = true;
6293 ofproto->vlans_changed = true;
6297 oftable_remove_rule(rule);
6298 ofproto_rule_unref(rule);
6302 case OFOPERATION_DELETE:
6303 ovs_assert(!op->error);
6304 ofproto_rule_unref(rule);
6308 case OFOPERATION_MODIFY:
6309 case OFOPERATION_REPLACE:
6311 long long int now = time_msec();
6313 ovs_mutex_lock(&rule->mutex);
6314 rule->modified = now;
6315 if (op->type == OFOPERATION_REPLACE) {
6316 rule->created = now;
6318 ovs_mutex_unlock(&rule->mutex);
6320 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6321 ovs_mutex_lock(&rule->mutex);
6322 rule->idle_timeout = op->idle_timeout;
6323 rule->hard_timeout = op->hard_timeout;
6324 ovs_mutex_unlock(&rule->mutex);
6326 const struct rule_actions *old_actions;
6328 ovs_mutex_lock(&rule->mutex);
6329 old_actions = rule_get_actions(rule);
6330 ovsrcu_set(&rule->actions, op->actions);
6331 ovs_mutex_unlock(&rule->mutex);
6334 rule_actions_destroy(old_actions);
6336 rule->flags = op->flags;
6344 ofoperation_destroy(op);
6347 ofmonitor_flush(ofproto->connmgr);
6349 if (!list_is_empty(&group->ofproto_node)) {
6350 ovs_assert(ofproto->n_pending > 0);
6351 ofproto->n_pending--;
6352 list_remove(&group->ofproto_node);
6354 if (!list_is_empty(&group->ofconn_node)) {
6355 list_remove(&group->ofconn_node);
6357 ofconn_send_error(group->ofconn, group->request, error);
6359 connmgr_retry(ofproto->connmgr);
6361 free(group->request);
6365 /* Initiates a new operation on 'rule', of the specified 'type', within
6366 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6368 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6369 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6371 * Returns the newly created ofoperation (which is also available as
6372 * rule->pending). */
6373 static struct ofoperation *
6374 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6375 enum ofoperation_type type,
6376 enum ofp_flow_removed_reason reason)
6377 OVS_REQUIRES(ofproto_mutex)
6379 struct ofproto *ofproto = group->ofproto;
6380 struct ofoperation *op;
6382 ovs_assert(!rule->pending);
6384 op = rule->pending = xzalloc(sizeof *op);
6386 list_push_back(&group->ops, &op->group_node);
6389 op->reason = reason;
6390 op->flow_cookie = rule->flow_cookie;
6391 ovs_mutex_lock(&rule->mutex);
6392 op->idle_timeout = rule->idle_timeout;
6393 op->hard_timeout = rule->hard_timeout;
6394 ovs_mutex_unlock(&rule->mutex);
6395 op->flags = rule->flags;
6399 if (type == OFOPERATION_DELETE) {
6400 hmap_insert(&ofproto->deletions, &op->hmap_node,
6401 cls_rule_hash(&rule->cr, rule->table_id));
6408 ofoperation_destroy(struct ofoperation *op)
6409 OVS_REQUIRES(ofproto_mutex)
6411 struct ofopgroup *group = op->group;
6414 op->rule->pending = NULL;
6416 if (op->type == OFOPERATION_DELETE) {
6417 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6419 list_remove(&op->group_node);
6420 rule_actions_destroy(op->actions);
6424 /* Indicates that 'op' completed with status 'error', which is either 0 to
6425 * indicate success or an OpenFlow error code on failure.
6427 * If 'error' is 0, indicating success, the operation will be committed
6428 * permanently to the flow table.
6430 * If 'error' is nonzero, then generally the operation will be rolled back:
6432 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6433 * restores the original rule. The caller must have uninitialized any
6434 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6435 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6436 * and 7 for the new rule, calling its ->rule_dealloc() function.
6438 * - If 'op' is a "modify flow" operation, ofproto restores the original
6441 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6442 * allowed to fail. It must always succeed.
6444 * Please see the large comment in ofproto/ofproto-provider.h titled
6445 * "Asynchronous Operation Support" for more information. */
6447 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6449 struct ofopgroup *group = op->group;
6451 ovs_assert(group->n_running > 0);
6452 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6455 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6456 /* This function can be called from ->rule_construct(), in which case
6457 * ofproto_mutex is held, or it can be called from ->run(), in which
6458 * case ofproto_mutex is not held. But only in the latter case can we
6459 * arrive here, so we can safely take ofproto_mutex now. */
6460 ovs_mutex_lock(&ofproto_mutex);
6461 ovs_assert(op->rule->pending == op);
6462 ofopgroup_complete(group);
6463 ovs_mutex_unlock(&ofproto_mutex);
6468 pick_datapath_id(const struct ofproto *ofproto)
6470 const struct ofport *port;
6472 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6474 uint8_t ea[ETH_ADDR_LEN];
6477 error = netdev_get_etheraddr(port->netdev, ea);
6479 return eth_addr_to_uint64(ea);
6481 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6482 ofproto->name, netdev_get_name(port->netdev),
6483 ovs_strerror(error));
6485 return ofproto->fallback_dpid;
6489 pick_fallback_dpid(void)
6491 uint8_t ea[ETH_ADDR_LEN];
6492 eth_addr_nicira_random(ea);
6493 return eth_addr_to_uint64(ea);
6496 /* Table overflow policy. */
6498 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6499 * to NULL if the table is not configured to evict rules or if the table
6500 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6501 * or with no timeouts are not evictable.) */
6503 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6504 OVS_REQUIRES(ofproto_mutex)
6506 struct eviction_group *evg;
6509 if (!table->eviction_fields) {
6513 /* In the common case, the outer and inner loops here will each be entered
6516 * - The inner loop normally "return"s in its first iteration. If the
6517 * eviction group has any evictable rules, then it always returns in
6520 * - The outer loop only iterates more than once if the largest eviction
6521 * group has no evictable rules.
6523 * - The outer loop can exit only if table's 'max_flows' is all filled up
6524 * by unevictable rules. */
6525 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6528 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6537 /* Searches 'ofproto' for tables that have more flows than their configured
6538 * maximum and that have flow eviction enabled, and evicts as many flows as
6539 * necessary and currently feasible from them.
6541 * This triggers only when an OpenFlow table has N flows in it and then the
6542 * client configures a maximum number of flows less than N. */
6544 ofproto_evict(struct ofproto *ofproto)
6546 struct oftable *table;
6548 ovs_mutex_lock(&ofproto_mutex);
6549 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6550 evict_rules_from_table(ofproto, table, 0);
6552 ovs_mutex_unlock(&ofproto_mutex);
6555 /* Eviction groups. */
6557 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6558 * rules. The priority contains low-order random bits to ensure that eviction
6559 * groups with the same number of rules are prioritized randomly. */
6561 eviction_group_priority(size_t n_rules)
6563 uint16_t size = MIN(UINT16_MAX, n_rules);
6564 return (size << 16) | random_uint16();
6567 /* Updates 'evg', an eviction_group within 'table', following a change that
6568 * adds or removes rules in 'evg'. */
6570 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6571 OVS_REQUIRES(ofproto_mutex)
6573 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6574 eviction_group_priority(heap_count(&evg->rules)));
6577 /* Destroys 'evg', an eviction_group within 'table':
6579 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6580 * rules themselves, just removes them from the eviction group.)
6582 * - Removes 'evg' from 'table'.
6586 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6587 OVS_REQUIRES(ofproto_mutex)
6589 while (!heap_is_empty(&evg->rules)) {
6592 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6593 rule->eviction_group = NULL;
6595 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6596 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6597 heap_destroy(&evg->rules);
6601 /* Removes 'rule' from its eviction group, if any. */
6603 eviction_group_remove_rule(struct rule *rule)
6604 OVS_REQUIRES(ofproto_mutex)
6606 if (rule->eviction_group) {
6607 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6608 struct eviction_group *evg = rule->eviction_group;
6610 rule->eviction_group = NULL;
6611 heap_remove(&evg->rules, &rule->evg_node);
6612 if (heap_is_empty(&evg->rules)) {
6613 eviction_group_destroy(table, evg);
6615 eviction_group_resized(table, evg);
6620 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6621 * returns the hash value. */
6623 eviction_group_hash_rule(struct rule *rule)
6624 OVS_REQUIRES(ofproto_mutex)
6626 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6627 const struct mf_subfield *sf;
6631 hash = table->eviction_group_id_basis;
6632 miniflow_expand(&rule->cr.match.flow, &flow);
6633 for (sf = table->eviction_fields;
6634 sf < &table->eviction_fields[table->n_eviction_fields];
6637 if (mf_are_prereqs_ok(sf->field, &flow)) {
6638 union mf_value value;
6640 mf_get_value(sf->field, &flow, &value);
6642 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6644 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6645 unsigned int start = sf->ofs + sf->n_bits;
6646 bitwise_zero(&value, sf->field->n_bytes, start,
6647 sf->field->n_bytes * 8 - start);
6649 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6651 hash = hash_int(hash, 0);
6658 /* Returns an eviction group within 'table' with the given 'id', creating one
6660 static struct eviction_group *
6661 eviction_group_find(struct oftable *table, uint32_t id)
6662 OVS_REQUIRES(ofproto_mutex)
6664 struct eviction_group *evg;
6666 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6670 evg = xmalloc(sizeof *evg);
6671 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6672 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6673 eviction_group_priority(0));
6674 heap_init(&evg->rules);
6679 /* Returns an eviction priority for 'rule'. The return value should be
6680 * interpreted so that higher priorities make a rule more attractive candidates
6682 * Called only if have a timeout. */
6684 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6685 OVS_REQUIRES(ofproto_mutex)
6687 long long int expiration = LLONG_MAX;
6688 long long int modified;
6689 uint32_t expiration_offset;
6691 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6692 ovs_mutex_lock(&rule->mutex);
6693 modified = rule->modified;
6694 ovs_mutex_unlock(&rule->mutex);
6696 if (rule->hard_timeout) {
6697 expiration = modified + rule->hard_timeout * 1000;
6699 if (rule->idle_timeout) {
6700 uint64_t packets, bytes;
6702 long long int idle_expiration;
6704 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6705 idle_expiration = used + rule->idle_timeout * 1000;
6706 expiration = MIN(expiration, idle_expiration);
6709 if (expiration == LLONG_MAX) {
6713 /* Calculate the time of expiration as a number of (approximate) seconds
6714 * after program startup.
6716 * This should work OK for program runs that last UINT32_MAX seconds or
6717 * less. Therefore, please restart OVS at least once every 136 years. */
6718 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6720 /* Invert the expiration offset because we're using a max-heap. */
6721 return UINT32_MAX - expiration_offset;
6724 /* Adds 'rule' to an appropriate eviction group for its oftable's
6725 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6726 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6729 * The caller must ensure that 'rule' is not already in an eviction group. */
6731 eviction_group_add_rule(struct rule *rule)
6732 OVS_REQUIRES(ofproto_mutex)
6734 struct ofproto *ofproto = rule->ofproto;
6735 struct oftable *table = &ofproto->tables[rule->table_id];
6738 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6739 * so no additional protection is needed. */
6740 has_timeout = rule->hard_timeout || rule->idle_timeout;
6742 if (table->eviction_fields && has_timeout) {
6743 struct eviction_group *evg;
6745 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6747 rule->eviction_group = evg;
6748 heap_insert(&evg->rules, &rule->evg_node,
6749 rule_eviction_priority(ofproto, rule));
6750 eviction_group_resized(table, evg);
6756 /* Initializes 'table'. */
6758 oftable_init(struct oftable *table)
6760 memset(table, 0, sizeof *table);
6761 classifier_init(&table->cls, flow_segment_u32s);
6762 table->max_flows = UINT_MAX;
6763 atomic_init(&table->config, (unsigned int)OFPROTO_TABLE_MISS_DEFAULT);
6766 /* Destroys 'table', including its classifier and eviction groups.
6768 * The caller is responsible for freeing 'table' itself. */
6770 oftable_destroy(struct oftable *table)
6772 fat_rwlock_rdlock(&table->cls.rwlock);
6773 ovs_assert(classifier_is_empty(&table->cls));
6774 fat_rwlock_unlock(&table->cls.rwlock);
6775 oftable_disable_eviction(table);
6776 classifier_destroy(&table->cls);
6780 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6781 * string, then 'table' will use its default name.
6783 * This only affects the name exposed for a table exposed through the OpenFlow
6784 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6786 oftable_set_name(struct oftable *table, const char *name)
6788 if (name && name[0]) {
6789 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6790 if (!table->name || strncmp(name, table->name, len)) {
6792 table->name = xmemdup0(name, len);
6800 /* oftables support a choice of two policies when adding a rule would cause the
6801 * number of flows in the table to exceed the configured maximum number: either
6802 * they can refuse to add the new flow or they can evict some existing flow.
6803 * This function configures the former policy on 'table'. */
6805 oftable_disable_eviction(struct oftable *table)
6806 OVS_REQUIRES(ofproto_mutex)
6808 if (table->eviction_fields) {
6809 struct eviction_group *evg, *next;
6811 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6812 &table->eviction_groups_by_id) {
6813 eviction_group_destroy(table, evg);
6815 hmap_destroy(&table->eviction_groups_by_id);
6816 heap_destroy(&table->eviction_groups_by_size);
6818 free(table->eviction_fields);
6819 table->eviction_fields = NULL;
6820 table->n_eviction_fields = 0;
6824 /* oftables support a choice of two policies when adding a rule would cause the
6825 * number of flows in the table to exceed the configured maximum number: either
6826 * they can refuse to add the new flow or they can evict some existing flow.
6827 * This function configures the latter policy on 'table', with fairness based
6828 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6829 * 'n_fields' as 0 disables fairness.) */
6831 oftable_enable_eviction(struct oftable *table,
6832 const struct mf_subfield *fields, size_t n_fields)
6833 OVS_REQUIRES(ofproto_mutex)
6835 struct cls_cursor cursor;
6838 if (table->eviction_fields
6839 && n_fields == table->n_eviction_fields
6841 || !memcmp(fields, table->eviction_fields,
6842 n_fields * sizeof *fields))) {
6847 oftable_disable_eviction(table);
6849 table->n_eviction_fields = n_fields;
6850 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6852 table->eviction_group_id_basis = random_uint32();
6853 hmap_init(&table->eviction_groups_by_id);
6854 heap_init(&table->eviction_groups_by_size);
6856 fat_rwlock_rdlock(&table->cls.rwlock);
6857 cls_cursor_init(&cursor, &table->cls, NULL);
6858 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6859 eviction_group_add_rule(rule);
6861 fat_rwlock_unlock(&table->cls.rwlock);
6864 /* Removes 'rule' from the oftable that contains it. */
6866 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6867 OVS_REQUIRES(ofproto_mutex)
6869 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6871 fat_rwlock_wrlock(&cls->rwlock);
6872 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6873 fat_rwlock_unlock(&cls->rwlock);
6875 cookies_remove(ofproto, rule);
6877 eviction_group_remove_rule(rule);
6878 if (!list_is_empty(&rule->expirable)) {
6879 list_remove(&rule->expirable);
6881 if (!list_is_empty(&rule->meter_list_node)) {
6882 list_remove(&rule->meter_list_node);
6883 list_init(&rule->meter_list_node);
6888 oftable_remove_rule(struct rule *rule)
6889 OVS_REQUIRES(ofproto_mutex)
6891 oftable_remove_rule__(rule->ofproto, rule);
6894 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6895 * the same cls_rule. */
6897 oftable_insert_rule(struct rule *rule)
6898 OVS_REQUIRES(ofproto_mutex)
6900 struct ofproto *ofproto = rule->ofproto;
6901 struct oftable *table = &ofproto->tables[rule->table_id];
6902 const struct rule_actions *actions;
6905 ovs_mutex_lock(&rule->mutex);
6906 may_expire = rule->hard_timeout || rule->idle_timeout;
6907 ovs_mutex_unlock(&rule->mutex);
6910 list_insert(&ofproto->expirable, &rule->expirable);
6913 cookies_insert(ofproto, rule);
6915 actions = rule_get_actions(rule);
6916 if (actions->provider_meter_id != UINT32_MAX) {
6917 uint32_t meter_id = ofpacts_get_meter(actions->ofpacts,
6918 actions->ofpacts_len);
6919 struct meter *meter = ofproto->meters[meter_id];
6920 list_insert(&meter->rules, &rule->meter_list_node);
6922 fat_rwlock_wrlock(&table->cls.rwlock);
6923 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6924 fat_rwlock_unlock(&table->cls.rwlock);
6925 eviction_group_add_rule(rule);
6928 /* unixctl commands. */
6931 ofproto_lookup(const char *name)
6933 struct ofproto *ofproto;
6935 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6937 if (!strcmp(ofproto->name, name)) {
6945 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6946 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6948 struct ofproto *ofproto;
6952 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6953 ds_put_format(&results, "%s\n", ofproto->name);
6955 unixctl_command_reply(conn, ds_cstr(&results));
6956 ds_destroy(&results);
6960 ofproto_unixctl_init(void)
6962 static bool registered;
6968 unixctl_command_register("ofproto/list", "", 0, 0,
6969 ofproto_unixctl_list, NULL);
6972 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6974 * This is deprecated. It is only for compatibility with broken device drivers
6975 * in old versions of Linux that do not properly support VLANs when VLAN
6976 * devices are not used. When broken device drivers are no longer in
6977 * widespread use, we will delete these interfaces. */
6979 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6980 * (exactly) by an OpenFlow rule in 'ofproto'. */
6982 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6985 struct cls_rule target;
6986 const struct oftable *oftable;
6988 match_init_catchall(&match);
6989 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
6990 cls_rule_init(&target, &match, 0);
6992 free(ofproto->vlan_bitmap);
6993 ofproto->vlan_bitmap = bitmap_allocate(4096);
6994 ofproto->vlans_changed = false;
6996 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6997 struct cls_cursor cursor;
7000 fat_rwlock_rdlock(&oftable->cls.rwlock);
7001 cls_cursor_init(&cursor, &oftable->cls, &target);
7002 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
7003 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7004 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7006 bitmap_set1(vlan_bitmap, vid);
7007 bitmap_set1(ofproto->vlan_bitmap, vid);
7010 fat_rwlock_unlock(&oftable->cls.rwlock);
7014 /* Returns true if new VLANs have come into use by the flow table since the
7015 * last call to ofproto_get_vlan_usage().
7017 * We don't track when old VLANs stop being used. */
7019 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7021 return ofproto->vlans_changed;
7024 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7025 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7026 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7027 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7028 * then the VLAN device is un-enslaved. */
7030 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7031 ofp_port_t realdev_ofp_port, int vid)
7033 struct ofport *ofport;
7036 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7038 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7040 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7041 ofproto->name, vlandev_ofp_port);
7045 if (!ofproto->ofproto_class->set_realdev) {
7046 if (!vlandev_ofp_port) {
7049 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7053 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7055 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7056 ofproto->name, vlandev_ofp_port,
7057 netdev_get_name(ofport->netdev), ovs_strerror(error));