2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
25 #include "byte-order.h"
26 #include "classifier.h"
29 #include "dynamic-string.h"
32 #include "meta-flow.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
38 #include "ofp-print.h"
41 #include "ofproto-provider.h"
42 #include "openflow/nicira-ext.h"
43 #include "openflow/openflow.h"
47 #include "poll-loop.h"
53 #include "unaligned.h"
57 VLOG_DEFINE_THIS_MODULE(ofproto);
59 COVERAGE_DEFINE(ofproto_error);
60 COVERAGE_DEFINE(ofproto_flush);
61 COVERAGE_DEFINE(ofproto_no_packet_in);
62 COVERAGE_DEFINE(ofproto_packet_out);
63 COVERAGE_DEFINE(ofproto_queue_req);
64 COVERAGE_DEFINE(ofproto_recv_openflow);
65 COVERAGE_DEFINE(ofproto_reinit_ports);
66 COVERAGE_DEFINE(ofproto_uninstallable);
67 COVERAGE_DEFINE(ofproto_update_port);
70 S_OPENFLOW, /* Processing OpenFlow commands. */
71 S_EVICT, /* Evicting flows from over-limit tables. */
72 S_FLUSH, /* Deleting all flow table rules. */
75 enum ofoperation_type {
81 /* A single OpenFlow request can execute any number of operations. The
82 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
83 * ofconn to which an error reply should be sent if necessary.
85 * ofproto initiates some operations internally. These operations are still
86 * assigned to groups but will not have an associated ofconn. */
88 struct ofproto *ofproto; /* Owning ofproto. */
89 struct list ofproto_node; /* In ofproto's "pending" list. */
90 struct list ops; /* List of "struct ofoperation"s. */
91 int n_running; /* Number of ops still pending. */
93 /* Data needed to send OpenFlow reply on failure or to send a buffered
96 * If list_is_empty(ofconn_node) then this ofopgroup never had an
97 * associated ofconn or its ofconn's connection dropped after it initiated
98 * the operation. In the latter case 'ofconn' is a wild pointer that
99 * refers to freed memory, so the 'ofconn' member must be used only if
100 * !list_is_empty(ofconn_node).
102 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
103 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
104 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
105 uint32_t buffer_id; /* Buffer id from original request. */
108 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
109 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
110 const struct ofp_header *,
112 static void ofopgroup_submit(struct ofopgroup *);
113 static void ofopgroup_complete(struct ofopgroup *);
115 /* A single flow table operation. */
117 struct ofopgroup *group; /* Owning group. */
118 struct list group_node; /* In ofopgroup's "ops" list. */
119 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
120 struct rule *rule; /* Rule being operated upon. */
121 enum ofoperation_type type; /* Type of operation. */
123 /* OFOPERATION_ADD. */
124 struct rule *victim; /* Rule being replaced, if any.. */
126 /* OFOPERATION_MODIFY: The old actions, if the actions are changing. */
127 struct ofpact *ofpacts;
130 /* OFOPERATION_DELETE. */
131 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
133 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
134 enum ofperr error; /* 0 if no error. */
137 static struct ofoperation *ofoperation_create(struct ofopgroup *,
139 enum ofoperation_type,
140 enum ofp_flow_removed_reason);
141 static void ofoperation_destroy(struct ofoperation *);
144 static void oftable_init(struct oftable *);
145 static void oftable_destroy(struct oftable *);
147 static void oftable_set_name(struct oftable *, const char *name);
149 static void oftable_disable_eviction(struct oftable *);
150 static void oftable_enable_eviction(struct oftable *,
151 const struct mf_subfield *fields,
154 static void oftable_remove_rule(struct rule *);
155 static struct rule *oftable_replace_rule(struct rule *);
156 static void oftable_substitute_rule(struct rule *old, struct rule *new);
158 /* A set of rules within a single OpenFlow table (oftable) that have the same
159 * values for the oftable's eviction_fields. A rule to be evicted, when one is
160 * needed, is taken from the eviction group that contains the greatest number
163 * An oftable owns any number of eviction groups, each of which contains any
166 * Membership in an eviction group is imprecise, based on the hash of the
167 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
168 * That is, if two rules have different eviction_fields, but those
169 * eviction_fields hash to the same value, then they will belong to the same
170 * eviction_group anyway.
172 * (When eviction is not enabled on an oftable, we don't track any eviction
173 * groups, to save time and space.) */
174 struct eviction_group {
175 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
176 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
177 struct heap rules; /* Contains "struct rule"s. */
180 static struct rule *choose_rule_to_evict(struct oftable *);
181 static void ofproto_evict(struct ofproto *);
182 static uint32_t rule_eviction_priority(struct rule *);
185 static void ofport_destroy__(struct ofport *);
186 static void ofport_destroy(struct ofport *);
188 static void update_port(struct ofproto *, const char *devname);
189 static int init_ports(struct ofproto *);
190 static void reinit_ports(struct ofproto *);
193 static void ofproto_rule_destroy__(struct rule *);
194 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
195 static bool rule_is_modifiable(const struct rule *);
198 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
199 const struct ofputil_flow_mod *,
200 const struct ofp_header *);
201 static void delete_flow__(struct rule *, struct ofopgroup *);
202 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
203 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
204 const struct ofputil_flow_mod *,
205 const struct ofp_header *);
208 static uint64_t pick_datapath_id(const struct ofproto *);
209 static uint64_t pick_fallback_dpid(void);
210 static void ofproto_destroy__(struct ofproto *);
211 static void update_mtu(struct ofproto *, struct ofport *);
214 static void ofproto_unixctl_init(void);
216 /* All registered ofproto classes, in probe order. */
217 static const struct ofproto_class **ofproto_classes;
218 static size_t n_ofproto_classes;
219 static size_t allocated_ofproto_classes;
221 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
222 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
224 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
227 ofproto_initialize(void)
233 ofproto_class_register(&ofproto_dpif_class);
237 /* 'type' should be a normalized datapath type, as returned by
238 * ofproto_normalize_type(). Returns the corresponding ofproto_class
239 * structure, or a null pointer if there is none registered for 'type'. */
240 static const struct ofproto_class *
241 ofproto_class_find__(const char *type)
245 ofproto_initialize();
246 for (i = 0; i < n_ofproto_classes; i++) {
247 const struct ofproto_class *class = ofproto_classes[i];
252 class->enumerate_types(&types);
253 found = sset_contains(&types, type);
254 sset_destroy(&types);
260 VLOG_WARN("unknown datapath type %s", type);
264 /* Registers a new ofproto class. After successful registration, new ofprotos
265 * of that type can be created using ofproto_create(). */
267 ofproto_class_register(const struct ofproto_class *new_class)
271 for (i = 0; i < n_ofproto_classes; i++) {
272 if (ofproto_classes[i] == new_class) {
277 if (n_ofproto_classes >= allocated_ofproto_classes) {
278 ofproto_classes = x2nrealloc(ofproto_classes,
279 &allocated_ofproto_classes,
280 sizeof *ofproto_classes);
282 ofproto_classes[n_ofproto_classes++] = new_class;
286 /* Unregisters a datapath provider. 'type' must have been previously
287 * registered and not currently be in use by any ofprotos. After
288 * unregistration new datapaths of that type cannot be opened using
289 * ofproto_create(). */
291 ofproto_class_unregister(const struct ofproto_class *class)
295 for (i = 0; i < n_ofproto_classes; i++) {
296 if (ofproto_classes[i] == class) {
297 for (i++; i < n_ofproto_classes; i++) {
298 ofproto_classes[i - 1] = ofproto_classes[i];
304 VLOG_WARN("attempted to unregister an ofproto class that is not "
309 /* Clears 'types' and enumerates all registered ofproto types into it. The
310 * caller must first initialize the sset. */
312 ofproto_enumerate_types(struct sset *types)
316 ofproto_initialize();
317 for (i = 0; i < n_ofproto_classes; i++) {
318 ofproto_classes[i]->enumerate_types(types);
322 /* Returns the fully spelled out name for the given ofproto 'type'.
324 * Normalized type string can be compared with strcmp(). Unnormalized type
325 * string might be the same even if they have different spellings. */
327 ofproto_normalize_type(const char *type)
329 return type && type[0] ? type : "system";
332 /* Clears 'names' and enumerates the names of all known created ofprotos with
333 * the given 'type'. The caller must first initialize the sset. Returns 0 if
334 * successful, otherwise a positive errno value.
336 * Some kinds of datapaths might not be practically enumerable. This is not
337 * considered an error. */
339 ofproto_enumerate_names(const char *type, struct sset *names)
341 const struct ofproto_class *class = ofproto_class_find__(type);
342 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
346 ofproto_create(const char *datapath_name, const char *datapath_type,
347 struct ofproto **ofprotop)
349 const struct ofproto_class *class;
350 struct ofproto *ofproto;
355 ofproto_initialize();
356 ofproto_unixctl_init();
358 datapath_type = ofproto_normalize_type(datapath_type);
359 class = ofproto_class_find__(datapath_type);
361 VLOG_WARN("could not create datapath %s of unknown type %s",
362 datapath_name, datapath_type);
366 ofproto = class->alloc();
368 VLOG_ERR("failed to allocate datapath %s of type %s",
369 datapath_name, datapath_type);
374 memset(ofproto, 0, sizeof *ofproto);
375 ofproto->ofproto_class = class;
376 ofproto->name = xstrdup(datapath_name);
377 ofproto->type = xstrdup(datapath_type);
378 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
379 hash_string(ofproto->name, 0));
380 ofproto->datapath_id = 0;
381 ofproto_set_flow_eviction_threshold(ofproto,
382 OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT);
383 ofproto->forward_bpdu = false;
384 ofproto->fallback_dpid = pick_fallback_dpid();
385 ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
386 ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
387 ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
388 ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
389 ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
390 ofproto->frag_handling = OFPC_FRAG_NORMAL;
391 hmap_init(&ofproto->ports);
392 shash_init(&ofproto->port_by_name);
393 ofproto->max_ports = OFPP_MAX;
394 ofproto->tables = NULL;
395 ofproto->n_tables = 0;
396 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
397 ofproto->state = S_OPENFLOW;
398 list_init(&ofproto->pending);
399 ofproto->n_pending = 0;
400 hmap_init(&ofproto->deletions);
401 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
402 ofproto->first_op = ofproto->last_op = LLONG_MIN;
403 ofproto->next_op_report = LLONG_MAX;
404 ofproto->op_backoff = LLONG_MIN;
405 ofproto->vlan_bitmap = NULL;
406 ofproto->vlans_changed = false;
407 ofproto->min_mtu = INT_MAX;
409 error = ofproto->ofproto_class->construct(ofproto);
411 VLOG_ERR("failed to open datapath %s: %s",
412 datapath_name, strerror(error));
413 ofproto_destroy__(ofproto);
417 assert(ofproto->n_tables);
419 ofproto->datapath_id = pick_datapath_id(ofproto);
426 /* Must be called (only) by an ofproto implementation in its constructor
427 * function. See the large comment on 'construct' in struct ofproto_class for
430 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
432 struct oftable *table;
434 assert(!ofproto->n_tables);
435 assert(n_tables >= 1 && n_tables <= 255);
437 ofproto->n_tables = n_tables;
438 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
439 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
444 /* To be optionally called (only) by an ofproto implementation in its
445 * constructor function. See the large comment on 'construct' in struct
446 * ofproto_class for details.
448 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
449 * will then ensure that actions passed into the ofproto implementation will
450 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
451 * function is not called, there will be no such restriction.
453 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
454 * the 'max_ports' restriction. */
456 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
458 assert(max_ports <= OFPP_MAX);
459 ofproto->max_ports = max_ports;
463 ofproto_get_datapath_id(const struct ofproto *ofproto)
465 return ofproto->datapath_id;
469 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
471 uint64_t old_dpid = p->datapath_id;
472 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
473 if (p->datapath_id != old_dpid) {
474 /* Force all active connections to reconnect, since there is no way to
475 * notify a controller that the datapath ID has changed. */
476 ofproto_reconnect_controllers(p);
481 ofproto_set_controllers(struct ofproto *p,
482 const struct ofproto_controller *controllers,
483 size_t n_controllers)
485 connmgr_set_controllers(p->connmgr, controllers, n_controllers);
489 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
491 connmgr_set_fail_mode(p->connmgr, fail_mode);
494 /* Drops the connections between 'ofproto' and all of its controllers, forcing
495 * them to reconnect. */
497 ofproto_reconnect_controllers(struct ofproto *ofproto)
499 connmgr_reconnect(ofproto->connmgr);
502 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
503 * in-band control should guarantee access, in the same way that in-band
504 * control guarantees access to OpenFlow controllers. */
506 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
507 const struct sockaddr_in *extras, size_t n)
509 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
512 /* Sets the OpenFlow queue used by flows set up by in-band control on
513 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
514 * flows will use the default queue. */
516 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
518 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
521 /* Sets the number of flows at which eviction from the kernel flow table
524 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
526 if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
527 ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
529 ofproto->flow_eviction_threshold = threshold;
533 /* If forward_bpdu is true, the NORMAL action will forward frames with
534 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
535 * the NORMAL action will drop these frames. */
537 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
539 bool old_val = ofproto->forward_bpdu;
540 ofproto->forward_bpdu = forward_bpdu;
541 if (old_val != ofproto->forward_bpdu) {
542 if (ofproto->ofproto_class->forward_bpdu_changed) {
543 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
548 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
549 * 'idle_time', in seconds. */
551 ofproto_set_mac_idle_time(struct ofproto *ofproto, unsigned idle_time)
553 if (ofproto->ofproto_class->set_mac_idle_time) {
554 ofproto->ofproto_class->set_mac_idle_time(ofproto, idle_time);
559 ofproto_set_desc(struct ofproto *p,
560 const char *mfr_desc, const char *hw_desc,
561 const char *sw_desc, const char *serial_desc,
564 struct ofp_desc_stats *ods;
567 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
568 VLOG_WARN("%s: truncating mfr_desc, must be less than %zu bytes",
569 p->name, sizeof ods->mfr_desc);
572 p->mfr_desc = xstrdup(mfr_desc);
575 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
576 VLOG_WARN("%s: truncating hw_desc, must be less than %zu bytes",
577 p->name, sizeof ods->hw_desc);
580 p->hw_desc = xstrdup(hw_desc);
583 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
584 VLOG_WARN("%s: truncating sw_desc, must be less than %zu bytes",
585 p->name, sizeof ods->sw_desc);
588 p->sw_desc = xstrdup(sw_desc);
591 if (strlen(serial_desc) >= sizeof ods->serial_num) {
592 VLOG_WARN("%s: truncating serial_desc, must be less than %zu "
593 "bytes", p->name, sizeof ods->serial_num);
595 free(p->serial_desc);
596 p->serial_desc = xstrdup(serial_desc);
599 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
600 VLOG_WARN("%s: truncating dp_desc, must be less than %zu bytes",
601 p->name, sizeof ods->dp_desc);
604 p->dp_desc = xstrdup(dp_desc);
609 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
611 return connmgr_set_snoops(ofproto->connmgr, snoops);
615 ofproto_set_netflow(struct ofproto *ofproto,
616 const struct netflow_options *nf_options)
618 if (nf_options && sset_is_empty(&nf_options->collectors)) {
622 if (ofproto->ofproto_class->set_netflow) {
623 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
625 return nf_options ? EOPNOTSUPP : 0;
630 ofproto_set_sflow(struct ofproto *ofproto,
631 const struct ofproto_sflow_options *oso)
633 if (oso && sset_is_empty(&oso->targets)) {
637 if (ofproto->ofproto_class->set_sflow) {
638 return ofproto->ofproto_class->set_sflow(ofproto, oso);
640 return oso ? EOPNOTSUPP : 0;
644 /* Spanning Tree Protocol (STP) configuration. */
646 /* Configures STP on 'ofproto' using the settings defined in 's'. If
647 * 's' is NULL, disables STP.
649 * Returns 0 if successful, otherwise a positive errno value. */
651 ofproto_set_stp(struct ofproto *ofproto,
652 const struct ofproto_stp_settings *s)
654 return (ofproto->ofproto_class->set_stp
655 ? ofproto->ofproto_class->set_stp(ofproto, s)
659 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
660 * 'enabled' member of 's' is false, then the other members are not
663 * Returns 0 if successful, otherwise a positive errno value. */
665 ofproto_get_stp_status(struct ofproto *ofproto,
666 struct ofproto_stp_status *s)
668 return (ofproto->ofproto_class->get_stp_status
669 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
673 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
674 * in 's'. The caller is responsible for assigning STP port numbers
675 * (using the 'port_num' member in the range of 1 through 255, inclusive)
676 * and ensuring there are no duplicates. If the 's' is NULL, then STP
677 * is disabled on the port.
679 * Returns 0 if successful, otherwise a positive errno value.*/
681 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
682 const struct ofproto_port_stp_settings *s)
684 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
686 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
687 ofproto->name, ofp_port);
691 return (ofproto->ofproto_class->set_stp_port
692 ? ofproto->ofproto_class->set_stp_port(ofport, s)
696 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
697 * 's'. If the 'enabled' member in 's' is false, then the other members
698 * are not meaningful.
700 * Returns 0 if successful, otherwise a positive errno value.*/
702 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
703 struct ofproto_port_stp_status *s)
705 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
707 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
708 "port %"PRIu16, ofproto->name, ofp_port);
712 return (ofproto->ofproto_class->get_stp_port_status
713 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
717 /* Queue DSCP configuration. */
719 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
720 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
721 * to implement QoS. Instead, it is used to implement features which require
722 * knowledge of what queues exist on a port, and some basic information about
725 * Returns 0 if successful, otherwise a positive errno value. */
727 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
728 const struct ofproto_port_queue *queues,
731 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
734 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
735 ofproto->name, ofp_port);
739 return (ofproto->ofproto_class->set_queues
740 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
744 /* Connectivity Fault Management configuration. */
746 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
748 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
750 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
751 if (ofport && ofproto->ofproto_class->set_cfm) {
752 ofproto->ofproto_class->set_cfm(ofport, NULL);
756 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
757 * basic configuration from the configuration members in 'cfm', and the remote
758 * maintenance point ID from remote_mpid. Ignores the statistics members of
761 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
763 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
764 const struct cfm_settings *s)
766 struct ofport *ofport;
769 ofport = ofproto_get_port(ofproto, ofp_port);
771 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
772 ofproto->name, ofp_port);
776 /* XXX: For configuration simplicity, we only support one remote_mpid
777 * outside of the CFM module. It's not clear if this is the correct long
778 * term solution or not. */
779 error = (ofproto->ofproto_class->set_cfm
780 ? ofproto->ofproto_class->set_cfm(ofport, s)
783 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
784 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
789 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
790 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
791 * 0 if LACP partner information is not current (generally indicating a
792 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
794 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
796 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
797 return (ofport && ofproto->ofproto_class->port_is_lacp_current
798 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
804 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
805 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
806 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
807 * configuration plus, if there is more than one slave, a bonding
810 * If 'aux' is already registered then this function updates its configuration
811 * to 's'. Otherwise, this function registers a new bundle.
813 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
816 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
817 const struct ofproto_bundle_settings *s)
819 return (ofproto->ofproto_class->bundle_set
820 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
824 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
825 * If no such bundle has been registered, this has no effect. */
827 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
829 return ofproto_bundle_register(ofproto, aux, NULL);
833 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
834 * If 'aux' is already registered then this function updates its configuration
835 * to 's'. Otherwise, this function registers a new mirror. */
837 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
838 const struct ofproto_mirror_settings *s)
840 return (ofproto->ofproto_class->mirror_set
841 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
845 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
846 * If no mirror has been registered, this has no effect. */
848 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
850 return ofproto_mirror_register(ofproto, aux, NULL);
853 /* Retrieves statistics from mirror associated with client data pointer
854 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
855 * 'bytes', respectively. If a particular counters is not supported,
856 * the appropriate argument is set to UINT64_MAX. */
858 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
859 uint64_t *packets, uint64_t *bytes)
861 if (!ofproto->ofproto_class->mirror_get_stats) {
862 *packets = *bytes = UINT64_MAX;
866 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
870 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
871 * which all packets are flooded, instead of using MAC learning. If
872 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
874 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
877 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
879 return (ofproto->ofproto_class->set_flood_vlans
880 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
884 /* Returns true if 'aux' is a registered bundle that is currently in use as the
885 * output for a mirror. */
887 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
889 return (ofproto->ofproto_class->is_mirror_output_bundle
890 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
894 /* Configuration of OpenFlow tables. */
896 /* Returns the number of OpenFlow tables in 'ofproto'. */
898 ofproto_get_n_tables(const struct ofproto *ofproto)
900 return ofproto->n_tables;
903 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
904 * settings from 's'. 'table_id' must be in the range 0 through the number of
905 * OpenFlow tables in 'ofproto' minus 1, inclusive.
907 * For read-only tables, only the name may be configured. */
909 ofproto_configure_table(struct ofproto *ofproto, int table_id,
910 const struct ofproto_table_settings *s)
912 struct oftable *table;
914 assert(table_id >= 0 && table_id < ofproto->n_tables);
915 table = &ofproto->tables[table_id];
917 oftable_set_name(table, s->name);
919 if (table->flags & OFTABLE_READONLY) {
924 oftable_enable_eviction(table, s->groups, s->n_groups);
926 oftable_disable_eviction(table);
929 table->max_flows = s->max_flows;
930 if (classifier_count(&table->cls) > table->max_flows
931 && table->eviction_fields) {
932 /* 'table' contains more flows than allowed. We might not be able to
933 * evict them right away because of the asynchronous nature of flow
934 * table changes. Schedule eviction for later. */
935 switch (ofproto->state) {
937 ofproto->state = S_EVICT;
941 /* We're already deleting flows, nothing more to do. */
948 ofproto_has_snoops(const struct ofproto *ofproto)
950 return connmgr_has_snoops(ofproto->connmgr);
954 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
956 connmgr_get_snoops(ofproto->connmgr, snoops);
960 ofproto_flush__(struct ofproto *ofproto)
962 struct ofopgroup *group;
963 struct oftable *table;
965 if (ofproto->ofproto_class->flush) {
966 ofproto->ofproto_class->flush(ofproto);
969 group = ofopgroup_create_unattached(ofproto);
970 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
971 struct rule *rule, *next_rule;
972 struct cls_cursor cursor;
974 if (table->flags & OFTABLE_HIDDEN) {
978 cls_cursor_init(&cursor, &table->cls, NULL);
979 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
980 if (!rule->pending) {
981 ofoperation_create(group, rule, OFOPERATION_DELETE,
983 oftable_remove_rule(rule);
984 ofproto->ofproto_class->rule_destruct(rule);
988 ofopgroup_submit(group);
992 ofproto_destroy__(struct ofproto *ofproto)
994 struct oftable *table;
996 assert(list_is_empty(&ofproto->pending));
997 assert(!ofproto->n_pending);
999 connmgr_destroy(ofproto->connmgr);
1001 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1002 free(ofproto->name);
1003 free(ofproto->type);
1004 free(ofproto->mfr_desc);
1005 free(ofproto->hw_desc);
1006 free(ofproto->sw_desc);
1007 free(ofproto->serial_desc);
1008 free(ofproto->dp_desc);
1009 hmap_destroy(&ofproto->ports);
1010 shash_destroy(&ofproto->port_by_name);
1012 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1013 oftable_destroy(table);
1015 free(ofproto->tables);
1017 hmap_destroy(&ofproto->deletions);
1019 free(ofproto->vlan_bitmap);
1021 ofproto->ofproto_class->dealloc(ofproto);
1025 ofproto_destroy(struct ofproto *p)
1027 struct ofport *ofport, *next_ofport;
1034 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1035 ofport_destroy(ofport);
1038 p->ofproto_class->destruct(p);
1039 ofproto_destroy__(p);
1042 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1043 * kernel datapath, for example, this destroys the datapath in the kernel, and
1044 * with the netdev-based datapath, it tears down the data structures that
1045 * represent the datapath.
1047 * The datapath should not be currently open as an ofproto. */
1049 ofproto_delete(const char *name, const char *type)
1051 const struct ofproto_class *class = ofproto_class_find__(type);
1052 return (!class ? EAFNOSUPPORT
1053 : !class->del ? EACCES
1054 : class->del(type, name));
1058 process_port_change(struct ofproto *ofproto, int error, char *devname)
1060 if (error == ENOBUFS) {
1061 reinit_ports(ofproto);
1062 } else if (!error) {
1063 update_port(ofproto, devname);
1069 ofproto_run(struct ofproto *p)
1071 struct sset changed_netdevs;
1072 const char *changed_netdev;
1073 struct ofport *ofport;
1076 error = p->ofproto_class->run(p);
1077 if (error && error != EAGAIN) {
1078 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, strerror(error));
1081 if (p->ofproto_class->port_poll) {
1084 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1085 process_port_change(p, error, devname);
1089 /* Update OpenFlow port status for any port whose netdev has changed.
1091 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1092 * destroyed, so it's not safe to update ports directly from the
1093 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1094 * need this two-phase approach. */
1095 sset_init(&changed_netdevs);
1096 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1097 unsigned int change_seq = netdev_change_seq(ofport->netdev);
1098 if (ofport->change_seq != change_seq) {
1099 ofport->change_seq = change_seq;
1100 sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1103 SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1104 update_port(p, changed_netdev);
1106 sset_destroy(&changed_netdevs);
1110 connmgr_run(p->connmgr, handle_openflow);
1114 connmgr_run(p->connmgr, NULL);
1116 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1117 p->state = S_OPENFLOW;
1122 connmgr_run(p->connmgr, NULL);
1124 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1125 connmgr_flushed(p->connmgr);
1126 p->state = S_OPENFLOW;
1134 if (time_msec() >= p->next_op_report) {
1135 long long int ago = (time_msec() - p->first_op) / 1000;
1136 long long int interval = (p->last_op - p->first_op) / 1000;
1140 ds_put_format(&s, "%d flow_mods ",
1141 p->n_add + p->n_delete + p->n_modify);
1142 if (interval == ago) {
1143 ds_put_format(&s, "in the last %lld s", ago);
1144 } else if (interval) {
1145 ds_put_format(&s, "in the %lld s starting %lld s ago",
1148 ds_put_format(&s, "%lld s ago", ago);
1151 ds_put_cstr(&s, " (");
1153 ds_put_format(&s, "%d adds, ", p->n_add);
1156 ds_put_format(&s, "%d deletes, ", p->n_delete);
1159 ds_put_format(&s, "%d modifications, ", p->n_modify);
1162 ds_put_char(&s, ')');
1164 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1167 p->n_add = p->n_delete = p->n_modify = 0;
1168 p->next_op_report = LLONG_MAX;
1174 /* Performs periodic activity required by 'ofproto' that needs to be done
1175 * with the least possible latency.
1177 * It makes sense to call this function a couple of times per poll loop, to
1178 * provide a significant performance boost on some benchmarks with the
1179 * ofproto-dpif implementation. */
1181 ofproto_run_fast(struct ofproto *p)
1185 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1186 if (error && error != EAGAIN) {
1187 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1188 p->name, strerror(error));
1194 ofproto_wait(struct ofproto *p)
1196 struct ofport *ofport;
1198 p->ofproto_class->wait(p);
1199 if (p->ofproto_class->port_poll_wait) {
1200 p->ofproto_class->port_poll_wait(p);
1203 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1204 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1205 poll_immediate_wake();
1211 connmgr_wait(p->connmgr, true);
1216 connmgr_wait(p->connmgr, false);
1217 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1218 poll_immediate_wake();
1225 ofproto_is_alive(const struct ofproto *p)
1227 return connmgr_has_controllers(p->connmgr);
1230 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1231 * memory_report(). */
1233 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1235 const struct oftable *table;
1236 unsigned int n_rules;
1238 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1239 simap_increase(usage, "ops",
1240 ofproto->n_pending + hmap_count(&ofproto->deletions));
1243 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1244 n_rules += classifier_count(&table->cls);
1246 simap_increase(usage, "rules", n_rules);
1248 if (ofproto->ofproto_class->get_memory_usage) {
1249 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1252 connmgr_get_memory_usage(ofproto->connmgr, usage);
1256 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1259 connmgr_get_controller_info(ofproto->connmgr, info);
1263 ofproto_free_ofproto_controller_info(struct shash *info)
1265 connmgr_free_controller_info(info);
1268 /* Makes a deep copy of 'old' into 'port'. */
1270 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1272 port->name = xstrdup(old->name);
1273 port->type = xstrdup(old->type);
1274 port->ofp_port = old->ofp_port;
1277 /* Frees memory allocated to members of 'ofproto_port'.
1279 * Do not call this function on an ofproto_port obtained from
1280 * ofproto_port_dump_next(): that function retains ownership of the data in the
1283 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1285 free(ofproto_port->name);
1286 free(ofproto_port->type);
1289 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1291 * This function provides no status indication. An error status for the entire
1292 * dump operation is provided when it is completed by calling
1293 * ofproto_port_dump_done().
1296 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1297 const struct ofproto *ofproto)
1299 dump->ofproto = ofproto;
1300 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1304 /* Attempts to retrieve another port from 'dump', which must have been created
1305 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1306 * 'port' and returns true. On failure, returns false.
1308 * Failure might indicate an actual error or merely that the last port has been
1309 * dumped. An error status for the entire dump operation is provided when it
1310 * is completed by calling ofproto_port_dump_done().
1312 * The ofproto owns the data stored in 'port'. It will remain valid until at
1313 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1314 * ofproto_port_dump_done(). */
1316 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1317 struct ofproto_port *port)
1319 const struct ofproto *ofproto = dump->ofproto;
1325 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1328 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1334 /* Completes port table dump operation 'dump', which must have been created
1335 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1336 * error-free, otherwise a positive errno value describing the problem. */
1338 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1340 const struct ofproto *ofproto = dump->ofproto;
1342 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1345 return dump->error == EOF ? 0 : dump->error;
1348 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1349 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1350 * the port's OpenFlow port number.
1352 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1353 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1354 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1355 * 'ofp_portp' is non-null). */
1357 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1358 uint16_t *ofp_portp)
1360 uint16_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1363 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
1365 update_port(ofproto, netdev_get_name(netdev));
1368 *ofp_portp = error ? OFPP_NONE : ofp_port;
1373 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1374 * initializes '*port' appropriately; on failure, returns a positive errno
1377 * The caller owns the data in 'ofproto_port' and must free it with
1378 * ofproto_port_destroy() when it is no longer needed. */
1380 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1381 struct ofproto_port *port)
1385 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1387 memset(port, 0, sizeof *port);
1392 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1393 * Returns 0 if successful, otherwise a positive errno. */
1395 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1397 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1398 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1401 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1402 if (!error && ofport) {
1403 /* 'name' is the netdev's name and update_port() is going to close the
1404 * netdev. Just in case update_port() refers to 'name' after it
1405 * destroys 'ofport', make a copy of it around the update_port()
1407 char *devname = xstrdup(name);
1408 update_port(ofproto, devname);
1414 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1415 * performs the 'n_actions' actions in 'actions'. The new flow will not
1418 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1419 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1420 * controllers; otherwise, it will be hidden.
1422 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1424 * This is a helper function for in-band control and fail-open. */
1426 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1427 unsigned int priority,
1428 const struct ofpact *ofpacts, size_t ofpacts_len)
1430 const struct rule *rule;
1432 rule = rule_from_cls_rule(classifier_find_match_exactly(
1433 &ofproto->tables[0].cls, match, priority));
1434 if (!rule || !ofpacts_equal(rule->ofpacts, rule->ofpacts_len,
1435 ofpacts, ofpacts_len)) {
1436 struct ofputil_flow_mod fm;
1438 memset(&fm, 0, sizeof fm);
1440 fm.priority = priority;
1441 fm.buffer_id = UINT32_MAX;
1442 fm.ofpacts = xmemdup(ofpacts, ofpacts_len);
1443 fm.ofpacts_len = ofpacts_len;
1444 add_flow(ofproto, NULL, &fm, NULL);
1449 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1450 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1451 * operation cannot be initiated now but may be retried later.
1453 * This is a helper function for in-band control and fail-open. */
1455 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1457 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1460 /* Searches for a rule with matching criteria exactly equal to 'target' in
1461 * ofproto's table 0 and, if it finds one, deletes it.
1463 * This is a helper function for in-band control and fail-open. */
1465 ofproto_delete_flow(struct ofproto *ofproto,
1466 const struct match *target, unsigned int priority)
1470 rule = rule_from_cls_rule(classifier_find_match_exactly(
1471 &ofproto->tables[0].cls, target, priority));
1473 /* No such rule -> success. */
1475 } else if (rule->pending) {
1476 /* An operation on the rule is already pending -> failure.
1477 * Caller must retry later if it's important. */
1480 /* Initiate deletion -> success. */
1481 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1482 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1483 oftable_remove_rule(rule);
1484 ofproto->ofproto_class->rule_destruct(rule);
1485 ofopgroup_submit(group);
1491 /* Starts the process of deleting all of the flows from all of ofproto's flow
1492 * tables and then reintroducing the flows required by in-band control and
1493 * fail-open. The process will complete in a later call to ofproto_run(). */
1495 ofproto_flush_flows(struct ofproto *ofproto)
1497 COVERAGE_INC(ofproto_flush);
1498 ofproto->state = S_FLUSH;
1502 reinit_ports(struct ofproto *p)
1504 struct ofproto_port_dump dump;
1505 struct sset devnames;
1506 struct ofport *ofport;
1507 struct ofproto_port ofproto_port;
1508 const char *devname;
1510 COVERAGE_INC(ofproto_reinit_ports);
1512 sset_init(&devnames);
1513 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1514 sset_add(&devnames, netdev_get_name(ofport->netdev));
1516 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1517 sset_add(&devnames, ofproto_port.name);
1520 SSET_FOR_EACH (devname, &devnames) {
1521 update_port(p, devname);
1523 sset_destroy(&devnames);
1526 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1527 * pointer if the netdev cannot be opened. On success, also fills in
1529 static struct netdev *
1530 ofport_open(const struct ofproto *ofproto,
1531 const struct ofproto_port *ofproto_port,
1532 struct ofputil_phy_port *pp)
1534 enum netdev_flags flags;
1535 struct netdev *netdev;
1538 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1540 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1541 "cannot be opened (%s)",
1543 ofproto_port->name, ofproto_port->ofp_port,
1544 ofproto_port->name, strerror(error));
1548 pp->port_no = ofproto_port->ofp_port;
1549 netdev_get_etheraddr(netdev, pp->hw_addr);
1550 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1551 netdev_get_flags(netdev, &flags);
1552 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1553 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1554 netdev_get_features(netdev, &pp->curr, &pp->advertised,
1555 &pp->supported, &pp->peer);
1556 pp->curr_speed = netdev_features_to_bps(pp->curr);
1557 pp->max_speed = netdev_features_to_bps(pp->supported);
1562 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1563 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1566 ofport_equal(const struct ofputil_phy_port *a,
1567 const struct ofputil_phy_port *b)
1569 return (eth_addr_equals(a->hw_addr, b->hw_addr)
1570 && a->state == b->state
1571 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1572 && a->curr == b->curr
1573 && a->advertised == b->advertised
1574 && a->supported == b->supported
1575 && a->peer == b->peer
1576 && a->curr_speed == b->curr_speed
1577 && a->max_speed == b->max_speed);
1580 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1581 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1582 * one with the same name or port number). */
1584 ofport_install(struct ofproto *p,
1585 struct netdev *netdev, const struct ofputil_phy_port *pp)
1587 const char *netdev_name = netdev_get_name(netdev);
1588 struct ofport *ofport;
1591 /* Create ofport. */
1592 ofport = p->ofproto_class->port_alloc();
1597 ofport->ofproto = p;
1598 ofport->netdev = netdev;
1599 ofport->change_seq = netdev_change_seq(netdev);
1601 ofport->ofp_port = pp->port_no;
1603 /* Add port to 'p'. */
1604 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1605 shash_add(&p->port_by_name, netdev_name, ofport);
1607 update_mtu(p, ofport);
1609 /* Let the ofproto_class initialize its private data. */
1610 error = p->ofproto_class->port_construct(ofport);
1614 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1618 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1619 p->name, netdev_name, strerror(error));
1621 ofport_destroy__(ofport);
1623 netdev_close(netdev);
1627 /* Removes 'ofport' from 'p' and destroys it. */
1629 ofport_remove(struct ofport *ofport)
1631 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1633 ofport_destroy(ofport);
1636 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1639 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1641 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1643 ofport_remove(port);
1647 /* Updates 'port' with new 'pp' description.
1649 * Does not handle a name or port number change. The caller must implement
1650 * such a change as a delete followed by an add. */
1652 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1654 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1655 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1656 | (pp->config & OFPUTIL_PC_PORT_DOWN));
1657 port->pp.state = pp->state;
1658 port->pp.curr = pp->curr;
1659 port->pp.advertised = pp->advertised;
1660 port->pp.supported = pp->supported;
1661 port->pp.peer = pp->peer;
1662 port->pp.curr_speed = pp->curr_speed;
1663 port->pp.max_speed = pp->max_speed;
1665 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1668 /* Update OpenFlow 'state' in 'port' and notify controller. */
1670 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
1672 if (port->pp.state != state) {
1673 port->pp.state = state;
1674 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
1680 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1682 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1684 if (port->ofproto->ofproto_class->set_realdev) {
1685 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1687 if (port->ofproto->ofproto_class->set_stp_port) {
1688 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1690 if (port->ofproto->ofproto_class->set_cfm) {
1691 port->ofproto->ofproto_class->set_cfm(port, NULL);
1693 if (port->ofproto->ofproto_class->bundle_remove) {
1694 port->ofproto->ofproto_class->bundle_remove(port);
1700 ofport_destroy__(struct ofport *port)
1702 struct ofproto *ofproto = port->ofproto;
1703 const char *name = netdev_get_name(port->netdev);
1705 hmap_remove(&ofproto->ports, &port->hmap_node);
1706 shash_delete(&ofproto->port_by_name,
1707 shash_find(&ofproto->port_by_name, name));
1709 netdev_close(port->netdev);
1710 ofproto->ofproto_class->port_dealloc(port);
1714 ofport_destroy(struct ofport *port)
1717 port->ofproto->ofproto_class->port_destruct(port);
1718 ofport_destroy__(port);
1723 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1725 struct ofport *port;
1727 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1728 hash_int(ofp_port, 0), &ofproto->ports) {
1729 if (port->ofp_port == ofp_port) {
1737 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1739 struct ofproto *ofproto = port->ofproto;
1742 if (ofproto->ofproto_class->port_get_stats) {
1743 error = ofproto->ofproto_class->port_get_stats(port, stats);
1752 update_port(struct ofproto *ofproto, const char *name)
1754 struct ofproto_port ofproto_port;
1755 struct ofputil_phy_port pp;
1756 struct netdev *netdev;
1757 struct ofport *port;
1759 COVERAGE_INC(ofproto_update_port);
1761 /* Fetch 'name''s location and properties from the datapath. */
1762 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1763 ? ofport_open(ofproto, &ofproto_port, &pp)
1766 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1767 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1768 struct netdev *old_netdev = port->netdev;
1770 /* 'name' hasn't changed location. Any properties changed? */
1771 if (!ofport_equal(&port->pp, &pp)) {
1772 ofport_modified(port, &pp);
1775 update_mtu(ofproto, port);
1777 /* Install the newly opened netdev in case it has changed.
1778 * Don't close the old netdev yet in case port_modified has to
1779 * remove a retained reference to it.*/
1780 port->netdev = netdev;
1781 port->change_seq = netdev_change_seq(netdev);
1783 if (port->ofproto->ofproto_class->port_modified) {
1784 port->ofproto->ofproto_class->port_modified(port);
1787 netdev_close(old_netdev);
1789 /* If 'port' is nonnull then its name differs from 'name' and thus
1790 * we should delete it. If we think there's a port named 'name'
1791 * then its port number must be wrong now so delete it too. */
1793 ofport_remove(port);
1795 ofport_remove_with_name(ofproto, name);
1796 ofport_install(ofproto, netdev, &pp);
1799 /* Any port named 'name' is gone now. */
1800 ofport_remove_with_name(ofproto, name);
1802 ofproto_port_destroy(&ofproto_port);
1806 init_ports(struct ofproto *p)
1808 struct ofproto_port_dump dump;
1809 struct ofproto_port ofproto_port;
1811 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1812 uint16_t ofp_port = ofproto_port.ofp_port;
1813 if (ofproto_get_port(p, ofp_port)) {
1814 VLOG_WARN_RL(&rl, "%s: ignoring duplicate port %"PRIu16" "
1815 "in datapath", p->name, ofp_port);
1816 } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1817 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
1818 p->name, ofproto_port.name);
1820 struct ofputil_phy_port pp;
1821 struct netdev *netdev;
1823 netdev = ofport_open(p, &ofproto_port, &pp);
1825 ofport_install(p, netdev, &pp);
1833 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1834 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1836 find_min_mtu(struct ofproto *p)
1838 struct ofport *ofport;
1841 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1842 struct netdev *netdev = ofport->netdev;
1845 /* Skip any internal ports, since that's what we're trying to
1847 if (!strcmp(netdev_get_type(netdev), "internal")) {
1851 if (netdev_get_mtu(netdev, &dev_mtu)) {
1854 if (!mtu || dev_mtu < mtu) {
1859 return mtu ? mtu: ETH_PAYLOAD_MAX;
1862 /* Update MTU of all datapath devices on 'p' to the minimum of the
1863 * non-datapath ports in event of 'port' added or changed. */
1865 update_mtu(struct ofproto *p, struct ofport *port)
1867 struct ofport *ofport;
1868 struct netdev *netdev = port->netdev;
1869 int dev_mtu, old_min;
1871 if (netdev_get_mtu(netdev, &dev_mtu)) {
1875 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
1876 if (dev_mtu > p->min_mtu) {
1877 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
1878 dev_mtu = p->min_mtu;
1881 port->mtu = dev_mtu;
1885 /* For non-internal port find new min mtu. */
1886 old_min = p->min_mtu;
1887 port->mtu = dev_mtu;
1888 p->min_mtu = find_min_mtu(p);
1889 if (p->min_mtu == old_min) {
1893 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1894 struct netdev *netdev = ofport->netdev;
1896 if (!strcmp(netdev_get_type(netdev), "internal")) {
1897 if (!netdev_set_mtu(netdev, p->min_mtu)) {
1898 ofport->mtu = p->min_mtu;
1905 ofproto_rule_destroy__(struct rule *rule)
1908 cls_rule_destroy(&rule->cr);
1909 free(rule->ofpacts);
1910 rule->ofproto->ofproto_class->rule_dealloc(rule);
1914 /* This function allows an ofproto implementation to destroy any rules that
1915 * remain when its ->destruct() function is called. The caller must have
1916 * already uninitialized any derived members of 'rule' (step 5 described in the
1917 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1918 * This function implements steps 6 and 7.
1920 * This function should only be called from an ofproto implementation's
1921 * ->destruct() function. It is not suitable elsewhere. */
1923 ofproto_rule_destroy(struct rule *rule)
1925 assert(!rule->pending);
1926 oftable_remove_rule(rule);
1927 ofproto_rule_destroy__(rule);
1930 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1931 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
1933 ofproto_rule_has_out_port(const struct rule *rule, uint16_t port)
1935 return (port == OFPP_NONE
1936 || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
1939 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
1940 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
1942 ofoperation_has_out_port(const struct ofoperation *op, uint16_t out_port)
1944 if (ofproto_rule_has_out_port(op->rule, out_port)) {
1949 case OFOPERATION_ADD:
1950 return op->victim && ofproto_rule_has_out_port(op->victim, out_port);
1952 case OFOPERATION_DELETE:
1955 case OFOPERATION_MODIFY:
1956 return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
1962 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1963 * statistics appropriately. 'packet' must have at least sizeof(struct
1964 * ofp_packet_in) bytes of headroom.
1966 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1967 * with statistics for 'packet' either way.
1969 * Takes ownership of 'packet'. */
1971 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1975 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1977 flow_extract(packet, 0, NULL, in_port, &flow);
1978 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1981 /* Returns true if 'rule' should be hidden from the controller.
1983 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1984 * (e.g. by in-band control) and are intentionally hidden from the
1987 ofproto_rule_is_hidden(const struct rule *rule)
1989 return rule->cr.priority > UINT16_MAX;
1992 static enum oftable_flags
1993 rule_get_flags(const struct rule *rule)
1995 return rule->ofproto->tables[rule->table_id].flags;
1999 rule_is_modifiable(const struct rule *rule)
2001 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2005 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2007 ofconn_send_reply(ofconn, make_echo_reply(oh));
2012 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2014 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2015 struct ofputil_switch_features features;
2016 struct ofport *port;
2020 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2022 assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2024 features.datapath_id = ofproto->datapath_id;
2025 features.n_buffers = pktbuf_capacity();
2026 features.n_tables = ofproto->n_tables;
2027 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2028 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2030 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2033 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2035 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2036 ofputil_put_switch_features_port(&port->pp, b);
2039 ofconn_send_reply(ofconn, b);
2044 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2046 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2047 struct ofp_switch_config *osc;
2048 enum ofp_config_flags flags;
2052 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2053 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2054 flags = ofproto->frag_handling;
2055 if (ofconn_get_invalid_ttl_to_controller(ofconn)) {
2056 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2058 osc->flags = htons(flags);
2059 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2060 ofconn_send_reply(ofconn, buf);
2066 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2068 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2069 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2070 uint16_t flags = ntohs(osc->flags);
2072 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2073 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
2074 enum ofp_config_flags cur = ofproto->frag_handling;
2075 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2077 assert((cur & OFPC_FRAG_MASK) == cur);
2079 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2080 ofproto->frag_handling = next;
2082 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2084 ofputil_frag_handling_to_string(next));
2088 ofconn_set_invalid_ttl_to_controller(ofconn,
2089 (flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2091 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2096 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2097 * error message code for the caller to propagate upward. Otherwise, returns
2100 * The log message mentions 'msg_type'. */
2102 reject_slave_controller(struct ofconn *ofconn)
2104 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2105 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
2106 return OFPERR_OFPBRC_EPERM;
2113 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2115 struct ofproto *p = ofconn_get_ofproto(ofconn);
2116 struct ofputil_packet_out po;
2117 struct ofpbuf *payload;
2118 uint64_t ofpacts_stub[1024 / 8];
2119 struct ofpbuf ofpacts;
2123 COVERAGE_INC(ofproto_packet_out);
2125 error = reject_slave_controller(ofconn);
2130 /* Decode message. */
2131 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2132 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2134 goto exit_free_ofpacts;
2136 if (po.in_port >= p->max_ports && po.in_port < OFPP_MAX) {
2137 error = OFPERR_OFPBRC_BAD_PORT;
2138 goto exit_free_ofpacts;
2143 if (po.buffer_id != UINT32_MAX) {
2144 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2145 if (error || !payload) {
2146 goto exit_free_ofpacts;
2149 payload = xmalloc(sizeof *payload);
2150 ofpbuf_use_const(payload, po.packet, po.packet_len);
2153 /* Verify actions against packet, then send packet if successful. */
2154 flow_extract(payload, 0, NULL, po.in_port, &flow);
2155 error = ofpacts_check(po.ofpacts, po.ofpacts_len, &flow, p->max_ports);
2157 error = p->ofproto_class->packet_out(p, payload, &flow,
2158 po.ofpacts, po.ofpacts_len);
2160 ofpbuf_delete(payload);
2163 ofpbuf_uninit(&ofpacts);
2169 update_port_config(struct ofport *port,
2170 enum ofputil_port_config config,
2171 enum ofputil_port_config mask)
2173 enum ofputil_port_config old_config = port->pp.config;
2174 enum ofputil_port_config toggle;
2176 toggle = (config ^ port->pp.config) & mask;
2177 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2178 if (config & OFPUTIL_PC_PORT_DOWN) {
2179 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2181 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2183 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2186 port->pp.config ^= toggle;
2187 if (port->pp.config != old_config) {
2188 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2193 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2195 struct ofproto *p = ofconn_get_ofproto(ofconn);
2196 struct ofputil_port_mod pm;
2197 struct ofport *port;
2200 error = reject_slave_controller(ofconn);
2205 error = ofputil_decode_port_mod(oh, &pm);
2210 port = ofproto_get_port(p, pm.port_no);
2212 return OFPERR_OFPPMFC_BAD_PORT;
2213 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2214 return OFPERR_OFPPMFC_BAD_HW_ADDR;
2216 update_port_config(port, pm.config, pm.mask);
2218 netdev_set_advertisements(port->netdev, pm.advertise);
2225 handle_desc_stats_request(struct ofconn *ofconn,
2226 const struct ofp_header *request)
2228 struct ofproto *p = ofconn_get_ofproto(ofconn);
2229 struct ofp_desc_stats *ods;
2232 msg = ofpraw_alloc_stats_reply(request, 0);
2233 ods = ofpbuf_put_zeros(msg, sizeof *ods);
2234 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
2235 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
2236 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
2237 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
2238 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
2239 ofconn_send_reply(ofconn, msg);
2245 handle_table_stats_request(struct ofconn *ofconn,
2246 const struct ofp_header *request)
2248 struct ofproto *p = ofconn_get_ofproto(ofconn);
2249 struct ofp12_table_stats *ots;
2253 /* Set up default values.
2255 * ofp12_table_stats is used as a generic structure as
2256 * it is able to hold all the fields for ofp10_table_stats
2257 * and ofp11_table_stats (and of course itself).
2259 ots = xcalloc(p->n_tables, sizeof *ots);
2260 for (i = 0; i < p->n_tables; i++) {
2261 ots[i].table_id = i;
2262 sprintf(ots[i].name, "table%zu", i);
2263 ots[i].match = htonll(OFPXMT12_MASK);
2264 ots[i].wildcards = htonll(OFPXMT12_MASK);
2265 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2266 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2267 ots[i].write_setfields = htonll(OFPXMT12_MASK);
2268 ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2269 ots[i].metadata_match = htonll(UINT64_MAX);
2270 ots[i].metadata_write = htonll(UINT64_MAX);
2271 ots[i].instructions = htonl(OFPIT11_ALL);
2272 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2273 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2274 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2277 p->ofproto_class->get_tables(p, ots);
2279 for (i = 0; i < p->n_tables; i++) {
2280 const struct oftable *table = &p->tables[i];
2283 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2286 if (table->max_flows < ntohl(ots[i].max_entries)) {
2287 ots[i].max_entries = htonl(table->max_flows);
2291 msg = ofputil_encode_table_stats_reply(ots, p->n_tables, request);
2292 ofconn_send_reply(ofconn, msg);
2300 append_port_stat(struct ofport *port, struct list *replies)
2302 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2304 /* Intentionally ignore return value, since errors will set
2305 * 'stats' to all-1s, which is correct for OpenFlow, and
2306 * netdev_get_stats() will log errors. */
2307 ofproto_port_get_stats(port, &ops.stats);
2309 ofputil_append_port_stat(replies, &ops);
2313 handle_port_stats_request(struct ofconn *ofconn,
2314 const struct ofp_header *request)
2316 struct ofproto *p = ofconn_get_ofproto(ofconn);
2317 struct ofport *port;
2318 struct list replies;
2322 error = ofputil_decode_port_stats_request(request, &port_no);
2327 ofpmp_init(&replies, request);
2328 if (port_no != OFPP_NONE) {
2329 port = ofproto_get_port(p, port_no);
2331 append_port_stat(port, &replies);
2334 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2335 append_port_stat(port, &replies);
2339 ofconn_send_replies(ofconn, &replies);
2344 handle_port_desc_stats_request(struct ofconn *ofconn,
2345 const struct ofp_header *request)
2347 struct ofproto *p = ofconn_get_ofproto(ofconn);
2348 enum ofp_version version;
2349 struct ofport *port;
2350 struct list replies;
2352 ofpmp_init(&replies, request);
2354 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2355 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2356 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2359 ofconn_send_replies(ofconn, &replies);
2364 calc_flow_duration__(long long int start, long long int now,
2365 uint32_t *sec, uint32_t *nsec)
2367 long long int msecs = now - start;
2368 *sec = msecs / 1000;
2369 *nsec = (msecs % 1000) * (1000 * 1000);
2372 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2373 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2375 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2377 return (table_id == 0xff || table_id < ofproto->n_tables
2379 : OFPERR_OFPBRC_BAD_TABLE_ID);
2383 static struct oftable *
2384 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2386 struct oftable *table;
2388 for (table = &ofproto->tables[table_id];
2389 table < &ofproto->tables[ofproto->n_tables];
2391 if (!(table->flags & OFTABLE_HIDDEN)) {
2399 static struct oftable *
2400 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2402 if (table_id == 0xff) {
2403 return next_visible_table(ofproto, 0);
2404 } else if (table_id < ofproto->n_tables) {
2405 return &ofproto->tables[table_id];
2411 static struct oftable *
2412 next_matching_table(const struct ofproto *ofproto,
2413 const struct oftable *table, uint8_t table_id)
2415 return (table_id == 0xff
2416 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2420 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2422 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2423 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2425 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2426 * only once, for that table. (This can be used to access tables marked
2429 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2430 * entered at all. (Perhaps you should have validated TABLE_ID with
2431 * check_table_id().)
2433 * All parameters are evaluated multiple times.
2435 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2436 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2438 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2440 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2441 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2442 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2445 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2446 * to 'out_port' are included.
2448 * Hidden rules are always omitted.
2450 * Returns 0 on success, otherwise an OpenFlow error code. */
2452 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2453 const struct match *match,
2454 ovs_be64 cookie, ovs_be64 cookie_mask,
2455 uint16_t out_port, struct list *rules)
2457 struct oftable *table;
2461 error = check_table_id(ofproto, table_id);
2467 cls_rule_init(&cr, match, 0);
2468 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2469 struct cls_cursor cursor;
2472 cls_cursor_init(&cursor, &table->cls, &cr);
2473 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2474 if (rule->pending) {
2475 error = OFPROTO_POSTPONE;
2478 if (!ofproto_rule_is_hidden(rule)
2479 && ofproto_rule_has_out_port(rule, out_port)
2480 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2481 list_push_back(rules, &rule->ofproto_node);
2487 cls_rule_destroy(&cr);
2491 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2492 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2493 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2496 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2497 * to 'out_port' are included.
2499 * Hidden rules are always omitted.
2501 * Returns 0 on success, otherwise an OpenFlow error code. */
2503 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2504 const struct match *match, unsigned int priority,
2505 ovs_be64 cookie, ovs_be64 cookie_mask,
2506 uint16_t out_port, struct list *rules)
2508 struct oftable *table;
2512 error = check_table_id(ofproto, table_id);
2518 cls_rule_init(&cr, match, priority);
2519 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2522 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2525 if (rule->pending) {
2526 error = OFPROTO_POSTPONE;
2529 if (!ofproto_rule_is_hidden(rule)
2530 && ofproto_rule_has_out_port(rule, out_port)
2531 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2532 list_push_back(rules, &rule->ofproto_node);
2538 cls_rule_destroy(&cr);
2542 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2543 * forced into the range of a uint16_t. */
2545 age_secs(long long int age_ms)
2547 return (age_ms < 0 ? 0
2548 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
2549 : (unsigned int) age_ms / 1000);
2553 handle_flow_stats_request(struct ofconn *ofconn,
2554 const struct ofp_header *request)
2556 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2557 struct ofputil_flow_stats_request fsr;
2558 struct list replies;
2563 error = ofputil_decode_flow_stats_request(&fsr, request);
2568 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2569 fsr.cookie, fsr.cookie_mask,
2570 fsr.out_port, &rules);
2575 ofpmp_init(&replies, request);
2576 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2577 long long int now = time_msec();
2578 struct ofputil_flow_stats fs;
2580 minimatch_expand(&rule->cr.match, &fs.match);
2581 fs.priority = rule->cr.priority;
2582 fs.cookie = rule->flow_cookie;
2583 fs.table_id = rule->table_id;
2584 calc_flow_duration__(rule->created, now, &fs.duration_sec,
2586 fs.idle_timeout = rule->idle_timeout;
2587 fs.hard_timeout = rule->hard_timeout;
2588 fs.idle_age = age_secs(now - rule->used);
2589 fs.hard_age = age_secs(now - rule->modified);
2590 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2592 fs.ofpacts = rule->ofpacts;
2593 fs.ofpacts_len = rule->ofpacts_len;
2594 ofputil_append_flow_stats_reply(&fs, &replies);
2596 ofconn_send_replies(ofconn, &replies);
2602 flow_stats_ds(struct rule *rule, struct ds *results)
2604 uint64_t packet_count, byte_count;
2606 rule->ofproto->ofproto_class->rule_get_stats(rule,
2607 &packet_count, &byte_count);
2609 if (rule->table_id != 0) {
2610 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2612 ds_put_format(results, "duration=%llds, ",
2613 (time_msec() - rule->created) / 1000);
2614 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2615 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2616 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2617 cls_rule_format(&rule->cr, results);
2618 ds_put_char(results, ',');
2619 if (rule->ofpacts_len > 0) {
2620 ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
2622 ds_put_cstr(results, "drop");
2624 ds_put_cstr(results, "\n");
2627 /* Adds a pretty-printed description of all flows to 'results', including
2628 * hidden flows (e.g., set up by in-band control). */
2630 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2632 struct oftable *table;
2634 OFPROTO_FOR_EACH_TABLE (table, p) {
2635 struct cls_cursor cursor;
2638 cls_cursor_init(&cursor, &table->cls, NULL);
2639 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2640 flow_stats_ds(rule, results);
2645 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2646 * '*engine_type' and '*engine_id', respectively. */
2648 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2649 uint8_t *engine_type, uint8_t *engine_id)
2651 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2654 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns a
2655 * bitmask of 'cfm_fault_reason's to indicate a CFM fault (generally
2656 * indicating a connectivity problem). Returns zero if CFM is not faulted,
2657 * and -1 if CFM is not enabled on 'ofp_port'. */
2659 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2661 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2662 return (ofport && ofproto->ofproto_class->get_cfm_fault
2663 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2667 /* Checks the operational status reported by the remote CFM endpoint of
2668 * 'ofp_port' Returns 1 if operationally up, 0 if operationally down, and -1
2669 * if CFM is not enabled on 'ofp_port' or does not support operational status.
2672 ofproto_port_get_cfm_opup(const struct ofproto *ofproto, uint16_t ofp_port)
2674 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2675 return (ofport && ofproto->ofproto_class->get_cfm_opup
2676 ? ofproto->ofproto_class->get_cfm_opup(ofport)
2680 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2681 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2682 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2683 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2685 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2686 uint16_t ofp_port, const uint64_t **rmps,
2689 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2693 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2694 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2699 /* Checks the health of the CFM for 'ofp_port' within 'ofproto'. Returns an
2700 * integer value between 0 and 100 to indicate the health of the port as a
2701 * percentage which is the average of cfm health of all the remote_mpids or
2702 * returns -1 if CFM is not enabled on 'ofport'. */
2704 ofproto_port_get_cfm_health(const struct ofproto *ofproto, uint16_t ofp_port)
2706 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2707 return (ofport && ofproto->ofproto_class->get_cfm_health
2708 ? ofproto->ofproto_class->get_cfm_health(ofport)
2713 handle_aggregate_stats_request(struct ofconn *ofconn,
2714 const struct ofp_header *oh)
2716 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2717 struct ofputil_flow_stats_request request;
2718 struct ofputil_aggregate_stats stats;
2719 bool unknown_packets, unknown_bytes;
2720 struct ofpbuf *reply;
2725 error = ofputil_decode_flow_stats_request(&request, oh);
2730 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2731 request.cookie, request.cookie_mask,
2732 request.out_port, &rules);
2737 memset(&stats, 0, sizeof stats);
2738 unknown_packets = unknown_bytes = false;
2739 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2740 uint64_t packet_count;
2741 uint64_t byte_count;
2743 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2746 if (packet_count == UINT64_MAX) {
2747 unknown_packets = true;
2749 stats.packet_count += packet_count;
2752 if (byte_count == UINT64_MAX) {
2753 unknown_bytes = true;
2755 stats.byte_count += byte_count;
2760 if (unknown_packets) {
2761 stats.packet_count = UINT64_MAX;
2763 if (unknown_bytes) {
2764 stats.byte_count = UINT64_MAX;
2767 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
2768 ofconn_send_reply(ofconn, reply);
2773 struct queue_stats_cbdata {
2774 struct ofport *ofport;
2775 struct list replies;
2779 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2780 const struct netdev_queue_stats *stats)
2783 struct ofputil_queue_stats oqs = {
2784 .port_no = cbdata->ofport->pp.port_no,
2785 .queue_id = queue_id,
2788 ofputil_append_queue_stat(&cbdata->replies, &oqs);
2792 handle_queue_stats_dump_cb(uint32_t queue_id,
2793 struct netdev_queue_stats *stats,
2796 struct queue_stats_cbdata *cbdata = cbdata_;
2798 put_queue_stats(cbdata, queue_id, stats);
2802 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2803 struct queue_stats_cbdata *cbdata)
2805 cbdata->ofport = port;
2806 if (queue_id == OFPQ_ALL) {
2807 netdev_dump_queue_stats(port->netdev,
2808 handle_queue_stats_dump_cb, cbdata);
2810 struct netdev_queue_stats stats;
2812 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2813 put_queue_stats(cbdata, queue_id, &stats);
2815 return OFPERR_OFPQOFC_BAD_QUEUE;
2822 handle_queue_stats_request(struct ofconn *ofconn,
2823 const struct ofp_header *rq)
2825 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2826 struct queue_stats_cbdata cbdata;
2827 struct ofport *port;
2829 struct ofputil_queue_stats_request oqsr;
2831 COVERAGE_INC(ofproto_queue_req);
2833 ofpmp_init(&cbdata.replies, rq);
2835 error = ofputil_decode_queue_stats_request(rq, &oqsr);
2840 if (oqsr.port_no == OFPP_ALL) {
2841 error = OFPERR_OFPQOFC_BAD_QUEUE;
2842 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2843 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
2848 port = ofproto_get_port(ofproto, oqsr.port_no);
2850 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
2851 : OFPERR_OFPQOFC_BAD_PORT);
2854 ofconn_send_replies(ofconn, &cbdata.replies);
2856 ofpbuf_list_delete(&cbdata.replies);
2863 is_flow_deletion_pending(const struct ofproto *ofproto,
2864 const struct cls_rule *cls_rule,
2867 if (!hmap_is_empty(&ofproto->deletions)) {
2868 struct ofoperation *op;
2870 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2871 cls_rule_hash(cls_rule, table_id),
2872 &ofproto->deletions) {
2873 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2882 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2883 * in which no matching flow already exists in the flow table.
2885 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2886 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
2887 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
2888 * initiated now but may be retried later.
2890 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
2891 * ownership remains with the caller.
2893 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2896 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
2897 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
2899 struct oftable *table;
2900 struct ofopgroup *group;
2901 struct rule *victim;
2906 error = check_table_id(ofproto, fm->table_id);
2912 if (fm->table_id == 0xff) {
2914 if (ofproto->ofproto_class->rule_choose_table) {
2915 error = ofproto->ofproto_class->rule_choose_table(ofproto,
2921 assert(table_id < ofproto->n_tables);
2922 table = &ofproto->tables[table_id];
2924 table = &ofproto->tables[0];
2926 } else if (fm->table_id < ofproto->n_tables) {
2927 table = &ofproto->tables[fm->table_id];
2929 return OFPERR_OFPBRC_BAD_TABLE_ID;
2932 if (table->flags & OFTABLE_READONLY) {
2933 return OFPERR_OFPBRC_EPERM;
2936 /* Allocate new rule and initialize classifier rule. */
2937 rule = ofproto->ofproto_class->rule_alloc();
2939 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2940 ofproto->name, strerror(error));
2943 cls_rule_init(&rule->cr, &fm->match, fm->priority);
2945 /* Serialize against pending deletion. */
2946 if (is_flow_deletion_pending(ofproto, &cr, table - ofproto->tables)) {
2947 cls_rule_destroy(&rule->cr);
2948 ofproto->ofproto_class->rule_dealloc(rule);
2949 return OFPROTO_POSTPONE;
2952 /* Check for overlap, if requested. */
2953 if (fm->flags & OFPFF_CHECK_OVERLAP
2954 && classifier_rule_overlaps(&table->cls, &rule->cr)) {
2955 cls_rule_destroy(&rule->cr);
2956 ofproto->ofproto_class->rule_dealloc(rule);
2957 return OFPERR_OFPFMFC_OVERLAP;
2960 rule->ofproto = ofproto;
2961 rule->pending = NULL;
2962 rule->flow_cookie = fm->new_cookie;
2963 rule->created = rule->modified = rule->used = time_msec();
2964 rule->idle_timeout = fm->idle_timeout;
2965 rule->hard_timeout = fm->hard_timeout;
2966 rule->table_id = table - ofproto->tables;
2967 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2968 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
2969 rule->ofpacts_len = fm->ofpacts_len;
2970 rule->evictable = true;
2971 rule->eviction_group = NULL;
2972 rule->monitor_flags = 0;
2973 rule->add_seqno = 0;
2974 rule->modify_seqno = 0;
2976 /* Insert new rule. */
2977 victim = oftable_replace_rule(rule);
2978 if (victim && !rule_is_modifiable(victim)) {
2979 error = OFPERR_OFPBRC_EPERM;
2980 } else if (victim && victim->pending) {
2981 error = OFPROTO_POSTPONE;
2983 struct ofoperation *op;
2986 if (classifier_count(&table->cls) > table->max_flows) {
2989 was_evictable = rule->evictable;
2990 rule->evictable = false;
2991 evict = choose_rule_to_evict(table);
2992 rule->evictable = was_evictable;
2995 error = OFPERR_OFPFMFC_TABLE_FULL;
2997 } else if (evict->pending) {
2998 error = OFPROTO_POSTPONE;
3005 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3006 op = ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3007 op->victim = victim;
3009 error = ofproto->ofproto_class->rule_construct(rule);
3011 op->group->n_running--;
3012 ofoperation_destroy(rule->pending);
3014 delete_flow__(evict, group);
3016 ofopgroup_submit(group);
3020 /* Back out if an error occurred. */
3022 oftable_substitute_rule(rule, victim);
3023 ofproto_rule_destroy__(rule);
3028 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3030 /* Modifies the rules listed in 'rules', changing their actions to match those
3033 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3036 * Returns 0 on success, otherwise an OpenFlow error code. */
3038 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3039 const struct ofputil_flow_mod *fm,
3040 const struct ofp_header *request, struct list *rules)
3042 struct ofopgroup *group;
3046 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3047 error = OFPERR_OFPBRC_EPERM;
3048 LIST_FOR_EACH (rule, ofproto_node, rules) {
3049 struct ofoperation *op;
3050 bool actions_changed;
3051 ovs_be64 new_cookie;
3053 if (rule_is_modifiable(rule)) {
3054 /* At least one rule is modifiable, don't report EPERM error. */
3060 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3061 rule->ofpacts, rule->ofpacts_len);
3062 new_cookie = (fm->new_cookie != htonll(UINT64_MAX)
3064 : rule->flow_cookie);
3065 if (!actions_changed && new_cookie == rule->flow_cookie) {
3066 /* No change at all. */
3070 op = ofoperation_create(group, rule, OFOPERATION_MODIFY, 0);
3071 rule->flow_cookie = new_cookie;
3072 if (actions_changed) {
3073 op->ofpacts = rule->ofpacts;
3074 op->ofpacts_len = rule->ofpacts_len;
3075 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3076 rule->ofpacts_len = fm->ofpacts_len;
3077 rule->ofproto->ofproto_class->rule_modify_actions(rule);
3079 ofoperation_complete(op, 0);
3082 ofopgroup_submit(group);
3088 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3089 const struct ofputil_flow_mod *fm,
3090 const struct ofp_header *request)
3092 if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3095 return add_flow(ofproto, ofconn, fm, request);
3098 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3101 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3104 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3105 const struct ofputil_flow_mod *fm,
3106 const struct ofp_header *request)
3111 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3112 fm->cookie, fm->cookie_mask,
3116 } else if (list_is_empty(&rules)) {
3117 return modify_flows_add(ofproto, ofconn, fm, request);
3119 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3123 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3126 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3129 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3130 const struct ofputil_flow_mod *fm,
3131 const struct ofp_header *request)
3136 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3137 fm->priority, fm->cookie, fm->cookie_mask,
3142 } else if (list_is_empty(&rules)) {
3143 return modify_flows_add(ofproto, ofconn, fm, request);
3145 return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3146 fm, request, &rules)
3151 /* OFPFC_DELETE implementation. */
3154 delete_flow__(struct rule *rule, struct ofopgroup *group)
3156 struct ofproto *ofproto = rule->ofproto;
3158 ofproto_rule_send_removed(rule, OFPRR_DELETE);
3160 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
3161 oftable_remove_rule(rule);
3162 ofproto->ofproto_class->rule_destruct(rule);
3165 /* Deletes the rules listed in 'rules'.
3167 * Returns 0 on success, otherwise an OpenFlow error code. */
3169 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3170 const struct ofp_header *request, struct list *rules)
3172 struct rule *rule, *next;
3173 struct ofopgroup *group;
3175 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3176 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3177 delete_flow__(rule, group);
3179 ofopgroup_submit(group);
3184 /* Implements OFPFC_DELETE. */
3186 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3187 const struct ofputil_flow_mod *fm,
3188 const struct ofp_header *request)
3193 error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3194 fm->cookie, fm->cookie_mask,
3195 fm->out_port, &rules);
3196 return (error ? error
3197 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3202 /* Implements OFPFC_DELETE_STRICT. */
3204 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3205 const struct ofputil_flow_mod *fm,
3206 const struct ofp_header *request)
3211 error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3212 fm->priority, fm->cookie, fm->cookie_mask,
3213 fm->out_port, &rules);
3214 return (error ? error
3215 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3221 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3223 struct ofputil_flow_removed fr;
3225 if (ofproto_rule_is_hidden(rule) || !rule->send_flow_removed) {
3229 minimatch_expand(&rule->cr.match, &fr.match);
3230 fr.priority = rule->cr.priority;
3231 fr.cookie = rule->flow_cookie;
3233 fr.table_id = rule->table_id;
3234 calc_flow_duration__(rule->created, time_msec(),
3235 &fr.duration_sec, &fr.duration_nsec);
3236 fr.idle_timeout = rule->idle_timeout;
3237 fr.hard_timeout = rule->hard_timeout;
3238 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3241 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3245 ofproto_rule_update_used(struct rule *rule, long long int used)
3247 if (used > rule->used) {
3248 struct eviction_group *evg = rule->eviction_group;
3252 heap_change(&evg->rules, &rule->evg_node,
3253 rule_eviction_priority(rule));
3258 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3259 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3262 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3265 * ofproto implementation ->run() functions should use this function to expire
3266 * OpenFlow flows. */
3268 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3270 struct ofproto *ofproto = rule->ofproto;
3271 struct ofopgroup *group;
3273 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
3275 ofproto_rule_send_removed(rule, reason);
3277 group = ofopgroup_create_unattached(ofproto);
3278 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3279 oftable_remove_rule(rule);
3280 ofproto->ofproto_class->rule_destruct(rule);
3281 ofopgroup_submit(group);
3285 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3287 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3288 struct ofputil_flow_mod fm;
3289 uint64_t ofpacts_stub[1024 / 8];
3290 struct ofpbuf ofpacts;
3294 error = reject_slave_controller(ofconn);
3299 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3300 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3303 goto exit_free_ofpacts;
3306 if (fm.flags & OFPFF10_EMERG) {
3307 /* We do not support the OpenFlow 1.0 emergency flow cache, which
3308 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
3309 * There is no good error code, so just state that the flow table
3311 error = OFPERR_OFPFMFC_TABLE_FULL;
3314 error = ofpacts_check(fm.ofpacts, fm.ofpacts_len,
3315 &fm.match.flow, ofproto->max_ports);
3318 error = handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
3321 goto exit_free_ofpacts;
3324 /* Record the operation for logging a summary report. */
3325 switch (fm.command) {
3331 case OFPFC_MODIFY_STRICT:
3332 ofproto->n_modify++;
3336 case OFPFC_DELETE_STRICT:
3337 ofproto->n_delete++;
3342 if (ofproto->next_op_report == LLONG_MAX) {
3343 ofproto->first_op = now;
3344 ofproto->next_op_report = MAX(now + 10 * 1000,
3345 ofproto->op_backoff);
3346 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
3348 ofproto->last_op = now;
3351 ofpbuf_uninit(&ofpacts);
3357 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3358 const struct ofputil_flow_mod *fm,
3359 const struct ofp_header *oh)
3361 if (ofproto->n_pending >= 50) {
3362 assert(!list_is_empty(&ofproto->pending));
3363 return OFPROTO_POSTPONE;
3366 switch (fm->command) {
3368 return add_flow(ofproto, ofconn, fm, oh);
3371 return modify_flows_loose(ofproto, ofconn, fm, oh);
3373 case OFPFC_MODIFY_STRICT:
3374 return modify_flow_strict(ofproto, ofconn, fm, oh);
3377 return delete_flows_loose(ofproto, ofconn, fm, oh);
3379 case OFPFC_DELETE_STRICT:
3380 return delete_flow_strict(ofproto, ofconn, fm, oh);
3383 if (fm->command > 0xff) {
3384 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
3385 "flow_mod_table_id extension is not enabled",
3388 return OFPERR_OFPFMFC_BAD_COMMAND;
3393 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
3395 const struct nx_role_request *nrr = ofpmsg_body(oh);
3396 struct nx_role_request *reply;
3400 role = ntohl(nrr->role);
3401 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
3402 && role != NX_ROLE_SLAVE) {
3403 return OFPERR_OFPRRFC_BAD_ROLE;
3406 if (ofconn_get_role(ofconn) != role
3407 && ofconn_has_pending_opgroups(ofconn)) {
3408 return OFPROTO_POSTPONE;
3411 ofconn_set_role(ofconn, role);
3413 buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, oh, 0);
3414 reply = ofpbuf_put_zeros(buf, sizeof *reply);
3415 reply->role = htonl(role);
3416 ofconn_send_reply(ofconn, buf);
3422 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
3423 const struct ofp_header *oh)
3425 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
3426 enum ofputil_protocol cur, next;
3428 cur = ofconn_get_protocol(ofconn);
3429 next = ofputil_protocol_set_tid(cur, msg->set != 0);
3430 ofconn_set_protocol(ofconn, next);
3436 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
3438 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
3439 enum ofputil_protocol cur, next;
3440 enum ofputil_protocol next_base;
3442 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
3444 return OFPERR_OFPBRC_EPERM;
3447 cur = ofconn_get_protocol(ofconn);
3448 next = ofputil_protocol_set_base(cur, next_base);
3449 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
3450 /* Avoid sending async messages in surprising protocol. */
3451 return OFPROTO_POSTPONE;
3454 ofconn_set_protocol(ofconn, next);
3459 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
3460 const struct ofp_header *oh)
3462 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
3465 format = ntohl(msg->format);
3466 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
3467 return OFPERR_OFPBRC_EPERM;
3470 if (format != ofconn_get_packet_in_format(ofconn)
3471 && ofconn_has_pending_opgroups(ofconn)) {
3472 /* Avoid sending async message in surprsing packet in format. */
3473 return OFPROTO_POSTPONE;
3476 ofconn_set_packet_in_format(ofconn, format);
3481 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
3483 const struct nx_async_config *msg = ofpmsg_body(oh);
3484 uint32_t master[OAM_N_TYPES];
3485 uint32_t slave[OAM_N_TYPES];
3487 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
3488 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
3489 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
3491 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
3492 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
3493 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
3495 ofconn_set_async_config(ofconn, master, slave);
3496 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
3497 !ofconn_get_miss_send_len(ofconn)) {
3498 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
3505 handle_nxt_set_controller_id(struct ofconn *ofconn,
3506 const struct ofp_header *oh)
3508 const struct nx_controller_id *nci = ofpmsg_body(oh);
3510 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
3511 return OFPERR_NXBRC_MUST_BE_ZERO;
3514 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
3519 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
3523 if (ofconn_has_pending_opgroups(ofconn)) {
3524 return OFPROTO_POSTPONE;
3527 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
3528 ? OFPRAW_OFPT10_BARRIER_REPLY
3529 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
3530 ofconn_send_reply(ofconn, buf);
3535 ofproto_compose_flow_refresh_update(const struct rule *rule,
3536 enum nx_flow_monitor_flags flags,
3539 struct ofoperation *op = rule->pending;
3540 struct ofputil_flow_update fu;
3543 if (op && op->type == OFOPERATION_ADD && !op->victim) {
3544 /* We'll report the final flow when the operation completes. Reporting
3545 * it now would cause a duplicate report later. */
3549 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
3550 ? NXFME_ADDED : NXFME_MODIFIED);
3552 fu.idle_timeout = rule->idle_timeout;
3553 fu.hard_timeout = rule->hard_timeout;
3554 fu.table_id = rule->table_id;
3555 fu.cookie = rule->flow_cookie;
3556 minimatch_expand(&rule->cr.match, &match);
3558 fu.priority = rule->cr.priority;
3559 if (!(flags & NXFMF_ACTIONS)) {
3563 fu.ofpacts = rule->ofpacts;
3564 fu.ofpacts_len = rule->ofpacts_len;
3566 /* An operation is in progress. Use the previous version of the flow's
3567 * actions, so that when the operation commits we report the change. */
3569 case OFOPERATION_ADD:
3570 /* We already verified that there was a victim. */
3571 fu.ofpacts = op->victim->ofpacts;
3572 fu.ofpacts_len = op->victim->ofpacts_len;
3575 case OFOPERATION_MODIFY:
3577 fu.ofpacts = op->ofpacts;
3578 fu.ofpacts_len = op->ofpacts_len;
3580 fu.ofpacts = rule->ofpacts;
3581 fu.ofpacts_len = rule->ofpacts_len;
3585 case OFOPERATION_DELETE:
3586 fu.ofpacts = rule->ofpacts;
3587 fu.ofpacts_len = rule->ofpacts_len;
3595 if (list_is_empty(msgs)) {
3596 ofputil_start_flow_update(msgs);
3598 ofputil_append_flow_update(&fu, msgs);
3602 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
3606 LIST_FOR_EACH (rule, ofproto_node, rules) {
3607 enum nx_flow_monitor_flags flags = rule->monitor_flags;
3608 rule->monitor_flags = 0;
3610 ofproto_compose_flow_refresh_update(rule, flags, msgs);
3615 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
3616 struct rule *rule, uint64_t seqno,
3619 enum nx_flow_monitor_flags update;
3621 if (ofproto_rule_is_hidden(rule)) {
3626 ? ofoperation_has_out_port(rule->pending, m->out_port)
3627 : ofproto_rule_has_out_port(rule, m->out_port))) {
3632 if (rule->add_seqno > seqno) {
3633 update = NXFMF_ADD | NXFMF_MODIFY;
3634 } else if (rule->modify_seqno > seqno) {
3635 update = NXFMF_MODIFY;
3640 if (!(m->flags & update)) {
3644 update = NXFMF_INITIAL;
3647 if (!rule->monitor_flags) {
3648 list_push_back(rules, &rule->ofproto_node);
3650 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
3654 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
3658 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
3659 const struct ofoperation *op;
3660 const struct oftable *table;
3661 struct cls_rule target;
3663 cls_rule_init_from_minimatch(&target, &m->match, 0);
3664 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
3665 struct cls_cursor cursor;
3668 cls_cursor_init(&cursor, &table->cls, &target);
3669 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3670 assert(!rule->pending); /* XXX */
3671 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3675 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
3676 struct rule *rule = op->rule;
3678 if (((m->table_id == 0xff
3679 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
3680 : m->table_id == rule->table_id))
3681 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
3682 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3685 cls_rule_destroy(&target);
3689 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
3692 if (m->flags & NXFMF_INITIAL) {
3693 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
3698 ofmonitor_collect_resume_rules(struct ofmonitor *m,
3699 uint64_t seqno, struct list *rules)
3701 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
3705 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
3707 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3708 struct ofmonitor **monitors;
3709 size_t n_monitors, allocated_monitors;
3710 struct list replies;
3717 ofpbuf_use_const(&b, oh, ntohs(oh->length));
3719 n_monitors = allocated_monitors = 0;
3721 struct ofputil_flow_monitor_request request;
3722 struct ofmonitor *m;
3725 retval = ofputil_decode_flow_monitor_request(&request, &b);
3726 if (retval == EOF) {
3728 } else if (retval) {
3733 if (request.table_id != 0xff
3734 && request.table_id >= ofproto->n_tables) {
3735 error = OFPERR_OFPBRC_BAD_TABLE_ID;
3739 error = ofmonitor_create(&request, ofconn, &m);
3744 if (n_monitors >= allocated_monitors) {
3745 monitors = x2nrealloc(monitors, &allocated_monitors,
3748 monitors[n_monitors++] = m;
3752 for (i = 0; i < n_monitors; i++) {
3753 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
3756 ofpmp_init(&replies, oh);
3757 ofmonitor_compose_refresh_updates(&rules, &replies);
3758 ofconn_send_replies(ofconn, &replies);
3765 for (i = 0; i < n_monitors; i++) {
3766 ofmonitor_destroy(monitors[i]);
3773 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
3775 struct ofmonitor *m;
3778 id = ofputil_decode_flow_monitor_cancel(oh);
3779 m = ofmonitor_lookup(ofconn, id);
3781 return OFPERR_NXBRC_FM_BAD_ID;
3784 ofmonitor_destroy(m);
3789 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
3791 const struct ofp_header *oh = msg->data;
3795 error = ofptype_decode(&type, oh);
3801 /* OpenFlow requests. */
3802 case OFPTYPE_ECHO_REQUEST:
3803 return handle_echo_request(ofconn, oh);
3805 case OFPTYPE_FEATURES_REQUEST:
3806 return handle_features_request(ofconn, oh);
3808 case OFPTYPE_GET_CONFIG_REQUEST:
3809 return handle_get_config_request(ofconn, oh);
3811 case OFPTYPE_SET_CONFIG:
3812 return handle_set_config(ofconn, oh);
3814 case OFPTYPE_PACKET_OUT:
3815 return handle_packet_out(ofconn, oh);
3817 case OFPTYPE_PORT_MOD:
3818 return handle_port_mod(ofconn, oh);
3820 case OFPTYPE_FLOW_MOD:
3821 return handle_flow_mod(ofconn, oh);
3823 case OFPTYPE_BARRIER_REQUEST:
3824 return handle_barrier_request(ofconn, oh);
3826 /* OpenFlow replies. */
3827 case OFPTYPE_ECHO_REPLY:
3830 /* Nicira extension requests. */
3831 case OFPTYPE_ROLE_REQUEST:
3832 return handle_role_request(ofconn, oh);
3834 case OFPTYPE_FLOW_MOD_TABLE_ID:
3835 return handle_nxt_flow_mod_table_id(ofconn, oh);
3837 case OFPTYPE_SET_FLOW_FORMAT:
3838 return handle_nxt_set_flow_format(ofconn, oh);
3840 case OFPTYPE_SET_PACKET_IN_FORMAT:
3841 return handle_nxt_set_packet_in_format(ofconn, oh);
3843 case OFPTYPE_SET_CONTROLLER_ID:
3844 return handle_nxt_set_controller_id(ofconn, oh);
3846 case OFPTYPE_FLOW_AGE:
3847 /* Nothing to do. */
3850 case OFPTYPE_FLOW_MONITOR_CANCEL:
3851 return handle_flow_monitor_cancel(ofconn, oh);
3853 case OFPTYPE_SET_ASYNC_CONFIG:
3854 return handle_nxt_set_async_config(ofconn, oh);
3856 /* Statistics requests. */
3857 case OFPTYPE_DESC_STATS_REQUEST:
3858 return handle_desc_stats_request(ofconn, oh);
3860 case OFPTYPE_FLOW_STATS_REQUEST:
3861 return handle_flow_stats_request(ofconn, oh);
3863 case OFPTYPE_AGGREGATE_STATS_REQUEST:
3864 return handle_aggregate_stats_request(ofconn, oh);
3866 case OFPTYPE_TABLE_STATS_REQUEST:
3867 return handle_table_stats_request(ofconn, oh);
3869 case OFPTYPE_PORT_STATS_REQUEST:
3870 return handle_port_stats_request(ofconn, oh);
3872 case OFPTYPE_QUEUE_STATS_REQUEST:
3873 return handle_queue_stats_request(ofconn, oh);
3875 case OFPTYPE_PORT_DESC_STATS_REQUEST:
3876 return handle_port_desc_stats_request(ofconn, oh);
3878 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
3879 return handle_flow_monitor_request(ofconn, oh);
3883 case OFPTYPE_FEATURES_REPLY:
3884 case OFPTYPE_GET_CONFIG_REPLY:
3885 case OFPTYPE_PACKET_IN:
3886 case OFPTYPE_FLOW_REMOVED:
3887 case OFPTYPE_PORT_STATUS:
3888 case OFPTYPE_BARRIER_REPLY:
3889 case OFPTYPE_DESC_STATS_REPLY:
3890 case OFPTYPE_FLOW_STATS_REPLY:
3891 case OFPTYPE_QUEUE_STATS_REPLY:
3892 case OFPTYPE_PORT_STATS_REPLY:
3893 case OFPTYPE_TABLE_STATS_REPLY:
3894 case OFPTYPE_AGGREGATE_STATS_REPLY:
3895 case OFPTYPE_PORT_DESC_STATS_REPLY:
3896 case OFPTYPE_ROLE_REPLY:
3897 case OFPTYPE_FLOW_MONITOR_PAUSED:
3898 case OFPTYPE_FLOW_MONITOR_RESUMED:
3899 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
3901 return OFPERR_OFPBRC_BAD_TYPE;
3906 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
3908 int error = handle_openflow__(ofconn, ofp_msg);
3909 if (error && error != OFPROTO_POSTPONE) {
3910 ofconn_send_error(ofconn, ofp_msg->data, error);
3912 COVERAGE_INC(ofproto_recv_openflow);
3913 return error != OFPROTO_POSTPONE;
3916 /* Asynchronous operations. */
3918 /* Creates and returns a new ofopgroup that is not associated with any
3919 * OpenFlow connection.
3921 * The caller should add operations to the returned group with
3922 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3923 static struct ofopgroup *
3924 ofopgroup_create_unattached(struct ofproto *ofproto)
3926 struct ofopgroup *group = xzalloc(sizeof *group);
3927 group->ofproto = ofproto;
3928 list_init(&group->ofproto_node);
3929 list_init(&group->ops);
3930 list_init(&group->ofconn_node);
3934 /* Creates and returns a new ofopgroup for 'ofproto'.
3936 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
3937 * connection. The 'request' and 'buffer_id' arguments are ignored.
3939 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
3940 * If the ofopgroup eventually fails, then the error reply will include
3941 * 'request'. If the ofopgroup eventually succeeds, then the packet with
3942 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
3944 * The caller should add operations to the returned group with
3945 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3946 static struct ofopgroup *
3947 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
3948 const struct ofp_header *request, uint32_t buffer_id)
3950 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3952 size_t request_len = ntohs(request->length);
3954 assert(ofconn_get_ofproto(ofconn) == ofproto);
3956 ofconn_add_opgroup(ofconn, &group->ofconn_node);
3957 group->ofconn = ofconn;
3958 group->request = xmemdup(request, MIN(request_len, 64));
3959 group->buffer_id = buffer_id;
3964 /* Submits 'group' for processing.
3966 * If 'group' contains no operations (e.g. none were ever added, or all of the
3967 * ones that were added completed synchronously), then it is destroyed
3968 * immediately. Otherwise it is added to the ofproto's list of pending
3971 ofopgroup_submit(struct ofopgroup *group)
3973 if (!group->n_running) {
3974 ofopgroup_complete(group);
3976 list_push_back(&group->ofproto->pending, &group->ofproto_node);
3977 group->ofproto->n_pending++;
3982 ofopgroup_complete(struct ofopgroup *group)
3984 struct ofproto *ofproto = group->ofproto;
3986 struct ofconn *abbrev_ofconn;
3987 ovs_be32 abbrev_xid;
3989 struct ofoperation *op, *next_op;
3992 assert(!group->n_running);
3995 LIST_FOR_EACH (op, group_node, &group->ops) {
4002 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
4003 LIST_FOR_EACH (op, group_node, &group->ops) {
4004 if (op->type != OFOPERATION_DELETE) {
4005 struct ofpbuf *packet;
4008 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
4012 error = rule_execute(op->rule, in_port, packet);
4019 if (!error && !list_is_empty(&group->ofconn_node)) {
4020 abbrev_ofconn = group->ofconn;
4021 abbrev_xid = group->request->xid;
4023 abbrev_ofconn = NULL;
4024 abbrev_xid = htonl(0);
4026 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
4027 struct rule *rule = op->rule;
4029 if (!op->error && !ofproto_rule_is_hidden(rule)) {
4030 /* Check that we can just cast from ofoperation_type to
4031 * nx_flow_update_event. */
4032 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_ADD
4034 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_DELETE
4036 BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_MODIFY
4039 ofmonitor_report(ofproto->connmgr, rule,
4040 (enum nx_flow_update_event) op->type,
4041 op->reason, abbrev_ofconn, abbrev_xid);
4044 rule->pending = NULL;
4047 case OFOPERATION_ADD:
4051 ofproto_rule_destroy__(op->victim);
4052 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
4053 if (vid_mask == VLAN_VID_MASK) {
4054 if (ofproto->vlan_bitmap) {
4055 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4056 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4057 bitmap_set1(ofproto->vlan_bitmap, vid);
4058 ofproto->vlans_changed = true;
4061 ofproto->vlans_changed = true;
4065 oftable_substitute_rule(rule, op->victim);
4066 ofproto_rule_destroy__(rule);
4070 case OFOPERATION_DELETE:
4072 ofproto_rule_destroy__(rule);
4076 case OFOPERATION_MODIFY:
4078 rule->modified = time_msec();
4080 rule->flow_cookie = op->flow_cookie;
4082 free(rule->ofpacts);
4083 rule->ofpacts = op->ofpacts;
4084 rule->ofpacts_len = op->ofpacts_len;
4086 op->ofpacts_len = 0;
4095 ofoperation_destroy(op);
4098 ofmonitor_flush(ofproto->connmgr);
4100 if (!list_is_empty(&group->ofproto_node)) {
4101 assert(ofproto->n_pending > 0);
4102 ofproto->n_pending--;
4103 list_remove(&group->ofproto_node);
4105 if (!list_is_empty(&group->ofconn_node)) {
4106 list_remove(&group->ofconn_node);
4108 ofconn_send_error(group->ofconn, group->request, error);
4110 connmgr_retry(ofproto->connmgr);
4112 free(group->request);
4116 /* Initiates a new operation on 'rule', of the specified 'type', within
4117 * 'group'. Prior to calling, 'rule' must not have any pending operation.
4119 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4120 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
4122 * Returns the newly created ofoperation (which is also available as
4123 * rule->pending). */
4124 static struct ofoperation *
4125 ofoperation_create(struct ofopgroup *group, struct rule *rule,
4126 enum ofoperation_type type,
4127 enum ofp_flow_removed_reason reason)
4129 struct ofproto *ofproto = group->ofproto;
4130 struct ofoperation *op;
4132 assert(!rule->pending);
4134 op = rule->pending = xzalloc(sizeof *op);
4136 list_push_back(&group->ops, &op->group_node);
4139 op->reason = reason;
4140 op->flow_cookie = rule->flow_cookie;
4144 if (type == OFOPERATION_DELETE) {
4145 hmap_insert(&ofproto->deletions, &op->hmap_node,
4146 cls_rule_hash(&rule->cr, rule->table_id));
4153 ofoperation_destroy(struct ofoperation *op)
4155 struct ofopgroup *group = op->group;
4158 op->rule->pending = NULL;
4160 if (op->type == OFOPERATION_DELETE) {
4161 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
4163 list_remove(&op->group_node);
4168 /* Indicates that 'op' completed with status 'error', which is either 0 to
4169 * indicate success or an OpenFlow error code on failure.
4171 * If 'error' is 0, indicating success, the operation will be committed
4172 * permanently to the flow table. There is one interesting subcase:
4174 * - If 'op' is an "add flow" operation that is replacing an existing rule in
4175 * the flow table (the "victim" rule) by a new one, then the caller must
4176 * have uninitialized any derived state in the victim rule, as in step 5 in
4177 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
4178 * performs steps 6 and 7 for the victim rule, most notably by calling its
4179 * ->rule_dealloc() function.
4181 * If 'error' is nonzero, then generally the operation will be rolled back:
4183 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
4184 * restores the original rule. The caller must have uninitialized any
4185 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
4186 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
4187 * and 7 for the new rule, calling its ->rule_dealloc() function.
4189 * - If 'op' is a "modify flow" operation, ofproto restores the original
4192 * - 'op' must not be a "delete flow" operation. Removing a rule is not
4193 * allowed to fail. It must always succeed.
4195 * Please see the large comment in ofproto/ofproto-provider.h titled
4196 * "Asynchronous Operation Support" for more information. */
4198 ofoperation_complete(struct ofoperation *op, enum ofperr error)
4200 struct ofopgroup *group = op->group;
4202 assert(op->rule->pending == op);
4203 assert(group->n_running > 0);
4204 assert(!error || op->type != OFOPERATION_DELETE);
4207 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
4208 ofopgroup_complete(group);
4213 ofoperation_get_victim(struct ofoperation *op)
4215 assert(op->type == OFOPERATION_ADD);
4220 pick_datapath_id(const struct ofproto *ofproto)
4222 const struct ofport *port;
4224 port = ofproto_get_port(ofproto, OFPP_LOCAL);
4226 uint8_t ea[ETH_ADDR_LEN];
4229 error = netdev_get_etheraddr(port->netdev, ea);
4231 return eth_addr_to_uint64(ea);
4233 VLOG_WARN("%s: could not get MAC address for %s (%s)",
4234 ofproto->name, netdev_get_name(port->netdev),
4237 return ofproto->fallback_dpid;
4241 pick_fallback_dpid(void)
4243 uint8_t ea[ETH_ADDR_LEN];
4244 eth_addr_nicira_random(ea);
4245 return eth_addr_to_uint64(ea);
4248 /* Table overflow policy. */
4250 /* Chooses and returns a rule to evict from 'table'. Returns NULL if the table
4251 * is not configured to evict rules or if the table contains no evictable
4252 * rules. (Rules with 'evictable' set to false or with no timeouts are not
4254 static struct rule *
4255 choose_rule_to_evict(struct oftable *table)
4257 struct eviction_group *evg;
4259 if (!table->eviction_fields) {
4263 /* In the common case, the outer and inner loops here will each be entered
4266 * - The inner loop normally "return"s in its first iteration. If the
4267 * eviction group has any evictable rules, then it always returns in
4270 * - The outer loop only iterates more than once if the largest eviction
4271 * group has no evictable rules.
4273 * - The outer loop can exit only if table's 'max_flows' is all filled up
4274 * by unevictable rules'. */
4275 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
4278 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
4279 if (rule->evictable) {
4288 /* Searches 'ofproto' for tables that have more flows than their configured
4289 * maximum and that have flow eviction enabled, and evicts as many flows as
4290 * necessary and currently feasible from them.
4292 * This triggers only when an OpenFlow table has N flows in it and then the
4293 * client configures a maximum number of flows less than N. */
4295 ofproto_evict(struct ofproto *ofproto)
4297 struct ofopgroup *group;
4298 struct oftable *table;
4300 group = ofopgroup_create_unattached(ofproto);
4301 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
4302 while (classifier_count(&table->cls) > table->max_flows
4303 && table->eviction_fields) {
4306 rule = choose_rule_to_evict(table);
4307 if (!rule || rule->pending) {
4311 ofoperation_create(group, rule,
4312 OFOPERATION_DELETE, OFPRR_EVICTION);
4313 oftable_remove_rule(rule);
4314 ofproto->ofproto_class->rule_destruct(rule);
4317 ofopgroup_submit(group);
4320 /* Eviction groups. */
4322 /* Returns the priority to use for an eviction_group that contains 'n_rules'
4323 * rules. The priority contains low-order random bits to ensure that eviction
4324 * groups with the same number of rules are prioritized randomly. */
4326 eviction_group_priority(size_t n_rules)
4328 uint16_t size = MIN(UINT16_MAX, n_rules);
4329 return (size << 16) | random_uint16();
4332 /* Updates 'evg', an eviction_group within 'table', following a change that
4333 * adds or removes rules in 'evg'. */
4335 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
4337 heap_change(&table->eviction_groups_by_size, &evg->size_node,
4338 eviction_group_priority(heap_count(&evg->rules)));
4341 /* Destroys 'evg', an eviction_group within 'table':
4343 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
4344 * rules themselves, just removes them from the eviction group.)
4346 * - Removes 'evg' from 'table'.
4350 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
4352 while (!heap_is_empty(&evg->rules)) {
4355 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
4356 rule->eviction_group = NULL;
4358 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
4359 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
4360 heap_destroy(&evg->rules);
4364 /* Removes 'rule' from its eviction group, if any. */
4366 eviction_group_remove_rule(struct rule *rule)
4368 if (rule->eviction_group) {
4369 struct oftable *table = &rule->ofproto->tables[rule->table_id];
4370 struct eviction_group *evg = rule->eviction_group;
4372 rule->eviction_group = NULL;
4373 heap_remove(&evg->rules, &rule->evg_node);
4374 if (heap_is_empty(&evg->rules)) {
4375 eviction_group_destroy(table, evg);
4377 eviction_group_resized(table, evg);
4382 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
4383 * returns the hash value. */
4385 eviction_group_hash_rule(struct rule *rule)
4387 struct oftable *table = &rule->ofproto->tables[rule->table_id];
4388 const struct mf_subfield *sf;
4392 hash = table->eviction_group_id_basis;
4393 miniflow_expand(&rule->cr.match.flow, &flow);
4394 for (sf = table->eviction_fields;
4395 sf < &table->eviction_fields[table->n_eviction_fields];
4398 if (mf_are_prereqs_ok(sf->field, &flow)) {
4399 union mf_value value;
4401 mf_get_value(sf->field, &flow, &value);
4403 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
4405 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
4406 unsigned int start = sf->ofs + sf->n_bits;
4407 bitwise_zero(&value, sf->field->n_bytes, start,
4408 sf->field->n_bytes * 8 - start);
4410 hash = hash_bytes(&value, sf->field->n_bytes, hash);
4412 hash = hash_int(hash, 0);
4419 /* Returns an eviction group within 'table' with the given 'id', creating one
4421 static struct eviction_group *
4422 eviction_group_find(struct oftable *table, uint32_t id)
4424 struct eviction_group *evg;
4426 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
4430 evg = xmalloc(sizeof *evg);
4431 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
4432 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
4433 eviction_group_priority(0));
4434 heap_init(&evg->rules);
4439 /* Returns an eviction priority for 'rule'. The return value should be
4440 * interpreted so that higher priorities make a rule more attractive candidates
4443 rule_eviction_priority(struct rule *rule)
4445 long long int hard_expiration;
4446 long long int idle_expiration;
4447 long long int expiration;
4448 uint32_t expiration_offset;
4450 /* Calculate time of expiration. */
4451 hard_expiration = (rule->hard_timeout
4452 ? rule->modified + rule->hard_timeout * 1000
4454 idle_expiration = (rule->idle_timeout
4455 ? rule->used + rule->idle_timeout * 1000
4457 expiration = MIN(hard_expiration, idle_expiration);
4458 if (expiration == LLONG_MAX) {
4462 /* Calculate the time of expiration as a number of (approximate) seconds
4463 * after program startup.
4465 * This should work OK for program runs that last UINT32_MAX seconds or
4466 * less. Therefore, please restart OVS at least once every 136 years. */
4467 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
4469 /* Invert the expiration offset because we're using a max-heap. */
4470 return UINT32_MAX - expiration_offset;
4473 /* Adds 'rule' to an appropriate eviction group for its oftable's
4474 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
4475 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
4478 * The caller must ensure that 'rule' is not already in an eviction group. */
4480 eviction_group_add_rule(struct rule *rule)
4482 struct ofproto *ofproto = rule->ofproto;
4483 struct oftable *table = &ofproto->tables[rule->table_id];
4485 if (table->eviction_fields
4486 && (rule->hard_timeout || rule->idle_timeout)) {
4487 struct eviction_group *evg;
4489 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
4491 rule->eviction_group = evg;
4492 heap_insert(&evg->rules, &rule->evg_node,
4493 rule_eviction_priority(rule));
4494 eviction_group_resized(table, evg);
4500 /* Initializes 'table'. */
4502 oftable_init(struct oftable *table)
4504 memset(table, 0, sizeof *table);
4505 classifier_init(&table->cls);
4506 table->max_flows = UINT_MAX;
4509 /* Destroys 'table', including its classifier and eviction groups.
4511 * The caller is responsible for freeing 'table' itself. */
4513 oftable_destroy(struct oftable *table)
4515 assert(classifier_is_empty(&table->cls));
4516 oftable_disable_eviction(table);
4517 classifier_destroy(&table->cls);
4521 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
4522 * string, then 'table' will use its default name.
4524 * This only affects the name exposed for a table exposed through the OpenFlow
4525 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
4527 oftable_set_name(struct oftable *table, const char *name)
4529 if (name && name[0]) {
4530 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
4531 if (!table->name || strncmp(name, table->name, len)) {
4533 table->name = xmemdup0(name, len);
4541 /* oftables support a choice of two policies when adding a rule would cause the
4542 * number of flows in the table to exceed the configured maximum number: either
4543 * they can refuse to add the new flow or they can evict some existing flow.
4544 * This function configures the former policy on 'table'. */
4546 oftable_disable_eviction(struct oftable *table)
4548 if (table->eviction_fields) {
4549 struct eviction_group *evg, *next;
4551 HMAP_FOR_EACH_SAFE (evg, next, id_node,
4552 &table->eviction_groups_by_id) {
4553 eviction_group_destroy(table, evg);
4555 hmap_destroy(&table->eviction_groups_by_id);
4556 heap_destroy(&table->eviction_groups_by_size);
4558 free(table->eviction_fields);
4559 table->eviction_fields = NULL;
4560 table->n_eviction_fields = 0;
4564 /* oftables support a choice of two policies when adding a rule would cause the
4565 * number of flows in the table to exceed the configured maximum number: either
4566 * they can refuse to add the new flow or they can evict some existing flow.
4567 * This function configures the latter policy on 'table', with fairness based
4568 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
4569 * 'n_fields' as 0 disables fairness.) */
4571 oftable_enable_eviction(struct oftable *table,
4572 const struct mf_subfield *fields, size_t n_fields)
4574 struct cls_cursor cursor;
4577 if (table->eviction_fields
4578 && n_fields == table->n_eviction_fields
4580 || !memcmp(fields, table->eviction_fields,
4581 n_fields * sizeof *fields))) {
4586 oftable_disable_eviction(table);
4588 table->n_eviction_fields = n_fields;
4589 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
4591 table->eviction_group_id_basis = random_uint32();
4592 hmap_init(&table->eviction_groups_by_id);
4593 heap_init(&table->eviction_groups_by_size);
4595 cls_cursor_init(&cursor, &table->cls, NULL);
4596 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4597 eviction_group_add_rule(rule);
4601 /* Removes 'rule' from the oftable that contains it. */
4603 oftable_remove_rule(struct rule *rule)
4605 struct ofproto *ofproto = rule->ofproto;
4606 struct oftable *table = &ofproto->tables[rule->table_id];
4608 classifier_remove(&table->cls, &rule->cr);
4609 eviction_group_remove_rule(rule);
4612 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
4613 * oftable that has an identical cls_rule. Returns the rule that was removed,
4614 * if any, and otherwise NULL. */
4615 static struct rule *
4616 oftable_replace_rule(struct rule *rule)
4618 struct ofproto *ofproto = rule->ofproto;
4619 struct oftable *table = &ofproto->tables[rule->table_id];
4620 struct rule *victim;
4622 victim = rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
4624 eviction_group_remove_rule(victim);
4626 eviction_group_add_rule(rule);
4630 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
4632 oftable_substitute_rule(struct rule *old, struct rule *new)
4635 oftable_replace_rule(new);
4637 oftable_remove_rule(old);
4641 /* unixctl commands. */
4644 ofproto_lookup(const char *name)
4646 struct ofproto *ofproto;
4648 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
4650 if (!strcmp(ofproto->name, name)) {
4658 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
4659 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
4661 struct ofproto *ofproto;
4665 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
4666 ds_put_format(&results, "%s\n", ofproto->name);
4668 unixctl_command_reply(conn, ds_cstr(&results));
4669 ds_destroy(&results);
4673 ofproto_unixctl_init(void)
4675 static bool registered;
4681 unixctl_command_register("ofproto/list", "", 0, 0,
4682 ofproto_unixctl_list, NULL);
4685 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
4687 * This is deprecated. It is only for compatibility with broken device drivers
4688 * in old versions of Linux that do not properly support VLANs when VLAN
4689 * devices are not used. When broken device drivers are no longer in
4690 * widespread use, we will delete these interfaces. */
4692 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
4693 * (exactly) by an OpenFlow rule in 'ofproto'. */
4695 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
4697 const struct oftable *oftable;
4699 free(ofproto->vlan_bitmap);
4700 ofproto->vlan_bitmap = bitmap_allocate(4096);
4701 ofproto->vlans_changed = false;
4703 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
4704 const struct cls_table *table;
4706 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
4707 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
4708 const struct cls_rule *rule;
4710 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
4711 uint16_t vid = miniflow_get_vid(&rule->match.flow);
4712 bitmap_set1(vlan_bitmap, vid);
4713 bitmap_set1(ofproto->vlan_bitmap, vid);
4720 /* Returns true if new VLANs have come into use by the flow table since the
4721 * last call to ofproto_get_vlan_usage().
4723 * We don't track when old VLANs stop being used. */
4725 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
4727 return ofproto->vlans_changed;
4730 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
4731 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
4732 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
4733 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
4734 * then the VLAN device is un-enslaved. */
4736 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
4737 uint16_t realdev_ofp_port, int vid)
4739 struct ofport *ofport;
4742 assert(vlandev_ofp_port != realdev_ofp_port);
4744 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
4746 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
4747 ofproto->name, vlandev_ofp_port);
4751 if (!ofproto->ofproto_class->set_realdev) {
4752 if (!vlandev_ofp_port) {
4755 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
4759 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
4761 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
4762 ofproto->name, vlandev_ofp_port,
4763 netdev_get_name(ofport->netdev), strerror(error));