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 config: contains enum ofproto_table_config; accessed atomically. */
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 groups (see comment on struct eviction_group for explanation) .
351 * 'eviction_group' is this rule's eviction group, or NULL if it is not in
352 * any eviction group. When 'eviction_group' is nonnull, 'evg_node' is in
353 * the ->eviction_group->rules hmap. */
354 struct eviction_group
*eviction_group
OVS_GUARDED_BY(ofproto_mutex
);
355 struct heap_node evg_node
OVS_GUARDED_BY(ofproto_mutex
);
357 /* OpenFlow actions. See struct rule_actions for more thread-safety
359 OVSRCU_TYPE(const struct rule_actions
*) actions
;
361 /* In owning meter's 'rules' list. An empty list if there is no meter. */
362 struct list meter_list_node
OVS_GUARDED_BY(ofproto_mutex
);
364 /* Flow monitors (e.g. for NXST_FLOW_MONITOR, related to struct ofmonitor).
366 * 'add_seqno' is the sequence number when this rule was created.
367 * 'modify_seqno' is the sequence number when this rule was last modified.
368 * See 'monitor_seqno' in connmgr.c for more information. */
369 enum nx_flow_monitor_flags monitor_flags
OVS_GUARDED_BY(ofproto_mutex
);
370 uint64_t add_seqno
OVS_GUARDED_BY(ofproto_mutex
);
371 uint64_t modify_seqno
OVS_GUARDED_BY(ofproto_mutex
);
373 /* Optimisation for flow expiry. In ofproto's 'expirable' list if this
374 * rule is expirable, otherwise empty. */
375 struct list expirable
OVS_GUARDED_BY(ofproto_mutex
);
377 /* Times. Last so that they are more likely close to the stats managed
378 * by the provider. */
379 long long int created OVS_GUARDED
; /* Creation time. */
381 /* Must hold 'mutex' for both read/write, 'ofproto_mutex' not needed. */
382 long long int modified OVS_GUARDED
; /* Time of last modification. */
385 void ofproto_rule_ref(struct rule
*);
386 bool ofproto_rule_try_ref(struct rule
*);
387 void ofproto_rule_unref(struct rule
*);
389 static inline const struct rule_actions
* rule_get_actions(const struct rule
*);
390 static inline bool rule_is_table_miss(const struct rule
*);
391 static inline bool rule_is_hidden(const struct rule
*);
393 /* A set of actions within a "struct rule".
399 * A struct rule_actions may be accessed without a risk of being freed by
400 * code that holds 'rule->mutex' (where 'rule' is the rule for which
401 * 'rule->actions == actions') or during the RCU active period.
403 * All members are immutable: they do not change during the struct's
405 struct rule_actions
{
408 * 'has_meter' is true if 'ofpacts' contains an OFPACT_METER action.
410 * 'has_learn_with_delete' is true if 'ofpacts' contains an OFPACT_LEARN
411 * action whose flags include NX_LEARN_F_DELETE_LEARNED. */
413 bool has_learn_with_delete
;
416 uint32_t ofpacts_len
; /* Size of 'ofpacts', in bytes. */
417 struct ofpact ofpacts
[]; /* Sequence of "struct ofpacts". */
419 BUILD_ASSERT_DECL(offsetof(struct rule_actions
, ofpacts
) % OFPACT_ALIGNTO
== 0);
421 const struct rule_actions
*rule_actions_create(const struct ofpact
*, size_t);
422 void rule_actions_destroy(const struct rule_actions
*);
423 bool ofproto_rule_has_out_port(const struct rule
*, ofp_port_t port
)
424 OVS_REQUIRES(ofproto_mutex
);
426 /* A set of rules to which an OpenFlow operation applies. */
427 struct rule_collection
{
428 struct rule
**rules
; /* The rules. */
429 size_t n
; /* Number of rules collected. */
431 size_t capacity
; /* Number of rules that will fit in 'rules'. */
432 struct rule
*stub
[64]; /* Preallocated rules to avoid malloc(). */
435 void rule_collection_init(struct rule_collection
*);
436 void rule_collection_add(struct rule_collection
*, struct rule
*);
437 void rule_collection_ref(struct rule_collection
*) OVS_REQUIRES(ofproto_mutex
);
438 void rule_collection_unref(struct rule_collection
*);
439 void rule_collection_destroy(struct rule_collection
*);
441 /* Limits the number of flows allowed in the datapath. Only affects the
442 * ofproto-dpif implementation. */
443 extern unsigned ofproto_flow_limit
;
445 /* Maximum idle time (in ms) for flows to be cached in the datapath.
446 * Revalidators may expire flows more quickly than the configured value based
447 * on system load and other factors. This variable is subject to change. */
448 extern unsigned ofproto_max_idle
;
450 /* Number of upcall handler and revalidator threads. Only affects the
451 * ofproto-dpif implementation. */
452 extern size_t n_handlers
, n_revalidators
;
454 static inline struct rule
*rule_from_cls_rule(const struct cls_rule
*);
456 void ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
457 OVS_REQUIRES(ofproto_mutex
);
458 void ofproto_rule_delete(struct ofproto
*, struct rule
*)
459 OVS_EXCLUDED(ofproto_mutex
);
460 void ofproto_rule_reduce_timeouts(struct rule
*rule
, uint16_t idle_timeout
,
461 uint16_t hard_timeout
)
462 OVS_EXCLUDED(ofproto_mutex
);
464 /* A group within a "struct ofproto".
466 * With few exceptions, ofproto implementations may look at these fields but
467 * should not modify them. */
469 struct hmap_node hmap_node OVS_GUARDED
; /* In ofproto's "groups" hmap. */
471 /* Number of references.
473 * This is needed to keep track of references to the group in the xlate
476 * If the main thread removes the group from an ofproto, we need to
477 * guarantee that the group remains accessible to users of
478 * xlate_group_actions and the xlate_cache, as the xlate_cache will not be
479 * cleaned up until the corresponding datapath flows are revalidated. */
480 struct ovs_refcount ref_count
;
482 /* No lock is needed to protect the fields below since they are not
483 * modified after construction. */
484 const struct ofproto
*ofproto
; /* The ofproto that contains this group. */
485 const uint32_t group_id
;
486 const enum ofp11_group_type type
; /* One of OFPGT_*. */
488 const long long int created
; /* Creation time. */
489 const long long int modified
; /* Time of last modification. */
491 struct list buckets
; /* Contains "struct ofputil_bucket"s. */
492 const uint32_t n_buckets
;
495 bool ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
496 struct ofgroup
**group
);
498 void ofproto_group_ref(struct ofgroup
*);
499 void ofproto_group_unref(struct ofgroup
*);
501 /* ofproto class structure, to be defined by each ofproto implementation.
507 * These functions work primarily with four different kinds of data
510 * - "struct ofproto", which represents an OpenFlow switch.
512 * - "struct ofport", which represents a port within an ofproto.
514 * - "struct rule", which represents an OpenFlow flow within an ofproto.
516 * - "struct ofgroup", which represents an OpenFlow 1.1+ group within an
519 * Each of these data structures contains all of the implementation-independent
520 * generic state for the respective concept, called the "base" state. None of
521 * them contains any extra space for ofproto implementations to use. Instead,
522 * each implementation is expected to declare its own data structure that
523 * contains an instance of the generic data structure plus additional
524 * implementation-specific members, called the "derived" state. The
525 * implementation can use casts or (preferably) the CONTAINER_OF macro to
526 * obtain access to derived state given only a pointer to the embedded generic
533 * Four stylized functions accompany each of these data structures:
535 * "alloc" "construct" "destruct" "dealloc"
536 * ------------ ---------------- --------------- --------------
537 * ofproto ->alloc ->construct ->destruct ->dealloc
538 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
539 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
540 * group ->group_alloc ->group_construct ->group_destruct ->group_dealloc
542 * "ofproto", "ofport", and "group" have this exact life cycle. The "rule"
543 * data structure also follow this life cycle with some additional elaborations
544 * described under "Rule Life Cycle" below.
546 * Any instance of a given data structure goes through the following life
549 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
550 * fails, skip all the other steps.
552 * 2. The client initializes all of the data structure's base state. If this
553 * fails, skip to step 7.
555 * 3. The client calls the "construct" function. The implementation
556 * initializes derived state. It may refer to the already-initialized
557 * base state. If "construct" fails, skip to step 6.
559 * 4. The data structure is now initialized and in use.
561 * 5. When the data structure is no longer needed, the client calls the
562 * "destruct" function. The implementation uninitializes derived state.
563 * The base state has not been uninitialized yet, so the implementation
564 * may still refer to it.
566 * 6. The client uninitializes all of the data structure's base state.
568 * 7. The client calls the "dealloc" to free the raw memory. The
569 * implementation must not refer to base or derived state in the data
570 * structure, because it has already been uninitialized.
572 * Each "alloc" function allocates and returns a new instance of the respective
573 * data structure. The "alloc" function is not given any information about the
574 * use of the new data structure, so it cannot perform much initialization.
575 * Its purpose is just to ensure that the new data structure has enough room
576 * for base and derived state. It may return a null pointer if memory is not
577 * available, in which case none of the other functions is called.
579 * Each "construct" function initializes derived state in its respective data
580 * structure. When "construct" is called, all of the base state has already
581 * been initialized, so the "construct" function may refer to it. The
582 * "construct" function is allowed to fail, in which case the client calls the
583 * "dealloc" function (but not the "destruct" function).
585 * Each "destruct" function uninitializes and frees derived state in its
586 * respective data structure. When "destruct" is called, the base state has
587 * not yet been uninitialized, so the "destruct" function may refer to it. The
588 * "destruct" function is not allowed to fail.
590 * Each "dealloc" function frees raw memory that was allocated by the the
591 * "alloc" function. The memory's base and derived members might not have ever
592 * been initialized (but if "construct" returned successfully, then it has been
593 * "destruct"ed already). The "dealloc" function is not allowed to fail.
599 * Most of these functions return 0 if they are successful or a positive error
600 * code on failure. Depending on the function, valid error codes are either
601 * errno values or OFPERR_* OpenFlow error codes.
603 * Most of these functions are expected to execute synchronously, that is, to
604 * block as necessary to obtain a result. Thus, these functions may return
605 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
606 * explicitly say those errors are a possibility. We may relax this
607 * requirement in the future if and when we encounter performance problems. */
608 struct ofproto_class
{
609 /* ## ----------------- ## */
610 /* ## Factory Functions ## */
611 /* ## ----------------- ## */
613 /* Initializes provider. The caller may pass in 'iface_hints',
614 * which contains an shash of "struct iface_hint" elements indexed
615 * by the interface's name. The provider may use these hints to
616 * describe the startup configuration in order to reinitialize its
617 * state. The caller owns the provided data, so a provider must
618 * make copies of anything required. An ofproto provider must
619 * remove any existing state that is not described by the hint, and
620 * may choose to remove it all. */
621 void (*init
)(const struct shash
*iface_hints
);
623 /* Enumerates the types of all support ofproto types into 'types'. The
624 * caller has already initialized 'types' and other ofproto classes might
625 * already have added names to it. */
626 void (*enumerate_types
)(struct sset
*types
);
628 /* Enumerates the names of all existing datapath of the specified 'type'
629 * into 'names' 'all_dps'. The caller has already initialized 'names' as
632 * 'type' is one of the types enumerated by ->enumerate_types().
634 * Returns 0 if successful, otherwise a positive errno value.
636 int (*enumerate_names
)(const char *type
, struct sset
*names
);
638 /* Deletes the datapath with the specified 'type' and 'name'. The caller
639 * should have closed any open ofproto with this 'type' and 'name'; this
640 * function is allowed to fail if that is not the case.
642 * 'type' is one of the types enumerated by ->enumerate_types().
643 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
645 * Returns 0 if successful, otherwise a positive errno value.
647 int (*del
)(const char *type
, const char *name
);
649 /* Returns the type to pass to netdev_open() when a datapath of type
650 * 'datapath_type' has a port of type 'port_type', for a few special
651 * cases when a netdev type differs from a port type. For example,
652 * when using the userspace datapath, a port of type "internal"
653 * needs to be opened as "tap".
655 * Returns either 'type' itself or a string literal, which must not
657 const char *(*port_open_type
)(const char *datapath_type
,
658 const char *port_type
);
660 /* ## ------------------------ ## */
661 /* ## Top-Level type Functions ## */
662 /* ## ------------------------ ## */
664 /* Performs any periodic activity required on ofprotos of type
667 * An ofproto provider may implement it or not, depending on whether
668 * it needs type-level maintenance.
670 * Returns 0 if successful, otherwise a positive errno value. */
671 int (*type_run
)(const char *type
);
673 /* Causes the poll loop to wake up when a type 'type''s 'run'
674 * function needs to be called, e.g. by calling the timer or fd
675 * waiting functions in poll-loop.h.
677 * An ofproto provider may implement it or not, depending on whether
678 * it needs type-level maintenance. */
679 void (*type_wait
)(const char *type
);
681 /* ## --------------------------- ## */
682 /* ## Top-Level ofproto Functions ## */
683 /* ## --------------------------- ## */
685 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
691 * ->construct() should not modify any base members of the ofproto. The
692 * client will initialize the ofproto's 'ports' and 'tables' members after
693 * construction is complete.
695 * When ->construct() is called, the client does not yet know how many flow
696 * tables the datapath supports, so ofproto->n_tables will be 0 and
697 * ofproto->tables will be NULL. ->construct() should call
698 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
699 * ofproto->tables. Each flow table will be initially empty, so
700 * ->construct() should delete flows from the underlying datapath, if
701 * necessary, rather than populating the tables.
703 * If the ofproto knows the maximum port number that the datapath can have,
704 * then it can call ofproto_init_max_ports(). If it does so, then the
705 * client will ensure that the actions it allows to be used through
706 * OpenFlow do not refer to ports above that maximum number.
708 * Only one ofproto instance needs to be supported for any given datapath.
709 * If a datapath is already open as part of one "ofproto", then another
710 * attempt to "construct" the same datapath as part of another ofproto is
711 * allowed to fail with an error.
713 * ->construct() returns 0 if successful, otherwise a positive errno
720 * ->destruct() must also destroy all remaining rules in the ofproto's
721 * tables, by passing each remaining rule to ofproto_rule_delete().
723 * The client will destroy the flow tables themselves after ->destruct()
726 struct ofproto
*(*alloc
)(void);
727 int (*construct
)(struct ofproto
*ofproto
);
728 void (*destruct
)(struct ofproto
*ofproto
);
729 void (*dealloc
)(struct ofproto
*ofproto
);
731 /* Performs any periodic activity required by 'ofproto'. It should:
733 * - Call connmgr_send_packet_in() for each received packet that missed
734 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
737 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
738 * its hard_timeout or idle_timeout, to expire the flow.
740 * Returns 0 if successful, otherwise a positive errno value. */
741 int (*run
)(struct ofproto
*ofproto
);
743 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
744 * be called, e.g. by calling the timer or fd waiting functions in
746 void (*wait
)(struct ofproto
*ofproto
);
748 /* Adds some memory usage statistics for the implementation of 'ofproto'
749 * into 'usage', for use with memory_report().
751 * This function is optional. */
752 void (*get_memory_usage
)(const struct ofproto
*ofproto
,
753 struct simap
*usage
);
755 /* Adds some memory usage statistics for the implementation of 'type'
756 * into 'usage', for use with memory_report().
758 * This function is optional. */
759 void (*type_get_memory_usage
)(const char *type
, struct simap
*usage
);
761 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
762 * This function may prepare for that, for example by clearing state in
763 * advance. It should *not* actually delete any "struct rule"s from
764 * 'ofproto', only prepare for it.
766 * This function is optional; it's really just for optimization in case
767 * it's cheaper to delete all the flows from your hardware in a single pass
768 * than to do it one by one. */
769 void (*flush
)(struct ofproto
*ofproto
);
771 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
773 * The implementation should store true in '*arp_match_ip' if the switch
774 * supports matching IP addresses inside ARP requests and replies, false
777 * The implementation should store in '*ofpacts' a bitmap of the supported
778 * OFPACT_* actions. */
779 void (*get_features
)(struct ofproto
*ofproto
,
783 /* Helper for the OpenFlow OFPST_TABLE statistics request.
785 * The 'stats' array contains 'ofproto->n_tables' elements. Each element is
788 * - 'table_id' to the array index.
790 * - 'name' to "table#" where # is the table ID.
792 * - 'match' and 'wildcards' to all fields.
794 * - 'write_actions' and 'apply_actions' to all actions.
796 * - 'write_setfields' and 'apply_setfields' to all writable fields.
798 * - 'metadata_match' and 'metadata_write' to OVS_BE64_MAX.
800 * - 'ovsinsts' to all instructions.
802 * - 'config' to the table miss configuration.
804 * - 'max_entries' to 1,000,000.
806 * - 'active_count' to the classifier_count() for the table.
808 * - 'lookup_count' and 'matched_count' to 0.
810 * The implementation should update any members in each element for which
811 * it has better values:
813 * - 'name' to a more meaningful name.
815 * - 'wildcards' to the set of wildcards actually supported by the table
816 * (if it doesn't support all OpenFlow wildcards).
818 * - 'ovsinsts' to the set of instructions actually supported by the
821 * - 'write_actions' to set the write actions actually supported by
822 * the table (if it doesn't support all OpenFlow actions).
824 * - 'apply_actions' to set the apply actions actually supported by
825 * the table (if it doesn't support all OpenFlow actions).
827 * - 'write_setfields' to set the write setfields actually supported by
830 * - 'apply_setfields' to set the apply setfields actually supported by
833 * - 'max_entries' to the maximum number of flows actually supported by
836 * - 'lookup_count' to the number of packets looked up in this flow table
839 * - 'matched_count' to the number of packets looked up in this flow
840 * table so far that matched one of the flow entries.
842 void (*get_tables
)(struct ofproto
*ofproto
,
843 struct ofputil_table_stats
*stats
);
845 /* ## ---------------- ## */
846 /* ## ofport Functions ## */
847 /* ## ---------------- ## */
849 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
851 * ->port_construct() should not modify any base members of the ofport.
852 * An ofproto implementation should use the 'ofp_port' member of
853 * "struct ofport" as the OpenFlow port number.
855 * ofports are managed by the base ofproto code. The ofproto
856 * implementation should only create and destroy them in response to calls
857 * to these functions. The base ofproto code will create and destroy
858 * ofports in the following situations:
860 * - Just after the ->construct() function is called, the base ofproto
861 * iterates over all of the implementation's ports, using
862 * ->port_dump_start() and related functions, and constructs an ofport
863 * for each dumped port.
865 * - If ->port_poll() reports that a specific port has changed, then the
866 * base ofproto will query that port with ->port_query_by_name() and
867 * construct or destruct ofports as necessary to reflect the updated
870 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
871 * change, then the base ofproto will iterate over all of the
872 * implementation's ports, in the same way as at ofproto
873 * initialization, and construct and destruct ofports to reflect all of
876 * ->port_construct() returns 0 if successful, otherwise a positive errno
879 struct ofport
*(*port_alloc
)(void);
880 int (*port_construct
)(struct ofport
*ofport
);
881 void (*port_destruct
)(struct ofport
*ofport
);
882 void (*port_dealloc
)(struct ofport
*ofport
);
884 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
885 * the ofproto implementation uses the ofport's netdev internally, then it
886 * should switch to using the new one. The old one has been closed.
888 * An ofproto implementation that doesn't need to do anything in this
889 * function may use a null pointer. */
890 void (*port_modified
)(struct ofport
*ofport
);
892 /* Called after an OpenFlow request changes a port's configuration.
893 * 'ofport->pp.config' contains the new configuration. 'old_config'
894 * contains the previous configuration.
896 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
897 * turn NETDEV_UP on and off, so this function doesn't have to do anything
898 * for that bit (and it won't be called if that is the only bit that
900 void (*port_reconfigured
)(struct ofport
*ofport
,
901 enum ofputil_port_config old_config
);
903 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
904 * initializes '*port' appropriately. Otherwise, returns a positive errno
907 * The caller owns the data in 'port' and must free it with
908 * ofproto_port_destroy() when it is no longer needed. */
909 int (*port_query_by_name
)(const struct ofproto
*ofproto
,
910 const char *devname
, struct ofproto_port
*port
);
912 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
913 * successful, otherwise a positive errno value. The caller should
914 * inform the implementation of the OpenFlow port through the
915 * ->port_construct() method.
917 * It doesn't matter whether the new port will be returned by a later call
918 * to ->port_poll(); the implementation may do whatever is more
920 int (*port_add
)(struct ofproto
*ofproto
, struct netdev
*netdev
);
922 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
923 * 0 if successful, otherwise a positive errno value.
925 * It doesn't matter whether the new port will be returned by a later call
926 * to ->port_poll(); the implementation may do whatever is more
928 int (*port_del
)(struct ofproto
*ofproto
, ofp_port_t ofp_port
);
931 int (*port_get_stats
)(const struct ofport
*port
,
932 struct netdev_stats
*stats
);
934 /* Port iteration functions.
936 * The client might not be entirely in control of the ports within an
937 * ofproto. Some hardware implementations, for example, might have a fixed
938 * set of ports in a datapath. For this reason, the client needs a way to
939 * iterate through all the ports that are actually in a datapath. These
940 * functions provide that functionality.
942 * The 'state' pointer provides the implementation a place to
943 * keep track of its position. Its format is opaque to the caller.
945 * The ofproto provider retains ownership of the data that it stores into
946 * ->port_dump_next()'s 'port' argument. The data must remain valid until
947 * at least the next call to ->port_dump_next() or ->port_dump_done() for
948 * 'state'. The caller will not modify or free it.
953 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
954 * On success, it should return 0 and initialize '*statep' with any data
955 * needed for iteration. On failure, returns a positive errno value, and
956 * the client will not call ->port_dump_next() or ->port_dump_done().
958 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
959 * 'state'. If there is another port, it should store the port's
960 * information into 'port' and return 0. It should return EOF if all ports
961 * have already been iterated. Otherwise, on error, it should return a
962 * positive errno value. This function will not be called again once it
963 * returns nonzero once for a given iteration (but the 'port_dump_done'
964 * function will be called afterward).
966 * ->port_dump_done() allows the implementation to release resources used
967 * for iteration. The caller might decide to stop iteration in the middle
968 * by calling this function before ->port_dump_next() returns nonzero.
976 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
979 * struct ofproto_port port;
981 * error = ofproto->ofproto_class->port_dump_next(
982 * ofproto, state, &port);
986 * // Do something with 'port' here (without modifying or freeing
987 * // any of its data).
989 * ofproto->ofproto_class->port_dump_done(ofproto, state);
991 * // 'error' is now EOF (success) or a positive errno value (failure).
993 int (*port_dump_start
)(const struct ofproto
*ofproto
, void **statep
);
994 int (*port_dump_next
)(const struct ofproto
*ofproto
, void *state
,
995 struct ofproto_port
*port
);
996 int (*port_dump_done
)(const struct ofproto
*ofproto
, void *state
);
998 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
999 * in 'ofproto' has changed, then this function should do one of the
1002 * - Preferably: store the name of the device that was added to or deleted
1003 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
1004 * for freeing '*devnamep' (with free()) when it no longer needs it.
1006 * - Alternatively: return ENOBUFS, without indicating the device that was
1009 * Occasional 'false positives', in which the function returns 0 while
1010 * indicating a device that was not actually added or deleted or returns
1011 * ENOBUFS without any change, are acceptable.
1013 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
1014 * externally to the 'ofproto' object, e.g. by a system administrator via
1015 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
1016 * not report changes made through calls to 'port_add' or 'port_del' on the
1017 * same 'ofproto' object. (But it's OK for it to report them too, just
1018 * slightly less efficient.)
1020 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
1021 * also return other positive errno values to indicate that something has
1024 * If the set of ports in a datapath is fixed, or if the only way that the
1025 * set of ports in a datapath can change is through ->port_add() and
1026 * ->port_del(), then this function may be a null pointer.
1028 int (*port_poll
)(const struct ofproto
*ofproto
, char **devnamep
);
1030 /* Arranges for the poll loop to wake up when ->port_poll() will return a
1031 * value other than EAGAIN.
1033 * If the set of ports in a datapath is fixed, or if the only way that the
1034 * set of ports in a datapath can change is through ->port_add() and
1035 * ->port_del(), or if the poll loop will always wake up anyway when
1036 * ->port_poll() will return a value other than EAGAIN, then this function
1037 * may be a null pointer.
1039 void (*port_poll_wait
)(const struct ofproto
*ofproto
);
1041 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
1042 * partner information for 'port' is up-to-date, 0 if LACP partner
1043 * information is not current (generally indicating a connectivity
1044 * problem), or -1 if LACP is not enabled on 'port'.
1046 * This function may be a null pointer if the ofproto implementation does
1047 * not support LACP. */
1048 int (*port_is_lacp_current
)(const struct ofport
*port
);
1050 /* ## ----------------------- ## */
1051 /* ## OpenFlow Rule Functions ## */
1052 /* ## ----------------------- ## */
1054 /* Chooses an appropriate table for 'match' within 'ofproto'. On
1055 * success, stores the table ID into '*table_idp' and returns 0. On
1056 * failure, returns an OpenFlow error code.
1058 * The choice of table should be a function of 'match' and 'ofproto''s
1059 * datapath capabilities. It should not depend on the flows already in
1060 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
1061 * 'match' as its matching condition can never be inserted into 'ofproto',
1062 * even starting from an empty flow table.
1064 * If multiple tables are candidates for inserting the flow, the function
1065 * should choose one arbitrarily (but deterministically).
1067 * If this function is NULL then table 0 is always chosen. */
1068 enum ofperr (*rule_choose_table
)(const struct ofproto
*ofproto
,
1069 const struct match
*match
,
1070 uint8_t *table_idp
);
1072 /* Life-cycle functions for a "struct rule".
1078 * The life cycle of a struct rule is an elaboration of the basic life
1079 * cycle described above under "Life Cycle".
1081 * After a rule is successfully constructed, it is then inserted. If
1082 * insertion is successful, then before it is later destructed, it is
1085 * You can think of a rule as having the following extra steps inserted
1086 * between "Life Cycle" steps 4 and 5:
1088 * 4.1. The client inserts the rule into the flow table, making it
1089 * visible in flow table lookups.
1091 * 4.2. The client calls "rule_insert" to insert the flow. The
1092 * implementation attempts to install the flow in the underlying
1093 * hardware and returns an error code indicate success or failure.
1094 * On failure, go to step 5.
1096 * 4.3. The rule is now installed in the flow table. Eventually it will
1099 * 4.4. The client removes the rule from the flow table. It is no longer
1100 * visible in flow table lookups.
1102 * 4.5. The client calls "rule_delete". The implementation uninstalls
1103 * the flow from the underlying hardware. Deletion is not allowed
1110 * When ->rule_construct() is called, 'rule' is a new rule that is not yet
1111 * inserted into a flow table. ->rule_construct() should initialize enough
1112 * of the rule's derived state for 'rule' to be suitable for inserting into
1113 * a flow table. ->rule_construct() should not modify any base members of
1116 * If ->rule_construct() fails (as indicated by returning a nonzero
1117 * OpenFlow error code), the ofproto base code will uninitialize and
1118 * deallocate 'rule'. See "Rule Life Cycle" above for more details.
1120 * ->rule_construct() may also:
1122 * - Validate that the datapath supports the matching rule in 'rule->cr'
1123 * datapath. For example, if the rule's table does not support
1124 * registers, then it is an error if 'rule->cr' does not wildcard all
1127 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
1129 * Some implementations might need to defer these tasks to ->rule_insert(),
1130 * which is also acceptable.
1136 * Following successful construction, the ofproto base case inserts 'rule'
1137 * into its flow table, then it calls ->rule_insert(). ->rule_insert()
1138 * must add the new rule to the datapath flow table and return only after
1139 * this is complete (whether it succeeds or fails).
1141 * If ->rule_insert() fails, the ofproto base code will remove 'rule' from
1142 * the flow table, destruct, uninitialize, and deallocate 'rule'. See
1143 * "Rule Life Cycle" above for more details.
1149 * The ofproto base code removes 'rule' from its flow table before it calls
1150 * ->rule_delete(). ->rule_delete() must remove 'rule' from the datapath
1151 * flow table and return only after this has completed successfully.
1153 * Rule deletion must not fail.
1159 * ->rule_destruct() must uninitialize derived state.
1161 * Rule destruction must not fail. */
1162 struct rule
*(*rule_alloc
)(void);
1163 enum ofperr (*rule_construct
)(struct rule
*rule
)
1164 /* OVS_REQUIRES(ofproto_mutex) */;
1165 enum ofperr (*rule_insert
)(struct rule
*rule
)
1166 /* OVS_REQUIRES(ofproto_mutex) */;
1167 void (*rule_delete
)(struct rule
*rule
) /* OVS_REQUIRES(ofproto_mutex) */;
1168 void (*rule_destruct
)(struct rule
*rule
);
1169 void (*rule_dealloc
)(struct rule
*rule
);
1171 /* Obtains statistics for 'rule', storing the number of packets that have
1172 * matched it in '*packet_count' and the number of bytes in those packets
1173 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
1174 * count is unknown. */
1175 void (*rule_get_stats
)(struct rule
*rule
, uint64_t *packet_count
,
1176 uint64_t *byte_count
, long long int *used
)
1177 /* OVS_EXCLUDED(ofproto_mutex) */;
1179 /* Applies the actions in 'rule' to 'packet'. (This implements sending
1180 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1182 * Takes ownership of 'packet' (so it should eventually free it, with
1185 * 'flow' reflects the flow information for 'packet'. All of the
1186 * information in 'flow' is extracted from 'packet', except for
1187 * flow->tunnel and flow->in_port, which are assigned the correct values
1188 * for the incoming packet. The register values are zeroed. 'packet''s
1189 * header pointers and offsets (e.g. packet->l3) are appropriately
1190 * initialized. packet->l3 is aligned on a 32-bit boundary.
1192 * The implementation should add the statistics for 'packet' into 'rule'.
1194 * Returns 0 if successful, otherwise an OpenFlow error code. */
1195 enum ofperr (*rule_execute
)(struct rule
*rule
, const struct flow
*flow
,
1196 struct ofpbuf
*packet
);
1198 /* If the datapath can properly implement changing 'rule''s actions to the
1199 * 'ofpacts_len' bytes in 'ofpacts', returns 0. Otherwise, returns an enum
1200 * ofperr indicating why the new actions wouldn't work.
1202 * May be a null pointer if any set of actions is acceptable. */
1203 enum ofperr (*rule_premodify_actions
)(const struct rule
*rule
,
1204 const struct ofpact
*ofpacts
,
1206 /* OVS_REQUIRES(ofproto_mutex) */;
1208 /* When ->rule_modify_actions() is called, the caller has already replaced
1209 * the OpenFlow actions in 'rule' by a new set. (If
1210 * ->rule_premodify_actions is nonnull, then it was previously called to
1211 * verify that the new set of actions is acceptable.)
1213 * ->rule_modify_actions() must:
1215 * - Update the datapath flow table with the new actions.
1217 * - Only if 'reset_counters' is true, reset any packet or byte counters
1218 * associated with the rule to zero, so that rule_get_stats() will not
1219 * longer count those packets or bytes.
1221 * Rule modification must not fail.
1223 * ->rule_modify_actions() should not modify any base members of struct
1225 void (*rule_modify_actions
)(struct rule
*rule
, bool reset_counters
)
1226 /* OVS_REQUIRES(ofproto_mutex) */;
1228 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1229 * which takes one of the following values, with the corresponding
1232 * - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1233 * as other packets, omitting TCP and UDP port numbers (always setting
1236 * - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1237 * passing them through the flow table.
1239 * - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1240 * passing packets through the flow table.
1242 * - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1243 * except that TCP and UDP port numbers should be included in fragments
1246 * Implementations are not required to support every mode.
1247 * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1249 * At the time of the call to ->set_frag_handling(), the current mode is
1250 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1251 * true if the requested mode was set, false if it is not supported.
1253 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1254 * reflect the new mode.
1256 bool (*set_frag_handling
)(struct ofproto
*ofproto
,
1257 enum ofp_config_flags frag_handling
);
1259 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1260 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1262 * The caller retains ownership of 'packet' and of 'ofpacts', so
1263 * ->packet_out() should not modify or free them.
1265 * This function must validate that it can correctly implement 'ofpacts'.
1266 * If not, then it should return an OpenFlow error code.
1268 * 'flow' reflects the flow information for 'packet'. All of the
1269 * information in 'flow' is extracted from 'packet', except for
1270 * flow->in_port (see below). flow->tunnel and its register values are
1273 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1274 * implementation should reject invalid flow->in_port values by returning
1275 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1276 * ofproto_init_max_ports(), then the client will reject these ports
1277 * itself.) For consistency, the implementation should consider valid for
1278 * flow->in_port any value that could possibly be seen in a packet that it
1279 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1280 * that never generates packet-ins (e.g. due to hardware limitations)
1281 * should still allow flow->in_port values for every possible physical port
1282 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1283 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1284 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1285 * these, treating each of them as packets generated by the controller as
1286 * opposed to packets originating from some switch port.
1288 * (Ordinarily the only effect of flow->in_port is on output actions that
1289 * involve the input port, such as actions that output to OFPP_IN_PORT,
1290 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1291 * "resubmit" actions.)
1293 * 'packet' is not matched against the OpenFlow flow table, so its
1294 * statistics should not be included in OpenFlow flow statistics.
1296 * Returns 0 if successful, otherwise an OpenFlow error code. */
1297 enum ofperr (*packet_out
)(struct ofproto
*ofproto
, struct ofpbuf
*packet
,
1298 const struct flow
*flow
,
1299 const struct ofpact
*ofpacts
,
1300 size_t ofpacts_len
);
1302 /* ## ------------------------- ## */
1303 /* ## OFPP_NORMAL configuration ## */
1304 /* ## ------------------------- ## */
1306 /* Configures NetFlow on 'ofproto' according to the options in
1307 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1309 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1310 * NetFlow, as does a null pointer. */
1311 int (*set_netflow
)(struct ofproto
*ofproto
,
1312 const struct netflow_options
*netflow_options
);
1314 void (*get_netflow_ids
)(const struct ofproto
*ofproto
,
1315 uint8_t *engine_type
, uint8_t *engine_id
);
1317 /* Configures sFlow on 'ofproto' according to the options in
1318 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1320 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1321 * sFlow, as does a null pointer. */
1322 int (*set_sflow
)(struct ofproto
*ofproto
,
1323 const struct ofproto_sflow_options
*sflow_options
);
1325 /* Configures IPFIX on 'ofproto' according to the options in
1326 * 'bridge_exporter_options' and the 'flow_exporters_options'
1327 * array, or turns off IPFIX if 'bridge_exporter_options' and
1328 * 'flow_exporters_options' is NULL.
1330 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1331 * IPFIX, as does a null pointer. */
1333 struct ofproto
*ofproto
,
1334 const struct ofproto_ipfix_bridge_exporter_options
1335 *bridge_exporter_options
,
1336 const struct ofproto_ipfix_flow_exporter_options
1337 *flow_exporters_options
, size_t n_flow_exporters_options
);
1339 /* Configures connectivity fault management on 'ofport'.
1341 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1343 * If 'cfm_settings' is null, removes any connectivity fault management
1344 * configuration from 'ofport'.
1346 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1347 * support CFM, as does a null pointer. */
1348 int (*set_cfm
)(struct ofport
*ofport
, const struct cfm_settings
*s
);
1350 /* Checks the status change of CFM on 'ofport'. Returns true if
1351 * there is status change since last call or if CFM is not specified. */
1352 bool (*cfm_status_changed
)(struct ofport
*ofport
);
1354 /* Populates 'smap' with the status of CFM on 'ofport'. Returns 0 on
1355 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1356 * that this ofproto_class does not support CFM, as does a null pointer.
1358 * The caller must provide and own '*status', and it must free the array
1359 * returned in 'status->rmps'. '*status' is indeterminate if the return
1360 * value is non-zero. */
1361 int (*get_cfm_status
)(const struct ofport
*ofport
,
1362 struct cfm_status
*status
);
1364 /* Configures BFD on 'ofport'.
1366 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1367 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1368 * according to 'cfg'.
1370 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1371 * support BFD, as does a null pointer. */
1372 int (*set_bfd
)(struct ofport
*ofport
, const struct smap
*cfg
);
1374 /* Checks the status change of BFD on 'ofport'. Returns true if there
1375 * is status change since last call or if BFD is not specified. */
1376 bool (*bfd_status_changed
)(struct ofport
*ofport
);
1378 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1379 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1380 * that this ofproto_class does not support BFD, as does a null pointer. */
1381 int (*get_bfd_status
)(struct ofport
*ofport
, struct smap
*smap
);
1383 /* Configures spanning tree protocol (STP) on 'ofproto' using the
1384 * settings defined in 's'.
1386 * If 's' is nonnull, configures STP according to its members.
1388 * If 's' is null, removes any STP configuration from 'ofproto'.
1390 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1391 * support STP, as does a null pointer. */
1392 int (*set_stp
)(struct ofproto
*ofproto
,
1393 const struct ofproto_stp_settings
*s
);
1395 /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1397 * Stores STP state for 'ofproto' in 's'. If the 'enabled' member
1398 * is false, the other member values are not meaningful.
1400 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1401 * support STP, as does a null pointer. */
1402 int (*get_stp_status
)(struct ofproto
*ofproto
,
1403 struct ofproto_stp_status
*s
);
1405 /* Configures spanning tree protocol (STP) on 'ofport' using the
1406 * settings defined in 's'.
1408 * If 's' is nonnull, configures STP according to its members. The
1409 * caller is responsible for assigning STP port numbers (using the
1410 * 'port_num' member in the range of 1 through 255, inclusive) and
1411 * ensuring there are no duplicates.
1413 * If 's' is null, removes any STP configuration from 'ofport'.
1415 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1416 * support STP, as does a null pointer. */
1417 int (*set_stp_port
)(struct ofport
*ofport
,
1418 const struct ofproto_port_stp_settings
*s
);
1420 /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1422 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1423 * false, the other member values are not meaningful.
1425 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1426 * support STP, as does a null pointer. */
1427 int (*get_stp_port_status
)(struct ofport
*ofport
,
1428 struct ofproto_port_stp_status
*s
);
1430 /* Retrieves spanning tree protocol (STP) port statistics of 'ofport'.
1432 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1433 * false, the other member values are not meaningful.
1435 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1436 * support STP, as does a null pointer. */
1437 int (*get_stp_port_stats
)(struct ofport
*ofport
,
1438 struct ofproto_port_stp_stats
*s
);
1440 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1441 * 'queues' attached to 'ofport'. This data is not intended to be
1442 * sufficient to implement QoS. Instead, providers may use this
1443 * information to implement features which require knowledge of what queues
1444 * exist on a port, and some basic information about them.
1446 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1447 * support QoS, as does a null pointer. */
1448 int (*set_queues
)(struct ofport
*ofport
,
1449 const struct ofproto_port_queue
*queues
, size_t n_qdscp
);
1451 /* If 's' is nonnull, this function registers a "bundle" associated with
1452 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
1453 * a Port in OVSDB, that is, it consists of one or more "slave" devices
1454 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1455 * there is more than one slave, a bonding configuration. If 'aux' is
1456 * already registered then this function updates its configuration to 's'.
1457 * Otherwise, this function registers a new bundle.
1459 * If 's' is NULL, this function unregisters the bundle registered on
1460 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
1461 * has been registered, this has no effect.
1463 * This function affects only the behavior of the NXAST_AUTOPATH action and
1464 * output to the OFPP_NORMAL port. An implementation that does not support
1465 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
1466 * that supports only a subset of the functionality should implement what
1467 * it can and return 0. */
1468 int (*bundle_set
)(struct ofproto
*ofproto
, void *aux
,
1469 const struct ofproto_bundle_settings
*s
);
1471 /* If 'port' is part of any bundle, removes it from that bundle. If the
1472 * bundle now has no ports, deletes the bundle. If the bundle now has only
1473 * one port, deconfigures the bundle's bonding configuration. */
1474 void (*bundle_remove
)(struct ofport
*ofport
);
1476 /* If 's' is nonnull, this function registers a mirror associated with
1477 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
1478 * a Mirror in OVSDB. If 'aux' is already registered then this function
1479 * updates its configuration to 's'. Otherwise, this function registers a
1482 * If 's' is NULL, this function unregisters the mirror registered on
1483 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
1484 * has been registered, this has no effect.
1486 * An implementation that does not support mirroring at all may set
1487 * it to NULL or return EOPNOTSUPP. An implementation that supports
1488 * only a subset of the functionality should implement what it can
1490 int (*mirror_set
)(struct ofproto
*ofproto
, void *aux
,
1491 const struct ofproto_mirror_settings
*s
);
1493 /* Retrieves statistics from mirror associated with client data
1494 * pointer 'aux' in 'ofproto'. Stores packet and byte counts in
1495 * 'packets' and 'bytes', respectively. If a particular counter is
1496 * not supported, the appropriate argument is set to UINT64_MAX.
1498 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1499 * support retrieving mirror statistics. */
1500 int (*mirror_get_stats
)(struct ofproto
*ofproto
, void *aux
,
1501 uint64_t *packets
, uint64_t *bytes
);
1503 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1504 * on which all packets are flooded, instead of using MAC learning. If
1505 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1507 * This function affects only the behavior of the OFPP_NORMAL action. An
1508 * implementation that does not support it may set it to NULL or return
1510 int (*set_flood_vlans
)(struct ofproto
*ofproto
,
1511 unsigned long *flood_vlans
);
1513 /* Returns true if 'aux' is a registered bundle that is currently in use as
1514 * the output for a mirror. */
1515 bool (*is_mirror_output_bundle
)(const struct ofproto
*ofproto
, void *aux
);
1517 /* When the configuration option of forward_bpdu changes, this function
1518 * will be invoked. */
1519 void (*forward_bpdu_changed
)(struct ofproto
*ofproto
);
1521 /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1522 * seconds, and the maximum number of MAC table entries to
1525 * An implementation that doesn't support configuring these features may
1526 * set this function to NULL or implement it as a no-op. */
1527 void (*set_mac_table_config
)(struct ofproto
*ofproto
,
1528 unsigned int idle_time
, size_t max_entries
);
1530 /* Configures multicast snooping on 'ofport' using the settings
1533 * If 's' is nonnull, this function updates multicast snooping
1534 * configuration to 's' in 'ofproto'.
1536 * If 's' is NULL, this function disables multicast snooping
1539 * An implementation that does not support multicast snooping may set
1540 * it to NULL or return EOPNOTSUPP. */
1541 int (*set_mcast_snooping
)(struct ofproto
*ofproto
,
1542 const struct ofproto_mcast_snooping_settings
*s
);
1544 /* Configures multicast snooping port's flood setting on 'ofproto'.
1546 * All multicast traffic is sent to struct port 'aux' in 'ofproto'
1547 * if 'flood' is true. Otherwise, struct port 'aux' is an ordinary
1550 * An implementation that does not support multicast snooping may set
1551 * it to NULL or return EOPNOTSUPP. */
1552 int (*set_mcast_snooping_port
)(struct ofproto
*ofproto_
, void *aux
,
1555 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1557 * This is deprecated. It is only for compatibility with broken device drivers
1558 * in old versions of Linux that do not properly support VLANs when VLAN
1559 * devices are not used. When broken device drivers are no longer in
1560 * widespread use, we will delete these interfaces. */
1562 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1563 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1564 * that has OpenFlow port number 'realdev_ofp_port'.
1566 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1567 * as a VLAN splinter port.
1569 * This function should be NULL if an implementation does not support it.
1571 int (*set_realdev
)(struct ofport
*ofport
,
1572 ofp_port_t realdev_ofp_port
, int vid
);
1574 /* ## ------------------------ ## */
1575 /* ## OpenFlow meter functions ## */
1576 /* ## ------------------------ ## */
1578 /* These functions should be NULL if an implementation does not support
1579 * them. They must be all null or all non-null.. */
1581 /* Initializes 'features' to describe the metering features supported by
1583 void (*meter_get_features
)(const struct ofproto
*ofproto
,
1584 struct ofputil_meter_features
*features
);
1586 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1587 * success the function must store a provider meter ID other than
1588 * UINT32_MAX in '*id'. All further references to the meter will be made
1589 * with the returned provider meter id rather than the OpenFlow meter id.
1590 * The caller does not try to interpret the provider meter id, giving the
1591 * implementation the freedom to either use the OpenFlow meter_id value
1592 * provided in the meter configuration, or any other value suitable for the
1595 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1596 * with that meter provider ID to have configuration 'config', while
1597 * leaving '*id' unchanged. On failure, the existing meter configuration
1598 * is left intact. */
1599 enum ofperr (*meter_set
)(struct ofproto
*ofproto
, ofproto_meter_id
*id
,
1600 const struct ofputil_meter_config
*config
);
1602 /* Gets the meter and meter band packet and byte counts for maximum of
1603 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1604 * 'ofproto'. The caller fills in the other stats values. The band stats
1605 * are copied to memory at 'stats->bands' provided by the caller. The
1606 * number of returned band stats is returned in 'stats->n_bands'. */
1607 enum ofperr (*meter_get
)(const struct ofproto
*ofproto
,
1608 ofproto_meter_id id
,
1609 struct ofputil_meter_stats
*stats
);
1611 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1613 void (*meter_del
)(struct ofproto
*, ofproto_meter_id
);
1616 /* ## -------------------- ## */
1617 /* ## OpenFlow 1.1+ groups ## */
1618 /* ## -------------------- ## */
1620 struct ofgroup
*(*group_alloc
)(void);
1621 enum ofperr (*group_construct
)(struct ofgroup
*);
1622 void (*group_destruct
)(struct ofgroup
*);
1623 void (*group_dealloc
)(struct ofgroup
*);
1625 enum ofperr (*group_modify
)(struct ofgroup
*);
1627 enum ofperr (*group_get_stats
)(const struct ofgroup
*,
1628 struct ofputil_group_stats
*);
1631 extern const struct ofproto_class ofproto_dpif_class
;
1633 int ofproto_class_register(const struct ofproto_class
*);
1634 int ofproto_class_unregister(const struct ofproto_class
*);
1636 int ofproto_flow_mod(struct ofproto
*, struct ofputil_flow_mod
*)
1637 OVS_EXCLUDED(ofproto_mutex
);
1638 void ofproto_add_flow(struct ofproto
*, const struct match
*,
1639 unsigned int priority
,
1640 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1641 OVS_EXCLUDED(ofproto_mutex
);
1642 void ofproto_delete_flow(struct ofproto
*,
1643 const struct match
*, unsigned int priority
)
1644 OVS_EXCLUDED(ofproto_mutex
);
1645 void ofproto_flush_flows(struct ofproto
*);
1648 static inline const struct rule_actions
*
1649 rule_get_actions(const struct rule
*rule
)
1651 return ovsrcu_get(const struct rule_actions
*, &rule
->actions
);
1654 /* Returns true if 'rule' is an OpenFlow 1.3 "table-miss" rule, false
1657 * ("Table-miss" rules are special because a packet_in generated through one
1658 * uses OFPR_NO_MATCH as its reason, whereas packet_ins generated by any other
1659 * rule use OFPR_ACTION.) */
1661 rule_is_table_miss(const struct rule
*rule
)
1663 return rule
->cr
.priority
== 0 && cls_rule_is_catchall(&rule
->cr
);
1666 /* Returns true if 'rule' should be hidden from the controller.
1668 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1669 * (e.g. by in-band control) and are intentionally hidden from the
1672 rule_is_hidden(const struct rule
*rule
)
1674 return rule
->cr
.priority
> UINT16_MAX
;
1677 static inline struct rule
*
1678 rule_from_cls_rule(const struct cls_rule
*cls_rule
)
1680 return cls_rule
? CONTAINER_OF(cls_rule
, struct rule
, cr
) : NULL
;
1683 #endif /* ofproto/ofproto-provider.h */