2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
25 #include "byte-order.h"
26 #include "classifier.h"
29 #include "dynamic-string.h"
32 #include "meta-flow.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
38 #include "ofp-print.h"
41 #include "ofproto-provider.h"
42 #include "openflow/nicira-ext.h"
43 #include "openflow/openflow.h"
47 #include "poll-loop.h"
53 #include "unaligned.h"
57 VLOG_DEFINE_THIS_MODULE(ofproto
);
59 COVERAGE_DEFINE(ofproto_error
);
60 COVERAGE_DEFINE(ofproto_flush
);
61 COVERAGE_DEFINE(ofproto_no_packet_in
);
62 COVERAGE_DEFINE(ofproto_packet_out
);
63 COVERAGE_DEFINE(ofproto_queue_req
);
64 COVERAGE_DEFINE(ofproto_recv_openflow
);
65 COVERAGE_DEFINE(ofproto_reinit_ports
);
66 COVERAGE_DEFINE(ofproto_uninstallable
);
67 COVERAGE_DEFINE(ofproto_update_port
);
70 S_OPENFLOW
, /* Processing OpenFlow commands. */
71 S_EVICT
, /* Evicting flows from over-limit tables. */
72 S_FLUSH
, /* Deleting all flow table rules. */
75 enum ofoperation_type
{
81 /* A single OpenFlow request can execute any number of operations. The
82 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
83 * ofconn to which an error reply should be sent if necessary.
85 * ofproto initiates some operations internally. These operations are still
86 * assigned to groups but will not have an associated ofconn. */
88 struct ofproto
*ofproto
; /* Owning ofproto. */
89 struct list ofproto_node
; /* In ofproto's "pending" list. */
90 struct list ops
; /* List of "struct ofoperation"s. */
91 int n_running
; /* Number of ops still pending. */
93 /* Data needed to send OpenFlow reply on failure or to send a buffered
96 * If list_is_empty(ofconn_node) then this ofopgroup never had an
97 * associated ofconn or its ofconn's connection dropped after it initiated
98 * the operation. In the latter case 'ofconn' is a wild pointer that
99 * refers to freed memory, so the 'ofconn' member must be used only if
100 * !list_is_empty(ofconn_node).
102 struct list ofconn_node
; /* In ofconn's list of pending opgroups. */
103 struct ofconn
*ofconn
; /* ofconn for reply (but see note above). */
104 struct ofp_header
*request
; /* Original request (truncated at 64 bytes). */
105 uint32_t buffer_id
; /* Buffer id from original request. */
108 static struct ofopgroup
*ofopgroup_create_unattached(struct ofproto
*);
109 static struct ofopgroup
*ofopgroup_create(struct ofproto
*, struct ofconn
*,
110 const struct ofp_header
*,
112 static void ofopgroup_submit(struct ofopgroup
*);
113 static void ofopgroup_complete(struct ofopgroup
*);
115 /* A single flow table operation. */
117 struct ofopgroup
*group
; /* Owning group. */
118 struct list group_node
; /* In ofopgroup's "ops" list. */
119 struct hmap_node hmap_node
; /* In ofproto's "deletions" hmap. */
120 struct rule
*rule
; /* Rule being operated upon. */
121 enum ofoperation_type type
; /* Type of operation. */
123 /* OFOPERATION_ADD. */
124 struct rule
*victim
; /* Rule being replaced, if any.. */
126 /* OFOPERATION_MODIFY: The old actions, if the actions are changing. */
127 struct ofpact
*ofpacts
;
130 /* OFOPERATION_DELETE. */
131 enum ofp_flow_removed_reason reason
; /* Reason flow was removed. */
133 ovs_be64 flow_cookie
; /* Rule's old flow cookie. */
134 enum ofperr error
; /* 0 if no error. */
137 static struct ofoperation
*ofoperation_create(struct ofopgroup
*,
139 enum ofoperation_type
,
140 enum ofp_flow_removed_reason
);
141 static void ofoperation_destroy(struct ofoperation
*);
144 static void oftable_init(struct oftable
*);
145 static void oftable_destroy(struct oftable
*);
147 static void oftable_set_name(struct oftable
*, const char *name
);
149 static void oftable_disable_eviction(struct oftable
*);
150 static void oftable_enable_eviction(struct oftable
*,
151 const struct mf_subfield
*fields
,
154 static void oftable_remove_rule(struct rule
*);
155 static struct rule
*oftable_replace_rule(struct rule
*);
156 static void oftable_substitute_rule(struct rule
*old
, struct rule
*new);
158 /* A set of rules within a single OpenFlow table (oftable) that have the same
159 * values for the oftable's eviction_fields. A rule to be evicted, when one is
160 * needed, is taken from the eviction group that contains the greatest number
163 * An oftable owns any number of eviction groups, each of which contains any
166 * Membership in an eviction group is imprecise, based on the hash of the
167 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
168 * That is, if two rules have different eviction_fields, but those
169 * eviction_fields hash to the same value, then they will belong to the same
170 * eviction_group anyway.
172 * (When eviction is not enabled on an oftable, we don't track any eviction
173 * groups, to save time and space.) */
174 struct eviction_group
{
175 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
176 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
177 struct heap rules
; /* Contains "struct rule"s. */
180 static struct rule
*choose_rule_to_evict(struct oftable
*);
181 static void ofproto_evict(struct ofproto
*);
182 static uint32_t rule_eviction_priority(struct rule
*);
185 static void ofport_destroy__(struct ofport
*);
186 static void ofport_destroy(struct ofport
*);
188 static void update_port(struct ofproto
*, const char *devname
);
189 static int init_ports(struct ofproto
*);
190 static void reinit_ports(struct ofproto
*);
193 static void ofproto_rule_destroy__(struct rule
*);
194 static void ofproto_rule_send_removed(struct rule
*, uint8_t reason
);
195 static bool rule_is_modifiable(const struct rule
*);
198 static enum ofperr
add_flow(struct ofproto
*, struct ofconn
*,
199 const struct ofputil_flow_mod
*,
200 const struct ofp_header
*);
201 static void delete_flow__(struct rule
*, struct ofopgroup
*);
202 static bool handle_openflow(struct ofconn
*, const struct ofpbuf
*);
203 static enum ofperr
handle_flow_mod__(struct ofproto
*, struct ofconn
*,
204 const struct ofputil_flow_mod
*,
205 const struct ofp_header
*);
206 static void calc_duration(long long int start
, long long int now
,
207 uint32_t *sec
, uint32_t *nsec
);
210 static uint64_t pick_datapath_id(const struct ofproto
*);
211 static uint64_t pick_fallback_dpid(void);
212 static void ofproto_destroy__(struct ofproto
*);
213 static void update_mtu(struct ofproto
*, struct ofport
*);
216 static void ofproto_unixctl_init(void);
218 /* All registered ofproto classes, in probe order. */
219 static const struct ofproto_class
**ofproto_classes
;
220 static size_t n_ofproto_classes
;
221 static size_t allocated_ofproto_classes
;
223 unsigned flow_eviction_threshold
= OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT
;
224 enum ofproto_flow_miss_model flow_miss_model
= OFPROTO_HANDLE_MISS_AUTO
;
226 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
227 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
229 /* Initial mappings of port to OpenFlow number mappings. */
230 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
232 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
234 /* The default value of true waits for flow restore. */
235 static bool flow_restore_wait
= true;
237 /* Must be called to initialize the ofproto library.
239 * The caller may pass in 'iface_hints', which contains an shash of
240 * "iface_hint" elements indexed by the interface's name. The provider
241 * may use these hints to describe the startup configuration in order to
242 * reinitialize its state. The caller owns the provided data, so a
243 * provider will make copies of anything required. An ofproto provider
244 * will remove any existing state that is not described by the hint, and
245 * may choose to remove it all. */
247 ofproto_init(const struct shash
*iface_hints
)
249 struct shash_node
*node
;
252 ofproto_class_register(&ofproto_dpif_class
);
254 /* Make a local copy, since we don't own 'iface_hints' elements. */
255 SHASH_FOR_EACH(node
, iface_hints
) {
256 const struct iface_hint
*orig_hint
= node
->data
;
257 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
258 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
260 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
261 new_hint
->br_type
= xstrdup(br_type
);
262 new_hint
->ofp_port
= orig_hint
->ofp_port
;
264 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
267 for (i
= 0; i
< n_ofproto_classes
; i
++) {
268 ofproto_classes
[i
]->init(&init_ofp_ports
);
272 /* 'type' should be a normalized datapath type, as returned by
273 * ofproto_normalize_type(). Returns the corresponding ofproto_class
274 * structure, or a null pointer if there is none registered for 'type'. */
275 static const struct ofproto_class
*
276 ofproto_class_find__(const char *type
)
280 for (i
= 0; i
< n_ofproto_classes
; i
++) {
281 const struct ofproto_class
*class = ofproto_classes
[i
];
286 class->enumerate_types(&types
);
287 found
= sset_contains(&types
, type
);
288 sset_destroy(&types
);
294 VLOG_WARN("unknown datapath type %s", type
);
298 /* Registers a new ofproto class. After successful registration, new ofprotos
299 * of that type can be created using ofproto_create(). */
301 ofproto_class_register(const struct ofproto_class
*new_class
)
305 for (i
= 0; i
< n_ofproto_classes
; i
++) {
306 if (ofproto_classes
[i
] == new_class
) {
311 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
312 ofproto_classes
= x2nrealloc(ofproto_classes
,
313 &allocated_ofproto_classes
,
314 sizeof *ofproto_classes
);
316 ofproto_classes
[n_ofproto_classes
++] = new_class
;
320 /* Unregisters a datapath provider. 'type' must have been previously
321 * registered and not currently be in use by any ofprotos. After
322 * unregistration new datapaths of that type cannot be opened using
323 * ofproto_create(). */
325 ofproto_class_unregister(const struct ofproto_class
*class)
329 for (i
= 0; i
< n_ofproto_classes
; i
++) {
330 if (ofproto_classes
[i
] == class) {
331 for (i
++; i
< n_ofproto_classes
; i
++) {
332 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
338 VLOG_WARN("attempted to unregister an ofproto class that is not "
343 /* Clears 'types' and enumerates all registered ofproto types into it. The
344 * caller must first initialize the sset. */
346 ofproto_enumerate_types(struct sset
*types
)
350 for (i
= 0; i
< n_ofproto_classes
; i
++) {
351 ofproto_classes
[i
]->enumerate_types(types
);
355 /* Returns the fully spelled out name for the given ofproto 'type'.
357 * Normalized type string can be compared with strcmp(). Unnormalized type
358 * string might be the same even if they have different spellings. */
360 ofproto_normalize_type(const char *type
)
362 return type
&& type
[0] ? type
: "system";
365 /* Clears 'names' and enumerates the names of all known created ofprotos with
366 * the given 'type'. The caller must first initialize the sset. Returns 0 if
367 * successful, otherwise a positive errno value.
369 * Some kinds of datapaths might not be practically enumerable. This is not
370 * considered an error. */
372 ofproto_enumerate_names(const char *type
, struct sset
*names
)
374 const struct ofproto_class
*class = ofproto_class_find__(type
);
375 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
379 ofproto_create(const char *datapath_name
, const char *datapath_type
,
380 struct ofproto
**ofprotop
)
382 const struct ofproto_class
*class;
383 struct ofproto
*ofproto
;
389 ofproto_unixctl_init();
391 datapath_type
= ofproto_normalize_type(datapath_type
);
392 class = ofproto_class_find__(datapath_type
);
394 VLOG_WARN("could not create datapath %s of unknown type %s",
395 datapath_name
, datapath_type
);
399 ofproto
= class->alloc();
401 VLOG_ERR("failed to allocate datapath %s of type %s",
402 datapath_name
, datapath_type
);
407 memset(ofproto
, 0, sizeof *ofproto
);
408 ofproto
->ofproto_class
= class;
409 ofproto
->name
= xstrdup(datapath_name
);
410 ofproto
->type
= xstrdup(datapath_type
);
411 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
412 hash_string(ofproto
->name
, 0));
413 ofproto
->datapath_id
= 0;
414 ofproto
->forward_bpdu
= false;
415 ofproto
->fallback_dpid
= pick_fallback_dpid();
416 ofproto
->mfr_desc
= NULL
;
417 ofproto
->hw_desc
= NULL
;
418 ofproto
->sw_desc
= NULL
;
419 ofproto
->serial_desc
= NULL
;
420 ofproto
->dp_desc
= NULL
;
421 ofproto
->frag_handling
= OFPC_FRAG_NORMAL
;
422 hmap_init(&ofproto
->ports
);
423 shash_init(&ofproto
->port_by_name
);
424 simap_init(&ofproto
->ofp_requests
);
425 ofproto
->max_ports
= OFPP_MAX
;
426 ofproto
->tables
= NULL
;
427 ofproto
->n_tables
= 0;
428 hindex_init(&ofproto
->cookies
);
429 list_init(&ofproto
->expirable
);
430 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
431 ofproto
->state
= S_OPENFLOW
;
432 list_init(&ofproto
->pending
);
433 ofproto
->n_pending
= 0;
434 hmap_init(&ofproto
->deletions
);
435 ofproto
->n_add
= ofproto
->n_delete
= ofproto
->n_modify
= 0;
436 ofproto
->first_op
= ofproto
->last_op
= LLONG_MIN
;
437 ofproto
->next_op_report
= LLONG_MAX
;
438 ofproto
->op_backoff
= LLONG_MIN
;
439 ofproto
->vlan_bitmap
= NULL
;
440 ofproto
->vlans_changed
= false;
441 ofproto
->min_mtu
= INT_MAX
;
443 error
= ofproto
->ofproto_class
->construct(ofproto
);
445 VLOG_ERR("failed to open datapath %s: %s",
446 datapath_name
, strerror(error
));
447 ofproto_destroy__(ofproto
);
451 /* The "max_ports" member should have been set by ->construct(ofproto).
452 * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
453 ofproto
->ofp_port_ids
= bitmap_allocate(ofp_to_u16(ofproto
->max_ports
));
454 bitmap_set1(ofproto
->ofp_port_ids
, 0);
456 /* Check that hidden tables, if any, are at the end. */
457 ovs_assert(ofproto
->n_tables
);
458 for (i
= 0; i
+ 1 < ofproto
->n_tables
; i
++) {
459 enum oftable_flags flags
= ofproto
->tables
[i
].flags
;
460 enum oftable_flags next_flags
= ofproto
->tables
[i
+ 1].flags
;
462 ovs_assert(!(flags
& OFTABLE_HIDDEN
) || next_flags
& OFTABLE_HIDDEN
);
465 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
472 /* Must be called (only) by an ofproto implementation in its constructor
473 * function. See the large comment on 'construct' in struct ofproto_class for
476 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
478 struct oftable
*table
;
480 ovs_assert(!ofproto
->n_tables
);
481 ovs_assert(n_tables
>= 1 && n_tables
<= 255);
483 ofproto
->n_tables
= n_tables
;
484 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
485 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
490 /* To be optionally called (only) by an ofproto implementation in its
491 * constructor function. See the large comment on 'construct' in struct
492 * ofproto_class for details.
494 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
495 * will then ensure that actions passed into the ofproto implementation will
496 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
497 * function is not called, there will be no such restriction.
499 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
500 * the 'max_ports' restriction. */
502 ofproto_init_max_ports(struct ofproto
*ofproto
, ofp_port_t max_ports
)
504 ovs_assert(ofp_to_u16(max_ports
) <= ofp_to_u16(OFPP_MAX
));
505 ofproto
->max_ports
= max_ports
;
509 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
511 return ofproto
->datapath_id
;
515 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
517 uint64_t old_dpid
= p
->datapath_id
;
518 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
519 if (p
->datapath_id
!= old_dpid
) {
520 /* Force all active connections to reconnect, since there is no way to
521 * notify a controller that the datapath ID has changed. */
522 ofproto_reconnect_controllers(p
);
527 ofproto_set_controllers(struct ofproto
*p
,
528 const struct ofproto_controller
*controllers
,
529 size_t n_controllers
, uint32_t allowed_versions
)
531 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
,
536 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
538 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
541 /* Drops the connections between 'ofproto' and all of its controllers, forcing
542 * them to reconnect. */
544 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
546 connmgr_reconnect(ofproto
->connmgr
);
549 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
550 * in-band control should guarantee access, in the same way that in-band
551 * control guarantees access to OpenFlow controllers. */
553 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
554 const struct sockaddr_in
*extras
, size_t n
)
556 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
559 /* Sets the OpenFlow queue used by flows set up by in-band control on
560 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
561 * flows will use the default queue. */
563 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
565 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
568 /* Sets the number of flows at which eviction from the kernel flow table
571 ofproto_set_flow_eviction_threshold(unsigned threshold
)
573 flow_eviction_threshold
= MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN
,
577 /* Sets the path for handling flow misses. */
579 ofproto_set_flow_miss_model(unsigned model
)
581 flow_miss_model
= model
;
584 /* If forward_bpdu is true, the NORMAL action will forward frames with
585 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
586 * the NORMAL action will drop these frames. */
588 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
590 bool old_val
= ofproto
->forward_bpdu
;
591 ofproto
->forward_bpdu
= forward_bpdu
;
592 if (old_val
!= ofproto
->forward_bpdu
) {
593 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
594 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
599 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
600 * 'idle_time', in seconds, and the maximum number of MAC table entries to
603 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
606 if (ofproto
->ofproto_class
->set_mac_table_config
) {
607 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
613 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
616 p
->dp_desc
= dp_desc
? xstrdup(dp_desc
) : NULL
;
620 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
622 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
626 ofproto_set_netflow(struct ofproto
*ofproto
,
627 const struct netflow_options
*nf_options
)
629 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
633 if (ofproto
->ofproto_class
->set_netflow
) {
634 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
636 return nf_options
? EOPNOTSUPP
: 0;
641 ofproto_set_sflow(struct ofproto
*ofproto
,
642 const struct ofproto_sflow_options
*oso
)
644 if (oso
&& sset_is_empty(&oso
->targets
)) {
648 if (ofproto
->ofproto_class
->set_sflow
) {
649 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
651 return oso
? EOPNOTSUPP
: 0;
656 ofproto_set_ipfix(struct ofproto
*ofproto
,
657 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
658 const struct ofproto_ipfix_flow_exporter_options
*fo
,
661 if (ofproto
->ofproto_class
->set_ipfix
) {
662 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
664 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
669 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
671 flow_restore_wait
= flow_restore_wait_db
;
675 ofproto_get_flow_restore_wait(void)
677 return flow_restore_wait
;
681 /* Spanning Tree Protocol (STP) configuration. */
683 /* Configures STP on 'ofproto' using the settings defined in 's'. If
684 * 's' is NULL, disables STP.
686 * Returns 0 if successful, otherwise a positive errno value. */
688 ofproto_set_stp(struct ofproto
*ofproto
,
689 const struct ofproto_stp_settings
*s
)
691 return (ofproto
->ofproto_class
->set_stp
692 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
696 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
697 * 'enabled' member of 's' is false, then the other members are not
700 * Returns 0 if successful, otherwise a positive errno value. */
702 ofproto_get_stp_status(struct ofproto
*ofproto
,
703 struct ofproto_stp_status
*s
)
705 return (ofproto
->ofproto_class
->get_stp_status
706 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
710 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
711 * in 's'. The caller is responsible for assigning STP port numbers
712 * (using the 'port_num' member in the range of 1 through 255, inclusive)
713 * and ensuring there are no duplicates. If the 's' is NULL, then STP
714 * is disabled on the port.
716 * Returns 0 if successful, otherwise a positive errno value.*/
718 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
719 const struct ofproto_port_stp_settings
*s
)
721 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
723 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
724 ofproto
->name
, ofp_port
);
728 return (ofproto
->ofproto_class
->set_stp_port
729 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
733 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
734 * 's'. If the 'enabled' member in 's' is false, then the other members
735 * are not meaningful.
737 * Returns 0 if successful, otherwise a positive errno value.*/
739 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
740 struct ofproto_port_stp_status
*s
)
742 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
744 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
745 "port %"PRIu16
, ofproto
->name
, ofp_port
);
749 return (ofproto
->ofproto_class
->get_stp_port_status
750 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
754 /* Queue DSCP configuration. */
756 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
757 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
758 * to implement QoS. Instead, it is used to implement features which require
759 * knowledge of what queues exist on a port, and some basic information about
762 * Returns 0 if successful, otherwise a positive errno value. */
764 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
765 const struct ofproto_port_queue
*queues
,
768 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
771 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
772 ofproto
->name
, ofp_port
);
776 return (ofproto
->ofproto_class
->set_queues
777 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
781 /* Connectivity Fault Management configuration. */
783 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
785 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
787 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
788 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
789 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
793 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
794 * basic configuration from the configuration members in 'cfm', and the remote
795 * maintenance point ID from remote_mpid. Ignores the statistics members of
798 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
800 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
801 const struct cfm_settings
*s
)
803 struct ofport
*ofport
;
806 ofport
= ofproto_get_port(ofproto
, ofp_port
);
808 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
809 ofproto
->name
, ofp_port
);
813 /* XXX: For configuration simplicity, we only support one remote_mpid
814 * outside of the CFM module. It's not clear if this is the correct long
815 * term solution or not. */
816 error
= (ofproto
->ofproto_class
->set_cfm
817 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
820 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
821 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
826 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
827 * 'ofproto' does not have a port 'ofp_port'. */
829 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
830 const struct smap
*cfg
)
832 struct ofport
*ofport
;
835 ofport
= ofproto_get_port(ofproto
, ofp_port
);
837 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16
,
838 ofproto
->name
, ofp_port
);
842 error
= (ofproto
->ofproto_class
->set_bfd
843 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
846 VLOG_WARN("%s: bfd configuration on port %"PRIu16
" (%s) failed (%s)",
847 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
852 /* Populates 'status' with key value pairs indicating the status of the BFD
853 * session on 'ofp_port'. This information is intended to be populated in the
854 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
857 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
860 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
861 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
862 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
866 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
867 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
868 * 0 if LACP partner information is not current (generally indicating a
869 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
871 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
873 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
874 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
875 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
881 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
882 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
883 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
884 * configuration plus, if there is more than one slave, a bonding
887 * If 'aux' is already registered then this function updates its configuration
888 * to 's'. Otherwise, this function registers a new bundle.
890 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
893 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
894 const struct ofproto_bundle_settings
*s
)
896 return (ofproto
->ofproto_class
->bundle_set
897 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
901 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
902 * If no such bundle has been registered, this has no effect. */
904 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
906 return ofproto_bundle_register(ofproto
, aux
, NULL
);
910 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
911 * If 'aux' is already registered then this function updates its configuration
912 * to 's'. Otherwise, this function registers a new mirror. */
914 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
915 const struct ofproto_mirror_settings
*s
)
917 return (ofproto
->ofproto_class
->mirror_set
918 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
922 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
923 * If no mirror has been registered, this has no effect. */
925 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
927 return ofproto_mirror_register(ofproto
, aux
, NULL
);
930 /* Retrieves statistics from mirror associated with client data pointer
931 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
932 * 'bytes', respectively. If a particular counters is not supported,
933 * the appropriate argument is set to UINT64_MAX. */
935 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
936 uint64_t *packets
, uint64_t *bytes
)
938 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
939 *packets
= *bytes
= UINT64_MAX
;
943 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
947 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
948 * which all packets are flooded, instead of using MAC learning. If
949 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
951 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
954 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
956 return (ofproto
->ofproto_class
->set_flood_vlans
957 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
961 /* Returns true if 'aux' is a registered bundle that is currently in use as the
962 * output for a mirror. */
964 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
966 return (ofproto
->ofproto_class
->is_mirror_output_bundle
967 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
971 /* Configuration of OpenFlow tables. */
973 /* Returns the number of OpenFlow tables in 'ofproto'. */
975 ofproto_get_n_tables(const struct ofproto
*ofproto
)
977 return ofproto
->n_tables
;
980 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
981 * settings from 's'. 'table_id' must be in the range 0 through the number of
982 * OpenFlow tables in 'ofproto' minus 1, inclusive.
984 * For read-only tables, only the name may be configured. */
986 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
987 const struct ofproto_table_settings
*s
)
989 struct oftable
*table
;
991 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
992 table
= &ofproto
->tables
[table_id
];
994 oftable_set_name(table
, s
->name
);
996 if (table
->flags
& OFTABLE_READONLY
) {
1001 oftable_enable_eviction(table
, s
->groups
, s
->n_groups
);
1003 oftable_disable_eviction(table
);
1006 table
->max_flows
= s
->max_flows
;
1007 if (classifier_count(&table
->cls
) > table
->max_flows
1008 && table
->eviction_fields
) {
1009 /* 'table' contains more flows than allowed. We might not be able to
1010 * evict them right away because of the asynchronous nature of flow
1011 * table changes. Schedule eviction for later. */
1012 switch (ofproto
->state
) {
1014 ofproto
->state
= S_EVICT
;
1018 /* We're already deleting flows, nothing more to do. */
1025 ofproto_has_snoops(const struct ofproto
*ofproto
)
1027 return connmgr_has_snoops(ofproto
->connmgr
);
1031 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1033 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1037 ofproto_flush__(struct ofproto
*ofproto
)
1039 struct ofopgroup
*group
;
1040 struct oftable
*table
;
1042 if (ofproto
->ofproto_class
->flush
) {
1043 ofproto
->ofproto_class
->flush(ofproto
);
1046 group
= ofopgroup_create_unattached(ofproto
);
1047 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1048 struct rule
*rule
, *next_rule
;
1049 struct cls_cursor cursor
;
1051 if (table
->flags
& OFTABLE_HIDDEN
) {
1055 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
1056 CLS_CURSOR_FOR_EACH_SAFE (rule
, next_rule
, cr
, &cursor
) {
1057 if (!rule
->pending
) {
1058 ofoperation_create(group
, rule
, OFOPERATION_DELETE
,
1060 oftable_remove_rule(rule
);
1061 ofproto
->ofproto_class
->rule_destruct(rule
);
1065 ofopgroup_submit(group
);
1069 ofproto_destroy__(struct ofproto
*ofproto
)
1071 struct oftable
*table
;
1073 ovs_assert(list_is_empty(&ofproto
->pending
));
1074 ovs_assert(!ofproto
->n_pending
);
1076 connmgr_destroy(ofproto
->connmgr
);
1078 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1079 free(ofproto
->name
);
1080 free(ofproto
->type
);
1081 free(ofproto
->mfr_desc
);
1082 free(ofproto
->hw_desc
);
1083 free(ofproto
->sw_desc
);
1084 free(ofproto
->serial_desc
);
1085 free(ofproto
->dp_desc
);
1086 hmap_destroy(&ofproto
->ports
);
1087 shash_destroy(&ofproto
->port_by_name
);
1088 bitmap_free(ofproto
->ofp_port_ids
);
1089 simap_destroy(&ofproto
->ofp_requests
);
1091 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1092 oftable_destroy(table
);
1094 free(ofproto
->tables
);
1096 hmap_destroy(&ofproto
->deletions
);
1098 free(ofproto
->vlan_bitmap
);
1100 ofproto
->ofproto_class
->dealloc(ofproto
);
1104 ofproto_destroy(struct ofproto
*p
)
1106 struct ofport
*ofport
, *next_ofport
;
1113 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1114 ofport_destroy(ofport
);
1117 p
->ofproto_class
->destruct(p
);
1118 ofproto_destroy__(p
);
1121 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1122 * kernel datapath, for example, this destroys the datapath in the kernel, and
1123 * with the netdev-based datapath, it tears down the data structures that
1124 * represent the datapath.
1126 * The datapath should not be currently open as an ofproto. */
1128 ofproto_delete(const char *name
, const char *type
)
1130 const struct ofproto_class
*class = ofproto_class_find__(type
);
1131 return (!class ? EAFNOSUPPORT
1132 : !class->del
? EACCES
1133 : class->del(type
, name
));
1137 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1139 if (error
== ENOBUFS
) {
1140 reinit_ports(ofproto
);
1141 } else if (!error
) {
1142 update_port(ofproto
, devname
);
1148 ofproto_type_run(const char *datapath_type
)
1150 const struct ofproto_class
*class;
1153 datapath_type
= ofproto_normalize_type(datapath_type
);
1154 class = ofproto_class_find__(datapath_type
);
1156 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1157 if (error
&& error
!= EAGAIN
) {
1158 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1159 datapath_type
, strerror(error
));
1165 ofproto_type_run_fast(const char *datapath_type
)
1167 const struct ofproto_class
*class;
1170 datapath_type
= ofproto_normalize_type(datapath_type
);
1171 class = ofproto_class_find__(datapath_type
);
1173 error
= class->type_run_fast
? class->type_run_fast(datapath_type
) : 0;
1174 if (error
&& error
!= EAGAIN
) {
1175 VLOG_ERR_RL(&rl
, "%s: type_run_fast failed (%s)",
1176 datapath_type
, strerror(error
));
1182 ofproto_type_wait(const char *datapath_type
)
1184 const struct ofproto_class
*class;
1186 datapath_type
= ofproto_normalize_type(datapath_type
);
1187 class = ofproto_class_find__(datapath_type
);
1189 if (class->type_wait
) {
1190 class->type_wait(datapath_type
);
1195 ofproto_run(struct ofproto
*p
)
1197 struct sset changed_netdevs
;
1198 const char *changed_netdev
;
1199 struct ofport
*ofport
;
1202 error
= p
->ofproto_class
->run(p
);
1203 if (error
&& error
!= EAGAIN
) {
1204 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, strerror(error
));
1207 if (p
->ofproto_class
->port_poll
) {
1210 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1211 process_port_change(p
, error
, devname
);
1215 /* Update OpenFlow port status for any port whose netdev has changed.
1217 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1218 * destroyed, so it's not safe to update ports directly from the
1219 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1220 * need this two-phase approach. */
1221 sset_init(&changed_netdevs
);
1222 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1223 unsigned int change_seq
= netdev_change_seq(ofport
->netdev
);
1224 if (ofport
->change_seq
!= change_seq
) {
1225 ofport
->change_seq
= change_seq
;
1226 sset_add(&changed_netdevs
, netdev_get_name(ofport
->netdev
));
1229 SSET_FOR_EACH (changed_netdev
, &changed_netdevs
) {
1230 update_port(p
, changed_netdev
);
1232 sset_destroy(&changed_netdevs
);
1236 connmgr_run(p
->connmgr
, handle_openflow
);
1240 connmgr_run(p
->connmgr
, NULL
);
1242 if (list_is_empty(&p
->pending
) && hmap_is_empty(&p
->deletions
)) {
1243 p
->state
= S_OPENFLOW
;
1248 connmgr_run(p
->connmgr
, NULL
);
1250 if (list_is_empty(&p
->pending
) && hmap_is_empty(&p
->deletions
)) {
1251 connmgr_flushed(p
->connmgr
);
1252 p
->state
= S_OPENFLOW
;
1260 if (time_msec() >= p
->next_op_report
) {
1261 long long int ago
= (time_msec() - p
->first_op
) / 1000;
1262 long long int interval
= (p
->last_op
- p
->first_op
) / 1000;
1266 ds_put_format(&s
, "%d flow_mods ",
1267 p
->n_add
+ p
->n_delete
+ p
->n_modify
);
1268 if (interval
== ago
) {
1269 ds_put_format(&s
, "in the last %lld s", ago
);
1270 } else if (interval
) {
1271 ds_put_format(&s
, "in the %lld s starting %lld s ago",
1274 ds_put_format(&s
, "%lld s ago", ago
);
1277 ds_put_cstr(&s
, " (");
1279 ds_put_format(&s
, "%d adds, ", p
->n_add
);
1282 ds_put_format(&s
, "%d deletes, ", p
->n_delete
);
1285 ds_put_format(&s
, "%d modifications, ", p
->n_modify
);
1288 ds_put_char(&s
, ')');
1290 VLOG_INFO("%s: %s", p
->name
, ds_cstr(&s
));
1293 p
->n_add
= p
->n_delete
= p
->n_modify
= 0;
1294 p
->next_op_report
= LLONG_MAX
;
1300 /* Performs periodic activity required by 'ofproto' that needs to be done
1301 * with the least possible latency.
1303 * It makes sense to call this function a couple of times per poll loop, to
1304 * provide a significant performance boost on some benchmarks with the
1305 * ofproto-dpif implementation. */
1307 ofproto_run_fast(struct ofproto
*p
)
1311 error
= p
->ofproto_class
->run_fast
? p
->ofproto_class
->run_fast(p
) : 0;
1312 if (error
&& error
!= EAGAIN
) {
1313 VLOG_ERR_RL(&rl
, "%s: fastpath run failed (%s)",
1314 p
->name
, strerror(error
));
1320 ofproto_wait(struct ofproto
*p
)
1322 struct ofport
*ofport
;
1324 p
->ofproto_class
->wait(p
);
1325 if (p
->ofproto_class
->port_poll_wait
) {
1326 p
->ofproto_class
->port_poll_wait(p
);
1329 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1330 if (ofport
->change_seq
!= netdev_change_seq(ofport
->netdev
)) {
1331 poll_immediate_wake();
1337 connmgr_wait(p
->connmgr
, true);
1342 connmgr_wait(p
->connmgr
, false);
1343 if (list_is_empty(&p
->pending
) && hmap_is_empty(&p
->deletions
)) {
1344 poll_immediate_wake();
1351 ofproto_is_alive(const struct ofproto
*p
)
1353 return connmgr_has_controllers(p
->connmgr
);
1356 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1357 * memory_report(). */
1359 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1361 const struct oftable
*table
;
1362 unsigned int n_rules
;
1364 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1365 simap_increase(usage
, "ops",
1366 ofproto
->n_pending
+ hmap_count(&ofproto
->deletions
));
1369 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1370 n_rules
+= classifier_count(&table
->cls
);
1372 simap_increase(usage
, "rules", n_rules
);
1374 if (ofproto
->ofproto_class
->get_memory_usage
) {
1375 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1378 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1382 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1385 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1389 ofproto_free_ofproto_controller_info(struct shash
*info
)
1391 connmgr_free_controller_info(info
);
1394 /* Makes a deep copy of 'old' into 'port'. */
1396 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1398 port
->name
= xstrdup(old
->name
);
1399 port
->type
= xstrdup(old
->type
);
1400 port
->ofp_port
= old
->ofp_port
;
1403 /* Frees memory allocated to members of 'ofproto_port'.
1405 * Do not call this function on an ofproto_port obtained from
1406 * ofproto_port_dump_next(): that function retains ownership of the data in the
1409 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1411 free(ofproto_port
->name
);
1412 free(ofproto_port
->type
);
1415 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1417 * This function provides no status indication. An error status for the entire
1418 * dump operation is provided when it is completed by calling
1419 * ofproto_port_dump_done().
1422 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1423 const struct ofproto
*ofproto
)
1425 dump
->ofproto
= ofproto
;
1426 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1430 /* Attempts to retrieve another port from 'dump', which must have been created
1431 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1432 * 'port' and returns true. On failure, returns false.
1434 * Failure might indicate an actual error or merely that the last port has been
1435 * dumped. An error status for the entire dump operation is provided when it
1436 * is completed by calling ofproto_port_dump_done().
1438 * The ofproto owns the data stored in 'port'. It will remain valid until at
1439 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1440 * ofproto_port_dump_done(). */
1442 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1443 struct ofproto_port
*port
)
1445 const struct ofproto
*ofproto
= dump
->ofproto
;
1451 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1454 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1460 /* Completes port table dump operation 'dump', which must have been created
1461 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1462 * error-free, otherwise a positive errno value describing the problem. */
1464 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1466 const struct ofproto
*ofproto
= dump
->ofproto
;
1468 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1471 return dump
->error
== EOF
? 0 : dump
->error
;
1474 /* Returns the type to pass to netdev_open() when a datapath of type
1475 * 'datapath_type' has a port of type 'port_type', for a few special
1476 * cases when a netdev type differs from a port type. For example, when
1477 * using the userspace datapath, a port of type "internal" needs to be
1480 * Returns either 'type' itself or a string literal, which must not be
1483 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1485 const struct ofproto_class
*class;
1487 datapath_type
= ofproto_normalize_type(datapath_type
);
1488 class = ofproto_class_find__(datapath_type
);
1493 return (class->port_open_type
1494 ? class->port_open_type(datapath_type
, port_type
)
1498 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1499 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1500 * the port's OpenFlow port number.
1502 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1503 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1504 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1505 * 'ofp_portp' is non-null). */
1507 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1508 ofp_port_t
*ofp_portp
)
1510 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1513 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1515 const char *netdev_name
= netdev_get_name(netdev
);
1517 simap_put(&ofproto
->ofp_requests
, netdev_name
,
1518 ofp_to_u16(ofp_port
));
1519 update_port(ofproto
, netdev_name
);
1522 struct ofproto_port ofproto_port
;
1524 ofproto_port_query_by_name(ofproto
, netdev_get_name(netdev
),
1526 *ofp_portp
= error
? OFPP_NONE
: ofproto_port
.ofp_port
;
1527 ofproto_port_destroy(&ofproto_port
);
1532 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1533 * initializes '*port' appropriately; on failure, returns a positive errno
1536 * The caller owns the data in 'ofproto_port' and must free it with
1537 * ofproto_port_destroy() when it is no longer needed. */
1539 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1540 struct ofproto_port
*port
)
1544 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1546 memset(port
, 0, sizeof *port
);
1551 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1552 * Returns 0 if successful, otherwise a positive errno. */
1554 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1556 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1557 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
1558 struct simap_node
*ofp_request_node
;
1561 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
1562 if (ofp_request_node
) {
1563 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
1566 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
1567 if (!error
&& ofport
) {
1568 /* 'name' is the netdev's name and update_port() is going to close the
1569 * netdev. Just in case update_port() refers to 'name' after it
1570 * destroys 'ofport', make a copy of it around the update_port()
1572 char *devname
= xstrdup(name
);
1573 update_port(ofproto
, devname
);
1579 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1580 * performs the 'n_actions' actions in 'actions'. The new flow will not
1583 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1584 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1585 * controllers; otherwise, it will be hidden.
1587 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1589 * This is a helper function for in-band control and fail-open. */
1591 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
1592 unsigned int priority
,
1593 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1595 const struct rule
*rule
;
1597 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1598 &ofproto
->tables
[0].cls
, match
, priority
));
1599 if (!rule
|| !ofpacts_equal(rule
->ofpacts
, rule
->ofpacts_len
,
1600 ofpacts
, ofpacts_len
)) {
1601 struct ofputil_flow_mod fm
;
1603 memset(&fm
, 0, sizeof fm
);
1605 fm
.priority
= priority
;
1606 fm
.buffer_id
= UINT32_MAX
;
1607 fm
.ofpacts
= xmemdup(ofpacts
, ofpacts_len
);
1608 fm
.ofpacts_len
= ofpacts_len
;
1609 add_flow(ofproto
, NULL
, &fm
, NULL
);
1614 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1615 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1616 * operation cannot be initiated now but may be retried later.
1618 * This is a helper function for in-band control and fail-open. */
1620 ofproto_flow_mod(struct ofproto
*ofproto
, const struct ofputil_flow_mod
*fm
)
1622 return handle_flow_mod__(ofproto
, NULL
, fm
, NULL
);
1625 /* Searches for a rule with matching criteria exactly equal to 'target' in
1626 * ofproto's table 0 and, if it finds one, deletes it.
1628 * This is a helper function for in-band control and fail-open. */
1630 ofproto_delete_flow(struct ofproto
*ofproto
,
1631 const struct match
*target
, unsigned int priority
)
1635 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1636 &ofproto
->tables
[0].cls
, target
, priority
));
1638 /* No such rule -> success. */
1640 } else if (rule
->pending
) {
1641 /* An operation on the rule is already pending -> failure.
1642 * Caller must retry later if it's important. */
1645 /* Initiate deletion -> success. */
1646 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
1647 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, OFPRR_DELETE
);
1648 oftable_remove_rule(rule
);
1649 ofproto
->ofproto_class
->rule_destruct(rule
);
1650 ofopgroup_submit(group
);
1656 /* Starts the process of deleting all of the flows from all of ofproto's flow
1657 * tables and then reintroducing the flows required by in-band control and
1658 * fail-open. The process will complete in a later call to ofproto_run(). */
1660 ofproto_flush_flows(struct ofproto
*ofproto
)
1662 COVERAGE_INC(ofproto_flush
);
1663 ofproto
->state
= S_FLUSH
;
1667 reinit_ports(struct ofproto
*p
)
1669 struct ofproto_port_dump dump
;
1670 struct sset devnames
;
1671 struct ofport
*ofport
;
1672 struct ofproto_port ofproto_port
;
1673 const char *devname
;
1675 COVERAGE_INC(ofproto_reinit_ports
);
1677 sset_init(&devnames
);
1678 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1679 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1681 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
1682 sset_add(&devnames
, ofproto_port
.name
);
1685 SSET_FOR_EACH (devname
, &devnames
) {
1686 update_port(p
, devname
);
1688 sset_destroy(&devnames
);
1692 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
1694 uint16_t max_ports
= ofp_to_u16(ofproto
->max_ports
);
1697 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
1699 port_idx
= UINT16_MAX
;
1702 if (port_idx
>= max_ports
1703 || bitmap_is_set(ofproto
->ofp_port_ids
, port_idx
)) {
1704 uint16_t end_port_no
= ofp_to_u16(ofproto
->alloc_port_no
);
1705 uint16_t alloc_port_no
= end_port_no
;
1707 /* Search for a free OpenFlow port number. We try not to
1708 * immediately reuse them to prevent problems due to old
1711 if (++alloc_port_no
>= max_ports
) {
1714 if (!bitmap_is_set(ofproto
->ofp_port_ids
, alloc_port_no
)) {
1715 port_idx
= alloc_port_no
;
1716 ofproto
->alloc_port_no
= u16_to_ofp(alloc_port_no
);
1719 if (alloc_port_no
== end_port_no
) {
1724 bitmap_set1(ofproto
->ofp_port_ids
, port_idx
);
1725 return u16_to_ofp(port_idx
);
1729 dealloc_ofp_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1731 if (ofp_to_u16(ofp_port
) < ofp_to_u16(ofproto
->max_ports
)) {
1732 bitmap_set0(ofproto
->ofp_port_ids
, ofp_to_u16(ofp_port
));
1736 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1737 * pointer if the netdev cannot be opened. On success, also fills in
1739 static struct netdev
*
1740 ofport_open(struct ofproto
*ofproto
,
1741 struct ofproto_port
*ofproto_port
,
1742 struct ofputil_phy_port
*pp
)
1744 enum netdev_flags flags
;
1745 struct netdev
*netdev
;
1748 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
1750 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
1751 "cannot be opened (%s)",
1753 ofproto_port
->name
, ofproto_port
->ofp_port
,
1754 ofproto_port
->name
, strerror(error
));
1758 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
1759 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
1760 ofproto_port
->ofp_port
= OFPP_LOCAL
;
1762 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
1763 ofproto_port
->name
);
1766 pp
->port_no
= ofproto_port
->ofp_port
;
1767 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
1768 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
1769 netdev_get_flags(netdev
, &flags
);
1770 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
1771 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
1772 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
1773 &pp
->supported
, &pp
->peer
);
1774 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0);
1775 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0);
1780 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1781 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1784 ofport_equal(const struct ofputil_phy_port
*a
,
1785 const struct ofputil_phy_port
*b
)
1787 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
1788 && a
->state
== b
->state
1789 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
1790 && a
->curr
== b
->curr
1791 && a
->advertised
== b
->advertised
1792 && a
->supported
== b
->supported
1793 && a
->peer
== b
->peer
1794 && a
->curr_speed
== b
->curr_speed
1795 && a
->max_speed
== b
->max_speed
);
1798 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1799 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1800 * one with the same name or port number). */
1802 ofport_install(struct ofproto
*p
,
1803 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
1805 const char *netdev_name
= netdev_get_name(netdev
);
1806 struct ofport
*ofport
;
1809 /* Create ofport. */
1810 ofport
= p
->ofproto_class
->port_alloc();
1815 ofport
->ofproto
= p
;
1816 ofport
->netdev
= netdev
;
1817 ofport
->change_seq
= netdev_change_seq(netdev
);
1819 ofport
->ofp_port
= pp
->port_no
;
1820 ofport
->created
= time_msec();
1822 /* Add port to 'p'. */
1823 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
1824 hash_ofp_port(ofport
->ofp_port
));
1825 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
1827 update_mtu(p
, ofport
);
1829 /* Let the ofproto_class initialize its private data. */
1830 error
= p
->ofproto_class
->port_construct(ofport
);
1834 connmgr_send_port_status(p
->connmgr
, pp
, OFPPR_ADD
);
1838 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
1839 p
->name
, netdev_name
, strerror(error
));
1841 ofport_destroy__(ofport
);
1843 netdev_close(netdev
);
1847 /* Removes 'ofport' from 'p' and destroys it. */
1849 ofport_remove(struct ofport
*ofport
)
1851 connmgr_send_port_status(ofport
->ofproto
->connmgr
, &ofport
->pp
,
1853 ofport_destroy(ofport
);
1856 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1859 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
1861 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
1863 ofport_remove(port
);
1867 /* Updates 'port' with new 'pp' description.
1869 * Does not handle a name or port number change. The caller must implement
1870 * such a change as a delete followed by an add. */
1872 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
1874 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
1875 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
1876 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
1877 port
->pp
.state
= pp
->state
;
1878 port
->pp
.curr
= pp
->curr
;
1879 port
->pp
.advertised
= pp
->advertised
;
1880 port
->pp
.supported
= pp
->supported
;
1881 port
->pp
.peer
= pp
->peer
;
1882 port
->pp
.curr_speed
= pp
->curr_speed
;
1883 port
->pp
.max_speed
= pp
->max_speed
;
1885 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->pp
, OFPPR_MODIFY
);
1888 /* Update OpenFlow 'state' in 'port' and notify controller. */
1890 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
1892 if (port
->pp
.state
!= state
) {
1893 port
->pp
.state
= state
;
1894 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->pp
,
1900 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1902 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
1904 if (port
->ofproto
->ofproto_class
->set_realdev
) {
1905 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
1907 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
1908 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
1910 if (port
->ofproto
->ofproto_class
->set_cfm
) {
1911 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
1913 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
1914 port
->ofproto
->ofproto_class
->bundle_remove(port
);
1920 ofport_destroy__(struct ofport
*port
)
1922 struct ofproto
*ofproto
= port
->ofproto
;
1923 const char *name
= netdev_get_name(port
->netdev
);
1925 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
1926 shash_delete(&ofproto
->port_by_name
,
1927 shash_find(&ofproto
->port_by_name
, name
));
1929 netdev_close(port
->netdev
);
1930 ofproto
->ofproto_class
->port_dealloc(port
);
1934 ofport_destroy(struct ofport
*port
)
1937 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
1938 port
->ofproto
->ofproto_class
->port_destruct(port
);
1939 ofport_destroy__(port
);
1944 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1946 struct ofport
*port
;
1948 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
1950 if (port
->ofp_port
== ofp_port
) {
1958 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
1960 struct ofproto
*ofproto
= port
->ofproto
;
1963 if (ofproto
->ofproto_class
->port_get_stats
) {
1964 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
1973 update_port(struct ofproto
*ofproto
, const char *name
)
1975 struct ofproto_port ofproto_port
;
1976 struct ofputil_phy_port pp
;
1977 struct netdev
*netdev
;
1978 struct ofport
*port
;
1980 COVERAGE_INC(ofproto_update_port
);
1982 /* Fetch 'name''s location and properties from the datapath. */
1983 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
1984 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
1988 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
1989 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
1990 struct netdev
*old_netdev
= port
->netdev
;
1992 /* 'name' hasn't changed location. Any properties changed? */
1993 if (!ofport_equal(&port
->pp
, &pp
)) {
1994 ofport_modified(port
, &pp
);
1997 update_mtu(ofproto
, port
);
1999 /* Install the newly opened netdev in case it has changed.
2000 * Don't close the old netdev yet in case port_modified has to
2001 * remove a retained reference to it.*/
2002 port
->netdev
= netdev
;
2003 port
->change_seq
= netdev_change_seq(netdev
);
2005 if (port
->ofproto
->ofproto_class
->port_modified
) {
2006 port
->ofproto
->ofproto_class
->port_modified(port
);
2009 netdev_close(old_netdev
);
2011 /* If 'port' is nonnull then its name differs from 'name' and thus
2012 * we should delete it. If we think there's a port named 'name'
2013 * then its port number must be wrong now so delete it too. */
2015 ofport_remove(port
);
2017 ofport_remove_with_name(ofproto
, name
);
2018 ofport_install(ofproto
, netdev
, &pp
);
2021 /* Any port named 'name' is gone now. */
2022 ofport_remove_with_name(ofproto
, name
);
2024 ofproto_port_destroy(&ofproto_port
);
2028 init_ports(struct ofproto
*p
)
2030 struct ofproto_port_dump dump
;
2031 struct ofproto_port ofproto_port
;
2032 struct shash_node
*node
, *next
;
2034 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2035 const char *name
= ofproto_port
.name
;
2037 if (shash_find(&p
->port_by_name
, name
)) {
2038 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2041 struct ofputil_phy_port pp
;
2042 struct netdev
*netdev
;
2044 /* Check if an OpenFlow port number had been requested. */
2045 node
= shash_find(&init_ofp_ports
, name
);
2047 const struct iface_hint
*iface_hint
= node
->data
;
2048 simap_put(&p
->ofp_requests
, name
,
2049 ofp_to_u16(iface_hint
->ofp_port
));
2052 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2054 ofport_install(p
, netdev
, &pp
);
2059 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2060 struct iface_hint
*iface_hint
= node
->data
;
2062 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2063 free(iface_hint
->br_name
);
2064 free(iface_hint
->br_type
);
2066 shash_delete(&init_ofp_ports
, node
);
2073 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2074 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2076 find_min_mtu(struct ofproto
*p
)
2078 struct ofport
*ofport
;
2081 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2082 struct netdev
*netdev
= ofport
->netdev
;
2085 /* Skip any internal ports, since that's what we're trying to
2087 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2091 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2094 if (!mtu
|| dev_mtu
< mtu
) {
2099 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2102 /* Update MTU of all datapath devices on 'p' to the minimum of the
2103 * non-datapath ports in event of 'port' added or changed. */
2105 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2107 struct ofport
*ofport
;
2108 struct netdev
*netdev
= port
->netdev
;
2109 int dev_mtu
, old_min
;
2111 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2115 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2116 if (dev_mtu
> p
->min_mtu
) {
2117 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2118 dev_mtu
= p
->min_mtu
;
2121 port
->mtu
= dev_mtu
;
2125 /* For non-internal port find new min mtu. */
2126 old_min
= p
->min_mtu
;
2127 port
->mtu
= dev_mtu
;
2128 p
->min_mtu
= find_min_mtu(p
);
2129 if (p
->min_mtu
== old_min
) {
2133 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2134 struct netdev
*netdev
= ofport
->netdev
;
2136 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2137 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2138 ofport
->mtu
= p
->min_mtu
;
2145 ofproto_rule_destroy__(struct rule
*rule
)
2148 cls_rule_destroy(&rule
->cr
);
2149 free(rule
->ofpacts
);
2150 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2154 /* This function allows an ofproto implementation to destroy any rules that
2155 * remain when its ->destruct() function is called. The caller must have
2156 * already uninitialized any derived members of 'rule' (step 5 described in the
2157 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
2158 * This function implements steps 6 and 7.
2160 * This function should only be called from an ofproto implementation's
2161 * ->destruct() function. It is not suitable elsewhere. */
2163 ofproto_rule_destroy(struct rule
*rule
)
2165 ovs_assert(!rule
->pending
);
2166 oftable_remove_rule(rule
);
2167 ofproto_rule_destroy__(rule
);
2170 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2171 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2173 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2175 return (port
== OFPP_ANY
2176 || ofpacts_output_to_port(rule
->ofpacts
, rule
->ofpacts_len
, port
));
2179 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2180 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2182 ofoperation_has_out_port(const struct ofoperation
*op
, ofp_port_t out_port
)
2184 if (ofproto_rule_has_out_port(op
->rule
, out_port
)) {
2189 case OFOPERATION_ADD
:
2190 return op
->victim
&& ofproto_rule_has_out_port(op
->victim
, out_port
);
2192 case OFOPERATION_DELETE
:
2195 case OFOPERATION_MODIFY
:
2196 return ofpacts_output_to_port(op
->ofpacts
, op
->ofpacts_len
, out_port
);
2202 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2203 * statistics appropriately. 'packet' must have at least sizeof(struct
2204 * ofp10_packet_in) bytes of headroom.
2206 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
2207 * with statistics for 'packet' either way.
2209 * Takes ownership of 'packet'. */
2211 rule_execute(struct rule
*rule
, ofp_port_t in_port
, struct ofpbuf
*packet
)
2214 union flow_in_port in_port_
;
2216 ovs_assert(ofpbuf_headroom(packet
) >= sizeof(struct ofp10_packet_in
));
2218 in_port_
.ofp_port
= in_port
;
2219 flow_extract(packet
, 0, 0, NULL
, &in_port_
, &flow
);
2220 return rule
->ofproto
->ofproto_class
->rule_execute(rule
, &flow
, packet
);
2223 /* Returns true if 'rule' should be hidden from the controller.
2225 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2226 * (e.g. by in-band control) and are intentionally hidden from the
2229 ofproto_rule_is_hidden(const struct rule
*rule
)
2231 return rule
->cr
.priority
> UINT16_MAX
;
2234 static enum oftable_flags
2235 rule_get_flags(const struct rule
*rule
)
2237 return rule
->ofproto
->tables
[rule
->table_id
].flags
;
2241 rule_is_modifiable(const struct rule
*rule
)
2243 return !(rule_get_flags(rule
) & OFTABLE_READONLY
);
2247 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2249 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
2254 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2256 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2257 struct ofputil_switch_features features
;
2258 struct ofport
*port
;
2264 ofproto
->ofproto_class
->get_features(ofproto
, &arp_match_ip
,
2266 ovs_assert(features
.actions
& OFPUTIL_A_OUTPUT
); /* sanity check */
2268 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2269 * if present, are always at the end.) */
2270 n_tables
= ofproto
->n_tables
;
2271 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2272 if (ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
) {
2278 features
.datapath_id
= ofproto
->datapath_id
;
2279 features
.n_buffers
= pktbuf_capacity();
2280 features
.n_tables
= n_tables
;
2281 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
2282 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
);
2284 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
2286 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2287 features
.auxiliary_id
= 0;
2288 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
2290 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
2291 ofputil_put_switch_features_port(&port
->pp
, b
);
2294 ofconn_send_reply(ofconn
, b
);
2299 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2301 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2302 struct ofp_switch_config
*osc
;
2303 enum ofp_config_flags flags
;
2307 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
2308 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
2309 flags
= ofproto
->frag_handling
;
2310 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2311 if (oh
->version
< OFP13_VERSION
2312 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
2313 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
2315 osc
->flags
= htons(flags
);
2316 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
2317 ofconn_send_reply(ofconn
, buf
);
2323 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2325 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
2326 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2327 uint16_t flags
= ntohs(osc
->flags
);
2329 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
2330 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
2331 enum ofp_config_flags cur
= ofproto
->frag_handling
;
2332 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
2334 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
2336 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
2337 ofproto
->frag_handling
= next
;
2339 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
2341 ofputil_frag_handling_to_string(next
));
2345 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2346 ofconn_set_invalid_ttl_to_controller(ofconn
,
2347 (oh
->version
< OFP13_VERSION
2348 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
2350 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
2355 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2356 * error message code for the caller to propagate upward. Otherwise, returns
2359 * The log message mentions 'msg_type'. */
2361 reject_slave_controller(struct ofconn
*ofconn
)
2363 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
2364 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
2365 return OFPERR_OFPBRC_EPERM
;
2372 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2374 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2375 struct ofputil_packet_out po
;
2376 struct ofpbuf
*payload
;
2377 uint64_t ofpacts_stub
[1024 / 8];
2378 struct ofpbuf ofpacts
;
2380 union flow_in_port in_port_
;
2383 COVERAGE_INC(ofproto_packet_out
);
2385 error
= reject_slave_controller(ofconn
);
2390 /* Decode message. */
2391 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
2392 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
2394 goto exit_free_ofpacts
;
2396 if (ofp_to_u16(po
.in_port
) >= ofp_to_u16(p
->max_ports
)
2397 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
2398 error
= OFPERR_OFPBRC_BAD_PORT
;
2399 goto exit_free_ofpacts
;
2404 if (po
.buffer_id
!= UINT32_MAX
) {
2405 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
2406 if (error
|| !payload
) {
2407 goto exit_free_ofpacts
;
2410 payload
= xmalloc(sizeof *payload
);
2411 ofpbuf_use_const(payload
, po
.packet
, po
.packet_len
);
2414 /* Verify actions against packet, then send packet if successful. */
2415 in_port_
.ofp_port
= po
.in_port
;
2416 flow_extract(payload
, 0, 0, NULL
, &in_port_
, &flow
);
2417 error
= ofpacts_check(po
.ofpacts
, po
.ofpacts_len
, &flow
, p
->max_ports
);
2419 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
2420 po
.ofpacts
, po
.ofpacts_len
);
2422 ofpbuf_delete(payload
);
2425 ofpbuf_uninit(&ofpacts
);
2431 update_port_config(struct ofport
*port
,
2432 enum ofputil_port_config config
,
2433 enum ofputil_port_config mask
)
2435 enum ofputil_port_config old_config
= port
->pp
.config
;
2436 enum ofputil_port_config toggle
;
2438 toggle
= (config
^ port
->pp
.config
) & mask
;
2439 if (toggle
& OFPUTIL_PC_PORT_DOWN
) {
2440 if (config
& OFPUTIL_PC_PORT_DOWN
) {
2441 netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
);
2443 netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
);
2445 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
2448 port
->pp
.config
^= toggle
;
2449 if (port
->pp
.config
!= old_config
) {
2450 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
2455 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2457 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2458 struct ofputil_port_mod pm
;
2459 struct ofport
*port
;
2462 error
= reject_slave_controller(ofconn
);
2467 error
= ofputil_decode_port_mod(oh
, &pm
);
2472 port
= ofproto_get_port(p
, pm
.port_no
);
2474 return OFPERR_OFPPMFC_BAD_PORT
;
2475 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
2476 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
2478 update_port_config(port
, pm
.config
, pm
.mask
);
2480 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
2487 handle_desc_stats_request(struct ofconn
*ofconn
,
2488 const struct ofp_header
*request
)
2490 static const char *default_mfr_desc
= "Nicira, Inc.";
2491 static const char *default_hw_desc
= "Open vSwitch";
2492 static const char *default_sw_desc
= VERSION
;
2493 static const char *default_serial_desc
= "None";
2494 static const char *default_dp_desc
= "None";
2496 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2497 struct ofp_desc_stats
*ods
;
2500 msg
= ofpraw_alloc_stats_reply(request
, 0);
2501 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
2502 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
2503 sizeof ods
->mfr_desc
);
2504 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
2505 sizeof ods
->hw_desc
);
2506 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
2507 sizeof ods
->sw_desc
);
2508 ovs_strlcpy(ods
->serial_num
,
2509 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
2510 sizeof ods
->serial_num
);
2511 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
2512 sizeof ods
->dp_desc
);
2513 ofconn_send_reply(ofconn
, msg
);
2519 handle_table_stats_request(struct ofconn
*ofconn
,
2520 const struct ofp_header
*request
)
2522 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2523 struct ofp12_table_stats
*ots
;
2528 /* Set up default values.
2530 * ofp12_table_stats is used as a generic structure as
2531 * it is able to hold all the fields for ofp10_table_stats
2532 * and ofp11_table_stats (and of course itself).
2534 ots
= xcalloc(p
->n_tables
, sizeof *ots
);
2535 for (i
= 0; i
< p
->n_tables
; i
++) {
2536 ots
[i
].table_id
= i
;
2537 sprintf(ots
[i
].name
, "table%zu", i
);
2538 ots
[i
].match
= htonll(OFPXMT12_MASK
);
2539 ots
[i
].wildcards
= htonll(OFPXMT12_MASK
);
2540 ots
[i
].write_actions
= htonl(OFPAT11_OUTPUT
);
2541 ots
[i
].apply_actions
= htonl(OFPAT11_OUTPUT
);
2542 ots
[i
].write_setfields
= htonll(OFPXMT12_MASK
);
2543 ots
[i
].apply_setfields
= htonll(OFPXMT12_MASK
);
2544 ots
[i
].metadata_match
= htonll(UINT64_MAX
);
2545 ots
[i
].metadata_write
= htonll(UINT64_MAX
);
2546 ots
[i
].instructions
= htonl(OFPIT11_ALL
);
2547 ots
[i
].config
= htonl(OFPTC11_TABLE_MISS_MASK
);
2548 ots
[i
].max_entries
= htonl(1000000); /* An arbitrary big number. */
2549 ots
[i
].active_count
= htonl(classifier_count(&p
->tables
[i
].cls
));
2552 p
->ofproto_class
->get_tables(p
, ots
);
2554 /* Post-process the tables, dropping hidden tables. */
2555 n_tables
= p
->n_tables
;
2556 for (i
= 0; i
< p
->n_tables
; i
++) {
2557 const struct oftable
*table
= &p
->tables
[i
];
2559 if (table
->flags
& OFTABLE_HIDDEN
) {
2565 ovs_strzcpy(ots
[i
].name
, table
->name
, sizeof ots
[i
].name
);
2568 if (table
->max_flows
< ntohl(ots
[i
].max_entries
)) {
2569 ots
[i
].max_entries
= htonl(table
->max_flows
);
2573 msg
= ofputil_encode_table_stats_reply(ots
, n_tables
, request
);
2574 ofconn_send_reply(ofconn
, msg
);
2582 append_port_stat(struct ofport
*port
, struct list
*replies
)
2584 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
2586 calc_duration(port
->created
, time_msec(),
2587 &ops
.duration_sec
, &ops
.duration_nsec
);
2589 /* Intentionally ignore return value, since errors will set
2590 * 'stats' to all-1s, which is correct for OpenFlow, and
2591 * netdev_get_stats() will log errors. */
2592 ofproto_port_get_stats(port
, &ops
.stats
);
2594 ofputil_append_port_stat(replies
, &ops
);
2598 handle_port_stats_request(struct ofconn
*ofconn
,
2599 const struct ofp_header
*request
)
2601 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2602 struct ofport
*port
;
2603 struct list replies
;
2607 error
= ofputil_decode_port_stats_request(request
, &port_no
);
2612 ofpmp_init(&replies
, request
);
2613 if (port_no
!= OFPP_ANY
) {
2614 port
= ofproto_get_port(p
, port_no
);
2616 append_port_stat(port
, &replies
);
2619 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
2620 append_port_stat(port
, &replies
);
2624 ofconn_send_replies(ofconn
, &replies
);
2629 handle_port_desc_stats_request(struct ofconn
*ofconn
,
2630 const struct ofp_header
*request
)
2632 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2633 enum ofp_version version
;
2634 struct ofport
*port
;
2635 struct list replies
;
2637 ofpmp_init(&replies
, request
);
2639 version
= ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn
));
2640 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
2641 ofputil_append_port_desc_stats_reply(version
, &port
->pp
, &replies
);
2644 ofconn_send_replies(ofconn
, &replies
);
2649 hash_cookie(ovs_be64 cookie
)
2651 return hash_2words((OVS_FORCE
uint64_t)cookie
>> 32,
2652 (OVS_FORCE
uint64_t)cookie
);
2656 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
2658 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
2659 hash_cookie(rule
->flow_cookie
));
2663 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
2665 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
2669 ofproto_rule_change_cookie(struct ofproto
*ofproto
, struct rule
*rule
,
2670 ovs_be64 new_cookie
)
2672 if (new_cookie
!= rule
->flow_cookie
) {
2673 cookies_remove(ofproto
, rule
);
2675 rule
->flow_cookie
= new_cookie
;
2677 cookies_insert(ofproto
, rule
);
2682 calc_duration(long long int start
, long long int now
,
2683 uint32_t *sec
, uint32_t *nsec
)
2685 long long int msecs
= now
- start
;
2686 *sec
= msecs
/ 1000;
2687 *nsec
= (msecs
% 1000) * (1000 * 1000);
2690 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2691 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2693 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
2695 return (table_id
== 0xff || table_id
< ofproto
->n_tables
2697 : OFPERR_OFPBRC_BAD_TABLE_ID
);
2701 static struct oftable
*
2702 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
2704 struct oftable
*table
;
2706 for (table
= &ofproto
->tables
[table_id
];
2707 table
< &ofproto
->tables
[ofproto
->n_tables
];
2709 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
2717 static struct oftable
*
2718 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
2720 if (table_id
== 0xff) {
2721 return next_visible_table(ofproto
, 0);
2722 } else if (table_id
< ofproto
->n_tables
) {
2723 return &ofproto
->tables
[table_id
];
2729 static struct oftable
*
2730 next_matching_table(const struct ofproto
*ofproto
,
2731 const struct oftable
*table
, uint8_t table_id
)
2733 return (table_id
== 0xff
2734 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
2738 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2740 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2741 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2743 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2744 * only once, for that table. (This can be used to access tables marked
2747 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2748 * entered at all. (Perhaps you should have validated TABLE_ID with
2749 * check_table_id().)
2751 * All parameters are evaluated multiple times.
2753 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2754 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2756 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2758 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2759 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2760 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2763 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2764 * to 'out_port' are included.
2766 * Hidden rules are always omitted.
2768 * Returns 0 on success, otherwise an OpenFlow error code. */
2770 collect_rules_loose(struct ofproto
*ofproto
, uint8_t table_id
,
2771 const struct match
*match
,
2772 ovs_be64 cookie
, ovs_be64 cookie_mask
,
2773 ofp_port_t out_port
, struct list
*rules
)
2775 struct oftable
*table
;
2779 error
= check_table_id(ofproto
, table_id
);
2785 cls_rule_init(&cr
, match
, 0);
2787 if (cookie_mask
== htonll(UINT64_MAX
)) {
2790 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
, hash_cookie(cookie
),
2791 &ofproto
->cookies
) {
2792 if (table_id
!= rule
->table_id
&& table_id
!= 0xff) {
2795 if (ofproto_rule_is_hidden(rule
)) {
2798 if (cls_rule_is_loose_match(&rule
->cr
, &cr
.match
)) {
2799 if (rule
->pending
) {
2800 error
= OFPROTO_POSTPONE
;
2803 if (rule
->flow_cookie
== cookie
/* Hash collisions possible. */
2804 && ofproto_rule_has_out_port(rule
, out_port
)) {
2805 list_push_back(rules
, &rule
->ofproto_node
);
2812 FOR_EACH_MATCHING_TABLE (table
, table_id
, ofproto
) {
2813 struct cls_cursor cursor
;
2816 cls_cursor_init(&cursor
, &table
->cls
, &cr
);
2817 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
2818 if (rule
->pending
) {
2819 error
= OFPROTO_POSTPONE
;
2822 if (!ofproto_rule_is_hidden(rule
)
2823 && ofproto_rule_has_out_port(rule
, out_port
)
2824 && !((rule
->flow_cookie
^ cookie
) & cookie_mask
)) {
2825 list_push_back(rules
, &rule
->ofproto_node
);
2831 cls_rule_destroy(&cr
);
2835 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2836 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2837 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2840 * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2841 * to 'out_port' are included.
2843 * Hidden rules are always omitted.
2845 * Returns 0 on success, otherwise an OpenFlow error code. */
2847 collect_rules_strict(struct ofproto
*ofproto
, uint8_t table_id
,
2848 const struct match
*match
, unsigned int priority
,
2849 ovs_be64 cookie
, ovs_be64 cookie_mask
,
2850 ofp_port_t out_port
, struct list
*rules
)
2852 struct oftable
*table
;
2856 error
= check_table_id(ofproto
, table_id
);
2862 cls_rule_init(&cr
, match
, priority
);
2864 if (cookie_mask
== htonll(UINT64_MAX
)) {
2867 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
, hash_cookie(cookie
),
2868 &ofproto
->cookies
) {
2869 if (table_id
!= rule
->table_id
&& table_id
!= 0xff) {
2872 if (ofproto_rule_is_hidden(rule
)) {
2875 if (cls_rule_equal(&rule
->cr
, &cr
)) {
2876 if (rule
->pending
) {
2877 error
= OFPROTO_POSTPONE
;
2880 if (rule
->flow_cookie
== cookie
/* Hash collisions possible. */
2881 && ofproto_rule_has_out_port(rule
, out_port
)) {
2882 list_push_back(rules
, &rule
->ofproto_node
);
2889 FOR_EACH_MATCHING_TABLE (table
, table_id
, ofproto
) {
2892 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
,
2895 if (rule
->pending
) {
2896 error
= OFPROTO_POSTPONE
;
2899 if (!ofproto_rule_is_hidden(rule
)
2900 && ofproto_rule_has_out_port(rule
, out_port
)
2901 && !((rule
->flow_cookie
^ cookie
) & cookie_mask
)) {
2902 list_push_back(rules
, &rule
->ofproto_node
);
2908 cls_rule_destroy(&cr
);
2912 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2913 * forced into the range of a uint16_t. */
2915 age_secs(long long int age_ms
)
2917 return (age_ms
< 0 ? 0
2918 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
2919 : (unsigned int) age_ms
/ 1000);
2923 handle_flow_stats_request(struct ofconn
*ofconn
,
2924 const struct ofp_header
*request
)
2926 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2927 struct ofputil_flow_stats_request fsr
;
2928 struct list replies
;
2933 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
2938 error
= collect_rules_loose(ofproto
, fsr
.table_id
, &fsr
.match
,
2939 fsr
.cookie
, fsr
.cookie_mask
,
2940 fsr
.out_port
, &rules
);
2945 ofpmp_init(&replies
, request
);
2946 LIST_FOR_EACH (rule
, ofproto_node
, &rules
) {
2947 long long int now
= time_msec();
2948 struct ofputil_flow_stats fs
;
2950 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
2951 fs
.priority
= rule
->cr
.priority
;
2952 fs
.cookie
= rule
->flow_cookie
;
2953 fs
.table_id
= rule
->table_id
;
2954 calc_duration(rule
->created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
2955 fs
.idle_timeout
= rule
->idle_timeout
;
2956 fs
.hard_timeout
= rule
->hard_timeout
;
2957 fs
.idle_age
= age_secs(now
- rule
->used
);
2958 fs
.hard_age
= age_secs(now
- rule
->modified
);
2959 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
2961 fs
.ofpacts
= rule
->ofpacts
;
2962 fs
.ofpacts_len
= rule
->ofpacts_len
;
2964 if (rule
->send_flow_removed
) {
2965 fs
.flags
|= OFPFF_SEND_FLOW_REM
;
2966 /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
2967 and OFPFF13_NO_BYT_COUNTS */
2969 ofputil_append_flow_stats_reply(&fs
, &replies
);
2971 ofconn_send_replies(ofconn
, &replies
);
2977 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
2979 uint64_t packet_count
, byte_count
;
2981 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
,
2982 &packet_count
, &byte_count
);
2984 if (rule
->table_id
!= 0) {
2985 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
2987 ds_put_format(results
, "duration=%llds, ",
2988 (time_msec() - rule
->created
) / 1000);
2989 ds_put_format(results
, "priority=%u, ", rule
->cr
.priority
);
2990 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
2991 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
2992 cls_rule_format(&rule
->cr
, results
);
2993 ds_put_char(results
, ',');
2994 ofpacts_format(rule
->ofpacts
, rule
->ofpacts_len
, results
);
2995 ds_put_cstr(results
, "\n");
2998 /* Adds a pretty-printed description of all flows to 'results', including
2999 * hidden flows (e.g., set up by in-band control). */
3001 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
3003 struct oftable
*table
;
3005 OFPROTO_FOR_EACH_TABLE (table
, p
) {
3006 struct cls_cursor cursor
;
3009 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
3010 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
3011 flow_stats_ds(rule
, results
);
3016 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3017 * '*engine_type' and '*engine_id', respectively. */
3019 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
3020 uint8_t *engine_type
, uint8_t *engine_id
)
3022 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
3025 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3026 * true if the port's CFM status was successfully stored into '*status'.
3027 * Returns false if the port did not have CFM configured, in which case
3028 * '*status' is indeterminate.
3030 * The caller must provide and owns '*status', but it does not own and must not
3031 * modify or free the array returned in 'status->rmps'. */
3033 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
3034 struct ofproto_cfm_status
*status
)
3036 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3038 && ofproto
->ofproto_class
->get_cfm_status
3039 && ofproto
->ofproto_class
->get_cfm_status(ofport
, status
));
3043 handle_aggregate_stats_request(struct ofconn
*ofconn
,
3044 const struct ofp_header
*oh
)
3046 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3047 struct ofputil_flow_stats_request request
;
3048 struct ofputil_aggregate_stats stats
;
3049 bool unknown_packets
, unknown_bytes
;
3050 struct ofpbuf
*reply
;
3055 error
= ofputil_decode_flow_stats_request(&request
, oh
);
3060 error
= collect_rules_loose(ofproto
, request
.table_id
, &request
.match
,
3061 request
.cookie
, request
.cookie_mask
,
3062 request
.out_port
, &rules
);
3067 memset(&stats
, 0, sizeof stats
);
3068 unknown_packets
= unknown_bytes
= false;
3069 LIST_FOR_EACH (rule
, ofproto_node
, &rules
) {
3070 uint64_t packet_count
;
3071 uint64_t byte_count
;
3073 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3076 if (packet_count
== UINT64_MAX
) {
3077 unknown_packets
= true;
3079 stats
.packet_count
+= packet_count
;
3082 if (byte_count
== UINT64_MAX
) {
3083 unknown_bytes
= true;
3085 stats
.byte_count
+= byte_count
;
3090 if (unknown_packets
) {
3091 stats
.packet_count
= UINT64_MAX
;
3093 if (unknown_bytes
) {
3094 stats
.byte_count
= UINT64_MAX
;
3097 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
3098 ofconn_send_reply(ofconn
, reply
);
3103 struct queue_stats_cbdata
{
3104 struct ofport
*ofport
;
3105 struct list replies
;
3109 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
3110 const struct netdev_queue_stats
*stats
)
3113 struct ofputil_queue_stats oqs
= {
3114 .port_no
= cbdata
->ofport
->pp
.port_no
,
3115 .queue_id
= queue_id
,
3118 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
3122 handle_queue_stats_dump_cb(uint32_t queue_id
,
3123 struct netdev_queue_stats
*stats
,
3126 struct queue_stats_cbdata
*cbdata
= cbdata_
;
3128 put_queue_stats(cbdata
, queue_id
, stats
);
3132 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
3133 struct queue_stats_cbdata
*cbdata
)
3135 cbdata
->ofport
= port
;
3136 if (queue_id
== OFPQ_ALL
) {
3137 netdev_dump_queue_stats(port
->netdev
,
3138 handle_queue_stats_dump_cb
, cbdata
);
3140 struct netdev_queue_stats stats
;
3142 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
3143 put_queue_stats(cbdata
, queue_id
, &stats
);
3145 return OFPERR_OFPQOFC_BAD_QUEUE
;
3152 handle_queue_stats_request(struct ofconn
*ofconn
,
3153 const struct ofp_header
*rq
)
3155 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3156 struct queue_stats_cbdata cbdata
;
3157 struct ofport
*port
;
3159 struct ofputil_queue_stats_request oqsr
;
3161 COVERAGE_INC(ofproto_queue_req
);
3163 ofpmp_init(&cbdata
.replies
, rq
);
3165 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
3170 if (oqsr
.port_no
== OFPP_ANY
) {
3171 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
3172 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3173 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
3178 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
3180 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
3181 : OFPERR_OFPQOFC_BAD_PORT
);
3184 ofconn_send_replies(ofconn
, &cbdata
.replies
);
3186 ofpbuf_list_delete(&cbdata
.replies
);
3193 is_flow_deletion_pending(const struct ofproto
*ofproto
,
3194 const struct cls_rule
*cls_rule
,
3197 if (!hmap_is_empty(&ofproto
->deletions
)) {
3198 struct ofoperation
*op
;
3200 HMAP_FOR_EACH_WITH_HASH (op
, hmap_node
,
3201 cls_rule_hash(cls_rule
, table_id
),
3202 &ofproto
->deletions
) {
3203 if (cls_rule_equal(cls_rule
, &op
->rule
->cr
)) {
3212 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3213 * in which no matching flow already exists in the flow table.
3215 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3216 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3217 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3218 * initiated now but may be retried later.
3220 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
3221 * ownership remains with the caller.
3223 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3226 add_flow(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3227 const struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
)
3229 struct oftable
*table
;
3230 struct ofopgroup
*group
;
3231 struct rule
*victim
;
3236 error
= check_table_id(ofproto
, fm
->table_id
);
3242 if (fm
->table_id
== 0xff) {
3243 if (ofproto
->ofproto_class
->rule_choose_table
) {
3244 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
3250 ovs_assert(table_id
< ofproto
->n_tables
);
3254 } else if (fm
->table_id
< ofproto
->n_tables
) {
3255 table_id
= fm
->table_id
;
3257 return OFPERR_OFPBRC_BAD_TABLE_ID
;
3260 table
= &ofproto
->tables
[table_id
];
3262 if (table
->flags
& OFTABLE_READONLY
) {
3263 return OFPERR_OFPBRC_EPERM
;
3266 /* Allocate new rule and initialize classifier rule. */
3267 rule
= ofproto
->ofproto_class
->rule_alloc();
3269 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
3270 ofproto
->name
, strerror(error
));
3273 cls_rule_init(&rule
->cr
, &fm
->match
, fm
->priority
);
3275 /* Serialize against pending deletion. */
3276 if (is_flow_deletion_pending(ofproto
, &rule
->cr
, table_id
)) {
3277 cls_rule_destroy(&rule
->cr
);
3278 ofproto
->ofproto_class
->rule_dealloc(rule
);
3279 return OFPROTO_POSTPONE
;
3282 /* Check for overlap, if requested. */
3283 if (fm
->flags
& OFPFF_CHECK_OVERLAP
3284 && classifier_rule_overlaps(&table
->cls
, &rule
->cr
)) {
3285 cls_rule_destroy(&rule
->cr
);
3286 ofproto
->ofproto_class
->rule_dealloc(rule
);
3287 return OFPERR_OFPFMFC_OVERLAP
;
3290 /* FIXME: Implement OFPFF12_RESET_COUNTS */
3292 rule
->ofproto
= ofproto
;
3293 rule
->pending
= NULL
;
3294 rule
->flow_cookie
= fm
->new_cookie
;
3295 rule
->created
= rule
->modified
= rule
->used
= time_msec();
3296 rule
->idle_timeout
= fm
->idle_timeout
;
3297 rule
->hard_timeout
= fm
->hard_timeout
;
3298 rule
->table_id
= table
- ofproto
->tables
;
3299 rule
->send_flow_removed
= (fm
->flags
& OFPFF_SEND_FLOW_REM
) != 0;
3300 /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
3301 and OFPFF13_NO_BYT_COUNTS */
3302 rule
->ofpacts
= xmemdup(fm
->ofpacts
, fm
->ofpacts_len
);
3303 rule
->ofpacts_len
= fm
->ofpacts_len
;
3304 rule
->evictable
= true;
3305 rule
->eviction_group
= NULL
;
3306 list_init(&rule
->expirable
);
3307 rule
->monitor_flags
= 0;
3308 rule
->add_seqno
= 0;
3309 rule
->modify_seqno
= 0;
3311 /* Insert new rule. */
3312 victim
= oftable_replace_rule(rule
);
3313 if (victim
&& !rule_is_modifiable(victim
)) {
3314 error
= OFPERR_OFPBRC_EPERM
;
3315 } else if (victim
&& victim
->pending
) {
3316 error
= OFPROTO_POSTPONE
;
3318 struct ofoperation
*op
;
3321 if (classifier_count(&table
->cls
) > table
->max_flows
) {
3324 was_evictable
= rule
->evictable
;
3325 rule
->evictable
= false;
3326 evict
= choose_rule_to_evict(table
);
3327 rule
->evictable
= was_evictable
;
3330 error
= OFPERR_OFPFMFC_TABLE_FULL
;
3332 } else if (evict
->pending
) {
3333 error
= OFPROTO_POSTPONE
;
3340 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
3341 op
= ofoperation_create(group
, rule
, OFOPERATION_ADD
, 0);
3342 op
->victim
= victim
;
3344 error
= ofproto
->ofproto_class
->rule_construct(rule
);
3346 op
->group
->n_running
--;
3347 ofoperation_destroy(rule
->pending
);
3349 delete_flow__(evict
, group
);
3351 ofopgroup_submit(group
);
3355 /* Back out if an error occurred. */
3357 oftable_substitute_rule(rule
, victim
);
3358 ofproto_rule_destroy__(rule
);
3363 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3365 /* Modifies the rules listed in 'rules', changing their actions to match those
3368 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3371 * Returns 0 on success, otherwise an OpenFlow error code. */
3373 modify_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3374 const struct ofputil_flow_mod
*fm
,
3375 const struct ofp_header
*request
, struct list
*rules
)
3377 struct ofopgroup
*group
;
3381 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
3382 error
= OFPERR_OFPBRC_EPERM
;
3383 LIST_FOR_EACH (rule
, ofproto_node
, rules
) {
3384 struct ofoperation
*op
;
3385 bool actions_changed
;
3387 /* FIXME: Implement OFPFF12_RESET_COUNTS */
3389 if (rule_is_modifiable(rule
)) {
3390 /* At least one rule is modifiable, don't report EPERM error. */
3396 actions_changed
= !ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
3397 rule
->ofpacts
, rule
->ofpacts_len
);
3399 op
= ofoperation_create(group
, rule
, OFOPERATION_MODIFY
, 0);
3401 if (fm
->new_cookie
!= htonll(UINT64_MAX
)) {
3402 ofproto_rule_change_cookie(ofproto
, rule
, fm
->new_cookie
);
3404 if (actions_changed
) {
3405 op
->ofpacts
= rule
->ofpacts
;
3406 op
->ofpacts_len
= rule
->ofpacts_len
;
3407 rule
->ofpacts
= xmemdup(fm
->ofpacts
, fm
->ofpacts_len
);
3408 rule
->ofpacts_len
= fm
->ofpacts_len
;
3409 rule
->ofproto
->ofproto_class
->rule_modify_actions(rule
);
3411 ofoperation_complete(op
, 0);
3414 ofopgroup_submit(group
);
3420 modify_flows_add(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3421 const struct ofputil_flow_mod
*fm
,
3422 const struct ofp_header
*request
)
3424 if (fm
->cookie_mask
!= htonll(0) || fm
->new_cookie
== htonll(UINT64_MAX
)) {
3427 return add_flow(ofproto
, ofconn
, fm
, request
);
3430 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3433 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3436 modify_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3437 const struct ofputil_flow_mod
*fm
,
3438 const struct ofp_header
*request
)
3443 error
= collect_rules_loose(ofproto
, fm
->table_id
, &fm
->match
,
3444 fm
->cookie
, fm
->cookie_mask
,
3448 } else if (list_is_empty(&rules
)) {
3449 return modify_flows_add(ofproto
, ofconn
, fm
, request
);
3451 return modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
);
3455 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3458 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3461 modify_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3462 const struct ofputil_flow_mod
*fm
,
3463 const struct ofp_header
*request
)
3468 error
= collect_rules_strict(ofproto
, fm
->table_id
, &fm
->match
,
3469 fm
->priority
, fm
->cookie
, fm
->cookie_mask
,
3474 } else if (list_is_empty(&rules
)) {
3475 return modify_flows_add(ofproto
, ofconn
, fm
, request
);
3477 return list_is_singleton(&rules
) ? modify_flows__(ofproto
, ofconn
,
3478 fm
, request
, &rules
)
3483 /* OFPFC_DELETE implementation. */
3486 delete_flow__(struct rule
*rule
, struct ofopgroup
*group
)
3488 struct ofproto
*ofproto
= rule
->ofproto
;
3490 ofproto_rule_send_removed(rule
, OFPRR_DELETE
);
3492 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, OFPRR_DELETE
);
3493 oftable_remove_rule(rule
);
3494 ofproto
->ofproto_class
->rule_destruct(rule
);
3497 /* Deletes the rules listed in 'rules'.
3499 * Returns 0 on success, otherwise an OpenFlow error code. */
3501 delete_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3502 const struct ofp_header
*request
, struct list
*rules
)
3504 struct rule
*rule
, *next
;
3505 struct ofopgroup
*group
;
3507 group
= ofopgroup_create(ofproto
, ofconn
, request
, UINT32_MAX
);
3508 LIST_FOR_EACH_SAFE (rule
, next
, ofproto_node
, rules
) {
3509 delete_flow__(rule
, group
);
3511 ofopgroup_submit(group
);
3516 /* Implements OFPFC_DELETE. */
3518 delete_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3519 const struct ofputil_flow_mod
*fm
,
3520 const struct ofp_header
*request
)
3525 error
= collect_rules_loose(ofproto
, fm
->table_id
, &fm
->match
,
3526 fm
->cookie
, fm
->cookie_mask
,
3527 fm
->out_port
, &rules
);
3528 return (error
? error
3529 : !list_is_empty(&rules
) ? delete_flows__(ofproto
, ofconn
, request
,
3534 /* Implements OFPFC_DELETE_STRICT. */
3536 delete_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3537 const struct ofputil_flow_mod
*fm
,
3538 const struct ofp_header
*request
)
3543 error
= collect_rules_strict(ofproto
, fm
->table_id
, &fm
->match
,
3544 fm
->priority
, fm
->cookie
, fm
->cookie_mask
,
3545 fm
->out_port
, &rules
);
3546 return (error
? error
3547 : list_is_singleton(&rules
) ? delete_flows__(ofproto
, ofconn
,
3553 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
3555 struct ofputil_flow_removed fr
;
3557 if (ofproto_rule_is_hidden(rule
) || !rule
->send_flow_removed
) {
3561 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
3562 fr
.priority
= rule
->cr
.priority
;
3563 fr
.cookie
= rule
->flow_cookie
;
3565 fr
.table_id
= rule
->table_id
;
3566 calc_duration(rule
->created
, time_msec(),
3567 &fr
.duration_sec
, &fr
.duration_nsec
);
3568 fr
.idle_timeout
= rule
->idle_timeout
;
3569 fr
.hard_timeout
= rule
->hard_timeout
;
3570 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
3573 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
3577 ofproto_rule_update_used(struct rule
*rule
, long long int used
)
3579 if (used
> rule
->used
) {
3580 struct eviction_group
*evg
= rule
->eviction_group
;
3584 heap_change(&evg
->rules
, &rule
->evg_node
,
3585 rule_eviction_priority(rule
));
3590 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3591 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3594 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3597 * ofproto implementation ->run() functions should use this function to expire
3598 * OpenFlow flows. */
3600 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
3602 struct ofproto
*ofproto
= rule
->ofproto
;
3603 struct ofopgroup
*group
;
3605 ovs_assert(reason
== OFPRR_HARD_TIMEOUT
|| reason
== OFPRR_IDLE_TIMEOUT
);
3607 ofproto_rule_send_removed(rule
, reason
);
3609 group
= ofopgroup_create_unattached(ofproto
);
3610 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, reason
);
3611 oftable_remove_rule(rule
);
3612 ofproto
->ofproto_class
->rule_destruct(rule
);
3613 ofopgroup_submit(group
);
3617 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3619 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3620 struct ofputil_flow_mod fm
;
3621 uint64_t ofpacts_stub
[1024 / 8];
3622 struct ofpbuf ofpacts
;
3626 error
= reject_slave_controller(ofconn
);
3631 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3632 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
3635 error
= ofpacts_check(fm
.ofpacts
, fm
.ofpacts_len
,
3636 &fm
.match
.flow
, ofproto
->max_ports
);
3639 error
= handle_flow_mod__(ofproto
, ofconn
, &fm
, oh
);
3642 goto exit_free_ofpacts
;
3645 /* Record the operation for logging a summary report. */
3646 switch (fm
.command
) {
3652 case OFPFC_MODIFY_STRICT
:
3653 ofproto
->n_modify
++;
3657 case OFPFC_DELETE_STRICT
:
3658 ofproto
->n_delete
++;
3663 if (ofproto
->next_op_report
== LLONG_MAX
) {
3664 ofproto
->first_op
= now
;
3665 ofproto
->next_op_report
= MAX(now
+ 10 * 1000,
3666 ofproto
->op_backoff
);
3667 ofproto
->op_backoff
= ofproto
->next_op_report
+ 60 * 1000;
3669 ofproto
->last_op
= now
;
3672 ofpbuf_uninit(&ofpacts
);
3678 handle_flow_mod__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3679 const struct ofputil_flow_mod
*fm
,
3680 const struct ofp_header
*oh
)
3682 if (ofproto
->n_pending
>= 50) {
3683 ovs_assert(!list_is_empty(&ofproto
->pending
));
3684 return OFPROTO_POSTPONE
;
3687 switch (fm
->command
) {
3689 return add_flow(ofproto
, ofconn
, fm
, oh
);
3692 return modify_flows_loose(ofproto
, ofconn
, fm
, oh
);
3694 case OFPFC_MODIFY_STRICT
:
3695 return modify_flow_strict(ofproto
, ofconn
, fm
, oh
);
3698 return delete_flows_loose(ofproto
, ofconn
, fm
, oh
);
3700 case OFPFC_DELETE_STRICT
:
3701 return delete_flow_strict(ofproto
, ofconn
, fm
, oh
);
3704 if (fm
->command
> 0xff) {
3705 VLOG_WARN_RL(&rl
, "%s: flow_mod has explicit table_id but "
3706 "flow_mod_table_id extension is not enabled",
3709 return OFPERR_OFPFMFC_BAD_COMMAND
;
3714 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3716 struct ofputil_role_request request
;
3717 struct ofputil_role_request reply
;
3721 error
= ofputil_decode_role_message(oh
, &request
);
3726 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
3727 if (ofconn_get_role(ofconn
) != request
.role
3728 && ofconn_has_pending_opgroups(ofconn
)) {
3729 return OFPROTO_POSTPONE
;
3732 if (request
.have_generation_id
3733 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
3734 return OFPERR_OFPRRFC_STALE
;
3737 ofconn_set_role(ofconn
, request
.role
);
3740 reply
.role
= ofconn_get_role(ofconn
);
3741 reply
.have_generation_id
= ofconn_get_master_election_id(
3742 ofconn
, &reply
.generation_id
);
3743 buf
= ofputil_encode_role_reply(oh
, &reply
);
3744 ofconn_send_reply(ofconn
, buf
);
3750 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
3751 const struct ofp_header
*oh
)
3753 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
3754 enum ofputil_protocol cur
, next
;
3756 cur
= ofconn_get_protocol(ofconn
);
3757 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
3758 ofconn_set_protocol(ofconn
, next
);
3764 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3766 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
3767 enum ofputil_protocol cur
, next
;
3768 enum ofputil_protocol next_base
;
3770 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
3772 return OFPERR_OFPBRC_EPERM
;
3775 cur
= ofconn_get_protocol(ofconn
);
3776 next
= ofputil_protocol_set_base(cur
, next_base
);
3777 if (cur
!= next
&& ofconn_has_pending_opgroups(ofconn
)) {
3778 /* Avoid sending async messages in surprising protocol. */
3779 return OFPROTO_POSTPONE
;
3782 ofconn_set_protocol(ofconn
, next
);
3787 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
3788 const struct ofp_header
*oh
)
3790 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
3793 format
= ntohl(msg
->format
);
3794 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
3795 return OFPERR_OFPBRC_EPERM
;
3798 if (format
!= ofconn_get_packet_in_format(ofconn
)
3799 && ofconn_has_pending_opgroups(ofconn
)) {
3800 /* Avoid sending async message in surprsing packet in format. */
3801 return OFPROTO_POSTPONE
;
3804 ofconn_set_packet_in_format(ofconn
, format
);
3809 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3811 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
3812 uint32_t master
[OAM_N_TYPES
];
3813 uint32_t slave
[OAM_N_TYPES
];
3815 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
3816 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
3817 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
3819 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
3820 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
3821 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
3823 ofconn_set_async_config(ofconn
, master
, slave
);
3824 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
3825 !ofconn_get_miss_send_len(ofconn
)) {
3826 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
3833 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
3834 const struct ofp_header
*oh
)
3836 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
3838 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
3839 return OFPERR_NXBRC_MUST_BE_ZERO
;
3842 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
3847 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3851 if (ofconn_has_pending_opgroups(ofconn
)) {
3852 return OFPROTO_POSTPONE
;
3855 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
3856 ? OFPRAW_OFPT10_BARRIER_REPLY
3857 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
3858 ofconn_send_reply(ofconn
, buf
);
3863 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
3864 enum nx_flow_monitor_flags flags
,
3867 struct ofoperation
*op
= rule
->pending
;
3868 struct ofputil_flow_update fu
;
3871 if (op
&& op
->type
== OFOPERATION_ADD
&& !op
->victim
) {
3872 /* We'll report the final flow when the operation completes. Reporting
3873 * it now would cause a duplicate report later. */
3877 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
3878 ? NXFME_ADDED
: NXFME_MODIFIED
);
3880 fu
.idle_timeout
= rule
->idle_timeout
;
3881 fu
.hard_timeout
= rule
->hard_timeout
;
3882 fu
.table_id
= rule
->table_id
;
3883 fu
.cookie
= rule
->flow_cookie
;
3884 minimatch_expand(&rule
->cr
.match
, &match
);
3886 fu
.priority
= rule
->cr
.priority
;
3887 if (!(flags
& NXFMF_ACTIONS
)) {
3891 fu
.ofpacts
= rule
->ofpacts
;
3892 fu
.ofpacts_len
= rule
->ofpacts_len
;
3894 /* An operation is in progress. Use the previous version of the flow's
3895 * actions, so that when the operation commits we report the change. */
3897 case OFOPERATION_ADD
:
3898 /* We already verified that there was a victim. */
3899 fu
.ofpacts
= op
->victim
->ofpacts
;
3900 fu
.ofpacts_len
= op
->victim
->ofpacts_len
;
3903 case OFOPERATION_MODIFY
:
3905 fu
.ofpacts
= op
->ofpacts
;
3906 fu
.ofpacts_len
= op
->ofpacts_len
;
3908 fu
.ofpacts
= rule
->ofpacts
;
3909 fu
.ofpacts_len
= rule
->ofpacts_len
;
3913 case OFOPERATION_DELETE
:
3914 fu
.ofpacts
= rule
->ofpacts
;
3915 fu
.ofpacts_len
= rule
->ofpacts_len
;
3923 if (list_is_empty(msgs
)) {
3924 ofputil_start_flow_update(msgs
);
3926 ofputil_append_flow_update(&fu
, msgs
);
3930 ofmonitor_compose_refresh_updates(struct list
*rules
, struct list
*msgs
)
3934 LIST_FOR_EACH (rule
, ofproto_node
, rules
) {
3935 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
3936 rule
->monitor_flags
= 0;
3938 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
3943 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
3944 struct rule
*rule
, uint64_t seqno
,
3947 enum nx_flow_monitor_flags update
;
3949 if (ofproto_rule_is_hidden(rule
)) {
3954 ? ofoperation_has_out_port(rule
->pending
, m
->out_port
)
3955 : ofproto_rule_has_out_port(rule
, m
->out_port
))) {
3960 if (rule
->add_seqno
> seqno
) {
3961 update
= NXFMF_ADD
| NXFMF_MODIFY
;
3962 } else if (rule
->modify_seqno
> seqno
) {
3963 update
= NXFMF_MODIFY
;
3968 if (!(m
->flags
& update
)) {
3972 update
= NXFMF_INITIAL
;
3975 if (!rule
->monitor_flags
) {
3976 list_push_back(rules
, &rule
->ofproto_node
);
3978 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
3982 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
3986 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
3987 const struct ofoperation
*op
;
3988 const struct oftable
*table
;
3989 struct cls_rule target
;
3991 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
3992 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
3993 struct cls_cursor cursor
;
3996 cls_cursor_init(&cursor
, &table
->cls
, &target
);
3997 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
3998 ovs_assert(!rule
->pending
); /* XXX */
3999 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4003 HMAP_FOR_EACH (op
, hmap_node
, &ofproto
->deletions
) {
4004 struct rule
*rule
= op
->rule
;
4006 if (((m
->table_id
== 0xff
4007 ? !(ofproto
->tables
[rule
->table_id
].flags
& OFTABLE_HIDDEN
)
4008 : m
->table_id
== rule
->table_id
))
4009 && cls_rule_is_loose_match(&rule
->cr
, &target
.match
)) {
4010 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4013 cls_rule_destroy(&target
);
4017 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
4020 if (m
->flags
& NXFMF_INITIAL
) {
4021 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
4026 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
4027 uint64_t seqno
, struct list
*rules
)
4029 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
4033 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4035 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4036 struct ofmonitor
**monitors
;
4037 size_t n_monitors
, allocated_monitors
;
4038 struct list replies
;
4045 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4047 n_monitors
= allocated_monitors
= 0;
4049 struct ofputil_flow_monitor_request request
;
4050 struct ofmonitor
*m
;
4053 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
4054 if (retval
== EOF
) {
4056 } else if (retval
) {
4061 if (request
.table_id
!= 0xff
4062 && request
.table_id
>= ofproto
->n_tables
) {
4063 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4067 error
= ofmonitor_create(&request
, ofconn
, &m
);
4072 if (n_monitors
>= allocated_monitors
) {
4073 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
4076 monitors
[n_monitors
++] = m
;
4080 for (i
= 0; i
< n_monitors
; i
++) {
4081 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
4084 ofpmp_init(&replies
, oh
);
4085 ofmonitor_compose_refresh_updates(&rules
, &replies
);
4086 ofconn_send_replies(ofconn
, &replies
);
4093 for (i
= 0; i
< n_monitors
; i
++) {
4094 ofmonitor_destroy(monitors
[i
]);
4101 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4103 struct ofmonitor
*m
;
4106 id
= ofputil_decode_flow_monitor_cancel(oh
);
4107 m
= ofmonitor_lookup(ofconn
, id
);
4109 return OFPERR_NXBRC_FM_BAD_ID
;
4112 ofmonitor_destroy(m
);
4117 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
4119 const struct ofp_header
*oh
= msg
->data
;
4123 error
= ofptype_decode(&type
, oh
);
4129 /* OpenFlow requests. */
4130 case OFPTYPE_ECHO_REQUEST
:
4131 return handle_echo_request(ofconn
, oh
);
4133 case OFPTYPE_FEATURES_REQUEST
:
4134 return handle_features_request(ofconn
, oh
);
4136 case OFPTYPE_GET_CONFIG_REQUEST
:
4137 return handle_get_config_request(ofconn
, oh
);
4139 case OFPTYPE_SET_CONFIG
:
4140 return handle_set_config(ofconn
, oh
);
4142 case OFPTYPE_PACKET_OUT
:
4143 return handle_packet_out(ofconn
, oh
);
4145 case OFPTYPE_PORT_MOD
:
4146 return handle_port_mod(ofconn
, oh
);
4148 case OFPTYPE_FLOW_MOD
:
4149 return handle_flow_mod(ofconn
, oh
);
4151 case OFPTYPE_BARRIER_REQUEST
:
4152 return handle_barrier_request(ofconn
, oh
);
4154 case OFPTYPE_ROLE_REQUEST
:
4155 return handle_role_request(ofconn
, oh
);
4157 /* OpenFlow replies. */
4158 case OFPTYPE_ECHO_REPLY
:
4161 /* Nicira extension requests. */
4162 case OFPTYPE_FLOW_MOD_TABLE_ID
:
4163 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
4165 case OFPTYPE_SET_FLOW_FORMAT
:
4166 return handle_nxt_set_flow_format(ofconn
, oh
);
4168 case OFPTYPE_SET_PACKET_IN_FORMAT
:
4169 return handle_nxt_set_packet_in_format(ofconn
, oh
);
4171 case OFPTYPE_SET_CONTROLLER_ID
:
4172 return handle_nxt_set_controller_id(ofconn
, oh
);
4174 case OFPTYPE_FLOW_AGE
:
4175 /* Nothing to do. */
4178 case OFPTYPE_FLOW_MONITOR_CANCEL
:
4179 return handle_flow_monitor_cancel(ofconn
, oh
);
4181 case OFPTYPE_SET_ASYNC_CONFIG
:
4182 return handle_nxt_set_async_config(ofconn
, oh
);
4184 /* Statistics requests. */
4185 case OFPTYPE_DESC_STATS_REQUEST
:
4186 return handle_desc_stats_request(ofconn
, oh
);
4188 case OFPTYPE_FLOW_STATS_REQUEST
:
4189 return handle_flow_stats_request(ofconn
, oh
);
4191 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
4192 return handle_aggregate_stats_request(ofconn
, oh
);
4194 case OFPTYPE_TABLE_STATS_REQUEST
:
4195 return handle_table_stats_request(ofconn
, oh
);
4197 case OFPTYPE_PORT_STATS_REQUEST
:
4198 return handle_port_stats_request(ofconn
, oh
);
4200 case OFPTYPE_QUEUE_STATS_REQUEST
:
4201 return handle_queue_stats_request(ofconn
, oh
);
4203 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
4204 return handle_port_desc_stats_request(ofconn
, oh
);
4206 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
4207 return handle_flow_monitor_request(ofconn
, oh
);
4209 /* FIXME: Change the following once they are implemented: */
4210 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
4211 case OFPTYPE_GET_ASYNC_REQUEST
:
4212 case OFPTYPE_METER_MOD
:
4213 case OFPTYPE_GROUP_REQUEST
:
4214 case OFPTYPE_GROUP_DESC_REQUEST
:
4215 case OFPTYPE_GROUP_FEATURES_REQUEST
:
4216 case OFPTYPE_METER_REQUEST
:
4217 case OFPTYPE_METER_CONFIG_REQUEST
:
4218 case OFPTYPE_METER_FEATURES_REQUEST
:
4219 case OFPTYPE_TABLE_FEATURES_REQUEST
:
4220 return OFPERR_OFPBRC_BAD_TYPE
;
4224 case OFPTYPE_FEATURES_REPLY
:
4225 case OFPTYPE_GET_CONFIG_REPLY
:
4226 case OFPTYPE_PACKET_IN
:
4227 case OFPTYPE_FLOW_REMOVED
:
4228 case OFPTYPE_PORT_STATUS
:
4229 case OFPTYPE_BARRIER_REPLY
:
4230 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
4231 case OFPTYPE_DESC_STATS_REPLY
:
4232 case OFPTYPE_FLOW_STATS_REPLY
:
4233 case OFPTYPE_QUEUE_STATS_REPLY
:
4234 case OFPTYPE_PORT_STATS_REPLY
:
4235 case OFPTYPE_TABLE_STATS_REPLY
:
4236 case OFPTYPE_AGGREGATE_STATS_REPLY
:
4237 case OFPTYPE_PORT_DESC_STATS_REPLY
:
4238 case OFPTYPE_ROLE_REPLY
:
4239 case OFPTYPE_FLOW_MONITOR_PAUSED
:
4240 case OFPTYPE_FLOW_MONITOR_RESUMED
:
4241 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
4242 case OFPTYPE_GET_ASYNC_REPLY
:
4243 case OFPTYPE_GROUP_REPLY
:
4244 case OFPTYPE_GROUP_DESC_REPLY
:
4245 case OFPTYPE_GROUP_FEATURES_REPLY
:
4246 case OFPTYPE_METER_REPLY
:
4247 case OFPTYPE_METER_CONFIG_REPLY
:
4248 case OFPTYPE_METER_FEATURES_REPLY
:
4249 case OFPTYPE_TABLE_FEATURES_REPLY
:
4251 return OFPERR_OFPBRC_BAD_TYPE
;
4256 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
4258 int error
= handle_openflow__(ofconn
, ofp_msg
);
4259 if (error
&& error
!= OFPROTO_POSTPONE
) {
4260 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
4262 COVERAGE_INC(ofproto_recv_openflow
);
4263 return error
!= OFPROTO_POSTPONE
;
4266 /* Asynchronous operations. */
4268 /* Creates and returns a new ofopgroup that is not associated with any
4269 * OpenFlow connection.
4271 * The caller should add operations to the returned group with
4272 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4273 static struct ofopgroup
*
4274 ofopgroup_create_unattached(struct ofproto
*ofproto
)
4276 struct ofopgroup
*group
= xzalloc(sizeof *group
);
4277 group
->ofproto
= ofproto
;
4278 list_init(&group
->ofproto_node
);
4279 list_init(&group
->ops
);
4280 list_init(&group
->ofconn_node
);
4284 /* Creates and returns a new ofopgroup for 'ofproto'.
4286 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
4287 * connection. The 'request' and 'buffer_id' arguments are ignored.
4289 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
4290 * If the ofopgroup eventually fails, then the error reply will include
4291 * 'request'. If the ofopgroup eventually succeeds, then the packet with
4292 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
4294 * The caller should add operations to the returned group with
4295 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4296 static struct ofopgroup
*
4297 ofopgroup_create(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4298 const struct ofp_header
*request
, uint32_t buffer_id
)
4300 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
4302 size_t request_len
= ntohs(request
->length
);
4304 ovs_assert(ofconn_get_ofproto(ofconn
) == ofproto
);
4306 ofconn_add_opgroup(ofconn
, &group
->ofconn_node
);
4307 group
->ofconn
= ofconn
;
4308 group
->request
= xmemdup(request
, MIN(request_len
, 64));
4309 group
->buffer_id
= buffer_id
;
4314 /* Submits 'group' for processing.
4316 * If 'group' contains no operations (e.g. none were ever added, or all of the
4317 * ones that were added completed synchronously), then it is destroyed
4318 * immediately. Otherwise it is added to the ofproto's list of pending
4321 ofopgroup_submit(struct ofopgroup
*group
)
4323 if (!group
->n_running
) {
4324 ofopgroup_complete(group
);
4326 list_push_back(&group
->ofproto
->pending
, &group
->ofproto_node
);
4327 group
->ofproto
->n_pending
++;
4332 ofopgroup_complete(struct ofopgroup
*group
)
4334 struct ofproto
*ofproto
= group
->ofproto
;
4336 struct ofconn
*abbrev_ofconn
;
4337 ovs_be32 abbrev_xid
;
4339 struct ofoperation
*op
, *next_op
;
4342 ovs_assert(!group
->n_running
);
4345 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
4352 if (!error
&& group
->ofconn
&& group
->buffer_id
!= UINT32_MAX
) {
4353 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
4354 if (op
->type
!= OFOPERATION_DELETE
) {
4355 struct ofpbuf
*packet
;
4358 error
= ofconn_pktbuf_retrieve(group
->ofconn
, group
->buffer_id
,
4362 error
= rule_execute(op
->rule
, in_port
, packet
);
4369 if (!error
&& !list_is_empty(&group
->ofconn_node
)) {
4370 abbrev_ofconn
= group
->ofconn
;
4371 abbrev_xid
= group
->request
->xid
;
4373 abbrev_ofconn
= NULL
;
4374 abbrev_xid
= htonl(0);
4376 LIST_FOR_EACH_SAFE (op
, next_op
, group_node
, &group
->ops
) {
4377 struct rule
*rule
= op
->rule
;
4379 /* We generally want to report the change to active OpenFlow flow
4380 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
4382 - The operation failed.
4384 - The affected rule is not visible to controllers.
4386 - The operation's only effect was to update rule->modified. */
4388 || ofproto_rule_is_hidden(rule
)
4389 || (op
->type
== OFOPERATION_MODIFY
4391 && rule
->flow_cookie
== op
->flow_cookie
))) {
4392 /* Check that we can just cast from ofoperation_type to
4393 * nx_flow_update_event. */
4394 BUILD_ASSERT_DECL((enum nx_flow_update_event
) OFOPERATION_ADD
4396 BUILD_ASSERT_DECL((enum nx_flow_update_event
) OFOPERATION_DELETE
4398 BUILD_ASSERT_DECL((enum nx_flow_update_event
) OFOPERATION_MODIFY
4401 ofmonitor_report(ofproto
->connmgr
, rule
,
4402 (enum nx_flow_update_event
) op
->type
,
4403 op
->reason
, abbrev_ofconn
, abbrev_xid
);
4406 rule
->pending
= NULL
;
4409 case OFOPERATION_ADD
:
4413 ofproto_rule_destroy__(op
->victim
);
4414 vid_mask
= minimask_get_vid_mask(&rule
->cr
.match
.mask
);
4415 if (vid_mask
== VLAN_VID_MASK
) {
4416 if (ofproto
->vlan_bitmap
) {
4417 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
4418 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
4419 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
4420 ofproto
->vlans_changed
= true;
4423 ofproto
->vlans_changed
= true;
4427 oftable_substitute_rule(rule
, op
->victim
);
4428 ofproto_rule_destroy__(rule
);
4432 case OFOPERATION_DELETE
:
4433 ovs_assert(!op
->error
);
4434 ofproto_rule_destroy__(rule
);
4438 case OFOPERATION_MODIFY
:
4440 rule
->modified
= time_msec();
4442 ofproto_rule_change_cookie(ofproto
, rule
, op
->flow_cookie
);
4444 free(rule
->ofpacts
);
4445 rule
->ofpacts
= op
->ofpacts
;
4446 rule
->ofpacts_len
= op
->ofpacts_len
;
4448 op
->ofpacts_len
= 0;
4457 ofoperation_destroy(op
);
4460 ofmonitor_flush(ofproto
->connmgr
);
4462 if (!list_is_empty(&group
->ofproto_node
)) {
4463 ovs_assert(ofproto
->n_pending
> 0);
4464 ofproto
->n_pending
--;
4465 list_remove(&group
->ofproto_node
);
4467 if (!list_is_empty(&group
->ofconn_node
)) {
4468 list_remove(&group
->ofconn_node
);
4470 ofconn_send_error(group
->ofconn
, group
->request
, error
);
4472 connmgr_retry(ofproto
->connmgr
);
4474 free(group
->request
);
4478 /* Initiates a new operation on 'rule', of the specified 'type', within
4479 * 'group'. Prior to calling, 'rule' must not have any pending operation.
4481 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4482 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
4484 * Returns the newly created ofoperation (which is also available as
4485 * rule->pending). */
4486 static struct ofoperation
*
4487 ofoperation_create(struct ofopgroup
*group
, struct rule
*rule
,
4488 enum ofoperation_type type
,
4489 enum ofp_flow_removed_reason reason
)
4491 struct ofproto
*ofproto
= group
->ofproto
;
4492 struct ofoperation
*op
;
4494 ovs_assert(!rule
->pending
);
4496 op
= rule
->pending
= xzalloc(sizeof *op
);
4498 list_push_back(&group
->ops
, &op
->group_node
);
4501 op
->reason
= reason
;
4502 op
->flow_cookie
= rule
->flow_cookie
;
4506 if (type
== OFOPERATION_DELETE
) {
4507 hmap_insert(&ofproto
->deletions
, &op
->hmap_node
,
4508 cls_rule_hash(&rule
->cr
, rule
->table_id
));
4515 ofoperation_destroy(struct ofoperation
*op
)
4517 struct ofopgroup
*group
= op
->group
;
4520 op
->rule
->pending
= NULL
;
4522 if (op
->type
== OFOPERATION_DELETE
) {
4523 hmap_remove(&group
->ofproto
->deletions
, &op
->hmap_node
);
4525 list_remove(&op
->group_node
);
4530 /* Indicates that 'op' completed with status 'error', which is either 0 to
4531 * indicate success or an OpenFlow error code on failure.
4533 * If 'error' is 0, indicating success, the operation will be committed
4534 * permanently to the flow table. There is one interesting subcase:
4536 * - If 'op' is an "add flow" operation that is replacing an existing rule in
4537 * the flow table (the "victim" rule) by a new one, then the caller must
4538 * have uninitialized any derived state in the victim rule, as in step 5 in
4539 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
4540 * performs steps 6 and 7 for the victim rule, most notably by calling its
4541 * ->rule_dealloc() function.
4543 * If 'error' is nonzero, then generally the operation will be rolled back:
4545 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
4546 * restores the original rule. The caller must have uninitialized any
4547 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
4548 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
4549 * and 7 for the new rule, calling its ->rule_dealloc() function.
4551 * - If 'op' is a "modify flow" operation, ofproto restores the original
4554 * - 'op' must not be a "delete flow" operation. Removing a rule is not
4555 * allowed to fail. It must always succeed.
4557 * Please see the large comment in ofproto/ofproto-provider.h titled
4558 * "Asynchronous Operation Support" for more information. */
4560 ofoperation_complete(struct ofoperation
*op
, enum ofperr error
)
4562 struct ofopgroup
*group
= op
->group
;
4564 ovs_assert(op
->rule
->pending
== op
);
4565 ovs_assert(group
->n_running
> 0);
4566 ovs_assert(!error
|| op
->type
!= OFOPERATION_DELETE
);
4569 if (!--group
->n_running
&& !list_is_empty(&group
->ofproto_node
)) {
4570 ofopgroup_complete(group
);
4575 ofoperation_get_victim(struct ofoperation
*op
)
4577 ovs_assert(op
->type
== OFOPERATION_ADD
);
4582 pick_datapath_id(const struct ofproto
*ofproto
)
4584 const struct ofport
*port
;
4586 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
4588 uint8_t ea
[ETH_ADDR_LEN
];
4591 error
= netdev_get_etheraddr(port
->netdev
, ea
);
4593 return eth_addr_to_uint64(ea
);
4595 VLOG_WARN("%s: could not get MAC address for %s (%s)",
4596 ofproto
->name
, netdev_get_name(port
->netdev
),
4599 return ofproto
->fallback_dpid
;
4603 pick_fallback_dpid(void)
4605 uint8_t ea
[ETH_ADDR_LEN
];
4606 eth_addr_nicira_random(ea
);
4607 return eth_addr_to_uint64(ea
);
4610 /* Table overflow policy. */
4612 /* Chooses and returns a rule to evict from 'table'. Returns NULL if the table
4613 * is not configured to evict rules or if the table contains no evictable
4614 * rules. (Rules with 'evictable' set to false or with no timeouts are not
4616 static struct rule
*
4617 choose_rule_to_evict(struct oftable
*table
)
4619 struct eviction_group
*evg
;
4621 if (!table
->eviction_fields
) {
4625 /* In the common case, the outer and inner loops here will each be entered
4628 * - The inner loop normally "return"s in its first iteration. If the
4629 * eviction group has any evictable rules, then it always returns in
4632 * - The outer loop only iterates more than once if the largest eviction
4633 * group has no evictable rules.
4635 * - The outer loop can exit only if table's 'max_flows' is all filled up
4636 * by unevictable rules'. */
4637 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
4640 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
4641 if (rule
->evictable
) {
4650 /* Searches 'ofproto' for tables that have more flows than their configured
4651 * maximum and that have flow eviction enabled, and evicts as many flows as
4652 * necessary and currently feasible from them.
4654 * This triggers only when an OpenFlow table has N flows in it and then the
4655 * client configures a maximum number of flows less than N. */
4657 ofproto_evict(struct ofproto
*ofproto
)
4659 struct ofopgroup
*group
;
4660 struct oftable
*table
;
4662 group
= ofopgroup_create_unattached(ofproto
);
4663 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
4664 while (classifier_count(&table
->cls
) > table
->max_flows
4665 && table
->eviction_fields
) {
4668 rule
= choose_rule_to_evict(table
);
4669 if (!rule
|| rule
->pending
) {
4673 ofoperation_create(group
, rule
,
4674 OFOPERATION_DELETE
, OFPRR_EVICTION
);
4675 oftable_remove_rule(rule
);
4676 ofproto
->ofproto_class
->rule_destruct(rule
);
4679 ofopgroup_submit(group
);
4682 /* Eviction groups. */
4684 /* Returns the priority to use for an eviction_group that contains 'n_rules'
4685 * rules. The priority contains low-order random bits to ensure that eviction
4686 * groups with the same number of rules are prioritized randomly. */
4688 eviction_group_priority(size_t n_rules
)
4690 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
4691 return (size
<< 16) | random_uint16();
4694 /* Updates 'evg', an eviction_group within 'table', following a change that
4695 * adds or removes rules in 'evg'. */
4697 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
4699 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
4700 eviction_group_priority(heap_count(&evg
->rules
)));
4703 /* Destroys 'evg', an eviction_group within 'table':
4705 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
4706 * rules themselves, just removes them from the eviction group.)
4708 * - Removes 'evg' from 'table'.
4712 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
4714 while (!heap_is_empty(&evg
->rules
)) {
4717 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
4718 rule
->eviction_group
= NULL
;
4720 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
4721 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
4722 heap_destroy(&evg
->rules
);
4726 /* Removes 'rule' from its eviction group, if any. */
4728 eviction_group_remove_rule(struct rule
*rule
)
4730 if (rule
->eviction_group
) {
4731 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
4732 struct eviction_group
*evg
= rule
->eviction_group
;
4734 rule
->eviction_group
= NULL
;
4735 heap_remove(&evg
->rules
, &rule
->evg_node
);
4736 if (heap_is_empty(&evg
->rules
)) {
4737 eviction_group_destroy(table
, evg
);
4739 eviction_group_resized(table
, evg
);
4744 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
4745 * returns the hash value. */
4747 eviction_group_hash_rule(struct rule
*rule
)
4749 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
4750 const struct mf_subfield
*sf
;
4754 hash
= table
->eviction_group_id_basis
;
4755 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
4756 for (sf
= table
->eviction_fields
;
4757 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
4760 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
4761 union mf_value value
;
4763 mf_get_value(sf
->field
, &flow
, &value
);
4765 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
4767 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
4768 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
4769 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
4770 sf
->field
->n_bytes
* 8 - start
);
4772 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
4774 hash
= hash_int(hash
, 0);
4781 /* Returns an eviction group within 'table' with the given 'id', creating one
4783 static struct eviction_group
*
4784 eviction_group_find(struct oftable
*table
, uint32_t id
)
4786 struct eviction_group
*evg
;
4788 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
4792 evg
= xmalloc(sizeof *evg
);
4793 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
4794 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
4795 eviction_group_priority(0));
4796 heap_init(&evg
->rules
);
4801 /* Returns an eviction priority for 'rule'. The return value should be
4802 * interpreted so that higher priorities make a rule more attractive candidates
4805 rule_eviction_priority(struct rule
*rule
)
4807 long long int hard_expiration
;
4808 long long int idle_expiration
;
4809 long long int expiration
;
4810 uint32_t expiration_offset
;
4812 /* Calculate time of expiration. */
4813 hard_expiration
= (rule
->hard_timeout
4814 ? rule
->modified
+ rule
->hard_timeout
* 1000
4816 idle_expiration
= (rule
->idle_timeout
4817 ? rule
->used
+ rule
->idle_timeout
* 1000
4819 expiration
= MIN(hard_expiration
, idle_expiration
);
4820 if (expiration
== LLONG_MAX
) {
4824 /* Calculate the time of expiration as a number of (approximate) seconds
4825 * after program startup.
4827 * This should work OK for program runs that last UINT32_MAX seconds or
4828 * less. Therefore, please restart OVS at least once every 136 years. */
4829 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
4831 /* Invert the expiration offset because we're using a max-heap. */
4832 return UINT32_MAX
- expiration_offset
;
4835 /* Adds 'rule' to an appropriate eviction group for its oftable's
4836 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
4837 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
4840 * The caller must ensure that 'rule' is not already in an eviction group. */
4842 eviction_group_add_rule(struct rule
*rule
)
4844 struct ofproto
*ofproto
= rule
->ofproto
;
4845 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
4847 if (table
->eviction_fields
4848 && (rule
->hard_timeout
|| rule
->idle_timeout
)) {
4849 struct eviction_group
*evg
;
4851 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
4853 rule
->eviction_group
= evg
;
4854 heap_insert(&evg
->rules
, &rule
->evg_node
,
4855 rule_eviction_priority(rule
));
4856 eviction_group_resized(table
, evg
);
4862 /* Initializes 'table'. */
4864 oftable_init(struct oftable
*table
)
4866 memset(table
, 0, sizeof *table
);
4867 classifier_init(&table
->cls
);
4868 table
->max_flows
= UINT_MAX
;
4871 /* Destroys 'table', including its classifier and eviction groups.
4873 * The caller is responsible for freeing 'table' itself. */
4875 oftable_destroy(struct oftable
*table
)
4877 ovs_assert(classifier_is_empty(&table
->cls
));
4878 oftable_disable_eviction(table
);
4879 classifier_destroy(&table
->cls
);
4883 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
4884 * string, then 'table' will use its default name.
4886 * This only affects the name exposed for a table exposed through the OpenFlow
4887 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
4889 oftable_set_name(struct oftable
*table
, const char *name
)
4891 if (name
&& name
[0]) {
4892 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
4893 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
4895 table
->name
= xmemdup0(name
, len
);
4903 /* oftables support a choice of two policies when adding a rule would cause the
4904 * number of flows in the table to exceed the configured maximum number: either
4905 * they can refuse to add the new flow or they can evict some existing flow.
4906 * This function configures the former policy on 'table'. */
4908 oftable_disable_eviction(struct oftable
*table
)
4910 if (table
->eviction_fields
) {
4911 struct eviction_group
*evg
, *next
;
4913 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
4914 &table
->eviction_groups_by_id
) {
4915 eviction_group_destroy(table
, evg
);
4917 hmap_destroy(&table
->eviction_groups_by_id
);
4918 heap_destroy(&table
->eviction_groups_by_size
);
4920 free(table
->eviction_fields
);
4921 table
->eviction_fields
= NULL
;
4922 table
->n_eviction_fields
= 0;
4926 /* oftables support a choice of two policies when adding a rule would cause the
4927 * number of flows in the table to exceed the configured maximum number: either
4928 * they can refuse to add the new flow or they can evict some existing flow.
4929 * This function configures the latter policy on 'table', with fairness based
4930 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
4931 * 'n_fields' as 0 disables fairness.) */
4933 oftable_enable_eviction(struct oftable
*table
,
4934 const struct mf_subfield
*fields
, size_t n_fields
)
4936 struct cls_cursor cursor
;
4939 if (table
->eviction_fields
4940 && n_fields
== table
->n_eviction_fields
4942 || !memcmp(fields
, table
->eviction_fields
,
4943 n_fields
* sizeof *fields
))) {
4948 oftable_disable_eviction(table
);
4950 table
->n_eviction_fields
= n_fields
;
4951 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
4953 table
->eviction_group_id_basis
= random_uint32();
4954 hmap_init(&table
->eviction_groups_by_id
);
4955 heap_init(&table
->eviction_groups_by_size
);
4957 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
4958 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
4959 eviction_group_add_rule(rule
);
4963 /* Removes 'rule' from the oftable that contains it. */
4965 oftable_remove_rule(struct rule
*rule
)
4967 struct ofproto
*ofproto
= rule
->ofproto
;
4968 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
4970 classifier_remove(&table
->cls
, &rule
->cr
);
4971 cookies_remove(ofproto
, rule
);
4972 eviction_group_remove_rule(rule
);
4973 if (!list_is_empty(&rule
->expirable
)) {
4974 list_remove(&rule
->expirable
);
4978 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
4979 * oftable that has an identical cls_rule. Returns the rule that was removed,
4980 * if any, and otherwise NULL. */
4981 static struct rule
*
4982 oftable_replace_rule(struct rule
*rule
)
4984 struct ofproto
*ofproto
= rule
->ofproto
;
4985 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
4986 struct rule
*victim
;
4987 bool may_expire
= rule
->hard_timeout
|| rule
->idle_timeout
;
4990 list_insert(&ofproto
->expirable
, &rule
->expirable
);
4992 cookies_insert(ofproto
, rule
);
4994 victim
= rule_from_cls_rule(classifier_replace(&table
->cls
, &rule
->cr
));
4996 cookies_remove(ofproto
, victim
);
4998 if (!list_is_empty(&victim
->expirable
)) {
4999 list_remove(&victim
->expirable
);
5001 eviction_group_remove_rule(victim
);
5003 eviction_group_add_rule(rule
);
5007 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
5009 oftable_substitute_rule(struct rule
*old
, struct rule
*new)
5012 oftable_replace_rule(new);
5014 oftable_remove_rule(old
);
5018 /* unixctl commands. */
5021 ofproto_lookup(const char *name
)
5023 struct ofproto
*ofproto
;
5025 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
5027 if (!strcmp(ofproto
->name
, name
)) {
5035 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
5036 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
5038 struct ofproto
*ofproto
;
5042 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
5043 ds_put_format(&results
, "%s\n", ofproto
->name
);
5045 unixctl_command_reply(conn
, ds_cstr(&results
));
5046 ds_destroy(&results
);
5050 ofproto_unixctl_init(void)
5052 static bool registered
;
5058 unixctl_command_register("ofproto/list", "", 0, 0,
5059 ofproto_unixctl_list
, NULL
);
5062 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
5064 * This is deprecated. It is only for compatibility with broken device drivers
5065 * in old versions of Linux that do not properly support VLANs when VLAN
5066 * devices are not used. When broken device drivers are no longer in
5067 * widespread use, we will delete these interfaces. */
5069 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
5070 * (exactly) by an OpenFlow rule in 'ofproto'. */
5072 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
5074 const struct oftable
*oftable
;
5076 free(ofproto
->vlan_bitmap
);
5077 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
5078 ofproto
->vlans_changed
= false;
5080 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
5081 const struct cls_table
*table
;
5083 HMAP_FOR_EACH (table
, hmap_node
, &oftable
->cls
.tables
) {
5084 if (minimask_get_vid_mask(&table
->mask
) == VLAN_VID_MASK
) {
5085 const struct cls_rule
*rule
;
5087 HMAP_FOR_EACH (rule
, hmap_node
, &table
->rules
) {
5088 uint16_t vid
= miniflow_get_vid(&rule
->match
.flow
);
5089 bitmap_set1(vlan_bitmap
, vid
);
5090 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
5097 /* Returns true if new VLANs have come into use by the flow table since the
5098 * last call to ofproto_get_vlan_usage().
5100 * We don't track when old VLANs stop being used. */
5102 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
5104 return ofproto
->vlans_changed
;
5107 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
5108 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
5109 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
5110 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
5111 * then the VLAN device is un-enslaved. */
5113 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
5114 ofp_port_t realdev_ofp_port
, int vid
)
5116 struct ofport
*ofport
;
5119 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
5121 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
5123 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
5124 ofproto
->name
, vlandev_ofp_port
);
5128 if (!ofproto
->ofproto_class
->set_realdev
) {
5129 if (!vlandev_ofp_port
) {
5132 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
5136 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
5138 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
5139 ofproto
->name
, vlandev_ofp_port
,
5140 netdev_get_name(ofport
->netdev
), strerror(error
));