2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
25 #include "byte-order.h"
26 #include "classifier.h"
29 #include "dynamic-string.h"
32 #include "meta-flow.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
38 #include "ofp-print.h"
41 #include "ofproto-provider.h"
42 #include "openflow/nicira-ext.h"
43 #include "openflow/openflow.h"
47 #include "poll-loop.h"
53 #include "unaligned.h"
57 VLOG_DEFINE_THIS_MODULE(ofproto);
59 COVERAGE_DEFINE(ofproto_error);
60 COVERAGE_DEFINE(ofproto_flush);
61 COVERAGE_DEFINE(ofproto_no_packet_in);
62 COVERAGE_DEFINE(ofproto_packet_out);
63 COVERAGE_DEFINE(ofproto_queue_req);
64 COVERAGE_DEFINE(ofproto_recv_openflow);
65 COVERAGE_DEFINE(ofproto_reinit_ports);
66 COVERAGE_DEFINE(ofproto_uninstallable);
67 COVERAGE_DEFINE(ofproto_update_port);
70 S_OPENFLOW, /* Processing OpenFlow commands. */
71 S_EVICT, /* Evicting flows from over-limit tables. */
72 S_FLUSH, /* Deleting all flow table rules. */
75 enum ofoperation_type {
81 /* A single OpenFlow request can execute any number of operations. The
82 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
83 * ofconn to which an error reply should be sent if necessary.
85 * ofproto initiates some operations internally. These operations are still
86 * assigned to groups but will not have an associated ofconn. */
88 struct ofproto *ofproto; /* Owning ofproto. */
89 struct list ofproto_node; /* In ofproto's "pending" list. */
90 struct list ops; /* List of "struct ofoperation"s. */
91 int n_running; /* Number of ops still pending. */
93 /* Data needed to send OpenFlow reply on failure or to send a buffered
96 * If list_is_empty(ofconn_node) then this ofopgroup never had an
97 * associated ofconn or its ofconn's connection dropped after it initiated
98 * the operation. In the latter case 'ofconn' is a wild pointer that
99 * refers to freed memory, so the 'ofconn' member must be used only if
100 * !list_is_empty(ofconn_node).
102 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
103 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
104 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
105 uint32_t buffer_id; /* Buffer id from original request. */
108 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
109 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
110 const struct ofp_header *,
112 static void ofopgroup_submit(struct ofopgroup *);
113 static void ofopgroup_complete(struct ofopgroup *);
115 /* A single flow table operation. */
117 struct ofopgroup *group; /* Owning group. */
118 struct list group_node; /* In ofopgroup's "ops" list. */
119 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
120 struct rule *rule; /* Rule being operated upon. */
121 enum ofoperation_type type; /* Type of operation. */
123 /* OFOPERATION_ADD. */
124 struct rule *victim; /* Rule being replaced, if any.. */
126 /* OFOPERATION_MODIFY: The old actions, if the actions are changing. */
127 struct ofpact *ofpacts;
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 *, const struct ofpbuf *);
203 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
204 const struct ofputil_flow_mod *,
205 const struct ofp_header *);
206 static void calc_duration(long long int start, long long int now,
207 uint32_t *sec, uint32_t *nsec);
210 static uint64_t pick_datapath_id(const struct ofproto *);
211 static uint64_t pick_fallback_dpid(void);
212 static void ofproto_destroy__(struct ofproto *);
213 static void update_mtu(struct ofproto *, struct ofport *);
216 static void ofproto_unixctl_init(void);
218 /* All registered ofproto classes, in probe order. */
219 static const struct ofproto_class **ofproto_classes;
220 static size_t n_ofproto_classes;
221 static size_t allocated_ofproto_classes;
223 unsigned flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT;
225 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
226 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
228 /* Initial mappings of port to OpenFlow number mappings. */
229 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
231 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
233 /* The default value of true waits for flow restore. */
234 static bool flow_restore_wait = true;
236 /* Must be called to initialize the ofproto library.
238 * The caller may pass in 'iface_hints', which contains an shash of
239 * "iface_hint" elements indexed by the interface's name. The provider
240 * may use these hints to describe the startup configuration in order to
241 * reinitialize its state. The caller owns the provided data, so a
242 * provider will make copies of anything required. An ofproto provider
243 * will remove any existing state that is not described by the hint, and
244 * may choose to remove it all. */
246 ofproto_init(const struct shash *iface_hints)
248 struct shash_node *node;
251 ofproto_class_register(&ofproto_dpif_class);
253 /* Make a local copy, since we don't own 'iface_hints' elements. */
254 SHASH_FOR_EACH(node, iface_hints) {
255 const struct iface_hint *orig_hint = node->data;
256 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
257 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
259 new_hint->br_name = xstrdup(orig_hint->br_name);
260 new_hint->br_type = xstrdup(br_type);
261 new_hint->ofp_port = orig_hint->ofp_port;
263 shash_add(&init_ofp_ports, node->name, new_hint);
266 for (i = 0; i < n_ofproto_classes; i++) {
267 ofproto_classes[i]->init(&init_ofp_ports);
271 /* 'type' should be a normalized datapath type, as returned by
272 * ofproto_normalize_type(). Returns the corresponding ofproto_class
273 * structure, or a null pointer if there is none registered for 'type'. */
274 static const struct ofproto_class *
275 ofproto_class_find__(const char *type)
279 for (i = 0; i < n_ofproto_classes; i++) {
280 const struct ofproto_class *class = ofproto_classes[i];
285 class->enumerate_types(&types);
286 found = sset_contains(&types, type);
287 sset_destroy(&types);
293 VLOG_WARN("unknown datapath type %s", type);
297 /* Registers a new ofproto class. After successful registration, new ofprotos
298 * of that type can be created using ofproto_create(). */
300 ofproto_class_register(const struct ofproto_class *new_class)
304 for (i = 0; i < n_ofproto_classes; i++) {
305 if (ofproto_classes[i] == new_class) {
310 if (n_ofproto_classes >= allocated_ofproto_classes) {
311 ofproto_classes = x2nrealloc(ofproto_classes,
312 &allocated_ofproto_classes,
313 sizeof *ofproto_classes);
315 ofproto_classes[n_ofproto_classes++] = new_class;
319 /* Unregisters a datapath provider. 'type' must have been previously
320 * registered and not currently be in use by any ofprotos. After
321 * unregistration new datapaths of that type cannot be opened using
322 * ofproto_create(). */
324 ofproto_class_unregister(const struct ofproto_class *class)
328 for (i = 0; i < n_ofproto_classes; i++) {
329 if (ofproto_classes[i] == class) {
330 for (i++; i < n_ofproto_classes; i++) {
331 ofproto_classes[i - 1] = ofproto_classes[i];
337 VLOG_WARN("attempted to unregister an ofproto class that is not "
342 /* Clears 'types' and enumerates all registered ofproto types into it. The
343 * caller must first initialize the sset. */
345 ofproto_enumerate_types(struct sset *types)
349 for (i = 0; i < n_ofproto_classes; i++) {
350 ofproto_classes[i]->enumerate_types(types);
354 /* Returns the fully spelled out name for the given ofproto 'type'.
356 * Normalized type string can be compared with strcmp(). Unnormalized type
357 * string might be the same even if they have different spellings. */
359 ofproto_normalize_type(const char *type)
361 return type && type[0] ? type : "system";
364 /* Clears 'names' and enumerates the names of all known created ofprotos with
365 * the given 'type'. The caller must first initialize the sset. Returns 0 if
366 * successful, otherwise a positive errno value.
368 * Some kinds of datapaths might not be practically enumerable. This is not
369 * considered an error. */
371 ofproto_enumerate_names(const char *type, struct sset *names)
373 const struct ofproto_class *class = ofproto_class_find__(type);
374 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
378 ofproto_create(const char *datapath_name, const char *datapath_type,
379 struct ofproto **ofprotop)
381 const struct ofproto_class *class;
382 struct ofproto *ofproto;
388 ofproto_unixctl_init();
390 datapath_type = ofproto_normalize_type(datapath_type);
391 class = ofproto_class_find__(datapath_type);
393 VLOG_WARN("could not create datapath %s of unknown type %s",
394 datapath_name, datapath_type);
398 ofproto = class->alloc();
400 VLOG_ERR("failed to allocate datapath %s of type %s",
401 datapath_name, datapath_type);
406 memset(ofproto, 0, sizeof *ofproto);
407 ofproto->ofproto_class = class;
408 ofproto->name = xstrdup(datapath_name);
409 ofproto->type = xstrdup(datapath_type);
410 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
411 hash_string(ofproto->name, 0));
412 ofproto->datapath_id = 0;
413 ofproto->forward_bpdu = false;
414 ofproto->fallback_dpid = pick_fallback_dpid();
415 ofproto->mfr_desc = NULL;
416 ofproto->hw_desc = NULL;
417 ofproto->sw_desc = NULL;
418 ofproto->serial_desc = NULL;
419 ofproto->dp_desc = NULL;
420 ofproto->frag_handling = OFPC_FRAG_NORMAL;
421 hmap_init(&ofproto->ports);
422 shash_init(&ofproto->port_by_name);
423 simap_init(&ofproto->ofp_requests);
424 ofproto->max_ports = OFPP_MAX;
425 ofproto->tables = NULL;
426 ofproto->n_tables = 0;
427 hindex_init(&ofproto->cookies);
428 list_init(&ofproto->expirable);
429 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
430 ofproto->state = S_OPENFLOW;
431 list_init(&ofproto->pending);
432 ofproto->n_pending = 0;
433 hmap_init(&ofproto->deletions);
434 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
435 ofproto->first_op = ofproto->last_op = LLONG_MIN;
436 ofproto->next_op_report = LLONG_MAX;
437 ofproto->op_backoff = LLONG_MIN;
438 ofproto->vlan_bitmap = NULL;
439 ofproto->vlans_changed = false;
440 ofproto->min_mtu = INT_MAX;
442 error = ofproto->ofproto_class->construct(ofproto);
444 VLOG_ERR("failed to open datapath %s: %s",
445 datapath_name, strerror(error));
446 ofproto_destroy__(ofproto);
450 /* The "max_ports" member should have been set by ->construct(ofproto).
451 * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
452 ofproto->ofp_port_ids = bitmap_allocate(ofproto->max_ports);
453 bitmap_set1(ofproto->ofp_port_ids, 0);
455 /* Check that hidden tables, if any, are at the end. */
456 ovs_assert(ofproto->n_tables);
457 for (i = 0; i + 1 < ofproto->n_tables; i++) {
458 enum oftable_flags flags = ofproto->tables[i].flags;
459 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
461 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
464 ofproto->datapath_id = pick_datapath_id(ofproto);
471 /* Must be called (only) by an ofproto implementation in its constructor
472 * function. See the large comment on 'construct' in struct ofproto_class for
475 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
477 struct oftable *table;
479 ovs_assert(!ofproto->n_tables);
480 ovs_assert(n_tables >= 1 && n_tables <= 255);
482 ofproto->n_tables = n_tables;
483 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
484 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
489 /* To be optionally called (only) by an ofproto implementation in its
490 * constructor function. See the large comment on 'construct' in struct
491 * ofproto_class for details.
493 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
494 * will then ensure that actions passed into the ofproto implementation will
495 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
496 * function is not called, there will be no such restriction.
498 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
499 * the 'max_ports' restriction. */
501 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
503 ovs_assert(max_ports <= OFPP_MAX);
504 ofproto->max_ports = max_ports;
508 ofproto_get_datapath_id(const struct ofproto *ofproto)
510 return ofproto->datapath_id;
514 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
516 uint64_t old_dpid = p->datapath_id;
517 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
518 if (p->datapath_id != old_dpid) {
519 /* Force all active connections to reconnect, since there is no way to
520 * notify a controller that the datapath ID has changed. */
521 ofproto_reconnect_controllers(p);
526 ofproto_set_controllers(struct ofproto *p,
527 const struct ofproto_controller *controllers,
528 size_t n_controllers, uint32_t allowed_versions)
530 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
535 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
537 connmgr_set_fail_mode(p->connmgr, fail_mode);
540 /* Drops the connections between 'ofproto' and all of its controllers, forcing
541 * them to reconnect. */
543 ofproto_reconnect_controllers(struct ofproto *ofproto)
545 connmgr_reconnect(ofproto->connmgr);
548 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
549 * in-band control should guarantee access, in the same way that in-band
550 * control guarantees access to OpenFlow controllers. */
552 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
553 const struct sockaddr_in *extras, size_t n)
555 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
558 /* Sets the OpenFlow queue used by flows set up by in-band control on
559 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
560 * flows will use the default queue. */
562 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
564 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
567 /* Sets the number of flows at which eviction from the kernel flow table
570 ofproto_set_flow_eviction_threshold(unsigned threshold)
572 flow_eviction_threshold = MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN,
576 /* If forward_bpdu is true, the NORMAL action will forward frames with
577 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
578 * the NORMAL action will drop these frames. */
580 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
582 bool old_val = ofproto->forward_bpdu;
583 ofproto->forward_bpdu = forward_bpdu;
584 if (old_val != ofproto->forward_bpdu) {
585 if (ofproto->ofproto_class->forward_bpdu_changed) {
586 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
591 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
592 * 'idle_time', in seconds, and the maximum number of MAC table entries to
595 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
598 if (ofproto->ofproto_class->set_mac_table_config) {
599 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
605 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
608 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
612 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
614 return connmgr_set_snoops(ofproto->connmgr, snoops);
618 ofproto_set_netflow(struct ofproto *ofproto,
619 const struct netflow_options *nf_options)
621 if (nf_options && sset_is_empty(&nf_options->collectors)) {
625 if (ofproto->ofproto_class->set_netflow) {
626 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
628 return nf_options ? EOPNOTSUPP : 0;
633 ofproto_set_sflow(struct ofproto *ofproto,
634 const struct ofproto_sflow_options *oso)
636 if (oso && sset_is_empty(&oso->targets)) {
640 if (ofproto->ofproto_class->set_sflow) {
641 return ofproto->ofproto_class->set_sflow(ofproto, oso);
643 return oso ? EOPNOTSUPP : 0;
648 ofproto_set_ipfix(struct ofproto *ofproto,
649 const struct ofproto_ipfix_bridge_exporter_options *bo,
650 const struct ofproto_ipfix_flow_exporter_options *fo,
653 if (ofproto->ofproto_class->set_ipfix) {
654 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
656 return (bo || fo) ? EOPNOTSUPP : 0;
661 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
663 flow_restore_wait = flow_restore_wait_db;
667 ofproto_get_flow_restore_wait(void)
669 return flow_restore_wait;
673 /* Spanning Tree Protocol (STP) configuration. */
675 /* Configures STP on 'ofproto' using the settings defined in 's'. If
676 * 's' is NULL, disables STP.
678 * Returns 0 if successful, otherwise a positive errno value. */
680 ofproto_set_stp(struct ofproto *ofproto,
681 const struct ofproto_stp_settings *s)
683 return (ofproto->ofproto_class->set_stp
684 ? ofproto->ofproto_class->set_stp(ofproto, s)
688 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
689 * 'enabled' member of 's' is false, then the other members are not
692 * Returns 0 if successful, otherwise a positive errno value. */
694 ofproto_get_stp_status(struct ofproto *ofproto,
695 struct ofproto_stp_status *s)
697 return (ofproto->ofproto_class->get_stp_status
698 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
702 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
703 * in 's'. The caller is responsible for assigning STP port numbers
704 * (using the 'port_num' member in the range of 1 through 255, inclusive)
705 * and ensuring there are no duplicates. If the 's' is NULL, then STP
706 * is disabled on the port.
708 * Returns 0 if successful, otherwise a positive errno value.*/
710 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
711 const struct ofproto_port_stp_settings *s)
713 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
715 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
716 ofproto->name, ofp_port);
720 return (ofproto->ofproto_class->set_stp_port
721 ? ofproto->ofproto_class->set_stp_port(ofport, s)
725 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
726 * 's'. If the 'enabled' member in 's' is false, then the other members
727 * are not meaningful.
729 * Returns 0 if successful, otherwise a positive errno value.*/
731 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
732 struct ofproto_port_stp_status *s)
734 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
736 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
737 "port %"PRIu16, ofproto->name, ofp_port);
741 return (ofproto->ofproto_class->get_stp_port_status
742 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
746 /* Queue DSCP configuration. */
748 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
749 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
750 * to implement QoS. Instead, it is used to implement features which require
751 * knowledge of what queues exist on a port, and some basic information about
754 * Returns 0 if successful, otherwise a positive errno value. */
756 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
757 const struct ofproto_port_queue *queues,
760 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
763 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
764 ofproto->name, ofp_port);
768 return (ofproto->ofproto_class->set_queues
769 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
773 /* Connectivity Fault Management configuration. */
775 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
777 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
779 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
780 if (ofport && ofproto->ofproto_class->set_cfm) {
781 ofproto->ofproto_class->set_cfm(ofport, NULL);
785 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
786 * basic configuration from the configuration members in 'cfm', and the remote
787 * maintenance point ID from remote_mpid. Ignores the statistics members of
790 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
792 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
793 const struct cfm_settings *s)
795 struct ofport *ofport;
798 ofport = ofproto_get_port(ofproto, ofp_port);
800 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
801 ofproto->name, ofp_port);
805 /* XXX: For configuration simplicity, we only support one remote_mpid
806 * outside of the CFM module. It's not clear if this is the correct long
807 * term solution or not. */
808 error = (ofproto->ofproto_class->set_cfm
809 ? ofproto->ofproto_class->set_cfm(ofport, s)
812 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
813 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
818 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
819 * 'ofproto' does not have a port 'ofp_port'. */
821 ofproto_port_set_bfd(struct ofproto *ofproto, uint16_t ofp_port,
822 const struct smap *cfg)
824 struct ofport *ofport;
827 ofport = ofproto_get_port(ofproto, ofp_port);
829 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
830 ofproto->name, ofp_port);
834 error = (ofproto->ofproto_class->set_bfd
835 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
838 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
839 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
844 /* Populates 'status' with key value pairs indicating the status of the BFD
845 * session on 'ofp_port'. This information is intended to be populated in the
846 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
849 ofproto_port_get_bfd_status(struct ofproto *ofproto, uint16_t ofp_port,
852 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
853 return (ofport && ofproto->ofproto_class->get_bfd_status
854 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
858 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
859 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
860 * 0 if LACP partner information is not current (generally indicating a
861 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
863 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
865 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
866 return (ofport && ofproto->ofproto_class->port_is_lacp_current
867 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
873 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
874 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
875 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
876 * configuration plus, if there is more than one slave, a bonding
879 * If 'aux' is already registered then this function updates its configuration
880 * to 's'. Otherwise, this function registers a new bundle.
882 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
885 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
886 const struct ofproto_bundle_settings *s)
888 return (ofproto->ofproto_class->bundle_set
889 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
893 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
894 * If no such bundle has been registered, this has no effect. */
896 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
898 return ofproto_bundle_register(ofproto, aux, NULL);
902 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
903 * If 'aux' is already registered then this function updates its configuration
904 * to 's'. Otherwise, this function registers a new mirror. */
906 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
907 const struct ofproto_mirror_settings *s)
909 return (ofproto->ofproto_class->mirror_set
910 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
914 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
915 * If no mirror has been registered, this has no effect. */
917 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
919 return ofproto_mirror_register(ofproto, aux, NULL);
922 /* Retrieves statistics from mirror associated with client data pointer
923 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
924 * 'bytes', respectively. If a particular counters is not supported,
925 * the appropriate argument is set to UINT64_MAX. */
927 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
928 uint64_t *packets, uint64_t *bytes)
930 if (!ofproto->ofproto_class->mirror_get_stats) {
931 *packets = *bytes = UINT64_MAX;
935 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
939 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
940 * which all packets are flooded, instead of using MAC learning. If
941 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
943 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
946 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
948 return (ofproto->ofproto_class->set_flood_vlans
949 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
953 /* Returns true if 'aux' is a registered bundle that is currently in use as the
954 * output for a mirror. */
956 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
958 return (ofproto->ofproto_class->is_mirror_output_bundle
959 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
963 /* Configuration of OpenFlow tables. */
965 /* Returns the number of OpenFlow tables in 'ofproto'. */
967 ofproto_get_n_tables(const struct ofproto *ofproto)
969 return ofproto->n_tables;
972 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
973 * settings from 's'. 'table_id' must be in the range 0 through the number of
974 * OpenFlow tables in 'ofproto' minus 1, inclusive.
976 * For read-only tables, only the name may be configured. */
978 ofproto_configure_table(struct ofproto *ofproto, int table_id,
979 const struct ofproto_table_settings *s)
981 struct oftable *table;
983 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
984 table = &ofproto->tables[table_id];
986 oftable_set_name(table, s->name);
988 if (table->flags & OFTABLE_READONLY) {
993 oftable_enable_eviction(table, s->groups, s->n_groups);
995 oftable_disable_eviction(table);
998 table->max_flows = s->max_flows;
999 if (classifier_count(&table->cls) > table->max_flows
1000 && table->eviction_fields) {
1001 /* 'table' contains more flows than allowed. We might not be able to
1002 * evict them right away because of the asynchronous nature of flow
1003 * table changes. Schedule eviction for later. */
1004 switch (ofproto->state) {
1006 ofproto->state = S_EVICT;
1010 /* We're already deleting flows, nothing more to do. */
1017 ofproto_has_snoops(const struct ofproto *ofproto)
1019 return connmgr_has_snoops(ofproto->connmgr);
1023 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1025 connmgr_get_snoops(ofproto->connmgr, snoops);
1029 ofproto_flush__(struct ofproto *ofproto)
1031 struct ofopgroup *group;
1032 struct oftable *table;
1034 if (ofproto->ofproto_class->flush) {
1035 ofproto->ofproto_class->flush(ofproto);
1038 group = ofopgroup_create_unattached(ofproto);
1039 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1040 struct rule *rule, *next_rule;
1041 struct cls_cursor cursor;
1043 if (table->flags & OFTABLE_HIDDEN) {
1047 cls_cursor_init(&cursor, &table->cls, NULL);
1048 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1049 if (!rule->pending) {
1050 ofoperation_create(group, rule, OFOPERATION_DELETE,
1052 oftable_remove_rule(rule);
1053 ofproto->ofproto_class->rule_destruct(rule);
1057 ofopgroup_submit(group);
1061 ofproto_destroy__(struct ofproto *ofproto)
1063 struct oftable *table;
1065 ovs_assert(list_is_empty(&ofproto->pending));
1066 ovs_assert(!ofproto->n_pending);
1068 connmgr_destroy(ofproto->connmgr);
1070 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1071 free(ofproto->name);
1072 free(ofproto->type);
1073 free(ofproto->mfr_desc);
1074 free(ofproto->hw_desc);
1075 free(ofproto->sw_desc);
1076 free(ofproto->serial_desc);
1077 free(ofproto->dp_desc);
1078 hmap_destroy(&ofproto->ports);
1079 shash_destroy(&ofproto->port_by_name);
1080 bitmap_free(ofproto->ofp_port_ids);
1081 simap_destroy(&ofproto->ofp_requests);
1083 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1084 oftable_destroy(table);
1086 free(ofproto->tables);
1088 hmap_destroy(&ofproto->deletions);
1090 free(ofproto->vlan_bitmap);
1092 ofproto->ofproto_class->dealloc(ofproto);
1096 ofproto_destroy(struct ofproto *p)
1098 struct ofport *ofport, *next_ofport;
1105 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1106 ofport_destroy(ofport);
1109 p->ofproto_class->destruct(p);
1110 ofproto_destroy__(p);
1113 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1114 * kernel datapath, for example, this destroys the datapath in the kernel, and
1115 * with the netdev-based datapath, it tears down the data structures that
1116 * represent the datapath.
1118 * The datapath should not be currently open as an ofproto. */
1120 ofproto_delete(const char *name, const char *type)
1122 const struct ofproto_class *class = ofproto_class_find__(type);
1123 return (!class ? EAFNOSUPPORT
1124 : !class->del ? EACCES
1125 : class->del(type, name));
1129 process_port_change(struct ofproto *ofproto, int error, char *devname)
1131 if (error == ENOBUFS) {
1132 reinit_ports(ofproto);
1133 } else if (!error) {
1134 update_port(ofproto, devname);
1140 ofproto_type_run(const char *datapath_type)
1142 const struct ofproto_class *class;
1145 datapath_type = ofproto_normalize_type(datapath_type);
1146 class = ofproto_class_find__(datapath_type);
1148 error = class->type_run ? class->type_run(datapath_type) : 0;
1149 if (error && error != EAGAIN) {
1150 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1151 datapath_type, strerror(error));
1157 ofproto_type_run_fast(const char *datapath_type)
1159 const struct ofproto_class *class;
1162 datapath_type = ofproto_normalize_type(datapath_type);
1163 class = ofproto_class_find__(datapath_type);
1165 error = class->type_run_fast ? class->type_run_fast(datapath_type) : 0;
1166 if (error && error != EAGAIN) {
1167 VLOG_ERR_RL(&rl, "%s: type_run_fast failed (%s)",
1168 datapath_type, strerror(error));
1174 ofproto_type_wait(const char *datapath_type)
1176 const struct ofproto_class *class;
1178 datapath_type = ofproto_normalize_type(datapath_type);
1179 class = ofproto_class_find__(datapath_type);
1181 if (class->type_wait) {
1182 class->type_wait(datapath_type);
1187 ofproto_run(struct ofproto *p)
1189 struct sset changed_netdevs;
1190 const char *changed_netdev;
1191 struct ofport *ofport;
1194 error = p->ofproto_class->run(p);
1195 if (error && error != EAGAIN) {
1196 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, strerror(error));
1199 if (p->ofproto_class->port_poll) {
1202 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1203 process_port_change(p, error, devname);
1207 /* Update OpenFlow port status for any port whose netdev has changed.
1209 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1210 * destroyed, so it's not safe to update ports directly from the
1211 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1212 * need this two-phase approach. */
1213 sset_init(&changed_netdevs);
1214 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1215 unsigned int change_seq = netdev_change_seq(ofport->netdev);
1216 if (ofport->change_seq != change_seq) {
1217 ofport->change_seq = change_seq;
1218 sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1221 SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1222 update_port(p, changed_netdev);
1224 sset_destroy(&changed_netdevs);
1228 connmgr_run(p->connmgr, handle_openflow);
1232 connmgr_run(p->connmgr, NULL);
1234 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1235 p->state = S_OPENFLOW;
1240 connmgr_run(p->connmgr, NULL);
1242 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1243 connmgr_flushed(p->connmgr);
1244 p->state = S_OPENFLOW;
1252 if (time_msec() >= p->next_op_report) {
1253 long long int ago = (time_msec() - p->first_op) / 1000;
1254 long long int interval = (p->last_op - p->first_op) / 1000;
1258 ds_put_format(&s, "%d flow_mods ",
1259 p->n_add + p->n_delete + p->n_modify);
1260 if (interval == ago) {
1261 ds_put_format(&s, "in the last %lld s", ago);
1262 } else if (interval) {
1263 ds_put_format(&s, "in the %lld s starting %lld s ago",
1266 ds_put_format(&s, "%lld s ago", ago);
1269 ds_put_cstr(&s, " (");
1271 ds_put_format(&s, "%d adds, ", p->n_add);
1274 ds_put_format(&s, "%d deletes, ", p->n_delete);
1277 ds_put_format(&s, "%d modifications, ", p->n_modify);
1280 ds_put_char(&s, ')');
1282 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1285 p->n_add = p->n_delete = p->n_modify = 0;
1286 p->next_op_report = LLONG_MAX;
1292 /* Performs periodic activity required by 'ofproto' that needs to be done
1293 * with the least possible latency.
1295 * It makes sense to call this function a couple of times per poll loop, to
1296 * provide a significant performance boost on some benchmarks with the
1297 * ofproto-dpif implementation. */
1299 ofproto_run_fast(struct ofproto *p)
1303 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1304 if (error && error != EAGAIN) {
1305 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1306 p->name, strerror(error));
1312 ofproto_wait(struct ofproto *p)
1314 struct ofport *ofport;
1316 p->ofproto_class->wait(p);
1317 if (p->ofproto_class->port_poll_wait) {
1318 p->ofproto_class->port_poll_wait(p);
1321 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1322 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1323 poll_immediate_wake();
1329 connmgr_wait(p->connmgr, true);
1334 connmgr_wait(p->connmgr, false);
1335 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1336 poll_immediate_wake();
1343 ofproto_is_alive(const struct ofproto *p)
1345 return connmgr_has_controllers(p->connmgr);
1348 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1349 * memory_report(). */
1351 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1353 const struct oftable *table;
1354 unsigned int n_rules;
1356 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1357 simap_increase(usage, "ops",
1358 ofproto->n_pending + hmap_count(&ofproto->deletions));
1361 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1362 n_rules += classifier_count(&table->cls);
1364 simap_increase(usage, "rules", n_rules);
1366 if (ofproto->ofproto_class->get_memory_usage) {
1367 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1370 connmgr_get_memory_usage(ofproto->connmgr, usage);
1374 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1377 connmgr_get_controller_info(ofproto->connmgr, info);
1381 ofproto_free_ofproto_controller_info(struct shash *info)
1383 connmgr_free_controller_info(info);
1386 /* Makes a deep copy of 'old' into 'port'. */
1388 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1390 port->name = xstrdup(old->name);
1391 port->type = xstrdup(old->type);
1392 port->ofp_port = old->ofp_port;
1395 /* Frees memory allocated to members of 'ofproto_port'.
1397 * Do not call this function on an ofproto_port obtained from
1398 * ofproto_port_dump_next(): that function retains ownership of the data in the
1401 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1403 free(ofproto_port->name);
1404 free(ofproto_port->type);
1407 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1409 * This function provides no status indication. An error status for the entire
1410 * dump operation is provided when it is completed by calling
1411 * ofproto_port_dump_done().
1414 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1415 const struct ofproto *ofproto)
1417 dump->ofproto = ofproto;
1418 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1422 /* Attempts to retrieve another port from 'dump', which must have been created
1423 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1424 * 'port' and returns true. On failure, returns false.
1426 * Failure might indicate an actual error or merely that the last port has been
1427 * dumped. An error status for the entire dump operation is provided when it
1428 * is completed by calling ofproto_port_dump_done().
1430 * The ofproto owns the data stored in 'port'. It will remain valid until at
1431 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1432 * ofproto_port_dump_done(). */
1434 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1435 struct ofproto_port *port)
1437 const struct ofproto *ofproto = dump->ofproto;
1443 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1446 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1452 /* Completes port table dump operation 'dump', which must have been created
1453 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1454 * error-free, otherwise a positive errno value describing the problem. */
1456 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1458 const struct ofproto *ofproto = dump->ofproto;
1460 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1463 return dump->error == EOF ? 0 : dump->error;
1466 /* Returns the type to pass to netdev_open() when a datapath of type
1467 * 'datapath_type' has a port of type 'port_type', for a few special
1468 * cases when a netdev type differs from a port type. For example, when
1469 * using the userspace datapath, a port of type "internal" needs to be
1472 * Returns either 'type' itself or a string literal, which must not be
1475 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1477 const struct ofproto_class *class;
1479 datapath_type = ofproto_normalize_type(datapath_type);
1480 class = ofproto_class_find__(datapath_type);
1485 return (class->port_open_type
1486 ? class->port_open_type(datapath_type, port_type)
1490 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1491 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1492 * the port's OpenFlow port number.
1494 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1495 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1496 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1497 * 'ofp_portp' is non-null). */
1499 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1500 uint16_t *ofp_portp)
1502 uint16_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1505 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1507 const char *netdev_name = netdev_get_name(netdev);
1509 simap_put(&ofproto->ofp_requests, netdev_name, ofp_port);
1510 update_port(ofproto, netdev_name);
1513 struct ofproto_port ofproto_port;
1515 ofproto_port_query_by_name(ofproto, netdev_get_name(netdev),
1517 *ofp_portp = error ? OFPP_NONE : ofproto_port.ofp_port;
1518 ofproto_port_destroy(&ofproto_port);
1523 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1524 * initializes '*port' appropriately; on failure, returns a positive errno
1527 * The caller owns the data in 'ofproto_port' and must free it with
1528 * ofproto_port_destroy() when it is no longer needed. */
1530 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1531 struct ofproto_port *port)
1535 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1537 memset(port, 0, sizeof *port);
1542 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1543 * Returns 0 if successful, otherwise a positive errno. */
1545 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1547 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1548 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1549 struct simap_node *ofp_request_node;
1552 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1553 if (ofp_request_node) {
1554 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1557 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1558 if (!error && ofport) {
1559 /* 'name' is the netdev's name and update_port() is going to close the
1560 * netdev. Just in case update_port() refers to 'name' after it
1561 * destroys 'ofport', make a copy of it around the update_port()
1563 char *devname = xstrdup(name);
1564 update_port(ofproto, devname);
1570 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1571 * performs the 'n_actions' actions in 'actions'. The new flow will not
1574 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1575 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1576 * controllers; otherwise, it will be hidden.
1578 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1580 * This is a helper function for in-band control and fail-open. */
1582 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1583 unsigned int priority,
1584 const struct ofpact *ofpacts, size_t ofpacts_len)
1586 const struct rule *rule;
1588 rule = rule_from_cls_rule(classifier_find_match_exactly(
1589 &ofproto->tables[0].cls, match, priority));
1590 if (!rule || !ofpacts_equal(rule->ofpacts, rule->ofpacts_len,
1591 ofpacts, ofpacts_len)) {
1592 struct ofputil_flow_mod fm;
1594 memset(&fm, 0, sizeof fm);
1596 fm.priority = priority;
1597 fm.buffer_id = UINT32_MAX;
1598 fm.ofpacts = xmemdup(ofpacts, ofpacts_len);
1599 fm.ofpacts_len = ofpacts_len;
1600 add_flow(ofproto, NULL, &fm, NULL);
1605 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1606 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1607 * operation cannot be initiated now but may be retried later.
1609 * This is a helper function for in-band control and fail-open. */
1611 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1613 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1616 /* Searches for a rule with matching criteria exactly equal to 'target' in
1617 * ofproto's table 0 and, if it finds one, deletes it.
1619 * This is a helper function for in-band control and fail-open. */
1621 ofproto_delete_flow(struct ofproto *ofproto,
1622 const struct match *target, unsigned int priority)
1626 rule = rule_from_cls_rule(classifier_find_match_exactly(
1627 &ofproto->tables[0].cls, target, priority));
1629 /* No such rule -> success. */
1631 } else if (rule->pending) {
1632 /* An operation on the rule is already pending -> failure.
1633 * Caller must retry later if it's important. */
1636 /* Initiate deletion -> success. */
1637 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1638 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1639 oftable_remove_rule(rule);
1640 ofproto->ofproto_class->rule_destruct(rule);
1641 ofopgroup_submit(group);
1647 /* Starts the process of deleting all of the flows from all of ofproto's flow
1648 * tables and then reintroducing the flows required by in-band control and
1649 * fail-open. The process will complete in a later call to ofproto_run(). */
1651 ofproto_flush_flows(struct ofproto *ofproto)
1653 COVERAGE_INC(ofproto_flush);
1654 ofproto->state = S_FLUSH;
1658 reinit_ports(struct ofproto *p)
1660 struct ofproto_port_dump dump;
1661 struct sset devnames;
1662 struct ofport *ofport;
1663 struct ofproto_port ofproto_port;
1664 const char *devname;
1666 COVERAGE_INC(ofproto_reinit_ports);
1668 sset_init(&devnames);
1669 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1670 sset_add(&devnames, netdev_get_name(ofport->netdev));
1672 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1673 sset_add(&devnames, ofproto_port.name);
1676 SSET_FOR_EACH (devname, &devnames) {
1677 update_port(p, devname);
1679 sset_destroy(&devnames);
1683 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
1686 uint16_t end_port_no = ofproto->alloc_port_no;
1688 ofp_port = simap_get(&ofproto->ofp_requests, netdev_name);
1689 ofp_port = ofp_port ? ofp_port : OFPP_NONE;
1691 if (ofp_port >= ofproto->max_ports
1692 || bitmap_is_set(ofproto->ofp_port_ids, ofp_port)) {
1693 /* Search for a free OpenFlow port number. We try not to
1694 * immediately reuse them to prevent problems due to old
1697 if (++ofproto->alloc_port_no >= ofproto->max_ports) {
1698 ofproto->alloc_port_no = 0;
1700 if (!bitmap_is_set(ofproto->ofp_port_ids,
1701 ofproto->alloc_port_no)) {
1702 ofp_port = ofproto->alloc_port_no;
1705 if (ofproto->alloc_port_no == end_port_no) {
1710 bitmap_set1(ofproto->ofp_port_ids, ofp_port);
1715 dealloc_ofp_port(const struct ofproto *ofproto, uint16_t ofp_port)
1717 if (ofp_port < ofproto->max_ports) {
1718 bitmap_set0(ofproto->ofp_port_ids, ofp_port);
1722 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1723 * pointer if the netdev cannot be opened. On success, also fills in
1725 static struct netdev *
1726 ofport_open(struct ofproto *ofproto,
1727 struct ofproto_port *ofproto_port,
1728 struct ofputil_phy_port *pp)
1730 enum netdev_flags flags;
1731 struct netdev *netdev;
1734 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1736 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1737 "cannot be opened (%s)",
1739 ofproto_port->name, ofproto_port->ofp_port,
1740 ofproto_port->name, strerror(error));
1744 if (ofproto_port->ofp_port == OFPP_NONE) {
1745 if (!strcmp(ofproto->name, ofproto_port->name)) {
1746 ofproto_port->ofp_port = OFPP_LOCAL;
1748 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1749 ofproto_port->name);
1752 pp->port_no = ofproto_port->ofp_port;
1753 netdev_get_etheraddr(netdev, pp->hw_addr);
1754 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1755 netdev_get_flags(netdev, &flags);
1756 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1757 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1758 netdev_get_features(netdev, &pp->curr, &pp->advertised,
1759 &pp->supported, &pp->peer);
1760 pp->curr_speed = netdev_features_to_bps(pp->curr, 0);
1761 pp->max_speed = netdev_features_to_bps(pp->supported, 0);
1766 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1767 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1770 ofport_equal(const struct ofputil_phy_port *a,
1771 const struct ofputil_phy_port *b)
1773 return (eth_addr_equals(a->hw_addr, b->hw_addr)
1774 && a->state == b->state
1775 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1776 && a->curr == b->curr
1777 && a->advertised == b->advertised
1778 && a->supported == b->supported
1779 && a->peer == b->peer
1780 && a->curr_speed == b->curr_speed
1781 && a->max_speed == b->max_speed);
1784 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1785 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1786 * one with the same name or port number). */
1788 ofport_install(struct ofproto *p,
1789 struct netdev *netdev, const struct ofputil_phy_port *pp)
1791 const char *netdev_name = netdev_get_name(netdev);
1792 struct ofport *ofport;
1795 /* Create ofport. */
1796 ofport = p->ofproto_class->port_alloc();
1801 ofport->ofproto = p;
1802 ofport->netdev = netdev;
1803 ofport->change_seq = netdev_change_seq(netdev);
1805 ofport->ofp_port = pp->port_no;
1806 ofport->created = time_msec();
1808 /* Add port to 'p'. */
1809 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1810 shash_add(&p->port_by_name, netdev_name, ofport);
1812 update_mtu(p, ofport);
1814 /* Let the ofproto_class initialize its private data. */
1815 error = p->ofproto_class->port_construct(ofport);
1819 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1823 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1824 p->name, netdev_name, strerror(error));
1826 ofport_destroy__(ofport);
1828 netdev_close(netdev);
1832 /* Removes 'ofport' from 'p' and destroys it. */
1834 ofport_remove(struct ofport *ofport)
1836 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1838 ofport_destroy(ofport);
1841 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1844 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1846 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1848 ofport_remove(port);
1852 /* Updates 'port' with new 'pp' description.
1854 * Does not handle a name or port number change. The caller must implement
1855 * such a change as a delete followed by an add. */
1857 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1859 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1860 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1861 | (pp->config & OFPUTIL_PC_PORT_DOWN));
1862 port->pp.state = pp->state;
1863 port->pp.curr = pp->curr;
1864 port->pp.advertised = pp->advertised;
1865 port->pp.supported = pp->supported;
1866 port->pp.peer = pp->peer;
1867 port->pp.curr_speed = pp->curr_speed;
1868 port->pp.max_speed = pp->max_speed;
1870 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1873 /* Update OpenFlow 'state' in 'port' and notify controller. */
1875 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
1877 if (port->pp.state != state) {
1878 port->pp.state = state;
1879 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
1885 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1887 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1889 if (port->ofproto->ofproto_class->set_realdev) {
1890 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1892 if (port->ofproto->ofproto_class->set_stp_port) {
1893 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1895 if (port->ofproto->ofproto_class->set_cfm) {
1896 port->ofproto->ofproto_class->set_cfm(port, NULL);
1898 if (port->ofproto->ofproto_class->bundle_remove) {
1899 port->ofproto->ofproto_class->bundle_remove(port);
1905 ofport_destroy__(struct ofport *port)
1907 struct ofproto *ofproto = port->ofproto;
1908 const char *name = netdev_get_name(port->netdev);
1910 hmap_remove(&ofproto->ports, &port->hmap_node);
1911 shash_delete(&ofproto->port_by_name,
1912 shash_find(&ofproto->port_by_name, name));
1914 netdev_close(port->netdev);
1915 ofproto->ofproto_class->port_dealloc(port);
1919 ofport_destroy(struct ofport *port)
1922 dealloc_ofp_port(port->ofproto, port->ofp_port);
1923 port->ofproto->ofproto_class->port_destruct(port);
1924 ofport_destroy__(port);
1929 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1931 struct ofport *port;
1933 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1934 hash_int(ofp_port, 0), &ofproto->ports) {
1935 if (port->ofp_port == ofp_port) {
1943 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1945 struct ofproto *ofproto = port->ofproto;
1948 if (ofproto->ofproto_class->port_get_stats) {
1949 error = ofproto->ofproto_class->port_get_stats(port, stats);
1958 update_port(struct ofproto *ofproto, const char *name)
1960 struct ofproto_port ofproto_port;
1961 struct ofputil_phy_port pp;
1962 struct netdev *netdev;
1963 struct ofport *port;
1965 COVERAGE_INC(ofproto_update_port);
1967 /* Fetch 'name''s location and properties from the datapath. */
1968 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1969 ? ofport_open(ofproto, &ofproto_port, &pp)
1972 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1973 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1974 struct netdev *old_netdev = port->netdev;
1976 /* 'name' hasn't changed location. Any properties changed? */
1977 if (!ofport_equal(&port->pp, &pp)) {
1978 ofport_modified(port, &pp);
1981 update_mtu(ofproto, port);
1983 /* Install the newly opened netdev in case it has changed.
1984 * Don't close the old netdev yet in case port_modified has to
1985 * remove a retained reference to it.*/
1986 port->netdev = netdev;
1987 port->change_seq = netdev_change_seq(netdev);
1989 if (port->ofproto->ofproto_class->port_modified) {
1990 port->ofproto->ofproto_class->port_modified(port);
1993 netdev_close(old_netdev);
1995 /* If 'port' is nonnull then its name differs from 'name' and thus
1996 * we should delete it. If we think there's a port named 'name'
1997 * then its port number must be wrong now so delete it too. */
1999 ofport_remove(port);
2001 ofport_remove_with_name(ofproto, name);
2002 ofport_install(ofproto, netdev, &pp);
2005 /* Any port named 'name' is gone now. */
2006 ofport_remove_with_name(ofproto, name);
2008 ofproto_port_destroy(&ofproto_port);
2012 init_ports(struct ofproto *p)
2014 struct ofproto_port_dump dump;
2015 struct ofproto_port ofproto_port;
2016 struct shash_node *node, *next;
2018 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2019 const char *name = ofproto_port.name;
2021 if (shash_find(&p->port_by_name, name)) {
2022 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2025 struct ofputil_phy_port pp;
2026 struct netdev *netdev;
2028 /* Check if an OpenFlow port number had been requested. */
2029 node = shash_find(&init_ofp_ports, name);
2031 const struct iface_hint *iface_hint = node->data;
2032 simap_put(&p->ofp_requests, name, iface_hint->ofp_port);
2035 netdev = ofport_open(p, &ofproto_port, &pp);
2037 ofport_install(p, netdev, &pp);
2042 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2043 struct iface_hint *iface_hint = node->data;
2045 if (!strcmp(iface_hint->br_name, p->name)) {
2046 free(iface_hint->br_name);
2047 free(iface_hint->br_type);
2049 shash_delete(&init_ofp_ports, node);
2056 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2057 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2059 find_min_mtu(struct ofproto *p)
2061 struct ofport *ofport;
2064 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2065 struct netdev *netdev = ofport->netdev;
2068 /* Skip any internal ports, since that's what we're trying to
2070 if (!strcmp(netdev_get_type(netdev), "internal")) {
2074 if (netdev_get_mtu(netdev, &dev_mtu)) {
2077 if (!mtu || dev_mtu < mtu) {
2082 return mtu ? mtu: ETH_PAYLOAD_MAX;
2085 /* Update MTU of all datapath devices on 'p' to the minimum of the
2086 * non-datapath ports in event of 'port' added or changed. */
2088 update_mtu(struct ofproto *p, struct ofport *port)
2090 struct ofport *ofport;
2091 struct netdev *netdev = port->netdev;
2092 int dev_mtu, old_min;
2094 if (netdev_get_mtu(netdev, &dev_mtu)) {
2098 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2099 if (dev_mtu > p->min_mtu) {
2100 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2101 dev_mtu = p->min_mtu;
2104 port->mtu = dev_mtu;
2108 /* For non-internal port find new min mtu. */
2109 old_min = p->min_mtu;
2110 port->mtu = dev_mtu;
2111 p->min_mtu = find_min_mtu(p);
2112 if (p->min_mtu == old_min) {
2116 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2117 struct netdev *netdev = ofport->netdev;
2119 if (!strcmp(netdev_get_type(netdev), "internal")) {
2120 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2121 ofport->mtu = p->min_mtu;
2128 ofproto_rule_destroy__(struct rule *rule)
2131 cls_rule_destroy(&rule->cr);
2132 free(rule->ofpacts);
2133 rule->ofproto->ofproto_class->rule_dealloc(rule);
2137 /* This function allows an ofproto implementation to destroy any rules that
2138 * remain when its ->destruct() function is called. The caller must have
2139 * already uninitialized any derived members of 'rule' (step 5 described in the
2140 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
2141 * This function implements steps 6 and 7.
2143 * This function should only be called from an ofproto implementation's
2144 * ->destruct() function. It is not suitable elsewhere. */
2146 ofproto_rule_destroy(struct rule *rule)
2148 ovs_assert(!rule->pending);
2149 oftable_remove_rule(rule);
2150 ofproto_rule_destroy__(rule);
2153 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2154 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2156 ofproto_rule_has_out_port(const struct rule *rule, uint16_t port)
2158 return (port == OFPP_ANY
2159 || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
2162 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2163 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2165 ofoperation_has_out_port(const struct ofoperation *op, uint16_t out_port)
2167 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2172 case OFOPERATION_ADD:
2173 return op->victim && ofproto_rule_has_out_port(op->victim, out_port);
2175 case OFOPERATION_DELETE:
2178 case OFOPERATION_MODIFY:
2179 return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
2185 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2186 * statistics appropriately. 'packet' must have at least sizeof(struct
2187 * ofp10_packet_in) bytes of headroom.
2189 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
2190 * with statistics for 'packet' either way.
2192 * Takes ownership of 'packet'. */
2194 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
2198 ovs_assert(ofpbuf_headroom(packet) >= sizeof(struct ofp10_packet_in));
2200 flow_extract(packet, 0, 0, NULL, in_port, &flow);
2201 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
2204 /* Returns true if 'rule' should be hidden from the controller.
2206 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2207 * (e.g. by in-band control) and are intentionally hidden from the
2210 ofproto_rule_is_hidden(const struct rule *rule)
2212 return rule->cr.priority > UINT16_MAX;
2215 static enum oftable_flags
2216 rule_get_flags(const struct rule *rule)
2218 return rule->ofproto->tables[rule->table_id].flags;
2222 rule_is_modifiable(const struct rule *rule)
2224 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2228 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2230 ofconn_send_reply(ofconn, make_echo_reply(oh));
2235 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2237 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2238 struct ofputil_switch_features features;
2239 struct ofport *port;
2245 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2247 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2249 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2250 * if present, are always at the end.) */
2251 n_tables = ofproto->n_tables;
2252 for (i = 0; i < ofproto->n_tables; i++) {
2253 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2259 features.datapath_id = ofproto->datapath_id;
2260 features.n_buffers = pktbuf_capacity();
2261 features.n_tables = n_tables;
2262 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2263 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2265 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2267 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2268 features.auxiliary_id = 0;
2269 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2271 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2272 ofputil_put_switch_features_port(&port->pp, b);
2275 ofconn_send_reply(ofconn, b);
2280 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2282 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2283 struct ofp_switch_config *osc;
2284 enum ofp_config_flags flags;
2288 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2289 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2290 flags = ofproto->frag_handling;
2291 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2292 if (oh->version < OFP13_VERSION
2293 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2294 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2296 osc->flags = htons(flags);
2297 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2298 ofconn_send_reply(ofconn, buf);
2304 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2306 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2307 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2308 uint16_t flags = ntohs(osc->flags);
2310 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2311 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2312 enum ofp_config_flags cur = ofproto->frag_handling;
2313 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2315 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2317 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2318 ofproto->frag_handling = next;
2320 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2322 ofputil_frag_handling_to_string(next));
2326 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2327 ofconn_set_invalid_ttl_to_controller(ofconn,
2328 (oh->version < OFP13_VERSION
2329 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2331 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2336 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2337 * error message code for the caller to propagate upward. Otherwise, returns
2340 * The log message mentions 'msg_type'. */
2342 reject_slave_controller(struct ofconn *ofconn)
2344 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2345 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2346 return OFPERR_OFPBRC_EPERM;
2353 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2355 struct ofproto *p = ofconn_get_ofproto(ofconn);
2356 struct ofputil_packet_out po;
2357 struct ofpbuf *payload;
2358 uint64_t ofpacts_stub[1024 / 8];
2359 struct ofpbuf ofpacts;
2363 COVERAGE_INC(ofproto_packet_out);
2365 error = reject_slave_controller(ofconn);
2370 /* Decode message. */
2371 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2372 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2374 goto exit_free_ofpacts;
2376 if (po.in_port >= p->max_ports && po.in_port < OFPP_MAX) {
2377 error = OFPERR_OFPBRC_BAD_PORT;
2378 goto exit_free_ofpacts;
2383 if (po.buffer_id != UINT32_MAX) {
2384 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2385 if (error || !payload) {
2386 goto exit_free_ofpacts;
2389 payload = xmalloc(sizeof *payload);
2390 ofpbuf_use_const(payload, po.packet, po.packet_len);
2393 /* Verify actions against packet, then send packet if successful. */
2394 flow_extract(payload, 0, 0, NULL, po.in_port, &flow);
2395 error = ofpacts_check(po.ofpacts, po.ofpacts_len, &flow, p->max_ports);
2397 error = p->ofproto_class->packet_out(p, payload, &flow,
2398 po.ofpacts, po.ofpacts_len);
2400 ofpbuf_delete(payload);
2403 ofpbuf_uninit(&ofpacts);
2409 update_port_config(struct ofport *port,
2410 enum ofputil_port_config config,
2411 enum ofputil_port_config mask)
2413 enum ofputil_port_config old_config = port->pp.config;
2414 enum ofputil_port_config toggle;
2416 toggle = (config ^ port->pp.config) & mask;
2417 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2418 if (config & OFPUTIL_PC_PORT_DOWN) {
2419 netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL);
2421 netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL);
2423 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2426 port->pp.config ^= toggle;
2427 if (port->pp.config != old_config) {
2428 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2433 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2435 struct ofproto *p = ofconn_get_ofproto(ofconn);
2436 struct ofputil_port_mod pm;
2437 struct ofport *port;
2440 error = reject_slave_controller(ofconn);
2445 error = ofputil_decode_port_mod(oh, &pm);
2450 port = ofproto_get_port(p, pm.port_no);
2452 return OFPERR_OFPPMFC_BAD_PORT;
2453 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2454 return OFPERR_OFPPMFC_BAD_HW_ADDR;
2456 update_port_config(port, pm.config, pm.mask);
2458 netdev_set_advertisements(port->netdev, pm.advertise);
2465 handle_desc_stats_request(struct ofconn *ofconn,
2466 const struct ofp_header *request)
2468 static const char *default_mfr_desc = "Nicira, Inc.";
2469 static const char *default_hw_desc = "Open vSwitch";
2470 static const char *default_sw_desc = VERSION;
2471 static const char *default_serial_desc = "None";
2472 static const char *default_dp_desc = "None";
2474 struct ofproto *p = ofconn_get_ofproto(ofconn);
2475 struct ofp_desc_stats *ods;
2478 msg = ofpraw_alloc_stats_reply(request, 0);
2479 ods = ofpbuf_put_zeros(msg, sizeof *ods);
2480 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
2481 sizeof ods->mfr_desc);
2482 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
2483 sizeof ods->hw_desc);
2484 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
2485 sizeof ods->sw_desc);
2486 ovs_strlcpy(ods->serial_num,
2487 p->serial_desc ? p->serial_desc : default_serial_desc,
2488 sizeof ods->serial_num);
2489 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
2490 sizeof ods->dp_desc);
2491 ofconn_send_reply(ofconn, msg);
2497 handle_table_stats_request(struct ofconn *ofconn,
2498 const struct ofp_header *request)
2500 struct ofproto *p = ofconn_get_ofproto(ofconn);
2501 struct ofp12_table_stats *ots;
2506 /* Set up default values.
2508 * ofp12_table_stats is used as a generic structure as
2509 * it is able to hold all the fields for ofp10_table_stats
2510 * and ofp11_table_stats (and of course itself).
2512 ots = xcalloc(p->n_tables, sizeof *ots);
2513 for (i = 0; i < p->n_tables; i++) {
2514 ots[i].table_id = i;
2515 sprintf(ots[i].name, "table%zu", i);
2516 ots[i].match = htonll(OFPXMT12_MASK);
2517 ots[i].wildcards = htonll(OFPXMT12_MASK);
2518 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2519 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2520 ots[i].write_setfields = htonll(OFPXMT12_MASK);
2521 ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2522 ots[i].metadata_match = htonll(UINT64_MAX);
2523 ots[i].metadata_write = htonll(UINT64_MAX);
2524 ots[i].instructions = htonl(OFPIT11_ALL);
2525 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2526 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2527 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2530 p->ofproto_class->get_tables(p, ots);
2532 /* Post-process the tables, dropping hidden tables. */
2533 n_tables = p->n_tables;
2534 for (i = 0; i < p->n_tables; i++) {
2535 const struct oftable *table = &p->tables[i];
2537 if (table->flags & OFTABLE_HIDDEN) {
2543 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2546 if (table->max_flows < ntohl(ots[i].max_entries)) {
2547 ots[i].max_entries = htonl(table->max_flows);
2551 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2552 ofconn_send_reply(ofconn, msg);
2560 append_port_stat(struct ofport *port, struct list *replies)
2562 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2564 calc_duration(port->created, time_msec(),
2565 &ops.duration_sec, &ops.duration_nsec);
2567 /* Intentionally ignore return value, since errors will set
2568 * 'stats' to all-1s, which is correct for OpenFlow, and
2569 * netdev_get_stats() will log errors. */
2570 ofproto_port_get_stats(port, &ops.stats);
2572 ofputil_append_port_stat(replies, &ops);
2576 handle_port_stats_request(struct ofconn *ofconn,
2577 const struct ofp_header *request)
2579 struct ofproto *p = ofconn_get_ofproto(ofconn);
2580 struct ofport *port;
2581 struct list replies;
2585 error = ofputil_decode_port_stats_request(request, &port_no);
2590 ofpmp_init(&replies, request);
2591 if (port_no != OFPP_ANY) {
2592 port = ofproto_get_port(p, port_no);
2594 append_port_stat(port, &replies);
2597 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2598 append_port_stat(port, &replies);
2602 ofconn_send_replies(ofconn, &replies);
2607 handle_port_desc_stats_request(struct ofconn *ofconn,
2608 const struct ofp_header *request)
2610 struct ofproto *p = ofconn_get_ofproto(ofconn);
2611 enum ofp_version version;
2612 struct ofport *port;
2613 struct list replies;
2615 ofpmp_init(&replies, request);
2617 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2618 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2619 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2622 ofconn_send_replies(ofconn, &replies);
2627 hash_cookie(ovs_be64 cookie)
2629 return hash_2words((OVS_FORCE uint64_t)cookie >> 32,
2630 (OVS_FORCE uint64_t)cookie);
2634 cookies_insert(struct ofproto *ofproto, struct rule *rule)
2636 hindex_insert(&ofproto->cookies, &rule->cookie_node,
2637 hash_cookie(rule->flow_cookie));
2641 cookies_remove(struct ofproto *ofproto, struct rule *rule)
2643 hindex_remove(&ofproto->cookies, &rule->cookie_node);
2647 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
2648 ovs_be64 new_cookie)
2650 if (new_cookie != rule->flow_cookie) {
2651 cookies_remove(ofproto, rule);
2653 rule->flow_cookie = new_cookie;
2655 cookies_insert(ofproto, rule);
2660 calc_duration(long long int start, long long int now,
2661 uint32_t *sec, uint32_t *nsec)
2663 long long int msecs = now - start;
2664 *sec = msecs / 1000;
2665 *nsec = (msecs % 1000) * (1000 * 1000);
2668 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2669 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2671 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2673 return (table_id == 0xff || table_id < ofproto->n_tables
2675 : OFPERR_OFPBRC_BAD_TABLE_ID);
2679 static struct oftable *
2680 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2682 struct oftable *table;
2684 for (table = &ofproto->tables[table_id];
2685 table < &ofproto->tables[ofproto->n_tables];
2687 if (!(table->flags & OFTABLE_HIDDEN)) {
2695 static struct oftable *
2696 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2698 if (table_id == 0xff) {
2699 return next_visible_table(ofproto, 0);
2700 } else if (table_id < ofproto->n_tables) {
2701 return &ofproto->tables[table_id];
2707 static struct oftable *
2708 next_matching_table(const struct ofproto *ofproto,
2709 const struct oftable *table, uint8_t table_id)
2711 return (table_id == 0xff
2712 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2716 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2718 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2719 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2721 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2722 * only once, for that table. (This can be used to access tables marked
2725 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2726 * entered at all. (Perhaps you should have validated TABLE_ID with
2727 * check_table_id().)
2729 * All parameters are evaluated multiple times.
2731 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2732 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2734 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2736 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2737 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2738 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2741 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2742 * to 'out_port' are included.
2744 * Hidden rules are always omitted.
2746 * Returns 0 on success, otherwise an OpenFlow error code. */
2748 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2749 const struct match *match,
2750 ovs_be64 cookie, ovs_be64 cookie_mask,
2751 uint16_t out_port, struct list *rules)
2753 struct oftable *table;
2757 error = check_table_id(ofproto, table_id);
2763 cls_rule_init(&cr, match, 0);
2765 if (cookie_mask == htonll(UINT64_MAX)) {
2768 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node, hash_cookie(cookie),
2769 &ofproto->cookies) {
2770 if (table_id != rule->table_id && table_id != 0xff) {
2773 if (ofproto_rule_is_hidden(rule)) {
2776 if (cls_rule_is_loose_match(&rule->cr, &cr.match)) {
2777 if (rule->pending) {
2778 error = OFPROTO_POSTPONE;
2781 if (rule->flow_cookie == cookie /* Hash collisions possible. */
2782 && ofproto_rule_has_out_port(rule, out_port)) {
2783 list_push_back(rules, &rule->ofproto_node);
2790 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2791 struct cls_cursor cursor;
2794 cls_cursor_init(&cursor, &table->cls, &cr);
2795 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2796 if (rule->pending) {
2797 error = OFPROTO_POSTPONE;
2800 if (!ofproto_rule_is_hidden(rule)
2801 && ofproto_rule_has_out_port(rule, out_port)
2802 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2803 list_push_back(rules, &rule->ofproto_node);
2809 cls_rule_destroy(&cr);
2813 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2814 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2815 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2818 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2819 * to 'out_port' are included.
2821 * Hidden rules are always omitted.
2823 * Returns 0 on success, otherwise an OpenFlow error code. */
2825 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2826 const struct match *match, unsigned int priority,
2827 ovs_be64 cookie, ovs_be64 cookie_mask,
2828 uint16_t out_port, struct list *rules)
2830 struct oftable *table;
2834 error = check_table_id(ofproto, table_id);
2840 cls_rule_init(&cr, match, priority);
2842 if (cookie_mask == htonll(UINT64_MAX)) {
2845 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node, hash_cookie(cookie),
2846 &ofproto->cookies) {
2847 if (table_id != rule->table_id && table_id != 0xff) {
2850 if (ofproto_rule_is_hidden(rule)) {
2853 if (cls_rule_equal(&rule->cr, &cr)) {
2854 if (rule->pending) {
2855 error = OFPROTO_POSTPONE;
2858 if (rule->flow_cookie == cookie /* Hash collisions possible. */
2859 && ofproto_rule_has_out_port(rule, out_port)) {
2860 list_push_back(rules, &rule->ofproto_node);
2867 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2870 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2873 if (rule->pending) {
2874 error = OFPROTO_POSTPONE;
2877 if (!ofproto_rule_is_hidden(rule)
2878 && ofproto_rule_has_out_port(rule, out_port)
2879 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2880 list_push_back(rules, &rule->ofproto_node);
2886 cls_rule_destroy(&cr);
2890 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2891 * forced into the range of a uint16_t. */
2893 age_secs(long long int age_ms)
2895 return (age_ms < 0 ? 0
2896 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
2897 : (unsigned int) age_ms / 1000);
2901 handle_flow_stats_request(struct ofconn *ofconn,
2902 const struct ofp_header *request)
2904 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2905 struct ofputil_flow_stats_request fsr;
2906 struct list replies;
2911 error = ofputil_decode_flow_stats_request(&fsr, request);
2916 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2917 fsr.cookie, fsr.cookie_mask,
2918 fsr.out_port, &rules);
2923 ofpmp_init(&replies, request);
2924 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2925 long long int now = time_msec();
2926 struct ofputil_flow_stats fs;
2928 minimatch_expand(&rule->cr.match, &fs.match);
2929 fs.priority = rule->cr.priority;
2930 fs.cookie = rule->flow_cookie;
2931 fs.table_id = rule->table_id;
2932 calc_duration(rule->created, now, &fs.duration_sec, &fs.duration_nsec);
2933 fs.idle_timeout = rule->idle_timeout;
2934 fs.hard_timeout = rule->hard_timeout;
2935 fs.idle_age = age_secs(now - rule->used);
2936 fs.hard_age = age_secs(now - rule->modified);
2937 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2939 fs.ofpacts = rule->ofpacts;
2940 fs.ofpacts_len = rule->ofpacts_len;
2942 if (rule->send_flow_removed) {
2943 fs.flags |= OFPFF_SEND_FLOW_REM;
2944 /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
2945 and OFPFF13_NO_BYT_COUNTS */
2947 ofputil_append_flow_stats_reply(&fs, &replies);
2949 ofconn_send_replies(ofconn, &replies);
2955 flow_stats_ds(struct rule *rule, struct ds *results)
2957 uint64_t packet_count, byte_count;
2959 rule->ofproto->ofproto_class->rule_get_stats(rule,
2960 &packet_count, &byte_count);
2962 if (rule->table_id != 0) {
2963 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2965 ds_put_format(results, "duration=%llds, ",
2966 (time_msec() - rule->created) / 1000);
2967 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2968 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2969 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2970 cls_rule_format(&rule->cr, results);
2971 ds_put_char(results, ',');
2972 ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
2973 ds_put_cstr(results, "\n");
2976 /* Adds a pretty-printed description of all flows to 'results', including
2977 * hidden flows (e.g., set up by in-band control). */
2979 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2981 struct oftable *table;
2983 OFPROTO_FOR_EACH_TABLE (table, p) {
2984 struct cls_cursor cursor;
2987 cls_cursor_init(&cursor, &table->cls, NULL);
2988 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2989 flow_stats_ds(rule, results);
2994 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2995 * '*engine_type' and '*engine_id', respectively. */
2997 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2998 uint8_t *engine_type, uint8_t *engine_id)
3000 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3003 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3004 * true if the port's CFM status was successfully stored into '*status'.
3005 * Returns false if the port did not have CFM configured, in which case
3006 * '*status' is indeterminate.
3008 * The caller must provide and owns '*status', but it does not own and must not
3009 * modify or free the array returned in 'status->rmps'. */
3011 ofproto_port_get_cfm_status(const struct ofproto *ofproto, uint16_t ofp_port,
3012 struct ofproto_cfm_status *status)
3014 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3016 && ofproto->ofproto_class->get_cfm_status
3017 && ofproto->ofproto_class->get_cfm_status(ofport, status));
3021 handle_aggregate_stats_request(struct ofconn *ofconn,
3022 const struct ofp_header *oh)
3024 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3025 struct ofputil_flow_stats_request request;
3026 struct ofputil_aggregate_stats stats;
3027 bool unknown_packets, unknown_bytes;
3028 struct ofpbuf *reply;
3033 error = ofputil_decode_flow_stats_request(&request, oh);
3038 error = collect_rules_loose(ofproto, request.table_id, &request.match,
3039 request.cookie, request.cookie_mask,
3040 request.out_port, &rules);
3045 memset(&stats, 0, sizeof stats);
3046 unknown_packets = unknown_bytes = false;
3047 LIST_FOR_EACH (rule, ofproto_node, &rules) {
3048 uint64_t packet_count;
3049 uint64_t byte_count;
3051 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3054 if (packet_count == UINT64_MAX) {
3055 unknown_packets = true;
3057 stats.packet_count += packet_count;
3060 if (byte_count == UINT64_MAX) {
3061 unknown_bytes = true;
3063 stats.byte_count += byte_count;
3068 if (unknown_packets) {
3069 stats.packet_count = UINT64_MAX;
3071 if (unknown_bytes) {
3072 stats.byte_count = UINT64_MAX;
3075 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3076 ofconn_send_reply(ofconn, reply);
3081 struct queue_stats_cbdata {
3082 struct ofport *ofport;
3083 struct list replies;
3087 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3088 const struct netdev_queue_stats *stats)
3091 struct ofputil_queue_stats oqs = {
3092 .port_no = cbdata->ofport->pp.port_no,
3093 .queue_id = queue_id,
3096 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3100 handle_queue_stats_dump_cb(uint32_t queue_id,
3101 struct netdev_queue_stats *stats,
3104 struct queue_stats_cbdata *cbdata = cbdata_;
3106 put_queue_stats(cbdata, queue_id, stats);
3110 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3111 struct queue_stats_cbdata *cbdata)
3113 cbdata->ofport = port;
3114 if (queue_id == OFPQ_ALL) {
3115 netdev_dump_queue_stats(port->netdev,
3116 handle_queue_stats_dump_cb, cbdata);
3118 struct netdev_queue_stats stats;
3120 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3121 put_queue_stats(cbdata, queue_id, &stats);
3123 return OFPERR_OFPQOFC_BAD_QUEUE;
3130 handle_queue_stats_request(struct ofconn *ofconn,
3131 const struct ofp_header *rq)
3133 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3134 struct queue_stats_cbdata cbdata;
3135 struct ofport *port;
3137 struct ofputil_queue_stats_request oqsr;
3139 COVERAGE_INC(ofproto_queue_req);
3141 ofpmp_init(&cbdata.replies, rq);
3143 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3148 if (oqsr.port_no == OFPP_ANY) {
3149 error = OFPERR_OFPQOFC_BAD_QUEUE;
3150 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3151 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3156 port = ofproto_get_port(ofproto, oqsr.port_no);
3158 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3159 : OFPERR_OFPQOFC_BAD_PORT);
3162 ofconn_send_replies(ofconn, &cbdata.replies);
3164 ofpbuf_list_delete(&cbdata.replies);
3171 is_flow_deletion_pending(const struct ofproto *ofproto,
3172 const struct cls_rule *cls_rule,
3175 if (!hmap_is_empty(&ofproto->deletions)) {
3176 struct ofoperation *op;
3178 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3179 cls_rule_hash(cls_rule, table_id),
3180 &ofproto->deletions) {
3181 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3190 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3191 * in which no matching flow already exists in the flow table.
3193 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3194 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3195 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3196 * initiated now but may be retried later.
3198 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
3199 * ownership remains with the caller.
3201 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3204 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3205 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
3207 struct oftable *table;
3208 struct ofopgroup *group;
3209 struct rule *victim;
3214 error = check_table_id(ofproto, fm->table_id);
3220 if (fm->table_id == 0xff) {
3221 if (ofproto->ofproto_class->rule_choose_table) {
3222 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3228 ovs_assert(table_id < ofproto->n_tables);
3232 } else if (fm->table_id < ofproto->n_tables) {
3233 table_id = fm->table_id;
3235 return OFPERR_OFPBRC_BAD_TABLE_ID;
3238 table = &ofproto->tables[table_id];
3240 if (table->flags & OFTABLE_READONLY) {
3241 return OFPERR_OFPBRC_EPERM;
3244 /* Allocate new rule and initialize classifier rule. */
3245 rule = ofproto->ofproto_class->rule_alloc();
3247 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3248 ofproto->name, strerror(error));
3251 cls_rule_init(&rule->cr, &fm->match, fm->priority);
3253 /* Serialize against pending deletion. */
3254 if (is_flow_deletion_pending(ofproto, &rule->cr, table_id)) {
3255 cls_rule_destroy(&rule->cr);
3256 ofproto->ofproto_class->rule_dealloc(rule);
3257 return OFPROTO_POSTPONE;
3260 /* Check for overlap, if requested. */
3261 if (fm->flags & OFPFF_CHECK_OVERLAP
3262 && classifier_rule_overlaps(&table->cls, &rule->cr)) {
3263 cls_rule_destroy(&rule->cr);
3264 ofproto->ofproto_class->rule_dealloc(rule);
3265 return OFPERR_OFPFMFC_OVERLAP;
3268 /* FIXME: Implement OFPFF12_RESET_COUNTS */
3270 rule->ofproto = ofproto;
3271 rule->pending = NULL;
3272 rule->flow_cookie = fm->new_cookie;
3273 rule->created = rule->modified = rule->used = time_msec();
3274 rule->idle_timeout = fm->idle_timeout;
3275 rule->hard_timeout = fm->hard_timeout;
3276 rule->table_id = table - ofproto->tables;
3277 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
3278 /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
3279 and OFPFF13_NO_BYT_COUNTS */
3280 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3281 rule->ofpacts_len = fm->ofpacts_len;
3282 rule->evictable = true;
3283 rule->eviction_group = NULL;
3284 list_init(&rule->expirable);
3285 rule->monitor_flags = 0;
3286 rule->add_seqno = 0;
3287 rule->modify_seqno = 0;
3289 /* Insert new rule. */
3290 victim = oftable_replace_rule(rule);
3291 if (victim && !rule_is_modifiable(victim)) {
3292 error = OFPERR_OFPBRC_EPERM;
3293 } else if (victim && victim->pending) {
3294 error = OFPROTO_POSTPONE;
3296 struct ofoperation *op;
3299 if (classifier_count(&table->cls) > table->max_flows) {
3302 was_evictable = rule->evictable;
3303 rule->evictable = false;
3304 evict = choose_rule_to_evict(table);
3305 rule->evictable = was_evictable;
3308 error = OFPERR_OFPFMFC_TABLE_FULL;
3310 } else if (evict->pending) {
3311 error = OFPROTO_POSTPONE;
3318 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3319 op = ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3320 op->victim = victim;
3322 error = ofproto->ofproto_class->rule_construct(rule);
3324 op->group->n_running--;
3325 ofoperation_destroy(rule->pending);
3327 delete_flow__(evict, group);
3329 ofopgroup_submit(group);
3333 /* Back out if an error occurred. */
3335 oftable_substitute_rule(rule, victim);
3336 ofproto_rule_destroy__(rule);
3341 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3343 /* Modifies the rules listed in 'rules', changing their actions to match those
3346 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3349 * Returns 0 on success, otherwise an OpenFlow error code. */
3351 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3352 const struct ofputil_flow_mod *fm,
3353 const struct ofp_header *request, struct list *rules)
3355 struct ofopgroup *group;
3359 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3360 error = OFPERR_OFPBRC_EPERM;
3361 LIST_FOR_EACH (rule, ofproto_node, rules) {
3362 struct ofoperation *op;
3363 bool actions_changed;
3365 /* FIXME: Implement OFPFF12_RESET_COUNTS */
3367 if (rule_is_modifiable(rule)) {
3368 /* At least one rule is modifiable, don't report EPERM error. */
3374 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3375 rule->ofpacts, rule->ofpacts_len);
3377 op = ofoperation_create(group, rule, OFOPERATION_MODIFY, 0);
3379 if (fm->new_cookie != htonll(UINT64_MAX)) {
3380 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
3382 if (actions_changed) {
3383 op->ofpacts = rule->ofpacts;
3384 op->ofpacts_len = rule->ofpacts_len;
3385 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3386 rule->ofpacts_len = fm->ofpacts_len;
3387 rule->ofproto->ofproto_class->rule_modify_actions(rule);
3389 ofoperation_complete(op, 0);
3392 ofopgroup_submit(group);
3398 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3399 const struct ofputil_flow_mod *fm,
3400 const struct ofp_header *request)
3402 if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3405 return add_flow(ofproto, ofconn, fm, request);
3408 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3411 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3414 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3415 const struct ofputil_flow_mod *fm,
3416 const struct ofp_header *request)
3421 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3422 fm->cookie, fm->cookie_mask,
3426 } else if (list_is_empty(&rules)) {
3427 return modify_flows_add(ofproto, ofconn, fm, request);
3429 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3433 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3436 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3439 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3440 const struct ofputil_flow_mod *fm,
3441 const struct ofp_header *request)
3446 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3447 fm->priority, fm->cookie, fm->cookie_mask,
3452 } else if (list_is_empty(&rules)) {
3453 return modify_flows_add(ofproto, ofconn, fm, request);
3455 return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3456 fm, request, &rules)
3461 /* OFPFC_DELETE implementation. */
3464 delete_flow__(struct rule *rule, struct ofopgroup *group)
3466 struct ofproto *ofproto = rule->ofproto;
3468 ofproto_rule_send_removed(rule, OFPRR_DELETE);
3470 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
3471 oftable_remove_rule(rule);
3472 ofproto->ofproto_class->rule_destruct(rule);
3475 /* Deletes the rules listed in 'rules'.
3477 * Returns 0 on success, otherwise an OpenFlow error code. */
3479 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3480 const struct ofp_header *request, struct list *rules)
3482 struct rule *rule, *next;
3483 struct ofopgroup *group;
3485 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3486 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3487 delete_flow__(rule, group);
3489 ofopgroup_submit(group);
3494 /* Implements OFPFC_DELETE. */
3496 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3497 const struct ofputil_flow_mod *fm,
3498 const struct ofp_header *request)
3503 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3504 fm->cookie, fm->cookie_mask,
3505 fm->out_port, &rules);
3506 return (error ? error
3507 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3512 /* Implements OFPFC_DELETE_STRICT. */
3514 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3515 const struct ofputil_flow_mod *fm,
3516 const struct ofp_header *request)
3521 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3522 fm->priority, fm->cookie, fm->cookie_mask,
3523 fm->out_port, &rules);
3524 return (error ? error
3525 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3531 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3533 struct ofputil_flow_removed fr;
3535 if (ofproto_rule_is_hidden(rule) || !rule->send_flow_removed) {
3539 minimatch_expand(&rule->cr.match, &fr.match);
3540 fr.priority = rule->cr.priority;
3541 fr.cookie = rule->flow_cookie;
3543 fr.table_id = rule->table_id;
3544 calc_duration(rule->created, time_msec(),
3545 &fr.duration_sec, &fr.duration_nsec);
3546 fr.idle_timeout = rule->idle_timeout;
3547 fr.hard_timeout = rule->hard_timeout;
3548 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3551 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3555 ofproto_rule_update_used(struct rule *rule, long long int used)
3557 if (used > rule->used) {
3558 struct eviction_group *evg = rule->eviction_group;
3562 heap_change(&evg->rules, &rule->evg_node,
3563 rule_eviction_priority(rule));
3568 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3569 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3572 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3575 * ofproto implementation ->run() functions should use this function to expire
3576 * OpenFlow flows. */
3578 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3580 struct ofproto *ofproto = rule->ofproto;
3581 struct ofopgroup *group;
3583 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
3585 ofproto_rule_send_removed(rule, reason);
3587 group = ofopgroup_create_unattached(ofproto);
3588 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3589 oftable_remove_rule(rule);
3590 ofproto->ofproto_class->rule_destruct(rule);
3591 ofopgroup_submit(group);
3595 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3597 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3598 struct ofputil_flow_mod fm;
3599 uint64_t ofpacts_stub[1024 / 8];
3600 struct ofpbuf ofpacts;
3604 error = reject_slave_controller(ofconn);
3609 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3610 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3613 error = ofpacts_check(fm.ofpacts, fm.ofpacts_len,
3614 &fm.match.flow, ofproto->max_ports);
3617 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
3620 goto exit_free_ofpacts;
3623 /* Record the operation for logging a summary report. */
3624 switch (fm.command) {
3630 case OFPFC_MODIFY_STRICT:
3631 ofproto->n_modify++;
3635 case OFPFC_DELETE_STRICT:
3636 ofproto->n_delete++;
3641 if (ofproto->next_op_report == LLONG_MAX) {
3642 ofproto->first_op = now;
3643 ofproto->next_op_report = MAX(now + 10 * 1000,
3644 ofproto->op_backoff);
3645 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
3647 ofproto->last_op = now;
3650 ofpbuf_uninit(&ofpacts);
3656 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3657 const struct ofputil_flow_mod *fm,
3658 const struct ofp_header *oh)
3660 if (ofproto->n_pending >= 50) {
3661 ovs_assert(!list_is_empty(&ofproto->pending));
3662 return OFPROTO_POSTPONE;
3665 switch (fm->command) {
3667 return add_flow(ofproto, ofconn, fm, oh);
3670 return modify_flows_loose(ofproto, ofconn, fm, oh);
3672 case OFPFC_MODIFY_STRICT:
3673 return modify_flow_strict(ofproto, ofconn, fm, oh);
3676 return delete_flows_loose(ofproto, ofconn, fm, oh);
3678 case OFPFC_DELETE_STRICT:
3679 return delete_flow_strict(ofproto, ofconn, fm, oh);
3682 if (fm->command > 0xff) {
3683 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
3684 "flow_mod_table_id extension is not enabled",
3687 return OFPERR_OFPFMFC_BAD_COMMAND;
3692 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
3694 struct ofputil_role_request request;
3695 struct ofputil_role_request reply;
3699 error = ofputil_decode_role_message(oh, &request);
3704 if (request.role != OFPCR12_ROLE_NOCHANGE) {
3705 if (ofconn_get_role(ofconn) != request.role
3706 && ofconn_has_pending_opgroups(ofconn)) {
3707 return OFPROTO_POSTPONE;
3710 if (request.have_generation_id
3711 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
3712 return OFPERR_OFPRRFC_STALE;
3715 ofconn_set_role(ofconn, request.role);
3718 reply.role = ofconn_get_role(ofconn);
3719 reply.have_generation_id = ofconn_get_master_election_id(
3720 ofconn, &reply.generation_id);
3721 buf = ofputil_encode_role_reply(oh, &reply);
3722 ofconn_send_reply(ofconn, buf);
3728 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
3729 const struct ofp_header *oh)
3731 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
3732 enum ofputil_protocol cur, next;
3734 cur = ofconn_get_protocol(ofconn);
3735 next = ofputil_protocol_set_tid(cur, msg->set != 0);
3736 ofconn_set_protocol(ofconn, next);
3742 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
3744 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
3745 enum ofputil_protocol cur, next;
3746 enum ofputil_protocol next_base;
3748 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
3750 return OFPERR_OFPBRC_EPERM;
3753 cur = ofconn_get_protocol(ofconn);
3754 next = ofputil_protocol_set_base(cur, next_base);
3755 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
3756 /* Avoid sending async messages in surprising protocol. */
3757 return OFPROTO_POSTPONE;
3760 ofconn_set_protocol(ofconn, next);
3765 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
3766 const struct ofp_header *oh)
3768 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
3771 format = ntohl(msg->format);
3772 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
3773 return OFPERR_OFPBRC_EPERM;
3776 if (format != ofconn_get_packet_in_format(ofconn)
3777 && ofconn_has_pending_opgroups(ofconn)) {
3778 /* Avoid sending async message in surprsing packet in format. */
3779 return OFPROTO_POSTPONE;
3782 ofconn_set_packet_in_format(ofconn, format);
3787 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
3789 const struct nx_async_config *msg = ofpmsg_body(oh);
3790 uint32_t master[OAM_N_TYPES];
3791 uint32_t slave[OAM_N_TYPES];
3793 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
3794 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
3795 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
3797 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
3798 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
3799 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
3801 ofconn_set_async_config(ofconn, master, slave);
3802 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
3803 !ofconn_get_miss_send_len(ofconn)) {
3804 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
3811 handle_nxt_set_controller_id(struct ofconn *ofconn,
3812 const struct ofp_header *oh)
3814 const struct nx_controller_id *nci = ofpmsg_body(oh);
3816 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
3817 return OFPERR_NXBRC_MUST_BE_ZERO;
3820 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
3825 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
3829 if (ofconn_has_pending_opgroups(ofconn)) {
3830 return OFPROTO_POSTPONE;
3833 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
3834 ? OFPRAW_OFPT10_BARRIER_REPLY
3835 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
3836 ofconn_send_reply(ofconn, buf);
3841 ofproto_compose_flow_refresh_update(const struct rule *rule,
3842 enum nx_flow_monitor_flags flags,
3845 struct ofoperation *op = rule->pending;
3846 struct ofputil_flow_update fu;
3849 if (op && op->type == OFOPERATION_ADD && !op->victim) {
3850 /* We'll report the final flow when the operation completes. Reporting
3851 * it now would cause a duplicate report later. */
3855 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
3856 ? NXFME_ADDED : NXFME_MODIFIED);
3858 fu.idle_timeout = rule->idle_timeout;
3859 fu.hard_timeout = rule->hard_timeout;
3860 fu.table_id = rule->table_id;
3861 fu.cookie = rule->flow_cookie;
3862 minimatch_expand(&rule->cr.match, &match);
3864 fu.priority = rule->cr.priority;
3865 if (!(flags & NXFMF_ACTIONS)) {
3869 fu.ofpacts = rule->ofpacts;
3870 fu.ofpacts_len = rule->ofpacts_len;
3872 /* An operation is in progress. Use the previous version of the flow's
3873 * actions, so that when the operation commits we report the change. */
3875 case OFOPERATION_ADD:
3876 /* We already verified that there was a victim. */
3877 fu.ofpacts = op->victim->ofpacts;
3878 fu.ofpacts_len = op->victim->ofpacts_len;
3881 case OFOPERATION_MODIFY:
3883 fu.ofpacts = op->ofpacts;
3884 fu.ofpacts_len = op->ofpacts_len;
3886 fu.ofpacts = rule->ofpacts;
3887 fu.ofpacts_len = rule->ofpacts_len;
3891 case OFOPERATION_DELETE:
3892 fu.ofpacts = rule->ofpacts;
3893 fu.ofpacts_len = rule->ofpacts_len;
3901 if (list_is_empty(msgs)) {
3902 ofputil_start_flow_update(msgs);
3904 ofputil_append_flow_update(&fu, msgs);
3908 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
3912 LIST_FOR_EACH (rule, ofproto_node, rules) {
3913 enum nx_flow_monitor_flags flags = rule->monitor_flags;
3914 rule->monitor_flags = 0;
3916 ofproto_compose_flow_refresh_update(rule, flags, msgs);
3921 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
3922 struct rule *rule, uint64_t seqno,
3925 enum nx_flow_monitor_flags update;
3927 if (ofproto_rule_is_hidden(rule)) {
3932 ? ofoperation_has_out_port(rule->pending, m->out_port)
3933 : ofproto_rule_has_out_port(rule, m->out_port))) {
3938 if (rule->add_seqno > seqno) {
3939 update = NXFMF_ADD | NXFMF_MODIFY;
3940 } else if (rule->modify_seqno > seqno) {
3941 update = NXFMF_MODIFY;
3946 if (!(m->flags & update)) {
3950 update = NXFMF_INITIAL;
3953 if (!rule->monitor_flags) {
3954 list_push_back(rules, &rule->ofproto_node);
3956 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
3960 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
3964 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
3965 const struct ofoperation *op;
3966 const struct oftable *table;
3967 struct cls_rule target;
3969 cls_rule_init_from_minimatch(&target, &m->match, 0);
3970 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
3971 struct cls_cursor cursor;
3974 cls_cursor_init(&cursor, &table->cls, &target);
3975 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3976 ovs_assert(!rule->pending); /* XXX */
3977 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3981 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
3982 struct rule *rule = op->rule;
3984 if (((m->table_id == 0xff
3985 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
3986 : m->table_id == rule->table_id))
3987 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
3988 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3991 cls_rule_destroy(&target);
3995 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
3998 if (m->flags & NXFMF_INITIAL) {
3999 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4004 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4005 uint64_t seqno, struct list *rules)
4007 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4011 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4013 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4014 struct ofmonitor **monitors;
4015 size_t n_monitors, allocated_monitors;
4016 struct list replies;
4023 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4025 n_monitors = allocated_monitors = 0;
4027 struct ofputil_flow_monitor_request request;
4028 struct ofmonitor *m;
4031 retval = ofputil_decode_flow_monitor_request(&request, &b);
4032 if (retval == EOF) {
4034 } else if (retval) {
4039 if (request.table_id != 0xff
4040 && request.table_id >= ofproto->n_tables) {
4041 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4045 error = ofmonitor_create(&request, ofconn, &m);
4050 if (n_monitors >= allocated_monitors) {
4051 monitors = x2nrealloc(monitors, &allocated_monitors,
4054 monitors[n_monitors++] = m;
4058 for (i = 0; i < n_monitors; i++) {
4059 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4062 ofpmp_init(&replies, oh);
4063 ofmonitor_compose_refresh_updates(&rules, &replies);
4064 ofconn_send_replies(ofconn, &replies);
4071 for (i = 0; i < n_monitors; i++) {
4072 ofmonitor_destroy(monitors[i]);
4079 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4081 struct ofmonitor *m;
4084 id = ofputil_decode_flow_monitor_cancel(oh);
4085 m = ofmonitor_lookup(ofconn, id);
4087 return OFPERR_NXBRC_FM_BAD_ID;
4090 ofmonitor_destroy(m);
4095 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
4097 const struct ofp_header *oh = msg->data;
4101 error = ofptype_decode(&type, oh);
4107 /* OpenFlow requests. */
4108 case OFPTYPE_ECHO_REQUEST:
4109 return handle_echo_request(ofconn, oh);
4111 case OFPTYPE_FEATURES_REQUEST:
4112 return handle_features_request(ofconn, oh);
4114 case OFPTYPE_GET_CONFIG_REQUEST:
4115 return handle_get_config_request(ofconn, oh);
4117 case OFPTYPE_SET_CONFIG:
4118 return handle_set_config(ofconn, oh);
4120 case OFPTYPE_PACKET_OUT:
4121 return handle_packet_out(ofconn, oh);
4123 case OFPTYPE_PORT_MOD:
4124 return handle_port_mod(ofconn, oh);
4126 case OFPTYPE_FLOW_MOD:
4127 return handle_flow_mod(ofconn, oh);
4129 case OFPTYPE_BARRIER_REQUEST:
4130 return handle_barrier_request(ofconn, oh);
4132 case OFPTYPE_ROLE_REQUEST:
4133 return handle_role_request(ofconn, oh);
4135 /* OpenFlow replies. */
4136 case OFPTYPE_ECHO_REPLY:
4139 /* Nicira extension requests. */
4140 case OFPTYPE_FLOW_MOD_TABLE_ID:
4141 return handle_nxt_flow_mod_table_id(ofconn, oh);
4143 case OFPTYPE_SET_FLOW_FORMAT:
4144 return handle_nxt_set_flow_format(ofconn, oh);
4146 case OFPTYPE_SET_PACKET_IN_FORMAT:
4147 return handle_nxt_set_packet_in_format(ofconn, oh);
4149 case OFPTYPE_SET_CONTROLLER_ID:
4150 return handle_nxt_set_controller_id(ofconn, oh);
4152 case OFPTYPE_FLOW_AGE:
4153 /* Nothing to do. */
4156 case OFPTYPE_FLOW_MONITOR_CANCEL:
4157 return handle_flow_monitor_cancel(ofconn, oh);
4159 case OFPTYPE_SET_ASYNC_CONFIG:
4160 return handle_nxt_set_async_config(ofconn, oh);
4162 /* Statistics requests. */
4163 case OFPTYPE_DESC_STATS_REQUEST:
4164 return handle_desc_stats_request(ofconn, oh);
4166 case OFPTYPE_FLOW_STATS_REQUEST:
4167 return handle_flow_stats_request(ofconn, oh);
4169 case OFPTYPE_AGGREGATE_STATS_REQUEST:
4170 return handle_aggregate_stats_request(ofconn, oh);
4172 case OFPTYPE_TABLE_STATS_REQUEST:
4173 return handle_table_stats_request(ofconn, oh);
4175 case OFPTYPE_PORT_STATS_REQUEST:
4176 return handle_port_stats_request(ofconn, oh);
4178 case OFPTYPE_QUEUE_STATS_REQUEST:
4179 return handle_queue_stats_request(ofconn, oh);
4181 case OFPTYPE_PORT_DESC_STATS_REQUEST:
4182 return handle_port_desc_stats_request(ofconn, oh);
4184 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
4185 return handle_flow_monitor_request(ofconn, oh);
4187 /* FIXME: Change the following once they are implemented: */
4188 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
4189 case OFPTYPE_GET_ASYNC_REQUEST:
4190 case OFPTYPE_METER_MOD:
4191 case OFPTYPE_GROUP_REQUEST:
4192 case OFPTYPE_GROUP_DESC_REQUEST:
4193 case OFPTYPE_GROUP_FEATURES_REQUEST:
4194 case OFPTYPE_METER_REQUEST:
4195 case OFPTYPE_METER_CONFIG_REQUEST:
4196 case OFPTYPE_METER_FEATURES_REQUEST:
4197 case OFPTYPE_TABLE_FEATURES_REQUEST:
4198 return OFPERR_OFPBRC_BAD_TYPE;
4202 case OFPTYPE_FEATURES_REPLY:
4203 case OFPTYPE_GET_CONFIG_REPLY:
4204 case OFPTYPE_PACKET_IN:
4205 case OFPTYPE_FLOW_REMOVED:
4206 case OFPTYPE_PORT_STATUS:
4207 case OFPTYPE_BARRIER_REPLY:
4208 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
4209 case OFPTYPE_DESC_STATS_REPLY:
4210 case OFPTYPE_FLOW_STATS_REPLY:
4211 case OFPTYPE_QUEUE_STATS_REPLY:
4212 case OFPTYPE_PORT_STATS_REPLY:
4213 case OFPTYPE_TABLE_STATS_REPLY:
4214 case OFPTYPE_AGGREGATE_STATS_REPLY:
4215 case OFPTYPE_PORT_DESC_STATS_REPLY:
4216 case OFPTYPE_ROLE_REPLY:
4217 case OFPTYPE_FLOW_MONITOR_PAUSED:
4218 case OFPTYPE_FLOW_MONITOR_RESUMED:
4219 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
4220 case OFPTYPE_GET_ASYNC_REPLY:
4221 case OFPTYPE_GROUP_REPLY:
4222 case OFPTYPE_GROUP_DESC_REPLY:
4223 case OFPTYPE_GROUP_FEATURES_REPLY:
4224 case OFPTYPE_METER_REPLY:
4225 case OFPTYPE_METER_CONFIG_REPLY:
4226 case OFPTYPE_METER_FEATURES_REPLY:
4227 case OFPTYPE_TABLE_FEATURES_REPLY:
4229 return OFPERR_OFPBRC_BAD_TYPE;
4234 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
4236 int error = handle_openflow__(ofconn, ofp_msg);
4237 if (error && error != OFPROTO_POSTPONE) {
4238 ofconn_send_error(ofconn, ofp_msg->data, error);
4240 COVERAGE_INC(ofproto_recv_openflow);
4241 return error != OFPROTO_POSTPONE;
4244 /* Asynchronous operations. */
4246 /* Creates and returns a new ofopgroup that is not associated with any
4247 * OpenFlow connection.
4249 * The caller should add operations to the returned group with
4250 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4251 static struct ofopgroup *
4252 ofopgroup_create_unattached(struct ofproto *ofproto)
4254 struct ofopgroup *group = xzalloc(sizeof *group);
4255 group->ofproto = ofproto;
4256 list_init(&group->ofproto_node);
4257 list_init(&group->ops);
4258 list_init(&group->ofconn_node);
4262 /* Creates and returns a new ofopgroup for 'ofproto'.
4264 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
4265 * connection. The 'request' and 'buffer_id' arguments are ignored.
4267 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
4268 * If the ofopgroup eventually fails, then the error reply will include
4269 * 'request'. If the ofopgroup eventually succeeds, then the packet with
4270 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
4272 * The caller should add operations to the returned group with
4273 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4274 static struct ofopgroup *
4275 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
4276 const struct ofp_header *request, uint32_t buffer_id)
4278 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
4280 size_t request_len = ntohs(request->length);
4282 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
4284 ofconn_add_opgroup(ofconn, &group->ofconn_node);
4285 group->ofconn = ofconn;
4286 group->request = xmemdup(request, MIN(request_len, 64));
4287 group->buffer_id = buffer_id;
4292 /* Submits 'group' for processing.
4294 * If 'group' contains no operations (e.g. none were ever added, or all of the
4295 * ones that were added completed synchronously), then it is destroyed
4296 * immediately. Otherwise it is added to the ofproto's list of pending
4299 ofopgroup_submit(struct ofopgroup *group)
4301 if (!group->n_running) {
4302 ofopgroup_complete(group);
4304 list_push_back(&group->ofproto->pending, &group->ofproto_node);
4305 group->ofproto->n_pending++;
4310 ofopgroup_complete(struct ofopgroup *group)
4312 struct ofproto *ofproto = group->ofproto;
4314 struct ofconn *abbrev_ofconn;
4315 ovs_be32 abbrev_xid;
4317 struct ofoperation *op, *next_op;
4320 ovs_assert(!group->n_running);
4323 LIST_FOR_EACH (op, group_node, &group->ops) {
4330 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
4331 LIST_FOR_EACH (op, group_node, &group->ops) {
4332 if (op->type != OFOPERATION_DELETE) {
4333 struct ofpbuf *packet;
4336 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
4340 error = rule_execute(op->rule, in_port, packet);
4347 if (!error && !list_is_empty(&group->ofconn_node)) {
4348 abbrev_ofconn = group->ofconn;
4349 abbrev_xid = group->request->xid;
4351 abbrev_ofconn = NULL;
4352 abbrev_xid = htonl(0);
4354 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
4355 struct rule *rule = op->rule;
4357 /* We generally want to report the change to active OpenFlow flow
4358 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
4360 - The operation failed.
4362 - The affected rule is not visible to controllers.
4364 - The operation's only effect was to update rule->modified. */
4366 || ofproto_rule_is_hidden(rule)
4367 || (op->type == OFOPERATION_MODIFY
4369 && rule->flow_cookie == op->flow_cookie))) {
4370 /* Check that we can just cast from ofoperation_type to
4371 * nx_flow_update_event. */
4372 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_ADD
4374 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_DELETE
4376 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_MODIFY
4379 ofmonitor_report(ofproto->connmgr, rule,
4380 (enum nx_flow_update_event) op->type,
4381 op->reason, abbrev_ofconn, abbrev_xid);
4384 rule->pending = NULL;
4387 case OFOPERATION_ADD:
4391 ofproto_rule_destroy__(op->victim);
4392 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
4393 if (vid_mask == VLAN_VID_MASK) {
4394 if (ofproto->vlan_bitmap) {
4395 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4396 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4397 bitmap_set1(ofproto->vlan_bitmap, vid);
4398 ofproto->vlans_changed = true;
4401 ofproto->vlans_changed = true;
4405 oftable_substitute_rule(rule, op->victim);
4406 ofproto_rule_destroy__(rule);
4410 case OFOPERATION_DELETE:
4411 ovs_assert(!op->error);
4412 ofproto_rule_destroy__(rule);
4416 case OFOPERATION_MODIFY:
4418 rule->modified = time_msec();
4420 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
4422 free(rule->ofpacts);
4423 rule->ofpacts = op->ofpacts;
4424 rule->ofpacts_len = op->ofpacts_len;
4426 op->ofpacts_len = 0;
4435 ofoperation_destroy(op);
4438 ofmonitor_flush(ofproto->connmgr);
4440 if (!list_is_empty(&group->ofproto_node)) {
4441 ovs_assert(ofproto->n_pending > 0);
4442 ofproto->n_pending--;
4443 list_remove(&group->ofproto_node);
4445 if (!list_is_empty(&group->ofconn_node)) {
4446 list_remove(&group->ofconn_node);
4448 ofconn_send_error(group->ofconn, group->request, error);
4450 connmgr_retry(ofproto->connmgr);
4452 free(group->request);
4456 /* Initiates a new operation on 'rule', of the specified 'type', within
4457 * 'group'. Prior to calling, 'rule' must not have any pending operation.
4459 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4460 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
4462 * Returns the newly created ofoperation (which is also available as
4463 * rule->pending). */
4464 static struct ofoperation *
4465 ofoperation_create(struct ofopgroup *group, struct rule *rule,
4466 enum ofoperation_type type,
4467 enum ofp_flow_removed_reason reason)
4469 struct ofproto *ofproto = group->ofproto;
4470 struct ofoperation *op;
4472 ovs_assert(!rule->pending);
4474 op = rule->pending = xzalloc(sizeof *op);
4476 list_push_back(&group->ops, &op->group_node);
4479 op->reason = reason;
4480 op->flow_cookie = rule->flow_cookie;
4484 if (type == OFOPERATION_DELETE) {
4485 hmap_insert(&ofproto->deletions, &op->hmap_node,
4486 cls_rule_hash(&rule->cr, rule->table_id));
4493 ofoperation_destroy(struct ofoperation *op)
4495 struct ofopgroup *group = op->group;
4498 op->rule->pending = NULL;
4500 if (op->type == OFOPERATION_DELETE) {
4501 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
4503 list_remove(&op->group_node);
4508 /* Indicates that 'op' completed with status 'error', which is either 0 to
4509 * indicate success or an OpenFlow error code on failure.
4511 * If 'error' is 0, indicating success, the operation will be committed
4512 * permanently to the flow table. There is one interesting subcase:
4514 * - If 'op' is an "add flow" operation that is replacing an existing rule in
4515 * the flow table (the "victim" rule) by a new one, then the caller must
4516 * have uninitialized any derived state in the victim rule, as in step 5 in
4517 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
4518 * performs steps 6 and 7 for the victim rule, most notably by calling its
4519 * ->rule_dealloc() function.
4521 * If 'error' is nonzero, then generally the operation will be rolled back:
4523 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
4524 * restores the original rule. The caller must have uninitialized any
4525 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
4526 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
4527 * and 7 for the new rule, calling its ->rule_dealloc() function.
4529 * - If 'op' is a "modify flow" operation, ofproto restores the original
4532 * - 'op' must not be a "delete flow" operation. Removing a rule is not
4533 * allowed to fail. It must always succeed.
4535 * Please see the large comment in ofproto/ofproto-provider.h titled
4536 * "Asynchronous Operation Support" for more information. */
4538 ofoperation_complete(struct ofoperation *op, enum ofperr error)
4540 struct ofopgroup *group = op->group;
4542 ovs_assert(op->rule->pending == op);
4543 ovs_assert(group->n_running > 0);
4544 ovs_assert(!error || op->type != OFOPERATION_DELETE);
4547 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
4548 ofopgroup_complete(group);
4553 ofoperation_get_victim(struct ofoperation *op)
4555 ovs_assert(op->type == OFOPERATION_ADD);
4560 pick_datapath_id(const struct ofproto *ofproto)
4562 const struct ofport *port;
4564 port = ofproto_get_port(ofproto, OFPP_LOCAL);
4566 uint8_t ea[ETH_ADDR_LEN];
4569 error = netdev_get_etheraddr(port->netdev, ea);
4571 return eth_addr_to_uint64(ea);
4573 VLOG_WARN("%s: could not get MAC address for %s (%s)",
4574 ofproto->name, netdev_get_name(port->netdev),
4577 return ofproto->fallback_dpid;
4581 pick_fallback_dpid(void)
4583 uint8_t ea[ETH_ADDR_LEN];
4584 eth_addr_nicira_random(ea);
4585 return eth_addr_to_uint64(ea);
4588 /* Table overflow policy. */
4590 /* Chooses and returns a rule to evict from 'table'. Returns NULL if the table
4591 * is not configured to evict rules or if the table contains no evictable
4592 * rules. (Rules with 'evictable' set to false or with no timeouts are not
4594 static struct rule *
4595 choose_rule_to_evict(struct oftable *table)
4597 struct eviction_group *evg;
4599 if (!table->eviction_fields) {
4603 /* In the common case, the outer and inner loops here will each be entered
4606 * - The inner loop normally "return"s in its first iteration. If the
4607 * eviction group has any evictable rules, then it always returns in
4610 * - The outer loop only iterates more than once if the largest eviction
4611 * group has no evictable rules.
4613 * - The outer loop can exit only if table's 'max_flows' is all filled up
4614 * by unevictable rules'. */
4615 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
4618 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
4619 if (rule->evictable) {
4628 /* Searches 'ofproto' for tables that have more flows than their configured
4629 * maximum and that have flow eviction enabled, and evicts as many flows as
4630 * necessary and currently feasible from them.
4632 * This triggers only when an OpenFlow table has N flows in it and then the
4633 * client configures a maximum number of flows less than N. */
4635 ofproto_evict(struct ofproto *ofproto)
4637 struct ofopgroup *group;
4638 struct oftable *table;
4640 group = ofopgroup_create_unattached(ofproto);
4641 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
4642 while (classifier_count(&table->cls) > table->max_flows
4643 && table->eviction_fields) {
4646 rule = choose_rule_to_evict(table);
4647 if (!rule || rule->pending) {
4651 ofoperation_create(group, rule,
4652 OFOPERATION_DELETE, OFPRR_EVICTION);
4653 oftable_remove_rule(rule);
4654 ofproto->ofproto_class->rule_destruct(rule);
4657 ofopgroup_submit(group);
4660 /* Eviction groups. */
4662 /* Returns the priority to use for an eviction_group that contains 'n_rules'
4663 * rules. The priority contains low-order random bits to ensure that eviction
4664 * groups with the same number of rules are prioritized randomly. */
4666 eviction_group_priority(size_t n_rules)
4668 uint16_t size = MIN(UINT16_MAX, n_rules);
4669 return (size << 16) | random_uint16();
4672 /* Updates 'evg', an eviction_group within 'table', following a change that
4673 * adds or removes rules in 'evg'. */
4675 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
4677 heap_change(&table->eviction_groups_by_size, &evg->size_node,
4678 eviction_group_priority(heap_count(&evg->rules)));
4681 /* Destroys 'evg', an eviction_group within 'table':
4683 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
4684 * rules themselves, just removes them from the eviction group.)
4686 * - Removes 'evg' from 'table'.
4690 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
4692 while (!heap_is_empty(&evg->rules)) {
4695 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
4696 rule->eviction_group = NULL;
4698 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
4699 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
4700 heap_destroy(&evg->rules);
4704 /* Removes 'rule' from its eviction group, if any. */
4706 eviction_group_remove_rule(struct rule *rule)
4708 if (rule->eviction_group) {
4709 struct oftable *table = &rule->ofproto->tables[rule->table_id];
4710 struct eviction_group *evg = rule->eviction_group;
4712 rule->eviction_group = NULL;
4713 heap_remove(&evg->rules, &rule->evg_node);
4714 if (heap_is_empty(&evg->rules)) {
4715 eviction_group_destroy(table, evg);
4717 eviction_group_resized(table, evg);
4722 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
4723 * returns the hash value. */
4725 eviction_group_hash_rule(struct rule *rule)
4727 struct oftable *table = &rule->ofproto->tables[rule->table_id];
4728 const struct mf_subfield *sf;
4732 hash = table->eviction_group_id_basis;
4733 miniflow_expand(&rule->cr.match.flow, &flow);
4734 for (sf = table->eviction_fields;
4735 sf < &table->eviction_fields[table->n_eviction_fields];
4738 if (mf_are_prereqs_ok(sf->field, &flow)) {
4739 union mf_value value;
4741 mf_get_value(sf->field, &flow, &value);
4743 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
4745 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
4746 unsigned int start = sf->ofs + sf->n_bits;
4747 bitwise_zero(&value, sf->field->n_bytes, start,
4748 sf->field->n_bytes * 8 - start);
4750 hash = hash_bytes(&value, sf->field->n_bytes, hash);
4752 hash = hash_int(hash, 0);
4759 /* Returns an eviction group within 'table' with the given 'id', creating one
4761 static struct eviction_group *
4762 eviction_group_find(struct oftable *table, uint32_t id)
4764 struct eviction_group *evg;
4766 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
4770 evg = xmalloc(sizeof *evg);
4771 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
4772 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
4773 eviction_group_priority(0));
4774 heap_init(&evg->rules);
4779 /* Returns an eviction priority for 'rule'. The return value should be
4780 * interpreted so that higher priorities make a rule more attractive candidates
4783 rule_eviction_priority(struct rule *rule)
4785 long long int hard_expiration;
4786 long long int idle_expiration;
4787 long long int expiration;
4788 uint32_t expiration_offset;
4790 /* Calculate time of expiration. */
4791 hard_expiration = (rule->hard_timeout
4792 ? rule->modified + rule->hard_timeout * 1000
4794 idle_expiration = (rule->idle_timeout
4795 ? rule->used + rule->idle_timeout * 1000
4797 expiration = MIN(hard_expiration, idle_expiration);
4798 if (expiration == LLONG_MAX) {
4802 /* Calculate the time of expiration as a number of (approximate) seconds
4803 * after program startup.
4805 * This should work OK for program runs that last UINT32_MAX seconds or
4806 * less. Therefore, please restart OVS at least once every 136 years. */
4807 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
4809 /* Invert the expiration offset because we're using a max-heap. */
4810 return UINT32_MAX - expiration_offset;
4813 /* Adds 'rule' to an appropriate eviction group for its oftable's
4814 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
4815 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
4818 * The caller must ensure that 'rule' is not already in an eviction group. */
4820 eviction_group_add_rule(struct rule *rule)
4822 struct ofproto *ofproto = rule->ofproto;
4823 struct oftable *table = &ofproto->tables[rule->table_id];
4825 if (table->eviction_fields
4826 && (rule->hard_timeout || rule->idle_timeout)) {
4827 struct eviction_group *evg;
4829 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
4831 rule->eviction_group = evg;
4832 heap_insert(&evg->rules, &rule->evg_node,
4833 rule_eviction_priority(rule));
4834 eviction_group_resized(table, evg);
4840 /* Initializes 'table'. */
4842 oftable_init(struct oftable *table)
4844 memset(table, 0, sizeof *table);
4845 classifier_init(&table->cls);
4846 table->max_flows = UINT_MAX;
4849 /* Destroys 'table', including its classifier and eviction groups.
4851 * The caller is responsible for freeing 'table' itself. */
4853 oftable_destroy(struct oftable *table)
4855 ovs_assert(classifier_is_empty(&table->cls));
4856 oftable_disable_eviction(table);
4857 classifier_destroy(&table->cls);
4861 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
4862 * string, then 'table' will use its default name.
4864 * This only affects the name exposed for a table exposed through the OpenFlow
4865 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
4867 oftable_set_name(struct oftable *table, const char *name)
4869 if (name && name[0]) {
4870 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
4871 if (!table->name || strncmp(name, table->name, len)) {
4873 table->name = xmemdup0(name, len);
4881 /* oftables support a choice of two policies when adding a rule would cause the
4882 * number of flows in the table to exceed the configured maximum number: either
4883 * they can refuse to add the new flow or they can evict some existing flow.
4884 * This function configures the former policy on 'table'. */
4886 oftable_disable_eviction(struct oftable *table)
4888 if (table->eviction_fields) {
4889 struct eviction_group *evg, *next;
4891 HMAP_FOR_EACH_SAFE (evg, next, id_node,
4892 &table->eviction_groups_by_id) {
4893 eviction_group_destroy(table, evg);
4895 hmap_destroy(&table->eviction_groups_by_id);
4896 heap_destroy(&table->eviction_groups_by_size);
4898 free(table->eviction_fields);
4899 table->eviction_fields = NULL;
4900 table->n_eviction_fields = 0;
4904 /* oftables support a choice of two policies when adding a rule would cause the
4905 * number of flows in the table to exceed the configured maximum number: either
4906 * they can refuse to add the new flow or they can evict some existing flow.
4907 * This function configures the latter policy on 'table', with fairness based
4908 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
4909 * 'n_fields' as 0 disables fairness.) */
4911 oftable_enable_eviction(struct oftable *table,
4912 const struct mf_subfield *fields, size_t n_fields)
4914 struct cls_cursor cursor;
4917 if (table->eviction_fields
4918 && n_fields == table->n_eviction_fields
4920 || !memcmp(fields, table->eviction_fields,
4921 n_fields * sizeof *fields))) {
4926 oftable_disable_eviction(table);
4928 table->n_eviction_fields = n_fields;
4929 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
4931 table->eviction_group_id_basis = random_uint32();
4932 hmap_init(&table->eviction_groups_by_id);
4933 heap_init(&table->eviction_groups_by_size);
4935 cls_cursor_init(&cursor, &table->cls, NULL);
4936 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4937 eviction_group_add_rule(rule);
4941 /* Removes 'rule' from the oftable that contains it. */
4943 oftable_remove_rule(struct rule *rule)
4945 struct ofproto *ofproto = rule->ofproto;
4946 struct oftable *table = &ofproto->tables[rule->table_id];
4948 classifier_remove(&table->cls, &rule->cr);
4949 cookies_remove(ofproto, rule);
4950 eviction_group_remove_rule(rule);
4951 if (!list_is_empty(&rule->expirable)) {
4952 list_remove(&rule->expirable);
4956 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
4957 * oftable that has an identical cls_rule. Returns the rule that was removed,
4958 * if any, and otherwise NULL. */
4959 static struct rule *
4960 oftable_replace_rule(struct rule *rule)
4962 struct ofproto *ofproto = rule->ofproto;
4963 struct oftable *table = &ofproto->tables[rule->table_id];
4964 struct rule *victim;
4965 bool may_expire = rule->hard_timeout || rule->idle_timeout;
4968 list_insert(&ofproto->expirable, &rule->expirable);
4970 cookies_insert(ofproto, rule);
4972 victim = rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
4974 cookies_remove(ofproto, victim);
4976 if (!list_is_empty(&victim->expirable)) {
4977 list_remove(&victim->expirable);
4979 eviction_group_remove_rule(victim);
4981 eviction_group_add_rule(rule);
4985 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
4987 oftable_substitute_rule(struct rule *old, struct rule *new)
4990 oftable_replace_rule(new);
4992 oftable_remove_rule(old);
4996 /* unixctl commands. */
4999 ofproto_lookup(const char *name)
5001 struct ofproto *ofproto;
5003 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
5005 if (!strcmp(ofproto->name, name)) {
5013 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
5014 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
5016 struct ofproto *ofproto;
5020 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
5021 ds_put_format(&results, "%s\n", ofproto->name);
5023 unixctl_command_reply(conn, ds_cstr(&results));
5024 ds_destroy(&results);
5028 ofproto_unixctl_init(void)
5030 static bool registered;
5036 unixctl_command_register("ofproto/list", "", 0, 0,
5037 ofproto_unixctl_list, NULL);
5040 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
5042 * This is deprecated. It is only for compatibility with broken device drivers
5043 * in old versions of Linux that do not properly support VLANs when VLAN
5044 * devices are not used. When broken device drivers are no longer in
5045 * widespread use, we will delete these interfaces. */
5047 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
5048 * (exactly) by an OpenFlow rule in 'ofproto'. */
5050 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
5052 const struct oftable *oftable;
5054 free(ofproto->vlan_bitmap);
5055 ofproto->vlan_bitmap = bitmap_allocate(4096);
5056 ofproto->vlans_changed = false;
5058 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
5059 const struct cls_table *table;
5061 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
5062 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
5063 const struct cls_rule *rule;
5065 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
5066 uint16_t vid = miniflow_get_vid(&rule->match.flow);
5067 bitmap_set1(vlan_bitmap, vid);
5068 bitmap_set1(ofproto->vlan_bitmap, vid);
5075 /* Returns true if new VLANs have come into use by the flow table since the
5076 * last call to ofproto_get_vlan_usage().
5078 * We don't track when old VLANs stop being used. */
5080 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
5082 return ofproto->vlans_changed;
5085 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
5086 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
5087 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
5088 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
5089 * then the VLAN device is un-enslaved. */
5091 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
5092 uint16_t realdev_ofp_port, int vid)
5094 struct ofport *ofport;
5097 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
5099 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
5101 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
5102 ofproto->name, vlandev_ofp_port);
5106 if (!ofproto->ofproto_class->set_realdev) {
5107 if (!vlandev_ofp_port) {
5110 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
5114 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
5116 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
5117 ofproto->name, vlandev_ofp_port,
5118 netdev_get_name(ofport->netdev), strerror(error));