2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
25 #include "byte-order.h"
26 #include "classifier.h"
29 #include "dynamic-string.h"
32 #include "meta-flow.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
38 #include "ofp-print.h"
41 #include "ofproto-provider.h"
42 #include "openflow/nicira-ext.h"
43 #include "openflow/openflow.h"
47 #include "poll-loop.h"
53 #include "unaligned.h"
57 VLOG_DEFINE_THIS_MODULE(ofproto);
59 COVERAGE_DEFINE(ofproto_error);
60 COVERAGE_DEFINE(ofproto_flush);
61 COVERAGE_DEFINE(ofproto_no_packet_in);
62 COVERAGE_DEFINE(ofproto_packet_out);
63 COVERAGE_DEFINE(ofproto_queue_req);
64 COVERAGE_DEFINE(ofproto_recv_openflow);
65 COVERAGE_DEFINE(ofproto_reinit_ports);
66 COVERAGE_DEFINE(ofproto_uninstallable);
67 COVERAGE_DEFINE(ofproto_update_port);
70 S_OPENFLOW, /* Processing OpenFlow commands. */
71 S_EVICT, /* Evicting flows from over-limit tables. */
72 S_FLUSH, /* Deleting all flow table rules. */
75 enum ofoperation_type {
81 /* A single OpenFlow request can execute any number of operations. The
82 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
83 * ofconn to which an error reply should be sent if necessary.
85 * ofproto initiates some operations internally. These operations are still
86 * assigned to groups but will not have an associated ofconn. */
88 struct ofproto *ofproto; /* Owning ofproto. */
89 struct list ofproto_node; /* In ofproto's "pending" list. */
90 struct list ops; /* List of "struct ofoperation"s. */
91 int n_running; /* Number of ops still pending. */
93 /* Data needed to send OpenFlow reply on failure or to send a buffered
96 * If list_is_empty(ofconn_node) then this ofopgroup never had an
97 * associated ofconn or its ofconn's connection dropped after it initiated
98 * the operation. In the latter case 'ofconn' is a wild pointer that
99 * refers to freed memory, so the 'ofconn' member must be used only if
100 * !list_is_empty(ofconn_node).
102 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
103 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
104 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
105 uint32_t buffer_id; /* Buffer id from original request. */
108 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
109 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
110 const struct ofp_header *,
112 static void ofopgroup_submit(struct ofopgroup *);
113 static void ofopgroup_complete(struct ofopgroup *);
115 /* A single flow table operation. */
117 struct ofopgroup *group; /* Owning group. */
118 struct list group_node; /* In ofopgroup's "ops" list. */
119 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
120 struct rule *rule; /* Rule being operated upon. */
121 enum ofoperation_type type; /* Type of operation. */
123 /* OFOPERATION_ADD. */
124 struct rule *victim; /* Rule being replaced, if any.. */
126 /* OFOPERATION_MODIFY: The old actions, if the actions are changing. */
127 struct ofpact *ofpacts;
131 /* OFOPERATION_DELETE. */
132 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
134 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
135 enum ofperr error; /* 0 if no error. */
138 static struct ofoperation *ofoperation_create(struct ofopgroup *,
140 enum ofoperation_type,
141 enum ofp_flow_removed_reason);
142 static void ofoperation_destroy(struct ofoperation *);
145 static void oftable_init(struct oftable *);
146 static void oftable_destroy(struct oftable *);
148 static void oftable_set_name(struct oftable *, const char *name);
150 static void oftable_disable_eviction(struct oftable *);
151 static void oftable_enable_eviction(struct oftable *,
152 const struct mf_subfield *fields,
155 static void oftable_remove_rule(struct rule *);
156 static struct rule *oftable_replace_rule(struct rule *);
157 static void oftable_substitute_rule(struct rule *old, struct rule *new);
159 /* A set of rules within a single OpenFlow table (oftable) that have the same
160 * values for the oftable's eviction_fields. A rule to be evicted, when one is
161 * needed, is taken from the eviction group that contains the greatest number
164 * An oftable owns any number of eviction groups, each of which contains any
167 * Membership in an eviction group is imprecise, based on the hash of the
168 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
169 * That is, if two rules have different eviction_fields, but those
170 * eviction_fields hash to the same value, then they will belong to the same
171 * eviction_group anyway.
173 * (When eviction is not enabled on an oftable, we don't track any eviction
174 * groups, to save time and space.) */
175 struct eviction_group {
176 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
177 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
178 struct heap rules; /* Contains "struct rule"s. */
181 static struct rule *choose_rule_to_evict(struct oftable *);
182 static void ofproto_evict(struct ofproto *);
183 static uint32_t rule_eviction_priority(struct rule *);
186 static void ofport_destroy__(struct ofport *);
187 static void ofport_destroy(struct ofport *);
189 static void update_port(struct ofproto *, const char *devname);
190 static int init_ports(struct ofproto *);
191 static void reinit_ports(struct ofproto *);
194 static void ofproto_rule_destroy__(struct rule *);
195 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
196 static bool rule_is_modifiable(const struct rule *);
199 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
200 struct ofputil_flow_mod *,
201 const struct ofp_header *);
202 static void delete_flow__(struct rule *, struct ofopgroup *,
203 enum ofp_flow_removed_reason);
204 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
205 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
206 struct ofputil_flow_mod *,
207 const struct ofp_header *);
208 static void calc_duration(long long int start, long long int now,
209 uint32_t *sec, uint32_t *nsec);
212 static uint64_t pick_datapath_id(const struct ofproto *);
213 static uint64_t pick_fallback_dpid(void);
214 static void ofproto_destroy__(struct ofproto *);
215 static void update_mtu(struct ofproto *, struct ofport *);
216 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
219 static void ofproto_unixctl_init(void);
221 /* All registered ofproto classes, in probe order. */
222 static const struct ofproto_class **ofproto_classes;
223 static size_t n_ofproto_classes;
224 static size_t allocated_ofproto_classes;
226 unsigned flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT;
227 enum ofproto_flow_miss_model flow_miss_model = OFPROTO_HANDLE_MISS_AUTO;
229 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
230 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
232 /* Initial mappings of port to OpenFlow number mappings. */
233 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
235 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
237 /* The default value of true waits for flow restore. */
238 static bool flow_restore_wait = true;
240 /* Must be called to initialize the ofproto library.
242 * The caller may pass in 'iface_hints', which contains an shash of
243 * "iface_hint" elements indexed by the interface's name. The provider
244 * may use these hints to describe the startup configuration in order to
245 * reinitialize its state. The caller owns the provided data, so a
246 * provider will make copies of anything required. An ofproto provider
247 * will remove any existing state that is not described by the hint, and
248 * may choose to remove it all. */
250 ofproto_init(const struct shash *iface_hints)
252 struct shash_node *node;
255 ofproto_class_register(&ofproto_dpif_class);
257 /* Make a local copy, since we don't own 'iface_hints' elements. */
258 SHASH_FOR_EACH(node, iface_hints) {
259 const struct iface_hint *orig_hint = node->data;
260 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
261 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
263 new_hint->br_name = xstrdup(orig_hint->br_name);
264 new_hint->br_type = xstrdup(br_type);
265 new_hint->ofp_port = orig_hint->ofp_port;
267 shash_add(&init_ofp_ports, node->name, new_hint);
270 for (i = 0; i < n_ofproto_classes; i++) {
271 ofproto_classes[i]->init(&init_ofp_ports);
275 /* 'type' should be a normalized datapath type, as returned by
276 * ofproto_normalize_type(). Returns the corresponding ofproto_class
277 * structure, or a null pointer if there is none registered for 'type'. */
278 static const struct ofproto_class *
279 ofproto_class_find__(const char *type)
283 for (i = 0; i < n_ofproto_classes; i++) {
284 const struct ofproto_class *class = ofproto_classes[i];
289 class->enumerate_types(&types);
290 found = sset_contains(&types, type);
291 sset_destroy(&types);
297 VLOG_WARN("unknown datapath type %s", type);
301 /* Registers a new ofproto class. After successful registration, new ofprotos
302 * of that type can be created using ofproto_create(). */
304 ofproto_class_register(const struct ofproto_class *new_class)
308 for (i = 0; i < n_ofproto_classes; i++) {
309 if (ofproto_classes[i] == new_class) {
314 if (n_ofproto_classes >= allocated_ofproto_classes) {
315 ofproto_classes = x2nrealloc(ofproto_classes,
316 &allocated_ofproto_classes,
317 sizeof *ofproto_classes);
319 ofproto_classes[n_ofproto_classes++] = new_class;
323 /* Unregisters a datapath provider. 'type' must have been previously
324 * registered and not currently be in use by any ofprotos. After
325 * unregistration new datapaths of that type cannot be opened using
326 * ofproto_create(). */
328 ofproto_class_unregister(const struct ofproto_class *class)
332 for (i = 0; i < n_ofproto_classes; i++) {
333 if (ofproto_classes[i] == class) {
334 for (i++; i < n_ofproto_classes; i++) {
335 ofproto_classes[i - 1] = ofproto_classes[i];
341 VLOG_WARN("attempted to unregister an ofproto class that is not "
346 /* Clears 'types' and enumerates all registered ofproto types into it. The
347 * caller must first initialize the sset. */
349 ofproto_enumerate_types(struct sset *types)
353 for (i = 0; i < n_ofproto_classes; i++) {
354 ofproto_classes[i]->enumerate_types(types);
358 /* Returns the fully spelled out name for the given ofproto 'type'.
360 * Normalized type string can be compared with strcmp(). Unnormalized type
361 * string might be the same even if they have different spellings. */
363 ofproto_normalize_type(const char *type)
365 return type && type[0] ? type : "system";
368 /* Clears 'names' and enumerates the names of all known created ofprotos with
369 * the given 'type'. The caller must first initialize the sset. Returns 0 if
370 * successful, otherwise a positive errno value.
372 * Some kinds of datapaths might not be practically enumerable. This is not
373 * considered an error. */
375 ofproto_enumerate_names(const char *type, struct sset *names)
377 const struct ofproto_class *class = ofproto_class_find__(type);
378 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
382 ofproto_create(const char *datapath_name, const char *datapath_type,
383 struct ofproto **ofprotop)
385 const struct ofproto_class *class;
386 struct ofproto *ofproto;
392 ofproto_unixctl_init();
394 datapath_type = ofproto_normalize_type(datapath_type);
395 class = ofproto_class_find__(datapath_type);
397 VLOG_WARN("could not create datapath %s of unknown type %s",
398 datapath_name, datapath_type);
402 ofproto = class->alloc();
404 VLOG_ERR("failed to allocate datapath %s of type %s",
405 datapath_name, datapath_type);
410 memset(ofproto, 0, sizeof *ofproto);
411 ofproto->ofproto_class = class;
412 ofproto->name = xstrdup(datapath_name);
413 ofproto->type = xstrdup(datapath_type);
414 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
415 hash_string(ofproto->name, 0));
416 ofproto->datapath_id = 0;
417 ofproto->forward_bpdu = false;
418 ofproto->fallback_dpid = pick_fallback_dpid();
419 ofproto->mfr_desc = NULL;
420 ofproto->hw_desc = NULL;
421 ofproto->sw_desc = NULL;
422 ofproto->serial_desc = NULL;
423 ofproto->dp_desc = NULL;
424 ofproto->frag_handling = OFPC_FRAG_NORMAL;
425 hmap_init(&ofproto->ports);
426 shash_init(&ofproto->port_by_name);
427 simap_init(&ofproto->ofp_requests);
428 ofproto->max_ports = OFPP_MAX;
429 ofproto->tables = NULL;
430 ofproto->n_tables = 0;
431 hindex_init(&ofproto->cookies);
432 list_init(&ofproto->expirable);
433 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
434 ofproto->state = S_OPENFLOW;
435 list_init(&ofproto->pending);
436 ofproto->n_pending = 0;
437 hmap_init(&ofproto->deletions);
438 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
439 ofproto->first_op = ofproto->last_op = LLONG_MIN;
440 ofproto->next_op_report = LLONG_MAX;
441 ofproto->op_backoff = LLONG_MIN;
442 ofproto->vlan_bitmap = NULL;
443 ofproto->vlans_changed = false;
444 ofproto->min_mtu = INT_MAX;
446 error = ofproto->ofproto_class->construct(ofproto);
448 VLOG_ERR("failed to open datapath %s: %s",
449 datapath_name, ovs_strerror(error));
450 ofproto_destroy__(ofproto);
454 /* The "max_ports" member should have been set by ->construct(ofproto).
455 * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
456 ofproto->ofp_port_ids = bitmap_allocate(ofp_to_u16(ofproto->max_ports));
457 bitmap_set1(ofproto->ofp_port_ids, 0);
459 /* Check that hidden tables, if any, are at the end. */
460 ovs_assert(ofproto->n_tables);
461 for (i = 0; i + 1 < ofproto->n_tables; i++) {
462 enum oftable_flags flags = ofproto->tables[i].flags;
463 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
465 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
468 ofproto->datapath_id = pick_datapath_id(ofproto);
471 /* Initialize meters table. */
472 if (ofproto->ofproto_class->meter_get_features) {
473 ofproto->ofproto_class->meter_get_features(ofproto,
474 &ofproto->meter_features);
476 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
478 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
479 * sizeof(struct meter *));
485 /* Must be called (only) by an ofproto implementation in its constructor
486 * function. See the large comment on 'construct' in struct ofproto_class for
489 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
491 struct oftable *table;
493 ovs_assert(!ofproto->n_tables);
494 ovs_assert(n_tables >= 1 && n_tables <= 255);
496 ofproto->n_tables = n_tables;
497 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
498 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
503 /* To be optionally called (only) by an ofproto implementation in its
504 * constructor function. See the large comment on 'construct' in struct
505 * ofproto_class for details.
507 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
508 * will then ensure that actions passed into the ofproto implementation will
509 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
510 * function is not called, there will be no such restriction.
512 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
513 * the 'max_ports' restriction. */
515 ofproto_init_max_ports(struct ofproto *ofproto, ofp_port_t max_ports)
517 ovs_assert(ofp_to_u16(max_ports) <= ofp_to_u16(OFPP_MAX));
518 ofproto->max_ports = max_ports;
522 ofproto_get_datapath_id(const struct ofproto *ofproto)
524 return ofproto->datapath_id;
528 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
530 uint64_t old_dpid = p->datapath_id;
531 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
532 if (p->datapath_id != old_dpid) {
533 /* Force all active connections to reconnect, since there is no way to
534 * notify a controller that the datapath ID has changed. */
535 ofproto_reconnect_controllers(p);
540 ofproto_set_controllers(struct ofproto *p,
541 const struct ofproto_controller *controllers,
542 size_t n_controllers, uint32_t allowed_versions)
544 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
549 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
551 connmgr_set_fail_mode(p->connmgr, fail_mode);
554 /* Drops the connections between 'ofproto' and all of its controllers, forcing
555 * them to reconnect. */
557 ofproto_reconnect_controllers(struct ofproto *ofproto)
559 connmgr_reconnect(ofproto->connmgr);
562 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
563 * in-band control should guarantee access, in the same way that in-band
564 * control guarantees access to OpenFlow controllers. */
566 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
567 const struct sockaddr_in *extras, size_t n)
569 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
572 /* Sets the OpenFlow queue used by flows set up by in-band control on
573 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
574 * flows will use the default queue. */
576 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
578 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
581 /* Sets the number of flows at which eviction from the kernel flow table
584 ofproto_set_flow_eviction_threshold(unsigned threshold)
586 flow_eviction_threshold = MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN,
590 /* Sets the path for handling flow misses. */
592 ofproto_set_flow_miss_model(unsigned model)
594 flow_miss_model = model;
597 /* If forward_bpdu is true, the NORMAL action will forward frames with
598 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
599 * the NORMAL action will drop these frames. */
601 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
603 bool old_val = ofproto->forward_bpdu;
604 ofproto->forward_bpdu = forward_bpdu;
605 if (old_val != ofproto->forward_bpdu) {
606 if (ofproto->ofproto_class->forward_bpdu_changed) {
607 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
612 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
613 * 'idle_time', in seconds, and the maximum number of MAC table entries to
616 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
619 if (ofproto->ofproto_class->set_mac_table_config) {
620 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
626 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
629 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
633 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
635 return connmgr_set_snoops(ofproto->connmgr, snoops);
639 ofproto_set_netflow(struct ofproto *ofproto,
640 const struct netflow_options *nf_options)
642 if (nf_options && sset_is_empty(&nf_options->collectors)) {
646 if (ofproto->ofproto_class->set_netflow) {
647 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
649 return nf_options ? EOPNOTSUPP : 0;
654 ofproto_set_sflow(struct ofproto *ofproto,
655 const struct ofproto_sflow_options *oso)
657 if (oso && sset_is_empty(&oso->targets)) {
661 if (ofproto->ofproto_class->set_sflow) {
662 return ofproto->ofproto_class->set_sflow(ofproto, oso);
664 return oso ? EOPNOTSUPP : 0;
669 ofproto_set_ipfix(struct ofproto *ofproto,
670 const struct ofproto_ipfix_bridge_exporter_options *bo,
671 const struct ofproto_ipfix_flow_exporter_options *fo,
674 if (ofproto->ofproto_class->set_ipfix) {
675 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
677 return (bo || fo) ? EOPNOTSUPP : 0;
682 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
684 flow_restore_wait = flow_restore_wait_db;
688 ofproto_get_flow_restore_wait(void)
690 return flow_restore_wait;
694 /* Spanning Tree Protocol (STP) configuration. */
696 /* Configures STP on 'ofproto' using the settings defined in 's'. If
697 * 's' is NULL, disables STP.
699 * Returns 0 if successful, otherwise a positive errno value. */
701 ofproto_set_stp(struct ofproto *ofproto,
702 const struct ofproto_stp_settings *s)
704 return (ofproto->ofproto_class->set_stp
705 ? ofproto->ofproto_class->set_stp(ofproto, s)
709 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
710 * 'enabled' member of 's' is false, then the other members are not
713 * Returns 0 if successful, otherwise a positive errno value. */
715 ofproto_get_stp_status(struct ofproto *ofproto,
716 struct ofproto_stp_status *s)
718 return (ofproto->ofproto_class->get_stp_status
719 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
723 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
724 * in 's'. The caller is responsible for assigning STP port numbers
725 * (using the 'port_num' member in the range of 1 through 255, inclusive)
726 * and ensuring there are no duplicates. If the 's' is NULL, then STP
727 * is disabled on the port.
729 * Returns 0 if successful, otherwise a positive errno value.*/
731 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
732 const struct ofproto_port_stp_settings *s)
734 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
736 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
737 ofproto->name, ofp_port);
741 return (ofproto->ofproto_class->set_stp_port
742 ? ofproto->ofproto_class->set_stp_port(ofport, s)
746 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
747 * 's'. If the 'enabled' member in 's' is false, then the other members
748 * are not meaningful.
750 * Returns 0 if successful, otherwise a positive errno value.*/
752 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
753 struct ofproto_port_stp_status *s)
755 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
757 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
758 "port %"PRIu16, ofproto->name, ofp_port);
762 return (ofproto->ofproto_class->get_stp_port_status
763 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
767 /* Queue DSCP configuration. */
769 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
770 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
771 * to implement QoS. Instead, it is used to implement features which require
772 * knowledge of what queues exist on a port, and some basic information about
775 * Returns 0 if successful, otherwise a positive errno value. */
777 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
778 const struct ofproto_port_queue *queues,
781 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
784 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
785 ofproto->name, ofp_port);
789 return (ofproto->ofproto_class->set_queues
790 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
794 /* Connectivity Fault Management configuration. */
796 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
798 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
800 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
801 if (ofport && ofproto->ofproto_class->set_cfm) {
802 ofproto->ofproto_class->set_cfm(ofport, NULL);
806 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
807 * basic configuration from the configuration members in 'cfm', and the remote
808 * maintenance point ID from remote_mpid. Ignores the statistics members of
811 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
813 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
814 const struct cfm_settings *s)
816 struct ofport *ofport;
819 ofport = ofproto_get_port(ofproto, ofp_port);
821 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
822 ofproto->name, ofp_port);
826 /* XXX: For configuration simplicity, we only support one remote_mpid
827 * outside of the CFM module. It's not clear if this is the correct long
828 * term solution or not. */
829 error = (ofproto->ofproto_class->set_cfm
830 ? ofproto->ofproto_class->set_cfm(ofport, s)
833 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
834 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
835 ovs_strerror(error));
839 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
840 * 'ofproto' does not have a port 'ofp_port'. */
842 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
843 const struct smap *cfg)
845 struct ofport *ofport;
848 ofport = ofproto_get_port(ofproto, ofp_port);
850 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
851 ofproto->name, ofp_port);
855 error = (ofproto->ofproto_class->set_bfd
856 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
859 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
860 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
861 ovs_strerror(error));
865 /* Populates 'status' with key value pairs indicating the status of the BFD
866 * session on 'ofp_port'. This information is intended to be populated in the
867 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
870 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
873 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
874 return (ofport && ofproto->ofproto_class->get_bfd_status
875 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
879 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
880 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
881 * 0 if LACP partner information is not current (generally indicating a
882 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
884 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
886 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
887 return (ofport && ofproto->ofproto_class->port_is_lacp_current
888 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
894 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
895 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
896 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
897 * configuration plus, if there is more than one slave, a bonding
900 * If 'aux' is already registered then this function updates its configuration
901 * to 's'. Otherwise, this function registers a new bundle.
903 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
906 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
907 const struct ofproto_bundle_settings *s)
909 return (ofproto->ofproto_class->bundle_set
910 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
914 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
915 * If no such bundle has been registered, this has no effect. */
917 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
919 return ofproto_bundle_register(ofproto, aux, NULL);
923 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
924 * If 'aux' is already registered then this function updates its configuration
925 * to 's'. Otherwise, this function registers a new mirror. */
927 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
928 const struct ofproto_mirror_settings *s)
930 return (ofproto->ofproto_class->mirror_set
931 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
935 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
936 * If no mirror has been registered, this has no effect. */
938 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
940 return ofproto_mirror_register(ofproto, aux, NULL);
943 /* Retrieves statistics from mirror associated with client data pointer
944 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
945 * 'bytes', respectively. If a particular counters is not supported,
946 * the appropriate argument is set to UINT64_MAX. */
948 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
949 uint64_t *packets, uint64_t *bytes)
951 if (!ofproto->ofproto_class->mirror_get_stats) {
952 *packets = *bytes = UINT64_MAX;
956 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
960 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
961 * which all packets are flooded, instead of using MAC learning. If
962 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
964 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
967 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
969 return (ofproto->ofproto_class->set_flood_vlans
970 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
974 /* Returns true if 'aux' is a registered bundle that is currently in use as the
975 * output for a mirror. */
977 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
979 return (ofproto->ofproto_class->is_mirror_output_bundle
980 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
984 /* Configuration of OpenFlow tables. */
986 /* Returns the number of OpenFlow tables in 'ofproto'. */
988 ofproto_get_n_tables(const struct ofproto *ofproto)
990 return ofproto->n_tables;
993 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
994 * settings from 's'. 'table_id' must be in the range 0 through the number of
995 * OpenFlow tables in 'ofproto' minus 1, inclusive.
997 * For read-only tables, only the name may be configured. */
999 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1000 const struct ofproto_table_settings *s)
1002 struct oftable *table;
1004 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1005 table = &ofproto->tables[table_id];
1007 oftable_set_name(table, s->name);
1009 if (table->flags & OFTABLE_READONLY) {
1014 oftable_enable_eviction(table, s->groups, s->n_groups);
1016 oftable_disable_eviction(table);
1019 table->max_flows = s->max_flows;
1020 if (classifier_count(&table->cls) > table->max_flows
1021 && table->eviction_fields) {
1022 /* 'table' contains more flows than allowed. We might not be able to
1023 * evict them right away because of the asynchronous nature of flow
1024 * table changes. Schedule eviction for later. */
1025 switch (ofproto->state) {
1027 ofproto->state = S_EVICT;
1031 /* We're already deleting flows, nothing more to do. */
1038 ofproto_has_snoops(const struct ofproto *ofproto)
1040 return connmgr_has_snoops(ofproto->connmgr);
1044 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1046 connmgr_get_snoops(ofproto->connmgr, snoops);
1050 ofproto_flush__(struct ofproto *ofproto)
1052 struct ofopgroup *group;
1053 struct oftable *table;
1055 if (ofproto->ofproto_class->flush) {
1056 ofproto->ofproto_class->flush(ofproto);
1059 group = ofopgroup_create_unattached(ofproto);
1060 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1061 struct rule *rule, *next_rule;
1062 struct cls_cursor cursor;
1064 if (table->flags & OFTABLE_HIDDEN) {
1068 cls_cursor_init(&cursor, &table->cls, NULL);
1069 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1070 if (!rule->pending) {
1071 ofoperation_create(group, rule, OFOPERATION_DELETE,
1073 oftable_remove_rule(rule);
1074 ofproto->ofproto_class->rule_destruct(rule);
1078 ofopgroup_submit(group);
1082 ofproto_destroy__(struct ofproto *ofproto)
1084 struct oftable *table;
1086 ovs_assert(list_is_empty(&ofproto->pending));
1087 ovs_assert(!ofproto->n_pending);
1089 if (ofproto->meters) {
1090 meter_delete(ofproto, 1, ofproto->meter_features.max_meters);
1091 free(ofproto->meters);
1094 connmgr_destroy(ofproto->connmgr);
1096 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1097 free(ofproto->name);
1098 free(ofproto->type);
1099 free(ofproto->mfr_desc);
1100 free(ofproto->hw_desc);
1101 free(ofproto->sw_desc);
1102 free(ofproto->serial_desc);
1103 free(ofproto->dp_desc);
1104 hmap_destroy(&ofproto->ports);
1105 shash_destroy(&ofproto->port_by_name);
1106 bitmap_free(ofproto->ofp_port_ids);
1107 simap_destroy(&ofproto->ofp_requests);
1109 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1110 oftable_destroy(table);
1112 free(ofproto->tables);
1114 hmap_destroy(&ofproto->deletions);
1116 free(ofproto->vlan_bitmap);
1118 ofproto->ofproto_class->dealloc(ofproto);
1122 ofproto_destroy(struct ofproto *p)
1124 struct ofport *ofport, *next_ofport;
1131 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1132 ofport_destroy(ofport);
1135 p->ofproto_class->destruct(p);
1136 ofproto_destroy__(p);
1139 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1140 * kernel datapath, for example, this destroys the datapath in the kernel, and
1141 * with the netdev-based datapath, it tears down the data structures that
1142 * represent the datapath.
1144 * The datapath should not be currently open as an ofproto. */
1146 ofproto_delete(const char *name, const char *type)
1148 const struct ofproto_class *class = ofproto_class_find__(type);
1149 return (!class ? EAFNOSUPPORT
1150 : !class->del ? EACCES
1151 : class->del(type, name));
1155 process_port_change(struct ofproto *ofproto, int error, char *devname)
1157 if (error == ENOBUFS) {
1158 reinit_ports(ofproto);
1159 } else if (!error) {
1160 update_port(ofproto, devname);
1166 ofproto_type_run(const char *datapath_type)
1168 const struct ofproto_class *class;
1171 datapath_type = ofproto_normalize_type(datapath_type);
1172 class = ofproto_class_find__(datapath_type);
1174 error = class->type_run ? class->type_run(datapath_type) : 0;
1175 if (error && error != EAGAIN) {
1176 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1177 datapath_type, ovs_strerror(error));
1183 ofproto_type_run_fast(const char *datapath_type)
1185 const struct ofproto_class *class;
1188 datapath_type = ofproto_normalize_type(datapath_type);
1189 class = ofproto_class_find__(datapath_type);
1191 error = class->type_run_fast ? class->type_run_fast(datapath_type) : 0;
1192 if (error && error != EAGAIN) {
1193 VLOG_ERR_RL(&rl, "%s: type_run_fast failed (%s)",
1194 datapath_type, ovs_strerror(error));
1200 ofproto_type_wait(const char *datapath_type)
1202 const struct ofproto_class *class;
1204 datapath_type = ofproto_normalize_type(datapath_type);
1205 class = ofproto_class_find__(datapath_type);
1207 if (class->type_wait) {
1208 class->type_wait(datapath_type);
1213 ofproto_run(struct ofproto *p)
1215 struct sset changed_netdevs;
1216 const char *changed_netdev;
1217 struct ofport *ofport;
1220 error = p->ofproto_class->run(p);
1221 if (error && error != EAGAIN) {
1222 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1225 if (p->ofproto_class->port_poll) {
1228 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1229 process_port_change(p, error, devname);
1233 /* Update OpenFlow port status for any port whose netdev has changed.
1235 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1236 * destroyed, so it's not safe to update ports directly from the
1237 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1238 * need this two-phase approach. */
1239 sset_init(&changed_netdevs);
1240 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1241 unsigned int change_seq = netdev_change_seq(ofport->netdev);
1242 if (ofport->change_seq != change_seq) {
1243 ofport->change_seq = change_seq;
1244 sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1247 SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1248 update_port(p, changed_netdev);
1250 sset_destroy(&changed_netdevs);
1254 connmgr_run(p->connmgr, handle_openflow);
1258 connmgr_run(p->connmgr, NULL);
1260 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1261 p->state = S_OPENFLOW;
1266 connmgr_run(p->connmgr, NULL);
1268 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1269 connmgr_flushed(p->connmgr);
1270 p->state = S_OPENFLOW;
1278 if (time_msec() >= p->next_op_report) {
1279 long long int ago = (time_msec() - p->first_op) / 1000;
1280 long long int interval = (p->last_op - p->first_op) / 1000;
1284 ds_put_format(&s, "%d flow_mods ",
1285 p->n_add + p->n_delete + p->n_modify);
1286 if (interval == ago) {
1287 ds_put_format(&s, "in the last %lld s", ago);
1288 } else if (interval) {
1289 ds_put_format(&s, "in the %lld s starting %lld s ago",
1292 ds_put_format(&s, "%lld s ago", ago);
1295 ds_put_cstr(&s, " (");
1297 ds_put_format(&s, "%d adds, ", p->n_add);
1300 ds_put_format(&s, "%d deletes, ", p->n_delete);
1303 ds_put_format(&s, "%d modifications, ", p->n_modify);
1306 ds_put_char(&s, ')');
1308 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1311 p->n_add = p->n_delete = p->n_modify = 0;
1312 p->next_op_report = LLONG_MAX;
1318 /* Performs periodic activity required by 'ofproto' that needs to be done
1319 * with the least possible latency.
1321 * It makes sense to call this function a couple of times per poll loop, to
1322 * provide a significant performance boost on some benchmarks with the
1323 * ofproto-dpif implementation. */
1325 ofproto_run_fast(struct ofproto *p)
1329 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1330 if (error && error != EAGAIN) {
1331 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1332 p->name, ovs_strerror(error));
1338 ofproto_wait(struct ofproto *p)
1340 struct ofport *ofport;
1342 p->ofproto_class->wait(p);
1343 if (p->ofproto_class->port_poll_wait) {
1344 p->ofproto_class->port_poll_wait(p);
1347 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1348 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1349 poll_immediate_wake();
1355 connmgr_wait(p->connmgr, true);
1360 connmgr_wait(p->connmgr, false);
1361 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1362 poll_immediate_wake();
1369 ofproto_is_alive(const struct ofproto *p)
1371 return connmgr_has_controllers(p->connmgr);
1374 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1375 * memory_report(). */
1377 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1379 const struct oftable *table;
1380 unsigned int n_rules;
1382 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1383 simap_increase(usage, "ops",
1384 ofproto->n_pending + hmap_count(&ofproto->deletions));
1387 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1388 n_rules += classifier_count(&table->cls);
1390 simap_increase(usage, "rules", n_rules);
1392 if (ofproto->ofproto_class->get_memory_usage) {
1393 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1396 connmgr_get_memory_usage(ofproto->connmgr, usage);
1400 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1403 connmgr_get_controller_info(ofproto->connmgr, info);
1407 ofproto_free_ofproto_controller_info(struct shash *info)
1409 connmgr_free_controller_info(info);
1412 /* Makes a deep copy of 'old' into 'port'. */
1414 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1416 port->name = xstrdup(old->name);
1417 port->type = xstrdup(old->type);
1418 port->ofp_port = old->ofp_port;
1421 /* Frees memory allocated to members of 'ofproto_port'.
1423 * Do not call this function on an ofproto_port obtained from
1424 * ofproto_port_dump_next(): that function retains ownership of the data in the
1427 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1429 free(ofproto_port->name);
1430 free(ofproto_port->type);
1433 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1435 * This function provides no status indication. An error status for the entire
1436 * dump operation is provided when it is completed by calling
1437 * ofproto_port_dump_done().
1440 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1441 const struct ofproto *ofproto)
1443 dump->ofproto = ofproto;
1444 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1448 /* Attempts to retrieve another port from 'dump', which must have been created
1449 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1450 * 'port' and returns true. On failure, returns false.
1452 * Failure might indicate an actual error or merely that the last port has been
1453 * dumped. An error status for the entire dump operation is provided when it
1454 * is completed by calling ofproto_port_dump_done().
1456 * The ofproto owns the data stored in 'port'. It will remain valid until at
1457 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1458 * ofproto_port_dump_done(). */
1460 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1461 struct ofproto_port *port)
1463 const struct ofproto *ofproto = dump->ofproto;
1469 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1472 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1478 /* Completes port table dump operation 'dump', which must have been created
1479 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1480 * error-free, otherwise a positive errno value describing the problem. */
1482 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1484 const struct ofproto *ofproto = dump->ofproto;
1486 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1489 return dump->error == EOF ? 0 : dump->error;
1492 /* Returns the type to pass to netdev_open() when a datapath of type
1493 * 'datapath_type' has a port of type 'port_type', for a few special
1494 * cases when a netdev type differs from a port type. For example, when
1495 * using the userspace datapath, a port of type "internal" needs to be
1498 * Returns either 'type' itself or a string literal, which must not be
1501 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1503 const struct ofproto_class *class;
1505 datapath_type = ofproto_normalize_type(datapath_type);
1506 class = ofproto_class_find__(datapath_type);
1511 return (class->port_open_type
1512 ? class->port_open_type(datapath_type, port_type)
1516 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1517 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1518 * the port's OpenFlow port number.
1520 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1521 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1522 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1523 * 'ofp_portp' is non-null). */
1525 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1526 ofp_port_t *ofp_portp)
1528 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1531 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1533 const char *netdev_name = netdev_get_name(netdev);
1535 simap_put(&ofproto->ofp_requests, netdev_name,
1536 ofp_to_u16(ofp_port));
1537 update_port(ofproto, netdev_name);
1540 struct ofproto_port ofproto_port;
1542 ofproto_port_query_by_name(ofproto, netdev_get_name(netdev),
1544 *ofp_portp = error ? OFPP_NONE : ofproto_port.ofp_port;
1545 ofproto_port_destroy(&ofproto_port);
1550 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1551 * initializes '*port' appropriately; on failure, returns a positive errno
1554 * The caller owns the data in 'ofproto_port' and must free it with
1555 * ofproto_port_destroy() when it is no longer needed. */
1557 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1558 struct ofproto_port *port)
1562 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1564 memset(port, 0, sizeof *port);
1569 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1570 * Returns 0 if successful, otherwise a positive errno. */
1572 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1574 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1575 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1576 struct simap_node *ofp_request_node;
1579 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1580 if (ofp_request_node) {
1581 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1584 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1585 if (!error && ofport) {
1586 /* 'name' is the netdev's name and update_port() is going to close the
1587 * netdev. Just in case update_port() refers to 'name' after it
1588 * destroys 'ofport', make a copy of it around the update_port()
1590 char *devname = xstrdup(name);
1591 update_port(ofproto, devname);
1597 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1598 * performs the 'n_actions' actions in 'actions'. The new flow will not
1601 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1602 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1603 * controllers; otherwise, it will be hidden.
1605 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1607 * This is a helper function for in-band control and fail-open. */
1609 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1610 unsigned int priority,
1611 const struct ofpact *ofpacts, size_t ofpacts_len)
1613 const struct rule *rule;
1615 rule = rule_from_cls_rule(classifier_find_match_exactly(
1616 &ofproto->tables[0].cls, match, priority));
1617 if (!rule || !ofpacts_equal(rule->ofpacts, rule->ofpacts_len,
1618 ofpacts, ofpacts_len)) {
1619 struct ofputil_flow_mod fm;
1621 memset(&fm, 0, sizeof fm);
1623 fm.priority = priority;
1624 fm.buffer_id = UINT32_MAX;
1625 fm.ofpacts = xmemdup(ofpacts, ofpacts_len);
1626 fm.ofpacts_len = ofpacts_len;
1627 add_flow(ofproto, NULL, &fm, NULL);
1632 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1633 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1634 * operation cannot be initiated now but may be retried later.
1636 * This is a helper function for in-band control and fail-open. */
1638 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1640 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1643 /* Searches for a rule with matching criteria exactly equal to 'target' in
1644 * ofproto's table 0 and, if it finds one, deletes it.
1646 * This is a helper function for in-band control and fail-open. */
1648 ofproto_delete_flow(struct ofproto *ofproto,
1649 const struct match *target, unsigned int priority)
1653 rule = rule_from_cls_rule(classifier_find_match_exactly(
1654 &ofproto->tables[0].cls, target, priority));
1656 /* No such rule -> success. */
1658 } else if (rule->pending) {
1659 /* An operation on the rule is already pending -> failure.
1660 * Caller must retry later if it's important. */
1663 /* Initiate deletion -> success. */
1664 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1665 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1666 oftable_remove_rule(rule);
1667 ofproto->ofproto_class->rule_destruct(rule);
1668 ofopgroup_submit(group);
1674 /* Starts the process of deleting all of the flows from all of ofproto's flow
1675 * tables and then reintroducing the flows required by in-band control and
1676 * fail-open. The process will complete in a later call to ofproto_run(). */
1678 ofproto_flush_flows(struct ofproto *ofproto)
1680 COVERAGE_INC(ofproto_flush);
1681 ofproto->state = S_FLUSH;
1685 reinit_ports(struct ofproto *p)
1687 struct ofproto_port_dump dump;
1688 struct sset devnames;
1689 struct ofport *ofport;
1690 struct ofproto_port ofproto_port;
1691 const char *devname;
1693 COVERAGE_INC(ofproto_reinit_ports);
1695 sset_init(&devnames);
1696 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1697 sset_add(&devnames, netdev_get_name(ofport->netdev));
1699 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1700 sset_add(&devnames, ofproto_port.name);
1703 SSET_FOR_EACH (devname, &devnames) {
1704 update_port(p, devname);
1706 sset_destroy(&devnames);
1710 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
1712 uint16_t max_ports = ofp_to_u16(ofproto->max_ports);
1715 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
1717 port_idx = UINT16_MAX;
1720 if (port_idx >= max_ports
1721 || bitmap_is_set(ofproto->ofp_port_ids, port_idx)) {
1722 uint16_t end_port_no = ofp_to_u16(ofproto->alloc_port_no);
1723 uint16_t alloc_port_no = end_port_no;
1725 /* Search for a free OpenFlow port number. We try not to
1726 * immediately reuse them to prevent problems due to old
1729 if (++alloc_port_no >= max_ports) {
1732 if (!bitmap_is_set(ofproto->ofp_port_ids, alloc_port_no)) {
1733 port_idx = alloc_port_no;
1734 ofproto->alloc_port_no = u16_to_ofp(alloc_port_no);
1737 if (alloc_port_no == end_port_no) {
1742 bitmap_set1(ofproto->ofp_port_ids, port_idx);
1743 return u16_to_ofp(port_idx);
1747 dealloc_ofp_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
1749 if (ofp_to_u16(ofp_port) < ofp_to_u16(ofproto->max_ports)) {
1750 bitmap_set0(ofproto->ofp_port_ids, ofp_to_u16(ofp_port));
1754 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1755 * pointer if the netdev cannot be opened. On success, also fills in
1757 static struct netdev *
1758 ofport_open(struct ofproto *ofproto,
1759 struct ofproto_port *ofproto_port,
1760 struct ofputil_phy_port *pp)
1762 enum netdev_flags flags;
1763 struct netdev *netdev;
1766 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1768 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1769 "cannot be opened (%s)",
1771 ofproto_port->name, ofproto_port->ofp_port,
1772 ofproto_port->name, ovs_strerror(error));
1776 if (ofproto_port->ofp_port == OFPP_NONE) {
1777 if (!strcmp(ofproto->name, ofproto_port->name)) {
1778 ofproto_port->ofp_port = OFPP_LOCAL;
1780 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1781 ofproto_port->name);
1784 pp->port_no = ofproto_port->ofp_port;
1785 netdev_get_etheraddr(netdev, pp->hw_addr);
1786 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1787 netdev_get_flags(netdev, &flags);
1788 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1789 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1790 netdev_get_features(netdev, &pp->curr, &pp->advertised,
1791 &pp->supported, &pp->peer);
1792 pp->curr_speed = netdev_features_to_bps(pp->curr, 0);
1793 pp->max_speed = netdev_features_to_bps(pp->supported, 0);
1798 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1799 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1802 ofport_equal(const struct ofputil_phy_port *a,
1803 const struct ofputil_phy_port *b)
1805 return (eth_addr_equals(a->hw_addr, b->hw_addr)
1806 && a->state == b->state
1807 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1808 && a->curr == b->curr
1809 && a->advertised == b->advertised
1810 && a->supported == b->supported
1811 && a->peer == b->peer
1812 && a->curr_speed == b->curr_speed
1813 && a->max_speed == b->max_speed);
1816 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1817 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1818 * one with the same name or port number). */
1820 ofport_install(struct ofproto *p,
1821 struct netdev *netdev, const struct ofputil_phy_port *pp)
1823 const char *netdev_name = netdev_get_name(netdev);
1824 struct ofport *ofport;
1827 /* Create ofport. */
1828 ofport = p->ofproto_class->port_alloc();
1833 ofport->ofproto = p;
1834 ofport->netdev = netdev;
1835 ofport->change_seq = netdev_change_seq(netdev);
1837 ofport->ofp_port = pp->port_no;
1838 ofport->created = time_msec();
1840 /* Add port to 'p'. */
1841 hmap_insert(&p->ports, &ofport->hmap_node,
1842 hash_ofp_port(ofport->ofp_port));
1843 shash_add(&p->port_by_name, netdev_name, ofport);
1845 update_mtu(p, ofport);
1847 /* Let the ofproto_class initialize its private data. */
1848 error = p->ofproto_class->port_construct(ofport);
1852 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1856 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1857 p->name, netdev_name, ovs_strerror(error));
1859 ofport_destroy__(ofport);
1861 netdev_close(netdev);
1865 /* Removes 'ofport' from 'p' and destroys it. */
1867 ofport_remove(struct ofport *ofport)
1869 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1871 ofport_destroy(ofport);
1874 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1877 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1879 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1881 ofport_remove(port);
1885 /* Updates 'port' with new 'pp' description.
1887 * Does not handle a name or port number change. The caller must implement
1888 * such a change as a delete followed by an add. */
1890 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1892 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1893 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1894 | (pp->config & OFPUTIL_PC_PORT_DOWN));
1895 port->pp.state = pp->state;
1896 port->pp.curr = pp->curr;
1897 port->pp.advertised = pp->advertised;
1898 port->pp.supported = pp->supported;
1899 port->pp.peer = pp->peer;
1900 port->pp.curr_speed = pp->curr_speed;
1901 port->pp.max_speed = pp->max_speed;
1903 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1906 /* Update OpenFlow 'state' in 'port' and notify controller. */
1908 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
1910 if (port->pp.state != state) {
1911 port->pp.state = state;
1912 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
1918 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
1920 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1922 if (port->ofproto->ofproto_class->set_realdev) {
1923 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1925 if (port->ofproto->ofproto_class->set_stp_port) {
1926 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1928 if (port->ofproto->ofproto_class->set_cfm) {
1929 port->ofproto->ofproto_class->set_cfm(port, NULL);
1931 if (port->ofproto->ofproto_class->bundle_remove) {
1932 port->ofproto->ofproto_class->bundle_remove(port);
1938 ofport_destroy__(struct ofport *port)
1940 struct ofproto *ofproto = port->ofproto;
1941 const char *name = netdev_get_name(port->netdev);
1943 hmap_remove(&ofproto->ports, &port->hmap_node);
1944 shash_delete(&ofproto->port_by_name,
1945 shash_find(&ofproto->port_by_name, name));
1947 netdev_close(port->netdev);
1948 ofproto->ofproto_class->port_dealloc(port);
1952 ofport_destroy(struct ofport *port)
1955 dealloc_ofp_port(port->ofproto, port->ofp_port);
1956 port->ofproto->ofproto_class->port_destruct(port);
1957 ofport_destroy__(port);
1962 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
1964 struct ofport *port;
1966 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
1968 if (port->ofp_port == ofp_port) {
1976 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1978 struct ofproto *ofproto = port->ofproto;
1981 if (ofproto->ofproto_class->port_get_stats) {
1982 error = ofproto->ofproto_class->port_get_stats(port, stats);
1991 update_port(struct ofproto *ofproto, const char *name)
1993 struct ofproto_port ofproto_port;
1994 struct ofputil_phy_port pp;
1995 struct netdev *netdev;
1996 struct ofport *port;
1998 COVERAGE_INC(ofproto_update_port);
2000 /* Fetch 'name''s location and properties from the datapath. */
2001 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2002 ? ofport_open(ofproto, &ofproto_port, &pp)
2006 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2007 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2008 struct netdev *old_netdev = port->netdev;
2010 /* 'name' hasn't changed location. Any properties changed? */
2011 if (!ofport_equal(&port->pp, &pp)) {
2012 ofport_modified(port, &pp);
2015 update_mtu(ofproto, port);
2017 /* Install the newly opened netdev in case it has changed.
2018 * Don't close the old netdev yet in case port_modified has to
2019 * remove a retained reference to it.*/
2020 port->netdev = netdev;
2021 port->change_seq = netdev_change_seq(netdev);
2023 if (port->ofproto->ofproto_class->port_modified) {
2024 port->ofproto->ofproto_class->port_modified(port);
2027 netdev_close(old_netdev);
2029 /* If 'port' is nonnull then its name differs from 'name' and thus
2030 * we should delete it. If we think there's a port named 'name'
2031 * then its port number must be wrong now so delete it too. */
2033 ofport_remove(port);
2035 ofport_remove_with_name(ofproto, name);
2036 ofport_install(ofproto, netdev, &pp);
2039 /* Any port named 'name' is gone now. */
2040 ofport_remove_with_name(ofproto, name);
2042 ofproto_port_destroy(&ofproto_port);
2046 init_ports(struct ofproto *p)
2048 struct ofproto_port_dump dump;
2049 struct ofproto_port ofproto_port;
2050 struct shash_node *node, *next;
2052 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2053 const char *name = ofproto_port.name;
2055 if (shash_find(&p->port_by_name, name)) {
2056 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2059 struct ofputil_phy_port pp;
2060 struct netdev *netdev;
2062 /* Check if an OpenFlow port number had been requested. */
2063 node = shash_find(&init_ofp_ports, name);
2065 const struct iface_hint *iface_hint = node->data;
2066 simap_put(&p->ofp_requests, name,
2067 ofp_to_u16(iface_hint->ofp_port));
2070 netdev = ofport_open(p, &ofproto_port, &pp);
2072 ofport_install(p, netdev, &pp);
2077 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2078 struct iface_hint *iface_hint = node->data;
2080 if (!strcmp(iface_hint->br_name, p->name)) {
2081 free(iface_hint->br_name);
2082 free(iface_hint->br_type);
2084 shash_delete(&init_ofp_ports, node);
2091 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2092 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2094 find_min_mtu(struct ofproto *p)
2096 struct ofport *ofport;
2099 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2100 struct netdev *netdev = ofport->netdev;
2103 /* Skip any internal ports, since that's what we're trying to
2105 if (!strcmp(netdev_get_type(netdev), "internal")) {
2109 if (netdev_get_mtu(netdev, &dev_mtu)) {
2112 if (!mtu || dev_mtu < mtu) {
2117 return mtu ? mtu: ETH_PAYLOAD_MAX;
2120 /* Update MTU of all datapath devices on 'p' to the minimum of the
2121 * non-datapath ports in event of 'port' added or changed. */
2123 update_mtu(struct ofproto *p, struct ofport *port)
2125 struct ofport *ofport;
2126 struct netdev *netdev = port->netdev;
2127 int dev_mtu, old_min;
2129 if (netdev_get_mtu(netdev, &dev_mtu)) {
2133 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2134 if (dev_mtu > p->min_mtu) {
2135 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2136 dev_mtu = p->min_mtu;
2139 port->mtu = dev_mtu;
2143 /* For non-internal port find new min mtu. */
2144 old_min = p->min_mtu;
2145 port->mtu = dev_mtu;
2146 p->min_mtu = find_min_mtu(p);
2147 if (p->min_mtu == old_min) {
2151 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2152 struct netdev *netdev = ofport->netdev;
2154 if (!strcmp(netdev_get_type(netdev), "internal")) {
2155 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2156 ofport->mtu = p->min_mtu;
2163 ofproto_rule_destroy__(struct rule *rule)
2166 cls_rule_destroy(&rule->cr);
2167 free(rule->ofpacts);
2168 rule->ofproto->ofproto_class->rule_dealloc(rule);
2172 /* This function allows an ofproto implementation to destroy any rules that
2173 * remain when its ->destruct() function is called. The caller must have
2174 * already uninitialized any derived members of 'rule' (step 5 described in the
2175 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
2176 * This function implements steps 6 and 7.
2178 * This function should only be called from an ofproto implementation's
2179 * ->destruct() function. It is not suitable elsewhere. */
2181 ofproto_rule_destroy(struct rule *rule)
2183 ovs_assert(!rule->pending);
2184 oftable_remove_rule(rule);
2185 ofproto_rule_destroy__(rule);
2188 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2189 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2191 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2193 return (port == OFPP_ANY
2194 || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
2197 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2198 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2200 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2202 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2207 case OFOPERATION_ADD:
2208 return op->victim && ofproto_rule_has_out_port(op->victim, out_port);
2210 case OFOPERATION_DELETE:
2213 case OFOPERATION_MODIFY:
2214 return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
2220 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2221 * statistics appropriately. 'packet' must have at least sizeof(struct
2222 * ofp10_packet_in) bytes of headroom.
2224 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
2225 * with statistics for 'packet' either way.
2227 * Takes ownership of 'packet'. */
2229 rule_execute(struct rule *rule, ofp_port_t in_port, struct ofpbuf *packet)
2232 union flow_in_port in_port_;
2234 ovs_assert(ofpbuf_headroom(packet) >= sizeof(struct ofp10_packet_in));
2236 in_port_.ofp_port = in_port;
2237 flow_extract(packet, 0, 0, NULL, &in_port_, &flow);
2238 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
2241 /* Returns true if 'rule' should be hidden from the controller.
2243 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2244 * (e.g. by in-band control) and are intentionally hidden from the
2247 ofproto_rule_is_hidden(const struct rule *rule)
2249 return rule->cr.priority > UINT16_MAX;
2252 static enum oftable_flags
2253 rule_get_flags(const struct rule *rule)
2255 return rule->ofproto->tables[rule->table_id].flags;
2259 rule_is_modifiable(const struct rule *rule)
2261 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2265 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2267 ofconn_send_reply(ofconn, make_echo_reply(oh));
2272 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2274 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2275 struct ofputil_switch_features features;
2276 struct ofport *port;
2282 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2284 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2286 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2287 * if present, are always at the end.) */
2288 n_tables = ofproto->n_tables;
2289 for (i = 0; i < ofproto->n_tables; i++) {
2290 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2296 features.datapath_id = ofproto->datapath_id;
2297 features.n_buffers = pktbuf_capacity();
2298 features.n_tables = n_tables;
2299 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2300 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2302 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2304 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2305 features.auxiliary_id = 0;
2306 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2308 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2309 ofputil_put_switch_features_port(&port->pp, b);
2312 ofconn_send_reply(ofconn, b);
2317 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2319 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2320 struct ofp_switch_config *osc;
2321 enum ofp_config_flags flags;
2325 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2326 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2327 flags = ofproto->frag_handling;
2328 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2329 if (oh->version < OFP13_VERSION
2330 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2331 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2333 osc->flags = htons(flags);
2334 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2335 ofconn_send_reply(ofconn, buf);
2341 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2343 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2344 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2345 uint16_t flags = ntohs(osc->flags);
2347 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2348 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2349 enum ofp_config_flags cur = ofproto->frag_handling;
2350 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2352 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2354 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2355 ofproto->frag_handling = next;
2357 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2359 ofputil_frag_handling_to_string(next));
2363 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2364 ofconn_set_invalid_ttl_to_controller(ofconn,
2365 (oh->version < OFP13_VERSION
2366 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2368 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2373 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2374 * error message code for the caller to propagate upward. Otherwise, returns
2377 * The log message mentions 'msg_type'. */
2379 reject_slave_controller(struct ofconn *ofconn)
2381 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2382 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2383 return OFPERR_OFPBRC_EPERM;
2389 /* Finds the OFPACT_METER action, if any, in the 'ofpacts_len' bytes of
2390 * 'ofpacts'. If found, returns its meter ID; if not, returns 0.
2392 * This function relies on the order of 'ofpacts' being correct (as checked by
2393 * ofpacts_verify()). */
2395 find_meter(const struct ofpact ofpacts[], size_t ofpacts_len)
2397 const struct ofpact *a;
2399 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2400 enum ovs_instruction_type inst;
2402 inst = ovs_instruction_type_from_ofpact_type(a->type);
2403 if (a->type == OFPACT_METER) {
2404 return ofpact_get_METER(a)->meter_id;
2405 } else if (inst > OVSINST_OFPIT13_METER) {
2413 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are appropriate
2414 * for a packet with the prerequisites satisfied by 'flow' in table 'table_id'.
2415 * 'flow' may be temporarily modified, but is restored at return.
2418 ofproto_check_ofpacts(struct ofproto *ofproto,
2419 const struct ofpact ofpacts[], size_t ofpacts_len,
2420 struct flow *flow, uint8_t table_id)
2425 error = ofpacts_check(ofpacts, ofpacts_len, flow, ofproto->max_ports,
2431 mid = find_meter(ofpacts, ofpacts_len);
2432 if (mid && ofproto_get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2433 return OFPERR_OFPMMFC_INVALID_METER;
2439 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2441 struct ofproto *p = ofconn_get_ofproto(ofconn);
2442 struct ofputil_packet_out po;
2443 struct ofpbuf *payload;
2444 uint64_t ofpacts_stub[1024 / 8];
2445 struct ofpbuf ofpacts;
2447 union flow_in_port in_port_;
2450 COVERAGE_INC(ofproto_packet_out);
2452 error = reject_slave_controller(ofconn);
2457 /* Decode message. */
2458 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2459 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2461 goto exit_free_ofpacts;
2463 if (ofp_to_u16(po.in_port) >= ofp_to_u16(p->max_ports)
2464 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2465 error = OFPERR_OFPBRC_BAD_PORT;
2466 goto exit_free_ofpacts;
2471 if (po.buffer_id != UINT32_MAX) {
2472 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2473 if (error || !payload) {
2474 goto exit_free_ofpacts;
2477 payload = xmalloc(sizeof *payload);
2478 ofpbuf_use_const(payload, po.packet, po.packet_len);
2481 /* Verify actions against packet, then send packet if successful. */
2482 in_port_.ofp_port = po.in_port;
2483 flow_extract(payload, 0, 0, NULL, &in_port_, &flow);
2484 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len, &flow, 0);
2486 error = p->ofproto_class->packet_out(p, payload, &flow,
2487 po.ofpacts, po.ofpacts_len);
2489 ofpbuf_delete(payload);
2492 ofpbuf_uninit(&ofpacts);
2498 update_port_config(struct ofport *port,
2499 enum ofputil_port_config config,
2500 enum ofputil_port_config mask)
2502 enum ofputil_port_config old_config = port->pp.config;
2503 enum ofputil_port_config toggle;
2505 toggle = (config ^ port->pp.config) & mask;
2506 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2507 if (config & OFPUTIL_PC_PORT_DOWN) {
2508 netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL);
2510 netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL);
2512 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2515 port->pp.config ^= toggle;
2516 if (port->pp.config != old_config) {
2517 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2522 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2524 struct ofproto *p = ofconn_get_ofproto(ofconn);
2525 struct ofputil_port_mod pm;
2526 struct ofport *port;
2529 error = reject_slave_controller(ofconn);
2534 error = ofputil_decode_port_mod(oh, &pm);
2539 port = ofproto_get_port(p, pm.port_no);
2541 return OFPERR_OFPPMFC_BAD_PORT;
2542 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2543 return OFPERR_OFPPMFC_BAD_HW_ADDR;
2545 update_port_config(port, pm.config, pm.mask);
2547 netdev_set_advertisements(port->netdev, pm.advertise);
2554 handle_desc_stats_request(struct ofconn *ofconn,
2555 const struct ofp_header *request)
2557 static const char *default_mfr_desc = "Nicira, Inc.";
2558 static const char *default_hw_desc = "Open vSwitch";
2559 static const char *default_sw_desc = VERSION;
2560 static const char *default_serial_desc = "None";
2561 static const char *default_dp_desc = "None";
2563 struct ofproto *p = ofconn_get_ofproto(ofconn);
2564 struct ofp_desc_stats *ods;
2567 msg = ofpraw_alloc_stats_reply(request, 0);
2568 ods = ofpbuf_put_zeros(msg, sizeof *ods);
2569 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
2570 sizeof ods->mfr_desc);
2571 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
2572 sizeof ods->hw_desc);
2573 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
2574 sizeof ods->sw_desc);
2575 ovs_strlcpy(ods->serial_num,
2576 p->serial_desc ? p->serial_desc : default_serial_desc,
2577 sizeof ods->serial_num);
2578 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
2579 sizeof ods->dp_desc);
2580 ofconn_send_reply(ofconn, msg);
2586 handle_table_stats_request(struct ofconn *ofconn,
2587 const struct ofp_header *request)
2589 struct ofproto *p = ofconn_get_ofproto(ofconn);
2590 struct ofp12_table_stats *ots;
2595 /* Set up default values.
2597 * ofp12_table_stats is used as a generic structure as
2598 * it is able to hold all the fields for ofp10_table_stats
2599 * and ofp11_table_stats (and of course itself).
2601 ots = xcalloc(p->n_tables, sizeof *ots);
2602 for (i = 0; i < p->n_tables; i++) {
2603 ots[i].table_id = i;
2604 sprintf(ots[i].name, "table%zu", i);
2605 ots[i].match = htonll(OFPXMT12_MASK);
2606 ots[i].wildcards = htonll(OFPXMT12_MASK);
2607 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2608 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2609 ots[i].write_setfields = htonll(OFPXMT12_MASK);
2610 ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2611 ots[i].metadata_match = htonll(UINT64_MAX);
2612 ots[i].metadata_write = htonll(UINT64_MAX);
2613 ots[i].instructions = htonl(OFPIT11_ALL);
2614 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2615 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2616 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2619 p->ofproto_class->get_tables(p, ots);
2621 /* Post-process the tables, dropping hidden tables. */
2622 n_tables = p->n_tables;
2623 for (i = 0; i < p->n_tables; i++) {
2624 const struct oftable *table = &p->tables[i];
2626 if (table->flags & OFTABLE_HIDDEN) {
2632 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2635 if (table->max_flows < ntohl(ots[i].max_entries)) {
2636 ots[i].max_entries = htonl(table->max_flows);
2640 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2641 ofconn_send_reply(ofconn, msg);
2649 append_port_stat(struct ofport *port, struct list *replies)
2651 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2653 calc_duration(port->created, time_msec(),
2654 &ops.duration_sec, &ops.duration_nsec);
2656 /* Intentionally ignore return value, since errors will set
2657 * 'stats' to all-1s, which is correct for OpenFlow, and
2658 * netdev_get_stats() will log errors. */
2659 ofproto_port_get_stats(port, &ops.stats);
2661 ofputil_append_port_stat(replies, &ops);
2665 handle_port_stats_request(struct ofconn *ofconn,
2666 const struct ofp_header *request)
2668 struct ofproto *p = ofconn_get_ofproto(ofconn);
2669 struct ofport *port;
2670 struct list replies;
2674 error = ofputil_decode_port_stats_request(request, &port_no);
2679 ofpmp_init(&replies, request);
2680 if (port_no != OFPP_ANY) {
2681 port = ofproto_get_port(p, port_no);
2683 append_port_stat(port, &replies);
2686 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2687 append_port_stat(port, &replies);
2691 ofconn_send_replies(ofconn, &replies);
2696 handle_port_desc_stats_request(struct ofconn *ofconn,
2697 const struct ofp_header *request)
2699 struct ofproto *p = ofconn_get_ofproto(ofconn);
2700 enum ofp_version version;
2701 struct ofport *port;
2702 struct list replies;
2704 ofpmp_init(&replies, request);
2706 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2707 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2708 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2711 ofconn_send_replies(ofconn, &replies);
2716 hash_cookie(ovs_be64 cookie)
2718 return hash_2words((OVS_FORCE uint64_t)cookie >> 32,
2719 (OVS_FORCE uint64_t)cookie);
2723 cookies_insert(struct ofproto *ofproto, struct rule *rule)
2725 hindex_insert(&ofproto->cookies, &rule->cookie_node,
2726 hash_cookie(rule->flow_cookie));
2730 cookies_remove(struct ofproto *ofproto, struct rule *rule)
2732 hindex_remove(&ofproto->cookies, &rule->cookie_node);
2736 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
2737 ovs_be64 new_cookie)
2739 if (new_cookie != rule->flow_cookie) {
2740 cookies_remove(ofproto, rule);
2742 rule->flow_cookie = new_cookie;
2744 cookies_insert(ofproto, rule);
2749 calc_duration(long long int start, long long int now,
2750 uint32_t *sec, uint32_t *nsec)
2752 long long int msecs = now - start;
2753 *sec = msecs / 1000;
2754 *nsec = (msecs % 1000) * (1000 * 1000);
2757 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2758 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2760 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2762 return (table_id == 0xff || table_id < ofproto->n_tables
2764 : OFPERR_OFPBRC_BAD_TABLE_ID);
2768 static struct oftable *
2769 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2771 struct oftable *table;
2773 for (table = &ofproto->tables[table_id];
2774 table < &ofproto->tables[ofproto->n_tables];
2776 if (!(table->flags & OFTABLE_HIDDEN)) {
2784 static struct oftable *
2785 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2787 if (table_id == 0xff) {
2788 return next_visible_table(ofproto, 0);
2789 } else if (table_id < ofproto->n_tables) {
2790 return &ofproto->tables[table_id];
2796 static struct oftable *
2797 next_matching_table(const struct ofproto *ofproto,
2798 const struct oftable *table, uint8_t table_id)
2800 return (table_id == 0xff
2801 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2805 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2807 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2808 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2810 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2811 * only once, for that table. (This can be used to access tables marked
2814 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2815 * entered at all. (Perhaps you should have validated TABLE_ID with
2816 * check_table_id().)
2818 * All parameters are evaluated multiple times.
2820 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2821 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2823 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2825 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2826 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2827 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2830 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2831 * to 'out_port' are included.
2833 * Hidden rules are always omitted.
2835 * Returns 0 on success, otherwise an OpenFlow error code. */
2837 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2838 const struct match *match,
2839 ovs_be64 cookie, ovs_be64 cookie_mask,
2840 ofp_port_t out_port, struct list *rules)
2842 struct oftable *table;
2846 error = check_table_id(ofproto, table_id);
2852 cls_rule_init(&cr, match, 0);
2854 if (cookie_mask == htonll(UINT64_MAX)) {
2857 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node, hash_cookie(cookie),
2858 &ofproto->cookies) {
2859 if (table_id != rule->table_id && table_id != 0xff) {
2862 if (ofproto_rule_is_hidden(rule)) {
2865 if (cls_rule_is_loose_match(&rule->cr, &cr.match)) {
2866 if (rule->pending) {
2867 error = OFPROTO_POSTPONE;
2870 if (rule->flow_cookie == cookie /* Hash collisions possible. */
2871 && ofproto_rule_has_out_port(rule, out_port)) {
2872 list_push_back(rules, &rule->ofproto_node);
2879 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2880 struct cls_cursor cursor;
2883 cls_cursor_init(&cursor, &table->cls, &cr);
2884 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2885 if (rule->pending) {
2886 error = OFPROTO_POSTPONE;
2889 if (!ofproto_rule_is_hidden(rule)
2890 && ofproto_rule_has_out_port(rule, out_port)
2891 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2892 list_push_back(rules, &rule->ofproto_node);
2898 cls_rule_destroy(&cr);
2902 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2903 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2904 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2907 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2908 * to 'out_port' are included.
2910 * Hidden rules are always omitted.
2912 * Returns 0 on success, otherwise an OpenFlow error code. */
2914 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2915 const struct match *match, unsigned int priority,
2916 ovs_be64 cookie, ovs_be64 cookie_mask,
2917 ofp_port_t out_port, struct list *rules)
2919 struct oftable *table;
2923 error = check_table_id(ofproto, table_id);
2929 cls_rule_init(&cr, match, priority);
2931 if (cookie_mask == htonll(UINT64_MAX)) {
2934 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node, hash_cookie(cookie),
2935 &ofproto->cookies) {
2936 if (table_id != rule->table_id && table_id != 0xff) {
2939 if (ofproto_rule_is_hidden(rule)) {
2942 if (cls_rule_equal(&rule->cr, &cr)) {
2943 if (rule->pending) {
2944 error = OFPROTO_POSTPONE;
2947 if (rule->flow_cookie == cookie /* Hash collisions possible. */
2948 && ofproto_rule_has_out_port(rule, out_port)) {
2949 list_push_back(rules, &rule->ofproto_node);
2956 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2959 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2962 if (rule->pending) {
2963 error = OFPROTO_POSTPONE;
2966 if (!ofproto_rule_is_hidden(rule)
2967 && ofproto_rule_has_out_port(rule, out_port)
2968 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2969 list_push_back(rules, &rule->ofproto_node);
2975 cls_rule_destroy(&cr);
2979 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2980 * forced into the range of a uint16_t. */
2982 age_secs(long long int age_ms)
2984 return (age_ms < 0 ? 0
2985 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
2986 : (unsigned int) age_ms / 1000);
2990 handle_flow_stats_request(struct ofconn *ofconn,
2991 const struct ofp_header *request)
2993 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2994 struct ofputil_flow_stats_request fsr;
2995 struct list replies;
3000 error = ofputil_decode_flow_stats_request(&fsr, request);
3005 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
3006 fsr.cookie, fsr.cookie_mask,
3007 fsr.out_port, &rules);
3012 ofpmp_init(&replies, request);
3013 LIST_FOR_EACH (rule, ofproto_node, &rules) {
3014 long long int now = time_msec();
3015 struct ofputil_flow_stats fs;
3017 minimatch_expand(&rule->cr.match, &fs.match);
3018 fs.priority = rule->cr.priority;
3019 fs.cookie = rule->flow_cookie;
3020 fs.table_id = rule->table_id;
3021 calc_duration(rule->created, now, &fs.duration_sec, &fs.duration_nsec);
3022 fs.idle_timeout = rule->idle_timeout;
3023 fs.hard_timeout = rule->hard_timeout;
3024 fs.idle_age = age_secs(now - rule->used);
3025 fs.hard_age = age_secs(now - rule->modified);
3026 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3028 fs.ofpacts = rule->ofpacts;
3029 fs.ofpacts_len = rule->ofpacts_len;
3031 if (rule->send_flow_removed) {
3032 fs.flags |= OFPFF_SEND_FLOW_REM;
3033 /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
3034 and OFPFF13_NO_BYT_COUNTS */
3036 ofputil_append_flow_stats_reply(&fs, &replies);
3038 ofconn_send_replies(ofconn, &replies);
3044 flow_stats_ds(struct rule *rule, struct ds *results)
3046 uint64_t packet_count, byte_count;
3048 rule->ofproto->ofproto_class->rule_get_stats(rule,
3049 &packet_count, &byte_count);
3051 if (rule->table_id != 0) {
3052 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3054 ds_put_format(results, "duration=%llds, ",
3055 (time_msec() - rule->created) / 1000);
3056 ds_put_format(results, "priority=%u, ", rule->cr.priority);
3057 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3058 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3059 cls_rule_format(&rule->cr, results);
3060 ds_put_char(results, ',');
3061 ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
3062 ds_put_cstr(results, "\n");
3065 /* Adds a pretty-printed description of all flows to 'results', including
3066 * hidden flows (e.g., set up by in-band control). */
3068 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3070 struct oftable *table;
3072 OFPROTO_FOR_EACH_TABLE (table, p) {
3073 struct cls_cursor cursor;
3076 cls_cursor_init(&cursor, &table->cls, NULL);
3077 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3078 flow_stats_ds(rule, results);
3083 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3084 * '*engine_type' and '*engine_id', respectively. */
3086 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3087 uint8_t *engine_type, uint8_t *engine_id)
3089 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3092 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3093 * true if the port's CFM status was successfully stored into '*status'.
3094 * Returns false if the port did not have CFM configured, in which case
3095 * '*status' is indeterminate.
3097 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3099 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3100 struct ofproto_cfm_status *status)
3102 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3104 && ofproto->ofproto_class->get_cfm_status
3105 && ofproto->ofproto_class->get_cfm_status(ofport, status));
3109 handle_aggregate_stats_request(struct ofconn *ofconn,
3110 const struct ofp_header *oh)
3112 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3113 struct ofputil_flow_stats_request request;
3114 struct ofputil_aggregate_stats stats;
3115 bool unknown_packets, unknown_bytes;
3116 struct ofpbuf *reply;
3121 error = ofputil_decode_flow_stats_request(&request, oh);
3126 error = collect_rules_loose(ofproto, request.table_id, &request.match,
3127 request.cookie, request.cookie_mask,
3128 request.out_port, &rules);
3133 memset(&stats, 0, sizeof stats);
3134 unknown_packets = unknown_bytes = false;
3135 LIST_FOR_EACH (rule, ofproto_node, &rules) {
3136 uint64_t packet_count;
3137 uint64_t byte_count;
3139 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3142 if (packet_count == UINT64_MAX) {
3143 unknown_packets = true;
3145 stats.packet_count += packet_count;
3148 if (byte_count == UINT64_MAX) {
3149 unknown_bytes = true;
3151 stats.byte_count += byte_count;
3156 if (unknown_packets) {
3157 stats.packet_count = UINT64_MAX;
3159 if (unknown_bytes) {
3160 stats.byte_count = UINT64_MAX;
3163 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3164 ofconn_send_reply(ofconn, reply);
3169 struct queue_stats_cbdata {
3170 struct ofport *ofport;
3171 struct list replies;
3176 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3177 const struct netdev_queue_stats *stats)
3179 struct ofputil_queue_stats oqs;
3181 oqs.port_no = cbdata->ofport->pp.port_no;
3182 oqs.queue_id = queue_id;
3183 oqs.tx_bytes = stats->tx_bytes;
3184 oqs.tx_packets = stats->tx_packets;
3185 oqs.tx_errors = stats->tx_errors;
3186 if (stats->created != LLONG_MIN) {
3187 calc_duration(stats->created, cbdata->now,
3188 &oqs.duration_sec, &oqs.duration_nsec);
3190 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3192 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3196 handle_queue_stats_dump_cb(uint32_t queue_id,
3197 struct netdev_queue_stats *stats,
3200 struct queue_stats_cbdata *cbdata = cbdata_;
3202 put_queue_stats(cbdata, queue_id, stats);
3206 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3207 struct queue_stats_cbdata *cbdata)
3209 cbdata->ofport = port;
3210 if (queue_id == OFPQ_ALL) {
3211 netdev_dump_queue_stats(port->netdev,
3212 handle_queue_stats_dump_cb, cbdata);
3214 struct netdev_queue_stats stats;
3216 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3217 put_queue_stats(cbdata, queue_id, &stats);
3219 return OFPERR_OFPQOFC_BAD_QUEUE;
3226 handle_queue_stats_request(struct ofconn *ofconn,
3227 const struct ofp_header *rq)
3229 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3230 struct queue_stats_cbdata cbdata;
3231 struct ofport *port;
3233 struct ofputil_queue_stats_request oqsr;
3235 COVERAGE_INC(ofproto_queue_req);
3237 ofpmp_init(&cbdata.replies, rq);
3238 cbdata.now = time_msec();
3240 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3245 if (oqsr.port_no == OFPP_ANY) {
3246 error = OFPERR_OFPQOFC_BAD_QUEUE;
3247 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3248 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3253 port = ofproto_get_port(ofproto, oqsr.port_no);
3255 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3256 : OFPERR_OFPQOFC_BAD_PORT);
3259 ofconn_send_replies(ofconn, &cbdata.replies);
3261 ofpbuf_list_delete(&cbdata.replies);
3268 is_flow_deletion_pending(const struct ofproto *ofproto,
3269 const struct cls_rule *cls_rule,
3272 if (!hmap_is_empty(&ofproto->deletions)) {
3273 struct ofoperation *op;
3275 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3276 cls_rule_hash(cls_rule, table_id),
3277 &ofproto->deletions) {
3278 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3287 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3288 * in which no matching flow already exists in the flow table.
3290 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3291 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3292 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3293 * initiated now but may be retried later.
3295 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
3296 * ownership remains with the caller.
3298 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3301 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3302 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3304 struct oftable *table;
3305 struct ofopgroup *group;
3306 struct rule *victim;
3311 error = check_table_id(ofproto, fm->table_id);
3317 if (fm->table_id == 0xff) {
3318 if (ofproto->ofproto_class->rule_choose_table) {
3319 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3325 ovs_assert(table_id < ofproto->n_tables);
3329 } else if (fm->table_id < ofproto->n_tables) {
3330 table_id = fm->table_id;
3332 return OFPERR_OFPBRC_BAD_TABLE_ID;
3335 table = &ofproto->tables[table_id];
3337 if (table->flags & OFTABLE_READONLY) {
3338 return OFPERR_OFPBRC_EPERM;
3341 /* Verify actions. */
3342 error = ofproto_check_ofpacts(ofproto, fm->ofpacts, fm->ofpacts_len,
3343 &fm->match.flow, table_id);
3348 /* Allocate new rule and initialize classifier rule. */
3349 rule = ofproto->ofproto_class->rule_alloc();
3351 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3352 ofproto->name, ovs_strerror(error));
3355 cls_rule_init(&rule->cr, &fm->match, fm->priority);
3357 /* Serialize against pending deletion. */
3358 if (is_flow_deletion_pending(ofproto, &rule->cr, table_id)) {
3359 cls_rule_destroy(&rule->cr);
3360 ofproto->ofproto_class->rule_dealloc(rule);
3361 return OFPROTO_POSTPONE;
3364 /* Check for overlap, if requested. */
3365 if (fm->flags & OFPFF_CHECK_OVERLAP
3366 && classifier_rule_overlaps(&table->cls, &rule->cr)) {
3367 cls_rule_destroy(&rule->cr);
3368 ofproto->ofproto_class->rule_dealloc(rule);
3369 return OFPERR_OFPFMFC_OVERLAP;
3372 /* FIXME: Implement OFPFF12_RESET_COUNTS */
3374 rule->ofproto = ofproto;
3375 rule->pending = NULL;
3376 rule->flow_cookie = fm->new_cookie;
3377 rule->created = rule->modified = rule->used = time_msec();
3378 rule->idle_timeout = fm->idle_timeout;
3379 rule->hard_timeout = fm->hard_timeout;
3380 rule->table_id = table - ofproto->tables;
3381 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
3382 /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
3383 and OFPFF13_NO_BYT_COUNTS */
3384 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3385 rule->ofpacts_len = fm->ofpacts_len;
3386 rule->meter_id = find_meter(rule->ofpacts, rule->ofpacts_len);
3387 list_init(&rule->meter_list_node);
3388 rule->evictable = true;
3389 rule->eviction_group = NULL;
3390 list_init(&rule->expirable);
3391 rule->monitor_flags = 0;
3392 rule->add_seqno = 0;
3393 rule->modify_seqno = 0;
3395 /* Insert new rule. */
3396 victim = oftable_replace_rule(rule);
3397 if (victim && !rule_is_modifiable(victim)) {
3398 error = OFPERR_OFPBRC_EPERM;
3399 } else if (victim && victim->pending) {
3400 error = OFPROTO_POSTPONE;
3402 struct ofoperation *op;
3405 if (classifier_count(&table->cls) > table->max_flows) {
3408 was_evictable = rule->evictable;
3409 rule->evictable = false;
3410 evict = choose_rule_to_evict(table);
3411 rule->evictable = was_evictable;
3414 error = OFPERR_OFPFMFC_TABLE_FULL;
3416 } else if (evict->pending) {
3417 error = OFPROTO_POSTPONE;
3424 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3425 op = ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3426 op->victim = victim;
3428 error = ofproto->ofproto_class->rule_construct(rule);
3430 op->group->n_running--;
3431 ofoperation_destroy(rule->pending);
3433 delete_flow__(evict, group, OFPRR_EVICTION);
3435 ofopgroup_submit(group);
3439 /* Back out if an error occurred. */
3441 oftable_substitute_rule(rule, victim);
3442 ofproto_rule_destroy__(rule);
3447 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3449 /* Modifies the rules listed in 'rules', changing their actions to match those
3452 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3455 * Returns 0 on success, otherwise an OpenFlow error code. */
3457 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3458 struct ofputil_flow_mod *fm, const struct ofp_header *request,
3461 struct ofopgroup *group;
3465 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3466 error = OFPERR_OFPBRC_EPERM;
3467 LIST_FOR_EACH (rule, ofproto_node, rules) {
3468 struct ofoperation *op;
3469 bool actions_changed;
3471 /* FIXME: Implement OFPFF12_RESET_COUNTS */
3473 if (rule_is_modifiable(rule)) {
3474 /* At least one rule is modifiable, don't report EPERM error. */
3480 /* Verify actions. */
3481 error = ofpacts_check(fm->ofpacts, fm->ofpacts_len, &fm->match.flow,
3482 ofproto->max_ports, rule->table_id);
3487 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3488 rule->ofpacts, rule->ofpacts_len);
3490 op = ofoperation_create(group, rule, OFOPERATION_MODIFY, 0);
3492 if (fm->modify_cookie && fm->new_cookie != htonll(UINT64_MAX)) {
3493 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
3495 if (actions_changed) {
3496 op->ofpacts = rule->ofpacts;
3497 op->ofpacts_len = rule->ofpacts_len;
3498 op->meter_id = rule->meter_id;
3499 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3500 rule->ofpacts_len = fm->ofpacts_len;
3501 rule->meter_id = find_meter(rule->ofpacts, rule->ofpacts_len);
3502 rule->ofproto->ofproto_class->rule_modify_actions(rule);
3504 ofoperation_complete(op, 0);
3507 ofopgroup_submit(group);
3513 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3514 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3516 if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3519 return add_flow(ofproto, ofconn, fm, request);
3522 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3525 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3528 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3529 struct ofputil_flow_mod *fm,
3530 const struct ofp_header *request)
3535 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3536 fm->cookie, fm->cookie_mask,
3540 } else if (list_is_empty(&rules)) {
3541 return modify_flows_add(ofproto, ofconn, fm, request);
3543 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3547 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3550 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3553 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3554 struct ofputil_flow_mod *fm,
3555 const struct ofp_header *request)
3560 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3561 fm->priority, fm->cookie, fm->cookie_mask,
3566 } else if (list_is_empty(&rules)) {
3567 return modify_flows_add(ofproto, ofconn, fm, request);
3569 return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3570 fm, request, &rules)
3575 /* OFPFC_DELETE implementation. */
3578 delete_flow__(struct rule *rule, struct ofopgroup *group,
3579 enum ofp_flow_removed_reason reason)
3581 struct ofproto *ofproto = rule->ofproto;
3583 ofproto_rule_send_removed(rule, reason);
3585 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3586 oftable_remove_rule(rule);
3587 ofproto->ofproto_class->rule_destruct(rule);
3590 /* Deletes the rules listed in 'rules'.
3592 * Returns 0 on success, otherwise an OpenFlow error code. */
3594 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3595 const struct ofp_header *request, struct list *rules,
3596 enum ofp_flow_removed_reason reason)
3598 struct rule *rule, *next;
3599 struct ofopgroup *group;
3601 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3602 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3603 delete_flow__(rule, group, reason);
3605 ofopgroup_submit(group);
3610 /* Implements OFPFC_DELETE. */
3612 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3613 const struct ofputil_flow_mod *fm,
3614 const struct ofp_header *request)
3619 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3620 fm->cookie, fm->cookie_mask,
3621 fm->out_port, &rules);
3622 return (error ? error
3623 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3624 &rules, OFPRR_DELETE)
3628 /* Implements OFPFC_DELETE_STRICT. */
3630 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3631 const struct ofputil_flow_mod *fm,
3632 const struct ofp_header *request)
3637 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3638 fm->priority, fm->cookie, fm->cookie_mask,
3639 fm->out_port, &rules);
3640 return (error ? error
3641 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3648 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3650 struct ofputil_flow_removed fr;
3652 if (ofproto_rule_is_hidden(rule) || !rule->send_flow_removed) {
3656 minimatch_expand(&rule->cr.match, &fr.match);
3657 fr.priority = rule->cr.priority;
3658 fr.cookie = rule->flow_cookie;
3660 fr.table_id = rule->table_id;
3661 calc_duration(rule->created, time_msec(),
3662 &fr.duration_sec, &fr.duration_nsec);
3663 fr.idle_timeout = rule->idle_timeout;
3664 fr.hard_timeout = rule->hard_timeout;
3665 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3668 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3672 ofproto_rule_update_used(struct rule *rule, long long int used)
3674 if (used > rule->used) {
3675 struct eviction_group *evg = rule->eviction_group;
3679 heap_change(&evg->rules, &rule->evg_node,
3680 rule_eviction_priority(rule));
3685 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3686 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3689 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3692 * ofproto implementation ->run() functions should use this function to expire
3693 * OpenFlow flows. */
3695 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3697 struct ofproto *ofproto = rule->ofproto;
3698 struct ofopgroup *group;
3700 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
3702 ofproto_rule_send_removed(rule, reason);
3704 group = ofopgroup_create_unattached(ofproto);
3705 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3706 oftable_remove_rule(rule);
3707 ofproto->ofproto_class->rule_destruct(rule);
3708 ofopgroup_submit(group);
3712 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3714 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3715 struct ofputil_flow_mod fm;
3716 uint64_t ofpacts_stub[1024 / 8];
3717 struct ofpbuf ofpacts;
3721 error = reject_slave_controller(ofconn);
3726 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3727 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3730 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
3733 goto exit_free_ofpacts;
3736 /* Record the operation for logging a summary report. */
3737 switch (fm.command) {
3743 case OFPFC_MODIFY_STRICT:
3744 ofproto->n_modify++;
3748 case OFPFC_DELETE_STRICT:
3749 ofproto->n_delete++;
3754 if (ofproto->next_op_report == LLONG_MAX) {
3755 ofproto->first_op = now;
3756 ofproto->next_op_report = MAX(now + 10 * 1000,
3757 ofproto->op_backoff);
3758 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
3760 ofproto->last_op = now;
3763 ofpbuf_uninit(&ofpacts);
3769 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3770 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
3772 if (ofproto->n_pending >= 50) {
3773 ovs_assert(!list_is_empty(&ofproto->pending));
3774 return OFPROTO_POSTPONE;
3777 switch (fm->command) {
3779 return add_flow(ofproto, ofconn, fm, oh);
3782 return modify_flows_loose(ofproto, ofconn, fm, oh);
3784 case OFPFC_MODIFY_STRICT:
3785 return modify_flow_strict(ofproto, ofconn, fm, oh);
3788 return delete_flows_loose(ofproto, ofconn, fm, oh);
3790 case OFPFC_DELETE_STRICT:
3791 return delete_flow_strict(ofproto, ofconn, fm, oh);
3794 if (fm->command > 0xff) {
3795 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
3796 "flow_mod_table_id extension is not enabled",
3799 return OFPERR_OFPFMFC_BAD_COMMAND;
3804 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
3806 struct ofputil_role_request request;
3807 struct ofputil_role_request reply;
3811 error = ofputil_decode_role_message(oh, &request);
3816 if (request.role != OFPCR12_ROLE_NOCHANGE) {
3817 if (ofconn_get_role(ofconn) != request.role
3818 && ofconn_has_pending_opgroups(ofconn)) {
3819 return OFPROTO_POSTPONE;
3822 if (request.have_generation_id
3823 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
3824 return OFPERR_OFPRRFC_STALE;
3827 ofconn_set_role(ofconn, request.role);
3830 reply.role = ofconn_get_role(ofconn);
3831 reply.have_generation_id = ofconn_get_master_election_id(
3832 ofconn, &reply.generation_id);
3833 buf = ofputil_encode_role_reply(oh, &reply);
3834 ofconn_send_reply(ofconn, buf);
3840 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
3841 const struct ofp_header *oh)
3843 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
3844 enum ofputil_protocol cur, next;
3846 cur = ofconn_get_protocol(ofconn);
3847 next = ofputil_protocol_set_tid(cur, msg->set != 0);
3848 ofconn_set_protocol(ofconn, next);
3854 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
3856 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
3857 enum ofputil_protocol cur, next;
3858 enum ofputil_protocol next_base;
3860 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
3862 return OFPERR_OFPBRC_EPERM;
3865 cur = ofconn_get_protocol(ofconn);
3866 next = ofputil_protocol_set_base(cur, next_base);
3867 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
3868 /* Avoid sending async messages in surprising protocol. */
3869 return OFPROTO_POSTPONE;
3872 ofconn_set_protocol(ofconn, next);
3877 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
3878 const struct ofp_header *oh)
3880 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
3883 format = ntohl(msg->format);
3884 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
3885 return OFPERR_OFPBRC_EPERM;
3888 if (format != ofconn_get_packet_in_format(ofconn)
3889 && ofconn_has_pending_opgroups(ofconn)) {
3890 /* Avoid sending async message in surprsing packet in format. */
3891 return OFPROTO_POSTPONE;
3894 ofconn_set_packet_in_format(ofconn, format);
3899 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
3901 const struct nx_async_config *msg = ofpmsg_body(oh);
3902 uint32_t master[OAM_N_TYPES];
3903 uint32_t slave[OAM_N_TYPES];
3905 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
3906 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
3907 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
3909 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
3910 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
3911 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
3913 ofconn_set_async_config(ofconn, master, slave);
3914 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
3915 !ofconn_get_miss_send_len(ofconn)) {
3916 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
3923 handle_nxt_set_controller_id(struct ofconn *ofconn,
3924 const struct ofp_header *oh)
3926 const struct nx_controller_id *nci = ofpmsg_body(oh);
3928 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
3929 return OFPERR_NXBRC_MUST_BE_ZERO;
3932 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
3937 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
3941 if (ofconn_has_pending_opgroups(ofconn)) {
3942 return OFPROTO_POSTPONE;
3945 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
3946 ? OFPRAW_OFPT10_BARRIER_REPLY
3947 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
3948 ofconn_send_reply(ofconn, buf);
3953 ofproto_compose_flow_refresh_update(const struct rule *rule,
3954 enum nx_flow_monitor_flags flags,
3957 struct ofoperation *op = rule->pending;
3958 struct ofputil_flow_update fu;
3961 if (op && op->type == OFOPERATION_ADD && !op->victim) {
3962 /* We'll report the final flow when the operation completes. Reporting
3963 * it now would cause a duplicate report later. */
3967 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
3968 ? NXFME_ADDED : NXFME_MODIFIED);
3970 fu.idle_timeout = rule->idle_timeout;
3971 fu.hard_timeout = rule->hard_timeout;
3972 fu.table_id = rule->table_id;
3973 fu.cookie = rule->flow_cookie;
3974 minimatch_expand(&rule->cr.match, &match);
3976 fu.priority = rule->cr.priority;
3977 if (!(flags & NXFMF_ACTIONS)) {
3981 fu.ofpacts = rule->ofpacts;
3982 fu.ofpacts_len = rule->ofpacts_len;
3984 /* An operation is in progress. Use the previous version of the flow's
3985 * actions, so that when the operation commits we report the change. */
3987 case OFOPERATION_ADD:
3988 /* We already verified that there was a victim. */
3989 fu.ofpacts = op->victim->ofpacts;
3990 fu.ofpacts_len = op->victim->ofpacts_len;
3993 case OFOPERATION_MODIFY:
3995 fu.ofpacts = op->ofpacts;
3996 fu.ofpacts_len = op->ofpacts_len;
3998 fu.ofpacts = rule->ofpacts;
3999 fu.ofpacts_len = rule->ofpacts_len;
4003 case OFOPERATION_DELETE:
4004 fu.ofpacts = rule->ofpacts;
4005 fu.ofpacts_len = rule->ofpacts_len;
4013 if (list_is_empty(msgs)) {
4014 ofputil_start_flow_update(msgs);
4016 ofputil_append_flow_update(&fu, msgs);
4020 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
4024 LIST_FOR_EACH (rule, ofproto_node, rules) {
4025 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4026 rule->monitor_flags = 0;
4028 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4033 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4034 struct rule *rule, uint64_t seqno,
4037 enum nx_flow_monitor_flags update;
4039 if (ofproto_rule_is_hidden(rule)) {
4044 ? ofoperation_has_out_port(rule->pending, m->out_port)
4045 : ofproto_rule_has_out_port(rule, m->out_port))) {
4050 if (rule->add_seqno > seqno) {
4051 update = NXFMF_ADD | NXFMF_MODIFY;
4052 } else if (rule->modify_seqno > seqno) {
4053 update = NXFMF_MODIFY;
4058 if (!(m->flags & update)) {
4062 update = NXFMF_INITIAL;
4065 if (!rule->monitor_flags) {
4066 list_push_back(rules, &rule->ofproto_node);
4068 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4072 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4076 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4077 const struct ofoperation *op;
4078 const struct oftable *table;
4079 struct cls_rule target;
4081 cls_rule_init_from_minimatch(&target, &m->match, 0);
4082 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4083 struct cls_cursor cursor;
4086 cls_cursor_init(&cursor, &table->cls, &target);
4087 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4088 ovs_assert(!rule->pending); /* XXX */
4089 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4093 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4094 struct rule *rule = op->rule;
4096 if (((m->table_id == 0xff
4097 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4098 : m->table_id == rule->table_id))
4099 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4100 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4103 cls_rule_destroy(&target);
4107 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4110 if (m->flags & NXFMF_INITIAL) {
4111 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4116 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4117 uint64_t seqno, struct list *rules)
4119 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4123 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4125 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4126 struct ofmonitor **monitors;
4127 size_t n_monitors, allocated_monitors;
4128 struct list replies;
4135 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4137 n_monitors = allocated_monitors = 0;
4139 struct ofputil_flow_monitor_request request;
4140 struct ofmonitor *m;
4143 retval = ofputil_decode_flow_monitor_request(&request, &b);
4144 if (retval == EOF) {
4146 } else if (retval) {
4151 if (request.table_id != 0xff
4152 && request.table_id >= ofproto->n_tables) {
4153 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4157 error = ofmonitor_create(&request, ofconn, &m);
4162 if (n_monitors >= allocated_monitors) {
4163 monitors = x2nrealloc(monitors, &allocated_monitors,
4166 monitors[n_monitors++] = m;
4170 for (i = 0; i < n_monitors; i++) {
4171 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4174 ofpmp_init(&replies, oh);
4175 ofmonitor_compose_refresh_updates(&rules, &replies);
4176 ofconn_send_replies(ofconn, &replies);
4183 for (i = 0; i < n_monitors; i++) {
4184 ofmonitor_destroy(monitors[i]);
4191 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4193 struct ofmonitor *m;
4196 id = ofputil_decode_flow_monitor_cancel(oh);
4197 m = ofmonitor_lookup(ofconn, id);
4199 return OFPERR_NXBRC_FM_BAD_ID;
4202 ofmonitor_destroy(m);
4206 /* Meters implementation.
4208 * Meter table entry, indexed by the OpenFlow meter_id.
4209 * These are always dynamically allocated to allocate enough space for
4211 * 'created' is used to compute the duration for meter stats.
4212 * 'list rules' is needed so that we can delete the dependent rules when the
4213 * meter table entry is deleted.
4214 * 'provider_meter_id' is for the provider's private use.
4217 long long int created; /* Time created. */
4218 struct list rules; /* List of "struct rule_dpif"s. */
4219 ofproto_meter_id provider_meter_id;
4220 uint16_t flags; /* Meter flags. */
4221 uint16_t n_bands; /* Number of meter bands. */
4222 struct ofputil_meter_band *bands;
4226 * This is used in instruction validation at flow set-up time,
4227 * as flows may not use non-existing meters.
4228 * This is also used by ofproto-providers to translate OpenFlow meter_ids
4229 * in METER instructions to the corresponding provider meter IDs.
4230 * Return value of UINT32_MAX signifies an invalid meter.
4233 ofproto_get_provider_meter_id(const struct ofproto * ofproto,
4234 uint32_t of_meter_id)
4236 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
4237 const struct meter *meter = ofproto->meters[of_meter_id];
4239 return meter->provider_meter_id.uint32;
4246 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
4250 meter->flags = config->flags;
4251 meter->n_bands = config->n_bands;
4252 meter->bands = xmemdup(config->bands,
4253 config->n_bands * sizeof *meter->bands);
4256 static struct meter *
4257 meter_create(const struct ofputil_meter_config *config,
4258 ofproto_meter_id provider_meter_id)
4260 struct meter *meter;
4262 meter = xzalloc(sizeof *meter);
4263 meter->provider_meter_id = provider_meter_id;
4264 meter->created = time_msec();
4265 list_init(&meter->rules);
4267 meter_update(meter, config);
4273 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
4276 for (mid = first; mid <= last; ++mid) {
4277 struct meter *meter = ofproto->meters[mid];
4279 ofproto->meters[mid] = NULL;
4280 ofproto->ofproto_class->meter_del(ofproto,
4281 meter->provider_meter_id);
4289 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4291 ofproto_meter_id provider_meter_id = { UINT32_MAX };
4292 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
4296 return OFPERR_OFPMMFC_METER_EXISTS;
4299 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
4302 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
4303 *meterp = meter_create(&mm->meter, provider_meter_id);
4309 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4311 struct meter *meter = ofproto->meters[mm->meter.meter_id];
4315 return OFPERR_OFPMMFC_UNKNOWN_METER;
4318 error = ofproto->ofproto_class->meter_set(ofproto,
4319 &meter->provider_meter_id,
4321 ovs_assert(meter->provider_meter_id.uint32 != UINT32_MAX);
4323 meter_update(meter, &mm->meter);
4329 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
4330 struct ofputil_meter_mod *mm)
4332 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4333 uint32_t meter_id = mm->meter.meter_id;
4334 uint32_t first, last;
4337 if (meter_id == OFPM13_ALL) {
4339 last = ofproto->meter_features.max_meters;
4341 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
4344 first = last = meter_id;
4347 /* First delete the rules that use this meter. If any of those rules are
4348 * currently being modified, postpone the whole operation until later. */
4350 for (meter_id = first; meter_id <= last; ++meter_id) {
4351 struct meter *meter = ofproto->meters[meter_id];
4352 if (meter && !list_is_empty(&meter->rules)) {
4355 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
4356 if (rule->pending) {
4357 return OFPROTO_POSTPONE;
4359 list_push_back(&rules, &rule->ofproto_node);
4363 if (!list_is_empty(&rules)) {
4364 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
4367 /* Delete the meters. */
4368 meter_delete(ofproto, first, last);
4374 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4376 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4377 struct ofputil_meter_mod mm;
4378 uint64_t bands_stub[256 / 8];
4379 struct ofpbuf bands;
4383 error = reject_slave_controller(ofconn);
4388 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
4390 error = ofputil_decode_meter_mod(oh, &mm, &bands);
4392 goto exit_free_bands;
4395 meter_id = mm.meter.meter_id;
4397 if (mm.command != OFPMC13_DELETE) {
4398 /* Fails also when meters are not implemented by the provider. */
4399 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
4400 error = OFPERR_OFPMMFC_INVALID_METER;
4401 goto exit_free_bands;
4403 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
4404 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
4405 goto exit_free_bands;
4409 switch (mm.command) {
4411 error = handle_add_meter(ofproto, &mm);
4414 case OFPMC13_MODIFY:
4415 error = handle_modify_meter(ofproto, &mm);
4418 case OFPMC13_DELETE:
4419 error = handle_delete_meter(ofconn, oh, &mm);
4423 error = OFPERR_OFPMMFC_BAD_COMMAND;
4428 ofpbuf_uninit(&bands);
4433 handle_meter_features_request(struct ofconn *ofconn,
4434 const struct ofp_header *request)
4436 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4437 struct ofputil_meter_features features;
4440 if (ofproto->ofproto_class->meter_get_features) {
4441 ofproto->ofproto_class->meter_get_features(ofproto, &features);
4443 memset(&features, 0, sizeof features);
4445 b = ofputil_encode_meter_features_reply(&features, request);
4447 ofconn_send_reply(ofconn, b);
4452 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
4455 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4456 struct list replies;
4457 uint64_t bands_stub[256 / 8];
4458 struct ofpbuf bands;
4459 uint32_t meter_id, first, last;
4461 ofputil_decode_meter_request(request, &meter_id);
4463 if (meter_id == OFPM13_ALL) {
4465 last = ofproto->meter_features.max_meters;
4467 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
4468 !ofproto->meters[meter_id]) {
4469 return OFPERR_OFPMMFC_UNKNOWN_METER;
4471 first = last = meter_id;
4474 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
4475 ofpmp_init(&replies, request);
4477 for (meter_id = first; meter_id <= last; ++meter_id) {
4478 struct meter *meter = ofproto->meters[meter_id];
4480 continue; /* Skip non-existing meters. */
4482 if (type == OFPTYPE_METER_STATS_REQUEST) {
4483 struct ofputil_meter_stats stats;
4485 stats.meter_id = meter_id;
4487 /* Provider sets the packet and byte counts, we do the rest. */
4488 stats.flow_count = list_size(&meter->rules);
4489 calc_duration(meter->created, time_msec(),
4490 &stats.duration_sec, &stats.duration_nsec);
4491 stats.n_bands = meter->n_bands;
4492 ofpbuf_clear(&bands);
4494 = ofpbuf_put_uninit(&bands,
4495 meter->n_bands * sizeof *stats.bands);
4497 if (!ofproto->ofproto_class->meter_get(ofproto,
4498 meter->provider_meter_id,
4500 ofputil_append_meter_stats(&replies, &stats);
4502 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
4503 struct ofputil_meter_config config;
4505 config.meter_id = meter_id;
4506 config.flags = meter->flags;
4507 config.n_bands = meter->n_bands;
4508 config.bands = meter->bands;
4509 ofputil_append_meter_config(&replies, &config);
4513 ofconn_send_replies(ofconn, &replies);
4514 ofpbuf_uninit(&bands);
4519 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
4521 const struct ofp_header *oh = msg->data;
4525 error = ofptype_decode(&type, oh);
4531 /* OpenFlow requests. */
4532 case OFPTYPE_ECHO_REQUEST:
4533 return handle_echo_request(ofconn, oh);
4535 case OFPTYPE_FEATURES_REQUEST:
4536 return handle_features_request(ofconn, oh);
4538 case OFPTYPE_GET_CONFIG_REQUEST:
4539 return handle_get_config_request(ofconn, oh);
4541 case OFPTYPE_SET_CONFIG:
4542 return handle_set_config(ofconn, oh);
4544 case OFPTYPE_PACKET_OUT:
4545 return handle_packet_out(ofconn, oh);
4547 case OFPTYPE_PORT_MOD:
4548 return handle_port_mod(ofconn, oh);
4550 case OFPTYPE_FLOW_MOD:
4551 return handle_flow_mod(ofconn, oh);
4553 case OFPTYPE_METER_MOD:
4554 return handle_meter_mod(ofconn, oh);
4556 case OFPTYPE_BARRIER_REQUEST:
4557 return handle_barrier_request(ofconn, oh);
4559 case OFPTYPE_ROLE_REQUEST:
4560 return handle_role_request(ofconn, oh);
4562 /* OpenFlow replies. */
4563 case OFPTYPE_ECHO_REPLY:
4566 /* Nicira extension requests. */
4567 case OFPTYPE_FLOW_MOD_TABLE_ID:
4568 return handle_nxt_flow_mod_table_id(ofconn, oh);
4570 case OFPTYPE_SET_FLOW_FORMAT:
4571 return handle_nxt_set_flow_format(ofconn, oh);
4573 case OFPTYPE_SET_PACKET_IN_FORMAT:
4574 return handle_nxt_set_packet_in_format(ofconn, oh);
4576 case OFPTYPE_SET_CONTROLLER_ID:
4577 return handle_nxt_set_controller_id(ofconn, oh);
4579 case OFPTYPE_FLOW_AGE:
4580 /* Nothing to do. */
4583 case OFPTYPE_FLOW_MONITOR_CANCEL:
4584 return handle_flow_monitor_cancel(ofconn, oh);
4586 case OFPTYPE_SET_ASYNC_CONFIG:
4587 return handle_nxt_set_async_config(ofconn, oh);
4589 /* Statistics requests. */
4590 case OFPTYPE_DESC_STATS_REQUEST:
4591 return handle_desc_stats_request(ofconn, oh);
4593 case OFPTYPE_FLOW_STATS_REQUEST:
4594 return handle_flow_stats_request(ofconn, oh);
4596 case OFPTYPE_AGGREGATE_STATS_REQUEST:
4597 return handle_aggregate_stats_request(ofconn, oh);
4599 case OFPTYPE_TABLE_STATS_REQUEST:
4600 return handle_table_stats_request(ofconn, oh);
4602 case OFPTYPE_PORT_STATS_REQUEST:
4603 return handle_port_stats_request(ofconn, oh);
4605 case OFPTYPE_QUEUE_STATS_REQUEST:
4606 return handle_queue_stats_request(ofconn, oh);
4608 case OFPTYPE_PORT_DESC_STATS_REQUEST:
4609 return handle_port_desc_stats_request(ofconn, oh);
4611 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
4612 return handle_flow_monitor_request(ofconn, oh);
4614 case OFPTYPE_METER_STATS_REQUEST:
4615 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
4616 return handle_meter_request(ofconn, oh, type);
4618 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
4619 return handle_meter_features_request(ofconn, oh);
4621 /* FIXME: Change the following once they are implemented: */
4622 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
4623 case OFPTYPE_GET_ASYNC_REQUEST:
4624 case OFPTYPE_GROUP_STATS_REQUEST:
4625 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
4626 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
4627 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
4628 return OFPERR_OFPBRC_BAD_TYPE;
4632 case OFPTYPE_FEATURES_REPLY:
4633 case OFPTYPE_GET_CONFIG_REPLY:
4634 case OFPTYPE_PACKET_IN:
4635 case OFPTYPE_FLOW_REMOVED:
4636 case OFPTYPE_PORT_STATUS:
4637 case OFPTYPE_BARRIER_REPLY:
4638 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
4639 case OFPTYPE_DESC_STATS_REPLY:
4640 case OFPTYPE_FLOW_STATS_REPLY:
4641 case OFPTYPE_QUEUE_STATS_REPLY:
4642 case OFPTYPE_PORT_STATS_REPLY:
4643 case OFPTYPE_TABLE_STATS_REPLY:
4644 case OFPTYPE_AGGREGATE_STATS_REPLY:
4645 case OFPTYPE_PORT_DESC_STATS_REPLY:
4646 case OFPTYPE_ROLE_REPLY:
4647 case OFPTYPE_FLOW_MONITOR_PAUSED:
4648 case OFPTYPE_FLOW_MONITOR_RESUMED:
4649 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
4650 case OFPTYPE_GET_ASYNC_REPLY:
4651 case OFPTYPE_GROUP_STATS_REPLY:
4652 case OFPTYPE_GROUP_DESC_STATS_REPLY:
4653 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
4654 case OFPTYPE_METER_STATS_REPLY:
4655 case OFPTYPE_METER_CONFIG_STATS_REPLY:
4656 case OFPTYPE_METER_FEATURES_STATS_REPLY:
4657 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
4659 return OFPERR_OFPBRC_BAD_TYPE;
4664 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
4666 int error = handle_openflow__(ofconn, ofp_msg);
4667 if (error && error != OFPROTO_POSTPONE) {
4668 ofconn_send_error(ofconn, ofp_msg->data, error);
4670 COVERAGE_INC(ofproto_recv_openflow);
4671 return error != OFPROTO_POSTPONE;
4674 /* Asynchronous operations. */
4676 /* Creates and returns a new ofopgroup that is not associated with any
4677 * OpenFlow connection.
4679 * The caller should add operations to the returned group with
4680 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4681 static struct ofopgroup *
4682 ofopgroup_create_unattached(struct ofproto *ofproto)
4684 struct ofopgroup *group = xzalloc(sizeof *group);
4685 group->ofproto = ofproto;
4686 list_init(&group->ofproto_node);
4687 list_init(&group->ops);
4688 list_init(&group->ofconn_node);
4692 /* Creates and returns a new ofopgroup for 'ofproto'.
4694 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
4695 * connection. The 'request' and 'buffer_id' arguments are ignored.
4697 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
4698 * If the ofopgroup eventually fails, then the error reply will include
4699 * 'request'. If the ofopgroup eventually succeeds, then the packet with
4700 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
4702 * The caller should add operations to the returned group with
4703 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4704 static struct ofopgroup *
4705 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
4706 const struct ofp_header *request, uint32_t buffer_id)
4708 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
4710 size_t request_len = ntohs(request->length);
4712 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
4714 ofconn_add_opgroup(ofconn, &group->ofconn_node);
4715 group->ofconn = ofconn;
4716 group->request = xmemdup(request, MIN(request_len, 64));
4717 group->buffer_id = buffer_id;
4722 /* Submits 'group' for processing.
4724 * If 'group' contains no operations (e.g. none were ever added, or all of the
4725 * ones that were added completed synchronously), then it is destroyed
4726 * immediately. Otherwise it is added to the ofproto's list of pending
4729 ofopgroup_submit(struct ofopgroup *group)
4731 if (!group->n_running) {
4732 ofopgroup_complete(group);
4734 list_push_back(&group->ofproto->pending, &group->ofproto_node);
4735 group->ofproto->n_pending++;
4740 ofopgroup_complete(struct ofopgroup *group)
4742 struct ofproto *ofproto = group->ofproto;
4744 struct ofconn *abbrev_ofconn;
4745 ovs_be32 abbrev_xid;
4747 struct ofoperation *op, *next_op;
4750 ovs_assert(!group->n_running);
4753 LIST_FOR_EACH (op, group_node, &group->ops) {
4760 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
4761 LIST_FOR_EACH (op, group_node, &group->ops) {
4762 if (op->type != OFOPERATION_DELETE) {
4763 struct ofpbuf *packet;
4766 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
4770 error = rule_execute(op->rule, in_port, packet);
4777 if (!error && !list_is_empty(&group->ofconn_node)) {
4778 abbrev_ofconn = group->ofconn;
4779 abbrev_xid = group->request->xid;
4781 abbrev_ofconn = NULL;
4782 abbrev_xid = htonl(0);
4784 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
4785 struct rule *rule = op->rule;
4787 /* We generally want to report the change to active OpenFlow flow
4788 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
4790 - The operation failed.
4792 - The affected rule is not visible to controllers.
4794 - The operation's only effect was to update rule->modified. */
4796 || ofproto_rule_is_hidden(rule)
4797 || (op->type == OFOPERATION_MODIFY
4799 && rule->flow_cookie == op->flow_cookie))) {
4800 /* Check that we can just cast from ofoperation_type to
4801 * nx_flow_update_event. */
4802 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_ADD
4804 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_DELETE
4806 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_MODIFY
4809 ofmonitor_report(ofproto->connmgr, rule,
4810 (enum nx_flow_update_event) op->type,
4811 op->reason, abbrev_ofconn, abbrev_xid);
4814 rule->pending = NULL;
4817 case OFOPERATION_ADD:
4821 ofproto_rule_destroy__(op->victim);
4822 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
4823 if (vid_mask == VLAN_VID_MASK) {
4824 if (ofproto->vlan_bitmap) {
4825 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4826 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4827 bitmap_set1(ofproto->vlan_bitmap, vid);
4828 ofproto->vlans_changed = true;
4831 ofproto->vlans_changed = true;
4835 oftable_substitute_rule(rule, op->victim);
4836 ofproto_rule_destroy__(rule);
4840 case OFOPERATION_DELETE:
4841 ovs_assert(!op->error);
4842 ofproto_rule_destroy__(rule);
4846 case OFOPERATION_MODIFY:
4848 rule->modified = time_msec();
4850 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
4852 free(rule->ofpacts);
4853 rule->ofpacts = op->ofpacts;
4854 rule->ofpacts_len = op->ofpacts_len;
4856 op->ofpacts_len = 0;
4865 ofoperation_destroy(op);
4868 ofmonitor_flush(ofproto->connmgr);
4870 if (!list_is_empty(&group->ofproto_node)) {
4871 ovs_assert(ofproto->n_pending > 0);
4872 ofproto->n_pending--;
4873 list_remove(&group->ofproto_node);
4875 if (!list_is_empty(&group->ofconn_node)) {
4876 list_remove(&group->ofconn_node);
4878 ofconn_send_error(group->ofconn, group->request, error);
4880 connmgr_retry(ofproto->connmgr);
4882 free(group->request);
4886 /* Initiates a new operation on 'rule', of the specified 'type', within
4887 * 'group'. Prior to calling, 'rule' must not have any pending operation.
4889 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4890 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
4892 * Returns the newly created ofoperation (which is also available as
4893 * rule->pending). */
4894 static struct ofoperation *
4895 ofoperation_create(struct ofopgroup *group, struct rule *rule,
4896 enum ofoperation_type type,
4897 enum ofp_flow_removed_reason reason)
4899 struct ofproto *ofproto = group->ofproto;
4900 struct ofoperation *op;
4902 ovs_assert(!rule->pending);
4904 op = rule->pending = xzalloc(sizeof *op);
4906 list_push_back(&group->ops, &op->group_node);
4909 op->reason = reason;
4910 op->flow_cookie = rule->flow_cookie;
4914 if (type == OFOPERATION_DELETE) {
4915 hmap_insert(&ofproto->deletions, &op->hmap_node,
4916 cls_rule_hash(&rule->cr, rule->table_id));
4923 ofoperation_destroy(struct ofoperation *op)
4925 struct ofopgroup *group = op->group;
4928 op->rule->pending = NULL;
4930 if (op->type == OFOPERATION_DELETE) {
4931 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
4933 list_remove(&op->group_node);
4938 /* Indicates that 'op' completed with status 'error', which is either 0 to
4939 * indicate success or an OpenFlow error code on failure.
4941 * If 'error' is 0, indicating success, the operation will be committed
4942 * permanently to the flow table. There is one interesting subcase:
4944 * - If 'op' is an "add flow" operation that is replacing an existing rule in
4945 * the flow table (the "victim" rule) by a new one, then the caller must
4946 * have uninitialized any derived state in the victim rule, as in step 5 in
4947 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
4948 * performs steps 6 and 7 for the victim rule, most notably by calling its
4949 * ->rule_dealloc() function.
4951 * If 'error' is nonzero, then generally the operation will be rolled back:
4953 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
4954 * restores the original rule. The caller must have uninitialized any
4955 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
4956 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
4957 * and 7 for the new rule, calling its ->rule_dealloc() function.
4959 * - If 'op' is a "modify flow" operation, ofproto restores the original
4962 * - 'op' must not be a "delete flow" operation. Removing a rule is not
4963 * allowed to fail. It must always succeed.
4965 * Please see the large comment in ofproto/ofproto-provider.h titled
4966 * "Asynchronous Operation Support" for more information. */
4968 ofoperation_complete(struct ofoperation *op, enum ofperr error)
4970 struct ofopgroup *group = op->group;
4972 ovs_assert(op->rule->pending == op);
4973 ovs_assert(group->n_running > 0);
4974 ovs_assert(!error || op->type != OFOPERATION_DELETE);
4977 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
4978 ofopgroup_complete(group);
4983 ofoperation_get_victim(struct ofoperation *op)
4985 ovs_assert(op->type == OFOPERATION_ADD);
4990 pick_datapath_id(const struct ofproto *ofproto)
4992 const struct ofport *port;
4994 port = ofproto_get_port(ofproto, OFPP_LOCAL);
4996 uint8_t ea[ETH_ADDR_LEN];
4999 error = netdev_get_etheraddr(port->netdev, ea);
5001 return eth_addr_to_uint64(ea);
5003 VLOG_WARN("%s: could not get MAC address for %s (%s)",
5004 ofproto->name, netdev_get_name(port->netdev),
5005 ovs_strerror(error));
5007 return ofproto->fallback_dpid;
5011 pick_fallback_dpid(void)
5013 uint8_t ea[ETH_ADDR_LEN];
5014 eth_addr_nicira_random(ea);
5015 return eth_addr_to_uint64(ea);
5018 /* Table overflow policy. */
5020 /* Chooses and returns a rule to evict from 'table'. Returns NULL if the table
5021 * is not configured to evict rules or if the table contains no evictable
5022 * rules. (Rules with 'evictable' set to false or with no timeouts are not
5024 static struct rule *
5025 choose_rule_to_evict(struct oftable *table)
5027 struct eviction_group *evg;
5029 if (!table->eviction_fields) {
5033 /* In the common case, the outer and inner loops here will each be entered
5036 * - The inner loop normally "return"s in its first iteration. If the
5037 * eviction group has any evictable rules, then it always returns in
5040 * - The outer loop only iterates more than once if the largest eviction
5041 * group has no evictable rules.
5043 * - The outer loop can exit only if table's 'max_flows' is all filled up
5044 * by unevictable rules'. */
5045 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
5048 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
5049 if (rule->evictable) {
5058 /* Searches 'ofproto' for tables that have more flows than their configured
5059 * maximum and that have flow eviction enabled, and evicts as many flows as
5060 * necessary and currently feasible from them.
5062 * This triggers only when an OpenFlow table has N flows in it and then the
5063 * client configures a maximum number of flows less than N. */
5065 ofproto_evict(struct ofproto *ofproto)
5067 struct ofopgroup *group;
5068 struct oftable *table;
5070 group = ofopgroup_create_unattached(ofproto);
5071 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
5072 while (classifier_count(&table->cls) > table->max_flows
5073 && table->eviction_fields) {
5076 rule = choose_rule_to_evict(table);
5077 if (!rule || rule->pending) {
5081 ofoperation_create(group, rule,
5082 OFOPERATION_DELETE, OFPRR_EVICTION);
5083 oftable_remove_rule(rule);
5084 ofproto->ofproto_class->rule_destruct(rule);
5087 ofopgroup_submit(group);
5090 /* Eviction groups. */
5092 /* Returns the priority to use for an eviction_group that contains 'n_rules'
5093 * rules. The priority contains low-order random bits to ensure that eviction
5094 * groups with the same number of rules are prioritized randomly. */
5096 eviction_group_priority(size_t n_rules)
5098 uint16_t size = MIN(UINT16_MAX, n_rules);
5099 return (size << 16) | random_uint16();
5102 /* Updates 'evg', an eviction_group within 'table', following a change that
5103 * adds or removes rules in 'evg'. */
5105 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
5107 heap_change(&table->eviction_groups_by_size, &evg->size_node,
5108 eviction_group_priority(heap_count(&evg->rules)));
5111 /* Destroys 'evg', an eviction_group within 'table':
5113 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
5114 * rules themselves, just removes them from the eviction group.)
5116 * - Removes 'evg' from 'table'.
5120 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
5122 while (!heap_is_empty(&evg->rules)) {
5125 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
5126 rule->eviction_group = NULL;
5128 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
5129 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
5130 heap_destroy(&evg->rules);
5134 /* Removes 'rule' from its eviction group, if any. */
5136 eviction_group_remove_rule(struct rule *rule)
5138 if (rule->eviction_group) {
5139 struct oftable *table = &rule->ofproto->tables[rule->table_id];
5140 struct eviction_group *evg = rule->eviction_group;
5142 rule->eviction_group = NULL;
5143 heap_remove(&evg->rules, &rule->evg_node);
5144 if (heap_is_empty(&evg->rules)) {
5145 eviction_group_destroy(table, evg);
5147 eviction_group_resized(table, evg);
5152 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
5153 * returns the hash value. */
5155 eviction_group_hash_rule(struct rule *rule)
5157 struct oftable *table = &rule->ofproto->tables[rule->table_id];
5158 const struct mf_subfield *sf;
5162 hash = table->eviction_group_id_basis;
5163 miniflow_expand(&rule->cr.match.flow, &flow);
5164 for (sf = table->eviction_fields;
5165 sf < &table->eviction_fields[table->n_eviction_fields];
5168 if (mf_are_prereqs_ok(sf->field, &flow)) {
5169 union mf_value value;
5171 mf_get_value(sf->field, &flow, &value);
5173 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
5175 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
5176 unsigned int start = sf->ofs + sf->n_bits;
5177 bitwise_zero(&value, sf->field->n_bytes, start,
5178 sf->field->n_bytes * 8 - start);
5180 hash = hash_bytes(&value, sf->field->n_bytes, hash);
5182 hash = hash_int(hash, 0);
5189 /* Returns an eviction group within 'table' with the given 'id', creating one
5191 static struct eviction_group *
5192 eviction_group_find(struct oftable *table, uint32_t id)
5194 struct eviction_group *evg;
5196 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
5200 evg = xmalloc(sizeof *evg);
5201 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
5202 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
5203 eviction_group_priority(0));
5204 heap_init(&evg->rules);
5209 /* Returns an eviction priority for 'rule'. The return value should be
5210 * interpreted so that higher priorities make a rule more attractive candidates
5213 rule_eviction_priority(struct rule *rule)
5215 long long int hard_expiration;
5216 long long int idle_expiration;
5217 long long int expiration;
5218 uint32_t expiration_offset;
5220 /* Calculate time of expiration. */
5221 hard_expiration = (rule->hard_timeout
5222 ? rule->modified + rule->hard_timeout * 1000
5224 idle_expiration = (rule->idle_timeout
5225 ? rule->used + rule->idle_timeout * 1000
5227 expiration = MIN(hard_expiration, idle_expiration);
5228 if (expiration == LLONG_MAX) {
5232 /* Calculate the time of expiration as a number of (approximate) seconds
5233 * after program startup.
5235 * This should work OK for program runs that last UINT32_MAX seconds or
5236 * less. Therefore, please restart OVS at least once every 136 years. */
5237 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
5239 /* Invert the expiration offset because we're using a max-heap. */
5240 return UINT32_MAX - expiration_offset;
5243 /* Adds 'rule' to an appropriate eviction group for its oftable's
5244 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
5245 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
5248 * The caller must ensure that 'rule' is not already in an eviction group. */
5250 eviction_group_add_rule(struct rule *rule)
5252 struct ofproto *ofproto = rule->ofproto;
5253 struct oftable *table = &ofproto->tables[rule->table_id];
5255 if (table->eviction_fields
5256 && (rule->hard_timeout || rule->idle_timeout)) {
5257 struct eviction_group *evg;
5259 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
5261 rule->eviction_group = evg;
5262 heap_insert(&evg->rules, &rule->evg_node,
5263 rule_eviction_priority(rule));
5264 eviction_group_resized(table, evg);
5270 /* Initializes 'table'. */
5272 oftable_init(struct oftable *table)
5274 memset(table, 0, sizeof *table);
5275 classifier_init(&table->cls);
5276 table->max_flows = UINT_MAX;
5279 /* Destroys 'table', including its classifier and eviction groups.
5281 * The caller is responsible for freeing 'table' itself. */
5283 oftable_destroy(struct oftable *table)
5285 ovs_assert(classifier_is_empty(&table->cls));
5286 oftable_disable_eviction(table);
5287 classifier_destroy(&table->cls);
5291 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
5292 * string, then 'table' will use its default name.
5294 * This only affects the name exposed for a table exposed through the OpenFlow
5295 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
5297 oftable_set_name(struct oftable *table, const char *name)
5299 if (name && name[0]) {
5300 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
5301 if (!table->name || strncmp(name, table->name, len)) {
5303 table->name = xmemdup0(name, len);
5311 /* oftables support a choice of two policies when adding a rule would cause the
5312 * number of flows in the table to exceed the configured maximum number: either
5313 * they can refuse to add the new flow or they can evict some existing flow.
5314 * This function configures the former policy on 'table'. */
5316 oftable_disable_eviction(struct oftable *table)
5318 if (table->eviction_fields) {
5319 struct eviction_group *evg, *next;
5321 HMAP_FOR_EACH_SAFE (evg, next, id_node,
5322 &table->eviction_groups_by_id) {
5323 eviction_group_destroy(table, evg);
5325 hmap_destroy(&table->eviction_groups_by_id);
5326 heap_destroy(&table->eviction_groups_by_size);
5328 free(table->eviction_fields);
5329 table->eviction_fields = NULL;
5330 table->n_eviction_fields = 0;
5334 /* oftables support a choice of two policies when adding a rule would cause the
5335 * number of flows in the table to exceed the configured maximum number: either
5336 * they can refuse to add the new flow or they can evict some existing flow.
5337 * This function configures the latter policy on 'table', with fairness based
5338 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
5339 * 'n_fields' as 0 disables fairness.) */
5341 oftable_enable_eviction(struct oftable *table,
5342 const struct mf_subfield *fields, size_t n_fields)
5344 struct cls_cursor cursor;
5347 if (table->eviction_fields
5348 && n_fields == table->n_eviction_fields
5350 || !memcmp(fields, table->eviction_fields,
5351 n_fields * sizeof *fields))) {
5356 oftable_disable_eviction(table);
5358 table->n_eviction_fields = n_fields;
5359 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
5361 table->eviction_group_id_basis = random_uint32();
5362 hmap_init(&table->eviction_groups_by_id);
5363 heap_init(&table->eviction_groups_by_size);
5365 cls_cursor_init(&cursor, &table->cls, NULL);
5366 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
5367 eviction_group_add_rule(rule);
5371 /* Removes 'rule' from the oftable that contains it. */
5373 oftable_remove_rule(struct rule *rule)
5375 struct ofproto *ofproto = rule->ofproto;
5376 struct oftable *table = &ofproto->tables[rule->table_id];
5378 classifier_remove(&table->cls, &rule->cr);
5379 if (rule->meter_id) {
5380 list_remove(&rule->meter_list_node);
5382 cookies_remove(ofproto, rule);
5383 eviction_group_remove_rule(rule);
5384 if (!list_is_empty(&rule->expirable)) {
5385 list_remove(&rule->expirable);
5387 if (!list_is_empty(&rule->meter_list_node)) {
5388 list_remove(&rule->meter_list_node);
5392 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
5393 * oftable that has an identical cls_rule. Returns the rule that was removed,
5394 * if any, and otherwise NULL. */
5395 static struct rule *
5396 oftable_replace_rule(struct rule *rule)
5398 struct ofproto *ofproto = rule->ofproto;
5399 struct oftable *table = &ofproto->tables[rule->table_id];
5400 struct rule *victim;
5401 bool may_expire = rule->hard_timeout || rule->idle_timeout;
5404 list_insert(&ofproto->expirable, &rule->expirable);
5406 cookies_insert(ofproto, rule);
5407 if (rule->meter_id) {
5408 struct meter *meter = ofproto->meters[rule->meter_id];
5409 list_insert(&meter->rules, &rule->meter_list_node);
5411 victim = rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
5413 if (victim->meter_id) {
5414 list_remove(&victim->meter_list_node);
5416 cookies_remove(ofproto, victim);
5418 if (!list_is_empty(&victim->expirable)) {
5419 list_remove(&victim->expirable);
5421 eviction_group_remove_rule(victim);
5423 eviction_group_add_rule(rule);
5427 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
5429 oftable_substitute_rule(struct rule *old, struct rule *new)
5432 oftable_replace_rule(new);
5434 oftable_remove_rule(old);
5438 /* unixctl commands. */
5441 ofproto_lookup(const char *name)
5443 struct ofproto *ofproto;
5445 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
5447 if (!strcmp(ofproto->name, name)) {
5455 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
5456 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
5458 struct ofproto *ofproto;
5462 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
5463 ds_put_format(&results, "%s\n", ofproto->name);
5465 unixctl_command_reply(conn, ds_cstr(&results));
5466 ds_destroy(&results);
5470 ofproto_unixctl_init(void)
5472 static bool registered;
5478 unixctl_command_register("ofproto/list", "", 0, 0,
5479 ofproto_unixctl_list, NULL);
5482 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
5484 * This is deprecated. It is only for compatibility with broken device drivers
5485 * in old versions of Linux that do not properly support VLANs when VLAN
5486 * devices are not used. When broken device drivers are no longer in
5487 * widespread use, we will delete these interfaces. */
5489 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
5490 * (exactly) by an OpenFlow rule in 'ofproto'. */
5492 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
5494 const struct oftable *oftable;
5496 free(ofproto->vlan_bitmap);
5497 ofproto->vlan_bitmap = bitmap_allocate(4096);
5498 ofproto->vlans_changed = false;
5500 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
5501 const struct cls_table *table;
5503 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
5504 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
5505 const struct cls_rule *rule;
5507 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
5508 uint16_t vid = miniflow_get_vid(&rule->match.flow);
5509 bitmap_set1(vlan_bitmap, vid);
5510 bitmap_set1(ofproto->vlan_bitmap, vid);
5517 /* Returns true if new VLANs have come into use by the flow table since the
5518 * last call to ofproto_get_vlan_usage().
5520 * We don't track when old VLANs stop being used. */
5522 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
5524 return ofproto->vlans_changed;
5527 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
5528 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
5529 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
5530 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
5531 * then the VLAN device is un-enslaved. */
5533 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
5534 ofp_port_t realdev_ofp_port, int vid)
5536 struct ofport *ofport;
5539 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
5541 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
5543 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
5544 ofproto->name, vlandev_ofp_port);
5548 if (!ofproto->ofproto_class->set_realdev) {
5549 if (!vlandev_ofp_port) {
5552 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
5556 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
5558 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
5559 ofproto->name, vlandev_ofp_port,
5560 netdev_get_name(ofport->netdev), ovs_strerror(error));