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 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1437 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1438 * the port's OpenFlow port number.
1440 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1441 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1442 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1443 * 'ofp_portp' is non-null). */
1445 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1446 uint16_t *ofp_portp)
1448 uint16_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1451 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1453 const char *netdev_name = netdev_get_name(netdev);
1455 simap_put(&ofproto->ofp_requests, netdev_name, ofp_port);
1456 update_port(ofproto, netdev_name);
1459 struct ofproto_port ofproto_port;
1461 ofproto_port_query_by_name(ofproto, netdev_get_name(netdev),
1463 *ofp_portp = error ? OFPP_NONE : ofproto_port.ofp_port;
1464 ofproto_port_destroy(&ofproto_port);
1469 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1470 * initializes '*port' appropriately; on failure, returns a positive errno
1473 * The caller owns the data in 'ofproto_port' and must free it with
1474 * ofproto_port_destroy() when it is no longer needed. */
1476 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1477 struct ofproto_port *port)
1481 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1483 memset(port, 0, sizeof *port);
1488 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1489 * Returns 0 if successful, otherwise a positive errno. */
1491 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1493 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1494 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1495 struct simap_node *ofp_request_node;
1498 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1499 if (ofp_request_node) {
1500 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1503 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1504 if (!error && ofport) {
1505 /* 'name' is the netdev's name and update_port() is going to close the
1506 * netdev. Just in case update_port() refers to 'name' after it
1507 * destroys 'ofport', make a copy of it around the update_port()
1509 char *devname = xstrdup(name);
1510 update_port(ofproto, devname);
1516 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1517 * performs the 'n_actions' actions in 'actions'. The new flow will not
1520 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1521 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1522 * controllers; otherwise, it will be hidden.
1524 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1526 * This is a helper function for in-band control and fail-open. */
1528 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1529 unsigned int priority,
1530 const struct ofpact *ofpacts, size_t ofpacts_len)
1532 const struct rule *rule;
1534 rule = rule_from_cls_rule(classifier_find_match_exactly(
1535 &ofproto->tables[0].cls, match, priority));
1536 if (!rule || !ofpacts_equal(rule->ofpacts, rule->ofpacts_len,
1537 ofpacts, ofpacts_len)) {
1538 struct ofputil_flow_mod fm;
1540 memset(&fm, 0, sizeof fm);
1542 fm.priority = priority;
1543 fm.buffer_id = UINT32_MAX;
1544 fm.ofpacts = xmemdup(ofpacts, ofpacts_len);
1545 fm.ofpacts_len = ofpacts_len;
1546 add_flow(ofproto, NULL, &fm, NULL);
1551 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1552 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1553 * operation cannot be initiated now but may be retried later.
1555 * This is a helper function for in-band control and fail-open. */
1557 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1559 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1562 /* Searches for a rule with matching criteria exactly equal to 'target' in
1563 * ofproto's table 0 and, if it finds one, deletes it.
1565 * This is a helper function for in-band control and fail-open. */
1567 ofproto_delete_flow(struct ofproto *ofproto,
1568 const struct match *target, unsigned int priority)
1572 rule = rule_from_cls_rule(classifier_find_match_exactly(
1573 &ofproto->tables[0].cls, target, priority));
1575 /* No such rule -> success. */
1577 } else if (rule->pending) {
1578 /* An operation on the rule is already pending -> failure.
1579 * Caller must retry later if it's important. */
1582 /* Initiate deletion -> success. */
1583 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1584 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1585 oftable_remove_rule(rule);
1586 ofproto->ofproto_class->rule_destruct(rule);
1587 ofopgroup_submit(group);
1593 /* Starts the process of deleting all of the flows from all of ofproto's flow
1594 * tables and then reintroducing the flows required by in-band control and
1595 * fail-open. The process will complete in a later call to ofproto_run(). */
1597 ofproto_flush_flows(struct ofproto *ofproto)
1599 COVERAGE_INC(ofproto_flush);
1600 ofproto->state = S_FLUSH;
1604 reinit_ports(struct ofproto *p)
1606 struct ofproto_port_dump dump;
1607 struct sset devnames;
1608 struct ofport *ofport;
1609 struct ofproto_port ofproto_port;
1610 const char *devname;
1612 COVERAGE_INC(ofproto_reinit_ports);
1614 sset_init(&devnames);
1615 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1616 sset_add(&devnames, netdev_get_name(ofport->netdev));
1618 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1619 sset_add(&devnames, ofproto_port.name);
1622 SSET_FOR_EACH (devname, &devnames) {
1623 update_port(p, devname);
1625 sset_destroy(&devnames);
1629 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
1633 ofp_port = simap_get(&ofproto->ofp_requests, netdev_name);
1634 ofp_port = ofp_port ? ofp_port : OFPP_NONE;
1636 if (ofp_port >= ofproto->max_ports
1637 || bitmap_is_set(ofproto->ofp_port_ids, ofp_port)) {
1638 bool retry = ofproto->alloc_port_no ? true : false;
1640 /* Search for a free OpenFlow port number. We try not to
1641 * immediately reuse them to prevent problems due to old
1643 while (ofp_port >= ofproto->max_ports) {
1644 for (ofproto->alloc_port_no++;
1645 ofproto->alloc_port_no < ofproto->max_ports; ) {
1646 if (!bitmap_is_set(ofproto->ofp_port_ids,
1647 ofproto->alloc_port_no)) {
1648 ofp_port = ofproto->alloc_port_no;
1652 if (ofproto->alloc_port_no >= ofproto->max_ports) {
1654 ofproto->alloc_port_no = 0;
1663 bitmap_set1(ofproto->ofp_port_ids, ofp_port);
1668 dealloc_ofp_port(const struct ofproto *ofproto, uint16_t ofp_port)
1670 bitmap_set0(ofproto->ofp_port_ids, ofp_port);
1673 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1674 * pointer if the netdev cannot be opened. On success, also fills in
1676 static struct netdev *
1677 ofport_open(struct ofproto *ofproto,
1678 struct ofproto_port *ofproto_port,
1679 struct ofputil_phy_port *pp)
1681 enum netdev_flags flags;
1682 struct netdev *netdev;
1685 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1687 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1688 "cannot be opened (%s)",
1690 ofproto_port->name, ofproto_port->ofp_port,
1691 ofproto_port->name, strerror(error));
1695 if (ofproto_port->ofp_port == OFPP_NONE) {
1696 if (!strcmp(ofproto->name, ofproto_port->name)) {
1697 ofproto_port->ofp_port = OFPP_LOCAL;
1699 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1700 ofproto_port->name);
1703 pp->port_no = ofproto_port->ofp_port;
1704 netdev_get_etheraddr(netdev, pp->hw_addr);
1705 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1706 netdev_get_flags(netdev, &flags);
1707 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1708 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1709 netdev_get_features(netdev, &pp->curr, &pp->advertised,
1710 &pp->supported, &pp->peer);
1711 pp->curr_speed = netdev_features_to_bps(pp->curr, 0);
1712 pp->max_speed = netdev_features_to_bps(pp->supported, 0);
1717 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1718 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1721 ofport_equal(const struct ofputil_phy_port *a,
1722 const struct ofputil_phy_port *b)
1724 return (eth_addr_equals(a->hw_addr, b->hw_addr)
1725 && a->state == b->state
1726 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1727 && a->curr == b->curr
1728 && a->advertised == b->advertised
1729 && a->supported == b->supported
1730 && a->peer == b->peer
1731 && a->curr_speed == b->curr_speed
1732 && a->max_speed == b->max_speed);
1735 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1736 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1737 * one with the same name or port number). */
1739 ofport_install(struct ofproto *p,
1740 struct netdev *netdev, const struct ofputil_phy_port *pp)
1742 const char *netdev_name = netdev_get_name(netdev);
1743 struct ofport *ofport;
1746 /* Create ofport. */
1747 ofport = p->ofproto_class->port_alloc();
1752 ofport->ofproto = p;
1753 ofport->netdev = netdev;
1754 ofport->change_seq = netdev_change_seq(netdev);
1756 ofport->ofp_port = pp->port_no;
1758 /* Add port to 'p'. */
1759 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1760 shash_add(&p->port_by_name, netdev_name, ofport);
1762 update_mtu(p, ofport);
1764 /* Let the ofproto_class initialize its private data. */
1765 error = p->ofproto_class->port_construct(ofport);
1769 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1773 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1774 p->name, netdev_name, strerror(error));
1776 ofport_destroy__(ofport);
1778 netdev_close(netdev);
1782 /* Removes 'ofport' from 'p' and destroys it. */
1784 ofport_remove(struct ofport *ofport)
1786 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1788 ofport_destroy(ofport);
1791 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1794 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1796 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1798 ofport_remove(port);
1802 /* Updates 'port' with new 'pp' description.
1804 * Does not handle a name or port number change. The caller must implement
1805 * such a change as a delete followed by an add. */
1807 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1809 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1810 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1811 | (pp->config & OFPUTIL_PC_PORT_DOWN));
1812 port->pp.state = pp->state;
1813 port->pp.curr = pp->curr;
1814 port->pp.advertised = pp->advertised;
1815 port->pp.supported = pp->supported;
1816 port->pp.peer = pp->peer;
1817 port->pp.curr_speed = pp->curr_speed;
1818 port->pp.max_speed = pp->max_speed;
1820 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1823 /* Update OpenFlow 'state' in 'port' and notify controller. */
1825 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
1827 if (port->pp.state != state) {
1828 port->pp.state = state;
1829 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
1835 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1837 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1839 if (port->ofproto->ofproto_class->set_realdev) {
1840 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1842 if (port->ofproto->ofproto_class->set_stp_port) {
1843 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1845 if (port->ofproto->ofproto_class->set_cfm) {
1846 port->ofproto->ofproto_class->set_cfm(port, NULL);
1848 if (port->ofproto->ofproto_class->bundle_remove) {
1849 port->ofproto->ofproto_class->bundle_remove(port);
1855 ofport_destroy__(struct ofport *port)
1857 struct ofproto *ofproto = port->ofproto;
1858 const char *name = netdev_get_name(port->netdev);
1860 hmap_remove(&ofproto->ports, &port->hmap_node);
1861 shash_delete(&ofproto->port_by_name,
1862 shash_find(&ofproto->port_by_name, name));
1864 netdev_close(port->netdev);
1865 ofproto->ofproto_class->port_dealloc(port);
1869 ofport_destroy(struct ofport *port)
1872 dealloc_ofp_port(port->ofproto, port->ofp_port);
1873 port->ofproto->ofproto_class->port_destruct(port);
1874 ofport_destroy__(port);
1879 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1881 struct ofport *port;
1883 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1884 hash_int(ofp_port, 0), &ofproto->ports) {
1885 if (port->ofp_port == ofp_port) {
1893 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1895 struct ofproto *ofproto = port->ofproto;
1898 if (ofproto->ofproto_class->port_get_stats) {
1899 error = ofproto->ofproto_class->port_get_stats(port, stats);
1908 update_port(struct ofproto *ofproto, const char *name)
1910 struct ofproto_port ofproto_port;
1911 struct ofputil_phy_port pp;
1912 struct netdev *netdev;
1913 struct ofport *port;
1915 COVERAGE_INC(ofproto_update_port);
1917 /* Fetch 'name''s location and properties from the datapath. */
1918 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1919 ? ofport_open(ofproto, &ofproto_port, &pp)
1922 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1923 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1924 struct netdev *old_netdev = port->netdev;
1926 /* 'name' hasn't changed location. Any properties changed? */
1927 if (!ofport_equal(&port->pp, &pp)) {
1928 ofport_modified(port, &pp);
1931 update_mtu(ofproto, port);
1933 /* Install the newly opened netdev in case it has changed.
1934 * Don't close the old netdev yet in case port_modified has to
1935 * remove a retained reference to it.*/
1936 port->netdev = netdev;
1937 port->change_seq = netdev_change_seq(netdev);
1939 if (port->ofproto->ofproto_class->port_modified) {
1940 port->ofproto->ofproto_class->port_modified(port);
1943 netdev_close(old_netdev);
1945 /* If 'port' is nonnull then its name differs from 'name' and thus
1946 * we should delete it. If we think there's a port named 'name'
1947 * then its port number must be wrong now so delete it too. */
1949 ofport_remove(port);
1951 ofport_remove_with_name(ofproto, name);
1952 ofport_install(ofproto, netdev, &pp);
1955 /* Any port named 'name' is gone now. */
1956 ofport_remove_with_name(ofproto, name);
1958 ofproto_port_destroy(&ofproto_port);
1962 init_ports(struct ofproto *p)
1964 struct ofproto_port_dump dump;
1965 struct ofproto_port ofproto_port;
1966 struct shash_node *node, *next;
1968 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1969 const char *name = ofproto_port.name;
1971 if (shash_find(&p->port_by_name, name)) {
1972 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
1975 struct ofputil_phy_port pp;
1976 struct netdev *netdev;
1978 /* Check if an OpenFlow port number had been requested. */
1979 node = shash_find(&init_ofp_ports, name);
1981 const struct iface_hint *iface_hint = node->data;
1982 simap_put(&p->ofp_requests, name, iface_hint->ofp_port);
1985 netdev = ofport_open(p, &ofproto_port, &pp);
1987 ofport_install(p, netdev, &pp);
1992 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
1993 const struct iface_hint *iface_hint = node->data;
1995 if (!strcmp(iface_hint->br_name, p->name)) {
1996 free(iface_hint->br_name);
1997 free(iface_hint->br_type);
1998 shash_delete(&init_ofp_ports, node);
2005 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2006 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2008 find_min_mtu(struct ofproto *p)
2010 struct ofport *ofport;
2013 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2014 struct netdev *netdev = ofport->netdev;
2017 /* Skip any internal ports, since that's what we're trying to
2019 if (!strcmp(netdev_get_type(netdev), "internal")) {
2023 if (netdev_get_mtu(netdev, &dev_mtu)) {
2026 if (!mtu || dev_mtu < mtu) {
2031 return mtu ? mtu: ETH_PAYLOAD_MAX;
2034 /* Update MTU of all datapath devices on 'p' to the minimum of the
2035 * non-datapath ports in event of 'port' added or changed. */
2037 update_mtu(struct ofproto *p, struct ofport *port)
2039 struct ofport *ofport;
2040 struct netdev *netdev = port->netdev;
2041 int dev_mtu, old_min;
2043 if (netdev_get_mtu(netdev, &dev_mtu)) {
2047 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2048 if (dev_mtu > p->min_mtu) {
2049 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2050 dev_mtu = p->min_mtu;
2053 port->mtu = dev_mtu;
2057 /* For non-internal port find new min mtu. */
2058 old_min = p->min_mtu;
2059 port->mtu = dev_mtu;
2060 p->min_mtu = find_min_mtu(p);
2061 if (p->min_mtu == old_min) {
2065 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2066 struct netdev *netdev = ofport->netdev;
2068 if (!strcmp(netdev_get_type(netdev), "internal")) {
2069 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2070 ofport->mtu = p->min_mtu;
2077 ofproto_rule_destroy__(struct rule *rule)
2080 cls_rule_destroy(&rule->cr);
2081 free(rule->ofpacts);
2082 rule->ofproto->ofproto_class->rule_dealloc(rule);
2086 /* This function allows an ofproto implementation to destroy any rules that
2087 * remain when its ->destruct() function is called. The caller must have
2088 * already uninitialized any derived members of 'rule' (step 5 described in the
2089 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
2090 * This function implements steps 6 and 7.
2092 * This function should only be called from an ofproto implementation's
2093 * ->destruct() function. It is not suitable elsewhere. */
2095 ofproto_rule_destroy(struct rule *rule)
2097 assert(!rule->pending);
2098 oftable_remove_rule(rule);
2099 ofproto_rule_destroy__(rule);
2102 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2103 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2105 ofproto_rule_has_out_port(const struct rule *rule, uint16_t port)
2107 return (port == OFPP_NONE
2108 || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
2111 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2112 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2114 ofoperation_has_out_port(const struct ofoperation *op, uint16_t out_port)
2116 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2121 case OFOPERATION_ADD:
2122 return op->victim && ofproto_rule_has_out_port(op->victim, out_port);
2124 case OFOPERATION_DELETE:
2127 case OFOPERATION_MODIFY:
2128 return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
2134 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2135 * statistics appropriately. 'packet' must have at least sizeof(struct
2136 * ofp_packet_in) bytes of headroom.
2138 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
2139 * with statistics for 'packet' either way.
2141 * Takes ownership of 'packet'. */
2143 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
2147 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2149 flow_extract(packet, 0, NULL, in_port, &flow);
2150 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
2153 /* Returns true if 'rule' should be hidden from the controller.
2155 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2156 * (e.g. by in-band control) and are intentionally hidden from the
2159 ofproto_rule_is_hidden(const struct rule *rule)
2161 return rule->cr.priority > UINT16_MAX;
2164 static enum oftable_flags
2165 rule_get_flags(const struct rule *rule)
2167 return rule->ofproto->tables[rule->table_id].flags;
2171 rule_is_modifiable(const struct rule *rule)
2173 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2177 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2179 ofconn_send_reply(ofconn, make_echo_reply(oh));
2184 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2186 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2187 struct ofputil_switch_features features;
2188 struct ofport *port;
2194 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2196 assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2198 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2199 * if present, are always at the end.) */
2200 n_tables = ofproto->n_tables;
2201 for (i = 0; i < ofproto->n_tables; i++) {
2202 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2208 features.datapath_id = ofproto->datapath_id;
2209 features.n_buffers = pktbuf_capacity();
2210 features.n_tables = n_tables;
2211 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2212 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2214 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2217 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2219 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2220 ofputil_put_switch_features_port(&port->pp, b);
2223 ofconn_send_reply(ofconn, b);
2228 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2230 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2231 struct ofp_switch_config *osc;
2232 enum ofp_config_flags flags;
2236 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2237 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2238 flags = ofproto->frag_handling;
2239 if (ofconn_get_invalid_ttl_to_controller(ofconn)) {
2240 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2242 osc->flags = htons(flags);
2243 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2244 ofconn_send_reply(ofconn, buf);
2250 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2252 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2253 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2254 uint16_t flags = ntohs(osc->flags);
2256 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2257 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
2258 enum ofp_config_flags cur = ofproto->frag_handling;
2259 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2261 assert((cur & OFPC_FRAG_MASK) == cur);
2263 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2264 ofproto->frag_handling = next;
2266 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2268 ofputil_frag_handling_to_string(next));
2272 ofconn_set_invalid_ttl_to_controller(ofconn,
2273 (flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2275 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2280 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2281 * error message code for the caller to propagate upward. Otherwise, returns
2284 * The log message mentions 'msg_type'. */
2286 reject_slave_controller(struct ofconn *ofconn)
2288 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2289 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
2290 return OFPERR_OFPBRC_EPERM;
2297 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2299 struct ofproto *p = ofconn_get_ofproto(ofconn);
2300 struct ofputil_packet_out po;
2301 struct ofpbuf *payload;
2302 uint64_t ofpacts_stub[1024 / 8];
2303 struct ofpbuf ofpacts;
2307 COVERAGE_INC(ofproto_packet_out);
2309 error = reject_slave_controller(ofconn);
2314 /* Decode message. */
2315 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2316 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2318 goto exit_free_ofpacts;
2320 if (po.in_port >= p->max_ports && po.in_port < OFPP_MAX) {
2321 error = OFPERR_OFPBRC_BAD_PORT;
2322 goto exit_free_ofpacts;
2327 if (po.buffer_id != UINT32_MAX) {
2328 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2329 if (error || !payload) {
2330 goto exit_free_ofpacts;
2333 payload = xmalloc(sizeof *payload);
2334 ofpbuf_use_const(payload, po.packet, po.packet_len);
2337 /* Verify actions against packet, then send packet if successful. */
2338 flow_extract(payload, 0, NULL, po.in_port, &flow);
2339 error = ofpacts_check(po.ofpacts, po.ofpacts_len, &flow, p->max_ports);
2341 error = p->ofproto_class->packet_out(p, payload, &flow,
2342 po.ofpacts, po.ofpacts_len);
2344 ofpbuf_delete(payload);
2347 ofpbuf_uninit(&ofpacts);
2353 update_port_config(struct ofport *port,
2354 enum ofputil_port_config config,
2355 enum ofputil_port_config mask)
2357 enum ofputil_port_config old_config = port->pp.config;
2358 enum ofputil_port_config toggle;
2360 toggle = (config ^ port->pp.config) & mask;
2361 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2362 if (config & OFPUTIL_PC_PORT_DOWN) {
2363 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2365 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2367 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2370 port->pp.config ^= toggle;
2371 if (port->pp.config != old_config) {
2372 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2377 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2379 struct ofproto *p = ofconn_get_ofproto(ofconn);
2380 struct ofputil_port_mod pm;
2381 struct ofport *port;
2384 error = reject_slave_controller(ofconn);
2389 error = ofputil_decode_port_mod(oh, &pm);
2394 port = ofproto_get_port(p, pm.port_no);
2396 return OFPERR_OFPPMFC_BAD_PORT;
2397 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2398 return OFPERR_OFPPMFC_BAD_HW_ADDR;
2400 update_port_config(port, pm.config, pm.mask);
2402 netdev_set_advertisements(port->netdev, pm.advertise);
2409 handle_desc_stats_request(struct ofconn *ofconn,
2410 const struct ofp_header *request)
2412 struct ofproto *p = ofconn_get_ofproto(ofconn);
2413 struct ofp_desc_stats *ods;
2416 msg = ofpraw_alloc_stats_reply(request, 0);
2417 ods = ofpbuf_put_zeros(msg, sizeof *ods);
2418 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
2419 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
2420 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
2421 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
2422 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
2423 ofconn_send_reply(ofconn, msg);
2429 handle_table_stats_request(struct ofconn *ofconn,
2430 const struct ofp_header *request)
2432 struct ofproto *p = ofconn_get_ofproto(ofconn);
2433 struct ofp12_table_stats *ots;
2438 /* Set up default values.
2440 * ofp12_table_stats is used as a generic structure as
2441 * it is able to hold all the fields for ofp10_table_stats
2442 * and ofp11_table_stats (and of course itself).
2444 ots = xcalloc(p->n_tables, sizeof *ots);
2445 for (i = 0; i < p->n_tables; i++) {
2446 ots[i].table_id = i;
2447 sprintf(ots[i].name, "table%zu", i);
2448 ots[i].match = htonll(OFPXMT12_MASK);
2449 ots[i].wildcards = htonll(OFPXMT12_MASK);
2450 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2451 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2452 ots[i].write_setfields = htonll(OFPXMT12_MASK);
2453 ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2454 ots[i].metadata_match = htonll(UINT64_MAX);
2455 ots[i].metadata_write = htonll(UINT64_MAX);
2456 ots[i].instructions = htonl(OFPIT11_ALL);
2457 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2458 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2459 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2462 p->ofproto_class->get_tables(p, ots);
2464 /* Post-process the tables, dropping hidden tables. */
2465 n_tables = p->n_tables;
2466 for (i = 0; i < p->n_tables; i++) {
2467 const struct oftable *table = &p->tables[i];
2469 if (table->flags & OFTABLE_HIDDEN) {
2475 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2478 if (table->max_flows < ntohl(ots[i].max_entries)) {
2479 ots[i].max_entries = htonl(table->max_flows);
2483 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2484 ofconn_send_reply(ofconn, msg);
2492 append_port_stat(struct ofport *port, struct list *replies)
2494 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2496 /* Intentionally ignore return value, since errors will set
2497 * 'stats' to all-1s, which is correct for OpenFlow, and
2498 * netdev_get_stats() will log errors. */
2499 ofproto_port_get_stats(port, &ops.stats);
2501 ofputil_append_port_stat(replies, &ops);
2505 handle_port_stats_request(struct ofconn *ofconn,
2506 const struct ofp_header *request)
2508 struct ofproto *p = ofconn_get_ofproto(ofconn);
2509 struct ofport *port;
2510 struct list replies;
2514 error = ofputil_decode_port_stats_request(request, &port_no);
2519 ofpmp_init(&replies, request);
2520 if (port_no != OFPP_NONE) {
2521 port = ofproto_get_port(p, port_no);
2523 append_port_stat(port, &replies);
2526 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2527 append_port_stat(port, &replies);
2531 ofconn_send_replies(ofconn, &replies);
2536 handle_port_desc_stats_request(struct ofconn *ofconn,
2537 const struct ofp_header *request)
2539 struct ofproto *p = ofconn_get_ofproto(ofconn);
2540 enum ofp_version version;
2541 struct ofport *port;
2542 struct list replies;
2544 ofpmp_init(&replies, request);
2546 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2547 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2548 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2551 ofconn_send_replies(ofconn, &replies);
2556 calc_flow_duration__(long long int start, long long int now,
2557 uint32_t *sec, uint32_t *nsec)
2559 long long int msecs = now - start;
2560 *sec = msecs / 1000;
2561 *nsec = (msecs % 1000) * (1000 * 1000);
2564 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2565 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2567 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2569 return (table_id == 0xff || table_id < ofproto->n_tables
2571 : OFPERR_OFPBRC_BAD_TABLE_ID);
2575 static struct oftable *
2576 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2578 struct oftable *table;
2580 for (table = &ofproto->tables[table_id];
2581 table < &ofproto->tables[ofproto->n_tables];
2583 if (!(table->flags & OFTABLE_HIDDEN)) {
2591 static struct oftable *
2592 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2594 if (table_id == 0xff) {
2595 return next_visible_table(ofproto, 0);
2596 } else if (table_id < ofproto->n_tables) {
2597 return &ofproto->tables[table_id];
2603 static struct oftable *
2604 next_matching_table(const struct ofproto *ofproto,
2605 const struct oftable *table, uint8_t table_id)
2607 return (table_id == 0xff
2608 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2612 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2614 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2615 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2617 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2618 * only once, for that table. (This can be used to access tables marked
2621 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2622 * entered at all. (Perhaps you should have validated TABLE_ID with
2623 * check_table_id().)
2625 * All parameters are evaluated multiple times.
2627 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2628 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2630 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2632 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2633 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2634 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2637 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2638 * to 'out_port' are included.
2640 * Hidden rules are always omitted.
2642 * Returns 0 on success, otherwise an OpenFlow error code. */
2644 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2645 const struct match *match,
2646 ovs_be64 cookie, ovs_be64 cookie_mask,
2647 uint16_t out_port, struct list *rules)
2649 struct oftable *table;
2653 error = check_table_id(ofproto, table_id);
2659 cls_rule_init(&cr, match, 0);
2660 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2661 struct cls_cursor cursor;
2664 cls_cursor_init(&cursor, &table->cls, &cr);
2665 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2666 if (rule->pending) {
2667 error = OFPROTO_POSTPONE;
2670 if (!ofproto_rule_is_hidden(rule)
2671 && ofproto_rule_has_out_port(rule, out_port)
2672 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2673 list_push_back(rules, &rule->ofproto_node);
2679 cls_rule_destroy(&cr);
2683 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2684 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2685 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2688 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2689 * to 'out_port' are included.
2691 * Hidden rules are always omitted.
2693 * Returns 0 on success, otherwise an OpenFlow error code. */
2695 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2696 const struct match *match, unsigned int priority,
2697 ovs_be64 cookie, ovs_be64 cookie_mask,
2698 uint16_t out_port, struct list *rules)
2700 struct oftable *table;
2704 error = check_table_id(ofproto, table_id);
2710 cls_rule_init(&cr, match, priority);
2711 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2714 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2717 if (rule->pending) {
2718 error = OFPROTO_POSTPONE;
2721 if (!ofproto_rule_is_hidden(rule)
2722 && ofproto_rule_has_out_port(rule, out_port)
2723 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2724 list_push_back(rules, &rule->ofproto_node);
2730 cls_rule_destroy(&cr);
2734 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2735 * forced into the range of a uint16_t. */
2737 age_secs(long long int age_ms)
2739 return (age_ms < 0 ? 0
2740 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
2741 : (unsigned int) age_ms / 1000);
2745 handle_flow_stats_request(struct ofconn *ofconn,
2746 const struct ofp_header *request)
2748 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2749 struct ofputil_flow_stats_request fsr;
2750 struct list replies;
2755 error = ofputil_decode_flow_stats_request(&fsr, request);
2760 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2761 fsr.cookie, fsr.cookie_mask,
2762 fsr.out_port, &rules);
2767 ofpmp_init(&replies, request);
2768 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2769 long long int now = time_msec();
2770 struct ofputil_flow_stats fs;
2772 minimatch_expand(&rule->cr.match, &fs.match);
2773 fs.priority = rule->cr.priority;
2774 fs.cookie = rule->flow_cookie;
2775 fs.table_id = rule->table_id;
2776 calc_flow_duration__(rule->created, now, &fs.duration_sec,
2778 fs.idle_timeout = rule->idle_timeout;
2779 fs.hard_timeout = rule->hard_timeout;
2780 fs.idle_age = age_secs(now - rule->used);
2781 fs.hard_age = age_secs(now - rule->modified);
2782 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2784 fs.ofpacts = rule->ofpacts;
2785 fs.ofpacts_len = rule->ofpacts_len;
2786 ofputil_append_flow_stats_reply(&fs, &replies);
2788 ofconn_send_replies(ofconn, &replies);
2794 flow_stats_ds(struct rule *rule, struct ds *results)
2796 uint64_t packet_count, byte_count;
2798 rule->ofproto->ofproto_class->rule_get_stats(rule,
2799 &packet_count, &byte_count);
2801 if (rule->table_id != 0) {
2802 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2804 ds_put_format(results, "duration=%llds, ",
2805 (time_msec() - rule->created) / 1000);
2806 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2807 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2808 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2809 cls_rule_format(&rule->cr, results);
2810 ds_put_char(results, ',');
2811 if (rule->ofpacts_len > 0) {
2812 ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
2814 ds_put_cstr(results, "drop");
2816 ds_put_cstr(results, "\n");
2819 /* Adds a pretty-printed description of all flows to 'results', including
2820 * hidden flows (e.g., set up by in-band control). */
2822 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2824 struct oftable *table;
2826 OFPROTO_FOR_EACH_TABLE (table, p) {
2827 struct cls_cursor cursor;
2830 cls_cursor_init(&cursor, &table->cls, NULL);
2831 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2832 flow_stats_ds(rule, results);
2837 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2838 * '*engine_type' and '*engine_id', respectively. */
2840 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2841 uint8_t *engine_type, uint8_t *engine_id)
2843 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2846 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns a
2847 * bitmask of 'cfm_fault_reason's to indicate a CFM fault (generally
2848 * indicating a connectivity problem). Returns zero if CFM is not faulted,
2849 * and -1 if CFM is not enabled on 'ofp_port'. */
2851 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2853 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2854 return (ofport && ofproto->ofproto_class->get_cfm_fault
2855 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2859 /* Checks the operational status reported by the remote CFM endpoint of
2860 * 'ofp_port' Returns 1 if operationally up, 0 if operationally down, and -1
2861 * if CFM is not enabled on 'ofp_port' or does not support operational status.
2864 ofproto_port_get_cfm_opup(const struct ofproto *ofproto, uint16_t ofp_port)
2866 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2867 return (ofport && ofproto->ofproto_class->get_cfm_opup
2868 ? ofproto->ofproto_class->get_cfm_opup(ofport)
2872 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2873 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2874 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2875 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2877 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2878 uint16_t ofp_port, const uint64_t **rmps,
2881 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2885 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2886 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2891 /* Checks the health of the CFM for 'ofp_port' within 'ofproto'. Returns an
2892 * integer value between 0 and 100 to indicate the health of the port as a
2893 * percentage which is the average of cfm health of all the remote_mpids or
2894 * returns -1 if CFM is not enabled on 'ofport'. */
2896 ofproto_port_get_cfm_health(const struct ofproto *ofproto, uint16_t ofp_port)
2898 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2899 return (ofport && ofproto->ofproto_class->get_cfm_health
2900 ? ofproto->ofproto_class->get_cfm_health(ofport)
2905 handle_aggregate_stats_request(struct ofconn *ofconn,
2906 const struct ofp_header *oh)
2908 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2909 struct ofputil_flow_stats_request request;
2910 struct ofputil_aggregate_stats stats;
2911 bool unknown_packets, unknown_bytes;
2912 struct ofpbuf *reply;
2917 error = ofputil_decode_flow_stats_request(&request, oh);
2922 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2923 request.cookie, request.cookie_mask,
2924 request.out_port, &rules);
2929 memset(&stats, 0, sizeof stats);
2930 unknown_packets = unknown_bytes = false;
2931 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2932 uint64_t packet_count;
2933 uint64_t byte_count;
2935 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2938 if (packet_count == UINT64_MAX) {
2939 unknown_packets = true;
2941 stats.packet_count += packet_count;
2944 if (byte_count == UINT64_MAX) {
2945 unknown_bytes = true;
2947 stats.byte_count += byte_count;
2952 if (unknown_packets) {
2953 stats.packet_count = UINT64_MAX;
2955 if (unknown_bytes) {
2956 stats.byte_count = UINT64_MAX;
2959 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
2960 ofconn_send_reply(ofconn, reply);
2965 struct queue_stats_cbdata {
2966 struct ofport *ofport;
2967 struct list replies;
2971 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2972 const struct netdev_queue_stats *stats)
2975 struct ofputil_queue_stats oqs = {
2976 .port_no = cbdata->ofport->pp.port_no,
2977 .queue_id = queue_id,
2980 ofputil_append_queue_stat(&cbdata->replies, &oqs);
2984 handle_queue_stats_dump_cb(uint32_t queue_id,
2985 struct netdev_queue_stats *stats,
2988 struct queue_stats_cbdata *cbdata = cbdata_;
2990 put_queue_stats(cbdata, queue_id, stats);
2994 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2995 struct queue_stats_cbdata *cbdata)
2997 cbdata->ofport = port;
2998 if (queue_id == OFPQ_ALL) {
2999 netdev_dump_queue_stats(port->netdev,
3000 handle_queue_stats_dump_cb, cbdata);
3002 struct netdev_queue_stats stats;
3004 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3005 put_queue_stats(cbdata, queue_id, &stats);
3007 return OFPERR_OFPQOFC_BAD_QUEUE;
3014 handle_queue_stats_request(struct ofconn *ofconn,
3015 const struct ofp_header *rq)
3017 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3018 struct queue_stats_cbdata cbdata;
3019 struct ofport *port;
3021 struct ofputil_queue_stats_request oqsr;
3023 COVERAGE_INC(ofproto_queue_req);
3025 ofpmp_init(&cbdata.replies, rq);
3027 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3032 if (oqsr.port_no == OFPP_ALL) {
3033 error = OFPERR_OFPQOFC_BAD_QUEUE;
3034 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3035 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3040 port = ofproto_get_port(ofproto, oqsr.port_no);
3042 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3043 : OFPERR_OFPQOFC_BAD_PORT);
3046 ofconn_send_replies(ofconn, &cbdata.replies);
3048 ofpbuf_list_delete(&cbdata.replies);
3055 is_flow_deletion_pending(const struct ofproto *ofproto,
3056 const struct cls_rule *cls_rule,
3059 if (!hmap_is_empty(&ofproto->deletions)) {
3060 struct ofoperation *op;
3062 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3063 cls_rule_hash(cls_rule, table_id),
3064 &ofproto->deletions) {
3065 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3074 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3075 * in which no matching flow already exists in the flow table.
3077 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3078 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3079 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3080 * initiated now but may be retried later.
3082 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
3083 * ownership remains with the caller.
3085 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3088 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3089 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
3091 struct oftable *table;
3092 struct ofopgroup *group;
3093 struct rule *victim;
3098 error = check_table_id(ofproto, fm->table_id);
3104 if (fm->table_id == 0xff) {
3106 if (ofproto->ofproto_class->rule_choose_table) {
3107 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3113 assert(table_id < ofproto->n_tables);
3114 table = &ofproto->tables[table_id];
3116 table = &ofproto->tables[0];
3118 } else if (fm->table_id < ofproto->n_tables) {
3119 table = &ofproto->tables[fm->table_id];
3121 return OFPERR_OFPBRC_BAD_TABLE_ID;
3124 if (table->flags & OFTABLE_READONLY) {
3125 return OFPERR_OFPBRC_EPERM;
3128 /* Allocate new rule and initialize classifier rule. */
3129 rule = ofproto->ofproto_class->rule_alloc();
3131 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3132 ofproto->name, strerror(error));
3135 cls_rule_init(&rule->cr, &fm->match, fm->priority);
3137 /* Serialize against pending deletion. */
3138 if (is_flow_deletion_pending(ofproto, &cr, table - ofproto->tables)) {
3139 cls_rule_destroy(&rule->cr);
3140 ofproto->ofproto_class->rule_dealloc(rule);
3141 return OFPROTO_POSTPONE;
3144 /* Check for overlap, if requested. */
3145 if (fm->flags & OFPFF_CHECK_OVERLAP
3146 && classifier_rule_overlaps(&table->cls, &rule->cr)) {
3147 cls_rule_destroy(&rule->cr);
3148 ofproto->ofproto_class->rule_dealloc(rule);
3149 return OFPERR_OFPFMFC_OVERLAP;
3152 rule->ofproto = ofproto;
3153 rule->pending = NULL;
3154 rule->flow_cookie = fm->new_cookie;
3155 rule->created = rule->modified = rule->used = time_msec();
3156 rule->idle_timeout = fm->idle_timeout;
3157 rule->hard_timeout = fm->hard_timeout;
3158 rule->table_id = table - ofproto->tables;
3159 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
3160 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3161 rule->ofpacts_len = fm->ofpacts_len;
3162 rule->evictable = true;
3163 rule->eviction_group = NULL;
3164 rule->monitor_flags = 0;
3165 rule->add_seqno = 0;
3166 rule->modify_seqno = 0;
3168 /* Insert new rule. */
3169 victim = oftable_replace_rule(rule);
3170 if (victim && !rule_is_modifiable(victim)) {
3171 error = OFPERR_OFPBRC_EPERM;
3172 } else if (victim && victim->pending) {
3173 error = OFPROTO_POSTPONE;
3175 struct ofoperation *op;
3178 if (classifier_count(&table->cls) > table->max_flows) {
3181 was_evictable = rule->evictable;
3182 rule->evictable = false;
3183 evict = choose_rule_to_evict(table);
3184 rule->evictable = was_evictable;
3187 error = OFPERR_OFPFMFC_TABLE_FULL;
3189 } else if (evict->pending) {
3190 error = OFPROTO_POSTPONE;
3197 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3198 op = ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3199 op->victim = victim;
3201 error = ofproto->ofproto_class->rule_construct(rule);
3203 op->group->n_running--;
3204 ofoperation_destroy(rule->pending);
3206 delete_flow__(evict, group);
3208 ofopgroup_submit(group);
3212 /* Back out if an error occurred. */
3214 oftable_substitute_rule(rule, victim);
3215 ofproto_rule_destroy__(rule);
3220 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3222 /* Modifies the rules listed in 'rules', changing their actions to match those
3225 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3228 * Returns 0 on success, otherwise an OpenFlow error code. */
3230 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3231 const struct ofputil_flow_mod *fm,
3232 const struct ofp_header *request, struct list *rules)
3234 struct ofopgroup *group;
3238 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3239 error = OFPERR_OFPBRC_EPERM;
3240 LIST_FOR_EACH (rule, ofproto_node, rules) {
3241 struct ofoperation *op;
3242 bool actions_changed;
3243 ovs_be64 new_cookie;
3245 if (rule_is_modifiable(rule)) {
3246 /* At least one rule is modifiable, don't report EPERM error. */
3252 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3253 rule->ofpacts, rule->ofpacts_len);
3254 new_cookie = (fm->new_cookie != htonll(UINT64_MAX)
3256 : rule->flow_cookie);
3257 if (!actions_changed && new_cookie == rule->flow_cookie) {
3258 /* No change at all. */
3262 op = ofoperation_create(group, rule, OFOPERATION_MODIFY, 0);
3263 rule->flow_cookie = new_cookie;
3264 if (actions_changed) {
3265 op->ofpacts = rule->ofpacts;
3266 op->ofpacts_len = rule->ofpacts_len;
3267 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3268 rule->ofpacts_len = fm->ofpacts_len;
3269 rule->ofproto->ofproto_class->rule_modify_actions(rule);
3271 ofoperation_complete(op, 0);
3274 ofopgroup_submit(group);
3280 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3281 const struct ofputil_flow_mod *fm,
3282 const struct ofp_header *request)
3284 if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3287 return add_flow(ofproto, ofconn, fm, request);
3290 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3293 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3296 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3297 const struct ofputil_flow_mod *fm,
3298 const struct ofp_header *request)
3303 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3304 fm->cookie, fm->cookie_mask,
3308 } else if (list_is_empty(&rules)) {
3309 return modify_flows_add(ofproto, ofconn, fm, request);
3311 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3315 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3318 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3321 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3322 const struct ofputil_flow_mod *fm,
3323 const struct ofp_header *request)
3328 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3329 fm->priority, fm->cookie, fm->cookie_mask,
3334 } else if (list_is_empty(&rules)) {
3335 return modify_flows_add(ofproto, ofconn, fm, request);
3337 return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3338 fm, request, &rules)
3343 /* OFPFC_DELETE implementation. */
3346 delete_flow__(struct rule *rule, struct ofopgroup *group)
3348 struct ofproto *ofproto = rule->ofproto;
3350 ofproto_rule_send_removed(rule, OFPRR_DELETE);
3352 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
3353 oftable_remove_rule(rule);
3354 ofproto->ofproto_class->rule_destruct(rule);
3357 /* Deletes the rules listed in 'rules'.
3359 * Returns 0 on success, otherwise an OpenFlow error code. */
3361 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3362 const struct ofp_header *request, struct list *rules)
3364 struct rule *rule, *next;
3365 struct ofopgroup *group;
3367 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3368 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3369 delete_flow__(rule, group);
3371 ofopgroup_submit(group);
3376 /* Implements OFPFC_DELETE. */
3378 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3379 const struct ofputil_flow_mod *fm,
3380 const struct ofp_header *request)
3385 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3386 fm->cookie, fm->cookie_mask,
3387 fm->out_port, &rules);
3388 return (error ? error
3389 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3394 /* Implements OFPFC_DELETE_STRICT. */
3396 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3397 const struct ofputil_flow_mod *fm,
3398 const struct ofp_header *request)
3403 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3404 fm->priority, fm->cookie, fm->cookie_mask,
3405 fm->out_port, &rules);
3406 return (error ? error
3407 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3413 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3415 struct ofputil_flow_removed fr;
3417 if (ofproto_rule_is_hidden(rule) || !rule->send_flow_removed) {
3421 minimatch_expand(&rule->cr.match, &fr.match);
3422 fr.priority = rule->cr.priority;
3423 fr.cookie = rule->flow_cookie;
3425 fr.table_id = rule->table_id;
3426 calc_flow_duration__(rule->created, time_msec(),
3427 &fr.duration_sec, &fr.duration_nsec);
3428 fr.idle_timeout = rule->idle_timeout;
3429 fr.hard_timeout = rule->hard_timeout;
3430 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3433 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3437 ofproto_rule_update_used(struct rule *rule, long long int used)
3439 if (used > rule->used) {
3440 struct eviction_group *evg = rule->eviction_group;
3444 heap_change(&evg->rules, &rule->evg_node,
3445 rule_eviction_priority(rule));
3450 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3451 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3454 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3457 * ofproto implementation ->run() functions should use this function to expire
3458 * OpenFlow flows. */
3460 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3462 struct ofproto *ofproto = rule->ofproto;
3463 struct ofopgroup *group;
3465 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
3467 ofproto_rule_send_removed(rule, reason);
3469 group = ofopgroup_create_unattached(ofproto);
3470 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3471 oftable_remove_rule(rule);
3472 ofproto->ofproto_class->rule_destruct(rule);
3473 ofopgroup_submit(group);
3477 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3479 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3480 struct ofputil_flow_mod fm;
3481 uint64_t ofpacts_stub[1024 / 8];
3482 struct ofpbuf ofpacts;
3486 error = reject_slave_controller(ofconn);
3491 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3492 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3495 goto exit_free_ofpacts;
3498 if (fm.flags & OFPFF10_EMERG) {
3499 /* We do not support the OpenFlow 1.0 emergency flow cache, which
3500 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
3501 * There is no good error code, so just state that the flow table
3503 error = OFPERR_OFPFMFC_TABLE_FULL;
3506 error = ofpacts_check(fm.ofpacts, fm.ofpacts_len,
3507 &fm.match.flow, ofproto->max_ports);
3510 error = handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
3513 goto exit_free_ofpacts;
3516 /* Record the operation for logging a summary report. */
3517 switch (fm.command) {
3523 case OFPFC_MODIFY_STRICT:
3524 ofproto->n_modify++;
3528 case OFPFC_DELETE_STRICT:
3529 ofproto->n_delete++;
3534 if (ofproto->next_op_report == LLONG_MAX) {
3535 ofproto->first_op = now;
3536 ofproto->next_op_report = MAX(now + 10 * 1000,
3537 ofproto->op_backoff);
3538 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
3540 ofproto->last_op = now;
3543 ofpbuf_uninit(&ofpacts);
3549 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3550 const struct ofputil_flow_mod *fm,
3551 const struct ofp_header *oh)
3553 if (ofproto->n_pending >= 50) {
3554 assert(!list_is_empty(&ofproto->pending));
3555 return OFPROTO_POSTPONE;
3558 switch (fm->command) {
3560 return add_flow(ofproto, ofconn, fm, oh);
3563 return modify_flows_loose(ofproto, ofconn, fm, oh);
3565 case OFPFC_MODIFY_STRICT:
3566 return modify_flow_strict(ofproto, ofconn, fm, oh);
3569 return delete_flows_loose(ofproto, ofconn, fm, oh);
3571 case OFPFC_DELETE_STRICT:
3572 return delete_flow_strict(ofproto, ofconn, fm, oh);
3575 if (fm->command > 0xff) {
3576 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
3577 "flow_mod_table_id extension is not enabled",
3580 return OFPERR_OFPFMFC_BAD_COMMAND;
3585 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
3587 const struct nx_role_request *nrr = ofpmsg_body(oh);
3588 struct nx_role_request *reply;
3592 role = ntohl(nrr->role);
3593 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
3594 && role != NX_ROLE_SLAVE) {
3595 return OFPERR_OFPRRFC_BAD_ROLE;
3598 if (ofconn_get_role(ofconn) != role
3599 && ofconn_has_pending_opgroups(ofconn)) {
3600 return OFPROTO_POSTPONE;
3603 ofconn_set_role(ofconn, role);
3605 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, oh, 0);
3606 reply = ofpbuf_put_zeros(buf, sizeof *reply);
3607 reply->role = htonl(role);
3608 ofconn_send_reply(ofconn, buf);
3614 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
3615 const struct ofp_header *oh)
3617 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
3618 enum ofputil_protocol cur, next;
3620 cur = ofconn_get_protocol(ofconn);
3621 next = ofputil_protocol_set_tid(cur, msg->set != 0);
3622 ofconn_set_protocol(ofconn, next);
3628 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
3630 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
3631 enum ofputil_protocol cur, next;
3632 enum ofputil_protocol next_base;
3634 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
3636 return OFPERR_OFPBRC_EPERM;
3639 cur = ofconn_get_protocol(ofconn);
3640 next = ofputil_protocol_set_base(cur, next_base);
3641 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
3642 /* Avoid sending async messages in surprising protocol. */
3643 return OFPROTO_POSTPONE;
3646 ofconn_set_protocol(ofconn, next);
3651 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
3652 const struct ofp_header *oh)
3654 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
3657 format = ntohl(msg->format);
3658 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
3659 return OFPERR_OFPBRC_EPERM;
3662 if (format != ofconn_get_packet_in_format(ofconn)
3663 && ofconn_has_pending_opgroups(ofconn)) {
3664 /* Avoid sending async message in surprsing packet in format. */
3665 return OFPROTO_POSTPONE;
3668 ofconn_set_packet_in_format(ofconn, format);
3673 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
3675 const struct nx_async_config *msg = ofpmsg_body(oh);
3676 uint32_t master[OAM_N_TYPES];
3677 uint32_t slave[OAM_N_TYPES];
3679 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
3680 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
3681 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
3683 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
3684 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
3685 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
3687 ofconn_set_async_config(ofconn, master, slave);
3688 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
3689 !ofconn_get_miss_send_len(ofconn)) {
3690 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
3697 handle_nxt_set_controller_id(struct ofconn *ofconn,
3698 const struct ofp_header *oh)
3700 const struct nx_controller_id *nci = ofpmsg_body(oh);
3702 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
3703 return OFPERR_NXBRC_MUST_BE_ZERO;
3706 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
3711 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
3715 if (ofconn_has_pending_opgroups(ofconn)) {
3716 return OFPROTO_POSTPONE;
3719 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
3720 ? OFPRAW_OFPT10_BARRIER_REPLY
3721 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
3722 ofconn_send_reply(ofconn, buf);
3727 ofproto_compose_flow_refresh_update(const struct rule *rule,
3728 enum nx_flow_monitor_flags flags,
3731 struct ofoperation *op = rule->pending;
3732 struct ofputil_flow_update fu;
3735 if (op && op->type == OFOPERATION_ADD && !op->victim) {
3736 /* We'll report the final flow when the operation completes. Reporting
3737 * it now would cause a duplicate report later. */
3741 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
3742 ? NXFME_ADDED : NXFME_MODIFIED);
3744 fu.idle_timeout = rule->idle_timeout;
3745 fu.hard_timeout = rule->hard_timeout;
3746 fu.table_id = rule->table_id;
3747 fu.cookie = rule->flow_cookie;
3748 minimatch_expand(&rule->cr.match, &match);
3750 fu.priority = rule->cr.priority;
3751 if (!(flags & NXFMF_ACTIONS)) {
3755 fu.ofpacts = rule->ofpacts;
3756 fu.ofpacts_len = rule->ofpacts_len;
3758 /* An operation is in progress. Use the previous version of the flow's
3759 * actions, so that when the operation commits we report the change. */
3761 case OFOPERATION_ADD:
3762 /* We already verified that there was a victim. */
3763 fu.ofpacts = op->victim->ofpacts;
3764 fu.ofpacts_len = op->victim->ofpacts_len;
3767 case OFOPERATION_MODIFY:
3769 fu.ofpacts = op->ofpacts;
3770 fu.ofpacts_len = op->ofpacts_len;
3772 fu.ofpacts = rule->ofpacts;
3773 fu.ofpacts_len = rule->ofpacts_len;
3777 case OFOPERATION_DELETE:
3778 fu.ofpacts = rule->ofpacts;
3779 fu.ofpacts_len = rule->ofpacts_len;
3787 if (list_is_empty(msgs)) {
3788 ofputil_start_flow_update(msgs);
3790 ofputil_append_flow_update(&fu, msgs);
3794 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
3798 LIST_FOR_EACH (rule, ofproto_node, rules) {
3799 enum nx_flow_monitor_flags flags = rule->monitor_flags;
3800 rule->monitor_flags = 0;
3802 ofproto_compose_flow_refresh_update(rule, flags, msgs);
3807 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
3808 struct rule *rule, uint64_t seqno,
3811 enum nx_flow_monitor_flags update;
3813 if (ofproto_rule_is_hidden(rule)) {
3818 ? ofoperation_has_out_port(rule->pending, m->out_port)
3819 : ofproto_rule_has_out_port(rule, m->out_port))) {
3824 if (rule->add_seqno > seqno) {
3825 update = NXFMF_ADD | NXFMF_MODIFY;
3826 } else if (rule->modify_seqno > seqno) {
3827 update = NXFMF_MODIFY;
3832 if (!(m->flags & update)) {
3836 update = NXFMF_INITIAL;
3839 if (!rule->monitor_flags) {
3840 list_push_back(rules, &rule->ofproto_node);
3842 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
3846 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
3850 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
3851 const struct ofoperation *op;
3852 const struct oftable *table;
3853 struct cls_rule target;
3855 cls_rule_init_from_minimatch(&target, &m->match, 0);
3856 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
3857 struct cls_cursor cursor;
3860 cls_cursor_init(&cursor, &table->cls, &target);
3861 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3862 assert(!rule->pending); /* XXX */
3863 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3867 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
3868 struct rule *rule = op->rule;
3870 if (((m->table_id == 0xff
3871 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
3872 : m->table_id == rule->table_id))
3873 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
3874 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3877 cls_rule_destroy(&target);
3881 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
3884 if (m->flags & NXFMF_INITIAL) {
3885 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
3890 ofmonitor_collect_resume_rules(struct ofmonitor *m,
3891 uint64_t seqno, struct list *rules)
3893 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
3897 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
3899 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3900 struct ofmonitor **monitors;
3901 size_t n_monitors, allocated_monitors;
3902 struct list replies;
3909 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3911 n_monitors = allocated_monitors = 0;
3913 struct ofputil_flow_monitor_request request;
3914 struct ofmonitor *m;
3917 retval = ofputil_decode_flow_monitor_request(&request, &b);
3918 if (retval == EOF) {
3920 } else if (retval) {
3925 if (request.table_id != 0xff
3926 && request.table_id >= ofproto->n_tables) {
3927 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3931 error = ofmonitor_create(&request, ofconn, &m);
3936 if (n_monitors >= allocated_monitors) {
3937 monitors = x2nrealloc(monitors, &allocated_monitors,
3940 monitors[n_monitors++] = m;
3944 for (i = 0; i < n_monitors; i++) {
3945 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
3948 ofpmp_init(&replies, oh);
3949 ofmonitor_compose_refresh_updates(&rules, &replies);
3950 ofconn_send_replies(ofconn, &replies);
3957 for (i = 0; i < n_monitors; i++) {
3958 ofmonitor_destroy(monitors[i]);
3965 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
3967 struct ofmonitor *m;
3970 id = ofputil_decode_flow_monitor_cancel(oh);
3971 m = ofmonitor_lookup(ofconn, id);
3973 return OFPERR_NXBRC_FM_BAD_ID;
3976 ofmonitor_destroy(m);
3981 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
3983 const struct ofp_header *oh = msg->data;
3987 error = ofptype_decode(&type, oh);
3993 /* OpenFlow requests. */
3994 case OFPTYPE_ECHO_REQUEST:
3995 return handle_echo_request(ofconn, oh);
3997 case OFPTYPE_FEATURES_REQUEST:
3998 return handle_features_request(ofconn, oh);
4000 case OFPTYPE_GET_CONFIG_REQUEST:
4001 return handle_get_config_request(ofconn, oh);
4003 case OFPTYPE_SET_CONFIG:
4004 return handle_set_config(ofconn, oh);
4006 case OFPTYPE_PACKET_OUT:
4007 return handle_packet_out(ofconn, oh);
4009 case OFPTYPE_PORT_MOD:
4010 return handle_port_mod(ofconn, oh);
4012 case OFPTYPE_FLOW_MOD:
4013 return handle_flow_mod(ofconn, oh);
4015 case OFPTYPE_BARRIER_REQUEST:
4016 return handle_barrier_request(ofconn, oh);
4018 /* OpenFlow replies. */
4019 case OFPTYPE_ECHO_REPLY:
4022 /* Nicira extension requests. */
4023 case OFPTYPE_ROLE_REQUEST:
4024 return handle_role_request(ofconn, oh);
4026 case OFPTYPE_FLOW_MOD_TABLE_ID:
4027 return handle_nxt_flow_mod_table_id(ofconn, oh);
4029 case OFPTYPE_SET_FLOW_FORMAT:
4030 return handle_nxt_set_flow_format(ofconn, oh);
4032 case OFPTYPE_SET_PACKET_IN_FORMAT:
4033 return handle_nxt_set_packet_in_format(ofconn, oh);
4035 case OFPTYPE_SET_CONTROLLER_ID:
4036 return handle_nxt_set_controller_id(ofconn, oh);
4038 case OFPTYPE_FLOW_AGE:
4039 /* Nothing to do. */
4042 case OFPTYPE_FLOW_MONITOR_CANCEL:
4043 return handle_flow_monitor_cancel(ofconn, oh);
4045 case OFPTYPE_SET_ASYNC_CONFIG:
4046 return handle_nxt_set_async_config(ofconn, oh);
4048 /* Statistics requests. */
4049 case OFPTYPE_DESC_STATS_REQUEST:
4050 return handle_desc_stats_request(ofconn, oh);
4052 case OFPTYPE_FLOW_STATS_REQUEST:
4053 return handle_flow_stats_request(ofconn, oh);
4055 case OFPTYPE_AGGREGATE_STATS_REQUEST:
4056 return handle_aggregate_stats_request(ofconn, oh);
4058 case OFPTYPE_TABLE_STATS_REQUEST:
4059 return handle_table_stats_request(ofconn, oh);
4061 case OFPTYPE_PORT_STATS_REQUEST:
4062 return handle_port_stats_request(ofconn, oh);
4064 case OFPTYPE_QUEUE_STATS_REQUEST:
4065 return handle_queue_stats_request(ofconn, oh);
4067 case OFPTYPE_PORT_DESC_STATS_REQUEST:
4068 return handle_port_desc_stats_request(ofconn, oh);
4070 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
4071 return handle_flow_monitor_request(ofconn, oh);
4075 case OFPTYPE_FEATURES_REPLY:
4076 case OFPTYPE_GET_CONFIG_REPLY:
4077 case OFPTYPE_PACKET_IN:
4078 case OFPTYPE_FLOW_REMOVED:
4079 case OFPTYPE_PORT_STATUS:
4080 case OFPTYPE_BARRIER_REPLY:
4081 case OFPTYPE_DESC_STATS_REPLY:
4082 case OFPTYPE_FLOW_STATS_REPLY:
4083 case OFPTYPE_QUEUE_STATS_REPLY:
4084 case OFPTYPE_PORT_STATS_REPLY:
4085 case OFPTYPE_TABLE_STATS_REPLY:
4086 case OFPTYPE_AGGREGATE_STATS_REPLY:
4087 case OFPTYPE_PORT_DESC_STATS_REPLY:
4088 case OFPTYPE_ROLE_REPLY:
4089 case OFPTYPE_FLOW_MONITOR_PAUSED:
4090 case OFPTYPE_FLOW_MONITOR_RESUMED:
4091 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
4093 return OFPERR_OFPBRC_BAD_TYPE;
4098 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
4100 int error = handle_openflow__(ofconn, ofp_msg);
4101 if (error && error != OFPROTO_POSTPONE) {
4102 ofconn_send_error(ofconn, ofp_msg->data, error);
4104 COVERAGE_INC(ofproto_recv_openflow);
4105 return error != OFPROTO_POSTPONE;
4108 /* Asynchronous operations. */
4110 /* Creates and returns a new ofopgroup that is not associated with any
4111 * OpenFlow connection.
4113 * The caller should add operations to the returned group with
4114 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4115 static struct ofopgroup *
4116 ofopgroup_create_unattached(struct ofproto *ofproto)
4118 struct ofopgroup *group = xzalloc(sizeof *group);
4119 group->ofproto = ofproto;
4120 list_init(&group->ofproto_node);
4121 list_init(&group->ops);
4122 list_init(&group->ofconn_node);
4126 /* Creates and returns a new ofopgroup for 'ofproto'.
4128 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
4129 * connection. The 'request' and 'buffer_id' arguments are ignored.
4131 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
4132 * If the ofopgroup eventually fails, then the error reply will include
4133 * 'request'. If the ofopgroup eventually succeeds, then the packet with
4134 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
4136 * The caller should add operations to the returned group with
4137 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4138 static struct ofopgroup *
4139 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
4140 const struct ofp_header *request, uint32_t buffer_id)
4142 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
4144 size_t request_len = ntohs(request->length);
4146 assert(ofconn_get_ofproto(ofconn) == ofproto);
4148 ofconn_add_opgroup(ofconn, &group->ofconn_node);
4149 group->ofconn = ofconn;
4150 group->request = xmemdup(request, MIN(request_len, 64));
4151 group->buffer_id = buffer_id;
4156 /* Submits 'group' for processing.
4158 * If 'group' contains no operations (e.g. none were ever added, or all of the
4159 * ones that were added completed synchronously), then it is destroyed
4160 * immediately. Otherwise it is added to the ofproto's list of pending
4163 ofopgroup_submit(struct ofopgroup *group)
4165 if (!group->n_running) {
4166 ofopgroup_complete(group);
4168 list_push_back(&group->ofproto->pending, &group->ofproto_node);
4169 group->ofproto->n_pending++;
4174 ofopgroup_complete(struct ofopgroup *group)
4176 struct ofproto *ofproto = group->ofproto;
4178 struct ofconn *abbrev_ofconn;
4179 ovs_be32 abbrev_xid;
4181 struct ofoperation *op, *next_op;
4184 assert(!group->n_running);
4187 LIST_FOR_EACH (op, group_node, &group->ops) {
4194 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
4195 LIST_FOR_EACH (op, group_node, &group->ops) {
4196 if (op->type != OFOPERATION_DELETE) {
4197 struct ofpbuf *packet;
4200 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
4204 error = rule_execute(op->rule, in_port, packet);
4211 if (!error && !list_is_empty(&group->ofconn_node)) {
4212 abbrev_ofconn = group->ofconn;
4213 abbrev_xid = group->request->xid;
4215 abbrev_ofconn = NULL;
4216 abbrev_xid = htonl(0);
4218 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
4219 struct rule *rule = op->rule;
4221 if (!op->error && !ofproto_rule_is_hidden(rule)) {
4222 /* Check that we can just cast from ofoperation_type to
4223 * nx_flow_update_event. */
4224 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_ADD
4226 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_DELETE
4228 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_MODIFY
4231 ofmonitor_report(ofproto->connmgr, rule,
4232 (enum nx_flow_update_event) op->type,
4233 op->reason, abbrev_ofconn, abbrev_xid);
4236 rule->pending = NULL;
4239 case OFOPERATION_ADD:
4243 ofproto_rule_destroy__(op->victim);
4244 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
4245 if (vid_mask == VLAN_VID_MASK) {
4246 if (ofproto->vlan_bitmap) {
4247 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4248 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4249 bitmap_set1(ofproto->vlan_bitmap, vid);
4250 ofproto->vlans_changed = true;
4253 ofproto->vlans_changed = true;
4257 oftable_substitute_rule(rule, op->victim);
4258 ofproto_rule_destroy__(rule);
4262 case OFOPERATION_DELETE:
4264 ofproto_rule_destroy__(rule);
4268 case OFOPERATION_MODIFY:
4270 rule->modified = time_msec();
4272 rule->flow_cookie = op->flow_cookie;
4274 free(rule->ofpacts);
4275 rule->ofpacts = op->ofpacts;
4276 rule->ofpacts_len = op->ofpacts_len;
4278 op->ofpacts_len = 0;
4287 ofoperation_destroy(op);
4290 ofmonitor_flush(ofproto->connmgr);
4292 if (!list_is_empty(&group->ofproto_node)) {
4293 assert(ofproto->n_pending > 0);
4294 ofproto->n_pending--;
4295 list_remove(&group->ofproto_node);
4297 if (!list_is_empty(&group->ofconn_node)) {
4298 list_remove(&group->ofconn_node);
4300 ofconn_send_error(group->ofconn, group->request, error);
4302 connmgr_retry(ofproto->connmgr);
4304 free(group->request);
4308 /* Initiates a new operation on 'rule', of the specified 'type', within
4309 * 'group'. Prior to calling, 'rule' must not have any pending operation.
4311 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4312 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
4314 * Returns the newly created ofoperation (which is also available as
4315 * rule->pending). */
4316 static struct ofoperation *
4317 ofoperation_create(struct ofopgroup *group, struct rule *rule,
4318 enum ofoperation_type type,
4319 enum ofp_flow_removed_reason reason)
4321 struct ofproto *ofproto = group->ofproto;
4322 struct ofoperation *op;
4324 assert(!rule->pending);
4326 op = rule->pending = xzalloc(sizeof *op);
4328 list_push_back(&group->ops, &op->group_node);
4331 op->reason = reason;
4332 op->flow_cookie = rule->flow_cookie;
4336 if (type == OFOPERATION_DELETE) {
4337 hmap_insert(&ofproto->deletions, &op->hmap_node,
4338 cls_rule_hash(&rule->cr, rule->table_id));
4345 ofoperation_destroy(struct ofoperation *op)
4347 struct ofopgroup *group = op->group;
4350 op->rule->pending = NULL;
4352 if (op->type == OFOPERATION_DELETE) {
4353 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
4355 list_remove(&op->group_node);
4360 /* Indicates that 'op' completed with status 'error', which is either 0 to
4361 * indicate success or an OpenFlow error code on failure.
4363 * If 'error' is 0, indicating success, the operation will be committed
4364 * permanently to the flow table. There is one interesting subcase:
4366 * - If 'op' is an "add flow" operation that is replacing an existing rule in
4367 * the flow table (the "victim" rule) by a new one, then the caller must
4368 * have uninitialized any derived state in the victim rule, as in step 5 in
4369 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
4370 * performs steps 6 and 7 for the victim rule, most notably by calling its
4371 * ->rule_dealloc() function.
4373 * If 'error' is nonzero, then generally the operation will be rolled back:
4375 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
4376 * restores the original rule. The caller must have uninitialized any
4377 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
4378 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
4379 * and 7 for the new rule, calling its ->rule_dealloc() function.
4381 * - If 'op' is a "modify flow" operation, ofproto restores the original
4384 * - 'op' must not be a "delete flow" operation. Removing a rule is not
4385 * allowed to fail. It must always succeed.
4387 * Please see the large comment in ofproto/ofproto-provider.h titled
4388 * "Asynchronous Operation Support" for more information. */
4390 ofoperation_complete(struct ofoperation *op, enum ofperr error)
4392 struct ofopgroup *group = op->group;
4394 assert(op->rule->pending == op);
4395 assert(group->n_running > 0);
4396 assert(!error || op->type != OFOPERATION_DELETE);
4399 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
4400 ofopgroup_complete(group);
4405 ofoperation_get_victim(struct ofoperation *op)
4407 assert(op->type == OFOPERATION_ADD);
4412 pick_datapath_id(const struct ofproto *ofproto)
4414 const struct ofport *port;
4416 port = ofproto_get_port(ofproto, OFPP_LOCAL);
4418 uint8_t ea[ETH_ADDR_LEN];
4421 error = netdev_get_etheraddr(port->netdev, ea);
4423 return eth_addr_to_uint64(ea);
4425 VLOG_WARN("%s: could not get MAC address for %s (%s)",
4426 ofproto->name, netdev_get_name(port->netdev),
4429 return ofproto->fallback_dpid;
4433 pick_fallback_dpid(void)
4435 uint8_t ea[ETH_ADDR_LEN];
4436 eth_addr_nicira_random(ea);
4437 return eth_addr_to_uint64(ea);
4440 /* Table overflow policy. */
4442 /* Chooses and returns a rule to evict from 'table'. Returns NULL if the table
4443 * is not configured to evict rules or if the table contains no evictable
4444 * rules. (Rules with 'evictable' set to false or with no timeouts are not
4446 static struct rule *
4447 choose_rule_to_evict(struct oftable *table)
4449 struct eviction_group *evg;
4451 if (!table->eviction_fields) {
4455 /* In the common case, the outer and inner loops here will each be entered
4458 * - The inner loop normally "return"s in its first iteration. If the
4459 * eviction group has any evictable rules, then it always returns in
4462 * - The outer loop only iterates more than once if the largest eviction
4463 * group has no evictable rules.
4465 * - The outer loop can exit only if table's 'max_flows' is all filled up
4466 * by unevictable rules'. */
4467 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
4470 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
4471 if (rule->evictable) {
4480 /* Searches 'ofproto' for tables that have more flows than their configured
4481 * maximum and that have flow eviction enabled, and evicts as many flows as
4482 * necessary and currently feasible from them.
4484 * This triggers only when an OpenFlow table has N flows in it and then the
4485 * client configures a maximum number of flows less than N. */
4487 ofproto_evict(struct ofproto *ofproto)
4489 struct ofopgroup *group;
4490 struct oftable *table;
4492 group = ofopgroup_create_unattached(ofproto);
4493 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
4494 while (classifier_count(&table->cls) > table->max_flows
4495 && table->eviction_fields) {
4498 rule = choose_rule_to_evict(table);
4499 if (!rule || rule->pending) {
4503 ofoperation_create(group, rule,
4504 OFOPERATION_DELETE, OFPRR_EVICTION);
4505 oftable_remove_rule(rule);
4506 ofproto->ofproto_class->rule_destruct(rule);
4509 ofopgroup_submit(group);
4512 /* Eviction groups. */
4514 /* Returns the priority to use for an eviction_group that contains 'n_rules'
4515 * rules. The priority contains low-order random bits to ensure that eviction
4516 * groups with the same number of rules are prioritized randomly. */
4518 eviction_group_priority(size_t n_rules)
4520 uint16_t size = MIN(UINT16_MAX, n_rules);
4521 return (size << 16) | random_uint16();
4524 /* Updates 'evg', an eviction_group within 'table', following a change that
4525 * adds or removes rules in 'evg'. */
4527 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
4529 heap_change(&table->eviction_groups_by_size, &evg->size_node,
4530 eviction_group_priority(heap_count(&evg->rules)));
4533 /* Destroys 'evg', an eviction_group within 'table':
4535 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
4536 * rules themselves, just removes them from the eviction group.)
4538 * - Removes 'evg' from 'table'.
4542 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
4544 while (!heap_is_empty(&evg->rules)) {
4547 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
4548 rule->eviction_group = NULL;
4550 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
4551 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
4552 heap_destroy(&evg->rules);
4556 /* Removes 'rule' from its eviction group, if any. */
4558 eviction_group_remove_rule(struct rule *rule)
4560 if (rule->eviction_group) {
4561 struct oftable *table = &rule->ofproto->tables[rule->table_id];
4562 struct eviction_group *evg = rule->eviction_group;
4564 rule->eviction_group = NULL;
4565 heap_remove(&evg->rules, &rule->evg_node);
4566 if (heap_is_empty(&evg->rules)) {
4567 eviction_group_destroy(table, evg);
4569 eviction_group_resized(table, evg);
4574 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
4575 * returns the hash value. */
4577 eviction_group_hash_rule(struct rule *rule)
4579 struct oftable *table = &rule->ofproto->tables[rule->table_id];
4580 const struct mf_subfield *sf;
4584 hash = table->eviction_group_id_basis;
4585 miniflow_expand(&rule->cr.match.flow, &flow);
4586 for (sf = table->eviction_fields;
4587 sf < &table->eviction_fields[table->n_eviction_fields];
4590 if (mf_are_prereqs_ok(sf->field, &flow)) {
4591 union mf_value value;
4593 mf_get_value(sf->field, &flow, &value);
4595 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
4597 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
4598 unsigned int start = sf->ofs + sf->n_bits;
4599 bitwise_zero(&value, sf->field->n_bytes, start,
4600 sf->field->n_bytes * 8 - start);
4602 hash = hash_bytes(&value, sf->field->n_bytes, hash);
4604 hash = hash_int(hash, 0);
4611 /* Returns an eviction group within 'table' with the given 'id', creating one
4613 static struct eviction_group *
4614 eviction_group_find(struct oftable *table, uint32_t id)
4616 struct eviction_group *evg;
4618 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
4622 evg = xmalloc(sizeof *evg);
4623 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
4624 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
4625 eviction_group_priority(0));
4626 heap_init(&evg->rules);
4631 /* Returns an eviction priority for 'rule'. The return value should be
4632 * interpreted so that higher priorities make a rule more attractive candidates
4635 rule_eviction_priority(struct rule *rule)
4637 long long int hard_expiration;
4638 long long int idle_expiration;
4639 long long int expiration;
4640 uint32_t expiration_offset;
4642 /* Calculate time of expiration. */
4643 hard_expiration = (rule->hard_timeout
4644 ? rule->modified + rule->hard_timeout * 1000
4646 idle_expiration = (rule->idle_timeout
4647 ? rule->used + rule->idle_timeout * 1000
4649 expiration = MIN(hard_expiration, idle_expiration);
4650 if (expiration == LLONG_MAX) {
4654 /* Calculate the time of expiration as a number of (approximate) seconds
4655 * after program startup.
4657 * This should work OK for program runs that last UINT32_MAX seconds or
4658 * less. Therefore, please restart OVS at least once every 136 years. */
4659 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
4661 /* Invert the expiration offset because we're using a max-heap. */
4662 return UINT32_MAX - expiration_offset;
4665 /* Adds 'rule' to an appropriate eviction group for its oftable's
4666 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
4667 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
4670 * The caller must ensure that 'rule' is not already in an eviction group. */
4672 eviction_group_add_rule(struct rule *rule)
4674 struct ofproto *ofproto = rule->ofproto;
4675 struct oftable *table = &ofproto->tables[rule->table_id];
4677 if (table->eviction_fields
4678 && (rule->hard_timeout || rule->idle_timeout)) {
4679 struct eviction_group *evg;
4681 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
4683 rule->eviction_group = evg;
4684 heap_insert(&evg->rules, &rule->evg_node,
4685 rule_eviction_priority(rule));
4686 eviction_group_resized(table, evg);
4692 /* Initializes 'table'. */
4694 oftable_init(struct oftable *table)
4696 memset(table, 0, sizeof *table);
4697 classifier_init(&table->cls);
4698 table->max_flows = UINT_MAX;
4701 /* Destroys 'table', including its classifier and eviction groups.
4703 * The caller is responsible for freeing 'table' itself. */
4705 oftable_destroy(struct oftable *table)
4707 assert(classifier_is_empty(&table->cls));
4708 oftable_disable_eviction(table);
4709 classifier_destroy(&table->cls);
4713 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
4714 * string, then 'table' will use its default name.
4716 * This only affects the name exposed for a table exposed through the OpenFlow
4717 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
4719 oftable_set_name(struct oftable *table, const char *name)
4721 if (name && name[0]) {
4722 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
4723 if (!table->name || strncmp(name, table->name, len)) {
4725 table->name = xmemdup0(name, len);
4733 /* oftables support a choice of two policies when adding a rule would cause the
4734 * number of flows in the table to exceed the configured maximum number: either
4735 * they can refuse to add the new flow or they can evict some existing flow.
4736 * This function configures the former policy on 'table'. */
4738 oftable_disable_eviction(struct oftable *table)
4740 if (table->eviction_fields) {
4741 struct eviction_group *evg, *next;
4743 HMAP_FOR_EACH_SAFE (evg, next, id_node,
4744 &table->eviction_groups_by_id) {
4745 eviction_group_destroy(table, evg);
4747 hmap_destroy(&table->eviction_groups_by_id);
4748 heap_destroy(&table->eviction_groups_by_size);
4750 free(table->eviction_fields);
4751 table->eviction_fields = NULL;
4752 table->n_eviction_fields = 0;
4756 /* oftables support a choice of two policies when adding a rule would cause the
4757 * number of flows in the table to exceed the configured maximum number: either
4758 * they can refuse to add the new flow or they can evict some existing flow.
4759 * This function configures the latter policy on 'table', with fairness based
4760 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
4761 * 'n_fields' as 0 disables fairness.) */
4763 oftable_enable_eviction(struct oftable *table,
4764 const struct mf_subfield *fields, size_t n_fields)
4766 struct cls_cursor cursor;
4769 if (table->eviction_fields
4770 && n_fields == table->n_eviction_fields
4772 || !memcmp(fields, table->eviction_fields,
4773 n_fields * sizeof *fields))) {
4778 oftable_disable_eviction(table);
4780 table->n_eviction_fields = n_fields;
4781 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
4783 table->eviction_group_id_basis = random_uint32();
4784 hmap_init(&table->eviction_groups_by_id);
4785 heap_init(&table->eviction_groups_by_size);
4787 cls_cursor_init(&cursor, &table->cls, NULL);
4788 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4789 eviction_group_add_rule(rule);
4793 /* Removes 'rule' from the oftable that contains it. */
4795 oftable_remove_rule(struct rule *rule)
4797 struct ofproto *ofproto = rule->ofproto;
4798 struct oftable *table = &ofproto->tables[rule->table_id];
4800 classifier_remove(&table->cls, &rule->cr);
4801 eviction_group_remove_rule(rule);
4804 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
4805 * oftable that has an identical cls_rule. Returns the rule that was removed,
4806 * if any, and otherwise NULL. */
4807 static struct rule *
4808 oftable_replace_rule(struct rule *rule)
4810 struct ofproto *ofproto = rule->ofproto;
4811 struct oftable *table = &ofproto->tables[rule->table_id];
4812 struct rule *victim;
4814 victim = rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
4816 eviction_group_remove_rule(victim);
4818 eviction_group_add_rule(rule);
4822 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
4824 oftable_substitute_rule(struct rule *old, struct rule *new)
4827 oftable_replace_rule(new);
4829 oftable_remove_rule(old);
4833 /* unixctl commands. */
4836 ofproto_lookup(const char *name)
4838 struct ofproto *ofproto;
4840 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
4842 if (!strcmp(ofproto->name, name)) {
4850 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
4851 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
4853 struct ofproto *ofproto;
4857 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
4858 ds_put_format(&results, "%s\n", ofproto->name);
4860 unixctl_command_reply(conn, ds_cstr(&results));
4861 ds_destroy(&results);
4865 ofproto_unixctl_init(void)
4867 static bool registered;
4873 unixctl_command_register("ofproto/list", "", 0, 0,
4874 ofproto_unixctl_list, NULL);
4877 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
4879 * This is deprecated. It is only for compatibility with broken device drivers
4880 * in old versions of Linux that do not properly support VLANs when VLAN
4881 * devices are not used. When broken device drivers are no longer in
4882 * widespread use, we will delete these interfaces. */
4884 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
4885 * (exactly) by an OpenFlow rule in 'ofproto'. */
4887 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
4889 const struct oftable *oftable;
4891 free(ofproto->vlan_bitmap);
4892 ofproto->vlan_bitmap = bitmap_allocate(4096);
4893 ofproto->vlans_changed = false;
4895 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
4896 const struct cls_table *table;
4898 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
4899 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
4900 const struct cls_rule *rule;
4902 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
4903 uint16_t vid = miniflow_get_vid(&rule->match.flow);
4904 bitmap_set1(vlan_bitmap, vid);
4905 bitmap_set1(ofproto->vlan_bitmap, vid);
4912 /* Returns true if new VLANs have come into use by the flow table since the
4913 * last call to ofproto_get_vlan_usage().
4915 * We don't track when old VLANs stop being used. */
4917 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
4919 return ofproto->vlans_changed;
4922 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
4923 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
4924 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
4925 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
4926 * then the VLAN device is un-enslaved. */
4928 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
4929 uint16_t realdev_ofp_port, int vid)
4931 struct ofport *ofport;
4934 assert(vlandev_ofp_port != realdev_ofp_port);
4936 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
4938 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
4939 ofproto->name, vlandev_ofp_port);
4943 if (!ofproto->ofproto_class->set_realdev) {
4944 if (!vlandev_ofp_port) {
4947 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
4951 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
4953 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
4954 ofproto->name, vlandev_ofp_port,
4955 netdev_get_name(ofport->netdev), strerror(error));