2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
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(size_t n_handlers_
, size_t n_revalidators_
)
739 int threads
= MAX(count_cpu_cores(), 2);
741 n_revalidators
= n_revalidators_
;
742 n_handlers
= n_handlers_
;
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 ovs_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 ovs_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 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
1267 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
1268 ovs_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 ovs_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 ovs_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 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
1616 n_rules
+= classifier_count(&table
->cls
);
1617 ovs_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 ovs_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 ovs_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 ovs_rwlock_rdlock(&cls
->rwlock
);
1956 rule
= rule_from_cls_rule(classifier_find_match_exactly(cls
, target
,
1958 ovs_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
)
2532 atomic_add(&rule
->ref_count
, 1, &orig
);
2533 ovs_assert(orig
!= 0);
2538 ofproto_rule_unref(struct rule
*rule
)
2543 atomic_sub(&rule
->ref_count
, 1, &orig
);
2545 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2546 ofproto_rule_destroy__(rule
);
2548 ovs_assert(orig
!= 0);
2553 struct rule_actions
*
2554 rule_get_actions(const struct rule
*rule
)
2555 OVS_EXCLUDED(rule
->mutex
)
2557 struct rule_actions
*actions
;
2559 ovs_mutex_lock(&rule
->mutex
);
2560 actions
= rule_get_actions__(rule
);
2561 ovs_mutex_unlock(&rule
->mutex
);
2566 struct rule_actions
*
2567 rule_get_actions__(const struct rule
*rule
)
2568 OVS_REQUIRES(rule
->mutex
)
2570 rule_actions_ref(rule
->actions
);
2571 return rule
->actions
;
2575 ofproto_rule_destroy__(struct rule
*rule
)
2576 OVS_NO_THREAD_SAFETY_ANALYSIS
2578 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2579 rule_actions_unref(rule
->actions
);
2580 ovs_mutex_destroy(&rule
->mutex
);
2581 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2584 static uint32_t get_provider_meter_id(const struct ofproto
*,
2585 uint32_t of_meter_id
);
2587 /* Creates and returns a new 'struct rule_actions', with a ref_count of 1,
2588 * whose actions are a copy of from the 'ofpacts_len' bytes of 'ofpacts'. */
2589 struct rule_actions
*
2590 rule_actions_create(const struct ofproto
*ofproto
,
2591 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2593 struct rule_actions
*actions
;
2595 actions
= xmalloc(sizeof *actions
);
2596 atomic_init(&actions
->ref_count
, 1);
2597 actions
->ofpacts
= xmemdup(ofpacts
, ofpacts_len
);
2598 actions
->ofpacts_len
= ofpacts_len
;
2599 actions
->provider_meter_id
2600 = get_provider_meter_id(ofproto
,
2601 ofpacts_get_meter(ofpacts
, ofpacts_len
));
2606 /* Increments 'actions''s ref_count. */
2608 rule_actions_ref(struct rule_actions
*actions
)
2613 atomic_add(&actions
->ref_count
, 1, &orig
);
2614 ovs_assert(orig
!= 0);
2618 /* Decrements 'actions''s ref_count and frees 'actions' if the ref_count
2621 rule_actions_unref(struct rule_actions
*actions
)
2626 atomic_sub(&actions
->ref_count
, 1, &orig
);
2628 free(actions
->ofpacts
);
2631 ovs_assert(orig
!= 0);
2636 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2637 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2639 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2640 OVS_REQUIRES(ofproto_mutex
)
2642 return (port
== OFPP_ANY
2643 || ofpacts_output_to_port(rule
->actions
->ofpacts
,
2644 rule
->actions
->ofpacts_len
, port
));
2647 /* Returns true if 'rule' has group and equals group_id. */
2649 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
2650 OVS_REQUIRES(ofproto_mutex
)
2652 return (group_id
== OFPG11_ANY
2653 || ofpacts_output_to_group(rule
->actions
->ofpacts
,
2654 rule
->actions
->ofpacts_len
, group_id
));
2657 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2658 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2660 ofoperation_has_out_port(const struct ofoperation
*op
, ofp_port_t out_port
)
2661 OVS_REQUIRES(ofproto_mutex
)
2663 if (ofproto_rule_has_out_port(op
->rule
, out_port
)) {
2668 case OFOPERATION_ADD
:
2669 case OFOPERATION_DELETE
:
2672 case OFOPERATION_MODIFY
:
2673 case OFOPERATION_REPLACE
:
2674 return ofpacts_output_to_port(op
->actions
->ofpacts
,
2675 op
->actions
->ofpacts_len
, out_port
);
2682 rule_execute_destroy(struct rule_execute
*e
)
2684 ofproto_rule_unref(e
->rule
);
2685 list_remove(&e
->list_node
);
2689 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2690 * by passing them to the ofproto provider. */
2692 run_rule_executes(struct ofproto
*ofproto
)
2693 OVS_EXCLUDED(ofproto_mutex
)
2695 struct rule_execute
*e
, *next
;
2696 struct list executes
;
2698 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2699 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2700 union flow_in_port in_port_
;
2703 in_port_
.ofp_port
= e
->in_port
;
2704 flow_extract(e
->packet
, 0, 0, NULL
, &in_port_
, &flow
);
2705 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
2707 rule_execute_destroy(e
);
2711 /* Destroys and discards all "rule_execute" operations queued up in
2712 * ofproto->rule_executes. */
2714 destroy_rule_executes(struct ofproto
*ofproto
)
2716 struct rule_execute
*e
, *next
;
2717 struct list executes
;
2719 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2720 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2721 ofpbuf_delete(e
->packet
);
2722 rule_execute_destroy(e
);
2726 /* Returns true if 'rule' should be hidden from the controller.
2728 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2729 * (e.g. by in-band control) and are intentionally hidden from the
2732 ofproto_rule_is_hidden(const struct rule
*rule
)
2734 return rule
->cr
.priority
> UINT16_MAX
;
2737 static enum oftable_flags
2738 rule_get_flags(const struct rule
*rule
)
2740 return rule
->ofproto
->tables
[rule
->table_id
].flags
;
2744 rule_is_modifiable(const struct rule
*rule
)
2746 return !(rule_get_flags(rule
) & OFTABLE_READONLY
);
2750 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2752 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
2757 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2759 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2760 struct ofputil_switch_features features
;
2761 struct ofport
*port
;
2767 ofproto
->ofproto_class
->get_features(ofproto
, &arp_match_ip
,
2769 ovs_assert(features
.actions
& OFPUTIL_A_OUTPUT
); /* sanity check */
2771 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2772 * if present, are always at the end.) */
2773 n_tables
= ofproto
->n_tables
;
2774 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2775 if (ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
) {
2781 features
.datapath_id
= ofproto
->datapath_id
;
2782 features
.n_buffers
= pktbuf_capacity();
2783 features
.n_tables
= n_tables
;
2784 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
2785 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
);
2787 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
2789 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2790 features
.auxiliary_id
= 0;
2791 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
2793 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
2794 ofputil_put_switch_features_port(&port
->pp
, b
);
2797 ofconn_send_reply(ofconn
, b
);
2802 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2804 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2805 struct ofp_switch_config
*osc
;
2806 enum ofp_config_flags flags
;
2810 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
2811 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
2812 flags
= ofproto
->frag_handling
;
2813 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2814 if (oh
->version
< OFP13_VERSION
2815 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
2816 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
2818 osc
->flags
= htons(flags
);
2819 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
2820 ofconn_send_reply(ofconn
, buf
);
2826 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2828 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
2829 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2830 uint16_t flags
= ntohs(osc
->flags
);
2832 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
2833 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
2834 enum ofp_config_flags cur
= ofproto
->frag_handling
;
2835 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
2837 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
2839 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
2840 ofproto
->frag_handling
= next
;
2842 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
2844 ofputil_frag_handling_to_string(next
));
2848 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2849 ofconn_set_invalid_ttl_to_controller(ofconn
,
2850 (oh
->version
< OFP13_VERSION
2851 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
2853 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
2858 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2859 * error message code for the caller to propagate upward. Otherwise, returns
2862 * The log message mentions 'msg_type'. */
2864 reject_slave_controller(struct ofconn
*ofconn
)
2866 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
2867 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
2868 return OFPERR_OFPBRC_EPERM
;
2874 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2877 * - If they use a meter, then 'ofproto' has that meter configured.
2879 * - If they use any groups, then 'ofproto' has that group configured.
2881 * Returns 0 if successful, otherwise an OpenFlow error. */
2883 ofproto_check_ofpacts(struct ofproto
*ofproto
,
2884 const struct ofpact ofpacts
[], size_t ofpacts_len
)
2886 const struct ofpact
*a
;
2889 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
2890 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
2891 return OFPERR_OFPMMFC_INVALID_METER
;
2894 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
2895 if (a
->type
== OFPACT_GROUP
2896 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
2897 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
2905 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2907 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2908 struct ofputil_packet_out po
;
2909 struct ofpbuf
*payload
;
2910 uint64_t ofpacts_stub
[1024 / 8];
2911 struct ofpbuf ofpacts
;
2913 union flow_in_port in_port_
;
2916 COVERAGE_INC(ofproto_packet_out
);
2918 error
= reject_slave_controller(ofconn
);
2923 /* Decode message. */
2924 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
2925 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
2927 goto exit_free_ofpacts
;
2929 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
2930 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
2931 error
= OFPERR_OFPBRC_BAD_PORT
;
2932 goto exit_free_ofpacts
;
2936 if (po
.buffer_id
!= UINT32_MAX
) {
2937 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
2938 if (error
|| !payload
) {
2939 goto exit_free_ofpacts
;
2942 /* Ensure that the L3 header is 32-bit aligned. */
2943 payload
= ofpbuf_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
2946 /* Verify actions against packet, then send packet if successful. */
2947 in_port_
.ofp_port
= po
.in_port
;
2948 flow_extract(payload
, 0, 0, NULL
, &in_port_
, &flow
);
2949 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
2951 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
2952 po
.ofpacts
, po
.ofpacts_len
);
2954 ofpbuf_delete(payload
);
2957 ofpbuf_uninit(&ofpacts
);
2963 update_port_config(struct ofport
*port
,
2964 enum ofputil_port_config config
,
2965 enum ofputil_port_config mask
)
2967 enum ofputil_port_config old_config
= port
->pp
.config
;
2968 enum ofputil_port_config toggle
;
2970 toggle
= (config
^ port
->pp
.config
) & mask
;
2971 if (toggle
& OFPUTIL_PC_PORT_DOWN
) {
2972 if (config
& OFPUTIL_PC_PORT_DOWN
) {
2973 netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
);
2975 netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
);
2977 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
2980 port
->pp
.config
^= toggle
;
2981 if (port
->pp
.config
!= old_config
) {
2982 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
2987 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2989 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2990 struct ofputil_port_mod pm
;
2991 struct ofport
*port
;
2994 error
= reject_slave_controller(ofconn
);
2999 error
= ofputil_decode_port_mod(oh
, &pm
);
3004 port
= ofproto_get_port(p
, pm
.port_no
);
3006 return OFPERR_OFPPMFC_BAD_PORT
;
3007 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
3008 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3010 update_port_config(port
, pm
.config
, pm
.mask
);
3012 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
3019 handle_desc_stats_request(struct ofconn
*ofconn
,
3020 const struct ofp_header
*request
)
3022 static const char *default_mfr_desc
= "Nicira, Inc.";
3023 static const char *default_hw_desc
= "Open vSwitch";
3024 static const char *default_sw_desc
= VERSION
;
3025 static const char *default_serial_desc
= "None";
3026 static const char *default_dp_desc
= "None";
3028 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3029 struct ofp_desc_stats
*ods
;
3032 msg
= ofpraw_alloc_stats_reply(request
, 0);
3033 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3034 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3035 sizeof ods
->mfr_desc
);
3036 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3037 sizeof ods
->hw_desc
);
3038 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3039 sizeof ods
->sw_desc
);
3040 ovs_strlcpy(ods
->serial_num
,
3041 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3042 sizeof ods
->serial_num
);
3043 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3044 sizeof ods
->dp_desc
);
3045 ofconn_send_reply(ofconn
, msg
);
3051 handle_table_stats_request(struct ofconn
*ofconn
,
3052 const struct ofp_header
*request
)
3054 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3055 struct ofp12_table_stats
*ots
;
3060 /* Set up default values.
3062 * ofp12_table_stats is used as a generic structure as
3063 * it is able to hold all the fields for ofp10_table_stats
3064 * and ofp11_table_stats (and of course itself).
3066 ots
= xcalloc(p
->n_tables
, sizeof *ots
);
3067 for (i
= 0; i
< p
->n_tables
; i
++) {
3068 ots
[i
].table_id
= i
;
3069 sprintf(ots
[i
].name
, "table%"PRIuSIZE
, i
);
3070 ots
[i
].match
= htonll(OFPXMT13_MASK
);
3071 ots
[i
].wildcards
= htonll(OFPXMT13_MASK
);
3072 ots
[i
].write_actions
= htonl(OFPAT11_OUTPUT
);
3073 ots
[i
].apply_actions
= htonl(OFPAT11_OUTPUT
);
3074 ots
[i
].write_setfields
= htonll(OFPXMT13_MASK
);
3075 ots
[i
].apply_setfields
= htonll(OFPXMT13_MASK
);
3076 ots
[i
].metadata_match
= OVS_BE64_MAX
;
3077 ots
[i
].metadata_write
= OVS_BE64_MAX
;
3078 ots
[i
].instructions
= htonl(OFPIT11_ALL
);
3079 ots
[i
].config
= htonl(OFPTC11_TABLE_MISS_MASK
);
3080 ots
[i
].max_entries
= htonl(1000000); /* An arbitrary big number. */
3081 ovs_rwlock_rdlock(&p
->tables
[i
].cls
.rwlock
);
3082 ots
[i
].active_count
= htonl(classifier_count(&p
->tables
[i
].cls
));
3083 ovs_rwlock_unlock(&p
->tables
[i
].cls
.rwlock
);
3086 p
->ofproto_class
->get_tables(p
, ots
);
3088 /* Post-process the tables, dropping hidden tables. */
3089 n_tables
= p
->n_tables
;
3090 for (i
= 0; i
< p
->n_tables
; i
++) {
3091 const struct oftable
*table
= &p
->tables
[i
];
3093 if (table
->flags
& OFTABLE_HIDDEN
) {
3099 ovs_strzcpy(ots
[i
].name
, table
->name
, sizeof ots
[i
].name
);
3102 if (table
->max_flows
< ntohl(ots
[i
].max_entries
)) {
3103 ots
[i
].max_entries
= htonl(table
->max_flows
);
3107 msg
= ofputil_encode_table_stats_reply(ots
, n_tables
, request
);
3108 ofconn_send_reply(ofconn
, msg
);
3116 append_port_stat(struct ofport
*port
, struct list
*replies
)
3118 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3120 calc_duration(port
->created
, time_msec(),
3121 &ops
.duration_sec
, &ops
.duration_nsec
);
3123 /* Intentionally ignore return value, since errors will set
3124 * 'stats' to all-1s, which is correct for OpenFlow, and
3125 * netdev_get_stats() will log errors. */
3126 ofproto_port_get_stats(port
, &ops
.stats
);
3128 ofputil_append_port_stat(replies
, &ops
);
3132 handle_port_stats_request(struct ofconn
*ofconn
,
3133 const struct ofp_header
*request
)
3135 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3136 struct ofport
*port
;
3137 struct list replies
;
3141 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3146 ofpmp_init(&replies
, request
);
3147 if (port_no
!= OFPP_ANY
) {
3148 port
= ofproto_get_port(p
, port_no
);
3150 append_port_stat(port
, &replies
);
3153 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
3154 append_port_stat(port
, &replies
);
3158 ofconn_send_replies(ofconn
, &replies
);
3163 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3164 const struct ofp_header
*request
)
3166 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3167 enum ofp_version version
;
3168 struct ofport
*port
;
3169 struct list replies
;
3171 ofpmp_init(&replies
, request
);
3173 version
= ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn
));
3174 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
3175 ofputil_append_port_desc_stats_reply(version
, &port
->pp
, &replies
);
3178 ofconn_send_replies(ofconn
, &replies
);
3183 hash_cookie(ovs_be64 cookie
)
3185 return hash_2words((OVS_FORCE
uint64_t)cookie
>> 32,
3186 (OVS_FORCE
uint64_t)cookie
);
3190 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3191 OVS_REQUIRES(ofproto_mutex
)
3193 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3194 hash_cookie(rule
->flow_cookie
));
3198 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3199 OVS_REQUIRES(ofproto_mutex
)
3201 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3205 ofproto_rule_change_cookie(struct ofproto
*ofproto
, struct rule
*rule
,
3206 ovs_be64 new_cookie
)
3207 OVS_REQUIRES(ofproto_mutex
)
3209 if (new_cookie
!= rule
->flow_cookie
) {
3210 cookies_remove(ofproto
, rule
);
3212 ovs_mutex_lock(&rule
->mutex
);
3213 rule
->flow_cookie
= new_cookie
;
3214 ovs_mutex_unlock(&rule
->mutex
);
3216 cookies_insert(ofproto
, rule
);
3221 calc_duration(long long int start
, long long int now
,
3222 uint32_t *sec
, uint32_t *nsec
)
3224 long long int msecs
= now
- start
;
3225 *sec
= msecs
/ 1000;
3226 *nsec
= (msecs
% 1000) * (1000 * 1000);
3229 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3230 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
3232 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3234 return (table_id
== 0xff || table_id
< ofproto
->n_tables
3236 : OFPERR_OFPBRC_BAD_TABLE_ID
);
3240 static struct oftable
*
3241 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3243 struct oftable
*table
;
3245 for (table
= &ofproto
->tables
[table_id
];
3246 table
< &ofproto
->tables
[ofproto
->n_tables
];
3248 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3256 static struct oftable
*
3257 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3259 if (table_id
== 0xff) {
3260 return next_visible_table(ofproto
, 0);
3261 } else if (table_id
< ofproto
->n_tables
) {
3262 return &ofproto
->tables
[table_id
];
3268 static struct oftable
*
3269 next_matching_table(const struct ofproto
*ofproto
,
3270 const struct oftable
*table
, uint8_t table_id
)
3272 return (table_id
== 0xff
3273 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3277 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3279 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3280 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3282 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3283 * only once, for that table. (This can be used to access tables marked
3286 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3287 * entered at all. (Perhaps you should have validated TABLE_ID with
3288 * check_table_id().)
3290 * All parameters are evaluated multiple times.
3292 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3293 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3295 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3297 /* Initializes 'criteria' in a straightforward way based on the other
3300 * For "loose" matching, the 'priority' parameter is unimportant and may be
3303 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3304 const struct match
*match
, unsigned int priority
,
3305 ovs_be64 cookie
, ovs_be64 cookie_mask
,
3306 ofp_port_t out_port
, uint32_t out_group
)
3308 criteria
->table_id
= table_id
;
3309 cls_rule_init(&criteria
->cr
, match
, priority
);
3310 criteria
->cookie
= cookie
;
3311 criteria
->cookie_mask
= cookie_mask
;
3312 criteria
->out_port
= out_port
;
3313 criteria
->out_group
= out_group
;
3317 rule_criteria_destroy(struct rule_criteria
*criteria
)
3319 cls_rule_destroy(&criteria
->cr
);
3323 rule_collection_init(struct rule_collection
*rules
)
3325 rules
->rules
= rules
->stub
;
3327 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
3331 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
3333 if (rules
->n
>= rules
->capacity
) {
3334 size_t old_size
, new_size
;
3336 old_size
= rules
->capacity
* sizeof *rules
->rules
;
3337 rules
->capacity
*= 2;
3338 new_size
= rules
->capacity
* sizeof *rules
->rules
;
3340 if (rules
->rules
== rules
->stub
) {
3341 rules
->rules
= xmalloc(new_size
);
3342 memcpy(rules
->rules
, rules
->stub
, old_size
);
3344 rules
->rules
= xrealloc(rules
->rules
, new_size
);
3348 rules
->rules
[rules
->n
++] = rule
;
3352 rule_collection_ref(struct rule_collection
*rules
)
3353 OVS_REQUIRES(ofproto_mutex
)
3357 for (i
= 0; i
< rules
->n
; i
++) {
3358 ofproto_rule_ref(rules
->rules
[i
]);
3363 rule_collection_unref(struct rule_collection
*rules
)
3367 for (i
= 0; i
< rules
->n
; i
++) {
3368 ofproto_rule_unref(rules
->rules
[i
]);
3373 rule_collection_destroy(struct rule_collection
*rules
)
3375 if (rules
->rules
!= rules
->stub
) {
3381 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
3382 struct rule_collection
*rules
)
3383 OVS_REQUIRES(ofproto_mutex
)
3385 /* We ordinarily want to skip hidden rules, but there has to be a way for
3386 * code internal to OVS to modify and delete them, so if the criteria
3387 * specify a priority that can only be for a hidden flow, then allow hidden
3388 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3389 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3391 if (ofproto_rule_is_hidden(rule
) && c
->cr
.priority
<= UINT16_MAX
) {
3393 } else if (rule
->pending
) {
3394 return OFPROTO_POSTPONE
;
3396 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
3397 && ofproto_rule_has_out_port(rule
, c
->out_port
)
3398 && ofproto_rule_has_out_group(rule
, c
->out_group
)
3399 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)) {
3400 rule_collection_add(rules
, rule
);
3406 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3407 * on classifiers rules are done in the "loose" way required for OpenFlow
3408 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3411 * Hidden rules are always omitted.
3413 * Returns 0 on success, otherwise an OpenFlow error code. */
3415 collect_rules_loose(struct ofproto
*ofproto
,
3416 const struct rule_criteria
*criteria
,
3417 struct rule_collection
*rules
)
3418 OVS_REQUIRES(ofproto_mutex
)
3420 struct oftable
*table
;
3423 rule_collection_init(rules
);
3425 error
= check_table_id(ofproto
, criteria
->table_id
);
3430 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3433 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3434 hash_cookie(criteria
->cookie
),
3435 &ofproto
->cookies
) {
3436 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
3437 error
= collect_rule(rule
, criteria
, rules
);
3444 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3445 struct cls_cursor cursor
;
3448 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
3449 cls_cursor_init(&cursor
, &table
->cls
, &criteria
->cr
);
3450 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
3451 error
= collect_rule(rule
, criteria
, rules
);
3456 ovs_rwlock_unlock(&table
->cls
.rwlock
);
3462 rule_collection_destroy(rules
);
3467 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3468 * on classifiers rules are done in the "strict" way required for OpenFlow
3469 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3470 * rules on list 'rules'.
3472 * Hidden rules are always omitted.
3474 * Returns 0 on success, otherwise an OpenFlow error code. */
3476 collect_rules_strict(struct ofproto
*ofproto
,
3477 const struct rule_criteria
*criteria
,
3478 struct rule_collection
*rules
)
3479 OVS_REQUIRES(ofproto_mutex
)
3481 struct oftable
*table
;
3484 rule_collection_init(rules
);
3486 error
= check_table_id(ofproto
, criteria
->table_id
);
3491 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3494 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3495 hash_cookie(criteria
->cookie
),
3496 &ofproto
->cookies
) {
3497 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
3498 error
= collect_rule(rule
, criteria
, rules
);
3505 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3508 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
3509 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
3510 &table
->cls
, &criteria
->cr
));
3511 ovs_rwlock_unlock(&table
->cls
.rwlock
);
3513 error
= collect_rule(rule
, criteria
, rules
);
3523 rule_collection_destroy(rules
);
3528 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3529 * forced into the range of a uint16_t. */
3531 age_secs(long long int age_ms
)
3533 return (age_ms
< 0 ? 0
3534 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
3535 : (unsigned int) age_ms
/ 1000);
3539 handle_flow_stats_request(struct ofconn
*ofconn
,
3540 const struct ofp_header
*request
)
3541 OVS_EXCLUDED(ofproto_mutex
)
3543 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3544 struct ofputil_flow_stats_request fsr
;
3545 struct rule_criteria criteria
;
3546 struct rule_collection rules
;
3547 struct list replies
;
3551 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
3556 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, fsr
.cookie
,
3557 fsr
.cookie_mask
, fsr
.out_port
, fsr
.out_group
);
3559 ovs_mutex_lock(&ofproto_mutex
);
3560 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3561 rule_criteria_destroy(&criteria
);
3563 rule_collection_ref(&rules
);
3565 ovs_mutex_unlock(&ofproto_mutex
);
3571 ofpmp_init(&replies
, request
);
3572 for (i
= 0; i
< rules
.n
; i
++) {
3573 struct rule
*rule
= rules
.rules
[i
];
3574 long long int now
= time_msec();
3575 struct ofputil_flow_stats fs
;
3576 long long int created
, used
, modified
;
3577 struct rule_actions
*actions
;
3578 enum ofputil_flow_mod_flags flags
;
3580 ovs_mutex_lock(&rule
->mutex
);
3581 fs
.cookie
= rule
->flow_cookie
;
3582 fs
.idle_timeout
= rule
->idle_timeout
;
3583 fs
.hard_timeout
= rule
->hard_timeout
;
3584 created
= rule
->created
;
3586 modified
= rule
->modified
;
3587 actions
= rule_get_actions__(rule
);
3588 flags
= rule
->flags
;
3589 ovs_mutex_unlock(&rule
->mutex
);
3591 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
3592 fs
.table_id
= rule
->table_id
;
3593 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
3594 fs
.priority
= rule
->cr
.priority
;
3595 fs
.idle_age
= age_secs(now
- used
);
3596 fs
.hard_age
= age_secs(now
- modified
);
3597 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
3599 fs
.ofpacts
= actions
->ofpacts
;
3600 fs
.ofpacts_len
= actions
->ofpacts_len
;
3603 ofputil_append_flow_stats_reply(&fs
, &replies
);
3605 rule_actions_unref(actions
);
3608 rule_collection_unref(&rules
);
3609 rule_collection_destroy(&rules
);
3611 ofconn_send_replies(ofconn
, &replies
);
3617 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
3619 uint64_t packet_count
, byte_count
;
3620 struct rule_actions
*actions
;
3621 long long int created
;
3623 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
,
3624 &packet_count
, &byte_count
);
3626 ovs_mutex_lock(&rule
->mutex
);
3627 actions
= rule_get_actions__(rule
);
3628 created
= rule
->created
;
3629 ovs_mutex_unlock(&rule
->mutex
);
3631 if (rule
->table_id
!= 0) {
3632 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
3634 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
3635 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
3636 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
3637 cls_rule_format(&rule
->cr
, results
);
3638 ds_put_char(results
, ',');
3640 ds_put_cstr(results
, "actions=");
3641 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
3643 ds_put_cstr(results
, "\n");
3645 rule_actions_unref(actions
);
3648 /* Adds a pretty-printed description of all flows to 'results', including
3649 * hidden flows (e.g., set up by in-band control). */
3651 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
3653 struct oftable
*table
;
3655 OFPROTO_FOR_EACH_TABLE (table
, p
) {
3656 struct cls_cursor cursor
;
3659 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
3660 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
3661 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
3662 flow_stats_ds(rule
, results
);
3664 ovs_rwlock_unlock(&table
->cls
.rwlock
);
3668 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3669 * '*engine_type' and '*engine_id', respectively. */
3671 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
3672 uint8_t *engine_type
, uint8_t *engine_id
)
3674 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
3677 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3678 * true if the port's CFM status was successfully stored into '*status'.
3679 * Returns false if the port did not have CFM configured, in which case
3680 * '*status' is indeterminate.
3682 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3684 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
3685 struct ofproto_cfm_status
*status
)
3687 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3689 && ofproto
->ofproto_class
->get_cfm_status
3690 && ofproto
->ofproto_class
->get_cfm_status(ofport
, status
));
3694 handle_aggregate_stats_request(struct ofconn
*ofconn
,
3695 const struct ofp_header
*oh
)
3696 OVS_EXCLUDED(ofproto_mutex
)
3698 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3699 struct ofputil_flow_stats_request request
;
3700 struct ofputil_aggregate_stats stats
;
3701 bool unknown_packets
, unknown_bytes
;
3702 struct rule_criteria criteria
;
3703 struct rule_collection rules
;
3704 struct ofpbuf
*reply
;
3708 error
= ofputil_decode_flow_stats_request(&request
, oh
);
3713 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
3714 request
.cookie
, request
.cookie_mask
,
3715 request
.out_port
, request
.out_group
);
3717 ovs_mutex_lock(&ofproto_mutex
);
3718 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3719 rule_criteria_destroy(&criteria
);
3721 rule_collection_ref(&rules
);
3723 ovs_mutex_unlock(&ofproto_mutex
);
3729 memset(&stats
, 0, sizeof stats
);
3730 unknown_packets
= unknown_bytes
= false;
3731 for (i
= 0; i
< rules
.n
; i
++) {
3732 struct rule
*rule
= rules
.rules
[i
];
3733 uint64_t packet_count
;
3734 uint64_t byte_count
;
3736 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3739 if (packet_count
== UINT64_MAX
) {
3740 unknown_packets
= true;
3742 stats
.packet_count
+= packet_count
;
3745 if (byte_count
== UINT64_MAX
) {
3746 unknown_bytes
= true;
3748 stats
.byte_count
+= byte_count
;
3753 if (unknown_packets
) {
3754 stats
.packet_count
= UINT64_MAX
;
3756 if (unknown_bytes
) {
3757 stats
.byte_count
= UINT64_MAX
;
3760 rule_collection_unref(&rules
);
3761 rule_collection_destroy(&rules
);
3763 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
3764 ofconn_send_reply(ofconn
, reply
);
3769 struct queue_stats_cbdata
{
3770 struct ofport
*ofport
;
3771 struct list replies
;
3776 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
3777 const struct netdev_queue_stats
*stats
)
3779 struct ofputil_queue_stats oqs
;
3781 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
3782 oqs
.queue_id
= queue_id
;
3783 oqs
.tx_bytes
= stats
->tx_bytes
;
3784 oqs
.tx_packets
= stats
->tx_packets
;
3785 oqs
.tx_errors
= stats
->tx_errors
;
3786 if (stats
->created
!= LLONG_MIN
) {
3787 calc_duration(stats
->created
, cbdata
->now
,
3788 &oqs
.duration_sec
, &oqs
.duration_nsec
);
3790 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
3792 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
3796 handle_queue_stats_dump_cb(uint32_t queue_id
,
3797 struct netdev_queue_stats
*stats
,
3800 struct queue_stats_cbdata
*cbdata
= cbdata_
;
3802 put_queue_stats(cbdata
, queue_id
, stats
);
3806 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
3807 struct queue_stats_cbdata
*cbdata
)
3809 cbdata
->ofport
= port
;
3810 if (queue_id
== OFPQ_ALL
) {
3811 netdev_dump_queue_stats(port
->netdev
,
3812 handle_queue_stats_dump_cb
, cbdata
);
3814 struct netdev_queue_stats stats
;
3816 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
3817 put_queue_stats(cbdata
, queue_id
, &stats
);
3819 return OFPERR_OFPQOFC_BAD_QUEUE
;
3826 handle_queue_stats_request(struct ofconn
*ofconn
,
3827 const struct ofp_header
*rq
)
3829 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3830 struct queue_stats_cbdata cbdata
;
3831 struct ofport
*port
;
3833 struct ofputil_queue_stats_request oqsr
;
3835 COVERAGE_INC(ofproto_queue_req
);
3837 ofpmp_init(&cbdata
.replies
, rq
);
3838 cbdata
.now
= time_msec();
3840 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
3845 if (oqsr
.port_no
== OFPP_ANY
) {
3846 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
3847 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3848 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
3853 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
3855 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
3856 : OFPERR_OFPQOFC_BAD_PORT
);
3859 ofconn_send_replies(ofconn
, &cbdata
.replies
);
3861 ofpbuf_list_delete(&cbdata
.replies
);
3868 is_flow_deletion_pending(const struct ofproto
*ofproto
,
3869 const struct cls_rule
*cls_rule
,
3871 OVS_REQUIRES(ofproto_mutex
)
3873 if (!hmap_is_empty(&ofproto
->deletions
)) {
3874 struct ofoperation
*op
;
3876 HMAP_FOR_EACH_WITH_HASH (op
, hmap_node
,
3877 cls_rule_hash(cls_rule
, table_id
),
3878 &ofproto
->deletions
) {
3879 if (cls_rule_equal(cls_rule
, &op
->rule
->cr
)) {
3889 should_evict_a_rule(struct oftable
*table
, unsigned int extra_space
)
3890 OVS_REQUIRES(ofproto_mutex
)
3891 OVS_NO_THREAD_SAFETY_ANALYSIS
3893 return classifier_count(&table
->cls
) + extra_space
> table
->max_flows
;
3897 evict_rules_from_table(struct ofproto
*ofproto
, struct oftable
*table
,
3898 unsigned int extra_space
)
3899 OVS_REQUIRES(ofproto_mutex
)
3901 while (should_evict_a_rule(table
, extra_space
)) {
3904 if (!choose_rule_to_evict(table
, &rule
)) {
3905 return OFPERR_OFPFMFC_TABLE_FULL
;
3906 } else if (rule
->pending
) {
3907 return OFPROTO_POSTPONE
;
3909 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
3910 delete_flow__(rule
, group
, OFPRR_EVICTION
);
3911 ofopgroup_submit(group
);
3918 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3919 * in which no matching flow already exists in the flow table.
3921 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3922 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3923 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3924 * initiated now but may be retried later.
3926 * The caller retains ownership of 'fm->ofpacts'.
3928 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3931 add_flow(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3932 struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
)
3933 OVS_REQUIRES(ofproto_mutex
)
3935 struct oftable
*table
;
3936 struct ofopgroup
*group
;
3942 error
= check_table_id(ofproto
, fm
->table_id
);
3948 if (fm
->table_id
== 0xff) {
3949 if (ofproto
->ofproto_class
->rule_choose_table
) {
3950 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
3956 ovs_assert(table_id
< ofproto
->n_tables
);
3960 } else if (fm
->table_id
< ofproto
->n_tables
) {
3961 table_id
= fm
->table_id
;
3963 return OFPERR_OFPBRC_BAD_TABLE_ID
;
3966 table
= &ofproto
->tables
[table_id
];
3968 if (table
->flags
& OFTABLE_READONLY
) {
3969 return OFPERR_OFPBRC_EPERM
;
3972 cls_rule_init(&cr
, &fm
->match
, fm
->priority
);
3974 /* Transform "add" into "modify" if there's an existing identical flow. */
3975 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
3976 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
));
3977 ovs_rwlock_unlock(&table
->cls
.rwlock
);
3979 cls_rule_destroy(&cr
);
3980 if (!rule_is_modifiable(rule
)) {
3981 return OFPERR_OFPBRC_EPERM
;
3982 } else if (rule
->pending
) {
3983 return OFPROTO_POSTPONE
;
3985 struct rule_collection rules
;
3987 rule_collection_init(&rules
);
3988 rule_collection_add(&rules
, rule
);
3989 fm
->modify_cookie
= true;
3990 error
= modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
);
3991 rule_collection_destroy(&rules
);
3997 /* Serialize against pending deletion. */
3998 if (is_flow_deletion_pending(ofproto
, &cr
, table_id
)) {
3999 cls_rule_destroy(&cr
);
4000 return OFPROTO_POSTPONE
;
4003 /* Check for overlap, if requested. */
4004 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
) {
4007 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
4008 overlaps
= classifier_rule_overlaps(&table
->cls
, &cr
);
4009 ovs_rwlock_unlock(&table
->cls
.rwlock
);
4012 cls_rule_destroy(&cr
);
4013 return OFPERR_OFPFMFC_OVERLAP
;
4017 /* If necessary, evict an existing rule to clear out space. */
4018 error
= evict_rules_from_table(ofproto
, table
, 1);
4020 cls_rule_destroy(&cr
);
4024 /* Allocate new rule. */
4025 rule
= ofproto
->ofproto_class
->rule_alloc();
4027 cls_rule_destroy(&cr
);
4028 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
4029 ofproto
->name
, ovs_strerror(error
));
4033 /* Initialize base state. */
4034 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4035 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), &cr
);
4036 atomic_init(&rule
->ref_count
, 1);
4037 rule
->pending
= NULL
;
4038 rule
->flow_cookie
= fm
->new_cookie
;
4039 rule
->created
= rule
->modified
= rule
->used
= time_msec();
4041 ovs_mutex_init(&rule
->mutex
);
4042 ovs_mutex_lock(&rule
->mutex
);
4043 rule
->idle_timeout
= fm
->idle_timeout
;
4044 rule
->hard_timeout
= fm
->hard_timeout
;
4045 ovs_mutex_unlock(&rule
->mutex
);
4047 *CONST_CAST(uint8_t *, &rule
->table_id
) = table
- ofproto
->tables
;
4048 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4049 rule
->actions
= rule_actions_create(ofproto
, fm
->ofpacts
, fm
->ofpacts_len
);
4050 list_init(&rule
->meter_list_node
);
4051 rule
->eviction_group
= NULL
;
4052 list_init(&rule
->expirable
);
4053 rule
->monitor_flags
= 0;
4054 rule
->add_seqno
= 0;
4055 rule
->modify_seqno
= 0;
4057 /* Construct rule, initializing derived state. */
4058 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4060 ofproto_rule_destroy__(rule
);
4065 oftable_insert_rule(rule
);
4067 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
4068 ofoperation_create(group
, rule
, OFOPERATION_ADD
, 0);
4069 ofproto
->ofproto_class
->rule_insert(rule
);
4070 ofopgroup_submit(group
);
4075 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4077 /* Modifies the rules listed in 'rules', changing their actions to match those
4080 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4083 * Returns 0 on success, otherwise an OpenFlow error code. */
4085 modify_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4086 struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
,
4087 const struct rule_collection
*rules
)
4088 OVS_REQUIRES(ofproto_mutex
)
4090 enum ofoperation_type type
;
4091 struct ofopgroup
*group
;
4095 type
= fm
->command
== OFPFC_ADD
? OFOPERATION_REPLACE
: OFOPERATION_MODIFY
;
4096 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
4097 error
= OFPERR_OFPBRC_EPERM
;
4098 for (i
= 0; i
< rules
->n
; i
++) {
4099 struct rule
*rule
= rules
->rules
[i
];
4100 struct ofoperation
*op
;
4101 bool actions_changed
;
4102 bool reset_counters
;
4104 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4106 if (rule_is_modifiable(rule
)) {
4107 /* At least one rule is modifiable, don't report EPERM error. */
4113 actions_changed
= !ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
4114 rule
->actions
->ofpacts
,
4115 rule
->actions
->ofpacts_len
);
4117 op
= ofoperation_create(group
, rule
, type
, 0);
4119 if (fm
->modify_cookie
&& fm
->new_cookie
!= OVS_BE64_MAX
) {
4120 ofproto_rule_change_cookie(ofproto
, rule
, fm
->new_cookie
);
4122 if (type
== OFOPERATION_REPLACE
) {
4123 ovs_mutex_lock(&rule
->mutex
);
4124 rule
->idle_timeout
= fm
->idle_timeout
;
4125 rule
->hard_timeout
= fm
->hard_timeout
;
4126 ovs_mutex_unlock(&rule
->mutex
);
4128 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4129 if (fm
->idle_timeout
|| fm
->hard_timeout
) {
4130 if (!rule
->eviction_group
) {
4131 eviction_group_add_rule(rule
);
4134 eviction_group_remove_rule(rule
);
4138 reset_counters
= (fm
->flags
& OFPUTIL_FF_RESET_COUNTS
) != 0;
4139 if (actions_changed
|| reset_counters
) {
4140 struct rule_actions
*new_actions
;
4142 op
->actions
= rule
->actions
;
4143 new_actions
= rule_actions_create(ofproto
,
4144 fm
->ofpacts
, fm
->ofpacts_len
);
4146 ovs_mutex_lock(&rule
->mutex
);
4147 rule
->actions
= new_actions
;
4148 ovs_mutex_unlock(&rule
->mutex
);
4150 rule
->ofproto
->ofproto_class
->rule_modify_actions(rule
,
4153 ofoperation_complete(op
, 0);
4156 ofopgroup_submit(group
);
4162 modify_flows_add(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4163 struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
)
4164 OVS_REQUIRES(ofproto_mutex
)
4166 if (fm
->cookie_mask
!= htonll(0) || fm
->new_cookie
== OVS_BE64_MAX
) {
4169 return add_flow(ofproto
, ofconn
, fm
, request
);
4172 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4175 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4178 modify_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4179 struct ofputil_flow_mod
*fm
,
4180 const struct ofp_header
*request
)
4181 OVS_REQUIRES(ofproto_mutex
)
4183 struct rule_criteria criteria
;
4184 struct rule_collection rules
;
4187 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4188 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4189 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4190 rule_criteria_destroy(&criteria
);
4193 error
= (rules
.n
> 0
4194 ? modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
)
4195 : modify_flows_add(ofproto
, ofconn
, fm
, request
));
4198 rule_collection_destroy(&rules
);
4203 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4206 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4209 modify_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4210 struct ofputil_flow_mod
*fm
,
4211 const struct ofp_header
*request
)
4212 OVS_REQUIRES(ofproto_mutex
)
4214 struct rule_criteria criteria
;
4215 struct rule_collection rules
;
4218 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4219 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4220 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4221 rule_criteria_destroy(&criteria
);
4225 error
= modify_flows_add(ofproto
, ofconn
, fm
, request
);
4226 } else if (rules
.n
== 1) {
4227 error
= modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
);
4231 rule_collection_destroy(&rules
);
4236 /* OFPFC_DELETE implementation. */
4239 delete_flow__(struct rule
*rule
, struct ofopgroup
*group
,
4240 enum ofp_flow_removed_reason reason
)
4241 OVS_REQUIRES(ofproto_mutex
)
4243 struct ofproto
*ofproto
= rule
->ofproto
;
4245 ofproto_rule_send_removed(rule
, reason
);
4247 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, reason
);
4248 oftable_remove_rule(rule
);
4249 ofproto
->ofproto_class
->rule_delete(rule
);
4252 /* Deletes the rules listed in 'rules'.
4254 * Returns 0 on success, otherwise an OpenFlow error code. */
4256 delete_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4257 const struct ofp_header
*request
,
4258 const struct rule_collection
*rules
,
4259 enum ofp_flow_removed_reason reason
)
4260 OVS_REQUIRES(ofproto_mutex
)
4262 struct ofopgroup
*group
;
4265 group
= ofopgroup_create(ofproto
, ofconn
, request
, UINT32_MAX
);
4266 for (i
= 0; i
< rules
->n
; i
++) {
4267 delete_flow__(rules
->rules
[i
], group
, reason
);
4269 ofopgroup_submit(group
);
4274 /* Implements OFPFC_DELETE. */
4276 delete_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4277 const struct ofputil_flow_mod
*fm
,
4278 const struct ofp_header
*request
)
4279 OVS_REQUIRES(ofproto_mutex
)
4281 struct rule_criteria criteria
;
4282 struct rule_collection rules
;
4285 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4286 fm
->cookie
, fm
->cookie_mask
,
4287 fm
->out_port
, fm
->out_group
);
4288 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4289 rule_criteria_destroy(&criteria
);
4291 if (!error
&& rules
.n
> 0) {
4292 error
= delete_flows__(ofproto
, ofconn
, request
, &rules
, OFPRR_DELETE
);
4294 rule_collection_destroy(&rules
);
4299 /* Implements OFPFC_DELETE_STRICT. */
4301 delete_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4302 const struct ofputil_flow_mod
*fm
,
4303 const struct ofp_header
*request
)
4304 OVS_REQUIRES(ofproto_mutex
)
4306 struct rule_criteria criteria
;
4307 struct rule_collection rules
;
4310 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4311 fm
->cookie
, fm
->cookie_mask
,
4312 fm
->out_port
, fm
->out_group
);
4313 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4314 rule_criteria_destroy(&criteria
);
4316 if (!error
&& rules
.n
> 0) {
4317 error
= delete_flows__(ofproto
, ofconn
, request
, &rules
, OFPRR_DELETE
);
4319 rule_collection_destroy(&rules
);
4325 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
4326 OVS_REQUIRES(ofproto_mutex
)
4328 struct ofputil_flow_removed fr
;
4330 if (ofproto_rule_is_hidden(rule
) ||
4331 !(rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
)) {
4335 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
4336 fr
.priority
= rule
->cr
.priority
;
4337 fr
.cookie
= rule
->flow_cookie
;
4339 fr
.table_id
= rule
->table_id
;
4340 calc_duration(rule
->created
, time_msec(),
4341 &fr
.duration_sec
, &fr
.duration_nsec
);
4342 ovs_mutex_lock(&rule
->mutex
);
4343 fr
.idle_timeout
= rule
->idle_timeout
;
4344 fr
.hard_timeout
= rule
->hard_timeout
;
4345 ovs_mutex_unlock(&rule
->mutex
);
4346 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
4349 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
4352 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4353 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4356 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4359 * ofproto implementation ->run() functions should use this function to expire
4360 * OpenFlow flows. */
4362 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
4363 OVS_REQUIRES(ofproto_mutex
)
4365 struct ofproto
*ofproto
= rule
->ofproto
;
4367 ovs_assert(reason
== OFPRR_HARD_TIMEOUT
|| reason
== OFPRR_IDLE_TIMEOUT
4368 || reason
== OFPRR_DELETE
|| reason
== OFPRR_GROUP_DELETE
);
4370 ofproto_rule_delete__(ofproto
, rule
, reason
);
4373 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4374 * means "infinite". */
4376 reduce_timeout(uint16_t max
, uint16_t *timeout
)
4378 if (max
&& (!*timeout
|| *timeout
> max
)) {
4383 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4384 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4385 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4387 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4389 ofproto_rule_reduce_timeouts(struct rule
*rule
,
4390 uint16_t idle_timeout
, uint16_t hard_timeout
)
4391 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
4393 if (!idle_timeout
&& !hard_timeout
) {
4397 ovs_mutex_lock(&ofproto_mutex
);
4398 if (list_is_empty(&rule
->expirable
)) {
4399 list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
4401 ovs_mutex_unlock(&ofproto_mutex
);
4403 ovs_mutex_lock(&rule
->mutex
);
4404 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
4405 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
4406 ovs_mutex_unlock(&rule
->mutex
);
4410 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4411 OVS_EXCLUDED(ofproto_mutex
)
4413 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4414 struct ofputil_flow_mod fm
;
4415 uint64_t ofpacts_stub
[1024 / 8];
4416 struct ofpbuf ofpacts
;
4420 error
= reject_slave_controller(ofconn
);
4425 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
4426 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
4428 u16_to_ofp(ofproto
->max_ports
),
4431 error
= ofproto_check_ofpacts(ofproto
, fm
.ofpacts
, fm
.ofpacts_len
);
4434 error
= handle_flow_mod__(ofproto
, ofconn
, &fm
, oh
);
4437 goto exit_free_ofpacts
;
4440 /* Record the operation for logging a summary report. */
4441 switch (fm
.command
) {
4447 case OFPFC_MODIFY_STRICT
:
4448 ofproto
->n_modify
++;
4452 case OFPFC_DELETE_STRICT
:
4453 ofproto
->n_delete
++;
4458 if (ofproto
->next_op_report
== LLONG_MAX
) {
4459 ofproto
->first_op
= now
;
4460 ofproto
->next_op_report
= MAX(now
+ 10 * 1000,
4461 ofproto
->op_backoff
);
4462 ofproto
->op_backoff
= ofproto
->next_op_report
+ 60 * 1000;
4464 ofproto
->last_op
= now
;
4467 ofpbuf_uninit(&ofpacts
);
4473 handle_flow_mod__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4474 struct ofputil_flow_mod
*fm
, const struct ofp_header
*oh
)
4475 OVS_EXCLUDED(ofproto_mutex
)
4479 ovs_mutex_lock(&ofproto_mutex
);
4480 if (ofproto
->n_pending
< 50) {
4481 switch (fm
->command
) {
4483 error
= add_flow(ofproto
, ofconn
, fm
, oh
);
4487 error
= modify_flows_loose(ofproto
, ofconn
, fm
, oh
);
4490 case OFPFC_MODIFY_STRICT
:
4491 error
= modify_flow_strict(ofproto
, ofconn
, fm
, oh
);
4495 error
= delete_flows_loose(ofproto
, ofconn
, fm
, oh
);
4498 case OFPFC_DELETE_STRICT
:
4499 error
= delete_flow_strict(ofproto
, ofconn
, fm
, oh
);
4503 if (fm
->command
> 0xff) {
4504 VLOG_WARN_RL(&rl
, "%s: flow_mod has explicit table_id but "
4505 "flow_mod_table_id extension is not enabled",
4508 error
= OFPERR_OFPFMFC_BAD_COMMAND
;
4512 ovs_assert(!list_is_empty(&ofproto
->pending
));
4513 error
= OFPROTO_POSTPONE
;
4515 ovs_mutex_unlock(&ofproto_mutex
);
4517 run_rule_executes(ofproto
);
4522 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4524 struct ofputil_role_request request
;
4525 struct ofputil_role_request reply
;
4529 error
= ofputil_decode_role_message(oh
, &request
);
4534 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
4535 if (ofconn_get_role(ofconn
) != request
.role
4536 && ofconn_has_pending_opgroups(ofconn
)) {
4537 return OFPROTO_POSTPONE
;
4540 if (request
.have_generation_id
4541 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
4542 return OFPERR_OFPRRFC_STALE
;
4545 ofconn_set_role(ofconn
, request
.role
);
4548 reply
.role
= ofconn_get_role(ofconn
);
4549 reply
.have_generation_id
= ofconn_get_master_election_id(
4550 ofconn
, &reply
.generation_id
);
4551 buf
= ofputil_encode_role_reply(oh
, &reply
);
4552 ofconn_send_reply(ofconn
, buf
);
4558 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
4559 const struct ofp_header
*oh
)
4561 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
4562 enum ofputil_protocol cur
, next
;
4564 cur
= ofconn_get_protocol(ofconn
);
4565 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
4566 ofconn_set_protocol(ofconn
, next
);
4572 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4574 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
4575 enum ofputil_protocol cur
, next
;
4576 enum ofputil_protocol next_base
;
4578 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
4580 return OFPERR_OFPBRC_EPERM
;
4583 cur
= ofconn_get_protocol(ofconn
);
4584 next
= ofputil_protocol_set_base(cur
, next_base
);
4585 if (cur
!= next
&& ofconn_has_pending_opgroups(ofconn
)) {
4586 /* Avoid sending async messages in surprising protocol. */
4587 return OFPROTO_POSTPONE
;
4590 ofconn_set_protocol(ofconn
, next
);
4595 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
4596 const struct ofp_header
*oh
)
4598 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
4601 format
= ntohl(msg
->format
);
4602 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
4603 return OFPERR_OFPBRC_EPERM
;
4606 if (format
!= ofconn_get_packet_in_format(ofconn
)
4607 && ofconn_has_pending_opgroups(ofconn
)) {
4608 /* Avoid sending async message in surprsing packet in format. */
4609 return OFPROTO_POSTPONE
;
4612 ofconn_set_packet_in_format(ofconn
, format
);
4617 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4619 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
4620 uint32_t master
[OAM_N_TYPES
];
4621 uint32_t slave
[OAM_N_TYPES
];
4623 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
4624 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
4625 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
4627 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
4628 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
4629 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
4631 ofconn_set_async_config(ofconn
, master
, slave
);
4632 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
4633 !ofconn_get_miss_send_len(ofconn
)) {
4634 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
4641 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4644 uint32_t master
[OAM_N_TYPES
];
4645 uint32_t slave
[OAM_N_TYPES
];
4646 struct nx_async_config
*msg
;
4648 ofconn_get_async_config(ofconn
, master
, slave
);
4649 buf
= ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY
, oh
, 0);
4650 msg
= ofpbuf_put_zeros(buf
, sizeof *msg
);
4652 msg
->packet_in_mask
[0] = htonl(master
[OAM_PACKET_IN
]);
4653 msg
->port_status_mask
[0] = htonl(master
[OAM_PORT_STATUS
]);
4654 msg
->flow_removed_mask
[0] = htonl(master
[OAM_FLOW_REMOVED
]);
4656 msg
->packet_in_mask
[1] = htonl(slave
[OAM_PACKET_IN
]);
4657 msg
->port_status_mask
[1] = htonl(slave
[OAM_PORT_STATUS
]);
4658 msg
->flow_removed_mask
[1] = htonl(slave
[OAM_FLOW_REMOVED
]);
4660 ofconn_send_reply(ofconn
, buf
);
4666 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
4667 const struct ofp_header
*oh
)
4669 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
4671 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
4672 return OFPERR_NXBRC_MUST_BE_ZERO
;
4675 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
4680 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4684 if (ofconn_has_pending_opgroups(ofconn
)) {
4685 return OFPROTO_POSTPONE
;
4688 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
4689 ? OFPRAW_OFPT10_BARRIER_REPLY
4690 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
4691 ofconn_send_reply(ofconn
, buf
);
4696 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
4697 enum nx_flow_monitor_flags flags
,
4699 OVS_REQUIRES(ofproto_mutex
)
4701 struct ofoperation
*op
= rule
->pending
;
4702 const struct rule_actions
*actions
;
4703 struct ofputil_flow_update fu
;
4706 if (op
&& op
->type
== OFOPERATION_ADD
) {
4707 /* We'll report the final flow when the operation completes. Reporting
4708 * it now would cause a duplicate report later. */
4712 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
4713 ? NXFME_ADDED
: NXFME_MODIFIED
);
4715 ovs_mutex_lock(&rule
->mutex
);
4716 fu
.idle_timeout
= rule
->idle_timeout
;
4717 fu
.hard_timeout
= rule
->hard_timeout
;
4718 ovs_mutex_unlock(&rule
->mutex
);
4719 fu
.table_id
= rule
->table_id
;
4720 fu
.cookie
= rule
->flow_cookie
;
4721 minimatch_expand(&rule
->cr
.match
, &match
);
4723 fu
.priority
= rule
->cr
.priority
;
4725 if (!(flags
& NXFMF_ACTIONS
)) {
4728 actions
= rule
->actions
;
4730 /* An operation is in progress. Use the previous version of the flow's
4731 * actions, so that when the operation commits we report the change. */
4733 case OFOPERATION_ADD
:
4736 case OFOPERATION_MODIFY
:
4737 case OFOPERATION_REPLACE
:
4738 actions
= op
->actions
? op
->actions
: rule
->actions
;
4741 case OFOPERATION_DELETE
:
4742 actions
= rule
->actions
;
4749 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
4750 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
4752 if (list_is_empty(msgs
)) {
4753 ofputil_start_flow_update(msgs
);
4755 ofputil_append_flow_update(&fu
, msgs
);
4759 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
4761 OVS_REQUIRES(ofproto_mutex
)
4765 for (i
= 0; i
< rules
->n
; i
++) {
4766 struct rule
*rule
= rules
->rules
[i
];
4767 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
4768 rule
->monitor_flags
= 0;
4770 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
4775 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
4776 struct rule
*rule
, uint64_t seqno
,
4777 struct rule_collection
*rules
)
4778 OVS_REQUIRES(ofproto_mutex
)
4780 enum nx_flow_monitor_flags update
;
4782 if (ofproto_rule_is_hidden(rule
)) {
4787 ? ofoperation_has_out_port(rule
->pending
, m
->out_port
)
4788 : ofproto_rule_has_out_port(rule
, m
->out_port
))) {
4793 if (rule
->add_seqno
> seqno
) {
4794 update
= NXFMF_ADD
| NXFMF_MODIFY
;
4795 } else if (rule
->modify_seqno
> seqno
) {
4796 update
= NXFMF_MODIFY
;
4801 if (!(m
->flags
& update
)) {
4805 update
= NXFMF_INITIAL
;
4808 if (!rule
->monitor_flags
) {
4809 rule_collection_add(rules
, rule
);
4811 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
4815 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
4817 struct rule_collection
*rules
)
4818 OVS_REQUIRES(ofproto_mutex
)
4820 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
4821 const struct ofoperation
*op
;
4822 const struct oftable
*table
;
4823 struct cls_rule target
;
4825 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
4826 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
4827 struct cls_cursor cursor
;
4830 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
4831 cls_cursor_init(&cursor
, &table
->cls
, &target
);
4832 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
4833 ovs_assert(!rule
->pending
); /* XXX */
4834 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4836 ovs_rwlock_unlock(&table
->cls
.rwlock
);
4839 HMAP_FOR_EACH (op
, hmap_node
, &ofproto
->deletions
) {
4840 struct rule
*rule
= op
->rule
;
4842 if (((m
->table_id
== 0xff
4843 ? !(ofproto
->tables
[rule
->table_id
].flags
& OFTABLE_HIDDEN
)
4844 : m
->table_id
== rule
->table_id
))
4845 && cls_rule_is_loose_match(&rule
->cr
, &target
.match
)) {
4846 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4849 cls_rule_destroy(&target
);
4853 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
4854 struct rule_collection
*rules
)
4855 OVS_REQUIRES(ofproto_mutex
)
4857 if (m
->flags
& NXFMF_INITIAL
) {
4858 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
4863 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
4864 uint64_t seqno
, struct rule_collection
*rules
)
4865 OVS_REQUIRES(ofproto_mutex
)
4867 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
4871 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4872 OVS_EXCLUDED(ofproto_mutex
)
4874 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4875 struct ofmonitor
**monitors
;
4876 size_t n_monitors
, allocated_monitors
;
4877 struct rule_collection rules
;
4878 struct list replies
;
4884 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4886 n_monitors
= allocated_monitors
= 0;
4888 ovs_mutex_lock(&ofproto_mutex
);
4890 struct ofputil_flow_monitor_request request
;
4891 struct ofmonitor
*m
;
4894 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
4895 if (retval
== EOF
) {
4897 } else if (retval
) {
4902 if (request
.table_id
!= 0xff
4903 && request
.table_id
>= ofproto
->n_tables
) {
4904 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4908 error
= ofmonitor_create(&request
, ofconn
, &m
);
4913 if (n_monitors
>= allocated_monitors
) {
4914 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
4917 monitors
[n_monitors
++] = m
;
4920 rule_collection_init(&rules
);
4921 for (i
= 0; i
< n_monitors
; i
++) {
4922 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
4925 ofpmp_init(&replies
, oh
);
4926 ofmonitor_compose_refresh_updates(&rules
, &replies
);
4927 ovs_mutex_unlock(&ofproto_mutex
);
4929 rule_collection_destroy(&rules
);
4931 ofconn_send_replies(ofconn
, &replies
);
4937 for (i
= 0; i
< n_monitors
; i
++) {
4938 ofmonitor_destroy(monitors
[i
]);
4941 ovs_mutex_unlock(&ofproto_mutex
);
4947 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4948 OVS_EXCLUDED(ofproto_mutex
)
4950 struct ofmonitor
*m
;
4954 id
= ofputil_decode_flow_monitor_cancel(oh
);
4956 ovs_mutex_lock(&ofproto_mutex
);
4957 m
= ofmonitor_lookup(ofconn
, id
);
4959 ofmonitor_destroy(m
);
4962 error
= OFPERR_NXBRC_FM_BAD_ID
;
4964 ovs_mutex_unlock(&ofproto_mutex
);
4969 /* Meters implementation.
4971 * Meter table entry, indexed by the OpenFlow meter_id.
4972 * These are always dynamically allocated to allocate enough space for
4974 * 'created' is used to compute the duration for meter stats.
4975 * 'list rules' is needed so that we can delete the dependent rules when the
4976 * meter table entry is deleted.
4977 * 'provider_meter_id' is for the provider's private use.
4980 long long int created
; /* Time created. */
4981 struct list rules
; /* List of "struct rule_dpif"s. */
4982 ofproto_meter_id provider_meter_id
;
4983 uint16_t flags
; /* Meter flags. */
4984 uint16_t n_bands
; /* Number of meter bands. */
4985 struct ofputil_meter_band
*bands
;
4989 * This is used in instruction validation at flow set-up time,
4990 * as flows may not use non-existing meters.
4991 * Return value of UINT32_MAX signifies an invalid meter.
4994 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
4996 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
4997 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
4999 return meter
->provider_meter_id
.uint32
;
5006 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
5010 meter
->flags
= config
->flags
;
5011 meter
->n_bands
= config
->n_bands
;
5012 meter
->bands
= xmemdup(config
->bands
,
5013 config
->n_bands
* sizeof *meter
->bands
);
5016 static struct meter
*
5017 meter_create(const struct ofputil_meter_config
*config
,
5018 ofproto_meter_id provider_meter_id
)
5020 struct meter
*meter
;
5022 meter
= xzalloc(sizeof *meter
);
5023 meter
->provider_meter_id
= provider_meter_id
;
5024 meter
->created
= time_msec();
5025 list_init(&meter
->rules
);
5027 meter_update(meter
, config
);
5033 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5034 OVS_REQUIRES(ofproto_mutex
)
5037 for (mid
= first
; mid
<= last
; ++mid
) {
5038 struct meter
*meter
= ofproto
->meters
[mid
];
5040 ofproto
->meters
[mid
] = NULL
;
5041 ofproto
->ofproto_class
->meter_del(ofproto
,
5042 meter
->provider_meter_id
);
5050 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5052 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5053 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5057 return OFPERR_OFPMMFC_METER_EXISTS
;
5060 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5063 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5064 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5070 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5072 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5074 uint32_t provider_meter_id
;
5077 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5080 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5081 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5082 &meter
->provider_meter_id
,
5084 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5086 meter_update(meter
, &mm
->meter
);
5092 handle_delete_meter(struct ofconn
*ofconn
, const struct ofp_header
*oh
,
5093 struct ofputil_meter_mod
*mm
)
5094 OVS_EXCLUDED(ofproto_mutex
)
5096 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5097 uint32_t meter_id
= mm
->meter
.meter_id
;
5098 struct rule_collection rules
;
5099 enum ofperr error
= 0;
5100 uint32_t first
, last
;
5102 if (meter_id
== OFPM13_ALL
) {
5104 last
= ofproto
->meter_features
.max_meters
;
5106 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
5109 first
= last
= meter_id
;
5112 /* First delete the rules that use this meter. If any of those rules are
5113 * currently being modified, postpone the whole operation until later. */
5114 rule_collection_init(&rules
);
5115 ovs_mutex_lock(&ofproto_mutex
);
5116 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5117 struct meter
*meter
= ofproto
->meters
[meter_id
];
5118 if (meter
&& !list_is_empty(&meter
->rules
)) {
5121 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
5122 if (rule
->pending
) {
5123 error
= OFPROTO_POSTPONE
;
5126 rule_collection_add(&rules
, rule
);
5131 delete_flows__(ofproto
, ofconn
, oh
, &rules
, OFPRR_METER_DELETE
);
5134 /* Delete the meters. */
5135 meter_delete(ofproto
, first
, last
);
5138 ovs_mutex_unlock(&ofproto_mutex
);
5139 rule_collection_destroy(&rules
);
5145 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5147 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5148 struct ofputil_meter_mod mm
;
5149 uint64_t bands_stub
[256 / 8];
5150 struct ofpbuf bands
;
5154 error
= reject_slave_controller(ofconn
);
5159 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5161 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
5163 goto exit_free_bands
;
5166 meter_id
= mm
.meter
.meter_id
;
5168 if (mm
.command
!= OFPMC13_DELETE
) {
5169 /* Fails also when meters are not implemented by the provider. */
5170 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
5171 error
= OFPERR_OFPMMFC_INVALID_METER
;
5172 goto exit_free_bands
;
5173 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
5174 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
5175 goto exit_free_bands
;
5177 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
5178 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
5179 goto exit_free_bands
;
5183 switch (mm
.command
) {
5185 error
= handle_add_meter(ofproto
, &mm
);
5188 case OFPMC13_MODIFY
:
5189 error
= handle_modify_meter(ofproto
, &mm
);
5192 case OFPMC13_DELETE
:
5193 error
= handle_delete_meter(ofconn
, oh
, &mm
);
5197 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
5202 ofpbuf_uninit(&bands
);
5207 handle_meter_features_request(struct ofconn
*ofconn
,
5208 const struct ofp_header
*request
)
5210 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5211 struct ofputil_meter_features features
;
5214 if (ofproto
->ofproto_class
->meter_get_features
) {
5215 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
5217 memset(&features
, 0, sizeof features
);
5219 b
= ofputil_encode_meter_features_reply(&features
, request
);
5221 ofconn_send_reply(ofconn
, b
);
5226 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
5229 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5230 struct list replies
;
5231 uint64_t bands_stub
[256 / 8];
5232 struct ofpbuf bands
;
5233 uint32_t meter_id
, first
, last
;
5235 ofputil_decode_meter_request(request
, &meter_id
);
5237 if (meter_id
== OFPM13_ALL
) {
5239 last
= ofproto
->meter_features
.max_meters
;
5241 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
5242 !ofproto
->meters
[meter_id
]) {
5243 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5245 first
= last
= meter_id
;
5248 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5249 ofpmp_init(&replies
, request
);
5251 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5252 struct meter
*meter
= ofproto
->meters
[meter_id
];
5254 continue; /* Skip non-existing meters. */
5256 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
5257 struct ofputil_meter_stats stats
;
5259 stats
.meter_id
= meter_id
;
5261 /* Provider sets the packet and byte counts, we do the rest. */
5262 stats
.flow_count
= list_size(&meter
->rules
);
5263 calc_duration(meter
->created
, time_msec(),
5264 &stats
.duration_sec
, &stats
.duration_nsec
);
5265 stats
.n_bands
= meter
->n_bands
;
5266 ofpbuf_clear(&bands
);
5268 = ofpbuf_put_uninit(&bands
,
5269 meter
->n_bands
* sizeof *stats
.bands
);
5271 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
5272 meter
->provider_meter_id
,
5274 ofputil_append_meter_stats(&replies
, &stats
);
5276 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5277 struct ofputil_meter_config config
;
5279 config
.meter_id
= meter_id
;
5280 config
.flags
= meter
->flags
;
5281 config
.n_bands
= meter
->n_bands
;
5282 config
.bands
= meter
->bands
;
5283 ofputil_append_meter_config(&replies
, &config
);
5287 ofconn_send_replies(ofconn
, &replies
);
5288 ofpbuf_uninit(&bands
);
5293 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5294 struct ofgroup
**group
)
5295 OVS_TRY_RDLOCK(true, (*group
)->rwlock
)
5297 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5298 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5299 hash_int(group_id
, 0), &ofproto
->groups
) {
5300 if ((*group
)->group_id
== group_id
) {
5301 ovs_rwlock_rdlock(&(*group
)->rwlock
);
5302 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5306 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5311 ofproto_group_release(struct ofgroup
*group
)
5312 OVS_RELEASES(group
->rwlock
)
5314 ovs_rwlock_unlock(&group
->rwlock
);
5318 ofproto_group_write_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5319 struct ofgroup
**group
)
5320 OVS_TRY_WRLOCK(true, ofproto
->groups_rwlock
)
5321 OVS_TRY_WRLOCK(true, (*group
)->rwlock
)
5323 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5324 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5325 hash_int(group_id
, 0), &ofproto
->groups
) {
5326 if ((*group
)->group_id
== group_id
) {
5327 ovs_rwlock_wrlock(&(*group
)->rwlock
);
5331 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5336 ofproto_group_exists__(const struct ofproto
*ofproto
, uint32_t group_id
)
5337 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5339 struct ofgroup
*grp
;
5341 HMAP_FOR_EACH_IN_BUCKET (grp
, hmap_node
,
5342 hash_int(group_id
, 0), &ofproto
->groups
) {
5343 if (grp
->group_id
== group_id
) {
5351 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
5352 OVS_EXCLUDED(ofproto
->groups_rwlock
)
5356 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5357 exists
= ofproto_group_exists__(ofproto
, group_id
);
5358 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5364 group_get_ref_count(struct ofgroup
*group
)
5365 OVS_EXCLUDED(ofproto_mutex
)
5367 struct ofproto
*ofproto
= group
->ofproto
;
5368 struct rule_criteria criteria
;
5369 struct rule_collection rules
;
5374 match_init_catchall(&match
);
5375 rule_criteria_init(&criteria
, 0xff, &match
, 0, htonll(0), htonll(0),
5376 OFPP_ANY
, group
->group_id
);
5377 ovs_mutex_lock(&ofproto_mutex
);
5378 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
5379 ovs_mutex_unlock(&ofproto_mutex
);
5380 rule_criteria_destroy(&criteria
);
5382 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
5384 rule_collection_destroy(&rules
);
5389 append_group_stats(struct ofgroup
*group
, struct list
*replies
)
5390 OVS_REQ_RDLOCK(group
->rwlock
)
5392 struct ofputil_group_stats ogs
;
5393 struct ofproto
*ofproto
= group
->ofproto
;
5394 long long int now
= time_msec();
5397 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
5399 /* Provider sets the packet and byte counts, we do the rest. */
5400 ogs
.ref_count
= group_get_ref_count(group
);
5401 ogs
.n_buckets
= group
->n_buckets
;
5403 error
= (ofproto
->ofproto_class
->group_get_stats
5404 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
5407 ogs
.packet_count
= UINT64_MAX
;
5408 ogs
.byte_count
= UINT64_MAX
;
5409 memset(ogs
.bucket_stats
, 0xff,
5410 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
5413 ogs
.group_id
= group
->group_id
;
5414 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
5416 ofputil_append_group_stats(replies
, &ogs
);
5418 free(ogs
.bucket_stats
);
5422 handle_group_stats_request(struct ofconn
*ofconn
,
5423 const struct ofp_header
*request
)
5425 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5426 struct list replies
;
5428 struct ofgroup
*group
;
5431 error
= ofputil_decode_group_stats_request(request
, &group_id
);
5436 ofpmp_init(&replies
, request
);
5438 if (group_id
== OFPG_ALL
) {
5439 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5440 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5441 ovs_rwlock_rdlock(&group
->rwlock
);
5442 append_group_stats(group
, &replies
);
5443 ovs_rwlock_unlock(&group
->rwlock
);
5445 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5447 if (ofproto_group_lookup(ofproto
, group_id
, &group
)) {
5448 append_group_stats(group
, &replies
);
5449 ofproto_group_release(group
);
5453 ofconn_send_replies(ofconn
, &replies
);
5459 handle_group_desc_stats_request(struct ofconn
*ofconn
,
5460 const struct ofp_header
*request
)
5462 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5463 struct list replies
;
5464 struct ofputil_group_desc gds
;
5465 struct ofgroup
*group
;
5467 ofpmp_init(&replies
, request
);
5469 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5470 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5471 gds
.group_id
= group
->group_id
;
5472 gds
.type
= group
->type
;
5473 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, &replies
);
5475 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5477 ofconn_send_replies(ofconn
, &replies
);
5483 handle_group_features_stats_request(struct ofconn
*ofconn
,
5484 const struct ofp_header
*request
)
5486 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5489 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
5491 ofconn_send_reply(ofconn
, msg
);
5498 handle_queue_get_config_request(struct ofconn
*ofconn
,
5499 const struct ofp_header
*oh
)
5501 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5502 struct netdev_queue_dump queue_dump
;
5503 struct ofport
*ofport
;
5504 unsigned int queue_id
;
5505 struct ofpbuf
*reply
;
5506 struct smap details
;
5510 error
= ofputil_decode_queue_get_config_request(oh
, &request
);
5515 ofport
= ofproto_get_port(p
, request
);
5517 return OFPERR_OFPQOFC_BAD_PORT
;
5520 reply
= ofputil_encode_queue_get_config_reply(oh
);
5522 smap_init(&details
);
5523 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
, ofport
->netdev
) {
5524 struct ofputil_queue_config queue
;
5526 /* None of the existing queues have compatible properties, so we
5527 * hard-code omitting min_rate and max_rate. */
5528 queue
.queue_id
= queue_id
;
5529 queue
.min_rate
= UINT16_MAX
;
5530 queue
.max_rate
= UINT16_MAX
;
5531 ofputil_append_queue_get_config_reply(reply
, &queue
);
5533 smap_destroy(&details
);
5535 ofconn_send_reply(ofconn
, reply
);
5540 /* Implements OFPGC11_ADD
5541 * in which no matching flow already exists in the flow table.
5543 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5544 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5545 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5546 * initiated now but may be retried later.
5548 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5549 * ownership remains with the caller.
5551 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5554 add_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5556 struct ofgroup
*ofgroup
;
5559 if (gm
->group_id
> OFPG_MAX
) {
5560 return OFPERR_OFPGMFC_INVALID_GROUP
;
5562 if (gm
->type
> OFPGT11_FF
) {
5563 return OFPERR_OFPGMFC_BAD_TYPE
;
5566 /* Allocate new group and initialize it. */
5567 ofgroup
= ofproto
->ofproto_class
->group_alloc();
5569 VLOG_WARN_RL(&rl
, "%s: failed to create group", ofproto
->name
);
5570 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5573 ovs_rwlock_init(&ofgroup
->rwlock
);
5574 ofgroup
->ofproto
= ofproto
;
5575 ofgroup
->group_id
= gm
->group_id
;
5576 ofgroup
->type
= gm
->type
;
5577 ofgroup
->created
= ofgroup
->modified
= time_msec();
5579 list_move(&ofgroup
->buckets
, &gm
->buckets
);
5580 ofgroup
->n_buckets
= list_size(&ofgroup
->buckets
);
5582 /* Construct called BEFORE any locks are held. */
5583 error
= ofproto
->ofproto_class
->group_construct(ofgroup
);
5588 /* We wrlock as late as possible to minimize the time we jam any other
5589 * threads: No visible state changes before acquiring the lock. */
5590 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5592 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5593 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5597 if (ofproto_group_exists__(ofproto
, gm
->group_id
)) {
5598 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
5603 /* Insert new group. */
5604 hmap_insert(&ofproto
->groups
, &ofgroup
->hmap_node
,
5605 hash_int(ofgroup
->group_id
, 0));
5606 ofproto
->n_groups
[ofgroup
->type
]++;
5608 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5613 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5614 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5616 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5617 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5622 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5625 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5628 modify_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5630 struct ofgroup
*ofgroup
;
5631 struct ofgroup
*victim
;
5634 if (gm
->group_id
> OFPG_MAX
) {
5635 return OFPERR_OFPGMFC_INVALID_GROUP
;
5638 if (gm
->type
> OFPGT11_FF
) {
5639 return OFPERR_OFPGMFC_BAD_TYPE
;
5642 victim
= ofproto
->ofproto_class
->group_alloc();
5644 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
5645 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5648 if (!ofproto_group_write_lookup(ofproto
, gm
->group_id
, &ofgroup
)) {
5649 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
5652 /* Both group's and its container's write locks held now.
5653 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5654 if (ofgroup
->type
!= gm
->type
5655 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5656 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5661 list_move(&victim
->buckets
, &ofgroup
->buckets
);
5663 ofgroup
->type
= gm
->type
;
5664 list_move(&ofgroup
->buckets
, &gm
->buckets
);
5665 ofgroup
->n_buckets
= list_size(&ofgroup
->buckets
);
5667 error
= ofproto
->ofproto_class
->group_modify(ofgroup
, victim
);
5669 ofputil_bucket_list_destroy(&victim
->buckets
);
5670 ofproto
->n_groups
[victim
->type
]--;
5671 ofproto
->n_groups
[ofgroup
->type
]++;
5672 ofgroup
->modified
= time_msec();
5674 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5677 list_move(&ofgroup
->buckets
, &victim
->buckets
);
5681 ovs_rwlock_unlock(&ofgroup
->rwlock
);
5682 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5684 ofproto
->ofproto_class
->group_dealloc(victim
);
5689 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
5690 OVS_RELEASES(ofproto
->groups_rwlock
)
5693 struct ofputil_flow_mod fm
;
5695 /* Delete all flow entries containing this group in a group action */
5696 match_init_catchall(&match
);
5697 flow_mod_init(&fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
5698 fm
.out_group
= ofgroup
->group_id
;
5699 handle_flow_mod__(ofproto
, NULL
, &fm
, NULL
);
5701 /* Must wait until existing readers are done,
5702 * while holding the container's write lock at the same time. */
5703 ovs_rwlock_wrlock(&ofgroup
->rwlock
);
5704 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5705 /* No-one can find this group any more. */
5706 ofproto
->n_groups
[ofgroup
->type
]--;
5707 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5709 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5710 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5711 ovs_rwlock_unlock(&ofgroup
->rwlock
);
5712 ovs_rwlock_destroy(&ofgroup
->rwlock
);
5713 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5716 /* Implements OFPGC_DELETE. */
5718 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
5720 struct ofgroup
*ofgroup
;
5722 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5723 if (group_id
== OFPG_ALL
) {
5725 struct hmap_node
*node
= hmap_first(&ofproto
->groups
);
5729 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, hmap_node
);
5730 delete_group__(ofproto
, ofgroup
);
5731 /* Lock for each node separately, so that we will not jam the
5732 * other threads for too long time. */
5733 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5736 HMAP_FOR_EACH_IN_BUCKET (ofgroup
, hmap_node
,
5737 hash_int(group_id
, 0), &ofproto
->groups
) {
5738 if (ofgroup
->group_id
== group_id
) {
5739 delete_group__(ofproto
, ofgroup
);
5744 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5748 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5750 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5751 struct ofputil_group_mod gm
;
5754 error
= reject_slave_controller(ofconn
);
5759 error
= ofputil_decode_group_mod(oh
, &gm
);
5764 switch (gm
.command
) {
5766 return add_group(ofproto
, &gm
);
5768 case OFPGC11_MODIFY
:
5769 return modify_group(ofproto
, &gm
);
5771 case OFPGC11_DELETE
:
5772 delete_group(ofproto
, gm
.group_id
);
5776 if (gm
.command
> OFPGC11_DELETE
) {
5777 VLOG_WARN_RL(&rl
, "%s: Invalid group_mod command type %d",
5778 ofproto
->name
, gm
.command
);
5780 return OFPERR_OFPGMFC_BAD_COMMAND
;
5785 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
5787 /* XXX Reject all configurations because none are currently supported */
5788 return OFPERR_OFPTMFC_BAD_CONFIG
;
5790 if (tm
->table_id
== OFPTT_ALL
) {
5792 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
5793 atomic_store(&ofproto
->tables
[i
].config
,
5794 (unsigned int)tm
->config
);
5796 } else if (!check_table_id(ofproto
, tm
->table_id
)) {
5797 return OFPERR_OFPTMFC_BAD_TABLE
;
5799 atomic_store(&ofproto
->tables
[tm
->table_id
].config
,
5800 (unsigned int)tm
->config
);
5807 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5809 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5810 struct ofputil_table_mod tm
;
5813 error
= reject_slave_controller(ofconn
);
5818 error
= ofputil_decode_table_mod(oh
, &tm
);
5823 return table_mod(ofproto
, &tm
);
5827 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
5828 OVS_EXCLUDED(ofproto_mutex
)
5830 const struct ofp_header
*oh
= msg
->data
;
5834 error
= ofptype_decode(&type
, oh
);
5838 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
5839 && ofpmp_more(oh
)) {
5840 /* We have no buffer implementation for multipart requests.
5841 * Report overflow for requests which consists of multiple
5843 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
5847 /* OpenFlow requests. */
5848 case OFPTYPE_ECHO_REQUEST
:
5849 return handle_echo_request(ofconn
, oh
);
5851 case OFPTYPE_FEATURES_REQUEST
:
5852 return handle_features_request(ofconn
, oh
);
5854 case OFPTYPE_GET_CONFIG_REQUEST
:
5855 return handle_get_config_request(ofconn
, oh
);
5857 case OFPTYPE_SET_CONFIG
:
5858 return handle_set_config(ofconn
, oh
);
5860 case OFPTYPE_PACKET_OUT
:
5861 return handle_packet_out(ofconn
, oh
);
5863 case OFPTYPE_PORT_MOD
:
5864 return handle_port_mod(ofconn
, oh
);
5866 case OFPTYPE_FLOW_MOD
:
5867 return handle_flow_mod(ofconn
, oh
);
5869 case OFPTYPE_GROUP_MOD
:
5870 return handle_group_mod(ofconn
, oh
);
5872 case OFPTYPE_TABLE_MOD
:
5873 return handle_table_mod(ofconn
, oh
);
5875 case OFPTYPE_METER_MOD
:
5876 return handle_meter_mod(ofconn
, oh
);
5878 case OFPTYPE_BARRIER_REQUEST
:
5879 return handle_barrier_request(ofconn
, oh
);
5881 case OFPTYPE_ROLE_REQUEST
:
5882 return handle_role_request(ofconn
, oh
);
5884 /* OpenFlow replies. */
5885 case OFPTYPE_ECHO_REPLY
:
5888 /* Nicira extension requests. */
5889 case OFPTYPE_FLOW_MOD_TABLE_ID
:
5890 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
5892 case OFPTYPE_SET_FLOW_FORMAT
:
5893 return handle_nxt_set_flow_format(ofconn
, oh
);
5895 case OFPTYPE_SET_PACKET_IN_FORMAT
:
5896 return handle_nxt_set_packet_in_format(ofconn
, oh
);
5898 case OFPTYPE_SET_CONTROLLER_ID
:
5899 return handle_nxt_set_controller_id(ofconn
, oh
);
5901 case OFPTYPE_FLOW_AGE
:
5902 /* Nothing to do. */
5905 case OFPTYPE_FLOW_MONITOR_CANCEL
:
5906 return handle_flow_monitor_cancel(ofconn
, oh
);
5908 case OFPTYPE_SET_ASYNC_CONFIG
:
5909 return handle_nxt_set_async_config(ofconn
, oh
);
5911 case OFPTYPE_GET_ASYNC_REQUEST
:
5912 return handle_nxt_get_async_request(ofconn
, oh
);
5914 /* Statistics requests. */
5915 case OFPTYPE_DESC_STATS_REQUEST
:
5916 return handle_desc_stats_request(ofconn
, oh
);
5918 case OFPTYPE_FLOW_STATS_REQUEST
:
5919 return handle_flow_stats_request(ofconn
, oh
);
5921 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
5922 return handle_aggregate_stats_request(ofconn
, oh
);
5924 case OFPTYPE_TABLE_STATS_REQUEST
:
5925 return handle_table_stats_request(ofconn
, oh
);
5927 case OFPTYPE_PORT_STATS_REQUEST
:
5928 return handle_port_stats_request(ofconn
, oh
);
5930 case OFPTYPE_QUEUE_STATS_REQUEST
:
5931 return handle_queue_stats_request(ofconn
, oh
);
5933 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
5934 return handle_port_desc_stats_request(ofconn
, oh
);
5936 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
5937 return handle_flow_monitor_request(ofconn
, oh
);
5939 case OFPTYPE_METER_STATS_REQUEST
:
5940 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
5941 return handle_meter_request(ofconn
, oh
, type
);
5943 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
5944 return handle_meter_features_request(ofconn
, oh
);
5946 case OFPTYPE_GROUP_STATS_REQUEST
:
5947 return handle_group_stats_request(ofconn
, oh
);
5949 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
5950 return handle_group_desc_stats_request(ofconn
, oh
);
5952 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
5953 return handle_group_features_stats_request(ofconn
, oh
);
5955 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
5956 return handle_queue_get_config_request(ofconn
, oh
);
5960 case OFPTYPE_FEATURES_REPLY
:
5961 case OFPTYPE_GET_CONFIG_REPLY
:
5962 case OFPTYPE_PACKET_IN
:
5963 case OFPTYPE_FLOW_REMOVED
:
5964 case OFPTYPE_PORT_STATUS
:
5965 case OFPTYPE_BARRIER_REPLY
:
5966 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
5967 case OFPTYPE_DESC_STATS_REPLY
:
5968 case OFPTYPE_FLOW_STATS_REPLY
:
5969 case OFPTYPE_QUEUE_STATS_REPLY
:
5970 case OFPTYPE_PORT_STATS_REPLY
:
5971 case OFPTYPE_TABLE_STATS_REPLY
:
5972 case OFPTYPE_AGGREGATE_STATS_REPLY
:
5973 case OFPTYPE_PORT_DESC_STATS_REPLY
:
5974 case OFPTYPE_ROLE_REPLY
:
5975 case OFPTYPE_FLOW_MONITOR_PAUSED
:
5976 case OFPTYPE_FLOW_MONITOR_RESUMED
:
5977 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
5978 case OFPTYPE_GET_ASYNC_REPLY
:
5979 case OFPTYPE_GROUP_STATS_REPLY
:
5980 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
5981 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
5982 case OFPTYPE_METER_STATS_REPLY
:
5983 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
5984 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
5985 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
5986 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
5987 case OFPTYPE_ROLE_STATUS
:
5989 if (ofpmsg_is_stat_request(oh
)) {
5990 return OFPERR_OFPBRC_BAD_STAT
;
5992 return OFPERR_OFPBRC_BAD_TYPE
;
5998 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
5999 OVS_EXCLUDED(ofproto_mutex
)
6001 int error
= handle_openflow__(ofconn
, ofp_msg
);
6002 if (error
&& error
!= OFPROTO_POSTPONE
) {
6003 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
6005 COVERAGE_INC(ofproto_recv_openflow
);
6006 return error
!= OFPROTO_POSTPONE
;
6009 /* Asynchronous operations. */
6011 /* Creates and returns a new ofopgroup that is not associated with any
6012 * OpenFlow connection.
6014 * The caller should add operations to the returned group with
6015 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6016 static struct ofopgroup
*
6017 ofopgroup_create_unattached(struct ofproto
*ofproto
)
6018 OVS_REQUIRES(ofproto_mutex
)
6020 struct ofopgroup
*group
= xzalloc(sizeof *group
);
6021 group
->ofproto
= ofproto
;
6022 list_init(&group
->ofproto_node
);
6023 list_init(&group
->ops
);
6024 list_init(&group
->ofconn_node
);
6028 /* Creates and returns a new ofopgroup for 'ofproto'.
6030 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6031 * connection. The 'request' and 'buffer_id' arguments are ignored.
6033 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6034 * If the ofopgroup eventually fails, then the error reply will include
6035 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6036 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6038 * The caller should add operations to the returned group with
6039 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6040 static struct ofopgroup
*
6041 ofopgroup_create(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
6042 const struct ofp_header
*request
, uint32_t buffer_id
)
6043 OVS_REQUIRES(ofproto_mutex
)
6045 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
6047 size_t request_len
= ntohs(request
->length
);
6049 ovs_assert(ofconn_get_ofproto(ofconn
) == ofproto
);
6051 ofconn_add_opgroup(ofconn
, &group
->ofconn_node
);
6052 group
->ofconn
= ofconn
;
6053 group
->request
= xmemdup(request
, MIN(request_len
, 64));
6054 group
->buffer_id
= buffer_id
;
6059 /* Submits 'group' for processing.
6061 * If 'group' contains no operations (e.g. none were ever added, or all of the
6062 * ones that were added completed synchronously), then it is destroyed
6063 * immediately. Otherwise it is added to the ofproto's list of pending
6066 ofopgroup_submit(struct ofopgroup
*group
)
6067 OVS_REQUIRES(ofproto_mutex
)
6069 if (!group
->n_running
) {
6070 ofopgroup_complete(group
);
6072 list_push_back(&group
->ofproto
->pending
, &group
->ofproto_node
);
6073 group
->ofproto
->n_pending
++;
6078 ofopgroup_complete(struct ofopgroup
*group
)
6079 OVS_REQUIRES(ofproto_mutex
)
6081 struct ofproto
*ofproto
= group
->ofproto
;
6083 struct ofconn
*abbrev_ofconn
;
6084 ovs_be32 abbrev_xid
;
6086 struct ofoperation
*op
, *next_op
;
6089 ovs_assert(!group
->n_running
);
6092 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
6099 if (!error
&& group
->ofconn
&& group
->buffer_id
!= UINT32_MAX
) {
6100 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
6101 if (op
->type
!= OFOPERATION_DELETE
) {
6102 struct ofpbuf
*packet
;
6105 error
= ofconn_pktbuf_retrieve(group
->ofconn
, group
->buffer_id
,
6108 struct rule_execute
*re
;
6112 ofproto_rule_ref(op
->rule
);
6114 re
= xmalloc(sizeof *re
);
6115 re
->rule
= op
->rule
;
6116 re
->in_port
= in_port
;
6117 re
->packet
= packet
;
6119 if (!guarded_list_push_back(&ofproto
->rule_executes
,
6120 &re
->list_node
, 1024)) {
6121 ofproto_rule_unref(op
->rule
);
6122 ofpbuf_delete(re
->packet
);
6131 if (!error
&& !list_is_empty(&group
->ofconn_node
)) {
6132 abbrev_ofconn
= group
->ofconn
;
6133 abbrev_xid
= group
->request
->xid
;
6135 abbrev_ofconn
= NULL
;
6136 abbrev_xid
= htonl(0);
6138 LIST_FOR_EACH_SAFE (op
, next_op
, group_node
, &group
->ops
) {
6139 struct rule
*rule
= op
->rule
;
6141 /* We generally want to report the change to active OpenFlow flow
6142 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6144 - The operation failed.
6146 - The affected rule is not visible to controllers.
6148 - The operation's only effect was to update rule->modified. */
6150 || ofproto_rule_is_hidden(rule
)
6151 || (op
->type
== OFOPERATION_MODIFY
6153 && rule
->flow_cookie
== op
->flow_cookie
))) {
6154 /* Check that we can just cast from ofoperation_type to
6155 * nx_flow_update_event. */
6156 enum nx_flow_update_event event_type
;
6159 case OFOPERATION_ADD
:
6160 case OFOPERATION_REPLACE
:
6161 event_type
= NXFME_ADDED
;
6164 case OFOPERATION_DELETE
:
6165 event_type
= NXFME_DELETED
;
6168 case OFOPERATION_MODIFY
:
6169 event_type
= NXFME_MODIFIED
;
6176 ofmonitor_report(ofproto
->connmgr
, rule
, event_type
,
6177 op
->reason
, abbrev_ofconn
, abbrev_xid
);
6180 rule
->pending
= NULL
;
6183 case OFOPERATION_ADD
:
6187 vid_mask
= minimask_get_vid_mask(&rule
->cr
.match
.mask
);
6188 if (vid_mask
== VLAN_VID_MASK
) {
6189 if (ofproto
->vlan_bitmap
) {
6190 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
6191 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
6192 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6193 ofproto
->vlans_changed
= true;
6196 ofproto
->vlans_changed
= true;
6200 oftable_remove_rule(rule
);
6201 ofproto_rule_unref(rule
);
6205 case OFOPERATION_DELETE
:
6206 ovs_assert(!op
->error
);
6207 ofproto_rule_unref(rule
);
6211 case OFOPERATION_MODIFY
:
6212 case OFOPERATION_REPLACE
:
6214 long long int now
= time_msec();
6216 rule
->modified
= now
;
6217 if (op
->type
== OFOPERATION_REPLACE
) {
6218 rule
->created
= rule
->used
= now
;
6221 ofproto_rule_change_cookie(ofproto
, rule
, op
->flow_cookie
);
6222 ovs_mutex_lock(&rule
->mutex
);
6223 rule
->idle_timeout
= op
->idle_timeout
;
6224 rule
->hard_timeout
= op
->hard_timeout
;
6225 ovs_mutex_unlock(&rule
->mutex
);
6227 struct rule_actions
*old_actions
;
6229 ovs_mutex_lock(&rule
->mutex
);
6230 old_actions
= rule
->actions
;
6231 rule
->actions
= op
->actions
;
6232 ovs_mutex_unlock(&rule
->mutex
);
6235 rule_actions_unref(old_actions
);
6237 rule
->flags
= op
->flags
;
6245 ofoperation_destroy(op
);
6248 ofmonitor_flush(ofproto
->connmgr
);
6250 if (!list_is_empty(&group
->ofproto_node
)) {
6251 ovs_assert(ofproto
->n_pending
> 0);
6252 ofproto
->n_pending
--;
6253 list_remove(&group
->ofproto_node
);
6255 if (!list_is_empty(&group
->ofconn_node
)) {
6256 list_remove(&group
->ofconn_node
);
6258 ofconn_send_error(group
->ofconn
, group
->request
, error
);
6260 connmgr_retry(ofproto
->connmgr
);
6262 free(group
->request
);
6266 /* Initiates a new operation on 'rule', of the specified 'type', within
6267 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6269 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6270 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6272 * Returns the newly created ofoperation (which is also available as
6273 * rule->pending). */
6274 static struct ofoperation
*
6275 ofoperation_create(struct ofopgroup
*group
, struct rule
*rule
,
6276 enum ofoperation_type type
,
6277 enum ofp_flow_removed_reason reason
)
6278 OVS_REQUIRES(ofproto_mutex
)
6280 struct ofproto
*ofproto
= group
->ofproto
;
6281 struct ofoperation
*op
;
6283 ovs_assert(!rule
->pending
);
6285 op
= rule
->pending
= xzalloc(sizeof *op
);
6287 list_push_back(&group
->ops
, &op
->group_node
);
6290 op
->reason
= reason
;
6291 op
->flow_cookie
= rule
->flow_cookie
;
6292 ovs_mutex_lock(&rule
->mutex
);
6293 op
->idle_timeout
= rule
->idle_timeout
;
6294 op
->hard_timeout
= rule
->hard_timeout
;
6295 ovs_mutex_unlock(&rule
->mutex
);
6296 op
->flags
= rule
->flags
;
6300 if (type
== OFOPERATION_DELETE
) {
6301 hmap_insert(&ofproto
->deletions
, &op
->hmap_node
,
6302 cls_rule_hash(&rule
->cr
, rule
->table_id
));
6309 ofoperation_destroy(struct ofoperation
*op
)
6310 OVS_REQUIRES(ofproto_mutex
)
6312 struct ofopgroup
*group
= op
->group
;
6315 op
->rule
->pending
= NULL
;
6317 if (op
->type
== OFOPERATION_DELETE
) {
6318 hmap_remove(&group
->ofproto
->deletions
, &op
->hmap_node
);
6320 list_remove(&op
->group_node
);
6321 rule_actions_unref(op
->actions
);
6325 /* Indicates that 'op' completed with status 'error', which is either 0 to
6326 * indicate success or an OpenFlow error code on failure.
6328 * If 'error' is 0, indicating success, the operation will be committed
6329 * permanently to the flow table.
6331 * If 'error' is nonzero, then generally the operation will be rolled back:
6333 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6334 * restores the original rule. The caller must have uninitialized any
6335 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6336 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6337 * and 7 for the new rule, calling its ->rule_dealloc() function.
6339 * - If 'op' is a "modify flow" operation, ofproto restores the original
6342 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6343 * allowed to fail. It must always succeed.
6345 * Please see the large comment in ofproto/ofproto-provider.h titled
6346 * "Asynchronous Operation Support" for more information. */
6348 ofoperation_complete(struct ofoperation
*op
, enum ofperr error
)
6350 struct ofopgroup
*group
= op
->group
;
6352 ovs_assert(group
->n_running
> 0);
6353 ovs_assert(!error
|| op
->type
!= OFOPERATION_DELETE
);
6356 if (!--group
->n_running
&& !list_is_empty(&group
->ofproto_node
)) {
6357 /* This function can be called from ->rule_construct(), in which case
6358 * ofproto_mutex is held, or it can be called from ->run(), in which
6359 * case ofproto_mutex is not held. But only in the latter case can we
6360 * arrive here, so we can safely take ofproto_mutex now. */
6361 ovs_mutex_lock(&ofproto_mutex
);
6362 ovs_assert(op
->rule
->pending
== op
);
6363 ofopgroup_complete(group
);
6364 ovs_mutex_unlock(&ofproto_mutex
);
6369 pick_datapath_id(const struct ofproto
*ofproto
)
6371 const struct ofport
*port
;
6373 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
6375 uint8_t ea
[ETH_ADDR_LEN
];
6378 error
= netdev_get_etheraddr(port
->netdev
, ea
);
6380 return eth_addr_to_uint64(ea
);
6382 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6383 ofproto
->name
, netdev_get_name(port
->netdev
),
6384 ovs_strerror(error
));
6386 return ofproto
->fallback_dpid
;
6390 pick_fallback_dpid(void)
6392 uint8_t ea
[ETH_ADDR_LEN
];
6393 eth_addr_nicira_random(ea
);
6394 return eth_addr_to_uint64(ea
);
6397 /* Table overflow policy. */
6399 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6400 * to NULL if the table is not configured to evict rules or if the table
6401 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6402 * or with no timeouts are not evictable.) */
6404 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
6405 OVS_REQUIRES(ofproto_mutex
)
6407 struct eviction_group
*evg
;
6410 if (!table
->eviction_fields
) {
6414 /* In the common case, the outer and inner loops here will each be entered
6417 * - The inner loop normally "return"s in its first iteration. If the
6418 * eviction group has any evictable rules, then it always returns in
6421 * - The outer loop only iterates more than once if the largest eviction
6422 * group has no evictable rules.
6424 * - The outer loop can exit only if table's 'max_flows' is all filled up
6425 * by unevictable rules. */
6426 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
6429 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
6438 /* Searches 'ofproto' for tables that have more flows than their configured
6439 * maximum and that have flow eviction enabled, and evicts as many flows as
6440 * necessary and currently feasible from them.
6442 * This triggers only when an OpenFlow table has N flows in it and then the
6443 * client configures a maximum number of flows less than N. */
6445 ofproto_evict(struct ofproto
*ofproto
)
6447 struct oftable
*table
;
6449 ovs_mutex_lock(&ofproto_mutex
);
6450 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
6451 evict_rules_from_table(ofproto
, table
, 0);
6453 ovs_mutex_unlock(&ofproto_mutex
);
6456 /* Eviction groups. */
6458 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6459 * rules. The priority contains low-order random bits to ensure that eviction
6460 * groups with the same number of rules are prioritized randomly. */
6462 eviction_group_priority(size_t n_rules
)
6464 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
6465 return (size
<< 16) | random_uint16();
6468 /* Updates 'evg', an eviction_group within 'table', following a change that
6469 * adds or removes rules in 'evg'. */
6471 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
6472 OVS_REQUIRES(ofproto_mutex
)
6474 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
6475 eviction_group_priority(heap_count(&evg
->rules
)));
6478 /* Destroys 'evg', an eviction_group within 'table':
6480 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6481 * rules themselves, just removes them from the eviction group.)
6483 * - Removes 'evg' from 'table'.
6487 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
6488 OVS_REQUIRES(ofproto_mutex
)
6490 while (!heap_is_empty(&evg
->rules
)) {
6493 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
6494 rule
->eviction_group
= NULL
;
6496 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
6497 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
6498 heap_destroy(&evg
->rules
);
6502 /* Removes 'rule' from its eviction group, if any. */
6504 eviction_group_remove_rule(struct rule
*rule
)
6505 OVS_REQUIRES(ofproto_mutex
)
6507 if (rule
->eviction_group
) {
6508 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6509 struct eviction_group
*evg
= rule
->eviction_group
;
6511 rule
->eviction_group
= NULL
;
6512 heap_remove(&evg
->rules
, &rule
->evg_node
);
6513 if (heap_is_empty(&evg
->rules
)) {
6514 eviction_group_destroy(table
, evg
);
6516 eviction_group_resized(table
, evg
);
6521 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6522 * returns the hash value. */
6524 eviction_group_hash_rule(struct rule
*rule
)
6525 OVS_REQUIRES(ofproto_mutex
)
6527 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6528 const struct mf_subfield
*sf
;
6532 hash
= table
->eviction_group_id_basis
;
6533 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
6534 for (sf
= table
->eviction_fields
;
6535 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
6538 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
6539 union mf_value value
;
6541 mf_get_value(sf
->field
, &flow
, &value
);
6543 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
6545 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
6546 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
6547 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
6548 sf
->field
->n_bytes
* 8 - start
);
6550 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
6552 hash
= hash_int(hash
, 0);
6559 /* Returns an eviction group within 'table' with the given 'id', creating one
6561 static struct eviction_group
*
6562 eviction_group_find(struct oftable
*table
, uint32_t id
)
6563 OVS_REQUIRES(ofproto_mutex
)
6565 struct eviction_group
*evg
;
6567 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
6571 evg
= xmalloc(sizeof *evg
);
6572 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
6573 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
6574 eviction_group_priority(0));
6575 heap_init(&evg
->rules
);
6580 /* Returns an eviction priority for 'rule'. The return value should be
6581 * interpreted so that higher priorities make a rule more attractive candidates
6584 rule_eviction_priority(struct rule
*rule
)
6585 OVS_REQUIRES(ofproto_mutex
)
6587 long long int hard_expiration
;
6588 long long int idle_expiration
;
6589 long long int expiration
;
6590 uint32_t expiration_offset
;
6592 /* Calculate time of expiration. */
6593 ovs_mutex_lock(&rule
->mutex
);
6594 hard_expiration
= (rule
->hard_timeout
6595 ? rule
->modified
+ rule
->hard_timeout
* 1000
6597 idle_expiration
= (rule
->idle_timeout
6598 ? rule
->used
+ rule
->idle_timeout
* 1000
6600 expiration
= MIN(hard_expiration
, idle_expiration
);
6601 ovs_mutex_unlock(&rule
->mutex
);
6602 if (expiration
== LLONG_MAX
) {
6606 /* Calculate the time of expiration as a number of (approximate) seconds
6607 * after program startup.
6609 * This should work OK for program runs that last UINT32_MAX seconds or
6610 * less. Therefore, please restart OVS at least once every 136 years. */
6611 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
6613 /* Invert the expiration offset because we're using a max-heap. */
6614 return UINT32_MAX
- expiration_offset
;
6617 /* Adds 'rule' to an appropriate eviction group for its oftable's
6618 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6619 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6622 * The caller must ensure that 'rule' is not already in an eviction group. */
6624 eviction_group_add_rule(struct rule
*rule
)
6625 OVS_REQUIRES(ofproto_mutex
)
6627 struct ofproto
*ofproto
= rule
->ofproto
;
6628 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6631 ovs_mutex_lock(&rule
->mutex
);
6632 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
6633 ovs_mutex_unlock(&rule
->mutex
);
6635 if (table
->eviction_fields
&& has_timeout
) {
6636 struct eviction_group
*evg
;
6638 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
6640 rule
->eviction_group
= evg
;
6641 heap_insert(&evg
->rules
, &rule
->evg_node
,
6642 rule_eviction_priority(rule
));
6643 eviction_group_resized(table
, evg
);
6649 /* Initializes 'table'. */
6651 oftable_init(struct oftable
*table
)
6653 memset(table
, 0, sizeof *table
);
6654 classifier_init(&table
->cls
, flow_segment_u32s
);
6655 table
->max_flows
= UINT_MAX
;
6656 atomic_init(&table
->config
, (unsigned int)OFPTC11_TABLE_MISS_CONTROLLER
);
6659 /* Destroys 'table', including its classifier and eviction groups.
6661 * The caller is responsible for freeing 'table' itself. */
6663 oftable_destroy(struct oftable
*table
)
6665 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
6666 ovs_assert(classifier_is_empty(&table
->cls
));
6667 ovs_rwlock_unlock(&table
->cls
.rwlock
);
6668 oftable_disable_eviction(table
);
6669 classifier_destroy(&table
->cls
);
6673 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6674 * string, then 'table' will use its default name.
6676 * This only affects the name exposed for a table exposed through the OpenFlow
6677 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6679 oftable_set_name(struct oftable
*table
, const char *name
)
6681 if (name
&& name
[0]) {
6682 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
6683 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
6685 table
->name
= xmemdup0(name
, len
);
6693 /* oftables support a choice of two policies when adding a rule would cause the
6694 * number of flows in the table to exceed the configured maximum number: either
6695 * they can refuse to add the new flow or they can evict some existing flow.
6696 * This function configures the former policy on 'table'. */
6698 oftable_disable_eviction(struct oftable
*table
)
6699 OVS_REQUIRES(ofproto_mutex
)
6701 if (table
->eviction_fields
) {
6702 struct eviction_group
*evg
, *next
;
6704 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
6705 &table
->eviction_groups_by_id
) {
6706 eviction_group_destroy(table
, evg
);
6708 hmap_destroy(&table
->eviction_groups_by_id
);
6709 heap_destroy(&table
->eviction_groups_by_size
);
6711 free(table
->eviction_fields
);
6712 table
->eviction_fields
= NULL
;
6713 table
->n_eviction_fields
= 0;
6717 /* oftables support a choice of two policies when adding a rule would cause the
6718 * number of flows in the table to exceed the configured maximum number: either
6719 * they can refuse to add the new flow or they can evict some existing flow.
6720 * This function configures the latter policy on 'table', with fairness based
6721 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6722 * 'n_fields' as 0 disables fairness.) */
6724 oftable_enable_eviction(struct oftable
*table
,
6725 const struct mf_subfield
*fields
, size_t n_fields
)
6726 OVS_REQUIRES(ofproto_mutex
)
6728 struct cls_cursor cursor
;
6731 if (table
->eviction_fields
6732 && n_fields
== table
->n_eviction_fields
6734 || !memcmp(fields
, table
->eviction_fields
,
6735 n_fields
* sizeof *fields
))) {
6740 oftable_disable_eviction(table
);
6742 table
->n_eviction_fields
= n_fields
;
6743 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
6745 table
->eviction_group_id_basis
= random_uint32();
6746 hmap_init(&table
->eviction_groups_by_id
);
6747 heap_init(&table
->eviction_groups_by_size
);
6749 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
6750 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
6751 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
6752 eviction_group_add_rule(rule
);
6754 ovs_rwlock_unlock(&table
->cls
.rwlock
);
6757 /* Removes 'rule' from the oftable that contains it. */
6759 oftable_remove_rule__(struct ofproto
*ofproto
, struct rule
*rule
)
6760 OVS_REQUIRES(ofproto_mutex
)
6762 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
6764 ovs_rwlock_wrlock(&cls
->rwlock
);
6765 classifier_remove(cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
6766 ovs_rwlock_unlock(&cls
->rwlock
);
6768 cookies_remove(ofproto
, rule
);
6770 eviction_group_remove_rule(rule
);
6771 if (!list_is_empty(&rule
->expirable
)) {
6772 list_remove(&rule
->expirable
);
6774 if (!list_is_empty(&rule
->meter_list_node
)) {
6775 list_remove(&rule
->meter_list_node
);
6776 list_init(&rule
->meter_list_node
);
6781 oftable_remove_rule(struct rule
*rule
)
6782 OVS_REQUIRES(ofproto_mutex
)
6784 oftable_remove_rule__(rule
->ofproto
, rule
);
6787 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6788 * the same cls_rule. */
6790 oftable_insert_rule(struct rule
*rule
)
6791 OVS_REQUIRES(ofproto_mutex
)
6793 struct ofproto
*ofproto
= rule
->ofproto
;
6794 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6797 ovs_mutex_lock(&rule
->mutex
);
6798 may_expire
= rule
->hard_timeout
|| rule
->idle_timeout
;
6799 ovs_mutex_unlock(&rule
->mutex
);
6802 list_insert(&ofproto
->expirable
, &rule
->expirable
);
6805 cookies_insert(ofproto
, rule
);
6807 if (rule
->actions
->provider_meter_id
!= UINT32_MAX
) {
6808 uint32_t meter_id
= ofpacts_get_meter(rule
->actions
->ofpacts
,
6809 rule
->actions
->ofpacts_len
);
6810 struct meter
*meter
= ofproto
->meters
[meter_id
];
6811 list_insert(&meter
->rules
, &rule
->meter_list_node
);
6813 ovs_rwlock_wrlock(&table
->cls
.rwlock
);
6814 classifier_insert(&table
->cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
6815 ovs_rwlock_unlock(&table
->cls
.rwlock
);
6816 eviction_group_add_rule(rule
);
6819 /* unixctl commands. */
6822 ofproto_lookup(const char *name
)
6824 struct ofproto
*ofproto
;
6826 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
6828 if (!strcmp(ofproto
->name
, name
)) {
6836 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
6837 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
6839 struct ofproto
*ofproto
;
6843 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
6844 ds_put_format(&results
, "%s\n", ofproto
->name
);
6846 unixctl_command_reply(conn
, ds_cstr(&results
));
6847 ds_destroy(&results
);
6851 ofproto_unixctl_init(void)
6853 static bool registered
;
6859 unixctl_command_register("ofproto/list", "", 0, 0,
6860 ofproto_unixctl_list
, NULL
);
6863 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6865 * This is deprecated. It is only for compatibility with broken device drivers
6866 * in old versions of Linux that do not properly support VLANs when VLAN
6867 * devices are not used. When broken device drivers are no longer in
6868 * widespread use, we will delete these interfaces. */
6870 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6871 * (exactly) by an OpenFlow rule in 'ofproto'. */
6873 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
6875 const struct oftable
*oftable
;
6877 free(ofproto
->vlan_bitmap
);
6878 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
6879 ofproto
->vlans_changed
= false;
6881 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
6882 const struct cls_subtable
*table
;
6884 ovs_rwlock_rdlock(&oftable
->cls
.rwlock
);
6885 HMAP_FOR_EACH (table
, hmap_node
, &oftable
->cls
.subtables
) {
6886 if (minimask_get_vid_mask(&table
->mask
) == VLAN_VID_MASK
) {
6887 const struct cls_rule
*rule
;
6889 HMAP_FOR_EACH (rule
, hmap_node
, &table
->rules
) {
6890 uint16_t vid
= miniflow_get_vid(&rule
->match
.flow
);
6891 bitmap_set1(vlan_bitmap
, vid
);
6892 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6896 ovs_rwlock_unlock(&oftable
->cls
.rwlock
);
6900 /* Returns true if new VLANs have come into use by the flow table since the
6901 * last call to ofproto_get_vlan_usage().
6903 * We don't track when old VLANs stop being used. */
6905 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
6907 return ofproto
->vlans_changed
;
6910 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6911 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6912 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6913 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6914 * then the VLAN device is un-enslaved. */
6916 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
6917 ofp_port_t realdev_ofp_port
, int vid
)
6919 struct ofport
*ofport
;
6922 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
6924 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
6926 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
6927 ofproto
->name
, vlandev_ofp_port
);
6931 if (!ofproto
->ofproto_class
->set_realdev
) {
6932 if (!vlandev_ofp_port
) {
6935 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
6939 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
6941 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
6942 ofproto
->name
, vlandev_ofp_port
,
6943 netdev_get_name(ofport
->netdev
), ovs_strerror(error
));