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.
25 #include "byte-order.h"
26 #include "classifier.h"
29 #include "dynamic-string.h"
32 #include "meta-flow.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
38 #include "ofp-print.h"
41 #include "ofproto-provider.h"
42 #include "openflow/nicira-ext.h"
43 #include "openflow/openflow.h"
47 #include "poll-loop.h"
53 #include "unaligned.h"
57 VLOG_DEFINE_THIS_MODULE(ofproto);
59 COVERAGE_DEFINE(ofproto_error);
60 COVERAGE_DEFINE(ofproto_flush);
61 COVERAGE_DEFINE(ofproto_no_packet_in);
62 COVERAGE_DEFINE(ofproto_packet_out);
63 COVERAGE_DEFINE(ofproto_queue_req);
64 COVERAGE_DEFINE(ofproto_recv_openflow);
65 COVERAGE_DEFINE(ofproto_reinit_ports);
66 COVERAGE_DEFINE(ofproto_uninstallable);
67 COVERAGE_DEFINE(ofproto_update_port);
70 S_OPENFLOW, /* Processing OpenFlow commands. */
71 S_EVICT, /* Evicting flows from over-limit tables. */
72 S_FLUSH, /* Deleting all flow table rules. */
75 enum ofoperation_type {
81 /* A single OpenFlow request can execute any number of operations. The
82 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
83 * ofconn to which an error reply should be sent if necessary.
85 * ofproto initiates some operations internally. These operations are still
86 * assigned to groups but will not have an associated ofconn. */
88 struct ofproto *ofproto; /* Owning ofproto. */
89 struct list ofproto_node; /* In ofproto's "pending" list. */
90 struct list ops; /* List of "struct ofoperation"s. */
91 int n_running; /* Number of ops still pending. */
93 /* Data needed to send OpenFlow reply on failure or to send a buffered
96 * If list_is_empty(ofconn_node) then this ofopgroup never had an
97 * associated ofconn or its ofconn's connection dropped after it initiated
98 * the operation. In the latter case 'ofconn' is a wild pointer that
99 * refers to freed memory, so the 'ofconn' member must be used only if
100 * !list_is_empty(ofconn_node).
102 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
103 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
104 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
105 uint32_t buffer_id; /* Buffer id from original request. */
108 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
109 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
110 const struct ofp_header *,
112 static void ofopgroup_submit(struct ofopgroup *);
113 static void ofopgroup_complete(struct ofopgroup *);
115 /* A single flow table operation. */
117 struct ofopgroup *group; /* Owning group. */
118 struct list group_node; /* In ofopgroup's "ops" list. */
119 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
120 struct rule *rule; /* Rule being operated upon. */
121 enum ofoperation_type type; /* Type of operation. */
123 /* OFOPERATION_ADD. */
124 struct rule *victim; /* Rule being replaced, if any.. */
126 /* OFOPERATION_MODIFY: The old actions, if the actions are changing. */
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 enum ofperr error; /* 0 if no error. */
138 static struct ofoperation *ofoperation_create(struct ofopgroup *,
140 enum ofoperation_type,
141 enum ofp_flow_removed_reason);
142 static void ofoperation_destroy(struct ofoperation *);
145 static void oftable_init(struct oftable *);
146 static void oftable_destroy(struct oftable *);
148 static void oftable_set_name(struct oftable *, const char *name);
150 static void oftable_disable_eviction(struct oftable *);
151 static void oftable_enable_eviction(struct oftable *,
152 const struct mf_subfield *fields,
155 static void oftable_remove_rule(struct rule *);
156 static struct rule *oftable_replace_rule(struct rule *);
157 static void oftable_substitute_rule(struct rule *old, struct rule *new);
159 /* A set of rules within a single OpenFlow table (oftable) that have the same
160 * values for the oftable's eviction_fields. A rule to be evicted, when one is
161 * needed, is taken from the eviction group that contains the greatest number
164 * An oftable owns any number of eviction groups, each of which contains any
167 * Membership in an eviction group is imprecise, based on the hash of the
168 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
169 * That is, if two rules have different eviction_fields, but those
170 * eviction_fields hash to the same value, then they will belong to the same
171 * eviction_group anyway.
173 * (When eviction is not enabled on an oftable, we don't track any eviction
174 * groups, to save time and space.) */
175 struct eviction_group {
176 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
177 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
178 struct heap rules; /* Contains "struct rule"s. */
181 static struct rule *choose_rule_to_evict(struct oftable *);
182 static void ofproto_evict(struct ofproto *);
183 static uint32_t rule_eviction_priority(struct rule *);
186 static void ofport_destroy__(struct ofport *);
187 static void ofport_destroy(struct ofport *);
189 static void update_port(struct ofproto *, const char *devname);
190 static int init_ports(struct ofproto *);
191 static void reinit_ports(struct ofproto *);
194 static void ofproto_rule_destroy__(struct rule *);
195 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
196 static bool rule_is_modifiable(const struct rule *);
199 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
200 struct ofputil_flow_mod *,
201 const struct ofp_header *);
202 static void delete_flow__(struct rule *, struct ofopgroup *,
203 enum ofp_flow_removed_reason);
204 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
205 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
206 struct ofputil_flow_mod *,
207 const struct ofp_header *);
208 static void calc_duration(long long int start, long long int now,
209 uint32_t *sec, uint32_t *nsec);
212 static uint64_t pick_datapath_id(const struct ofproto *);
213 static uint64_t pick_fallback_dpid(void);
214 static void ofproto_destroy__(struct ofproto *);
215 static void update_mtu(struct ofproto *, struct ofport *);
216 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
219 static void ofproto_unixctl_init(void);
221 /* All registered ofproto classes, in probe order. */
222 static const struct ofproto_class **ofproto_classes;
223 static size_t n_ofproto_classes;
224 static size_t allocated_ofproto_classes;
226 unsigned flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT;
227 enum ofproto_flow_miss_model flow_miss_model = OFPROTO_HANDLE_MISS_AUTO;
229 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
230 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
232 /* Initial mappings of port to OpenFlow number mappings. */
233 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
235 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
237 /* The default value of true waits for flow restore. */
238 static bool flow_restore_wait = true;
240 /* Must be called to initialize the ofproto library.
242 * The caller may pass in 'iface_hints', which contains an shash of
243 * "iface_hint" elements indexed by the interface's name. The provider
244 * may use these hints to describe the startup configuration in order to
245 * reinitialize its state. The caller owns the provided data, so a
246 * provider will make copies of anything required. An ofproto provider
247 * will remove any existing state that is not described by the hint, and
248 * may choose to remove it all. */
250 ofproto_init(const struct shash *iface_hints)
252 struct shash_node *node;
255 ofproto_class_register(&ofproto_dpif_class);
257 /* Make a local copy, since we don't own 'iface_hints' elements. */
258 SHASH_FOR_EACH(node, iface_hints) {
259 const struct iface_hint *orig_hint = node->data;
260 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
261 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
263 new_hint->br_name = xstrdup(orig_hint->br_name);
264 new_hint->br_type = xstrdup(br_type);
265 new_hint->ofp_port = orig_hint->ofp_port;
267 shash_add(&init_ofp_ports, node->name, new_hint);
270 for (i = 0; i < n_ofproto_classes; i++) {
271 ofproto_classes[i]->init(&init_ofp_ports);
275 /* 'type' should be a normalized datapath type, as returned by
276 * ofproto_normalize_type(). Returns the corresponding ofproto_class
277 * structure, or a null pointer if there is none registered for 'type'. */
278 static const struct ofproto_class *
279 ofproto_class_find__(const char *type)
283 for (i = 0; i < n_ofproto_classes; i++) {
284 const struct ofproto_class *class = ofproto_classes[i];
289 class->enumerate_types(&types);
290 found = sset_contains(&types, type);
291 sset_destroy(&types);
297 VLOG_WARN("unknown datapath type %s", type);
301 /* Registers a new ofproto class. After successful registration, new ofprotos
302 * of that type can be created using ofproto_create(). */
304 ofproto_class_register(const struct ofproto_class *new_class)
308 for (i = 0; i < n_ofproto_classes; i++) {
309 if (ofproto_classes[i] == new_class) {
314 if (n_ofproto_classes >= allocated_ofproto_classes) {
315 ofproto_classes = x2nrealloc(ofproto_classes,
316 &allocated_ofproto_classes,
317 sizeof *ofproto_classes);
319 ofproto_classes[n_ofproto_classes++] = new_class;
323 /* Unregisters a datapath provider. 'type' must have been previously
324 * registered and not currently be in use by any ofprotos. After
325 * unregistration new datapaths of that type cannot be opened using
326 * ofproto_create(). */
328 ofproto_class_unregister(const struct ofproto_class *class)
332 for (i = 0; i < n_ofproto_classes; i++) {
333 if (ofproto_classes[i] == class) {
334 for (i++; i < n_ofproto_classes; i++) {
335 ofproto_classes[i - 1] = ofproto_classes[i];
341 VLOG_WARN("attempted to unregister an ofproto class that is not "
346 /* Clears 'types' and enumerates all registered ofproto types into it. The
347 * caller must first initialize the sset. */
349 ofproto_enumerate_types(struct sset *types)
353 for (i = 0; i < n_ofproto_classes; i++) {
354 ofproto_classes[i]->enumerate_types(types);
358 /* Returns the fully spelled out name for the given ofproto 'type'.
360 * Normalized type string can be compared with strcmp(). Unnormalized type
361 * string might be the same even if they have different spellings. */
363 ofproto_normalize_type(const char *type)
365 return type && type[0] ? type : "system";
368 /* Clears 'names' and enumerates the names of all known created ofprotos with
369 * the given 'type'. The caller must first initialize the sset. Returns 0 if
370 * successful, otherwise a positive errno value.
372 * Some kinds of datapaths might not be practically enumerable. This is not
373 * considered an error. */
375 ofproto_enumerate_names(const char *type, struct sset *names)
377 const struct ofproto_class *class = ofproto_class_find__(type);
378 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
382 ofproto_create(const char *datapath_name, const char *datapath_type,
383 struct ofproto **ofprotop)
385 const struct ofproto_class *class;
386 struct ofproto *ofproto;
392 ofproto_unixctl_init();
394 datapath_type = ofproto_normalize_type(datapath_type);
395 class = ofproto_class_find__(datapath_type);
397 VLOG_WARN("could not create datapath %s of unknown type %s",
398 datapath_name, datapath_type);
402 ofproto = class->alloc();
404 VLOG_ERR("failed to allocate datapath %s of type %s",
405 datapath_name, datapath_type);
410 memset(ofproto, 0, sizeof *ofproto);
411 ofproto->ofproto_class = class;
412 ofproto->name = xstrdup(datapath_name);
413 ofproto->type = xstrdup(datapath_type);
414 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
415 hash_string(ofproto->name, 0));
416 ofproto->datapath_id = 0;
417 ofproto->forward_bpdu = false;
418 ofproto->fallback_dpid = pick_fallback_dpid();
419 ofproto->mfr_desc = NULL;
420 ofproto->hw_desc = NULL;
421 ofproto->sw_desc = NULL;
422 ofproto->serial_desc = NULL;
423 ofproto->dp_desc = NULL;
424 ofproto->frag_handling = OFPC_FRAG_NORMAL;
425 hmap_init(&ofproto->ports);
426 shash_init(&ofproto->port_by_name);
427 simap_init(&ofproto->ofp_requests);
428 ofproto->max_ports = OFPP_MAX;
429 ofproto->tables = NULL;
430 ofproto->n_tables = 0;
431 hindex_init(&ofproto->cookies);
432 list_init(&ofproto->expirable);
433 ovs_mutex_init(&ofproto->expirable_mutex, PTHREAD_MUTEX_RECURSIVE);
434 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
435 ofproto->state = S_OPENFLOW;
436 list_init(&ofproto->pending);
437 ofproto->n_pending = 0;
438 hmap_init(&ofproto->deletions);
439 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
440 ofproto->first_op = ofproto->last_op = LLONG_MIN;
441 ofproto->next_op_report = LLONG_MAX;
442 ofproto->op_backoff = LLONG_MIN;
443 ofproto->vlan_bitmap = NULL;
444 ofproto->vlans_changed = false;
445 ofproto->min_mtu = INT_MAX;
447 error = ofproto->ofproto_class->construct(ofproto);
449 VLOG_ERR("failed to open datapath %s: %s",
450 datapath_name, ovs_strerror(error));
451 ofproto_destroy__(ofproto);
455 /* The "max_ports" member should have been set by ->construct(ofproto).
456 * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
457 ofproto->ofp_port_ids = bitmap_allocate(ofp_to_u16(ofproto->max_ports));
458 bitmap_set1(ofproto->ofp_port_ids, 0);
460 /* Check that hidden tables, if any, are at the end. */
461 ovs_assert(ofproto->n_tables);
462 for (i = 0; i + 1 < ofproto->n_tables; i++) {
463 enum oftable_flags flags = ofproto->tables[i].flags;
464 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
466 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
469 ofproto->datapath_id = pick_datapath_id(ofproto);
472 /* Initialize meters table. */
473 if (ofproto->ofproto_class->meter_get_features) {
474 ofproto->ofproto_class->meter_get_features(ofproto,
475 &ofproto->meter_features);
477 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
479 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
480 * sizeof(struct meter *));
486 /* Must be called (only) by an ofproto implementation in its constructor
487 * function. See the large comment on 'construct' in struct ofproto_class for
490 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
492 struct oftable *table;
494 ovs_assert(!ofproto->n_tables);
495 ovs_assert(n_tables >= 1 && n_tables <= 255);
497 ofproto->n_tables = n_tables;
498 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
499 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
504 /* To be optionally called (only) by an ofproto implementation in its
505 * constructor function. See the large comment on 'construct' in struct
506 * ofproto_class for details.
508 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
509 * will then ensure that actions passed into the ofproto implementation will
510 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
511 * function is not called, there will be no such restriction.
513 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
514 * the 'max_ports' restriction. */
516 ofproto_init_max_ports(struct ofproto *ofproto, ofp_port_t max_ports)
518 ovs_assert(ofp_to_u16(max_ports) <= ofp_to_u16(OFPP_MAX));
519 ofproto->max_ports = max_ports;
523 ofproto_get_datapath_id(const struct ofproto *ofproto)
525 return ofproto->datapath_id;
529 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
531 uint64_t old_dpid = p->datapath_id;
532 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
533 if (p->datapath_id != old_dpid) {
534 /* Force all active connections to reconnect, since there is no way to
535 * notify a controller that the datapath ID has changed. */
536 ofproto_reconnect_controllers(p);
541 ofproto_set_controllers(struct ofproto *p,
542 const struct ofproto_controller *controllers,
543 size_t n_controllers, uint32_t allowed_versions)
545 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
550 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
552 connmgr_set_fail_mode(p->connmgr, fail_mode);
555 /* Drops the connections between 'ofproto' and all of its controllers, forcing
556 * them to reconnect. */
558 ofproto_reconnect_controllers(struct ofproto *ofproto)
560 connmgr_reconnect(ofproto->connmgr);
563 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
564 * in-band control should guarantee access, in the same way that in-band
565 * control guarantees access to OpenFlow controllers. */
567 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
568 const struct sockaddr_in *extras, size_t n)
570 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
573 /* Sets the OpenFlow queue used by flows set up by in-band control on
574 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
575 * flows will use the default queue. */
577 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
579 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
582 /* Sets the number of flows at which eviction from the kernel flow table
585 ofproto_set_flow_eviction_threshold(unsigned threshold)
587 flow_eviction_threshold = MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN,
591 /* Sets the path for handling flow misses. */
593 ofproto_set_flow_miss_model(unsigned model)
595 flow_miss_model = model;
598 /* If forward_bpdu is true, the NORMAL action will forward frames with
599 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
600 * the NORMAL action will drop these frames. */
602 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
604 bool old_val = ofproto->forward_bpdu;
605 ofproto->forward_bpdu = forward_bpdu;
606 if (old_val != ofproto->forward_bpdu) {
607 if (ofproto->ofproto_class->forward_bpdu_changed) {
608 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
613 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
614 * 'idle_time', in seconds, and the maximum number of MAC table entries to
617 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
620 if (ofproto->ofproto_class->set_mac_table_config) {
621 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
627 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
630 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
634 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
636 return connmgr_set_snoops(ofproto->connmgr, snoops);
640 ofproto_set_netflow(struct ofproto *ofproto,
641 const struct netflow_options *nf_options)
643 if (nf_options && sset_is_empty(&nf_options->collectors)) {
647 if (ofproto->ofproto_class->set_netflow) {
648 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
650 return nf_options ? EOPNOTSUPP : 0;
655 ofproto_set_sflow(struct ofproto *ofproto,
656 const struct ofproto_sflow_options *oso)
658 if (oso && sset_is_empty(&oso->targets)) {
662 if (ofproto->ofproto_class->set_sflow) {
663 return ofproto->ofproto_class->set_sflow(ofproto, oso);
665 return oso ? EOPNOTSUPP : 0;
670 ofproto_set_ipfix(struct ofproto *ofproto,
671 const struct ofproto_ipfix_bridge_exporter_options *bo,
672 const struct ofproto_ipfix_flow_exporter_options *fo,
675 if (ofproto->ofproto_class->set_ipfix) {
676 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
678 return (bo || fo) ? EOPNOTSUPP : 0;
683 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
685 flow_restore_wait = flow_restore_wait_db;
689 ofproto_get_flow_restore_wait(void)
691 return flow_restore_wait;
695 /* Spanning Tree Protocol (STP) configuration. */
697 /* Configures STP on 'ofproto' using the settings defined in 's'. If
698 * 's' is NULL, disables STP.
700 * Returns 0 if successful, otherwise a positive errno value. */
702 ofproto_set_stp(struct ofproto *ofproto,
703 const struct ofproto_stp_settings *s)
705 return (ofproto->ofproto_class->set_stp
706 ? ofproto->ofproto_class->set_stp(ofproto, s)
710 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
711 * 'enabled' member of 's' is false, then the other members are not
714 * Returns 0 if successful, otherwise a positive errno value. */
716 ofproto_get_stp_status(struct ofproto *ofproto,
717 struct ofproto_stp_status *s)
719 return (ofproto->ofproto_class->get_stp_status
720 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
724 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
725 * in 's'. The caller is responsible for assigning STP port numbers
726 * (using the 'port_num' member in the range of 1 through 255, inclusive)
727 * and ensuring there are no duplicates. If the 's' is NULL, then STP
728 * is disabled on the port.
730 * Returns 0 if successful, otherwise a positive errno value.*/
732 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
733 const struct ofproto_port_stp_settings *s)
735 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
737 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
738 ofproto->name, ofp_port);
742 return (ofproto->ofproto_class->set_stp_port
743 ? ofproto->ofproto_class->set_stp_port(ofport, s)
747 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
748 * 's'. If the 'enabled' member in 's' is false, then the other members
749 * are not meaningful.
751 * Returns 0 if successful, otherwise a positive errno value.*/
753 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
754 struct ofproto_port_stp_status *s)
756 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
758 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
759 "port %"PRIu16, ofproto->name, ofp_port);
763 return (ofproto->ofproto_class->get_stp_port_status
764 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
768 /* Queue DSCP configuration. */
770 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
771 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
772 * to implement QoS. Instead, it is used to implement features which require
773 * knowledge of what queues exist on a port, and some basic information about
776 * Returns 0 if successful, otherwise a positive errno value. */
778 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
779 const struct ofproto_port_queue *queues,
782 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
785 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
786 ofproto->name, ofp_port);
790 return (ofproto->ofproto_class->set_queues
791 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
795 /* Connectivity Fault Management configuration. */
797 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
799 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
801 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
802 if (ofport && ofproto->ofproto_class->set_cfm) {
803 ofproto->ofproto_class->set_cfm(ofport, NULL);
807 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
808 * basic configuration from the configuration members in 'cfm', and the remote
809 * maintenance point ID from remote_mpid. Ignores the statistics members of
812 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
814 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
815 const struct cfm_settings *s)
817 struct ofport *ofport;
820 ofport = ofproto_get_port(ofproto, ofp_port);
822 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
823 ofproto->name, ofp_port);
827 /* XXX: For configuration simplicity, we only support one remote_mpid
828 * outside of the CFM module. It's not clear if this is the correct long
829 * term solution or not. */
830 error = (ofproto->ofproto_class->set_cfm
831 ? ofproto->ofproto_class->set_cfm(ofport, s)
834 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
835 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
836 ovs_strerror(error));
840 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
841 * 'ofproto' does not have a port 'ofp_port'. */
843 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
844 const struct smap *cfg)
846 struct ofport *ofport;
849 ofport = ofproto_get_port(ofproto, ofp_port);
851 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
852 ofproto->name, ofp_port);
856 error = (ofproto->ofproto_class->set_bfd
857 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
860 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
861 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
862 ovs_strerror(error));
866 /* Populates 'status' with key value pairs indicating the status of the BFD
867 * session on 'ofp_port'. This information is intended to be populated in the
868 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
871 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
874 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
875 return (ofport && ofproto->ofproto_class->get_bfd_status
876 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
880 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
881 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
882 * 0 if LACP partner information is not current (generally indicating a
883 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
885 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
887 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
888 return (ofport && ofproto->ofproto_class->port_is_lacp_current
889 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
895 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
896 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
897 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
898 * configuration plus, if there is more than one slave, a bonding
901 * If 'aux' is already registered then this function updates its configuration
902 * to 's'. Otherwise, this function registers a new bundle.
904 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
907 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
908 const struct ofproto_bundle_settings *s)
910 return (ofproto->ofproto_class->bundle_set
911 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
915 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
916 * If no such bundle has been registered, this has no effect. */
918 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
920 return ofproto_bundle_register(ofproto, aux, NULL);
924 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
925 * If 'aux' is already registered then this function updates its configuration
926 * to 's'. Otherwise, this function registers a new mirror. */
928 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
929 const struct ofproto_mirror_settings *s)
931 return (ofproto->ofproto_class->mirror_set
932 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
936 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
937 * If no mirror has been registered, this has no effect. */
939 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
941 return ofproto_mirror_register(ofproto, aux, NULL);
944 /* Retrieves statistics from mirror associated with client data pointer
945 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
946 * 'bytes', respectively. If a particular counters is not supported,
947 * the appropriate argument is set to UINT64_MAX. */
949 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
950 uint64_t *packets, uint64_t *bytes)
952 if (!ofproto->ofproto_class->mirror_get_stats) {
953 *packets = *bytes = UINT64_MAX;
957 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
961 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
962 * which all packets are flooded, instead of using MAC learning. If
963 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
965 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
968 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
970 return (ofproto->ofproto_class->set_flood_vlans
971 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
975 /* Returns true if 'aux' is a registered bundle that is currently in use as the
976 * output for a mirror. */
978 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
980 return (ofproto->ofproto_class->is_mirror_output_bundle
981 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
985 /* Configuration of OpenFlow tables. */
987 /* Returns the number of OpenFlow tables in 'ofproto'. */
989 ofproto_get_n_tables(const struct ofproto *ofproto)
991 return ofproto->n_tables;
994 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
995 * settings from 's'. 'table_id' must be in the range 0 through the number of
996 * OpenFlow tables in 'ofproto' minus 1, inclusive.
998 * For read-only tables, only the name may be configured. */
1000 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1001 const struct ofproto_table_settings *s)
1003 struct oftable *table;
1005 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1006 table = &ofproto->tables[table_id];
1008 oftable_set_name(table, s->name);
1010 if (table->flags & OFTABLE_READONLY) {
1015 oftable_enable_eviction(table, s->groups, s->n_groups);
1017 oftable_disable_eviction(table);
1020 table->max_flows = s->max_flows;
1021 if (classifier_count(&table->cls) > table->max_flows
1022 && table->eviction_fields) {
1023 /* 'table' contains more flows than allowed. We might not be able to
1024 * evict them right away because of the asynchronous nature of flow
1025 * table changes. Schedule eviction for later. */
1026 switch (ofproto->state) {
1028 ofproto->state = S_EVICT;
1032 /* We're already deleting flows, nothing more to do. */
1039 ofproto_has_snoops(const struct ofproto *ofproto)
1041 return connmgr_has_snoops(ofproto->connmgr);
1045 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1047 connmgr_get_snoops(ofproto->connmgr, snoops);
1051 ofproto_flush__(struct ofproto *ofproto)
1053 struct ofopgroup *group;
1054 struct oftable *table;
1056 if (ofproto->ofproto_class->flush) {
1057 ofproto->ofproto_class->flush(ofproto);
1060 group = ofopgroup_create_unattached(ofproto);
1061 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1062 struct rule *rule, *next_rule;
1063 struct cls_cursor cursor;
1065 if (table->flags & OFTABLE_HIDDEN) {
1069 cls_cursor_init(&cursor, &table->cls, NULL);
1070 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1071 if (!rule->pending) {
1072 ofoperation_create(group, rule, OFOPERATION_DELETE,
1074 oftable_remove_rule(rule);
1075 ofproto->ofproto_class->rule_destruct(rule);
1079 ofopgroup_submit(group);
1083 ofproto_destroy__(struct ofproto *ofproto)
1085 struct oftable *table;
1087 ovs_assert(list_is_empty(&ofproto->pending));
1088 ovs_assert(!ofproto->n_pending);
1090 if (ofproto->meters) {
1091 meter_delete(ofproto, 1, ofproto->meter_features.max_meters);
1092 free(ofproto->meters);
1095 connmgr_destroy(ofproto->connmgr);
1097 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1098 free(ofproto->name);
1099 free(ofproto->type);
1100 free(ofproto->mfr_desc);
1101 free(ofproto->hw_desc);
1102 free(ofproto->sw_desc);
1103 free(ofproto->serial_desc);
1104 free(ofproto->dp_desc);
1105 hmap_destroy(&ofproto->ports);
1106 shash_destroy(&ofproto->port_by_name);
1107 bitmap_free(ofproto->ofp_port_ids);
1108 simap_destroy(&ofproto->ofp_requests);
1110 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1111 oftable_destroy(table);
1113 free(ofproto->tables);
1115 hmap_destroy(&ofproto->deletions);
1117 free(ofproto->vlan_bitmap);
1119 ovs_mutex_destroy(&ofproto->expirable_mutex);
1120 ofproto->ofproto_class->dealloc(ofproto);
1124 ofproto_destroy(struct ofproto *p)
1126 struct ofport *ofport, *next_ofport;
1133 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1134 ofport_destroy(ofport);
1137 p->ofproto_class->destruct(p);
1138 ofproto_destroy__(p);
1141 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1142 * kernel datapath, for example, this destroys the datapath in the kernel, and
1143 * with the netdev-based datapath, it tears down the data structures that
1144 * represent the datapath.
1146 * The datapath should not be currently open as an ofproto. */
1148 ofproto_delete(const char *name, const char *type)
1150 const struct ofproto_class *class = ofproto_class_find__(type);
1151 return (!class ? EAFNOSUPPORT
1152 : !class->del ? EACCES
1153 : class->del(type, name));
1157 process_port_change(struct ofproto *ofproto, int error, char *devname)
1159 if (error == ENOBUFS) {
1160 reinit_ports(ofproto);
1161 } else if (!error) {
1162 update_port(ofproto, devname);
1168 ofproto_type_run(const char *datapath_type)
1170 const struct ofproto_class *class;
1173 datapath_type = ofproto_normalize_type(datapath_type);
1174 class = ofproto_class_find__(datapath_type);
1176 error = class->type_run ? class->type_run(datapath_type) : 0;
1177 if (error && error != EAGAIN) {
1178 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1179 datapath_type, ovs_strerror(error));
1185 ofproto_type_run_fast(const char *datapath_type)
1187 const struct ofproto_class *class;
1190 datapath_type = ofproto_normalize_type(datapath_type);
1191 class = ofproto_class_find__(datapath_type);
1193 error = class->type_run_fast ? class->type_run_fast(datapath_type) : 0;
1194 if (error && error != EAGAIN) {
1195 VLOG_ERR_RL(&rl, "%s: type_run_fast failed (%s)",
1196 datapath_type, ovs_strerror(error));
1202 ofproto_type_wait(const char *datapath_type)
1204 const struct ofproto_class *class;
1206 datapath_type = ofproto_normalize_type(datapath_type);
1207 class = ofproto_class_find__(datapath_type);
1209 if (class->type_wait) {
1210 class->type_wait(datapath_type);
1215 ofproto_run(struct ofproto *p)
1217 struct sset changed_netdevs;
1218 const char *changed_netdev;
1219 struct ofport *ofport;
1222 error = p->ofproto_class->run(p);
1223 if (error && error != EAGAIN) {
1224 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1227 if (p->ofproto_class->port_poll) {
1230 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1231 process_port_change(p, error, devname);
1235 /* Update OpenFlow port status for any port whose netdev has changed.
1237 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1238 * destroyed, so it's not safe to update ports directly from the
1239 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1240 * need this two-phase approach. */
1241 sset_init(&changed_netdevs);
1242 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1243 unsigned int change_seq = netdev_change_seq(ofport->netdev);
1244 if (ofport->change_seq != change_seq) {
1245 ofport->change_seq = change_seq;
1246 sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1249 SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1250 update_port(p, changed_netdev);
1252 sset_destroy(&changed_netdevs);
1256 connmgr_run(p->connmgr, handle_openflow);
1260 connmgr_run(p->connmgr, NULL);
1262 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1263 p->state = S_OPENFLOW;
1268 connmgr_run(p->connmgr, NULL);
1270 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1271 connmgr_flushed(p->connmgr);
1272 p->state = S_OPENFLOW;
1280 if (time_msec() >= p->next_op_report) {
1281 long long int ago = (time_msec() - p->first_op) / 1000;
1282 long long int interval = (p->last_op - p->first_op) / 1000;
1286 ds_put_format(&s, "%d flow_mods ",
1287 p->n_add + p->n_delete + p->n_modify);
1288 if (interval == ago) {
1289 ds_put_format(&s, "in the last %lld s", ago);
1290 } else if (interval) {
1291 ds_put_format(&s, "in the %lld s starting %lld s ago",
1294 ds_put_format(&s, "%lld s ago", ago);
1297 ds_put_cstr(&s, " (");
1299 ds_put_format(&s, "%d adds, ", p->n_add);
1302 ds_put_format(&s, "%d deletes, ", p->n_delete);
1305 ds_put_format(&s, "%d modifications, ", p->n_modify);
1308 ds_put_char(&s, ')');
1310 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1313 p->n_add = p->n_delete = p->n_modify = 0;
1314 p->next_op_report = LLONG_MAX;
1320 /* Performs periodic activity required by 'ofproto' that needs to be done
1321 * with the least possible latency.
1323 * It makes sense to call this function a couple of times per poll loop, to
1324 * provide a significant performance boost on some benchmarks with the
1325 * ofproto-dpif implementation. */
1327 ofproto_run_fast(struct ofproto *p)
1331 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1332 if (error && error != EAGAIN) {
1333 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1334 p->name, ovs_strerror(error));
1340 ofproto_wait(struct ofproto *p)
1342 struct ofport *ofport;
1344 p->ofproto_class->wait(p);
1345 if (p->ofproto_class->port_poll_wait) {
1346 p->ofproto_class->port_poll_wait(p);
1349 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1350 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1351 poll_immediate_wake();
1357 connmgr_wait(p->connmgr, true);
1362 connmgr_wait(p->connmgr, false);
1363 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1364 poll_immediate_wake();
1371 ofproto_is_alive(const struct ofproto *p)
1373 return connmgr_has_controllers(p->connmgr);
1376 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1377 * memory_report(). */
1379 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1381 const struct oftable *table;
1382 unsigned int n_rules;
1384 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1385 simap_increase(usage, "ops",
1386 ofproto->n_pending + hmap_count(&ofproto->deletions));
1389 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1390 n_rules += classifier_count(&table->cls);
1392 simap_increase(usage, "rules", n_rules);
1394 if (ofproto->ofproto_class->get_memory_usage) {
1395 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1398 connmgr_get_memory_usage(ofproto->connmgr, usage);
1402 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1405 connmgr_get_controller_info(ofproto->connmgr, info);
1409 ofproto_free_ofproto_controller_info(struct shash *info)
1411 connmgr_free_controller_info(info);
1414 /* Makes a deep copy of 'old' into 'port'. */
1416 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1418 port->name = xstrdup(old->name);
1419 port->type = xstrdup(old->type);
1420 port->ofp_port = old->ofp_port;
1423 /* Frees memory allocated to members of 'ofproto_port'.
1425 * Do not call this function on an ofproto_port obtained from
1426 * ofproto_port_dump_next(): that function retains ownership of the data in the
1429 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1431 free(ofproto_port->name);
1432 free(ofproto_port->type);
1435 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1437 * This function provides no status indication. An error status for the entire
1438 * dump operation is provided when it is completed by calling
1439 * ofproto_port_dump_done().
1442 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1443 const struct ofproto *ofproto)
1445 dump->ofproto = ofproto;
1446 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1450 /* Attempts to retrieve another port from 'dump', which must have been created
1451 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1452 * 'port' and returns true. On failure, returns false.
1454 * Failure might indicate an actual error or merely that the last port has been
1455 * dumped. An error status for the entire dump operation is provided when it
1456 * is completed by calling ofproto_port_dump_done().
1458 * The ofproto owns the data stored in 'port'. It will remain valid until at
1459 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1460 * ofproto_port_dump_done(). */
1462 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1463 struct ofproto_port *port)
1465 const struct ofproto *ofproto = dump->ofproto;
1471 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1474 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1480 /* Completes port table dump operation 'dump', which must have been created
1481 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1482 * error-free, otherwise a positive errno value describing the problem. */
1484 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1486 const struct ofproto *ofproto = dump->ofproto;
1488 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1491 return dump->error == EOF ? 0 : dump->error;
1494 /* Returns the type to pass to netdev_open() when a datapath of type
1495 * 'datapath_type' has a port of type 'port_type', for a few special
1496 * cases when a netdev type differs from a port type. For example, when
1497 * using the userspace datapath, a port of type "internal" needs to be
1500 * Returns either 'type' itself or a string literal, which must not be
1503 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1505 const struct ofproto_class *class;
1507 datapath_type = ofproto_normalize_type(datapath_type);
1508 class = ofproto_class_find__(datapath_type);
1513 return (class->port_open_type
1514 ? class->port_open_type(datapath_type, port_type)
1518 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1519 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1520 * the port's OpenFlow port number.
1522 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1523 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1524 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1525 * 'ofp_portp' is non-null). */
1527 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1528 ofp_port_t *ofp_portp)
1530 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1533 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1535 const char *netdev_name = netdev_get_name(netdev);
1537 simap_put(&ofproto->ofp_requests, netdev_name,
1538 ofp_to_u16(ofp_port));
1539 update_port(ofproto, netdev_name);
1542 struct ofproto_port ofproto_port;
1544 ofproto_port_query_by_name(ofproto, netdev_get_name(netdev),
1546 *ofp_portp = error ? OFPP_NONE : ofproto_port.ofp_port;
1547 ofproto_port_destroy(&ofproto_port);
1552 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1553 * initializes '*port' appropriately; on failure, returns a positive errno
1556 * The caller owns the data in 'ofproto_port' and must free it with
1557 * ofproto_port_destroy() when it is no longer needed. */
1559 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1560 struct ofproto_port *port)
1564 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1566 memset(port, 0, sizeof *port);
1571 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1572 * Returns 0 if successful, otherwise a positive errno. */
1574 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1576 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1577 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1578 struct simap_node *ofp_request_node;
1581 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1582 if (ofp_request_node) {
1583 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1586 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1587 if (!error && ofport) {
1588 /* 'name' is the netdev's name and update_port() is going to close the
1589 * netdev. Just in case update_port() refers to 'name' after it
1590 * destroys 'ofport', make a copy of it around the update_port()
1592 char *devname = xstrdup(name);
1593 update_port(ofproto, devname);
1599 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1600 * performs the 'n_actions' actions in 'actions'. The new flow will not
1603 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1604 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1605 * controllers; otherwise, it will be hidden.
1607 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1609 * This is a helper function for in-band control and fail-open. */
1611 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1612 unsigned int priority,
1613 const struct ofpact *ofpacts, size_t ofpacts_len)
1615 const struct rule *rule;
1617 rule = rule_from_cls_rule(classifier_find_match_exactly(
1618 &ofproto->tables[0].cls, match, priority));
1619 if (!rule || !ofpacts_equal(rule->ofpacts, rule->ofpacts_len,
1620 ofpacts, ofpacts_len)) {
1621 struct ofputil_flow_mod fm;
1623 memset(&fm, 0, sizeof fm);
1625 fm.priority = priority;
1626 fm.buffer_id = UINT32_MAX;
1627 fm.ofpacts = xmemdup(ofpacts, ofpacts_len);
1628 fm.ofpacts_len = ofpacts_len;
1629 add_flow(ofproto, NULL, &fm, NULL);
1634 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1635 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1636 * operation cannot be initiated now but may be retried later.
1638 * This is a helper function for in-band control and fail-open. */
1640 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1642 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1645 /* Searches for a rule with matching criteria exactly equal to 'target' in
1646 * ofproto's table 0 and, if it finds one, deletes it.
1648 * This is a helper function for in-band control and fail-open. */
1650 ofproto_delete_flow(struct ofproto *ofproto,
1651 const struct match *target, unsigned int priority)
1655 rule = rule_from_cls_rule(classifier_find_match_exactly(
1656 &ofproto->tables[0].cls, target, priority));
1658 /* No such rule -> success. */
1660 } else if (rule->pending) {
1661 /* An operation on the rule is already pending -> failure.
1662 * Caller must retry later if it's important. */
1665 /* Initiate deletion -> success. */
1666 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1667 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1668 oftable_remove_rule(rule);
1669 ofproto->ofproto_class->rule_destruct(rule);
1670 ofopgroup_submit(group);
1676 /* Starts the process of deleting all of the flows from all of ofproto's flow
1677 * tables and then reintroducing the flows required by in-band control and
1678 * fail-open. The process will complete in a later call to ofproto_run(). */
1680 ofproto_flush_flows(struct ofproto *ofproto)
1682 COVERAGE_INC(ofproto_flush);
1683 ofproto->state = S_FLUSH;
1687 reinit_ports(struct ofproto *p)
1689 struct ofproto_port_dump dump;
1690 struct sset devnames;
1691 struct ofport *ofport;
1692 struct ofproto_port ofproto_port;
1693 const char *devname;
1695 COVERAGE_INC(ofproto_reinit_ports);
1697 sset_init(&devnames);
1698 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1699 sset_add(&devnames, netdev_get_name(ofport->netdev));
1701 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1702 sset_add(&devnames, ofproto_port.name);
1705 SSET_FOR_EACH (devname, &devnames) {
1706 update_port(p, devname);
1708 sset_destroy(&devnames);
1712 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
1714 uint16_t max_ports = ofp_to_u16(ofproto->max_ports);
1717 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
1719 port_idx = UINT16_MAX;
1722 if (port_idx >= max_ports
1723 || bitmap_is_set(ofproto->ofp_port_ids, port_idx)) {
1724 uint16_t end_port_no = ofp_to_u16(ofproto->alloc_port_no);
1725 uint16_t alloc_port_no = end_port_no;
1727 /* Search for a free OpenFlow port number. We try not to
1728 * immediately reuse them to prevent problems due to old
1731 if (++alloc_port_no >= max_ports) {
1734 if (!bitmap_is_set(ofproto->ofp_port_ids, alloc_port_no)) {
1735 port_idx = alloc_port_no;
1736 ofproto->alloc_port_no = u16_to_ofp(alloc_port_no);
1739 if (alloc_port_no == end_port_no) {
1744 bitmap_set1(ofproto->ofp_port_ids, port_idx);
1745 return u16_to_ofp(port_idx);
1749 dealloc_ofp_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
1751 if (ofp_to_u16(ofp_port) < ofp_to_u16(ofproto->max_ports)) {
1752 bitmap_set0(ofproto->ofp_port_ids, ofp_to_u16(ofp_port));
1756 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1757 * pointer if the netdev cannot be opened. On success, also fills in
1759 static struct netdev *
1760 ofport_open(struct ofproto *ofproto,
1761 struct ofproto_port *ofproto_port,
1762 struct ofputil_phy_port *pp)
1764 enum netdev_flags flags;
1765 struct netdev *netdev;
1768 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1770 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1771 "cannot be opened (%s)",
1773 ofproto_port->name, ofproto_port->ofp_port,
1774 ofproto_port->name, ovs_strerror(error));
1778 if (ofproto_port->ofp_port == OFPP_NONE) {
1779 if (!strcmp(ofproto->name, ofproto_port->name)) {
1780 ofproto_port->ofp_port = OFPP_LOCAL;
1782 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1783 ofproto_port->name);
1786 pp->port_no = ofproto_port->ofp_port;
1787 netdev_get_etheraddr(netdev, pp->hw_addr);
1788 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1789 netdev_get_flags(netdev, &flags);
1790 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1791 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1792 netdev_get_features(netdev, &pp->curr, &pp->advertised,
1793 &pp->supported, &pp->peer);
1794 pp->curr_speed = netdev_features_to_bps(pp->curr, 0);
1795 pp->max_speed = netdev_features_to_bps(pp->supported, 0);
1800 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1801 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1804 ofport_equal(const struct ofputil_phy_port *a,
1805 const struct ofputil_phy_port *b)
1807 return (eth_addr_equals(a->hw_addr, b->hw_addr)
1808 && a->state == b->state
1809 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1810 && a->curr == b->curr
1811 && a->advertised == b->advertised
1812 && a->supported == b->supported
1813 && a->peer == b->peer
1814 && a->curr_speed == b->curr_speed
1815 && a->max_speed == b->max_speed);
1818 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1819 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1820 * one with the same name or port number). */
1822 ofport_install(struct ofproto *p,
1823 struct netdev *netdev, const struct ofputil_phy_port *pp)
1825 const char *netdev_name = netdev_get_name(netdev);
1826 struct ofport *ofport;
1829 /* Create ofport. */
1830 ofport = p->ofproto_class->port_alloc();
1835 ofport->ofproto = p;
1836 ofport->netdev = netdev;
1837 ofport->change_seq = netdev_change_seq(netdev);
1839 ofport->ofp_port = pp->port_no;
1840 ofport->created = time_msec();
1842 /* Add port to 'p'. */
1843 hmap_insert(&p->ports, &ofport->hmap_node,
1844 hash_ofp_port(ofport->ofp_port));
1845 shash_add(&p->port_by_name, netdev_name, ofport);
1847 update_mtu(p, ofport);
1849 /* Let the ofproto_class initialize its private data. */
1850 error = p->ofproto_class->port_construct(ofport);
1854 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1858 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1859 p->name, netdev_name, ovs_strerror(error));
1861 ofport_destroy__(ofport);
1863 netdev_close(netdev);
1867 /* Removes 'ofport' from 'p' and destroys it. */
1869 ofport_remove(struct ofport *ofport)
1871 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1873 ofport_destroy(ofport);
1876 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1879 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1881 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1883 ofport_remove(port);
1887 /* Updates 'port' with new 'pp' description.
1889 * Does not handle a name or port number change. The caller must implement
1890 * such a change as a delete followed by an add. */
1892 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1894 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1895 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1896 | (pp->config & OFPUTIL_PC_PORT_DOWN));
1897 port->pp.state = pp->state;
1898 port->pp.curr = pp->curr;
1899 port->pp.advertised = pp->advertised;
1900 port->pp.supported = pp->supported;
1901 port->pp.peer = pp->peer;
1902 port->pp.curr_speed = pp->curr_speed;
1903 port->pp.max_speed = pp->max_speed;
1905 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1908 /* Update OpenFlow 'state' in 'port' and notify controller. */
1910 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
1912 if (port->pp.state != state) {
1913 port->pp.state = state;
1914 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
1920 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
1922 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1924 if (port->ofproto->ofproto_class->set_realdev) {
1925 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1927 if (port->ofproto->ofproto_class->set_stp_port) {
1928 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1930 if (port->ofproto->ofproto_class->set_cfm) {
1931 port->ofproto->ofproto_class->set_cfm(port, NULL);
1933 if (port->ofproto->ofproto_class->bundle_remove) {
1934 port->ofproto->ofproto_class->bundle_remove(port);
1940 ofport_destroy__(struct ofport *port)
1942 struct ofproto *ofproto = port->ofproto;
1943 const char *name = netdev_get_name(port->netdev);
1945 hmap_remove(&ofproto->ports, &port->hmap_node);
1946 shash_delete(&ofproto->port_by_name,
1947 shash_find(&ofproto->port_by_name, name));
1949 netdev_close(port->netdev);
1950 ofproto->ofproto_class->port_dealloc(port);
1954 ofport_destroy(struct ofport *port)
1957 dealloc_ofp_port(port->ofproto, port->ofp_port);
1958 port->ofproto->ofproto_class->port_destruct(port);
1959 ofport_destroy__(port);
1964 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
1966 struct ofport *port;
1968 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
1970 if (port->ofp_port == ofp_port) {
1978 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1980 struct ofproto *ofproto = port->ofproto;
1983 if (ofproto->ofproto_class->port_get_stats) {
1984 error = ofproto->ofproto_class->port_get_stats(port, stats);
1993 update_port(struct ofproto *ofproto, const char *name)
1995 struct ofproto_port ofproto_port;
1996 struct ofputil_phy_port pp;
1997 struct netdev *netdev;
1998 struct ofport *port;
2000 COVERAGE_INC(ofproto_update_port);
2002 /* Fetch 'name''s location and properties from the datapath. */
2003 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2004 ? ofport_open(ofproto, &ofproto_port, &pp)
2008 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2009 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2010 struct netdev *old_netdev = port->netdev;
2012 /* 'name' hasn't changed location. Any properties changed? */
2013 if (!ofport_equal(&port->pp, &pp)) {
2014 ofport_modified(port, &pp);
2017 update_mtu(ofproto, port);
2019 /* Install the newly opened netdev in case it has changed.
2020 * Don't close the old netdev yet in case port_modified has to
2021 * remove a retained reference to it.*/
2022 port->netdev = netdev;
2023 port->change_seq = netdev_change_seq(netdev);
2025 if (port->ofproto->ofproto_class->port_modified) {
2026 port->ofproto->ofproto_class->port_modified(port);
2029 netdev_close(old_netdev);
2031 /* If 'port' is nonnull then its name differs from 'name' and thus
2032 * we should delete it. If we think there's a port named 'name'
2033 * then its port number must be wrong now so delete it too. */
2035 ofport_remove(port);
2037 ofport_remove_with_name(ofproto, name);
2038 ofport_install(ofproto, netdev, &pp);
2041 /* Any port named 'name' is gone now. */
2042 ofport_remove_with_name(ofproto, name);
2044 ofproto_port_destroy(&ofproto_port);
2048 init_ports(struct ofproto *p)
2050 struct ofproto_port_dump dump;
2051 struct ofproto_port ofproto_port;
2052 struct shash_node *node, *next;
2054 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2055 const char *name = ofproto_port.name;
2057 if (shash_find(&p->port_by_name, name)) {
2058 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2061 struct ofputil_phy_port pp;
2062 struct netdev *netdev;
2064 /* Check if an OpenFlow port number had been requested. */
2065 node = shash_find(&init_ofp_ports, name);
2067 const struct iface_hint *iface_hint = node->data;
2068 simap_put(&p->ofp_requests, name,
2069 ofp_to_u16(iface_hint->ofp_port));
2072 netdev = ofport_open(p, &ofproto_port, &pp);
2074 ofport_install(p, netdev, &pp);
2079 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2080 struct iface_hint *iface_hint = node->data;
2082 if (!strcmp(iface_hint->br_name, p->name)) {
2083 free(iface_hint->br_name);
2084 free(iface_hint->br_type);
2086 shash_delete(&init_ofp_ports, node);
2093 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2094 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2096 find_min_mtu(struct ofproto *p)
2098 struct ofport *ofport;
2101 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2102 struct netdev *netdev = ofport->netdev;
2105 /* Skip any internal ports, since that's what we're trying to
2107 if (!strcmp(netdev_get_type(netdev), "internal")) {
2111 if (netdev_get_mtu(netdev, &dev_mtu)) {
2114 if (!mtu || dev_mtu < mtu) {
2119 return mtu ? mtu: ETH_PAYLOAD_MAX;
2122 /* Update MTU of all datapath devices on 'p' to the minimum of the
2123 * non-datapath ports in event of 'port' added or changed. */
2125 update_mtu(struct ofproto *p, struct ofport *port)
2127 struct ofport *ofport;
2128 struct netdev *netdev = port->netdev;
2129 int dev_mtu, old_min;
2131 if (netdev_get_mtu(netdev, &dev_mtu)) {
2135 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2136 if (dev_mtu > p->min_mtu) {
2137 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2138 dev_mtu = p->min_mtu;
2141 port->mtu = dev_mtu;
2145 /* For non-internal port find new min mtu. */
2146 old_min = p->min_mtu;
2147 port->mtu = dev_mtu;
2148 p->min_mtu = find_min_mtu(p);
2149 if (p->min_mtu == old_min) {
2153 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2154 struct netdev *netdev = ofport->netdev;
2156 if (!strcmp(netdev_get_type(netdev), "internal")) {
2157 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2158 ofport->mtu = p->min_mtu;
2165 ofproto_rule_destroy__(struct rule *rule)
2168 cls_rule_destroy(&rule->cr);
2169 free(rule->ofpacts);
2170 ovs_mutex_destroy(&rule->timeout_mutex);
2171 rule->ofproto->ofproto_class->rule_dealloc(rule);
2175 /* This function allows an ofproto implementation to destroy any rules that
2176 * remain when its ->destruct() function is called. The caller must have
2177 * already uninitialized any derived members of 'rule' (step 5 described in the
2178 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
2179 * This function implements steps 6 and 7.
2181 * This function should only be called from an ofproto implementation's
2182 * ->destruct() function. It is not suitable elsewhere. */
2184 ofproto_rule_destroy(struct rule *rule)
2186 ovs_assert(!rule->pending);
2187 oftable_remove_rule(rule);
2188 ofproto_rule_destroy__(rule);
2191 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2192 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2194 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2196 return (port == OFPP_ANY
2197 || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
2200 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2201 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2203 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2205 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2210 case OFOPERATION_ADD:
2211 return op->victim && ofproto_rule_has_out_port(op->victim, out_port);
2213 case OFOPERATION_DELETE:
2216 case OFOPERATION_MODIFY:
2217 return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
2223 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2224 * statistics appropriately. 'packet' must have at least sizeof(struct
2225 * ofp10_packet_in) bytes of headroom.
2227 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
2228 * with statistics for 'packet' either way.
2230 * Takes ownership of 'packet'. */
2232 rule_execute(struct rule *rule, ofp_port_t in_port, struct ofpbuf *packet)
2235 union flow_in_port in_port_;
2237 ovs_assert(ofpbuf_headroom(packet) >= sizeof(struct ofp10_packet_in));
2239 in_port_.ofp_port = in_port;
2240 flow_extract(packet, 0, 0, NULL, &in_port_, &flow);
2241 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
2244 /* Returns true if 'rule' should be hidden from the controller.
2246 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2247 * (e.g. by in-band control) and are intentionally hidden from the
2250 ofproto_rule_is_hidden(const struct rule *rule)
2252 return rule->cr.priority > UINT16_MAX;
2255 static enum oftable_flags
2256 rule_get_flags(const struct rule *rule)
2258 return rule->ofproto->tables[rule->table_id].flags;
2262 rule_is_modifiable(const struct rule *rule)
2264 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2268 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2270 ofconn_send_reply(ofconn, make_echo_reply(oh));
2275 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2277 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2278 struct ofputil_switch_features features;
2279 struct ofport *port;
2285 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2287 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2289 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2290 * if present, are always at the end.) */
2291 n_tables = ofproto->n_tables;
2292 for (i = 0; i < ofproto->n_tables; i++) {
2293 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2299 features.datapath_id = ofproto->datapath_id;
2300 features.n_buffers = pktbuf_capacity();
2301 features.n_tables = n_tables;
2302 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2303 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2305 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2307 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2308 features.auxiliary_id = 0;
2309 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2311 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2312 ofputil_put_switch_features_port(&port->pp, b);
2315 ofconn_send_reply(ofconn, b);
2320 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2322 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2323 struct ofp_switch_config *osc;
2324 enum ofp_config_flags flags;
2328 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2329 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2330 flags = ofproto->frag_handling;
2331 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2332 if (oh->version < OFP13_VERSION
2333 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2334 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2336 osc->flags = htons(flags);
2337 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2338 ofconn_send_reply(ofconn, buf);
2344 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2346 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2347 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2348 uint16_t flags = ntohs(osc->flags);
2350 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2351 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2352 enum ofp_config_flags cur = ofproto->frag_handling;
2353 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2355 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2357 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2358 ofproto->frag_handling = next;
2360 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2362 ofputil_frag_handling_to_string(next));
2366 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2367 ofconn_set_invalid_ttl_to_controller(ofconn,
2368 (oh->version < OFP13_VERSION
2369 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2371 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2376 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2377 * error message code for the caller to propagate upward. Otherwise, returns
2380 * The log message mentions 'msg_type'. */
2382 reject_slave_controller(struct ofconn *ofconn)
2384 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2385 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2386 return OFPERR_OFPBRC_EPERM;
2392 /* Finds the OFPACT_METER action, if any, in the 'ofpacts_len' bytes of
2393 * 'ofpacts'. If found, returns its meter ID; if not, returns 0.
2395 * This function relies on the order of 'ofpacts' being correct (as checked by
2396 * ofpacts_verify()). */
2398 find_meter(const struct ofpact ofpacts[], size_t ofpacts_len)
2400 const struct ofpact *a;
2402 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2403 enum ovs_instruction_type inst;
2405 inst = ovs_instruction_type_from_ofpact_type(a->type);
2406 if (a->type == OFPACT_METER) {
2407 return ofpact_get_METER(a)->meter_id;
2408 } else if (inst > OVSINST_OFPIT13_METER) {
2416 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are appropriate
2417 * for a packet with the prerequisites satisfied by 'flow' in table 'table_id'.
2418 * 'flow' may be temporarily modified, but is restored at return.
2421 ofproto_check_ofpacts(struct ofproto *ofproto,
2422 const struct ofpact ofpacts[], size_t ofpacts_len,
2423 struct flow *flow, uint8_t table_id)
2428 error = ofpacts_check(ofpacts, ofpacts_len, flow, ofproto->max_ports,
2434 mid = find_meter(ofpacts, ofpacts_len);
2435 if (mid && ofproto_get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2436 return OFPERR_OFPMMFC_INVALID_METER;
2442 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2444 struct ofproto *p = ofconn_get_ofproto(ofconn);
2445 struct ofputil_packet_out po;
2446 struct ofpbuf *payload;
2447 uint64_t ofpacts_stub[1024 / 8];
2448 struct ofpbuf ofpacts;
2450 union flow_in_port in_port_;
2453 COVERAGE_INC(ofproto_packet_out);
2455 error = reject_slave_controller(ofconn);
2460 /* Decode message. */
2461 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2462 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2464 goto exit_free_ofpacts;
2466 if (ofp_to_u16(po.in_port) >= ofp_to_u16(p->max_ports)
2467 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2468 error = OFPERR_OFPBRC_BAD_PORT;
2469 goto exit_free_ofpacts;
2474 if (po.buffer_id != UINT32_MAX) {
2475 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2476 if (error || !payload) {
2477 goto exit_free_ofpacts;
2480 payload = xmalloc(sizeof *payload);
2481 ofpbuf_use_const(payload, po.packet, po.packet_len);
2484 /* Verify actions against packet, then send packet if successful. */
2485 in_port_.ofp_port = po.in_port;
2486 flow_extract(payload, 0, 0, NULL, &in_port_, &flow);
2487 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len, &flow, 0);
2489 error = p->ofproto_class->packet_out(p, payload, &flow,
2490 po.ofpacts, po.ofpacts_len);
2492 ofpbuf_delete(payload);
2495 ofpbuf_uninit(&ofpacts);
2501 update_port_config(struct ofport *port,
2502 enum ofputil_port_config config,
2503 enum ofputil_port_config mask)
2505 enum ofputil_port_config old_config = port->pp.config;
2506 enum ofputil_port_config toggle;
2508 toggle = (config ^ port->pp.config) & mask;
2509 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2510 if (config & OFPUTIL_PC_PORT_DOWN) {
2511 netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL);
2513 netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL);
2515 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2518 port->pp.config ^= toggle;
2519 if (port->pp.config != old_config) {
2520 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2525 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2527 struct ofproto *p = ofconn_get_ofproto(ofconn);
2528 struct ofputil_port_mod pm;
2529 struct ofport *port;
2532 error = reject_slave_controller(ofconn);
2537 error = ofputil_decode_port_mod(oh, &pm);
2542 port = ofproto_get_port(p, pm.port_no);
2544 return OFPERR_OFPPMFC_BAD_PORT;
2545 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2546 return OFPERR_OFPPMFC_BAD_HW_ADDR;
2548 update_port_config(port, pm.config, pm.mask);
2550 netdev_set_advertisements(port->netdev, pm.advertise);
2557 handle_desc_stats_request(struct ofconn *ofconn,
2558 const struct ofp_header *request)
2560 static const char *default_mfr_desc = "Nicira, Inc.";
2561 static const char *default_hw_desc = "Open vSwitch";
2562 static const char *default_sw_desc = VERSION;
2563 static const char *default_serial_desc = "None";
2564 static const char *default_dp_desc = "None";
2566 struct ofproto *p = ofconn_get_ofproto(ofconn);
2567 struct ofp_desc_stats *ods;
2570 msg = ofpraw_alloc_stats_reply(request, 0);
2571 ods = ofpbuf_put_zeros(msg, sizeof *ods);
2572 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
2573 sizeof ods->mfr_desc);
2574 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
2575 sizeof ods->hw_desc);
2576 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
2577 sizeof ods->sw_desc);
2578 ovs_strlcpy(ods->serial_num,
2579 p->serial_desc ? p->serial_desc : default_serial_desc,
2580 sizeof ods->serial_num);
2581 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
2582 sizeof ods->dp_desc);
2583 ofconn_send_reply(ofconn, msg);
2589 handle_table_stats_request(struct ofconn *ofconn,
2590 const struct ofp_header *request)
2592 struct ofproto *p = ofconn_get_ofproto(ofconn);
2593 struct ofp12_table_stats *ots;
2598 /* Set up default values.
2600 * ofp12_table_stats is used as a generic structure as
2601 * it is able to hold all the fields for ofp10_table_stats
2602 * and ofp11_table_stats (and of course itself).
2604 ots = xcalloc(p->n_tables, sizeof *ots);
2605 for (i = 0; i < p->n_tables; i++) {
2606 ots[i].table_id = i;
2607 sprintf(ots[i].name, "table%zu", i);
2608 ots[i].match = htonll(OFPXMT12_MASK);
2609 ots[i].wildcards = htonll(OFPXMT12_MASK);
2610 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2611 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2612 ots[i].write_setfields = htonll(OFPXMT12_MASK);
2613 ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2614 ots[i].metadata_match = htonll(UINT64_MAX);
2615 ots[i].metadata_write = htonll(UINT64_MAX);
2616 ots[i].instructions = htonl(OFPIT11_ALL);
2617 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2618 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2619 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2622 p->ofproto_class->get_tables(p, ots);
2624 /* Post-process the tables, dropping hidden tables. */
2625 n_tables = p->n_tables;
2626 for (i = 0; i < p->n_tables; i++) {
2627 const struct oftable *table = &p->tables[i];
2629 if (table->flags & OFTABLE_HIDDEN) {
2635 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2638 if (table->max_flows < ntohl(ots[i].max_entries)) {
2639 ots[i].max_entries = htonl(table->max_flows);
2643 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2644 ofconn_send_reply(ofconn, msg);
2652 append_port_stat(struct ofport *port, struct list *replies)
2654 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2656 calc_duration(port->created, time_msec(),
2657 &ops.duration_sec, &ops.duration_nsec);
2659 /* Intentionally ignore return value, since errors will set
2660 * 'stats' to all-1s, which is correct for OpenFlow, and
2661 * netdev_get_stats() will log errors. */
2662 ofproto_port_get_stats(port, &ops.stats);
2664 ofputil_append_port_stat(replies, &ops);
2668 handle_port_stats_request(struct ofconn *ofconn,
2669 const struct ofp_header *request)
2671 struct ofproto *p = ofconn_get_ofproto(ofconn);
2672 struct ofport *port;
2673 struct list replies;
2677 error = ofputil_decode_port_stats_request(request, &port_no);
2682 ofpmp_init(&replies, request);
2683 if (port_no != OFPP_ANY) {
2684 port = ofproto_get_port(p, port_no);
2686 append_port_stat(port, &replies);
2689 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2690 append_port_stat(port, &replies);
2694 ofconn_send_replies(ofconn, &replies);
2699 handle_port_desc_stats_request(struct ofconn *ofconn,
2700 const struct ofp_header *request)
2702 struct ofproto *p = ofconn_get_ofproto(ofconn);
2703 enum ofp_version version;
2704 struct ofport *port;
2705 struct list replies;
2707 ofpmp_init(&replies, request);
2709 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2710 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2711 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2714 ofconn_send_replies(ofconn, &replies);
2719 hash_cookie(ovs_be64 cookie)
2721 return hash_2words((OVS_FORCE uint64_t)cookie >> 32,
2722 (OVS_FORCE uint64_t)cookie);
2726 cookies_insert(struct ofproto *ofproto, struct rule *rule)
2728 hindex_insert(&ofproto->cookies, &rule->cookie_node,
2729 hash_cookie(rule->flow_cookie));
2733 cookies_remove(struct ofproto *ofproto, struct rule *rule)
2735 hindex_remove(&ofproto->cookies, &rule->cookie_node);
2739 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
2740 ovs_be64 new_cookie)
2742 if (new_cookie != rule->flow_cookie) {
2743 cookies_remove(ofproto, rule);
2745 rule->flow_cookie = new_cookie;
2747 cookies_insert(ofproto, rule);
2752 calc_duration(long long int start, long long int now,
2753 uint32_t *sec, uint32_t *nsec)
2755 long long int msecs = now - start;
2756 *sec = msecs / 1000;
2757 *nsec = (msecs % 1000) * (1000 * 1000);
2760 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2761 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2763 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2765 return (table_id == 0xff || table_id < ofproto->n_tables
2767 : OFPERR_OFPBRC_BAD_TABLE_ID);
2771 static struct oftable *
2772 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2774 struct oftable *table;
2776 for (table = &ofproto->tables[table_id];
2777 table < &ofproto->tables[ofproto->n_tables];
2779 if (!(table->flags & OFTABLE_HIDDEN)) {
2787 static struct oftable *
2788 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2790 if (table_id == 0xff) {
2791 return next_visible_table(ofproto, 0);
2792 } else if (table_id < ofproto->n_tables) {
2793 return &ofproto->tables[table_id];
2799 static struct oftable *
2800 next_matching_table(const struct ofproto *ofproto,
2801 const struct oftable *table, uint8_t table_id)
2803 return (table_id == 0xff
2804 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2808 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2810 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2811 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2813 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2814 * only once, for that table. (This can be used to access tables marked
2817 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2818 * entered at all. (Perhaps you should have validated TABLE_ID with
2819 * check_table_id().)
2821 * All parameters are evaluated multiple times.
2823 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2824 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2826 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2828 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2829 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2830 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2833 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2834 * to 'out_port' are included.
2836 * Hidden rules are always omitted.
2838 * Returns 0 on success, otherwise an OpenFlow error code. */
2840 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2841 const struct match *match,
2842 ovs_be64 cookie, ovs_be64 cookie_mask,
2843 ofp_port_t out_port, struct list *rules)
2845 struct oftable *table;
2849 error = check_table_id(ofproto, table_id);
2855 cls_rule_init(&cr, match, 0);
2857 if (cookie_mask == htonll(UINT64_MAX)) {
2860 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node, hash_cookie(cookie),
2861 &ofproto->cookies) {
2862 if (table_id != rule->table_id && table_id != 0xff) {
2865 if (ofproto_rule_is_hidden(rule)) {
2868 if (cls_rule_is_loose_match(&rule->cr, &cr.match)) {
2869 if (rule->pending) {
2870 error = OFPROTO_POSTPONE;
2873 if (rule->flow_cookie == cookie /* Hash collisions possible. */
2874 && ofproto_rule_has_out_port(rule, out_port)) {
2875 list_push_back(rules, &rule->ofproto_node);
2882 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2883 struct cls_cursor cursor;
2886 cls_cursor_init(&cursor, &table->cls, &cr);
2887 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2888 if (rule->pending) {
2889 error = OFPROTO_POSTPONE;
2892 if (!ofproto_rule_is_hidden(rule)
2893 && ofproto_rule_has_out_port(rule, out_port)
2894 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2895 list_push_back(rules, &rule->ofproto_node);
2901 cls_rule_destroy(&cr);
2905 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2906 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2907 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2910 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2911 * to 'out_port' are included.
2913 * Hidden rules are always omitted.
2915 * Returns 0 on success, otherwise an OpenFlow error code. */
2917 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2918 const struct match *match, unsigned int priority,
2919 ovs_be64 cookie, ovs_be64 cookie_mask,
2920 ofp_port_t out_port, struct list *rules)
2922 struct oftable *table;
2926 error = check_table_id(ofproto, table_id);
2932 cls_rule_init(&cr, match, priority);
2934 if (cookie_mask == htonll(UINT64_MAX)) {
2937 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node, hash_cookie(cookie),
2938 &ofproto->cookies) {
2939 if (table_id != rule->table_id && table_id != 0xff) {
2942 if (ofproto_rule_is_hidden(rule)) {
2945 if (cls_rule_equal(&rule->cr, &cr)) {
2946 if (rule->pending) {
2947 error = OFPROTO_POSTPONE;
2950 if (rule->flow_cookie == cookie /* Hash collisions possible. */
2951 && ofproto_rule_has_out_port(rule, out_port)) {
2952 list_push_back(rules, &rule->ofproto_node);
2959 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2962 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2965 if (rule->pending) {
2966 error = OFPROTO_POSTPONE;
2969 if (!ofproto_rule_is_hidden(rule)
2970 && ofproto_rule_has_out_port(rule, out_port)
2971 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2972 list_push_back(rules, &rule->ofproto_node);
2978 cls_rule_destroy(&cr);
2982 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2983 * forced into the range of a uint16_t. */
2985 age_secs(long long int age_ms)
2987 return (age_ms < 0 ? 0
2988 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
2989 : (unsigned int) age_ms / 1000);
2993 handle_flow_stats_request(struct ofconn *ofconn,
2994 const struct ofp_header *request)
2996 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2997 struct ofputil_flow_stats_request fsr;
2998 struct list replies;
3003 error = ofputil_decode_flow_stats_request(&fsr, request);
3008 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
3009 fsr.cookie, fsr.cookie_mask,
3010 fsr.out_port, &rules);
3015 ofpmp_init(&replies, request);
3016 LIST_FOR_EACH (rule, ofproto_node, &rules) {
3017 long long int now = time_msec();
3018 struct ofputil_flow_stats fs;
3020 minimatch_expand(&rule->cr.match, &fs.match);
3021 fs.priority = rule->cr.priority;
3022 fs.cookie = rule->flow_cookie;
3023 fs.table_id = rule->table_id;
3024 calc_duration(rule->created, now, &fs.duration_sec, &fs.duration_nsec);
3025 fs.idle_age = age_secs(now - rule->used);
3026 fs.hard_age = age_secs(now - rule->modified);
3027 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3029 fs.ofpacts = rule->ofpacts;
3030 fs.ofpacts_len = rule->ofpacts_len;
3033 ovs_mutex_lock(&rule->timeout_mutex);
3034 fs.idle_timeout = rule->idle_timeout;
3035 fs.hard_timeout = rule->hard_timeout;
3036 ovs_mutex_unlock(&rule->timeout_mutex);
3038 if (rule->send_flow_removed) {
3039 fs.flags |= OFPFF_SEND_FLOW_REM;
3040 /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
3041 and OFPFF13_NO_BYT_COUNTS */
3043 ofputil_append_flow_stats_reply(&fs, &replies);
3045 ofconn_send_replies(ofconn, &replies);
3051 flow_stats_ds(struct rule *rule, struct ds *results)
3053 uint64_t packet_count, byte_count;
3055 rule->ofproto->ofproto_class->rule_get_stats(rule,
3056 &packet_count, &byte_count);
3058 if (rule->table_id != 0) {
3059 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3061 ds_put_format(results, "duration=%llds, ",
3062 (time_msec() - rule->created) / 1000);
3063 ds_put_format(results, "priority=%u, ", rule->cr.priority);
3064 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3065 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3066 cls_rule_format(&rule->cr, results);
3067 ds_put_char(results, ',');
3068 ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
3069 ds_put_cstr(results, "\n");
3072 /* Adds a pretty-printed description of all flows to 'results', including
3073 * hidden flows (e.g., set up by in-band control). */
3075 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3077 struct oftable *table;
3079 OFPROTO_FOR_EACH_TABLE (table, p) {
3080 struct cls_cursor cursor;
3083 cls_cursor_init(&cursor, &table->cls, NULL);
3084 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3085 flow_stats_ds(rule, results);
3090 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3091 * '*engine_type' and '*engine_id', respectively. */
3093 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3094 uint8_t *engine_type, uint8_t *engine_id)
3096 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3099 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3100 * true if the port's CFM status was successfully stored into '*status'.
3101 * Returns false if the port did not have CFM configured, in which case
3102 * '*status' is indeterminate.
3104 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3106 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3107 struct ofproto_cfm_status *status)
3109 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3111 && ofproto->ofproto_class->get_cfm_status
3112 && ofproto->ofproto_class->get_cfm_status(ofport, status));
3116 handle_aggregate_stats_request(struct ofconn *ofconn,
3117 const struct ofp_header *oh)
3119 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3120 struct ofputil_flow_stats_request request;
3121 struct ofputil_aggregate_stats stats;
3122 bool unknown_packets, unknown_bytes;
3123 struct ofpbuf *reply;
3128 error = ofputil_decode_flow_stats_request(&request, oh);
3133 error = collect_rules_loose(ofproto, request.table_id, &request.match,
3134 request.cookie, request.cookie_mask,
3135 request.out_port, &rules);
3140 memset(&stats, 0, sizeof stats);
3141 unknown_packets = unknown_bytes = false;
3142 LIST_FOR_EACH (rule, ofproto_node, &rules) {
3143 uint64_t packet_count;
3144 uint64_t byte_count;
3146 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3149 if (packet_count == UINT64_MAX) {
3150 unknown_packets = true;
3152 stats.packet_count += packet_count;
3155 if (byte_count == UINT64_MAX) {
3156 unknown_bytes = true;
3158 stats.byte_count += byte_count;
3163 if (unknown_packets) {
3164 stats.packet_count = UINT64_MAX;
3166 if (unknown_bytes) {
3167 stats.byte_count = UINT64_MAX;
3170 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3171 ofconn_send_reply(ofconn, reply);
3176 struct queue_stats_cbdata {
3177 struct ofport *ofport;
3178 struct list replies;
3183 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3184 const struct netdev_queue_stats *stats)
3186 struct ofputil_queue_stats oqs;
3188 oqs.port_no = cbdata->ofport->pp.port_no;
3189 oqs.queue_id = queue_id;
3190 oqs.tx_bytes = stats->tx_bytes;
3191 oqs.tx_packets = stats->tx_packets;
3192 oqs.tx_errors = stats->tx_errors;
3193 if (stats->created != LLONG_MIN) {
3194 calc_duration(stats->created, cbdata->now,
3195 &oqs.duration_sec, &oqs.duration_nsec);
3197 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3199 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3203 handle_queue_stats_dump_cb(uint32_t queue_id,
3204 struct netdev_queue_stats *stats,
3207 struct queue_stats_cbdata *cbdata = cbdata_;
3209 put_queue_stats(cbdata, queue_id, stats);
3213 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3214 struct queue_stats_cbdata *cbdata)
3216 cbdata->ofport = port;
3217 if (queue_id == OFPQ_ALL) {
3218 netdev_dump_queue_stats(port->netdev,
3219 handle_queue_stats_dump_cb, cbdata);
3221 struct netdev_queue_stats stats;
3223 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3224 put_queue_stats(cbdata, queue_id, &stats);
3226 return OFPERR_OFPQOFC_BAD_QUEUE;
3233 handle_queue_stats_request(struct ofconn *ofconn,
3234 const struct ofp_header *rq)
3236 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3237 struct queue_stats_cbdata cbdata;
3238 struct ofport *port;
3240 struct ofputil_queue_stats_request oqsr;
3242 COVERAGE_INC(ofproto_queue_req);
3244 ofpmp_init(&cbdata.replies, rq);
3245 cbdata.now = time_msec();
3247 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3252 if (oqsr.port_no == OFPP_ANY) {
3253 error = OFPERR_OFPQOFC_BAD_QUEUE;
3254 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3255 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3260 port = ofproto_get_port(ofproto, oqsr.port_no);
3262 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3263 : OFPERR_OFPQOFC_BAD_PORT);
3266 ofconn_send_replies(ofconn, &cbdata.replies);
3268 ofpbuf_list_delete(&cbdata.replies);
3275 is_flow_deletion_pending(const struct ofproto *ofproto,
3276 const struct cls_rule *cls_rule,
3279 if (!hmap_is_empty(&ofproto->deletions)) {
3280 struct ofoperation *op;
3282 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3283 cls_rule_hash(cls_rule, table_id),
3284 &ofproto->deletions) {
3285 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3294 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3295 * in which no matching flow already exists in the flow table.
3297 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3298 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3299 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3300 * initiated now but may be retried later.
3302 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
3303 * ownership remains with the caller.
3305 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3308 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3309 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3311 struct oftable *table;
3312 struct ofopgroup *group;
3313 struct rule *victim;
3318 error = check_table_id(ofproto, fm->table_id);
3324 if (fm->table_id == 0xff) {
3325 if (ofproto->ofproto_class->rule_choose_table) {
3326 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3332 ovs_assert(table_id < ofproto->n_tables);
3336 } else if (fm->table_id < ofproto->n_tables) {
3337 table_id = fm->table_id;
3339 return OFPERR_OFPBRC_BAD_TABLE_ID;
3342 table = &ofproto->tables[table_id];
3344 if (table->flags & OFTABLE_READONLY) {
3345 return OFPERR_OFPBRC_EPERM;
3348 /* Verify actions. */
3349 error = ofproto_check_ofpacts(ofproto, fm->ofpacts, fm->ofpacts_len,
3350 &fm->match.flow, table_id);
3355 /* Allocate new rule and initialize classifier rule. */
3356 rule = ofproto->ofproto_class->rule_alloc();
3358 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3359 ofproto->name, ovs_strerror(error));
3362 cls_rule_init(&rule->cr, &fm->match, fm->priority);
3364 /* Serialize against pending deletion. */
3365 if (is_flow_deletion_pending(ofproto, &rule->cr, table_id)) {
3366 cls_rule_destroy(&rule->cr);
3367 ofproto->ofproto_class->rule_dealloc(rule);
3368 return OFPROTO_POSTPONE;
3371 /* Check for overlap, if requested. */
3372 if (fm->flags & OFPFF_CHECK_OVERLAP
3373 && classifier_rule_overlaps(&table->cls, &rule->cr)) {
3374 cls_rule_destroy(&rule->cr);
3375 ofproto->ofproto_class->rule_dealloc(rule);
3376 return OFPERR_OFPFMFC_OVERLAP;
3379 /* FIXME: Implement OFPFF12_RESET_COUNTS */
3381 rule->ofproto = ofproto;
3382 rule->pending = NULL;
3383 rule->flow_cookie = fm->new_cookie;
3384 rule->created = rule->modified = rule->used = time_msec();
3386 ovs_mutex_init(&rule->timeout_mutex, OVS_MUTEX_ADAPTIVE);
3387 ovs_mutex_lock(&rule->timeout_mutex);
3388 rule->idle_timeout = fm->idle_timeout;
3389 rule->hard_timeout = fm->hard_timeout;
3390 ovs_mutex_unlock(&rule->timeout_mutex);
3392 rule->table_id = table - ofproto->tables;
3393 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
3394 /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
3395 and OFPFF13_NO_BYT_COUNTS */
3396 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3397 rule->ofpacts_len = fm->ofpacts_len;
3398 rule->meter_id = find_meter(rule->ofpacts, rule->ofpacts_len);
3399 list_init(&rule->meter_list_node);
3400 rule->evictable = true;
3401 rule->eviction_group = NULL;
3402 list_init(&rule->expirable);
3403 rule->monitor_flags = 0;
3404 rule->add_seqno = 0;
3405 rule->modify_seqno = 0;
3407 /* Insert new rule. */
3408 victim = oftable_replace_rule(rule);
3409 if (victim && !rule_is_modifiable(victim)) {
3410 error = OFPERR_OFPBRC_EPERM;
3411 } else if (victim && victim->pending) {
3412 error = OFPROTO_POSTPONE;
3414 struct ofoperation *op;
3417 if (classifier_count(&table->cls) > table->max_flows) {
3420 was_evictable = rule->evictable;
3421 rule->evictable = false;
3422 evict = choose_rule_to_evict(table);
3423 rule->evictable = was_evictable;
3426 error = OFPERR_OFPFMFC_TABLE_FULL;
3428 } else if (evict->pending) {
3429 error = OFPROTO_POSTPONE;
3436 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3437 op = ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3438 op->victim = victim;
3440 error = ofproto->ofproto_class->rule_construct(rule);
3442 op->group->n_running--;
3443 ofoperation_destroy(rule->pending);
3445 delete_flow__(evict, group, OFPRR_EVICTION);
3447 ofopgroup_submit(group);
3451 /* Back out if an error occurred. */
3453 oftable_substitute_rule(rule, victim);
3454 ofproto_rule_destroy__(rule);
3459 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3461 /* Modifies the rules listed in 'rules', changing their actions to match those
3464 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3467 * Returns 0 on success, otherwise an OpenFlow error code. */
3469 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3470 struct ofputil_flow_mod *fm, const struct ofp_header *request,
3473 struct ofopgroup *group;
3477 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3478 error = OFPERR_OFPBRC_EPERM;
3479 LIST_FOR_EACH (rule, ofproto_node, rules) {
3480 struct ofoperation *op;
3481 bool actions_changed;
3483 /* FIXME: Implement OFPFF12_RESET_COUNTS */
3485 if (rule_is_modifiable(rule)) {
3486 /* At least one rule is modifiable, don't report EPERM error. */
3492 /* Verify actions. */
3493 error = ofpacts_check(fm->ofpacts, fm->ofpacts_len, &fm->match.flow,
3494 ofproto->max_ports, rule->table_id);
3499 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3500 rule->ofpacts, rule->ofpacts_len);
3502 op = ofoperation_create(group, rule, OFOPERATION_MODIFY, 0);
3504 if (fm->modify_cookie && fm->new_cookie != htonll(UINT64_MAX)) {
3505 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
3507 if (actions_changed) {
3508 op->ofpacts = rule->ofpacts;
3509 op->ofpacts_len = rule->ofpacts_len;
3510 op->meter_id = rule->meter_id;
3511 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3512 rule->ofpacts_len = fm->ofpacts_len;
3513 rule->meter_id = find_meter(rule->ofpacts, rule->ofpacts_len);
3514 rule->ofproto->ofproto_class->rule_modify_actions(rule);
3516 ofoperation_complete(op, 0);
3519 ofopgroup_submit(group);
3525 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3526 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3528 if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3531 return add_flow(ofproto, ofconn, fm, request);
3534 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3537 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3540 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3541 struct ofputil_flow_mod *fm,
3542 const struct ofp_header *request)
3547 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3548 fm->cookie, fm->cookie_mask,
3552 } else if (list_is_empty(&rules)) {
3553 return modify_flows_add(ofproto, ofconn, fm, request);
3555 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3559 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3562 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3565 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3566 struct ofputil_flow_mod *fm,
3567 const struct ofp_header *request)
3572 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3573 fm->priority, fm->cookie, fm->cookie_mask,
3578 } else if (list_is_empty(&rules)) {
3579 return modify_flows_add(ofproto, ofconn, fm, request);
3581 return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3582 fm, request, &rules)
3587 /* OFPFC_DELETE implementation. */
3590 delete_flow__(struct rule *rule, struct ofopgroup *group,
3591 enum ofp_flow_removed_reason reason)
3593 struct ofproto *ofproto = rule->ofproto;
3595 ofproto_rule_send_removed(rule, reason);
3597 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3598 oftable_remove_rule(rule);
3599 ofproto->ofproto_class->rule_destruct(rule);
3602 /* Deletes the rules listed in 'rules'.
3604 * Returns 0 on success, otherwise an OpenFlow error code. */
3606 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3607 const struct ofp_header *request, struct list *rules,
3608 enum ofp_flow_removed_reason reason)
3610 struct rule *rule, *next;
3611 struct ofopgroup *group;
3613 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3614 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3615 delete_flow__(rule, group, reason);
3617 ofopgroup_submit(group);
3622 /* Implements OFPFC_DELETE. */
3624 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3625 const struct ofputil_flow_mod *fm,
3626 const struct ofp_header *request)
3631 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3632 fm->cookie, fm->cookie_mask,
3633 fm->out_port, &rules);
3634 return (error ? error
3635 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3636 &rules, OFPRR_DELETE)
3640 /* Implements OFPFC_DELETE_STRICT. */
3642 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3643 const struct ofputil_flow_mod *fm,
3644 const struct ofp_header *request)
3649 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3650 fm->priority, fm->cookie, fm->cookie_mask,
3651 fm->out_port, &rules);
3652 return (error ? error
3653 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3660 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3662 struct ofputil_flow_removed fr;
3664 if (ofproto_rule_is_hidden(rule) || !rule->send_flow_removed) {
3668 minimatch_expand(&rule->cr.match, &fr.match);
3669 fr.priority = rule->cr.priority;
3670 fr.cookie = rule->flow_cookie;
3672 fr.table_id = rule->table_id;
3673 calc_duration(rule->created, time_msec(),
3674 &fr.duration_sec, &fr.duration_nsec);
3675 ovs_mutex_lock(&rule->timeout_mutex);
3676 fr.idle_timeout = rule->idle_timeout;
3677 fr.hard_timeout = rule->hard_timeout;
3678 ovs_mutex_unlock(&rule->timeout_mutex);
3679 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3682 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3686 ofproto_rule_update_used(struct rule *rule, long long int used)
3688 if (used > rule->used) {
3689 struct eviction_group *evg = rule->eviction_group;
3693 heap_change(&evg->rules, &rule->evg_node,
3694 rule_eviction_priority(rule));
3699 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3700 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3703 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3706 * ofproto implementation ->run() functions should use this function to expire
3707 * OpenFlow flows. */
3709 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3711 struct ofproto *ofproto = rule->ofproto;
3712 struct ofopgroup *group;
3714 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
3716 ofproto_rule_send_removed(rule, reason);
3718 group = ofopgroup_create_unattached(ofproto);
3719 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3720 oftable_remove_rule(rule);
3721 ofproto->ofproto_class->rule_destruct(rule);
3722 ofopgroup_submit(group);
3726 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3728 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3729 struct ofputil_flow_mod fm;
3730 uint64_t ofpacts_stub[1024 / 8];
3731 struct ofpbuf ofpacts;
3735 error = reject_slave_controller(ofconn);
3740 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3741 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3744 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
3747 goto exit_free_ofpacts;
3750 /* Record the operation for logging a summary report. */
3751 switch (fm.command) {
3757 case OFPFC_MODIFY_STRICT:
3758 ofproto->n_modify++;
3762 case OFPFC_DELETE_STRICT:
3763 ofproto->n_delete++;
3768 if (ofproto->next_op_report == LLONG_MAX) {
3769 ofproto->first_op = now;
3770 ofproto->next_op_report = MAX(now + 10 * 1000,
3771 ofproto->op_backoff);
3772 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
3774 ofproto->last_op = now;
3777 ofpbuf_uninit(&ofpacts);
3783 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3784 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
3786 if (ofproto->n_pending >= 50) {
3787 ovs_assert(!list_is_empty(&ofproto->pending));
3788 return OFPROTO_POSTPONE;
3791 switch (fm->command) {
3793 return add_flow(ofproto, ofconn, fm, oh);
3796 return modify_flows_loose(ofproto, ofconn, fm, oh);
3798 case OFPFC_MODIFY_STRICT:
3799 return modify_flow_strict(ofproto, ofconn, fm, oh);
3802 return delete_flows_loose(ofproto, ofconn, fm, oh);
3804 case OFPFC_DELETE_STRICT:
3805 return delete_flow_strict(ofproto, ofconn, fm, oh);
3808 if (fm->command > 0xff) {
3809 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
3810 "flow_mod_table_id extension is not enabled",
3813 return OFPERR_OFPFMFC_BAD_COMMAND;
3818 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
3820 struct ofputil_role_request request;
3821 struct ofputil_role_request reply;
3825 error = ofputil_decode_role_message(oh, &request);
3830 if (request.role != OFPCR12_ROLE_NOCHANGE) {
3831 if (ofconn_get_role(ofconn) != request.role
3832 && ofconn_has_pending_opgroups(ofconn)) {
3833 return OFPROTO_POSTPONE;
3836 if (request.have_generation_id
3837 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
3838 return OFPERR_OFPRRFC_STALE;
3841 ofconn_set_role(ofconn, request.role);
3844 reply.role = ofconn_get_role(ofconn);
3845 reply.have_generation_id = ofconn_get_master_election_id(
3846 ofconn, &reply.generation_id);
3847 buf = ofputil_encode_role_reply(oh, &reply);
3848 ofconn_send_reply(ofconn, buf);
3854 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
3855 const struct ofp_header *oh)
3857 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
3858 enum ofputil_protocol cur, next;
3860 cur = ofconn_get_protocol(ofconn);
3861 next = ofputil_protocol_set_tid(cur, msg->set != 0);
3862 ofconn_set_protocol(ofconn, next);
3868 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
3870 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
3871 enum ofputil_protocol cur, next;
3872 enum ofputil_protocol next_base;
3874 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
3876 return OFPERR_OFPBRC_EPERM;
3879 cur = ofconn_get_protocol(ofconn);
3880 next = ofputil_protocol_set_base(cur, next_base);
3881 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
3882 /* Avoid sending async messages in surprising protocol. */
3883 return OFPROTO_POSTPONE;
3886 ofconn_set_protocol(ofconn, next);
3891 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
3892 const struct ofp_header *oh)
3894 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
3897 format = ntohl(msg->format);
3898 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
3899 return OFPERR_OFPBRC_EPERM;
3902 if (format != ofconn_get_packet_in_format(ofconn)
3903 && ofconn_has_pending_opgroups(ofconn)) {
3904 /* Avoid sending async message in surprsing packet in format. */
3905 return OFPROTO_POSTPONE;
3908 ofconn_set_packet_in_format(ofconn, format);
3913 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
3915 const struct nx_async_config *msg = ofpmsg_body(oh);
3916 uint32_t master[OAM_N_TYPES];
3917 uint32_t slave[OAM_N_TYPES];
3919 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
3920 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
3921 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
3923 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
3924 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
3925 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
3927 ofconn_set_async_config(ofconn, master, slave);
3928 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
3929 !ofconn_get_miss_send_len(ofconn)) {
3930 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
3937 handle_nxt_set_controller_id(struct ofconn *ofconn,
3938 const struct ofp_header *oh)
3940 const struct nx_controller_id *nci = ofpmsg_body(oh);
3942 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
3943 return OFPERR_NXBRC_MUST_BE_ZERO;
3946 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
3951 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
3955 if (ofconn_has_pending_opgroups(ofconn)) {
3956 return OFPROTO_POSTPONE;
3959 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
3960 ? OFPRAW_OFPT10_BARRIER_REPLY
3961 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
3962 ofconn_send_reply(ofconn, buf);
3967 ofproto_compose_flow_refresh_update(const struct rule *rule,
3968 enum nx_flow_monitor_flags flags,
3971 struct ofoperation *op = rule->pending;
3972 struct ofputil_flow_update fu;
3975 if (op && op->type == OFOPERATION_ADD && !op->victim) {
3976 /* We'll report the final flow when the operation completes. Reporting
3977 * it now would cause a duplicate report later. */
3981 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
3982 ? NXFME_ADDED : NXFME_MODIFIED);
3984 ovs_mutex_lock(&rule->timeout_mutex);
3985 fu.idle_timeout = rule->idle_timeout;
3986 fu.hard_timeout = rule->hard_timeout;
3987 ovs_mutex_unlock(&rule->timeout_mutex);
3988 fu.table_id = rule->table_id;
3989 fu.cookie = rule->flow_cookie;
3990 minimatch_expand(&rule->cr.match, &match);
3992 fu.priority = rule->cr.priority;
3993 if (!(flags & NXFMF_ACTIONS)) {
3997 fu.ofpacts = rule->ofpacts;
3998 fu.ofpacts_len = rule->ofpacts_len;
4000 /* An operation is in progress. Use the previous version of the flow's
4001 * actions, so that when the operation commits we report the change. */
4003 case OFOPERATION_ADD:
4004 /* We already verified that there was a victim. */
4005 fu.ofpacts = op->victim->ofpacts;
4006 fu.ofpacts_len = op->victim->ofpacts_len;
4009 case OFOPERATION_MODIFY:
4011 fu.ofpacts = op->ofpacts;
4012 fu.ofpacts_len = op->ofpacts_len;
4014 fu.ofpacts = rule->ofpacts;
4015 fu.ofpacts_len = rule->ofpacts_len;
4019 case OFOPERATION_DELETE:
4020 fu.ofpacts = rule->ofpacts;
4021 fu.ofpacts_len = rule->ofpacts_len;
4029 if (list_is_empty(msgs)) {
4030 ofputil_start_flow_update(msgs);
4032 ofputil_append_flow_update(&fu, msgs);
4036 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
4040 LIST_FOR_EACH (rule, ofproto_node, rules) {
4041 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4042 rule->monitor_flags = 0;
4044 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4049 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4050 struct rule *rule, uint64_t seqno,
4053 enum nx_flow_monitor_flags update;
4055 if (ofproto_rule_is_hidden(rule)) {
4060 ? ofoperation_has_out_port(rule->pending, m->out_port)
4061 : ofproto_rule_has_out_port(rule, m->out_port))) {
4066 if (rule->add_seqno > seqno) {
4067 update = NXFMF_ADD | NXFMF_MODIFY;
4068 } else if (rule->modify_seqno > seqno) {
4069 update = NXFMF_MODIFY;
4074 if (!(m->flags & update)) {
4078 update = NXFMF_INITIAL;
4081 if (!rule->monitor_flags) {
4082 list_push_back(rules, &rule->ofproto_node);
4084 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4088 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4092 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4093 const struct ofoperation *op;
4094 const struct oftable *table;
4095 struct cls_rule target;
4097 cls_rule_init_from_minimatch(&target, &m->match, 0);
4098 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4099 struct cls_cursor cursor;
4102 cls_cursor_init(&cursor, &table->cls, &target);
4103 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4104 ovs_assert(!rule->pending); /* XXX */
4105 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4109 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4110 struct rule *rule = op->rule;
4112 if (((m->table_id == 0xff
4113 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4114 : m->table_id == rule->table_id))
4115 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4116 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4119 cls_rule_destroy(&target);
4123 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4126 if (m->flags & NXFMF_INITIAL) {
4127 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4132 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4133 uint64_t seqno, struct list *rules)
4135 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4139 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4141 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4142 struct ofmonitor **monitors;
4143 size_t n_monitors, allocated_monitors;
4144 struct list replies;
4151 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4153 n_monitors = allocated_monitors = 0;
4155 struct ofputil_flow_monitor_request request;
4156 struct ofmonitor *m;
4159 retval = ofputil_decode_flow_monitor_request(&request, &b);
4160 if (retval == EOF) {
4162 } else if (retval) {
4167 if (request.table_id != 0xff
4168 && request.table_id >= ofproto->n_tables) {
4169 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4173 error = ofmonitor_create(&request, ofconn, &m);
4178 if (n_monitors >= allocated_monitors) {
4179 monitors = x2nrealloc(monitors, &allocated_monitors,
4182 monitors[n_monitors++] = m;
4186 for (i = 0; i < n_monitors; i++) {
4187 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4190 ofpmp_init(&replies, oh);
4191 ofmonitor_compose_refresh_updates(&rules, &replies);
4192 ofconn_send_replies(ofconn, &replies);
4199 for (i = 0; i < n_monitors; i++) {
4200 ofmonitor_destroy(monitors[i]);
4207 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4209 struct ofmonitor *m;
4212 id = ofputil_decode_flow_monitor_cancel(oh);
4213 m = ofmonitor_lookup(ofconn, id);
4215 return OFPERR_NXBRC_FM_BAD_ID;
4218 ofmonitor_destroy(m);
4222 /* Meters implementation.
4224 * Meter table entry, indexed by the OpenFlow meter_id.
4225 * These are always dynamically allocated to allocate enough space for
4227 * 'created' is used to compute the duration for meter stats.
4228 * 'list rules' is needed so that we can delete the dependent rules when the
4229 * meter table entry is deleted.
4230 * 'provider_meter_id' is for the provider's private use.
4233 long long int created; /* Time created. */
4234 struct list rules; /* List of "struct rule_dpif"s. */
4235 ofproto_meter_id provider_meter_id;
4236 uint16_t flags; /* Meter flags. */
4237 uint16_t n_bands; /* Number of meter bands. */
4238 struct ofputil_meter_band *bands;
4242 * This is used in instruction validation at flow set-up time,
4243 * as flows may not use non-existing meters.
4244 * This is also used by ofproto-providers to translate OpenFlow meter_ids
4245 * in METER instructions to the corresponding provider meter IDs.
4246 * Return value of UINT32_MAX signifies an invalid meter.
4249 ofproto_get_provider_meter_id(const struct ofproto * ofproto,
4250 uint32_t of_meter_id)
4252 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
4253 const struct meter *meter = ofproto->meters[of_meter_id];
4255 return meter->provider_meter_id.uint32;
4262 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
4266 meter->flags = config->flags;
4267 meter->n_bands = config->n_bands;
4268 meter->bands = xmemdup(config->bands,
4269 config->n_bands * sizeof *meter->bands);
4272 static struct meter *
4273 meter_create(const struct ofputil_meter_config *config,
4274 ofproto_meter_id provider_meter_id)
4276 struct meter *meter;
4278 meter = xzalloc(sizeof *meter);
4279 meter->provider_meter_id = provider_meter_id;
4280 meter->created = time_msec();
4281 list_init(&meter->rules);
4283 meter_update(meter, config);
4289 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
4292 for (mid = first; mid <= last; ++mid) {
4293 struct meter *meter = ofproto->meters[mid];
4295 ofproto->meters[mid] = NULL;
4296 ofproto->ofproto_class->meter_del(ofproto,
4297 meter->provider_meter_id);
4305 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4307 ofproto_meter_id provider_meter_id = { UINT32_MAX };
4308 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
4312 return OFPERR_OFPMMFC_METER_EXISTS;
4315 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
4318 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
4319 *meterp = meter_create(&mm->meter, provider_meter_id);
4325 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4327 struct meter *meter = ofproto->meters[mm->meter.meter_id];
4331 return OFPERR_OFPMMFC_UNKNOWN_METER;
4334 error = ofproto->ofproto_class->meter_set(ofproto,
4335 &meter->provider_meter_id,
4337 ovs_assert(meter->provider_meter_id.uint32 != UINT32_MAX);
4339 meter_update(meter, &mm->meter);
4345 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
4346 struct ofputil_meter_mod *mm)
4348 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4349 uint32_t meter_id = mm->meter.meter_id;
4350 uint32_t first, last;
4353 if (meter_id == OFPM13_ALL) {
4355 last = ofproto->meter_features.max_meters;
4357 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
4360 first = last = meter_id;
4363 /* First delete the rules that use this meter. If any of those rules are
4364 * currently being modified, postpone the whole operation until later. */
4366 for (meter_id = first; meter_id <= last; ++meter_id) {
4367 struct meter *meter = ofproto->meters[meter_id];
4368 if (meter && !list_is_empty(&meter->rules)) {
4371 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
4372 if (rule->pending) {
4373 return OFPROTO_POSTPONE;
4375 list_push_back(&rules, &rule->ofproto_node);
4379 if (!list_is_empty(&rules)) {
4380 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
4383 /* Delete the meters. */
4384 meter_delete(ofproto, first, last);
4390 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4392 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4393 struct ofputil_meter_mod mm;
4394 uint64_t bands_stub[256 / 8];
4395 struct ofpbuf bands;
4399 error = reject_slave_controller(ofconn);
4404 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
4406 error = ofputil_decode_meter_mod(oh, &mm, &bands);
4408 goto exit_free_bands;
4411 meter_id = mm.meter.meter_id;
4413 if (mm.command != OFPMC13_DELETE) {
4414 /* Fails also when meters are not implemented by the provider. */
4415 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
4416 error = OFPERR_OFPMMFC_INVALID_METER;
4417 goto exit_free_bands;
4419 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
4420 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
4421 goto exit_free_bands;
4425 switch (mm.command) {
4427 error = handle_add_meter(ofproto, &mm);
4430 case OFPMC13_MODIFY:
4431 error = handle_modify_meter(ofproto, &mm);
4434 case OFPMC13_DELETE:
4435 error = handle_delete_meter(ofconn, oh, &mm);
4439 error = OFPERR_OFPMMFC_BAD_COMMAND;
4444 ofpbuf_uninit(&bands);
4449 handle_meter_features_request(struct ofconn *ofconn,
4450 const struct ofp_header *request)
4452 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4453 struct ofputil_meter_features features;
4456 if (ofproto->ofproto_class->meter_get_features) {
4457 ofproto->ofproto_class->meter_get_features(ofproto, &features);
4459 memset(&features, 0, sizeof features);
4461 b = ofputil_encode_meter_features_reply(&features, request);
4463 ofconn_send_reply(ofconn, b);
4468 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
4471 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4472 struct list replies;
4473 uint64_t bands_stub[256 / 8];
4474 struct ofpbuf bands;
4475 uint32_t meter_id, first, last;
4477 ofputil_decode_meter_request(request, &meter_id);
4479 if (meter_id == OFPM13_ALL) {
4481 last = ofproto->meter_features.max_meters;
4483 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
4484 !ofproto->meters[meter_id]) {
4485 return OFPERR_OFPMMFC_UNKNOWN_METER;
4487 first = last = meter_id;
4490 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
4491 ofpmp_init(&replies, request);
4493 for (meter_id = first; meter_id <= last; ++meter_id) {
4494 struct meter *meter = ofproto->meters[meter_id];
4496 continue; /* Skip non-existing meters. */
4498 if (type == OFPTYPE_METER_STATS_REQUEST) {
4499 struct ofputil_meter_stats stats;
4501 stats.meter_id = meter_id;
4503 /* Provider sets the packet and byte counts, we do the rest. */
4504 stats.flow_count = list_size(&meter->rules);
4505 calc_duration(meter->created, time_msec(),
4506 &stats.duration_sec, &stats.duration_nsec);
4507 stats.n_bands = meter->n_bands;
4508 ofpbuf_clear(&bands);
4510 = ofpbuf_put_uninit(&bands,
4511 meter->n_bands * sizeof *stats.bands);
4513 if (!ofproto->ofproto_class->meter_get(ofproto,
4514 meter->provider_meter_id,
4516 ofputil_append_meter_stats(&replies, &stats);
4518 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
4519 struct ofputil_meter_config config;
4521 config.meter_id = meter_id;
4522 config.flags = meter->flags;
4523 config.n_bands = meter->n_bands;
4524 config.bands = meter->bands;
4525 ofputil_append_meter_config(&replies, &config);
4529 ofconn_send_replies(ofconn, &replies);
4530 ofpbuf_uninit(&bands);
4535 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
4537 const struct ofp_header *oh = msg->data;
4541 error = ofptype_decode(&type, oh);
4547 /* OpenFlow requests. */
4548 case OFPTYPE_ECHO_REQUEST:
4549 return handle_echo_request(ofconn, oh);
4551 case OFPTYPE_FEATURES_REQUEST:
4552 return handle_features_request(ofconn, oh);
4554 case OFPTYPE_GET_CONFIG_REQUEST:
4555 return handle_get_config_request(ofconn, oh);
4557 case OFPTYPE_SET_CONFIG:
4558 return handle_set_config(ofconn, oh);
4560 case OFPTYPE_PACKET_OUT:
4561 return handle_packet_out(ofconn, oh);
4563 case OFPTYPE_PORT_MOD:
4564 return handle_port_mod(ofconn, oh);
4566 case OFPTYPE_FLOW_MOD:
4567 return handle_flow_mod(ofconn, oh);
4569 case OFPTYPE_METER_MOD:
4570 return handle_meter_mod(ofconn, oh);
4572 case OFPTYPE_BARRIER_REQUEST:
4573 return handle_barrier_request(ofconn, oh);
4575 case OFPTYPE_ROLE_REQUEST:
4576 return handle_role_request(ofconn, oh);
4578 /* OpenFlow replies. */
4579 case OFPTYPE_ECHO_REPLY:
4582 /* Nicira extension requests. */
4583 case OFPTYPE_FLOW_MOD_TABLE_ID:
4584 return handle_nxt_flow_mod_table_id(ofconn, oh);
4586 case OFPTYPE_SET_FLOW_FORMAT:
4587 return handle_nxt_set_flow_format(ofconn, oh);
4589 case OFPTYPE_SET_PACKET_IN_FORMAT:
4590 return handle_nxt_set_packet_in_format(ofconn, oh);
4592 case OFPTYPE_SET_CONTROLLER_ID:
4593 return handle_nxt_set_controller_id(ofconn, oh);
4595 case OFPTYPE_FLOW_AGE:
4596 /* Nothing to do. */
4599 case OFPTYPE_FLOW_MONITOR_CANCEL:
4600 return handle_flow_monitor_cancel(ofconn, oh);
4602 case OFPTYPE_SET_ASYNC_CONFIG:
4603 return handle_nxt_set_async_config(ofconn, oh);
4605 /* Statistics requests. */
4606 case OFPTYPE_DESC_STATS_REQUEST:
4607 return handle_desc_stats_request(ofconn, oh);
4609 case OFPTYPE_FLOW_STATS_REQUEST:
4610 return handle_flow_stats_request(ofconn, oh);
4612 case OFPTYPE_AGGREGATE_STATS_REQUEST:
4613 return handle_aggregate_stats_request(ofconn, oh);
4615 case OFPTYPE_TABLE_STATS_REQUEST:
4616 return handle_table_stats_request(ofconn, oh);
4618 case OFPTYPE_PORT_STATS_REQUEST:
4619 return handle_port_stats_request(ofconn, oh);
4621 case OFPTYPE_QUEUE_STATS_REQUEST:
4622 return handle_queue_stats_request(ofconn, oh);
4624 case OFPTYPE_PORT_DESC_STATS_REQUEST:
4625 return handle_port_desc_stats_request(ofconn, oh);
4627 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
4628 return handle_flow_monitor_request(ofconn, oh);
4630 case OFPTYPE_METER_STATS_REQUEST:
4631 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
4632 return handle_meter_request(ofconn, oh, type);
4634 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
4635 return handle_meter_features_request(ofconn, oh);
4637 /* FIXME: Change the following once they are implemented: */
4638 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
4639 case OFPTYPE_GET_ASYNC_REQUEST:
4640 case OFPTYPE_GROUP_STATS_REQUEST:
4641 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
4642 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
4643 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
4644 return OFPERR_OFPBRC_BAD_TYPE;
4648 case OFPTYPE_FEATURES_REPLY:
4649 case OFPTYPE_GET_CONFIG_REPLY:
4650 case OFPTYPE_PACKET_IN:
4651 case OFPTYPE_FLOW_REMOVED:
4652 case OFPTYPE_PORT_STATUS:
4653 case OFPTYPE_BARRIER_REPLY:
4654 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
4655 case OFPTYPE_DESC_STATS_REPLY:
4656 case OFPTYPE_FLOW_STATS_REPLY:
4657 case OFPTYPE_QUEUE_STATS_REPLY:
4658 case OFPTYPE_PORT_STATS_REPLY:
4659 case OFPTYPE_TABLE_STATS_REPLY:
4660 case OFPTYPE_AGGREGATE_STATS_REPLY:
4661 case OFPTYPE_PORT_DESC_STATS_REPLY:
4662 case OFPTYPE_ROLE_REPLY:
4663 case OFPTYPE_FLOW_MONITOR_PAUSED:
4664 case OFPTYPE_FLOW_MONITOR_RESUMED:
4665 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
4666 case OFPTYPE_GET_ASYNC_REPLY:
4667 case OFPTYPE_GROUP_STATS_REPLY:
4668 case OFPTYPE_GROUP_DESC_STATS_REPLY:
4669 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
4670 case OFPTYPE_METER_STATS_REPLY:
4671 case OFPTYPE_METER_CONFIG_STATS_REPLY:
4672 case OFPTYPE_METER_FEATURES_STATS_REPLY:
4673 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
4675 return OFPERR_OFPBRC_BAD_TYPE;
4680 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
4682 int error = handle_openflow__(ofconn, ofp_msg);
4683 if (error && error != OFPROTO_POSTPONE) {
4684 ofconn_send_error(ofconn, ofp_msg->data, error);
4686 COVERAGE_INC(ofproto_recv_openflow);
4687 return error != OFPROTO_POSTPONE;
4690 /* Asynchronous operations. */
4692 /* Creates and returns a new ofopgroup that is not associated with any
4693 * OpenFlow connection.
4695 * The caller should add operations to the returned group with
4696 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4697 static struct ofopgroup *
4698 ofopgroup_create_unattached(struct ofproto *ofproto)
4700 struct ofopgroup *group = xzalloc(sizeof *group);
4701 group->ofproto = ofproto;
4702 list_init(&group->ofproto_node);
4703 list_init(&group->ops);
4704 list_init(&group->ofconn_node);
4708 /* Creates and returns a new ofopgroup for 'ofproto'.
4710 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
4711 * connection. The 'request' and 'buffer_id' arguments are ignored.
4713 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
4714 * If the ofopgroup eventually fails, then the error reply will include
4715 * 'request'. If the ofopgroup eventually succeeds, then the packet with
4716 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
4718 * The caller should add operations to the returned group with
4719 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4720 static struct ofopgroup *
4721 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
4722 const struct ofp_header *request, uint32_t buffer_id)
4724 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
4726 size_t request_len = ntohs(request->length);
4728 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
4730 ofconn_add_opgroup(ofconn, &group->ofconn_node);
4731 group->ofconn = ofconn;
4732 group->request = xmemdup(request, MIN(request_len, 64));
4733 group->buffer_id = buffer_id;
4738 /* Submits 'group' for processing.
4740 * If 'group' contains no operations (e.g. none were ever added, or all of the
4741 * ones that were added completed synchronously), then it is destroyed
4742 * immediately. Otherwise it is added to the ofproto's list of pending
4745 ofopgroup_submit(struct ofopgroup *group)
4747 if (!group->n_running) {
4748 ofopgroup_complete(group);
4750 list_push_back(&group->ofproto->pending, &group->ofproto_node);
4751 group->ofproto->n_pending++;
4756 ofopgroup_complete(struct ofopgroup *group)
4758 struct ofproto *ofproto = group->ofproto;
4760 struct ofconn *abbrev_ofconn;
4761 ovs_be32 abbrev_xid;
4763 struct ofoperation *op, *next_op;
4766 ovs_assert(!group->n_running);
4769 LIST_FOR_EACH (op, group_node, &group->ops) {
4776 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
4777 LIST_FOR_EACH (op, group_node, &group->ops) {
4778 if (op->type != OFOPERATION_DELETE) {
4779 struct ofpbuf *packet;
4782 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
4786 error = rule_execute(op->rule, in_port, packet);
4793 if (!error && !list_is_empty(&group->ofconn_node)) {
4794 abbrev_ofconn = group->ofconn;
4795 abbrev_xid = group->request->xid;
4797 abbrev_ofconn = NULL;
4798 abbrev_xid = htonl(0);
4800 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
4801 struct rule *rule = op->rule;
4803 /* We generally want to report the change to active OpenFlow flow
4804 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
4806 - The operation failed.
4808 - The affected rule is not visible to controllers.
4810 - The operation's only effect was to update rule->modified. */
4812 || ofproto_rule_is_hidden(rule)
4813 || (op->type == OFOPERATION_MODIFY
4815 && rule->flow_cookie == op->flow_cookie))) {
4816 /* Check that we can just cast from ofoperation_type to
4817 * nx_flow_update_event. */
4818 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_ADD
4820 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_DELETE
4822 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_MODIFY
4825 ofmonitor_report(ofproto->connmgr, rule,
4826 (enum nx_flow_update_event) op->type,
4827 op->reason, abbrev_ofconn, abbrev_xid);
4830 rule->pending = NULL;
4833 case OFOPERATION_ADD:
4837 ofproto_rule_destroy__(op->victim);
4838 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
4839 if (vid_mask == VLAN_VID_MASK) {
4840 if (ofproto->vlan_bitmap) {
4841 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4842 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4843 bitmap_set1(ofproto->vlan_bitmap, vid);
4844 ofproto->vlans_changed = true;
4847 ofproto->vlans_changed = true;
4851 oftable_substitute_rule(rule, op->victim);
4852 ofproto_rule_destroy__(rule);
4856 case OFOPERATION_DELETE:
4857 ovs_assert(!op->error);
4858 ofproto_rule_destroy__(rule);
4862 case OFOPERATION_MODIFY:
4864 rule->modified = time_msec();
4866 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
4868 free(rule->ofpacts);
4869 rule->ofpacts = op->ofpacts;
4870 rule->ofpacts_len = op->ofpacts_len;
4872 op->ofpacts_len = 0;
4881 ofoperation_destroy(op);
4884 ofmonitor_flush(ofproto->connmgr);
4886 if (!list_is_empty(&group->ofproto_node)) {
4887 ovs_assert(ofproto->n_pending > 0);
4888 ofproto->n_pending--;
4889 list_remove(&group->ofproto_node);
4891 if (!list_is_empty(&group->ofconn_node)) {
4892 list_remove(&group->ofconn_node);
4894 ofconn_send_error(group->ofconn, group->request, error);
4896 connmgr_retry(ofproto->connmgr);
4898 free(group->request);
4902 /* Initiates a new operation on 'rule', of the specified 'type', within
4903 * 'group'. Prior to calling, 'rule' must not have any pending operation.
4905 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4906 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
4908 * Returns the newly created ofoperation (which is also available as
4909 * rule->pending). */
4910 static struct ofoperation *
4911 ofoperation_create(struct ofopgroup *group, struct rule *rule,
4912 enum ofoperation_type type,
4913 enum ofp_flow_removed_reason reason)
4915 struct ofproto *ofproto = group->ofproto;
4916 struct ofoperation *op;
4918 ovs_assert(!rule->pending);
4920 op = rule->pending = xzalloc(sizeof *op);
4922 list_push_back(&group->ops, &op->group_node);
4925 op->reason = reason;
4926 op->flow_cookie = rule->flow_cookie;
4930 if (type == OFOPERATION_DELETE) {
4931 hmap_insert(&ofproto->deletions, &op->hmap_node,
4932 cls_rule_hash(&rule->cr, rule->table_id));
4939 ofoperation_destroy(struct ofoperation *op)
4941 struct ofopgroup *group = op->group;
4944 op->rule->pending = NULL;
4946 if (op->type == OFOPERATION_DELETE) {
4947 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
4949 list_remove(&op->group_node);
4954 /* Indicates that 'op' completed with status 'error', which is either 0 to
4955 * indicate success or an OpenFlow error code on failure.
4957 * If 'error' is 0, indicating success, the operation will be committed
4958 * permanently to the flow table. There is one interesting subcase:
4960 * - If 'op' is an "add flow" operation that is replacing an existing rule in
4961 * the flow table (the "victim" rule) by a new one, then the caller must
4962 * have uninitialized any derived state in the victim rule, as in step 5 in
4963 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
4964 * performs steps 6 and 7 for the victim rule, most notably by calling its
4965 * ->rule_dealloc() function.
4967 * If 'error' is nonzero, then generally the operation will be rolled back:
4969 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
4970 * restores the original rule. The caller must have uninitialized any
4971 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
4972 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
4973 * and 7 for the new rule, calling its ->rule_dealloc() function.
4975 * - If 'op' is a "modify flow" operation, ofproto restores the original
4978 * - 'op' must not be a "delete flow" operation. Removing a rule is not
4979 * allowed to fail. It must always succeed.
4981 * Please see the large comment in ofproto/ofproto-provider.h titled
4982 * "Asynchronous Operation Support" for more information. */
4984 ofoperation_complete(struct ofoperation *op, enum ofperr error)
4986 struct ofopgroup *group = op->group;
4988 ovs_assert(op->rule->pending == op);
4989 ovs_assert(group->n_running > 0);
4990 ovs_assert(!error || op->type != OFOPERATION_DELETE);
4993 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
4994 ofopgroup_complete(group);
4999 ofoperation_get_victim(struct ofoperation *op)
5001 ovs_assert(op->type == OFOPERATION_ADD);
5006 pick_datapath_id(const struct ofproto *ofproto)
5008 const struct ofport *port;
5010 port = ofproto_get_port(ofproto, OFPP_LOCAL);
5012 uint8_t ea[ETH_ADDR_LEN];
5015 error = netdev_get_etheraddr(port->netdev, ea);
5017 return eth_addr_to_uint64(ea);
5019 VLOG_WARN("%s: could not get MAC address for %s (%s)",
5020 ofproto->name, netdev_get_name(port->netdev),
5021 ovs_strerror(error));
5023 return ofproto->fallback_dpid;
5027 pick_fallback_dpid(void)
5029 uint8_t ea[ETH_ADDR_LEN];
5030 eth_addr_nicira_random(ea);
5031 return eth_addr_to_uint64(ea);
5034 /* Table overflow policy. */
5036 /* Chooses and returns a rule to evict from 'table'. Returns NULL if the table
5037 * is not configured to evict rules or if the table contains no evictable
5038 * rules. (Rules with 'evictable' set to false or with no timeouts are not
5040 static struct rule *
5041 choose_rule_to_evict(struct oftable *table)
5043 struct eviction_group *evg;
5045 if (!table->eviction_fields) {
5049 /* In the common case, the outer and inner loops here will each be entered
5052 * - The inner loop normally "return"s in its first iteration. If the
5053 * eviction group has any evictable rules, then it always returns in
5056 * - The outer loop only iterates more than once if the largest eviction
5057 * group has no evictable rules.
5059 * - The outer loop can exit only if table's 'max_flows' is all filled up
5060 * by unevictable rules'. */
5061 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
5064 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
5065 if (rule->evictable) {
5074 /* Searches 'ofproto' for tables that have more flows than their configured
5075 * maximum and that have flow eviction enabled, and evicts as many flows as
5076 * necessary and currently feasible from them.
5078 * This triggers only when an OpenFlow table has N flows in it and then the
5079 * client configures a maximum number of flows less than N. */
5081 ofproto_evict(struct ofproto *ofproto)
5083 struct ofopgroup *group;
5084 struct oftable *table;
5086 group = ofopgroup_create_unattached(ofproto);
5087 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
5088 while (classifier_count(&table->cls) > table->max_flows
5089 && table->eviction_fields) {
5092 rule = choose_rule_to_evict(table);
5093 if (!rule || rule->pending) {
5097 ofoperation_create(group, rule,
5098 OFOPERATION_DELETE, OFPRR_EVICTION);
5099 oftable_remove_rule(rule);
5100 ofproto->ofproto_class->rule_destruct(rule);
5103 ofopgroup_submit(group);
5106 /* Eviction groups. */
5108 /* Returns the priority to use for an eviction_group that contains 'n_rules'
5109 * rules. The priority contains low-order random bits to ensure that eviction
5110 * groups with the same number of rules are prioritized randomly. */
5112 eviction_group_priority(size_t n_rules)
5114 uint16_t size = MIN(UINT16_MAX, n_rules);
5115 return (size << 16) | random_uint16();
5118 /* Updates 'evg', an eviction_group within 'table', following a change that
5119 * adds or removes rules in 'evg'. */
5121 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
5123 heap_change(&table->eviction_groups_by_size, &evg->size_node,
5124 eviction_group_priority(heap_count(&evg->rules)));
5127 /* Destroys 'evg', an eviction_group within 'table':
5129 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
5130 * rules themselves, just removes them from the eviction group.)
5132 * - Removes 'evg' from 'table'.
5136 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
5138 while (!heap_is_empty(&evg->rules)) {
5141 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
5142 rule->eviction_group = NULL;
5144 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
5145 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
5146 heap_destroy(&evg->rules);
5150 /* Removes 'rule' from its eviction group, if any. */
5152 eviction_group_remove_rule(struct rule *rule)
5154 if (rule->eviction_group) {
5155 struct oftable *table = &rule->ofproto->tables[rule->table_id];
5156 struct eviction_group *evg = rule->eviction_group;
5158 rule->eviction_group = NULL;
5159 heap_remove(&evg->rules, &rule->evg_node);
5160 if (heap_is_empty(&evg->rules)) {
5161 eviction_group_destroy(table, evg);
5163 eviction_group_resized(table, evg);
5168 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
5169 * returns the hash value. */
5171 eviction_group_hash_rule(struct rule *rule)
5173 struct oftable *table = &rule->ofproto->tables[rule->table_id];
5174 const struct mf_subfield *sf;
5178 hash = table->eviction_group_id_basis;
5179 miniflow_expand(&rule->cr.match.flow, &flow);
5180 for (sf = table->eviction_fields;
5181 sf < &table->eviction_fields[table->n_eviction_fields];
5184 if (mf_are_prereqs_ok(sf->field, &flow)) {
5185 union mf_value value;
5187 mf_get_value(sf->field, &flow, &value);
5189 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
5191 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
5192 unsigned int start = sf->ofs + sf->n_bits;
5193 bitwise_zero(&value, sf->field->n_bytes, start,
5194 sf->field->n_bytes * 8 - start);
5196 hash = hash_bytes(&value, sf->field->n_bytes, hash);
5198 hash = hash_int(hash, 0);
5205 /* Returns an eviction group within 'table' with the given 'id', creating one
5207 static struct eviction_group *
5208 eviction_group_find(struct oftable *table, uint32_t id)
5210 struct eviction_group *evg;
5212 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
5216 evg = xmalloc(sizeof *evg);
5217 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
5218 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
5219 eviction_group_priority(0));
5220 heap_init(&evg->rules);
5225 /* Returns an eviction priority for 'rule'. The return value should be
5226 * interpreted so that higher priorities make a rule more attractive candidates
5229 rule_eviction_priority(struct rule *rule)
5231 long long int hard_expiration;
5232 long long int idle_expiration;
5233 long long int expiration;
5234 uint32_t expiration_offset;
5236 /* Calculate time of expiration. */
5237 ovs_mutex_lock(&rule->timeout_mutex);
5238 hard_expiration = (rule->hard_timeout
5239 ? rule->modified + rule->hard_timeout * 1000
5241 idle_expiration = (rule->idle_timeout
5242 ? rule->used + rule->idle_timeout * 1000
5244 expiration = MIN(hard_expiration, idle_expiration);
5245 ovs_mutex_unlock(&rule->timeout_mutex);
5246 if (expiration == LLONG_MAX) {
5250 /* Calculate the time of expiration as a number of (approximate) seconds
5251 * after program startup.
5253 * This should work OK for program runs that last UINT32_MAX seconds or
5254 * less. Therefore, please restart OVS at least once every 136 years. */
5255 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
5257 /* Invert the expiration offset because we're using a max-heap. */
5258 return UINT32_MAX - expiration_offset;
5261 /* Adds 'rule' to an appropriate eviction group for its oftable's
5262 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
5263 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
5266 * The caller must ensure that 'rule' is not already in an eviction group. */
5268 eviction_group_add_rule(struct rule *rule)
5270 struct ofproto *ofproto = rule->ofproto;
5271 struct oftable *table = &ofproto->tables[rule->table_id];
5274 ovs_mutex_lock(&rule->timeout_mutex);
5275 has_timeout = rule->hard_timeout || rule->idle_timeout;
5276 ovs_mutex_unlock(&rule->timeout_mutex);
5278 if (table->eviction_fields && has_timeout) {
5279 struct eviction_group *evg;
5281 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
5283 rule->eviction_group = evg;
5284 heap_insert(&evg->rules, &rule->evg_node,
5285 rule_eviction_priority(rule));
5286 eviction_group_resized(table, evg);
5292 /* Initializes 'table'. */
5294 oftable_init(struct oftable *table)
5296 memset(table, 0, sizeof *table);
5297 classifier_init(&table->cls);
5298 table->max_flows = UINT_MAX;
5301 /* Destroys 'table', including its classifier and eviction groups.
5303 * The caller is responsible for freeing 'table' itself. */
5305 oftable_destroy(struct oftable *table)
5307 ovs_assert(classifier_is_empty(&table->cls));
5308 oftable_disable_eviction(table);
5309 classifier_destroy(&table->cls);
5313 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
5314 * string, then 'table' will use its default name.
5316 * This only affects the name exposed for a table exposed through the OpenFlow
5317 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
5319 oftable_set_name(struct oftable *table, const char *name)
5321 if (name && name[0]) {
5322 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
5323 if (!table->name || strncmp(name, table->name, len)) {
5325 table->name = xmemdup0(name, len);
5333 /* oftables support a choice of two policies when adding a rule would cause the
5334 * number of flows in the table to exceed the configured maximum number: either
5335 * they can refuse to add the new flow or they can evict some existing flow.
5336 * This function configures the former policy on 'table'. */
5338 oftable_disable_eviction(struct oftable *table)
5340 if (table->eviction_fields) {
5341 struct eviction_group *evg, *next;
5343 HMAP_FOR_EACH_SAFE (evg, next, id_node,
5344 &table->eviction_groups_by_id) {
5345 eviction_group_destroy(table, evg);
5347 hmap_destroy(&table->eviction_groups_by_id);
5348 heap_destroy(&table->eviction_groups_by_size);
5350 free(table->eviction_fields);
5351 table->eviction_fields = NULL;
5352 table->n_eviction_fields = 0;
5356 /* oftables support a choice of two policies when adding a rule would cause the
5357 * number of flows in the table to exceed the configured maximum number: either
5358 * they can refuse to add the new flow or they can evict some existing flow.
5359 * This function configures the latter policy on 'table', with fairness based
5360 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
5361 * 'n_fields' as 0 disables fairness.) */
5363 oftable_enable_eviction(struct oftable *table,
5364 const struct mf_subfield *fields, size_t n_fields)
5366 struct cls_cursor cursor;
5369 if (table->eviction_fields
5370 && n_fields == table->n_eviction_fields
5372 || !memcmp(fields, table->eviction_fields,
5373 n_fields * sizeof *fields))) {
5378 oftable_disable_eviction(table);
5380 table->n_eviction_fields = n_fields;
5381 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
5383 table->eviction_group_id_basis = random_uint32();
5384 hmap_init(&table->eviction_groups_by_id);
5385 heap_init(&table->eviction_groups_by_size);
5387 cls_cursor_init(&cursor, &table->cls, NULL);
5388 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
5389 eviction_group_add_rule(rule);
5393 /* Removes 'rule' from the oftable that contains it. */
5395 oftable_remove_rule(struct rule *rule)
5397 struct ofproto *ofproto = rule->ofproto;
5398 struct oftable *table = &ofproto->tables[rule->table_id];
5400 classifier_remove(&table->cls, &rule->cr);
5401 if (rule->meter_id) {
5402 list_remove(&rule->meter_list_node);
5404 cookies_remove(ofproto, rule);
5405 eviction_group_remove_rule(rule);
5406 ovs_mutex_lock(&ofproto->expirable_mutex);
5407 if (!list_is_empty(&rule->expirable)) {
5408 list_remove(&rule->expirable);
5410 ovs_mutex_unlock(&ofproto->expirable_mutex);
5411 if (!list_is_empty(&rule->meter_list_node)) {
5412 list_remove(&rule->meter_list_node);
5416 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
5417 * oftable that has an identical cls_rule. Returns the rule that was removed,
5418 * if any, and otherwise NULL. */
5419 static struct rule *
5420 oftable_replace_rule(struct rule *rule)
5422 struct ofproto *ofproto = rule->ofproto;
5423 struct oftable *table = &ofproto->tables[rule->table_id];
5424 struct rule *victim;
5427 ovs_mutex_lock(&rule->timeout_mutex);
5428 may_expire = rule->hard_timeout || rule->idle_timeout;
5429 ovs_mutex_unlock(&rule->timeout_mutex);
5432 ovs_mutex_lock(&ofproto->expirable_mutex);
5433 list_insert(&ofproto->expirable, &rule->expirable);
5434 ovs_mutex_unlock(&ofproto->expirable_mutex);
5436 cookies_insert(ofproto, rule);
5437 if (rule->meter_id) {
5438 struct meter *meter = ofproto->meters[rule->meter_id];
5439 list_insert(&meter->rules, &rule->meter_list_node);
5441 victim = rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
5443 if (victim->meter_id) {
5444 list_remove(&victim->meter_list_node);
5446 cookies_remove(ofproto, victim);
5448 ovs_mutex_lock(&ofproto->expirable_mutex);
5449 if (!list_is_empty(&victim->expirable)) {
5450 list_remove(&victim->expirable);
5452 ovs_mutex_unlock(&ofproto->expirable_mutex);
5453 eviction_group_remove_rule(victim);
5455 eviction_group_add_rule(rule);
5459 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
5461 oftable_substitute_rule(struct rule *old, struct rule *new)
5464 oftable_replace_rule(new);
5466 oftable_remove_rule(old);
5470 /* unixctl commands. */
5473 ofproto_lookup(const char *name)
5475 struct ofproto *ofproto;
5477 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
5479 if (!strcmp(ofproto->name, name)) {
5487 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
5488 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
5490 struct ofproto *ofproto;
5494 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
5495 ds_put_format(&results, "%s\n", ofproto->name);
5497 unixctl_command_reply(conn, ds_cstr(&results));
5498 ds_destroy(&results);
5502 ofproto_unixctl_init(void)
5504 static bool registered;
5510 unixctl_command_register("ofproto/list", "", 0, 0,
5511 ofproto_unixctl_list, NULL);
5514 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
5516 * This is deprecated. It is only for compatibility with broken device drivers
5517 * in old versions of Linux that do not properly support VLANs when VLAN
5518 * devices are not used. When broken device drivers are no longer in
5519 * widespread use, we will delete these interfaces. */
5521 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
5522 * (exactly) by an OpenFlow rule in 'ofproto'. */
5524 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
5526 const struct oftable *oftable;
5528 free(ofproto->vlan_bitmap);
5529 ofproto->vlan_bitmap = bitmap_allocate(4096);
5530 ofproto->vlans_changed = false;
5532 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
5533 const struct cls_table *table;
5535 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
5536 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
5537 const struct cls_rule *rule;
5539 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
5540 uint16_t vid = miniflow_get_vid(&rule->match.flow);
5541 bitmap_set1(vlan_bitmap, vid);
5542 bitmap_set1(ofproto->vlan_bitmap, vid);
5549 /* Returns true if new VLANs have come into use by the flow table since the
5550 * last call to ofproto_get_vlan_usage().
5552 * We don't track when old VLANs stop being used. */
5554 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
5556 return ofproto->vlans_changed;
5559 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
5560 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
5561 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
5562 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
5563 * then the VLAN device is un-enslaved. */
5565 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
5566 ofp_port_t realdev_ofp_port, int vid)
5568 struct ofport *ofport;
5571 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
5573 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
5575 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
5576 ofproto->name, vlandev_ofp_port);
5580 if (!ofproto->ofproto_class->set_realdev) {
5581 if (!vlandev_ofp_port) {
5584 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
5588 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
5590 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
5591 ofproto->name, vlandev_ofp_port,
5592 netdev_get_name(ofport->netdev), ovs_strerror(error));