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 flow_eviction_threshold
= OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT
;
310 enum ofproto_flow_miss_model flow_miss_model
= OFPROTO_HANDLE_MISS_AUTO
;
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_eviction_threshold(unsigned threshold
)
698 flow_eviction_threshold
= MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN
,
702 /* Sets the path for handling flow misses. */
704 ofproto_set_flow_miss_model(unsigned model
)
706 flow_miss_model
= model
;
709 /* If forward_bpdu is true, the NORMAL action will forward frames with
710 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
711 * the NORMAL action will drop these frames. */
713 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
715 bool old_val
= ofproto
->forward_bpdu
;
716 ofproto
->forward_bpdu
= forward_bpdu
;
717 if (old_val
!= ofproto
->forward_bpdu
) {
718 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
719 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
724 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
725 * 'idle_time', in seconds, and the maximum number of MAC table entries to
728 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
731 if (ofproto
->ofproto_class
->set_mac_table_config
) {
732 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
737 /* Sets number of upcall handler threads. The default is
738 * (number of online cores - 2). */
740 ofproto_set_threads(size_t n_handlers_
)
742 int threads
= MAX(count_cpu_cores() - 2, 1);
743 n_handlers
= n_handlers_
? n_handlers_
: threads
;
747 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
750 p
->dp_desc
= dp_desc
? xstrdup(dp_desc
) : NULL
;
754 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
756 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
760 ofproto_set_netflow(struct ofproto
*ofproto
,
761 const struct netflow_options
*nf_options
)
763 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
767 if (ofproto
->ofproto_class
->set_netflow
) {
768 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
770 return nf_options
? EOPNOTSUPP
: 0;
775 ofproto_set_sflow(struct ofproto
*ofproto
,
776 const struct ofproto_sflow_options
*oso
)
778 if (oso
&& sset_is_empty(&oso
->targets
)) {
782 if (ofproto
->ofproto_class
->set_sflow
) {
783 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
785 return oso
? EOPNOTSUPP
: 0;
790 ofproto_set_ipfix(struct ofproto
*ofproto
,
791 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
792 const struct ofproto_ipfix_flow_exporter_options
*fo
,
795 if (ofproto
->ofproto_class
->set_ipfix
) {
796 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
798 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
803 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
805 flow_restore_wait
= flow_restore_wait_db
;
809 ofproto_get_flow_restore_wait(void)
811 return flow_restore_wait
;
815 /* Spanning Tree Protocol (STP) configuration. */
817 /* Configures STP on 'ofproto' using the settings defined in 's'. If
818 * 's' is NULL, disables STP.
820 * Returns 0 if successful, otherwise a positive errno value. */
822 ofproto_set_stp(struct ofproto
*ofproto
,
823 const struct ofproto_stp_settings
*s
)
825 return (ofproto
->ofproto_class
->set_stp
826 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
830 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
831 * 'enabled' member of 's' is false, then the other members are not
834 * Returns 0 if successful, otherwise a positive errno value. */
836 ofproto_get_stp_status(struct ofproto
*ofproto
,
837 struct ofproto_stp_status
*s
)
839 return (ofproto
->ofproto_class
->get_stp_status
840 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
844 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
845 * in 's'. The caller is responsible for assigning STP port numbers
846 * (using the 'port_num' member in the range of 1 through 255, inclusive)
847 * and ensuring there are no duplicates. If the 's' is NULL, then STP
848 * is disabled on the port.
850 * Returns 0 if successful, otherwise a positive errno value.*/
852 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
853 const struct ofproto_port_stp_settings
*s
)
855 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
857 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
858 ofproto
->name
, ofp_port
);
862 return (ofproto
->ofproto_class
->set_stp_port
863 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
867 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
868 * 's'. If the 'enabled' member in 's' is false, then the other members
869 * are not meaningful.
871 * Returns 0 if successful, otherwise a positive errno value.*/
873 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
874 struct ofproto_port_stp_status
*s
)
876 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
878 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
879 "port %"PRIu16
, ofproto
->name
, ofp_port
);
883 return (ofproto
->ofproto_class
->get_stp_port_status
884 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
888 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
889 * 's'. If the 'enabled' member in 's' is false, then the other members
890 * are not meaningful.
892 * Returns 0 if successful, otherwise a positive errno value.*/
894 ofproto_port_get_stp_stats(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
895 struct ofproto_port_stp_stats
*s
)
897 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
899 VLOG_WARN_RL(&rl
, "%s: cannot get STP stats on nonexistent "
900 "port %"PRIu16
, ofproto
->name
, ofp_port
);
904 return (ofproto
->ofproto_class
->get_stp_port_stats
905 ? ofproto
->ofproto_class
->get_stp_port_stats(ofport
, s
)
909 /* Queue DSCP configuration. */
911 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
912 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
913 * to implement QoS. Instead, it is used to implement features which require
914 * knowledge of what queues exist on a port, and some basic information about
917 * Returns 0 if successful, otherwise a positive errno value. */
919 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
920 const struct ofproto_port_queue
*queues
,
923 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
926 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
927 ofproto
->name
, ofp_port
);
931 return (ofproto
->ofproto_class
->set_queues
932 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
936 /* Connectivity Fault Management configuration. */
938 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
940 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
942 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
943 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
944 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
948 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
949 * basic configuration from the configuration members in 'cfm', and the remote
950 * maintenance point ID from remote_mpid. Ignores the statistics members of
953 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
955 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
956 const struct cfm_settings
*s
)
958 struct ofport
*ofport
;
961 ofport
= ofproto_get_port(ofproto
, ofp_port
);
963 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
964 ofproto
->name
, ofp_port
);
968 /* XXX: For configuration simplicity, we only support one remote_mpid
969 * outside of the CFM module. It's not clear if this is the correct long
970 * term solution or not. */
971 error
= (ofproto
->ofproto_class
->set_cfm
972 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
975 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
976 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
977 ovs_strerror(error
));
981 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
982 * 'ofproto' does not have a port 'ofp_port'. */
984 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
985 const struct smap
*cfg
)
987 struct ofport
*ofport
;
990 ofport
= ofproto_get_port(ofproto
, ofp_port
);
992 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16
,
993 ofproto
->name
, ofp_port
);
997 error
= (ofproto
->ofproto_class
->set_bfd
998 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
1001 VLOG_WARN("%s: bfd configuration on port %"PRIu16
" (%s) failed (%s)",
1002 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1003 ovs_strerror(error
));
1007 /* Populates 'status' with key value pairs indicating the status of the BFD
1008 * session on 'ofp_port'. This information is intended to be populated in the
1009 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
1012 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1013 struct smap
*status
)
1015 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1016 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
1017 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
1021 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1022 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1023 * 0 if LACP partner information is not current (generally indicating a
1024 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1026 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1028 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1029 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
1030 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
1036 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1037 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1038 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1039 * configuration plus, if there is more than one slave, a bonding
1042 * If 'aux' is already registered then this function updates its configuration
1043 * to 's'. Otherwise, this function registers a new bundle.
1045 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1048 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
1049 const struct ofproto_bundle_settings
*s
)
1051 return (ofproto
->ofproto_class
->bundle_set
1052 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
1056 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1057 * If no such bundle has been registered, this has no effect. */
1059 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
1061 return ofproto_bundle_register(ofproto
, aux
, NULL
);
1065 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1066 * If 'aux' is already registered then this function updates its configuration
1067 * to 's'. Otherwise, this function registers a new mirror. */
1069 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
1070 const struct ofproto_mirror_settings
*s
)
1072 return (ofproto
->ofproto_class
->mirror_set
1073 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
1077 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1078 * If no mirror has been registered, this has no effect. */
1080 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
1082 return ofproto_mirror_register(ofproto
, aux
, NULL
);
1085 /* Retrieves statistics from mirror associated with client data pointer
1086 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1087 * 'bytes', respectively. If a particular counters is not supported,
1088 * the appropriate argument is set to UINT64_MAX. */
1090 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
1091 uint64_t *packets
, uint64_t *bytes
)
1093 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
1094 *packets
= *bytes
= UINT64_MAX
;
1098 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
1102 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1103 * which all packets are flooded, instead of using MAC learning. If
1104 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1106 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1109 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
1111 return (ofproto
->ofproto_class
->set_flood_vlans
1112 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
1116 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1117 * output for a mirror. */
1119 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
1121 return (ofproto
->ofproto_class
->is_mirror_output_bundle
1122 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
1126 /* Configuration of OpenFlow tables. */
1128 /* Returns the number of OpenFlow tables in 'ofproto'. */
1130 ofproto_get_n_tables(const struct ofproto
*ofproto
)
1132 return ofproto
->n_tables
;
1135 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1136 * settings from 's'. 'table_id' must be in the range 0 through the number of
1137 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1139 * For read-only tables, only the name may be configured. */
1141 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
1142 const struct ofproto_table_settings
*s
)
1144 struct oftable
*table
;
1146 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
1147 table
= &ofproto
->tables
[table_id
];
1149 oftable_set_name(table
, s
->name
);
1151 if (table
->flags
& OFTABLE_READONLY
) {
1156 oftable_enable_eviction(table
, s
->groups
, s
->n_groups
);
1158 oftable_disable_eviction(table
);
1161 table
->max_flows
= s
->max_flows
;
1162 ovs_rwlock_wrlock(&table
->cls
.rwlock
);
1163 if (classifier_count(&table
->cls
) > table
->max_flows
1164 && table
->eviction_fields
) {
1165 /* 'table' contains more flows than allowed. We might not be able to
1166 * evict them right away because of the asynchronous nature of flow
1167 * table changes. Schedule eviction for later. */
1168 switch (ofproto
->state
) {
1170 ofproto
->state
= S_EVICT
;
1174 /* We're already deleting flows, nothing more to do. */
1179 classifier_set_prefix_fields(&table
->cls
,
1180 s
->prefix_fields
, s
->n_prefix_fields
);
1182 ovs_rwlock_unlock(&table
->cls
.rwlock
);
1186 ofproto_has_snoops(const struct ofproto
*ofproto
)
1188 return connmgr_has_snoops(ofproto
->connmgr
);
1192 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1194 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1198 ofproto_rule_delete__(struct ofproto
*ofproto
, struct rule
*rule
,
1200 OVS_REQUIRES(ofproto_mutex
)
1202 struct ofopgroup
*group
;
1204 ovs_assert(!rule
->pending
);
1206 group
= ofopgroup_create_unattached(ofproto
);
1207 delete_flow__(rule
, group
, reason
);
1208 ofopgroup_submit(group
);
1211 /* Deletes 'rule' from 'cls' within 'ofproto'.
1213 * Within an ofproto implementation, this function allows an ofproto
1214 * implementation to destroy any rules that remain when its ->destruct()
1215 * function is called. This function is not suitable for use elsewhere in an
1216 * ofproto implementation.
1218 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1219 * Cycle" in ofproto-provider.h. */
1221 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1222 OVS_EXCLUDED(ofproto_mutex
)
1224 struct ofopgroup
*group
;
1226 ovs_mutex_lock(&ofproto_mutex
);
1227 ovs_assert(!rule
->pending
);
1229 group
= ofopgroup_create_unattached(ofproto
);
1230 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, OFPRR_DELETE
);
1231 oftable_remove_rule__(ofproto
, rule
);
1232 ofproto
->ofproto_class
->rule_delete(rule
);
1233 ofopgroup_submit(group
);
1235 ovs_mutex_unlock(&ofproto_mutex
);
1239 ofproto_flush__(struct ofproto
*ofproto
)
1240 OVS_EXCLUDED(ofproto_mutex
)
1242 struct oftable
*table
;
1244 if (ofproto
->ofproto_class
->flush
) {
1245 ofproto
->ofproto_class
->flush(ofproto
);
1248 ovs_mutex_lock(&ofproto_mutex
);
1249 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1250 struct rule
*rule
, *next_rule
;
1251 struct cls_cursor cursor
;
1253 if (table
->flags
& OFTABLE_HIDDEN
) {
1257 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
1258 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
1259 ovs_rwlock_unlock(&table
->cls
.rwlock
);
1260 CLS_CURSOR_FOR_EACH_SAFE (rule
, next_rule
, cr
, &cursor
) {
1261 if (!rule
->pending
) {
1262 ofproto_rule_delete__(ofproto
, rule
, OFPRR_DELETE
);
1266 ovs_mutex_unlock(&ofproto_mutex
);
1269 static void delete_group(struct ofproto
*ofproto
, uint32_t group_id
);
1272 ofproto_destroy__(struct ofproto
*ofproto
)
1273 OVS_EXCLUDED(ofproto_mutex
)
1275 struct oftable
*table
;
1277 ovs_assert(list_is_empty(&ofproto
->pending
));
1279 destroy_rule_executes(ofproto
);
1280 guarded_list_destroy(&ofproto
->rule_executes
);
1282 delete_group(ofproto
, OFPG_ALL
);
1283 ovs_rwlock_destroy(&ofproto
->groups_rwlock
);
1284 hmap_destroy(&ofproto
->groups
);
1286 connmgr_destroy(ofproto
->connmgr
);
1288 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1289 free(ofproto
->name
);
1290 free(ofproto
->type
);
1291 free(ofproto
->mfr_desc
);
1292 free(ofproto
->hw_desc
);
1293 free(ofproto
->sw_desc
);
1294 free(ofproto
->serial_desc
);
1295 free(ofproto
->dp_desc
);
1296 hmap_destroy(&ofproto
->ports
);
1297 hmap_destroy(&ofproto
->ofport_usage
);
1298 shash_destroy(&ofproto
->port_by_name
);
1299 simap_destroy(&ofproto
->ofp_requests
);
1301 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1302 oftable_destroy(table
);
1304 free(ofproto
->tables
);
1306 hmap_destroy(&ofproto
->deletions
);
1308 free(ofproto
->vlan_bitmap
);
1310 ofproto
->ofproto_class
->dealloc(ofproto
);
1314 ofproto_destroy(struct ofproto
*p
)
1315 OVS_EXCLUDED(ofproto_mutex
)
1317 struct ofport
*ofport
, *next_ofport
;
1318 struct ofport_usage
*usage
, *next_usage
;
1325 meter_delete(p
, 1, p
->meter_features
.max_meters
);
1326 p
->meter_features
.max_meters
= 0;
1332 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1333 ofport_destroy(ofport
);
1336 HMAP_FOR_EACH_SAFE (usage
, next_usage
, hmap_node
, &p
->ofport_usage
) {
1337 hmap_remove(&p
->ofport_usage
, &usage
->hmap_node
);
1341 p
->ofproto_class
->destruct(p
);
1342 ofproto_destroy__(p
);
1345 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1346 * kernel datapath, for example, this destroys the datapath in the kernel, and
1347 * with the netdev-based datapath, it tears down the data structures that
1348 * represent the datapath.
1350 * The datapath should not be currently open as an ofproto. */
1352 ofproto_delete(const char *name
, const char *type
)
1354 const struct ofproto_class
*class = ofproto_class_find__(type
);
1355 return (!class ? EAFNOSUPPORT
1356 : !class->del
? EACCES
1357 : class->del(type
, name
));
1361 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1363 if (error
== ENOBUFS
) {
1364 reinit_ports(ofproto
);
1365 } else if (!error
) {
1366 update_port(ofproto
, devname
);
1372 ofproto_type_run(const char *datapath_type
)
1374 const struct ofproto_class
*class;
1377 datapath_type
= ofproto_normalize_type(datapath_type
);
1378 class = ofproto_class_find__(datapath_type
);
1380 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1381 if (error
&& error
!= EAGAIN
) {
1382 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1383 datapath_type
, ovs_strerror(error
));
1389 ofproto_type_wait(const char *datapath_type
)
1391 const struct ofproto_class
*class;
1393 datapath_type
= ofproto_normalize_type(datapath_type
);
1394 class = ofproto_class_find__(datapath_type
);
1396 if (class->type_wait
) {
1397 class->type_wait(datapath_type
);
1402 any_pending_ops(const struct ofproto
*p
)
1403 OVS_EXCLUDED(ofproto_mutex
)
1407 ovs_mutex_lock(&ofproto_mutex
);
1408 b
= !list_is_empty(&p
->pending
);
1409 ovs_mutex_unlock(&ofproto_mutex
);
1415 ofproto_run(struct ofproto
*p
)
1420 error
= p
->ofproto_class
->run(p
);
1421 if (error
&& error
!= EAGAIN
) {
1422 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, ovs_strerror(error
));
1425 run_rule_executes(p
);
1427 /* Restore the eviction group heap invariant occasionally. */
1428 if (p
->eviction_group_timer
< time_msec()) {
1431 p
->eviction_group_timer
= time_msec() + 1000;
1433 for (i
= 0; i
< p
->n_tables
; i
++) {
1434 struct oftable
*table
= &p
->tables
[i
];
1435 struct eviction_group
*evg
;
1436 struct cls_cursor cursor
;
1439 if (!table
->eviction_fields
) {
1443 ovs_mutex_lock(&ofproto_mutex
);
1444 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1445 heap_rebuild(&evg
->rules
);
1448 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
1449 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
1450 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
1451 if (!rule
->eviction_group
1452 && (rule
->idle_timeout
|| rule
->hard_timeout
)) {
1453 eviction_group_add_rule(rule
);
1456 ovs_rwlock_unlock(&table
->cls
.rwlock
);
1457 ovs_mutex_unlock(&ofproto_mutex
);
1461 if (p
->ofproto_class
->port_poll
) {
1464 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1465 process_port_change(p
, error
, devname
);
1469 new_seq
= seq_read(connectivity_seq_get());
1470 if (new_seq
!= p
->change_seq
) {
1471 struct sset devnames
;
1472 const char *devname
;
1473 struct ofport
*ofport
;
1475 /* Update OpenFlow port status for any port whose netdev has changed.
1477 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1478 * destroyed, so it's not safe to update ports directly from the
1479 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1480 * need this two-phase approach. */
1481 sset_init(&devnames
);
1482 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1483 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1485 SSET_FOR_EACH (devname
, &devnames
) {
1486 update_port(p
, devname
);
1488 sset_destroy(&devnames
);
1490 p
->change_seq
= new_seq
;
1495 connmgr_run(p
->connmgr
, handle_openflow
);
1499 connmgr_run(p
->connmgr
, NULL
);
1501 if (!any_pending_ops(p
)) {
1502 p
->state
= S_OPENFLOW
;
1507 connmgr_run(p
->connmgr
, NULL
);
1509 if (!any_pending_ops(p
)) {
1510 connmgr_flushed(p
->connmgr
);
1511 p
->state
= S_OPENFLOW
;
1519 if (time_msec() >= p
->next_op_report
) {
1520 long long int ago
= (time_msec() - p
->first_op
) / 1000;
1521 long long int interval
= (p
->last_op
- p
->first_op
) / 1000;
1525 ds_put_format(&s
, "%d flow_mods ",
1526 p
->n_add
+ p
->n_delete
+ p
->n_modify
);
1527 if (interval
== ago
) {
1528 ds_put_format(&s
, "in the last %lld s", ago
);
1529 } else if (interval
) {
1530 ds_put_format(&s
, "in the %lld s starting %lld s ago",
1533 ds_put_format(&s
, "%lld s ago", ago
);
1536 ds_put_cstr(&s
, " (");
1538 ds_put_format(&s
, "%d adds, ", p
->n_add
);
1541 ds_put_format(&s
, "%d deletes, ", p
->n_delete
);
1544 ds_put_format(&s
, "%d modifications, ", p
->n_modify
);
1547 ds_put_char(&s
, ')');
1549 VLOG_INFO("%s: %s", p
->name
, ds_cstr(&s
));
1552 p
->n_add
= p
->n_delete
= p
->n_modify
= 0;
1553 p
->next_op_report
= LLONG_MAX
;
1560 ofproto_wait(struct ofproto
*p
)
1562 p
->ofproto_class
->wait(p
);
1563 if (p
->ofproto_class
->port_poll_wait
) {
1564 p
->ofproto_class
->port_poll_wait(p
);
1566 seq_wait(connectivity_seq_get(), p
->change_seq
);
1570 connmgr_wait(p
->connmgr
, true);
1575 connmgr_wait(p
->connmgr
, false);
1576 if (!any_pending_ops(p
)) {
1577 poll_immediate_wake();
1584 ofproto_is_alive(const struct ofproto
*p
)
1586 return connmgr_has_controllers(p
->connmgr
);
1589 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1590 * memory_report(). */
1592 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1594 const struct oftable
*table
;
1595 unsigned int n_rules
;
1597 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1599 ovs_mutex_lock(&ofproto_mutex
);
1600 simap_increase(usage
, "ops",
1601 ofproto
->n_pending
+ hmap_count(&ofproto
->deletions
));
1602 ovs_mutex_unlock(&ofproto_mutex
);
1605 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1606 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
1607 n_rules
+= classifier_count(&table
->cls
);
1608 ovs_rwlock_unlock(&table
->cls
.rwlock
);
1610 simap_increase(usage
, "rules", n_rules
);
1612 if (ofproto
->ofproto_class
->get_memory_usage
) {
1613 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1616 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1620 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1622 const struct ofproto_class
*class;
1624 datapath_type
= ofproto_normalize_type(datapath_type
);
1625 class = ofproto_class_find__(datapath_type
);
1627 if (class && class->type_get_memory_usage
) {
1628 class->type_get_memory_usage(datapath_type
, usage
);
1633 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1636 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1640 ofproto_free_ofproto_controller_info(struct shash
*info
)
1642 connmgr_free_controller_info(info
);
1645 /* Makes a deep copy of 'old' into 'port'. */
1647 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1649 port
->name
= xstrdup(old
->name
);
1650 port
->type
= xstrdup(old
->type
);
1651 port
->ofp_port
= old
->ofp_port
;
1654 /* Frees memory allocated to members of 'ofproto_port'.
1656 * Do not call this function on an ofproto_port obtained from
1657 * ofproto_port_dump_next(): that function retains ownership of the data in the
1660 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1662 free(ofproto_port
->name
);
1663 free(ofproto_port
->type
);
1666 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1668 * This function provides no status indication. An error status for the entire
1669 * dump operation is provided when it is completed by calling
1670 * ofproto_port_dump_done().
1673 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1674 const struct ofproto
*ofproto
)
1676 dump
->ofproto
= ofproto
;
1677 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1681 /* Attempts to retrieve another port from 'dump', which must have been created
1682 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1683 * 'port' and returns true. On failure, returns false.
1685 * Failure might indicate an actual error or merely that the last port has been
1686 * dumped. An error status for the entire dump operation is provided when it
1687 * is completed by calling ofproto_port_dump_done().
1689 * The ofproto owns the data stored in 'port'. It will remain valid until at
1690 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1691 * ofproto_port_dump_done(). */
1693 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1694 struct ofproto_port
*port
)
1696 const struct ofproto
*ofproto
= dump
->ofproto
;
1702 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1705 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1711 /* Completes port table dump operation 'dump', which must have been created
1712 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1713 * error-free, otherwise a positive errno value describing the problem. */
1715 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1717 const struct ofproto
*ofproto
= dump
->ofproto
;
1719 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1722 return dump
->error
== EOF
? 0 : dump
->error
;
1725 /* Returns the type to pass to netdev_open() when a datapath of type
1726 * 'datapath_type' has a port of type 'port_type', for a few special
1727 * cases when a netdev type differs from a port type. For example, when
1728 * using the userspace datapath, a port of type "internal" needs to be
1731 * Returns either 'type' itself or a string literal, which must not be
1734 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1736 const struct ofproto_class
*class;
1738 datapath_type
= ofproto_normalize_type(datapath_type
);
1739 class = ofproto_class_find__(datapath_type
);
1744 return (class->port_open_type
1745 ? class->port_open_type(datapath_type
, port_type
)
1749 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1750 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1751 * the port's OpenFlow port number.
1753 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1754 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1755 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1756 * 'ofp_portp' is non-null). */
1758 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1759 ofp_port_t
*ofp_portp
)
1761 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1764 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1766 const char *netdev_name
= netdev_get_name(netdev
);
1768 simap_put(&ofproto
->ofp_requests
, netdev_name
,
1769 ofp_to_u16(ofp_port
));
1770 update_port(ofproto
, netdev_name
);
1773 *ofp_portp
= OFPP_NONE
;
1775 struct ofproto_port ofproto_port
;
1777 error
= ofproto_port_query_by_name(ofproto
,
1778 netdev_get_name(netdev
),
1781 *ofp_portp
= ofproto_port
.ofp_port
;
1782 ofproto_port_destroy(&ofproto_port
);
1789 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1790 * initializes '*port' appropriately; on failure, returns a positive errno
1793 * The caller owns the data in 'ofproto_port' and must free it with
1794 * ofproto_port_destroy() when it is no longer needed. */
1796 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1797 struct ofproto_port
*port
)
1801 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1803 memset(port
, 0, sizeof *port
);
1808 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1809 * Returns 0 if successful, otherwise a positive errno. */
1811 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1813 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1814 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
1815 struct simap_node
*ofp_request_node
;
1818 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
1819 if (ofp_request_node
) {
1820 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
1823 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
1824 if (!error
&& ofport
) {
1825 /* 'name' is the netdev's name and update_port() is going to close the
1826 * netdev. Just in case update_port() refers to 'name' after it
1827 * destroys 'ofport', make a copy of it around the update_port()
1829 char *devname
= xstrdup(name
);
1830 update_port(ofproto
, devname
);
1837 flow_mod_init(struct ofputil_flow_mod
*fm
,
1838 const struct match
*match
, unsigned int priority
,
1839 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1840 enum ofp_flow_mod_command command
)
1842 memset(fm
, 0, sizeof *fm
);
1844 fm
->priority
= priority
;
1847 fm
->modify_cookie
= false;
1849 fm
->command
= command
;
1850 fm
->idle_timeout
= 0;
1851 fm
->hard_timeout
= 0;
1852 fm
->buffer_id
= UINT32_MAX
;
1853 fm
->out_port
= OFPP_ANY
;
1854 fm
->out_group
= OFPG_ANY
;
1856 fm
->ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
);
1857 fm
->ofpacts_len
= ofpacts_len
;
1861 simple_flow_mod(struct ofproto
*ofproto
,
1862 const struct match
*match
, unsigned int priority
,
1863 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1864 enum ofp_flow_mod_command command
)
1866 struct ofputil_flow_mod fm
;
1868 flow_mod_init(&fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
1870 return handle_flow_mod__(ofproto
, NULL
, &fm
, NULL
);
1873 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1874 * performs the 'n_actions' actions in 'actions'. The new flow will not
1877 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1878 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1879 * controllers; otherwise, it will be hidden.
1881 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1883 * This is a helper function for in-band control and fail-open. */
1885 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
1886 unsigned int priority
,
1887 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1888 OVS_EXCLUDED(ofproto_mutex
)
1890 const struct rule
*rule
;
1893 /* First do a cheap check whether the rule we're looking for already exists
1894 * with the actions that we want. If it does, then we're done. */
1895 ovs_rwlock_rdlock(&ofproto
->tables
[0].cls
.rwlock
);
1896 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1897 &ofproto
->tables
[0].cls
, match
, priority
));
1899 ovs_mutex_lock(&rule
->mutex
);
1900 must_add
= !ofpacts_equal(rule
->actions
->ofpacts
,
1901 rule
->actions
->ofpacts_len
,
1902 ofpacts
, ofpacts_len
);
1903 ovs_mutex_unlock(&rule
->mutex
);
1907 ovs_rwlock_unlock(&ofproto
->tables
[0].cls
.rwlock
);
1909 /* If there's no such rule or the rule doesn't have the actions we want,
1910 * fall back to a executing a full flow mod. We can't optimize this at
1911 * all because we didn't take enough locks above to ensure that the flow
1912 * table didn't already change beneath us. */
1914 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
1915 OFPFC_MODIFY_STRICT
);
1919 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1920 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1921 * operation cannot be initiated now but may be retried later.
1923 * This is a helper function for in-band control and fail-open and the "learn"
1926 ofproto_flow_mod(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
)
1927 OVS_EXCLUDED(ofproto_mutex
)
1929 return handle_flow_mod__(ofproto
, NULL
, fm
, NULL
);
1932 /* Searches for a rule with matching criteria exactly equal to 'target' in
1933 * ofproto's table 0 and, if it finds one, deletes it.
1935 * This is a helper function for in-band control and fail-open. */
1937 ofproto_delete_flow(struct ofproto
*ofproto
,
1938 const struct match
*target
, unsigned int priority
)
1939 OVS_EXCLUDED(ofproto_mutex
)
1941 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
1944 /* First do a cheap check whether the rule we're looking for has already
1945 * been deleted. If so, then we're done. */
1946 ovs_rwlock_rdlock(&cls
->rwlock
);
1947 rule
= rule_from_cls_rule(classifier_find_match_exactly(cls
, target
,
1949 ovs_rwlock_unlock(&cls
->rwlock
);
1954 /* Fall back to a executing a full flow mod. We can't optimize this at all
1955 * because we didn't take enough locks above to ensure that the flow table
1956 * didn't already change beneath us. */
1957 return simple_flow_mod(ofproto
, target
, priority
, NULL
, 0,
1958 OFPFC_DELETE_STRICT
) != OFPROTO_POSTPONE
;
1961 /* Starts the process of deleting all of the flows from all of ofproto's flow
1962 * tables and then reintroducing the flows required by in-band control and
1963 * fail-open. The process will complete in a later call to ofproto_run(). */
1965 ofproto_flush_flows(struct ofproto
*ofproto
)
1967 COVERAGE_INC(ofproto_flush
);
1968 ofproto
->state
= S_FLUSH
;
1972 reinit_ports(struct ofproto
*p
)
1974 struct ofproto_port_dump dump
;
1975 struct sset devnames
;
1976 struct ofport
*ofport
;
1977 struct ofproto_port ofproto_port
;
1978 const char *devname
;
1980 COVERAGE_INC(ofproto_reinit_ports
);
1982 sset_init(&devnames
);
1983 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1984 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1986 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
1987 sset_add(&devnames
, ofproto_port
.name
);
1990 SSET_FOR_EACH (devname
, &devnames
) {
1991 update_port(p
, devname
);
1993 sset_destroy(&devnames
);
1997 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2001 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2002 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2004 if (port_idx
>= ofproto
->max_ports
2005 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2006 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2007 long long int last_used_at
, lru
= LLONG_MAX
;
2009 /* Search for a free OpenFlow port number. We try not to
2010 * immediately reuse them to prevent problems due to old
2013 * We limit the automatically assigned port numbers to the lower half
2014 * of the port range, to reserve the upper half for assignment by
2017 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2018 ofproto
->alloc_port_no
= 1;
2020 last_used_at
= ofport_get_usage(ofproto
,
2021 u16_to_ofp(ofproto
->alloc_port_no
));
2022 if (!last_used_at
) {
2023 port_idx
= ofproto
->alloc_port_no
;
2025 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2026 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2027 * more than an hour ago, consider it usable. */
2028 ofport_remove_usage(ofproto
,
2029 u16_to_ofp(ofproto
->alloc_port_no
));
2030 port_idx
= ofproto
->alloc_port_no
;
2032 } else if (last_used_at
< lru
) {
2034 lru_ofport
= ofproto
->alloc_port_no
;
2037 if (ofproto
->alloc_port_no
== end_port_no
) {
2039 port_idx
= lru_ofport
;
2046 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2047 return u16_to_ofp(port_idx
);
2051 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2053 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2054 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2058 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2059 * pointer if the netdev cannot be opened. On success, also fills in
2061 static struct netdev
*
2062 ofport_open(struct ofproto
*ofproto
,
2063 struct ofproto_port
*ofproto_port
,
2064 struct ofputil_phy_port
*pp
)
2066 enum netdev_flags flags
;
2067 struct netdev
*netdev
;
2070 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2072 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
2073 "cannot be opened (%s)",
2075 ofproto_port
->name
, ofproto_port
->ofp_port
,
2076 ofproto_port
->name
, ovs_strerror(error
));
2080 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2081 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2082 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2084 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2085 ofproto_port
->name
);
2088 pp
->port_no
= ofproto_port
->ofp_port
;
2089 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
2090 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2091 netdev_get_flags(netdev
, &flags
);
2092 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2093 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2094 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2095 &pp
->supported
, &pp
->peer
);
2096 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2097 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2102 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2103 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2106 ofport_equal(const struct ofputil_phy_port
*a
,
2107 const struct ofputil_phy_port
*b
)
2109 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2110 && a
->state
== b
->state
2111 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2112 && a
->curr
== b
->curr
2113 && a
->advertised
== b
->advertised
2114 && a
->supported
== b
->supported
2115 && a
->peer
== b
->peer
2116 && a
->curr_speed
== b
->curr_speed
2117 && a
->max_speed
== b
->max_speed
);
2120 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2121 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2122 * one with the same name or port number). */
2124 ofport_install(struct ofproto
*p
,
2125 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2127 const char *netdev_name
= netdev_get_name(netdev
);
2128 struct ofport
*ofport
;
2131 /* Create ofport. */
2132 ofport
= p
->ofproto_class
->port_alloc();
2137 ofport
->ofproto
= p
;
2138 ofport
->netdev
= netdev
;
2140 ofport
->ofp_port
= pp
->port_no
;
2141 ofport
->created
= time_msec();
2143 /* Add port to 'p'. */
2144 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2145 hash_ofp_port(ofport
->ofp_port
));
2146 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2148 update_mtu(p
, ofport
);
2150 /* Let the ofproto_class initialize its private data. */
2151 error
= p
->ofproto_class
->port_construct(ofport
);
2155 connmgr_send_port_status(p
->connmgr
, pp
, OFPPR_ADD
);
2159 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2160 p
->name
, netdev_name
, ovs_strerror(error
));
2162 ofport_destroy__(ofport
);
2164 netdev_close(netdev
);
2168 /* Removes 'ofport' from 'p' and destroys it. */
2170 ofport_remove(struct ofport
*ofport
)
2172 connmgr_send_port_status(ofport
->ofproto
->connmgr
, &ofport
->pp
,
2174 ofport_destroy(ofport
);
2177 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2180 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2182 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2184 ofport_remove(port
);
2188 /* Updates 'port' with new 'pp' description.
2190 * Does not handle a name or port number change. The caller must implement
2191 * such a change as a delete followed by an add. */
2193 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2195 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
2196 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2197 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2198 port
->pp
.state
= pp
->state
;
2199 port
->pp
.curr
= pp
->curr
;
2200 port
->pp
.advertised
= pp
->advertised
;
2201 port
->pp
.supported
= pp
->supported
;
2202 port
->pp
.peer
= pp
->peer
;
2203 port
->pp
.curr_speed
= pp
->curr_speed
;
2204 port
->pp
.max_speed
= pp
->max_speed
;
2206 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->pp
, OFPPR_MODIFY
);
2209 /* Update OpenFlow 'state' in 'port' and notify controller. */
2211 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2213 if (port
->pp
.state
!= state
) {
2214 port
->pp
.state
= state
;
2215 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->pp
,
2221 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2223 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2225 if (port
->ofproto
->ofproto_class
->set_realdev
) {
2226 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
2228 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2229 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2231 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2232 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2234 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2235 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2241 ofport_destroy__(struct ofport
*port
)
2243 struct ofproto
*ofproto
= port
->ofproto
;
2244 const char *name
= netdev_get_name(port
->netdev
);
2246 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2247 shash_delete(&ofproto
->port_by_name
,
2248 shash_find(&ofproto
->port_by_name
, name
));
2250 netdev_close(port
->netdev
);
2251 ofproto
->ofproto_class
->port_dealloc(port
);
2255 ofport_destroy(struct ofport
*port
)
2258 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2259 port
->ofproto
->ofproto_class
->port_destruct(port
);
2260 ofport_destroy__(port
);
2265 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2267 struct ofport
*port
;
2269 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2271 if (port
->ofp_port
== ofp_port
) {
2278 static long long int
2279 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2281 struct ofport_usage
*usage
;
2283 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2284 &ofproto
->ofport_usage
) {
2285 if (usage
->ofp_port
== ofp_port
) {
2286 return usage
->last_used
;
2293 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2294 long long int last_used
)
2296 struct ofport_usage
*usage
;
2297 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2298 &ofproto
->ofport_usage
) {
2299 if (usage
->ofp_port
== ofp_port
) {
2300 usage
->last_used
= last_used
;
2304 ovs_assert(last_used
== LLONG_MAX
);
2306 usage
= xmalloc(sizeof *usage
);
2307 usage
->ofp_port
= ofp_port
;
2308 usage
->last_used
= last_used
;
2309 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2310 hash_ofp_port(ofp_port
));
2314 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2316 struct ofport_usage
*usage
;
2317 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2318 &ofproto
->ofport_usage
) {
2319 if (usage
->ofp_port
== ofp_port
) {
2320 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2328 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2330 struct ofproto
*ofproto
= port
->ofproto
;
2333 if (ofproto
->ofproto_class
->port_get_stats
) {
2334 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2343 update_port(struct ofproto
*ofproto
, const char *name
)
2345 struct ofproto_port ofproto_port
;
2346 struct ofputil_phy_port pp
;
2347 struct netdev
*netdev
;
2348 struct ofport
*port
;
2350 COVERAGE_INC(ofproto_update_port
);
2352 /* Fetch 'name''s location and properties from the datapath. */
2353 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2354 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2358 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2359 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2360 struct netdev
*old_netdev
= port
->netdev
;
2362 /* 'name' hasn't changed location. Any properties changed? */
2363 if (!ofport_equal(&port
->pp
, &pp
)) {
2364 ofport_modified(port
, &pp
);
2367 update_mtu(ofproto
, port
);
2369 /* Install the newly opened netdev in case it has changed.
2370 * Don't close the old netdev yet in case port_modified has to
2371 * remove a retained reference to it.*/
2372 port
->netdev
= netdev
;
2374 if (port
->ofproto
->ofproto_class
->port_modified
) {
2375 port
->ofproto
->ofproto_class
->port_modified(port
);
2378 netdev_close(old_netdev
);
2380 /* If 'port' is nonnull then its name differs from 'name' and thus
2381 * we should delete it. If we think there's a port named 'name'
2382 * then its port number must be wrong now so delete it too. */
2384 ofport_remove(port
);
2386 ofport_remove_with_name(ofproto
, name
);
2387 ofport_install(ofproto
, netdev
, &pp
);
2390 /* Any port named 'name' is gone now. */
2391 ofport_remove_with_name(ofproto
, name
);
2393 ofproto_port_destroy(&ofproto_port
);
2397 init_ports(struct ofproto
*p
)
2399 struct ofproto_port_dump dump
;
2400 struct ofproto_port ofproto_port
;
2401 struct shash_node
*node
, *next
;
2403 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2404 const char *name
= ofproto_port
.name
;
2406 if (shash_find(&p
->port_by_name
, name
)) {
2407 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2410 struct ofputil_phy_port pp
;
2411 struct netdev
*netdev
;
2413 /* Check if an OpenFlow port number had been requested. */
2414 node
= shash_find(&init_ofp_ports
, name
);
2416 const struct iface_hint
*iface_hint
= node
->data
;
2417 simap_put(&p
->ofp_requests
, name
,
2418 ofp_to_u16(iface_hint
->ofp_port
));
2421 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2423 ofport_install(p
, netdev
, &pp
);
2424 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2425 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2426 ofp_to_u16(ofproto_port
.ofp_port
));
2432 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2433 struct iface_hint
*iface_hint
= node
->data
;
2435 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2436 free(iface_hint
->br_name
);
2437 free(iface_hint
->br_type
);
2439 shash_delete(&init_ofp_ports
, node
);
2446 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2447 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2449 find_min_mtu(struct ofproto
*p
)
2451 struct ofport
*ofport
;
2454 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2455 struct netdev
*netdev
= ofport
->netdev
;
2458 /* Skip any internal ports, since that's what we're trying to
2460 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2464 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2467 if (!mtu
|| dev_mtu
< mtu
) {
2472 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2475 /* Update MTU of all datapath devices on 'p' to the minimum of the
2476 * non-datapath ports in event of 'port' added or changed. */
2478 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2480 struct ofport
*ofport
;
2481 struct netdev
*netdev
= port
->netdev
;
2482 int dev_mtu
, old_min
;
2484 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2488 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2489 if (dev_mtu
> p
->min_mtu
) {
2490 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2491 dev_mtu
= p
->min_mtu
;
2494 port
->mtu
= dev_mtu
;
2498 /* For non-internal port find new min mtu. */
2499 old_min
= p
->min_mtu
;
2500 port
->mtu
= dev_mtu
;
2501 p
->min_mtu
= find_min_mtu(p
);
2502 if (p
->min_mtu
== old_min
) {
2506 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2507 struct netdev
*netdev
= ofport
->netdev
;
2509 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2510 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2511 ofport
->mtu
= p
->min_mtu
;
2518 ofproto_rule_ref(struct rule
*rule
)
2523 atomic_add(&rule
->ref_count
, 1, &orig
);
2524 ovs_assert(orig
!= 0);
2529 ofproto_rule_unref(struct rule
*rule
)
2534 atomic_sub(&rule
->ref_count
, 1, &orig
);
2536 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2537 ofproto_rule_destroy__(rule
);
2539 ovs_assert(orig
!= 0);
2544 struct rule_actions
*
2545 rule_get_actions(const struct rule
*rule
)
2546 OVS_EXCLUDED(rule
->mutex
)
2548 struct rule_actions
*actions
;
2550 ovs_mutex_lock(&rule
->mutex
);
2551 actions
= rule_get_actions__(rule
);
2552 ovs_mutex_unlock(&rule
->mutex
);
2557 struct rule_actions
*
2558 rule_get_actions__(const struct rule
*rule
)
2559 OVS_REQUIRES(rule
->mutex
)
2561 rule_actions_ref(rule
->actions
);
2562 return rule
->actions
;
2566 ofproto_rule_destroy__(struct rule
*rule
)
2567 OVS_NO_THREAD_SAFETY_ANALYSIS
2569 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2570 rule_actions_unref(rule
->actions
);
2571 ovs_mutex_destroy(&rule
->mutex
);
2572 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2575 static uint32_t get_provider_meter_id(const struct ofproto
*,
2576 uint32_t of_meter_id
);
2578 /* Creates and returns a new 'struct rule_actions', with a ref_count of 1,
2579 * whose actions are a copy of from the 'ofpacts_len' bytes of 'ofpacts'. */
2580 struct rule_actions
*
2581 rule_actions_create(const struct ofproto
*ofproto
,
2582 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2584 struct rule_actions
*actions
;
2586 actions
= xmalloc(sizeof *actions
);
2587 atomic_init(&actions
->ref_count
, 1);
2588 actions
->ofpacts
= xmemdup(ofpacts
, ofpacts_len
);
2589 actions
->ofpacts_len
= ofpacts_len
;
2590 actions
->provider_meter_id
2591 = get_provider_meter_id(ofproto
,
2592 ofpacts_get_meter(ofpacts
, ofpacts_len
));
2597 /* Increments 'actions''s ref_count. */
2599 rule_actions_ref(struct rule_actions
*actions
)
2604 atomic_add(&actions
->ref_count
, 1, &orig
);
2605 ovs_assert(orig
!= 0);
2609 /* Decrements 'actions''s ref_count and frees 'actions' if the ref_count
2612 rule_actions_unref(struct rule_actions
*actions
)
2617 atomic_sub(&actions
->ref_count
, 1, &orig
);
2619 free(actions
->ofpacts
);
2622 ovs_assert(orig
!= 0);
2627 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2628 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2630 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2631 OVS_REQUIRES(ofproto_mutex
)
2633 return (port
== OFPP_ANY
2634 || ofpacts_output_to_port(rule
->actions
->ofpacts
,
2635 rule
->actions
->ofpacts_len
, port
));
2638 /* Returns true if 'rule' has group and equals group_id. */
2640 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
2641 OVS_REQUIRES(ofproto_mutex
)
2643 return (group_id
== OFPG11_ANY
2644 || ofpacts_output_to_group(rule
->actions
->ofpacts
,
2645 rule
->actions
->ofpacts_len
, group_id
));
2648 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2649 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2651 ofoperation_has_out_port(const struct ofoperation
*op
, ofp_port_t out_port
)
2652 OVS_REQUIRES(ofproto_mutex
)
2654 if (ofproto_rule_has_out_port(op
->rule
, out_port
)) {
2659 case OFOPERATION_ADD
:
2660 case OFOPERATION_DELETE
:
2663 case OFOPERATION_MODIFY
:
2664 case OFOPERATION_REPLACE
:
2665 return ofpacts_output_to_port(op
->actions
->ofpacts
,
2666 op
->actions
->ofpacts_len
, out_port
);
2673 rule_execute_destroy(struct rule_execute
*e
)
2675 ofproto_rule_unref(e
->rule
);
2676 list_remove(&e
->list_node
);
2680 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2681 * by passing them to the ofproto provider. */
2683 run_rule_executes(struct ofproto
*ofproto
)
2684 OVS_EXCLUDED(ofproto_mutex
)
2686 struct rule_execute
*e
, *next
;
2687 struct list executes
;
2689 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2690 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2691 union flow_in_port in_port_
;
2694 in_port_
.ofp_port
= e
->in_port
;
2695 flow_extract(e
->packet
, 0, 0, NULL
, &in_port_
, &flow
);
2696 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
2698 rule_execute_destroy(e
);
2702 /* Destroys and discards all "rule_execute" operations queued up in
2703 * ofproto->rule_executes. */
2705 destroy_rule_executes(struct ofproto
*ofproto
)
2707 struct rule_execute
*e
, *next
;
2708 struct list executes
;
2710 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2711 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2712 ofpbuf_delete(e
->packet
);
2713 rule_execute_destroy(e
);
2717 /* Returns true if 'rule' should be hidden from the controller.
2719 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2720 * (e.g. by in-band control) and are intentionally hidden from the
2723 ofproto_rule_is_hidden(const struct rule
*rule
)
2725 return rule
->cr
.priority
> UINT16_MAX
;
2728 static enum oftable_flags
2729 rule_get_flags(const struct rule
*rule
)
2731 return rule
->ofproto
->tables
[rule
->table_id
].flags
;
2735 rule_is_modifiable(const struct rule
*rule
)
2737 return !(rule_get_flags(rule
) & OFTABLE_READONLY
);
2741 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2743 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
2748 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2750 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2751 struct ofputil_switch_features features
;
2752 struct ofport
*port
;
2758 ofproto
->ofproto_class
->get_features(ofproto
, &arp_match_ip
,
2760 ovs_assert(features
.actions
& OFPUTIL_A_OUTPUT
); /* sanity check */
2762 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2763 * if present, are always at the end.) */
2764 n_tables
= ofproto
->n_tables
;
2765 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2766 if (ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
) {
2772 features
.datapath_id
= ofproto
->datapath_id
;
2773 features
.n_buffers
= pktbuf_capacity();
2774 features
.n_tables
= n_tables
;
2775 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
2776 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
);
2778 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
2780 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2781 features
.auxiliary_id
= 0;
2782 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
2784 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
2785 ofputil_put_switch_features_port(&port
->pp
, b
);
2788 ofconn_send_reply(ofconn
, b
);
2793 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2795 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2796 struct ofp_switch_config
*osc
;
2797 enum ofp_config_flags flags
;
2801 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
2802 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
2803 flags
= ofproto
->frag_handling
;
2804 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2805 if (oh
->version
< OFP13_VERSION
2806 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
2807 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
2809 osc
->flags
= htons(flags
);
2810 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
2811 ofconn_send_reply(ofconn
, buf
);
2817 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2819 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
2820 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2821 uint16_t flags
= ntohs(osc
->flags
);
2823 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
2824 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
2825 enum ofp_config_flags cur
= ofproto
->frag_handling
;
2826 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
2828 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
2830 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
2831 ofproto
->frag_handling
= next
;
2833 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
2835 ofputil_frag_handling_to_string(next
));
2839 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2840 ofconn_set_invalid_ttl_to_controller(ofconn
,
2841 (oh
->version
< OFP13_VERSION
2842 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
2844 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
2849 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2850 * error message code for the caller to propagate upward. Otherwise, returns
2853 * The log message mentions 'msg_type'. */
2855 reject_slave_controller(struct ofconn
*ofconn
)
2857 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
2858 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
2859 return OFPERR_OFPBRC_EPERM
;
2865 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
2868 * - If they use a meter, then 'ofproto' has that meter configured.
2870 * - If they use any groups, then 'ofproto' has that group configured.
2872 * Returns 0 if successful, otherwise an OpenFlow error. */
2874 ofproto_check_ofpacts(struct ofproto
*ofproto
,
2875 const struct ofpact ofpacts
[], size_t ofpacts_len
)
2877 const struct ofpact
*a
;
2880 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
2881 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
2882 return OFPERR_OFPMMFC_INVALID_METER
;
2885 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
2886 if (a
->type
== OFPACT_GROUP
2887 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
2888 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
2896 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2898 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2899 struct ofputil_packet_out po
;
2900 struct ofpbuf
*payload
;
2901 uint64_t ofpacts_stub
[1024 / 8];
2902 struct ofpbuf ofpacts
;
2904 union flow_in_port in_port_
;
2907 COVERAGE_INC(ofproto_packet_out
);
2909 error
= reject_slave_controller(ofconn
);
2914 /* Decode message. */
2915 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
2916 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
2918 goto exit_free_ofpacts
;
2920 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
2921 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
2922 error
= OFPERR_OFPBRC_BAD_PORT
;
2923 goto exit_free_ofpacts
;
2927 if (po
.buffer_id
!= UINT32_MAX
) {
2928 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
2929 if (error
|| !payload
) {
2930 goto exit_free_ofpacts
;
2933 /* Ensure that the L3 header is 32-bit aligned. */
2934 payload
= ofpbuf_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
2937 /* Verify actions against packet, then send packet if successful. */
2938 in_port_
.ofp_port
= po
.in_port
;
2939 flow_extract(payload
, 0, 0, NULL
, &in_port_
, &flow
);
2940 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
2942 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
2943 po
.ofpacts
, po
.ofpacts_len
);
2945 ofpbuf_delete(payload
);
2948 ofpbuf_uninit(&ofpacts
);
2954 update_port_config(struct ofport
*port
,
2955 enum ofputil_port_config config
,
2956 enum ofputil_port_config mask
)
2958 enum ofputil_port_config old_config
= port
->pp
.config
;
2959 enum ofputil_port_config toggle
;
2961 toggle
= (config
^ port
->pp
.config
) & mask
;
2962 if (toggle
& OFPUTIL_PC_PORT_DOWN
) {
2963 if (config
& OFPUTIL_PC_PORT_DOWN
) {
2964 netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
);
2966 netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
);
2968 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
2971 port
->pp
.config
^= toggle
;
2972 if (port
->pp
.config
!= old_config
) {
2973 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
2978 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2980 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2981 struct ofputil_port_mod pm
;
2982 struct ofport
*port
;
2985 error
= reject_slave_controller(ofconn
);
2990 error
= ofputil_decode_port_mod(oh
, &pm
);
2995 port
= ofproto_get_port(p
, pm
.port_no
);
2997 return OFPERR_OFPPMFC_BAD_PORT
;
2998 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
2999 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3001 update_port_config(port
, pm
.config
, pm
.mask
);
3003 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
3010 handle_desc_stats_request(struct ofconn
*ofconn
,
3011 const struct ofp_header
*request
)
3013 static const char *default_mfr_desc
= "Nicira, Inc.";
3014 static const char *default_hw_desc
= "Open vSwitch";
3015 static const char *default_sw_desc
= VERSION
;
3016 static const char *default_serial_desc
= "None";
3017 static const char *default_dp_desc
= "None";
3019 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3020 struct ofp_desc_stats
*ods
;
3023 msg
= ofpraw_alloc_stats_reply(request
, 0);
3024 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3025 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3026 sizeof ods
->mfr_desc
);
3027 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3028 sizeof ods
->hw_desc
);
3029 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3030 sizeof ods
->sw_desc
);
3031 ovs_strlcpy(ods
->serial_num
,
3032 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3033 sizeof ods
->serial_num
);
3034 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3035 sizeof ods
->dp_desc
);
3036 ofconn_send_reply(ofconn
, msg
);
3042 handle_table_stats_request(struct ofconn
*ofconn
,
3043 const struct ofp_header
*request
)
3045 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3046 struct ofp12_table_stats
*ots
;
3051 /* Set up default values.
3053 * ofp12_table_stats is used as a generic structure as
3054 * it is able to hold all the fields for ofp10_table_stats
3055 * and ofp11_table_stats (and of course itself).
3057 ots
= xcalloc(p
->n_tables
, sizeof *ots
);
3058 for (i
= 0; i
< p
->n_tables
; i
++) {
3059 ots
[i
].table_id
= i
;
3060 sprintf(ots
[i
].name
, "table%"PRIuSIZE
, i
);
3061 ots
[i
].match
= htonll(OFPXMT13_MASK
);
3062 ots
[i
].wildcards
= htonll(OFPXMT13_MASK
);
3063 ots
[i
].write_actions
= htonl(OFPAT11_OUTPUT
);
3064 ots
[i
].apply_actions
= htonl(OFPAT11_OUTPUT
);
3065 ots
[i
].write_setfields
= htonll(OFPXMT13_MASK
);
3066 ots
[i
].apply_setfields
= htonll(OFPXMT13_MASK
);
3067 ots
[i
].metadata_match
= OVS_BE64_MAX
;
3068 ots
[i
].metadata_write
= OVS_BE64_MAX
;
3069 ots
[i
].instructions
= htonl(OFPIT11_ALL
);
3070 ots
[i
].config
= htonl(OFPTC11_TABLE_MISS_MASK
);
3071 ots
[i
].max_entries
= htonl(1000000); /* An arbitrary big number. */
3072 ovs_rwlock_rdlock(&p
->tables
[i
].cls
.rwlock
);
3073 ots
[i
].active_count
= htonl(classifier_count(&p
->tables
[i
].cls
));
3074 ovs_rwlock_unlock(&p
->tables
[i
].cls
.rwlock
);
3077 p
->ofproto_class
->get_tables(p
, ots
);
3079 /* Post-process the tables, dropping hidden tables. */
3080 n_tables
= p
->n_tables
;
3081 for (i
= 0; i
< p
->n_tables
; i
++) {
3082 const struct oftable
*table
= &p
->tables
[i
];
3084 if (table
->flags
& OFTABLE_HIDDEN
) {
3090 ovs_strzcpy(ots
[i
].name
, table
->name
, sizeof ots
[i
].name
);
3093 if (table
->max_flows
< ntohl(ots
[i
].max_entries
)) {
3094 ots
[i
].max_entries
= htonl(table
->max_flows
);
3098 msg
= ofputil_encode_table_stats_reply(ots
, n_tables
, request
);
3099 ofconn_send_reply(ofconn
, msg
);
3107 append_port_stat(struct ofport
*port
, struct list
*replies
)
3109 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3111 calc_duration(port
->created
, time_msec(),
3112 &ops
.duration_sec
, &ops
.duration_nsec
);
3114 /* Intentionally ignore return value, since errors will set
3115 * 'stats' to all-1s, which is correct for OpenFlow, and
3116 * netdev_get_stats() will log errors. */
3117 ofproto_port_get_stats(port
, &ops
.stats
);
3119 ofputil_append_port_stat(replies
, &ops
);
3123 handle_port_stats_request(struct ofconn
*ofconn
,
3124 const struct ofp_header
*request
)
3126 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3127 struct ofport
*port
;
3128 struct list replies
;
3132 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3137 ofpmp_init(&replies
, request
);
3138 if (port_no
!= OFPP_ANY
) {
3139 port
= ofproto_get_port(p
, port_no
);
3141 append_port_stat(port
, &replies
);
3144 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
3145 append_port_stat(port
, &replies
);
3149 ofconn_send_replies(ofconn
, &replies
);
3154 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3155 const struct ofp_header
*request
)
3157 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3158 enum ofp_version version
;
3159 struct ofport
*port
;
3160 struct list replies
;
3162 ofpmp_init(&replies
, request
);
3164 version
= ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn
));
3165 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
3166 ofputil_append_port_desc_stats_reply(version
, &port
->pp
, &replies
);
3169 ofconn_send_replies(ofconn
, &replies
);
3174 hash_cookie(ovs_be64 cookie
)
3176 return hash_2words((OVS_FORCE
uint64_t)cookie
>> 32,
3177 (OVS_FORCE
uint64_t)cookie
);
3181 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3182 OVS_REQUIRES(ofproto_mutex
)
3184 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3185 hash_cookie(rule
->flow_cookie
));
3189 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3190 OVS_REQUIRES(ofproto_mutex
)
3192 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3196 ofproto_rule_change_cookie(struct ofproto
*ofproto
, struct rule
*rule
,
3197 ovs_be64 new_cookie
)
3198 OVS_REQUIRES(ofproto_mutex
)
3200 if (new_cookie
!= rule
->flow_cookie
) {
3201 cookies_remove(ofproto
, rule
);
3203 ovs_mutex_lock(&rule
->mutex
);
3204 rule
->flow_cookie
= new_cookie
;
3205 ovs_mutex_unlock(&rule
->mutex
);
3207 cookies_insert(ofproto
, rule
);
3212 calc_duration(long long int start
, long long int now
,
3213 uint32_t *sec
, uint32_t *nsec
)
3215 long long int msecs
= now
- start
;
3216 *sec
= msecs
/ 1000;
3217 *nsec
= (msecs
% 1000) * (1000 * 1000);
3220 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3221 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
3223 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3225 return (table_id
== 0xff || table_id
< ofproto
->n_tables
3227 : OFPERR_OFPBRC_BAD_TABLE_ID
);
3231 static struct oftable
*
3232 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3234 struct oftable
*table
;
3236 for (table
= &ofproto
->tables
[table_id
];
3237 table
< &ofproto
->tables
[ofproto
->n_tables
];
3239 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3247 static struct oftable
*
3248 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3250 if (table_id
== 0xff) {
3251 return next_visible_table(ofproto
, 0);
3252 } else if (table_id
< ofproto
->n_tables
) {
3253 return &ofproto
->tables
[table_id
];
3259 static struct oftable
*
3260 next_matching_table(const struct ofproto
*ofproto
,
3261 const struct oftable
*table
, uint8_t table_id
)
3263 return (table_id
== 0xff
3264 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3268 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3270 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3271 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3273 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3274 * only once, for that table. (This can be used to access tables marked
3277 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3278 * entered at all. (Perhaps you should have validated TABLE_ID with
3279 * check_table_id().)
3281 * All parameters are evaluated multiple times.
3283 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3284 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3286 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3288 /* Initializes 'criteria' in a straightforward way based on the other
3291 * For "loose" matching, the 'priority' parameter is unimportant and may be
3294 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3295 const struct match
*match
, unsigned int priority
,
3296 ovs_be64 cookie
, ovs_be64 cookie_mask
,
3297 ofp_port_t out_port
, uint32_t out_group
)
3299 criteria
->table_id
= table_id
;
3300 cls_rule_init(&criteria
->cr
, match
, priority
);
3301 criteria
->cookie
= cookie
;
3302 criteria
->cookie_mask
= cookie_mask
;
3303 criteria
->out_port
= out_port
;
3304 criteria
->out_group
= out_group
;
3308 rule_criteria_destroy(struct rule_criteria
*criteria
)
3310 cls_rule_destroy(&criteria
->cr
);
3314 rule_collection_init(struct rule_collection
*rules
)
3316 rules
->rules
= rules
->stub
;
3318 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
3322 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
3324 if (rules
->n
>= rules
->capacity
) {
3325 size_t old_size
, new_size
;
3327 old_size
= rules
->capacity
* sizeof *rules
->rules
;
3328 rules
->capacity
*= 2;
3329 new_size
= rules
->capacity
* sizeof *rules
->rules
;
3331 if (rules
->rules
== rules
->stub
) {
3332 rules
->rules
= xmalloc(new_size
);
3333 memcpy(rules
->rules
, rules
->stub
, old_size
);
3335 rules
->rules
= xrealloc(rules
->rules
, new_size
);
3339 rules
->rules
[rules
->n
++] = rule
;
3343 rule_collection_ref(struct rule_collection
*rules
)
3344 OVS_REQUIRES(ofproto_mutex
)
3348 for (i
= 0; i
< rules
->n
; i
++) {
3349 ofproto_rule_ref(rules
->rules
[i
]);
3354 rule_collection_unref(struct rule_collection
*rules
)
3358 for (i
= 0; i
< rules
->n
; i
++) {
3359 ofproto_rule_unref(rules
->rules
[i
]);
3364 rule_collection_destroy(struct rule_collection
*rules
)
3366 if (rules
->rules
!= rules
->stub
) {
3372 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
3373 struct rule_collection
*rules
)
3374 OVS_REQUIRES(ofproto_mutex
)
3376 /* We ordinarily want to skip hidden rules, but there has to be a way for
3377 * code internal to OVS to modify and delete them, so if the criteria
3378 * specify a priority that can only be for a hidden flow, then allow hidden
3379 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3380 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3382 if (ofproto_rule_is_hidden(rule
) && c
->cr
.priority
<= UINT16_MAX
) {
3384 } else if (rule
->pending
) {
3385 return OFPROTO_POSTPONE
;
3387 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
3388 && ofproto_rule_has_out_port(rule
, c
->out_port
)
3389 && ofproto_rule_has_out_group(rule
, c
->out_group
)
3390 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)) {
3391 rule_collection_add(rules
, rule
);
3397 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3398 * on classifiers rules are done in the "loose" way required for OpenFlow
3399 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3402 * Hidden rules are always omitted.
3404 * Returns 0 on success, otherwise an OpenFlow error code. */
3406 collect_rules_loose(struct ofproto
*ofproto
,
3407 const struct rule_criteria
*criteria
,
3408 struct rule_collection
*rules
)
3409 OVS_REQUIRES(ofproto_mutex
)
3411 struct oftable
*table
;
3414 rule_collection_init(rules
);
3416 error
= check_table_id(ofproto
, criteria
->table_id
);
3421 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3424 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3425 hash_cookie(criteria
->cookie
),
3426 &ofproto
->cookies
) {
3427 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
3428 error
= collect_rule(rule
, criteria
, rules
);
3435 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3436 struct cls_cursor cursor
;
3439 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
3440 cls_cursor_init(&cursor
, &table
->cls
, &criteria
->cr
);
3441 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
3442 error
= collect_rule(rule
, criteria
, rules
);
3447 ovs_rwlock_unlock(&table
->cls
.rwlock
);
3453 rule_collection_destroy(rules
);
3458 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3459 * on classifiers rules are done in the "strict" way required for OpenFlow
3460 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3461 * rules on list 'rules'.
3463 * Hidden rules are always omitted.
3465 * Returns 0 on success, otherwise an OpenFlow error code. */
3467 collect_rules_strict(struct ofproto
*ofproto
,
3468 const struct rule_criteria
*criteria
,
3469 struct rule_collection
*rules
)
3470 OVS_REQUIRES(ofproto_mutex
)
3472 struct oftable
*table
;
3475 rule_collection_init(rules
);
3477 error
= check_table_id(ofproto
, criteria
->table_id
);
3482 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3485 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3486 hash_cookie(criteria
->cookie
),
3487 &ofproto
->cookies
) {
3488 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
3489 error
= collect_rule(rule
, criteria
, rules
);
3496 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3499 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
3500 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
3501 &table
->cls
, &criteria
->cr
));
3502 ovs_rwlock_unlock(&table
->cls
.rwlock
);
3504 error
= collect_rule(rule
, criteria
, rules
);
3514 rule_collection_destroy(rules
);
3519 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3520 * forced into the range of a uint16_t. */
3522 age_secs(long long int age_ms
)
3524 return (age_ms
< 0 ? 0
3525 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
3526 : (unsigned int) age_ms
/ 1000);
3530 handle_flow_stats_request(struct ofconn
*ofconn
,
3531 const struct ofp_header
*request
)
3532 OVS_EXCLUDED(ofproto_mutex
)
3534 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3535 struct ofputil_flow_stats_request fsr
;
3536 struct rule_criteria criteria
;
3537 struct rule_collection rules
;
3538 struct list replies
;
3542 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
3547 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, fsr
.cookie
,
3548 fsr
.cookie_mask
, fsr
.out_port
, fsr
.out_group
);
3550 ovs_mutex_lock(&ofproto_mutex
);
3551 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3552 rule_criteria_destroy(&criteria
);
3554 rule_collection_ref(&rules
);
3556 ovs_mutex_unlock(&ofproto_mutex
);
3562 ofpmp_init(&replies
, request
);
3563 for (i
= 0; i
< rules
.n
; i
++) {
3564 struct rule
*rule
= rules
.rules
[i
];
3565 long long int now
= time_msec();
3566 struct ofputil_flow_stats fs
;
3567 long long int created
, used
, modified
;
3568 struct rule_actions
*actions
;
3569 enum ofputil_flow_mod_flags flags
;
3571 ovs_mutex_lock(&rule
->mutex
);
3572 fs
.cookie
= rule
->flow_cookie
;
3573 fs
.idle_timeout
= rule
->idle_timeout
;
3574 fs
.hard_timeout
= rule
->hard_timeout
;
3575 created
= rule
->created
;
3577 modified
= rule
->modified
;
3578 actions
= rule_get_actions__(rule
);
3579 flags
= rule
->flags
;
3580 ovs_mutex_unlock(&rule
->mutex
);
3582 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
3583 fs
.table_id
= rule
->table_id
;
3584 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
3585 fs
.priority
= rule
->cr
.priority
;
3586 fs
.idle_age
= age_secs(now
- used
);
3587 fs
.hard_age
= age_secs(now
- modified
);
3588 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
3590 fs
.ofpacts
= actions
->ofpacts
;
3591 fs
.ofpacts_len
= actions
->ofpacts_len
;
3594 ofputil_append_flow_stats_reply(&fs
, &replies
);
3596 rule_actions_unref(actions
);
3599 rule_collection_unref(&rules
);
3600 rule_collection_destroy(&rules
);
3602 ofconn_send_replies(ofconn
, &replies
);
3608 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
3610 uint64_t packet_count
, byte_count
;
3611 struct rule_actions
*actions
;
3612 long long int created
;
3614 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
,
3615 &packet_count
, &byte_count
);
3617 ovs_mutex_lock(&rule
->mutex
);
3618 actions
= rule_get_actions__(rule
);
3619 created
= rule
->created
;
3620 ovs_mutex_unlock(&rule
->mutex
);
3622 if (rule
->table_id
!= 0) {
3623 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
3625 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
3626 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
3627 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
3628 cls_rule_format(&rule
->cr
, results
);
3629 ds_put_char(results
, ',');
3631 ds_put_cstr(results
, "actions=");
3632 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
3634 ds_put_cstr(results
, "\n");
3636 rule_actions_unref(actions
);
3639 /* Adds a pretty-printed description of all flows to 'results', including
3640 * hidden flows (e.g., set up by in-band control). */
3642 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
3644 struct oftable
*table
;
3646 OFPROTO_FOR_EACH_TABLE (table
, p
) {
3647 struct cls_cursor cursor
;
3650 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
3651 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
3652 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
3653 flow_stats_ds(rule
, results
);
3655 ovs_rwlock_unlock(&table
->cls
.rwlock
);
3659 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3660 * '*engine_type' and '*engine_id', respectively. */
3662 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
3663 uint8_t *engine_type
, uint8_t *engine_id
)
3665 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
3668 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3669 * true if the port's CFM status was successfully stored into '*status'.
3670 * Returns false if the port did not have CFM configured, in which case
3671 * '*status' is indeterminate.
3673 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3675 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
3676 struct ofproto_cfm_status
*status
)
3678 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3680 && ofproto
->ofproto_class
->get_cfm_status
3681 && ofproto
->ofproto_class
->get_cfm_status(ofport
, status
));
3685 handle_aggregate_stats_request(struct ofconn
*ofconn
,
3686 const struct ofp_header
*oh
)
3687 OVS_EXCLUDED(ofproto_mutex
)
3689 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3690 struct ofputil_flow_stats_request request
;
3691 struct ofputil_aggregate_stats stats
;
3692 bool unknown_packets
, unknown_bytes
;
3693 struct rule_criteria criteria
;
3694 struct rule_collection rules
;
3695 struct ofpbuf
*reply
;
3699 error
= ofputil_decode_flow_stats_request(&request
, oh
);
3704 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
3705 request
.cookie
, request
.cookie_mask
,
3706 request
.out_port
, request
.out_group
);
3708 ovs_mutex_lock(&ofproto_mutex
);
3709 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3710 rule_criteria_destroy(&criteria
);
3712 rule_collection_ref(&rules
);
3714 ovs_mutex_unlock(&ofproto_mutex
);
3720 memset(&stats
, 0, sizeof stats
);
3721 unknown_packets
= unknown_bytes
= false;
3722 for (i
= 0; i
< rules
.n
; i
++) {
3723 struct rule
*rule
= rules
.rules
[i
];
3724 uint64_t packet_count
;
3725 uint64_t byte_count
;
3727 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3730 if (packet_count
== UINT64_MAX
) {
3731 unknown_packets
= true;
3733 stats
.packet_count
+= packet_count
;
3736 if (byte_count
== UINT64_MAX
) {
3737 unknown_bytes
= true;
3739 stats
.byte_count
+= byte_count
;
3744 if (unknown_packets
) {
3745 stats
.packet_count
= UINT64_MAX
;
3747 if (unknown_bytes
) {
3748 stats
.byte_count
= UINT64_MAX
;
3751 rule_collection_unref(&rules
);
3752 rule_collection_destroy(&rules
);
3754 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
3755 ofconn_send_reply(ofconn
, reply
);
3760 struct queue_stats_cbdata
{
3761 struct ofport
*ofport
;
3762 struct list replies
;
3767 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
3768 const struct netdev_queue_stats
*stats
)
3770 struct ofputil_queue_stats oqs
;
3772 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
3773 oqs
.queue_id
= queue_id
;
3774 oqs
.tx_bytes
= stats
->tx_bytes
;
3775 oqs
.tx_packets
= stats
->tx_packets
;
3776 oqs
.tx_errors
= stats
->tx_errors
;
3777 if (stats
->created
!= LLONG_MIN
) {
3778 calc_duration(stats
->created
, cbdata
->now
,
3779 &oqs
.duration_sec
, &oqs
.duration_nsec
);
3781 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
3783 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
3787 handle_queue_stats_dump_cb(uint32_t queue_id
,
3788 struct netdev_queue_stats
*stats
,
3791 struct queue_stats_cbdata
*cbdata
= cbdata_
;
3793 put_queue_stats(cbdata
, queue_id
, stats
);
3797 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
3798 struct queue_stats_cbdata
*cbdata
)
3800 cbdata
->ofport
= port
;
3801 if (queue_id
== OFPQ_ALL
) {
3802 netdev_dump_queue_stats(port
->netdev
,
3803 handle_queue_stats_dump_cb
, cbdata
);
3805 struct netdev_queue_stats stats
;
3807 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
3808 put_queue_stats(cbdata
, queue_id
, &stats
);
3810 return OFPERR_OFPQOFC_BAD_QUEUE
;
3817 handle_queue_stats_request(struct ofconn
*ofconn
,
3818 const struct ofp_header
*rq
)
3820 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3821 struct queue_stats_cbdata cbdata
;
3822 struct ofport
*port
;
3824 struct ofputil_queue_stats_request oqsr
;
3826 COVERAGE_INC(ofproto_queue_req
);
3828 ofpmp_init(&cbdata
.replies
, rq
);
3829 cbdata
.now
= time_msec();
3831 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
3836 if (oqsr
.port_no
== OFPP_ANY
) {
3837 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
3838 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3839 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
3844 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
3846 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
3847 : OFPERR_OFPQOFC_BAD_PORT
);
3850 ofconn_send_replies(ofconn
, &cbdata
.replies
);
3852 ofpbuf_list_delete(&cbdata
.replies
);
3859 is_flow_deletion_pending(const struct ofproto
*ofproto
,
3860 const struct cls_rule
*cls_rule
,
3862 OVS_REQUIRES(ofproto_mutex
)
3864 if (!hmap_is_empty(&ofproto
->deletions
)) {
3865 struct ofoperation
*op
;
3867 HMAP_FOR_EACH_WITH_HASH (op
, hmap_node
,
3868 cls_rule_hash(cls_rule
, table_id
),
3869 &ofproto
->deletions
) {
3870 if (cls_rule_equal(cls_rule
, &op
->rule
->cr
)) {
3880 should_evict_a_rule(struct oftable
*table
, unsigned int extra_space
)
3881 OVS_REQUIRES(ofproto_mutex
)
3882 OVS_NO_THREAD_SAFETY_ANALYSIS
3884 return classifier_count(&table
->cls
) + extra_space
> table
->max_flows
;
3888 evict_rules_from_table(struct ofproto
*ofproto
, struct oftable
*table
,
3889 unsigned int extra_space
)
3890 OVS_REQUIRES(ofproto_mutex
)
3892 while (should_evict_a_rule(table
, extra_space
)) {
3895 if (!choose_rule_to_evict(table
, &rule
)) {
3896 return OFPERR_OFPFMFC_TABLE_FULL
;
3897 } else if (rule
->pending
) {
3898 return OFPROTO_POSTPONE
;
3900 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
3901 delete_flow__(rule
, group
, OFPRR_EVICTION
);
3902 ofopgroup_submit(group
);
3909 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3910 * in which no matching flow already exists in the flow table.
3912 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3913 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3914 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3915 * initiated now but may be retried later.
3917 * The caller retains ownership of 'fm->ofpacts'.
3919 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3922 add_flow(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3923 struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
)
3924 OVS_REQUIRES(ofproto_mutex
)
3926 struct oftable
*table
;
3927 struct ofopgroup
*group
;
3933 error
= check_table_id(ofproto
, fm
->table_id
);
3939 if (fm
->table_id
== 0xff) {
3940 if (ofproto
->ofproto_class
->rule_choose_table
) {
3941 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
3947 ovs_assert(table_id
< ofproto
->n_tables
);
3951 } else if (fm
->table_id
< ofproto
->n_tables
) {
3952 table_id
= fm
->table_id
;
3954 return OFPERR_OFPBRC_BAD_TABLE_ID
;
3957 table
= &ofproto
->tables
[table_id
];
3959 if (table
->flags
& OFTABLE_READONLY
) {
3960 return OFPERR_OFPBRC_EPERM
;
3963 cls_rule_init(&cr
, &fm
->match
, fm
->priority
);
3965 /* Transform "add" into "modify" if there's an existing identical flow. */
3966 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
3967 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
));
3968 ovs_rwlock_unlock(&table
->cls
.rwlock
);
3970 cls_rule_destroy(&cr
);
3971 if (!rule_is_modifiable(rule
)) {
3972 return OFPERR_OFPBRC_EPERM
;
3973 } else if (rule
->pending
) {
3974 return OFPROTO_POSTPONE
;
3976 struct rule_collection rules
;
3978 rule_collection_init(&rules
);
3979 rule_collection_add(&rules
, rule
);
3980 fm
->modify_cookie
= true;
3981 error
= modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
);
3982 rule_collection_destroy(&rules
);
3988 /* Serialize against pending deletion. */
3989 if (is_flow_deletion_pending(ofproto
, &cr
, table_id
)) {
3990 cls_rule_destroy(&cr
);
3991 return OFPROTO_POSTPONE
;
3994 /* Check for overlap, if requested. */
3995 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
) {
3998 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
3999 overlaps
= classifier_rule_overlaps(&table
->cls
, &cr
);
4000 ovs_rwlock_unlock(&table
->cls
.rwlock
);
4003 cls_rule_destroy(&cr
);
4004 return OFPERR_OFPFMFC_OVERLAP
;
4008 /* If necessary, evict an existing rule to clear out space. */
4009 error
= evict_rules_from_table(ofproto
, table
, 1);
4011 cls_rule_destroy(&cr
);
4015 /* Allocate new rule. */
4016 rule
= ofproto
->ofproto_class
->rule_alloc();
4018 cls_rule_destroy(&cr
);
4019 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
4020 ofproto
->name
, ovs_strerror(error
));
4024 /* Initialize base state. */
4025 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4026 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), &cr
);
4027 atomic_init(&rule
->ref_count
, 1);
4028 rule
->pending
= NULL
;
4029 rule
->flow_cookie
= fm
->new_cookie
;
4030 rule
->created
= rule
->modified
= rule
->used
= time_msec();
4032 ovs_mutex_init(&rule
->mutex
);
4033 ovs_mutex_lock(&rule
->mutex
);
4034 rule
->idle_timeout
= fm
->idle_timeout
;
4035 rule
->hard_timeout
= fm
->hard_timeout
;
4036 ovs_mutex_unlock(&rule
->mutex
);
4038 *CONST_CAST(uint8_t *, &rule
->table_id
) = table
- ofproto
->tables
;
4039 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4040 rule
->actions
= rule_actions_create(ofproto
, fm
->ofpacts
, fm
->ofpacts_len
);
4041 list_init(&rule
->meter_list_node
);
4042 rule
->eviction_group
= NULL
;
4043 list_init(&rule
->expirable
);
4044 rule
->monitor_flags
= 0;
4045 rule
->add_seqno
= 0;
4046 rule
->modify_seqno
= 0;
4048 /* Construct rule, initializing derived state. */
4049 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4051 ofproto_rule_destroy__(rule
);
4056 oftable_insert_rule(rule
);
4058 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
4059 ofoperation_create(group
, rule
, OFOPERATION_ADD
, 0);
4060 ofproto
->ofproto_class
->rule_insert(rule
);
4061 ofopgroup_submit(group
);
4066 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4068 /* Modifies the rules listed in 'rules', changing their actions to match those
4071 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4074 * Returns 0 on success, otherwise an OpenFlow error code. */
4076 modify_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4077 struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
,
4078 const struct rule_collection
*rules
)
4079 OVS_REQUIRES(ofproto_mutex
)
4081 enum ofoperation_type type
;
4082 struct ofopgroup
*group
;
4086 type
= fm
->command
== OFPFC_ADD
? OFOPERATION_REPLACE
: OFOPERATION_MODIFY
;
4087 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
4088 error
= OFPERR_OFPBRC_EPERM
;
4089 for (i
= 0; i
< rules
->n
; i
++) {
4090 struct rule
*rule
= rules
->rules
[i
];
4091 struct ofoperation
*op
;
4092 bool actions_changed
;
4093 bool reset_counters
;
4095 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4097 if (rule_is_modifiable(rule
)) {
4098 /* At least one rule is modifiable, don't report EPERM error. */
4104 actions_changed
= !ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
4105 rule
->actions
->ofpacts
,
4106 rule
->actions
->ofpacts_len
);
4108 op
= ofoperation_create(group
, rule
, type
, 0);
4110 if (fm
->modify_cookie
&& fm
->new_cookie
!= OVS_BE64_MAX
) {
4111 ofproto_rule_change_cookie(ofproto
, rule
, fm
->new_cookie
);
4113 if (type
== OFOPERATION_REPLACE
) {
4114 ovs_mutex_lock(&rule
->mutex
);
4115 rule
->idle_timeout
= fm
->idle_timeout
;
4116 rule
->hard_timeout
= fm
->hard_timeout
;
4117 ovs_mutex_unlock(&rule
->mutex
);
4119 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4120 if (fm
->idle_timeout
|| fm
->hard_timeout
) {
4121 if (!rule
->eviction_group
) {
4122 eviction_group_add_rule(rule
);
4125 eviction_group_remove_rule(rule
);
4129 reset_counters
= (fm
->flags
& OFPUTIL_FF_RESET_COUNTS
) != 0;
4130 if (actions_changed
|| reset_counters
) {
4131 struct rule_actions
*new_actions
;
4133 op
->actions
= rule
->actions
;
4134 new_actions
= rule_actions_create(ofproto
,
4135 fm
->ofpacts
, fm
->ofpacts_len
);
4137 ovs_mutex_lock(&rule
->mutex
);
4138 rule
->actions
= new_actions
;
4139 ovs_mutex_unlock(&rule
->mutex
);
4141 rule
->ofproto
->ofproto_class
->rule_modify_actions(rule
,
4144 ofoperation_complete(op
, 0);
4147 ofopgroup_submit(group
);
4153 modify_flows_add(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4154 struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
)
4155 OVS_REQUIRES(ofproto_mutex
)
4157 if (fm
->cookie_mask
!= htonll(0) || fm
->new_cookie
== OVS_BE64_MAX
) {
4160 return add_flow(ofproto
, ofconn
, fm
, request
);
4163 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4166 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4169 modify_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4170 struct ofputil_flow_mod
*fm
,
4171 const struct ofp_header
*request
)
4172 OVS_REQUIRES(ofproto_mutex
)
4174 struct rule_criteria criteria
;
4175 struct rule_collection rules
;
4178 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4179 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4180 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4181 rule_criteria_destroy(&criteria
);
4184 error
= (rules
.n
> 0
4185 ? modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
)
4186 : modify_flows_add(ofproto
, ofconn
, fm
, request
));
4189 rule_collection_destroy(&rules
);
4194 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4197 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4200 modify_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4201 struct ofputil_flow_mod
*fm
,
4202 const struct ofp_header
*request
)
4203 OVS_REQUIRES(ofproto_mutex
)
4205 struct rule_criteria criteria
;
4206 struct rule_collection rules
;
4209 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4210 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4211 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4212 rule_criteria_destroy(&criteria
);
4216 error
= modify_flows_add(ofproto
, ofconn
, fm
, request
);
4217 } else if (rules
.n
== 1) {
4218 error
= modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
);
4222 rule_collection_destroy(&rules
);
4227 /* OFPFC_DELETE implementation. */
4230 delete_flow__(struct rule
*rule
, struct ofopgroup
*group
,
4231 enum ofp_flow_removed_reason reason
)
4232 OVS_REQUIRES(ofproto_mutex
)
4234 struct ofproto
*ofproto
= rule
->ofproto
;
4236 ofproto_rule_send_removed(rule
, reason
);
4238 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, reason
);
4239 oftable_remove_rule(rule
);
4240 ofproto
->ofproto_class
->rule_delete(rule
);
4243 /* Deletes the rules listed in 'rules'.
4245 * Returns 0 on success, otherwise an OpenFlow error code. */
4247 delete_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4248 const struct ofp_header
*request
,
4249 const struct rule_collection
*rules
,
4250 enum ofp_flow_removed_reason reason
)
4251 OVS_REQUIRES(ofproto_mutex
)
4253 struct ofopgroup
*group
;
4256 group
= ofopgroup_create(ofproto
, ofconn
, request
, UINT32_MAX
);
4257 for (i
= 0; i
< rules
->n
; i
++) {
4258 delete_flow__(rules
->rules
[i
], group
, reason
);
4260 ofopgroup_submit(group
);
4265 /* Implements OFPFC_DELETE. */
4267 delete_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4268 const struct ofputil_flow_mod
*fm
,
4269 const struct ofp_header
*request
)
4270 OVS_REQUIRES(ofproto_mutex
)
4272 struct rule_criteria criteria
;
4273 struct rule_collection rules
;
4276 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4277 fm
->cookie
, fm
->cookie_mask
,
4278 fm
->out_port
, fm
->out_group
);
4279 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4280 rule_criteria_destroy(&criteria
);
4282 if (!error
&& rules
.n
> 0) {
4283 error
= delete_flows__(ofproto
, ofconn
, request
, &rules
, OFPRR_DELETE
);
4285 rule_collection_destroy(&rules
);
4290 /* Implements OFPFC_DELETE_STRICT. */
4292 delete_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4293 const struct ofputil_flow_mod
*fm
,
4294 const struct ofp_header
*request
)
4295 OVS_REQUIRES(ofproto_mutex
)
4297 struct rule_criteria criteria
;
4298 struct rule_collection rules
;
4301 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4302 fm
->cookie
, fm
->cookie_mask
,
4303 fm
->out_port
, fm
->out_group
);
4304 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4305 rule_criteria_destroy(&criteria
);
4307 if (!error
&& rules
.n
> 0) {
4308 error
= delete_flows__(ofproto
, ofconn
, request
, &rules
, OFPRR_DELETE
);
4310 rule_collection_destroy(&rules
);
4316 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
4317 OVS_REQUIRES(ofproto_mutex
)
4319 struct ofputil_flow_removed fr
;
4321 if (ofproto_rule_is_hidden(rule
) ||
4322 !(rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
)) {
4326 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
4327 fr
.priority
= rule
->cr
.priority
;
4328 fr
.cookie
= rule
->flow_cookie
;
4330 fr
.table_id
= rule
->table_id
;
4331 calc_duration(rule
->created
, time_msec(),
4332 &fr
.duration_sec
, &fr
.duration_nsec
);
4333 ovs_mutex_lock(&rule
->mutex
);
4334 fr
.idle_timeout
= rule
->idle_timeout
;
4335 fr
.hard_timeout
= rule
->hard_timeout
;
4336 ovs_mutex_unlock(&rule
->mutex
);
4337 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
4340 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
4343 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4344 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4347 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4350 * ofproto implementation ->run() functions should use this function to expire
4351 * OpenFlow flows. */
4353 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
4354 OVS_REQUIRES(ofproto_mutex
)
4356 struct ofproto
*ofproto
= rule
->ofproto
;
4358 ovs_assert(reason
== OFPRR_HARD_TIMEOUT
|| reason
== OFPRR_IDLE_TIMEOUT
4359 || reason
== OFPRR_DELETE
|| reason
== OFPRR_GROUP_DELETE
);
4361 ofproto_rule_delete__(ofproto
, rule
, reason
);
4364 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4365 * means "infinite". */
4367 reduce_timeout(uint16_t max
, uint16_t *timeout
)
4369 if (max
&& (!*timeout
|| *timeout
> max
)) {
4374 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4375 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4376 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4378 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4380 ofproto_rule_reduce_timeouts(struct rule
*rule
,
4381 uint16_t idle_timeout
, uint16_t hard_timeout
)
4382 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
4384 if (!idle_timeout
&& !hard_timeout
) {
4388 ovs_mutex_lock(&ofproto_mutex
);
4389 if (list_is_empty(&rule
->expirable
)) {
4390 list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
4392 ovs_mutex_unlock(&ofproto_mutex
);
4394 ovs_mutex_lock(&rule
->mutex
);
4395 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
4396 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
4397 ovs_mutex_unlock(&rule
->mutex
);
4401 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4402 OVS_EXCLUDED(ofproto_mutex
)
4404 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4405 struct ofputil_flow_mod fm
;
4406 uint64_t ofpacts_stub
[1024 / 8];
4407 struct ofpbuf ofpacts
;
4411 error
= reject_slave_controller(ofconn
);
4416 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
4417 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
4419 u16_to_ofp(ofproto
->max_ports
),
4422 error
= ofproto_check_ofpacts(ofproto
, fm
.ofpacts
, fm
.ofpacts_len
);
4425 error
= handle_flow_mod__(ofproto
, ofconn
, &fm
, oh
);
4428 goto exit_free_ofpacts
;
4431 /* Record the operation for logging a summary report. */
4432 switch (fm
.command
) {
4438 case OFPFC_MODIFY_STRICT
:
4439 ofproto
->n_modify
++;
4443 case OFPFC_DELETE_STRICT
:
4444 ofproto
->n_delete
++;
4449 if (ofproto
->next_op_report
== LLONG_MAX
) {
4450 ofproto
->first_op
= now
;
4451 ofproto
->next_op_report
= MAX(now
+ 10 * 1000,
4452 ofproto
->op_backoff
);
4453 ofproto
->op_backoff
= ofproto
->next_op_report
+ 60 * 1000;
4455 ofproto
->last_op
= now
;
4458 ofpbuf_uninit(&ofpacts
);
4464 handle_flow_mod__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4465 struct ofputil_flow_mod
*fm
, const struct ofp_header
*oh
)
4466 OVS_EXCLUDED(ofproto_mutex
)
4470 ovs_mutex_lock(&ofproto_mutex
);
4471 if (ofproto
->n_pending
< 50) {
4472 switch (fm
->command
) {
4474 error
= add_flow(ofproto
, ofconn
, fm
, oh
);
4478 error
= modify_flows_loose(ofproto
, ofconn
, fm
, oh
);
4481 case OFPFC_MODIFY_STRICT
:
4482 error
= modify_flow_strict(ofproto
, ofconn
, fm
, oh
);
4486 error
= delete_flows_loose(ofproto
, ofconn
, fm
, oh
);
4489 case OFPFC_DELETE_STRICT
:
4490 error
= delete_flow_strict(ofproto
, ofconn
, fm
, oh
);
4494 if (fm
->command
> 0xff) {
4495 VLOG_WARN_RL(&rl
, "%s: flow_mod has explicit table_id but "
4496 "flow_mod_table_id extension is not enabled",
4499 error
= OFPERR_OFPFMFC_BAD_COMMAND
;
4503 ovs_assert(!list_is_empty(&ofproto
->pending
));
4504 error
= OFPROTO_POSTPONE
;
4506 ovs_mutex_unlock(&ofproto_mutex
);
4508 run_rule_executes(ofproto
);
4513 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4515 struct ofputil_role_request request
;
4516 struct ofputil_role_request reply
;
4520 error
= ofputil_decode_role_message(oh
, &request
);
4525 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
4526 if (ofconn_get_role(ofconn
) != request
.role
4527 && ofconn_has_pending_opgroups(ofconn
)) {
4528 return OFPROTO_POSTPONE
;
4531 if (request
.have_generation_id
4532 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
4533 return OFPERR_OFPRRFC_STALE
;
4536 ofconn_set_role(ofconn
, request
.role
);
4539 reply
.role
= ofconn_get_role(ofconn
);
4540 reply
.have_generation_id
= ofconn_get_master_election_id(
4541 ofconn
, &reply
.generation_id
);
4542 buf
= ofputil_encode_role_reply(oh
, &reply
);
4543 ofconn_send_reply(ofconn
, buf
);
4549 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
4550 const struct ofp_header
*oh
)
4552 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
4553 enum ofputil_protocol cur
, next
;
4555 cur
= ofconn_get_protocol(ofconn
);
4556 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
4557 ofconn_set_protocol(ofconn
, next
);
4563 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4565 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
4566 enum ofputil_protocol cur
, next
;
4567 enum ofputil_protocol next_base
;
4569 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
4571 return OFPERR_OFPBRC_EPERM
;
4574 cur
= ofconn_get_protocol(ofconn
);
4575 next
= ofputil_protocol_set_base(cur
, next_base
);
4576 if (cur
!= next
&& ofconn_has_pending_opgroups(ofconn
)) {
4577 /* Avoid sending async messages in surprising protocol. */
4578 return OFPROTO_POSTPONE
;
4581 ofconn_set_protocol(ofconn
, next
);
4586 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
4587 const struct ofp_header
*oh
)
4589 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
4592 format
= ntohl(msg
->format
);
4593 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
4594 return OFPERR_OFPBRC_EPERM
;
4597 if (format
!= ofconn_get_packet_in_format(ofconn
)
4598 && ofconn_has_pending_opgroups(ofconn
)) {
4599 /* Avoid sending async message in surprsing packet in format. */
4600 return OFPROTO_POSTPONE
;
4603 ofconn_set_packet_in_format(ofconn
, format
);
4608 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4610 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
4611 uint32_t master
[OAM_N_TYPES
];
4612 uint32_t slave
[OAM_N_TYPES
];
4614 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
4615 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
4616 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
4618 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
4619 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
4620 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
4622 ofconn_set_async_config(ofconn
, master
, slave
);
4623 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
4624 !ofconn_get_miss_send_len(ofconn
)) {
4625 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
4632 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4635 uint32_t master
[OAM_N_TYPES
];
4636 uint32_t slave
[OAM_N_TYPES
];
4637 struct nx_async_config
*msg
;
4639 ofconn_get_async_config(ofconn
, master
, slave
);
4640 buf
= ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY
, oh
, 0);
4641 msg
= ofpbuf_put_zeros(buf
, sizeof *msg
);
4643 msg
->packet_in_mask
[0] = htonl(master
[OAM_PACKET_IN
]);
4644 msg
->port_status_mask
[0] = htonl(master
[OAM_PORT_STATUS
]);
4645 msg
->flow_removed_mask
[0] = htonl(master
[OAM_FLOW_REMOVED
]);
4647 msg
->packet_in_mask
[1] = htonl(slave
[OAM_PACKET_IN
]);
4648 msg
->port_status_mask
[1] = htonl(slave
[OAM_PORT_STATUS
]);
4649 msg
->flow_removed_mask
[1] = htonl(slave
[OAM_FLOW_REMOVED
]);
4651 ofconn_send_reply(ofconn
, buf
);
4657 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
4658 const struct ofp_header
*oh
)
4660 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
4662 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
4663 return OFPERR_NXBRC_MUST_BE_ZERO
;
4666 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
4671 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4675 if (ofconn_has_pending_opgroups(ofconn
)) {
4676 return OFPROTO_POSTPONE
;
4679 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
4680 ? OFPRAW_OFPT10_BARRIER_REPLY
4681 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
4682 ofconn_send_reply(ofconn
, buf
);
4687 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
4688 enum nx_flow_monitor_flags flags
,
4690 OVS_REQUIRES(ofproto_mutex
)
4692 struct ofoperation
*op
= rule
->pending
;
4693 const struct rule_actions
*actions
;
4694 struct ofputil_flow_update fu
;
4697 if (op
&& op
->type
== OFOPERATION_ADD
) {
4698 /* We'll report the final flow when the operation completes. Reporting
4699 * it now would cause a duplicate report later. */
4703 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
4704 ? NXFME_ADDED
: NXFME_MODIFIED
);
4706 ovs_mutex_lock(&rule
->mutex
);
4707 fu
.idle_timeout
= rule
->idle_timeout
;
4708 fu
.hard_timeout
= rule
->hard_timeout
;
4709 ovs_mutex_unlock(&rule
->mutex
);
4710 fu
.table_id
= rule
->table_id
;
4711 fu
.cookie
= rule
->flow_cookie
;
4712 minimatch_expand(&rule
->cr
.match
, &match
);
4714 fu
.priority
= rule
->cr
.priority
;
4716 if (!(flags
& NXFMF_ACTIONS
)) {
4719 actions
= rule
->actions
;
4721 /* An operation is in progress. Use the previous version of the flow's
4722 * actions, so that when the operation commits we report the change. */
4724 case OFOPERATION_ADD
:
4727 case OFOPERATION_MODIFY
:
4728 case OFOPERATION_REPLACE
:
4729 actions
= op
->actions
? op
->actions
: rule
->actions
;
4732 case OFOPERATION_DELETE
:
4733 actions
= rule
->actions
;
4740 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
4741 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
4743 if (list_is_empty(msgs
)) {
4744 ofputil_start_flow_update(msgs
);
4746 ofputil_append_flow_update(&fu
, msgs
);
4750 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
4752 OVS_REQUIRES(ofproto_mutex
)
4756 for (i
= 0; i
< rules
->n
; i
++) {
4757 struct rule
*rule
= rules
->rules
[i
];
4758 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
4759 rule
->monitor_flags
= 0;
4761 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
4766 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
4767 struct rule
*rule
, uint64_t seqno
,
4768 struct rule_collection
*rules
)
4769 OVS_REQUIRES(ofproto_mutex
)
4771 enum nx_flow_monitor_flags update
;
4773 if (ofproto_rule_is_hidden(rule
)) {
4778 ? ofoperation_has_out_port(rule
->pending
, m
->out_port
)
4779 : ofproto_rule_has_out_port(rule
, m
->out_port
))) {
4784 if (rule
->add_seqno
> seqno
) {
4785 update
= NXFMF_ADD
| NXFMF_MODIFY
;
4786 } else if (rule
->modify_seqno
> seqno
) {
4787 update
= NXFMF_MODIFY
;
4792 if (!(m
->flags
& update
)) {
4796 update
= NXFMF_INITIAL
;
4799 if (!rule
->monitor_flags
) {
4800 rule_collection_add(rules
, rule
);
4802 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
4806 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
4808 struct rule_collection
*rules
)
4809 OVS_REQUIRES(ofproto_mutex
)
4811 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
4812 const struct ofoperation
*op
;
4813 const struct oftable
*table
;
4814 struct cls_rule target
;
4816 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
4817 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
4818 struct cls_cursor cursor
;
4821 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
4822 cls_cursor_init(&cursor
, &table
->cls
, &target
);
4823 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
4824 ovs_assert(!rule
->pending
); /* XXX */
4825 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4827 ovs_rwlock_unlock(&table
->cls
.rwlock
);
4830 HMAP_FOR_EACH (op
, hmap_node
, &ofproto
->deletions
) {
4831 struct rule
*rule
= op
->rule
;
4833 if (((m
->table_id
== 0xff
4834 ? !(ofproto
->tables
[rule
->table_id
].flags
& OFTABLE_HIDDEN
)
4835 : m
->table_id
== rule
->table_id
))
4836 && cls_rule_is_loose_match(&rule
->cr
, &target
.match
)) {
4837 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4840 cls_rule_destroy(&target
);
4844 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
4845 struct rule_collection
*rules
)
4846 OVS_REQUIRES(ofproto_mutex
)
4848 if (m
->flags
& NXFMF_INITIAL
) {
4849 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
4854 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
4855 uint64_t seqno
, struct rule_collection
*rules
)
4856 OVS_REQUIRES(ofproto_mutex
)
4858 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
4862 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4863 OVS_EXCLUDED(ofproto_mutex
)
4865 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4866 struct ofmonitor
**monitors
;
4867 size_t n_monitors
, allocated_monitors
;
4868 struct rule_collection rules
;
4869 struct list replies
;
4875 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4877 n_monitors
= allocated_monitors
= 0;
4879 ovs_mutex_lock(&ofproto_mutex
);
4881 struct ofputil_flow_monitor_request request
;
4882 struct ofmonitor
*m
;
4885 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
4886 if (retval
== EOF
) {
4888 } else if (retval
) {
4893 if (request
.table_id
!= 0xff
4894 && request
.table_id
>= ofproto
->n_tables
) {
4895 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4899 error
= ofmonitor_create(&request
, ofconn
, &m
);
4904 if (n_monitors
>= allocated_monitors
) {
4905 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
4908 monitors
[n_monitors
++] = m
;
4911 rule_collection_init(&rules
);
4912 for (i
= 0; i
< n_monitors
; i
++) {
4913 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
4916 ofpmp_init(&replies
, oh
);
4917 ofmonitor_compose_refresh_updates(&rules
, &replies
);
4918 ovs_mutex_unlock(&ofproto_mutex
);
4920 rule_collection_destroy(&rules
);
4922 ofconn_send_replies(ofconn
, &replies
);
4928 for (i
= 0; i
< n_monitors
; i
++) {
4929 ofmonitor_destroy(monitors
[i
]);
4932 ovs_mutex_unlock(&ofproto_mutex
);
4938 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4939 OVS_EXCLUDED(ofproto_mutex
)
4941 struct ofmonitor
*m
;
4945 id
= ofputil_decode_flow_monitor_cancel(oh
);
4947 ovs_mutex_lock(&ofproto_mutex
);
4948 m
= ofmonitor_lookup(ofconn
, id
);
4950 ofmonitor_destroy(m
);
4953 error
= OFPERR_NXBRC_FM_BAD_ID
;
4955 ovs_mutex_unlock(&ofproto_mutex
);
4960 /* Meters implementation.
4962 * Meter table entry, indexed by the OpenFlow meter_id.
4963 * These are always dynamically allocated to allocate enough space for
4965 * 'created' is used to compute the duration for meter stats.
4966 * 'list rules' is needed so that we can delete the dependent rules when the
4967 * meter table entry is deleted.
4968 * 'provider_meter_id' is for the provider's private use.
4971 long long int created
; /* Time created. */
4972 struct list rules
; /* List of "struct rule_dpif"s. */
4973 ofproto_meter_id provider_meter_id
;
4974 uint16_t flags
; /* Meter flags. */
4975 uint16_t n_bands
; /* Number of meter bands. */
4976 struct ofputil_meter_band
*bands
;
4980 * This is used in instruction validation at flow set-up time,
4981 * as flows may not use non-existing meters.
4982 * Return value of UINT32_MAX signifies an invalid meter.
4985 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
4987 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
4988 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
4990 return meter
->provider_meter_id
.uint32
;
4997 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
5001 meter
->flags
= config
->flags
;
5002 meter
->n_bands
= config
->n_bands
;
5003 meter
->bands
= xmemdup(config
->bands
,
5004 config
->n_bands
* sizeof *meter
->bands
);
5007 static struct meter
*
5008 meter_create(const struct ofputil_meter_config
*config
,
5009 ofproto_meter_id provider_meter_id
)
5011 struct meter
*meter
;
5013 meter
= xzalloc(sizeof *meter
);
5014 meter
->provider_meter_id
= provider_meter_id
;
5015 meter
->created
= time_msec();
5016 list_init(&meter
->rules
);
5018 meter_update(meter
, config
);
5024 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5025 OVS_REQUIRES(ofproto_mutex
)
5028 for (mid
= first
; mid
<= last
; ++mid
) {
5029 struct meter
*meter
= ofproto
->meters
[mid
];
5031 ofproto
->meters
[mid
] = NULL
;
5032 ofproto
->ofproto_class
->meter_del(ofproto
,
5033 meter
->provider_meter_id
);
5041 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5043 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5044 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5048 return OFPERR_OFPMMFC_METER_EXISTS
;
5051 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5054 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5055 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5061 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5063 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5065 uint32_t provider_meter_id
;
5068 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5071 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5072 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5073 &meter
->provider_meter_id
,
5075 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5077 meter_update(meter
, &mm
->meter
);
5083 handle_delete_meter(struct ofconn
*ofconn
, const struct ofp_header
*oh
,
5084 struct ofputil_meter_mod
*mm
)
5085 OVS_EXCLUDED(ofproto_mutex
)
5087 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5088 uint32_t meter_id
= mm
->meter
.meter_id
;
5089 struct rule_collection rules
;
5090 enum ofperr error
= 0;
5091 uint32_t first
, last
;
5093 if (meter_id
== OFPM13_ALL
) {
5095 last
= ofproto
->meter_features
.max_meters
;
5097 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
5100 first
= last
= meter_id
;
5103 /* First delete the rules that use this meter. If any of those rules are
5104 * currently being modified, postpone the whole operation until later. */
5105 rule_collection_init(&rules
);
5106 ovs_mutex_lock(&ofproto_mutex
);
5107 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5108 struct meter
*meter
= ofproto
->meters
[meter_id
];
5109 if (meter
&& !list_is_empty(&meter
->rules
)) {
5112 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
5113 if (rule
->pending
) {
5114 error
= OFPROTO_POSTPONE
;
5117 rule_collection_add(&rules
, rule
);
5122 delete_flows__(ofproto
, ofconn
, oh
, &rules
, OFPRR_METER_DELETE
);
5125 /* Delete the meters. */
5126 meter_delete(ofproto
, first
, last
);
5129 ovs_mutex_unlock(&ofproto_mutex
);
5130 rule_collection_destroy(&rules
);
5136 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5138 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5139 struct ofputil_meter_mod mm
;
5140 uint64_t bands_stub
[256 / 8];
5141 struct ofpbuf bands
;
5145 error
= reject_slave_controller(ofconn
);
5150 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5152 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
5154 goto exit_free_bands
;
5157 meter_id
= mm
.meter
.meter_id
;
5159 if (mm
.command
!= OFPMC13_DELETE
) {
5160 /* Fails also when meters are not implemented by the provider. */
5161 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
5162 error
= OFPERR_OFPMMFC_INVALID_METER
;
5163 goto exit_free_bands
;
5164 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
5165 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
5166 goto exit_free_bands
;
5168 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
5169 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
5170 goto exit_free_bands
;
5174 switch (mm
.command
) {
5176 error
= handle_add_meter(ofproto
, &mm
);
5179 case OFPMC13_MODIFY
:
5180 error
= handle_modify_meter(ofproto
, &mm
);
5183 case OFPMC13_DELETE
:
5184 error
= handle_delete_meter(ofconn
, oh
, &mm
);
5188 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
5193 ofpbuf_uninit(&bands
);
5198 handle_meter_features_request(struct ofconn
*ofconn
,
5199 const struct ofp_header
*request
)
5201 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5202 struct ofputil_meter_features features
;
5205 if (ofproto
->ofproto_class
->meter_get_features
) {
5206 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
5208 memset(&features
, 0, sizeof features
);
5210 b
= ofputil_encode_meter_features_reply(&features
, request
);
5212 ofconn_send_reply(ofconn
, b
);
5217 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
5220 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5221 struct list replies
;
5222 uint64_t bands_stub
[256 / 8];
5223 struct ofpbuf bands
;
5224 uint32_t meter_id
, first
, last
;
5226 ofputil_decode_meter_request(request
, &meter_id
);
5228 if (meter_id
== OFPM13_ALL
) {
5230 last
= ofproto
->meter_features
.max_meters
;
5232 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
5233 !ofproto
->meters
[meter_id
]) {
5234 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5236 first
= last
= meter_id
;
5239 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5240 ofpmp_init(&replies
, request
);
5242 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5243 struct meter
*meter
= ofproto
->meters
[meter_id
];
5245 continue; /* Skip non-existing meters. */
5247 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
5248 struct ofputil_meter_stats stats
;
5250 stats
.meter_id
= meter_id
;
5252 /* Provider sets the packet and byte counts, we do the rest. */
5253 stats
.flow_count
= list_size(&meter
->rules
);
5254 calc_duration(meter
->created
, time_msec(),
5255 &stats
.duration_sec
, &stats
.duration_nsec
);
5256 stats
.n_bands
= meter
->n_bands
;
5257 ofpbuf_clear(&bands
);
5259 = ofpbuf_put_uninit(&bands
,
5260 meter
->n_bands
* sizeof *stats
.bands
);
5262 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
5263 meter
->provider_meter_id
,
5265 ofputil_append_meter_stats(&replies
, &stats
);
5267 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5268 struct ofputil_meter_config config
;
5270 config
.meter_id
= meter_id
;
5271 config
.flags
= meter
->flags
;
5272 config
.n_bands
= meter
->n_bands
;
5273 config
.bands
= meter
->bands
;
5274 ofputil_append_meter_config(&replies
, &config
);
5278 ofconn_send_replies(ofconn
, &replies
);
5279 ofpbuf_uninit(&bands
);
5284 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5285 struct ofgroup
**group
)
5286 OVS_TRY_RDLOCK(true, (*group
)->rwlock
)
5288 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5289 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5290 hash_int(group_id
, 0), &ofproto
->groups
) {
5291 if ((*group
)->group_id
== group_id
) {
5292 ovs_rwlock_rdlock(&(*group
)->rwlock
);
5293 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5297 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5302 ofproto_group_release(struct ofgroup
*group
)
5303 OVS_RELEASES(group
->rwlock
)
5305 ovs_rwlock_unlock(&group
->rwlock
);
5309 ofproto_group_write_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5310 struct ofgroup
**group
)
5311 OVS_TRY_WRLOCK(true, ofproto
->groups_rwlock
)
5312 OVS_TRY_WRLOCK(true, (*group
)->rwlock
)
5314 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5315 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5316 hash_int(group_id
, 0), &ofproto
->groups
) {
5317 if ((*group
)->group_id
== group_id
) {
5318 ovs_rwlock_wrlock(&(*group
)->rwlock
);
5322 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5327 ofproto_group_exists__(const struct ofproto
*ofproto
, uint32_t group_id
)
5328 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5330 struct ofgroup
*grp
;
5332 HMAP_FOR_EACH_IN_BUCKET (grp
, hmap_node
,
5333 hash_int(group_id
, 0), &ofproto
->groups
) {
5334 if (grp
->group_id
== group_id
) {
5342 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
5343 OVS_EXCLUDED(ofproto
->groups_rwlock
)
5347 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5348 exists
= ofproto_group_exists__(ofproto
, group_id
);
5349 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5355 group_get_ref_count(struct ofgroup
*group
)
5356 OVS_EXCLUDED(ofproto_mutex
)
5358 struct ofproto
*ofproto
= group
->ofproto
;
5359 struct rule_criteria criteria
;
5360 struct rule_collection rules
;
5365 match_init_catchall(&match
);
5366 rule_criteria_init(&criteria
, 0xff, &match
, 0, htonll(0), htonll(0),
5367 OFPP_ANY
, group
->group_id
);
5368 ovs_mutex_lock(&ofproto_mutex
);
5369 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
5370 ovs_mutex_unlock(&ofproto_mutex
);
5371 rule_criteria_destroy(&criteria
);
5373 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
5375 rule_collection_destroy(&rules
);
5380 append_group_stats(struct ofgroup
*group
, struct list
*replies
)
5381 OVS_REQ_RDLOCK(group
->rwlock
)
5383 struct ofputil_group_stats ogs
;
5384 struct ofproto
*ofproto
= group
->ofproto
;
5385 long long int now
= time_msec();
5388 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
5390 /* Provider sets the packet and byte counts, we do the rest. */
5391 ogs
.ref_count
= group_get_ref_count(group
);
5392 ogs
.n_buckets
= group
->n_buckets
;
5394 error
= (ofproto
->ofproto_class
->group_get_stats
5395 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
5398 ogs
.packet_count
= UINT64_MAX
;
5399 ogs
.byte_count
= UINT64_MAX
;
5400 memset(ogs
.bucket_stats
, 0xff,
5401 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
5404 ogs
.group_id
= group
->group_id
;
5405 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
5407 ofputil_append_group_stats(replies
, &ogs
);
5409 free(ogs
.bucket_stats
);
5413 handle_group_stats_request(struct ofconn
*ofconn
,
5414 const struct ofp_header
*request
)
5416 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5417 struct list replies
;
5419 struct ofgroup
*group
;
5422 error
= ofputil_decode_group_stats_request(request
, &group_id
);
5427 ofpmp_init(&replies
, request
);
5429 if (group_id
== OFPG_ALL
) {
5430 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5431 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5432 ovs_rwlock_rdlock(&group
->rwlock
);
5433 append_group_stats(group
, &replies
);
5434 ovs_rwlock_unlock(&group
->rwlock
);
5436 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5438 if (ofproto_group_lookup(ofproto
, group_id
, &group
)) {
5439 append_group_stats(group
, &replies
);
5440 ofproto_group_release(group
);
5444 ofconn_send_replies(ofconn
, &replies
);
5450 handle_group_desc_stats_request(struct ofconn
*ofconn
,
5451 const struct ofp_header
*request
)
5453 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5454 struct list replies
;
5455 struct ofputil_group_desc gds
;
5456 struct ofgroup
*group
;
5458 ofpmp_init(&replies
, request
);
5460 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5461 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5462 gds
.group_id
= group
->group_id
;
5463 gds
.type
= group
->type
;
5464 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, &replies
);
5466 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5468 ofconn_send_replies(ofconn
, &replies
);
5474 handle_group_features_stats_request(struct ofconn
*ofconn
,
5475 const struct ofp_header
*request
)
5477 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5480 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
5482 ofconn_send_reply(ofconn
, msg
);
5489 handle_queue_get_config_request(struct ofconn
*ofconn
,
5490 const struct ofp_header
*oh
)
5492 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5493 struct netdev_queue_dump queue_dump
;
5494 struct ofport
*ofport
;
5495 unsigned int queue_id
;
5496 struct ofpbuf
*reply
;
5497 struct smap details
;
5501 error
= ofputil_decode_queue_get_config_request(oh
, &request
);
5506 ofport
= ofproto_get_port(p
, request
);
5508 return OFPERR_OFPQOFC_BAD_PORT
;
5511 reply
= ofputil_encode_queue_get_config_reply(oh
);
5513 smap_init(&details
);
5514 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
, ofport
->netdev
) {
5515 struct ofputil_queue_config queue
;
5517 /* None of the existing queues have compatible properties, so we
5518 * hard-code omitting min_rate and max_rate. */
5519 queue
.queue_id
= queue_id
;
5520 queue
.min_rate
= UINT16_MAX
;
5521 queue
.max_rate
= UINT16_MAX
;
5522 ofputil_append_queue_get_config_reply(reply
, &queue
);
5524 smap_destroy(&details
);
5526 ofconn_send_reply(ofconn
, reply
);
5531 /* Implements OFPGC11_ADD
5532 * in which no matching flow already exists in the flow table.
5534 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
5535 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
5536 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
5537 * initiated now but may be retried later.
5539 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
5540 * ownership remains with the caller.
5542 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
5545 add_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5547 struct ofgroup
*ofgroup
;
5550 if (gm
->group_id
> OFPG_MAX
) {
5551 return OFPERR_OFPGMFC_INVALID_GROUP
;
5553 if (gm
->type
> OFPGT11_FF
) {
5554 return OFPERR_OFPGMFC_BAD_TYPE
;
5557 /* Allocate new group and initialize it. */
5558 ofgroup
= ofproto
->ofproto_class
->group_alloc();
5560 VLOG_WARN_RL(&rl
, "%s: failed to create group", ofproto
->name
);
5561 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5564 ovs_rwlock_init(&ofgroup
->rwlock
);
5565 ofgroup
->ofproto
= ofproto
;
5566 ofgroup
->group_id
= gm
->group_id
;
5567 ofgroup
->type
= gm
->type
;
5568 ofgroup
->created
= ofgroup
->modified
= time_msec();
5570 list_move(&ofgroup
->buckets
, &gm
->buckets
);
5571 ofgroup
->n_buckets
= list_size(&ofgroup
->buckets
);
5573 /* Construct called BEFORE any locks are held. */
5574 error
= ofproto
->ofproto_class
->group_construct(ofgroup
);
5579 /* We wrlock as late as possible to minimize the time we jam any other
5580 * threads: No visible state changes before acquiring the lock. */
5581 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5583 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5584 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5588 if (ofproto_group_exists__(ofproto
, gm
->group_id
)) {
5589 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
5594 /* Insert new group. */
5595 hmap_insert(&ofproto
->groups
, &ofgroup
->hmap_node
,
5596 hash_int(ofgroup
->group_id
, 0));
5597 ofproto
->n_groups
[ofgroup
->type
]++;
5599 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5604 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5605 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5607 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5608 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5613 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5616 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5619 modify_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5621 struct ofgroup
*ofgroup
;
5622 struct ofgroup
*victim
;
5625 if (gm
->group_id
> OFPG_MAX
) {
5626 return OFPERR_OFPGMFC_INVALID_GROUP
;
5629 if (gm
->type
> OFPGT11_FF
) {
5630 return OFPERR_OFPGMFC_BAD_TYPE
;
5633 victim
= ofproto
->ofproto_class
->group_alloc();
5635 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
5636 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5639 if (!ofproto_group_write_lookup(ofproto
, gm
->group_id
, &ofgroup
)) {
5640 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
5643 /* Both group's and its container's write locks held now.
5644 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5645 if (ofgroup
->type
!= gm
->type
5646 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5647 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5652 list_move(&victim
->buckets
, &ofgroup
->buckets
);
5654 ofgroup
->type
= gm
->type
;
5655 list_move(&ofgroup
->buckets
, &gm
->buckets
);
5656 ofgroup
->n_buckets
= list_size(&ofgroup
->buckets
);
5658 error
= ofproto
->ofproto_class
->group_modify(ofgroup
, victim
);
5660 ofputil_bucket_list_destroy(&victim
->buckets
);
5661 ofproto
->n_groups
[victim
->type
]--;
5662 ofproto
->n_groups
[ofgroup
->type
]++;
5663 ofgroup
->modified
= time_msec();
5665 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5668 list_move(&ofgroup
->buckets
, &victim
->buckets
);
5672 ovs_rwlock_unlock(&ofgroup
->rwlock
);
5673 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5675 ofproto
->ofproto_class
->group_dealloc(victim
);
5680 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
5681 OVS_RELEASES(ofproto
->groups_rwlock
)
5684 struct ofputil_flow_mod fm
;
5686 /* Delete all flow entries containing this group in a group action */
5687 match_init_catchall(&match
);
5688 flow_mod_init(&fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
5689 fm
.out_group
= ofgroup
->group_id
;
5690 handle_flow_mod__(ofproto
, NULL
, &fm
, NULL
);
5692 /* Must wait until existing readers are done,
5693 * while holding the container's write lock at the same time. */
5694 ovs_rwlock_wrlock(&ofgroup
->rwlock
);
5695 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5696 /* No-one can find this group any more. */
5697 ofproto
->n_groups
[ofgroup
->type
]--;
5698 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5700 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5701 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5702 ovs_rwlock_unlock(&ofgroup
->rwlock
);
5703 ovs_rwlock_destroy(&ofgroup
->rwlock
);
5704 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5707 /* Implements OFPGC_DELETE. */
5709 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
5711 struct ofgroup
*ofgroup
;
5713 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5714 if (group_id
== OFPG_ALL
) {
5716 struct hmap_node
*node
= hmap_first(&ofproto
->groups
);
5720 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, hmap_node
);
5721 delete_group__(ofproto
, ofgroup
);
5722 /* Lock for each node separately, so that we will not jam the
5723 * other threads for too long time. */
5724 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5727 HMAP_FOR_EACH_IN_BUCKET (ofgroup
, hmap_node
,
5728 hash_int(group_id
, 0), &ofproto
->groups
) {
5729 if (ofgroup
->group_id
== group_id
) {
5730 delete_group__(ofproto
, ofgroup
);
5735 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5739 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5741 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5742 struct ofputil_group_mod gm
;
5745 error
= reject_slave_controller(ofconn
);
5750 error
= ofputil_decode_group_mod(oh
, &gm
);
5755 switch (gm
.command
) {
5757 return add_group(ofproto
, &gm
);
5759 case OFPGC11_MODIFY
:
5760 return modify_group(ofproto
, &gm
);
5762 case OFPGC11_DELETE
:
5763 delete_group(ofproto
, gm
.group_id
);
5767 if (gm
.command
> OFPGC11_DELETE
) {
5768 VLOG_WARN_RL(&rl
, "%s: Invalid group_mod command type %d",
5769 ofproto
->name
, gm
.command
);
5771 return OFPERR_OFPGMFC_BAD_COMMAND
;
5776 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5778 struct ofputil_table_mod tm
;
5781 error
= reject_slave_controller(ofconn
);
5786 error
= ofputil_decode_table_mod(oh
, &tm
);
5791 /* XXX Actual table mod support is not implemented yet. */
5796 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
5797 OVS_EXCLUDED(ofproto_mutex
)
5799 const struct ofp_header
*oh
= msg
->data
;
5803 error
= ofptype_decode(&type
, oh
);
5807 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
5808 && ofpmp_more(oh
)) {
5809 /* We have no buffer implementation for multipart requests.
5810 * Report overflow for requests which consists of multiple
5812 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
5816 /* OpenFlow requests. */
5817 case OFPTYPE_ECHO_REQUEST
:
5818 return handle_echo_request(ofconn
, oh
);
5820 case OFPTYPE_FEATURES_REQUEST
:
5821 return handle_features_request(ofconn
, oh
);
5823 case OFPTYPE_GET_CONFIG_REQUEST
:
5824 return handle_get_config_request(ofconn
, oh
);
5826 case OFPTYPE_SET_CONFIG
:
5827 return handle_set_config(ofconn
, oh
);
5829 case OFPTYPE_PACKET_OUT
:
5830 return handle_packet_out(ofconn
, oh
);
5832 case OFPTYPE_PORT_MOD
:
5833 return handle_port_mod(ofconn
, oh
);
5835 case OFPTYPE_FLOW_MOD
:
5836 return handle_flow_mod(ofconn
, oh
);
5838 case OFPTYPE_GROUP_MOD
:
5839 return handle_group_mod(ofconn
, oh
);
5841 case OFPTYPE_TABLE_MOD
:
5842 return handle_table_mod(ofconn
, oh
);
5844 case OFPTYPE_METER_MOD
:
5845 return handle_meter_mod(ofconn
, oh
);
5847 case OFPTYPE_BARRIER_REQUEST
:
5848 return handle_barrier_request(ofconn
, oh
);
5850 case OFPTYPE_ROLE_REQUEST
:
5851 return handle_role_request(ofconn
, oh
);
5853 /* OpenFlow replies. */
5854 case OFPTYPE_ECHO_REPLY
:
5857 /* Nicira extension requests. */
5858 case OFPTYPE_FLOW_MOD_TABLE_ID
:
5859 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
5861 case OFPTYPE_SET_FLOW_FORMAT
:
5862 return handle_nxt_set_flow_format(ofconn
, oh
);
5864 case OFPTYPE_SET_PACKET_IN_FORMAT
:
5865 return handle_nxt_set_packet_in_format(ofconn
, oh
);
5867 case OFPTYPE_SET_CONTROLLER_ID
:
5868 return handle_nxt_set_controller_id(ofconn
, oh
);
5870 case OFPTYPE_FLOW_AGE
:
5871 /* Nothing to do. */
5874 case OFPTYPE_FLOW_MONITOR_CANCEL
:
5875 return handle_flow_monitor_cancel(ofconn
, oh
);
5877 case OFPTYPE_SET_ASYNC_CONFIG
:
5878 return handle_nxt_set_async_config(ofconn
, oh
);
5880 case OFPTYPE_GET_ASYNC_REQUEST
:
5881 return handle_nxt_get_async_request(ofconn
, oh
);
5883 /* Statistics requests. */
5884 case OFPTYPE_DESC_STATS_REQUEST
:
5885 return handle_desc_stats_request(ofconn
, oh
);
5887 case OFPTYPE_FLOW_STATS_REQUEST
:
5888 return handle_flow_stats_request(ofconn
, oh
);
5890 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
5891 return handle_aggregate_stats_request(ofconn
, oh
);
5893 case OFPTYPE_TABLE_STATS_REQUEST
:
5894 return handle_table_stats_request(ofconn
, oh
);
5896 case OFPTYPE_PORT_STATS_REQUEST
:
5897 return handle_port_stats_request(ofconn
, oh
);
5899 case OFPTYPE_QUEUE_STATS_REQUEST
:
5900 return handle_queue_stats_request(ofconn
, oh
);
5902 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
5903 return handle_port_desc_stats_request(ofconn
, oh
);
5905 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
5906 return handle_flow_monitor_request(ofconn
, oh
);
5908 case OFPTYPE_METER_STATS_REQUEST
:
5909 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
5910 return handle_meter_request(ofconn
, oh
, type
);
5912 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
5913 return handle_meter_features_request(ofconn
, oh
);
5915 case OFPTYPE_GROUP_STATS_REQUEST
:
5916 return handle_group_stats_request(ofconn
, oh
);
5918 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
5919 return handle_group_desc_stats_request(ofconn
, oh
);
5921 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
5922 return handle_group_features_stats_request(ofconn
, oh
);
5924 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
5925 return handle_queue_get_config_request(ofconn
, oh
);
5929 case OFPTYPE_FEATURES_REPLY
:
5930 case OFPTYPE_GET_CONFIG_REPLY
:
5931 case OFPTYPE_PACKET_IN
:
5932 case OFPTYPE_FLOW_REMOVED
:
5933 case OFPTYPE_PORT_STATUS
:
5934 case OFPTYPE_BARRIER_REPLY
:
5935 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
5936 case OFPTYPE_DESC_STATS_REPLY
:
5937 case OFPTYPE_FLOW_STATS_REPLY
:
5938 case OFPTYPE_QUEUE_STATS_REPLY
:
5939 case OFPTYPE_PORT_STATS_REPLY
:
5940 case OFPTYPE_TABLE_STATS_REPLY
:
5941 case OFPTYPE_AGGREGATE_STATS_REPLY
:
5942 case OFPTYPE_PORT_DESC_STATS_REPLY
:
5943 case OFPTYPE_ROLE_REPLY
:
5944 case OFPTYPE_FLOW_MONITOR_PAUSED
:
5945 case OFPTYPE_FLOW_MONITOR_RESUMED
:
5946 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
5947 case OFPTYPE_GET_ASYNC_REPLY
:
5948 case OFPTYPE_GROUP_STATS_REPLY
:
5949 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
5950 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
5951 case OFPTYPE_METER_STATS_REPLY
:
5952 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
5953 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
5954 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
5955 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
5956 case OFPTYPE_ROLE_STATUS
:
5958 if (ofpmsg_is_stat_request(oh
)) {
5959 return OFPERR_OFPBRC_BAD_STAT
;
5961 return OFPERR_OFPBRC_BAD_TYPE
;
5967 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
5968 OVS_EXCLUDED(ofproto_mutex
)
5970 int error
= handle_openflow__(ofconn
, ofp_msg
);
5971 if (error
&& error
!= OFPROTO_POSTPONE
) {
5972 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
5974 COVERAGE_INC(ofproto_recv_openflow
);
5975 return error
!= OFPROTO_POSTPONE
;
5978 /* Asynchronous operations. */
5980 /* Creates and returns a new ofopgroup that is not associated with any
5981 * OpenFlow connection.
5983 * The caller should add operations to the returned group with
5984 * ofoperation_create() and then submit it with ofopgroup_submit(). */
5985 static struct ofopgroup
*
5986 ofopgroup_create_unattached(struct ofproto
*ofproto
)
5987 OVS_REQUIRES(ofproto_mutex
)
5989 struct ofopgroup
*group
= xzalloc(sizeof *group
);
5990 group
->ofproto
= ofproto
;
5991 list_init(&group
->ofproto_node
);
5992 list_init(&group
->ops
);
5993 list_init(&group
->ofconn_node
);
5997 /* Creates and returns a new ofopgroup for 'ofproto'.
5999 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
6000 * connection. The 'request' and 'buffer_id' arguments are ignored.
6002 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
6003 * If the ofopgroup eventually fails, then the error reply will include
6004 * 'request'. If the ofopgroup eventually succeeds, then the packet with
6005 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
6007 * The caller should add operations to the returned group with
6008 * ofoperation_create() and then submit it with ofopgroup_submit(). */
6009 static struct ofopgroup
*
6010 ofopgroup_create(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
6011 const struct ofp_header
*request
, uint32_t buffer_id
)
6012 OVS_REQUIRES(ofproto_mutex
)
6014 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
6016 size_t request_len
= ntohs(request
->length
);
6018 ovs_assert(ofconn_get_ofproto(ofconn
) == ofproto
);
6020 ofconn_add_opgroup(ofconn
, &group
->ofconn_node
);
6021 group
->ofconn
= ofconn
;
6022 group
->request
= xmemdup(request
, MIN(request_len
, 64));
6023 group
->buffer_id
= buffer_id
;
6028 /* Submits 'group' for processing.
6030 * If 'group' contains no operations (e.g. none were ever added, or all of the
6031 * ones that were added completed synchronously), then it is destroyed
6032 * immediately. Otherwise it is added to the ofproto's list of pending
6035 ofopgroup_submit(struct ofopgroup
*group
)
6036 OVS_REQUIRES(ofproto_mutex
)
6038 if (!group
->n_running
) {
6039 ofopgroup_complete(group
);
6041 list_push_back(&group
->ofproto
->pending
, &group
->ofproto_node
);
6042 group
->ofproto
->n_pending
++;
6047 ofopgroup_complete(struct ofopgroup
*group
)
6048 OVS_REQUIRES(ofproto_mutex
)
6050 struct ofproto
*ofproto
= group
->ofproto
;
6052 struct ofconn
*abbrev_ofconn
;
6053 ovs_be32 abbrev_xid
;
6055 struct ofoperation
*op
, *next_op
;
6058 ovs_assert(!group
->n_running
);
6061 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
6068 if (!error
&& group
->ofconn
&& group
->buffer_id
!= UINT32_MAX
) {
6069 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
6070 if (op
->type
!= OFOPERATION_DELETE
) {
6071 struct ofpbuf
*packet
;
6074 error
= ofconn_pktbuf_retrieve(group
->ofconn
, group
->buffer_id
,
6077 struct rule_execute
*re
;
6081 ofproto_rule_ref(op
->rule
);
6083 re
= xmalloc(sizeof *re
);
6084 re
->rule
= op
->rule
;
6085 re
->in_port
= in_port
;
6086 re
->packet
= packet
;
6088 if (!guarded_list_push_back(&ofproto
->rule_executes
,
6089 &re
->list_node
, 1024)) {
6090 ofproto_rule_unref(op
->rule
);
6091 ofpbuf_delete(re
->packet
);
6100 if (!error
&& !list_is_empty(&group
->ofconn_node
)) {
6101 abbrev_ofconn
= group
->ofconn
;
6102 abbrev_xid
= group
->request
->xid
;
6104 abbrev_ofconn
= NULL
;
6105 abbrev_xid
= htonl(0);
6107 LIST_FOR_EACH_SAFE (op
, next_op
, group_node
, &group
->ops
) {
6108 struct rule
*rule
= op
->rule
;
6110 /* We generally want to report the change to active OpenFlow flow
6111 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
6113 - The operation failed.
6115 - The affected rule is not visible to controllers.
6117 - The operation's only effect was to update rule->modified. */
6119 || ofproto_rule_is_hidden(rule
)
6120 || (op
->type
== OFOPERATION_MODIFY
6122 && rule
->flow_cookie
== op
->flow_cookie
))) {
6123 /* Check that we can just cast from ofoperation_type to
6124 * nx_flow_update_event. */
6125 enum nx_flow_update_event event_type
;
6128 case OFOPERATION_ADD
:
6129 case OFOPERATION_REPLACE
:
6130 event_type
= NXFME_ADDED
;
6133 case OFOPERATION_DELETE
:
6134 event_type
= NXFME_DELETED
;
6137 case OFOPERATION_MODIFY
:
6138 event_type
= NXFME_MODIFIED
;
6145 ofmonitor_report(ofproto
->connmgr
, rule
, event_type
,
6146 op
->reason
, abbrev_ofconn
, abbrev_xid
);
6149 rule
->pending
= NULL
;
6152 case OFOPERATION_ADD
:
6156 vid_mask
= minimask_get_vid_mask(&rule
->cr
.match
.mask
);
6157 if (vid_mask
== VLAN_VID_MASK
) {
6158 if (ofproto
->vlan_bitmap
) {
6159 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
6160 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
6161 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6162 ofproto
->vlans_changed
= true;
6165 ofproto
->vlans_changed
= true;
6169 oftable_remove_rule(rule
);
6170 ofproto_rule_unref(rule
);
6174 case OFOPERATION_DELETE
:
6175 ovs_assert(!op
->error
);
6176 ofproto_rule_unref(rule
);
6180 case OFOPERATION_MODIFY
:
6181 case OFOPERATION_REPLACE
:
6183 long long int now
= time_msec();
6185 rule
->modified
= now
;
6186 if (op
->type
== OFOPERATION_REPLACE
) {
6187 rule
->created
= rule
->used
= now
;
6190 ofproto_rule_change_cookie(ofproto
, rule
, op
->flow_cookie
);
6191 ovs_mutex_lock(&rule
->mutex
);
6192 rule
->idle_timeout
= op
->idle_timeout
;
6193 rule
->hard_timeout
= op
->hard_timeout
;
6194 ovs_mutex_unlock(&rule
->mutex
);
6196 struct rule_actions
*old_actions
;
6198 ovs_mutex_lock(&rule
->mutex
);
6199 old_actions
= rule
->actions
;
6200 rule
->actions
= op
->actions
;
6201 ovs_mutex_unlock(&rule
->mutex
);
6204 rule_actions_unref(old_actions
);
6206 rule
->flags
= op
->flags
;
6214 ofoperation_destroy(op
);
6217 ofmonitor_flush(ofproto
->connmgr
);
6219 if (!list_is_empty(&group
->ofproto_node
)) {
6220 ovs_assert(ofproto
->n_pending
> 0);
6221 ofproto
->n_pending
--;
6222 list_remove(&group
->ofproto_node
);
6224 if (!list_is_empty(&group
->ofconn_node
)) {
6225 list_remove(&group
->ofconn_node
);
6227 ofconn_send_error(group
->ofconn
, group
->request
, error
);
6229 connmgr_retry(ofproto
->connmgr
);
6231 free(group
->request
);
6235 /* Initiates a new operation on 'rule', of the specified 'type', within
6236 * 'group'. Prior to calling, 'rule' must not have any pending operation.
6238 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
6239 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
6241 * Returns the newly created ofoperation (which is also available as
6242 * rule->pending). */
6243 static struct ofoperation
*
6244 ofoperation_create(struct ofopgroup
*group
, struct rule
*rule
,
6245 enum ofoperation_type type
,
6246 enum ofp_flow_removed_reason reason
)
6247 OVS_REQUIRES(ofproto_mutex
)
6249 struct ofproto
*ofproto
= group
->ofproto
;
6250 struct ofoperation
*op
;
6252 ovs_assert(!rule
->pending
);
6254 op
= rule
->pending
= xzalloc(sizeof *op
);
6256 list_push_back(&group
->ops
, &op
->group_node
);
6259 op
->reason
= reason
;
6260 op
->flow_cookie
= rule
->flow_cookie
;
6261 ovs_mutex_lock(&rule
->mutex
);
6262 op
->idle_timeout
= rule
->idle_timeout
;
6263 op
->hard_timeout
= rule
->hard_timeout
;
6264 ovs_mutex_unlock(&rule
->mutex
);
6265 op
->flags
= rule
->flags
;
6269 if (type
== OFOPERATION_DELETE
) {
6270 hmap_insert(&ofproto
->deletions
, &op
->hmap_node
,
6271 cls_rule_hash(&rule
->cr
, rule
->table_id
));
6278 ofoperation_destroy(struct ofoperation
*op
)
6279 OVS_REQUIRES(ofproto_mutex
)
6281 struct ofopgroup
*group
= op
->group
;
6284 op
->rule
->pending
= NULL
;
6286 if (op
->type
== OFOPERATION_DELETE
) {
6287 hmap_remove(&group
->ofproto
->deletions
, &op
->hmap_node
);
6289 list_remove(&op
->group_node
);
6290 rule_actions_unref(op
->actions
);
6294 /* Indicates that 'op' completed with status 'error', which is either 0 to
6295 * indicate success or an OpenFlow error code on failure.
6297 * If 'error' is 0, indicating success, the operation will be committed
6298 * permanently to the flow table.
6300 * If 'error' is nonzero, then generally the operation will be rolled back:
6302 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
6303 * restores the original rule. The caller must have uninitialized any
6304 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
6305 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
6306 * and 7 for the new rule, calling its ->rule_dealloc() function.
6308 * - If 'op' is a "modify flow" operation, ofproto restores the original
6311 * - 'op' must not be a "delete flow" operation. Removing a rule is not
6312 * allowed to fail. It must always succeed.
6314 * Please see the large comment in ofproto/ofproto-provider.h titled
6315 * "Asynchronous Operation Support" for more information. */
6317 ofoperation_complete(struct ofoperation
*op
, enum ofperr error
)
6319 struct ofopgroup
*group
= op
->group
;
6321 ovs_assert(group
->n_running
> 0);
6322 ovs_assert(!error
|| op
->type
!= OFOPERATION_DELETE
);
6325 if (!--group
->n_running
&& !list_is_empty(&group
->ofproto_node
)) {
6326 /* This function can be called from ->rule_construct(), in which case
6327 * ofproto_mutex is held, or it can be called from ->run(), in which
6328 * case ofproto_mutex is not held. But only in the latter case can we
6329 * arrive here, so we can safely take ofproto_mutex now. */
6330 ovs_mutex_lock(&ofproto_mutex
);
6331 ovs_assert(op
->rule
->pending
== op
);
6332 ofopgroup_complete(group
);
6333 ovs_mutex_unlock(&ofproto_mutex
);
6338 pick_datapath_id(const struct ofproto
*ofproto
)
6340 const struct ofport
*port
;
6342 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
6344 uint8_t ea
[ETH_ADDR_LEN
];
6347 error
= netdev_get_etheraddr(port
->netdev
, ea
);
6349 return eth_addr_to_uint64(ea
);
6351 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6352 ofproto
->name
, netdev_get_name(port
->netdev
),
6353 ovs_strerror(error
));
6355 return ofproto
->fallback_dpid
;
6359 pick_fallback_dpid(void)
6361 uint8_t ea
[ETH_ADDR_LEN
];
6362 eth_addr_nicira_random(ea
);
6363 return eth_addr_to_uint64(ea
);
6366 /* Table overflow policy. */
6368 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6369 * to NULL if the table is not configured to evict rules or if the table
6370 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6371 * or with no timeouts are not evictable.) */
6373 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
6374 OVS_REQUIRES(ofproto_mutex
)
6376 struct eviction_group
*evg
;
6379 if (!table
->eviction_fields
) {
6383 /* In the common case, the outer and inner loops here will each be entered
6386 * - The inner loop normally "return"s in its first iteration. If the
6387 * eviction group has any evictable rules, then it always returns in
6390 * - The outer loop only iterates more than once if the largest eviction
6391 * group has no evictable rules.
6393 * - The outer loop can exit only if table's 'max_flows' is all filled up
6394 * by unevictable rules. */
6395 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
6398 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
6407 /* Searches 'ofproto' for tables that have more flows than their configured
6408 * maximum and that have flow eviction enabled, and evicts as many flows as
6409 * necessary and currently feasible from them.
6411 * This triggers only when an OpenFlow table has N flows in it and then the
6412 * client configures a maximum number of flows less than N. */
6414 ofproto_evict(struct ofproto
*ofproto
)
6416 struct oftable
*table
;
6418 ovs_mutex_lock(&ofproto_mutex
);
6419 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
6420 evict_rules_from_table(ofproto
, table
, 0);
6422 ovs_mutex_unlock(&ofproto_mutex
);
6425 /* Eviction groups. */
6427 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6428 * rules. The priority contains low-order random bits to ensure that eviction
6429 * groups with the same number of rules are prioritized randomly. */
6431 eviction_group_priority(size_t n_rules
)
6433 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
6434 return (size
<< 16) | random_uint16();
6437 /* Updates 'evg', an eviction_group within 'table', following a change that
6438 * adds or removes rules in 'evg'. */
6440 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
6441 OVS_REQUIRES(ofproto_mutex
)
6443 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
6444 eviction_group_priority(heap_count(&evg
->rules
)));
6447 /* Destroys 'evg', an eviction_group within 'table':
6449 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6450 * rules themselves, just removes them from the eviction group.)
6452 * - Removes 'evg' from 'table'.
6456 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
6457 OVS_REQUIRES(ofproto_mutex
)
6459 while (!heap_is_empty(&evg
->rules
)) {
6462 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
6463 rule
->eviction_group
= NULL
;
6465 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
6466 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
6467 heap_destroy(&evg
->rules
);
6471 /* Removes 'rule' from its eviction group, if any. */
6473 eviction_group_remove_rule(struct rule
*rule
)
6474 OVS_REQUIRES(ofproto_mutex
)
6476 if (rule
->eviction_group
) {
6477 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6478 struct eviction_group
*evg
= rule
->eviction_group
;
6480 rule
->eviction_group
= NULL
;
6481 heap_remove(&evg
->rules
, &rule
->evg_node
);
6482 if (heap_is_empty(&evg
->rules
)) {
6483 eviction_group_destroy(table
, evg
);
6485 eviction_group_resized(table
, evg
);
6490 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6491 * returns the hash value. */
6493 eviction_group_hash_rule(struct rule
*rule
)
6494 OVS_REQUIRES(ofproto_mutex
)
6496 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6497 const struct mf_subfield
*sf
;
6501 hash
= table
->eviction_group_id_basis
;
6502 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
6503 for (sf
= table
->eviction_fields
;
6504 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
6507 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
6508 union mf_value value
;
6510 mf_get_value(sf
->field
, &flow
, &value
);
6512 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
6514 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
6515 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
6516 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
6517 sf
->field
->n_bytes
* 8 - start
);
6519 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
6521 hash
= hash_int(hash
, 0);
6528 /* Returns an eviction group within 'table' with the given 'id', creating one
6530 static struct eviction_group
*
6531 eviction_group_find(struct oftable
*table
, uint32_t id
)
6532 OVS_REQUIRES(ofproto_mutex
)
6534 struct eviction_group
*evg
;
6536 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
6540 evg
= xmalloc(sizeof *evg
);
6541 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
6542 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
6543 eviction_group_priority(0));
6544 heap_init(&evg
->rules
);
6549 /* Returns an eviction priority for 'rule'. The return value should be
6550 * interpreted so that higher priorities make a rule more attractive candidates
6553 rule_eviction_priority(struct rule
*rule
)
6554 OVS_REQUIRES(ofproto_mutex
)
6556 long long int hard_expiration
;
6557 long long int idle_expiration
;
6558 long long int expiration
;
6559 uint32_t expiration_offset
;
6561 /* Calculate time of expiration. */
6562 ovs_mutex_lock(&rule
->mutex
);
6563 hard_expiration
= (rule
->hard_timeout
6564 ? rule
->modified
+ rule
->hard_timeout
* 1000
6566 idle_expiration
= (rule
->idle_timeout
6567 ? rule
->used
+ rule
->idle_timeout
* 1000
6569 expiration
= MIN(hard_expiration
, idle_expiration
);
6570 ovs_mutex_unlock(&rule
->mutex
);
6571 if (expiration
== LLONG_MAX
) {
6575 /* Calculate the time of expiration as a number of (approximate) seconds
6576 * after program startup.
6578 * This should work OK for program runs that last UINT32_MAX seconds or
6579 * less. Therefore, please restart OVS at least once every 136 years. */
6580 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
6582 /* Invert the expiration offset because we're using a max-heap. */
6583 return UINT32_MAX
- expiration_offset
;
6586 /* Adds 'rule' to an appropriate eviction group for its oftable's
6587 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6588 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6591 * The caller must ensure that 'rule' is not already in an eviction group. */
6593 eviction_group_add_rule(struct rule
*rule
)
6594 OVS_REQUIRES(ofproto_mutex
)
6596 struct ofproto
*ofproto
= rule
->ofproto
;
6597 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6600 ovs_mutex_lock(&rule
->mutex
);
6601 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
6602 ovs_mutex_unlock(&rule
->mutex
);
6604 if (table
->eviction_fields
&& has_timeout
) {
6605 struct eviction_group
*evg
;
6607 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
6609 rule
->eviction_group
= evg
;
6610 heap_insert(&evg
->rules
, &rule
->evg_node
,
6611 rule_eviction_priority(rule
));
6612 eviction_group_resized(table
, evg
);
6618 /* Initializes 'table'. */
6620 oftable_init(struct oftable
*table
)
6622 memset(table
, 0, sizeof *table
);
6623 classifier_init(&table
->cls
, flow_segment_u32s
);
6624 table
->max_flows
= UINT_MAX
;
6627 /* Destroys 'table', including its classifier and eviction groups.
6629 * The caller is responsible for freeing 'table' itself. */
6631 oftable_destroy(struct oftable
*table
)
6633 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
6634 ovs_assert(classifier_is_empty(&table
->cls
));
6635 ovs_rwlock_unlock(&table
->cls
.rwlock
);
6636 oftable_disable_eviction(table
);
6637 classifier_destroy(&table
->cls
);
6641 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6642 * string, then 'table' will use its default name.
6644 * This only affects the name exposed for a table exposed through the OpenFlow
6645 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6647 oftable_set_name(struct oftable
*table
, const char *name
)
6649 if (name
&& name
[0]) {
6650 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
6651 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
6653 table
->name
= xmemdup0(name
, len
);
6661 /* oftables support a choice of two policies when adding a rule would cause the
6662 * number of flows in the table to exceed the configured maximum number: either
6663 * they can refuse to add the new flow or they can evict some existing flow.
6664 * This function configures the former policy on 'table'. */
6666 oftable_disable_eviction(struct oftable
*table
)
6667 OVS_REQUIRES(ofproto_mutex
)
6669 if (table
->eviction_fields
) {
6670 struct eviction_group
*evg
, *next
;
6672 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
6673 &table
->eviction_groups_by_id
) {
6674 eviction_group_destroy(table
, evg
);
6676 hmap_destroy(&table
->eviction_groups_by_id
);
6677 heap_destroy(&table
->eviction_groups_by_size
);
6679 free(table
->eviction_fields
);
6680 table
->eviction_fields
= NULL
;
6681 table
->n_eviction_fields
= 0;
6685 /* oftables support a choice of two policies when adding a rule would cause the
6686 * number of flows in the table to exceed the configured maximum number: either
6687 * they can refuse to add the new flow or they can evict some existing flow.
6688 * This function configures the latter policy on 'table', with fairness based
6689 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6690 * 'n_fields' as 0 disables fairness.) */
6692 oftable_enable_eviction(struct oftable
*table
,
6693 const struct mf_subfield
*fields
, size_t n_fields
)
6694 OVS_REQUIRES(ofproto_mutex
)
6696 struct cls_cursor cursor
;
6699 if (table
->eviction_fields
6700 && n_fields
== table
->n_eviction_fields
6702 || !memcmp(fields
, table
->eviction_fields
,
6703 n_fields
* sizeof *fields
))) {
6708 oftable_disable_eviction(table
);
6710 table
->n_eviction_fields
= n_fields
;
6711 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
6713 table
->eviction_group_id_basis
= random_uint32();
6714 hmap_init(&table
->eviction_groups_by_id
);
6715 heap_init(&table
->eviction_groups_by_size
);
6717 ovs_rwlock_rdlock(&table
->cls
.rwlock
);
6718 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
6719 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
6720 eviction_group_add_rule(rule
);
6722 ovs_rwlock_unlock(&table
->cls
.rwlock
);
6725 /* Removes 'rule' from the oftable that contains it. */
6727 oftable_remove_rule__(struct ofproto
*ofproto
, struct rule
*rule
)
6728 OVS_REQUIRES(ofproto_mutex
)
6730 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
6732 ovs_rwlock_wrlock(&cls
->rwlock
);
6733 classifier_remove(cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
6734 ovs_rwlock_unlock(&cls
->rwlock
);
6736 cookies_remove(ofproto
, rule
);
6738 eviction_group_remove_rule(rule
);
6739 if (!list_is_empty(&rule
->expirable
)) {
6740 list_remove(&rule
->expirable
);
6742 if (!list_is_empty(&rule
->meter_list_node
)) {
6743 list_remove(&rule
->meter_list_node
);
6744 list_init(&rule
->meter_list_node
);
6749 oftable_remove_rule(struct rule
*rule
)
6750 OVS_REQUIRES(ofproto_mutex
)
6752 oftable_remove_rule__(rule
->ofproto
, rule
);
6755 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6756 * the same cls_rule. */
6758 oftable_insert_rule(struct rule
*rule
)
6759 OVS_REQUIRES(ofproto_mutex
)
6761 struct ofproto
*ofproto
= rule
->ofproto
;
6762 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6765 ovs_mutex_lock(&rule
->mutex
);
6766 may_expire
= rule
->hard_timeout
|| rule
->idle_timeout
;
6767 ovs_mutex_unlock(&rule
->mutex
);
6770 list_insert(&ofproto
->expirable
, &rule
->expirable
);
6773 cookies_insert(ofproto
, rule
);
6775 if (rule
->actions
->provider_meter_id
!= UINT32_MAX
) {
6776 uint32_t meter_id
= ofpacts_get_meter(rule
->actions
->ofpacts
,
6777 rule
->actions
->ofpacts_len
);
6778 struct meter
*meter
= ofproto
->meters
[meter_id
];
6779 list_insert(&meter
->rules
, &rule
->meter_list_node
);
6781 ovs_rwlock_wrlock(&table
->cls
.rwlock
);
6782 classifier_insert(&table
->cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
6783 ovs_rwlock_unlock(&table
->cls
.rwlock
);
6784 eviction_group_add_rule(rule
);
6787 /* unixctl commands. */
6790 ofproto_lookup(const char *name
)
6792 struct ofproto
*ofproto
;
6794 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
6796 if (!strcmp(ofproto
->name
, name
)) {
6804 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
6805 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
6807 struct ofproto
*ofproto
;
6811 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
6812 ds_put_format(&results
, "%s\n", ofproto
->name
);
6814 unixctl_command_reply(conn
, ds_cstr(&results
));
6815 ds_destroy(&results
);
6819 ofproto_unixctl_init(void)
6821 static bool registered
;
6827 unixctl_command_register("ofproto/list", "", 0, 0,
6828 ofproto_unixctl_list
, NULL
);
6831 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6833 * This is deprecated. It is only for compatibility with broken device drivers
6834 * in old versions of Linux that do not properly support VLANs when VLAN
6835 * devices are not used. When broken device drivers are no longer in
6836 * widespread use, we will delete these interfaces. */
6838 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6839 * (exactly) by an OpenFlow rule in 'ofproto'. */
6841 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
6843 const struct oftable
*oftable
;
6845 free(ofproto
->vlan_bitmap
);
6846 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
6847 ofproto
->vlans_changed
= false;
6849 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
6850 const struct cls_subtable
*table
;
6852 ovs_rwlock_rdlock(&oftable
->cls
.rwlock
);
6853 HMAP_FOR_EACH (table
, hmap_node
, &oftable
->cls
.subtables
) {
6854 if (minimask_get_vid_mask(&table
->mask
) == VLAN_VID_MASK
) {
6855 const struct cls_rule
*rule
;
6857 HMAP_FOR_EACH (rule
, hmap_node
, &table
->rules
) {
6858 uint16_t vid
= miniflow_get_vid(&rule
->match
.flow
);
6859 bitmap_set1(vlan_bitmap
, vid
);
6860 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6864 ovs_rwlock_unlock(&oftable
->cls
.rwlock
);
6868 /* Returns true if new VLANs have come into use by the flow table since the
6869 * last call to ofproto_get_vlan_usage().
6871 * We don't track when old VLANs stop being used. */
6873 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
6875 return ofproto
->vlans_changed
;
6878 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6879 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6880 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6881 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6882 * then the VLAN device is un-enslaved. */
6884 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
6885 ofp_port_t realdev_ofp_port
, int vid
)
6887 struct ofport
*ofport
;
6890 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
6892 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
6894 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
6895 ofproto
->name
, vlandev_ofp_port
);
6899 if (!ofproto
->ofproto_class
->set_realdev
) {
6900 if (!vlandev_ofp_port
) {
6903 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
6907 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
6909 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
6910 ofproto
->name
, vlandev_ofp_port
,
6911 netdev_get_name(ofport
->netdev
), ovs_strerror(error
));