2 * Copyright (c) 2009, 2010, 2011, 2012 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;
130 /* OFOPERATION_DELETE. */
131 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
133 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
134 enum ofperr error; /* 0 if no error. */
137 static struct ofoperation *ofoperation_create(struct ofopgroup *,
139 enum ofoperation_type,
140 enum ofp_flow_removed_reason);
141 static void ofoperation_destroy(struct ofoperation *);
144 static void oftable_init(struct oftable *);
145 static void oftable_destroy(struct oftable *);
147 static void oftable_set_name(struct oftable *, const char *name);
149 static void oftable_disable_eviction(struct oftable *);
150 static void oftable_enable_eviction(struct oftable *,
151 const struct mf_subfield *fields,
154 static void oftable_remove_rule(struct rule *);
155 static struct rule *oftable_replace_rule(struct rule *);
156 static void oftable_substitute_rule(struct rule *old, struct rule *new);
158 /* A set of rules within a single OpenFlow table (oftable) that have the same
159 * values for the oftable's eviction_fields. A rule to be evicted, when one is
160 * needed, is taken from the eviction group that contains the greatest number
163 * An oftable owns any number of eviction groups, each of which contains any
166 * Membership in an eviction group is imprecise, based on the hash of the
167 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
168 * That is, if two rules have different eviction_fields, but those
169 * eviction_fields hash to the same value, then they will belong to the same
170 * eviction_group anyway.
172 * (When eviction is not enabled on an oftable, we don't track any eviction
173 * groups, to save time and space.) */
174 struct eviction_group {
175 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
176 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
177 struct heap rules; /* Contains "struct rule"s. */
180 static struct rule *choose_rule_to_evict(struct oftable *);
181 static void ofproto_evict(struct ofproto *);
182 static uint32_t rule_eviction_priority(struct rule *);
185 static void ofport_destroy__(struct ofport *);
186 static void ofport_destroy(struct ofport *);
188 static void update_port(struct ofproto *, const char *devname);
189 static int init_ports(struct ofproto *);
190 static void reinit_ports(struct ofproto *);
193 static void ofproto_rule_destroy__(struct rule *);
194 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
195 static bool rule_is_modifiable(const struct rule *);
198 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
199 const struct ofputil_flow_mod *,
200 const struct ofp_header *);
201 static void delete_flow__(struct rule *, struct ofopgroup *);
202 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
203 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
204 const struct ofputil_flow_mod *,
205 const struct ofp_header *);
208 static uint64_t pick_datapath_id(const struct ofproto *);
209 static uint64_t pick_fallback_dpid(void);
210 static void ofproto_destroy__(struct ofproto *);
211 static void update_mtu(struct ofproto *, struct ofport *);
214 static void ofproto_unixctl_init(void);
216 /* All registered ofproto classes, in probe order. */
217 static const struct ofproto_class **ofproto_classes;
218 static size_t n_ofproto_classes;
219 static size_t allocated_ofproto_classes;
221 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
222 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
224 /* Initial mappings of port to OpenFlow number mappings. */
225 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
227 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
229 /* Must be called to initialize the ofproto library.
231 * The caller may pass in 'iface_hints', which contains an shash of
232 * "iface_hint" elements indexed by the interface's name. The provider
233 * may use these hints to describe the startup configuration in order to
234 * reinitialize its state. The caller owns the provided data, so a
235 * provider will make copies of anything required. An ofproto provider
236 * will remove any existing state that is not described by the hint, and
237 * may choose to remove it all. */
239 ofproto_init(const struct shash *iface_hints)
241 struct shash_node *node;
244 ofproto_class_register(&ofproto_dpif_class);
246 /* Make a local copy, since we don't own 'iface_hints' elements. */
247 SHASH_FOR_EACH(node, iface_hints) {
248 const struct iface_hint *orig_hint = node->data;
249 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
250 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
252 new_hint->br_name = xstrdup(orig_hint->br_name);
253 new_hint->br_type = xstrdup(br_type);
254 new_hint->ofp_port = orig_hint->ofp_port;
256 shash_add(&init_ofp_ports, node->name, new_hint);
259 for (i = 0; i < n_ofproto_classes; i++) {
260 ofproto_classes[i]->init(&init_ofp_ports);
264 /* 'type' should be a normalized datapath type, as returned by
265 * ofproto_normalize_type(). Returns the corresponding ofproto_class
266 * structure, or a null pointer if there is none registered for 'type'. */
267 static const struct ofproto_class *
268 ofproto_class_find__(const char *type)
272 for (i = 0; i < n_ofproto_classes; i++) {
273 const struct ofproto_class *class = ofproto_classes[i];
278 class->enumerate_types(&types);
279 found = sset_contains(&types, type);
280 sset_destroy(&types);
286 VLOG_WARN("unknown datapath type %s", type);
290 /* Registers a new ofproto class. After successful registration, new ofprotos
291 * of that type can be created using ofproto_create(). */
293 ofproto_class_register(const struct ofproto_class *new_class)
297 for (i = 0; i < n_ofproto_classes; i++) {
298 if (ofproto_classes[i] == new_class) {
303 if (n_ofproto_classes >= allocated_ofproto_classes) {
304 ofproto_classes = x2nrealloc(ofproto_classes,
305 &allocated_ofproto_classes,
306 sizeof *ofproto_classes);
308 ofproto_classes[n_ofproto_classes++] = new_class;
312 /* Unregisters a datapath provider. 'type' must have been previously
313 * registered and not currently be in use by any ofprotos. After
314 * unregistration new datapaths of that type cannot be opened using
315 * ofproto_create(). */
317 ofproto_class_unregister(const struct ofproto_class *class)
321 for (i = 0; i < n_ofproto_classes; i++) {
322 if (ofproto_classes[i] == class) {
323 for (i++; i < n_ofproto_classes; i++) {
324 ofproto_classes[i - 1] = ofproto_classes[i];
330 VLOG_WARN("attempted to unregister an ofproto class that is not "
335 /* Clears 'types' and enumerates all registered ofproto types into it. The
336 * caller must first initialize the sset. */
338 ofproto_enumerate_types(struct sset *types)
342 for (i = 0; i < n_ofproto_classes; i++) {
343 ofproto_classes[i]->enumerate_types(types);
347 /* Returns the fully spelled out name for the given ofproto 'type'.
349 * Normalized type string can be compared with strcmp(). Unnormalized type
350 * string might be the same even if they have different spellings. */
352 ofproto_normalize_type(const char *type)
354 return type && type[0] ? type : "system";
357 /* Clears 'names' and enumerates the names of all known created ofprotos with
358 * the given 'type'. The caller must first initialize the sset. Returns 0 if
359 * successful, otherwise a positive errno value.
361 * Some kinds of datapaths might not be practically enumerable. This is not
362 * considered an error. */
364 ofproto_enumerate_names(const char *type, struct sset *names)
366 const struct ofproto_class *class = ofproto_class_find__(type);
367 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
371 ofproto_create(const char *datapath_name, const char *datapath_type,
372 struct ofproto **ofprotop)
374 const struct ofproto_class *class;
375 struct ofproto *ofproto;
381 ofproto_unixctl_init();
383 datapath_type = ofproto_normalize_type(datapath_type);
384 class = ofproto_class_find__(datapath_type);
386 VLOG_WARN("could not create datapath %s of unknown type %s",
387 datapath_name, datapath_type);
391 ofproto = class->alloc();
393 VLOG_ERR("failed to allocate datapath %s of type %s",
394 datapath_name, datapath_type);
399 memset(ofproto, 0, sizeof *ofproto);
400 ofproto->ofproto_class = class;
401 ofproto->name = xstrdup(datapath_name);
402 ofproto->type = xstrdup(datapath_type);
403 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
404 hash_string(ofproto->name, 0));
405 ofproto->datapath_id = 0;
406 ofproto_set_flow_eviction_threshold(ofproto,
407 OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT);
408 ofproto->forward_bpdu = false;
409 ofproto->fallback_dpid = pick_fallback_dpid();
410 ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
411 ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
412 ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
413 ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
414 ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
415 ofproto->frag_handling = OFPC_FRAG_NORMAL;
416 hmap_init(&ofproto->ports);
417 shash_init(&ofproto->port_by_name);
418 simap_init(&ofproto->ofp_requests);
419 ofproto->max_ports = OFPP_MAX;
420 ofproto->tables = NULL;
421 ofproto->n_tables = 0;
422 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
423 ofproto->state = S_OPENFLOW;
424 list_init(&ofproto->pending);
425 ofproto->n_pending = 0;
426 hmap_init(&ofproto->deletions);
427 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
428 ofproto->first_op = ofproto->last_op = LLONG_MIN;
429 ofproto->next_op_report = LLONG_MAX;
430 ofproto->op_backoff = LLONG_MIN;
431 ofproto->vlan_bitmap = NULL;
432 ofproto->vlans_changed = false;
433 ofproto->min_mtu = INT_MAX;
435 error = ofproto->ofproto_class->construct(ofproto);
437 VLOG_ERR("failed to open datapath %s: %s",
438 datapath_name, strerror(error));
439 ofproto_destroy__(ofproto);
443 /* The "max_ports" member should have been set by ->construct(ofproto).
444 * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
445 ofproto->ofp_port_ids = bitmap_allocate(ofproto->max_ports);
446 bitmap_set1(ofproto->ofp_port_ids, 0);
448 /* Check that hidden tables, if any, are at the end. */
449 assert(ofproto->n_tables);
450 for (i = 0; i + 1 < ofproto->n_tables; i++) {
451 enum oftable_flags flags = ofproto->tables[i].flags;
452 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
454 assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
457 ofproto->datapath_id = pick_datapath_id(ofproto);
464 /* Must be called (only) by an ofproto implementation in its constructor
465 * function. See the large comment on 'construct' in struct ofproto_class for
468 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
470 struct oftable *table;
472 assert(!ofproto->n_tables);
473 assert(n_tables >= 1 && n_tables <= 255);
475 ofproto->n_tables = n_tables;
476 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
477 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
482 /* To be optionally called (only) by an ofproto implementation in its
483 * constructor function. See the large comment on 'construct' in struct
484 * ofproto_class for details.
486 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
487 * will then ensure that actions passed into the ofproto implementation will
488 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
489 * function is not called, there will be no such restriction.
491 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
492 * the 'max_ports' restriction. */
494 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
496 assert(max_ports <= OFPP_MAX);
497 ofproto->max_ports = max_ports;
501 ofproto_get_datapath_id(const struct ofproto *ofproto)
503 return ofproto->datapath_id;
507 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
509 uint64_t old_dpid = p->datapath_id;
510 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
511 if (p->datapath_id != old_dpid) {
512 /* Force all active connections to reconnect, since there is no way to
513 * notify a controller that the datapath ID has changed. */
514 ofproto_reconnect_controllers(p);
519 ofproto_set_controllers(struct ofproto *p,
520 const struct ofproto_controller *controllers,
521 size_t n_controllers, uint32_t allowed_versions)
523 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
528 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
530 connmgr_set_fail_mode(p->connmgr, fail_mode);
533 /* Drops the connections between 'ofproto' and all of its controllers, forcing
534 * them to reconnect. */
536 ofproto_reconnect_controllers(struct ofproto *ofproto)
538 connmgr_reconnect(ofproto->connmgr);
541 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
542 * in-band control should guarantee access, in the same way that in-band
543 * control guarantees access to OpenFlow controllers. */
545 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
546 const struct sockaddr_in *extras, size_t n)
548 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
551 /* Sets the OpenFlow queue used by flows set up by in-band control on
552 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
553 * flows will use the default queue. */
555 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
557 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
560 /* Sets the number of flows at which eviction from the kernel flow table
563 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
565 if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
566 ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
568 ofproto->flow_eviction_threshold = threshold;
572 /* If forward_bpdu is true, the NORMAL action will forward frames with
573 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
574 * the NORMAL action will drop these frames. */
576 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
578 bool old_val = ofproto->forward_bpdu;
579 ofproto->forward_bpdu = forward_bpdu;
580 if (old_val != ofproto->forward_bpdu) {
581 if (ofproto->ofproto_class->forward_bpdu_changed) {
582 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
587 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
588 * 'idle_time', in seconds. */
590 ofproto_set_mac_idle_time(struct ofproto *ofproto, unsigned idle_time)
592 if (ofproto->ofproto_class->set_mac_idle_time) {
593 ofproto->ofproto_class->set_mac_idle_time(ofproto, idle_time);
598 ofproto_set_desc(struct ofproto *p,
599 const char *mfr_desc, const char *hw_desc,
600 const char *sw_desc, const char *serial_desc,
603 struct ofp_desc_stats *ods;
606 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
607 VLOG_WARN("%s: truncating mfr_desc, must be less than %zu bytes",
608 p->name, sizeof ods->mfr_desc);
611 p->mfr_desc = xstrdup(mfr_desc);
614 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
615 VLOG_WARN("%s: truncating hw_desc, must be less than %zu bytes",
616 p->name, sizeof ods->hw_desc);
619 p->hw_desc = xstrdup(hw_desc);
622 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
623 VLOG_WARN("%s: truncating sw_desc, must be less than %zu bytes",
624 p->name, sizeof ods->sw_desc);
627 p->sw_desc = xstrdup(sw_desc);
630 if (strlen(serial_desc) >= sizeof ods->serial_num) {
631 VLOG_WARN("%s: truncating serial_desc, must be less than %zu "
632 "bytes", p->name, sizeof ods->serial_num);
634 free(p->serial_desc);
635 p->serial_desc = xstrdup(serial_desc);
638 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
639 VLOG_WARN("%s: truncating dp_desc, must be less than %zu bytes",
640 p->name, sizeof ods->dp_desc);
643 p->dp_desc = xstrdup(dp_desc);
648 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
650 return connmgr_set_snoops(ofproto->connmgr, snoops);
654 ofproto_set_netflow(struct ofproto *ofproto,
655 const struct netflow_options *nf_options)
657 if (nf_options && sset_is_empty(&nf_options->collectors)) {
661 if (ofproto->ofproto_class->set_netflow) {
662 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
664 return nf_options ? EOPNOTSUPP : 0;
669 ofproto_set_sflow(struct ofproto *ofproto,
670 const struct ofproto_sflow_options *oso)
672 if (oso && sset_is_empty(&oso->targets)) {
676 if (ofproto->ofproto_class->set_sflow) {
677 return ofproto->ofproto_class->set_sflow(ofproto, oso);
679 return oso ? EOPNOTSUPP : 0;
683 /* Spanning Tree Protocol (STP) configuration. */
685 /* Configures STP on 'ofproto' using the settings defined in 's'. If
686 * 's' is NULL, disables STP.
688 * Returns 0 if successful, otherwise a positive errno value. */
690 ofproto_set_stp(struct ofproto *ofproto,
691 const struct ofproto_stp_settings *s)
693 return (ofproto->ofproto_class->set_stp
694 ? ofproto->ofproto_class->set_stp(ofproto, s)
698 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
699 * 'enabled' member of 's' is false, then the other members are not
702 * Returns 0 if successful, otherwise a positive errno value. */
704 ofproto_get_stp_status(struct ofproto *ofproto,
705 struct ofproto_stp_status *s)
707 return (ofproto->ofproto_class->get_stp_status
708 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
712 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
713 * in 's'. The caller is responsible for assigning STP port numbers
714 * (using the 'port_num' member in the range of 1 through 255, inclusive)
715 * and ensuring there are no duplicates. If the 's' is NULL, then STP
716 * is disabled on the port.
718 * Returns 0 if successful, otherwise a positive errno value.*/
720 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
721 const struct ofproto_port_stp_settings *s)
723 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
725 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
726 ofproto->name, ofp_port);
730 return (ofproto->ofproto_class->set_stp_port
731 ? ofproto->ofproto_class->set_stp_port(ofport, s)
735 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
736 * 's'. If the 'enabled' member in 's' is false, then the other members
737 * are not meaningful.
739 * Returns 0 if successful, otherwise a positive errno value.*/
741 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
742 struct ofproto_port_stp_status *s)
744 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
746 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
747 "port %"PRIu16, ofproto->name, ofp_port);
751 return (ofproto->ofproto_class->get_stp_port_status
752 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
756 /* Queue DSCP configuration. */
758 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
759 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
760 * to implement QoS. Instead, it is used to implement features which require
761 * knowledge of what queues exist on a port, and some basic information about
764 * Returns 0 if successful, otherwise a positive errno value. */
766 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
767 const struct ofproto_port_queue *queues,
770 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
773 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
774 ofproto->name, ofp_port);
778 return (ofproto->ofproto_class->set_queues
779 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
783 /* Connectivity Fault Management configuration. */
785 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
787 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
789 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
790 if (ofport && ofproto->ofproto_class->set_cfm) {
791 ofproto->ofproto_class->set_cfm(ofport, NULL);
795 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
796 * basic configuration from the configuration members in 'cfm', and the remote
797 * maintenance point ID from remote_mpid. Ignores the statistics members of
800 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
802 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
803 const struct cfm_settings *s)
805 struct ofport *ofport;
808 ofport = ofproto_get_port(ofproto, ofp_port);
810 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
811 ofproto->name, ofp_port);
815 /* XXX: For configuration simplicity, we only support one remote_mpid
816 * outside of the CFM module. It's not clear if this is the correct long
817 * term solution or not. */
818 error = (ofproto->ofproto_class->set_cfm
819 ? ofproto->ofproto_class->set_cfm(ofport, s)
822 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
823 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
828 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
829 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
830 * 0 if LACP partner information is not current (generally indicating a
831 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
833 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
835 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
836 return (ofport && ofproto->ofproto_class->port_is_lacp_current
837 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
843 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
844 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
845 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
846 * configuration plus, if there is more than one slave, a bonding
849 * If 'aux' is already registered then this function updates its configuration
850 * to 's'. Otherwise, this function registers a new bundle.
852 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
855 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
856 const struct ofproto_bundle_settings *s)
858 return (ofproto->ofproto_class->bundle_set
859 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
863 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
864 * If no such bundle has been registered, this has no effect. */
866 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
868 return ofproto_bundle_register(ofproto, aux, NULL);
872 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
873 * If 'aux' is already registered then this function updates its configuration
874 * to 's'. Otherwise, this function registers a new mirror. */
876 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
877 const struct ofproto_mirror_settings *s)
879 return (ofproto->ofproto_class->mirror_set
880 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
884 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
885 * If no mirror has been registered, this has no effect. */
887 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
889 return ofproto_mirror_register(ofproto, aux, NULL);
892 /* Retrieves statistics from mirror associated with client data pointer
893 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
894 * 'bytes', respectively. If a particular counters is not supported,
895 * the appropriate argument is set to UINT64_MAX. */
897 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
898 uint64_t *packets, uint64_t *bytes)
900 if (!ofproto->ofproto_class->mirror_get_stats) {
901 *packets = *bytes = UINT64_MAX;
905 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
909 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
910 * which all packets are flooded, instead of using MAC learning. If
911 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
913 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
916 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
918 return (ofproto->ofproto_class->set_flood_vlans
919 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
923 /* Returns true if 'aux' is a registered bundle that is currently in use as the
924 * output for a mirror. */
926 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
928 return (ofproto->ofproto_class->is_mirror_output_bundle
929 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
933 /* Configuration of OpenFlow tables. */
935 /* Returns the number of OpenFlow tables in 'ofproto'. */
937 ofproto_get_n_tables(const struct ofproto *ofproto)
939 return ofproto->n_tables;
942 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
943 * settings from 's'. 'table_id' must be in the range 0 through the number of
944 * OpenFlow tables in 'ofproto' minus 1, inclusive.
946 * For read-only tables, only the name may be configured. */
948 ofproto_configure_table(struct ofproto *ofproto, int table_id,
949 const struct ofproto_table_settings *s)
951 struct oftable *table;
953 assert(table_id >= 0 && table_id < ofproto->n_tables);
954 table = &ofproto->tables[table_id];
956 oftable_set_name(table, s->name);
958 if (table->flags & OFTABLE_READONLY) {
963 oftable_enable_eviction(table, s->groups, s->n_groups);
965 oftable_disable_eviction(table);
968 table->max_flows = s->max_flows;
969 if (classifier_count(&table->cls) > table->max_flows
970 && table->eviction_fields) {
971 /* 'table' contains more flows than allowed. We might not be able to
972 * evict them right away because of the asynchronous nature of flow
973 * table changes. Schedule eviction for later. */
974 switch (ofproto->state) {
976 ofproto->state = S_EVICT;
980 /* We're already deleting flows, nothing more to do. */
987 ofproto_has_snoops(const struct ofproto *ofproto)
989 return connmgr_has_snoops(ofproto->connmgr);
993 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
995 connmgr_get_snoops(ofproto->connmgr, snoops);
999 ofproto_flush__(struct ofproto *ofproto)
1001 struct ofopgroup *group;
1002 struct oftable *table;
1004 if (ofproto->ofproto_class->flush) {
1005 ofproto->ofproto_class->flush(ofproto);
1008 group = ofopgroup_create_unattached(ofproto);
1009 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1010 struct rule *rule, *next_rule;
1011 struct cls_cursor cursor;
1013 if (table->flags & OFTABLE_HIDDEN) {
1017 cls_cursor_init(&cursor, &table->cls, NULL);
1018 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1019 if (!rule->pending) {
1020 ofoperation_create(group, rule, OFOPERATION_DELETE,
1022 oftable_remove_rule(rule);
1023 ofproto->ofproto_class->rule_destruct(rule);
1027 ofopgroup_submit(group);
1031 ofproto_destroy__(struct ofproto *ofproto)
1033 struct oftable *table;
1035 assert(list_is_empty(&ofproto->pending));
1036 assert(!ofproto->n_pending);
1038 connmgr_destroy(ofproto->connmgr);
1040 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1041 free(ofproto->name);
1042 free(ofproto->type);
1043 free(ofproto->mfr_desc);
1044 free(ofproto->hw_desc);
1045 free(ofproto->sw_desc);
1046 free(ofproto->serial_desc);
1047 free(ofproto->dp_desc);
1048 hmap_destroy(&ofproto->ports);
1049 shash_destroy(&ofproto->port_by_name);
1050 bitmap_free(ofproto->ofp_port_ids);
1051 simap_destroy(&ofproto->ofp_requests);
1053 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1054 oftable_destroy(table);
1056 free(ofproto->tables);
1058 hmap_destroy(&ofproto->deletions);
1060 free(ofproto->vlan_bitmap);
1062 ofproto->ofproto_class->dealloc(ofproto);
1066 ofproto_destroy(struct ofproto *p)
1068 struct ofport *ofport, *next_ofport;
1075 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1076 ofport_destroy(ofport);
1079 p->ofproto_class->destruct(p);
1080 ofproto_destroy__(p);
1083 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1084 * kernel datapath, for example, this destroys the datapath in the kernel, and
1085 * with the netdev-based datapath, it tears down the data structures that
1086 * represent the datapath.
1088 * The datapath should not be currently open as an ofproto. */
1090 ofproto_delete(const char *name, const char *type)
1092 const struct ofproto_class *class = ofproto_class_find__(type);
1093 return (!class ? EAFNOSUPPORT
1094 : !class->del ? EACCES
1095 : class->del(type, name));
1099 process_port_change(struct ofproto *ofproto, int error, char *devname)
1101 if (error == ENOBUFS) {
1102 reinit_ports(ofproto);
1103 } else if (!error) {
1104 update_port(ofproto, devname);
1110 ofproto_type_run(const char *datapath_type)
1112 const struct ofproto_class *class;
1115 datapath_type = ofproto_normalize_type(datapath_type);
1116 class = ofproto_class_find__(datapath_type);
1118 error = class->type_run ? class->type_run(datapath_type) : 0;
1119 if (error && error != EAGAIN) {
1120 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1121 datapath_type, strerror(error));
1127 ofproto_type_run_fast(const char *datapath_type)
1129 const struct ofproto_class *class;
1132 datapath_type = ofproto_normalize_type(datapath_type);
1133 class = ofproto_class_find__(datapath_type);
1135 error = class->type_run_fast ? class->type_run_fast(datapath_type) : 0;
1136 if (error && error != EAGAIN) {
1137 VLOG_ERR_RL(&rl, "%s: type_run_fast failed (%s)",
1138 datapath_type, strerror(error));
1144 ofproto_type_wait(const char *datapath_type)
1146 const struct ofproto_class *class;
1148 datapath_type = ofproto_normalize_type(datapath_type);
1149 class = ofproto_class_find__(datapath_type);
1151 if (class->type_wait) {
1152 class->type_wait(datapath_type);
1157 ofproto_run(struct ofproto *p)
1159 struct sset changed_netdevs;
1160 const char *changed_netdev;
1161 struct ofport *ofport;
1164 error = p->ofproto_class->run(p);
1165 if (error && error != EAGAIN) {
1166 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, strerror(error));
1169 if (p->ofproto_class->port_poll) {
1172 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1173 process_port_change(p, error, devname);
1177 /* Update OpenFlow port status for any port whose netdev has changed.
1179 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1180 * destroyed, so it's not safe to update ports directly from the
1181 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1182 * need this two-phase approach. */
1183 sset_init(&changed_netdevs);
1184 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1185 unsigned int change_seq = netdev_change_seq(ofport->netdev);
1186 if (ofport->change_seq != change_seq) {
1187 ofport->change_seq = change_seq;
1188 sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1191 SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1192 update_port(p, changed_netdev);
1194 sset_destroy(&changed_netdevs);
1198 connmgr_run(p->connmgr, handle_openflow);
1202 connmgr_run(p->connmgr, NULL);
1204 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1205 p->state = S_OPENFLOW;
1210 connmgr_run(p->connmgr, NULL);
1212 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1213 connmgr_flushed(p->connmgr);
1214 p->state = S_OPENFLOW;
1222 if (time_msec() >= p->next_op_report) {
1223 long long int ago = (time_msec() - p->first_op) / 1000;
1224 long long int interval = (p->last_op - p->first_op) / 1000;
1228 ds_put_format(&s, "%d flow_mods ",
1229 p->n_add + p->n_delete + p->n_modify);
1230 if (interval == ago) {
1231 ds_put_format(&s, "in the last %lld s", ago);
1232 } else if (interval) {
1233 ds_put_format(&s, "in the %lld s starting %lld s ago",
1236 ds_put_format(&s, "%lld s ago", ago);
1239 ds_put_cstr(&s, " (");
1241 ds_put_format(&s, "%d adds, ", p->n_add);
1244 ds_put_format(&s, "%d deletes, ", p->n_delete);
1247 ds_put_format(&s, "%d modifications, ", p->n_modify);
1250 ds_put_char(&s, ')');
1252 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1255 p->n_add = p->n_delete = p->n_modify = 0;
1256 p->next_op_report = LLONG_MAX;
1262 /* Performs periodic activity required by 'ofproto' that needs to be done
1263 * with the least possible latency.
1265 * It makes sense to call this function a couple of times per poll loop, to
1266 * provide a significant performance boost on some benchmarks with the
1267 * ofproto-dpif implementation. */
1269 ofproto_run_fast(struct ofproto *p)
1273 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1274 if (error && error != EAGAIN) {
1275 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1276 p->name, strerror(error));
1282 ofproto_wait(struct ofproto *p)
1284 struct ofport *ofport;
1286 p->ofproto_class->wait(p);
1287 if (p->ofproto_class->port_poll_wait) {
1288 p->ofproto_class->port_poll_wait(p);
1291 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1292 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1293 poll_immediate_wake();
1299 connmgr_wait(p->connmgr, true);
1304 connmgr_wait(p->connmgr, false);
1305 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1306 poll_immediate_wake();
1313 ofproto_is_alive(const struct ofproto *p)
1315 return connmgr_has_controllers(p->connmgr);
1318 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1319 * memory_report(). */
1321 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1323 const struct oftable *table;
1324 unsigned int n_rules;
1326 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1327 simap_increase(usage, "ops",
1328 ofproto->n_pending + hmap_count(&ofproto->deletions));
1331 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1332 n_rules += classifier_count(&table->cls);
1334 simap_increase(usage, "rules", n_rules);
1336 if (ofproto->ofproto_class->get_memory_usage) {
1337 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1340 connmgr_get_memory_usage(ofproto->connmgr, usage);
1344 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1347 connmgr_get_controller_info(ofproto->connmgr, info);
1351 ofproto_free_ofproto_controller_info(struct shash *info)
1353 connmgr_free_controller_info(info);
1356 /* Makes a deep copy of 'old' into 'port'. */
1358 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1360 port->name = xstrdup(old->name);
1361 port->type = xstrdup(old->type);
1362 port->ofp_port = old->ofp_port;
1365 /* Frees memory allocated to members of 'ofproto_port'.
1367 * Do not call this function on an ofproto_port obtained from
1368 * ofproto_port_dump_next(): that function retains ownership of the data in the
1371 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1373 free(ofproto_port->name);
1374 free(ofproto_port->type);
1377 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1379 * This function provides no status indication. An error status for the entire
1380 * dump operation is provided when it is completed by calling
1381 * ofproto_port_dump_done().
1384 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1385 const struct ofproto *ofproto)
1387 dump->ofproto = ofproto;
1388 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1392 /* Attempts to retrieve another port from 'dump', which must have been created
1393 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1394 * 'port' and returns true. On failure, returns false.
1396 * Failure might indicate an actual error or merely that the last port has been
1397 * dumped. An error status for the entire dump operation is provided when it
1398 * is completed by calling ofproto_port_dump_done().
1400 * The ofproto owns the data stored in 'port'. It will remain valid until at
1401 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1402 * ofproto_port_dump_done(). */
1404 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1405 struct ofproto_port *port)
1407 const struct ofproto *ofproto = dump->ofproto;
1413 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1416 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1422 /* Completes port table dump operation 'dump', which must have been created
1423 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1424 * error-free, otherwise a positive errno value describing the problem. */
1426 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1428 const struct ofproto *ofproto = dump->ofproto;
1430 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1433 return dump->error == EOF ? 0 : dump->error;
1436 /* Returns the type to pass to netdev_open() when a datapath of type
1437 * 'datapath_type' has a port of type 'port_type', for a few special
1438 * cases when a netdev type differs from a port type. For example, when
1439 * using the userspace datapath, a port of type "internal" needs to be
1442 * Returns either 'type' itself or a string literal, which must not be
1445 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1447 const struct ofproto_class *class;
1449 datapath_type = ofproto_normalize_type(datapath_type);
1450 class = ofproto_class_find__(datapath_type);
1455 return (class->port_open_type
1456 ? class->port_open_type(datapath_type, port_type)
1460 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1461 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1462 * the port's OpenFlow port number.
1464 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1465 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1466 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1467 * 'ofp_portp' is non-null). */
1469 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1470 uint16_t *ofp_portp)
1472 uint16_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1475 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1477 const char *netdev_name = netdev_get_name(netdev);
1479 simap_put(&ofproto->ofp_requests, netdev_name, ofp_port);
1480 update_port(ofproto, netdev_name);
1483 struct ofproto_port ofproto_port;
1485 ofproto_port_query_by_name(ofproto, netdev_get_name(netdev),
1487 *ofp_portp = error ? OFPP_NONE : ofproto_port.ofp_port;
1488 ofproto_port_destroy(&ofproto_port);
1493 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1494 * initializes '*port' appropriately; on failure, returns a positive errno
1497 * The caller owns the data in 'ofproto_port' and must free it with
1498 * ofproto_port_destroy() when it is no longer needed. */
1500 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1501 struct ofproto_port *port)
1505 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1507 memset(port, 0, sizeof *port);
1512 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1513 * Returns 0 if successful, otherwise a positive errno. */
1515 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1517 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1518 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1519 struct simap_node *ofp_request_node;
1522 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1523 if (ofp_request_node) {
1524 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1527 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1528 if (!error && ofport) {
1529 /* 'name' is the netdev's name and update_port() is going to close the
1530 * netdev. Just in case update_port() refers to 'name' after it
1531 * destroys 'ofport', make a copy of it around the update_port()
1533 char *devname = xstrdup(name);
1534 update_port(ofproto, devname);
1540 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1541 * performs the 'n_actions' actions in 'actions'. The new flow will not
1544 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1545 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1546 * controllers; otherwise, it will be hidden.
1548 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1550 * This is a helper function for in-band control and fail-open. */
1552 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1553 unsigned int priority,
1554 const struct ofpact *ofpacts, size_t ofpacts_len)
1556 const struct rule *rule;
1558 rule = rule_from_cls_rule(classifier_find_match_exactly(
1559 &ofproto->tables[0].cls, match, priority));
1560 if (!rule || !ofpacts_equal(rule->ofpacts, rule->ofpacts_len,
1561 ofpacts, ofpacts_len)) {
1562 struct ofputil_flow_mod fm;
1564 memset(&fm, 0, sizeof fm);
1566 fm.priority = priority;
1567 fm.buffer_id = UINT32_MAX;
1568 fm.ofpacts = xmemdup(ofpacts, ofpacts_len);
1569 fm.ofpacts_len = ofpacts_len;
1570 add_flow(ofproto, NULL, &fm, NULL);
1575 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1576 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1577 * operation cannot be initiated now but may be retried later.
1579 * This is a helper function for in-band control and fail-open. */
1581 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1583 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1586 /* Searches for a rule with matching criteria exactly equal to 'target' in
1587 * ofproto's table 0 and, if it finds one, deletes it.
1589 * This is a helper function for in-band control and fail-open. */
1591 ofproto_delete_flow(struct ofproto *ofproto,
1592 const struct match *target, unsigned int priority)
1596 rule = rule_from_cls_rule(classifier_find_match_exactly(
1597 &ofproto->tables[0].cls, target, priority));
1599 /* No such rule -> success. */
1601 } else if (rule->pending) {
1602 /* An operation on the rule is already pending -> failure.
1603 * Caller must retry later if it's important. */
1606 /* Initiate deletion -> success. */
1607 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1608 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1609 oftable_remove_rule(rule);
1610 ofproto->ofproto_class->rule_destruct(rule);
1611 ofopgroup_submit(group);
1617 /* Starts the process of deleting all of the flows from all of ofproto's flow
1618 * tables and then reintroducing the flows required by in-band control and
1619 * fail-open. The process will complete in a later call to ofproto_run(). */
1621 ofproto_flush_flows(struct ofproto *ofproto)
1623 COVERAGE_INC(ofproto_flush);
1624 ofproto->state = S_FLUSH;
1628 reinit_ports(struct ofproto *p)
1630 struct ofproto_port_dump dump;
1631 struct sset devnames;
1632 struct ofport *ofport;
1633 struct ofproto_port ofproto_port;
1634 const char *devname;
1636 COVERAGE_INC(ofproto_reinit_ports);
1638 sset_init(&devnames);
1639 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1640 sset_add(&devnames, netdev_get_name(ofport->netdev));
1642 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1643 sset_add(&devnames, ofproto_port.name);
1646 SSET_FOR_EACH (devname, &devnames) {
1647 update_port(p, devname);
1649 sset_destroy(&devnames);
1653 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
1657 ofp_port = simap_get(&ofproto->ofp_requests, netdev_name);
1658 ofp_port = ofp_port ? ofp_port : OFPP_NONE;
1660 if (ofp_port >= ofproto->max_ports
1661 || bitmap_is_set(ofproto->ofp_port_ids, ofp_port)) {
1662 bool retry = ofproto->alloc_port_no ? true : false;
1664 /* Search for a free OpenFlow port number. We try not to
1665 * immediately reuse them to prevent problems due to old
1667 while (ofp_port >= ofproto->max_ports) {
1668 for (ofproto->alloc_port_no++;
1669 ofproto->alloc_port_no < ofproto->max_ports; ) {
1670 if (!bitmap_is_set(ofproto->ofp_port_ids,
1671 ofproto->alloc_port_no)) {
1672 ofp_port = ofproto->alloc_port_no;
1676 if (ofproto->alloc_port_no >= ofproto->max_ports) {
1678 ofproto->alloc_port_no = 0;
1687 bitmap_set1(ofproto->ofp_port_ids, ofp_port);
1692 dealloc_ofp_port(const struct ofproto *ofproto, uint16_t ofp_port)
1694 bitmap_set0(ofproto->ofp_port_ids, ofp_port);
1697 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1698 * pointer if the netdev cannot be opened. On success, also fills in
1700 static struct netdev *
1701 ofport_open(struct ofproto *ofproto,
1702 struct ofproto_port *ofproto_port,
1703 struct ofputil_phy_port *pp)
1705 enum netdev_flags flags;
1706 struct netdev *netdev;
1709 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1711 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1712 "cannot be opened (%s)",
1714 ofproto_port->name, ofproto_port->ofp_port,
1715 ofproto_port->name, strerror(error));
1719 if (ofproto_port->ofp_port == OFPP_NONE) {
1720 if (!strcmp(ofproto->name, ofproto_port->name)) {
1721 ofproto_port->ofp_port = OFPP_LOCAL;
1723 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1724 ofproto_port->name);
1727 pp->port_no = ofproto_port->ofp_port;
1728 netdev_get_etheraddr(netdev, pp->hw_addr);
1729 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1730 netdev_get_flags(netdev, &flags);
1731 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1732 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1733 netdev_get_features(netdev, &pp->curr, &pp->advertised,
1734 &pp->supported, &pp->peer);
1735 pp->curr_speed = netdev_features_to_bps(pp->curr, 0);
1736 pp->max_speed = netdev_features_to_bps(pp->supported, 0);
1741 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1742 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1745 ofport_equal(const struct ofputil_phy_port *a,
1746 const struct ofputil_phy_port *b)
1748 return (eth_addr_equals(a->hw_addr, b->hw_addr)
1749 && a->state == b->state
1750 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1751 && a->curr == b->curr
1752 && a->advertised == b->advertised
1753 && a->supported == b->supported
1754 && a->peer == b->peer
1755 && a->curr_speed == b->curr_speed
1756 && a->max_speed == b->max_speed);
1759 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1760 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1761 * one with the same name or port number). */
1763 ofport_install(struct ofproto *p,
1764 struct netdev *netdev, const struct ofputil_phy_port *pp)
1766 const char *netdev_name = netdev_get_name(netdev);
1767 struct ofport *ofport;
1770 /* Create ofport. */
1771 ofport = p->ofproto_class->port_alloc();
1776 ofport->ofproto = p;
1777 ofport->netdev = netdev;
1778 ofport->change_seq = netdev_change_seq(netdev);
1780 ofport->ofp_port = pp->port_no;
1782 /* Add port to 'p'. */
1783 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1784 shash_add(&p->port_by_name, netdev_name, ofport);
1786 update_mtu(p, ofport);
1788 /* Let the ofproto_class initialize its private data. */
1789 error = p->ofproto_class->port_construct(ofport);
1793 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1797 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1798 p->name, netdev_name, strerror(error));
1800 ofport_destroy__(ofport);
1802 netdev_close(netdev);
1806 /* Removes 'ofport' from 'p' and destroys it. */
1808 ofport_remove(struct ofport *ofport)
1810 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1812 ofport_destroy(ofport);
1815 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1818 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1820 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1822 ofport_remove(port);
1826 /* Updates 'port' with new 'pp' description.
1828 * Does not handle a name or port number change. The caller must implement
1829 * such a change as a delete followed by an add. */
1831 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1833 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1834 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1835 | (pp->config & OFPUTIL_PC_PORT_DOWN));
1836 port->pp.state = pp->state;
1837 port->pp.curr = pp->curr;
1838 port->pp.advertised = pp->advertised;
1839 port->pp.supported = pp->supported;
1840 port->pp.peer = pp->peer;
1841 port->pp.curr_speed = pp->curr_speed;
1842 port->pp.max_speed = pp->max_speed;
1844 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1847 /* Update OpenFlow 'state' in 'port' and notify controller. */
1849 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
1851 if (port->pp.state != state) {
1852 port->pp.state = state;
1853 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
1859 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1861 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1863 if (port->ofproto->ofproto_class->set_realdev) {
1864 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1866 if (port->ofproto->ofproto_class->set_stp_port) {
1867 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1869 if (port->ofproto->ofproto_class->set_cfm) {
1870 port->ofproto->ofproto_class->set_cfm(port, NULL);
1872 if (port->ofproto->ofproto_class->bundle_remove) {
1873 port->ofproto->ofproto_class->bundle_remove(port);
1879 ofport_destroy__(struct ofport *port)
1881 struct ofproto *ofproto = port->ofproto;
1882 const char *name = netdev_get_name(port->netdev);
1884 hmap_remove(&ofproto->ports, &port->hmap_node);
1885 shash_delete(&ofproto->port_by_name,
1886 shash_find(&ofproto->port_by_name, name));
1888 netdev_close(port->netdev);
1889 ofproto->ofproto_class->port_dealloc(port);
1893 ofport_destroy(struct ofport *port)
1896 dealloc_ofp_port(port->ofproto, port->ofp_port);
1897 port->ofproto->ofproto_class->port_destruct(port);
1898 ofport_destroy__(port);
1903 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1905 struct ofport *port;
1907 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1908 hash_int(ofp_port, 0), &ofproto->ports) {
1909 if (port->ofp_port == ofp_port) {
1917 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1919 struct ofproto *ofproto = port->ofproto;
1922 if (ofproto->ofproto_class->port_get_stats) {
1923 error = ofproto->ofproto_class->port_get_stats(port, stats);
1932 update_port(struct ofproto *ofproto, const char *name)
1934 struct ofproto_port ofproto_port;
1935 struct ofputil_phy_port pp;
1936 struct netdev *netdev;
1937 struct ofport *port;
1939 COVERAGE_INC(ofproto_update_port);
1941 /* Fetch 'name''s location and properties from the datapath. */
1942 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1943 ? ofport_open(ofproto, &ofproto_port, &pp)
1946 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1947 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1948 struct netdev *old_netdev = port->netdev;
1950 /* 'name' hasn't changed location. Any properties changed? */
1951 if (!ofport_equal(&port->pp, &pp)) {
1952 ofport_modified(port, &pp);
1955 update_mtu(ofproto, port);
1957 /* Install the newly opened netdev in case it has changed.
1958 * Don't close the old netdev yet in case port_modified has to
1959 * remove a retained reference to it.*/
1960 port->netdev = netdev;
1961 port->change_seq = netdev_change_seq(netdev);
1963 if (port->ofproto->ofproto_class->port_modified) {
1964 port->ofproto->ofproto_class->port_modified(port);
1967 netdev_close(old_netdev);
1969 /* If 'port' is nonnull then its name differs from 'name' and thus
1970 * we should delete it. If we think there's a port named 'name'
1971 * then its port number must be wrong now so delete it too. */
1973 ofport_remove(port);
1975 ofport_remove_with_name(ofproto, name);
1976 ofport_install(ofproto, netdev, &pp);
1979 /* Any port named 'name' is gone now. */
1980 ofport_remove_with_name(ofproto, name);
1982 ofproto_port_destroy(&ofproto_port);
1986 init_ports(struct ofproto *p)
1988 struct ofproto_port_dump dump;
1989 struct ofproto_port ofproto_port;
1990 struct shash_node *node, *next;
1992 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1993 const char *name = ofproto_port.name;
1995 if (shash_find(&p->port_by_name, name)) {
1996 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
1999 struct ofputil_phy_port pp;
2000 struct netdev *netdev;
2002 /* Check if an OpenFlow port number had been requested. */
2003 node = shash_find(&init_ofp_ports, name);
2005 const struct iface_hint *iface_hint = node->data;
2006 simap_put(&p->ofp_requests, name, iface_hint->ofp_port);
2009 netdev = ofport_open(p, &ofproto_port, &pp);
2011 ofport_install(p, netdev, &pp);
2016 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2017 const struct iface_hint *iface_hint = node->data;
2019 if (!strcmp(iface_hint->br_name, p->name)) {
2020 free(iface_hint->br_name);
2021 free(iface_hint->br_type);
2022 shash_delete(&init_ofp_ports, node);
2029 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2030 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2032 find_min_mtu(struct ofproto *p)
2034 struct ofport *ofport;
2037 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2038 struct netdev *netdev = ofport->netdev;
2041 /* Skip any internal ports, since that's what we're trying to
2043 if (!strcmp(netdev_get_type(netdev), "internal")) {
2047 if (netdev_get_mtu(netdev, &dev_mtu)) {
2050 if (!mtu || dev_mtu < mtu) {
2055 return mtu ? mtu: ETH_PAYLOAD_MAX;
2058 /* Update MTU of all datapath devices on 'p' to the minimum of the
2059 * non-datapath ports in event of 'port' added or changed. */
2061 update_mtu(struct ofproto *p, struct ofport *port)
2063 struct ofport *ofport;
2064 struct netdev *netdev = port->netdev;
2065 int dev_mtu, old_min;
2067 if (netdev_get_mtu(netdev, &dev_mtu)) {
2071 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2072 if (dev_mtu > p->min_mtu) {
2073 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2074 dev_mtu = p->min_mtu;
2077 port->mtu = dev_mtu;
2081 /* For non-internal port find new min mtu. */
2082 old_min = p->min_mtu;
2083 port->mtu = dev_mtu;
2084 p->min_mtu = find_min_mtu(p);
2085 if (p->min_mtu == old_min) {
2089 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2090 struct netdev *netdev = ofport->netdev;
2092 if (!strcmp(netdev_get_type(netdev), "internal")) {
2093 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2094 ofport->mtu = p->min_mtu;
2101 ofproto_rule_destroy__(struct rule *rule)
2104 cls_rule_destroy(&rule->cr);
2105 free(rule->ofpacts);
2106 rule->ofproto->ofproto_class->rule_dealloc(rule);
2110 /* This function allows an ofproto implementation to destroy any rules that
2111 * remain when its ->destruct() function is called. The caller must have
2112 * already uninitialized any derived members of 'rule' (step 5 described in the
2113 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
2114 * This function implements steps 6 and 7.
2116 * This function should only be called from an ofproto implementation's
2117 * ->destruct() function. It is not suitable elsewhere. */
2119 ofproto_rule_destroy(struct rule *rule)
2121 assert(!rule->pending);
2122 oftable_remove_rule(rule);
2123 ofproto_rule_destroy__(rule);
2126 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2127 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2129 ofproto_rule_has_out_port(const struct rule *rule, uint16_t port)
2131 return (port == OFPP_NONE
2132 || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
2135 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2136 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2138 ofoperation_has_out_port(const struct ofoperation *op, uint16_t out_port)
2140 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2145 case OFOPERATION_ADD:
2146 return op->victim && ofproto_rule_has_out_port(op->victim, out_port);
2148 case OFOPERATION_DELETE:
2151 case OFOPERATION_MODIFY:
2152 return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
2158 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2159 * statistics appropriately. 'packet' must have at least sizeof(struct
2160 * ofp_packet_in) bytes of headroom.
2162 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
2163 * with statistics for 'packet' either way.
2165 * Takes ownership of 'packet'. */
2167 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
2171 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2173 flow_extract(packet, 0, NULL, in_port, &flow);
2174 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
2177 /* Returns true if 'rule' should be hidden from the controller.
2179 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2180 * (e.g. by in-band control) and are intentionally hidden from the
2183 ofproto_rule_is_hidden(const struct rule *rule)
2185 return rule->cr.priority > UINT16_MAX;
2188 static enum oftable_flags
2189 rule_get_flags(const struct rule *rule)
2191 return rule->ofproto->tables[rule->table_id].flags;
2195 rule_is_modifiable(const struct rule *rule)
2197 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2201 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2203 ofconn_send_reply(ofconn, make_echo_reply(oh));
2208 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2210 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2211 struct ofputil_switch_features features;
2212 struct ofport *port;
2218 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2220 assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2222 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2223 * if present, are always at the end.) */
2224 n_tables = ofproto->n_tables;
2225 for (i = 0; i < ofproto->n_tables; i++) {
2226 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2232 features.datapath_id = ofproto->datapath_id;
2233 features.n_buffers = pktbuf_capacity();
2234 features.n_tables = n_tables;
2235 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2236 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2238 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2241 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2243 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2244 ofputil_put_switch_features_port(&port->pp, b);
2247 ofconn_send_reply(ofconn, b);
2252 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2254 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2255 struct ofp_switch_config *osc;
2256 enum ofp_config_flags flags;
2260 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2261 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2262 flags = ofproto->frag_handling;
2263 if (ofconn_get_invalid_ttl_to_controller(ofconn)) {
2264 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2266 osc->flags = htons(flags);
2267 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2268 ofconn_send_reply(ofconn, buf);
2274 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2276 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2277 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2278 uint16_t flags = ntohs(osc->flags);
2280 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2281 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
2282 enum ofp_config_flags cur = ofproto->frag_handling;
2283 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2285 assert((cur & OFPC_FRAG_MASK) == cur);
2287 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2288 ofproto->frag_handling = next;
2290 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2292 ofputil_frag_handling_to_string(next));
2296 ofconn_set_invalid_ttl_to_controller(ofconn,
2297 (flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2299 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2304 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2305 * error message code for the caller to propagate upward. Otherwise, returns
2308 * The log message mentions 'msg_type'. */
2310 reject_slave_controller(struct ofconn *ofconn)
2312 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2313 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
2314 return OFPERR_OFPBRC_EPERM;
2321 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2323 struct ofproto *p = ofconn_get_ofproto(ofconn);
2324 struct ofputil_packet_out po;
2325 struct ofpbuf *payload;
2326 uint64_t ofpacts_stub[1024 / 8];
2327 struct ofpbuf ofpacts;
2331 COVERAGE_INC(ofproto_packet_out);
2333 error = reject_slave_controller(ofconn);
2338 /* Decode message. */
2339 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2340 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2342 goto exit_free_ofpacts;
2344 if (po.in_port >= p->max_ports && po.in_port < OFPP_MAX) {
2345 error = OFPERR_OFPBRC_BAD_PORT;
2346 goto exit_free_ofpacts;
2351 if (po.buffer_id != UINT32_MAX) {
2352 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2353 if (error || !payload) {
2354 goto exit_free_ofpacts;
2357 payload = xmalloc(sizeof *payload);
2358 ofpbuf_use_const(payload, po.packet, po.packet_len);
2361 /* Verify actions against packet, then send packet if successful. */
2362 flow_extract(payload, 0, NULL, po.in_port, &flow);
2363 error = ofpacts_check(po.ofpacts, po.ofpacts_len, &flow, p->max_ports);
2365 error = p->ofproto_class->packet_out(p, payload, &flow,
2366 po.ofpacts, po.ofpacts_len);
2368 ofpbuf_delete(payload);
2371 ofpbuf_uninit(&ofpacts);
2377 update_port_config(struct ofport *port,
2378 enum ofputil_port_config config,
2379 enum ofputil_port_config mask)
2381 enum ofputil_port_config old_config = port->pp.config;
2382 enum ofputil_port_config toggle;
2384 toggle = (config ^ port->pp.config) & mask;
2385 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2386 if (config & OFPUTIL_PC_PORT_DOWN) {
2387 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2389 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2391 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2394 port->pp.config ^= toggle;
2395 if (port->pp.config != old_config) {
2396 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2401 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2403 struct ofproto *p = ofconn_get_ofproto(ofconn);
2404 struct ofputil_port_mod pm;
2405 struct ofport *port;
2408 error = reject_slave_controller(ofconn);
2413 error = ofputil_decode_port_mod(oh, &pm);
2418 port = ofproto_get_port(p, pm.port_no);
2420 return OFPERR_OFPPMFC_BAD_PORT;
2421 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2422 return OFPERR_OFPPMFC_BAD_HW_ADDR;
2424 update_port_config(port, pm.config, pm.mask);
2426 netdev_set_advertisements(port->netdev, pm.advertise);
2433 handle_desc_stats_request(struct ofconn *ofconn,
2434 const struct ofp_header *request)
2436 struct ofproto *p = ofconn_get_ofproto(ofconn);
2437 struct ofp_desc_stats *ods;
2440 msg = ofpraw_alloc_stats_reply(request, 0);
2441 ods = ofpbuf_put_zeros(msg, sizeof *ods);
2442 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
2443 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
2444 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
2445 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
2446 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
2447 ofconn_send_reply(ofconn, msg);
2453 handle_table_stats_request(struct ofconn *ofconn,
2454 const struct ofp_header *request)
2456 struct ofproto *p = ofconn_get_ofproto(ofconn);
2457 struct ofp12_table_stats *ots;
2462 /* Set up default values.
2464 * ofp12_table_stats is used as a generic structure as
2465 * it is able to hold all the fields for ofp10_table_stats
2466 * and ofp11_table_stats (and of course itself).
2468 ots = xcalloc(p->n_tables, sizeof *ots);
2469 for (i = 0; i < p->n_tables; i++) {
2470 ots[i].table_id = i;
2471 sprintf(ots[i].name, "table%zu", i);
2472 ots[i].match = htonll(OFPXMT12_MASK);
2473 ots[i].wildcards = htonll(OFPXMT12_MASK);
2474 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2475 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2476 ots[i].write_setfields = htonll(OFPXMT12_MASK);
2477 ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2478 ots[i].metadata_match = htonll(UINT64_MAX);
2479 ots[i].metadata_write = htonll(UINT64_MAX);
2480 ots[i].instructions = htonl(OFPIT11_ALL);
2481 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2482 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2483 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2486 p->ofproto_class->get_tables(p, ots);
2488 /* Post-process the tables, dropping hidden tables. */
2489 n_tables = p->n_tables;
2490 for (i = 0; i < p->n_tables; i++) {
2491 const struct oftable *table = &p->tables[i];
2493 if (table->flags & OFTABLE_HIDDEN) {
2499 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2502 if (table->max_flows < ntohl(ots[i].max_entries)) {
2503 ots[i].max_entries = htonl(table->max_flows);
2507 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2508 ofconn_send_reply(ofconn, msg);
2516 append_port_stat(struct ofport *port, struct list *replies)
2518 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2520 /* Intentionally ignore return value, since errors will set
2521 * 'stats' to all-1s, which is correct for OpenFlow, and
2522 * netdev_get_stats() will log errors. */
2523 ofproto_port_get_stats(port, &ops.stats);
2525 ofputil_append_port_stat(replies, &ops);
2529 handle_port_stats_request(struct ofconn *ofconn,
2530 const struct ofp_header *request)
2532 struct ofproto *p = ofconn_get_ofproto(ofconn);
2533 struct ofport *port;
2534 struct list replies;
2538 error = ofputil_decode_port_stats_request(request, &port_no);
2543 ofpmp_init(&replies, request);
2544 if (port_no != OFPP_NONE) {
2545 port = ofproto_get_port(p, port_no);
2547 append_port_stat(port, &replies);
2550 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2551 append_port_stat(port, &replies);
2555 ofconn_send_replies(ofconn, &replies);
2560 handle_port_desc_stats_request(struct ofconn *ofconn,
2561 const struct ofp_header *request)
2563 struct ofproto *p = ofconn_get_ofproto(ofconn);
2564 enum ofp_version version;
2565 struct ofport *port;
2566 struct list replies;
2568 ofpmp_init(&replies, request);
2570 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2571 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2572 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2575 ofconn_send_replies(ofconn, &replies);
2580 calc_flow_duration__(long long int start, long long int now,
2581 uint32_t *sec, uint32_t *nsec)
2583 long long int msecs = now - start;
2584 *sec = msecs / 1000;
2585 *nsec = (msecs % 1000) * (1000 * 1000);
2588 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2589 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2591 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2593 return (table_id == 0xff || table_id < ofproto->n_tables
2595 : OFPERR_OFPBRC_BAD_TABLE_ID);
2599 static struct oftable *
2600 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2602 struct oftable *table;
2604 for (table = &ofproto->tables[table_id];
2605 table < &ofproto->tables[ofproto->n_tables];
2607 if (!(table->flags & OFTABLE_HIDDEN)) {
2615 static struct oftable *
2616 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2618 if (table_id == 0xff) {
2619 return next_visible_table(ofproto, 0);
2620 } else if (table_id < ofproto->n_tables) {
2621 return &ofproto->tables[table_id];
2627 static struct oftable *
2628 next_matching_table(const struct ofproto *ofproto,
2629 const struct oftable *table, uint8_t table_id)
2631 return (table_id == 0xff
2632 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2636 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2638 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2639 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2641 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2642 * only once, for that table. (This can be used to access tables marked
2645 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2646 * entered at all. (Perhaps you should have validated TABLE_ID with
2647 * check_table_id().)
2649 * All parameters are evaluated multiple times.
2651 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2652 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2654 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2656 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2657 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2658 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2661 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2662 * to 'out_port' are included.
2664 * Hidden rules are always omitted.
2666 * Returns 0 on success, otherwise an OpenFlow error code. */
2668 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2669 const struct match *match,
2670 ovs_be64 cookie, ovs_be64 cookie_mask,
2671 uint16_t out_port, struct list *rules)
2673 struct oftable *table;
2677 error = check_table_id(ofproto, table_id);
2683 cls_rule_init(&cr, match, 0);
2684 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2685 struct cls_cursor cursor;
2688 cls_cursor_init(&cursor, &table->cls, &cr);
2689 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2690 if (rule->pending) {
2691 error = OFPROTO_POSTPONE;
2694 if (!ofproto_rule_is_hidden(rule)
2695 && ofproto_rule_has_out_port(rule, out_port)
2696 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2697 list_push_back(rules, &rule->ofproto_node);
2703 cls_rule_destroy(&cr);
2707 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2708 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2709 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2712 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2713 * to 'out_port' are included.
2715 * Hidden rules are always omitted.
2717 * Returns 0 on success, otherwise an OpenFlow error code. */
2719 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2720 const struct match *match, unsigned int priority,
2721 ovs_be64 cookie, ovs_be64 cookie_mask,
2722 uint16_t out_port, struct list *rules)
2724 struct oftable *table;
2728 error = check_table_id(ofproto, table_id);
2734 cls_rule_init(&cr, match, priority);
2735 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2738 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2741 if (rule->pending) {
2742 error = OFPROTO_POSTPONE;
2745 if (!ofproto_rule_is_hidden(rule)
2746 && ofproto_rule_has_out_port(rule, out_port)
2747 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2748 list_push_back(rules, &rule->ofproto_node);
2754 cls_rule_destroy(&cr);
2758 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2759 * forced into the range of a uint16_t. */
2761 age_secs(long long int age_ms)
2763 return (age_ms < 0 ? 0
2764 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
2765 : (unsigned int) age_ms / 1000);
2769 handle_flow_stats_request(struct ofconn *ofconn,
2770 const struct ofp_header *request)
2772 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2773 struct ofputil_flow_stats_request fsr;
2774 struct list replies;
2779 error = ofputil_decode_flow_stats_request(&fsr, request);
2784 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2785 fsr.cookie, fsr.cookie_mask,
2786 fsr.out_port, &rules);
2791 ofpmp_init(&replies, request);
2792 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2793 long long int now = time_msec();
2794 struct ofputil_flow_stats fs;
2796 minimatch_expand(&rule->cr.match, &fs.match);
2797 fs.priority = rule->cr.priority;
2798 fs.cookie = rule->flow_cookie;
2799 fs.table_id = rule->table_id;
2800 calc_flow_duration__(rule->created, now, &fs.duration_sec,
2802 fs.idle_timeout = rule->idle_timeout;
2803 fs.hard_timeout = rule->hard_timeout;
2804 fs.idle_age = age_secs(now - rule->used);
2805 fs.hard_age = age_secs(now - rule->modified);
2806 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2808 fs.ofpacts = rule->ofpacts;
2809 fs.ofpacts_len = rule->ofpacts_len;
2810 ofputil_append_flow_stats_reply(&fs, &replies);
2812 ofconn_send_replies(ofconn, &replies);
2818 flow_stats_ds(struct rule *rule, struct ds *results)
2820 uint64_t packet_count, byte_count;
2822 rule->ofproto->ofproto_class->rule_get_stats(rule,
2823 &packet_count, &byte_count);
2825 if (rule->table_id != 0) {
2826 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2828 ds_put_format(results, "duration=%llds, ",
2829 (time_msec() - rule->created) / 1000);
2830 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2831 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2832 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2833 cls_rule_format(&rule->cr, results);
2834 ds_put_char(results, ',');
2835 if (rule->ofpacts_len > 0) {
2836 ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
2838 ds_put_cstr(results, "drop");
2840 ds_put_cstr(results, "\n");
2843 /* Adds a pretty-printed description of all flows to 'results', including
2844 * hidden flows (e.g., set up by in-band control). */
2846 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2848 struct oftable *table;
2850 OFPROTO_FOR_EACH_TABLE (table, p) {
2851 struct cls_cursor cursor;
2854 cls_cursor_init(&cursor, &table->cls, NULL);
2855 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2856 flow_stats_ds(rule, results);
2861 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2862 * '*engine_type' and '*engine_id', respectively. */
2864 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2865 uint8_t *engine_type, uint8_t *engine_id)
2867 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2870 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns a
2871 * bitmask of 'cfm_fault_reason's to indicate a CFM fault (generally
2872 * indicating a connectivity problem). Returns zero if CFM is not faulted,
2873 * and -1 if CFM is not enabled on 'ofp_port'. */
2875 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2877 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2878 return (ofport && ofproto->ofproto_class->get_cfm_fault
2879 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2883 /* Checks the operational status reported by the remote CFM endpoint of
2884 * 'ofp_port' Returns 1 if operationally up, 0 if operationally down, and -1
2885 * if CFM is not enabled on 'ofp_port' or does not support operational status.
2888 ofproto_port_get_cfm_opup(const struct ofproto *ofproto, uint16_t ofp_port)
2890 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2891 return (ofport && ofproto->ofproto_class->get_cfm_opup
2892 ? ofproto->ofproto_class->get_cfm_opup(ofport)
2896 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2897 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2898 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2899 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2901 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2902 uint16_t ofp_port, const uint64_t **rmps,
2905 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2909 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2910 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2915 /* Checks the health of the CFM for 'ofp_port' within 'ofproto'. Returns an
2916 * integer value between 0 and 100 to indicate the health of the port as a
2917 * percentage which is the average of cfm health of all the remote_mpids or
2918 * returns -1 if CFM is not enabled on 'ofport'. */
2920 ofproto_port_get_cfm_health(const struct ofproto *ofproto, uint16_t ofp_port)
2922 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2923 return (ofport && ofproto->ofproto_class->get_cfm_health
2924 ? ofproto->ofproto_class->get_cfm_health(ofport)
2929 handle_aggregate_stats_request(struct ofconn *ofconn,
2930 const struct ofp_header *oh)
2932 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2933 struct ofputil_flow_stats_request request;
2934 struct ofputil_aggregate_stats stats;
2935 bool unknown_packets, unknown_bytes;
2936 struct ofpbuf *reply;
2941 error = ofputil_decode_flow_stats_request(&request, oh);
2946 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2947 request.cookie, request.cookie_mask,
2948 request.out_port, &rules);
2953 memset(&stats, 0, sizeof stats);
2954 unknown_packets = unknown_bytes = false;
2955 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2956 uint64_t packet_count;
2957 uint64_t byte_count;
2959 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2962 if (packet_count == UINT64_MAX) {
2963 unknown_packets = true;
2965 stats.packet_count += packet_count;
2968 if (byte_count == UINT64_MAX) {
2969 unknown_bytes = true;
2971 stats.byte_count += byte_count;
2976 if (unknown_packets) {
2977 stats.packet_count = UINT64_MAX;
2979 if (unknown_bytes) {
2980 stats.byte_count = UINT64_MAX;
2983 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
2984 ofconn_send_reply(ofconn, reply);
2989 struct queue_stats_cbdata {
2990 struct ofport *ofport;
2991 struct list replies;
2995 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2996 const struct netdev_queue_stats *stats)
2999 struct ofputil_queue_stats oqs = {
3000 .port_no = cbdata->ofport->pp.port_no,
3001 .queue_id = queue_id,
3004 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3008 handle_queue_stats_dump_cb(uint32_t queue_id,
3009 struct netdev_queue_stats *stats,
3012 struct queue_stats_cbdata *cbdata = cbdata_;
3014 put_queue_stats(cbdata, queue_id, stats);
3018 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3019 struct queue_stats_cbdata *cbdata)
3021 cbdata->ofport = port;
3022 if (queue_id == OFPQ_ALL) {
3023 netdev_dump_queue_stats(port->netdev,
3024 handle_queue_stats_dump_cb, cbdata);
3026 struct netdev_queue_stats stats;
3028 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3029 put_queue_stats(cbdata, queue_id, &stats);
3031 return OFPERR_OFPQOFC_BAD_QUEUE;
3038 handle_queue_stats_request(struct ofconn *ofconn,
3039 const struct ofp_header *rq)
3041 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3042 struct queue_stats_cbdata cbdata;
3043 struct ofport *port;
3045 struct ofputil_queue_stats_request oqsr;
3047 COVERAGE_INC(ofproto_queue_req);
3049 ofpmp_init(&cbdata.replies, rq);
3051 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3056 if (oqsr.port_no == OFPP_ALL) {
3057 error = OFPERR_OFPQOFC_BAD_QUEUE;
3058 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3059 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3064 port = ofproto_get_port(ofproto, oqsr.port_no);
3066 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3067 : OFPERR_OFPQOFC_BAD_PORT);
3070 ofconn_send_replies(ofconn, &cbdata.replies);
3072 ofpbuf_list_delete(&cbdata.replies);
3079 is_flow_deletion_pending(const struct ofproto *ofproto,
3080 const struct cls_rule *cls_rule,
3083 if (!hmap_is_empty(&ofproto->deletions)) {
3084 struct ofoperation *op;
3086 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3087 cls_rule_hash(cls_rule, table_id),
3088 &ofproto->deletions) {
3089 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3098 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3099 * in which no matching flow already exists in the flow table.
3101 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3102 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3103 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3104 * initiated now but may be retried later.
3106 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
3107 * ownership remains with the caller.
3109 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3112 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3113 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
3115 struct oftable *table;
3116 struct ofopgroup *group;
3117 struct rule *victim;
3122 error = check_table_id(ofproto, fm->table_id);
3128 if (fm->table_id == 0xff) {
3130 if (ofproto->ofproto_class->rule_choose_table) {
3131 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3137 assert(table_id < ofproto->n_tables);
3138 table = &ofproto->tables[table_id];
3140 table = &ofproto->tables[0];
3142 } else if (fm->table_id < ofproto->n_tables) {
3143 table = &ofproto->tables[fm->table_id];
3145 return OFPERR_OFPBRC_BAD_TABLE_ID;
3148 if (table->flags & OFTABLE_READONLY) {
3149 return OFPERR_OFPBRC_EPERM;
3152 /* Allocate new rule and initialize classifier rule. */
3153 rule = ofproto->ofproto_class->rule_alloc();
3155 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3156 ofproto->name, strerror(error));
3159 cls_rule_init(&rule->cr, &fm->match, fm->priority);
3161 /* Serialize against pending deletion. */
3162 if (is_flow_deletion_pending(ofproto, &cr, table - ofproto->tables)) {
3163 cls_rule_destroy(&rule->cr);
3164 ofproto->ofproto_class->rule_dealloc(rule);
3165 return OFPROTO_POSTPONE;
3168 /* Check for overlap, if requested. */
3169 if (fm->flags & OFPFF_CHECK_OVERLAP
3170 && classifier_rule_overlaps(&table->cls, &rule->cr)) {
3171 cls_rule_destroy(&rule->cr);
3172 ofproto->ofproto_class->rule_dealloc(rule);
3173 return OFPERR_OFPFMFC_OVERLAP;
3176 rule->ofproto = ofproto;
3177 rule->pending = NULL;
3178 rule->flow_cookie = fm->new_cookie;
3179 rule->created = rule->modified = rule->used = time_msec();
3180 rule->idle_timeout = fm->idle_timeout;
3181 rule->hard_timeout = fm->hard_timeout;
3182 rule->table_id = table - ofproto->tables;
3183 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
3184 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3185 rule->ofpacts_len = fm->ofpacts_len;
3186 rule->evictable = true;
3187 rule->eviction_group = NULL;
3188 rule->monitor_flags = 0;
3189 rule->add_seqno = 0;
3190 rule->modify_seqno = 0;
3192 /* Insert new rule. */
3193 victim = oftable_replace_rule(rule);
3194 if (victim && !rule_is_modifiable(victim)) {
3195 error = OFPERR_OFPBRC_EPERM;
3196 } else if (victim && victim->pending) {
3197 error = OFPROTO_POSTPONE;
3199 struct ofoperation *op;
3202 if (classifier_count(&table->cls) > table->max_flows) {
3205 was_evictable = rule->evictable;
3206 rule->evictable = false;
3207 evict = choose_rule_to_evict(table);
3208 rule->evictable = was_evictable;
3211 error = OFPERR_OFPFMFC_TABLE_FULL;
3213 } else if (evict->pending) {
3214 error = OFPROTO_POSTPONE;
3221 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3222 op = ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3223 op->victim = victim;
3225 error = ofproto->ofproto_class->rule_construct(rule);
3227 op->group->n_running--;
3228 ofoperation_destroy(rule->pending);
3230 delete_flow__(evict, group);
3232 ofopgroup_submit(group);
3236 /* Back out if an error occurred. */
3238 oftable_substitute_rule(rule, victim);
3239 ofproto_rule_destroy__(rule);
3244 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3246 /* Modifies the rules listed in 'rules', changing their actions to match those
3249 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3252 * Returns 0 on success, otherwise an OpenFlow error code. */
3254 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3255 const struct ofputil_flow_mod *fm,
3256 const struct ofp_header *request, struct list *rules)
3258 struct ofopgroup *group;
3262 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3263 error = OFPERR_OFPBRC_EPERM;
3264 LIST_FOR_EACH (rule, ofproto_node, rules) {
3265 struct ofoperation *op;
3266 bool actions_changed;
3267 ovs_be64 new_cookie;
3269 if (rule_is_modifiable(rule)) {
3270 /* At least one rule is modifiable, don't report EPERM error. */
3276 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3277 rule->ofpacts, rule->ofpacts_len);
3278 new_cookie = (fm->new_cookie != htonll(UINT64_MAX)
3280 : rule->flow_cookie);
3281 if (!actions_changed && new_cookie == rule->flow_cookie) {
3282 /* No change at all. */
3286 op = ofoperation_create(group, rule, OFOPERATION_MODIFY, 0);
3287 rule->flow_cookie = new_cookie;
3288 if (actions_changed) {
3289 op->ofpacts = rule->ofpacts;
3290 op->ofpacts_len = rule->ofpacts_len;
3291 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3292 rule->ofpacts_len = fm->ofpacts_len;
3293 rule->ofproto->ofproto_class->rule_modify_actions(rule);
3295 ofoperation_complete(op, 0);
3298 ofopgroup_submit(group);
3304 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3305 const struct ofputil_flow_mod *fm,
3306 const struct ofp_header *request)
3308 if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3311 return add_flow(ofproto, ofconn, fm, request);
3314 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3317 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3320 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3321 const struct ofputil_flow_mod *fm,
3322 const struct ofp_header *request)
3327 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3328 fm->cookie, fm->cookie_mask,
3332 } else if (list_is_empty(&rules)) {
3333 return modify_flows_add(ofproto, ofconn, fm, request);
3335 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3339 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3342 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3345 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3346 const struct ofputil_flow_mod *fm,
3347 const struct ofp_header *request)
3352 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3353 fm->priority, fm->cookie, fm->cookie_mask,
3358 } else if (list_is_empty(&rules)) {
3359 return modify_flows_add(ofproto, ofconn, fm, request);
3361 return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3362 fm, request, &rules)
3367 /* OFPFC_DELETE implementation. */
3370 delete_flow__(struct rule *rule, struct ofopgroup *group)
3372 struct ofproto *ofproto = rule->ofproto;
3374 ofproto_rule_send_removed(rule, OFPRR_DELETE);
3376 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
3377 oftable_remove_rule(rule);
3378 ofproto->ofproto_class->rule_destruct(rule);
3381 /* Deletes the rules listed in 'rules'.
3383 * Returns 0 on success, otherwise an OpenFlow error code. */
3385 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3386 const struct ofp_header *request, struct list *rules)
3388 struct rule *rule, *next;
3389 struct ofopgroup *group;
3391 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3392 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3393 delete_flow__(rule, group);
3395 ofopgroup_submit(group);
3400 /* Implements OFPFC_DELETE. */
3402 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3403 const struct ofputil_flow_mod *fm,
3404 const struct ofp_header *request)
3409 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3410 fm->cookie, fm->cookie_mask,
3411 fm->out_port, &rules);
3412 return (error ? error
3413 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3418 /* Implements OFPFC_DELETE_STRICT. */
3420 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3421 const struct ofputil_flow_mod *fm,
3422 const struct ofp_header *request)
3427 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3428 fm->priority, fm->cookie, fm->cookie_mask,
3429 fm->out_port, &rules);
3430 return (error ? error
3431 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3437 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3439 struct ofputil_flow_removed fr;
3441 if (ofproto_rule_is_hidden(rule) || !rule->send_flow_removed) {
3445 minimatch_expand(&rule->cr.match, &fr.match);
3446 fr.priority = rule->cr.priority;
3447 fr.cookie = rule->flow_cookie;
3449 fr.table_id = rule->table_id;
3450 calc_flow_duration__(rule->created, time_msec(),
3451 &fr.duration_sec, &fr.duration_nsec);
3452 fr.idle_timeout = rule->idle_timeout;
3453 fr.hard_timeout = rule->hard_timeout;
3454 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3457 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3461 ofproto_rule_update_used(struct rule *rule, long long int used)
3463 if (used > rule->used) {
3464 struct eviction_group *evg = rule->eviction_group;
3468 heap_change(&evg->rules, &rule->evg_node,
3469 rule_eviction_priority(rule));
3474 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3475 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3478 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3481 * ofproto implementation ->run() functions should use this function to expire
3482 * OpenFlow flows. */
3484 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3486 struct ofproto *ofproto = rule->ofproto;
3487 struct ofopgroup *group;
3489 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
3491 ofproto_rule_send_removed(rule, reason);
3493 group = ofopgroup_create_unattached(ofproto);
3494 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3495 oftable_remove_rule(rule);
3496 ofproto->ofproto_class->rule_destruct(rule);
3497 ofopgroup_submit(group);
3501 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3503 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3504 struct ofputil_flow_mod fm;
3505 uint64_t ofpacts_stub[1024 / 8];
3506 struct ofpbuf ofpacts;
3510 error = reject_slave_controller(ofconn);
3515 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3516 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3519 goto exit_free_ofpacts;
3522 if (fm.flags & OFPFF10_EMERG) {
3523 /* We do not support the OpenFlow 1.0 emergency flow cache, which
3524 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
3525 * There is no good error code, so just state that the flow table
3527 error = OFPERR_OFPFMFC_TABLE_FULL;
3530 error = ofpacts_check(fm.ofpacts, fm.ofpacts_len,
3531 &fm.match.flow, ofproto->max_ports);
3534 error = handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
3537 goto exit_free_ofpacts;
3540 /* Record the operation for logging a summary report. */
3541 switch (fm.command) {
3547 case OFPFC_MODIFY_STRICT:
3548 ofproto->n_modify++;
3552 case OFPFC_DELETE_STRICT:
3553 ofproto->n_delete++;
3558 if (ofproto->next_op_report == LLONG_MAX) {
3559 ofproto->first_op = now;
3560 ofproto->next_op_report = MAX(now + 10 * 1000,
3561 ofproto->op_backoff);
3562 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
3564 ofproto->last_op = now;
3567 ofpbuf_uninit(&ofpacts);
3573 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3574 const struct ofputil_flow_mod *fm,
3575 const struct ofp_header *oh)
3577 if (ofproto->n_pending >= 50) {
3578 assert(!list_is_empty(&ofproto->pending));
3579 return OFPROTO_POSTPONE;
3582 switch (fm->command) {
3584 return add_flow(ofproto, ofconn, fm, oh);
3587 return modify_flows_loose(ofproto, ofconn, fm, oh);
3589 case OFPFC_MODIFY_STRICT:
3590 return modify_flow_strict(ofproto, ofconn, fm, oh);
3593 return delete_flows_loose(ofproto, ofconn, fm, oh);
3595 case OFPFC_DELETE_STRICT:
3596 return delete_flow_strict(ofproto, ofconn, fm, oh);
3599 if (fm->command > 0xff) {
3600 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
3601 "flow_mod_table_id extension is not enabled",
3604 return OFPERR_OFPFMFC_BAD_COMMAND;
3609 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
3611 const struct nx_role_request *nrr = ofpmsg_body(oh);
3612 struct nx_role_request *reply;
3616 role = ntohl(nrr->role);
3617 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
3618 && role != NX_ROLE_SLAVE) {
3619 return OFPERR_OFPRRFC_BAD_ROLE;
3622 if (ofconn_get_role(ofconn) != role
3623 && ofconn_has_pending_opgroups(ofconn)) {
3624 return OFPROTO_POSTPONE;
3627 ofconn_set_role(ofconn, role);
3629 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, oh, 0);
3630 reply = ofpbuf_put_zeros(buf, sizeof *reply);
3631 reply->role = htonl(role);
3632 ofconn_send_reply(ofconn, buf);
3638 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
3639 const struct ofp_header *oh)
3641 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
3642 enum ofputil_protocol cur, next;
3644 cur = ofconn_get_protocol(ofconn);
3645 next = ofputil_protocol_set_tid(cur, msg->set != 0);
3646 ofconn_set_protocol(ofconn, next);
3652 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
3654 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
3655 enum ofputil_protocol cur, next;
3656 enum ofputil_protocol next_base;
3658 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
3660 return OFPERR_OFPBRC_EPERM;
3663 cur = ofconn_get_protocol(ofconn);
3664 next = ofputil_protocol_set_base(cur, next_base);
3665 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
3666 /* Avoid sending async messages in surprising protocol. */
3667 return OFPROTO_POSTPONE;
3670 ofconn_set_protocol(ofconn, next);
3675 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
3676 const struct ofp_header *oh)
3678 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
3681 format = ntohl(msg->format);
3682 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
3683 return OFPERR_OFPBRC_EPERM;
3686 if (format != ofconn_get_packet_in_format(ofconn)
3687 && ofconn_has_pending_opgroups(ofconn)) {
3688 /* Avoid sending async message in surprsing packet in format. */
3689 return OFPROTO_POSTPONE;
3692 ofconn_set_packet_in_format(ofconn, format);
3697 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
3699 const struct nx_async_config *msg = ofpmsg_body(oh);
3700 uint32_t master[OAM_N_TYPES];
3701 uint32_t slave[OAM_N_TYPES];
3703 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
3704 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
3705 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
3707 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
3708 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
3709 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
3711 ofconn_set_async_config(ofconn, master, slave);
3712 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
3713 !ofconn_get_miss_send_len(ofconn)) {
3714 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
3721 handle_nxt_set_controller_id(struct ofconn *ofconn,
3722 const struct ofp_header *oh)
3724 const struct nx_controller_id *nci = ofpmsg_body(oh);
3726 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
3727 return OFPERR_NXBRC_MUST_BE_ZERO;
3730 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
3735 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
3739 if (ofconn_has_pending_opgroups(ofconn)) {
3740 return OFPROTO_POSTPONE;
3743 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
3744 ? OFPRAW_OFPT10_BARRIER_REPLY
3745 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
3746 ofconn_send_reply(ofconn, buf);
3751 ofproto_compose_flow_refresh_update(const struct rule *rule,
3752 enum nx_flow_monitor_flags flags,
3755 struct ofoperation *op = rule->pending;
3756 struct ofputil_flow_update fu;
3759 if (op && op->type == OFOPERATION_ADD && !op->victim) {
3760 /* We'll report the final flow when the operation completes. Reporting
3761 * it now would cause a duplicate report later. */
3765 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
3766 ? NXFME_ADDED : NXFME_MODIFIED);
3768 fu.idle_timeout = rule->idle_timeout;
3769 fu.hard_timeout = rule->hard_timeout;
3770 fu.table_id = rule->table_id;
3771 fu.cookie = rule->flow_cookie;
3772 minimatch_expand(&rule->cr.match, &match);
3774 fu.priority = rule->cr.priority;
3775 if (!(flags & NXFMF_ACTIONS)) {
3779 fu.ofpacts = rule->ofpacts;
3780 fu.ofpacts_len = rule->ofpacts_len;
3782 /* An operation is in progress. Use the previous version of the flow's
3783 * actions, so that when the operation commits we report the change. */
3785 case OFOPERATION_ADD:
3786 /* We already verified that there was a victim. */
3787 fu.ofpacts = op->victim->ofpacts;
3788 fu.ofpacts_len = op->victim->ofpacts_len;
3791 case OFOPERATION_MODIFY:
3793 fu.ofpacts = op->ofpacts;
3794 fu.ofpacts_len = op->ofpacts_len;
3796 fu.ofpacts = rule->ofpacts;
3797 fu.ofpacts_len = rule->ofpacts_len;
3801 case OFOPERATION_DELETE:
3802 fu.ofpacts = rule->ofpacts;
3803 fu.ofpacts_len = rule->ofpacts_len;
3811 if (list_is_empty(msgs)) {
3812 ofputil_start_flow_update(msgs);
3814 ofputil_append_flow_update(&fu, msgs);
3818 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
3822 LIST_FOR_EACH (rule, ofproto_node, rules) {
3823 enum nx_flow_monitor_flags flags = rule->monitor_flags;
3824 rule->monitor_flags = 0;
3826 ofproto_compose_flow_refresh_update(rule, flags, msgs);
3831 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
3832 struct rule *rule, uint64_t seqno,
3835 enum nx_flow_monitor_flags update;
3837 if (ofproto_rule_is_hidden(rule)) {
3842 ? ofoperation_has_out_port(rule->pending, m->out_port)
3843 : ofproto_rule_has_out_port(rule, m->out_port))) {
3848 if (rule->add_seqno > seqno) {
3849 update = NXFMF_ADD | NXFMF_MODIFY;
3850 } else if (rule->modify_seqno > seqno) {
3851 update = NXFMF_MODIFY;
3856 if (!(m->flags & update)) {
3860 update = NXFMF_INITIAL;
3863 if (!rule->monitor_flags) {
3864 list_push_back(rules, &rule->ofproto_node);
3866 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
3870 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
3874 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
3875 const struct ofoperation *op;
3876 const struct oftable *table;
3877 struct cls_rule target;
3879 cls_rule_init_from_minimatch(&target, &m->match, 0);
3880 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
3881 struct cls_cursor cursor;
3884 cls_cursor_init(&cursor, &table->cls, &target);
3885 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3886 assert(!rule->pending); /* XXX */
3887 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3891 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
3892 struct rule *rule = op->rule;
3894 if (((m->table_id == 0xff
3895 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
3896 : m->table_id == rule->table_id))
3897 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
3898 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3901 cls_rule_destroy(&target);
3905 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
3908 if (m->flags & NXFMF_INITIAL) {
3909 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
3914 ofmonitor_collect_resume_rules(struct ofmonitor *m,
3915 uint64_t seqno, struct list *rules)
3917 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
3921 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
3923 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3924 struct ofmonitor **monitors;
3925 size_t n_monitors, allocated_monitors;
3926 struct list replies;
3933 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3935 n_monitors = allocated_monitors = 0;
3937 struct ofputil_flow_monitor_request request;
3938 struct ofmonitor *m;
3941 retval = ofputil_decode_flow_monitor_request(&request, &b);
3942 if (retval == EOF) {
3944 } else if (retval) {
3949 if (request.table_id != 0xff
3950 && request.table_id >= ofproto->n_tables) {
3951 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3955 error = ofmonitor_create(&request, ofconn, &m);
3960 if (n_monitors >= allocated_monitors) {
3961 monitors = x2nrealloc(monitors, &allocated_monitors,
3964 monitors[n_monitors++] = m;
3968 for (i = 0; i < n_monitors; i++) {
3969 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
3972 ofpmp_init(&replies, oh);
3973 ofmonitor_compose_refresh_updates(&rules, &replies);
3974 ofconn_send_replies(ofconn, &replies);
3981 for (i = 0; i < n_monitors; i++) {
3982 ofmonitor_destroy(monitors[i]);
3989 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
3991 struct ofmonitor *m;
3994 id = ofputil_decode_flow_monitor_cancel(oh);
3995 m = ofmonitor_lookup(ofconn, id);
3997 return OFPERR_NXBRC_FM_BAD_ID;
4000 ofmonitor_destroy(m);
4005 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
4007 const struct ofp_header *oh = msg->data;
4011 error = ofptype_decode(&type, oh);
4017 /* OpenFlow requests. */
4018 case OFPTYPE_ECHO_REQUEST:
4019 return handle_echo_request(ofconn, oh);
4021 case OFPTYPE_FEATURES_REQUEST:
4022 return handle_features_request(ofconn, oh);
4024 case OFPTYPE_GET_CONFIG_REQUEST:
4025 return handle_get_config_request(ofconn, oh);
4027 case OFPTYPE_SET_CONFIG:
4028 return handle_set_config(ofconn, oh);
4030 case OFPTYPE_PACKET_OUT:
4031 return handle_packet_out(ofconn, oh);
4033 case OFPTYPE_PORT_MOD:
4034 return handle_port_mod(ofconn, oh);
4036 case OFPTYPE_FLOW_MOD:
4037 return handle_flow_mod(ofconn, oh);
4039 case OFPTYPE_BARRIER_REQUEST:
4040 return handle_barrier_request(ofconn, oh);
4042 /* OpenFlow replies. */
4043 case OFPTYPE_ECHO_REPLY:
4046 /* Nicira extension requests. */
4047 case OFPTYPE_ROLE_REQUEST:
4048 return handle_role_request(ofconn, oh);
4050 case OFPTYPE_FLOW_MOD_TABLE_ID:
4051 return handle_nxt_flow_mod_table_id(ofconn, oh);
4053 case OFPTYPE_SET_FLOW_FORMAT:
4054 return handle_nxt_set_flow_format(ofconn, oh);
4056 case OFPTYPE_SET_PACKET_IN_FORMAT:
4057 return handle_nxt_set_packet_in_format(ofconn, oh);
4059 case OFPTYPE_SET_CONTROLLER_ID:
4060 return handle_nxt_set_controller_id(ofconn, oh);
4062 case OFPTYPE_FLOW_AGE:
4063 /* Nothing to do. */
4066 case OFPTYPE_FLOW_MONITOR_CANCEL:
4067 return handle_flow_monitor_cancel(ofconn, oh);
4069 case OFPTYPE_SET_ASYNC_CONFIG:
4070 return handle_nxt_set_async_config(ofconn, oh);
4072 /* Statistics requests. */
4073 case OFPTYPE_DESC_STATS_REQUEST:
4074 return handle_desc_stats_request(ofconn, oh);
4076 case OFPTYPE_FLOW_STATS_REQUEST:
4077 return handle_flow_stats_request(ofconn, oh);
4079 case OFPTYPE_AGGREGATE_STATS_REQUEST:
4080 return handle_aggregate_stats_request(ofconn, oh);
4082 case OFPTYPE_TABLE_STATS_REQUEST:
4083 return handle_table_stats_request(ofconn, oh);
4085 case OFPTYPE_PORT_STATS_REQUEST:
4086 return handle_port_stats_request(ofconn, oh);
4088 case OFPTYPE_QUEUE_STATS_REQUEST:
4089 return handle_queue_stats_request(ofconn, oh);
4091 case OFPTYPE_PORT_DESC_STATS_REQUEST:
4092 return handle_port_desc_stats_request(ofconn, oh);
4094 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
4095 return handle_flow_monitor_request(ofconn, oh);
4099 case OFPTYPE_FEATURES_REPLY:
4100 case OFPTYPE_GET_CONFIG_REPLY:
4101 case OFPTYPE_PACKET_IN:
4102 case OFPTYPE_FLOW_REMOVED:
4103 case OFPTYPE_PORT_STATUS:
4104 case OFPTYPE_BARRIER_REPLY:
4105 case OFPTYPE_DESC_STATS_REPLY:
4106 case OFPTYPE_FLOW_STATS_REPLY:
4107 case OFPTYPE_QUEUE_STATS_REPLY:
4108 case OFPTYPE_PORT_STATS_REPLY:
4109 case OFPTYPE_TABLE_STATS_REPLY:
4110 case OFPTYPE_AGGREGATE_STATS_REPLY:
4111 case OFPTYPE_PORT_DESC_STATS_REPLY:
4112 case OFPTYPE_ROLE_REPLY:
4113 case OFPTYPE_FLOW_MONITOR_PAUSED:
4114 case OFPTYPE_FLOW_MONITOR_RESUMED:
4115 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
4117 return OFPERR_OFPBRC_BAD_TYPE;
4122 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
4124 int error = handle_openflow__(ofconn, ofp_msg);
4125 if (error && error != OFPROTO_POSTPONE) {
4126 ofconn_send_error(ofconn, ofp_msg->data, error);
4128 COVERAGE_INC(ofproto_recv_openflow);
4129 return error != OFPROTO_POSTPONE;
4132 /* Asynchronous operations. */
4134 /* Creates and returns a new ofopgroup that is not associated with any
4135 * OpenFlow connection.
4137 * The caller should add operations to the returned group with
4138 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4139 static struct ofopgroup *
4140 ofopgroup_create_unattached(struct ofproto *ofproto)
4142 struct ofopgroup *group = xzalloc(sizeof *group);
4143 group->ofproto = ofproto;
4144 list_init(&group->ofproto_node);
4145 list_init(&group->ops);
4146 list_init(&group->ofconn_node);
4150 /* Creates and returns a new ofopgroup for 'ofproto'.
4152 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
4153 * connection. The 'request' and 'buffer_id' arguments are ignored.
4155 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
4156 * If the ofopgroup eventually fails, then the error reply will include
4157 * 'request'. If the ofopgroup eventually succeeds, then the packet with
4158 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
4160 * The caller should add operations to the returned group with
4161 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4162 static struct ofopgroup *
4163 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
4164 const struct ofp_header *request, uint32_t buffer_id)
4166 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
4168 size_t request_len = ntohs(request->length);
4170 assert(ofconn_get_ofproto(ofconn) == ofproto);
4172 ofconn_add_opgroup(ofconn, &group->ofconn_node);
4173 group->ofconn = ofconn;
4174 group->request = xmemdup(request, MIN(request_len, 64));
4175 group->buffer_id = buffer_id;
4180 /* Submits 'group' for processing.
4182 * If 'group' contains no operations (e.g. none were ever added, or all of the
4183 * ones that were added completed synchronously), then it is destroyed
4184 * immediately. Otherwise it is added to the ofproto's list of pending
4187 ofopgroup_submit(struct ofopgroup *group)
4189 if (!group->n_running) {
4190 ofopgroup_complete(group);
4192 list_push_back(&group->ofproto->pending, &group->ofproto_node);
4193 group->ofproto->n_pending++;
4198 ofopgroup_complete(struct ofopgroup *group)
4200 struct ofproto *ofproto = group->ofproto;
4202 struct ofconn *abbrev_ofconn;
4203 ovs_be32 abbrev_xid;
4205 struct ofoperation *op, *next_op;
4208 assert(!group->n_running);
4211 LIST_FOR_EACH (op, group_node, &group->ops) {
4218 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
4219 LIST_FOR_EACH (op, group_node, &group->ops) {
4220 if (op->type != OFOPERATION_DELETE) {
4221 struct ofpbuf *packet;
4224 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
4228 error = rule_execute(op->rule, in_port, packet);
4235 if (!error && !list_is_empty(&group->ofconn_node)) {
4236 abbrev_ofconn = group->ofconn;
4237 abbrev_xid = group->request->xid;
4239 abbrev_ofconn = NULL;
4240 abbrev_xid = htonl(0);
4242 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
4243 struct rule *rule = op->rule;
4245 if (!op->error && !ofproto_rule_is_hidden(rule)) {
4246 /* Check that we can just cast from ofoperation_type to
4247 * nx_flow_update_event. */
4248 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_ADD
4250 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_DELETE
4252 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_MODIFY
4255 ofmonitor_report(ofproto->connmgr, rule,
4256 (enum nx_flow_update_event) op->type,
4257 op->reason, abbrev_ofconn, abbrev_xid);
4260 rule->pending = NULL;
4263 case OFOPERATION_ADD:
4267 ofproto_rule_destroy__(op->victim);
4268 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
4269 if (vid_mask == VLAN_VID_MASK) {
4270 if (ofproto->vlan_bitmap) {
4271 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4272 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4273 bitmap_set1(ofproto->vlan_bitmap, vid);
4274 ofproto->vlans_changed = true;
4277 ofproto->vlans_changed = true;
4281 oftable_substitute_rule(rule, op->victim);
4282 ofproto_rule_destroy__(rule);
4286 case OFOPERATION_DELETE:
4288 ofproto_rule_destroy__(rule);
4292 case OFOPERATION_MODIFY:
4294 rule->modified = time_msec();
4296 rule->flow_cookie = op->flow_cookie;
4298 free(rule->ofpacts);
4299 rule->ofpacts = op->ofpacts;
4300 rule->ofpacts_len = op->ofpacts_len;
4302 op->ofpacts_len = 0;
4311 ofoperation_destroy(op);
4314 ofmonitor_flush(ofproto->connmgr);
4316 if (!list_is_empty(&group->ofproto_node)) {
4317 assert(ofproto->n_pending > 0);
4318 ofproto->n_pending--;
4319 list_remove(&group->ofproto_node);
4321 if (!list_is_empty(&group->ofconn_node)) {
4322 list_remove(&group->ofconn_node);
4324 ofconn_send_error(group->ofconn, group->request, error);
4326 connmgr_retry(ofproto->connmgr);
4328 free(group->request);
4332 /* Initiates a new operation on 'rule', of the specified 'type', within
4333 * 'group'. Prior to calling, 'rule' must not have any pending operation.
4335 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4336 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
4338 * Returns the newly created ofoperation (which is also available as
4339 * rule->pending). */
4340 static struct ofoperation *
4341 ofoperation_create(struct ofopgroup *group, struct rule *rule,
4342 enum ofoperation_type type,
4343 enum ofp_flow_removed_reason reason)
4345 struct ofproto *ofproto = group->ofproto;
4346 struct ofoperation *op;
4348 assert(!rule->pending);
4350 op = rule->pending = xzalloc(sizeof *op);
4352 list_push_back(&group->ops, &op->group_node);
4355 op->reason = reason;
4356 op->flow_cookie = rule->flow_cookie;
4360 if (type == OFOPERATION_DELETE) {
4361 hmap_insert(&ofproto->deletions, &op->hmap_node,
4362 cls_rule_hash(&rule->cr, rule->table_id));
4369 ofoperation_destroy(struct ofoperation *op)
4371 struct ofopgroup *group = op->group;
4374 op->rule->pending = NULL;
4376 if (op->type == OFOPERATION_DELETE) {
4377 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
4379 list_remove(&op->group_node);
4384 /* Indicates that 'op' completed with status 'error', which is either 0 to
4385 * indicate success or an OpenFlow error code on failure.
4387 * If 'error' is 0, indicating success, the operation will be committed
4388 * permanently to the flow table. There is one interesting subcase:
4390 * - If 'op' is an "add flow" operation that is replacing an existing rule in
4391 * the flow table (the "victim" rule) by a new one, then the caller must
4392 * have uninitialized any derived state in the victim rule, as in step 5 in
4393 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
4394 * performs steps 6 and 7 for the victim rule, most notably by calling its
4395 * ->rule_dealloc() function.
4397 * If 'error' is nonzero, then generally the operation will be rolled back:
4399 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
4400 * restores the original rule. The caller must have uninitialized any
4401 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
4402 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
4403 * and 7 for the new rule, calling its ->rule_dealloc() function.
4405 * - If 'op' is a "modify flow" operation, ofproto restores the original
4408 * - 'op' must not be a "delete flow" operation. Removing a rule is not
4409 * allowed to fail. It must always succeed.
4411 * Please see the large comment in ofproto/ofproto-provider.h titled
4412 * "Asynchronous Operation Support" for more information. */
4414 ofoperation_complete(struct ofoperation *op, enum ofperr error)
4416 struct ofopgroup *group = op->group;
4418 assert(op->rule->pending == op);
4419 assert(group->n_running > 0);
4420 assert(!error || op->type != OFOPERATION_DELETE);
4423 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
4424 ofopgroup_complete(group);
4429 ofoperation_get_victim(struct ofoperation *op)
4431 assert(op->type == OFOPERATION_ADD);
4436 pick_datapath_id(const struct ofproto *ofproto)
4438 const struct ofport *port;
4440 port = ofproto_get_port(ofproto, OFPP_LOCAL);
4442 uint8_t ea[ETH_ADDR_LEN];
4445 error = netdev_get_etheraddr(port->netdev, ea);
4447 return eth_addr_to_uint64(ea);
4449 VLOG_WARN("%s: could not get MAC address for %s (%s)",
4450 ofproto->name, netdev_get_name(port->netdev),
4453 return ofproto->fallback_dpid;
4457 pick_fallback_dpid(void)
4459 uint8_t ea[ETH_ADDR_LEN];
4460 eth_addr_nicira_random(ea);
4461 return eth_addr_to_uint64(ea);
4464 /* Table overflow policy. */
4466 /* Chooses and returns a rule to evict from 'table'. Returns NULL if the table
4467 * is not configured to evict rules or if the table contains no evictable
4468 * rules. (Rules with 'evictable' set to false or with no timeouts are not
4470 static struct rule *
4471 choose_rule_to_evict(struct oftable *table)
4473 struct eviction_group *evg;
4475 if (!table->eviction_fields) {
4479 /* In the common case, the outer and inner loops here will each be entered
4482 * - The inner loop normally "return"s in its first iteration. If the
4483 * eviction group has any evictable rules, then it always returns in
4486 * - The outer loop only iterates more than once if the largest eviction
4487 * group has no evictable rules.
4489 * - The outer loop can exit only if table's 'max_flows' is all filled up
4490 * by unevictable rules'. */
4491 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
4494 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
4495 if (rule->evictable) {
4504 /* Searches 'ofproto' for tables that have more flows than their configured
4505 * maximum and that have flow eviction enabled, and evicts as many flows as
4506 * necessary and currently feasible from them.
4508 * This triggers only when an OpenFlow table has N flows in it and then the
4509 * client configures a maximum number of flows less than N. */
4511 ofproto_evict(struct ofproto *ofproto)
4513 struct ofopgroup *group;
4514 struct oftable *table;
4516 group = ofopgroup_create_unattached(ofproto);
4517 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
4518 while (classifier_count(&table->cls) > table->max_flows
4519 && table->eviction_fields) {
4522 rule = choose_rule_to_evict(table);
4523 if (!rule || rule->pending) {
4527 ofoperation_create(group, rule,
4528 OFOPERATION_DELETE, OFPRR_EVICTION);
4529 oftable_remove_rule(rule);
4530 ofproto->ofproto_class->rule_destruct(rule);
4533 ofopgroup_submit(group);
4536 /* Eviction groups. */
4538 /* Returns the priority to use for an eviction_group that contains 'n_rules'
4539 * rules. The priority contains low-order random bits to ensure that eviction
4540 * groups with the same number of rules are prioritized randomly. */
4542 eviction_group_priority(size_t n_rules)
4544 uint16_t size = MIN(UINT16_MAX, n_rules);
4545 return (size << 16) | random_uint16();
4548 /* Updates 'evg', an eviction_group within 'table', following a change that
4549 * adds or removes rules in 'evg'. */
4551 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
4553 heap_change(&table->eviction_groups_by_size, &evg->size_node,
4554 eviction_group_priority(heap_count(&evg->rules)));
4557 /* Destroys 'evg', an eviction_group within 'table':
4559 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
4560 * rules themselves, just removes them from the eviction group.)
4562 * - Removes 'evg' from 'table'.
4566 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
4568 while (!heap_is_empty(&evg->rules)) {
4571 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
4572 rule->eviction_group = NULL;
4574 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
4575 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
4576 heap_destroy(&evg->rules);
4580 /* Removes 'rule' from its eviction group, if any. */
4582 eviction_group_remove_rule(struct rule *rule)
4584 if (rule->eviction_group) {
4585 struct oftable *table = &rule->ofproto->tables[rule->table_id];
4586 struct eviction_group *evg = rule->eviction_group;
4588 rule->eviction_group = NULL;
4589 heap_remove(&evg->rules, &rule->evg_node);
4590 if (heap_is_empty(&evg->rules)) {
4591 eviction_group_destroy(table, evg);
4593 eviction_group_resized(table, evg);
4598 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
4599 * returns the hash value. */
4601 eviction_group_hash_rule(struct rule *rule)
4603 struct oftable *table = &rule->ofproto->tables[rule->table_id];
4604 const struct mf_subfield *sf;
4608 hash = table->eviction_group_id_basis;
4609 miniflow_expand(&rule->cr.match.flow, &flow);
4610 for (sf = table->eviction_fields;
4611 sf < &table->eviction_fields[table->n_eviction_fields];
4614 if (mf_are_prereqs_ok(sf->field, &flow)) {
4615 union mf_value value;
4617 mf_get_value(sf->field, &flow, &value);
4619 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
4621 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
4622 unsigned int start = sf->ofs + sf->n_bits;
4623 bitwise_zero(&value, sf->field->n_bytes, start,
4624 sf->field->n_bytes * 8 - start);
4626 hash = hash_bytes(&value, sf->field->n_bytes, hash);
4628 hash = hash_int(hash, 0);
4635 /* Returns an eviction group within 'table' with the given 'id', creating one
4637 static struct eviction_group *
4638 eviction_group_find(struct oftable *table, uint32_t id)
4640 struct eviction_group *evg;
4642 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
4646 evg = xmalloc(sizeof *evg);
4647 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
4648 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
4649 eviction_group_priority(0));
4650 heap_init(&evg->rules);
4655 /* Returns an eviction priority for 'rule'. The return value should be
4656 * interpreted so that higher priorities make a rule more attractive candidates
4659 rule_eviction_priority(struct rule *rule)
4661 long long int hard_expiration;
4662 long long int idle_expiration;
4663 long long int expiration;
4664 uint32_t expiration_offset;
4666 /* Calculate time of expiration. */
4667 hard_expiration = (rule->hard_timeout
4668 ? rule->modified + rule->hard_timeout * 1000
4670 idle_expiration = (rule->idle_timeout
4671 ? rule->used + rule->idle_timeout * 1000
4673 expiration = MIN(hard_expiration, idle_expiration);
4674 if (expiration == LLONG_MAX) {
4678 /* Calculate the time of expiration as a number of (approximate) seconds
4679 * after program startup.
4681 * This should work OK for program runs that last UINT32_MAX seconds or
4682 * less. Therefore, please restart OVS at least once every 136 years. */
4683 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
4685 /* Invert the expiration offset because we're using a max-heap. */
4686 return UINT32_MAX - expiration_offset;
4689 /* Adds 'rule' to an appropriate eviction group for its oftable's
4690 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
4691 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
4694 * The caller must ensure that 'rule' is not already in an eviction group. */
4696 eviction_group_add_rule(struct rule *rule)
4698 struct ofproto *ofproto = rule->ofproto;
4699 struct oftable *table = &ofproto->tables[rule->table_id];
4701 if (table->eviction_fields
4702 && (rule->hard_timeout || rule->idle_timeout)) {
4703 struct eviction_group *evg;
4705 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
4707 rule->eviction_group = evg;
4708 heap_insert(&evg->rules, &rule->evg_node,
4709 rule_eviction_priority(rule));
4710 eviction_group_resized(table, evg);
4716 /* Initializes 'table'. */
4718 oftable_init(struct oftable *table)
4720 memset(table, 0, sizeof *table);
4721 classifier_init(&table->cls);
4722 table->max_flows = UINT_MAX;
4725 /* Destroys 'table', including its classifier and eviction groups.
4727 * The caller is responsible for freeing 'table' itself. */
4729 oftable_destroy(struct oftable *table)
4731 assert(classifier_is_empty(&table->cls));
4732 oftable_disable_eviction(table);
4733 classifier_destroy(&table->cls);
4737 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
4738 * string, then 'table' will use its default name.
4740 * This only affects the name exposed for a table exposed through the OpenFlow
4741 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
4743 oftable_set_name(struct oftable *table, const char *name)
4745 if (name && name[0]) {
4746 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
4747 if (!table->name || strncmp(name, table->name, len)) {
4749 table->name = xmemdup0(name, len);
4757 /* oftables support a choice of two policies when adding a rule would cause the
4758 * number of flows in the table to exceed the configured maximum number: either
4759 * they can refuse to add the new flow or they can evict some existing flow.
4760 * This function configures the former policy on 'table'. */
4762 oftable_disable_eviction(struct oftable *table)
4764 if (table->eviction_fields) {
4765 struct eviction_group *evg, *next;
4767 HMAP_FOR_EACH_SAFE (evg, next, id_node,
4768 &table->eviction_groups_by_id) {
4769 eviction_group_destroy(table, evg);
4771 hmap_destroy(&table->eviction_groups_by_id);
4772 heap_destroy(&table->eviction_groups_by_size);
4774 free(table->eviction_fields);
4775 table->eviction_fields = NULL;
4776 table->n_eviction_fields = 0;
4780 /* oftables support a choice of two policies when adding a rule would cause the
4781 * number of flows in the table to exceed the configured maximum number: either
4782 * they can refuse to add the new flow or they can evict some existing flow.
4783 * This function configures the latter policy on 'table', with fairness based
4784 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
4785 * 'n_fields' as 0 disables fairness.) */
4787 oftable_enable_eviction(struct oftable *table,
4788 const struct mf_subfield *fields, size_t n_fields)
4790 struct cls_cursor cursor;
4793 if (table->eviction_fields
4794 && n_fields == table->n_eviction_fields
4796 || !memcmp(fields, table->eviction_fields,
4797 n_fields * sizeof *fields))) {
4802 oftable_disable_eviction(table);
4804 table->n_eviction_fields = n_fields;
4805 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
4807 table->eviction_group_id_basis = random_uint32();
4808 hmap_init(&table->eviction_groups_by_id);
4809 heap_init(&table->eviction_groups_by_size);
4811 cls_cursor_init(&cursor, &table->cls, NULL);
4812 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4813 eviction_group_add_rule(rule);
4817 /* Removes 'rule' from the oftable that contains it. */
4819 oftable_remove_rule(struct rule *rule)
4821 struct ofproto *ofproto = rule->ofproto;
4822 struct oftable *table = &ofproto->tables[rule->table_id];
4824 classifier_remove(&table->cls, &rule->cr);
4825 eviction_group_remove_rule(rule);
4828 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
4829 * oftable that has an identical cls_rule. Returns the rule that was removed,
4830 * if any, and otherwise NULL. */
4831 static struct rule *
4832 oftable_replace_rule(struct rule *rule)
4834 struct ofproto *ofproto = rule->ofproto;
4835 struct oftable *table = &ofproto->tables[rule->table_id];
4836 struct rule *victim;
4838 victim = rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
4840 eviction_group_remove_rule(victim);
4842 eviction_group_add_rule(rule);
4846 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
4848 oftable_substitute_rule(struct rule *old, struct rule *new)
4851 oftable_replace_rule(new);
4853 oftable_remove_rule(old);
4857 /* unixctl commands. */
4860 ofproto_lookup(const char *name)
4862 struct ofproto *ofproto;
4864 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
4866 if (!strcmp(ofproto->name, name)) {
4874 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
4875 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
4877 struct ofproto *ofproto;
4881 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
4882 ds_put_format(&results, "%s\n", ofproto->name);
4884 unixctl_command_reply(conn, ds_cstr(&results));
4885 ds_destroy(&results);
4889 ofproto_unixctl_init(void)
4891 static bool registered;
4897 unixctl_command_register("ofproto/list", "", 0, 0,
4898 ofproto_unixctl_list, NULL);
4901 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
4903 * This is deprecated. It is only for compatibility with broken device drivers
4904 * in old versions of Linux that do not properly support VLANs when VLAN
4905 * devices are not used. When broken device drivers are no longer in
4906 * widespread use, we will delete these interfaces. */
4908 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
4909 * (exactly) by an OpenFlow rule in 'ofproto'. */
4911 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
4913 const struct oftable *oftable;
4915 free(ofproto->vlan_bitmap);
4916 ofproto->vlan_bitmap = bitmap_allocate(4096);
4917 ofproto->vlans_changed = false;
4919 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
4920 const struct cls_table *table;
4922 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
4923 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
4924 const struct cls_rule *rule;
4926 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
4927 uint16_t vid = miniflow_get_vid(&rule->match.flow);
4928 bitmap_set1(vlan_bitmap, vid);
4929 bitmap_set1(ofproto->vlan_bitmap, vid);
4936 /* Returns true if new VLANs have come into use by the flow table since the
4937 * last call to ofproto_get_vlan_usage().
4939 * We don't track when old VLANs stop being used. */
4941 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
4943 return ofproto->vlans_changed;
4946 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
4947 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
4948 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
4949 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
4950 * then the VLAN device is un-enslaved. */
4952 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
4953 uint16_t realdev_ofp_port, int vid)
4955 struct ofport *ofport;
4958 assert(vlandev_ofp_port != realdev_ofp_port);
4960 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
4962 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
4963 ofproto->name, vlandev_ofp_port);
4967 if (!ofproto->ofproto_class->set_realdev) {
4968 if (!vlandev_ofp_port) {
4971 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
4975 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
4977 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
4978 ofproto->name, vlandev_ofp_port,
4979 netdev_get_name(ofport->netdev), strerror(error));