2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef OFPROTO_OFPROTO_PROVIDER_H
18 #define OFPROTO_OFPROTO_PROVIDER_H 1
20 /* Definitions for use within ofproto.
26 * Lots of ofproto data structures are only accessed from a single thread.
27 * Those data structures are generally not thread-safe.
29 * The ofproto-dpif ofproto implementation accesses the flow table from
30 * multiple threads, including modifying the flow table from multiple threads
31 * via the "learn" action, so the flow table and various structures that index
32 * it have been made thread-safe. Refer to comments on individual data
33 * structures for details.
37 #include "classifier.h"
38 #include "guarded-list.h"
42 #include "ofp-actions.h"
43 #include "ofp-errors.h"
45 #include "ofproto/ofproto.h"
46 #include "ovs-atomic.h"
48 #include "ovs-thread.h"
54 struct ofputil_flow_mod
;
59 extern struct ovs_mutex ofproto_mutex
;
61 /* An OpenFlow switch.
63 * With few exceptions, ofproto implementations may look at these fields but
64 * should not modify them. */
66 struct hmap_node hmap_node
; /* In global 'all_ofprotos' hmap. */
67 const struct ofproto_class
*ofproto_class
;
68 char *type
; /* Datapath type. */
69 char *name
; /* Datapath name. */
72 uint64_t fallback_dpid
; /* Datapath ID if no better choice found. */
73 uint64_t datapath_id
; /* Datapath ID. */
74 bool forward_bpdu
; /* Option to allow forwarding of BPDU frames
75 * when NORMAL action is invoked. */
76 char *mfr_desc
; /* Manufacturer (NULL for default). */
77 char *hw_desc
; /* Hardware (NULL for default). */
78 char *sw_desc
; /* Software version (NULL for default). */
79 char *serial_desc
; /* Serial number (NULL for default). */
80 char *dp_desc
; /* Datapath description (NULL for default). */
81 enum ofp_config_flags frag_handling
; /* One of OFPC_*. */
84 struct hmap ports
; /* Contains "struct ofport"s. */
85 struct shash port_by_name
;
86 struct simap ofp_requests
; /* OpenFlow port number requests. */
87 uint16_t alloc_port_no
; /* Last allocated OpenFlow port number. */
88 uint16_t max_ports
; /* Max possible OpenFlow port num, plus one. */
89 struct hmap ofport_usage
; /* Map ofport to last used time. */
90 uint64_t change_seq
; /* Change sequence for netdev status. */
93 long long int eviction_group_timer
; /* For rate limited reheapification. */
94 struct oftable
*tables
;
97 /* Rules indexed on their cookie values, in all flow tables. */
98 struct hindex cookies
OVS_GUARDED_BY(ofproto_mutex
);
99 struct hmap learned_cookies
OVS_GUARDED_BY(ofproto_mutex
);
101 /* List of expirable flows, in all flow tables. */
102 struct list expirable
OVS_GUARDED_BY(ofproto_mutex
);
105 * OpenFlow meters start at 1. To avoid confusion we leave the first
106 * pointer in the array un-used, and index directly with the OpenFlow
108 struct ofputil_meter_features meter_features
;
109 struct meter
**meters
; /* 'meter_features.max_meter' + 1 pointers. */
111 /* OpenFlow connections. */
112 struct connmgr
*connmgr
;
114 /* Delayed rule executions.
116 * We delay calls to ->ofproto_class->rule_execute() past releasing
117 * ofproto_mutex during a flow_mod, because otherwise a "learn" action
118 * triggered by the executing the packet would try to recursively modify
119 * the flow table and reacquire the global lock. */
120 struct guarded_list rule_executes
; /* Contains "struct rule_execute"s. */
122 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
124 * This is deprecated. It is only for compatibility with broken device
125 * drivers in old versions of Linux that do not properly support VLANs when
126 * VLAN devices are not used. When broken device drivers are no longer in
127 * widespread use, we will delete these interfaces. */
128 unsigned long int *vlan_bitmap
; /* 4096-bit bitmap of in-use VLANs. */
129 bool vlans_changed
; /* True if new VLANs are in use. */
130 int min_mtu
; /* Current MTU of non-internal ports. */
133 struct ovs_rwlock groups_rwlock
;
134 struct hmap groups OVS_GUARDED
; /* Contains "struct ofgroup"s. */
135 uint32_t n_groups
[4] OVS_GUARDED
; /* # of existing groups of each type. */
136 struct ofputil_group_features ogf
;
139 void ofproto_init_tables(struct ofproto
*, int n_tables
);
140 void ofproto_init_max_ports(struct ofproto
*, uint16_t max_ports
);
142 struct ofproto
*ofproto_lookup(const char *name
);
143 struct ofport
*ofproto_get_port(const struct ofproto
*, ofp_port_t ofp_port
);
145 /* An OpenFlow port within a "struct ofproto".
147 * The port's name is netdev_get_name(port->netdev).
149 * With few exceptions, ofproto implementations may look at these fields but
150 * should not modify them. */
152 struct hmap_node hmap_node
; /* In struct ofproto's "ports" hmap. */
153 struct ofproto
*ofproto
; /* The ofproto that contains this port. */
154 struct netdev
*netdev
;
155 struct ofputil_phy_port pp
;
156 ofp_port_t ofp_port
; /* OpenFlow port number. */
158 long long int created
; /* Time created, in msec. */
162 void ofproto_port_set_state(struct ofport
*, enum ofputil_port_state
);
164 /* OpenFlow table flags:
166 * - "Hidden" tables are not included in OpenFlow operations that operate on
167 * "all tables". For example, a request for flow stats on all tables will
168 * omit flows in hidden tables, table stats requests will omit the table
169 * entirely, and the switch features reply will not count the hidden table.
171 * However, operations that specifically name the particular table still
172 * operate on it. For example, flow_mods and flow stats requests on a
175 * To avoid gaps in table IDs (which have unclear validity in OpenFlow),
176 * hidden tables must be the highest-numbered tables that a provider
179 * - "Read-only" tables can't be changed through OpenFlow operations. (At
180 * the moment all flow table operations go effectively through OpenFlow, so
181 * this means that read-only tables can't be changed at all after the
182 * read-only flag is set.)
184 * The generic ofproto layer never sets these flags. An ofproto provider can
185 * set them if it is appropriate.
188 OFTABLE_HIDDEN
= 1 << 0, /* Hide from most OpenFlow operations. */
189 OFTABLE_READONLY
= 1 << 1 /* Don't allow OpenFlow controller to change
193 /* A flow table within a "struct ofproto".
199 * Adding or removing rules requires holding ofproto_mutex.
201 * Rules in 'cls' are RCU protected. For extended access to a rule, try
202 * incrementing its ref_count with ofproto_rule_try_ref(), or
203 * ofproto_rule_ref(), if the rule is still known to be in 'cls'. A rule
204 * will be freed using ovsrcu_postpone() once its 'ref_count' reaches zero.
206 * Modifying a rule requires the rule's own mutex.
208 * Freeing a rule requires ofproto_mutex. After removing the rule from the
209 * classifier, release a ref_count from the rule ('cls''s reference to the
212 * Refer to the thread-safety notes on struct rule for more information.*/
214 enum oftable_flags flags
;
215 struct classifier cls
; /* Contains "struct rule"s. */
216 char *name
; /* Table name exposed via OpenFlow, or NULL. */
218 /* Maximum number of flows or UINT_MAX if there is no limit besides any
219 * limit imposed by resource limitations. */
220 unsigned int max_flows
;
222 /* These members determine the handling of an attempt to add a flow that
223 * would cause the table to have more than 'max_flows' flows.
225 * If 'eviction_fields' is NULL, overflows will be rejected with an error.
227 * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
228 * is nonzero), an overflow will cause a flow to be removed. The flow to
229 * be removed is chosen to give fairness among groups distinguished by
230 * different values for the subfields within 'groups'. */
231 struct mf_subfield
*eviction_fields
;
232 size_t n_eviction_fields
;
236 * When a flow is added that would cause the table to have more than
237 * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
238 * used to decide which rule to evict: the rule is chosen from the eviction
239 * group that contains the greatest number of rules.*/
240 uint32_t eviction_group_id_basis
;
241 struct hmap eviction_groups_by_id
;
242 struct heap eviction_groups_by_size
;
244 /* Table configuration. */
245 ATOMIC(enum ofputil_table_miss
) miss_config
;
247 atomic_ulong n_matched
;
248 atomic_ulong n_missed
;
251 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
253 * All parameters are evaluated multiple times. */
254 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO) \
255 for ((TABLE) = (OFPROTO)->tables; \
256 (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
259 /* An OpenFlow flow within a "struct ofproto".
261 * With few exceptions, ofproto implementations may look at these fields but
262 * should not modify them.
268 * Except near the beginning or ending of its lifespan, rule 'rule' belongs to
269 * the classifier rule->ofproto->tables[rule->table_id].cls. The text below
270 * calls this classifier 'cls'.
275 * The thread safety rules described here for "struct rule" are motivated by
278 * - Prevent threads that read members of "struct rule" from reading bad
279 * data due to changes by some thread concurrently modifying those
282 * - Prevent two threads making changes to members of a given "struct rule"
283 * from interfering with each other.
289 * A rule 'rule' may be accessed without a risk of being freed by a thread
290 * until the thread quiesces (i.e., rules are RCU protected and destructed
291 * using ovsrcu_postpone()). Code that needs to hold onto a rule for a
292 * while should increment 'rule->ref_count' either with ofproto_rule_ref()
293 * (if 'ofproto_mutex' is held), or with ofproto_rule_try_ref() (when some
294 * other thread might remove the rule from 'cls'). ofproto_rule_try_ref()
295 * will fail if the rule has already been scheduled for destruction.
297 * 'rule->ref_count' protects 'rule' from being freed. It doesn't protect the
298 * rule from being deleted from 'cls' (that's 'ofproto_mutex') and it doesn't
299 * protect members of 'rule' from modification (that's 'rule->mutex').
301 * 'rule->mutex' protects the members of 'rule' from modification. It doesn't
302 * protect the rule from being deleted from 'cls' (that's 'ofproto_mutex') and
303 * it doesn't prevent the rule from being freed (that's 'rule->ref_count').
305 * Regarding thread safety, the members of a rule fall into the following
308 * - Immutable. These members are marked 'const'.
310 * - Members that may be safely read or written only by code holding
311 * ofproto_mutex. These are marked OVS_GUARDED_BY(ofproto_mutex).
313 * - Members that may be safely read only by code holding ofproto_mutex or
314 * 'rule->mutex', and safely written only by coding holding ofproto_mutex
315 * AND 'rule->mutex'. These are marked OVS_GUARDED.
318 /* Where this rule resides in an OpenFlow switch.
320 * These are immutable once the rule is constructed, hence 'const'. */
321 struct ofproto
*const ofproto
; /* The ofproto that contains this rule. */
322 const struct cls_rule cr
; /* In owning ofproto's classifier. */
323 const uint8_t table_id
; /* Index in ofproto's 'tables' array. */
325 /* Protects members marked OVS_GUARDED.
326 * Readers only need to hold this mutex.
327 * Writers must hold both this mutex AND ofproto_mutex.
328 * By implication writers can read *without* taking this mutex while they
329 * hold ofproto_mutex. */
330 struct ovs_mutex mutex
OVS_ACQ_AFTER(ofproto_mutex
);
332 /* Number of references.
333 * The classifier owns one reference.
334 * Any thread trying to keep a rule from being freed should hold its own
336 struct ovs_refcount ref_count
;
338 /* A "flow cookie" is the OpenFlow name for a 64-bit value associated with
340 ovs_be64 flow_cookie OVS_GUARDED
;
341 struct hindex_node cookie_node
OVS_GUARDED_BY(ofproto_mutex
);
343 enum ofputil_flow_mod_flags flags OVS_GUARDED
;
346 uint16_t hard_timeout OVS_GUARDED
; /* In seconds from ->modified. */
347 uint16_t idle_timeout OVS_GUARDED
; /* In seconds from ->used. */
349 /* Eviction precedence. */
350 uint16_t importance OVS_GUARDED
;
352 /* Eviction groups (see comment on struct eviction_group for explanation) .
354 * 'eviction_group' is this rule's eviction group, or NULL if it is not in
355 * any eviction group. When 'eviction_group' is nonnull, 'evg_node' is in
356 * the ->eviction_group->rules hmap. */
357 struct eviction_group
*eviction_group
OVS_GUARDED_BY(ofproto_mutex
);
358 struct heap_node evg_node
OVS_GUARDED_BY(ofproto_mutex
);
360 /* OpenFlow actions. See struct rule_actions for more thread-safety
362 OVSRCU_TYPE(const struct rule_actions
*) actions
;
364 /* In owning meter's 'rules' list. An empty list if there is no meter. */
365 struct list meter_list_node
OVS_GUARDED_BY(ofproto_mutex
);
367 /* Flow monitors (e.g. for NXST_FLOW_MONITOR, related to struct ofmonitor).
369 * 'add_seqno' is the sequence number when this rule was created.
370 * 'modify_seqno' is the sequence number when this rule was last modified.
371 * See 'monitor_seqno' in connmgr.c for more information. */
372 enum nx_flow_monitor_flags monitor_flags
OVS_GUARDED_BY(ofproto_mutex
);
373 uint64_t add_seqno
OVS_GUARDED_BY(ofproto_mutex
);
374 uint64_t modify_seqno
OVS_GUARDED_BY(ofproto_mutex
);
376 /* Optimisation for flow expiry. In ofproto's 'expirable' list if this
377 * rule is expirable, otherwise empty. */
378 struct list expirable
OVS_GUARDED_BY(ofproto_mutex
);
380 /* Times. Last so that they are more likely close to the stats managed
381 * by the provider. */
382 long long int created OVS_GUARDED
; /* Creation time. */
384 /* Must hold 'mutex' for both read/write, 'ofproto_mutex' not needed. */
385 long long int modified OVS_GUARDED
; /* Time of last modification. */
388 void ofproto_rule_ref(struct rule
*);
389 bool ofproto_rule_try_ref(struct rule
*);
390 void ofproto_rule_unref(struct rule
*);
392 static inline const struct rule_actions
* rule_get_actions(const struct rule
*);
393 static inline bool rule_is_table_miss(const struct rule
*);
394 static inline bool rule_is_hidden(const struct rule
*);
396 /* A set of actions within a "struct rule".
402 * A struct rule_actions may be accessed without a risk of being freed by
403 * code that holds 'rule->mutex' (where 'rule' is the rule for which
404 * 'rule->actions == actions') or during the RCU active period.
406 * All members are immutable: they do not change during the struct's
408 struct rule_actions
{
411 * 'has_meter' is true if 'ofpacts' contains an OFPACT_METER action.
413 * 'has_learn_with_delete' is true if 'ofpacts' contains an OFPACT_LEARN
414 * action whose flags include NX_LEARN_F_DELETE_LEARNED. */
416 bool has_learn_with_delete
;
419 uint32_t ofpacts_len
; /* Size of 'ofpacts', in bytes. */
420 struct ofpact ofpacts
[]; /* Sequence of "struct ofpacts". */
422 BUILD_ASSERT_DECL(offsetof(struct rule_actions
, ofpacts
) % OFPACT_ALIGNTO
== 0);
424 const struct rule_actions
*rule_actions_create(const struct ofpact
*, size_t);
425 void rule_actions_destroy(const struct rule_actions
*);
426 bool ofproto_rule_has_out_port(const struct rule
*, ofp_port_t port
)
427 OVS_REQUIRES(ofproto_mutex
);
429 /* A set of rules to which an OpenFlow operation applies. */
430 struct rule_collection
{
431 struct rule
**rules
; /* The rules. */
432 size_t n
; /* Number of rules collected. */
434 size_t capacity
; /* Number of rules that will fit in 'rules'. */
435 struct rule
*stub
[64]; /* Preallocated rules to avoid malloc(). */
438 void rule_collection_init(struct rule_collection
*);
439 void rule_collection_add(struct rule_collection
*, struct rule
*);
440 void rule_collection_ref(struct rule_collection
*) OVS_REQUIRES(ofproto_mutex
);
441 void rule_collection_unref(struct rule_collection
*);
442 void rule_collection_destroy(struct rule_collection
*);
444 /* Limits the number of flows allowed in the datapath. Only affects the
445 * ofproto-dpif implementation. */
446 extern unsigned ofproto_flow_limit
;
448 /* Maximum idle time (in ms) for flows to be cached in the datapath.
449 * Revalidators may expire flows more quickly than the configured value based
450 * on system load and other factors. This variable is subject to change. */
451 extern unsigned ofproto_max_idle
;
453 /* Number of upcall handler and revalidator threads. Only affects the
454 * ofproto-dpif implementation. */
455 extern size_t n_handlers
, n_revalidators
;
457 /* Number of rx queues to be created for each dpdk interface. */
458 extern size_t n_dpdk_rxqs
;
460 /* Cpu mask for pmd threads. */
461 extern char *pmd_cpu_mask
;
463 static inline struct rule
*rule_from_cls_rule(const struct cls_rule
*);
465 void ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
466 OVS_REQUIRES(ofproto_mutex
);
467 void ofproto_rule_delete(struct ofproto
*, struct rule
*)
468 OVS_EXCLUDED(ofproto_mutex
);
469 void ofproto_rule_reduce_timeouts(struct rule
*rule
, uint16_t idle_timeout
,
470 uint16_t hard_timeout
)
471 OVS_EXCLUDED(ofproto_mutex
);
473 /* A group within a "struct ofproto".
475 * With few exceptions, ofproto implementations may look at these fields but
476 * should not modify them. */
478 struct hmap_node hmap_node OVS_GUARDED
; /* In ofproto's "groups" hmap. */
480 /* Number of references.
482 * This is needed to keep track of references to the group in the xlate
485 * If the main thread removes the group from an ofproto, we need to
486 * guarantee that the group remains accessible to users of
487 * xlate_group_actions and the xlate_cache, as the xlate_cache will not be
488 * cleaned up until the corresponding datapath flows are revalidated. */
489 struct ovs_refcount ref_count
;
491 /* No lock is needed to protect the fields below since they are not
492 * modified after construction. */
493 const struct ofproto
*ofproto
; /* The ofproto that contains this group. */
494 const uint32_t group_id
;
495 const enum ofp11_group_type type
; /* One of OFPGT_*. */
497 const long long int created
; /* Creation time. */
498 const long long int modified
; /* Time of last modification. */
500 struct list buckets
; /* Contains "struct ofputil_bucket"s. */
501 const uint32_t n_buckets
;
504 bool ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
505 struct ofgroup
**group
);
507 void ofproto_group_ref(struct ofgroup
*);
508 void ofproto_group_unref(struct ofgroup
*);
510 /* ofproto class structure, to be defined by each ofproto implementation.
516 * These functions work primarily with four different kinds of data
519 * - "struct ofproto", which represents an OpenFlow switch.
521 * - "struct ofport", which represents a port within an ofproto.
523 * - "struct rule", which represents an OpenFlow flow within an ofproto.
525 * - "struct ofgroup", which represents an OpenFlow 1.1+ group within an
528 * Each of these data structures contains all of the implementation-independent
529 * generic state for the respective concept, called the "base" state. None of
530 * them contains any extra space for ofproto implementations to use. Instead,
531 * each implementation is expected to declare its own data structure that
532 * contains an instance of the generic data structure plus additional
533 * implementation-specific members, called the "derived" state. The
534 * implementation can use casts or (preferably) the CONTAINER_OF macro to
535 * obtain access to derived state given only a pointer to the embedded generic
542 * Four stylized functions accompany each of these data structures:
544 * "alloc" "construct" "destruct" "dealloc"
545 * ------------ ---------------- --------------- --------------
546 * ofproto ->alloc ->construct ->destruct ->dealloc
547 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
548 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
549 * group ->group_alloc ->group_construct ->group_destruct ->group_dealloc
551 * "ofproto", "ofport", and "group" have this exact life cycle. The "rule"
552 * data structure also follow this life cycle with some additional elaborations
553 * described under "Rule Life Cycle" below.
555 * Any instance of a given data structure goes through the following life
558 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
559 * fails, skip all the other steps.
561 * 2. The client initializes all of the data structure's base state. If this
562 * fails, skip to step 7.
564 * 3. The client calls the "construct" function. The implementation
565 * initializes derived state. It may refer to the already-initialized
566 * base state. If "construct" fails, skip to step 6.
568 * 4. The data structure is now initialized and in use.
570 * 5. When the data structure is no longer needed, the client calls the
571 * "destruct" function. The implementation uninitializes derived state.
572 * The base state has not been uninitialized yet, so the implementation
573 * may still refer to it.
575 * 6. The client uninitializes all of the data structure's base state.
577 * 7. The client calls the "dealloc" to free the raw memory. The
578 * implementation must not refer to base or derived state in the data
579 * structure, because it has already been uninitialized.
581 * Each "alloc" function allocates and returns a new instance of the respective
582 * data structure. The "alloc" function is not given any information about the
583 * use of the new data structure, so it cannot perform much initialization.
584 * Its purpose is just to ensure that the new data structure has enough room
585 * for base and derived state. It may return a null pointer if memory is not
586 * available, in which case none of the other functions is called.
588 * Each "construct" function initializes derived state in its respective data
589 * structure. When "construct" is called, all of the base state has already
590 * been initialized, so the "construct" function may refer to it. The
591 * "construct" function is allowed to fail, in which case the client calls the
592 * "dealloc" function (but not the "destruct" function).
594 * Each "destruct" function uninitializes and frees derived state in its
595 * respective data structure. When "destruct" is called, the base state has
596 * not yet been uninitialized, so the "destruct" function may refer to it. The
597 * "destruct" function is not allowed to fail.
599 * Each "dealloc" function frees raw memory that was allocated by the the
600 * "alloc" function. The memory's base and derived members might not have ever
601 * been initialized (but if "construct" returned successfully, then it has been
602 * "destruct"ed already). The "dealloc" function is not allowed to fail.
608 * Most of these functions return 0 if they are successful or a positive error
609 * code on failure. Depending on the function, valid error codes are either
610 * errno values or OFPERR_* OpenFlow error codes.
612 * Most of these functions are expected to execute synchronously, that is, to
613 * block as necessary to obtain a result. Thus, these functions may return
614 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
615 * explicitly say those errors are a possibility. We may relax this
616 * requirement in the future if and when we encounter performance problems. */
617 struct ofproto_class
{
618 /* ## ----------------- ## */
619 /* ## Factory Functions ## */
620 /* ## ----------------- ## */
622 /* Initializes provider. The caller may pass in 'iface_hints',
623 * which contains an shash of "struct iface_hint" elements indexed
624 * by the interface's name. The provider may use these hints to
625 * describe the startup configuration in order to reinitialize its
626 * state. The caller owns the provided data, so a provider must
627 * make copies of anything required. An ofproto provider must
628 * remove any existing state that is not described by the hint, and
629 * may choose to remove it all. */
630 void (*init
)(const struct shash
*iface_hints
);
632 /* Enumerates the types of all support ofproto types into 'types'. The
633 * caller has already initialized 'types' and other ofproto classes might
634 * already have added names to it. */
635 void (*enumerate_types
)(struct sset
*types
);
637 /* Enumerates the names of all existing datapath of the specified 'type'
638 * into 'names' 'all_dps'. The caller has already initialized 'names' as
641 * 'type' is one of the types enumerated by ->enumerate_types().
643 * Returns 0 if successful, otherwise a positive errno value.
645 int (*enumerate_names
)(const char *type
, struct sset
*names
);
647 /* Deletes the datapath with the specified 'type' and 'name'. The caller
648 * should have closed any open ofproto with this 'type' and 'name'; this
649 * function is allowed to fail if that is not the case.
651 * 'type' is one of the types enumerated by ->enumerate_types().
652 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
654 * Returns 0 if successful, otherwise a positive errno value.
656 int (*del
)(const char *type
, const char *name
);
658 /* Returns the type to pass to netdev_open() when a datapath of type
659 * 'datapath_type' has a port of type 'port_type', for a few special
660 * cases when a netdev type differs from a port type. For example,
661 * when using the userspace datapath, a port of type "internal"
662 * needs to be opened as "tap".
664 * Returns either 'type' itself or a string literal, which must not
666 const char *(*port_open_type
)(const char *datapath_type
,
667 const char *port_type
);
669 /* ## ------------------------ ## */
670 /* ## Top-Level type Functions ## */
671 /* ## ------------------------ ## */
673 /* Performs any periodic activity required on ofprotos of type
676 * An ofproto provider may implement it or not, depending on whether
677 * it needs type-level maintenance.
679 * Returns 0 if successful, otherwise a positive errno value. */
680 int (*type_run
)(const char *type
);
682 /* Causes the poll loop to wake up when a type 'type''s 'run'
683 * function needs to be called, e.g. by calling the timer or fd
684 * waiting functions in poll-loop.h.
686 * An ofproto provider may implement it or not, depending on whether
687 * it needs type-level maintenance. */
688 void (*type_wait
)(const char *type
);
690 /* ## --------------------------- ## */
691 /* ## Top-Level ofproto Functions ## */
692 /* ## --------------------------- ## */
694 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
700 * ->construct() should not modify any base members of the ofproto. The
701 * client will initialize the ofproto's 'ports' and 'tables' members after
702 * construction is complete.
704 * When ->construct() is called, the client does not yet know how many flow
705 * tables the datapath supports, so ofproto->n_tables will be 0 and
706 * ofproto->tables will be NULL. ->construct() should call
707 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
708 * ofproto->tables. Each flow table will be initially empty, so
709 * ->construct() should delete flows from the underlying datapath, if
710 * necessary, rather than populating the tables.
712 * If the ofproto knows the maximum port number that the datapath can have,
713 * then it can call ofproto_init_max_ports(). If it does so, then the
714 * client will ensure that the actions it allows to be used through
715 * OpenFlow do not refer to ports above that maximum number.
717 * Only one ofproto instance needs to be supported for any given datapath.
718 * If a datapath is already open as part of one "ofproto", then another
719 * attempt to "construct" the same datapath as part of another ofproto is
720 * allowed to fail with an error.
722 * ->construct() returns 0 if successful, otherwise a positive errno
729 * ->destruct() must also destroy all remaining rules in the ofproto's
730 * tables, by passing each remaining rule to ofproto_rule_delete().
732 * The client will destroy the flow tables themselves after ->destruct()
735 struct ofproto
*(*alloc
)(void);
736 int (*construct
)(struct ofproto
*ofproto
);
737 void (*destruct
)(struct ofproto
*ofproto
);
738 void (*dealloc
)(struct ofproto
*ofproto
);
740 /* Performs any periodic activity required by 'ofproto'. It should:
742 * - Call connmgr_send_packet_in() for each received packet that missed
743 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
746 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
747 * its hard_timeout or idle_timeout, to expire the flow.
749 * Returns 0 if successful, otherwise a positive errno value. */
750 int (*run
)(struct ofproto
*ofproto
);
752 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
753 * be called, e.g. by calling the timer or fd waiting functions in
755 void (*wait
)(struct ofproto
*ofproto
);
757 /* Adds some memory usage statistics for the implementation of 'ofproto'
758 * into 'usage', for use with memory_report().
760 * This function is optional. */
761 void (*get_memory_usage
)(const struct ofproto
*ofproto
,
762 struct simap
*usage
);
764 /* Adds some memory usage statistics for the implementation of 'type'
765 * into 'usage', for use with memory_report().
767 * This function is optional. */
768 void (*type_get_memory_usage
)(const char *type
, struct simap
*usage
);
770 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
771 * This function may prepare for that, for example by clearing state in
772 * advance. It should *not* actually delete any "struct rule"s from
773 * 'ofproto', only prepare for it.
775 * This function is optional; it's really just for optimization in case
776 * it's cheaper to delete all the flows from your hardware in a single pass
777 * than to do it one by one. */
778 void (*flush
)(struct ofproto
*ofproto
);
780 /* Helper for the OpenFlow OFPT_TABLE_FEATURES request.
782 * The 'features' array contains 'ofproto->n_tables' elements. Each
783 * element is initialized as:
785 * - 'table_id' to the array index.
787 * - 'name' to "table#" where # is the table ID.
789 * - 'metadata_match' and 'metadata_write' to OVS_BE64_MAX.
791 * - 'config' to the table miss configuration.
793 * - 'max_entries' to 1,000,000.
795 * - Both 'nonmiss' and 'miss' to:
797 * * 'next' to all 1-bits for all later tables.
799 * * 'instructions' to all instructions.
801 * * 'write' and 'apply' both to:
803 * - 'ofpacts': All actions.
805 * - 'set_fields': All fields.
807 * - 'match', 'mask', and 'wildcard' to all fields.
809 * If 'stats' is nonnull, it also contains 'ofproto->n_tables' elements.
810 * Each element is initialized as:
812 * - 'table_id' to the array index.
814 * - 'active_count' to the classifier_count() for the table.
816 * - 'lookup_count' and 'matched_count' to 0.
818 * The implementation should update any members in each element for which
819 * it has better values:
821 * - Any member of 'features' to better describe the implementation's
824 * - 'lookup_count' to the number of packets looked up in this flow table
827 * - 'matched_count' to the number of packets looked up in this flow
828 * table so far that matched one of the flow entries.
830 void (*query_tables
)(struct ofproto
*ofproto
,
831 struct ofputil_table_features
*features
,
832 struct ofputil_table_stats
*stats
);
834 /* ## ---------------- ## */
835 /* ## ofport Functions ## */
836 /* ## ---------------- ## */
838 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
840 * ->port_construct() should not modify any base members of the ofport.
841 * An ofproto implementation should use the 'ofp_port' member of
842 * "struct ofport" as the OpenFlow port number.
844 * ofports are managed by the base ofproto code. The ofproto
845 * implementation should only create and destroy them in response to calls
846 * to these functions. The base ofproto code will create and destroy
847 * ofports in the following situations:
849 * - Just after the ->construct() function is called, the base ofproto
850 * iterates over all of the implementation's ports, using
851 * ->port_dump_start() and related functions, and constructs an ofport
852 * for each dumped port.
854 * - If ->port_poll() reports that a specific port has changed, then the
855 * base ofproto will query that port with ->port_query_by_name() and
856 * construct or destruct ofports as necessary to reflect the updated
859 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
860 * change, then the base ofproto will iterate over all of the
861 * implementation's ports, in the same way as at ofproto
862 * initialization, and construct and destruct ofports to reflect all of
865 * ->port_construct() returns 0 if successful, otherwise a positive errno
868 struct ofport
*(*port_alloc
)(void);
869 int (*port_construct
)(struct ofport
*ofport
);
870 void (*port_destruct
)(struct ofport
*ofport
);
871 void (*port_dealloc
)(struct ofport
*ofport
);
873 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
874 * the ofproto implementation uses the ofport's netdev internally, then it
875 * should switch to using the new one. The old one has been closed.
877 * An ofproto implementation that doesn't need to do anything in this
878 * function may use a null pointer. */
879 void (*port_modified
)(struct ofport
*ofport
);
881 /* Called after an OpenFlow request changes a port's configuration.
882 * 'ofport->pp.config' contains the new configuration. 'old_config'
883 * contains the previous configuration.
885 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
886 * turn NETDEV_UP on and off, so this function doesn't have to do anything
887 * for that bit (and it won't be called if that is the only bit that
889 void (*port_reconfigured
)(struct ofport
*ofport
,
890 enum ofputil_port_config old_config
);
892 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
893 * initializes '*port' appropriately. Otherwise, returns a positive errno
896 * The caller owns the data in 'port' and must free it with
897 * ofproto_port_destroy() when it is no longer needed. */
898 int (*port_query_by_name
)(const struct ofproto
*ofproto
,
899 const char *devname
, struct ofproto_port
*port
);
901 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
902 * successful, otherwise a positive errno value. The caller should
903 * inform the implementation of the OpenFlow port through the
904 * ->port_construct() method.
906 * It doesn't matter whether the new port will be returned by a later call
907 * to ->port_poll(); the implementation may do whatever is more
909 int (*port_add
)(struct ofproto
*ofproto
, struct netdev
*netdev
);
911 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
912 * 0 if successful, otherwise a positive errno value.
914 * It doesn't matter whether the new port will be returned by a later call
915 * to ->port_poll(); the implementation may do whatever is more
917 int (*port_del
)(struct ofproto
*ofproto
, ofp_port_t ofp_port
);
920 int (*port_get_stats
)(const struct ofport
*port
,
921 struct netdev_stats
*stats
);
923 /* Port iteration functions.
925 * The client might not be entirely in control of the ports within an
926 * ofproto. Some hardware implementations, for example, might have a fixed
927 * set of ports in a datapath. For this reason, the client needs a way to
928 * iterate through all the ports that are actually in a datapath. These
929 * functions provide that functionality.
931 * The 'state' pointer provides the implementation a place to
932 * keep track of its position. Its format is opaque to the caller.
934 * The ofproto provider retains ownership of the data that it stores into
935 * ->port_dump_next()'s 'port' argument. The data must remain valid until
936 * at least the next call to ->port_dump_next() or ->port_dump_done() for
937 * 'state'. The caller will not modify or free it.
942 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
943 * On success, it should return 0 and initialize '*statep' with any data
944 * needed for iteration. On failure, returns a positive errno value, and
945 * the client will not call ->port_dump_next() or ->port_dump_done().
947 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
948 * 'state'. If there is another port, it should store the port's
949 * information into 'port' and return 0. It should return EOF if all ports
950 * have already been iterated. Otherwise, on error, it should return a
951 * positive errno value. This function will not be called again once it
952 * returns nonzero once for a given iteration (but the 'port_dump_done'
953 * function will be called afterward).
955 * ->port_dump_done() allows the implementation to release resources used
956 * for iteration. The caller might decide to stop iteration in the middle
957 * by calling this function before ->port_dump_next() returns nonzero.
965 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
968 * struct ofproto_port port;
970 * error = ofproto->ofproto_class->port_dump_next(
971 * ofproto, state, &port);
975 * // Do something with 'port' here (without modifying or freeing
976 * // any of its data).
978 * ofproto->ofproto_class->port_dump_done(ofproto, state);
980 * // 'error' is now EOF (success) or a positive errno value (failure).
982 int (*port_dump_start
)(const struct ofproto
*ofproto
, void **statep
);
983 int (*port_dump_next
)(const struct ofproto
*ofproto
, void *state
,
984 struct ofproto_port
*port
);
985 int (*port_dump_done
)(const struct ofproto
*ofproto
, void *state
);
987 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
988 * in 'ofproto' has changed, then this function should do one of the
991 * - Preferably: store the name of the device that was added to or deleted
992 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
993 * for freeing '*devnamep' (with free()) when it no longer needs it.
995 * - Alternatively: return ENOBUFS, without indicating the device that was
998 * Occasional 'false positives', in which the function returns 0 while
999 * indicating a device that was not actually added or deleted or returns
1000 * ENOBUFS without any change, are acceptable.
1002 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
1003 * externally to the 'ofproto' object, e.g. by a system administrator via
1004 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
1005 * not report changes made through calls to 'port_add' or 'port_del' on the
1006 * same 'ofproto' object. (But it's OK for it to report them too, just
1007 * slightly less efficient.)
1009 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
1010 * also return other positive errno values to indicate that something has
1013 * If the set of ports in a datapath is fixed, or if the only way that the
1014 * set of ports in a datapath can change is through ->port_add() and
1015 * ->port_del(), then this function may be a null pointer.
1017 int (*port_poll
)(const struct ofproto
*ofproto
, char **devnamep
);
1019 /* Arranges for the poll loop to wake up when ->port_poll() will return a
1020 * value other than EAGAIN.
1022 * If the set of ports in a datapath is fixed, or if the only way that the
1023 * set of ports in a datapath can change is through ->port_add() and
1024 * ->port_del(), or if the poll loop will always wake up anyway when
1025 * ->port_poll() will return a value other than EAGAIN, then this function
1026 * may be a null pointer.
1028 void (*port_poll_wait
)(const struct ofproto
*ofproto
);
1030 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
1031 * partner information for 'port' is up-to-date, 0 if LACP partner
1032 * information is not current (generally indicating a connectivity
1033 * problem), or -1 if LACP is not enabled on 'port'.
1035 * This function may be a null pointer if the ofproto implementation does
1036 * not support LACP. */
1037 int (*port_is_lacp_current
)(const struct ofport
*port
);
1039 /* Get LACP port stats. Returns -1 if LACP is not enabled on 'port'.
1041 * This function may be a null pointer if the ofproto implementation does
1042 * not support LACP. */
1043 int (*port_get_lacp_stats
)(const struct ofport
*port
,
1044 struct lacp_slave_stats
*stats
);
1047 /* ## ----------------------- ## */
1048 /* ## OpenFlow Rule Functions ## */
1049 /* ## ----------------------- ## */
1051 /* Chooses an appropriate table for 'match' within 'ofproto'. On
1052 * success, stores the table ID into '*table_idp' and returns 0. On
1053 * failure, returns an OpenFlow error code.
1055 * The choice of table should be a function of 'match' and 'ofproto''s
1056 * datapath capabilities. It should not depend on the flows already in
1057 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
1058 * 'match' as its matching condition can never be inserted into 'ofproto',
1059 * even starting from an empty flow table.
1061 * If multiple tables are candidates for inserting the flow, the function
1062 * should choose one arbitrarily (but deterministically).
1064 * If this function is NULL then table 0 is always chosen. */
1065 enum ofperr (*rule_choose_table
)(const struct ofproto
*ofproto
,
1066 const struct match
*match
,
1067 uint8_t *table_idp
);
1069 /* Life-cycle functions for a "struct rule".
1075 * The life cycle of a struct rule is an elaboration of the basic life
1076 * cycle described above under "Life Cycle".
1078 * After a rule is successfully constructed, it is then inserted. If
1079 * insertion is successful, then before it is later destructed, it is
1082 * You can think of a rule as having the following extra steps inserted
1083 * between "Life Cycle" steps 4 and 5:
1085 * 4.1. The client inserts the rule into the flow table, making it
1086 * visible in flow table lookups.
1088 * 4.2. The client calls "rule_insert" to insert the flow. The
1089 * implementation attempts to install the flow in the underlying
1090 * hardware and returns an error code indicate success or failure.
1091 * On failure, go to step 5.
1093 * 4.3. The rule is now installed in the flow table. Eventually it will
1096 * 4.4. The client removes the rule from the flow table. It is no longer
1097 * visible in flow table lookups.
1099 * 4.5. The client calls "rule_delete". The implementation uninstalls
1100 * the flow from the underlying hardware. Deletion is not allowed
1107 * When ->rule_construct() is called, 'rule' is a new rule that is not yet
1108 * inserted into a flow table. ->rule_construct() should initialize enough
1109 * of the rule's derived state for 'rule' to be suitable for inserting into
1110 * a flow table. ->rule_construct() should not modify any base members of
1113 * If ->rule_construct() fails (as indicated by returning a nonzero
1114 * OpenFlow error code), the ofproto base code will uninitialize and
1115 * deallocate 'rule'. See "Rule Life Cycle" above for more details.
1117 * ->rule_construct() may also:
1119 * - Validate that the datapath supports the matching rule in 'rule->cr'
1120 * datapath. For example, if the rule's table does not support
1121 * registers, then it is an error if 'rule->cr' does not wildcard all
1124 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
1126 * Some implementations might need to defer these tasks to ->rule_insert(),
1127 * which is also acceptable.
1133 * Following successful construction, the ofproto base case inserts 'rule'
1134 * into its flow table, then it calls ->rule_insert(). ->rule_insert()
1135 * must add the new rule to the datapath flow table and return only after
1136 * this is complete (whether it succeeds or fails).
1138 * If ->rule_insert() fails, the ofproto base code will remove 'rule' from
1139 * the flow table, destruct, uninitialize, and deallocate 'rule'. See
1140 * "Rule Life Cycle" above for more details.
1146 * The ofproto base code removes 'rule' from its flow table before it calls
1147 * ->rule_delete(). ->rule_delete() must remove 'rule' from the datapath
1148 * flow table and return only after this has completed successfully.
1150 * Rule deletion must not fail.
1156 * ->rule_destruct() must uninitialize derived state.
1158 * Rule destruction must not fail. */
1159 struct rule
*(*rule_alloc
)(void);
1160 enum ofperr (*rule_construct
)(struct rule
*rule
)
1161 /* OVS_REQUIRES(ofproto_mutex) */;
1162 enum ofperr (*rule_insert
)(struct rule
*rule
)
1163 /* OVS_REQUIRES(ofproto_mutex) */;
1164 void (*rule_delete
)(struct rule
*rule
) /* OVS_REQUIRES(ofproto_mutex) */;
1165 void (*rule_destruct
)(struct rule
*rule
);
1166 void (*rule_dealloc
)(struct rule
*rule
);
1168 /* Obtains statistics for 'rule', storing the number of packets that have
1169 * matched it in '*packet_count' and the number of bytes in those packets
1170 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
1171 * count is unknown. */
1172 void (*rule_get_stats
)(struct rule
*rule
, uint64_t *packet_count
,
1173 uint64_t *byte_count
, long long int *used
)
1174 /* OVS_EXCLUDED(ofproto_mutex) */;
1176 /* Applies the actions in 'rule' to 'packet'. (This implements sending
1177 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1179 * Takes ownership of 'packet' (so it should eventually free it, with
1182 * 'flow' reflects the flow information for 'packet'. All of the
1183 * information in 'flow' is extracted from 'packet', except for
1184 * flow->tunnel and flow->in_port, which are assigned the correct values
1185 * for the incoming packet. The register values are zeroed. 'packet''s
1186 * header pointers and offsets (e.g. packet->l3) are appropriately
1187 * initialized. packet->l3 is aligned on a 32-bit boundary.
1189 * The implementation should add the statistics for 'packet' into 'rule'.
1191 * Returns 0 if successful, otherwise an OpenFlow error code. */
1192 enum ofperr (*rule_execute
)(struct rule
*rule
, const struct flow
*flow
,
1193 struct ofpbuf
*packet
);
1195 /* If the datapath can properly implement changing 'rule''s actions to the
1196 * 'ofpacts_len' bytes in 'ofpacts', returns 0. Otherwise, returns an enum
1197 * ofperr indicating why the new actions wouldn't work.
1199 * May be a null pointer if any set of actions is acceptable. */
1200 enum ofperr (*rule_premodify_actions
)(const struct rule
*rule
,
1201 const struct ofpact
*ofpacts
,
1203 /* OVS_REQUIRES(ofproto_mutex) */;
1205 /* When ->rule_modify_actions() is called, the caller has already replaced
1206 * the OpenFlow actions in 'rule' by a new set. (If
1207 * ->rule_premodify_actions is nonnull, then it was previously called to
1208 * verify that the new set of actions is acceptable.)
1210 * ->rule_modify_actions() must:
1212 * - Update the datapath flow table with the new actions.
1214 * - Only if 'reset_counters' is true, reset any packet or byte counters
1215 * associated with the rule to zero, so that rule_get_stats() will not
1216 * longer count those packets or bytes.
1218 * Rule modification must not fail.
1220 * ->rule_modify_actions() should not modify any base members of struct
1222 void (*rule_modify_actions
)(struct rule
*rule
, bool reset_counters
)
1223 /* OVS_REQUIRES(ofproto_mutex) */;
1225 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1226 * which takes one of the following values, with the corresponding
1229 * - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1230 * as other packets, omitting TCP and UDP port numbers (always setting
1233 * - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1234 * passing them through the flow table.
1236 * - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1237 * passing packets through the flow table.
1239 * - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1240 * except that TCP and UDP port numbers should be included in fragments
1243 * Implementations are not required to support every mode.
1244 * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1246 * At the time of the call to ->set_frag_handling(), the current mode is
1247 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1248 * true if the requested mode was set, false if it is not supported.
1250 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1251 * reflect the new mode.
1253 bool (*set_frag_handling
)(struct ofproto
*ofproto
,
1254 enum ofp_config_flags frag_handling
);
1256 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1257 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1259 * The caller retains ownership of 'packet' and of 'ofpacts', so
1260 * ->packet_out() should not modify or free them.
1262 * This function must validate that it can correctly implement 'ofpacts'.
1263 * If not, then it should return an OpenFlow error code.
1265 * 'flow' reflects the flow information for 'packet'. All of the
1266 * information in 'flow' is extracted from 'packet', except for
1267 * flow->in_port (see below). flow->tunnel and its register values are
1270 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1271 * implementation should reject invalid flow->in_port values by returning
1272 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1273 * ofproto_init_max_ports(), then the client will reject these ports
1274 * itself.) For consistency, the implementation should consider valid for
1275 * flow->in_port any value that could possibly be seen in a packet that it
1276 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1277 * that never generates packet-ins (e.g. due to hardware limitations)
1278 * should still allow flow->in_port values for every possible physical port
1279 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1280 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1281 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1282 * these, treating each of them as packets generated by the controller as
1283 * opposed to packets originating from some switch port.
1285 * (Ordinarily the only effect of flow->in_port is on output actions that
1286 * involve the input port, such as actions that output to OFPP_IN_PORT,
1287 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1288 * "resubmit" actions.)
1290 * 'packet' is not matched against the OpenFlow flow table, so its
1291 * statistics should not be included in OpenFlow flow statistics.
1293 * Returns 0 if successful, otherwise an OpenFlow error code. */
1294 enum ofperr (*packet_out
)(struct ofproto
*ofproto
, struct ofpbuf
*packet
,
1295 const struct flow
*flow
,
1296 const struct ofpact
*ofpacts
,
1297 size_t ofpacts_len
);
1299 /* ## ------------------------- ## */
1300 /* ## OFPP_NORMAL configuration ## */
1301 /* ## ------------------------- ## */
1303 /* Configures NetFlow on 'ofproto' according to the options in
1304 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1306 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1307 * NetFlow, as does a null pointer. */
1308 int (*set_netflow
)(struct ofproto
*ofproto
,
1309 const struct netflow_options
*netflow_options
);
1311 void (*get_netflow_ids
)(const struct ofproto
*ofproto
,
1312 uint8_t *engine_type
, uint8_t *engine_id
);
1314 /* Configures sFlow on 'ofproto' according to the options in
1315 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1317 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1318 * sFlow, as does a null pointer. */
1319 int (*set_sflow
)(struct ofproto
*ofproto
,
1320 const struct ofproto_sflow_options
*sflow_options
);
1322 /* Configures IPFIX on 'ofproto' according to the options in
1323 * 'bridge_exporter_options' and the 'flow_exporters_options'
1324 * array, or turns off IPFIX if 'bridge_exporter_options' and
1325 * 'flow_exporters_options' is NULL.
1327 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1328 * IPFIX, as does a null pointer. */
1330 struct ofproto
*ofproto
,
1331 const struct ofproto_ipfix_bridge_exporter_options
1332 *bridge_exporter_options
,
1333 const struct ofproto_ipfix_flow_exporter_options
1334 *flow_exporters_options
, size_t n_flow_exporters_options
);
1336 /* Configures connectivity fault management on 'ofport'.
1338 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1340 * If 'cfm_settings' is null, removes any connectivity fault management
1341 * configuration from 'ofport'.
1343 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1344 * support CFM, as does a null pointer. */
1345 int (*set_cfm
)(struct ofport
*ofport
, const struct cfm_settings
*s
);
1347 /* Checks the status change of CFM on 'ofport'. Returns true if
1348 * there is status change since last call or if CFM is not specified. */
1349 bool (*cfm_status_changed
)(struct ofport
*ofport
);
1351 /* Populates 'smap' with the status of CFM on 'ofport'. Returns 0 on
1352 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1353 * that this ofproto_class does not support CFM, as does a null pointer.
1355 * The caller must provide and own '*status', and it must free the array
1356 * returned in 'status->rmps'. '*status' is indeterminate if the return
1357 * value is non-zero. */
1358 int (*get_cfm_status
)(const struct ofport
*ofport
,
1359 struct cfm_status
*status
);
1361 /* Configures BFD on 'ofport'.
1363 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1364 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1365 * according to 'cfg'.
1367 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1368 * support BFD, as does a null pointer. */
1369 int (*set_bfd
)(struct ofport
*ofport
, const struct smap
*cfg
);
1371 /* Checks the status change of BFD on 'ofport'. Returns true if there
1372 * is status change since last call or if BFD is not specified. */
1373 bool (*bfd_status_changed
)(struct ofport
*ofport
);
1375 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1376 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1377 * that this ofproto_class does not support BFD, as does a null pointer. */
1378 int (*get_bfd_status
)(struct ofport
*ofport
, struct smap
*smap
);
1380 /* Configures spanning tree protocol (STP) on 'ofproto' using the
1381 * settings defined in 's'.
1383 * If 's' is nonnull, configures STP according to its members.
1385 * If 's' is null, removes any STP configuration from 'ofproto'.
1387 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1388 * support STP, as does a null pointer. */
1389 int (*set_stp
)(struct ofproto
*ofproto
,
1390 const struct ofproto_stp_settings
*s
);
1392 /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1394 * Stores STP state for 'ofproto' in 's'. If the 'enabled' member
1395 * is false, the other member values are not meaningful.
1397 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1398 * support STP, as does a null pointer. */
1399 int (*get_stp_status
)(struct ofproto
*ofproto
,
1400 struct ofproto_stp_status
*s
);
1402 /* Configures spanning tree protocol (STP) on 'ofport' using the
1403 * settings defined in 's'.
1405 * If 's' is nonnull, configures STP according to its members. The
1406 * caller is responsible for assigning STP port numbers (using the
1407 * 'port_num' member in the range of 1 through 255, inclusive) and
1408 * ensuring there are no duplicates.
1410 * If 's' is null, removes any STP configuration from 'ofport'.
1412 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1413 * support STP, as does a null pointer. */
1414 int (*set_stp_port
)(struct ofport
*ofport
,
1415 const struct ofproto_port_stp_settings
*s
);
1417 /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1419 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1420 * false, the other member values are not meaningful.
1422 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1423 * support STP, as does a null pointer. */
1424 int (*get_stp_port_status
)(struct ofport
*ofport
,
1425 struct ofproto_port_stp_status
*s
);
1427 /* Retrieves spanning tree protocol (STP) port statistics of 'ofport'.
1429 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1430 * false, the other member values are not meaningful.
1432 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1433 * support STP, as does a null pointer. */
1434 int (*get_stp_port_stats
)(struct ofport
*ofport
,
1435 struct ofproto_port_stp_stats
*s
);
1437 /* Configures Rapid Spanning Tree Protocol (RSTP) on 'ofproto' using the
1438 * settings defined in 's'.
1440 * If 's' is nonnull, configures RSTP according to its members.
1442 * If 's' is null, removes any RSTP configuration from 'ofproto'.
1444 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1445 * support RSTP, as does a null pointer. */
1446 void (*set_rstp
)(struct ofproto
*ofproto
,
1447 const struct ofproto_rstp_settings
*s
);
1449 /* Retrieves state of Rapid Spanning Tree Protocol (RSTP) on 'ofproto'.
1451 * Stores RSTP state for 'ofproto' in 's'. If the 'enabled' member
1452 * is false, the other member values are not meaningful.
1454 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1455 * support RSTP, as does a null pointer. */
1456 void (*get_rstp_status
)(struct ofproto
*ofproto
,
1457 struct ofproto_rstp_status
*s
);
1459 /* Configures Rapid Spanning Tree Protocol (RSTP) on 'ofport' using the
1460 * settings defined in 's'.
1462 * If 's' is nonnull, configures RSTP according to its members. The
1463 * caller is responsible for assigning RSTP port numbers (using the
1464 * 'port_num' member in the range of 1 through 255, inclusive) and
1465 * ensuring there are no duplicates.
1467 * If 's' is null, removes any RSTP configuration from 'ofport'.
1469 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1470 * support STP, as does a null pointer. */
1471 void (*set_rstp_port
)(struct ofport
*ofport
,
1472 const struct ofproto_port_rstp_settings
*s
);
1474 /* Retrieves Rapid Spanning Tree Protocol (RSTP) port status of 'ofport'.
1476 * Stores RSTP state for 'ofport' in 's'. If the 'enabled' member is
1477 * false, the other member values are not meaningful.
1479 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1480 * support RSTP, as does a null pointer. */
1481 void (*get_rstp_port_status
)(struct ofport
*ofport
,
1482 struct ofproto_port_rstp_status
*s
);
1484 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1485 * 'queues' attached to 'ofport'. This data is not intended to be
1486 * sufficient to implement QoS. Instead, providers may use this
1487 * information to implement features which require knowledge of what queues
1488 * exist on a port, and some basic information about them.
1490 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1491 * support QoS, as does a null pointer. */
1492 int (*set_queues
)(struct ofport
*ofport
,
1493 const struct ofproto_port_queue
*queues
, size_t n_qdscp
);
1495 /* If 's' is nonnull, this function registers a "bundle" associated with
1496 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
1497 * a Port in OVSDB, that is, it consists of one or more "slave" devices
1498 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1499 * there is more than one slave, a bonding configuration. If 'aux' is
1500 * already registered then this function updates its configuration to 's'.
1501 * Otherwise, this function registers a new bundle.
1503 * If 's' is NULL, this function unregisters the bundle registered on
1504 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
1505 * has been registered, this has no effect.
1507 * This function affects only the behavior of the NXAST_AUTOPATH action and
1508 * output to the OFPP_NORMAL port. An implementation that does not support
1509 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
1510 * that supports only a subset of the functionality should implement what
1511 * it can and return 0. */
1512 int (*bundle_set
)(struct ofproto
*ofproto
, void *aux
,
1513 const struct ofproto_bundle_settings
*s
);
1515 /* If 'port' is part of any bundle, removes it from that bundle. If the
1516 * bundle now has no ports, deletes the bundle. If the bundle now has only
1517 * one port, deconfigures the bundle's bonding configuration. */
1518 void (*bundle_remove
)(struct ofport
*ofport
);
1520 /* If 's' is nonnull, this function registers a mirror associated with
1521 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
1522 * a Mirror in OVSDB. If 'aux' is already registered then this function
1523 * updates its configuration to 's'. Otherwise, this function registers a
1526 * If 's' is NULL, this function unregisters the mirror registered on
1527 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
1528 * has been registered, this has no effect.
1530 * An implementation that does not support mirroring at all may set
1531 * it to NULL or return EOPNOTSUPP. An implementation that supports
1532 * only a subset of the functionality should implement what it can
1534 int (*mirror_set
)(struct ofproto
*ofproto
, void *aux
,
1535 const struct ofproto_mirror_settings
*s
);
1537 /* Retrieves statistics from mirror associated with client data
1538 * pointer 'aux' in 'ofproto'. Stores packet and byte counts in
1539 * 'packets' and 'bytes', respectively. If a particular counter is
1540 * not supported, the appropriate argument is set to UINT64_MAX.
1542 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1543 * support retrieving mirror statistics. */
1544 int (*mirror_get_stats
)(struct ofproto
*ofproto
, void *aux
,
1545 uint64_t *packets
, uint64_t *bytes
);
1547 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1548 * on which all packets are flooded, instead of using MAC learning. If
1549 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1551 * This function affects only the behavior of the OFPP_NORMAL action. An
1552 * implementation that does not support it may set it to NULL or return
1554 int (*set_flood_vlans
)(struct ofproto
*ofproto
,
1555 unsigned long *flood_vlans
);
1557 /* Returns true if 'aux' is a registered bundle that is currently in use as
1558 * the output for a mirror. */
1559 bool (*is_mirror_output_bundle
)(const struct ofproto
*ofproto
, void *aux
);
1561 /* When the configuration option of forward_bpdu changes, this function
1562 * will be invoked. */
1563 void (*forward_bpdu_changed
)(struct ofproto
*ofproto
);
1565 /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1566 * seconds, and the maximum number of MAC table entries to
1569 * An implementation that doesn't support configuring these features may
1570 * set this function to NULL or implement it as a no-op. */
1571 void (*set_mac_table_config
)(struct ofproto
*ofproto
,
1572 unsigned int idle_time
, size_t max_entries
);
1574 /* Configures multicast snooping on 'ofport' using the settings
1577 * If 's' is nonnull, this function updates multicast snooping
1578 * configuration to 's' in 'ofproto'.
1580 * If 's' is NULL, this function disables multicast snooping
1583 * An implementation that does not support multicast snooping may set
1584 * it to NULL or return EOPNOTSUPP. */
1585 int (*set_mcast_snooping
)(struct ofproto
*ofproto
,
1586 const struct ofproto_mcast_snooping_settings
*s
);
1588 /* Configures multicast snooping port's flood setting on 'ofproto'.
1590 * All multicast traffic is sent to struct port 'aux' in 'ofproto'
1591 * if 'flood' is true. Otherwise, struct port 'aux' is an ordinary
1594 * An implementation that does not support multicast snooping may set
1595 * it to NULL or return EOPNOTSUPP. */
1596 int (*set_mcast_snooping_port
)(struct ofproto
*ofproto_
, void *aux
,
1599 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1601 * This is deprecated. It is only for compatibility with broken device drivers
1602 * in old versions of Linux that do not properly support VLANs when VLAN
1603 * devices are not used. When broken device drivers are no longer in
1604 * widespread use, we will delete these interfaces. */
1606 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1607 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1608 * that has OpenFlow port number 'realdev_ofp_port'.
1610 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1611 * as a VLAN splinter port.
1613 * This function should be NULL if an implementation does not support it.
1615 int (*set_realdev
)(struct ofport
*ofport
,
1616 ofp_port_t realdev_ofp_port
, int vid
);
1618 /* ## ------------------------ ## */
1619 /* ## OpenFlow meter functions ## */
1620 /* ## ------------------------ ## */
1622 /* These functions should be NULL if an implementation does not support
1623 * them. They must be all null or all non-null.. */
1625 /* Initializes 'features' to describe the metering features supported by
1627 void (*meter_get_features
)(const struct ofproto
*ofproto
,
1628 struct ofputil_meter_features
*features
);
1630 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1631 * success the function must store a provider meter ID other than
1632 * UINT32_MAX in '*id'. All further references to the meter will be made
1633 * with the returned provider meter id rather than the OpenFlow meter id.
1634 * The caller does not try to interpret the provider meter id, giving the
1635 * implementation the freedom to either use the OpenFlow meter_id value
1636 * provided in the meter configuration, or any other value suitable for the
1639 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1640 * with that meter provider ID to have configuration 'config', while
1641 * leaving '*id' unchanged. On failure, the existing meter configuration
1642 * is left intact. */
1643 enum ofperr (*meter_set
)(struct ofproto
*ofproto
, ofproto_meter_id
*id
,
1644 const struct ofputil_meter_config
*config
);
1646 /* Gets the meter and meter band packet and byte counts for maximum of
1647 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1648 * 'ofproto'. The caller fills in the other stats values. The band stats
1649 * are copied to memory at 'stats->bands' provided by the caller. The
1650 * number of returned band stats is returned in 'stats->n_bands'. */
1651 enum ofperr (*meter_get
)(const struct ofproto
*ofproto
,
1652 ofproto_meter_id id
,
1653 struct ofputil_meter_stats
*stats
);
1655 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1657 void (*meter_del
)(struct ofproto
*, ofproto_meter_id
);
1660 /* ## -------------------- ## */
1661 /* ## OpenFlow 1.1+ groups ## */
1662 /* ## -------------------- ## */
1664 struct ofgroup
*(*group_alloc
)(void);
1665 enum ofperr (*group_construct
)(struct ofgroup
*);
1666 void (*group_destruct
)(struct ofgroup
*);
1667 void (*group_dealloc
)(struct ofgroup
*);
1669 enum ofperr (*group_modify
)(struct ofgroup
*);
1671 enum ofperr (*group_get_stats
)(const struct ofgroup
*,
1672 struct ofputil_group_stats
*);
1674 /* ## --------------------- ## */
1675 /* ## Datapath information ## */
1676 /* ## --------------------- ## */
1677 /* Retrieve the version string of the datapath. The version
1678 * string can be NULL if it can not be determined.
1680 * The version retuned is read only. The caller should not
1683 * This function should be NULL if an implementation does not support it.
1685 const char *(*get_datapath_version
)(const struct ofproto
*);
1688 extern const struct ofproto_class ofproto_dpif_class
;
1690 int ofproto_class_register(const struct ofproto_class
*);
1691 int ofproto_class_unregister(const struct ofproto_class
*);
1693 int ofproto_flow_mod(struct ofproto
*, struct ofputil_flow_mod
*)
1694 OVS_EXCLUDED(ofproto_mutex
);
1695 void ofproto_add_flow(struct ofproto
*, const struct match
*, int priority
,
1696 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1697 OVS_EXCLUDED(ofproto_mutex
);
1698 void ofproto_delete_flow(struct ofproto
*, const struct match
*, int priority
)
1699 OVS_EXCLUDED(ofproto_mutex
);
1700 void ofproto_flush_flows(struct ofproto
*);
1703 static inline const struct rule_actions
*
1704 rule_get_actions(const struct rule
*rule
)
1706 return ovsrcu_get(const struct rule_actions
*, &rule
->actions
);
1709 /* Returns true if 'rule' is an OpenFlow 1.3 "table-miss" rule, false
1712 * ("Table-miss" rules are special because a packet_in generated through one
1713 * uses OFPR_NO_MATCH as its reason, whereas packet_ins generated by any other
1714 * rule use OFPR_ACTION.) */
1716 rule_is_table_miss(const struct rule
*rule
)
1718 return rule
->cr
.priority
== 0 && cls_rule_is_catchall(&rule
->cr
);
1721 /* Returns true if 'rule' should be hidden from the controller.
1723 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1724 * (e.g. by in-band control) and are intentionally hidden from the
1727 rule_is_hidden(const struct rule
*rule
)
1729 return rule
->cr
.priority
> UINT16_MAX
;
1732 static inline struct rule
*
1733 rule_from_cls_rule(const struct cls_rule
*cls_rule
)
1735 return cls_rule
? CONTAINER_OF(cls_rule
, struct rule
, cr
) : NULL
;
1738 #endif /* ofproto/ofproto-provider.h */