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 if (classifier_count(&table->cls) > 100000) {
1482 static struct vlog_rate_limit count_rl =
1483 VLOG_RATE_LIMIT_INIT(1, 1);
1484 VLOG_WARN_RL(&count_rl, "Table %"PRIuSIZE" has an excessive"
1485 " number of rules: %d", i,
1486 classifier_count(&table->cls));
1489 ovs_mutex_lock(&ofproto_mutex);
1490 fat_rwlock_rdlock(&table->cls.rwlock);
1491 cls_cursor_init(&cursor, &table->cls, NULL);
1492 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1493 if (rule->idle_timeout || rule->hard_timeout) {
1494 if (!rule->eviction_group) {
1495 eviction_group_add_rule(rule);
1497 heap_raw_change(&rule->evg_node,
1498 rule_eviction_priority(p, rule));
1502 fat_rwlock_unlock(&table->cls.rwlock);
1504 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1505 heap_rebuild(&evg->rules);
1507 ovs_mutex_unlock(&ofproto_mutex);
1511 if (p->ofproto_class->port_poll) {
1514 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1515 process_port_change(p, error, devname);
1519 new_seq = seq_read(connectivity_seq_get());
1520 if (new_seq != p->change_seq) {
1521 struct sset devnames;
1522 const char *devname;
1523 struct ofport *ofport;
1525 /* Update OpenFlow port status for any port whose netdev has changed.
1527 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1528 * destroyed, so it's not safe to update ports directly from the
1529 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1530 * need this two-phase approach. */
1531 sset_init(&devnames);
1532 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1533 uint64_t port_change_seq;
1535 port_change_seq = netdev_get_change_seq(ofport->netdev);
1536 if (ofport->change_seq != port_change_seq) {
1537 ofport->change_seq = port_change_seq;
1538 sset_add(&devnames, netdev_get_name(ofport->netdev));
1541 SSET_FOR_EACH (devname, &devnames) {
1542 update_port(p, devname);
1544 sset_destroy(&devnames);
1546 p->change_seq = new_seq;
1551 connmgr_run(p->connmgr, handle_openflow);
1555 connmgr_run(p->connmgr, NULL);
1557 if (!any_pending_ops(p)) {
1558 p->state = S_OPENFLOW;
1563 connmgr_run(p->connmgr, NULL);
1565 if (!any_pending_ops(p)) {
1566 connmgr_flushed(p->connmgr);
1567 p->state = S_OPENFLOW;
1579 ofproto_wait(struct ofproto *p)
1581 p->ofproto_class->wait(p);
1582 if (p->ofproto_class->port_poll_wait) {
1583 p->ofproto_class->port_poll_wait(p);
1585 seq_wait(connectivity_seq_get(), p->change_seq);
1589 connmgr_wait(p->connmgr, true);
1594 connmgr_wait(p->connmgr, false);
1595 if (!any_pending_ops(p)) {
1596 poll_immediate_wake();
1603 ofproto_is_alive(const struct ofproto *p)
1605 return connmgr_has_controllers(p->connmgr);
1608 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1609 * memory_report(). */
1611 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1613 const struct oftable *table;
1614 unsigned int n_rules;
1616 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1618 ovs_mutex_lock(&ofproto_mutex);
1619 simap_increase(usage, "ops",
1620 ofproto->n_pending + hmap_count(&ofproto->deletions));
1621 ovs_mutex_unlock(&ofproto_mutex);
1624 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1625 fat_rwlock_rdlock(&table->cls.rwlock);
1626 n_rules += classifier_count(&table->cls);
1627 fat_rwlock_unlock(&table->cls.rwlock);
1629 simap_increase(usage, "rules", n_rules);
1631 if (ofproto->ofproto_class->get_memory_usage) {
1632 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1635 connmgr_get_memory_usage(ofproto->connmgr, usage);
1639 ofproto_type_get_memory_usage(const char *datapath_type, struct simap *usage)
1641 const struct ofproto_class *class;
1643 datapath_type = ofproto_normalize_type(datapath_type);
1644 class = ofproto_class_find__(datapath_type);
1646 if (class && class->type_get_memory_usage) {
1647 class->type_get_memory_usage(datapath_type, usage);
1652 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1655 connmgr_get_controller_info(ofproto->connmgr, info);
1659 ofproto_free_ofproto_controller_info(struct shash *info)
1661 connmgr_free_controller_info(info);
1664 /* Makes a deep copy of 'old' into 'port'. */
1666 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1668 port->name = xstrdup(old->name);
1669 port->type = xstrdup(old->type);
1670 port->ofp_port = old->ofp_port;
1673 /* Frees memory allocated to members of 'ofproto_port'.
1675 * Do not call this function on an ofproto_port obtained from
1676 * ofproto_port_dump_next(): that function retains ownership of the data in the
1679 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1681 free(ofproto_port->name);
1682 free(ofproto_port->type);
1685 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1687 * This function provides no status indication. An error status for the entire
1688 * dump operation is provided when it is completed by calling
1689 * ofproto_port_dump_done().
1692 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1693 const struct ofproto *ofproto)
1695 dump->ofproto = ofproto;
1696 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1700 /* Attempts to retrieve another port from 'dump', which must have been created
1701 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1702 * 'port' and returns true. On failure, returns false.
1704 * Failure might indicate an actual error or merely that the last port has been
1705 * dumped. An error status for the entire dump operation is provided when it
1706 * is completed by calling ofproto_port_dump_done().
1708 * The ofproto owns the data stored in 'port'. It will remain valid until at
1709 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1710 * ofproto_port_dump_done(). */
1712 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1713 struct ofproto_port *port)
1715 const struct ofproto *ofproto = dump->ofproto;
1721 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1724 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1730 /* Completes port table dump operation 'dump', which must have been created
1731 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1732 * error-free, otherwise a positive errno value describing the problem. */
1734 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1736 const struct ofproto *ofproto = dump->ofproto;
1738 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1741 return dump->error == EOF ? 0 : dump->error;
1744 /* Returns the type to pass to netdev_open() when a datapath of type
1745 * 'datapath_type' has a port of type 'port_type', for a few special
1746 * cases when a netdev type differs from a port type. For example, when
1747 * using the userspace datapath, a port of type "internal" needs to be
1750 * Returns either 'type' itself or a string literal, which must not be
1753 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1755 const struct ofproto_class *class;
1757 datapath_type = ofproto_normalize_type(datapath_type);
1758 class = ofproto_class_find__(datapath_type);
1763 return (class->port_open_type
1764 ? class->port_open_type(datapath_type, port_type)
1768 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1769 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1770 * the port's OpenFlow port number.
1772 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1773 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1774 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1775 * 'ofp_portp' is non-null). */
1777 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1778 ofp_port_t *ofp_portp)
1780 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1783 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1785 const char *netdev_name = netdev_get_name(netdev);
1787 simap_put(&ofproto->ofp_requests, netdev_name,
1788 ofp_to_u16(ofp_port));
1789 update_port(ofproto, netdev_name);
1792 *ofp_portp = OFPP_NONE;
1794 struct ofproto_port ofproto_port;
1796 error = ofproto_port_query_by_name(ofproto,
1797 netdev_get_name(netdev),
1800 *ofp_portp = ofproto_port.ofp_port;
1801 ofproto_port_destroy(&ofproto_port);
1808 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1809 * initializes '*port' appropriately; on failure, returns a positive errno
1812 * The caller owns the data in 'ofproto_port' and must free it with
1813 * ofproto_port_destroy() when it is no longer needed. */
1815 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1816 struct ofproto_port *port)
1820 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1822 memset(port, 0, sizeof *port);
1827 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1828 * Returns 0 if successful, otherwise a positive errno. */
1830 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1832 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1833 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1834 struct simap_node *ofp_request_node;
1837 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1838 if (ofp_request_node) {
1839 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1842 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1843 if (!error && ofport) {
1844 /* 'name' is the netdev's name and update_port() is going to close the
1845 * netdev. Just in case update_port() refers to 'name' after it
1846 * destroys 'ofport', make a copy of it around the update_port()
1848 char *devname = xstrdup(name);
1849 update_port(ofproto, devname);
1856 flow_mod_init(struct ofputil_flow_mod *fm,
1857 const struct match *match, unsigned int priority,
1858 const struct ofpact *ofpacts, size_t ofpacts_len,
1859 enum ofp_flow_mod_command command)
1861 memset(fm, 0, sizeof *fm);
1863 fm->priority = priority;
1866 fm->modify_cookie = false;
1868 fm->command = command;
1869 fm->idle_timeout = 0;
1870 fm->hard_timeout = 0;
1871 fm->buffer_id = UINT32_MAX;
1872 fm->out_port = OFPP_ANY;
1873 fm->out_group = OFPG_ANY;
1875 fm->ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1876 fm->ofpacts_len = ofpacts_len;
1880 simple_flow_mod(struct ofproto *ofproto,
1881 const struct match *match, unsigned int priority,
1882 const struct ofpact *ofpacts, size_t ofpacts_len,
1883 enum ofp_flow_mod_command command)
1885 struct ofputil_flow_mod fm;
1887 flow_mod_init(&fm, match, priority, ofpacts, ofpacts_len, command);
1889 return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1892 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1893 * performs the 'n_actions' actions in 'actions'. The new flow will not
1896 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1897 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1898 * controllers; otherwise, it will be hidden.
1900 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1902 * This is a helper function for in-band control and fail-open. */
1904 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1905 unsigned int priority,
1906 const struct ofpact *ofpacts, size_t ofpacts_len)
1907 OVS_EXCLUDED(ofproto_mutex)
1909 const struct rule *rule;
1912 /* First do a cheap check whether the rule we're looking for already exists
1913 * with the actions that we want. If it does, then we're done. */
1914 fat_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1915 rule = rule_from_cls_rule(classifier_find_match_exactly(
1916 &ofproto->tables[0].cls, match, priority));
1918 const struct rule_actions *actions = rule_get_actions(rule);
1919 must_add = !ofpacts_equal(actions->ofpacts, actions->ofpacts_len,
1920 ofpacts, ofpacts_len);
1924 fat_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1926 /* If there's no such rule or the rule doesn't have the actions we want,
1927 * fall back to a executing a full flow mod. We can't optimize this at
1928 * all because we didn't take enough locks above to ensure that the flow
1929 * table didn't already change beneath us. */
1931 simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1932 OFPFC_MODIFY_STRICT);
1936 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1937 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1938 * operation cannot be initiated now but may be retried later.
1940 * This is a helper function for in-band control and fail-open and the "learn"
1943 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1944 OVS_EXCLUDED(ofproto_mutex)
1946 /* Optimize for the most common case of a repeated learn action.
1947 * If an identical flow already exists we only need to update its
1948 * 'modified' time. */
1949 if (fm->command == OFPFC_MODIFY_STRICT && fm->table_id != OFPTT_ALL
1950 && !(fm->flags & OFPUTIL_FF_RESET_COUNTS)) {
1951 struct oftable *table = &ofproto->tables[fm->table_id];
1955 fat_rwlock_rdlock(&table->cls.rwlock);
1956 rule = rule_from_cls_rule(classifier_find_match_exactly(&table->cls,
1960 /* Reading many of the rule fields and writing on 'modified'
1961 * requires the rule->mutex. Also, rule->actions may change
1962 * if rule->mutex is not held. */
1963 const struct rule_actions *actions;
1965 ovs_mutex_lock(&rule->mutex);
1966 actions = rule_get_actions(rule);
1967 if (rule->idle_timeout == fm->idle_timeout
1968 && rule->hard_timeout == fm->hard_timeout
1969 && rule->flags == (fm->flags & OFPUTIL_FF_STATE)
1970 && (!fm->modify_cookie || (fm->new_cookie == rule->flow_cookie))
1971 && ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
1972 actions->ofpacts, actions->ofpacts_len)) {
1973 /* Rule already exists and need not change, only update the
1974 modified timestamp. */
1975 rule->modified = time_msec();
1978 ovs_mutex_unlock(&rule->mutex);
1980 fat_rwlock_unlock(&table->cls.rwlock);
1987 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1990 /* Searches for a rule with matching criteria exactly equal to 'target' in
1991 * ofproto's table 0 and, if it finds one, deletes it.
1993 * This is a helper function for in-band control and fail-open. */
1995 ofproto_delete_flow(struct ofproto *ofproto,
1996 const struct match *target, unsigned int priority)
1997 OVS_EXCLUDED(ofproto_mutex)
1999 struct classifier *cls = &ofproto->tables[0].cls;
2002 /* First do a cheap check whether the rule we're looking for has already
2003 * been deleted. If so, then we're done. */
2004 fat_rwlock_rdlock(&cls->rwlock);
2005 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
2007 fat_rwlock_unlock(&cls->rwlock);
2012 /* Fall back to a executing a full flow mod. We can't optimize this at all
2013 * because we didn't take enough locks above to ensure that the flow table
2014 * didn't already change beneath us. */
2015 return simple_flow_mod(ofproto, target, priority, NULL, 0,
2016 OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
2019 /* Starts the process of deleting all of the flows from all of ofproto's flow
2020 * tables and then reintroducing the flows required by in-band control and
2021 * fail-open. The process will complete in a later call to ofproto_run(). */
2023 ofproto_flush_flows(struct ofproto *ofproto)
2025 COVERAGE_INC(ofproto_flush);
2026 ofproto->state = S_FLUSH;
2030 reinit_ports(struct ofproto *p)
2032 struct ofproto_port_dump dump;
2033 struct sset devnames;
2034 struct ofport *ofport;
2035 struct ofproto_port ofproto_port;
2036 const char *devname;
2038 COVERAGE_INC(ofproto_reinit_ports);
2040 sset_init(&devnames);
2041 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2042 sset_add(&devnames, netdev_get_name(ofport->netdev));
2044 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2045 sset_add(&devnames, ofproto_port.name);
2048 SSET_FOR_EACH (devname, &devnames) {
2049 update_port(p, devname);
2051 sset_destroy(&devnames);
2055 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
2059 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
2060 port_idx = port_idx ? port_idx : UINT16_MAX;
2062 if (port_idx >= ofproto->max_ports
2063 || ofport_get_usage(ofproto, u16_to_ofp(port_idx)) == LLONG_MAX) {
2064 uint16_t lru_ofport = 0, end_port_no = ofproto->alloc_port_no;
2065 long long int last_used_at, lru = LLONG_MAX;
2067 /* Search for a free OpenFlow port number. We try not to
2068 * immediately reuse them to prevent problems due to old
2071 * We limit the automatically assigned port numbers to the lower half
2072 * of the port range, to reserve the upper half for assignment by
2075 if (++ofproto->alloc_port_no >= MIN(ofproto->max_ports, 32768)) {
2076 ofproto->alloc_port_no = 1;
2078 last_used_at = ofport_get_usage(ofproto,
2079 u16_to_ofp(ofproto->alloc_port_no));
2080 if (!last_used_at) {
2081 port_idx = ofproto->alloc_port_no;
2083 } else if ( last_used_at < time_msec() - 60*60*1000) {
2084 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2085 * more than an hour ago, consider it usable. */
2086 ofport_remove_usage(ofproto,
2087 u16_to_ofp(ofproto->alloc_port_no));
2088 port_idx = ofproto->alloc_port_no;
2090 } else if (last_used_at < lru) {
2092 lru_ofport = ofproto->alloc_port_no;
2095 if (ofproto->alloc_port_no == end_port_no) {
2097 port_idx = lru_ofport;
2104 ofport_set_usage(ofproto, u16_to_ofp(port_idx), LLONG_MAX);
2105 return u16_to_ofp(port_idx);
2109 dealloc_ofp_port(struct ofproto *ofproto, ofp_port_t ofp_port)
2111 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
2112 ofport_set_usage(ofproto, ofp_port, time_msec());
2116 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2117 * pointer if the netdev cannot be opened. On success, also fills in
2119 static struct netdev *
2120 ofport_open(struct ofproto *ofproto,
2121 struct ofproto_port *ofproto_port,
2122 struct ofputil_phy_port *pp)
2124 enum netdev_flags flags;
2125 struct netdev *netdev;
2128 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
2130 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
2131 "cannot be opened (%s)",
2133 ofproto_port->name, ofproto_port->ofp_port,
2134 ofproto_port->name, ovs_strerror(error));
2138 if (ofproto_port->ofp_port == OFPP_NONE) {
2139 if (!strcmp(ofproto->name, ofproto_port->name)) {
2140 ofproto_port->ofp_port = OFPP_LOCAL;
2142 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
2143 ofproto_port->name);
2146 pp->port_no = ofproto_port->ofp_port;
2147 netdev_get_etheraddr(netdev, pp->hw_addr);
2148 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
2149 netdev_get_flags(netdev, &flags);
2150 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2151 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2152 netdev_get_features(netdev, &pp->curr, &pp->advertised,
2153 &pp->supported, &pp->peer);
2154 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2155 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2160 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2161 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2164 ofport_equal(const struct ofputil_phy_port *a,
2165 const struct ofputil_phy_port *b)
2167 return (eth_addr_equals(a->hw_addr, b->hw_addr)
2168 && a->state == b->state
2169 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2170 && a->curr == b->curr
2171 && a->advertised == b->advertised
2172 && a->supported == b->supported
2173 && a->peer == b->peer
2174 && a->curr_speed == b->curr_speed
2175 && a->max_speed == b->max_speed);
2178 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2179 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2180 * one with the same name or port number). */
2182 ofport_install(struct ofproto *p,
2183 struct netdev *netdev, const struct ofputil_phy_port *pp)
2185 const char *netdev_name = netdev_get_name(netdev);
2186 struct ofport *ofport;
2189 /* Create ofport. */
2190 ofport = p->ofproto_class->port_alloc();
2195 ofport->ofproto = p;
2196 ofport->netdev = netdev;
2197 ofport->change_seq = netdev_get_change_seq(netdev);
2199 ofport->ofp_port = pp->port_no;
2200 ofport->created = time_msec();
2202 /* Add port to 'p'. */
2203 hmap_insert(&p->ports, &ofport->hmap_node,
2204 hash_ofp_port(ofport->ofp_port));
2205 shash_add(&p->port_by_name, netdev_name, ofport);
2207 update_mtu(p, ofport);
2209 /* Let the ofproto_class initialize its private data. */
2210 error = p->ofproto_class->port_construct(ofport);
2214 connmgr_send_port_status(p->connmgr, NULL, pp, OFPPR_ADD);
2218 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2219 p->name, netdev_name, ovs_strerror(error));
2221 ofport_destroy__(ofport);
2223 netdev_close(netdev);
2227 /* Removes 'ofport' from 'p' and destroys it. */
2229 ofport_remove(struct ofport *ofport)
2231 connmgr_send_port_status(ofport->ofproto->connmgr, NULL, &ofport->pp,
2233 ofport_destroy(ofport);
2236 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2239 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2241 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2243 ofport_remove(port);
2247 /* Updates 'port' with new 'pp' description.
2249 * Does not handle a name or port number change. The caller must implement
2250 * such a change as a delete followed by an add. */
2252 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2254 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2255 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2256 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2257 port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2258 | (pp->state & OFPUTIL_PS_LINK_DOWN));
2259 port->pp.curr = pp->curr;
2260 port->pp.advertised = pp->advertised;
2261 port->pp.supported = pp->supported;
2262 port->pp.peer = pp->peer;
2263 port->pp.curr_speed = pp->curr_speed;
2264 port->pp.max_speed = pp->max_speed;
2266 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2267 &port->pp, OFPPR_MODIFY);
2270 /* Update OpenFlow 'state' in 'port' and notify controller. */
2272 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2274 if (port->pp.state != state) {
2275 port->pp.state = state;
2276 connmgr_send_port_status(port->ofproto->connmgr, NULL,
2277 &port->pp, OFPPR_MODIFY);
2282 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2284 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2286 if (port->ofproto->ofproto_class->set_realdev) {
2287 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2289 if (port->ofproto->ofproto_class->set_stp_port) {
2290 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2292 if (port->ofproto->ofproto_class->set_cfm) {
2293 port->ofproto->ofproto_class->set_cfm(port, NULL);
2295 if (port->ofproto->ofproto_class->bundle_remove) {
2296 port->ofproto->ofproto_class->bundle_remove(port);
2302 ofport_destroy__(struct ofport *port)
2304 struct ofproto *ofproto = port->ofproto;
2305 const char *name = netdev_get_name(port->netdev);
2307 hmap_remove(&ofproto->ports, &port->hmap_node);
2308 shash_delete(&ofproto->port_by_name,
2309 shash_find(&ofproto->port_by_name, name));
2311 netdev_close(port->netdev);
2312 ofproto->ofproto_class->port_dealloc(port);
2316 ofport_destroy(struct ofport *port)
2319 dealloc_ofp_port(port->ofproto, port->ofp_port);
2320 port->ofproto->ofproto_class->port_destruct(port);
2321 ofport_destroy__(port);
2326 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2328 struct ofport *port;
2330 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2332 if (port->ofp_port == ofp_port) {
2339 static long long int
2340 ofport_get_usage(const struct ofproto *ofproto, ofp_port_t ofp_port)
2342 struct ofport_usage *usage;
2344 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2345 &ofproto->ofport_usage) {
2346 if (usage->ofp_port == ofp_port) {
2347 return usage->last_used;
2354 ofport_set_usage(struct ofproto *ofproto, ofp_port_t ofp_port,
2355 long long int last_used)
2357 struct ofport_usage *usage;
2358 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2359 &ofproto->ofport_usage) {
2360 if (usage->ofp_port == ofp_port) {
2361 usage->last_used = last_used;
2365 ovs_assert(last_used == LLONG_MAX);
2367 usage = xmalloc(sizeof *usage);
2368 usage->ofp_port = ofp_port;
2369 usage->last_used = last_used;
2370 hmap_insert(&ofproto->ofport_usage, &usage->hmap_node,
2371 hash_ofp_port(ofp_port));
2375 ofport_remove_usage(struct ofproto *ofproto, ofp_port_t ofp_port)
2377 struct ofport_usage *usage;
2378 HMAP_FOR_EACH_IN_BUCKET (usage, hmap_node, hash_ofp_port(ofp_port),
2379 &ofproto->ofport_usage) {
2380 if (usage->ofp_port == ofp_port) {
2381 hmap_remove(&ofproto->ofport_usage, &usage->hmap_node);
2389 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2391 struct ofproto *ofproto = port->ofproto;
2394 if (ofproto->ofproto_class->port_get_stats) {
2395 error = ofproto->ofproto_class->port_get_stats(port, stats);
2404 update_port(struct ofproto *ofproto, const char *name)
2406 struct ofproto_port ofproto_port;
2407 struct ofputil_phy_port pp;
2408 struct netdev *netdev;
2409 struct ofport *port;
2411 COVERAGE_INC(ofproto_update_port);
2413 /* Fetch 'name''s location and properties from the datapath. */
2414 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2415 ? ofport_open(ofproto, &ofproto_port, &pp)
2419 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2420 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2421 struct netdev *old_netdev = port->netdev;
2423 /* 'name' hasn't changed location. Any properties changed? */
2424 if (!ofport_equal(&port->pp, &pp)) {
2425 ofport_modified(port, &pp);
2428 update_mtu(ofproto, port);
2430 /* Install the newly opened netdev in case it has changed.
2431 * Don't close the old netdev yet in case port_modified has to
2432 * remove a retained reference to it.*/
2433 port->netdev = netdev;
2434 port->change_seq = netdev_get_change_seq(netdev);
2436 if (port->ofproto->ofproto_class->port_modified) {
2437 port->ofproto->ofproto_class->port_modified(port);
2440 netdev_close(old_netdev);
2442 /* If 'port' is nonnull then its name differs from 'name' and thus
2443 * we should delete it. If we think there's a port named 'name'
2444 * then its port number must be wrong now so delete it too. */
2446 ofport_remove(port);
2448 ofport_remove_with_name(ofproto, name);
2449 ofport_install(ofproto, netdev, &pp);
2452 /* Any port named 'name' is gone now. */
2453 ofport_remove_with_name(ofproto, name);
2455 ofproto_port_destroy(&ofproto_port);
2459 init_ports(struct ofproto *p)
2461 struct ofproto_port_dump dump;
2462 struct ofproto_port ofproto_port;
2463 struct shash_node *node, *next;
2465 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2466 const char *name = ofproto_port.name;
2468 if (shash_find(&p->port_by_name, name)) {
2469 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2472 struct ofputil_phy_port pp;
2473 struct netdev *netdev;
2475 /* Check if an OpenFlow port number had been requested. */
2476 node = shash_find(&init_ofp_ports, name);
2478 const struct iface_hint *iface_hint = node->data;
2479 simap_put(&p->ofp_requests, name,
2480 ofp_to_u16(iface_hint->ofp_port));
2483 netdev = ofport_open(p, &ofproto_port, &pp);
2485 ofport_install(p, netdev, &pp);
2486 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2487 p->alloc_port_no = MAX(p->alloc_port_no,
2488 ofp_to_u16(ofproto_port.ofp_port));
2494 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2495 struct iface_hint *iface_hint = node->data;
2497 if (!strcmp(iface_hint->br_name, p->name)) {
2498 free(iface_hint->br_name);
2499 free(iface_hint->br_type);
2501 shash_delete(&init_ofp_ports, node);
2508 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2509 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2511 find_min_mtu(struct ofproto *p)
2513 struct ofport *ofport;
2516 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2517 struct netdev *netdev = ofport->netdev;
2520 /* Skip any internal ports, since that's what we're trying to
2522 if (!strcmp(netdev_get_type(netdev), "internal")) {
2526 if (netdev_get_mtu(netdev, &dev_mtu)) {
2529 if (!mtu || dev_mtu < mtu) {
2534 return mtu ? mtu: ETH_PAYLOAD_MAX;
2537 /* Update MTU of all datapath devices on 'p' to the minimum of the
2538 * non-datapath ports in event of 'port' added or changed. */
2540 update_mtu(struct ofproto *p, struct ofport *port)
2542 struct ofport *ofport;
2543 struct netdev *netdev = port->netdev;
2544 int dev_mtu, old_min;
2546 if (netdev_get_mtu(netdev, &dev_mtu)) {
2550 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2551 if (dev_mtu > p->min_mtu) {
2552 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2553 dev_mtu = p->min_mtu;
2556 port->mtu = dev_mtu;
2560 /* For non-internal port find new min mtu. */
2561 old_min = p->min_mtu;
2562 port->mtu = dev_mtu;
2563 p->min_mtu = find_min_mtu(p);
2564 if (p->min_mtu == old_min) {
2568 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2569 struct netdev *netdev = ofport->netdev;
2571 if (!strcmp(netdev_get_type(netdev), "internal")) {
2572 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2573 ofport->mtu = p->min_mtu;
2580 ofproto_rule_destroy__(struct rule *rule)
2581 OVS_NO_THREAD_SAFETY_ANALYSIS
2583 cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2584 rule_actions_destroy(rule_get_actions(rule));
2585 ovs_mutex_destroy(&rule->mutex);
2586 rule->ofproto->ofproto_class->rule_dealloc(rule);
2590 rule_destroy_cb(struct rule *rule)
2592 rule->ofproto->ofproto_class->rule_destruct(rule);
2593 ofproto_rule_destroy__(rule);
2597 ofproto_rule_ref(struct rule *rule)
2600 ovs_refcount_ref(&rule->ref_count);
2604 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2605 * ref_count reaches 0.
2607 * Use of RCU allows short term use (between RCU quiescent periods) without
2608 * keeping a reference. A reference must be taken if the rule needs to
2609 * stay around accross the RCU quiescent periods. */
2611 ofproto_rule_unref(struct rule *rule)
2613 if (rule && ovs_refcount_unref(&rule->ref_count) == 1) {
2614 ovsrcu_postpone(rule_destroy_cb, rule);
2618 static uint32_t get_provider_meter_id(const struct ofproto *,
2619 uint32_t of_meter_id);
2621 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2622 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2623 const struct rule_actions *
2624 rule_actions_create(const struct ofproto *ofproto,
2625 const struct ofpact *ofpacts, size_t ofpacts_len)
2627 struct rule_actions *actions;
2629 actions = xmalloc(sizeof *actions + ofpacts_len);
2630 actions->ofpacts_len = ofpacts_len;
2631 actions->provider_meter_id
2632 = get_provider_meter_id(ofproto,
2633 ofpacts_get_meter(ofpacts, ofpacts_len));
2634 memcpy(actions->ofpacts, ofpacts, ofpacts_len);
2639 /* Free the actions after the RCU quiescent period is reached. */
2641 rule_actions_destroy(const struct rule_actions *actions)
2644 ovsrcu_postpone(free, CONST_CAST(struct rule_actions *, actions));
2648 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2649 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2651 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2652 OVS_REQUIRES(ofproto_mutex)
2654 if (port == OFPP_ANY) {
2657 const struct rule_actions *actions = rule_get_actions(rule);
2658 return ofpacts_output_to_port(actions->ofpacts,
2659 actions->ofpacts_len, port);
2663 /* Returns true if 'rule' has group and equals group_id. */
2665 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2666 OVS_REQUIRES(ofproto_mutex)
2668 if (group_id == OFPG_ANY) {
2671 const struct rule_actions *actions = rule_get_actions(rule);
2672 return ofpacts_output_to_group(actions->ofpacts,
2673 actions->ofpacts_len, group_id);
2677 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2678 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2680 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2681 OVS_REQUIRES(ofproto_mutex)
2683 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2688 case OFOPERATION_ADD:
2689 case OFOPERATION_DELETE:
2692 case OFOPERATION_MODIFY:
2693 case OFOPERATION_REPLACE:
2694 return ofpacts_output_to_port(op->actions->ofpacts,
2695 op->actions->ofpacts_len, out_port);
2702 rule_execute_destroy(struct rule_execute *e)
2704 ofproto_rule_unref(e->rule);
2705 list_remove(&e->list_node);
2709 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2710 * by passing them to the ofproto provider. */
2712 run_rule_executes(struct ofproto *ofproto)
2713 OVS_EXCLUDED(ofproto_mutex)
2715 struct rule_execute *e, *next;
2716 struct list executes;
2718 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2719 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2722 flow_extract(e->packet, NULL, &flow);
2723 flow.in_port.ofp_port = e->in_port;
2724 ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2726 rule_execute_destroy(e);
2730 /* Destroys and discards all "rule_execute" operations queued up in
2731 * ofproto->rule_executes. */
2733 destroy_rule_executes(struct ofproto *ofproto)
2735 struct rule_execute *e, *next;
2736 struct list executes;
2738 guarded_list_pop_all(&ofproto->rule_executes, &executes);
2739 LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2740 ofpbuf_delete(e->packet);
2741 rule_execute_destroy(e);
2745 /* Returns true if 'rule' should be hidden from the controller.
2747 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2748 * (e.g. by in-band control) and are intentionally hidden from the
2751 ofproto_rule_is_hidden(const struct rule *rule)
2753 return (rule->cr.priority > UINT16_MAX);
2757 oftable_is_modifiable(const struct oftable *table,
2758 enum ofputil_flow_mod_flags flags)
2760 if (flags & OFPUTIL_FF_NO_READONLY) {
2764 return !(table->flags & OFTABLE_READONLY);
2768 rule_is_modifiable(const struct rule *rule, enum ofputil_flow_mod_flags flags)
2770 const struct oftable *rule_table;
2772 rule_table = &rule->ofproto->tables[rule->table_id];
2773 return oftable_is_modifiable(rule_table, flags);
2777 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2779 ofconn_send_reply(ofconn, make_echo_reply(oh));
2784 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2786 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2787 struct ofputil_switch_features features;
2788 struct ofport *port;
2792 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2794 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2796 features.datapath_id = ofproto->datapath_id;
2797 features.n_buffers = pktbuf_capacity();
2798 features.n_tables = ofproto_get_n_visible_tables(ofproto);
2799 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2800 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2802 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2804 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2805 features.auxiliary_id = 0;
2806 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2808 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2809 ofputil_put_switch_features_port(&port->pp, b);
2812 ofconn_send_reply(ofconn, b);
2817 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2819 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2820 struct ofp_switch_config *osc;
2821 enum ofp_config_flags flags;
2825 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2826 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2827 flags = ofproto->frag_handling;
2828 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2829 if (oh->version < OFP13_VERSION
2830 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2831 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2833 osc->flags = htons(flags);
2834 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2835 ofconn_send_reply(ofconn, buf);
2841 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2843 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2844 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2845 uint16_t flags = ntohs(osc->flags);
2847 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2848 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2849 enum ofp_config_flags cur = ofproto->frag_handling;
2850 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2852 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2854 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2855 ofproto->frag_handling = next;
2857 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2859 ofputil_frag_handling_to_string(next));
2863 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2864 ofconn_set_invalid_ttl_to_controller(ofconn,
2865 (oh->version < OFP13_VERSION
2866 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2868 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2873 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2874 * error message code for the caller to propagate upward. Otherwise, returns
2877 * The log message mentions 'msg_type'. */
2879 reject_slave_controller(struct ofconn *ofconn)
2881 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2882 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2883 return OFPERR_OFPBRC_EPERM;
2889 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2892 * - If they use a meter, then 'ofproto' has that meter configured.
2894 * - If they use any groups, then 'ofproto' has that group configured.
2896 * Returns 0 if successful, otherwise an OpenFlow error. */
2898 ofproto_check_ofpacts(struct ofproto *ofproto,
2899 const struct ofpact ofpacts[], size_t ofpacts_len)
2901 const struct ofpact *a;
2904 mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2905 if (mid && get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2906 return OFPERR_OFPMMFC_INVALID_METER;
2909 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2910 if (a->type == OFPACT_GROUP
2911 && !ofproto_group_exists(ofproto, ofpact_get_GROUP(a)->group_id)) {
2912 return OFPERR_OFPBAC_BAD_OUT_GROUP;
2920 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2922 struct ofproto *p = ofconn_get_ofproto(ofconn);
2923 struct ofputil_packet_out po;
2924 struct ofpbuf *payload;
2925 uint64_t ofpacts_stub[1024 / 8];
2926 struct ofpbuf ofpacts;
2930 COVERAGE_INC(ofproto_packet_out);
2932 error = reject_slave_controller(ofconn);
2937 /* Decode message. */
2938 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2939 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2941 goto exit_free_ofpacts;
2943 if (ofp_to_u16(po.in_port) >= p->max_ports
2944 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2945 error = OFPERR_OFPBRC_BAD_PORT;
2946 goto exit_free_ofpacts;
2950 if (po.buffer_id != UINT32_MAX) {
2951 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2952 if (error || !payload) {
2953 goto exit_free_ofpacts;
2956 /* Ensure that the L3 header is 32-bit aligned. */
2957 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2960 /* Verify actions against packet, then send packet if successful. */
2961 flow_extract(payload, NULL, &flow);
2962 flow.in_port.ofp_port = po.in_port;
2963 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len);
2965 error = p->ofproto_class->packet_out(p, payload, &flow,
2966 po.ofpacts, po.ofpacts_len);
2968 ofpbuf_delete(payload);
2971 ofpbuf_uninit(&ofpacts);
2977 update_port_config(struct ofconn *ofconn, struct ofport *port,
2978 enum ofputil_port_config config,
2979 enum ofputil_port_config mask)
2981 enum ofputil_port_config toggle = (config ^ port->pp.config) & mask;
2983 if (toggle & OFPUTIL_PC_PORT_DOWN
2984 && (config & OFPUTIL_PC_PORT_DOWN
2985 ? netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL)
2986 : netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL))) {
2987 /* We tried to bring the port up or down, but it failed, so don't
2988 * update the "down" bit. */
2989 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2993 enum ofputil_port_config old_config = port->pp.config;
2994 port->pp.config ^= toggle;
2995 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2996 connmgr_send_port_status(port->ofproto->connmgr, ofconn, &port->pp,
3002 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3004 struct ofproto *p = ofconn_get_ofproto(ofconn);
3005 struct ofputil_port_mod pm;
3006 struct ofport *port;
3009 error = reject_slave_controller(ofconn);
3014 error = ofputil_decode_port_mod(oh, &pm, false);
3019 port = ofproto_get_port(p, pm.port_no);
3021 return OFPERR_OFPPMFC_BAD_PORT;
3022 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
3023 return OFPERR_OFPPMFC_BAD_HW_ADDR;
3025 update_port_config(ofconn, port, pm.config, pm.mask);
3027 netdev_set_advertisements(port->netdev, pm.advertise);
3034 handle_desc_stats_request(struct ofconn *ofconn,
3035 const struct ofp_header *request)
3037 static const char *default_mfr_desc = "Nicira, Inc.";
3038 static const char *default_hw_desc = "Open vSwitch";
3039 static const char *default_sw_desc = VERSION;
3040 static const char *default_serial_desc = "None";
3041 static const char *default_dp_desc = "None";
3043 struct ofproto *p = ofconn_get_ofproto(ofconn);
3044 struct ofp_desc_stats *ods;
3047 msg = ofpraw_alloc_stats_reply(request, 0);
3048 ods = ofpbuf_put_zeros(msg, sizeof *ods);
3049 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
3050 sizeof ods->mfr_desc);
3051 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
3052 sizeof ods->hw_desc);
3053 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
3054 sizeof ods->sw_desc);
3055 ovs_strlcpy(ods->serial_num,
3056 p->serial_desc ? p->serial_desc : default_serial_desc,
3057 sizeof ods->serial_num);
3058 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
3059 sizeof ods->dp_desc);
3060 ofconn_send_reply(ofconn, msg);
3066 handle_table_stats_request(struct ofconn *ofconn,
3067 const struct ofp_header *request)
3069 struct ofproto *p = ofconn_get_ofproto(ofconn);
3070 struct ofp12_table_stats *ots;
3075 /* Set up default values.
3077 * ofp12_table_stats is used as a generic structure as
3078 * it is able to hold all the fields for ofp10_table_stats
3079 * and ofp11_table_stats (and of course itself).
3081 ots = xcalloc(p->n_tables, sizeof *ots);
3082 for (i = 0; i < p->n_tables; i++) {
3083 ots[i].table_id = i;
3084 sprintf(ots[i].name, "table%"PRIuSIZE, i);
3085 ots[i].match = htonll(OFPXMT13_MASK);
3086 ots[i].wildcards = htonll(OFPXMT13_MASK);
3087 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
3088 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
3089 ots[i].write_setfields = htonll(OFPXMT13_MASK);
3090 ots[i].apply_setfields = htonll(OFPXMT13_MASK);
3091 ots[i].metadata_match = OVS_BE64_MAX;
3092 ots[i].metadata_write = OVS_BE64_MAX;
3093 ots[i].instructions = htonl(OFPIT11_ALL);
3094 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
3095 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
3096 fat_rwlock_rdlock(&p->tables[i].cls.rwlock);
3097 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
3098 fat_rwlock_unlock(&p->tables[i].cls.rwlock);
3101 p->ofproto_class->get_tables(p, ots);
3103 /* Post-process the tables, dropping hidden tables. */
3104 n_tables = p->n_tables;
3105 for (i = 0; i < p->n_tables; i++) {
3106 const struct oftable *table = &p->tables[i];
3108 if (table->flags & OFTABLE_HIDDEN) {
3114 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
3117 if (table->max_flows < ntohl(ots[i].max_entries)) {
3118 ots[i].max_entries = htonl(table->max_flows);
3122 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
3123 ofconn_send_reply(ofconn, msg);
3131 append_port_stat(struct ofport *port, struct list *replies)
3133 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
3135 calc_duration(port->created, time_msec(),
3136 &ops.duration_sec, &ops.duration_nsec);
3138 /* Intentionally ignore return value, since errors will set
3139 * 'stats' to all-1s, which is correct for OpenFlow, and
3140 * netdev_get_stats() will log errors. */
3141 ofproto_port_get_stats(port, &ops.stats);
3143 ofputil_append_port_stat(replies, &ops);
3147 handle_port_request(struct ofconn *ofconn,
3148 const struct ofp_header *request, ofp_port_t port_no,
3149 void (*cb)(struct ofport *, struct list *replies))
3151 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3152 struct ofport *port;
3153 struct list replies;
3155 ofpmp_init(&replies, request);
3156 if (port_no != OFPP_ANY) {
3157 port = ofproto_get_port(ofproto, port_no);
3162 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3167 ofconn_send_replies(ofconn, &replies);
3171 handle_port_stats_request(struct ofconn *ofconn,
3172 const struct ofp_header *request)
3177 error = ofputil_decode_port_stats_request(request, &port_no);
3179 handle_port_request(ofconn, request, port_no, append_port_stat);
3185 append_port_desc(struct ofport *port, struct list *replies)
3187 ofputil_append_port_desc_stats_reply(&port->pp, replies);
3191 handle_port_desc_stats_request(struct ofconn *ofconn,
3192 const struct ofp_header *request)
3197 error = ofputil_decode_port_desc_stats_request(request, &port_no);
3199 handle_port_request(ofconn, request, port_no, append_port_desc);
3205 hash_cookie(ovs_be64 cookie)
3207 return hash_uint64((OVS_FORCE uint64_t)cookie);
3211 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3212 OVS_REQUIRES(ofproto_mutex)
3214 hindex_insert(&ofproto->cookies, &rule->cookie_node,
3215 hash_cookie(rule->flow_cookie));
3219 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3220 OVS_REQUIRES(ofproto_mutex)
3222 hindex_remove(&ofproto->cookies, &rule->cookie_node);
3226 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3227 ovs_be64 new_cookie)
3228 OVS_REQUIRES(ofproto_mutex)
3230 if (new_cookie != rule->flow_cookie) {
3231 cookies_remove(ofproto, rule);
3233 ovs_mutex_lock(&rule->mutex);
3234 rule->flow_cookie = new_cookie;
3235 ovs_mutex_unlock(&rule->mutex);
3237 cookies_insert(ofproto, rule);
3242 calc_duration(long long int start, long long int now,
3243 uint32_t *sec, uint32_t *nsec)
3245 long long int msecs = now - start;
3246 *sec = msecs / 1000;
3247 *nsec = (msecs % 1000) * (1000 * 1000);
3250 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3251 * true if 'table_id' is OK, false otherwise. */
3253 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3255 return table_id == OFPTT_ALL || table_id < ofproto->n_tables;
3258 static struct oftable *
3259 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3261 struct oftable *table;
3263 for (table = &ofproto->tables[table_id];
3264 table < &ofproto->tables[ofproto->n_tables];
3266 if (!(table->flags & OFTABLE_HIDDEN)) {
3274 static struct oftable *
3275 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3277 if (table_id == 0xff) {
3278 return next_visible_table(ofproto, 0);
3279 } else if (table_id < ofproto->n_tables) {
3280 return &ofproto->tables[table_id];
3286 static struct oftable *
3287 next_matching_table(const struct ofproto *ofproto,
3288 const struct oftable *table, uint8_t table_id)
3290 return (table_id == 0xff
3291 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3295 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3297 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3298 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3300 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3301 * only once, for that table. (This can be used to access tables marked
3304 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3305 * entered at all. (Perhaps you should have validated TABLE_ID with
3306 * check_table_id().)
3308 * All parameters are evaluated multiple times.
3310 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3311 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3313 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3315 /* Initializes 'criteria' in a straightforward way based on the other
3318 * For "loose" matching, the 'priority' parameter is unimportant and may be
3321 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3322 const struct match *match, unsigned int priority,
3323 ovs_be64 cookie, ovs_be64 cookie_mask,
3324 ofp_port_t out_port, uint32_t out_group)
3326 criteria->table_id = table_id;
3327 cls_rule_init(&criteria->cr, match, priority);
3328 criteria->cookie = cookie;
3329 criteria->cookie_mask = cookie_mask;
3330 criteria->out_port = out_port;
3331 criteria->out_group = out_group;
3335 rule_criteria_destroy(struct rule_criteria *criteria)
3337 cls_rule_destroy(&criteria->cr);
3341 rule_collection_init(struct rule_collection *rules)
3343 rules->rules = rules->stub;
3345 rules->capacity = ARRAY_SIZE(rules->stub);
3349 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3351 if (rules->n >= rules->capacity) {
3352 size_t old_size, new_size;
3354 old_size = rules->capacity * sizeof *rules->rules;
3355 rules->capacity *= 2;
3356 new_size = rules->capacity * sizeof *rules->rules;
3358 if (rules->rules == rules->stub) {
3359 rules->rules = xmalloc(new_size);
3360 memcpy(rules->rules, rules->stub, old_size);
3362 rules->rules = xrealloc(rules->rules, new_size);
3366 rules->rules[rules->n++] = rule;
3370 rule_collection_ref(struct rule_collection *rules)
3371 OVS_REQUIRES(ofproto_mutex)
3375 for (i = 0; i < rules->n; i++) {
3376 ofproto_rule_ref(rules->rules[i]);
3381 rule_collection_unref(struct rule_collection *rules)
3385 for (i = 0; i < rules->n; i++) {
3386 ofproto_rule_unref(rules->rules[i]);
3391 rule_collection_destroy(struct rule_collection *rules)
3393 if (rules->rules != rules->stub) {
3399 collect_rule(struct rule *rule, const struct rule_criteria *c,
3400 struct rule_collection *rules)
3401 OVS_REQUIRES(ofproto_mutex)
3403 /* We ordinarily want to skip hidden rules, but there has to be a way for
3404 * code internal to OVS to modify and delete them, so if the criteria
3405 * specify a priority that can only be for a hidden flow, then allow hidden
3406 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3407 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3409 if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3411 } else if (rule->pending) {
3412 return OFPROTO_POSTPONE;
3414 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3415 && ofproto_rule_has_out_port(rule, c->out_port)
3416 && ofproto_rule_has_out_group(rule, c->out_group)
3417 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3418 rule_collection_add(rules, rule);
3424 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3425 * on classifiers rules are done in the "loose" way required for OpenFlow
3426 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3429 * Hidden rules are always omitted.
3431 * Returns 0 on success, otherwise an OpenFlow error code. */
3433 collect_rules_loose(struct ofproto *ofproto,
3434 const struct rule_criteria *criteria,
3435 struct rule_collection *rules)
3436 OVS_REQUIRES(ofproto_mutex)
3438 struct oftable *table;
3439 enum ofperr error = 0;
3441 rule_collection_init(rules);
3443 if (!check_table_id(ofproto, criteria->table_id)) {
3444 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3448 if (criteria->cookie_mask == OVS_BE64_MAX) {
3451 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3452 hash_cookie(criteria->cookie),
3453 &ofproto->cookies) {
3454 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3455 error = collect_rule(rule, criteria, rules);
3462 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3463 struct cls_cursor cursor;
3466 fat_rwlock_rdlock(&table->cls.rwlock);
3467 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3468 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3469 error = collect_rule(rule, criteria, rules);
3474 fat_rwlock_unlock(&table->cls.rwlock);
3480 rule_collection_destroy(rules);
3485 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3486 * on classifiers rules are done in the "strict" way required for OpenFlow
3487 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3488 * rules on list 'rules'.
3490 * Hidden rules are always omitted.
3492 * Returns 0 on success, otherwise an OpenFlow error code. */
3494 collect_rules_strict(struct ofproto *ofproto,
3495 const struct rule_criteria *criteria,
3496 struct rule_collection *rules)
3497 OVS_REQUIRES(ofproto_mutex)
3499 struct oftable *table;
3502 rule_collection_init(rules);
3504 if (!check_table_id(ofproto, criteria->table_id)) {
3505 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3509 if (criteria->cookie_mask == OVS_BE64_MAX) {
3512 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3513 hash_cookie(criteria->cookie),
3514 &ofproto->cookies) {
3515 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3516 error = collect_rule(rule, criteria, rules);
3523 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3526 fat_rwlock_rdlock(&table->cls.rwlock);
3527 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3528 &table->cls, &criteria->cr));
3529 fat_rwlock_unlock(&table->cls.rwlock);
3531 error = collect_rule(rule, criteria, rules);
3541 rule_collection_destroy(rules);
3546 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3547 * forced into the range of a uint16_t. */
3549 age_secs(long long int age_ms)
3551 return (age_ms < 0 ? 0
3552 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3553 : (unsigned int) age_ms / 1000);
3557 handle_flow_stats_request(struct ofconn *ofconn,
3558 const struct ofp_header *request)
3559 OVS_EXCLUDED(ofproto_mutex)
3561 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3562 struct ofputil_flow_stats_request fsr;
3563 struct rule_criteria criteria;
3564 struct rule_collection rules;
3565 struct list replies;
3569 error = ofputil_decode_flow_stats_request(&fsr, request);
3574 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3575 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3577 ovs_mutex_lock(&ofproto_mutex);
3578 error = collect_rules_loose(ofproto, &criteria, &rules);
3579 rule_criteria_destroy(&criteria);
3581 rule_collection_ref(&rules);
3583 ovs_mutex_unlock(&ofproto_mutex);
3589 ofpmp_init(&replies, request);
3590 for (i = 0; i < rules.n; i++) {
3591 struct rule *rule = rules.rules[i];
3592 long long int now = time_msec();
3593 struct ofputil_flow_stats fs;
3594 long long int created, used, modified;
3595 const struct rule_actions *actions;
3596 enum ofputil_flow_mod_flags flags;
3598 ovs_mutex_lock(&rule->mutex);
3599 fs.cookie = rule->flow_cookie;
3600 fs.idle_timeout = rule->idle_timeout;
3601 fs.hard_timeout = rule->hard_timeout;
3602 created = rule->created;
3603 modified = rule->modified;
3604 actions = rule_get_actions(rule);
3605 flags = rule->flags;
3606 ovs_mutex_unlock(&rule->mutex);
3608 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3609 &fs.byte_count, &used);
3611 minimatch_expand(&rule->cr.match, &fs.match);
3612 fs.table_id = rule->table_id;
3613 calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3614 fs.priority = rule->cr.priority;
3615 fs.idle_age = age_secs(now - used);
3616 fs.hard_age = age_secs(now - modified);
3617 fs.ofpacts = actions->ofpacts;
3618 fs.ofpacts_len = actions->ofpacts_len;
3621 ofputil_append_flow_stats_reply(&fs, &replies);
3624 rule_collection_unref(&rules);
3625 rule_collection_destroy(&rules);
3627 ofconn_send_replies(ofconn, &replies);
3633 flow_stats_ds(struct rule *rule, struct ds *results)
3635 uint64_t packet_count, byte_count;
3636 const struct rule_actions *actions;
3637 long long int created, used;
3639 rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3640 &byte_count, &used);
3642 ovs_mutex_lock(&rule->mutex);
3643 actions = rule_get_actions(rule);
3644 created = rule->created;
3645 ovs_mutex_unlock(&rule->mutex);
3647 if (rule->table_id != 0) {
3648 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3650 ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3651 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3652 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3653 cls_rule_format(&rule->cr, results);
3654 ds_put_char(results, ',');
3656 ds_put_cstr(results, "actions=");
3657 ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3659 ds_put_cstr(results, "\n");
3662 /* Adds a pretty-printed description of all flows to 'results', including
3663 * hidden flows (e.g., set up by in-band control). */
3665 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3667 struct oftable *table;
3669 OFPROTO_FOR_EACH_TABLE (table, p) {
3670 struct cls_cursor cursor;
3673 fat_rwlock_rdlock(&table->cls.rwlock);
3674 cls_cursor_init(&cursor, &table->cls, NULL);
3675 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3676 flow_stats_ds(rule, results);
3678 fat_rwlock_unlock(&table->cls.rwlock);
3682 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3683 * '*engine_type' and '*engine_id', respectively. */
3685 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3686 uint8_t *engine_type, uint8_t *engine_id)
3688 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3691 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto' and stores
3692 * the port's CFM status in '*status'. If 'force' is set to true, status will
3693 * be returned even if there is no status change since last update.
3695 * Returns 0 on success. Returns a negative number if there is no status
3696 * change since last update and 'force' is set to false. Returns positive errno
3697 * if the port did not have CFM configured.
3699 * The caller must provide and own '*status', and must free 'status->rmps'.
3700 * '*status' is indeterminate if the return value is non-zero. */
3702 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3703 bool force, struct ofproto_cfm_status *status)
3705 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3706 return (ofport && ofproto->ofproto_class->get_cfm_status
3707 ? ofproto->ofproto_class->get_cfm_status(ofport, force, status)
3712 handle_aggregate_stats_request(struct ofconn *ofconn,
3713 const struct ofp_header *oh)
3714 OVS_EXCLUDED(ofproto_mutex)
3716 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3717 struct ofputil_flow_stats_request request;
3718 struct ofputil_aggregate_stats stats;
3719 bool unknown_packets, unknown_bytes;
3720 struct rule_criteria criteria;
3721 struct rule_collection rules;
3722 struct ofpbuf *reply;
3726 error = ofputil_decode_flow_stats_request(&request, oh);
3731 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3732 request.cookie, request.cookie_mask,
3733 request.out_port, request.out_group);
3735 ovs_mutex_lock(&ofproto_mutex);
3736 error = collect_rules_loose(ofproto, &criteria, &rules);
3737 rule_criteria_destroy(&criteria);
3739 rule_collection_ref(&rules);
3741 ovs_mutex_unlock(&ofproto_mutex);
3747 memset(&stats, 0, sizeof stats);
3748 unknown_packets = unknown_bytes = false;
3749 for (i = 0; i < rules.n; i++) {
3750 struct rule *rule = rules.rules[i];
3751 uint64_t packet_count;
3752 uint64_t byte_count;
3755 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3756 &byte_count, &used);
3758 if (packet_count == UINT64_MAX) {
3759 unknown_packets = true;
3761 stats.packet_count += packet_count;
3764 if (byte_count == UINT64_MAX) {
3765 unknown_bytes = true;
3767 stats.byte_count += byte_count;
3772 if (unknown_packets) {
3773 stats.packet_count = UINT64_MAX;
3775 if (unknown_bytes) {
3776 stats.byte_count = UINT64_MAX;
3779 rule_collection_unref(&rules);
3780 rule_collection_destroy(&rules);
3782 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3783 ofconn_send_reply(ofconn, reply);
3788 struct queue_stats_cbdata {
3789 struct ofport *ofport;
3790 struct list replies;
3795 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3796 const struct netdev_queue_stats *stats)
3798 struct ofputil_queue_stats oqs;
3800 oqs.port_no = cbdata->ofport->pp.port_no;
3801 oqs.queue_id = queue_id;
3802 oqs.tx_bytes = stats->tx_bytes;
3803 oqs.tx_packets = stats->tx_packets;
3804 oqs.tx_errors = stats->tx_errors;
3805 if (stats->created != LLONG_MIN) {
3806 calc_duration(stats->created, cbdata->now,
3807 &oqs.duration_sec, &oqs.duration_nsec);
3809 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3811 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3815 handle_queue_stats_dump_cb(uint32_t queue_id,
3816 struct netdev_queue_stats *stats,
3819 struct queue_stats_cbdata *cbdata = cbdata_;
3821 put_queue_stats(cbdata, queue_id, stats);
3825 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3826 struct queue_stats_cbdata *cbdata)
3828 cbdata->ofport = port;
3829 if (queue_id == OFPQ_ALL) {
3830 netdev_dump_queue_stats(port->netdev,
3831 handle_queue_stats_dump_cb, cbdata);
3833 struct netdev_queue_stats stats;
3835 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3836 put_queue_stats(cbdata, queue_id, &stats);
3838 return OFPERR_OFPQOFC_BAD_QUEUE;
3845 handle_queue_stats_request(struct ofconn *ofconn,
3846 const struct ofp_header *rq)
3848 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3849 struct queue_stats_cbdata cbdata;
3850 struct ofport *port;
3852 struct ofputil_queue_stats_request oqsr;
3854 COVERAGE_INC(ofproto_queue_req);
3856 ofpmp_init(&cbdata.replies, rq);
3857 cbdata.now = time_msec();
3859 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3864 if (oqsr.port_no == OFPP_ANY) {
3865 error = OFPERR_OFPQOFC_BAD_QUEUE;
3866 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3867 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3872 port = ofproto_get_port(ofproto, oqsr.port_no);
3874 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3875 : OFPERR_OFPQOFC_BAD_PORT);
3878 ofconn_send_replies(ofconn, &cbdata.replies);
3880 ofpbuf_list_delete(&cbdata.replies);
3887 is_flow_deletion_pending(const struct ofproto *ofproto,
3888 const struct cls_rule *cls_rule,
3890 OVS_REQUIRES(ofproto_mutex)
3892 if (!hmap_is_empty(&ofproto->deletions)) {
3893 struct ofoperation *op;
3895 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3896 cls_rule_hash(cls_rule, table_id),
3897 &ofproto->deletions) {
3898 if (op->rule->table_id == table_id
3899 && cls_rule_equal(cls_rule, &op->rule->cr)) {
3909 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3910 OVS_REQUIRES(ofproto_mutex)
3911 OVS_NO_THREAD_SAFETY_ANALYSIS
3913 return classifier_count(&table->cls) + extra_space > table->max_flows;
3917 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3918 unsigned int extra_space)
3919 OVS_REQUIRES(ofproto_mutex)
3921 while (should_evict_a_rule(table, extra_space)) {
3924 if (!choose_rule_to_evict(table, &rule)) {
3925 return OFPERR_OFPFMFC_TABLE_FULL;
3926 } else if (rule->pending) {
3927 return OFPROTO_POSTPONE;
3929 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3930 delete_flow__(rule, group, OFPRR_EVICTION);
3931 ofopgroup_submit(group);
3938 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3939 * in which no matching flow already exists in the flow table.
3941 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3942 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3943 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3944 * initiated now but may be retried later.
3946 * The caller retains ownership of 'fm->ofpacts'.
3948 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3951 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3952 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3953 OVS_REQUIRES(ofproto_mutex)
3955 struct oftable *table;
3961 if (!check_table_id(ofproto, fm->table_id)) {
3962 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3967 if (fm->table_id == 0xff) {
3968 if (ofproto->ofproto_class->rule_choose_table) {
3969 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3975 ovs_assert(table_id < ofproto->n_tables);
3979 } else if (fm->table_id < ofproto->n_tables) {
3980 table_id = fm->table_id;
3982 return OFPERR_OFPBRC_BAD_TABLE_ID;
3985 table = &ofproto->tables[table_id];
3987 if (!oftable_is_modifiable(table, fm->flags)) {
3988 return OFPERR_OFPBRC_EPERM;
3991 if (!(fm->flags & OFPUTIL_FF_HIDDEN_FIELDS)) {
3992 if (!match_has_default_hidden_fields(&fm->match)) {
3993 VLOG_WARN_RL(&rl, "%s: (add_flow) only internal flows can set "
3994 "non-default values to hidden fields", ofproto->name);
3995 return OFPERR_OFPBRC_EPERM;
3999 cls_rule_init(&cr, &fm->match, fm->priority);
4001 /* Transform "add" into "modify" if there's an existing identical flow. */
4002 fat_rwlock_rdlock(&table->cls.rwlock);
4003 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
4004 fat_rwlock_unlock(&table->cls.rwlock);
4006 cls_rule_destroy(&cr);
4007 if (!rule_is_modifiable(rule, fm->flags)) {
4008 return OFPERR_OFPBRC_EPERM;
4009 } else if (rule->pending) {
4010 return OFPROTO_POSTPONE;
4012 struct rule_collection rules;
4014 rule_collection_init(&rules);
4015 rule_collection_add(&rules, rule);
4016 fm->modify_cookie = true;
4017 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4018 rule_collection_destroy(&rules);
4024 /* Serialize against pending deletion. */
4025 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
4026 cls_rule_destroy(&cr);
4027 return OFPROTO_POSTPONE;
4030 /* Check for overlap, if requested. */
4031 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
4034 fat_rwlock_rdlock(&table->cls.rwlock);
4035 overlaps = classifier_rule_overlaps(&table->cls, &cr);
4036 fat_rwlock_unlock(&table->cls.rwlock);
4039 cls_rule_destroy(&cr);
4040 return OFPERR_OFPFMFC_OVERLAP;
4044 /* If necessary, evict an existing rule to clear out space. */
4045 error = evict_rules_from_table(ofproto, table, 1);
4047 cls_rule_destroy(&cr);
4051 /* Allocate new rule. */
4052 rule = ofproto->ofproto_class->rule_alloc();
4054 cls_rule_destroy(&cr);
4055 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
4056 ofproto->name, ovs_strerror(error));
4060 /* Initialize base state. */
4061 *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
4062 cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
4063 ovs_refcount_init(&rule->ref_count);
4064 rule->pending = NULL;
4065 rule->flow_cookie = fm->new_cookie;
4066 rule->created = rule->modified = time_msec();
4068 ovs_mutex_init(&rule->mutex);
4069 ovs_mutex_lock(&rule->mutex);
4070 rule->idle_timeout = fm->idle_timeout;
4071 rule->hard_timeout = fm->hard_timeout;
4072 ovs_mutex_unlock(&rule->mutex);
4074 *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
4075 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4076 ovsrcu_set(&rule->actions,
4077 rule_actions_create(ofproto, fm->ofpacts, fm->ofpacts_len));
4078 list_init(&rule->meter_list_node);
4079 rule->eviction_group = NULL;
4080 list_init(&rule->expirable);
4081 rule->monitor_flags = 0;
4082 rule->add_seqno = 0;
4083 rule->modify_seqno = 0;
4085 /* Construct rule, initializing derived state. */
4086 error = ofproto->ofproto_class->rule_construct(rule);
4088 ofproto_rule_destroy__(rule);
4093 do_add_flow(ofproto, ofconn, request, fm->buffer_id, rule);
4099 do_add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
4100 const struct ofp_header *request, uint32_t buffer_id,
4102 OVS_REQUIRES(ofproto_mutex)
4104 struct ofopgroup *group;
4106 oftable_insert_rule(rule);
4108 group = ofopgroup_create(ofproto, ofconn, request, buffer_id);
4109 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
4110 ofproto->ofproto_class->rule_insert(rule);
4111 ofopgroup_submit(group);
4114 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4116 /* Modifies the rules listed in 'rules', changing their actions to match those
4119 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4122 * Returns 0 on success, otherwise an OpenFlow error code. */
4124 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4125 struct ofputil_flow_mod *fm, const struct ofp_header *request,
4126 const struct rule_collection *rules)
4127 OVS_REQUIRES(ofproto_mutex)
4129 enum ofoperation_type type;
4130 struct ofopgroup *group;
4134 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
4135 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
4136 error = OFPERR_OFPBRC_EPERM;
4137 for (i = 0; i < rules->n; i++) {
4138 struct rule *rule = rules->rules[i];
4139 const struct rule_actions *actions;
4140 struct ofoperation *op;
4141 bool actions_changed;
4142 bool reset_counters;
4144 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4146 if (rule_is_modifiable(rule, fm->flags)) {
4147 /* At least one rule is modifiable, don't report EPERM error. */
4153 actions = rule_get_actions(rule);
4154 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
4156 actions->ofpacts_len);
4158 op = ofoperation_create(group, rule, type, 0);
4160 if (fm->modify_cookie && fm->new_cookie != OVS_BE64_MAX) {
4161 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
4163 if (type == OFOPERATION_REPLACE) {
4164 ovs_mutex_lock(&rule->mutex);
4165 rule->idle_timeout = fm->idle_timeout;
4166 rule->hard_timeout = fm->hard_timeout;
4167 ovs_mutex_unlock(&rule->mutex);
4169 rule->flags = fm->flags & OFPUTIL_FF_STATE;
4170 if (fm->idle_timeout || fm->hard_timeout) {
4171 if (!rule->eviction_group) {
4172 eviction_group_add_rule(rule);
4175 eviction_group_remove_rule(rule);
4179 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
4180 if (actions_changed || reset_counters) {
4181 const struct rule_actions *new_actions;
4183 op->actions = rule_get_actions(rule);
4184 new_actions = rule_actions_create(ofproto,
4185 fm->ofpacts, fm->ofpacts_len);
4187 ovsrcu_set(&rule->actions, new_actions);
4189 rule->ofproto->ofproto_class->rule_modify_actions(rule,
4192 ofoperation_complete(op, 0);
4195 ofopgroup_submit(group);
4201 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4202 struct ofputil_flow_mod *fm, const struct ofp_header *request)
4203 OVS_REQUIRES(ofproto_mutex)
4205 if (fm->cookie_mask != htonll(0) || fm->new_cookie == OVS_BE64_MAX) {
4208 return add_flow(ofproto, ofconn, fm, request);
4211 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4214 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4217 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4218 struct ofputil_flow_mod *fm,
4219 const struct ofp_header *request)
4220 OVS_REQUIRES(ofproto_mutex)
4222 struct rule_criteria criteria;
4223 struct rule_collection rules;
4226 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4227 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4228 error = collect_rules_loose(ofproto, &criteria, &rules);
4229 rule_criteria_destroy(&criteria);
4232 error = (rules.n > 0
4233 ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4234 : modify_flows_add(ofproto, ofconn, fm, request));
4237 rule_collection_destroy(&rules);
4242 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4245 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4248 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4249 struct ofputil_flow_mod *fm,
4250 const struct ofp_header *request)
4251 OVS_REQUIRES(ofproto_mutex)
4253 struct rule_criteria criteria;
4254 struct rule_collection rules;
4257 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4258 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
4259 error = collect_rules_strict(ofproto, &criteria, &rules);
4260 rule_criteria_destroy(&criteria);
4264 error = modify_flows_add(ofproto, ofconn, fm, request);
4265 } else if (rules.n == 1) {
4266 error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4270 rule_collection_destroy(&rules);
4275 /* OFPFC_DELETE implementation. */
4278 delete_flow__(struct rule *rule, struct ofopgroup *group,
4279 enum ofp_flow_removed_reason reason)
4280 OVS_REQUIRES(ofproto_mutex)
4282 struct ofproto *ofproto = rule->ofproto;
4284 ofproto_rule_send_removed(rule, reason);
4286 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4287 oftable_remove_rule(rule);
4288 ofproto->ofproto_class->rule_delete(rule);
4291 /* Deletes the rules listed in 'rules'.
4293 * Returns 0 on success, otherwise an OpenFlow error code. */
4295 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4296 const struct ofp_header *request,
4297 const struct rule_collection *rules,
4298 enum ofp_flow_removed_reason reason)
4299 OVS_REQUIRES(ofproto_mutex)
4301 struct ofopgroup *group;
4304 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4305 for (i = 0; i < rules->n; i++) {
4306 delete_flow__(rules->rules[i], group, reason);
4308 ofopgroup_submit(group);
4313 /* Implements OFPFC_DELETE. */
4315 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4316 const struct ofputil_flow_mod *fm,
4317 const struct ofp_header *request)
4318 OVS_REQUIRES(ofproto_mutex)
4320 struct rule_criteria criteria;
4321 struct rule_collection rules;
4324 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4325 fm->cookie, fm->cookie_mask,
4326 fm->out_port, fm->out_group);
4327 error = collect_rules_loose(ofproto, &criteria, &rules);
4328 rule_criteria_destroy(&criteria);
4330 if (!error && rules.n > 0) {
4331 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4333 rule_collection_destroy(&rules);
4338 /* Implements OFPFC_DELETE_STRICT. */
4340 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4341 const struct ofputil_flow_mod *fm,
4342 const struct ofp_header *request)
4343 OVS_REQUIRES(ofproto_mutex)
4345 struct rule_criteria criteria;
4346 struct rule_collection rules;
4349 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4350 fm->cookie, fm->cookie_mask,
4351 fm->out_port, fm->out_group);
4352 error = collect_rules_strict(ofproto, &criteria, &rules);
4353 rule_criteria_destroy(&criteria);
4355 if (!error && rules.n > 0) {
4356 error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4358 rule_collection_destroy(&rules);
4364 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4365 OVS_REQUIRES(ofproto_mutex)
4367 struct ofputil_flow_removed fr;
4370 if (ofproto_rule_is_hidden(rule) ||
4371 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
4375 minimatch_expand(&rule->cr.match, &fr.match);
4376 fr.priority = rule->cr.priority;
4377 fr.cookie = rule->flow_cookie;
4379 fr.table_id = rule->table_id;
4380 calc_duration(rule->created, time_msec(),
4381 &fr.duration_sec, &fr.duration_nsec);
4382 ovs_mutex_lock(&rule->mutex);
4383 fr.idle_timeout = rule->idle_timeout;
4384 fr.hard_timeout = rule->hard_timeout;
4385 ovs_mutex_unlock(&rule->mutex);
4386 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4387 &fr.byte_count, &used);
4389 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4392 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4393 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4396 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4399 * ofproto implementation ->run() functions should use this function to expire
4400 * OpenFlow flows. */
4402 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4403 OVS_REQUIRES(ofproto_mutex)
4405 struct ofproto *ofproto = rule->ofproto;
4407 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4408 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
4410 ofproto_rule_delete__(ofproto, rule, reason);
4413 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4414 * means "infinite". */
4416 reduce_timeout(uint16_t max, uint16_t *timeout)
4418 if (max && (!*timeout || *timeout > max)) {
4423 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4424 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4425 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4427 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4429 ofproto_rule_reduce_timeouts(struct rule *rule,
4430 uint16_t idle_timeout, uint16_t hard_timeout)
4431 OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4433 if (!idle_timeout && !hard_timeout) {
4437 ovs_mutex_lock(&ofproto_mutex);
4438 if (list_is_empty(&rule->expirable)) {
4439 list_insert(&rule->ofproto->expirable, &rule->expirable);
4441 ovs_mutex_unlock(&ofproto_mutex);
4443 ovs_mutex_lock(&rule->mutex);
4444 reduce_timeout(idle_timeout, &rule->idle_timeout);
4445 reduce_timeout(hard_timeout, &rule->hard_timeout);
4446 ovs_mutex_unlock(&rule->mutex);
4450 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4451 OVS_EXCLUDED(ofproto_mutex)
4453 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4454 struct ofputil_flow_mod fm;
4455 uint64_t ofpacts_stub[1024 / 8];
4456 struct ofpbuf ofpacts;
4459 error = reject_slave_controller(ofconn);
4464 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4465 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4467 u16_to_ofp(ofproto->max_ports),
4470 error = ofproto_check_ofpacts(ofproto, fm.ofpacts, fm.ofpacts_len);
4473 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4476 goto exit_free_ofpacts;
4479 ofconn_report_flow_mod(ofconn, fm.command);
4482 ofpbuf_uninit(&ofpacts);
4488 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4489 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4490 OVS_EXCLUDED(ofproto_mutex)
4494 ovs_mutex_lock(&ofproto_mutex);
4495 if (ofproto->n_pending < 50) {
4496 switch (fm->command) {
4498 error = add_flow(ofproto, ofconn, fm, oh);
4502 error = modify_flows_loose(ofproto, ofconn, fm, oh);
4505 case OFPFC_MODIFY_STRICT:
4506 error = modify_flow_strict(ofproto, ofconn, fm, oh);
4510 error = delete_flows_loose(ofproto, ofconn, fm, oh);
4513 case OFPFC_DELETE_STRICT:
4514 error = delete_flow_strict(ofproto, ofconn, fm, oh);
4518 if (fm->command > 0xff) {
4519 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4520 "flow_mod_table_id extension is not enabled",
4523 error = OFPERR_OFPFMFC_BAD_COMMAND;
4527 ovs_assert(!list_is_empty(&ofproto->pending));
4528 error = OFPROTO_POSTPONE;
4530 ovs_mutex_unlock(&ofproto_mutex);
4532 run_rule_executes(ofproto);
4537 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4539 struct ofputil_role_request request;
4540 struct ofputil_role_request reply;
4544 error = ofputil_decode_role_message(oh, &request);
4549 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4550 if (ofconn_get_role(ofconn) != request.role
4551 && ofconn_has_pending_opgroups(ofconn)) {
4552 return OFPROTO_POSTPONE;
4555 if (request.have_generation_id
4556 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4557 return OFPERR_OFPRRFC_STALE;
4560 ofconn_set_role(ofconn, request.role);
4563 reply.role = ofconn_get_role(ofconn);
4564 reply.have_generation_id = ofconn_get_master_election_id(
4565 ofconn, &reply.generation_id);
4566 buf = ofputil_encode_role_reply(oh, &reply);
4567 ofconn_send_reply(ofconn, buf);
4573 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4574 const struct ofp_header *oh)
4576 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4577 enum ofputil_protocol cur, next;
4579 cur = ofconn_get_protocol(ofconn);
4580 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4581 ofconn_set_protocol(ofconn, next);
4587 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4589 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4590 enum ofputil_protocol cur, next;
4591 enum ofputil_protocol next_base;
4593 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4595 return OFPERR_OFPBRC_EPERM;
4598 cur = ofconn_get_protocol(ofconn);
4599 next = ofputil_protocol_set_base(cur, next_base);
4600 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4601 /* Avoid sending async messages in surprising protocol. */
4602 return OFPROTO_POSTPONE;
4605 ofconn_set_protocol(ofconn, next);
4610 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4611 const struct ofp_header *oh)
4613 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4616 format = ntohl(msg->format);
4617 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4618 return OFPERR_OFPBRC_EPERM;
4621 if (format != ofconn_get_packet_in_format(ofconn)
4622 && ofconn_has_pending_opgroups(ofconn)) {
4623 /* Avoid sending async message in surprsing packet in format. */
4624 return OFPROTO_POSTPONE;
4627 ofconn_set_packet_in_format(ofconn, format);
4632 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4634 const struct nx_async_config *msg = ofpmsg_body(oh);
4635 uint32_t master[OAM_N_TYPES];
4636 uint32_t slave[OAM_N_TYPES];
4638 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4639 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4640 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4642 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4643 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4644 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4646 ofconn_set_async_config(ofconn, master, slave);
4647 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4648 !ofconn_get_miss_send_len(ofconn)) {
4649 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4656 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4659 uint32_t master[OAM_N_TYPES];
4660 uint32_t slave[OAM_N_TYPES];
4661 struct nx_async_config *msg;
4663 ofconn_get_async_config(ofconn, master, slave);
4664 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4665 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4667 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4668 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4669 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4671 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4672 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4673 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4675 ofconn_send_reply(ofconn, buf);
4681 handle_nxt_set_controller_id(struct ofconn *ofconn,
4682 const struct ofp_header *oh)
4684 const struct nx_controller_id *nci = ofpmsg_body(oh);
4686 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4687 return OFPERR_NXBRC_MUST_BE_ZERO;
4690 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4695 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4699 if (ofconn_has_pending_opgroups(ofconn)) {
4700 return OFPROTO_POSTPONE;
4703 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4704 ? OFPRAW_OFPT10_BARRIER_REPLY
4705 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4706 ofconn_send_reply(ofconn, buf);
4711 ofproto_compose_flow_refresh_update(const struct rule *rule,
4712 enum nx_flow_monitor_flags flags,
4714 OVS_REQUIRES(ofproto_mutex)
4716 struct ofoperation *op = rule->pending;
4717 const struct rule_actions *actions;
4718 struct ofputil_flow_update fu;
4721 if (op && op->type == OFOPERATION_ADD) {
4722 /* We'll report the final flow when the operation completes. Reporting
4723 * it now would cause a duplicate report later. */
4727 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4728 ? NXFME_ADDED : NXFME_MODIFIED);
4730 ovs_mutex_lock(&rule->mutex);
4731 fu.idle_timeout = rule->idle_timeout;
4732 fu.hard_timeout = rule->hard_timeout;
4733 ovs_mutex_unlock(&rule->mutex);
4734 fu.table_id = rule->table_id;
4735 fu.cookie = rule->flow_cookie;
4736 minimatch_expand(&rule->cr.match, &match);
4738 fu.priority = rule->cr.priority;
4740 if (!(flags & NXFMF_ACTIONS)) {
4743 actions = rule_get_actions(rule);
4745 /* An operation is in progress. Use the previous version of the flow's
4746 * actions, so that when the operation commits we report the change. */
4748 case OFOPERATION_ADD:
4751 case OFOPERATION_MODIFY:
4752 case OFOPERATION_REPLACE:
4753 actions = op->actions ? op->actions : rule_get_actions(rule);
4756 case OFOPERATION_DELETE:
4757 actions = rule_get_actions(rule);
4764 fu.ofpacts = actions ? actions->ofpacts : NULL;
4765 fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4767 if (list_is_empty(msgs)) {
4768 ofputil_start_flow_update(msgs);
4770 ofputil_append_flow_update(&fu, msgs);
4774 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4776 OVS_REQUIRES(ofproto_mutex)
4780 for (i = 0; i < rules->n; i++) {
4781 struct rule *rule = rules->rules[i];
4782 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4783 rule->monitor_flags = 0;
4785 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4790 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4791 struct rule *rule, uint64_t seqno,
4792 struct rule_collection *rules)
4793 OVS_REQUIRES(ofproto_mutex)
4795 enum nx_flow_monitor_flags update;
4797 if (ofproto_rule_is_hidden(rule)) {
4802 ? ofoperation_has_out_port(rule->pending, m->out_port)
4803 : ofproto_rule_has_out_port(rule, m->out_port))) {
4808 if (rule->add_seqno > seqno) {
4809 update = NXFMF_ADD | NXFMF_MODIFY;
4810 } else if (rule->modify_seqno > seqno) {
4811 update = NXFMF_MODIFY;
4816 if (!(m->flags & update)) {
4820 update = NXFMF_INITIAL;
4823 if (!rule->monitor_flags) {
4824 rule_collection_add(rules, rule);
4826 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4830 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4832 struct rule_collection *rules)
4833 OVS_REQUIRES(ofproto_mutex)
4835 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4836 const struct ofoperation *op;
4837 const struct oftable *table;
4838 struct cls_rule target;
4840 cls_rule_init_from_minimatch(&target, &m->match, 0);
4841 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4842 struct cls_cursor cursor;
4845 fat_rwlock_rdlock(&table->cls.rwlock);
4846 cls_cursor_init(&cursor, &table->cls, &target);
4847 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4848 ovs_assert(!rule->pending); /* XXX */
4849 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4851 fat_rwlock_unlock(&table->cls.rwlock);
4854 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4855 struct rule *rule = op->rule;
4857 if (((m->table_id == 0xff
4858 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4859 : m->table_id == rule->table_id))
4860 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4861 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4864 cls_rule_destroy(&target);
4868 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4869 struct rule_collection *rules)
4870 OVS_REQUIRES(ofproto_mutex)
4872 if (m->flags & NXFMF_INITIAL) {
4873 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4878 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4879 uint64_t seqno, struct rule_collection *rules)
4880 OVS_REQUIRES(ofproto_mutex)
4882 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4886 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4887 OVS_EXCLUDED(ofproto_mutex)
4889 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4890 struct ofmonitor **monitors;
4891 size_t n_monitors, allocated_monitors;
4892 struct rule_collection rules;
4893 struct list replies;
4899 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4901 n_monitors = allocated_monitors = 0;
4903 ovs_mutex_lock(&ofproto_mutex);
4905 struct ofputil_flow_monitor_request request;
4906 struct ofmonitor *m;
4909 retval = ofputil_decode_flow_monitor_request(&request, &b);
4910 if (retval == EOF) {
4912 } else if (retval) {
4917 if (request.table_id != 0xff
4918 && request.table_id >= ofproto->n_tables) {
4919 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4923 error = ofmonitor_create(&request, ofconn, &m);
4928 if (n_monitors >= allocated_monitors) {
4929 monitors = x2nrealloc(monitors, &allocated_monitors,
4932 monitors[n_monitors++] = m;
4935 rule_collection_init(&rules);
4936 for (i = 0; i < n_monitors; i++) {
4937 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4940 ofpmp_init(&replies, oh);
4941 ofmonitor_compose_refresh_updates(&rules, &replies);
4942 ovs_mutex_unlock(&ofproto_mutex);
4944 rule_collection_destroy(&rules);
4946 ofconn_send_replies(ofconn, &replies);
4952 for (i = 0; i < n_monitors; i++) {
4953 ofmonitor_destroy(monitors[i]);
4956 ovs_mutex_unlock(&ofproto_mutex);
4962 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4963 OVS_EXCLUDED(ofproto_mutex)
4965 struct ofmonitor *m;
4969 id = ofputil_decode_flow_monitor_cancel(oh);
4971 ovs_mutex_lock(&ofproto_mutex);
4972 m = ofmonitor_lookup(ofconn, id);
4974 ofmonitor_destroy(m);
4977 error = OFPERR_NXBRC_FM_BAD_ID;
4979 ovs_mutex_unlock(&ofproto_mutex);
4984 /* Meters implementation.
4986 * Meter table entry, indexed by the OpenFlow meter_id.
4987 * These are always dynamically allocated to allocate enough space for
4989 * 'created' is used to compute the duration for meter stats.
4990 * 'list rules' is needed so that we can delete the dependent rules when the
4991 * meter table entry is deleted.
4992 * 'provider_meter_id' is for the provider's private use.
4995 long long int created; /* Time created. */
4996 struct list rules; /* List of "struct rule_dpif"s. */
4997 ofproto_meter_id provider_meter_id;
4998 uint16_t flags; /* Meter flags. */
4999 uint16_t n_bands; /* Number of meter bands. */
5000 struct ofputil_meter_band *bands;
5004 * This is used in instruction validation at flow set-up time,
5005 * as flows may not use non-existing meters.
5006 * Return value of UINT32_MAX signifies an invalid meter.
5009 get_provider_meter_id(const struct ofproto *ofproto, uint32_t of_meter_id)
5011 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
5012 const struct meter *meter = ofproto->meters[of_meter_id];
5014 return meter->provider_meter_id.uint32;
5021 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
5025 meter->flags = config->flags;
5026 meter->n_bands = config->n_bands;
5027 meter->bands = xmemdup(config->bands,
5028 config->n_bands * sizeof *meter->bands);
5031 static struct meter *
5032 meter_create(const struct ofputil_meter_config *config,
5033 ofproto_meter_id provider_meter_id)
5035 struct meter *meter;
5037 meter = xzalloc(sizeof *meter);
5038 meter->provider_meter_id = provider_meter_id;
5039 meter->created = time_msec();
5040 list_init(&meter->rules);
5042 meter_update(meter, config);
5048 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
5049 OVS_REQUIRES(ofproto_mutex)
5052 for (mid = first; mid <= last; ++mid) {
5053 struct meter *meter = ofproto->meters[mid];
5055 ofproto->meters[mid] = NULL;
5056 ofproto->ofproto_class->meter_del(ofproto,
5057 meter->provider_meter_id);
5065 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5067 ofproto_meter_id provider_meter_id = { UINT32_MAX };
5068 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
5072 return OFPERR_OFPMMFC_METER_EXISTS;
5075 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
5078 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
5079 *meterp = meter_create(&mm->meter, provider_meter_id);
5085 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
5087 struct meter *meter = ofproto->meters[mm->meter.meter_id];
5089 uint32_t provider_meter_id;
5092 return OFPERR_OFPMMFC_UNKNOWN_METER;
5095 provider_meter_id = meter->provider_meter_id.uint32;
5096 error = ofproto->ofproto_class->meter_set(ofproto,
5097 &meter->provider_meter_id,
5099 ovs_assert(meter->provider_meter_id.uint32 == provider_meter_id);
5101 meter_update(meter, &mm->meter);
5107 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
5108 struct ofputil_meter_mod *mm)
5109 OVS_EXCLUDED(ofproto_mutex)
5111 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5112 uint32_t meter_id = mm->meter.meter_id;
5113 struct rule_collection rules;
5114 enum ofperr error = 0;
5115 uint32_t first, last;
5117 if (meter_id == OFPM13_ALL) {
5119 last = ofproto->meter_features.max_meters;
5121 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
5124 first = last = meter_id;
5127 /* First delete the rules that use this meter. If any of those rules are
5128 * currently being modified, postpone the whole operation until later. */
5129 rule_collection_init(&rules);
5130 ovs_mutex_lock(&ofproto_mutex);
5131 for (meter_id = first; meter_id <= last; ++meter_id) {
5132 struct meter *meter = ofproto->meters[meter_id];
5133 if (meter && !list_is_empty(&meter->rules)) {
5136 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
5137 if (rule->pending) {
5138 error = OFPROTO_POSTPONE;
5141 rule_collection_add(&rules, rule);
5146 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
5149 /* Delete the meters. */
5150 meter_delete(ofproto, first, last);
5153 ovs_mutex_unlock(&ofproto_mutex);
5154 rule_collection_destroy(&rules);
5160 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5162 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5163 struct ofputil_meter_mod mm;
5164 uint64_t bands_stub[256 / 8];
5165 struct ofpbuf bands;
5169 error = reject_slave_controller(ofconn);
5174 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5176 error = ofputil_decode_meter_mod(oh, &mm, &bands);
5178 goto exit_free_bands;
5181 meter_id = mm.meter.meter_id;
5183 if (mm.command != OFPMC13_DELETE) {
5184 /* Fails also when meters are not implemented by the provider. */
5185 if (meter_id == 0 || meter_id > OFPM13_MAX) {
5186 error = OFPERR_OFPMMFC_INVALID_METER;
5187 goto exit_free_bands;
5188 } else if (meter_id > ofproto->meter_features.max_meters) {
5189 error = OFPERR_OFPMMFC_OUT_OF_METERS;
5190 goto exit_free_bands;
5192 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
5193 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
5194 goto exit_free_bands;
5198 switch (mm.command) {
5200 error = handle_add_meter(ofproto, &mm);
5203 case OFPMC13_MODIFY:
5204 error = handle_modify_meter(ofproto, &mm);
5207 case OFPMC13_DELETE:
5208 error = handle_delete_meter(ofconn, oh, &mm);
5212 error = OFPERR_OFPMMFC_BAD_COMMAND;
5217 ofpbuf_uninit(&bands);
5222 handle_meter_features_request(struct ofconn *ofconn,
5223 const struct ofp_header *request)
5225 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5226 struct ofputil_meter_features features;
5229 if (ofproto->ofproto_class->meter_get_features) {
5230 ofproto->ofproto_class->meter_get_features(ofproto, &features);
5232 memset(&features, 0, sizeof features);
5234 b = ofputil_encode_meter_features_reply(&features, request);
5236 ofconn_send_reply(ofconn, b);
5241 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5244 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5245 struct list replies;
5246 uint64_t bands_stub[256 / 8];
5247 struct ofpbuf bands;
5248 uint32_t meter_id, first, last;
5250 ofputil_decode_meter_request(request, &meter_id);
5252 if (meter_id == OFPM13_ALL) {
5254 last = ofproto->meter_features.max_meters;
5256 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5257 !ofproto->meters[meter_id]) {
5258 return OFPERR_OFPMMFC_UNKNOWN_METER;
5260 first = last = meter_id;
5263 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5264 ofpmp_init(&replies, request);
5266 for (meter_id = first; meter_id <= last; ++meter_id) {
5267 struct meter *meter = ofproto->meters[meter_id];
5269 continue; /* Skip non-existing meters. */
5271 if (type == OFPTYPE_METER_STATS_REQUEST) {
5272 struct ofputil_meter_stats stats;
5274 stats.meter_id = meter_id;
5276 /* Provider sets the packet and byte counts, we do the rest. */
5277 stats.flow_count = list_size(&meter->rules);
5278 calc_duration(meter->created, time_msec(),
5279 &stats.duration_sec, &stats.duration_nsec);
5280 stats.n_bands = meter->n_bands;
5281 ofpbuf_clear(&bands);
5283 = ofpbuf_put_uninit(&bands,
5284 meter->n_bands * sizeof *stats.bands);
5286 if (!ofproto->ofproto_class->meter_get(ofproto,
5287 meter->provider_meter_id,
5289 ofputil_append_meter_stats(&replies, &stats);
5291 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5292 struct ofputil_meter_config config;
5294 config.meter_id = meter_id;
5295 config.flags = meter->flags;
5296 config.n_bands = meter->n_bands;
5297 config.bands = meter->bands;
5298 ofputil_append_meter_config(&replies, &config);
5302 ofconn_send_replies(ofconn, &replies);
5303 ofpbuf_uninit(&bands);
5308 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
5309 struct ofgroup **group)
5310 OVS_TRY_RDLOCK(true, (*group)->rwlock)
5312 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5313 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5314 hash_int(group_id, 0), &ofproto->groups) {
5315 if ((*group)->group_id == group_id) {
5316 ovs_rwlock_rdlock(&(*group)->rwlock);
5317 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5321 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5326 ofproto_group_release(struct ofgroup *group)
5327 OVS_RELEASES(group->rwlock)
5329 ovs_rwlock_unlock(&group->rwlock);
5333 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
5334 struct ofgroup **group)
5335 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
5336 OVS_TRY_WRLOCK(true, (*group)->rwlock)
5338 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5339 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
5340 hash_int(group_id, 0), &ofproto->groups) {
5341 if ((*group)->group_id == group_id) {
5342 ovs_rwlock_wrlock(&(*group)->rwlock);
5346 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5351 ofproto_group_exists__(const struct ofproto *ofproto, uint32_t group_id)
5352 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
5354 struct ofgroup *grp;
5356 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
5357 hash_int(group_id, 0), &ofproto->groups) {
5358 if (grp->group_id == group_id) {
5366 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
5367 OVS_EXCLUDED(ofproto->groups_rwlock)
5371 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5372 exists = ofproto_group_exists__(ofproto, group_id);
5373 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5379 group_get_ref_count(struct ofgroup *group)
5380 OVS_EXCLUDED(ofproto_mutex)
5382 struct ofproto *ofproto = group->ofproto;
5383 struct rule_criteria criteria;
5384 struct rule_collection rules;
5389 match_init_catchall(&match);
5390 rule_criteria_init(&criteria, 0xff, &match, 0, htonll(0), htonll(0),
5391 OFPP_ANY, group->group_id);
5392 ovs_mutex_lock(&ofproto_mutex);
5393 error = collect_rules_loose(ofproto, &criteria, &rules);
5394 ovs_mutex_unlock(&ofproto_mutex);
5395 rule_criteria_destroy(&criteria);
5397 count = !error && rules.n < UINT32_MAX ? rules.n : UINT32_MAX;
5399 rule_collection_destroy(&rules);
5404 append_group_stats(struct ofgroup *group, struct list *replies)
5405 OVS_REQ_RDLOCK(group->rwlock)
5407 struct ofputil_group_stats ogs;
5408 struct ofproto *ofproto = group->ofproto;
5409 long long int now = time_msec();
5412 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
5414 /* Provider sets the packet and byte counts, we do the rest. */
5415 ogs.ref_count = group_get_ref_count(group);
5416 ogs.n_buckets = group->n_buckets;
5418 error = (ofproto->ofproto_class->group_get_stats
5419 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
5422 ogs.packet_count = UINT64_MAX;
5423 ogs.byte_count = UINT64_MAX;
5424 memset(ogs.bucket_stats, 0xff,
5425 ogs.n_buckets * sizeof *ogs.bucket_stats);
5428 ogs.group_id = group->group_id;
5429 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
5431 ofputil_append_group_stats(replies, &ogs);
5433 free(ogs.bucket_stats);
5437 handle_group_request(struct ofconn *ofconn,
5438 const struct ofp_header *request, uint32_t group_id,
5439 void (*cb)(struct ofgroup *, struct list *replies))
5441 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5442 struct ofgroup *group;
5443 struct list replies;
5445 ofpmp_init(&replies, request);
5446 if (group_id == OFPG_ALL) {
5447 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
5448 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
5449 ovs_rwlock_rdlock(&group->rwlock);
5450 cb(group, &replies);
5451 ovs_rwlock_unlock(&group->rwlock);
5453 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5455 if (ofproto_group_lookup(ofproto, group_id, &group)) {
5456 cb(group, &replies);
5457 ofproto_group_release(group);
5460 ofconn_send_replies(ofconn, &replies);
5464 handle_group_stats_request(struct ofconn *ofconn,
5465 const struct ofp_header *request)
5470 error = ofputil_decode_group_stats_request(request, &group_id);
5475 handle_group_request(ofconn, request, group_id, append_group_stats);
5480 append_group_desc(struct ofgroup *group, struct list *replies)
5482 struct ofputil_group_desc gds;
5484 gds.group_id = group->group_id;
5485 gds.type = group->type;
5486 ofputil_append_group_desc_reply(&gds, &group->buckets, replies);
5490 handle_group_desc_stats_request(struct ofconn *ofconn,
5491 const struct ofp_header *request)
5493 handle_group_request(ofconn, request,
5494 ofputil_decode_group_desc_request(request),
5500 handle_group_features_stats_request(struct ofconn *ofconn,
5501 const struct ofp_header *request)
5503 struct ofproto *p = ofconn_get_ofproto(ofconn);
5506 msg = ofputil_encode_group_features_reply(&p->ogf, request);
5508 ofconn_send_reply(ofconn, msg);
5515 handle_queue_get_config_request(struct ofconn *ofconn,
5516 const struct ofp_header *oh)
5518 struct ofproto *p = ofconn_get_ofproto(ofconn);
5519 struct netdev_queue_dump queue_dump;
5520 struct ofport *ofport;
5521 unsigned int queue_id;
5522 struct ofpbuf *reply;
5523 struct smap details;
5527 error = ofputil_decode_queue_get_config_request(oh, &request);
5532 ofport = ofproto_get_port(p, request);
5534 return OFPERR_OFPQOFC_BAD_PORT;
5537 reply = ofputil_encode_queue_get_config_reply(oh);
5539 smap_init(&details);
5540 NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &queue_dump, ofport->netdev) {
5541 struct ofputil_queue_config queue;
5543 /* None of the existing queues have compatible properties, so we
5544 * hard-code omitting min_rate and max_rate. */
5545 queue.queue_id = queue_id;
5546 queue.min_rate = UINT16_MAX;
5547 queue.max_rate = UINT16_MAX;
5548 ofputil_append_queue_get_config_reply(reply, &queue);
5550 smap_destroy(&details);
5552 ofconn_send_reply(ofconn, reply);
5557 /* Implements OFPGC11_ADD
5558 * in which no matching flow already exists in the flow table.
5560 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5561 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5562 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5563 * initiated now but may be retried later.
5565 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5566 * ownership remains with the caller.
5568 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5571 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5573 struct ofgroup *ofgroup;
5576 if (gm->group_id > OFPG_MAX) {
5577 return OFPERR_OFPGMFC_INVALID_GROUP;
5579 if (gm->type > OFPGT11_FF) {
5580 return OFPERR_OFPGMFC_BAD_TYPE;
5583 /* Allocate new group and initialize it. */
5584 ofgroup = ofproto->ofproto_class->group_alloc();
5586 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
5587 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5590 ovs_rwlock_init(&ofgroup->rwlock);
5591 ofgroup->ofproto = ofproto;
5592 ofgroup->group_id = gm->group_id;
5593 ofgroup->type = gm->type;
5594 ofgroup->created = ofgroup->modified = time_msec();
5596 list_move(&ofgroup->buckets, &gm->buckets);
5597 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5599 /* Construct called BEFORE any locks are held. */
5600 error = ofproto->ofproto_class->group_construct(ofgroup);
5605 /* We wrlock as late as possible to minimize the time we jam any other
5606 * threads: No visible state changes before acquiring the lock. */
5607 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5609 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5610 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5614 if (ofproto_group_exists__(ofproto, gm->group_id)) {
5615 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5620 /* Insert new group. */
5621 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5622 hash_int(ofgroup->group_id, 0));
5623 ofproto->n_groups[ofgroup->type]++;
5625 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5630 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5631 ofproto->ofproto_class->group_destruct(ofgroup);
5633 ofputil_bucket_list_destroy(&ofgroup->buckets);
5634 ofproto->ofproto_class->group_dealloc(ofgroup);
5639 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5642 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5645 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5647 struct ofgroup *ofgroup;
5648 struct ofgroup *victim;
5651 if (gm->group_id > OFPG_MAX) {
5652 return OFPERR_OFPGMFC_INVALID_GROUP;
5655 if (gm->type > OFPGT11_FF) {
5656 return OFPERR_OFPGMFC_BAD_TYPE;
5659 victim = ofproto->ofproto_class->group_alloc();
5661 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5662 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5665 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5666 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5669 /* Both group's and its container's write locks held now.
5670 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5671 if (ofgroup->type != gm->type
5672 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5673 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5678 list_move(&victim->buckets, &ofgroup->buckets);
5680 ofgroup->type = gm->type;
5681 list_move(&ofgroup->buckets, &gm->buckets);
5682 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5684 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5686 ofputil_bucket_list_destroy(&victim->buckets);
5687 ofproto->n_groups[victim->type]--;
5688 ofproto->n_groups[ofgroup->type]++;
5689 ofgroup->modified = time_msec();
5691 ofputil_bucket_list_destroy(&ofgroup->buckets);
5694 list_move(&ofgroup->buckets, &victim->buckets);
5698 ovs_rwlock_unlock(&ofgroup->rwlock);
5699 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5701 ofproto->ofproto_class->group_dealloc(victim);
5706 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5707 OVS_RELEASES(ofproto->groups_rwlock)
5710 struct ofputil_flow_mod fm;
5712 /* Delete all flow entries containing this group in a group action */
5713 match_init_catchall(&match);
5714 flow_mod_init(&fm, &match, 0, NULL, 0, OFPFC_DELETE);
5715 fm.out_group = ofgroup->group_id;
5716 handle_flow_mod__(ofproto, NULL, &fm, NULL);
5718 /* Must wait until existing readers are done,
5719 * while holding the container's write lock at the same time. */
5720 ovs_rwlock_wrlock(&ofgroup->rwlock);
5721 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5722 /* No-one can find this group any more. */
5723 ofproto->n_groups[ofgroup->type]--;
5724 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5726 ofproto->ofproto_class->group_destruct(ofgroup);
5727 ofputil_bucket_list_destroy(&ofgroup->buckets);
5728 ovs_rwlock_unlock(&ofgroup->rwlock);
5729 ovs_rwlock_destroy(&ofgroup->rwlock);
5730 ofproto->ofproto_class->group_dealloc(ofgroup);
5733 /* Implements OFPGC_DELETE. */
5735 delete_group(struct ofproto *ofproto, uint32_t group_id)
5737 struct ofgroup *ofgroup;
5739 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5740 if (group_id == OFPG_ALL) {
5742 struct hmap_node *node = hmap_first(&ofproto->groups);
5746 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5747 delete_group__(ofproto, ofgroup);
5748 /* Lock for each node separately, so that we will not jam the
5749 * other threads for too long time. */
5750 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5753 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5754 hash_int(group_id, 0), &ofproto->groups) {
5755 if (ofgroup->group_id == group_id) {
5756 delete_group__(ofproto, ofgroup);
5761 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5765 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5767 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5768 struct ofputil_group_mod gm;
5771 error = reject_slave_controller(ofconn);
5776 error = ofputil_decode_group_mod(oh, &gm);
5781 switch (gm.command) {
5783 return add_group(ofproto, &gm);
5785 case OFPGC11_MODIFY:
5786 return modify_group(ofproto, &gm);
5788 case OFPGC11_DELETE:
5789 delete_group(ofproto, gm.group_id);
5793 if (gm.command > OFPGC11_DELETE) {
5794 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5795 ofproto->name, gm.command);
5797 return OFPERR_OFPGMFC_BAD_COMMAND;
5801 enum ofproto_table_config
5802 ofproto_table_get_config(const struct ofproto *ofproto, uint8_t table_id)
5805 atomic_read(&ofproto->tables[table_id].config, &value);
5806 return (enum ofproto_table_config)value;
5810 table_mod(struct ofproto *ofproto, const struct ofputil_table_mod *tm)
5812 /* Only accept currently supported configurations */
5813 if (tm->config & ~OFPTC11_TABLE_MISS_MASK) {
5814 return OFPERR_OFPTMFC_BAD_CONFIG;
5817 if (tm->table_id == OFPTT_ALL) {
5819 for (i = 0; i < ofproto->n_tables; i++) {
5820 atomic_store(&ofproto->tables[i].config,
5821 (unsigned int)tm->config);
5823 } else if (!check_table_id(ofproto, tm->table_id)) {
5824 return OFPERR_OFPTMFC_BAD_TABLE;
5826 atomic_store(&ofproto->tables[tm->table_id].config,
5827 (unsigned int)tm->config);
5834 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5836 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5837 struct ofputil_table_mod tm;
5840 error = reject_slave_controller(ofconn);
5845 error = ofputil_decode_table_mod(oh, &tm);
5850 return table_mod(ofproto, &tm);
5854 handle_bundle_control(struct ofconn *ofconn, const struct ofp_header *oh)
5857 struct ofputil_bundle_ctrl_msg bctrl;
5859 struct ofputil_bundle_ctrl_msg reply;
5861 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
5866 reply.bundle_id = bctrl.bundle_id;
5868 switch (bctrl.type) {
5869 case OFPBCT_OPEN_REQUEST:
5870 error = ofp_bundle_open(ofconn, bctrl.bundle_id, bctrl.flags);
5871 reply.type = OFPBCT_OPEN_REPLY;
5873 case OFPBCT_CLOSE_REQUEST:
5874 error = ofp_bundle_close(ofconn, bctrl.bundle_id, bctrl.flags);
5875 reply.type = OFPBCT_CLOSE_REPLY;;
5877 case OFPBCT_COMMIT_REQUEST:
5878 error = ofp_bundle_commit(ofconn, bctrl.bundle_id, bctrl.flags);
5879 reply.type = OFPBCT_COMMIT_REPLY;
5881 case OFPBCT_DISCARD_REQUEST:
5882 error = ofp_bundle_discard(ofconn, bctrl.bundle_id);
5883 reply.type = OFPBCT_DISCARD_REPLY;
5886 case OFPBCT_OPEN_REPLY:
5887 case OFPBCT_CLOSE_REPLY:
5888 case OFPBCT_COMMIT_REPLY:
5889 case OFPBCT_DISCARD_REPLY:
5890 return OFPERR_OFPBFC_BAD_TYPE;
5895 buf = ofputil_encode_bundle_ctrl_reply(oh, &reply);
5896 ofconn_send_reply(ofconn, buf);
5903 handle_bundle_add(struct ofconn *ofconn, const struct ofp_header *oh)
5906 struct ofputil_bundle_add_msg badd;
5908 error = ofputil_decode_bundle_add(oh, &badd);
5913 return ofp_bundle_add_message(ofconn, &badd);
5917 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5918 OVS_EXCLUDED(ofproto_mutex)
5920 const struct ofp_header *oh = ofpbuf_data(msg);
5924 error = ofptype_decode(&type, oh);
5928 if (oh->version >= OFP13_VERSION && ofpmsg_is_stat_request(oh)
5929 && ofpmp_more(oh)) {
5930 /* We have no buffer implementation for multipart requests.
5931 * Report overflow for requests which consists of multiple
5933 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW;
5937 /* OpenFlow requests. */
5938 case OFPTYPE_ECHO_REQUEST:
5939 return handle_echo_request(ofconn, oh);
5941 case OFPTYPE_FEATURES_REQUEST:
5942 return handle_features_request(ofconn, oh);
5944 case OFPTYPE_GET_CONFIG_REQUEST:
5945 return handle_get_config_request(ofconn, oh);
5947 case OFPTYPE_SET_CONFIG:
5948 return handle_set_config(ofconn, oh);
5950 case OFPTYPE_PACKET_OUT:
5951 return handle_packet_out(ofconn, oh);
5953 case OFPTYPE_PORT_MOD:
5954 return handle_port_mod(ofconn, oh);
5956 case OFPTYPE_FLOW_MOD:
5957 return handle_flow_mod(ofconn, oh);
5959 case OFPTYPE_GROUP_MOD:
5960 return handle_group_mod(ofconn, oh);
5962 case OFPTYPE_TABLE_MOD:
5963 return handle_table_mod(ofconn, oh);
5965 case OFPTYPE_METER_MOD:
5966 return handle_meter_mod(ofconn, oh);
5968 case OFPTYPE_BARRIER_REQUEST:
5969 return handle_barrier_request(ofconn, oh);
5971 case OFPTYPE_ROLE_REQUEST:
5972 return handle_role_request(ofconn, oh);
5974 /* OpenFlow replies. */
5975 case OFPTYPE_ECHO_REPLY:
5978 /* Nicira extension requests. */
5979 case OFPTYPE_FLOW_MOD_TABLE_ID:
5980 return handle_nxt_flow_mod_table_id(ofconn, oh);
5982 case OFPTYPE_SET_FLOW_FORMAT:
5983 return handle_nxt_set_flow_format(ofconn, oh);
5985 case OFPTYPE_SET_PACKET_IN_FORMAT:
5986 return handle_nxt_set_packet_in_format(ofconn, oh);
5988 case OFPTYPE_SET_CONTROLLER_ID:
5989 return handle_nxt_set_controller_id(ofconn, oh);
5991 case OFPTYPE_FLOW_AGE:
5992 /* Nothing to do. */
5995 case OFPTYPE_FLOW_MONITOR_CANCEL:
5996 return handle_flow_monitor_cancel(ofconn, oh);
5998 case OFPTYPE_SET_ASYNC_CONFIG:
5999 return handle_nxt_set_async_config(ofconn, oh);
6001 case OFPTYPE_GET_ASYNC_REQUEST:
6002 return handle_nxt_get_async_request(ofconn, oh);
6004 /* Statistics requests. */
6005 case OFPTYPE_DESC_STATS_REQUEST:
6006 return handle_desc_stats_request(ofconn, oh);
6008 case OFPTYPE_FLOW_STATS_REQUEST:
6009 return handle_flow_stats_request(ofconn, oh);
6011 case OFPTYPE_AGGREGATE_STATS_REQUEST:
6012 return handle_aggregate_stats_request(ofconn, oh);
6014 case OFPTYPE_TABLE_STATS_REQUEST:
6015 return handle_table_stats_request(ofconn, oh);
6017 case OFPTYPE_PORT_STATS_REQUEST:
6018 return handle_port_stats_request(ofconn, oh);
6020 case OFPTYPE_QUEUE_STATS_REQUEST:
6021 return handle_queue_stats_request(ofconn, oh);
6023 case OFPTYPE_PORT_DESC_STATS_REQUEST:
6024 return handle_port_desc_stats_request(ofconn, oh);
6026 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
6027 return handle_flow_monitor_request(ofconn, oh);
6029 case OFPTYPE_METER_STATS_REQUEST:
6030 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
6031 return handle_meter_request(ofconn, oh, type);
6033 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
6034 return handle_meter_features_request(ofconn, oh);
6036 case OFPTYPE_GROUP_STATS_REQUEST:
6037 return handle_group_stats_request(ofconn, oh);
6039 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
6040 return handle_group_desc_stats_request(ofconn, oh);
6042 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
6043 return handle_group_features_stats_request(ofconn, oh);
6045 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
6046 return handle_queue_get_config_request(ofconn, oh);
6048 case OFPTYPE_BUNDLE_CONTROL:
6049 return handle_bundle_control(ofconn, oh);
6051 case OFPTYPE_BUNDLE_ADD_MESSAGE:
6052 return handle_bundle_add(ofconn, oh);
6056 case OFPTYPE_FEATURES_REPLY:
6057 case OFPTYPE_GET_CONFIG_REPLY:
6058 case OFPTYPE_PACKET_IN:
6059 case OFPTYPE_FLOW_REMOVED:
6060 case OFPTYPE_PORT_STATUS:
6061 case OFPTYPE_BARRIER_REPLY:
6062 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
6063 case OFPTYPE_DESC_STATS_REPLY:
6064 case OFPTYPE_FLOW_STATS_REPLY:
6065 case OFPTYPE_QUEUE_STATS_REPLY:
6066 case OFPTYPE_PORT_STATS_REPLY:
6067 case OFPTYPE_TABLE_STATS_REPLY:
6068 case OFPTYPE_AGGREGATE_STATS_REPLY:
6069 case OFPTYPE_PORT_DESC_STATS_REPLY:
6070 case OFPTYPE_ROLE_REPLY:
6071 case OFPTYPE_FLOW_MONITOR_PAUSED:
6072 case OFPTYPE_FLOW_MONITOR_RESUMED:
6073 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
6074 case OFPTYPE_GET_ASYNC_REPLY:
6075 case OFPTYPE_GROUP_STATS_REPLY:
6076 case OFPTYPE_GROUP_DESC_STATS_REPLY:
6077 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
6078 case OFPTYPE_METER_STATS_REPLY:
6079 case OFPTYPE_METER_CONFIG_STATS_REPLY:
6080 case OFPTYPE_METER_FEATURES_STATS_REPLY:
6081 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
6082 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
6083 case OFPTYPE_ROLE_STATUS:
6085 if (ofpmsg_is_stat_request(oh)) {
6086 return OFPERR_OFPBRC_BAD_STAT;
6088 return OFPERR_OFPBRC_BAD_TYPE;
6094 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
6095 OVS_EXCLUDED(ofproto_mutex)
6097 int error = handle_openflow__(ofconn, ofp_msg);
6098 if (error && error != OFPROTO_POSTPONE) {
6099 ofconn_send_error(ofconn, ofpbuf_data(ofp_msg), error);
6101 COVERAGE_INC(ofproto_recv_openflow);
6102 return error != OFPROTO_POSTPONE;
6105 /* Asynchronous operations. */
6107 /* Creates and returns a new ofopgroup that is not associated with any
6108 * OpenFlow connection.
6110 * The caller should add operations to the returned group with
6111 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6112 static struct ofopgroup *
6113 ofopgroup_create_unattached(struct ofproto *ofproto)
6114 OVS_REQUIRES(ofproto_mutex)
6116 struct ofopgroup *group = xzalloc(sizeof *group);
6117 group->ofproto = ofproto;
6118 list_init(&group->ofproto_node);
6119 list_init(&group->ops);
6120 list_init(&group->ofconn_node);
6124 /* Creates and returns a new ofopgroup for 'ofproto'.
6126 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6127 * connection. The 'request' and 'buffer_id' arguments are ignored.
6129 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6130 * If the ofopgroup eventually fails, then the error reply will include
6131 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6132 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6134 * The caller should add operations to the returned group with
6135 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6136 static struct ofopgroup *
6137 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
6138 const struct ofp_header *request, uint32_t buffer_id)
6139 OVS_REQUIRES(ofproto_mutex)
6141 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
6143 size_t request_len = ntohs(request->length);
6145 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
6147 ofconn_add_opgroup(ofconn, &group->ofconn_node);
6148 group->ofconn = ofconn;
6149 group->request = xmemdup(request, MIN(request_len, 64));
6150 group->buffer_id = buffer_id;
6155 /* Submits 'group' for processing.
6157 * If 'group' contains no operations (e.g. none were ever added, or all of the
6158 * ones that were added completed synchronously), then it is destroyed
6159 * immediately. Otherwise it is added to the ofproto's list of pending
6162 ofopgroup_submit(struct ofopgroup *group)
6163 OVS_REQUIRES(ofproto_mutex)
6165 if (!group->n_running) {
6166 ofopgroup_complete(group);
6168 list_push_back(&group->ofproto->pending, &group->ofproto_node);
6169 group->ofproto->n_pending++;
6174 ofopgroup_complete(struct ofopgroup *group)
6175 OVS_REQUIRES(ofproto_mutex)
6177 struct ofproto *ofproto = group->ofproto;
6179 struct ofconn *abbrev_ofconn;
6180 ovs_be32 abbrev_xid;
6182 struct ofoperation *op, *next_op;
6185 ovs_assert(!group->n_running);
6188 LIST_FOR_EACH (op, group_node, &group->ops) {
6195 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
6196 LIST_FOR_EACH (op, group_node, &group->ops) {
6197 if (op->type != OFOPERATION_DELETE) {
6198 struct ofpbuf *packet;
6201 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
6204 struct rule_execute *re;
6208 ofproto_rule_ref(op->rule);
6210 re = xmalloc(sizeof *re);
6211 re->rule = op->rule;
6212 re->in_port = in_port;
6213 re->packet = packet;
6215 if (!guarded_list_push_back(&ofproto->rule_executes,
6216 &re->list_node, 1024)) {
6217 ofproto_rule_unref(op->rule);
6218 ofpbuf_delete(re->packet);
6227 if (!error && !list_is_empty(&group->ofconn_node)) {
6228 abbrev_ofconn = group->ofconn;
6229 abbrev_xid = group->request->xid;
6231 abbrev_ofconn = NULL;
6232 abbrev_xid = htonl(0);
6234 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
6235 struct rule *rule = op->rule;
6237 /* We generally want to report the change to active OpenFlow flow
6238 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6240 - The operation failed.
6242 - The affected rule is not visible to controllers.
6244 - The operation's only effect was to update rule->modified. */
6246 || ofproto_rule_is_hidden(rule)
6247 || (op->type == OFOPERATION_MODIFY
6249 && rule->flow_cookie == op->flow_cookie))) {
6250 /* Check that we can just cast from ofoperation_type to
6251 * nx_flow_update_event. */
6252 enum nx_flow_update_event event_type;
6255 case OFOPERATION_ADD:
6256 case OFOPERATION_REPLACE:
6257 event_type = NXFME_ADDED;
6260 case OFOPERATION_DELETE:
6261 event_type = NXFME_DELETED;
6264 case OFOPERATION_MODIFY:
6265 event_type = NXFME_MODIFIED;
6272 ofmonitor_report(ofproto->connmgr, rule, event_type,
6273 op->reason, abbrev_ofconn, abbrev_xid);
6276 rule->pending = NULL;
6279 case OFOPERATION_ADD:
6283 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
6284 if (vid_mask == VLAN_VID_MASK) {
6285 if (ofproto->vlan_bitmap) {
6286 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
6287 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
6288 bitmap_set1(ofproto->vlan_bitmap, vid);
6289 ofproto->vlans_changed = true;
6292 ofproto->vlans_changed = true;
6296 oftable_remove_rule(rule);
6297 ofproto_rule_unref(rule);
6301 case OFOPERATION_DELETE:
6302 ovs_assert(!op->error);
6303 ofproto_rule_unref(rule);
6307 case OFOPERATION_MODIFY:
6308 case OFOPERATION_REPLACE:
6310 long long int now = time_msec();
6312 ovs_mutex_lock(&rule->mutex);
6313 rule->modified = now;
6314 if (op->type == OFOPERATION_REPLACE) {
6315 rule->created = now;
6317 ovs_mutex_unlock(&rule->mutex);
6319 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
6320 ovs_mutex_lock(&rule->mutex);
6321 rule->idle_timeout = op->idle_timeout;
6322 rule->hard_timeout = op->hard_timeout;
6323 ovs_mutex_unlock(&rule->mutex);
6325 const struct rule_actions *old_actions;
6327 ovs_mutex_lock(&rule->mutex);
6328 old_actions = rule_get_actions(rule);
6329 ovsrcu_set(&rule->actions, op->actions);
6330 ovs_mutex_unlock(&rule->mutex);
6333 rule_actions_destroy(old_actions);
6335 rule->flags = op->flags;
6343 ofoperation_destroy(op);
6346 ofmonitor_flush(ofproto->connmgr);
6348 if (!list_is_empty(&group->ofproto_node)) {
6349 ovs_assert(ofproto->n_pending > 0);
6350 ofproto->n_pending--;
6351 list_remove(&group->ofproto_node);
6353 if (!list_is_empty(&group->ofconn_node)) {
6354 list_remove(&group->ofconn_node);
6356 ofconn_send_error(group->ofconn, group->request, error);
6358 connmgr_retry(ofproto->connmgr);
6360 free(group->request);
6364 /* Initiates a new operation on 'rule', of the specified 'type', within
6365 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6367 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6368 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6370 * Returns the newly created ofoperation (which is also available as
6371 * rule->pending). */
6372 static struct ofoperation *
6373 ofoperation_create(struct ofopgroup *group, struct rule *rule,
6374 enum ofoperation_type type,
6375 enum ofp_flow_removed_reason reason)
6376 OVS_REQUIRES(ofproto_mutex)
6378 struct ofproto *ofproto = group->ofproto;
6379 struct ofoperation *op;
6381 ovs_assert(!rule->pending);
6383 op = rule->pending = xzalloc(sizeof *op);
6385 list_push_back(&group->ops, &op->group_node);
6388 op->reason = reason;
6389 op->flow_cookie = rule->flow_cookie;
6390 ovs_mutex_lock(&rule->mutex);
6391 op->idle_timeout = rule->idle_timeout;
6392 op->hard_timeout = rule->hard_timeout;
6393 ovs_mutex_unlock(&rule->mutex);
6394 op->flags = rule->flags;
6398 if (type == OFOPERATION_DELETE) {
6399 hmap_insert(&ofproto->deletions, &op->hmap_node,
6400 cls_rule_hash(&rule->cr, rule->table_id));
6407 ofoperation_destroy(struct ofoperation *op)
6408 OVS_REQUIRES(ofproto_mutex)
6410 struct ofopgroup *group = op->group;
6413 op->rule->pending = NULL;
6415 if (op->type == OFOPERATION_DELETE) {
6416 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
6418 list_remove(&op->group_node);
6419 rule_actions_destroy(op->actions);
6423 /* Indicates that 'op' completed with status 'error', which is either 0 to
6424 * indicate success or an OpenFlow error code on failure.
6426 * If 'error' is 0, indicating success, the operation will be committed
6427 * permanently to the flow table.
6429 * If 'error' is nonzero, then generally the operation will be rolled back:
6431 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6432 * restores the original rule. The caller must have uninitialized any
6433 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6434 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6435 * and 7 for the new rule, calling its ->rule_dealloc() function.
6437 * - If 'op' is a "modify flow" operation, ofproto restores the original
6440 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6441 * allowed to fail. It must always succeed.
6443 * Please see the large comment in ofproto/ofproto-provider.h titled
6444 * "Asynchronous Operation Support" for more information. */
6446 ofoperation_complete(struct ofoperation *op, enum ofperr error)
6448 struct ofopgroup *group = op->group;
6450 ovs_assert(group->n_running > 0);
6451 ovs_assert(!error || op->type != OFOPERATION_DELETE);
6454 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
6455 /* This function can be called from ->rule_construct(), in which case
6456 * ofproto_mutex is held, or it can be called from ->run(), in which
6457 * case ofproto_mutex is not held. But only in the latter case can we
6458 * arrive here, so we can safely take ofproto_mutex now. */
6459 ovs_mutex_lock(&ofproto_mutex);
6460 ovs_assert(op->rule->pending == op);
6461 ofopgroup_complete(group);
6462 ovs_mutex_unlock(&ofproto_mutex);
6467 pick_datapath_id(const struct ofproto *ofproto)
6469 const struct ofport *port;
6471 port = ofproto_get_port(ofproto, OFPP_LOCAL);
6473 uint8_t ea[ETH_ADDR_LEN];
6476 error = netdev_get_etheraddr(port->netdev, ea);
6478 return eth_addr_to_uint64(ea);
6480 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6481 ofproto->name, netdev_get_name(port->netdev),
6482 ovs_strerror(error));
6484 return ofproto->fallback_dpid;
6488 pick_fallback_dpid(void)
6490 uint8_t ea[ETH_ADDR_LEN];
6491 eth_addr_nicira_random(ea);
6492 return eth_addr_to_uint64(ea);
6495 /* Table overflow policy. */
6497 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6498 * to NULL if the table is not configured to evict rules or if the table
6499 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6500 * or with no timeouts are not evictable.) */
6502 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
6503 OVS_REQUIRES(ofproto_mutex)
6505 struct eviction_group *evg;
6508 if (!table->eviction_fields) {
6512 /* In the common case, the outer and inner loops here will each be entered
6515 * - The inner loop normally "return"s in its first iteration. If the
6516 * eviction group has any evictable rules, then it always returns in
6519 * - The outer loop only iterates more than once if the largest eviction
6520 * group has no evictable rules.
6522 * - The outer loop can exit only if table's 'max_flows' is all filled up
6523 * by unevictable rules. */
6524 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
6527 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
6536 /* Searches 'ofproto' for tables that have more flows than their configured
6537 * maximum and that have flow eviction enabled, and evicts as many flows as
6538 * necessary and currently feasible from them.
6540 * This triggers only when an OpenFlow table has N flows in it and then the
6541 * client configures a maximum number of flows less than N. */
6543 ofproto_evict(struct ofproto *ofproto)
6545 struct oftable *table;
6547 ovs_mutex_lock(&ofproto_mutex);
6548 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
6549 evict_rules_from_table(ofproto, table, 0);
6551 ovs_mutex_unlock(&ofproto_mutex);
6554 /* Eviction groups. */
6556 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6557 * rules. The priority contains low-order random bits to ensure that eviction
6558 * groups with the same number of rules are prioritized randomly. */
6560 eviction_group_priority(size_t n_rules)
6562 uint16_t size = MIN(UINT16_MAX, n_rules);
6563 return (size << 16) | random_uint16();
6566 /* Updates 'evg', an eviction_group within 'table', following a change that
6567 * adds or removes rules in 'evg'. */
6569 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
6570 OVS_REQUIRES(ofproto_mutex)
6572 heap_change(&table->eviction_groups_by_size, &evg->size_node,
6573 eviction_group_priority(heap_count(&evg->rules)));
6576 /* Destroys 'evg', an eviction_group within 'table':
6578 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6579 * rules themselves, just removes them from the eviction group.)
6581 * - Removes 'evg' from 'table'.
6585 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
6586 OVS_REQUIRES(ofproto_mutex)
6588 while (!heap_is_empty(&evg->rules)) {
6591 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
6592 rule->eviction_group = NULL;
6594 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
6595 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
6596 heap_destroy(&evg->rules);
6600 /* Removes 'rule' from its eviction group, if any. */
6602 eviction_group_remove_rule(struct rule *rule)
6603 OVS_REQUIRES(ofproto_mutex)
6605 if (rule->eviction_group) {
6606 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6607 struct eviction_group *evg = rule->eviction_group;
6609 rule->eviction_group = NULL;
6610 heap_remove(&evg->rules, &rule->evg_node);
6611 if (heap_is_empty(&evg->rules)) {
6612 eviction_group_destroy(table, evg);
6614 eviction_group_resized(table, evg);
6619 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6620 * returns the hash value. */
6622 eviction_group_hash_rule(struct rule *rule)
6623 OVS_REQUIRES(ofproto_mutex)
6625 struct oftable *table = &rule->ofproto->tables[rule->table_id];
6626 const struct mf_subfield *sf;
6630 hash = table->eviction_group_id_basis;
6631 miniflow_expand(&rule->cr.match.flow, &flow);
6632 for (sf = table->eviction_fields;
6633 sf < &table->eviction_fields[table->n_eviction_fields];
6636 if (mf_are_prereqs_ok(sf->field, &flow)) {
6637 union mf_value value;
6639 mf_get_value(sf->field, &flow, &value);
6641 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
6643 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
6644 unsigned int start = sf->ofs + sf->n_bits;
6645 bitwise_zero(&value, sf->field->n_bytes, start,
6646 sf->field->n_bytes * 8 - start);
6648 hash = hash_bytes(&value, sf->field->n_bytes, hash);
6650 hash = hash_int(hash, 0);
6657 /* Returns an eviction group within 'table' with the given 'id', creating one
6659 static struct eviction_group *
6660 eviction_group_find(struct oftable *table, uint32_t id)
6661 OVS_REQUIRES(ofproto_mutex)
6663 struct eviction_group *evg;
6665 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
6669 evg = xmalloc(sizeof *evg);
6670 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
6671 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
6672 eviction_group_priority(0));
6673 heap_init(&evg->rules);
6678 /* Returns an eviction priority for 'rule'. The return value should be
6679 * interpreted so that higher priorities make a rule more attractive candidates
6681 * Called only if have a timeout. */
6683 rule_eviction_priority(struct ofproto *ofproto, struct rule *rule)
6684 OVS_REQUIRES(ofproto_mutex)
6686 long long int expiration = LLONG_MAX;
6687 long long int modified;
6688 uint32_t expiration_offset;
6690 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6691 ovs_mutex_lock(&rule->mutex);
6692 modified = rule->modified;
6693 ovs_mutex_unlock(&rule->mutex);
6695 if (rule->hard_timeout) {
6696 expiration = modified + rule->hard_timeout * 1000;
6698 if (rule->idle_timeout) {
6699 uint64_t packets, bytes;
6701 long long int idle_expiration;
6703 ofproto->ofproto_class->rule_get_stats(rule, &packets, &bytes, &used);
6704 idle_expiration = used + rule->idle_timeout * 1000;
6705 expiration = MIN(expiration, idle_expiration);
6708 if (expiration == LLONG_MAX) {
6712 /* Calculate the time of expiration as a number of (approximate) seconds
6713 * after program startup.
6715 * This should work OK for program runs that last UINT32_MAX seconds or
6716 * less. Therefore, please restart OVS at least once every 136 years. */
6717 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
6719 /* Invert the expiration offset because we're using a max-heap. */
6720 return UINT32_MAX - expiration_offset;
6723 /* Adds 'rule' to an appropriate eviction group for its oftable's
6724 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6725 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6728 * The caller must ensure that 'rule' is not already in an eviction group. */
6730 eviction_group_add_rule(struct rule *rule)
6731 OVS_REQUIRES(ofproto_mutex)
6733 struct ofproto *ofproto = rule->ofproto;
6734 struct oftable *table = &ofproto->tables[rule->table_id];
6737 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6738 * so no additional protection is needed. */
6739 has_timeout = rule->hard_timeout || rule->idle_timeout;
6741 if (table->eviction_fields && has_timeout) {
6742 struct eviction_group *evg;
6744 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6746 rule->eviction_group = evg;
6747 heap_insert(&evg->rules, &rule->evg_node,
6748 rule_eviction_priority(ofproto, rule));
6749 eviction_group_resized(table, evg);
6755 /* Initializes 'table'. */
6757 oftable_init(struct oftable *table)
6759 memset(table, 0, sizeof *table);
6760 classifier_init(&table->cls, flow_segment_u32s);
6761 table->max_flows = UINT_MAX;
6762 atomic_init(&table->config, (unsigned int)OFPROTO_TABLE_MISS_DEFAULT);
6765 /* Destroys 'table', including its classifier and eviction groups.
6767 * The caller is responsible for freeing 'table' itself. */
6769 oftable_destroy(struct oftable *table)
6771 fat_rwlock_rdlock(&table->cls.rwlock);
6772 ovs_assert(classifier_is_empty(&table->cls));
6773 fat_rwlock_unlock(&table->cls.rwlock);
6774 oftable_disable_eviction(table);
6775 classifier_destroy(&table->cls);
6779 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6780 * string, then 'table' will use its default name.
6782 * This only affects the name exposed for a table exposed through the OpenFlow
6783 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6785 oftable_set_name(struct oftable *table, const char *name)
6787 if (name && name[0]) {
6788 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6789 if (!table->name || strncmp(name, table->name, len)) {
6791 table->name = xmemdup0(name, len);
6799 /* oftables support a choice of two policies when adding a rule would cause the
6800 * number of flows in the table to exceed the configured maximum number: either
6801 * they can refuse to add the new flow or they can evict some existing flow.
6802 * This function configures the former policy on 'table'. */
6804 oftable_disable_eviction(struct oftable *table)
6805 OVS_REQUIRES(ofproto_mutex)
6807 if (table->eviction_fields) {
6808 struct eviction_group *evg, *next;
6810 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6811 &table->eviction_groups_by_id) {
6812 eviction_group_destroy(table, evg);
6814 hmap_destroy(&table->eviction_groups_by_id);
6815 heap_destroy(&table->eviction_groups_by_size);
6817 free(table->eviction_fields);
6818 table->eviction_fields = NULL;
6819 table->n_eviction_fields = 0;
6823 /* oftables support a choice of two policies when adding a rule would cause the
6824 * number of flows in the table to exceed the configured maximum number: either
6825 * they can refuse to add the new flow or they can evict some existing flow.
6826 * This function configures the latter policy on 'table', with fairness based
6827 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6828 * 'n_fields' as 0 disables fairness.) */
6830 oftable_enable_eviction(struct oftable *table,
6831 const struct mf_subfield *fields, size_t n_fields)
6832 OVS_REQUIRES(ofproto_mutex)
6834 struct cls_cursor cursor;
6837 if (table->eviction_fields
6838 && n_fields == table->n_eviction_fields
6840 || !memcmp(fields, table->eviction_fields,
6841 n_fields * sizeof *fields))) {
6846 oftable_disable_eviction(table);
6848 table->n_eviction_fields = n_fields;
6849 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6851 table->eviction_group_id_basis = random_uint32();
6852 hmap_init(&table->eviction_groups_by_id);
6853 heap_init(&table->eviction_groups_by_size);
6855 fat_rwlock_rdlock(&table->cls.rwlock);
6856 cls_cursor_init(&cursor, &table->cls, NULL);
6857 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6858 eviction_group_add_rule(rule);
6860 fat_rwlock_unlock(&table->cls.rwlock);
6863 /* Removes 'rule' from the oftable that contains it. */
6865 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6866 OVS_REQUIRES(ofproto_mutex)
6868 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6870 fat_rwlock_wrlock(&cls->rwlock);
6871 classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6872 fat_rwlock_unlock(&cls->rwlock);
6874 cookies_remove(ofproto, rule);
6876 eviction_group_remove_rule(rule);
6877 if (!list_is_empty(&rule->expirable)) {
6878 list_remove(&rule->expirable);
6880 if (!list_is_empty(&rule->meter_list_node)) {
6881 list_remove(&rule->meter_list_node);
6882 list_init(&rule->meter_list_node);
6887 oftable_remove_rule(struct rule *rule)
6888 OVS_REQUIRES(ofproto_mutex)
6890 oftable_remove_rule__(rule->ofproto, rule);
6893 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6894 * the same cls_rule. */
6896 oftable_insert_rule(struct rule *rule)
6897 OVS_REQUIRES(ofproto_mutex)
6899 struct ofproto *ofproto = rule->ofproto;
6900 struct oftable *table = &ofproto->tables[rule->table_id];
6901 const struct rule_actions *actions;
6904 ovs_mutex_lock(&rule->mutex);
6905 may_expire = rule->hard_timeout || rule->idle_timeout;
6906 ovs_mutex_unlock(&rule->mutex);
6909 list_insert(&ofproto->expirable, &rule->expirable);
6912 cookies_insert(ofproto, rule);
6914 actions = rule_get_actions(rule);
6915 if (actions->provider_meter_id != UINT32_MAX) {
6916 uint32_t meter_id = ofpacts_get_meter(actions->ofpacts,
6917 actions->ofpacts_len);
6918 struct meter *meter = ofproto->meters[meter_id];
6919 list_insert(&meter->rules, &rule->meter_list_node);
6921 fat_rwlock_wrlock(&table->cls.rwlock);
6922 classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6923 fat_rwlock_unlock(&table->cls.rwlock);
6924 eviction_group_add_rule(rule);
6927 /* unixctl commands. */
6930 ofproto_lookup(const char *name)
6932 struct ofproto *ofproto;
6934 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6936 if (!strcmp(ofproto->name, name)) {
6944 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6945 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6947 struct ofproto *ofproto;
6951 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6952 ds_put_format(&results, "%s\n", ofproto->name);
6954 unixctl_command_reply(conn, ds_cstr(&results));
6955 ds_destroy(&results);
6959 ofproto_unixctl_init(void)
6961 static bool registered;
6967 unixctl_command_register("ofproto/list", "", 0, 0,
6968 ofproto_unixctl_list, NULL);
6971 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6973 * This is deprecated. It is only for compatibility with broken device drivers
6974 * in old versions of Linux that do not properly support VLANs when VLAN
6975 * devices are not used. When broken device drivers are no longer in
6976 * widespread use, we will delete these interfaces. */
6978 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6979 * (exactly) by an OpenFlow rule in 'ofproto'. */
6981 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6984 struct cls_rule target;
6985 const struct oftable *oftable;
6987 match_init_catchall(&match);
6988 match_set_vlan_vid_masked(&match, htons(VLAN_CFI), htons(VLAN_CFI));
6989 cls_rule_init(&target, &match, 0);
6991 free(ofproto->vlan_bitmap);
6992 ofproto->vlan_bitmap = bitmap_allocate(4096);
6993 ofproto->vlans_changed = false;
6995 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6996 struct cls_cursor cursor;
6999 fat_rwlock_rdlock(&oftable->cls.rwlock);
7000 cls_cursor_init(&cursor, &oftable->cls, &target);
7001 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
7002 if (minimask_get_vid_mask(&rule->cr.match.mask) == VLAN_VID_MASK) {
7003 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
7005 bitmap_set1(vlan_bitmap, vid);
7006 bitmap_set1(ofproto->vlan_bitmap, vid);
7009 fat_rwlock_unlock(&oftable->cls.rwlock);
7013 /* Returns true if new VLANs have come into use by the flow table since the
7014 * last call to ofproto_get_vlan_usage().
7016 * We don't track when old VLANs stop being used. */
7018 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
7020 return ofproto->vlans_changed;
7023 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7024 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7025 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7026 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7027 * then the VLAN device is un-enslaved. */
7029 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
7030 ofp_port_t realdev_ofp_port, int vid)
7032 struct ofport *ofport;
7035 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
7037 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
7039 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
7040 ofproto->name, vlandev_ofp_port);
7044 if (!ofproto->ofproto_class->set_realdev) {
7045 if (!vlandev_ofp_port) {
7048 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
7052 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
7054 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
7055 ofproto->name, vlandev_ofp_port,
7056 netdev_get_name(ofport->netdev), ovs_strerror(error));