2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
49 #include "poll-loop.h"
57 #include "unaligned.h"
61 VLOG_DEFINE_THIS_MODULE(ofproto
);
63 COVERAGE_DEFINE(ofproto_flush
);
64 COVERAGE_DEFINE(ofproto_packet_out
);
65 COVERAGE_DEFINE(ofproto_queue_req
);
66 COVERAGE_DEFINE(ofproto_recv_openflow
);
67 COVERAGE_DEFINE(ofproto_reinit_ports
);
68 COVERAGE_DEFINE(ofproto_update_port
);
71 S_OPENFLOW
, /* Processing OpenFlow commands. */
72 S_EVICT
, /* Evicting flows from over-limit tables. */
73 S_FLUSH
, /* Deleting all flow table rules. */
76 enum ofoperation_type
{
83 /* A single OpenFlow request can execute any number of operations. The
84 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
85 * ofconn to which an error reply should be sent if necessary.
87 * ofproto initiates some operations internally. These operations are still
88 * assigned to groups but will not have an associated ofconn. */
90 struct ofproto
*ofproto
; /* Owning ofproto. */
91 struct list ofproto_node
; /* In ofproto's "pending" list. */
92 struct list ops
; /* List of "struct ofoperation"s. */
93 int n_running
; /* Number of ops still pending. */
95 /* Data needed to send OpenFlow reply on failure or to send a buffered
98 * If list_is_empty(ofconn_node) then this ofopgroup never had an
99 * associated ofconn or its ofconn's connection dropped after it initiated
100 * the operation. In the latter case 'ofconn' is a wild pointer that
101 * refers to freed memory, so the 'ofconn' member must be used only if
102 * !list_is_empty(ofconn_node).
104 struct list ofconn_node
; /* In ofconn's list of pending opgroups. */
105 struct ofconn
*ofconn
; /* ofconn for reply (but see note above). */
106 struct ofp_header
*request
; /* Original request (truncated at 64 bytes). */
107 uint32_t buffer_id
; /* Buffer id from original request. */
110 static struct ofopgroup
*ofopgroup_create_unattached(struct ofproto
*);
111 static struct ofopgroup
*ofopgroup_create(struct ofproto
*, struct ofconn
*,
112 const struct ofp_header
*,
114 static void ofopgroup_submit(struct ofopgroup
*);
115 static void ofopgroup_complete(struct ofopgroup
*);
117 /* A single flow table operation. */
119 struct ofopgroup
*group
; /* Owning group. */
120 struct list group_node
; /* In ofopgroup's "ops" list. */
121 struct hmap_node hmap_node
; /* In ofproto's "deletions" hmap. */
122 struct rule
*rule
; /* Rule being operated upon. */
123 enum ofoperation_type type
; /* Type of operation. */
125 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
127 struct rule_actions
*actions
;
129 /* OFOPERATION_DELETE. */
130 enum ofp_flow_removed_reason reason
; /* Reason flow was removed. */
132 ovs_be64 flow_cookie
; /* Rule's old flow cookie. */
133 uint16_t idle_timeout
; /* Rule's old idle timeout. */
134 uint16_t hard_timeout
; /* Rule's old hard timeout. */
135 enum ofputil_flow_mod_flags flags
; /* Rule's old flags. */
136 enum ofperr error
; /* 0 if no error. */
139 static struct ofoperation
*ofoperation_create(struct ofopgroup
*,
141 enum ofoperation_type
,
142 enum ofp_flow_removed_reason
);
143 static void ofoperation_destroy(struct ofoperation
*);
146 static void oftable_init(struct oftable
*);
147 static void oftable_destroy(struct oftable
*);
149 static void oftable_set_name(struct oftable
*, const char *name
);
151 static void oftable_disable_eviction(struct oftable
*);
152 static void oftable_enable_eviction(struct oftable
*,
153 const struct mf_subfield
*fields
,
156 static void oftable_remove_rule(struct rule
*rule
) OVS_REQUIRES(ofproto_mutex
);
157 static void oftable_remove_rule__(struct ofproto
*, struct rule
*)
158 OVS_REQUIRES(ofproto_mutex
);
159 static void oftable_insert_rule(struct rule
*);
161 /* A set of rules within a single OpenFlow table (oftable) that have the same
162 * values for the oftable's eviction_fields. A rule to be evicted, when one is
163 * needed, is taken from the eviction group that contains the greatest number
166 * An oftable owns any number of eviction groups, each of which contains any
169 * Membership in an eviction group is imprecise, based on the hash of the
170 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
171 * That is, if two rules have different eviction_fields, but those
172 * eviction_fields hash to the same value, then they will belong to the same
173 * eviction_group anyway.
175 * (When eviction is not enabled on an oftable, we don't track any eviction
176 * groups, to save time and space.) */
177 struct eviction_group
{
178 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
179 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
180 struct heap rules
; /* Contains "struct rule"s. */
183 static bool choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
);
184 static void ofproto_evict(struct ofproto
*) OVS_EXCLUDED(ofproto_mutex
);
185 static uint32_t rule_eviction_priority(struct rule
*);
186 static void eviction_group_add_rule(struct rule
*);
187 static void eviction_group_remove_rule(struct rule
*);
189 /* Criteria that flow_mod and other operations use for selecting rules on
190 * which to operate. */
191 struct rule_criteria
{
192 /* An OpenFlow table or 255 for all tables. */
195 /* OpenFlow matching criteria. Interpreted different in "loose" way by
196 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
197 * defined in the OpenFlow spec. */
200 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
201 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
202 * The rule will not be selected if M is 1 and B != C. */
204 ovs_be64 cookie_mask
;
206 /* Selection based on actions within a rule:
208 * If out_port != OFPP_ANY, selects only rules that output to out_port.
209 * If out_group != OFPG_ALL, select only rules that output to out_group. */
214 static void rule_criteria_init(struct rule_criteria
*, uint8_t table_id
,
215 const struct match
*match
,
216 unsigned int priority
,
217 ovs_be64 cookie
, ovs_be64 cookie_mask
,
218 ofp_port_t out_port
, uint32_t out_group
);
219 static void rule_criteria_destroy(struct rule_criteria
*);
221 /* A packet that needs to be passed to rule_execute().
223 * (We can't do this immediately from ofopgroup_complete() because that holds
224 * ofproto_mutex, which rule_execute() needs released.) */
225 struct rule_execute
{
226 struct list list_node
; /* In struct ofproto's "rule_executes" list. */
227 struct rule
*rule
; /* Owns a reference to the rule. */
229 struct ofpbuf
*packet
; /* Owns the packet. */
232 static void run_rule_executes(struct ofproto
*) OVS_EXCLUDED(ofproto_mutex
);
233 static void destroy_rule_executes(struct ofproto
*);
236 static void ofport_destroy__(struct ofport
*) OVS_EXCLUDED(ofproto_mutex
);
237 static void ofport_destroy(struct ofport
*);
239 static void update_port(struct ofproto
*, const char *devname
);
240 static int init_ports(struct ofproto
*);
241 static void reinit_ports(struct ofproto
*);
243 static long long int ofport_get_usage(const struct ofproto
*,
244 ofp_port_t ofp_port
);
245 static void ofport_set_usage(struct ofproto
*, ofp_port_t ofp_port
,
246 long long int last_used
);
247 static void ofport_remove_usage(struct ofproto
*, ofp_port_t ofp_port
);
251 * Keeps track of the currently used and recently used ofport values and is
252 * used to prevent immediate recycling of ofport values. */
253 struct ofport_usage
{
254 struct hmap_node hmap_node
; /* In struct ofproto's "ofport_usage" hmap. */
255 ofp_port_t ofp_port
; /* OpenFlow port number. */
256 long long int last_used
; /* Last time the 'ofp_port' was used. LLONG_MAX
257 represents in-use ofports. */
261 static void ofproto_rule_destroy__(struct rule
*);
262 static void ofproto_rule_send_removed(struct rule
*, uint8_t reason
);
263 static bool rule_is_modifiable(const struct rule
*);
266 static enum ofperr
add_flow(struct ofproto
*, struct ofconn
*,
267 struct ofputil_flow_mod
*,
268 const struct ofp_header
*);
269 static enum ofperr
modify_flows__(struct ofproto
*, struct ofconn
*,
270 struct ofputil_flow_mod
*,
271 const struct ofp_header
*,
272 const struct rule_collection
*);
273 static void delete_flow__(struct rule
*rule
, struct ofopgroup
*,
274 enum ofp_flow_removed_reason
)
275 OVS_REQUIRES(ofproto_mutex
);
276 static bool ofproto_group_exists__(const struct ofproto
*ofproto
,
278 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
);
279 static bool ofproto_group_exists(const struct ofproto
*ofproto
,
281 OVS_EXCLUDED(ofproto
->groups_rwlock
);
282 static enum ofperr
add_group(struct ofproto
*, struct ofputil_group_mod
*);
283 static bool handle_openflow(struct ofconn
*, const struct ofpbuf
*);
284 static enum ofperr
handle_flow_mod__(struct ofproto
*, struct ofconn
*,
285 struct ofputil_flow_mod
*,
286 const struct ofp_header
*)
287 OVS_EXCLUDED(ofproto_mutex
);
288 static void calc_duration(long long int start
, long long int now
,
289 uint32_t *sec
, uint32_t *nsec
);
292 static uint64_t pick_datapath_id(const struct ofproto
*);
293 static uint64_t pick_fallback_dpid(void);
294 static void ofproto_destroy__(struct ofproto
*);
295 static void update_mtu(struct ofproto
*, struct ofport
*);
296 static void meter_delete(struct ofproto
*, uint32_t first
, uint32_t last
);
299 static void ofproto_unixctl_init(void);
301 /* All registered ofproto classes, in probe order. */
302 static const struct ofproto_class
**ofproto_classes
;
303 static size_t n_ofproto_classes
;
304 static size_t allocated_ofproto_classes
;
306 /* Global lock that protects all flow table operations. */
307 struct ovs_mutex ofproto_mutex
= OVS_MUTEX_INITIALIZER
;
309 unsigned ofproto_flow_limit
= OFPROTO_FLOW_LIMIT_DEFAULT
;
310 enum ofproto_flow_miss_model flow_miss_model
= OFPROTO_HANDLE_MISS_AUTO
;
312 size_t n_handlers
, n_revalidators
;
314 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
315 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
317 /* Initial mappings of port to OpenFlow number mappings. */
318 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
320 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
322 /* The default value of true waits for flow restore. */
323 static bool flow_restore_wait
= true;
325 /* Must be called to initialize the ofproto library.
327 * The caller may pass in 'iface_hints', which contains an shash of
328 * "iface_hint" elements indexed by the interface's name. The provider
329 * may use these hints to describe the startup configuration in order to
330 * reinitialize its state. The caller owns the provided data, so a
331 * provider will make copies of anything required. An ofproto provider
332 * will remove any existing state that is not described by the hint, and
333 * may choose to remove it all. */
335 ofproto_init(const struct shash
*iface_hints
)
337 struct shash_node
*node
;
340 ofproto_class_register(&ofproto_dpif_class
);
342 /* Make a local copy, since we don't own 'iface_hints' elements. */
343 SHASH_FOR_EACH(node
, iface_hints
) {
344 const struct iface_hint
*orig_hint
= node
->data
;
345 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
346 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
348 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
349 new_hint
->br_type
= xstrdup(br_type
);
350 new_hint
->ofp_port
= orig_hint
->ofp_port
;
352 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
355 for (i
= 0; i
< n_ofproto_classes
; i
++) {
356 ofproto_classes
[i
]->init(&init_ofp_ports
);
360 /* 'type' should be a normalized datapath type, as returned by
361 * ofproto_normalize_type(). Returns the corresponding ofproto_class
362 * structure, or a null pointer if there is none registered for 'type'. */
363 static const struct ofproto_class
*
364 ofproto_class_find__(const char *type
)
368 for (i
= 0; i
< n_ofproto_classes
; i
++) {
369 const struct ofproto_class
*class = ofproto_classes
[i
];
374 class->enumerate_types(&types
);
375 found
= sset_contains(&types
, type
);
376 sset_destroy(&types
);
382 VLOG_WARN("unknown datapath type %s", type
);
386 /* Registers a new ofproto class. After successful registration, new ofprotos
387 * of that type can be created using ofproto_create(). */
389 ofproto_class_register(const struct ofproto_class
*new_class
)
393 for (i
= 0; i
< n_ofproto_classes
; i
++) {
394 if (ofproto_classes
[i
] == new_class
) {
399 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
400 ofproto_classes
= x2nrealloc(ofproto_classes
,
401 &allocated_ofproto_classes
,
402 sizeof *ofproto_classes
);
404 ofproto_classes
[n_ofproto_classes
++] = new_class
;
408 /* Unregisters a datapath provider. 'type' must have been previously
409 * registered and not currently be in use by any ofprotos. After
410 * unregistration new datapaths of that type cannot be opened using
411 * ofproto_create(). */
413 ofproto_class_unregister(const struct ofproto_class
*class)
417 for (i
= 0; i
< n_ofproto_classes
; i
++) {
418 if (ofproto_classes
[i
] == class) {
419 for (i
++; i
< n_ofproto_classes
; i
++) {
420 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
426 VLOG_WARN("attempted to unregister an ofproto class that is not "
431 /* Clears 'types' and enumerates all registered ofproto types into it. The
432 * caller must first initialize the sset. */
434 ofproto_enumerate_types(struct sset
*types
)
439 for (i
= 0; i
< n_ofproto_classes
; i
++) {
440 ofproto_classes
[i
]->enumerate_types(types
);
444 /* Returns the fully spelled out name for the given ofproto 'type'.
446 * Normalized type string can be compared with strcmp(). Unnormalized type
447 * string might be the same even if they have different spellings. */
449 ofproto_normalize_type(const char *type
)
451 return type
&& type
[0] ? type
: "system";
454 /* Clears 'names' and enumerates the names of all known created ofprotos with
455 * the given 'type'. The caller must first initialize the sset. Returns 0 if
456 * successful, otherwise a positive errno value.
458 * Some kinds of datapaths might not be practically enumerable. This is not
459 * considered an error. */
461 ofproto_enumerate_names(const char *type
, struct sset
*names
)
463 const struct ofproto_class
*class = ofproto_class_find__(type
);
464 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
468 ofproto_create(const char *datapath_name
, const char *datapath_type
,
469 struct ofproto
**ofprotop
)
471 const struct ofproto_class
*class;
472 struct ofproto
*ofproto
;
478 ofproto_unixctl_init();
480 datapath_type
= ofproto_normalize_type(datapath_type
);
481 class = ofproto_class_find__(datapath_type
);
483 VLOG_WARN("could not create datapath %s of unknown type %s",
484 datapath_name
, datapath_type
);
488 ofproto
= class->alloc();
490 VLOG_ERR("failed to allocate datapath %s of type %s",
491 datapath_name
, datapath_type
);
496 ovs_mutex_lock(&ofproto_mutex
);
497 memset(ofproto
, 0, sizeof *ofproto
);
498 ofproto
->ofproto_class
= class;
499 ofproto
->name
= xstrdup(datapath_name
);
500 ofproto
->type
= xstrdup(datapath_type
);
501 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
502 hash_string(ofproto
->name
, 0));
503 ofproto
->datapath_id
= 0;
504 ofproto
->forward_bpdu
= false;
505 ofproto
->fallback_dpid
= pick_fallback_dpid();
506 ofproto
->mfr_desc
= NULL
;
507 ofproto
->hw_desc
= NULL
;
508 ofproto
->sw_desc
= NULL
;
509 ofproto
->serial_desc
= NULL
;
510 ofproto
->dp_desc
= NULL
;
511 ofproto
->frag_handling
= OFPC_FRAG_NORMAL
;
512 hmap_init(&ofproto
->ports
);
513 hmap_init(&ofproto
->ofport_usage
);
514 shash_init(&ofproto
->port_by_name
);
515 simap_init(&ofproto
->ofp_requests
);
516 ofproto
->max_ports
= ofp_to_u16(OFPP_MAX
);
517 ofproto
->eviction_group_timer
= LLONG_MIN
;
518 ofproto
->tables
= NULL
;
519 ofproto
->n_tables
= 0;
520 hindex_init(&ofproto
->cookies
);
521 list_init(&ofproto
->expirable
);
522 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
523 ofproto
->state
= S_OPENFLOW
;
524 list_init(&ofproto
->pending
);
525 ofproto
->n_pending
= 0;
526 hmap_init(&ofproto
->deletions
);
527 guarded_list_init(&ofproto
->rule_executes
);
528 ofproto
->n_add
= ofproto
->n_delete
= ofproto
->n_modify
= 0;
529 ofproto
->first_op
= ofproto
->last_op
= LLONG_MIN
;
530 ofproto
->next_op_report
= LLONG_MAX
;
531 ofproto
->op_backoff
= LLONG_MIN
;
532 ofproto
->vlan_bitmap
= NULL
;
533 ofproto
->vlans_changed
= false;
534 ofproto
->min_mtu
= INT_MAX
;
535 ovs_rwlock_init(&ofproto
->groups_rwlock
);
536 hmap_init(&ofproto
->groups
);
537 ovs_mutex_unlock(&ofproto_mutex
);
538 ofproto
->ogf
.capabilities
= OFPGFC_CHAINING
| OFPGFC_SELECT_LIVENESS
|
539 OFPGFC_SELECT_WEIGHT
;
540 ofproto
->ogf
.max_groups
[OFPGT11_ALL
] = OFPG_MAX
;
541 ofproto
->ogf
.max_groups
[OFPGT11_SELECT
] = OFPG_MAX
;
542 ofproto
->ogf
.max_groups
[OFPGT11_INDIRECT
] = OFPG_MAX
;
543 ofproto
->ogf
.max_groups
[OFPGT11_FF
] = OFPG_MAX
;
544 ofproto
->ogf
.actions
[0] =
545 (1 << OFPAT11_OUTPUT
) |
546 (1 << OFPAT11_COPY_TTL_OUT
) |
547 (1 << OFPAT11_COPY_TTL_IN
) |
548 (1 << OFPAT11_SET_MPLS_TTL
) |
549 (1 << OFPAT11_DEC_MPLS_TTL
) |
550 (1 << OFPAT11_PUSH_VLAN
) |
551 (1 << OFPAT11_POP_VLAN
) |
552 (1 << OFPAT11_PUSH_MPLS
) |
553 (1 << OFPAT11_POP_MPLS
) |
554 (1 << OFPAT11_SET_QUEUE
) |
555 (1 << OFPAT11_GROUP
) |
556 (1 << OFPAT11_SET_NW_TTL
) |
557 (1 << OFPAT11_DEC_NW_TTL
) |
558 (1 << OFPAT12_SET_FIELD
);
560 * (1 << OFPAT13_PUSH_PBB) |
561 * (1 << OFPAT13_POP_PBB) */
563 error
= ofproto
->ofproto_class
->construct(ofproto
);
565 VLOG_ERR("failed to open datapath %s: %s",
566 datapath_name
, ovs_strerror(error
));
567 ofproto_destroy__(ofproto
);
571 /* Check that hidden tables, if any, are at the end. */
572 ovs_assert(ofproto
->n_tables
);
573 for (i
= 0; i
+ 1 < ofproto
->n_tables
; i
++) {
574 enum oftable_flags flags
= ofproto
->tables
[i
].flags
;
575 enum oftable_flags next_flags
= ofproto
->tables
[i
+ 1].flags
;
577 ovs_assert(!(flags
& OFTABLE_HIDDEN
) || next_flags
& OFTABLE_HIDDEN
);
580 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
583 /* Initialize meters table. */
584 if (ofproto
->ofproto_class
->meter_get_features
) {
585 ofproto
->ofproto_class
->meter_get_features(ofproto
,
586 &ofproto
->meter_features
);
588 memset(&ofproto
->meter_features
, 0, sizeof ofproto
->meter_features
);
590 ofproto
->meters
= xzalloc((ofproto
->meter_features
.max_meters
+ 1)
591 * sizeof(struct meter
*));
597 /* Must be called (only) by an ofproto implementation in its constructor
598 * function. See the large comment on 'construct' in struct ofproto_class for
601 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
603 struct oftable
*table
;
605 ovs_assert(!ofproto
->n_tables
);
606 ovs_assert(n_tables
>= 1 && n_tables
<= 255);
608 ofproto
->n_tables
= n_tables
;
609 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
610 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
615 /* To be optionally called (only) by an ofproto implementation in its
616 * constructor function. See the large comment on 'construct' in struct
617 * ofproto_class for details.
619 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
620 * will then ensure that actions passed into the ofproto implementation will
621 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
622 * function is not called, there will be no such restriction.
624 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
625 * the 'max_ports' restriction. */
627 ofproto_init_max_ports(struct ofproto
*ofproto
, uint16_t max_ports
)
629 ovs_assert(max_ports
<= ofp_to_u16(OFPP_MAX
));
630 ofproto
->max_ports
= max_ports
;
634 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
636 return ofproto
->datapath_id
;
640 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
642 uint64_t old_dpid
= p
->datapath_id
;
643 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
644 if (p
->datapath_id
!= old_dpid
) {
645 /* Force all active connections to reconnect, since there is no way to
646 * notify a controller that the datapath ID has changed. */
647 ofproto_reconnect_controllers(p
);
652 ofproto_set_controllers(struct ofproto
*p
,
653 const struct ofproto_controller
*controllers
,
654 size_t n_controllers
, uint32_t allowed_versions
)
656 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
,
661 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
663 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
666 /* Drops the connections between 'ofproto' and all of its controllers, forcing
667 * them to reconnect. */
669 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
671 connmgr_reconnect(ofproto
->connmgr
);
674 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
675 * in-band control should guarantee access, in the same way that in-band
676 * control guarantees access to OpenFlow controllers. */
678 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
679 const struct sockaddr_in
*extras
, size_t n
)
681 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
684 /* Sets the OpenFlow queue used by flows set up by in-band control on
685 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
686 * flows will use the default queue. */
688 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
690 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
693 /* Sets the number of flows at which eviction from the kernel flow table
696 ofproto_set_flow_limit(unsigned limit
)
698 ofproto_flow_limit
= limit
;
701 /* Sets the path for handling flow misses. */
703 ofproto_set_flow_miss_model(unsigned model
)
705 flow_miss_model
= model
;
708 /* If forward_bpdu is true, the NORMAL action will forward frames with
709 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
710 * the NORMAL action will drop these frames. */
712 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
714 bool old_val
= ofproto
->forward_bpdu
;
715 ofproto
->forward_bpdu
= forward_bpdu
;
716 if (old_val
!= ofproto
->forward_bpdu
) {
717 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
718 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
723 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
724 * 'idle_time', in seconds, and the maximum number of MAC table entries to
727 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
730 if (ofproto
->ofproto_class
->set_mac_table_config
) {
731 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
737 ofproto_set_threads(int n_handlers_
, int n_revalidators_
)
739 int threads
= MAX(count_cpu_cores(), 2);
741 n_revalidators
= MAX(n_revalidators_
, 0);
742 n_handlers
= MAX(n_handlers_
, 0);
744 if (!n_revalidators
) {
745 n_revalidators
= n_handlers
746 ? MAX(threads
- (int) n_handlers
, 1)
751 n_handlers
= MAX(threads
- (int) n_revalidators
, 1);
756 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
759 p
->dp_desc
= dp_desc
? xstrdup(dp_desc
) : NULL
;
763 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
765 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
769 ofproto_set_netflow(struct ofproto
*ofproto
,
770 const struct netflow_options
*nf_options
)
772 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
776 if (ofproto
->ofproto_class
->set_netflow
) {
777 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
779 return nf_options
? EOPNOTSUPP
: 0;
784 ofproto_set_sflow(struct ofproto
*ofproto
,
785 const struct ofproto_sflow_options
*oso
)
787 if (oso
&& sset_is_empty(&oso
->targets
)) {
791 if (ofproto
->ofproto_class
->set_sflow
) {
792 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
794 return oso
? EOPNOTSUPP
: 0;
799 ofproto_set_ipfix(struct ofproto
*ofproto
,
800 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
801 const struct ofproto_ipfix_flow_exporter_options
*fo
,
804 if (ofproto
->ofproto_class
->set_ipfix
) {
805 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
807 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
812 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
814 flow_restore_wait
= flow_restore_wait_db
;
818 ofproto_get_flow_restore_wait(void)
820 return flow_restore_wait
;
824 /* Spanning Tree Protocol (STP) configuration. */
826 /* Configures STP on 'ofproto' using the settings defined in 's'. If
827 * 's' is NULL, disables STP.
829 * Returns 0 if successful, otherwise a positive errno value. */
831 ofproto_set_stp(struct ofproto
*ofproto
,
832 const struct ofproto_stp_settings
*s
)
834 return (ofproto
->ofproto_class
->set_stp
835 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
839 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
840 * 'enabled' member of 's' is false, then the other members are not
843 * Returns 0 if successful, otherwise a positive errno value. */
845 ofproto_get_stp_status(struct ofproto
*ofproto
,
846 struct ofproto_stp_status
*s
)
848 return (ofproto
->ofproto_class
->get_stp_status
849 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
853 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
854 * in 's'. The caller is responsible for assigning STP port numbers
855 * (using the 'port_num' member in the range of 1 through 255, inclusive)
856 * and ensuring there are no duplicates. If the 's' is NULL, then STP
857 * is disabled on the port.
859 * Returns 0 if successful, otherwise a positive errno value.*/
861 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
862 const struct ofproto_port_stp_settings
*s
)
864 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
866 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
867 ofproto
->name
, ofp_port
);
871 return (ofproto
->ofproto_class
->set_stp_port
872 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
876 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
877 * 's'. If the 'enabled' member in 's' is false, then the other members
878 * are not meaningful.
880 * Returns 0 if successful, otherwise a positive errno value.*/
882 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
883 struct ofproto_port_stp_status
*s
)
885 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
887 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
888 "port %"PRIu16
, ofproto
->name
, ofp_port
);
892 return (ofproto
->ofproto_class
->get_stp_port_status
893 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
897 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
898 * 's'. If the 'enabled' member in 's' is false, then the other members
899 * are not meaningful.
901 * Returns 0 if successful, otherwise a positive errno value.*/
903 ofproto_port_get_stp_stats(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
904 struct ofproto_port_stp_stats
*s
)
906 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
908 VLOG_WARN_RL(&rl
, "%s: cannot get STP stats on nonexistent "
909 "port %"PRIu16
, ofproto
->name
, ofp_port
);
913 return (ofproto
->ofproto_class
->get_stp_port_stats
914 ? ofproto
->ofproto_class
->get_stp_port_stats(ofport
, s
)
918 /* Queue DSCP configuration. */
920 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
921 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
922 * to implement QoS. Instead, it is used to implement features which require
923 * knowledge of what queues exist on a port, and some basic information about
926 * Returns 0 if successful, otherwise a positive errno value. */
928 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
929 const struct ofproto_port_queue
*queues
,
932 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
935 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
936 ofproto
->name
, ofp_port
);
940 return (ofproto
->ofproto_class
->set_queues
941 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
945 /* Connectivity Fault Management configuration. */
947 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
949 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
951 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
952 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
953 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
957 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
958 * basic configuration from the configuration members in 'cfm', and the remote
959 * maintenance point ID from remote_mpid. Ignores the statistics members of
962 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
964 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
965 const struct cfm_settings
*s
)
967 struct ofport
*ofport
;
970 ofport
= ofproto_get_port(ofproto
, ofp_port
);
972 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
973 ofproto
->name
, ofp_port
);
977 /* XXX: For configuration simplicity, we only support one remote_mpid
978 * outside of the CFM module. It's not clear if this is the correct long
979 * term solution or not. */
980 error
= (ofproto
->ofproto_class
->set_cfm
981 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
984 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
985 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
986 ovs_strerror(error
));
990 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
991 * 'ofproto' does not have a port 'ofp_port'. */
993 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
994 const struct smap
*cfg
)
996 struct ofport
*ofport
;
999 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1001 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16
,
1002 ofproto
->name
, ofp_port
);
1006 error
= (ofproto
->ofproto_class
->set_bfd
1007 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
1010 VLOG_WARN("%s: bfd configuration on port %"PRIu16
" (%s) failed (%s)",
1011 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1012 ovs_strerror(error
));
1016 /* Populates 'status' with key value pairs indicating the status of the BFD
1017 * session on 'ofp_port'. This information is intended to be populated in the
1018 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
1021 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1022 struct smap
*status
)
1024 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1025 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
1026 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
1030 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1031 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1032 * 0 if LACP partner information is not current (generally indicating a
1033 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1035 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1037 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1038 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
1039 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
1045 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1046 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1047 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1048 * configuration plus, if there is more than one slave, a bonding
1051 * If 'aux' is already registered then this function updates its configuration
1052 * to 's'. Otherwise, this function registers a new bundle.
1054 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1057 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
1058 const struct ofproto_bundle_settings
*s
)
1060 return (ofproto
->ofproto_class
->bundle_set
1061 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
1065 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1066 * If no such bundle has been registered, this has no effect. */
1068 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
1070 return ofproto_bundle_register(ofproto
, aux
, NULL
);
1074 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1075 * If 'aux' is already registered then this function updates its configuration
1076 * to 's'. Otherwise, this function registers a new mirror. */
1078 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
1079 const struct ofproto_mirror_settings
*s
)
1081 return (ofproto
->ofproto_class
->mirror_set
1082 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
1086 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1087 * If no mirror has been registered, this has no effect. */
1089 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
1091 return ofproto_mirror_register(ofproto
, aux
, NULL
);
1094 /* Retrieves statistics from mirror associated with client data pointer
1095 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1096 * 'bytes', respectively. If a particular counters is not supported,
1097 * the appropriate argument is set to UINT64_MAX. */
1099 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
1100 uint64_t *packets
, uint64_t *bytes
)
1102 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
1103 *packets
= *bytes
= UINT64_MAX
;
1107 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
1111 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1112 * which all packets are flooded, instead of using MAC learning. If
1113 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1115 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1118 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
1120 return (ofproto
->ofproto_class
->set_flood_vlans
1121 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
1125 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1126 * output for a mirror. */
1128 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
1130 return (ofproto
->ofproto_class
->is_mirror_output_bundle
1131 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
1135 /* Configuration of OpenFlow tables. */
1137 /* Returns the number of OpenFlow tables in 'ofproto'. */
1139 ofproto_get_n_tables(const struct ofproto
*ofproto
)
1141 return ofproto
->n_tables
;
1144 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1145 * settings from 's'. 'table_id' must be in the range 0 through the number of
1146 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1148 * For read-only tables, only the name may be configured. */
1150 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
1151 const struct ofproto_table_settings
*s
)
1153 struct oftable
*table
;
1155 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
1156 table
= &ofproto
->tables
[table_id
];
1158 oftable_set_name(table
, s
->name
);
1160 if (table
->flags
& OFTABLE_READONLY
) {
1165 oftable_enable_eviction(table
, s
->groups
, s
->n_groups
);
1167 oftable_disable_eviction(table
);
1170 table
->max_flows
= s
->max_flows
;
1171 fat_rwlock_wrlock(&table
->cls
.rwlock
);
1172 if (classifier_count(&table
->cls
) > table
->max_flows
1173 && table
->eviction_fields
) {
1174 /* 'table' contains more flows than allowed. We might not be able to
1175 * evict them right away because of the asynchronous nature of flow
1176 * table changes. Schedule eviction for later. */
1177 switch (ofproto
->state
) {
1179 ofproto
->state
= S_EVICT
;
1183 /* We're already deleting flows, nothing more to do. */
1188 classifier_set_prefix_fields(&table
->cls
,
1189 s
->prefix_fields
, s
->n_prefix_fields
);
1191 fat_rwlock_unlock(&table
->cls
.rwlock
);
1195 ofproto_has_snoops(const struct ofproto
*ofproto
)
1197 return connmgr_has_snoops(ofproto
->connmgr
);
1201 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1203 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1207 ofproto_rule_delete__(struct ofproto
*ofproto
, struct rule
*rule
,
1209 OVS_REQUIRES(ofproto_mutex
)
1211 struct ofopgroup
*group
;
1213 ovs_assert(!rule
->pending
);
1215 group
= ofopgroup_create_unattached(ofproto
);
1216 delete_flow__(rule
, group
, reason
);
1217 ofopgroup_submit(group
);
1220 /* Deletes 'rule' from 'cls' within 'ofproto'.
1222 * Within an ofproto implementation, this function allows an ofproto
1223 * implementation to destroy any rules that remain when its ->destruct()
1224 * function is called. This function is not suitable for use elsewhere in an
1225 * ofproto implementation.
1227 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1228 * Cycle" in ofproto-provider.h. */
1230 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1231 OVS_EXCLUDED(ofproto_mutex
)
1233 struct ofopgroup
*group
;
1235 ovs_mutex_lock(&ofproto_mutex
);
1236 ovs_assert(!rule
->pending
);
1238 group
= ofopgroup_create_unattached(ofproto
);
1239 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, OFPRR_DELETE
);
1240 oftable_remove_rule__(ofproto
, rule
);
1241 ofproto
->ofproto_class
->rule_delete(rule
);
1242 ofopgroup_submit(group
);
1244 ovs_mutex_unlock(&ofproto_mutex
);
1248 ofproto_flush__(struct ofproto
*ofproto
)
1249 OVS_EXCLUDED(ofproto_mutex
)
1251 struct oftable
*table
;
1253 if (ofproto
->ofproto_class
->flush
) {
1254 ofproto
->ofproto_class
->flush(ofproto
);
1257 ovs_mutex_lock(&ofproto_mutex
);
1258 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1259 struct rule
*rule
, *next_rule
;
1260 struct cls_cursor cursor
;
1262 if (table
->flags
& OFTABLE_HIDDEN
) {
1266 fat_rwlock_rdlock(&table
->cls
.rwlock
);
1267 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
1268 fat_rwlock_unlock(&table
->cls
.rwlock
);
1269 CLS_CURSOR_FOR_EACH_SAFE (rule
, next_rule
, cr
, &cursor
) {
1270 if (!rule
->pending
) {
1271 ofproto_rule_delete__(ofproto
, rule
, OFPRR_DELETE
);
1275 ovs_mutex_unlock(&ofproto_mutex
);
1278 static void delete_group(struct ofproto
*ofproto
, uint32_t group_id
);
1281 ofproto_destroy__(struct ofproto
*ofproto
)
1282 OVS_EXCLUDED(ofproto_mutex
)
1284 struct oftable
*table
;
1286 ovs_assert(list_is_empty(&ofproto
->pending
));
1288 destroy_rule_executes(ofproto
);
1289 guarded_list_destroy(&ofproto
->rule_executes
);
1291 delete_group(ofproto
, OFPG_ALL
);
1292 ovs_rwlock_destroy(&ofproto
->groups_rwlock
);
1293 hmap_destroy(&ofproto
->groups
);
1295 connmgr_destroy(ofproto
->connmgr
);
1297 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1298 free(ofproto
->name
);
1299 free(ofproto
->type
);
1300 free(ofproto
->mfr_desc
);
1301 free(ofproto
->hw_desc
);
1302 free(ofproto
->sw_desc
);
1303 free(ofproto
->serial_desc
);
1304 free(ofproto
->dp_desc
);
1305 hmap_destroy(&ofproto
->ports
);
1306 hmap_destroy(&ofproto
->ofport_usage
);
1307 shash_destroy(&ofproto
->port_by_name
);
1308 simap_destroy(&ofproto
->ofp_requests
);
1310 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1311 oftable_destroy(table
);
1313 free(ofproto
->tables
);
1315 hmap_destroy(&ofproto
->deletions
);
1317 free(ofproto
->vlan_bitmap
);
1319 ofproto
->ofproto_class
->dealloc(ofproto
);
1323 ofproto_destroy(struct ofproto
*p
)
1324 OVS_EXCLUDED(ofproto_mutex
)
1326 struct ofport
*ofport
, *next_ofport
;
1327 struct ofport_usage
*usage
, *next_usage
;
1334 meter_delete(p
, 1, p
->meter_features
.max_meters
);
1335 p
->meter_features
.max_meters
= 0;
1341 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1342 ofport_destroy(ofport
);
1345 HMAP_FOR_EACH_SAFE (usage
, next_usage
, hmap_node
, &p
->ofport_usage
) {
1346 hmap_remove(&p
->ofport_usage
, &usage
->hmap_node
);
1350 p
->ofproto_class
->destruct(p
);
1351 ofproto_destroy__(p
);
1354 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1355 * kernel datapath, for example, this destroys the datapath in the kernel, and
1356 * with the netdev-based datapath, it tears down the data structures that
1357 * represent the datapath.
1359 * The datapath should not be currently open as an ofproto. */
1361 ofproto_delete(const char *name
, const char *type
)
1363 const struct ofproto_class
*class = ofproto_class_find__(type
);
1364 return (!class ? EAFNOSUPPORT
1365 : !class->del
? EACCES
1366 : class->del(type
, name
));
1370 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1372 if (error
== ENOBUFS
) {
1373 reinit_ports(ofproto
);
1374 } else if (!error
) {
1375 update_port(ofproto
, devname
);
1381 ofproto_type_run(const char *datapath_type
)
1383 const struct ofproto_class
*class;
1386 datapath_type
= ofproto_normalize_type(datapath_type
);
1387 class = ofproto_class_find__(datapath_type
);
1389 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1390 if (error
&& error
!= EAGAIN
) {
1391 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1392 datapath_type
, ovs_strerror(error
));
1398 ofproto_type_wait(const char *datapath_type
)
1400 const struct ofproto_class
*class;
1402 datapath_type
= ofproto_normalize_type(datapath_type
);
1403 class = ofproto_class_find__(datapath_type
);
1405 if (class->type_wait
) {
1406 class->type_wait(datapath_type
);
1411 any_pending_ops(const struct ofproto
*p
)
1412 OVS_EXCLUDED(ofproto_mutex
)
1416 ovs_mutex_lock(&ofproto_mutex
);
1417 b
= !list_is_empty(&p
->pending
);
1418 ovs_mutex_unlock(&ofproto_mutex
);
1424 ofproto_run(struct ofproto
*p
)
1429 error
= p
->ofproto_class
->run(p
);
1430 if (error
&& error
!= EAGAIN
) {
1431 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, ovs_strerror(error
));
1434 run_rule_executes(p
);
1436 /* Restore the eviction group heap invariant occasionally. */
1437 if (p
->eviction_group_timer
< time_msec()) {
1440 p
->eviction_group_timer
= time_msec() + 1000;
1442 for (i
= 0; i
< p
->n_tables
; i
++) {
1443 struct oftable
*table
= &p
->tables
[i
];
1444 struct eviction_group
*evg
;
1445 struct cls_cursor cursor
;
1448 if (!table
->eviction_fields
) {
1452 ovs_mutex_lock(&ofproto_mutex
);
1453 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1454 heap_rebuild(&evg
->rules
);
1457 fat_rwlock_rdlock(&table
->cls
.rwlock
);
1458 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
1459 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
1460 if (!rule
->eviction_group
1461 && (rule
->idle_timeout
|| rule
->hard_timeout
)) {
1462 eviction_group_add_rule(rule
);
1465 fat_rwlock_unlock(&table
->cls
.rwlock
);
1466 ovs_mutex_unlock(&ofproto_mutex
);
1470 if (p
->ofproto_class
->port_poll
) {
1473 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1474 process_port_change(p
, error
, devname
);
1478 new_seq
= seq_read(connectivity_seq_get());
1479 if (new_seq
!= p
->change_seq
) {
1480 struct sset devnames
;
1481 const char *devname
;
1482 struct ofport
*ofport
;
1484 /* Update OpenFlow port status for any port whose netdev has changed.
1486 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1487 * destroyed, so it's not safe to update ports directly from the
1488 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1489 * need this two-phase approach. */
1490 sset_init(&devnames
);
1491 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1492 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1494 SSET_FOR_EACH (devname
, &devnames
) {
1495 update_port(p
, devname
);
1497 sset_destroy(&devnames
);
1499 p
->change_seq
= new_seq
;
1504 connmgr_run(p
->connmgr
, handle_openflow
);
1508 connmgr_run(p
->connmgr
, NULL
);
1510 if (!any_pending_ops(p
)) {
1511 p
->state
= S_OPENFLOW
;
1516 connmgr_run(p
->connmgr
, NULL
);
1518 if (!any_pending_ops(p
)) {
1519 connmgr_flushed(p
->connmgr
);
1520 p
->state
= S_OPENFLOW
;
1528 if (time_msec() >= p
->next_op_report
) {
1529 long long int ago
= (time_msec() - p
->first_op
) / 1000;
1530 long long int interval
= (p
->last_op
- p
->first_op
) / 1000;
1534 ds_put_format(&s
, "%d flow_mods ",
1535 p
->n_add
+ p
->n_delete
+ p
->n_modify
);
1536 if (interval
== ago
) {
1537 ds_put_format(&s
, "in the last %lld s", ago
);
1538 } else if (interval
) {
1539 ds_put_format(&s
, "in the %lld s starting %lld s ago",
1542 ds_put_format(&s
, "%lld s ago", ago
);
1545 ds_put_cstr(&s
, " (");
1547 ds_put_format(&s
, "%d adds, ", p
->n_add
);
1550 ds_put_format(&s
, "%d deletes, ", p
->n_delete
);
1553 ds_put_format(&s
, "%d modifications, ", p
->n_modify
);
1556 ds_put_char(&s
, ')');
1558 VLOG_INFO("%s: %s", p
->name
, ds_cstr(&s
));
1561 p
->n_add
= p
->n_delete
= p
->n_modify
= 0;
1562 p
->next_op_report
= LLONG_MAX
;
1569 ofproto_wait(struct ofproto
*p
)
1571 p
->ofproto_class
->wait(p
);
1572 if (p
->ofproto_class
->port_poll_wait
) {
1573 p
->ofproto_class
->port_poll_wait(p
);
1575 seq_wait(connectivity_seq_get(), p
->change_seq
);
1579 connmgr_wait(p
->connmgr
, true);
1584 connmgr_wait(p
->connmgr
, false);
1585 if (!any_pending_ops(p
)) {
1586 poll_immediate_wake();
1593 ofproto_is_alive(const struct ofproto
*p
)
1595 return connmgr_has_controllers(p
->connmgr
);
1598 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1599 * memory_report(). */
1601 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1603 const struct oftable
*table
;
1604 unsigned int n_rules
;
1606 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1608 ovs_mutex_lock(&ofproto_mutex
);
1609 simap_increase(usage
, "ops",
1610 ofproto
->n_pending
+ hmap_count(&ofproto
->deletions
));
1611 ovs_mutex_unlock(&ofproto_mutex
);
1614 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1615 fat_rwlock_rdlock(&table
->cls
.rwlock
);
1616 n_rules
+= classifier_count(&table
->cls
);
1617 fat_rwlock_unlock(&table
->cls
.rwlock
);
1619 simap_increase(usage
, "rules", n_rules
);
1621 if (ofproto
->ofproto_class
->get_memory_usage
) {
1622 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1625 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1629 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1631 const struct ofproto_class
*class;
1633 datapath_type
= ofproto_normalize_type(datapath_type
);
1634 class = ofproto_class_find__(datapath_type
);
1636 if (class && class->type_get_memory_usage
) {
1637 class->type_get_memory_usage(datapath_type
, usage
);
1642 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1645 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1649 ofproto_free_ofproto_controller_info(struct shash
*info
)
1651 connmgr_free_controller_info(info
);
1654 /* Makes a deep copy of 'old' into 'port'. */
1656 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1658 port
->name
= xstrdup(old
->name
);
1659 port
->type
= xstrdup(old
->type
);
1660 port
->ofp_port
= old
->ofp_port
;
1663 /* Frees memory allocated to members of 'ofproto_port'.
1665 * Do not call this function on an ofproto_port obtained from
1666 * ofproto_port_dump_next(): that function retains ownership of the data in the
1669 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1671 free(ofproto_port
->name
);
1672 free(ofproto_port
->type
);
1675 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1677 * This function provides no status indication. An error status for the entire
1678 * dump operation is provided when it is completed by calling
1679 * ofproto_port_dump_done().
1682 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1683 const struct ofproto
*ofproto
)
1685 dump
->ofproto
= ofproto
;
1686 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1690 /* Attempts to retrieve another port from 'dump', which must have been created
1691 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1692 * 'port' and returns true. On failure, returns false.
1694 * Failure might indicate an actual error or merely that the last port has been
1695 * dumped. An error status for the entire dump operation is provided when it
1696 * is completed by calling ofproto_port_dump_done().
1698 * The ofproto owns the data stored in 'port'. It will remain valid until at
1699 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1700 * ofproto_port_dump_done(). */
1702 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1703 struct ofproto_port
*port
)
1705 const struct ofproto
*ofproto
= dump
->ofproto
;
1711 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1714 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1720 /* Completes port table dump operation 'dump', which must have been created
1721 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1722 * error-free, otherwise a positive errno value describing the problem. */
1724 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1726 const struct ofproto
*ofproto
= dump
->ofproto
;
1728 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1731 return dump
->error
== EOF
? 0 : dump
->error
;
1734 /* Returns the type to pass to netdev_open() when a datapath of type
1735 * 'datapath_type' has a port of type 'port_type', for a few special
1736 * cases when a netdev type differs from a port type. For example, when
1737 * using the userspace datapath, a port of type "internal" needs to be
1740 * Returns either 'type' itself or a string literal, which must not be
1743 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1745 const struct ofproto_class
*class;
1747 datapath_type
= ofproto_normalize_type(datapath_type
);
1748 class = ofproto_class_find__(datapath_type
);
1753 return (class->port_open_type
1754 ? class->port_open_type(datapath_type
, port_type
)
1758 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1759 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1760 * the port's OpenFlow port number.
1762 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1763 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1764 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1765 * 'ofp_portp' is non-null). */
1767 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1768 ofp_port_t
*ofp_portp
)
1770 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1773 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1775 const char *netdev_name
= netdev_get_name(netdev
);
1777 simap_put(&ofproto
->ofp_requests
, netdev_name
,
1778 ofp_to_u16(ofp_port
));
1779 update_port(ofproto
, netdev_name
);
1782 *ofp_portp
= OFPP_NONE
;
1784 struct ofproto_port ofproto_port
;
1786 error
= ofproto_port_query_by_name(ofproto
,
1787 netdev_get_name(netdev
),
1790 *ofp_portp
= ofproto_port
.ofp_port
;
1791 ofproto_port_destroy(&ofproto_port
);
1798 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1799 * initializes '*port' appropriately; on failure, returns a positive errno
1802 * The caller owns the data in 'ofproto_port' and must free it with
1803 * ofproto_port_destroy() when it is no longer needed. */
1805 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1806 struct ofproto_port
*port
)
1810 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1812 memset(port
, 0, sizeof *port
);
1817 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1818 * Returns 0 if successful, otherwise a positive errno. */
1820 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1822 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1823 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
1824 struct simap_node
*ofp_request_node
;
1827 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
1828 if (ofp_request_node
) {
1829 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
1832 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
1833 if (!error
&& ofport
) {
1834 /* 'name' is the netdev's name and update_port() is going to close the
1835 * netdev. Just in case update_port() refers to 'name' after it
1836 * destroys 'ofport', make a copy of it around the update_port()
1838 char *devname
= xstrdup(name
);
1839 update_port(ofproto
, devname
);
1846 flow_mod_init(struct ofputil_flow_mod
*fm
,
1847 const struct match
*match
, unsigned int priority
,
1848 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1849 enum ofp_flow_mod_command command
)
1851 memset(fm
, 0, sizeof *fm
);
1853 fm
->priority
= priority
;
1856 fm
->modify_cookie
= false;
1858 fm
->command
= command
;
1859 fm
->idle_timeout
= 0;
1860 fm
->hard_timeout
= 0;
1861 fm
->buffer_id
= UINT32_MAX
;
1862 fm
->out_port
= OFPP_ANY
;
1863 fm
->out_group
= OFPG_ANY
;
1865 fm
->ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
);
1866 fm
->ofpacts_len
= ofpacts_len
;
1870 simple_flow_mod(struct ofproto
*ofproto
,
1871 const struct match
*match
, unsigned int priority
,
1872 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1873 enum ofp_flow_mod_command command
)
1875 struct ofputil_flow_mod fm
;
1877 flow_mod_init(&fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
1879 return handle_flow_mod__(ofproto
, NULL
, &fm
, NULL
);
1882 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1883 * performs the 'n_actions' actions in 'actions'. The new flow will not
1886 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1887 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1888 * controllers; otherwise, it will be hidden.
1890 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1892 * This is a helper function for in-band control and fail-open. */
1894 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
1895 unsigned int priority
,
1896 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1897 OVS_EXCLUDED(ofproto_mutex
)
1899 const struct rule
*rule
;
1902 /* First do a cheap check whether the rule we're looking for already exists
1903 * with the actions that we want. If it does, then we're done. */
1904 fat_rwlock_rdlock(&ofproto
->tables
[0].cls
.rwlock
);
1905 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1906 &ofproto
->tables
[0].cls
, match
, priority
));
1908 ovs_mutex_lock(&rule
->mutex
);
1909 must_add
= !ofpacts_equal(rule
->actions
->ofpacts
,
1910 rule
->actions
->ofpacts_len
,
1911 ofpacts
, ofpacts_len
);
1912 ovs_mutex_unlock(&rule
->mutex
);
1916 fat_rwlock_unlock(&ofproto
->tables
[0].cls
.rwlock
);
1918 /* If there's no such rule or the rule doesn't have the actions we want,
1919 * fall back to a executing a full flow mod. We can't optimize this at
1920 * all because we didn't take enough locks above to ensure that the flow
1921 * table didn't already change beneath us. */
1923 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
1924 OFPFC_MODIFY_STRICT
);
1928 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1929 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1930 * operation cannot be initiated now but may be retried later.
1932 * This is a helper function for in-band control and fail-open and the "learn"
1935 ofproto_flow_mod(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
)
1936 OVS_EXCLUDED(ofproto_mutex
)
1938 return handle_flow_mod__(ofproto
, NULL
, fm
, NULL
);
1941 /* Searches for a rule with matching criteria exactly equal to 'target' in
1942 * ofproto's table 0 and, if it finds one, deletes it.
1944 * This is a helper function for in-band control and fail-open. */
1946 ofproto_delete_flow(struct ofproto
*ofproto
,
1947 const struct match
*target
, unsigned int priority
)
1948 OVS_EXCLUDED(ofproto_mutex
)
1950 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
1953 /* First do a cheap check whether the rule we're looking for has already
1954 * been deleted. If so, then we're done. */
1955 fat_rwlock_rdlock(&cls
->rwlock
);
1956 rule
= rule_from_cls_rule(classifier_find_match_exactly(cls
, target
,
1958 fat_rwlock_unlock(&cls
->rwlock
);
1963 /* Fall back to a executing a full flow mod. We can't optimize this at all
1964 * because we didn't take enough locks above to ensure that the flow table
1965 * didn't already change beneath us. */
1966 return simple_flow_mod(ofproto
, target
, priority
, NULL
, 0,
1967 OFPFC_DELETE_STRICT
) != OFPROTO_POSTPONE
;
1970 /* Starts the process of deleting all of the flows from all of ofproto's flow
1971 * tables and then reintroducing the flows required by in-band control and
1972 * fail-open. The process will complete in a later call to ofproto_run(). */
1974 ofproto_flush_flows(struct ofproto
*ofproto
)
1976 COVERAGE_INC(ofproto_flush
);
1977 ofproto
->state
= S_FLUSH
;
1981 reinit_ports(struct ofproto
*p
)
1983 struct ofproto_port_dump dump
;
1984 struct sset devnames
;
1985 struct ofport
*ofport
;
1986 struct ofproto_port ofproto_port
;
1987 const char *devname
;
1989 COVERAGE_INC(ofproto_reinit_ports
);
1991 sset_init(&devnames
);
1992 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1993 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1995 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
1996 sset_add(&devnames
, ofproto_port
.name
);
1999 SSET_FOR_EACH (devname
, &devnames
) {
2000 update_port(p
, devname
);
2002 sset_destroy(&devnames
);
2006 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2010 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2011 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2013 if (port_idx
>= ofproto
->max_ports
2014 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2015 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2016 long long int last_used_at
, lru
= LLONG_MAX
;
2018 /* Search for a free OpenFlow port number. We try not to
2019 * immediately reuse them to prevent problems due to old
2022 * We limit the automatically assigned port numbers to the lower half
2023 * of the port range, to reserve the upper half for assignment by
2026 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2027 ofproto
->alloc_port_no
= 1;
2029 last_used_at
= ofport_get_usage(ofproto
,
2030 u16_to_ofp(ofproto
->alloc_port_no
));
2031 if (!last_used_at
) {
2032 port_idx
= ofproto
->alloc_port_no
;
2034 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2035 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2036 * more than an hour ago, consider it usable. */
2037 ofport_remove_usage(ofproto
,
2038 u16_to_ofp(ofproto
->alloc_port_no
));
2039 port_idx
= ofproto
->alloc_port_no
;
2041 } else if (last_used_at
< lru
) {
2043 lru_ofport
= ofproto
->alloc_port_no
;
2046 if (ofproto
->alloc_port_no
== end_port_no
) {
2048 port_idx
= lru_ofport
;
2055 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2056 return u16_to_ofp(port_idx
);
2060 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2062 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2063 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2067 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2068 * pointer if the netdev cannot be opened. On success, also fills in
2070 static struct netdev
*
2071 ofport_open(struct ofproto
*ofproto
,
2072 struct ofproto_port
*ofproto_port
,
2073 struct ofputil_phy_port
*pp
)
2075 enum netdev_flags flags
;
2076 struct netdev
*netdev
;
2079 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2081 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
2082 "cannot be opened (%s)",
2084 ofproto_port
->name
, ofproto_port
->ofp_port
,
2085 ofproto_port
->name
, ovs_strerror(error
));
2089 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2090 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2091 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2093 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2094 ofproto_port
->name
);
2097 pp
->port_no
= ofproto_port
->ofp_port
;
2098 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
2099 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2100 netdev_get_flags(netdev
, &flags
);
2101 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2102 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2103 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2104 &pp
->supported
, &pp
->peer
);
2105 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2106 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2111 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2112 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2115 ofport_equal(const struct ofputil_phy_port
*a
,
2116 const struct ofputil_phy_port
*b
)
2118 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2119 && a
->state
== b
->state
2120 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2121 && a
->curr
== b
->curr
2122 && a
->advertised
== b
->advertised
2123 && a
->supported
== b
->supported
2124 && a
->peer
== b
->peer
2125 && a
->curr_speed
== b
->curr_speed
2126 && a
->max_speed
== b
->max_speed
);
2129 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2130 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2131 * one with the same name or port number). */
2133 ofport_install(struct ofproto
*p
,
2134 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2136 const char *netdev_name
= netdev_get_name(netdev
);
2137 struct ofport
*ofport
;
2140 /* Create ofport. */
2141 ofport
= p
->ofproto_class
->port_alloc();
2146 ofport
->ofproto
= p
;
2147 ofport
->netdev
= netdev
;
2149 ofport
->ofp_port
= pp
->port_no
;
2150 ofport
->created
= time_msec();
2152 /* Add port to 'p'. */
2153 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2154 hash_ofp_port(ofport
->ofp_port
));
2155 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2157 update_mtu(p
, ofport
);
2159 /* Let the ofproto_class initialize its private data. */
2160 error
= p
->ofproto_class
->port_construct(ofport
);
2164 connmgr_send_port_status(p
->connmgr
, pp
, OFPPR_ADD
);
2168 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2169 p
->name
, netdev_name
, ovs_strerror(error
));
2171 ofport_destroy__(ofport
);
2173 netdev_close(netdev
);
2177 /* Removes 'ofport' from 'p' and destroys it. */
2179 ofport_remove(struct ofport
*ofport
)
2181 connmgr_send_port_status(ofport
->ofproto
->connmgr
, &ofport
->pp
,
2183 ofport_destroy(ofport
);
2186 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2189 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2191 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2193 ofport_remove(port
);
2197 /* Updates 'port' with new 'pp' description.
2199 * Does not handle a name or port number change. The caller must implement
2200 * such a change as a delete followed by an add. */
2202 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2204 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
2205 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2206 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2207 port
->pp
.state
= pp
->state
;
2208 port
->pp
.curr
= pp
->curr
;
2209 port
->pp
.advertised
= pp
->advertised
;
2210 port
->pp
.supported
= pp
->supported
;
2211 port
->pp
.peer
= pp
->peer
;
2212 port
->pp
.curr_speed
= pp
->curr_speed
;
2213 port
->pp
.max_speed
= pp
->max_speed
;
2215 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->pp
, OFPPR_MODIFY
);
2218 /* Update OpenFlow 'state' in 'port' and notify controller. */
2220 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2222 if (port
->pp
.state
!= state
) {
2223 port
->pp
.state
= state
;
2224 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->pp
,
2230 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2232 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2234 if (port
->ofproto
->ofproto_class
->set_realdev
) {
2235 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
2237 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2238 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2240 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2241 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2243 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2244 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2250 ofport_destroy__(struct ofport
*port
)
2252 struct ofproto
*ofproto
= port
->ofproto
;
2253 const char *name
= netdev_get_name(port
->netdev
);
2255 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2256 shash_delete(&ofproto
->port_by_name
,
2257 shash_find(&ofproto
->port_by_name
, name
));
2259 netdev_close(port
->netdev
);
2260 ofproto
->ofproto_class
->port_dealloc(port
);
2264 ofport_destroy(struct ofport
*port
)
2267 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2268 port
->ofproto
->ofproto_class
->port_destruct(port
);
2269 ofport_destroy__(port
);
2274 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2276 struct ofport
*port
;
2278 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2280 if (port
->ofp_port
== ofp_port
) {
2287 static long long int
2288 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2290 struct ofport_usage
*usage
;
2292 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2293 &ofproto
->ofport_usage
) {
2294 if (usage
->ofp_port
== ofp_port
) {
2295 return usage
->last_used
;
2302 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2303 long long int last_used
)
2305 struct ofport_usage
*usage
;
2306 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2307 &ofproto
->ofport_usage
) {
2308 if (usage
->ofp_port
== ofp_port
) {
2309 usage
->last_used
= last_used
;
2313 ovs_assert(last_used
== LLONG_MAX
);
2315 usage
= xmalloc(sizeof *usage
);
2316 usage
->ofp_port
= ofp_port
;
2317 usage
->last_used
= last_used
;
2318 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2319 hash_ofp_port(ofp_port
));
2323 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2325 struct ofport_usage
*usage
;
2326 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2327 &ofproto
->ofport_usage
) {
2328 if (usage
->ofp_port
== ofp_port
) {
2329 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2337 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2339 struct ofproto
*ofproto
= port
->ofproto
;
2342 if (ofproto
->ofproto_class
->port_get_stats
) {
2343 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2352 update_port(struct ofproto
*ofproto
, const char *name
)
2354 struct ofproto_port ofproto_port
;
2355 struct ofputil_phy_port pp
;
2356 struct netdev
*netdev
;
2357 struct ofport
*port
;
2359 COVERAGE_INC(ofproto_update_port
);
2361 /* Fetch 'name''s location and properties from the datapath. */
2362 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2363 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2367 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2368 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2369 struct netdev
*old_netdev
= port
->netdev
;
2371 /* 'name' hasn't changed location. Any properties changed? */
2372 if (!ofport_equal(&port
->pp
, &pp
)) {
2373 ofport_modified(port
, &pp
);
2376 update_mtu(ofproto
, port
);
2378 /* Install the newly opened netdev in case it has changed.
2379 * Don't close the old netdev yet in case port_modified has to
2380 * remove a retained reference to it.*/
2381 port
->netdev
= netdev
;
2383 if (port
->ofproto
->ofproto_class
->port_modified
) {
2384 port
->ofproto
->ofproto_class
->port_modified(port
);
2387 netdev_close(old_netdev
);
2389 /* If 'port' is nonnull then its name differs from 'name' and thus
2390 * we should delete it. If we think there's a port named 'name'
2391 * then its port number must be wrong now so delete it too. */
2393 ofport_remove(port
);
2395 ofport_remove_with_name(ofproto
, name
);
2396 ofport_install(ofproto
, netdev
, &pp
);
2399 /* Any port named 'name' is gone now. */
2400 ofport_remove_with_name(ofproto
, name
);
2402 ofproto_port_destroy(&ofproto_port
);
2406 init_ports(struct ofproto
*p
)
2408 struct ofproto_port_dump dump
;
2409 struct ofproto_port ofproto_port
;
2410 struct shash_node
*node
, *next
;
2412 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2413 const char *name
= ofproto_port
.name
;
2415 if (shash_find(&p
->port_by_name
, name
)) {
2416 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2419 struct ofputil_phy_port pp
;
2420 struct netdev
*netdev
;
2422 /* Check if an OpenFlow port number had been requested. */
2423 node
= shash_find(&init_ofp_ports
, name
);
2425 const struct iface_hint
*iface_hint
= node
->data
;
2426 simap_put(&p
->ofp_requests
, name
,
2427 ofp_to_u16(iface_hint
->ofp_port
));
2430 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2432 ofport_install(p
, netdev
, &pp
);
2433 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2434 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2435 ofp_to_u16(ofproto_port
.ofp_port
));
2441 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2442 struct iface_hint
*iface_hint
= node
->data
;
2444 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2445 free(iface_hint
->br_name
);
2446 free(iface_hint
->br_type
);
2448 shash_delete(&init_ofp_ports
, node
);
2455 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2456 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2458 find_min_mtu(struct ofproto
*p
)
2460 struct ofport
*ofport
;
2463 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2464 struct netdev
*netdev
= ofport
->netdev
;
2467 /* Skip any internal ports, since that's what we're trying to
2469 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2473 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2476 if (!mtu
|| dev_mtu
< mtu
) {
2481 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2484 /* Update MTU of all datapath devices on 'p' to the minimum of the
2485 * non-datapath ports in event of 'port' added or changed. */
2487 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2489 struct ofport
*ofport
;
2490 struct netdev
*netdev
= port
->netdev
;
2491 int dev_mtu
, old_min
;
2493 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2497 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2498 if (dev_mtu
> p
->min_mtu
) {
2499 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2500 dev_mtu
= p
->min_mtu
;
2503 port
->mtu
= dev_mtu
;
2507 /* For non-internal port find new min mtu. */
2508 old_min
= p
->min_mtu
;
2509 port
->mtu
= dev_mtu
;
2510 p
->min_mtu
= find_min_mtu(p
);
2511 if (p
->min_mtu
== old_min
) {
2515 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2516 struct netdev
*netdev
= ofport
->netdev
;
2518 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2519 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2520 ofport
->mtu
= p
->min_mtu
;
2527 ofproto_rule_ref(struct rule
*rule
)
2530 ovs_refcount_ref(&rule
->ref_count
);
2535 ofproto_rule_unref(struct rule
*rule
)
2537 if (rule
&& ovs_refcount_unref(&rule
->ref_count
) == 1) {
2538 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2539 ofproto_rule_destroy__(rule
);
2543 struct rule_actions
*
2544 rule_get_actions(const struct rule
*rule
)
2545 OVS_EXCLUDED(rule
->mutex
)
2547 struct rule_actions
*actions
;
2549 ovs_mutex_lock(&rule
->mutex
);
2550 actions
= rule_get_actions__(rule
);
2551 ovs_mutex_unlock(&rule
->mutex
);
2556 struct rule_actions
*
2557 rule_get_actions__(const struct rule
*rule
)
2558 OVS_REQUIRES(rule
->mutex
)
2560 rule_actions_ref(rule
->actions
);
2561 return rule
->actions
;
2565 ofproto_rule_destroy__(struct rule
*rule
)
2566 OVS_NO_THREAD_SAFETY_ANALYSIS
2568 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2569 rule_actions_unref(rule
->actions
);
2570 ovs_mutex_destroy(&rule
->mutex
);
2571 ovs_refcount_destroy(&rule
->ref_count
);
2572 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2575 static uint32_t get_provider_meter_id(const struct ofproto
*,
2576 uint32_t of_meter_id
);
2578 /* Creates and returns a new 'struct rule_actions', with a ref_count of 1,
2579 * whose actions are a copy of from the 'ofpacts_len' bytes of 'ofpacts'. */
2580 struct rule_actions
*
2581 rule_actions_create(const struct ofproto
*ofproto
,
2582 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2584 struct rule_actions
*actions
;
2586 actions
= xmalloc(sizeof *actions
);
2587 ovs_refcount_init(&actions
->ref_count
);
2588 actions
->ofpacts
= xmemdup(ofpacts
, ofpacts_len
);
2589 actions
->ofpacts_len
= ofpacts_len
;
2590 actions
->provider_meter_id
2591 = get_provider_meter_id(ofproto
,
2592 ofpacts_get_meter(ofpacts
, ofpacts_len
));
2597 /* Increments 'actions''s ref_count. */
2599 rule_actions_ref(struct rule_actions
*actions
)
2602 ovs_refcount_ref(&actions
->ref_count
);
2606 /* Decrements 'actions''s ref_count and frees 'actions' if the ref_count
2609 rule_actions_unref(struct rule_actions
*actions
)
2611 if (actions
&& ovs_refcount_unref(&actions
->ref_count
) == 1) {
2612 ovs_refcount_destroy(&actions
->ref_count
);
2613 free(actions
->ofpacts
);
2618 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2619 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2621 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2622 OVS_REQUIRES(ofproto_mutex
)
2624 return (port
== OFPP_ANY
2625 || ofpacts_output_to_port(rule
->actions
->ofpacts
,
2626 rule
->actions
->ofpacts_len
, port
));
2629 /* Returns true if 'rule' has group and equals group_id. */
2631 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
2632 OVS_REQUIRES(ofproto_mutex
)
2634 return (group_id
== OFPG11_ANY
2635 || ofpacts_output_to_group(rule
->actions
->ofpacts
,
2636 rule
->actions
->ofpacts_len
, group_id
));
2639 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2640 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2642 ofoperation_has_out_port(const struct ofoperation
*op
, ofp_port_t out_port
)
2643 OVS_REQUIRES(ofproto_mutex
)
2645 if (ofproto_rule_has_out_port(op
->rule
, out_port
)) {
2650 case OFOPERATION_ADD
:
2651 case OFOPERATION_DELETE
:
2654 case OFOPERATION_MODIFY
:
2655 case OFOPERATION_REPLACE
:
2656 return ofpacts_output_to_port(op
->actions
->ofpacts
,
2657 op
->actions
->ofpacts_len
, out_port
);
2664 rule_execute_destroy(struct rule_execute
*e
)
2666 ofproto_rule_unref(e
->rule
);
2667 list_remove(&e
->list_node
);
2671 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2672 * by passing them to the ofproto provider. */
2674 run_rule_executes(struct ofproto
*ofproto
)
2675 OVS_EXCLUDED(ofproto_mutex
)
2677 struct rule_execute
*e
, *next
;
2678 struct list executes
;
2680 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2681 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2682 union flow_in_port in_port_
;
2685 in_port_
.ofp_port
= e
->in_port
;
2686 flow_extract(e
->packet
, 0, 0, NULL
, &in_port_
, &flow
);
2687 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
2689 rule_execute_destroy(e
);
2693 /* Destroys and discards all "rule_execute" operations queued up in
2694 * ofproto->rule_executes. */
2696 destroy_rule_executes(struct ofproto
*ofproto
)
2698 struct rule_execute
*e
, *next
;
2699 struct list executes
;
2701 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2702 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2703 ofpbuf_delete(e
->packet
);
2704 rule_execute_destroy(e
);
2708 /* Returns true if 'rule' should be hidden from the controller.
2710 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2711 * (e.g. by in-band control) and are intentionally hidden from the
2714 ofproto_rule_is_hidden(const struct rule
*rule
)
2716 return rule
->cr
.priority
> UINT16_MAX
;
2719 static enum oftable_flags
2720 rule_get_flags(const struct rule
*rule
)
2722 return rule
->ofproto
->tables
[rule
->table_id
].flags
;
2726 rule_is_modifiable(const struct rule
*rule
)
2728 return !(rule_get_flags(rule
) & OFTABLE_READONLY
);
2732 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2734 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
2739 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2741 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2742 struct ofputil_switch_features features
;
2743 struct ofport
*port
;
2749 ofproto
->ofproto_class
->get_features(ofproto
, &arp_match_ip
,
2751 ovs_assert(features
.actions
& OFPUTIL_A_OUTPUT
); /* sanity check */
2753 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2754 * if present, are always at the end.) */
2755 n_tables
= ofproto
->n_tables
;
2756 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2757 if (ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
) {
2763 features
.datapath_id
= ofproto
->datapath_id
;
2764 features
.n_buffers
= pktbuf_capacity();
2765 features
.n_tables
= n_tables
;
2766 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
2767 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
);
2769 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
2771 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2772 features
.auxiliary_id
= 0;
2773 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
2775 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
2776 ofputil_put_switch_features_port(&port
->pp
, b
);
2779 ofconn_send_reply(ofconn
, b
);
2784 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2786 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2787 struct ofp_switch_config
*osc
;
2788 enum ofp_config_flags flags
;
2792 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
2793 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
2794 flags
= ofproto
->frag_handling
;
2795 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2796 if (oh
->version
< OFP13_VERSION
2797 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
2798 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
2800 osc
->flags
= htons(flags
);
2801 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
2802 ofconn_send_reply(ofconn
, buf
);
2808 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2810 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
2811 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2812 uint16_t flags
= ntohs(osc
->flags
);
2814 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
2815 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
2816 enum ofp_config_flags cur
= ofproto
->frag_handling
;
2817 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
2819 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
2821 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
2822 ofproto
->frag_handling
= next
;
2824 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
2826 ofputil_frag_handling_to_string(next
));
2830 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2831 ofconn_set_invalid_ttl_to_controller(ofconn
,
2832 (oh
->version
< OFP13_VERSION
2833 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
2835 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
2840 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2841 * error message code for the caller to propagate upward. Otherwise, returns
2844 * The log message mentions 'msg_type'. */
2846 reject_slave_controller(struct ofconn
*ofconn
)
2848 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
2849 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
2850 return OFPERR_OFPBRC_EPERM
;
2856 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2859 * - If they use a meter, then 'ofproto' has that meter configured.
2861 * - If they use any groups, then 'ofproto' has that group configured.
2863 * Returns 0 if successful, otherwise an OpenFlow error. */
2865 ofproto_check_ofpacts(struct ofproto
*ofproto
,
2866 const struct ofpact ofpacts
[], size_t ofpacts_len
)
2868 const struct ofpact
*a
;
2871 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
2872 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
2873 return OFPERR_OFPMMFC_INVALID_METER
;
2876 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
2877 if (a
->type
== OFPACT_GROUP
2878 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
2879 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
2887 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2889 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2890 struct ofputil_packet_out po
;
2891 struct ofpbuf
*payload
;
2892 uint64_t ofpacts_stub
[1024 / 8];
2893 struct ofpbuf ofpacts
;
2895 union flow_in_port in_port_
;
2898 COVERAGE_INC(ofproto_packet_out
);
2900 error
= reject_slave_controller(ofconn
);
2905 /* Decode message. */
2906 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
2907 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
2909 goto exit_free_ofpacts
;
2911 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
2912 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
2913 error
= OFPERR_OFPBRC_BAD_PORT
;
2914 goto exit_free_ofpacts
;
2918 if (po
.buffer_id
!= UINT32_MAX
) {
2919 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
2920 if (error
|| !payload
) {
2921 goto exit_free_ofpacts
;
2924 /* Ensure that the L3 header is 32-bit aligned. */
2925 payload
= ofpbuf_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
2928 /* Verify actions against packet, then send packet if successful. */
2929 in_port_
.ofp_port
= po
.in_port
;
2930 flow_extract(payload
, 0, 0, NULL
, &in_port_
, &flow
);
2931 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
2933 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
2934 po
.ofpacts
, po
.ofpacts_len
);
2936 ofpbuf_delete(payload
);
2939 ofpbuf_uninit(&ofpacts
);
2945 update_port_config(struct ofport
*port
,
2946 enum ofputil_port_config config
,
2947 enum ofputil_port_config mask
)
2949 enum ofputil_port_config old_config
= port
->pp
.config
;
2950 enum ofputil_port_config toggle
;
2952 toggle
= (config
^ port
->pp
.config
) & mask
;
2953 if (toggle
& OFPUTIL_PC_PORT_DOWN
) {
2954 if (config
& OFPUTIL_PC_PORT_DOWN
) {
2955 netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
);
2957 netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
);
2959 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
2962 port
->pp
.config
^= toggle
;
2963 if (port
->pp
.config
!= old_config
) {
2964 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
2969 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2971 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2972 struct ofputil_port_mod pm
;
2973 struct ofport
*port
;
2976 error
= reject_slave_controller(ofconn
);
2981 error
= ofputil_decode_port_mod(oh
, &pm
);
2986 port
= ofproto_get_port(p
, pm
.port_no
);
2988 return OFPERR_OFPPMFC_BAD_PORT
;
2989 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
2990 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
2992 update_port_config(port
, pm
.config
, pm
.mask
);
2994 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
3001 handle_desc_stats_request(struct ofconn
*ofconn
,
3002 const struct ofp_header
*request
)
3004 static const char *default_mfr_desc
= "Nicira, Inc.";
3005 static const char *default_hw_desc
= "Open vSwitch";
3006 static const char *default_sw_desc
= VERSION
;
3007 static const char *default_serial_desc
= "None";
3008 static const char *default_dp_desc
= "None";
3010 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3011 struct ofp_desc_stats
*ods
;
3014 msg
= ofpraw_alloc_stats_reply(request
, 0);
3015 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3016 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3017 sizeof ods
->mfr_desc
);
3018 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3019 sizeof ods
->hw_desc
);
3020 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3021 sizeof ods
->sw_desc
);
3022 ovs_strlcpy(ods
->serial_num
,
3023 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3024 sizeof ods
->serial_num
);
3025 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3026 sizeof ods
->dp_desc
);
3027 ofconn_send_reply(ofconn
, msg
);
3033 handle_table_stats_request(struct ofconn
*ofconn
,
3034 const struct ofp_header
*request
)
3036 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3037 struct ofp12_table_stats
*ots
;
3042 /* Set up default values.
3044 * ofp12_table_stats is used as a generic structure as
3045 * it is able to hold all the fields for ofp10_table_stats
3046 * and ofp11_table_stats (and of course itself).
3048 ots
= xcalloc(p
->n_tables
, sizeof *ots
);
3049 for (i
= 0; i
< p
->n_tables
; i
++) {
3050 ots
[i
].table_id
= i
;
3051 sprintf(ots
[i
].name
, "table%"PRIuSIZE
, i
);
3052 ots
[i
].match
= htonll(OFPXMT13_MASK
);
3053 ots
[i
].wildcards
= htonll(OFPXMT13_MASK
);
3054 ots
[i
].write_actions
= htonl(OFPAT11_OUTPUT
);
3055 ots
[i
].apply_actions
= htonl(OFPAT11_OUTPUT
);
3056 ots
[i
].write_setfields
= htonll(OFPXMT13_MASK
);
3057 ots
[i
].apply_setfields
= htonll(OFPXMT13_MASK
);
3058 ots
[i
].metadata_match
= OVS_BE64_MAX
;
3059 ots
[i
].metadata_write
= OVS_BE64_MAX
;
3060 ots
[i
].instructions
= htonl(OFPIT11_ALL
);
3061 ots
[i
].config
= htonl(OFPTC11_TABLE_MISS_MASK
);
3062 ots
[i
].max_entries
= htonl(1000000); /* An arbitrary big number. */
3063 fat_rwlock_rdlock(&p
->tables
[i
].cls
.rwlock
);
3064 ots
[i
].active_count
= htonl(classifier_count(&p
->tables
[i
].cls
));
3065 fat_rwlock_unlock(&p
->tables
[i
].cls
.rwlock
);
3068 p
->ofproto_class
->get_tables(p
, ots
);
3070 /* Post-process the tables, dropping hidden tables. */
3071 n_tables
= p
->n_tables
;
3072 for (i
= 0; i
< p
->n_tables
; i
++) {
3073 const struct oftable
*table
= &p
->tables
[i
];
3075 if (table
->flags
& OFTABLE_HIDDEN
) {
3081 ovs_strzcpy(ots
[i
].name
, table
->name
, sizeof ots
[i
].name
);
3084 if (table
->max_flows
< ntohl(ots
[i
].max_entries
)) {
3085 ots
[i
].max_entries
= htonl(table
->max_flows
);
3089 msg
= ofputil_encode_table_stats_reply(ots
, n_tables
, request
);
3090 ofconn_send_reply(ofconn
, msg
);
3098 append_port_stat(struct ofport
*port
, struct list
*replies
)
3100 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3102 calc_duration(port
->created
, time_msec(),
3103 &ops
.duration_sec
, &ops
.duration_nsec
);
3105 /* Intentionally ignore return value, since errors will set
3106 * 'stats' to all-1s, which is correct for OpenFlow, and
3107 * netdev_get_stats() will log errors. */
3108 ofproto_port_get_stats(port
, &ops
.stats
);
3110 ofputil_append_port_stat(replies
, &ops
);
3114 handle_port_stats_request(struct ofconn
*ofconn
,
3115 const struct ofp_header
*request
)
3117 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3118 struct ofport
*port
;
3119 struct list replies
;
3123 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3128 ofpmp_init(&replies
, request
);
3129 if (port_no
!= OFPP_ANY
) {
3130 port
= ofproto_get_port(p
, port_no
);
3132 append_port_stat(port
, &replies
);
3135 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
3136 append_port_stat(port
, &replies
);
3140 ofconn_send_replies(ofconn
, &replies
);
3145 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3146 const struct ofp_header
*request
)
3148 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3149 enum ofp_version version
;
3150 struct ofport
*port
;
3151 struct list replies
;
3153 ofpmp_init(&replies
, request
);
3155 version
= ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn
));
3156 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
3157 ofputil_append_port_desc_stats_reply(version
, &port
->pp
, &replies
);
3160 ofconn_send_replies(ofconn
, &replies
);
3165 hash_cookie(ovs_be64 cookie
)
3167 return hash_2words((OVS_FORCE
uint64_t)cookie
>> 32,
3168 (OVS_FORCE
uint64_t)cookie
);
3172 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3173 OVS_REQUIRES(ofproto_mutex
)
3175 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3176 hash_cookie(rule
->flow_cookie
));
3180 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3181 OVS_REQUIRES(ofproto_mutex
)
3183 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3187 ofproto_rule_change_cookie(struct ofproto
*ofproto
, struct rule
*rule
,
3188 ovs_be64 new_cookie
)
3189 OVS_REQUIRES(ofproto_mutex
)
3191 if (new_cookie
!= rule
->flow_cookie
) {
3192 cookies_remove(ofproto
, rule
);
3194 ovs_mutex_lock(&rule
->mutex
);
3195 rule
->flow_cookie
= new_cookie
;
3196 ovs_mutex_unlock(&rule
->mutex
);
3198 cookies_insert(ofproto
, rule
);
3203 calc_duration(long long int start
, long long int now
,
3204 uint32_t *sec
, uint32_t *nsec
)
3206 long long int msecs
= now
- start
;
3207 *sec
= msecs
/ 1000;
3208 *nsec
= (msecs
% 1000) * (1000 * 1000);
3211 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3212 * true if 'table_id' is OK, false otherwise. */
3214 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3216 return table_id
== OFPTT_ALL
|| table_id
< ofproto
->n_tables
;
3219 static struct oftable
*
3220 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3222 struct oftable
*table
;
3224 for (table
= &ofproto
->tables
[table_id
];
3225 table
< &ofproto
->tables
[ofproto
->n_tables
];
3227 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3235 static struct oftable
*
3236 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3238 if (table_id
== 0xff) {
3239 return next_visible_table(ofproto
, 0);
3240 } else if (table_id
< ofproto
->n_tables
) {
3241 return &ofproto
->tables
[table_id
];
3247 static struct oftable
*
3248 next_matching_table(const struct ofproto
*ofproto
,
3249 const struct oftable
*table
, uint8_t table_id
)
3251 return (table_id
== 0xff
3252 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3256 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3258 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3259 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3261 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3262 * only once, for that table. (This can be used to access tables marked
3265 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3266 * entered at all. (Perhaps you should have validated TABLE_ID with
3267 * check_table_id().)
3269 * All parameters are evaluated multiple times.
3271 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3272 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3274 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3276 /* Initializes 'criteria' in a straightforward way based on the other
3279 * For "loose" matching, the 'priority' parameter is unimportant and may be
3282 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3283 const struct match
*match
, unsigned int priority
,
3284 ovs_be64 cookie
, ovs_be64 cookie_mask
,
3285 ofp_port_t out_port
, uint32_t out_group
)
3287 criteria
->table_id
= table_id
;
3288 cls_rule_init(&criteria
->cr
, match
, priority
);
3289 criteria
->cookie
= cookie
;
3290 criteria
->cookie_mask
= cookie_mask
;
3291 criteria
->out_port
= out_port
;
3292 criteria
->out_group
= out_group
;
3296 rule_criteria_destroy(struct rule_criteria
*criteria
)
3298 cls_rule_destroy(&criteria
->cr
);
3302 rule_collection_init(struct rule_collection
*rules
)
3304 rules
->rules
= rules
->stub
;
3306 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
3310 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
3312 if (rules
->n
>= rules
->capacity
) {
3313 size_t old_size
, new_size
;
3315 old_size
= rules
->capacity
* sizeof *rules
->rules
;
3316 rules
->capacity
*= 2;
3317 new_size
= rules
->capacity
* sizeof *rules
->rules
;
3319 if (rules
->rules
== rules
->stub
) {
3320 rules
->rules
= xmalloc(new_size
);
3321 memcpy(rules
->rules
, rules
->stub
, old_size
);
3323 rules
->rules
= xrealloc(rules
->rules
, new_size
);
3327 rules
->rules
[rules
->n
++] = rule
;
3331 rule_collection_ref(struct rule_collection
*rules
)
3332 OVS_REQUIRES(ofproto_mutex
)
3336 for (i
= 0; i
< rules
->n
; i
++) {
3337 ofproto_rule_ref(rules
->rules
[i
]);
3342 rule_collection_unref(struct rule_collection
*rules
)
3346 for (i
= 0; i
< rules
->n
; i
++) {
3347 ofproto_rule_unref(rules
->rules
[i
]);
3352 rule_collection_destroy(struct rule_collection
*rules
)
3354 if (rules
->rules
!= rules
->stub
) {
3360 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
3361 struct rule_collection
*rules
)
3362 OVS_REQUIRES(ofproto_mutex
)
3364 /* We ordinarily want to skip hidden rules, but there has to be a way for
3365 * code internal to OVS to modify and delete them, so if the criteria
3366 * specify a priority that can only be for a hidden flow, then allow hidden
3367 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3368 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3370 if (ofproto_rule_is_hidden(rule
) && c
->cr
.priority
<= UINT16_MAX
) {
3372 } else if (rule
->pending
) {
3373 return OFPROTO_POSTPONE
;
3375 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
3376 && ofproto_rule_has_out_port(rule
, c
->out_port
)
3377 && ofproto_rule_has_out_group(rule
, c
->out_group
)
3378 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)) {
3379 rule_collection_add(rules
, rule
);
3385 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3386 * on classifiers rules are done in the "loose" way required for OpenFlow
3387 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3390 * Hidden rules are always omitted.
3392 * Returns 0 on success, otherwise an OpenFlow error code. */
3394 collect_rules_loose(struct ofproto
*ofproto
,
3395 const struct rule_criteria
*criteria
,
3396 struct rule_collection
*rules
)
3397 OVS_REQUIRES(ofproto_mutex
)
3399 struct oftable
*table
;
3400 enum ofperr error
= 0;
3402 rule_collection_init(rules
);
3404 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3405 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3409 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3412 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3413 hash_cookie(criteria
->cookie
),
3414 &ofproto
->cookies
) {
3415 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
3416 error
= collect_rule(rule
, criteria
, rules
);
3423 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3424 struct cls_cursor cursor
;
3427 fat_rwlock_rdlock(&table
->cls
.rwlock
);
3428 cls_cursor_init(&cursor
, &table
->cls
, &criteria
->cr
);
3429 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
3430 error
= collect_rule(rule
, criteria
, rules
);
3435 fat_rwlock_unlock(&table
->cls
.rwlock
);
3441 rule_collection_destroy(rules
);
3446 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3447 * on classifiers rules are done in the "strict" way required for OpenFlow
3448 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3449 * rules on list 'rules'.
3451 * Hidden rules are always omitted.
3453 * Returns 0 on success, otherwise an OpenFlow error code. */
3455 collect_rules_strict(struct ofproto
*ofproto
,
3456 const struct rule_criteria
*criteria
,
3457 struct rule_collection
*rules
)
3458 OVS_REQUIRES(ofproto_mutex
)
3460 struct oftable
*table
;
3463 rule_collection_init(rules
);
3465 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3466 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3470 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3473 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3474 hash_cookie(criteria
->cookie
),
3475 &ofproto
->cookies
) {
3476 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
3477 error
= collect_rule(rule
, criteria
, rules
);
3484 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3487 fat_rwlock_rdlock(&table
->cls
.rwlock
);
3488 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
3489 &table
->cls
, &criteria
->cr
));
3490 fat_rwlock_unlock(&table
->cls
.rwlock
);
3492 error
= collect_rule(rule
, criteria
, rules
);
3502 rule_collection_destroy(rules
);
3507 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3508 * forced into the range of a uint16_t. */
3510 age_secs(long long int age_ms
)
3512 return (age_ms
< 0 ? 0
3513 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
3514 : (unsigned int) age_ms
/ 1000);
3518 handle_flow_stats_request(struct ofconn
*ofconn
,
3519 const struct ofp_header
*request
)
3520 OVS_EXCLUDED(ofproto_mutex
)
3522 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3523 struct ofputil_flow_stats_request fsr
;
3524 struct rule_criteria criteria
;
3525 struct rule_collection rules
;
3526 struct list replies
;
3530 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
3535 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, fsr
.cookie
,
3536 fsr
.cookie_mask
, fsr
.out_port
, fsr
.out_group
);
3538 ovs_mutex_lock(&ofproto_mutex
);
3539 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3540 rule_criteria_destroy(&criteria
);
3542 rule_collection_ref(&rules
);
3544 ovs_mutex_unlock(&ofproto_mutex
);
3550 ofpmp_init(&replies
, request
);
3551 for (i
= 0; i
< rules
.n
; i
++) {
3552 struct rule
*rule
= rules
.rules
[i
];
3553 long long int now
= time_msec();
3554 struct ofputil_flow_stats fs
;
3555 long long int created
, used
, modified
;
3556 struct rule_actions
*actions
;
3557 enum ofputil_flow_mod_flags flags
;
3559 ovs_mutex_lock(&rule
->mutex
);
3560 fs
.cookie
= rule
->flow_cookie
;
3561 fs
.idle_timeout
= rule
->idle_timeout
;
3562 fs
.hard_timeout
= rule
->hard_timeout
;
3563 created
= rule
->created
;
3565 modified
= rule
->modified
;
3566 actions
= rule_get_actions__(rule
);
3567 flags
= rule
->flags
;
3568 ovs_mutex_unlock(&rule
->mutex
);
3570 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
3571 fs
.table_id
= rule
->table_id
;
3572 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
3573 fs
.priority
= rule
->cr
.priority
;
3574 fs
.idle_age
= age_secs(now
- used
);
3575 fs
.hard_age
= age_secs(now
- modified
);
3576 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
3578 fs
.ofpacts
= actions
->ofpacts
;
3579 fs
.ofpacts_len
= actions
->ofpacts_len
;
3582 ofputil_append_flow_stats_reply(&fs
, &replies
);
3584 rule_actions_unref(actions
);
3587 rule_collection_unref(&rules
);
3588 rule_collection_destroy(&rules
);
3590 ofconn_send_replies(ofconn
, &replies
);
3596 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
3598 uint64_t packet_count
, byte_count
;
3599 struct rule_actions
*actions
;
3600 long long int created
;
3602 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
,
3603 &packet_count
, &byte_count
);
3605 ovs_mutex_lock(&rule
->mutex
);
3606 actions
= rule_get_actions__(rule
);
3607 created
= rule
->created
;
3608 ovs_mutex_unlock(&rule
->mutex
);
3610 if (rule
->table_id
!= 0) {
3611 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
3613 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
3614 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
3615 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
3616 cls_rule_format(&rule
->cr
, results
);
3617 ds_put_char(results
, ',');
3619 ds_put_cstr(results
, "actions=");
3620 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
3622 ds_put_cstr(results
, "\n");
3624 rule_actions_unref(actions
);
3627 /* Adds a pretty-printed description of all flows to 'results', including
3628 * hidden flows (e.g., set up by in-band control). */
3630 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
3632 struct oftable
*table
;
3634 OFPROTO_FOR_EACH_TABLE (table
, p
) {
3635 struct cls_cursor cursor
;
3638 fat_rwlock_rdlock(&table
->cls
.rwlock
);
3639 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
3640 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
3641 flow_stats_ds(rule
, results
);
3643 fat_rwlock_unlock(&table
->cls
.rwlock
);
3647 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3648 * '*engine_type' and '*engine_id', respectively. */
3650 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
3651 uint8_t *engine_type
, uint8_t *engine_id
)
3653 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
3656 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3657 * true if the port's CFM status was successfully stored into '*status'.
3658 * Returns false if the port did not have CFM configured, in which case
3659 * '*status' is indeterminate.
3661 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3663 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
3664 struct ofproto_cfm_status
*status
)
3666 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3668 && ofproto
->ofproto_class
->get_cfm_status
3669 && ofproto
->ofproto_class
->get_cfm_status(ofport
, status
));
3673 handle_aggregate_stats_request(struct ofconn
*ofconn
,
3674 const struct ofp_header
*oh
)
3675 OVS_EXCLUDED(ofproto_mutex
)
3677 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3678 struct ofputil_flow_stats_request request
;
3679 struct ofputil_aggregate_stats stats
;
3680 bool unknown_packets
, unknown_bytes
;
3681 struct rule_criteria criteria
;
3682 struct rule_collection rules
;
3683 struct ofpbuf
*reply
;
3687 error
= ofputil_decode_flow_stats_request(&request
, oh
);
3692 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
3693 request
.cookie
, request
.cookie_mask
,
3694 request
.out_port
, request
.out_group
);
3696 ovs_mutex_lock(&ofproto_mutex
);
3697 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3698 rule_criteria_destroy(&criteria
);
3700 rule_collection_ref(&rules
);
3702 ovs_mutex_unlock(&ofproto_mutex
);
3708 memset(&stats
, 0, sizeof stats
);
3709 unknown_packets
= unknown_bytes
= false;
3710 for (i
= 0; i
< rules
.n
; i
++) {
3711 struct rule
*rule
= rules
.rules
[i
];
3712 uint64_t packet_count
;
3713 uint64_t byte_count
;
3715 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3718 if (packet_count
== UINT64_MAX
) {
3719 unknown_packets
= true;
3721 stats
.packet_count
+= packet_count
;
3724 if (byte_count
== UINT64_MAX
) {
3725 unknown_bytes
= true;
3727 stats
.byte_count
+= byte_count
;
3732 if (unknown_packets
) {
3733 stats
.packet_count
= UINT64_MAX
;
3735 if (unknown_bytes
) {
3736 stats
.byte_count
= UINT64_MAX
;
3739 rule_collection_unref(&rules
);
3740 rule_collection_destroy(&rules
);
3742 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
3743 ofconn_send_reply(ofconn
, reply
);
3748 struct queue_stats_cbdata
{
3749 struct ofport
*ofport
;
3750 struct list replies
;
3755 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
3756 const struct netdev_queue_stats
*stats
)
3758 struct ofputil_queue_stats oqs
;
3760 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
3761 oqs
.queue_id
= queue_id
;
3762 oqs
.tx_bytes
= stats
->tx_bytes
;
3763 oqs
.tx_packets
= stats
->tx_packets
;
3764 oqs
.tx_errors
= stats
->tx_errors
;
3765 if (stats
->created
!= LLONG_MIN
) {
3766 calc_duration(stats
->created
, cbdata
->now
,
3767 &oqs
.duration_sec
, &oqs
.duration_nsec
);
3769 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
3771 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
3775 handle_queue_stats_dump_cb(uint32_t queue_id
,
3776 struct netdev_queue_stats
*stats
,
3779 struct queue_stats_cbdata
*cbdata
= cbdata_
;
3781 put_queue_stats(cbdata
, queue_id
, stats
);
3785 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
3786 struct queue_stats_cbdata
*cbdata
)
3788 cbdata
->ofport
= port
;
3789 if (queue_id
== OFPQ_ALL
) {
3790 netdev_dump_queue_stats(port
->netdev
,
3791 handle_queue_stats_dump_cb
, cbdata
);
3793 struct netdev_queue_stats stats
;
3795 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
3796 put_queue_stats(cbdata
, queue_id
, &stats
);
3798 return OFPERR_OFPQOFC_BAD_QUEUE
;
3805 handle_queue_stats_request(struct ofconn
*ofconn
,
3806 const struct ofp_header
*rq
)
3808 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3809 struct queue_stats_cbdata cbdata
;
3810 struct ofport
*port
;
3812 struct ofputil_queue_stats_request oqsr
;
3814 COVERAGE_INC(ofproto_queue_req
);
3816 ofpmp_init(&cbdata
.replies
, rq
);
3817 cbdata
.now
= time_msec();
3819 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
3824 if (oqsr
.port_no
== OFPP_ANY
) {
3825 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
3826 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3827 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
3832 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
3834 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
3835 : OFPERR_OFPQOFC_BAD_PORT
);
3838 ofconn_send_replies(ofconn
, &cbdata
.replies
);
3840 ofpbuf_list_delete(&cbdata
.replies
);
3847 is_flow_deletion_pending(const struct ofproto
*ofproto
,
3848 const struct cls_rule
*cls_rule
,
3850 OVS_REQUIRES(ofproto_mutex
)
3852 if (!hmap_is_empty(&ofproto
->deletions
)) {
3853 struct ofoperation
*op
;
3855 HMAP_FOR_EACH_WITH_HASH (op
, hmap_node
,
3856 cls_rule_hash(cls_rule
, table_id
),
3857 &ofproto
->deletions
) {
3858 if (cls_rule_equal(cls_rule
, &op
->rule
->cr
)) {
3868 should_evict_a_rule(struct oftable
*table
, unsigned int extra_space
)
3869 OVS_REQUIRES(ofproto_mutex
)
3870 OVS_NO_THREAD_SAFETY_ANALYSIS
3872 return classifier_count(&table
->cls
) + extra_space
> table
->max_flows
;
3876 evict_rules_from_table(struct ofproto
*ofproto
, struct oftable
*table
,
3877 unsigned int extra_space
)
3878 OVS_REQUIRES(ofproto_mutex
)
3880 while (should_evict_a_rule(table
, extra_space
)) {
3883 if (!choose_rule_to_evict(table
, &rule
)) {
3884 return OFPERR_OFPFMFC_TABLE_FULL
;
3885 } else if (rule
->pending
) {
3886 return OFPROTO_POSTPONE
;
3888 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
3889 delete_flow__(rule
, group
, OFPRR_EVICTION
);
3890 ofopgroup_submit(group
);
3897 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3898 * in which no matching flow already exists in the flow table.
3900 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3901 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3902 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3903 * initiated now but may be retried later.
3905 * The caller retains ownership of 'fm->ofpacts'.
3907 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3910 add_flow(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3911 struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
)
3912 OVS_REQUIRES(ofproto_mutex
)
3914 struct oftable
*table
;
3915 struct ofopgroup
*group
;
3921 if (!check_table_id(ofproto
, fm
->table_id
)) {
3922 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3927 if (fm
->table_id
== 0xff) {
3928 if (ofproto
->ofproto_class
->rule_choose_table
) {
3929 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
3935 ovs_assert(table_id
< ofproto
->n_tables
);
3939 } else if (fm
->table_id
< ofproto
->n_tables
) {
3940 table_id
= fm
->table_id
;
3942 return OFPERR_OFPBRC_BAD_TABLE_ID
;
3945 table
= &ofproto
->tables
[table_id
];
3947 if (table
->flags
& OFTABLE_READONLY
) {
3948 return OFPERR_OFPBRC_EPERM
;
3951 cls_rule_init(&cr
, &fm
->match
, fm
->priority
);
3953 /* Transform "add" into "modify" if there's an existing identical flow. */
3954 fat_rwlock_rdlock(&table
->cls
.rwlock
);
3955 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
));
3956 fat_rwlock_unlock(&table
->cls
.rwlock
);
3958 cls_rule_destroy(&cr
);
3959 if (!rule_is_modifiable(rule
)) {
3960 return OFPERR_OFPBRC_EPERM
;
3961 } else if (rule
->pending
) {
3962 return OFPROTO_POSTPONE
;
3964 struct rule_collection rules
;
3966 rule_collection_init(&rules
);
3967 rule_collection_add(&rules
, rule
);
3968 fm
->modify_cookie
= true;
3969 error
= modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
);
3970 rule_collection_destroy(&rules
);
3976 /* Serialize against pending deletion. */
3977 if (is_flow_deletion_pending(ofproto
, &cr
, table_id
)) {
3978 cls_rule_destroy(&cr
);
3979 return OFPROTO_POSTPONE
;
3982 /* Check for overlap, if requested. */
3983 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
) {
3986 fat_rwlock_rdlock(&table
->cls
.rwlock
);
3987 overlaps
= classifier_rule_overlaps(&table
->cls
, &cr
);
3988 fat_rwlock_unlock(&table
->cls
.rwlock
);
3991 cls_rule_destroy(&cr
);
3992 return OFPERR_OFPFMFC_OVERLAP
;
3996 /* If necessary, evict an existing rule to clear out space. */
3997 error
= evict_rules_from_table(ofproto
, table
, 1);
3999 cls_rule_destroy(&cr
);
4003 /* Allocate new rule. */
4004 rule
= ofproto
->ofproto_class
->rule_alloc();
4006 cls_rule_destroy(&cr
);
4007 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
4008 ofproto
->name
, ovs_strerror(error
));
4012 /* Initialize base state. */
4013 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4014 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), &cr
);
4015 ovs_refcount_init(&rule
->ref_count
);
4016 rule
->pending
= NULL
;
4017 rule
->flow_cookie
= fm
->new_cookie
;
4018 rule
->created
= rule
->modified
= rule
->used
= time_msec();
4020 ovs_mutex_init(&rule
->mutex
);
4021 ovs_mutex_lock(&rule
->mutex
);
4022 rule
->idle_timeout
= fm
->idle_timeout
;
4023 rule
->hard_timeout
= fm
->hard_timeout
;
4024 ovs_mutex_unlock(&rule
->mutex
);
4026 *CONST_CAST(uint8_t *, &rule
->table_id
) = table
- ofproto
->tables
;
4027 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4028 rule
->actions
= rule_actions_create(ofproto
, fm
->ofpacts
, fm
->ofpacts_len
);
4029 list_init(&rule
->meter_list_node
);
4030 rule
->eviction_group
= NULL
;
4031 list_init(&rule
->expirable
);
4032 rule
->monitor_flags
= 0;
4033 rule
->add_seqno
= 0;
4034 rule
->modify_seqno
= 0;
4036 /* Construct rule, initializing derived state. */
4037 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4039 ofproto_rule_destroy__(rule
);
4044 oftable_insert_rule(rule
);
4046 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
4047 ofoperation_create(group
, rule
, OFOPERATION_ADD
, 0);
4048 ofproto
->ofproto_class
->rule_insert(rule
);
4049 ofopgroup_submit(group
);
4054 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4056 /* Modifies the rules listed in 'rules', changing their actions to match those
4059 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4062 * Returns 0 on success, otherwise an OpenFlow error code. */
4064 modify_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4065 struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
,
4066 const struct rule_collection
*rules
)
4067 OVS_REQUIRES(ofproto_mutex
)
4069 enum ofoperation_type type
;
4070 struct ofopgroup
*group
;
4074 type
= fm
->command
== OFPFC_ADD
? OFOPERATION_REPLACE
: OFOPERATION_MODIFY
;
4075 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
4076 error
= OFPERR_OFPBRC_EPERM
;
4077 for (i
= 0; i
< rules
->n
; i
++) {
4078 struct rule
*rule
= rules
->rules
[i
];
4079 struct ofoperation
*op
;
4080 bool actions_changed
;
4081 bool reset_counters
;
4083 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4085 if (rule_is_modifiable(rule
)) {
4086 /* At least one rule is modifiable, don't report EPERM error. */
4092 actions_changed
= !ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
4093 rule
->actions
->ofpacts
,
4094 rule
->actions
->ofpacts_len
);
4096 op
= ofoperation_create(group
, rule
, type
, 0);
4098 if (fm
->modify_cookie
&& fm
->new_cookie
!= OVS_BE64_MAX
) {
4099 ofproto_rule_change_cookie(ofproto
, rule
, fm
->new_cookie
);
4101 if (type
== OFOPERATION_REPLACE
) {
4102 ovs_mutex_lock(&rule
->mutex
);
4103 rule
->idle_timeout
= fm
->idle_timeout
;
4104 rule
->hard_timeout
= fm
->hard_timeout
;
4105 ovs_mutex_unlock(&rule
->mutex
);
4107 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4108 if (fm
->idle_timeout
|| fm
->hard_timeout
) {
4109 if (!rule
->eviction_group
) {
4110 eviction_group_add_rule(rule
);
4113 eviction_group_remove_rule(rule
);
4117 reset_counters
= (fm
->flags
& OFPUTIL_FF_RESET_COUNTS
) != 0;
4118 if (actions_changed
|| reset_counters
) {
4119 struct rule_actions
*new_actions
;
4121 op
->actions
= rule
->actions
;
4122 new_actions
= rule_actions_create(ofproto
,
4123 fm
->ofpacts
, fm
->ofpacts_len
);
4125 ovs_mutex_lock(&rule
->mutex
);
4126 rule
->actions
= new_actions
;
4127 ovs_mutex_unlock(&rule
->mutex
);
4129 rule
->ofproto
->ofproto_class
->rule_modify_actions(rule
,
4132 ofoperation_complete(op
, 0);
4135 ofopgroup_submit(group
);
4141 modify_flows_add(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4142 struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
)
4143 OVS_REQUIRES(ofproto_mutex
)
4145 if (fm
->cookie_mask
!= htonll(0) || fm
->new_cookie
== OVS_BE64_MAX
) {
4148 return add_flow(ofproto
, ofconn
, fm
, request
);
4151 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4154 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4157 modify_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4158 struct ofputil_flow_mod
*fm
,
4159 const struct ofp_header
*request
)
4160 OVS_REQUIRES(ofproto_mutex
)
4162 struct rule_criteria criteria
;
4163 struct rule_collection rules
;
4166 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4167 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4168 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4169 rule_criteria_destroy(&criteria
);
4172 error
= (rules
.n
> 0
4173 ? modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
)
4174 : modify_flows_add(ofproto
, ofconn
, fm
, request
));
4177 rule_collection_destroy(&rules
);
4182 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4185 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4188 modify_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4189 struct ofputil_flow_mod
*fm
,
4190 const struct ofp_header
*request
)
4191 OVS_REQUIRES(ofproto_mutex
)
4193 struct rule_criteria criteria
;
4194 struct rule_collection rules
;
4197 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4198 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4199 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4200 rule_criteria_destroy(&criteria
);
4204 error
= modify_flows_add(ofproto
, ofconn
, fm
, request
);
4205 } else if (rules
.n
== 1) {
4206 error
= modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
);
4210 rule_collection_destroy(&rules
);
4215 /* OFPFC_DELETE implementation. */
4218 delete_flow__(struct rule
*rule
, struct ofopgroup
*group
,
4219 enum ofp_flow_removed_reason reason
)
4220 OVS_REQUIRES(ofproto_mutex
)
4222 struct ofproto
*ofproto
= rule
->ofproto
;
4224 ofproto_rule_send_removed(rule
, reason
);
4226 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, reason
);
4227 oftable_remove_rule(rule
);
4228 ofproto
->ofproto_class
->rule_delete(rule
);
4231 /* Deletes the rules listed in 'rules'.
4233 * Returns 0 on success, otherwise an OpenFlow error code. */
4235 delete_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4236 const struct ofp_header
*request
,
4237 const struct rule_collection
*rules
,
4238 enum ofp_flow_removed_reason reason
)
4239 OVS_REQUIRES(ofproto_mutex
)
4241 struct ofopgroup
*group
;
4244 group
= ofopgroup_create(ofproto
, ofconn
, request
, UINT32_MAX
);
4245 for (i
= 0; i
< rules
->n
; i
++) {
4246 delete_flow__(rules
->rules
[i
], group
, reason
);
4248 ofopgroup_submit(group
);
4253 /* Implements OFPFC_DELETE. */
4255 delete_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4256 const struct ofputil_flow_mod
*fm
,
4257 const struct ofp_header
*request
)
4258 OVS_REQUIRES(ofproto_mutex
)
4260 struct rule_criteria criteria
;
4261 struct rule_collection rules
;
4264 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4265 fm
->cookie
, fm
->cookie_mask
,
4266 fm
->out_port
, fm
->out_group
);
4267 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4268 rule_criteria_destroy(&criteria
);
4270 if (!error
&& rules
.n
> 0) {
4271 error
= delete_flows__(ofproto
, ofconn
, request
, &rules
, OFPRR_DELETE
);
4273 rule_collection_destroy(&rules
);
4278 /* Implements OFPFC_DELETE_STRICT. */
4280 delete_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4281 const struct ofputil_flow_mod
*fm
,
4282 const struct ofp_header
*request
)
4283 OVS_REQUIRES(ofproto_mutex
)
4285 struct rule_criteria criteria
;
4286 struct rule_collection rules
;
4289 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4290 fm
->cookie
, fm
->cookie_mask
,
4291 fm
->out_port
, fm
->out_group
);
4292 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4293 rule_criteria_destroy(&criteria
);
4295 if (!error
&& rules
.n
> 0) {
4296 error
= delete_flows__(ofproto
, ofconn
, request
, &rules
, OFPRR_DELETE
);
4298 rule_collection_destroy(&rules
);
4304 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
4305 OVS_REQUIRES(ofproto_mutex
)
4307 struct ofputil_flow_removed fr
;
4309 if (ofproto_rule_is_hidden(rule
) ||
4310 !(rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
)) {
4314 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
4315 fr
.priority
= rule
->cr
.priority
;
4316 fr
.cookie
= rule
->flow_cookie
;
4318 fr
.table_id
= rule
->table_id
;
4319 calc_duration(rule
->created
, time_msec(),
4320 &fr
.duration_sec
, &fr
.duration_nsec
);
4321 ovs_mutex_lock(&rule
->mutex
);
4322 fr
.idle_timeout
= rule
->idle_timeout
;
4323 fr
.hard_timeout
= rule
->hard_timeout
;
4324 ovs_mutex_unlock(&rule
->mutex
);
4325 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
4328 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
4331 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4332 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4335 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4338 * ofproto implementation ->run() functions should use this function to expire
4339 * OpenFlow flows. */
4341 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
4342 OVS_REQUIRES(ofproto_mutex
)
4344 struct ofproto
*ofproto
= rule
->ofproto
;
4346 ovs_assert(reason
== OFPRR_HARD_TIMEOUT
|| reason
== OFPRR_IDLE_TIMEOUT
4347 || reason
== OFPRR_DELETE
|| reason
== OFPRR_GROUP_DELETE
);
4349 ofproto_rule_delete__(ofproto
, rule
, reason
);
4352 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4353 * means "infinite". */
4355 reduce_timeout(uint16_t max
, uint16_t *timeout
)
4357 if (max
&& (!*timeout
|| *timeout
> max
)) {
4362 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4363 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4364 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4366 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4368 ofproto_rule_reduce_timeouts(struct rule
*rule
,
4369 uint16_t idle_timeout
, uint16_t hard_timeout
)
4370 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
4372 if (!idle_timeout
&& !hard_timeout
) {
4376 ovs_mutex_lock(&ofproto_mutex
);
4377 if (list_is_empty(&rule
->expirable
)) {
4378 list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
4380 ovs_mutex_unlock(&ofproto_mutex
);
4382 ovs_mutex_lock(&rule
->mutex
);
4383 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
4384 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
4385 ovs_mutex_unlock(&rule
->mutex
);
4389 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4390 OVS_EXCLUDED(ofproto_mutex
)
4392 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4393 struct ofputil_flow_mod fm
;
4394 uint64_t ofpacts_stub
[1024 / 8];
4395 struct ofpbuf ofpacts
;
4399 error
= reject_slave_controller(ofconn
);
4404 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
4405 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
4407 u16_to_ofp(ofproto
->max_ports
),
4410 error
= ofproto_check_ofpacts(ofproto
, fm
.ofpacts
, fm
.ofpacts_len
);
4413 error
= handle_flow_mod__(ofproto
, ofconn
, &fm
, oh
);
4416 goto exit_free_ofpacts
;
4419 /* Record the operation for logging a summary report. */
4420 switch (fm
.command
) {
4426 case OFPFC_MODIFY_STRICT
:
4427 ofproto
->n_modify
++;
4431 case OFPFC_DELETE_STRICT
:
4432 ofproto
->n_delete
++;
4437 if (ofproto
->next_op_report
== LLONG_MAX
) {
4438 ofproto
->first_op
= now
;
4439 ofproto
->next_op_report
= MAX(now
+ 10 * 1000,
4440 ofproto
->op_backoff
);
4441 ofproto
->op_backoff
= ofproto
->next_op_report
+ 60 * 1000;
4443 ofproto
->last_op
= now
;
4446 ofpbuf_uninit(&ofpacts
);
4452 handle_flow_mod__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4453 struct ofputil_flow_mod
*fm
, const struct ofp_header
*oh
)
4454 OVS_EXCLUDED(ofproto_mutex
)
4458 ovs_mutex_lock(&ofproto_mutex
);
4459 if (ofproto
->n_pending
< 50) {
4460 switch (fm
->command
) {
4462 error
= add_flow(ofproto
, ofconn
, fm
, oh
);
4466 error
= modify_flows_loose(ofproto
, ofconn
, fm
, oh
);
4469 case OFPFC_MODIFY_STRICT
:
4470 error
= modify_flow_strict(ofproto
, ofconn
, fm
, oh
);
4474 error
= delete_flows_loose(ofproto
, ofconn
, fm
, oh
);
4477 case OFPFC_DELETE_STRICT
:
4478 error
= delete_flow_strict(ofproto
, ofconn
, fm
, oh
);
4482 if (fm
->command
> 0xff) {
4483 VLOG_WARN_RL(&rl
, "%s: flow_mod has explicit table_id but "
4484 "flow_mod_table_id extension is not enabled",
4487 error
= OFPERR_OFPFMFC_BAD_COMMAND
;
4491 ovs_assert(!list_is_empty(&ofproto
->pending
));
4492 error
= OFPROTO_POSTPONE
;
4494 ovs_mutex_unlock(&ofproto_mutex
);
4496 run_rule_executes(ofproto
);
4501 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4503 struct ofputil_role_request request
;
4504 struct ofputil_role_request reply
;
4508 error
= ofputil_decode_role_message(oh
, &request
);
4513 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
4514 if (ofconn_get_role(ofconn
) != request
.role
4515 && ofconn_has_pending_opgroups(ofconn
)) {
4516 return OFPROTO_POSTPONE
;
4519 if (request
.have_generation_id
4520 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
4521 return OFPERR_OFPRRFC_STALE
;
4524 ofconn_set_role(ofconn
, request
.role
);
4527 reply
.role
= ofconn_get_role(ofconn
);
4528 reply
.have_generation_id
= ofconn_get_master_election_id(
4529 ofconn
, &reply
.generation_id
);
4530 buf
= ofputil_encode_role_reply(oh
, &reply
);
4531 ofconn_send_reply(ofconn
, buf
);
4537 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
4538 const struct ofp_header
*oh
)
4540 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
4541 enum ofputil_protocol cur
, next
;
4543 cur
= ofconn_get_protocol(ofconn
);
4544 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
4545 ofconn_set_protocol(ofconn
, next
);
4551 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4553 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
4554 enum ofputil_protocol cur
, next
;
4555 enum ofputil_protocol next_base
;
4557 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
4559 return OFPERR_OFPBRC_EPERM
;
4562 cur
= ofconn_get_protocol(ofconn
);
4563 next
= ofputil_protocol_set_base(cur
, next_base
);
4564 if (cur
!= next
&& ofconn_has_pending_opgroups(ofconn
)) {
4565 /* Avoid sending async messages in surprising protocol. */
4566 return OFPROTO_POSTPONE
;
4569 ofconn_set_protocol(ofconn
, next
);
4574 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
4575 const struct ofp_header
*oh
)
4577 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
4580 format
= ntohl(msg
->format
);
4581 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
4582 return OFPERR_OFPBRC_EPERM
;
4585 if (format
!= ofconn_get_packet_in_format(ofconn
)
4586 && ofconn_has_pending_opgroups(ofconn
)) {
4587 /* Avoid sending async message in surprsing packet in format. */
4588 return OFPROTO_POSTPONE
;
4591 ofconn_set_packet_in_format(ofconn
, format
);
4596 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4598 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
4599 uint32_t master
[OAM_N_TYPES
];
4600 uint32_t slave
[OAM_N_TYPES
];
4602 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
4603 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
4604 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
4606 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
4607 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
4608 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
4610 ofconn_set_async_config(ofconn
, master
, slave
);
4611 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
4612 !ofconn_get_miss_send_len(ofconn
)) {
4613 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
4620 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4623 uint32_t master
[OAM_N_TYPES
];
4624 uint32_t slave
[OAM_N_TYPES
];
4625 struct nx_async_config
*msg
;
4627 ofconn_get_async_config(ofconn
, master
, slave
);
4628 buf
= ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY
, oh
, 0);
4629 msg
= ofpbuf_put_zeros(buf
, sizeof *msg
);
4631 msg
->packet_in_mask
[0] = htonl(master
[OAM_PACKET_IN
]);
4632 msg
->port_status_mask
[0] = htonl(master
[OAM_PORT_STATUS
]);
4633 msg
->flow_removed_mask
[0] = htonl(master
[OAM_FLOW_REMOVED
]);
4635 msg
->packet_in_mask
[1] = htonl(slave
[OAM_PACKET_IN
]);
4636 msg
->port_status_mask
[1] = htonl(slave
[OAM_PORT_STATUS
]);
4637 msg
->flow_removed_mask
[1] = htonl(slave
[OAM_FLOW_REMOVED
]);
4639 ofconn_send_reply(ofconn
, buf
);
4645 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
4646 const struct ofp_header
*oh
)
4648 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
4650 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
4651 return OFPERR_NXBRC_MUST_BE_ZERO
;
4654 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
4659 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4663 if (ofconn_has_pending_opgroups(ofconn
)) {
4664 return OFPROTO_POSTPONE
;
4667 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
4668 ? OFPRAW_OFPT10_BARRIER_REPLY
4669 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
4670 ofconn_send_reply(ofconn
, buf
);
4675 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
4676 enum nx_flow_monitor_flags flags
,
4678 OVS_REQUIRES(ofproto_mutex
)
4680 struct ofoperation
*op
= rule
->pending
;
4681 const struct rule_actions
*actions
;
4682 struct ofputil_flow_update fu
;
4685 if (op
&& op
->type
== OFOPERATION_ADD
) {
4686 /* We'll report the final flow when the operation completes. Reporting
4687 * it now would cause a duplicate report later. */
4691 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
4692 ? NXFME_ADDED
: NXFME_MODIFIED
);
4694 ovs_mutex_lock(&rule
->mutex
);
4695 fu
.idle_timeout
= rule
->idle_timeout
;
4696 fu
.hard_timeout
= rule
->hard_timeout
;
4697 ovs_mutex_unlock(&rule
->mutex
);
4698 fu
.table_id
= rule
->table_id
;
4699 fu
.cookie
= rule
->flow_cookie
;
4700 minimatch_expand(&rule
->cr
.match
, &match
);
4702 fu
.priority
= rule
->cr
.priority
;
4704 if (!(flags
& NXFMF_ACTIONS
)) {
4707 actions
= rule
->actions
;
4709 /* An operation is in progress. Use the previous version of the flow's
4710 * actions, so that when the operation commits we report the change. */
4712 case OFOPERATION_ADD
:
4715 case OFOPERATION_MODIFY
:
4716 case OFOPERATION_REPLACE
:
4717 actions
= op
->actions
? op
->actions
: rule
->actions
;
4720 case OFOPERATION_DELETE
:
4721 actions
= rule
->actions
;
4728 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
4729 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
4731 if (list_is_empty(msgs
)) {
4732 ofputil_start_flow_update(msgs
);
4734 ofputil_append_flow_update(&fu
, msgs
);
4738 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
4740 OVS_REQUIRES(ofproto_mutex
)
4744 for (i
= 0; i
< rules
->n
; i
++) {
4745 struct rule
*rule
= rules
->rules
[i
];
4746 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
4747 rule
->monitor_flags
= 0;
4749 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
4754 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
4755 struct rule
*rule
, uint64_t seqno
,
4756 struct rule_collection
*rules
)
4757 OVS_REQUIRES(ofproto_mutex
)
4759 enum nx_flow_monitor_flags update
;
4761 if (ofproto_rule_is_hidden(rule
)) {
4766 ? ofoperation_has_out_port(rule
->pending
, m
->out_port
)
4767 : ofproto_rule_has_out_port(rule
, m
->out_port
))) {
4772 if (rule
->add_seqno
> seqno
) {
4773 update
= NXFMF_ADD
| NXFMF_MODIFY
;
4774 } else if (rule
->modify_seqno
> seqno
) {
4775 update
= NXFMF_MODIFY
;
4780 if (!(m
->flags
& update
)) {
4784 update
= NXFMF_INITIAL
;
4787 if (!rule
->monitor_flags
) {
4788 rule_collection_add(rules
, rule
);
4790 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
4794 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
4796 struct rule_collection
*rules
)
4797 OVS_REQUIRES(ofproto_mutex
)
4799 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
4800 const struct ofoperation
*op
;
4801 const struct oftable
*table
;
4802 struct cls_rule target
;
4804 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
4805 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
4806 struct cls_cursor cursor
;
4809 fat_rwlock_rdlock(&table
->cls
.rwlock
);
4810 cls_cursor_init(&cursor
, &table
->cls
, &target
);
4811 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
4812 ovs_assert(!rule
->pending
); /* XXX */
4813 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4815 fat_rwlock_unlock(&table
->cls
.rwlock
);
4818 HMAP_FOR_EACH (op
, hmap_node
, &ofproto
->deletions
) {
4819 struct rule
*rule
= op
->rule
;
4821 if (((m
->table_id
== 0xff
4822 ? !(ofproto
->tables
[rule
->table_id
].flags
& OFTABLE_HIDDEN
)
4823 : m
->table_id
== rule
->table_id
))
4824 && cls_rule_is_loose_match(&rule
->cr
, &target
.match
)) {
4825 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4828 cls_rule_destroy(&target
);
4832 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
4833 struct rule_collection
*rules
)
4834 OVS_REQUIRES(ofproto_mutex
)
4836 if (m
->flags
& NXFMF_INITIAL
) {
4837 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
4842 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
4843 uint64_t seqno
, struct rule_collection
*rules
)
4844 OVS_REQUIRES(ofproto_mutex
)
4846 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
4850 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4851 OVS_EXCLUDED(ofproto_mutex
)
4853 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4854 struct ofmonitor
**monitors
;
4855 size_t n_monitors
, allocated_monitors
;
4856 struct rule_collection rules
;
4857 struct list replies
;
4863 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4865 n_monitors
= allocated_monitors
= 0;
4867 ovs_mutex_lock(&ofproto_mutex
);
4869 struct ofputil_flow_monitor_request request
;
4870 struct ofmonitor
*m
;
4873 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
4874 if (retval
== EOF
) {
4876 } else if (retval
) {
4881 if (request
.table_id
!= 0xff
4882 && request
.table_id
>= ofproto
->n_tables
) {
4883 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4887 error
= ofmonitor_create(&request
, ofconn
, &m
);
4892 if (n_monitors
>= allocated_monitors
) {
4893 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
4896 monitors
[n_monitors
++] = m
;
4899 rule_collection_init(&rules
);
4900 for (i
= 0; i
< n_monitors
; i
++) {
4901 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
4904 ofpmp_init(&replies
, oh
);
4905 ofmonitor_compose_refresh_updates(&rules
, &replies
);
4906 ovs_mutex_unlock(&ofproto_mutex
);
4908 rule_collection_destroy(&rules
);
4910 ofconn_send_replies(ofconn
, &replies
);
4916 for (i
= 0; i
< n_monitors
; i
++) {
4917 ofmonitor_destroy(monitors
[i
]);
4920 ovs_mutex_unlock(&ofproto_mutex
);
4926 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4927 OVS_EXCLUDED(ofproto_mutex
)
4929 struct ofmonitor
*m
;
4933 id
= ofputil_decode_flow_monitor_cancel(oh
);
4935 ovs_mutex_lock(&ofproto_mutex
);
4936 m
= ofmonitor_lookup(ofconn
, id
);
4938 ofmonitor_destroy(m
);
4941 error
= OFPERR_NXBRC_FM_BAD_ID
;
4943 ovs_mutex_unlock(&ofproto_mutex
);
4948 /* Meters implementation.
4950 * Meter table entry, indexed by the OpenFlow meter_id.
4951 * These are always dynamically allocated to allocate enough space for
4953 * 'created' is used to compute the duration for meter stats.
4954 * 'list rules' is needed so that we can delete the dependent rules when the
4955 * meter table entry is deleted.
4956 * 'provider_meter_id' is for the provider's private use.
4959 long long int created
; /* Time created. */
4960 struct list rules
; /* List of "struct rule_dpif"s. */
4961 ofproto_meter_id provider_meter_id
;
4962 uint16_t flags
; /* Meter flags. */
4963 uint16_t n_bands
; /* Number of meter bands. */
4964 struct ofputil_meter_band
*bands
;
4968 * This is used in instruction validation at flow set-up time,
4969 * as flows may not use non-existing meters.
4970 * Return value of UINT32_MAX signifies an invalid meter.
4973 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
4975 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
4976 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
4978 return meter
->provider_meter_id
.uint32
;
4985 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
4989 meter
->flags
= config
->flags
;
4990 meter
->n_bands
= config
->n_bands
;
4991 meter
->bands
= xmemdup(config
->bands
,
4992 config
->n_bands
* sizeof *meter
->bands
);
4995 static struct meter
*
4996 meter_create(const struct ofputil_meter_config
*config
,
4997 ofproto_meter_id provider_meter_id
)
4999 struct meter
*meter
;
5001 meter
= xzalloc(sizeof *meter
);
5002 meter
->provider_meter_id
= provider_meter_id
;
5003 meter
->created
= time_msec();
5004 list_init(&meter
->rules
);
5006 meter_update(meter
, config
);
5012 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5013 OVS_REQUIRES(ofproto_mutex
)
5016 for (mid
= first
; mid
<= last
; ++mid
) {
5017 struct meter
*meter
= ofproto
->meters
[mid
];
5019 ofproto
->meters
[mid
] = NULL
;
5020 ofproto
->ofproto_class
->meter_del(ofproto
,
5021 meter
->provider_meter_id
);
5029 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5031 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5032 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5036 return OFPERR_OFPMMFC_METER_EXISTS
;
5039 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5042 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5043 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5049 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5051 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5053 uint32_t provider_meter_id
;
5056 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5059 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5060 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5061 &meter
->provider_meter_id
,
5063 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5065 meter_update(meter
, &mm
->meter
);
5071 handle_delete_meter(struct ofconn
*ofconn
, const struct ofp_header
*oh
,
5072 struct ofputil_meter_mod
*mm
)
5073 OVS_EXCLUDED(ofproto_mutex
)
5075 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5076 uint32_t meter_id
= mm
->meter
.meter_id
;
5077 struct rule_collection rules
;
5078 enum ofperr error
= 0;
5079 uint32_t first
, last
;
5081 if (meter_id
== OFPM13_ALL
) {
5083 last
= ofproto
->meter_features
.max_meters
;
5085 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
5088 first
= last
= meter_id
;
5091 /* First delete the rules that use this meter. If any of those rules are
5092 * currently being modified, postpone the whole operation until later. */
5093 rule_collection_init(&rules
);
5094 ovs_mutex_lock(&ofproto_mutex
);
5095 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5096 struct meter
*meter
= ofproto
->meters
[meter_id
];
5097 if (meter
&& !list_is_empty(&meter
->rules
)) {
5100 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
5101 if (rule
->pending
) {
5102 error
= OFPROTO_POSTPONE
;
5105 rule_collection_add(&rules
, rule
);
5110 delete_flows__(ofproto
, ofconn
, oh
, &rules
, OFPRR_METER_DELETE
);
5113 /* Delete the meters. */
5114 meter_delete(ofproto
, first
, last
);
5117 ovs_mutex_unlock(&ofproto_mutex
);
5118 rule_collection_destroy(&rules
);
5124 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5126 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5127 struct ofputil_meter_mod mm
;
5128 uint64_t bands_stub
[256 / 8];
5129 struct ofpbuf bands
;
5133 error
= reject_slave_controller(ofconn
);
5138 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5140 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
5142 goto exit_free_bands
;
5145 meter_id
= mm
.meter
.meter_id
;
5147 if (mm
.command
!= OFPMC13_DELETE
) {
5148 /* Fails also when meters are not implemented by the provider. */
5149 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
5150 error
= OFPERR_OFPMMFC_INVALID_METER
;
5151 goto exit_free_bands
;
5152 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
5153 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
5154 goto exit_free_bands
;
5156 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
5157 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
5158 goto exit_free_bands
;
5162 switch (mm
.command
) {
5164 error
= handle_add_meter(ofproto
, &mm
);
5167 case OFPMC13_MODIFY
:
5168 error
= handle_modify_meter(ofproto
, &mm
);
5171 case OFPMC13_DELETE
:
5172 error
= handle_delete_meter(ofconn
, oh
, &mm
);
5176 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
5181 ofpbuf_uninit(&bands
);
5186 handle_meter_features_request(struct ofconn
*ofconn
,
5187 const struct ofp_header
*request
)
5189 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5190 struct ofputil_meter_features features
;
5193 if (ofproto
->ofproto_class
->meter_get_features
) {
5194 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
5196 memset(&features
, 0, sizeof features
);
5198 b
= ofputil_encode_meter_features_reply(&features
, request
);
5200 ofconn_send_reply(ofconn
, b
);
5205 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
5208 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5209 struct list replies
;
5210 uint64_t bands_stub
[256 / 8];
5211 struct ofpbuf bands
;
5212 uint32_t meter_id
, first
, last
;
5214 ofputil_decode_meter_request(request
, &meter_id
);
5216 if (meter_id
== OFPM13_ALL
) {
5218 last
= ofproto
->meter_features
.max_meters
;
5220 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
5221 !ofproto
->meters
[meter_id
]) {
5222 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5224 first
= last
= meter_id
;
5227 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5228 ofpmp_init(&replies
, request
);
5230 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5231 struct meter
*meter
= ofproto
->meters
[meter_id
];
5233 continue; /* Skip non-existing meters. */
5235 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
5236 struct ofputil_meter_stats stats
;
5238 stats
.meter_id
= meter_id
;
5240 /* Provider sets the packet and byte counts, we do the rest. */
5241 stats
.flow_count
= list_size(&meter
->rules
);
5242 calc_duration(meter
->created
, time_msec(),
5243 &stats
.duration_sec
, &stats
.duration_nsec
);
5244 stats
.n_bands
= meter
->n_bands
;
5245 ofpbuf_clear(&bands
);
5247 = ofpbuf_put_uninit(&bands
,
5248 meter
->n_bands
* sizeof *stats
.bands
);
5250 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
5251 meter
->provider_meter_id
,
5253 ofputil_append_meter_stats(&replies
, &stats
);
5255 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5256 struct ofputil_meter_config config
;
5258 config
.meter_id
= meter_id
;
5259 config
.flags
= meter
->flags
;
5260 config
.n_bands
= meter
->n_bands
;
5261 config
.bands
= meter
->bands
;
5262 ofputil_append_meter_config(&replies
, &config
);
5266 ofconn_send_replies(ofconn
, &replies
);
5267 ofpbuf_uninit(&bands
);
5272 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5273 struct ofgroup
**group
)
5274 OVS_TRY_RDLOCK(true, (*group
)->rwlock
)
5276 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5277 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5278 hash_int(group_id
, 0), &ofproto
->groups
) {
5279 if ((*group
)->group_id
== group_id
) {
5280 ovs_rwlock_rdlock(&(*group
)->rwlock
);
5281 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5285 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5290 ofproto_group_release(struct ofgroup
*group
)
5291 OVS_RELEASES(group
->rwlock
)
5293 ovs_rwlock_unlock(&group
->rwlock
);
5297 ofproto_group_write_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5298 struct ofgroup
**group
)
5299 OVS_TRY_WRLOCK(true, ofproto
->groups_rwlock
)
5300 OVS_TRY_WRLOCK(true, (*group
)->rwlock
)
5302 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5303 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5304 hash_int(group_id
, 0), &ofproto
->groups
) {
5305 if ((*group
)->group_id
== group_id
) {
5306 ovs_rwlock_wrlock(&(*group
)->rwlock
);
5310 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5315 ofproto_group_exists__(const struct ofproto
*ofproto
, uint32_t group_id
)
5316 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5318 struct ofgroup
*grp
;
5320 HMAP_FOR_EACH_IN_BUCKET (grp
, hmap_node
,
5321 hash_int(group_id
, 0), &ofproto
->groups
) {
5322 if (grp
->group_id
== group_id
) {
5330 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
5331 OVS_EXCLUDED(ofproto
->groups_rwlock
)
5335 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5336 exists
= ofproto_group_exists__(ofproto
, group_id
);
5337 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5343 group_get_ref_count(struct ofgroup
*group
)
5344 OVS_EXCLUDED(ofproto_mutex
)
5346 struct ofproto
*ofproto
= group
->ofproto
;
5347 struct rule_criteria criteria
;
5348 struct rule_collection rules
;
5353 match_init_catchall(&match
);
5354 rule_criteria_init(&criteria
, 0xff, &match
, 0, htonll(0), htonll(0),
5355 OFPP_ANY
, group
->group_id
);
5356 ovs_mutex_lock(&ofproto_mutex
);
5357 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
5358 ovs_mutex_unlock(&ofproto_mutex
);
5359 rule_criteria_destroy(&criteria
);
5361 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
5363 rule_collection_destroy(&rules
);
5368 append_group_stats(struct ofgroup
*group
, struct list
*replies
)
5369 OVS_REQ_RDLOCK(group
->rwlock
)
5371 struct ofputil_group_stats ogs
;
5372 struct ofproto
*ofproto
= group
->ofproto
;
5373 long long int now
= time_msec();
5376 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
5378 /* Provider sets the packet and byte counts, we do the rest. */
5379 ogs
.ref_count
= group_get_ref_count(group
);
5380 ogs
.n_buckets
= group
->n_buckets
;
5382 error
= (ofproto
->ofproto_class
->group_get_stats
5383 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
5386 ogs
.packet_count
= UINT64_MAX
;
5387 ogs
.byte_count
= UINT64_MAX
;
5388 memset(ogs
.bucket_stats
, 0xff,
5389 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
5392 ogs
.group_id
= group
->group_id
;
5393 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
5395 ofputil_append_group_stats(replies
, &ogs
);
5397 free(ogs
.bucket_stats
);
5401 handle_group_stats_request(struct ofconn
*ofconn
,
5402 const struct ofp_header
*request
)
5404 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5405 struct list replies
;
5407 struct ofgroup
*group
;
5410 error
= ofputil_decode_group_stats_request(request
, &group_id
);
5415 ofpmp_init(&replies
, request
);
5417 if (group_id
== OFPG_ALL
) {
5418 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5419 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5420 ovs_rwlock_rdlock(&group
->rwlock
);
5421 append_group_stats(group
, &replies
);
5422 ovs_rwlock_unlock(&group
->rwlock
);
5424 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5426 if (ofproto_group_lookup(ofproto
, group_id
, &group
)) {
5427 append_group_stats(group
, &replies
);
5428 ofproto_group_release(group
);
5432 ofconn_send_replies(ofconn
, &replies
);
5438 handle_group_desc_stats_request(struct ofconn
*ofconn
,
5439 const struct ofp_header
*request
)
5441 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5442 struct list replies
;
5443 struct ofputil_group_desc gds
;
5444 struct ofgroup
*group
;
5446 ofpmp_init(&replies
, request
);
5448 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5449 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5450 gds
.group_id
= group
->group_id
;
5451 gds
.type
= group
->type
;
5452 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, &replies
);
5454 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5456 ofconn_send_replies(ofconn
, &replies
);
5462 handle_group_features_stats_request(struct ofconn
*ofconn
,
5463 const struct ofp_header
*request
)
5465 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5468 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
5470 ofconn_send_reply(ofconn
, msg
);
5477 handle_queue_get_config_request(struct ofconn
*ofconn
,
5478 const struct ofp_header
*oh
)
5480 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5481 struct netdev_queue_dump queue_dump
;
5482 struct ofport
*ofport
;
5483 unsigned int queue_id
;
5484 struct ofpbuf
*reply
;
5485 struct smap details
;
5489 error
= ofputil_decode_queue_get_config_request(oh
, &request
);
5494 ofport
= ofproto_get_port(p
, request
);
5496 return OFPERR_OFPQOFC_BAD_PORT
;
5499 reply
= ofputil_encode_queue_get_config_reply(oh
);
5501 smap_init(&details
);
5502 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
, ofport
->netdev
) {
5503 struct ofputil_queue_config queue
;
5505 /* None of the existing queues have compatible properties, so we
5506 * hard-code omitting min_rate and max_rate. */
5507 queue
.queue_id
= queue_id
;
5508 queue
.min_rate
= UINT16_MAX
;
5509 queue
.max_rate
= UINT16_MAX
;
5510 ofputil_append_queue_get_config_reply(reply
, &queue
);
5512 smap_destroy(&details
);
5514 ofconn_send_reply(ofconn
, reply
);
5519 /* Implements OFPGC11_ADD
5520 * in which no matching flow already exists in the flow table.
5522 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5523 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5524 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5525 * initiated now but may be retried later.
5527 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5528 * ownership remains with the caller.
5530 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5533 add_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5535 struct ofgroup
*ofgroup
;
5538 if (gm
->group_id
> OFPG_MAX
) {
5539 return OFPERR_OFPGMFC_INVALID_GROUP
;
5541 if (gm
->type
> OFPGT11_FF
) {
5542 return OFPERR_OFPGMFC_BAD_TYPE
;
5545 /* Allocate new group and initialize it. */
5546 ofgroup
= ofproto
->ofproto_class
->group_alloc();
5548 VLOG_WARN_RL(&rl
, "%s: failed to create group", ofproto
->name
);
5549 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5552 ovs_rwlock_init(&ofgroup
->rwlock
);
5553 ofgroup
->ofproto
= ofproto
;
5554 ofgroup
->group_id
= gm
->group_id
;
5555 ofgroup
->type
= gm
->type
;
5556 ofgroup
->created
= ofgroup
->modified
= time_msec();
5558 list_move(&ofgroup
->buckets
, &gm
->buckets
);
5559 ofgroup
->n_buckets
= list_size(&ofgroup
->buckets
);
5561 /* Construct called BEFORE any locks are held. */
5562 error
= ofproto
->ofproto_class
->group_construct(ofgroup
);
5567 /* We wrlock as late as possible to minimize the time we jam any other
5568 * threads: No visible state changes before acquiring the lock. */
5569 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5571 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5572 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5576 if (ofproto_group_exists__(ofproto
, gm
->group_id
)) {
5577 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
5582 /* Insert new group. */
5583 hmap_insert(&ofproto
->groups
, &ofgroup
->hmap_node
,
5584 hash_int(ofgroup
->group_id
, 0));
5585 ofproto
->n_groups
[ofgroup
->type
]++;
5587 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5592 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5593 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5595 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5596 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5601 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5604 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5607 modify_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5609 struct ofgroup
*ofgroup
;
5610 struct ofgroup
*victim
;
5613 if (gm
->group_id
> OFPG_MAX
) {
5614 return OFPERR_OFPGMFC_INVALID_GROUP
;
5617 if (gm
->type
> OFPGT11_FF
) {
5618 return OFPERR_OFPGMFC_BAD_TYPE
;
5621 victim
= ofproto
->ofproto_class
->group_alloc();
5623 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
5624 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5627 if (!ofproto_group_write_lookup(ofproto
, gm
->group_id
, &ofgroup
)) {
5628 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
5631 /* Both group's and its container's write locks held now.
5632 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5633 if (ofgroup
->type
!= gm
->type
5634 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5635 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5640 list_move(&victim
->buckets
, &ofgroup
->buckets
);
5642 ofgroup
->type
= gm
->type
;
5643 list_move(&ofgroup
->buckets
, &gm
->buckets
);
5644 ofgroup
->n_buckets
= list_size(&ofgroup
->buckets
);
5646 error
= ofproto
->ofproto_class
->group_modify(ofgroup
, victim
);
5648 ofputil_bucket_list_destroy(&victim
->buckets
);
5649 ofproto
->n_groups
[victim
->type
]--;
5650 ofproto
->n_groups
[ofgroup
->type
]++;
5651 ofgroup
->modified
= time_msec();
5653 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5656 list_move(&ofgroup
->buckets
, &victim
->buckets
);
5660 ovs_rwlock_unlock(&ofgroup
->rwlock
);
5661 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5663 ofproto
->ofproto_class
->group_dealloc(victim
);
5668 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
5669 OVS_RELEASES(ofproto
->groups_rwlock
)
5672 struct ofputil_flow_mod fm
;
5674 /* Delete all flow entries containing this group in a group action */
5675 match_init_catchall(&match
);
5676 flow_mod_init(&fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
5677 fm
.out_group
= ofgroup
->group_id
;
5678 handle_flow_mod__(ofproto
, NULL
, &fm
, NULL
);
5680 /* Must wait until existing readers are done,
5681 * while holding the container's write lock at the same time. */
5682 ovs_rwlock_wrlock(&ofgroup
->rwlock
);
5683 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5684 /* No-one can find this group any more. */
5685 ofproto
->n_groups
[ofgroup
->type
]--;
5686 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5688 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5689 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5690 ovs_rwlock_unlock(&ofgroup
->rwlock
);
5691 ovs_rwlock_destroy(&ofgroup
->rwlock
);
5692 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5695 /* Implements OFPGC_DELETE. */
5697 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
5699 struct ofgroup
*ofgroup
;
5701 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5702 if (group_id
== OFPG_ALL
) {
5704 struct hmap_node
*node
= hmap_first(&ofproto
->groups
);
5708 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, hmap_node
);
5709 delete_group__(ofproto
, ofgroup
);
5710 /* Lock for each node separately, so that we will not jam the
5711 * other threads for too long time. */
5712 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5715 HMAP_FOR_EACH_IN_BUCKET (ofgroup
, hmap_node
,
5716 hash_int(group_id
, 0), &ofproto
->groups
) {
5717 if (ofgroup
->group_id
== group_id
) {
5718 delete_group__(ofproto
, ofgroup
);
5723 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5727 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5729 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5730 struct ofputil_group_mod gm
;
5733 error
= reject_slave_controller(ofconn
);
5738 error
= ofputil_decode_group_mod(oh
, &gm
);
5743 switch (gm
.command
) {
5745 return add_group(ofproto
, &gm
);
5747 case OFPGC11_MODIFY
:
5748 return modify_group(ofproto
, &gm
);
5750 case OFPGC11_DELETE
:
5751 delete_group(ofproto
, gm
.group_id
);
5755 if (gm
.command
> OFPGC11_DELETE
) {
5756 VLOG_WARN_RL(&rl
, "%s: Invalid group_mod command type %d",
5757 ofproto
->name
, gm
.command
);
5759 return OFPERR_OFPGMFC_BAD_COMMAND
;
5764 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
5766 /* XXX Reject all configurations because none are currently supported */
5767 return OFPERR_OFPTMFC_BAD_CONFIG
;
5769 if (tm
->table_id
== OFPTT_ALL
) {
5771 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
5772 atomic_store(&ofproto
->tables
[i
].config
,
5773 (unsigned int)tm
->config
);
5775 } else if (!check_table_id(ofproto
, tm
->table_id
)) {
5776 return OFPERR_OFPTMFC_BAD_TABLE
;
5778 atomic_store(&ofproto
->tables
[tm
->table_id
].config
,
5779 (unsigned int)tm
->config
);
5786 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5788 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5789 struct ofputil_table_mod tm
;
5792 error
= reject_slave_controller(ofconn
);
5797 error
= ofputil_decode_table_mod(oh
, &tm
);
5802 return table_mod(ofproto
, &tm
);
5806 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
5807 OVS_EXCLUDED(ofproto_mutex
)
5809 const struct ofp_header
*oh
= msg
->data
;
5813 error
= ofptype_decode(&type
, oh
);
5817 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
5818 && ofpmp_more(oh
)) {
5819 /* We have no buffer implementation for multipart requests.
5820 * Report overflow for requests which consists of multiple
5822 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
5826 /* OpenFlow requests. */
5827 case OFPTYPE_ECHO_REQUEST
:
5828 return handle_echo_request(ofconn
, oh
);
5830 case OFPTYPE_FEATURES_REQUEST
:
5831 return handle_features_request(ofconn
, oh
);
5833 case OFPTYPE_GET_CONFIG_REQUEST
:
5834 return handle_get_config_request(ofconn
, oh
);
5836 case OFPTYPE_SET_CONFIG
:
5837 return handle_set_config(ofconn
, oh
);
5839 case OFPTYPE_PACKET_OUT
:
5840 return handle_packet_out(ofconn
, oh
);
5842 case OFPTYPE_PORT_MOD
:
5843 return handle_port_mod(ofconn
, oh
);
5845 case OFPTYPE_FLOW_MOD
:
5846 return handle_flow_mod(ofconn
, oh
);
5848 case OFPTYPE_GROUP_MOD
:
5849 return handle_group_mod(ofconn
, oh
);
5851 case OFPTYPE_TABLE_MOD
:
5852 return handle_table_mod(ofconn
, oh
);
5854 case OFPTYPE_METER_MOD
:
5855 return handle_meter_mod(ofconn
, oh
);
5857 case OFPTYPE_BARRIER_REQUEST
:
5858 return handle_barrier_request(ofconn
, oh
);
5860 case OFPTYPE_ROLE_REQUEST
:
5861 return handle_role_request(ofconn
, oh
);
5863 /* OpenFlow replies. */
5864 case OFPTYPE_ECHO_REPLY
:
5867 /* Nicira extension requests. */
5868 case OFPTYPE_FLOW_MOD_TABLE_ID
:
5869 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
5871 case OFPTYPE_SET_FLOW_FORMAT
:
5872 return handle_nxt_set_flow_format(ofconn
, oh
);
5874 case OFPTYPE_SET_PACKET_IN_FORMAT
:
5875 return handle_nxt_set_packet_in_format(ofconn
, oh
);
5877 case OFPTYPE_SET_CONTROLLER_ID
:
5878 return handle_nxt_set_controller_id(ofconn
, oh
);
5880 case OFPTYPE_FLOW_AGE
:
5881 /* Nothing to do. */
5884 case OFPTYPE_FLOW_MONITOR_CANCEL
:
5885 return handle_flow_monitor_cancel(ofconn
, oh
);
5887 case OFPTYPE_SET_ASYNC_CONFIG
:
5888 return handle_nxt_set_async_config(ofconn
, oh
);
5890 case OFPTYPE_GET_ASYNC_REQUEST
:
5891 return handle_nxt_get_async_request(ofconn
, oh
);
5893 /* Statistics requests. */
5894 case OFPTYPE_DESC_STATS_REQUEST
:
5895 return handle_desc_stats_request(ofconn
, oh
);
5897 case OFPTYPE_FLOW_STATS_REQUEST
:
5898 return handle_flow_stats_request(ofconn
, oh
);
5900 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
5901 return handle_aggregate_stats_request(ofconn
, oh
);
5903 case OFPTYPE_TABLE_STATS_REQUEST
:
5904 return handle_table_stats_request(ofconn
, oh
);
5906 case OFPTYPE_PORT_STATS_REQUEST
:
5907 return handle_port_stats_request(ofconn
, oh
);
5909 case OFPTYPE_QUEUE_STATS_REQUEST
:
5910 return handle_queue_stats_request(ofconn
, oh
);
5912 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
5913 return handle_port_desc_stats_request(ofconn
, oh
);
5915 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
5916 return handle_flow_monitor_request(ofconn
, oh
);
5918 case OFPTYPE_METER_STATS_REQUEST
:
5919 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
5920 return handle_meter_request(ofconn
, oh
, type
);
5922 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
5923 return handle_meter_features_request(ofconn
, oh
);
5925 case OFPTYPE_GROUP_STATS_REQUEST
:
5926 return handle_group_stats_request(ofconn
, oh
);
5928 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
5929 return handle_group_desc_stats_request(ofconn
, oh
);
5931 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
5932 return handle_group_features_stats_request(ofconn
, oh
);
5934 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
5935 return handle_queue_get_config_request(ofconn
, oh
);
5939 case OFPTYPE_FEATURES_REPLY
:
5940 case OFPTYPE_GET_CONFIG_REPLY
:
5941 case OFPTYPE_PACKET_IN
:
5942 case OFPTYPE_FLOW_REMOVED
:
5943 case OFPTYPE_PORT_STATUS
:
5944 case OFPTYPE_BARRIER_REPLY
:
5945 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
5946 case OFPTYPE_DESC_STATS_REPLY
:
5947 case OFPTYPE_FLOW_STATS_REPLY
:
5948 case OFPTYPE_QUEUE_STATS_REPLY
:
5949 case OFPTYPE_PORT_STATS_REPLY
:
5950 case OFPTYPE_TABLE_STATS_REPLY
:
5951 case OFPTYPE_AGGREGATE_STATS_REPLY
:
5952 case OFPTYPE_PORT_DESC_STATS_REPLY
:
5953 case OFPTYPE_ROLE_REPLY
:
5954 case OFPTYPE_FLOW_MONITOR_PAUSED
:
5955 case OFPTYPE_FLOW_MONITOR_RESUMED
:
5956 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
5957 case OFPTYPE_GET_ASYNC_REPLY
:
5958 case OFPTYPE_GROUP_STATS_REPLY
:
5959 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
5960 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
5961 case OFPTYPE_METER_STATS_REPLY
:
5962 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
5963 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
5964 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
5965 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
5966 case OFPTYPE_ROLE_STATUS
:
5968 if (ofpmsg_is_stat_request(oh
)) {
5969 return OFPERR_OFPBRC_BAD_STAT
;
5971 return OFPERR_OFPBRC_BAD_TYPE
;
5977 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
5978 OVS_EXCLUDED(ofproto_mutex
)
5980 int error
= handle_openflow__(ofconn
, ofp_msg
);
5981 if (error
&& error
!= OFPROTO_POSTPONE
) {
5982 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
5984 COVERAGE_INC(ofproto_recv_openflow
);
5985 return error
!= OFPROTO_POSTPONE
;
5988 /* Asynchronous operations. */
5990 /* Creates and returns a new ofopgroup that is not associated with any
5991 * OpenFlow connection.
5993 * The caller should add operations to the returned group with
5994 * ofoperation_create() and then submit it with ofopgroup_submit(). */
5995 static struct ofopgroup
*
5996 ofopgroup_create_unattached(struct ofproto
*ofproto
)
5997 OVS_REQUIRES(ofproto_mutex
)
5999 struct ofopgroup
*group
= xzalloc(sizeof *group
);
6000 group
->ofproto
= ofproto
;
6001 list_init(&group
->ofproto_node
);
6002 list_init(&group
->ops
);
6003 list_init(&group
->ofconn_node
);
6007 /* Creates and returns a new ofopgroup for 'ofproto'.
6009 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6010 * connection. The 'request' and 'buffer_id' arguments are ignored.
6012 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6013 * If the ofopgroup eventually fails, then the error reply will include
6014 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6015 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6017 * The caller should add operations to the returned group with
6018 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6019 static struct ofopgroup
*
6020 ofopgroup_create(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
6021 const struct ofp_header
*request
, uint32_t buffer_id
)
6022 OVS_REQUIRES(ofproto_mutex
)
6024 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
6026 size_t request_len
= ntohs(request
->length
);
6028 ovs_assert(ofconn_get_ofproto(ofconn
) == ofproto
);
6030 ofconn_add_opgroup(ofconn
, &group
->ofconn_node
);
6031 group
->ofconn
= ofconn
;
6032 group
->request
= xmemdup(request
, MIN(request_len
, 64));
6033 group
->buffer_id
= buffer_id
;
6038 /* Submits 'group' for processing.
6040 * If 'group' contains no operations (e.g. none were ever added, or all of the
6041 * ones that were added completed synchronously), then it is destroyed
6042 * immediately. Otherwise it is added to the ofproto's list of pending
6045 ofopgroup_submit(struct ofopgroup
*group
)
6046 OVS_REQUIRES(ofproto_mutex
)
6048 if (!group
->n_running
) {
6049 ofopgroup_complete(group
);
6051 list_push_back(&group
->ofproto
->pending
, &group
->ofproto_node
);
6052 group
->ofproto
->n_pending
++;
6057 ofopgroup_complete(struct ofopgroup
*group
)
6058 OVS_REQUIRES(ofproto_mutex
)
6060 struct ofproto
*ofproto
= group
->ofproto
;
6062 struct ofconn
*abbrev_ofconn
;
6063 ovs_be32 abbrev_xid
;
6065 struct ofoperation
*op
, *next_op
;
6068 ovs_assert(!group
->n_running
);
6071 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
6078 if (!error
&& group
->ofconn
&& group
->buffer_id
!= UINT32_MAX
) {
6079 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
6080 if (op
->type
!= OFOPERATION_DELETE
) {
6081 struct ofpbuf
*packet
;
6084 error
= ofconn_pktbuf_retrieve(group
->ofconn
, group
->buffer_id
,
6087 struct rule_execute
*re
;
6091 ofproto_rule_ref(op
->rule
);
6093 re
= xmalloc(sizeof *re
);
6094 re
->rule
= op
->rule
;
6095 re
->in_port
= in_port
;
6096 re
->packet
= packet
;
6098 if (!guarded_list_push_back(&ofproto
->rule_executes
,
6099 &re
->list_node
, 1024)) {
6100 ofproto_rule_unref(op
->rule
);
6101 ofpbuf_delete(re
->packet
);
6110 if (!error
&& !list_is_empty(&group
->ofconn_node
)) {
6111 abbrev_ofconn
= group
->ofconn
;
6112 abbrev_xid
= group
->request
->xid
;
6114 abbrev_ofconn
= NULL
;
6115 abbrev_xid
= htonl(0);
6117 LIST_FOR_EACH_SAFE (op
, next_op
, group_node
, &group
->ops
) {
6118 struct rule
*rule
= op
->rule
;
6120 /* We generally want to report the change to active OpenFlow flow
6121 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6123 - The operation failed.
6125 - The affected rule is not visible to controllers.
6127 - The operation's only effect was to update rule->modified. */
6129 || ofproto_rule_is_hidden(rule
)
6130 || (op
->type
== OFOPERATION_MODIFY
6132 && rule
->flow_cookie
== op
->flow_cookie
))) {
6133 /* Check that we can just cast from ofoperation_type to
6134 * nx_flow_update_event. */
6135 enum nx_flow_update_event event_type
;
6138 case OFOPERATION_ADD
:
6139 case OFOPERATION_REPLACE
:
6140 event_type
= NXFME_ADDED
;
6143 case OFOPERATION_DELETE
:
6144 event_type
= NXFME_DELETED
;
6147 case OFOPERATION_MODIFY
:
6148 event_type
= NXFME_MODIFIED
;
6155 ofmonitor_report(ofproto
->connmgr
, rule
, event_type
,
6156 op
->reason
, abbrev_ofconn
, abbrev_xid
);
6159 rule
->pending
= NULL
;
6162 case OFOPERATION_ADD
:
6166 vid_mask
= minimask_get_vid_mask(&rule
->cr
.match
.mask
);
6167 if (vid_mask
== VLAN_VID_MASK
) {
6168 if (ofproto
->vlan_bitmap
) {
6169 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
6170 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
6171 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6172 ofproto
->vlans_changed
= true;
6175 ofproto
->vlans_changed
= true;
6179 oftable_remove_rule(rule
);
6180 ofproto_rule_unref(rule
);
6184 case OFOPERATION_DELETE
:
6185 ovs_assert(!op
->error
);
6186 ofproto_rule_unref(rule
);
6190 case OFOPERATION_MODIFY
:
6191 case OFOPERATION_REPLACE
:
6193 long long int now
= time_msec();
6195 rule
->modified
= now
;
6196 if (op
->type
== OFOPERATION_REPLACE
) {
6197 rule
->created
= rule
->used
= now
;
6200 ofproto_rule_change_cookie(ofproto
, rule
, op
->flow_cookie
);
6201 ovs_mutex_lock(&rule
->mutex
);
6202 rule
->idle_timeout
= op
->idle_timeout
;
6203 rule
->hard_timeout
= op
->hard_timeout
;
6204 ovs_mutex_unlock(&rule
->mutex
);
6206 struct rule_actions
*old_actions
;
6208 ovs_mutex_lock(&rule
->mutex
);
6209 old_actions
= rule
->actions
;
6210 rule
->actions
= op
->actions
;
6211 ovs_mutex_unlock(&rule
->mutex
);
6214 rule_actions_unref(old_actions
);
6216 rule
->flags
= op
->flags
;
6224 ofoperation_destroy(op
);
6227 ofmonitor_flush(ofproto
->connmgr
);
6229 if (!list_is_empty(&group
->ofproto_node
)) {
6230 ovs_assert(ofproto
->n_pending
> 0);
6231 ofproto
->n_pending
--;
6232 list_remove(&group
->ofproto_node
);
6234 if (!list_is_empty(&group
->ofconn_node
)) {
6235 list_remove(&group
->ofconn_node
);
6237 ofconn_send_error(group
->ofconn
, group
->request
, error
);
6239 connmgr_retry(ofproto
->connmgr
);
6241 free(group
->request
);
6245 /* Initiates a new operation on 'rule', of the specified 'type', within
6246 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6248 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6249 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6251 * Returns the newly created ofoperation (which is also available as
6252 * rule->pending). */
6253 static struct ofoperation
*
6254 ofoperation_create(struct ofopgroup
*group
, struct rule
*rule
,
6255 enum ofoperation_type type
,
6256 enum ofp_flow_removed_reason reason
)
6257 OVS_REQUIRES(ofproto_mutex
)
6259 struct ofproto
*ofproto
= group
->ofproto
;
6260 struct ofoperation
*op
;
6262 ovs_assert(!rule
->pending
);
6264 op
= rule
->pending
= xzalloc(sizeof *op
);
6266 list_push_back(&group
->ops
, &op
->group_node
);
6269 op
->reason
= reason
;
6270 op
->flow_cookie
= rule
->flow_cookie
;
6271 ovs_mutex_lock(&rule
->mutex
);
6272 op
->idle_timeout
= rule
->idle_timeout
;
6273 op
->hard_timeout
= rule
->hard_timeout
;
6274 ovs_mutex_unlock(&rule
->mutex
);
6275 op
->flags
= rule
->flags
;
6279 if (type
== OFOPERATION_DELETE
) {
6280 hmap_insert(&ofproto
->deletions
, &op
->hmap_node
,
6281 cls_rule_hash(&rule
->cr
, rule
->table_id
));
6288 ofoperation_destroy(struct ofoperation
*op
)
6289 OVS_REQUIRES(ofproto_mutex
)
6291 struct ofopgroup
*group
= op
->group
;
6294 op
->rule
->pending
= NULL
;
6296 if (op
->type
== OFOPERATION_DELETE
) {
6297 hmap_remove(&group
->ofproto
->deletions
, &op
->hmap_node
);
6299 list_remove(&op
->group_node
);
6300 rule_actions_unref(op
->actions
);
6304 /* Indicates that 'op' completed with status 'error', which is either 0 to
6305 * indicate success or an OpenFlow error code on failure.
6307 * If 'error' is 0, indicating success, the operation will be committed
6308 * permanently to the flow table.
6310 * If 'error' is nonzero, then generally the operation will be rolled back:
6312 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6313 * restores the original rule. The caller must have uninitialized any
6314 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6315 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6316 * and 7 for the new rule, calling its ->rule_dealloc() function.
6318 * - If 'op' is a "modify flow" operation, ofproto restores the original
6321 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6322 * allowed to fail. It must always succeed.
6324 * Please see the large comment in ofproto/ofproto-provider.h titled
6325 * "Asynchronous Operation Support" for more information. */
6327 ofoperation_complete(struct ofoperation
*op
, enum ofperr error
)
6329 struct ofopgroup
*group
= op
->group
;
6331 ovs_assert(group
->n_running
> 0);
6332 ovs_assert(!error
|| op
->type
!= OFOPERATION_DELETE
);
6335 if (!--group
->n_running
&& !list_is_empty(&group
->ofproto_node
)) {
6336 /* This function can be called from ->rule_construct(), in which case
6337 * ofproto_mutex is held, or it can be called from ->run(), in which
6338 * case ofproto_mutex is not held. But only in the latter case can we
6339 * arrive here, so we can safely take ofproto_mutex now. */
6340 ovs_mutex_lock(&ofproto_mutex
);
6341 ovs_assert(op
->rule
->pending
== op
);
6342 ofopgroup_complete(group
);
6343 ovs_mutex_unlock(&ofproto_mutex
);
6348 pick_datapath_id(const struct ofproto
*ofproto
)
6350 const struct ofport
*port
;
6352 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
6354 uint8_t ea
[ETH_ADDR_LEN
];
6357 error
= netdev_get_etheraddr(port
->netdev
, ea
);
6359 return eth_addr_to_uint64(ea
);
6361 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6362 ofproto
->name
, netdev_get_name(port
->netdev
),
6363 ovs_strerror(error
));
6365 return ofproto
->fallback_dpid
;
6369 pick_fallback_dpid(void)
6371 uint8_t ea
[ETH_ADDR_LEN
];
6372 eth_addr_nicira_random(ea
);
6373 return eth_addr_to_uint64(ea
);
6376 /* Table overflow policy. */
6378 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6379 * to NULL if the table is not configured to evict rules or if the table
6380 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6381 * or with no timeouts are not evictable.) */
6383 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
6384 OVS_REQUIRES(ofproto_mutex
)
6386 struct eviction_group
*evg
;
6389 if (!table
->eviction_fields
) {
6393 /* In the common case, the outer and inner loops here will each be entered
6396 * - The inner loop normally "return"s in its first iteration. If the
6397 * eviction group has any evictable rules, then it always returns in
6400 * - The outer loop only iterates more than once if the largest eviction
6401 * group has no evictable rules.
6403 * - The outer loop can exit only if table's 'max_flows' is all filled up
6404 * by unevictable rules. */
6405 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
6408 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
6417 /* Searches 'ofproto' for tables that have more flows than their configured
6418 * maximum and that have flow eviction enabled, and evicts as many flows as
6419 * necessary and currently feasible from them.
6421 * This triggers only when an OpenFlow table has N flows in it and then the
6422 * client configures a maximum number of flows less than N. */
6424 ofproto_evict(struct ofproto
*ofproto
)
6426 struct oftable
*table
;
6428 ovs_mutex_lock(&ofproto_mutex
);
6429 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
6430 evict_rules_from_table(ofproto
, table
, 0);
6432 ovs_mutex_unlock(&ofproto_mutex
);
6435 /* Eviction groups. */
6437 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6438 * rules. The priority contains low-order random bits to ensure that eviction
6439 * groups with the same number of rules are prioritized randomly. */
6441 eviction_group_priority(size_t n_rules
)
6443 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
6444 return (size
<< 16) | random_uint16();
6447 /* Updates 'evg', an eviction_group within 'table', following a change that
6448 * adds or removes rules in 'evg'. */
6450 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
6451 OVS_REQUIRES(ofproto_mutex
)
6453 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
6454 eviction_group_priority(heap_count(&evg
->rules
)));
6457 /* Destroys 'evg', an eviction_group within 'table':
6459 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6460 * rules themselves, just removes them from the eviction group.)
6462 * - Removes 'evg' from 'table'.
6466 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
6467 OVS_REQUIRES(ofproto_mutex
)
6469 while (!heap_is_empty(&evg
->rules
)) {
6472 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
6473 rule
->eviction_group
= NULL
;
6475 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
6476 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
6477 heap_destroy(&evg
->rules
);
6481 /* Removes 'rule' from its eviction group, if any. */
6483 eviction_group_remove_rule(struct rule
*rule
)
6484 OVS_REQUIRES(ofproto_mutex
)
6486 if (rule
->eviction_group
) {
6487 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6488 struct eviction_group
*evg
= rule
->eviction_group
;
6490 rule
->eviction_group
= NULL
;
6491 heap_remove(&evg
->rules
, &rule
->evg_node
);
6492 if (heap_is_empty(&evg
->rules
)) {
6493 eviction_group_destroy(table
, evg
);
6495 eviction_group_resized(table
, evg
);
6500 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6501 * returns the hash value. */
6503 eviction_group_hash_rule(struct rule
*rule
)
6504 OVS_REQUIRES(ofproto_mutex
)
6506 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6507 const struct mf_subfield
*sf
;
6511 hash
= table
->eviction_group_id_basis
;
6512 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
6513 for (sf
= table
->eviction_fields
;
6514 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
6517 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
6518 union mf_value value
;
6520 mf_get_value(sf
->field
, &flow
, &value
);
6522 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
6524 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
6525 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
6526 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
6527 sf
->field
->n_bytes
* 8 - start
);
6529 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
6531 hash
= hash_int(hash
, 0);
6538 /* Returns an eviction group within 'table' with the given 'id', creating one
6540 static struct eviction_group
*
6541 eviction_group_find(struct oftable
*table
, uint32_t id
)
6542 OVS_REQUIRES(ofproto_mutex
)
6544 struct eviction_group
*evg
;
6546 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
6550 evg
= xmalloc(sizeof *evg
);
6551 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
6552 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
6553 eviction_group_priority(0));
6554 heap_init(&evg
->rules
);
6559 /* Returns an eviction priority for 'rule'. The return value should be
6560 * interpreted so that higher priorities make a rule more attractive candidates
6563 rule_eviction_priority(struct rule
*rule
)
6564 OVS_REQUIRES(ofproto_mutex
)
6566 long long int hard_expiration
;
6567 long long int idle_expiration
;
6568 long long int expiration
;
6569 uint32_t expiration_offset
;
6571 /* Calculate time of expiration. */
6572 ovs_mutex_lock(&rule
->mutex
);
6573 hard_expiration
= (rule
->hard_timeout
6574 ? rule
->modified
+ rule
->hard_timeout
* 1000
6576 idle_expiration
= (rule
->idle_timeout
6577 ? rule
->used
+ rule
->idle_timeout
* 1000
6579 expiration
= MIN(hard_expiration
, idle_expiration
);
6580 ovs_mutex_unlock(&rule
->mutex
);
6581 if (expiration
== LLONG_MAX
) {
6585 /* Calculate the time of expiration as a number of (approximate) seconds
6586 * after program startup.
6588 * This should work OK for program runs that last UINT32_MAX seconds or
6589 * less. Therefore, please restart OVS at least once every 136 years. */
6590 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
6592 /* Invert the expiration offset because we're using a max-heap. */
6593 return UINT32_MAX
- expiration_offset
;
6596 /* Adds 'rule' to an appropriate eviction group for its oftable's
6597 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6598 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6601 * The caller must ensure that 'rule' is not already in an eviction group. */
6603 eviction_group_add_rule(struct rule
*rule
)
6604 OVS_REQUIRES(ofproto_mutex
)
6606 struct ofproto
*ofproto
= rule
->ofproto
;
6607 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6610 ovs_mutex_lock(&rule
->mutex
);
6611 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
6612 ovs_mutex_unlock(&rule
->mutex
);
6614 if (table
->eviction_fields
&& has_timeout
) {
6615 struct eviction_group
*evg
;
6617 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
6619 rule
->eviction_group
= evg
;
6620 heap_insert(&evg
->rules
, &rule
->evg_node
,
6621 rule_eviction_priority(rule
));
6622 eviction_group_resized(table
, evg
);
6628 /* Initializes 'table'. */
6630 oftable_init(struct oftable
*table
)
6632 memset(table
, 0, sizeof *table
);
6633 classifier_init(&table
->cls
, flow_segment_u32s
);
6634 table
->max_flows
= UINT_MAX
;
6635 atomic_init(&table
->config
, (unsigned int)OFPTC11_TABLE_MISS_CONTROLLER
);
6638 /* Destroys 'table', including its classifier and eviction groups.
6640 * The caller is responsible for freeing 'table' itself. */
6642 oftable_destroy(struct oftable
*table
)
6644 fat_rwlock_rdlock(&table
->cls
.rwlock
);
6645 ovs_assert(classifier_is_empty(&table
->cls
));
6646 fat_rwlock_unlock(&table
->cls
.rwlock
);
6647 oftable_disable_eviction(table
);
6648 classifier_destroy(&table
->cls
);
6650 atomic_destroy(&table
->config
);
6653 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6654 * string, then 'table' will use its default name.
6656 * This only affects the name exposed for a table exposed through the OpenFlow
6657 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6659 oftable_set_name(struct oftable
*table
, const char *name
)
6661 if (name
&& name
[0]) {
6662 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
6663 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
6665 table
->name
= xmemdup0(name
, len
);
6673 /* oftables support a choice of two policies when adding a rule would cause the
6674 * number of flows in the table to exceed the configured maximum number: either
6675 * they can refuse to add the new flow or they can evict some existing flow.
6676 * This function configures the former policy on 'table'. */
6678 oftable_disable_eviction(struct oftable
*table
)
6679 OVS_REQUIRES(ofproto_mutex
)
6681 if (table
->eviction_fields
) {
6682 struct eviction_group
*evg
, *next
;
6684 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
6685 &table
->eviction_groups_by_id
) {
6686 eviction_group_destroy(table
, evg
);
6688 hmap_destroy(&table
->eviction_groups_by_id
);
6689 heap_destroy(&table
->eviction_groups_by_size
);
6691 free(table
->eviction_fields
);
6692 table
->eviction_fields
= NULL
;
6693 table
->n_eviction_fields
= 0;
6697 /* oftables support a choice of two policies when adding a rule would cause the
6698 * number of flows in the table to exceed the configured maximum number: either
6699 * they can refuse to add the new flow or they can evict some existing flow.
6700 * This function configures the latter policy on 'table', with fairness based
6701 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6702 * 'n_fields' as 0 disables fairness.) */
6704 oftable_enable_eviction(struct oftable
*table
,
6705 const struct mf_subfield
*fields
, size_t n_fields
)
6706 OVS_REQUIRES(ofproto_mutex
)
6708 struct cls_cursor cursor
;
6711 if (table
->eviction_fields
6712 && n_fields
== table
->n_eviction_fields
6714 || !memcmp(fields
, table
->eviction_fields
,
6715 n_fields
* sizeof *fields
))) {
6720 oftable_disable_eviction(table
);
6722 table
->n_eviction_fields
= n_fields
;
6723 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
6725 table
->eviction_group_id_basis
= random_uint32();
6726 hmap_init(&table
->eviction_groups_by_id
);
6727 heap_init(&table
->eviction_groups_by_size
);
6729 fat_rwlock_rdlock(&table
->cls
.rwlock
);
6730 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
6731 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
6732 eviction_group_add_rule(rule
);
6734 fat_rwlock_unlock(&table
->cls
.rwlock
);
6737 /* Removes 'rule' from the oftable that contains it. */
6739 oftable_remove_rule__(struct ofproto
*ofproto
, struct rule
*rule
)
6740 OVS_REQUIRES(ofproto_mutex
)
6742 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
6744 fat_rwlock_wrlock(&cls
->rwlock
);
6745 classifier_remove(cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
6746 fat_rwlock_unlock(&cls
->rwlock
);
6748 cookies_remove(ofproto
, rule
);
6750 eviction_group_remove_rule(rule
);
6751 if (!list_is_empty(&rule
->expirable
)) {
6752 list_remove(&rule
->expirable
);
6754 if (!list_is_empty(&rule
->meter_list_node
)) {
6755 list_remove(&rule
->meter_list_node
);
6756 list_init(&rule
->meter_list_node
);
6761 oftable_remove_rule(struct rule
*rule
)
6762 OVS_REQUIRES(ofproto_mutex
)
6764 oftable_remove_rule__(rule
->ofproto
, rule
);
6767 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6768 * the same cls_rule. */
6770 oftable_insert_rule(struct rule
*rule
)
6771 OVS_REQUIRES(ofproto_mutex
)
6773 struct ofproto
*ofproto
= rule
->ofproto
;
6774 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6777 ovs_mutex_lock(&rule
->mutex
);
6778 may_expire
= rule
->hard_timeout
|| rule
->idle_timeout
;
6779 ovs_mutex_unlock(&rule
->mutex
);
6782 list_insert(&ofproto
->expirable
, &rule
->expirable
);
6785 cookies_insert(ofproto
, rule
);
6787 if (rule
->actions
->provider_meter_id
!= UINT32_MAX
) {
6788 uint32_t meter_id
= ofpacts_get_meter(rule
->actions
->ofpacts
,
6789 rule
->actions
->ofpacts_len
);
6790 struct meter
*meter
= ofproto
->meters
[meter_id
];
6791 list_insert(&meter
->rules
, &rule
->meter_list_node
);
6793 fat_rwlock_wrlock(&table
->cls
.rwlock
);
6794 classifier_insert(&table
->cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
6795 fat_rwlock_unlock(&table
->cls
.rwlock
);
6796 eviction_group_add_rule(rule
);
6799 /* unixctl commands. */
6802 ofproto_lookup(const char *name
)
6804 struct ofproto
*ofproto
;
6806 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
6808 if (!strcmp(ofproto
->name
, name
)) {
6816 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
6817 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
6819 struct ofproto
*ofproto
;
6823 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
6824 ds_put_format(&results
, "%s\n", ofproto
->name
);
6826 unixctl_command_reply(conn
, ds_cstr(&results
));
6827 ds_destroy(&results
);
6831 ofproto_unixctl_init(void)
6833 static bool registered
;
6839 unixctl_command_register("ofproto/list", "", 0, 0,
6840 ofproto_unixctl_list
, NULL
);
6843 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6845 * This is deprecated. It is only for compatibility with broken device drivers
6846 * in old versions of Linux that do not properly support VLANs when VLAN
6847 * devices are not used. When broken device drivers are no longer in
6848 * widespread use, we will delete these interfaces. */
6850 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6851 * (exactly) by an OpenFlow rule in 'ofproto'. */
6853 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
6855 const struct oftable
*oftable
;
6857 free(ofproto
->vlan_bitmap
);
6858 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
6859 ofproto
->vlans_changed
= false;
6861 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
6862 const struct cls_subtable
*table
;
6864 fat_rwlock_rdlock(&oftable
->cls
.rwlock
);
6865 HMAP_FOR_EACH (table
, hmap_node
, &oftable
->cls
.subtables
) {
6866 if (minimask_get_vid_mask(&table
->mask
) == VLAN_VID_MASK
) {
6867 const struct cls_rule
*rule
;
6869 HMAP_FOR_EACH (rule
, hmap_node
, &table
->rules
) {
6870 uint16_t vid
= miniflow_get_vid(&rule
->match
.flow
);
6871 bitmap_set1(vlan_bitmap
, vid
);
6872 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6876 fat_rwlock_unlock(&oftable
->cls
.rwlock
);
6880 /* Returns true if new VLANs have come into use by the flow table since the
6881 * last call to ofproto_get_vlan_usage().
6883 * We don't track when old VLANs stop being used. */
6885 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
6887 return ofproto
->vlans_changed
;
6890 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6891 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6892 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6893 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6894 * then the VLAN device is un-enslaved. */
6896 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
6897 ofp_port_t realdev_ofp_port
, int vid
)
6899 struct ofport
*ofport
;
6902 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
6904 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
6906 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
6907 ofproto
->name
, vlandev_ofp_port
);
6911 if (!ofproto
->ofproto_class
->set_realdev
) {
6912 if (!vlandev_ofp_port
) {
6915 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
6919 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
6921 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
6922 ofproto
->name
, vlandev_ofp_port
,
6923 netdev_get_name(ofport
->netdev
), ovs_strerror(error
));