2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
26 #include "byte-order.h"
27 #include "classifier.h"
30 #include "dynamic-string.h"
33 #include "meta-flow.h"
36 #include "ofp-actions.h"
37 #include "ofp-errors.h"
39 #include "ofp-print.h"
42 #include "ofproto-provider.h"
43 #include "openflow/nicira-ext.h"
44 #include "openflow/openflow.h"
48 #include "poll-loop.h"
54 #include "unaligned.h"
58 VLOG_DEFINE_THIS_MODULE(ofproto);
60 COVERAGE_DEFINE(ofproto_error);
61 COVERAGE_DEFINE(ofproto_flush);
62 COVERAGE_DEFINE(ofproto_no_packet_in);
63 COVERAGE_DEFINE(ofproto_packet_out);
64 COVERAGE_DEFINE(ofproto_queue_req);
65 COVERAGE_DEFINE(ofproto_recv_openflow);
66 COVERAGE_DEFINE(ofproto_reinit_ports);
67 COVERAGE_DEFINE(ofproto_uninstallable);
68 COVERAGE_DEFINE(ofproto_update_port);
71 S_OPENFLOW, /* Processing OpenFlow commands. */
72 S_EVICT, /* Evicting flows from over-limit tables. */
73 S_FLUSH, /* Deleting all flow table rules. */
76 enum ofoperation_type {
83 /* A single OpenFlow request can execute any number of operations. The
84 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
85 * ofconn to which an error reply should be sent if necessary.
87 * ofproto initiates some operations internally. These operations are still
88 * assigned to groups but will not have an associated ofconn. */
90 struct ofproto *ofproto; /* Owning ofproto. */
91 struct list ofproto_node; /* In ofproto's "pending" list. */
92 struct list ops; /* List of "struct ofoperation"s. */
93 int n_running; /* Number of ops still pending. */
95 /* Data needed to send OpenFlow reply on failure or to send a buffered
98 * If list_is_empty(ofconn_node) then this ofopgroup never had an
99 * associated ofconn or its ofconn's connection dropped after it initiated
100 * the operation. In the latter case 'ofconn' is a wild pointer that
101 * refers to freed memory, so the 'ofconn' member must be used only if
102 * !list_is_empty(ofconn_node).
104 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
105 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
106 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
107 uint32_t buffer_id; /* Buffer id from original request. */
110 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
111 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
112 const struct ofp_header *,
114 static void ofopgroup_submit(struct ofopgroup *);
115 static void ofopgroup_complete(struct ofopgroup *);
117 /* A single flow table operation. */
119 struct ofopgroup *group; /* Owning group. */
120 struct list group_node; /* In ofopgroup's "ops" list. */
121 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
122 struct rule *rule; /* Rule being operated upon. */
123 enum ofoperation_type type; /* Type of operation. */
125 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
127 struct ofpact *ofpacts;
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_RELEASES(rule->rwlock);
159 static void oftable_remove_rule__(struct ofproto *ofproto,
160 struct classifier *cls, struct rule *rule)
161 OVS_REQ_WRLOCK(cls->rwlock) OVS_RELEASES(rule->rwlock);
162 static void oftable_insert_rule(struct rule *);
164 /* A set of rules within a single OpenFlow table (oftable) that have the same
165 * values for the oftable's eviction_fields. A rule to be evicted, when one is
166 * needed, is taken from the eviction group that contains the greatest number
169 * An oftable owns any number of eviction groups, each of which contains any
172 * Membership in an eviction group is imprecise, based on the hash of the
173 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
174 * That is, if two rules have different eviction_fields, but those
175 * eviction_fields hash to the same value, then they will belong to the same
176 * eviction_group anyway.
178 * (When eviction is not enabled on an oftable, we don't track any eviction
179 * groups, to save time and space.) */
180 struct eviction_group {
181 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
182 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
183 struct heap rules; /* Contains "struct rule"s. */
186 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
187 OVS_TRY_WRLOCK(true, (*rulep)->rwlock);
188 static void ofproto_evict(struct ofproto *);
189 static uint32_t rule_eviction_priority(struct rule *);
190 static void eviction_group_add_rule(struct rule *);
191 static void eviction_group_remove_rule(struct rule *);
194 static void ofport_destroy__(struct ofport *);
195 static void ofport_destroy(struct ofport *);
197 static void update_port(struct ofproto *, const char *devname);
198 static int init_ports(struct ofproto *);
199 static void reinit_ports(struct ofproto *);
202 static void ofproto_rule_destroy(struct rule *);
203 static void ofproto_rule_destroy__(struct rule *);
204 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
205 static bool rule_is_modifiable(const struct rule *);
208 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
209 struct ofputil_flow_mod *,
210 const struct ofp_header *);
211 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
212 struct ofputil_flow_mod *,
213 const struct ofp_header *, struct list *);
214 static void delete_flow__(struct rule *rule, struct ofopgroup *,
215 enum ofp_flow_removed_reason)
216 OVS_RELEASES(rule->rwlock);
217 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
218 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
219 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
220 struct ofputil_flow_mod *,
221 const struct ofp_header *);
222 static void calc_duration(long long int start, long long int now,
223 uint32_t *sec, uint32_t *nsec);
226 static uint64_t pick_datapath_id(const struct ofproto *);
227 static uint64_t pick_fallback_dpid(void);
228 static void ofproto_destroy__(struct ofproto *);
229 static void update_mtu(struct ofproto *, struct ofport *);
230 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
233 static void ofproto_unixctl_init(void);
235 /* All registered ofproto classes, in probe order. */
236 static const struct ofproto_class **ofproto_classes;
237 static size_t n_ofproto_classes;
238 static size_t allocated_ofproto_classes;
240 unsigned flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT;
241 unsigned n_handler_threads;
242 enum ofproto_flow_miss_model flow_miss_model = OFPROTO_HANDLE_MISS_AUTO;
244 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
245 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
247 /* Initial mappings of port to OpenFlow number mappings. */
248 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
250 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
252 /* The default value of true waits for flow restore. */
253 static bool flow_restore_wait = true;
255 /* Must be called to initialize the ofproto library.
257 * The caller may pass in 'iface_hints', which contains an shash of
258 * "iface_hint" elements indexed by the interface's name. The provider
259 * may use these hints to describe the startup configuration in order to
260 * reinitialize its state. The caller owns the provided data, so a
261 * provider will make copies of anything required. An ofproto provider
262 * will remove any existing state that is not described by the hint, and
263 * may choose to remove it all. */
265 ofproto_init(const struct shash *iface_hints)
267 struct shash_node *node;
270 ofproto_class_register(&ofproto_dpif_class);
272 /* Make a local copy, since we don't own 'iface_hints' elements. */
273 SHASH_FOR_EACH(node, iface_hints) {
274 const struct iface_hint *orig_hint = node->data;
275 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
276 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
278 new_hint->br_name = xstrdup(orig_hint->br_name);
279 new_hint->br_type = xstrdup(br_type);
280 new_hint->ofp_port = orig_hint->ofp_port;
282 shash_add(&init_ofp_ports, node->name, new_hint);
285 for (i = 0; i < n_ofproto_classes; i++) {
286 ofproto_classes[i]->init(&init_ofp_ports);
290 /* 'type' should be a normalized datapath type, as returned by
291 * ofproto_normalize_type(). Returns the corresponding ofproto_class
292 * structure, or a null pointer if there is none registered for 'type'. */
293 static const struct ofproto_class *
294 ofproto_class_find__(const char *type)
298 for (i = 0; i < n_ofproto_classes; i++) {
299 const struct ofproto_class *class = ofproto_classes[i];
304 class->enumerate_types(&types);
305 found = sset_contains(&types, type);
306 sset_destroy(&types);
312 VLOG_WARN("unknown datapath type %s", type);
316 /* Registers a new ofproto class. After successful registration, new ofprotos
317 * of that type can be created using ofproto_create(). */
319 ofproto_class_register(const struct ofproto_class *new_class)
323 for (i = 0; i < n_ofproto_classes; i++) {
324 if (ofproto_classes[i] == new_class) {
329 if (n_ofproto_classes >= allocated_ofproto_classes) {
330 ofproto_classes = x2nrealloc(ofproto_classes,
331 &allocated_ofproto_classes,
332 sizeof *ofproto_classes);
334 ofproto_classes[n_ofproto_classes++] = new_class;
338 /* Unregisters a datapath provider. 'type' must have been previously
339 * registered and not currently be in use by any ofprotos. After
340 * unregistration new datapaths of that type cannot be opened using
341 * ofproto_create(). */
343 ofproto_class_unregister(const struct ofproto_class *class)
347 for (i = 0; i < n_ofproto_classes; i++) {
348 if (ofproto_classes[i] == class) {
349 for (i++; i < n_ofproto_classes; i++) {
350 ofproto_classes[i - 1] = ofproto_classes[i];
356 VLOG_WARN("attempted to unregister an ofproto class that is not "
361 /* Clears 'types' and enumerates all registered ofproto types into it. The
362 * caller must first initialize the sset. */
364 ofproto_enumerate_types(struct sset *types)
368 for (i = 0; i < n_ofproto_classes; i++) {
369 ofproto_classes[i]->enumerate_types(types);
373 /* Returns the fully spelled out name for the given ofproto 'type'.
375 * Normalized type string can be compared with strcmp(). Unnormalized type
376 * string might be the same even if they have different spellings. */
378 ofproto_normalize_type(const char *type)
380 return type && type[0] ? type : "system";
383 /* Clears 'names' and enumerates the names of all known created ofprotos with
384 * the given 'type'. The caller must first initialize the sset. Returns 0 if
385 * successful, otherwise a positive errno value.
387 * Some kinds of datapaths might not be practically enumerable. This is not
388 * considered an error. */
390 ofproto_enumerate_names(const char *type, struct sset *names)
392 const struct ofproto_class *class = ofproto_class_find__(type);
393 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
397 ofproto_create(const char *datapath_name, const char *datapath_type,
398 struct ofproto **ofprotop)
400 const struct ofproto_class *class;
401 struct ofproto *ofproto;
407 ofproto_unixctl_init();
409 datapath_type = ofproto_normalize_type(datapath_type);
410 class = ofproto_class_find__(datapath_type);
412 VLOG_WARN("could not create datapath %s of unknown type %s",
413 datapath_name, datapath_type);
417 ofproto = class->alloc();
419 VLOG_ERR("failed to allocate datapath %s of type %s",
420 datapath_name, datapath_type);
425 memset(ofproto, 0, sizeof *ofproto);
426 ofproto->ofproto_class = class;
427 ofproto->name = xstrdup(datapath_name);
428 ofproto->type = xstrdup(datapath_type);
429 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
430 hash_string(ofproto->name, 0));
431 ofproto->datapath_id = 0;
432 ofproto->forward_bpdu = false;
433 ofproto->fallback_dpid = pick_fallback_dpid();
434 ofproto->mfr_desc = NULL;
435 ofproto->hw_desc = NULL;
436 ofproto->sw_desc = NULL;
437 ofproto->serial_desc = NULL;
438 ofproto->dp_desc = NULL;
439 ofproto->frag_handling = OFPC_FRAG_NORMAL;
440 hmap_init(&ofproto->ports);
441 shash_init(&ofproto->port_by_name);
442 simap_init(&ofproto->ofp_requests);
443 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
444 ofproto->eviction_group_timer = LLONG_MIN;
445 ofproto->tables = NULL;
446 ofproto->n_tables = 0;
447 hindex_init(&ofproto->cookies);
448 list_init(&ofproto->expirable);
449 ovs_mutex_init_recursive(&ofproto->expirable_mutex);
450 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
451 ofproto->state = S_OPENFLOW;
452 list_init(&ofproto->pending);
453 ofproto->n_pending = 0;
454 hmap_init(&ofproto->deletions);
455 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
456 ofproto->first_op = ofproto->last_op = LLONG_MIN;
457 ofproto->next_op_report = LLONG_MAX;
458 ofproto->op_backoff = LLONG_MIN;
459 ofproto->vlan_bitmap = NULL;
460 ofproto->vlans_changed = false;
461 ofproto->min_mtu = INT_MAX;
462 ovs_rwlock_init(&ofproto->groups_rwlock);
463 hmap_init(&ofproto->groups);
465 error = ofproto->ofproto_class->construct(ofproto);
467 VLOG_ERR("failed to open datapath %s: %s",
468 datapath_name, ovs_strerror(error));
469 ofproto_destroy__(ofproto);
473 /* The "max_ports" member should have been set by ->construct(ofproto).
474 * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
475 ofproto->ofp_port_ids = bitmap_allocate(ofproto->max_ports);
476 bitmap_set1(ofproto->ofp_port_ids, 0);
478 /* Check that hidden tables, if any, are at the end. */
479 ovs_assert(ofproto->n_tables);
480 for (i = 0; i + 1 < ofproto->n_tables; i++) {
481 enum oftable_flags flags = ofproto->tables[i].flags;
482 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
484 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
487 ofproto->datapath_id = pick_datapath_id(ofproto);
490 /* Initialize meters table. */
491 if (ofproto->ofproto_class->meter_get_features) {
492 ofproto->ofproto_class->meter_get_features(ofproto,
493 &ofproto->meter_features);
495 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
497 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
498 * sizeof(struct meter *));
504 /* Must be called (only) by an ofproto implementation in its constructor
505 * function. See the large comment on 'construct' in struct ofproto_class for
508 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
510 struct oftable *table;
512 ovs_assert(!ofproto->n_tables);
513 ovs_assert(n_tables >= 1 && n_tables <= 255);
515 ofproto->n_tables = n_tables;
516 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
517 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
522 /* To be optionally called (only) by an ofproto implementation in its
523 * constructor function. See the large comment on 'construct' in struct
524 * ofproto_class for details.
526 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
527 * will then ensure that actions passed into the ofproto implementation will
528 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
529 * function is not called, there will be no such restriction.
531 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
532 * the 'max_ports' restriction. */
534 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
536 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
537 ofproto->max_ports = max_ports;
541 ofproto_get_datapath_id(const struct ofproto *ofproto)
543 return ofproto->datapath_id;
547 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
549 uint64_t old_dpid = p->datapath_id;
550 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
551 if (p->datapath_id != old_dpid) {
552 /* Force all active connections to reconnect, since there is no way to
553 * notify a controller that the datapath ID has changed. */
554 ofproto_reconnect_controllers(p);
559 ofproto_set_controllers(struct ofproto *p,
560 const struct ofproto_controller *controllers,
561 size_t n_controllers, uint32_t allowed_versions)
563 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
568 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
570 connmgr_set_fail_mode(p->connmgr, fail_mode);
573 /* Drops the connections between 'ofproto' and all of its controllers, forcing
574 * them to reconnect. */
576 ofproto_reconnect_controllers(struct ofproto *ofproto)
578 connmgr_reconnect(ofproto->connmgr);
581 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
582 * in-band control should guarantee access, in the same way that in-band
583 * control guarantees access to OpenFlow controllers. */
585 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
586 const struct sockaddr_in *extras, size_t n)
588 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
591 /* Sets the OpenFlow queue used by flows set up by in-band control on
592 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
593 * flows will use the default queue. */
595 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
597 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
600 /* Sets the number of flows at which eviction from the kernel flow table
603 ofproto_set_flow_eviction_threshold(unsigned threshold)
605 flow_eviction_threshold = MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN,
609 /* Sets the path for handling flow misses. */
611 ofproto_set_flow_miss_model(unsigned model)
613 flow_miss_model = model;
616 /* If forward_bpdu is true, the NORMAL action will forward frames with
617 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
618 * the NORMAL action will drop these frames. */
620 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
622 bool old_val = ofproto->forward_bpdu;
623 ofproto->forward_bpdu = forward_bpdu;
624 if (old_val != ofproto->forward_bpdu) {
625 if (ofproto->ofproto_class->forward_bpdu_changed) {
626 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
631 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
632 * 'idle_time', in seconds, and the maximum number of MAC table entries to
635 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
638 if (ofproto->ofproto_class->set_mac_table_config) {
639 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
644 /* Sets number of upcall handler threads. The default is
645 * (number of online cores - 2). */
647 ofproto_set_n_handler_threads(unsigned limit)
650 n_handler_threads = limit;
652 int n_proc = sysconf(_SC_NPROCESSORS_ONLN);
653 n_handler_threads = n_proc > 2 ? n_proc - 2 : 1;
658 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
661 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
665 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
667 return connmgr_set_snoops(ofproto->connmgr, snoops);
671 ofproto_set_netflow(struct ofproto *ofproto,
672 const struct netflow_options *nf_options)
674 if (nf_options && sset_is_empty(&nf_options->collectors)) {
678 if (ofproto->ofproto_class->set_netflow) {
679 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
681 return nf_options ? EOPNOTSUPP : 0;
686 ofproto_set_sflow(struct ofproto *ofproto,
687 const struct ofproto_sflow_options *oso)
689 if (oso && sset_is_empty(&oso->targets)) {
693 if (ofproto->ofproto_class->set_sflow) {
694 return ofproto->ofproto_class->set_sflow(ofproto, oso);
696 return oso ? EOPNOTSUPP : 0;
701 ofproto_set_ipfix(struct ofproto *ofproto,
702 const struct ofproto_ipfix_bridge_exporter_options *bo,
703 const struct ofproto_ipfix_flow_exporter_options *fo,
706 if (ofproto->ofproto_class->set_ipfix) {
707 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
709 return (bo || fo) ? EOPNOTSUPP : 0;
714 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
716 flow_restore_wait = flow_restore_wait_db;
720 ofproto_get_flow_restore_wait(void)
722 return flow_restore_wait;
726 /* Spanning Tree Protocol (STP) configuration. */
728 /* Configures STP on 'ofproto' using the settings defined in 's'. If
729 * 's' is NULL, disables STP.
731 * Returns 0 if successful, otherwise a positive errno value. */
733 ofproto_set_stp(struct ofproto *ofproto,
734 const struct ofproto_stp_settings *s)
736 return (ofproto->ofproto_class->set_stp
737 ? ofproto->ofproto_class->set_stp(ofproto, s)
741 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
742 * 'enabled' member of 's' is false, then the other members are not
745 * Returns 0 if successful, otherwise a positive errno value. */
747 ofproto_get_stp_status(struct ofproto *ofproto,
748 struct ofproto_stp_status *s)
750 return (ofproto->ofproto_class->get_stp_status
751 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
755 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
756 * in 's'. The caller is responsible for assigning STP port numbers
757 * (using the 'port_num' member in the range of 1 through 255, inclusive)
758 * and ensuring there are no duplicates. If the 's' is NULL, then STP
759 * is disabled on the port.
761 * Returns 0 if successful, otherwise a positive errno value.*/
763 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
764 const struct ofproto_port_stp_settings *s)
766 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
768 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
769 ofproto->name, ofp_port);
773 return (ofproto->ofproto_class->set_stp_port
774 ? ofproto->ofproto_class->set_stp_port(ofport, s)
778 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
779 * 's'. If the 'enabled' member in 's' is false, then the other members
780 * are not meaningful.
782 * Returns 0 if successful, otherwise a positive errno value.*/
784 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
785 struct ofproto_port_stp_status *s)
787 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
789 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
790 "port %"PRIu16, ofproto->name, ofp_port);
794 return (ofproto->ofproto_class->get_stp_port_status
795 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
799 /* Queue DSCP configuration. */
801 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
802 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
803 * to implement QoS. Instead, it is used to implement features which require
804 * knowledge of what queues exist on a port, and some basic information about
807 * Returns 0 if successful, otherwise a positive errno value. */
809 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
810 const struct ofproto_port_queue *queues,
813 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
816 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
817 ofproto->name, ofp_port);
821 return (ofproto->ofproto_class->set_queues
822 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
826 /* Connectivity Fault Management configuration. */
828 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
830 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
832 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
833 if (ofport && ofproto->ofproto_class->set_cfm) {
834 ofproto->ofproto_class->set_cfm(ofport, NULL);
838 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
839 * basic configuration from the configuration members in 'cfm', and the remote
840 * maintenance point ID from remote_mpid. Ignores the statistics members of
843 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
845 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
846 const struct cfm_settings *s)
848 struct ofport *ofport;
851 ofport = ofproto_get_port(ofproto, ofp_port);
853 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
854 ofproto->name, ofp_port);
858 /* XXX: For configuration simplicity, we only support one remote_mpid
859 * outside of the CFM module. It's not clear if this is the correct long
860 * term solution or not. */
861 error = (ofproto->ofproto_class->set_cfm
862 ? ofproto->ofproto_class->set_cfm(ofport, s)
865 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
866 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
867 ovs_strerror(error));
871 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
872 * 'ofproto' does not have a port 'ofp_port'. */
874 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
875 const struct smap *cfg)
877 struct ofport *ofport;
880 ofport = ofproto_get_port(ofproto, ofp_port);
882 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
883 ofproto->name, ofp_port);
887 error = (ofproto->ofproto_class->set_bfd
888 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
891 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
892 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
893 ovs_strerror(error));
897 /* Populates 'status' with key value pairs indicating the status of the BFD
898 * session on 'ofp_port'. This information is intended to be populated in the
899 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
902 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
905 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
906 return (ofport && ofproto->ofproto_class->get_bfd_status
907 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
911 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
912 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
913 * 0 if LACP partner information is not current (generally indicating a
914 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
916 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
918 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
919 return (ofport && ofproto->ofproto_class->port_is_lacp_current
920 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
926 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
927 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
928 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
929 * configuration plus, if there is more than one slave, a bonding
932 * If 'aux' is already registered then this function updates its configuration
933 * to 's'. Otherwise, this function registers a new bundle.
935 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
938 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
939 const struct ofproto_bundle_settings *s)
941 return (ofproto->ofproto_class->bundle_set
942 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
946 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
947 * If no such bundle has been registered, this has no effect. */
949 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
951 return ofproto_bundle_register(ofproto, aux, NULL);
955 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
956 * If 'aux' is already registered then this function updates its configuration
957 * to 's'. Otherwise, this function registers a new mirror. */
959 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
960 const struct ofproto_mirror_settings *s)
962 return (ofproto->ofproto_class->mirror_set
963 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
967 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
968 * If no mirror has been registered, this has no effect. */
970 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
972 return ofproto_mirror_register(ofproto, aux, NULL);
975 /* Retrieves statistics from mirror associated with client data pointer
976 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
977 * 'bytes', respectively. If a particular counters is not supported,
978 * the appropriate argument is set to UINT64_MAX. */
980 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
981 uint64_t *packets, uint64_t *bytes)
983 if (!ofproto->ofproto_class->mirror_get_stats) {
984 *packets = *bytes = UINT64_MAX;
988 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
992 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
993 * which all packets are flooded, instead of using MAC learning. If
994 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
996 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
999 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1001 return (ofproto->ofproto_class->set_flood_vlans
1002 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1006 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1007 * output for a mirror. */
1009 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1011 return (ofproto->ofproto_class->is_mirror_output_bundle
1012 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1016 /* Configuration of OpenFlow tables. */
1018 /* Returns the number of OpenFlow tables in 'ofproto'. */
1020 ofproto_get_n_tables(const struct ofproto *ofproto)
1022 return ofproto->n_tables;
1025 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1026 * settings from 's'. 'table_id' must be in the range 0 through the number of
1027 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1029 * For read-only tables, only the name may be configured. */
1031 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1032 const struct ofproto_table_settings *s)
1034 struct oftable *table;
1036 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1037 table = &ofproto->tables[table_id];
1039 oftable_set_name(table, s->name);
1041 if (table->flags & OFTABLE_READONLY) {
1046 oftable_enable_eviction(table, s->groups, s->n_groups);
1048 oftable_disable_eviction(table);
1051 table->max_flows = s->max_flows;
1052 ovs_rwlock_rdlock(&table->cls.rwlock);
1053 if (classifier_count(&table->cls) > table->max_flows
1054 && table->eviction_fields) {
1055 /* 'table' contains more flows than allowed. We might not be able to
1056 * evict them right away because of the asynchronous nature of flow
1057 * table changes. Schedule eviction for later. */
1058 switch (ofproto->state) {
1060 ofproto->state = S_EVICT;
1064 /* We're already deleting flows, nothing more to do. */
1068 ovs_rwlock_unlock(&table->cls.rwlock);
1072 ofproto_has_snoops(const struct ofproto *ofproto)
1074 return connmgr_has_snoops(ofproto->connmgr);
1078 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1080 connmgr_get_snoops(ofproto->connmgr, snoops);
1083 /* Deletes 'rule' from 'cls' within 'ofproto'.
1085 * The 'cls' argument is redundant (it is &ofproto->tables[rule->table_id].cls)
1086 * but it allows Clang to do better checking. */
1088 ofproto_delete_rule(struct ofproto *ofproto, struct classifier *cls,
1090 OVS_REQ_WRLOCK(cls->rwlock)
1092 struct ofopgroup *group;
1094 ovs_assert(!rule->pending);
1095 ovs_assert(cls == &ofproto->tables[rule->table_id].cls);
1097 group = ofopgroup_create_unattached(ofproto);
1098 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1099 ovs_rwlock_wrlock(&rule->rwlock);
1100 oftable_remove_rule__(ofproto, cls, rule);
1101 ofproto->ofproto_class->rule_delete(rule);
1102 ofopgroup_submit(group);
1106 ofproto_flush__(struct ofproto *ofproto)
1108 struct oftable *table;
1110 if (ofproto->ofproto_class->flush) {
1111 ofproto->ofproto_class->flush(ofproto);
1114 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1115 struct rule *rule, *next_rule;
1116 struct cls_cursor cursor;
1118 if (table->flags & OFTABLE_HIDDEN) {
1122 ovs_rwlock_wrlock(&table->cls.rwlock);
1123 cls_cursor_init(&cursor, &table->cls, NULL);
1124 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1125 if (!rule->pending) {
1126 ofproto_delete_rule(ofproto, &table->cls, rule);
1129 ovs_rwlock_unlock(&table->cls.rwlock);
1133 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1136 ofproto_destroy__(struct ofproto *ofproto)
1138 struct oftable *table;
1140 ovs_assert(list_is_empty(&ofproto->pending));
1141 ovs_assert(!ofproto->n_pending);
1143 if (ofproto->meters) {
1144 meter_delete(ofproto, 1, ofproto->meter_features.max_meters);
1145 free(ofproto->meters);
1148 delete_group(ofproto, OFPG_ALL);
1149 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1150 hmap_destroy(&ofproto->groups);
1152 connmgr_destroy(ofproto->connmgr);
1154 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1155 free(ofproto->name);
1156 free(ofproto->type);
1157 free(ofproto->mfr_desc);
1158 free(ofproto->hw_desc);
1159 free(ofproto->sw_desc);
1160 free(ofproto->serial_desc);
1161 free(ofproto->dp_desc);
1162 hmap_destroy(&ofproto->ports);
1163 shash_destroy(&ofproto->port_by_name);
1164 bitmap_free(ofproto->ofp_port_ids);
1165 simap_destroy(&ofproto->ofp_requests);
1167 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1168 oftable_destroy(table);
1170 free(ofproto->tables);
1172 hmap_destroy(&ofproto->deletions);
1174 free(ofproto->vlan_bitmap);
1176 ovs_mutex_destroy(&ofproto->expirable_mutex);
1177 ofproto->ofproto_class->dealloc(ofproto);
1181 ofproto_destroy(struct ofproto *p)
1183 struct ofport *ofport, *next_ofport;
1190 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1191 ofport_destroy(ofport);
1194 p->ofproto_class->destruct(p);
1195 ofproto_destroy__(p);
1198 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1199 * kernel datapath, for example, this destroys the datapath in the kernel, and
1200 * with the netdev-based datapath, it tears down the data structures that
1201 * represent the datapath.
1203 * The datapath should not be currently open as an ofproto. */
1205 ofproto_delete(const char *name, const char *type)
1207 const struct ofproto_class *class = ofproto_class_find__(type);
1208 return (!class ? EAFNOSUPPORT
1209 : !class->del ? EACCES
1210 : class->del(type, name));
1214 process_port_change(struct ofproto *ofproto, int error, char *devname)
1216 if (error == ENOBUFS) {
1217 reinit_ports(ofproto);
1218 } else if (!error) {
1219 update_port(ofproto, devname);
1225 ofproto_type_run(const char *datapath_type)
1227 const struct ofproto_class *class;
1230 datapath_type = ofproto_normalize_type(datapath_type);
1231 class = ofproto_class_find__(datapath_type);
1233 error = class->type_run ? class->type_run(datapath_type) : 0;
1234 if (error && error != EAGAIN) {
1235 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1236 datapath_type, ovs_strerror(error));
1242 ofproto_type_run_fast(const char *datapath_type)
1244 const struct ofproto_class *class;
1247 datapath_type = ofproto_normalize_type(datapath_type);
1248 class = ofproto_class_find__(datapath_type);
1250 error = class->type_run_fast ? class->type_run_fast(datapath_type) : 0;
1251 if (error && error != EAGAIN) {
1252 VLOG_ERR_RL(&rl, "%s: type_run_fast failed (%s)",
1253 datapath_type, ovs_strerror(error));
1259 ofproto_type_wait(const char *datapath_type)
1261 const struct ofproto_class *class;
1263 datapath_type = ofproto_normalize_type(datapath_type);
1264 class = ofproto_class_find__(datapath_type);
1266 if (class->type_wait) {
1267 class->type_wait(datapath_type);
1272 ofproto_run(struct ofproto *p)
1274 struct sset changed_netdevs;
1275 const char *changed_netdev;
1276 struct ofport *ofport;
1279 error = p->ofproto_class->run(p);
1280 if (error && error != EAGAIN) {
1281 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1284 /* Restore the eviction group heap invariant occasionally. */
1285 if (p->eviction_group_timer < time_msec()) {
1288 p->eviction_group_timer = time_msec() + 1000;
1290 for (i = 0; i < p->n_tables; i++) {
1291 struct oftable *table = &p->tables[i];
1292 struct eviction_group *evg;
1293 struct cls_cursor cursor;
1296 if (!table->eviction_fields) {
1300 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1301 heap_rebuild(&evg->rules);
1304 ovs_rwlock_rdlock(&table->cls.rwlock);
1305 cls_cursor_init(&cursor, &table->cls, NULL);
1306 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1307 if (!rule->eviction_group
1308 && (rule->idle_timeout || rule->hard_timeout)) {
1309 eviction_group_add_rule(rule);
1312 ovs_rwlock_unlock(&table->cls.rwlock);
1316 if (p->ofproto_class->port_poll) {
1319 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1320 process_port_change(p, error, devname);
1324 /* Update OpenFlow port status for any port whose netdev has changed.
1326 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1327 * destroyed, so it's not safe to update ports directly from the
1328 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1329 * need this two-phase approach. */
1330 sset_init(&changed_netdevs);
1331 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1332 unsigned int change_seq = netdev_change_seq(ofport->netdev);
1333 if (ofport->change_seq != change_seq) {
1334 ofport->change_seq = change_seq;
1335 sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1338 SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1339 update_port(p, changed_netdev);
1341 sset_destroy(&changed_netdevs);
1345 connmgr_run(p->connmgr, handle_openflow);
1349 connmgr_run(p->connmgr, NULL);
1351 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1352 p->state = S_OPENFLOW;
1357 connmgr_run(p->connmgr, NULL);
1359 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1360 connmgr_flushed(p->connmgr);
1361 p->state = S_OPENFLOW;
1369 if (time_msec() >= p->next_op_report) {
1370 long long int ago = (time_msec() - p->first_op) / 1000;
1371 long long int interval = (p->last_op - p->first_op) / 1000;
1375 ds_put_format(&s, "%d flow_mods ",
1376 p->n_add + p->n_delete + p->n_modify);
1377 if (interval == ago) {
1378 ds_put_format(&s, "in the last %lld s", ago);
1379 } else if (interval) {
1380 ds_put_format(&s, "in the %lld s starting %lld s ago",
1383 ds_put_format(&s, "%lld s ago", ago);
1386 ds_put_cstr(&s, " (");
1388 ds_put_format(&s, "%d adds, ", p->n_add);
1391 ds_put_format(&s, "%d deletes, ", p->n_delete);
1394 ds_put_format(&s, "%d modifications, ", p->n_modify);
1397 ds_put_char(&s, ')');
1399 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1402 p->n_add = p->n_delete = p->n_modify = 0;
1403 p->next_op_report = LLONG_MAX;
1409 /* Performs periodic activity required by 'ofproto' that needs to be done
1410 * with the least possible latency.
1412 * It makes sense to call this function a couple of times per poll loop, to
1413 * provide a significant performance boost on some benchmarks with the
1414 * ofproto-dpif implementation. */
1416 ofproto_run_fast(struct ofproto *p)
1420 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1421 if (error && error != EAGAIN) {
1422 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1423 p->name, ovs_strerror(error));
1429 ofproto_wait(struct ofproto *p)
1431 struct ofport *ofport;
1433 p->ofproto_class->wait(p);
1434 if (p->ofproto_class->port_poll_wait) {
1435 p->ofproto_class->port_poll_wait(p);
1438 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1439 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1440 poll_immediate_wake();
1446 connmgr_wait(p->connmgr, true);
1451 connmgr_wait(p->connmgr, false);
1452 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1453 poll_immediate_wake();
1460 ofproto_is_alive(const struct ofproto *p)
1462 return connmgr_has_controllers(p->connmgr);
1465 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1466 * memory_report(). */
1468 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1470 const struct oftable *table;
1471 unsigned int n_rules;
1473 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1474 simap_increase(usage, "ops",
1475 ofproto->n_pending + hmap_count(&ofproto->deletions));
1478 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1479 ovs_rwlock_rdlock(&table->cls.rwlock);
1480 n_rules += classifier_count(&table->cls);
1481 ovs_rwlock_unlock(&table->cls.rwlock);
1483 simap_increase(usage, "rules", n_rules);
1485 if (ofproto->ofproto_class->get_memory_usage) {
1486 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1489 connmgr_get_memory_usage(ofproto->connmgr, usage);
1493 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1496 connmgr_get_controller_info(ofproto->connmgr, info);
1500 ofproto_free_ofproto_controller_info(struct shash *info)
1502 connmgr_free_controller_info(info);
1505 /* Makes a deep copy of 'old' into 'port'. */
1507 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1509 port->name = xstrdup(old->name);
1510 port->type = xstrdup(old->type);
1511 port->ofp_port = old->ofp_port;
1514 /* Frees memory allocated to members of 'ofproto_port'.
1516 * Do not call this function on an ofproto_port obtained from
1517 * ofproto_port_dump_next(): that function retains ownership of the data in the
1520 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1522 free(ofproto_port->name);
1523 free(ofproto_port->type);
1526 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1528 * This function provides no status indication. An error status for the entire
1529 * dump operation is provided when it is completed by calling
1530 * ofproto_port_dump_done().
1533 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1534 const struct ofproto *ofproto)
1536 dump->ofproto = ofproto;
1537 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1541 /* Attempts to retrieve another port from 'dump', which must have been created
1542 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1543 * 'port' and returns true. On failure, returns false.
1545 * Failure might indicate an actual error or merely that the last port has been
1546 * dumped. An error status for the entire dump operation is provided when it
1547 * is completed by calling ofproto_port_dump_done().
1549 * The ofproto owns the data stored in 'port'. It will remain valid until at
1550 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1551 * ofproto_port_dump_done(). */
1553 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1554 struct ofproto_port *port)
1556 const struct ofproto *ofproto = dump->ofproto;
1562 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1565 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1571 /* Completes port table dump operation 'dump', which must have been created
1572 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1573 * error-free, otherwise a positive errno value describing the problem. */
1575 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1577 const struct ofproto *ofproto = dump->ofproto;
1579 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1582 return dump->error == EOF ? 0 : dump->error;
1585 /* Returns the type to pass to netdev_open() when a datapath of type
1586 * 'datapath_type' has a port of type 'port_type', for a few special
1587 * cases when a netdev type differs from a port type. For example, when
1588 * using the userspace datapath, a port of type "internal" needs to be
1591 * Returns either 'type' itself or a string literal, which must not be
1594 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1596 const struct ofproto_class *class;
1598 datapath_type = ofproto_normalize_type(datapath_type);
1599 class = ofproto_class_find__(datapath_type);
1604 return (class->port_open_type
1605 ? class->port_open_type(datapath_type, port_type)
1609 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1610 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1611 * the port's OpenFlow port number.
1613 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1614 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1615 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1616 * 'ofp_portp' is non-null). */
1618 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1619 ofp_port_t *ofp_portp)
1621 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1624 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1626 const char *netdev_name = netdev_get_name(netdev);
1628 simap_put(&ofproto->ofp_requests, netdev_name,
1629 ofp_to_u16(ofp_port));
1630 update_port(ofproto, netdev_name);
1633 struct ofproto_port ofproto_port;
1635 ofproto_port_query_by_name(ofproto, netdev_get_name(netdev),
1637 *ofp_portp = error ? OFPP_NONE : ofproto_port.ofp_port;
1638 ofproto_port_destroy(&ofproto_port);
1643 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1644 * initializes '*port' appropriately; on failure, returns a positive errno
1647 * The caller owns the data in 'ofproto_port' and must free it with
1648 * ofproto_port_destroy() when it is no longer needed. */
1650 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1651 struct ofproto_port *port)
1655 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1657 memset(port, 0, sizeof *port);
1662 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1663 * Returns 0 if successful, otherwise a positive errno. */
1665 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1667 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1668 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1669 struct simap_node *ofp_request_node;
1672 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1673 if (ofp_request_node) {
1674 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1677 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1678 if (!error && ofport) {
1679 /* 'name' is the netdev's name and update_port() is going to close the
1680 * netdev. Just in case update_port() refers to 'name' after it
1681 * destroys 'ofport', make a copy of it around the update_port()
1683 char *devname = xstrdup(name);
1684 update_port(ofproto, devname);
1690 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1691 * performs the 'n_actions' actions in 'actions'. The new flow will not
1694 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1695 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1696 * controllers; otherwise, it will be hidden.
1698 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1700 * This is a helper function for in-band control and fail-open. */
1702 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1703 unsigned int priority,
1704 const struct ofpact *ofpacts, size_t ofpacts_len)
1706 const struct rule *rule;
1708 ovs_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1709 rule = rule_from_cls_rule(classifier_find_match_exactly(
1710 &ofproto->tables[0].cls, match, priority));
1711 ovs_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1712 if (!rule || !ofpacts_equal(rule->ofpacts, rule->ofpacts_len,
1713 ofpacts, ofpacts_len)) {
1714 struct ofputil_flow_mod fm;
1716 memset(&fm, 0, sizeof fm);
1718 fm.priority = priority;
1719 fm.buffer_id = UINT32_MAX;
1720 fm.ofpacts = xmemdup(ofpacts, ofpacts_len);
1721 fm.ofpacts_len = ofpacts_len;
1722 add_flow(ofproto, NULL, &fm, NULL);
1727 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1728 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1729 * operation cannot be initiated now but may be retried later.
1731 * This is a helper function for in-band control and fail-open. */
1733 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1735 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1738 /* Searches for a rule with matching criteria exactly equal to 'target' in
1739 * ofproto's table 0 and, if it finds one, deletes it.
1741 * This is a helper function for in-band control and fail-open. */
1743 ofproto_delete_flow(struct ofproto *ofproto,
1744 const struct match *target, unsigned int priority)
1746 struct classifier *cls = &ofproto->tables[0].cls;
1749 ovs_rwlock_rdlock(&cls->rwlock);
1750 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
1752 ovs_rwlock_unlock(&cls->rwlock);
1754 /* No such rule -> success. */
1756 } else if (rule->pending) {
1757 /* An operation on the rule is already pending -> failure.
1758 * Caller must retry later if it's important. */
1761 /* Initiate deletion -> success. */
1762 ovs_rwlock_wrlock(&cls->rwlock);
1763 ofproto_delete_rule(ofproto, cls, rule);
1764 ovs_rwlock_unlock(&cls->rwlock);
1771 /* Starts the process of deleting all of the flows from all of ofproto's flow
1772 * tables and then reintroducing the flows required by in-band control and
1773 * fail-open. The process will complete in a later call to ofproto_run(). */
1775 ofproto_flush_flows(struct ofproto *ofproto)
1777 COVERAGE_INC(ofproto_flush);
1778 ofproto->state = S_FLUSH;
1782 reinit_ports(struct ofproto *p)
1784 struct ofproto_port_dump dump;
1785 struct sset devnames;
1786 struct ofport *ofport;
1787 struct ofproto_port ofproto_port;
1788 const char *devname;
1790 COVERAGE_INC(ofproto_reinit_ports);
1792 sset_init(&devnames);
1793 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1794 sset_add(&devnames, netdev_get_name(ofport->netdev));
1796 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1797 sset_add(&devnames, ofproto_port.name);
1800 SSET_FOR_EACH (devname, &devnames) {
1801 update_port(p, devname);
1803 sset_destroy(&devnames);
1807 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
1811 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
1812 port_idx = port_idx ? port_idx : UINT16_MAX;
1814 if (port_idx >= ofproto->max_ports
1815 || bitmap_is_set(ofproto->ofp_port_ids, port_idx)) {
1816 uint16_t end_port_no = ofproto->alloc_port_no;
1818 /* Search for a free OpenFlow port number. We try not to
1819 * immediately reuse them to prevent problems due to old
1822 if (++ofproto->alloc_port_no >= ofproto->max_ports) {
1823 ofproto->alloc_port_no = 0;
1825 if (!bitmap_is_set(ofproto->ofp_port_ids,
1826 ofproto->alloc_port_no)) {
1827 port_idx = ofproto->alloc_port_no;
1830 if (ofproto->alloc_port_no == end_port_no) {
1835 bitmap_set1(ofproto->ofp_port_ids, port_idx);
1836 return u16_to_ofp(port_idx);
1840 dealloc_ofp_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
1842 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
1843 bitmap_set0(ofproto->ofp_port_ids, ofp_to_u16(ofp_port));
1847 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1848 * pointer if the netdev cannot be opened. On success, also fills in
1850 static struct netdev *
1851 ofport_open(struct ofproto *ofproto,
1852 struct ofproto_port *ofproto_port,
1853 struct ofputil_phy_port *pp)
1855 enum netdev_flags flags;
1856 struct netdev *netdev;
1859 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1861 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1862 "cannot be opened (%s)",
1864 ofproto_port->name, ofproto_port->ofp_port,
1865 ofproto_port->name, ovs_strerror(error));
1869 if (ofproto_port->ofp_port == OFPP_NONE) {
1870 if (!strcmp(ofproto->name, ofproto_port->name)) {
1871 ofproto_port->ofp_port = OFPP_LOCAL;
1873 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1874 ofproto_port->name);
1877 pp->port_no = ofproto_port->ofp_port;
1878 netdev_get_etheraddr(netdev, pp->hw_addr);
1879 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1880 netdev_get_flags(netdev, &flags);
1881 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1882 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1883 netdev_get_features(netdev, &pp->curr, &pp->advertised,
1884 &pp->supported, &pp->peer);
1885 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
1886 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
1891 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1892 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1895 ofport_equal(const struct ofputil_phy_port *a,
1896 const struct ofputil_phy_port *b)
1898 return (eth_addr_equals(a->hw_addr, b->hw_addr)
1899 && a->state == b->state
1900 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1901 && a->curr == b->curr
1902 && a->advertised == b->advertised
1903 && a->supported == b->supported
1904 && a->peer == b->peer
1905 && a->curr_speed == b->curr_speed
1906 && a->max_speed == b->max_speed);
1909 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1910 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1911 * one with the same name or port number). */
1913 ofport_install(struct ofproto *p,
1914 struct netdev *netdev, const struct ofputil_phy_port *pp)
1916 const char *netdev_name = netdev_get_name(netdev);
1917 struct ofport *ofport;
1920 /* Create ofport. */
1921 ofport = p->ofproto_class->port_alloc();
1926 ofport->ofproto = p;
1927 ofport->netdev = netdev;
1928 ofport->change_seq = netdev_change_seq(netdev);
1930 ofport->ofp_port = pp->port_no;
1931 ofport->created = time_msec();
1933 /* Add port to 'p'. */
1934 hmap_insert(&p->ports, &ofport->hmap_node,
1935 hash_ofp_port(ofport->ofp_port));
1936 shash_add(&p->port_by_name, netdev_name, ofport);
1938 update_mtu(p, ofport);
1940 /* Let the ofproto_class initialize its private data. */
1941 error = p->ofproto_class->port_construct(ofport);
1945 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1949 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1950 p->name, netdev_name, ovs_strerror(error));
1952 ofport_destroy__(ofport);
1954 netdev_close(netdev);
1958 /* Removes 'ofport' from 'p' and destroys it. */
1960 ofport_remove(struct ofport *ofport)
1962 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1964 ofport_destroy(ofport);
1967 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1970 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1972 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1974 ofport_remove(port);
1978 /* Updates 'port' with new 'pp' description.
1980 * Does not handle a name or port number change. The caller must implement
1981 * such a change as a delete followed by an add. */
1983 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1985 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1986 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1987 | (pp->config & OFPUTIL_PC_PORT_DOWN));
1988 port->pp.state = pp->state;
1989 port->pp.curr = pp->curr;
1990 port->pp.advertised = pp->advertised;
1991 port->pp.supported = pp->supported;
1992 port->pp.peer = pp->peer;
1993 port->pp.curr_speed = pp->curr_speed;
1994 port->pp.max_speed = pp->max_speed;
1996 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1999 /* Update OpenFlow 'state' in 'port' and notify controller. */
2001 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2003 if (port->pp.state != state) {
2004 port->pp.state = state;
2005 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
2011 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2013 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2015 if (port->ofproto->ofproto_class->set_realdev) {
2016 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2018 if (port->ofproto->ofproto_class->set_stp_port) {
2019 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2021 if (port->ofproto->ofproto_class->set_cfm) {
2022 port->ofproto->ofproto_class->set_cfm(port, NULL);
2024 if (port->ofproto->ofproto_class->bundle_remove) {
2025 port->ofproto->ofproto_class->bundle_remove(port);
2031 ofport_destroy__(struct ofport *port)
2033 struct ofproto *ofproto = port->ofproto;
2034 const char *name = netdev_get_name(port->netdev);
2036 hmap_remove(&ofproto->ports, &port->hmap_node);
2037 shash_delete(&ofproto->port_by_name,
2038 shash_find(&ofproto->port_by_name, name));
2040 netdev_close(port->netdev);
2041 ofproto->ofproto_class->port_dealloc(port);
2045 ofport_destroy(struct ofport *port)
2048 dealloc_ofp_port(port->ofproto, port->ofp_port);
2049 port->ofproto->ofproto_class->port_destruct(port);
2050 ofport_destroy__(port);
2055 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2057 struct ofport *port;
2059 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2061 if (port->ofp_port == ofp_port) {
2069 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2071 struct ofproto *ofproto = port->ofproto;
2074 if (ofproto->ofproto_class->port_get_stats) {
2075 error = ofproto->ofproto_class->port_get_stats(port, stats);
2084 update_port(struct ofproto *ofproto, const char *name)
2086 struct ofproto_port ofproto_port;
2087 struct ofputil_phy_port pp;
2088 struct netdev *netdev;
2089 struct ofport *port;
2091 COVERAGE_INC(ofproto_update_port);
2093 /* Fetch 'name''s location and properties from the datapath. */
2094 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2095 ? ofport_open(ofproto, &ofproto_port, &pp)
2099 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2100 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2101 struct netdev *old_netdev = port->netdev;
2103 /* 'name' hasn't changed location. Any properties changed? */
2104 if (!ofport_equal(&port->pp, &pp)) {
2105 ofport_modified(port, &pp);
2108 update_mtu(ofproto, port);
2110 /* Install the newly opened netdev in case it has changed.
2111 * Don't close the old netdev yet in case port_modified has to
2112 * remove a retained reference to it.*/
2113 port->netdev = netdev;
2114 port->change_seq = netdev_change_seq(netdev);
2116 if (port->ofproto->ofproto_class->port_modified) {
2117 port->ofproto->ofproto_class->port_modified(port);
2120 netdev_close(old_netdev);
2122 /* If 'port' is nonnull then its name differs from 'name' and thus
2123 * we should delete it. If we think there's a port named 'name'
2124 * then its port number must be wrong now so delete it too. */
2126 ofport_remove(port);
2128 ofport_remove_with_name(ofproto, name);
2129 ofport_install(ofproto, netdev, &pp);
2132 /* Any port named 'name' is gone now. */
2133 ofport_remove_with_name(ofproto, name);
2135 ofproto_port_destroy(&ofproto_port);
2139 init_ports(struct ofproto *p)
2141 struct ofproto_port_dump dump;
2142 struct ofproto_port ofproto_port;
2143 struct shash_node *node, *next;
2145 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2146 const char *name = ofproto_port.name;
2148 if (shash_find(&p->port_by_name, name)) {
2149 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2152 struct ofputil_phy_port pp;
2153 struct netdev *netdev;
2155 /* Check if an OpenFlow port number had been requested. */
2156 node = shash_find(&init_ofp_ports, name);
2158 const struct iface_hint *iface_hint = node->data;
2159 simap_put(&p->ofp_requests, name,
2160 ofp_to_u16(iface_hint->ofp_port));
2163 netdev = ofport_open(p, &ofproto_port, &pp);
2165 ofport_install(p, netdev, &pp);
2166 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2167 p->alloc_port_no = MAX(p->alloc_port_no,
2168 ofp_to_u16(ofproto_port.ofp_port));
2174 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2175 struct iface_hint *iface_hint = node->data;
2177 if (!strcmp(iface_hint->br_name, p->name)) {
2178 free(iface_hint->br_name);
2179 free(iface_hint->br_type);
2181 shash_delete(&init_ofp_ports, node);
2188 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2189 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2191 find_min_mtu(struct ofproto *p)
2193 struct ofport *ofport;
2196 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2197 struct netdev *netdev = ofport->netdev;
2200 /* Skip any internal ports, since that's what we're trying to
2202 if (!strcmp(netdev_get_type(netdev), "internal")) {
2206 if (netdev_get_mtu(netdev, &dev_mtu)) {
2209 if (!mtu || dev_mtu < mtu) {
2214 return mtu ? mtu: ETH_PAYLOAD_MAX;
2217 /* Update MTU of all datapath devices on 'p' to the minimum of the
2218 * non-datapath ports in event of 'port' added or changed. */
2220 update_mtu(struct ofproto *p, struct ofport *port)
2222 struct ofport *ofport;
2223 struct netdev *netdev = port->netdev;
2224 int dev_mtu, old_min;
2226 if (netdev_get_mtu(netdev, &dev_mtu)) {
2230 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2231 if (dev_mtu > p->min_mtu) {
2232 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2233 dev_mtu = p->min_mtu;
2236 port->mtu = dev_mtu;
2240 /* For non-internal port find new min mtu. */
2241 old_min = p->min_mtu;
2242 port->mtu = dev_mtu;
2243 p->min_mtu = find_min_mtu(p);
2244 if (p->min_mtu == old_min) {
2248 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2249 struct netdev *netdev = ofport->netdev;
2251 if (!strcmp(netdev_get_type(netdev), "internal")) {
2252 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2253 ofport->mtu = p->min_mtu;
2260 ofproto_rule_destroy(struct rule *rule)
2263 rule->ofproto->ofproto_class->rule_destruct(rule);
2264 ofproto_rule_destroy__(rule);
2269 ofproto_rule_destroy__(struct rule *rule)
2271 cls_rule_destroy(&rule->cr);
2272 free(rule->ofpacts);
2273 ovs_mutex_destroy(&rule->timeout_mutex);
2274 ovs_rwlock_destroy(&rule->rwlock);
2275 rule->ofproto->ofproto_class->rule_dealloc(rule);
2278 /* This function allows an ofproto implementation to destroy any rules that
2279 * remain when its ->destruct() function is called.. This function implements
2280 * steps 4.4 and 4.5 in the section titled "Rule Life Cycle" in
2281 * ofproto-provider.h.
2283 * This function should only be called from an ofproto implementation's
2284 * ->destruct() function. It is not suitable elsewhere. */
2286 ofproto_rule_delete(struct ofproto *ofproto, struct classifier *cls,
2288 OVS_REQ_WRLOCK(cls->rwlock)
2290 ofproto_delete_rule(ofproto, cls, rule);
2293 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2294 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2296 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2298 return (port == OFPP_ANY
2299 || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
2302 /* Returns true if 'rule' has group and equals group_id. */
2304 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2306 return (group_id == OFPG11_ANY
2307 || ofpacts_output_to_group(rule->ofpacts, rule->ofpacts_len, group_id));
2310 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2311 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2313 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2315 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2320 case OFOPERATION_ADD:
2321 case OFOPERATION_DELETE:
2324 case OFOPERATION_MODIFY:
2325 case OFOPERATION_REPLACE:
2326 return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
2332 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2333 * statistics appropriately.
2335 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
2336 * with statistics for 'packet' either way.
2338 * Takes ownership of 'packet'. */
2340 rule_execute(struct rule *rule, ofp_port_t in_port, struct ofpbuf *packet)
2343 union flow_in_port in_port_;
2345 in_port_.ofp_port = in_port;
2346 flow_extract(packet, 0, 0, NULL, &in_port_, &flow);
2347 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
2350 /* Returns true if 'rule' should be hidden from the controller.
2352 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2353 * (e.g. by in-band control) and are intentionally hidden from the
2356 ofproto_rule_is_hidden(const struct rule *rule)
2358 return rule->cr.priority > UINT16_MAX;
2361 static enum oftable_flags
2362 rule_get_flags(const struct rule *rule)
2364 return rule->ofproto->tables[rule->table_id].flags;
2368 rule_is_modifiable(const struct rule *rule)
2370 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2374 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2376 ofconn_send_reply(ofconn, make_echo_reply(oh));
2381 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2383 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2384 struct ofputil_switch_features features;
2385 struct ofport *port;
2391 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2393 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2395 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2396 * if present, are always at the end.) */
2397 n_tables = ofproto->n_tables;
2398 for (i = 0; i < ofproto->n_tables; i++) {
2399 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2405 features.datapath_id = ofproto->datapath_id;
2406 features.n_buffers = pktbuf_capacity();
2407 features.n_tables = n_tables;
2408 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2409 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2411 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2413 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2414 features.auxiliary_id = 0;
2415 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2417 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2418 ofputil_put_switch_features_port(&port->pp, b);
2421 ofconn_send_reply(ofconn, b);
2426 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2428 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2429 struct ofp_switch_config *osc;
2430 enum ofp_config_flags flags;
2434 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2435 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2436 flags = ofproto->frag_handling;
2437 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2438 if (oh->version < OFP13_VERSION
2439 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2440 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2442 osc->flags = htons(flags);
2443 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2444 ofconn_send_reply(ofconn, buf);
2450 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2452 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2453 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2454 uint16_t flags = ntohs(osc->flags);
2456 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2457 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2458 enum ofp_config_flags cur = ofproto->frag_handling;
2459 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2461 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2463 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2464 ofproto->frag_handling = next;
2466 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2468 ofputil_frag_handling_to_string(next));
2472 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2473 ofconn_set_invalid_ttl_to_controller(ofconn,
2474 (oh->version < OFP13_VERSION
2475 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2477 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2482 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2483 * error message code for the caller to propagate upward. Otherwise, returns
2486 * The log message mentions 'msg_type'. */
2488 reject_slave_controller(struct ofconn *ofconn)
2490 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2491 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2492 return OFPERR_OFPBRC_EPERM;
2498 /* Finds the OFPACT_METER action, if any, in the 'ofpacts_len' bytes of
2499 * 'ofpacts'. If found, returns its meter ID; if not, returns 0.
2501 * This function relies on the order of 'ofpacts' being correct (as checked by
2502 * ofpacts_verify()). */
2504 find_meter(const struct ofpact ofpacts[], size_t ofpacts_len)
2506 const struct ofpact *a;
2508 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2509 enum ovs_instruction_type inst;
2511 inst = ovs_instruction_type_from_ofpact_type(a->type);
2512 if (a->type == OFPACT_METER) {
2513 return ofpact_get_METER(a)->meter_id;
2514 } else if (inst > OVSINST_OFPIT13_METER) {
2522 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are appropriate
2523 * for a packet with the prerequisites satisfied by 'flow' in table 'table_id'.
2524 * 'flow' may be temporarily modified, but is restored at return.
2527 ofproto_check_ofpacts(struct ofproto *ofproto,
2528 const struct ofpact ofpacts[], size_t ofpacts_len,
2529 struct flow *flow, uint8_t table_id)
2534 error = ofpacts_check(ofpacts, ofpacts_len, flow,
2535 u16_to_ofp(ofproto->max_ports), table_id);
2540 mid = find_meter(ofpacts, ofpacts_len);
2541 if (mid && ofproto_get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2542 return OFPERR_OFPMMFC_INVALID_METER;
2548 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2550 struct ofproto *p = ofconn_get_ofproto(ofconn);
2551 struct ofputil_packet_out po;
2552 struct ofpbuf *payload;
2553 uint64_t ofpacts_stub[1024 / 8];
2554 struct ofpbuf ofpacts;
2556 union flow_in_port in_port_;
2559 COVERAGE_INC(ofproto_packet_out);
2561 error = reject_slave_controller(ofconn);
2566 /* Decode message. */
2567 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2568 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2570 goto exit_free_ofpacts;
2572 if (ofp_to_u16(po.in_port) >= p->max_ports
2573 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2574 error = OFPERR_OFPBRC_BAD_PORT;
2575 goto exit_free_ofpacts;
2580 if (po.buffer_id != UINT32_MAX) {
2581 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2582 if (error || !payload) {
2583 goto exit_free_ofpacts;
2586 /* Ensure that the L3 header is 32-bit aligned. */
2587 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2590 /* Verify actions against packet, then send packet if successful. */
2591 in_port_.ofp_port = po.in_port;
2592 flow_extract(payload, 0, 0, NULL, &in_port_, &flow);
2593 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len, &flow, 0);
2595 error = p->ofproto_class->packet_out(p, payload, &flow,
2596 po.ofpacts, po.ofpacts_len);
2598 ofpbuf_delete(payload);
2601 ofpbuf_uninit(&ofpacts);
2607 update_port_config(struct ofport *port,
2608 enum ofputil_port_config config,
2609 enum ofputil_port_config mask)
2611 enum ofputil_port_config old_config = port->pp.config;
2612 enum ofputil_port_config toggle;
2614 toggle = (config ^ port->pp.config) & mask;
2615 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2616 if (config & OFPUTIL_PC_PORT_DOWN) {
2617 netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL);
2619 netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL);
2621 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2624 port->pp.config ^= toggle;
2625 if (port->pp.config != old_config) {
2626 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2631 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2633 struct ofproto *p = ofconn_get_ofproto(ofconn);
2634 struct ofputil_port_mod pm;
2635 struct ofport *port;
2638 error = reject_slave_controller(ofconn);
2643 error = ofputil_decode_port_mod(oh, &pm);
2648 port = ofproto_get_port(p, pm.port_no);
2650 return OFPERR_OFPPMFC_BAD_PORT;
2651 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2652 return OFPERR_OFPPMFC_BAD_HW_ADDR;
2654 update_port_config(port, pm.config, pm.mask);
2656 netdev_set_advertisements(port->netdev, pm.advertise);
2663 handle_desc_stats_request(struct ofconn *ofconn,
2664 const struct ofp_header *request)
2666 static const char *default_mfr_desc = "Nicira, Inc.";
2667 static const char *default_hw_desc = "Open vSwitch";
2668 static const char *default_sw_desc = VERSION;
2669 static const char *default_serial_desc = "None";
2670 static const char *default_dp_desc = "None";
2672 struct ofproto *p = ofconn_get_ofproto(ofconn);
2673 struct ofp_desc_stats *ods;
2676 msg = ofpraw_alloc_stats_reply(request, 0);
2677 ods = ofpbuf_put_zeros(msg, sizeof *ods);
2678 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
2679 sizeof ods->mfr_desc);
2680 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
2681 sizeof ods->hw_desc);
2682 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
2683 sizeof ods->sw_desc);
2684 ovs_strlcpy(ods->serial_num,
2685 p->serial_desc ? p->serial_desc : default_serial_desc,
2686 sizeof ods->serial_num);
2687 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
2688 sizeof ods->dp_desc);
2689 ofconn_send_reply(ofconn, msg);
2695 handle_table_stats_request(struct ofconn *ofconn,
2696 const struct ofp_header *request)
2698 struct ofproto *p = ofconn_get_ofproto(ofconn);
2699 struct ofp12_table_stats *ots;
2704 /* Set up default values.
2706 * ofp12_table_stats is used as a generic structure as
2707 * it is able to hold all the fields for ofp10_table_stats
2708 * and ofp11_table_stats (and of course itself).
2710 ots = xcalloc(p->n_tables, sizeof *ots);
2711 for (i = 0; i < p->n_tables; i++) {
2712 ots[i].table_id = i;
2713 sprintf(ots[i].name, "table%zu", i);
2714 ots[i].match = htonll(OFPXMT12_MASK);
2715 ots[i].wildcards = htonll(OFPXMT12_MASK);
2716 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2717 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2718 ots[i].write_setfields = htonll(OFPXMT12_MASK);
2719 ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2720 ots[i].metadata_match = htonll(UINT64_MAX);
2721 ots[i].metadata_write = htonll(UINT64_MAX);
2722 ots[i].instructions = htonl(OFPIT11_ALL);
2723 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2724 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2725 ovs_rwlock_rdlock(&p->tables[i].cls.rwlock);
2726 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2727 ovs_rwlock_unlock(&p->tables[i].cls.rwlock);
2730 p->ofproto_class->get_tables(p, ots);
2732 /* Post-process the tables, dropping hidden tables. */
2733 n_tables = p->n_tables;
2734 for (i = 0; i < p->n_tables; i++) {
2735 const struct oftable *table = &p->tables[i];
2737 if (table->flags & OFTABLE_HIDDEN) {
2743 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2746 if (table->max_flows < ntohl(ots[i].max_entries)) {
2747 ots[i].max_entries = htonl(table->max_flows);
2751 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2752 ofconn_send_reply(ofconn, msg);
2760 append_port_stat(struct ofport *port, struct list *replies)
2762 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2764 calc_duration(port->created, time_msec(),
2765 &ops.duration_sec, &ops.duration_nsec);
2767 /* Intentionally ignore return value, since errors will set
2768 * 'stats' to all-1s, which is correct for OpenFlow, and
2769 * netdev_get_stats() will log errors. */
2770 ofproto_port_get_stats(port, &ops.stats);
2772 ofputil_append_port_stat(replies, &ops);
2776 handle_port_stats_request(struct ofconn *ofconn,
2777 const struct ofp_header *request)
2779 struct ofproto *p = ofconn_get_ofproto(ofconn);
2780 struct ofport *port;
2781 struct list replies;
2785 error = ofputil_decode_port_stats_request(request, &port_no);
2790 ofpmp_init(&replies, request);
2791 if (port_no != OFPP_ANY) {
2792 port = ofproto_get_port(p, port_no);
2794 append_port_stat(port, &replies);
2797 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2798 append_port_stat(port, &replies);
2802 ofconn_send_replies(ofconn, &replies);
2807 handle_port_desc_stats_request(struct ofconn *ofconn,
2808 const struct ofp_header *request)
2810 struct ofproto *p = ofconn_get_ofproto(ofconn);
2811 enum ofp_version version;
2812 struct ofport *port;
2813 struct list replies;
2815 ofpmp_init(&replies, request);
2817 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2818 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2819 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2822 ofconn_send_replies(ofconn, &replies);
2827 hash_cookie(ovs_be64 cookie)
2829 return hash_2words((OVS_FORCE uint64_t)cookie >> 32,
2830 (OVS_FORCE uint64_t)cookie);
2834 cookies_insert(struct ofproto *ofproto, struct rule *rule)
2836 hindex_insert(&ofproto->cookies, &rule->cookie_node,
2837 hash_cookie(rule->flow_cookie));
2841 cookies_remove(struct ofproto *ofproto, struct rule *rule)
2843 hindex_remove(&ofproto->cookies, &rule->cookie_node);
2847 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
2848 ovs_be64 new_cookie)
2850 if (new_cookie != rule->flow_cookie) {
2851 cookies_remove(ofproto, rule);
2853 ovs_rwlock_wrlock(&rule->rwlock);
2854 rule->flow_cookie = new_cookie;
2855 ovs_rwlock_unlock(&rule->rwlock);
2857 cookies_insert(ofproto, rule);
2862 calc_duration(long long int start, long long int now,
2863 uint32_t *sec, uint32_t *nsec)
2865 long long int msecs = now - start;
2866 *sec = msecs / 1000;
2867 *nsec = (msecs % 1000) * (1000 * 1000);
2870 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2871 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2873 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2875 return (table_id == 0xff || table_id < ofproto->n_tables
2877 : OFPERR_OFPBRC_BAD_TABLE_ID);
2881 static struct oftable *
2882 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2884 struct oftable *table;
2886 for (table = &ofproto->tables[table_id];
2887 table < &ofproto->tables[ofproto->n_tables];
2889 if (!(table->flags & OFTABLE_HIDDEN)) {
2897 static struct oftable *
2898 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2900 if (table_id == 0xff) {
2901 return next_visible_table(ofproto, 0);
2902 } else if (table_id < ofproto->n_tables) {
2903 return &ofproto->tables[table_id];
2909 static struct oftable *
2910 next_matching_table(const struct ofproto *ofproto,
2911 const struct oftable *table, uint8_t table_id)
2913 return (table_id == 0xff
2914 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2918 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2920 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2921 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2923 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2924 * only once, for that table. (This can be used to access tables marked
2927 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2928 * entered at all. (Perhaps you should have validated TABLE_ID with
2929 * check_table_id().)
2931 * All parameters are evaluated multiple times.
2933 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2934 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2936 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2938 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2939 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2940 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2943 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2944 * to 'out_port' are included.
2946 * Hidden rules are always omitted.
2948 * Returns 0 on success, otherwise an OpenFlow error code. */
2950 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2951 const struct match *match,
2952 ovs_be64 cookie, ovs_be64 cookie_mask,
2953 ofp_port_t out_port, uint32_t out_group,
2956 struct oftable *table;
2960 error = check_table_id(ofproto, table_id);
2966 cls_rule_init(&cr, match, 0);
2968 if (cookie_mask == htonll(UINT64_MAX)) {
2971 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node, hash_cookie(cookie),
2972 &ofproto->cookies) {
2973 if (table_id != rule->table_id && table_id != 0xff) {
2976 if (ofproto_rule_is_hidden(rule)) {
2979 if (cls_rule_is_loose_match(&rule->cr, &cr.match)) {
2980 if (rule->pending) {
2981 error = OFPROTO_POSTPONE;
2984 if (rule->flow_cookie == cookie /* Hash collisions possible. */
2985 && ofproto_rule_has_out_port(rule, out_port)
2986 && ofproto_rule_has_out_group(rule, out_group)) {
2987 list_push_back(rules, &rule->ofproto_node);
2994 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2995 struct cls_cursor cursor;
2998 ovs_rwlock_rdlock(&table->cls.rwlock);
2999 cls_cursor_init(&cursor, &table->cls, &cr);
3000 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3001 if (rule->pending) {
3002 ovs_rwlock_unlock(&table->cls.rwlock);
3003 error = OFPROTO_POSTPONE;
3006 if (!ofproto_rule_is_hidden(rule)
3007 && ofproto_rule_has_out_port(rule, out_port)
3008 && ofproto_rule_has_out_group(rule, out_group)
3009 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
3010 list_push_back(rules, &rule->ofproto_node);
3013 ovs_rwlock_unlock(&table->cls.rwlock);
3017 cls_rule_destroy(&cr);
3021 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
3022 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
3023 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
3026 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
3027 * to 'out_port' are included.
3029 * Hidden rules are always omitted.
3031 * Returns 0 on success, otherwise an OpenFlow error code. */
3033 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
3034 const struct match *match, unsigned int priority,
3035 ovs_be64 cookie, ovs_be64 cookie_mask,
3036 ofp_port_t out_port, uint32_t out_group,
3039 struct oftable *table;
3043 error = check_table_id(ofproto, table_id);
3049 cls_rule_init(&cr, match, priority);
3051 if (cookie_mask == htonll(UINT64_MAX)) {
3054 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node, hash_cookie(cookie),
3055 &ofproto->cookies) {
3056 if (table_id != rule->table_id && table_id != 0xff) {
3059 if (ofproto_rule_is_hidden(rule)) {
3062 if (cls_rule_equal(&rule->cr, &cr)) {
3063 if (rule->pending) {
3064 error = OFPROTO_POSTPONE;
3067 if (rule->flow_cookie == cookie /* Hash collisions possible. */
3068 && ofproto_rule_has_out_port(rule, out_port)
3069 && ofproto_rule_has_out_group(rule, out_group)) {
3070 list_push_back(rules, &rule->ofproto_node);
3077 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
3080 ovs_rwlock_rdlock(&table->cls.rwlock);
3081 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
3083 ovs_rwlock_unlock(&table->cls.rwlock);
3085 if (rule->pending) {
3086 error = OFPROTO_POSTPONE;
3089 if (!ofproto_rule_is_hidden(rule)
3090 && ofproto_rule_has_out_port(rule, out_port)
3091 && ofproto_rule_has_out_group(rule, out_group)
3092 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
3093 list_push_back(rules, &rule->ofproto_node);
3099 cls_rule_destroy(&cr);
3103 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3104 * forced into the range of a uint16_t. */
3106 age_secs(long long int age_ms)
3108 return (age_ms < 0 ? 0
3109 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3110 : (unsigned int) age_ms / 1000);
3114 handle_flow_stats_request(struct ofconn *ofconn,
3115 const struct ofp_header *request)
3117 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3118 struct ofputil_flow_stats_request fsr;
3119 struct list replies;
3124 error = ofputil_decode_flow_stats_request(&fsr, request);
3129 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
3130 fsr.cookie, fsr.cookie_mask,
3131 fsr.out_port, fsr.out_group, &rules);
3136 ofpmp_init(&replies, request);
3137 LIST_FOR_EACH (rule, ofproto_node, &rules) {
3138 long long int now = time_msec();
3139 struct ofputil_flow_stats fs;
3141 minimatch_expand(&rule->cr.match, &fs.match);
3142 fs.priority = rule->cr.priority;
3143 fs.cookie = rule->flow_cookie;
3144 fs.table_id = rule->table_id;
3145 calc_duration(rule->created, now, &fs.duration_sec, &fs.duration_nsec);
3146 fs.idle_age = age_secs(now - rule->used);
3147 fs.hard_age = age_secs(now - rule->modified);
3148 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3150 fs.ofpacts = rule->ofpacts;
3151 fs.ofpacts_len = rule->ofpacts_len;
3153 ovs_mutex_lock(&rule->timeout_mutex);
3154 fs.idle_timeout = rule->idle_timeout;
3155 fs.hard_timeout = rule->hard_timeout;
3156 ovs_mutex_unlock(&rule->timeout_mutex);
3158 fs.flags = rule->flags;
3160 ofputil_append_flow_stats_reply(&fs, &replies);
3162 ofconn_send_replies(ofconn, &replies);
3168 flow_stats_ds(struct rule *rule, struct ds *results)
3170 uint64_t packet_count, byte_count;
3172 rule->ofproto->ofproto_class->rule_get_stats(rule,
3173 &packet_count, &byte_count);
3175 if (rule->table_id != 0) {
3176 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3178 ds_put_format(results, "duration=%llds, ",
3179 (time_msec() - rule->created) / 1000);
3180 ds_put_format(results, "priority=%u, ", rule->cr.priority);
3181 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3182 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3183 cls_rule_format(&rule->cr, results);
3184 ds_put_char(results, ',');
3185 ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
3186 ds_put_cstr(results, "\n");
3189 /* Adds a pretty-printed description of all flows to 'results', including
3190 * hidden flows (e.g., set up by in-band control). */
3192 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3194 struct oftable *table;
3196 OFPROTO_FOR_EACH_TABLE (table, p) {
3197 struct cls_cursor cursor;
3200 ovs_rwlock_rdlock(&table->cls.rwlock);
3201 cls_cursor_init(&cursor, &table->cls, NULL);
3202 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3203 flow_stats_ds(rule, results);
3205 ovs_rwlock_unlock(&table->cls.rwlock);
3209 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3210 * '*engine_type' and '*engine_id', respectively. */
3212 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3213 uint8_t *engine_type, uint8_t *engine_id)
3215 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3218 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3219 * true if the port's CFM status was successfully stored into '*status'.
3220 * Returns false if the port did not have CFM configured, in which case
3221 * '*status' is indeterminate.
3223 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3225 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3226 struct ofproto_cfm_status *status)
3228 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3230 && ofproto->ofproto_class->get_cfm_status
3231 && ofproto->ofproto_class->get_cfm_status(ofport, status));
3235 handle_aggregate_stats_request(struct ofconn *ofconn,
3236 const struct ofp_header *oh)
3238 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3239 struct ofputil_flow_stats_request request;
3240 struct ofputil_aggregate_stats stats;
3241 bool unknown_packets, unknown_bytes;
3242 struct ofpbuf *reply;
3247 error = ofputil_decode_flow_stats_request(&request, oh);
3252 error = collect_rules_loose(ofproto, request.table_id, &request.match,
3253 request.cookie, request.cookie_mask,
3254 request.out_port, request.out_group, &rules);
3259 memset(&stats, 0, sizeof stats);
3260 unknown_packets = unknown_bytes = false;
3261 LIST_FOR_EACH (rule, ofproto_node, &rules) {
3262 uint64_t packet_count;
3263 uint64_t byte_count;
3265 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3268 if (packet_count == UINT64_MAX) {
3269 unknown_packets = true;
3271 stats.packet_count += packet_count;
3274 if (byte_count == UINT64_MAX) {
3275 unknown_bytes = true;
3277 stats.byte_count += byte_count;
3282 if (unknown_packets) {
3283 stats.packet_count = UINT64_MAX;
3285 if (unknown_bytes) {
3286 stats.byte_count = UINT64_MAX;
3289 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3290 ofconn_send_reply(ofconn, reply);
3295 struct queue_stats_cbdata {
3296 struct ofport *ofport;
3297 struct list replies;
3302 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3303 const struct netdev_queue_stats *stats)
3305 struct ofputil_queue_stats oqs;
3307 oqs.port_no = cbdata->ofport->pp.port_no;
3308 oqs.queue_id = queue_id;
3309 oqs.tx_bytes = stats->tx_bytes;
3310 oqs.tx_packets = stats->tx_packets;
3311 oqs.tx_errors = stats->tx_errors;
3312 if (stats->created != LLONG_MIN) {
3313 calc_duration(stats->created, cbdata->now,
3314 &oqs.duration_sec, &oqs.duration_nsec);
3316 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3318 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3322 handle_queue_stats_dump_cb(uint32_t queue_id,
3323 struct netdev_queue_stats *stats,
3326 struct queue_stats_cbdata *cbdata = cbdata_;
3328 put_queue_stats(cbdata, queue_id, stats);
3332 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3333 struct queue_stats_cbdata *cbdata)
3335 cbdata->ofport = port;
3336 if (queue_id == OFPQ_ALL) {
3337 netdev_dump_queue_stats(port->netdev,
3338 handle_queue_stats_dump_cb, cbdata);
3340 struct netdev_queue_stats stats;
3342 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3343 put_queue_stats(cbdata, queue_id, &stats);
3345 return OFPERR_OFPQOFC_BAD_QUEUE;
3352 handle_queue_stats_request(struct ofconn *ofconn,
3353 const struct ofp_header *rq)
3355 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3356 struct queue_stats_cbdata cbdata;
3357 struct ofport *port;
3359 struct ofputil_queue_stats_request oqsr;
3361 COVERAGE_INC(ofproto_queue_req);
3363 ofpmp_init(&cbdata.replies, rq);
3364 cbdata.now = time_msec();
3366 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3371 if (oqsr.port_no == OFPP_ANY) {
3372 error = OFPERR_OFPQOFC_BAD_QUEUE;
3373 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3374 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3379 port = ofproto_get_port(ofproto, oqsr.port_no);
3381 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3382 : OFPERR_OFPQOFC_BAD_PORT);
3385 ofconn_send_replies(ofconn, &cbdata.replies);
3387 ofpbuf_list_delete(&cbdata.replies);
3394 is_flow_deletion_pending(const struct ofproto *ofproto,
3395 const struct cls_rule *cls_rule,
3398 if (!hmap_is_empty(&ofproto->deletions)) {
3399 struct ofoperation *op;
3401 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3402 cls_rule_hash(cls_rule, table_id),
3403 &ofproto->deletions) {
3404 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3414 evict_rule_from_table(struct ofproto *ofproto, struct oftable *table)
3419 ovs_rwlock_rdlock(&table->cls.rwlock);
3420 n_rules = classifier_count(&table->cls);
3421 ovs_rwlock_unlock(&table->cls.rwlock);
3423 if (n_rules < table->max_flows) {
3425 } else if (!choose_rule_to_evict(table, &rule)) {
3426 return OFPERR_OFPFMFC_TABLE_FULL;
3427 } else if (rule->pending) {
3428 ovs_rwlock_unlock(&rule->rwlock);
3429 return OFPROTO_POSTPONE;
3431 struct ofopgroup *group;
3433 group = ofopgroup_create_unattached(ofproto);
3434 delete_flow__(rule, group, OFPRR_EVICTION);
3435 ofopgroup_submit(group);
3441 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3442 * in which no matching flow already exists in the flow table.
3444 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3445 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3446 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3447 * initiated now but may be retried later.
3449 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
3450 * ownership remains with the caller.
3452 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3455 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3456 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3458 struct oftable *table;
3459 struct ofopgroup *group;
3465 error = check_table_id(ofproto, fm->table_id);
3471 if (fm->table_id == 0xff) {
3472 if (ofproto->ofproto_class->rule_choose_table) {
3473 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3479 ovs_assert(table_id < ofproto->n_tables);
3483 } else if (fm->table_id < ofproto->n_tables) {
3484 table_id = fm->table_id;
3486 return OFPERR_OFPBRC_BAD_TABLE_ID;
3489 table = &ofproto->tables[table_id];
3491 if (table->flags & OFTABLE_READONLY) {
3492 return OFPERR_OFPBRC_EPERM;
3495 cls_rule_init(&cr, &fm->match, fm->priority);
3497 /* Transform "add" into "modify" if there's an existing identical flow. */
3498 ovs_rwlock_rdlock(&table->cls.rwlock);
3499 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
3500 ovs_rwlock_unlock(&table->cls.rwlock);
3502 cls_rule_destroy(&cr);
3503 if (!rule_is_modifiable(rule)) {
3504 return OFPERR_OFPBRC_EPERM;
3505 } else if (rule->pending) {
3506 return OFPROTO_POSTPONE;
3511 list_push_back(&rules, &rule->ofproto_node);
3512 fm->modify_cookie = true;
3513 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3517 /* Verify actions. */
3518 error = ofproto_check_ofpacts(ofproto, fm->ofpacts, fm->ofpacts_len,
3519 &fm->match.flow, table_id);
3521 cls_rule_destroy(&cr);
3525 /* Serialize against pending deletion. */
3526 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
3527 cls_rule_destroy(&cr);
3528 return OFPROTO_POSTPONE;
3531 /* Check for overlap, if requested. */
3532 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
3535 ovs_rwlock_rdlock(&table->cls.rwlock);
3536 overlaps = classifier_rule_overlaps(&table->cls, &cr);
3537 ovs_rwlock_unlock(&table->cls.rwlock);
3540 cls_rule_destroy(&cr);
3541 return OFPERR_OFPFMFC_OVERLAP;
3545 /* If necessary, evict an existing rule to clear out space. */
3546 error = evict_rule_from_table(ofproto, table);
3548 cls_rule_destroy(&cr);
3552 /* Allocate new rule. */
3553 rule = ofproto->ofproto_class->rule_alloc();
3555 cls_rule_destroy(&cr);
3556 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3557 ofproto->name, ovs_strerror(error));
3561 /* Initialize base state. */
3562 rule->ofproto = ofproto;
3563 cls_rule_move(&rule->cr, &cr);
3564 rule->pending = NULL;
3565 rule->flow_cookie = fm->new_cookie;
3566 rule->created = rule->modified = rule->used = time_msec();
3568 ovs_mutex_init(&rule->timeout_mutex);
3569 ovs_mutex_lock(&rule->timeout_mutex);
3570 rule->idle_timeout = fm->idle_timeout;
3571 rule->hard_timeout = fm->hard_timeout;
3572 ovs_mutex_unlock(&rule->timeout_mutex);
3574 rule->table_id = table - ofproto->tables;
3575 rule->flags = fm->flags & OFPUTIL_FF_STATE;
3577 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3578 rule->ofpacts_len = fm->ofpacts_len;
3579 rule->meter_id = find_meter(rule->ofpacts, rule->ofpacts_len);
3580 list_init(&rule->meter_list_node);
3581 rule->eviction_group = NULL;
3582 list_init(&rule->expirable);
3583 rule->monitor_flags = 0;
3584 rule->add_seqno = 0;
3585 rule->modify_seqno = 0;
3586 ovs_rwlock_init(&rule->rwlock);
3588 /* Construct rule, initializing derived state. */
3589 error = ofproto->ofproto_class->rule_construct(rule);
3591 ofproto_rule_destroy__(rule);
3596 oftable_insert_rule(rule);
3598 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3599 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3600 ofproto->ofproto_class->rule_insert(rule);
3601 ofopgroup_submit(group);
3606 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3608 /* Modifies the rules listed in 'rules', changing their actions to match those
3611 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3614 * Returns 0 on success, otherwise an OpenFlow error code. */
3616 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3617 struct ofputil_flow_mod *fm, const struct ofp_header *request,
3620 enum ofoperation_type type;
3621 struct ofopgroup *group;
3625 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
3626 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3627 error = OFPERR_OFPBRC_EPERM;
3628 LIST_FOR_EACH (rule, ofproto_node, rules) {
3629 struct ofoperation *op;
3630 bool actions_changed;
3631 bool reset_counters;
3633 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
3635 if (rule_is_modifiable(rule)) {
3636 /* At least one rule is modifiable, don't report EPERM error. */
3642 /* Verify actions. */
3643 error = ofpacts_check(fm->ofpacts, fm->ofpacts_len, &fm->match.flow,
3644 u16_to_ofp(ofproto->max_ports), rule->table_id);
3649 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3650 rule->ofpacts, rule->ofpacts_len);
3652 op = ofoperation_create(group, rule, type, 0);
3654 if (fm->modify_cookie && fm->new_cookie != htonll(UINT64_MAX)) {
3655 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
3657 if (type == OFOPERATION_REPLACE) {
3658 ovs_mutex_lock(&rule->timeout_mutex);
3659 rule->idle_timeout = fm->idle_timeout;
3660 rule->hard_timeout = fm->hard_timeout;
3661 ovs_mutex_unlock(&rule->timeout_mutex);
3663 rule->flags = fm->flags & OFPUTIL_FF_STATE;
3664 if (fm->idle_timeout || fm->hard_timeout) {
3665 if (!rule->eviction_group) {
3666 eviction_group_add_rule(rule);
3669 eviction_group_remove_rule(rule);
3673 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
3674 if (actions_changed || reset_counters) {
3675 op->ofpacts = rule->ofpacts;
3676 op->ofpacts_len = rule->ofpacts_len;
3677 op->meter_id = rule->meter_id;
3679 ovs_rwlock_wrlock(&rule->rwlock);
3680 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3681 rule->ofpacts_len = fm->ofpacts_len;
3682 ovs_rwlock_unlock(&rule->rwlock);
3684 rule->meter_id = find_meter(rule->ofpacts, rule->ofpacts_len);
3685 rule->ofproto->ofproto_class->rule_modify_actions(rule,
3688 ofoperation_complete(op, 0);
3691 ofopgroup_submit(group);
3697 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3698 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3700 if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3703 return add_flow(ofproto, ofconn, fm, request);
3706 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3709 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3712 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3713 struct ofputil_flow_mod *fm,
3714 const struct ofp_header *request)
3719 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3720 fm->cookie, fm->cookie_mask,
3721 OFPP_ANY, OFPG11_ANY, &rules);
3724 } else if (list_is_empty(&rules)) {
3725 return modify_flows_add(ofproto, ofconn, fm, request);
3727 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3731 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3734 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3737 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3738 struct ofputil_flow_mod *fm,
3739 const struct ofp_header *request)
3744 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3745 fm->priority, fm->cookie, fm->cookie_mask,
3746 OFPP_ANY, OFPG11_ANY, &rules);
3749 } else if (list_is_empty(&rules)) {
3750 return modify_flows_add(ofproto, ofconn, fm, request);
3752 return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3753 fm, request, &rules)
3758 /* OFPFC_DELETE implementation. */
3761 delete_flow__(struct rule *rule, struct ofopgroup *group,
3762 enum ofp_flow_removed_reason reason)
3764 struct ofproto *ofproto = rule->ofproto;
3766 ofproto_rule_send_removed(rule, reason);
3768 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3769 oftable_remove_rule(rule);
3770 ofproto->ofproto_class->rule_delete(rule);
3773 /* Deletes the rules listed in 'rules'.
3775 * Returns 0 on success, otherwise an OpenFlow error code. */
3777 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3778 const struct ofp_header *request, struct list *rules,
3779 enum ofp_flow_removed_reason reason)
3781 struct rule *rule, *next;
3782 struct ofopgroup *group;
3784 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3785 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3786 ovs_rwlock_wrlock(&rule->rwlock);
3787 delete_flow__(rule, group, reason);
3789 ofopgroup_submit(group);
3794 /* Implements OFPFC_DELETE. */
3796 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3797 const struct ofputil_flow_mod *fm,
3798 const struct ofp_header *request)
3803 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3804 fm->cookie, fm->cookie_mask,
3805 fm->out_port, fm->out_group, &rules);
3806 return (error ? error
3807 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3808 &rules, OFPRR_DELETE)
3812 /* Implements OFPFC_DELETE_STRICT. */
3814 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3815 const struct ofputil_flow_mod *fm,
3816 const struct ofp_header *request)
3821 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3822 fm->priority, fm->cookie, fm->cookie_mask,
3823 fm->out_port, fm->out_group, &rules);
3824 return (error ? error
3825 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3832 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3834 struct ofputil_flow_removed fr;
3836 if (ofproto_rule_is_hidden(rule) ||
3837 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
3841 minimatch_expand(&rule->cr.match, &fr.match);
3842 fr.priority = rule->cr.priority;
3843 fr.cookie = rule->flow_cookie;
3845 fr.table_id = rule->table_id;
3846 calc_duration(rule->created, time_msec(),
3847 &fr.duration_sec, &fr.duration_nsec);
3848 ovs_mutex_lock(&rule->timeout_mutex);
3849 fr.idle_timeout = rule->idle_timeout;
3850 fr.hard_timeout = rule->hard_timeout;
3851 ovs_mutex_unlock(&rule->timeout_mutex);
3852 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3855 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3858 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3859 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3862 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3865 * ofproto implementation ->run() functions should use this function to expire
3866 * OpenFlow flows. */
3868 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3870 struct ofproto *ofproto = rule->ofproto;
3871 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
3873 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
3874 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
3875 ofproto_rule_send_removed(rule, reason);
3877 ovs_rwlock_wrlock(&cls->rwlock);
3878 ofproto_delete_rule(ofproto, cls, rule);
3879 ovs_rwlock_unlock(&cls->rwlock);
3882 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
3883 * means "infinite". */
3885 reduce_timeout(uint16_t max, uint16_t *timeout)
3887 if (max && (!*timeout || *timeout > max)) {
3892 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
3893 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
3894 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
3896 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
3898 ofproto_rule_reduce_timeouts(struct rule *rule,
3899 uint16_t idle_timeout, uint16_t hard_timeout)
3900 OVS_EXCLUDED(rule->ofproto->expirable_mutex, rule->timeout_mutex)
3902 if (!idle_timeout && !hard_timeout) {
3906 ovs_mutex_lock(&rule->ofproto->expirable_mutex);
3907 if (list_is_empty(&rule->expirable)) {
3908 list_insert(&rule->ofproto->expirable, &rule->expirable);
3910 ovs_mutex_unlock(&rule->ofproto->expirable_mutex);
3912 ovs_mutex_lock(&rule->timeout_mutex);
3913 reduce_timeout(idle_timeout, &rule->idle_timeout);
3914 reduce_timeout(hard_timeout, &rule->hard_timeout);
3915 ovs_mutex_unlock(&rule->timeout_mutex);
3919 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3921 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3922 struct ofputil_flow_mod fm;
3923 uint64_t ofpacts_stub[1024 / 8];
3924 struct ofpbuf ofpacts;
3928 error = reject_slave_controller(ofconn);
3933 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3934 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3937 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
3940 goto exit_free_ofpacts;
3943 /* Record the operation for logging a summary report. */
3944 switch (fm.command) {
3950 case OFPFC_MODIFY_STRICT:
3951 ofproto->n_modify++;
3955 case OFPFC_DELETE_STRICT:
3956 ofproto->n_delete++;
3961 if (ofproto->next_op_report == LLONG_MAX) {
3962 ofproto->first_op = now;
3963 ofproto->next_op_report = MAX(now + 10 * 1000,
3964 ofproto->op_backoff);
3965 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
3967 ofproto->last_op = now;
3970 ofpbuf_uninit(&ofpacts);
3976 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3977 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
3979 if (ofproto->n_pending >= 50) {
3980 ovs_assert(!list_is_empty(&ofproto->pending));
3981 return OFPROTO_POSTPONE;
3984 switch (fm->command) {
3986 return add_flow(ofproto, ofconn, fm, oh);
3989 return modify_flows_loose(ofproto, ofconn, fm, oh);
3991 case OFPFC_MODIFY_STRICT:
3992 return modify_flow_strict(ofproto, ofconn, fm, oh);
3995 return delete_flows_loose(ofproto, ofconn, fm, oh);
3997 case OFPFC_DELETE_STRICT:
3998 return delete_flow_strict(ofproto, ofconn, fm, oh);
4001 if (fm->command > 0xff) {
4002 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4003 "flow_mod_table_id extension is not enabled",
4006 return OFPERR_OFPFMFC_BAD_COMMAND;
4011 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4013 struct ofputil_role_request request;
4014 struct ofputil_role_request reply;
4018 error = ofputil_decode_role_message(oh, &request);
4023 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4024 if (ofconn_get_role(ofconn) != request.role
4025 && ofconn_has_pending_opgroups(ofconn)) {
4026 return OFPROTO_POSTPONE;
4029 if (request.have_generation_id
4030 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4031 return OFPERR_OFPRRFC_STALE;
4034 ofconn_set_role(ofconn, request.role);
4037 reply.role = ofconn_get_role(ofconn);
4038 reply.have_generation_id = ofconn_get_master_election_id(
4039 ofconn, &reply.generation_id);
4040 buf = ofputil_encode_role_reply(oh, &reply);
4041 ofconn_send_reply(ofconn, buf);
4047 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4048 const struct ofp_header *oh)
4050 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4051 enum ofputil_protocol cur, next;
4053 cur = ofconn_get_protocol(ofconn);
4054 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4055 ofconn_set_protocol(ofconn, next);
4061 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4063 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4064 enum ofputil_protocol cur, next;
4065 enum ofputil_protocol next_base;
4067 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4069 return OFPERR_OFPBRC_EPERM;
4072 cur = ofconn_get_protocol(ofconn);
4073 next = ofputil_protocol_set_base(cur, next_base);
4074 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4075 /* Avoid sending async messages in surprising protocol. */
4076 return OFPROTO_POSTPONE;
4079 ofconn_set_protocol(ofconn, next);
4084 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4085 const struct ofp_header *oh)
4087 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4090 format = ntohl(msg->format);
4091 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4092 return OFPERR_OFPBRC_EPERM;
4095 if (format != ofconn_get_packet_in_format(ofconn)
4096 && ofconn_has_pending_opgroups(ofconn)) {
4097 /* Avoid sending async message in surprsing packet in format. */
4098 return OFPROTO_POSTPONE;
4101 ofconn_set_packet_in_format(ofconn, format);
4106 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4108 const struct nx_async_config *msg = ofpmsg_body(oh);
4109 uint32_t master[OAM_N_TYPES];
4110 uint32_t slave[OAM_N_TYPES];
4112 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4113 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4114 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4116 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4117 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4118 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4120 ofconn_set_async_config(ofconn, master, slave);
4121 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4122 !ofconn_get_miss_send_len(ofconn)) {
4123 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4130 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4133 uint32_t master[OAM_N_TYPES];
4134 uint32_t slave[OAM_N_TYPES];
4135 struct nx_async_config *msg;
4137 ofconn_get_async_config(ofconn, master, slave);
4138 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4139 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4141 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4142 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4143 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4145 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4146 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4147 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4149 ofconn_send_reply(ofconn, buf);
4155 handle_nxt_set_controller_id(struct ofconn *ofconn,
4156 const struct ofp_header *oh)
4158 const struct nx_controller_id *nci = ofpmsg_body(oh);
4160 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4161 return OFPERR_NXBRC_MUST_BE_ZERO;
4164 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4169 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4173 if (ofconn_has_pending_opgroups(ofconn)) {
4174 return OFPROTO_POSTPONE;
4177 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4178 ? OFPRAW_OFPT10_BARRIER_REPLY
4179 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4180 ofconn_send_reply(ofconn, buf);
4185 ofproto_compose_flow_refresh_update(const struct rule *rule,
4186 enum nx_flow_monitor_flags flags,
4189 struct ofoperation *op = rule->pending;
4190 struct ofputil_flow_update fu;
4193 if (op && op->type == OFOPERATION_ADD) {
4194 /* We'll report the final flow when the operation completes. Reporting
4195 * it now would cause a duplicate report later. */
4199 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4200 ? NXFME_ADDED : NXFME_MODIFIED);
4202 ovs_mutex_lock(&rule->timeout_mutex);
4203 fu.idle_timeout = rule->idle_timeout;
4204 fu.hard_timeout = rule->hard_timeout;
4205 ovs_mutex_unlock(&rule->timeout_mutex);
4206 fu.table_id = rule->table_id;
4207 fu.cookie = rule->flow_cookie;
4208 minimatch_expand(&rule->cr.match, &match);
4210 fu.priority = rule->cr.priority;
4211 if (!(flags & NXFMF_ACTIONS)) {
4215 fu.ofpacts = rule->ofpacts;
4216 fu.ofpacts_len = rule->ofpacts_len;
4218 /* An operation is in progress. Use the previous version of the flow's
4219 * actions, so that when the operation commits we report the change. */
4221 case OFOPERATION_ADD:
4224 case OFOPERATION_MODIFY:
4225 case OFOPERATION_REPLACE:
4227 fu.ofpacts = op->ofpacts;
4228 fu.ofpacts_len = op->ofpacts_len;
4230 fu.ofpacts = rule->ofpacts;
4231 fu.ofpacts_len = rule->ofpacts_len;
4235 case OFOPERATION_DELETE:
4236 fu.ofpacts = rule->ofpacts;
4237 fu.ofpacts_len = rule->ofpacts_len;
4245 if (list_is_empty(msgs)) {
4246 ofputil_start_flow_update(msgs);
4248 ofputil_append_flow_update(&fu, msgs);
4252 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
4256 LIST_FOR_EACH (rule, ofproto_node, rules) {
4257 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4258 rule->monitor_flags = 0;
4260 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4265 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4266 struct rule *rule, uint64_t seqno,
4269 enum nx_flow_monitor_flags update;
4271 if (ofproto_rule_is_hidden(rule)) {
4276 ? ofoperation_has_out_port(rule->pending, m->out_port)
4277 : ofproto_rule_has_out_port(rule, m->out_port))) {
4282 if (rule->add_seqno > seqno) {
4283 update = NXFMF_ADD | NXFMF_MODIFY;
4284 } else if (rule->modify_seqno > seqno) {
4285 update = NXFMF_MODIFY;
4290 if (!(m->flags & update)) {
4294 update = NXFMF_INITIAL;
4297 if (!rule->monitor_flags) {
4298 list_push_back(rules, &rule->ofproto_node);
4300 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4304 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4308 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4309 const struct ofoperation *op;
4310 const struct oftable *table;
4311 struct cls_rule target;
4313 cls_rule_init_from_minimatch(&target, &m->match, 0);
4314 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4315 struct cls_cursor cursor;
4318 ovs_rwlock_rdlock(&table->cls.rwlock);
4319 cls_cursor_init(&cursor, &table->cls, &target);
4320 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4321 ovs_assert(!rule->pending); /* XXX */
4322 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4324 ovs_rwlock_unlock(&table->cls.rwlock);
4327 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4328 struct rule *rule = op->rule;
4330 if (((m->table_id == 0xff
4331 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4332 : m->table_id == rule->table_id))
4333 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4334 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4337 cls_rule_destroy(&target);
4341 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4344 if (m->flags & NXFMF_INITIAL) {
4345 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4350 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4351 uint64_t seqno, struct list *rules)
4353 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4357 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4359 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4360 struct ofmonitor **monitors;
4361 size_t n_monitors, allocated_monitors;
4362 struct list replies;
4369 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4371 n_monitors = allocated_monitors = 0;
4373 struct ofputil_flow_monitor_request request;
4374 struct ofmonitor *m;
4377 retval = ofputil_decode_flow_monitor_request(&request, &b);
4378 if (retval == EOF) {
4380 } else if (retval) {
4385 if (request.table_id != 0xff
4386 && request.table_id >= ofproto->n_tables) {
4387 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4391 error = ofmonitor_create(&request, ofconn, &m);
4396 if (n_monitors >= allocated_monitors) {
4397 monitors = x2nrealloc(monitors, &allocated_monitors,
4400 monitors[n_monitors++] = m;
4404 for (i = 0; i < n_monitors; i++) {
4405 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4408 ofpmp_init(&replies, oh);
4409 ofmonitor_compose_refresh_updates(&rules, &replies);
4410 ofconn_send_replies(ofconn, &replies);
4417 for (i = 0; i < n_monitors; i++) {
4418 ofmonitor_destroy(monitors[i]);
4425 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4427 struct ofmonitor *m;
4430 id = ofputil_decode_flow_monitor_cancel(oh);
4431 m = ofmonitor_lookup(ofconn, id);
4433 return OFPERR_NXBRC_FM_BAD_ID;
4436 ofmonitor_destroy(m);
4440 /* Meters implementation.
4442 * Meter table entry, indexed by the OpenFlow meter_id.
4443 * These are always dynamically allocated to allocate enough space for
4445 * 'created' is used to compute the duration for meter stats.
4446 * 'list rules' is needed so that we can delete the dependent rules when the
4447 * meter table entry is deleted.
4448 * 'provider_meter_id' is for the provider's private use.
4451 long long int created; /* Time created. */
4452 struct list rules; /* List of "struct rule_dpif"s. */
4453 ofproto_meter_id provider_meter_id;
4454 uint16_t flags; /* Meter flags. */
4455 uint16_t n_bands; /* Number of meter bands. */
4456 struct ofputil_meter_band *bands;
4460 * This is used in instruction validation at flow set-up time,
4461 * as flows may not use non-existing meters.
4462 * This is also used by ofproto-providers to translate OpenFlow meter_ids
4463 * in METER instructions to the corresponding provider meter IDs.
4464 * Return value of UINT32_MAX signifies an invalid meter.
4467 ofproto_get_provider_meter_id(const struct ofproto * ofproto,
4468 uint32_t of_meter_id)
4470 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
4471 const struct meter *meter = ofproto->meters[of_meter_id];
4473 return meter->provider_meter_id.uint32;
4480 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
4484 meter->flags = config->flags;
4485 meter->n_bands = config->n_bands;
4486 meter->bands = xmemdup(config->bands,
4487 config->n_bands * sizeof *meter->bands);
4490 static struct meter *
4491 meter_create(const struct ofputil_meter_config *config,
4492 ofproto_meter_id provider_meter_id)
4494 struct meter *meter;
4496 meter = xzalloc(sizeof *meter);
4497 meter->provider_meter_id = provider_meter_id;
4498 meter->created = time_msec();
4499 list_init(&meter->rules);
4501 meter_update(meter, config);
4507 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
4510 for (mid = first; mid <= last; ++mid) {
4511 struct meter *meter = ofproto->meters[mid];
4513 ofproto->meters[mid] = NULL;
4514 ofproto->ofproto_class->meter_del(ofproto,
4515 meter->provider_meter_id);
4523 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4525 ofproto_meter_id provider_meter_id = { UINT32_MAX };
4526 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
4530 return OFPERR_OFPMMFC_METER_EXISTS;
4533 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
4536 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
4537 *meterp = meter_create(&mm->meter, provider_meter_id);
4543 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4545 struct meter *meter = ofproto->meters[mm->meter.meter_id];
4549 return OFPERR_OFPMMFC_UNKNOWN_METER;
4552 error = ofproto->ofproto_class->meter_set(ofproto,
4553 &meter->provider_meter_id,
4555 ovs_assert(meter->provider_meter_id.uint32 != UINT32_MAX);
4557 meter_update(meter, &mm->meter);
4563 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
4564 struct ofputil_meter_mod *mm)
4566 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4567 uint32_t meter_id = mm->meter.meter_id;
4568 uint32_t first, last;
4571 if (meter_id == OFPM13_ALL) {
4573 last = ofproto->meter_features.max_meters;
4575 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
4578 first = last = meter_id;
4581 /* First delete the rules that use this meter. If any of those rules are
4582 * currently being modified, postpone the whole operation until later. */
4584 for (meter_id = first; meter_id <= last; ++meter_id) {
4585 struct meter *meter = ofproto->meters[meter_id];
4586 if (meter && !list_is_empty(&meter->rules)) {
4589 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
4590 if (rule->pending) {
4591 return OFPROTO_POSTPONE;
4593 list_push_back(&rules, &rule->ofproto_node);
4597 if (!list_is_empty(&rules)) {
4598 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
4601 /* Delete the meters. */
4602 meter_delete(ofproto, first, last);
4608 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4610 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4611 struct ofputil_meter_mod mm;
4612 uint64_t bands_stub[256 / 8];
4613 struct ofpbuf bands;
4617 error = reject_slave_controller(ofconn);
4622 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
4624 error = ofputil_decode_meter_mod(oh, &mm, &bands);
4626 goto exit_free_bands;
4629 meter_id = mm.meter.meter_id;
4631 if (mm.command != OFPMC13_DELETE) {
4632 /* Fails also when meters are not implemented by the provider. */
4633 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
4634 error = OFPERR_OFPMMFC_INVALID_METER;
4635 goto exit_free_bands;
4637 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
4638 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
4639 goto exit_free_bands;
4643 switch (mm.command) {
4645 error = handle_add_meter(ofproto, &mm);
4648 case OFPMC13_MODIFY:
4649 error = handle_modify_meter(ofproto, &mm);
4652 case OFPMC13_DELETE:
4653 error = handle_delete_meter(ofconn, oh, &mm);
4657 error = OFPERR_OFPMMFC_BAD_COMMAND;
4662 ofpbuf_uninit(&bands);
4667 handle_meter_features_request(struct ofconn *ofconn,
4668 const struct ofp_header *request)
4670 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4671 struct ofputil_meter_features features;
4674 if (ofproto->ofproto_class->meter_get_features) {
4675 ofproto->ofproto_class->meter_get_features(ofproto, &features);
4677 memset(&features, 0, sizeof features);
4679 b = ofputil_encode_meter_features_reply(&features, request);
4681 ofconn_send_reply(ofconn, b);
4686 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
4689 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4690 struct list replies;
4691 uint64_t bands_stub[256 / 8];
4692 struct ofpbuf bands;
4693 uint32_t meter_id, first, last;
4695 ofputil_decode_meter_request(request, &meter_id);
4697 if (meter_id == OFPM13_ALL) {
4699 last = ofproto->meter_features.max_meters;
4701 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
4702 !ofproto->meters[meter_id]) {
4703 return OFPERR_OFPMMFC_UNKNOWN_METER;
4705 first = last = meter_id;
4708 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
4709 ofpmp_init(&replies, request);
4711 for (meter_id = first; meter_id <= last; ++meter_id) {
4712 struct meter *meter = ofproto->meters[meter_id];
4714 continue; /* Skip non-existing meters. */
4716 if (type == OFPTYPE_METER_STATS_REQUEST) {
4717 struct ofputil_meter_stats stats;
4719 stats.meter_id = meter_id;
4721 /* Provider sets the packet and byte counts, we do the rest. */
4722 stats.flow_count = list_size(&meter->rules);
4723 calc_duration(meter->created, time_msec(),
4724 &stats.duration_sec, &stats.duration_nsec);
4725 stats.n_bands = meter->n_bands;
4726 ofpbuf_clear(&bands);
4728 = ofpbuf_put_uninit(&bands,
4729 meter->n_bands * sizeof *stats.bands);
4731 if (!ofproto->ofproto_class->meter_get(ofproto,
4732 meter->provider_meter_id,
4734 ofputil_append_meter_stats(&replies, &stats);
4736 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
4737 struct ofputil_meter_config config;
4739 config.meter_id = meter_id;
4740 config.flags = meter->flags;
4741 config.n_bands = meter->n_bands;
4742 config.bands = meter->bands;
4743 ofputil_append_meter_config(&replies, &config);
4747 ofconn_send_replies(ofconn, &replies);
4748 ofpbuf_uninit(&bands);
4753 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
4754 struct ofgroup **group)
4755 OVS_TRY_RDLOCK(true, (*group)->rwlock)
4757 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
4758 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
4759 hash_int(group_id, 0), &ofproto->groups) {
4760 if ((*group)->group_id == group_id) {
4761 ovs_rwlock_rdlock(&(*group)->rwlock);
4762 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4766 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4771 ofproto_group_release(struct ofgroup *group)
4772 OVS_RELEASES(group->rwlock)
4774 ovs_rwlock_unlock(&group->rwlock);
4778 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
4779 struct ofgroup **group)
4780 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
4781 OVS_TRY_WRLOCK(true, (*group)->rwlock)
4783 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
4784 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
4785 hash_int(group_id, 0), &ofproto->groups) {
4786 if ((*group)->group_id == group_id) {
4787 ovs_rwlock_wrlock(&(*group)->rwlock);
4791 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4796 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
4797 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
4799 struct ofgroup *grp;
4801 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
4802 hash_int(group_id, 0), &ofproto->groups) {
4803 if (grp->group_id == group_id) {
4811 append_group_stats(struct ofgroup *group, struct list *replies)
4812 OVS_REQ_RDLOCK(group->rwlock)
4814 struct ofputil_group_stats ogs;
4815 struct ofproto *ofproto = group->ofproto;
4816 long long int now = time_msec();
4819 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
4821 error = (ofproto->ofproto_class->group_get_stats
4822 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
4825 ogs.ref_count = UINT32_MAX;
4826 ogs.packet_count = UINT64_MAX;
4827 ogs.byte_count = UINT64_MAX;
4828 ogs.n_buckets = group->n_buckets;
4829 memset(ogs.bucket_stats, 0xff,
4830 ogs.n_buckets * sizeof *ogs.bucket_stats);
4833 ogs.group_id = group->group_id;
4834 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
4836 ofputil_append_group_stats(replies, &ogs);
4838 free(ogs.bucket_stats);
4842 handle_group_stats_request(struct ofconn *ofconn,
4843 const struct ofp_header *request)
4845 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4846 struct list replies;
4848 struct ofgroup *group;
4851 error = ofputil_decode_group_stats_request(request, &group_id);
4856 ofpmp_init(&replies, request);
4858 if (group_id == OFPG_ALL) {
4859 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
4860 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
4861 ovs_rwlock_rdlock(&group->rwlock);
4862 append_group_stats(group, &replies);
4863 ovs_rwlock_unlock(&group->rwlock);
4865 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4867 if (ofproto_group_lookup(ofproto, group_id, &group)) {
4868 append_group_stats(group, &replies);
4869 ofproto_group_release(group);
4873 ofconn_send_replies(ofconn, &replies);
4879 handle_group_desc_stats_request(struct ofconn *ofconn,
4880 const struct ofp_header *request)
4882 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4883 struct list replies;
4884 struct ofputil_group_desc gds;
4885 struct ofgroup *group;
4887 ofpmp_init(&replies, request);
4889 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
4890 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
4891 gds.group_id = group->group_id;
4892 gds.type = group->type;
4893 ofputil_append_group_desc_reply(&gds, &group->buckets, &replies);
4895 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4897 ofconn_send_replies(ofconn, &replies);
4903 handle_group_features_stats_request(struct ofconn *ofconn,
4904 const struct ofp_header *request)
4906 struct ofproto *p = ofconn_get_ofproto(ofconn);
4909 msg = ofputil_encode_group_features_reply(&p->ogf, request);
4911 ofconn_send_reply(ofconn, msg);
4917 /* Implements OFPGC11_ADD
4918 * in which no matching flow already exists in the flow table.
4920 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4921 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4922 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4923 * initiated now but may be retried later.
4925 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
4926 * ownership remains with the caller.
4928 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4931 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
4933 struct ofgroup *ofgroup;
4936 if (gm->group_id > OFPG_MAX) {
4937 return OFPERR_OFPGMFC_INVALID_GROUP;
4939 if (gm->type > OFPGT11_FF) {
4940 return OFPERR_OFPGMFC_BAD_TYPE;
4943 /* Allocate new group and initialize it. */
4944 ofgroup = ofproto->ofproto_class->group_alloc();
4946 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
4947 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
4950 ovs_rwlock_init(&ofgroup->rwlock);
4951 ofgroup->ofproto = ofproto;
4952 ofgroup->group_id = gm->group_id;
4953 ofgroup->type = gm->type;
4954 ofgroup->created = ofgroup->modified = time_msec();
4956 list_move(&ofgroup->buckets, &gm->buckets);
4957 ofgroup->n_buckets = list_size(&ofgroup->buckets);
4959 /* Construct called BEFORE any locks are held. */
4960 error = ofproto->ofproto_class->group_construct(ofgroup);
4965 /* We wrlock as late as possible to minimize the time we jam any other
4966 * threads: No visible state changes before acquiring the lock. */
4967 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
4969 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
4970 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
4974 if (ofproto_group_exists(ofproto, gm->group_id)) {
4975 error = OFPERR_OFPGMFC_GROUP_EXISTS;
4980 /* Insert new group. */
4981 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
4982 hash_int(ofgroup->group_id, 0));
4983 ofproto->n_groups[ofgroup->type]++;
4985 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4990 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4991 ofproto->ofproto_class->group_destruct(ofgroup);
4993 ofputil_bucket_list_destroy(&ofgroup->buckets);
4994 ofproto->ofproto_class->group_dealloc(ofgroup);
4999 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5002 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5005 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5007 struct ofgroup *ofgroup;
5008 struct ofgroup *victim;
5011 if (gm->group_id > OFPG_MAX) {
5012 return OFPERR_OFPGMFC_INVALID_GROUP;
5015 if (gm->type > OFPGT11_FF) {
5016 return OFPERR_OFPGMFC_BAD_TYPE;
5019 victim = ofproto->ofproto_class->group_alloc();
5021 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5022 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5025 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5026 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5029 /* Both group's and its container's write locks held now.
5030 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5031 if (ofgroup->type != gm->type
5032 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5033 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5038 list_move(&victim->buckets, &ofgroup->buckets);
5040 ofgroup->type = gm->type;
5041 list_move(&ofgroup->buckets, &gm->buckets);
5042 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5044 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5046 ofputil_bucket_list_destroy(&victim->buckets);
5047 ofproto->n_groups[victim->type]--;
5048 ofproto->n_groups[ofgroup->type]++;
5049 ofgroup->modified = time_msec();
5051 ofputil_bucket_list_destroy(&ofgroup->buckets);
5054 list_move(&ofgroup->buckets, &victim->buckets);
5058 ovs_rwlock_unlock(&ofgroup->rwlock);
5059 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5061 ofproto->ofproto_class->group_dealloc(victim);
5066 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5067 OVS_RELEASES(ofproto->groups_rwlock)
5069 /* Must wait until existing readers are done,
5070 * while holding the container's write lock at the same time. */
5071 ovs_rwlock_wrlock(&ofgroup->rwlock);
5072 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5073 /* No-one can find this group any more. */
5074 ofproto->n_groups[ofgroup->type]--;
5075 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5077 ofproto->ofproto_class->group_destruct(ofgroup);
5078 ofputil_bucket_list_destroy(&ofgroup->buckets);
5079 ovs_rwlock_unlock(&ofgroup->rwlock);
5080 ovs_rwlock_destroy(&ofgroup->rwlock);
5081 ofproto->ofproto_class->group_dealloc(ofgroup);
5084 /* Implements OFPGC_DELETE. */
5086 delete_group(struct ofproto *ofproto, uint32_t group_id)
5088 struct ofgroup *ofgroup;
5090 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5091 if (group_id == OFPG_ALL) {
5093 struct hmap_node *node = hmap_first(&ofproto->groups);
5097 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5098 delete_group__(ofproto, ofgroup);
5099 /* Lock for each node separately, so that we will not jam the
5100 * other threads for too long time. */
5101 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5104 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5105 hash_int(group_id, 0), &ofproto->groups) {
5106 if (ofgroup->group_id == group_id) {
5107 delete_group__(ofproto, ofgroup);
5112 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5116 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5118 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5119 struct ofputil_group_mod gm;
5122 error = reject_slave_controller(ofconn);
5127 error = ofputil_decode_group_mod(oh, &gm);
5132 switch (gm.command) {
5134 return add_group(ofproto, &gm);
5136 case OFPGC11_MODIFY:
5137 return modify_group(ofproto, &gm);
5139 case OFPGC11_DELETE:
5140 delete_group(ofproto, gm.group_id);
5144 if (gm.command > OFPGC11_DELETE) {
5145 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5146 ofproto->name, gm.command);
5148 return OFPERR_OFPGMFC_BAD_COMMAND;
5153 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5155 struct ofputil_table_mod tm;
5158 error = reject_slave_controller(ofconn);
5163 error = ofputil_decode_table_mod(oh, &tm);
5168 /* XXX Actual table mod support is not implemented yet. */
5173 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5175 const struct ofp_header *oh = msg->data;
5179 error = ofptype_decode(&type, oh);
5185 /* OpenFlow requests. */
5186 case OFPTYPE_ECHO_REQUEST:
5187 return handle_echo_request(ofconn, oh);
5189 case OFPTYPE_FEATURES_REQUEST:
5190 return handle_features_request(ofconn, oh);
5192 case OFPTYPE_GET_CONFIG_REQUEST:
5193 return handle_get_config_request(ofconn, oh);
5195 case OFPTYPE_SET_CONFIG:
5196 return handle_set_config(ofconn, oh);
5198 case OFPTYPE_PACKET_OUT:
5199 return handle_packet_out(ofconn, oh);
5201 case OFPTYPE_PORT_MOD:
5202 return handle_port_mod(ofconn, oh);
5204 case OFPTYPE_FLOW_MOD:
5205 return handle_flow_mod(ofconn, oh);
5207 case OFPTYPE_GROUP_MOD:
5208 return handle_group_mod(ofconn, oh);
5210 case OFPTYPE_TABLE_MOD:
5211 return handle_table_mod(ofconn, oh);
5213 case OFPTYPE_METER_MOD:
5214 return handle_meter_mod(ofconn, oh);
5216 case OFPTYPE_BARRIER_REQUEST:
5217 return handle_barrier_request(ofconn, oh);
5219 case OFPTYPE_ROLE_REQUEST:
5220 return handle_role_request(ofconn, oh);
5222 /* OpenFlow replies. */
5223 case OFPTYPE_ECHO_REPLY:
5226 /* Nicira extension requests. */
5227 case OFPTYPE_FLOW_MOD_TABLE_ID:
5228 return handle_nxt_flow_mod_table_id(ofconn, oh);
5230 case OFPTYPE_SET_FLOW_FORMAT:
5231 return handle_nxt_set_flow_format(ofconn, oh);
5233 case OFPTYPE_SET_PACKET_IN_FORMAT:
5234 return handle_nxt_set_packet_in_format(ofconn, oh);
5236 case OFPTYPE_SET_CONTROLLER_ID:
5237 return handle_nxt_set_controller_id(ofconn, oh);
5239 case OFPTYPE_FLOW_AGE:
5240 /* Nothing to do. */
5243 case OFPTYPE_FLOW_MONITOR_CANCEL:
5244 return handle_flow_monitor_cancel(ofconn, oh);
5246 case OFPTYPE_SET_ASYNC_CONFIG:
5247 return handle_nxt_set_async_config(ofconn, oh);
5249 case OFPTYPE_GET_ASYNC_REQUEST:
5250 return handle_nxt_get_async_request(ofconn, oh);
5252 /* Statistics requests. */
5253 case OFPTYPE_DESC_STATS_REQUEST:
5254 return handle_desc_stats_request(ofconn, oh);
5256 case OFPTYPE_FLOW_STATS_REQUEST:
5257 return handle_flow_stats_request(ofconn, oh);
5259 case OFPTYPE_AGGREGATE_STATS_REQUEST:
5260 return handle_aggregate_stats_request(ofconn, oh);
5262 case OFPTYPE_TABLE_STATS_REQUEST:
5263 return handle_table_stats_request(ofconn, oh);
5265 case OFPTYPE_PORT_STATS_REQUEST:
5266 return handle_port_stats_request(ofconn, oh);
5268 case OFPTYPE_QUEUE_STATS_REQUEST:
5269 return handle_queue_stats_request(ofconn, oh);
5271 case OFPTYPE_PORT_DESC_STATS_REQUEST:
5272 return handle_port_desc_stats_request(ofconn, oh);
5274 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
5275 return handle_flow_monitor_request(ofconn, oh);
5277 case OFPTYPE_METER_STATS_REQUEST:
5278 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
5279 return handle_meter_request(ofconn, oh, type);
5281 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
5282 return handle_meter_features_request(ofconn, oh);
5284 case OFPTYPE_GROUP_STATS_REQUEST:
5285 return handle_group_stats_request(ofconn, oh);
5287 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
5288 return handle_group_desc_stats_request(ofconn, oh);
5290 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
5291 return handle_group_features_stats_request(ofconn, oh);
5293 /* FIXME: Change the following once they are implemented: */
5294 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
5295 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
5296 return OFPERR_OFPBRC_BAD_TYPE;
5300 case OFPTYPE_FEATURES_REPLY:
5301 case OFPTYPE_GET_CONFIG_REPLY:
5302 case OFPTYPE_PACKET_IN:
5303 case OFPTYPE_FLOW_REMOVED:
5304 case OFPTYPE_PORT_STATUS:
5305 case OFPTYPE_BARRIER_REPLY:
5306 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
5307 case OFPTYPE_DESC_STATS_REPLY:
5308 case OFPTYPE_FLOW_STATS_REPLY:
5309 case OFPTYPE_QUEUE_STATS_REPLY:
5310 case OFPTYPE_PORT_STATS_REPLY:
5311 case OFPTYPE_TABLE_STATS_REPLY:
5312 case OFPTYPE_AGGREGATE_STATS_REPLY:
5313 case OFPTYPE_PORT_DESC_STATS_REPLY:
5314 case OFPTYPE_ROLE_REPLY:
5315 case OFPTYPE_FLOW_MONITOR_PAUSED:
5316 case OFPTYPE_FLOW_MONITOR_RESUMED:
5317 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
5318 case OFPTYPE_GET_ASYNC_REPLY:
5319 case OFPTYPE_GROUP_STATS_REPLY:
5320 case OFPTYPE_GROUP_DESC_STATS_REPLY:
5321 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
5322 case OFPTYPE_METER_STATS_REPLY:
5323 case OFPTYPE_METER_CONFIG_STATS_REPLY:
5324 case OFPTYPE_METER_FEATURES_STATS_REPLY:
5325 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
5327 return OFPERR_OFPBRC_BAD_TYPE;
5332 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
5334 int error = handle_openflow__(ofconn, ofp_msg);
5335 if (error && error != OFPROTO_POSTPONE) {
5336 ofconn_send_error(ofconn, ofp_msg->data, error);
5338 COVERAGE_INC(ofproto_recv_openflow);
5339 return error != OFPROTO_POSTPONE;
5342 /* Asynchronous operations. */
5344 /* Creates and returns a new ofopgroup that is not associated with any
5345 * OpenFlow connection.
5347 * The caller should add operations to the returned group with
5348 * ofoperation_create() and then submit it with ofopgroup_submit(). */
5349 static struct ofopgroup *
5350 ofopgroup_create_unattached(struct ofproto *ofproto)
5352 struct ofopgroup *group = xzalloc(sizeof *group);
5353 group->ofproto = ofproto;
5354 list_init(&group->ofproto_node);
5355 list_init(&group->ops);
5356 list_init(&group->ofconn_node);
5360 /* Creates and returns a new ofopgroup for 'ofproto'.
5362 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
5363 * connection. The 'request' and 'buffer_id' arguments are ignored.
5365 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
5366 * If the ofopgroup eventually fails, then the error reply will include
5367 * 'request'. If the ofopgroup eventually succeeds, then the packet with
5368 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
5370 * The caller should add operations to the returned group with
5371 * ofoperation_create() and then submit it with ofopgroup_submit(). */
5372 static struct ofopgroup *
5373 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
5374 const struct ofp_header *request, uint32_t buffer_id)
5376 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
5378 size_t request_len = ntohs(request->length);
5380 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
5382 ofconn_add_opgroup(ofconn, &group->ofconn_node);
5383 group->ofconn = ofconn;
5384 group->request = xmemdup(request, MIN(request_len, 64));
5385 group->buffer_id = buffer_id;
5390 /* Submits 'group' for processing.
5392 * If 'group' contains no operations (e.g. none were ever added, or all of the
5393 * ones that were added completed synchronously), then it is destroyed
5394 * immediately. Otherwise it is added to the ofproto's list of pending
5397 ofopgroup_submit(struct ofopgroup *group)
5399 if (!group->n_running) {
5400 ofopgroup_complete(group);
5402 list_push_back(&group->ofproto->pending, &group->ofproto_node);
5403 group->ofproto->n_pending++;
5408 ofopgroup_complete(struct ofopgroup *group)
5410 struct ofproto *ofproto = group->ofproto;
5412 struct ofconn *abbrev_ofconn;
5413 ovs_be32 abbrev_xid;
5415 struct ofoperation *op, *next_op;
5418 ovs_assert(!group->n_running);
5421 LIST_FOR_EACH (op, group_node, &group->ops) {
5428 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
5429 LIST_FOR_EACH (op, group_node, &group->ops) {
5430 if (op->type != OFOPERATION_DELETE) {
5431 struct ofpbuf *packet;
5434 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
5438 error = rule_execute(op->rule, in_port, packet);
5445 if (!error && !list_is_empty(&group->ofconn_node)) {
5446 abbrev_ofconn = group->ofconn;
5447 abbrev_xid = group->request->xid;
5449 abbrev_ofconn = NULL;
5450 abbrev_xid = htonl(0);
5452 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
5453 struct rule *rule = op->rule;
5455 /* We generally want to report the change to active OpenFlow flow
5456 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
5458 - The operation failed.
5460 - The affected rule is not visible to controllers.
5462 - The operation's only effect was to update rule->modified. */
5464 || ofproto_rule_is_hidden(rule)
5465 || (op->type == OFOPERATION_MODIFY
5467 && rule->flow_cookie == op->flow_cookie))) {
5468 /* Check that we can just cast from ofoperation_type to
5469 * nx_flow_update_event. */
5470 enum nx_flow_update_event event_type;
5473 case OFOPERATION_ADD:
5474 case OFOPERATION_REPLACE:
5475 event_type = NXFME_ADDED;
5478 case OFOPERATION_DELETE:
5479 event_type = NXFME_DELETED;
5482 case OFOPERATION_MODIFY:
5483 event_type = NXFME_MODIFIED;
5490 ofmonitor_report(ofproto->connmgr, rule, event_type,
5491 op->reason, abbrev_ofconn, abbrev_xid);
5494 rule->pending = NULL;
5497 case OFOPERATION_ADD:
5501 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
5502 if (vid_mask == VLAN_VID_MASK) {
5503 if (ofproto->vlan_bitmap) {
5504 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
5505 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
5506 bitmap_set1(ofproto->vlan_bitmap, vid);
5507 ofproto->vlans_changed = true;
5510 ofproto->vlans_changed = true;
5514 ovs_rwlock_wrlock(&rule->rwlock);
5515 oftable_remove_rule(rule);
5516 ofproto_rule_destroy(rule);
5520 case OFOPERATION_DELETE:
5521 ovs_assert(!op->error);
5522 ofproto_rule_destroy(rule);
5526 case OFOPERATION_MODIFY:
5527 case OFOPERATION_REPLACE:
5529 long long int now = time_msec();
5531 rule->modified = now;
5532 if (op->type == OFOPERATION_REPLACE) {
5533 rule->created = rule->used = now;
5536 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
5537 ovs_mutex_lock(&rule->timeout_mutex);
5538 rule->idle_timeout = op->idle_timeout;
5539 rule->hard_timeout = op->hard_timeout;
5540 ovs_mutex_unlock(&rule->timeout_mutex);
5542 free(rule->ofpacts);
5544 ovs_rwlock_wrlock(&rule->rwlock);
5545 rule->ofpacts = op->ofpacts;
5546 rule->ofpacts_len = op->ofpacts_len;
5547 ovs_rwlock_unlock(&rule->rwlock);
5550 op->ofpacts_len = 0;
5552 rule->flags = op->flags;
5560 ofoperation_destroy(op);
5563 ofmonitor_flush(ofproto->connmgr);
5565 if (!list_is_empty(&group->ofproto_node)) {
5566 ovs_assert(ofproto->n_pending > 0);
5567 ofproto->n_pending--;
5568 list_remove(&group->ofproto_node);
5570 if (!list_is_empty(&group->ofconn_node)) {
5571 list_remove(&group->ofconn_node);
5573 ofconn_send_error(group->ofconn, group->request, error);
5575 connmgr_retry(ofproto->connmgr);
5577 free(group->request);
5581 /* Initiates a new operation on 'rule', of the specified 'type', within
5582 * 'group'. Prior to calling, 'rule' must not have any pending operation.
5584 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
5585 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
5587 * Returns the newly created ofoperation (which is also available as
5588 * rule->pending). */
5589 static struct ofoperation *
5590 ofoperation_create(struct ofopgroup *group, struct rule *rule,
5591 enum ofoperation_type type,
5592 enum ofp_flow_removed_reason reason)
5594 struct ofproto *ofproto = group->ofproto;
5595 struct ofoperation *op;
5597 ovs_assert(!rule->pending);
5599 op = rule->pending = xzalloc(sizeof *op);
5601 list_push_back(&group->ops, &op->group_node);
5604 op->reason = reason;
5605 op->flow_cookie = rule->flow_cookie;
5606 ovs_mutex_lock(&rule->timeout_mutex);
5607 op->idle_timeout = rule->idle_timeout;
5608 op->hard_timeout = rule->hard_timeout;
5609 ovs_mutex_unlock(&rule->timeout_mutex);
5610 op->flags = rule->flags;
5614 if (type == OFOPERATION_DELETE) {
5615 hmap_insert(&ofproto->deletions, &op->hmap_node,
5616 cls_rule_hash(&rule->cr, rule->table_id));
5623 ofoperation_destroy(struct ofoperation *op)
5625 struct ofopgroup *group = op->group;
5628 op->rule->pending = NULL;
5630 if (op->type == OFOPERATION_DELETE) {
5631 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
5633 list_remove(&op->group_node);
5638 /* Indicates that 'op' completed with status 'error', which is either 0 to
5639 * indicate success or an OpenFlow error code on failure.
5641 * If 'error' is 0, indicating success, the operation will be committed
5642 * permanently to the flow table.
5644 * If 'error' is nonzero, then generally the operation will be rolled back:
5646 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
5647 * restores the original rule. The caller must have uninitialized any
5648 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
5649 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
5650 * and 7 for the new rule, calling its ->rule_dealloc() function.
5652 * - If 'op' is a "modify flow" operation, ofproto restores the original
5655 * - 'op' must not be a "delete flow" operation. Removing a rule is not
5656 * allowed to fail. It must always succeed.
5658 * Please see the large comment in ofproto/ofproto-provider.h titled
5659 * "Asynchronous Operation Support" for more information. */
5661 ofoperation_complete(struct ofoperation *op, enum ofperr error)
5663 struct ofopgroup *group = op->group;
5665 ovs_assert(op->rule->pending == op);
5666 ovs_assert(group->n_running > 0);
5667 ovs_assert(!error || op->type != OFOPERATION_DELETE);
5670 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
5671 ofopgroup_complete(group);
5676 pick_datapath_id(const struct ofproto *ofproto)
5678 const struct ofport *port;
5680 port = ofproto_get_port(ofproto, OFPP_LOCAL);
5682 uint8_t ea[ETH_ADDR_LEN];
5685 error = netdev_get_etheraddr(port->netdev, ea);
5687 return eth_addr_to_uint64(ea);
5689 VLOG_WARN("%s: could not get MAC address for %s (%s)",
5690 ofproto->name, netdev_get_name(port->netdev),
5691 ovs_strerror(error));
5693 return ofproto->fallback_dpid;
5697 pick_fallback_dpid(void)
5699 uint8_t ea[ETH_ADDR_LEN];
5700 eth_addr_nicira_random(ea);
5701 return eth_addr_to_uint64(ea);
5704 /* Table overflow policy. */
5706 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
5707 * to NULL if the table is not configured to evict rules or if the table
5708 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
5709 * or with no timeouts are not evictable.) */
5711 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
5713 struct eviction_group *evg;
5716 if (!table->eviction_fields) {
5720 /* In the common case, the outer and inner loops here will each be entered
5723 * - The inner loop normally "return"s in its first iteration. If the
5724 * eviction group has any evictable rules, then it always returns in
5727 * - The outer loop only iterates more than once if the largest eviction
5728 * group has no evictable rules.
5730 * - The outer loop can exit only if table's 'max_flows' is all filled up
5731 * by unevictable rules. */
5732 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
5735 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
5736 if (!ovs_rwlock_trywrlock(&rule->rwlock)) {
5746 /* Searches 'ofproto' for tables that have more flows than their configured
5747 * maximum and that have flow eviction enabled, and evicts as many flows as
5748 * necessary and currently feasible from them.
5750 * This triggers only when an OpenFlow table has N flows in it and then the
5751 * client configures a maximum number of flows less than N. */
5753 ofproto_evict(struct ofproto *ofproto)
5755 struct ofopgroup *group;
5756 struct oftable *table;
5758 group = ofopgroup_create_unattached(ofproto);
5759 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
5760 while (table->eviction_fields) {
5764 ovs_rwlock_rdlock(&table->cls.rwlock);
5765 n_rules = classifier_count(&table->cls);
5766 ovs_rwlock_unlock(&table->cls.rwlock);
5768 if (n_rules <= table->max_flows) {
5772 if (!choose_rule_to_evict(table, &rule)) {
5776 if (rule->pending) {
5777 ovs_rwlock_unlock(&rule->rwlock);
5781 ofoperation_create(group, rule,
5782 OFOPERATION_DELETE, OFPRR_EVICTION);
5783 oftable_remove_rule(rule);
5784 ofproto->ofproto_class->rule_delete(rule);
5787 ofopgroup_submit(group);
5790 /* Eviction groups. */
5792 /* Returns the priority to use for an eviction_group that contains 'n_rules'
5793 * rules. The priority contains low-order random bits to ensure that eviction
5794 * groups with the same number of rules are prioritized randomly. */
5796 eviction_group_priority(size_t n_rules)
5798 uint16_t size = MIN(UINT16_MAX, n_rules);
5799 return (size << 16) | random_uint16();
5802 /* Updates 'evg', an eviction_group within 'table', following a change that
5803 * adds or removes rules in 'evg'. */
5805 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
5807 heap_change(&table->eviction_groups_by_size, &evg->size_node,
5808 eviction_group_priority(heap_count(&evg->rules)));
5811 /* Destroys 'evg', an eviction_group within 'table':
5813 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
5814 * rules themselves, just removes them from the eviction group.)
5816 * - Removes 'evg' from 'table'.
5820 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
5822 while (!heap_is_empty(&evg->rules)) {
5825 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
5826 rule->eviction_group = NULL;
5828 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
5829 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
5830 heap_destroy(&evg->rules);
5834 /* Removes 'rule' from its eviction group, if any. */
5836 eviction_group_remove_rule(struct rule *rule)
5838 if (rule->eviction_group) {
5839 struct oftable *table = &rule->ofproto->tables[rule->table_id];
5840 struct eviction_group *evg = rule->eviction_group;
5842 rule->eviction_group = NULL;
5843 heap_remove(&evg->rules, &rule->evg_node);
5844 if (heap_is_empty(&evg->rules)) {
5845 eviction_group_destroy(table, evg);
5847 eviction_group_resized(table, evg);
5852 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
5853 * returns the hash value. */
5855 eviction_group_hash_rule(struct rule *rule)
5857 struct oftable *table = &rule->ofproto->tables[rule->table_id];
5858 const struct mf_subfield *sf;
5862 hash = table->eviction_group_id_basis;
5863 miniflow_expand(&rule->cr.match.flow, &flow);
5864 for (sf = table->eviction_fields;
5865 sf < &table->eviction_fields[table->n_eviction_fields];
5868 if (mf_are_prereqs_ok(sf->field, &flow)) {
5869 union mf_value value;
5871 mf_get_value(sf->field, &flow, &value);
5873 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
5875 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
5876 unsigned int start = sf->ofs + sf->n_bits;
5877 bitwise_zero(&value, sf->field->n_bytes, start,
5878 sf->field->n_bytes * 8 - start);
5880 hash = hash_bytes(&value, sf->field->n_bytes, hash);
5882 hash = hash_int(hash, 0);
5889 /* Returns an eviction group within 'table' with the given 'id', creating one
5891 static struct eviction_group *
5892 eviction_group_find(struct oftable *table, uint32_t id)
5894 struct eviction_group *evg;
5896 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
5900 evg = xmalloc(sizeof *evg);
5901 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
5902 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
5903 eviction_group_priority(0));
5904 heap_init(&evg->rules);
5909 /* Returns an eviction priority for 'rule'. The return value should be
5910 * interpreted so that higher priorities make a rule more attractive candidates
5913 rule_eviction_priority(struct rule *rule)
5915 long long int hard_expiration;
5916 long long int idle_expiration;
5917 long long int expiration;
5918 uint32_t expiration_offset;
5920 /* Calculate time of expiration. */
5921 ovs_mutex_lock(&rule->timeout_mutex);
5922 hard_expiration = (rule->hard_timeout
5923 ? rule->modified + rule->hard_timeout * 1000
5925 idle_expiration = (rule->idle_timeout
5926 ? rule->used + rule->idle_timeout * 1000
5928 expiration = MIN(hard_expiration, idle_expiration);
5929 ovs_mutex_unlock(&rule->timeout_mutex);
5930 if (expiration == LLONG_MAX) {
5934 /* Calculate the time of expiration as a number of (approximate) seconds
5935 * after program startup.
5937 * This should work OK for program runs that last UINT32_MAX seconds or
5938 * less. Therefore, please restart OVS at least once every 136 years. */
5939 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
5941 /* Invert the expiration offset because we're using a max-heap. */
5942 return UINT32_MAX - expiration_offset;
5945 /* Adds 'rule' to an appropriate eviction group for its oftable's
5946 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
5947 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
5950 * The caller must ensure that 'rule' is not already in an eviction group. */
5952 eviction_group_add_rule(struct rule *rule)
5954 struct ofproto *ofproto = rule->ofproto;
5955 struct oftable *table = &ofproto->tables[rule->table_id];
5958 ovs_mutex_lock(&rule->timeout_mutex);
5959 has_timeout = rule->hard_timeout || rule->idle_timeout;
5960 ovs_mutex_unlock(&rule->timeout_mutex);
5962 if (table->eviction_fields && has_timeout) {
5963 struct eviction_group *evg;
5965 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
5967 rule->eviction_group = evg;
5968 heap_insert(&evg->rules, &rule->evg_node,
5969 rule_eviction_priority(rule));
5970 eviction_group_resized(table, evg);
5976 /* Initializes 'table'. */
5978 oftable_init(struct oftable *table)
5980 memset(table, 0, sizeof *table);
5981 classifier_init(&table->cls);
5982 table->max_flows = UINT_MAX;
5985 /* Destroys 'table', including its classifier and eviction groups.
5987 * The caller is responsible for freeing 'table' itself. */
5989 oftable_destroy(struct oftable *table)
5991 ovs_rwlock_rdlock(&table->cls.rwlock);
5992 ovs_assert(classifier_is_empty(&table->cls));
5993 ovs_rwlock_unlock(&table->cls.rwlock);
5994 oftable_disable_eviction(table);
5995 classifier_destroy(&table->cls);
5999 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6000 * string, then 'table' will use its default name.
6002 * This only affects the name exposed for a table exposed through the OpenFlow
6003 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6005 oftable_set_name(struct oftable *table, const char *name)
6007 if (name && name[0]) {
6008 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6009 if (!table->name || strncmp(name, table->name, len)) {
6011 table->name = xmemdup0(name, len);
6019 /* oftables support a choice of two policies when adding a rule would cause the
6020 * number of flows in the table to exceed the configured maximum number: either
6021 * they can refuse to add the new flow or they can evict some existing flow.
6022 * This function configures the former policy on 'table'. */
6024 oftable_disable_eviction(struct oftable *table)
6026 if (table->eviction_fields) {
6027 struct eviction_group *evg, *next;
6029 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6030 &table->eviction_groups_by_id) {
6031 eviction_group_destroy(table, evg);
6033 hmap_destroy(&table->eviction_groups_by_id);
6034 heap_destroy(&table->eviction_groups_by_size);
6036 free(table->eviction_fields);
6037 table->eviction_fields = NULL;
6038 table->n_eviction_fields = 0;
6042 /* oftables support a choice of two policies when adding a rule would cause the
6043 * number of flows in the table to exceed the configured maximum number: either
6044 * they can refuse to add the new flow or they can evict some existing flow.
6045 * This function configures the latter policy on 'table', with fairness based
6046 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6047 * 'n_fields' as 0 disables fairness.) */
6049 oftable_enable_eviction(struct oftable *table,
6050 const struct mf_subfield *fields, size_t n_fields)
6052 struct cls_cursor cursor;
6055 if (table->eviction_fields
6056 && n_fields == table->n_eviction_fields
6058 || !memcmp(fields, table->eviction_fields,
6059 n_fields * sizeof *fields))) {
6064 oftable_disable_eviction(table);
6066 table->n_eviction_fields = n_fields;
6067 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6069 table->eviction_group_id_basis = random_uint32();
6070 hmap_init(&table->eviction_groups_by_id);
6071 heap_init(&table->eviction_groups_by_size);
6073 ovs_rwlock_rdlock(&table->cls.rwlock);
6074 cls_cursor_init(&cursor, &table->cls, NULL);
6075 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6076 eviction_group_add_rule(rule);
6078 ovs_rwlock_unlock(&table->cls.rwlock);
6081 /* Removes 'rule' from the oftable that contains it. */
6083 oftable_remove_rule__(struct ofproto *ofproto, struct classifier *cls,
6085 OVS_REQ_WRLOCK(cls->rwlock) OVS_RELEASES(rule->rwlock)
6087 classifier_remove(cls, &rule->cr);
6088 cookies_remove(ofproto, rule);
6089 eviction_group_remove_rule(rule);
6090 ovs_mutex_lock(&ofproto->expirable_mutex);
6091 if (!list_is_empty(&rule->expirable)) {
6092 list_remove(&rule->expirable);
6094 ovs_mutex_unlock(&ofproto->expirable_mutex);
6095 if (!list_is_empty(&rule->meter_list_node)) {
6096 list_remove(&rule->meter_list_node);
6097 list_init(&rule->meter_list_node);
6099 ovs_rwlock_unlock(&rule->rwlock);
6103 oftable_remove_rule(struct rule *rule)
6105 struct ofproto *ofproto = rule->ofproto;
6106 struct oftable *table = &ofproto->tables[rule->table_id];
6108 ovs_rwlock_wrlock(&table->cls.rwlock);
6109 oftable_remove_rule__(ofproto, &table->cls, rule);
6110 ovs_rwlock_unlock(&table->cls.rwlock);
6113 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6114 * the same cls_rule. */
6116 oftable_insert_rule(struct rule *rule)
6118 struct ofproto *ofproto = rule->ofproto;
6119 struct oftable *table = &ofproto->tables[rule->table_id];
6122 ovs_mutex_lock(&rule->timeout_mutex);
6123 may_expire = rule->hard_timeout || rule->idle_timeout;
6124 ovs_mutex_unlock(&rule->timeout_mutex);
6127 ovs_mutex_lock(&ofproto->expirable_mutex);
6128 list_insert(&ofproto->expirable, &rule->expirable);
6129 ovs_mutex_unlock(&ofproto->expirable_mutex);
6131 cookies_insert(ofproto, rule);
6132 if (rule->meter_id) {
6133 struct meter *meter = ofproto->meters[rule->meter_id];
6134 list_insert(&meter->rules, &rule->meter_list_node);
6136 ovs_rwlock_wrlock(&table->cls.rwlock);
6137 classifier_insert(&table->cls, &rule->cr);
6138 ovs_rwlock_unlock(&table->cls.rwlock);
6139 eviction_group_add_rule(rule);
6142 /* unixctl commands. */
6145 ofproto_lookup(const char *name)
6147 struct ofproto *ofproto;
6149 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6151 if (!strcmp(ofproto->name, name)) {
6159 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6160 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6162 struct ofproto *ofproto;
6166 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6167 ds_put_format(&results, "%s\n", ofproto->name);
6169 unixctl_command_reply(conn, ds_cstr(&results));
6170 ds_destroy(&results);
6174 ofproto_unixctl_init(void)
6176 static bool registered;
6182 unixctl_command_register("ofproto/list", "", 0, 0,
6183 ofproto_unixctl_list, NULL);
6186 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6188 * This is deprecated. It is only for compatibility with broken device drivers
6189 * in old versions of Linux that do not properly support VLANs when VLAN
6190 * devices are not used. When broken device drivers are no longer in
6191 * widespread use, we will delete these interfaces. */
6193 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6194 * (exactly) by an OpenFlow rule in 'ofproto'. */
6196 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6198 const struct oftable *oftable;
6200 free(ofproto->vlan_bitmap);
6201 ofproto->vlan_bitmap = bitmap_allocate(4096);
6202 ofproto->vlans_changed = false;
6204 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6205 const struct cls_table *table;
6207 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
6208 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
6209 const struct cls_rule *rule;
6211 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
6212 uint16_t vid = miniflow_get_vid(&rule->match.flow);
6213 bitmap_set1(vlan_bitmap, vid);
6214 bitmap_set1(ofproto->vlan_bitmap, vid);
6221 /* Returns true if new VLANs have come into use by the flow table since the
6222 * last call to ofproto_get_vlan_usage().
6224 * We don't track when old VLANs stop being used. */
6226 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
6228 return ofproto->vlans_changed;
6231 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6232 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6233 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6234 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6235 * then the VLAN device is un-enslaved. */
6237 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
6238 ofp_port_t realdev_ofp_port, int vid)
6240 struct ofport *ofport;
6243 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
6245 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
6247 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
6248 ofproto->name, vlandev_ofp_port);
6252 if (!ofproto->ofproto_class->set_realdev) {
6253 if (!vlandev_ofp_port) {
6256 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
6260 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
6262 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
6263 ofproto->name, vlandev_ofp_port,
6264 netdev_get_name(ofport->netdev), ovs_strerror(error));