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 * A cls->rwlock read-lock holder prevents rules from being added or deleted.
201 * Adding or removing rules requires holding ofproto_mutex AND the cls->rwlock
204 * cls->rwlock should be held only briefly. For extended access to a rule,
205 * increment its ref_count with ofproto_rule_ref(). A rule will not be freed
206 * until its ref_count reaches zero.
208 * Modifying a rule requires the rule's own mutex. Holding cls->rwlock (for
209 * read or write) does not allow the holder to modify the rule.
211 * Freeing a rule requires ofproto_mutex and the cls->rwlock write-lock. After
212 * removing the rule from the classifier, release a ref_count from the rule
213 * ('cls''s reference to the rule).
215 * Refer to the thread-safety notes on struct rule for more information.*/
217 enum oftable_flags flags;
218 struct classifier cls; /* Contains "struct rule"s. */
219 char *name; /* Table name exposed via OpenFlow, or NULL. */
221 /* Maximum number of flows or UINT_MAX if there is no limit besides any
222 * limit imposed by resource limitations. */
223 unsigned int max_flows;
225 /* These members determine the handling of an attempt to add a flow that
226 * would cause the table to have more than 'max_flows' flows.
228 * If 'eviction_fields' is NULL, overflows will be rejected with an error.
230 * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
231 * is nonzero), an overflow will cause a flow to be removed. The flow to
232 * be removed is chosen to give fairness among groups distinguished by
233 * different values for the subfields within 'groups'. */
234 struct mf_subfield *eviction_fields;
235 size_t n_eviction_fields;
239 * When a flow is added that would cause the table to have more than
240 * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
241 * used to decide which rule to evict: the rule is chosen from the eviction
242 * group that contains the greatest number of rules.*/
243 uint32_t eviction_group_id_basis;
244 struct hmap eviction_groups_by_id;
245 struct heap eviction_groups_by_size;
247 /* Table config: contains enum ofproto_table_config; accessed atomically. */
250 atomic_ulong n_matched;
251 atomic_ulong n_missed;
254 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
256 * All parameters are evaluated multiple times. */
257 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO) \
258 for ((TABLE) = (OFPROTO)->tables; \
259 (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
262 /* An OpenFlow flow within a "struct ofproto".
264 * With few exceptions, ofproto implementations may look at these fields but
265 * should not modify them.
271 * Except near the beginning or ending of its lifespan, rule 'rule' belongs to
272 * the classifier rule->ofproto->tables[rule->table_id].cls. The text below
273 * calls this classifier 'cls'.
278 * The thread safety rules described here for "struct rule" are motivated by
281 * - Prevent threads that read members of "struct rule" from reading bad
282 * data due to changes by some thread concurrently modifying those
285 * - Prevent two threads making changes to members of a given "struct rule"
286 * from interfering with each other.
292 * A rule 'rule' may be accessed without a risk of being freed by code that
293 * holds a read-lock or write-lock on 'cls->rwlock' or that owns a reference to
294 * 'rule->ref_count' (or both). Code that needs to hold onto a rule for a
295 * while should take 'cls->rwlock', find the rule it needs, increment
296 * 'rule->ref_count' with ofproto_rule_ref(), and drop 'cls->rwlock'.
298 * 'rule->ref_count' protects 'rule' from being freed. It doesn't protect the
299 * rule from being deleted from 'cls' (that's 'cls->rwlock') and it doesn't
300 * protect members of 'rule' from modification (that's 'rule->mutex').
302 * 'rule->mutex' protects the members of 'rule' from modification. It doesn't
303 * protect the rule from being deleted from 'cls' (that's 'cls->rwlock') and it
304 * doesn't prevent the rule from being freed (that's 'rule->ref_count').
306 * Regarding thread safety, the members of a rule fall into the following
309 * - Immutable. These members are marked 'const'.
311 * - Members that may be safely read or written only by code holding
312 * ofproto_mutex. These are marked OVS_GUARDED_BY(ofproto_mutex).
314 * - Members that may be safely read only by code holding ofproto_mutex or
315 * 'rule->mutex', and safely written only by coding holding ofproto_mutex
316 * AND 'rule->mutex'. These are marked OVS_GUARDED.
319 /* Where this rule resides in an OpenFlow switch.
321 * These are immutable once the rule is constructed, hence 'const'. */
322 struct ofproto *const ofproto; /* The ofproto that contains this rule. */
323 const struct cls_rule cr; /* In owning ofproto's classifier. */
324 const uint8_t table_id; /* Index in ofproto's 'tables' array. */
326 /* Protects members marked OVS_GUARDED.
327 * Readers only need to hold this mutex.
328 * Writers must hold both this mutex AND ofproto_mutex.
329 * By implication writers can read *without* taking this mutex while they
330 * hold ofproto_mutex. */
331 struct ovs_mutex mutex OVS_ACQ_AFTER(ofproto_mutex);
333 /* Number of references.
334 * The classifier owns one reference.
335 * Any thread trying to keep a rule from being freed should hold its own
337 struct ovs_refcount ref_count;
339 /* A "flow cookie" is the OpenFlow name for a 64-bit value associated with
341 ovs_be64 flow_cookie OVS_GUARDED;
342 struct hindex_node cookie_node OVS_GUARDED_BY(ofproto_mutex);
344 enum ofputil_flow_mod_flags flags OVS_GUARDED;
347 uint16_t hard_timeout OVS_GUARDED; /* In seconds from ->modified. */
348 uint16_t idle_timeout OVS_GUARDED; /* In seconds from ->used. */
350 /* Eviction groups (see comment on struct eviction_group for explanation) .
352 * 'eviction_group' is this rule's eviction group, or NULL if it is not in
353 * any eviction group. When 'eviction_group' is nonnull, 'evg_node' is in
354 * the ->eviction_group->rules hmap. */
355 struct eviction_group *eviction_group OVS_GUARDED_BY(ofproto_mutex);
356 struct heap_node evg_node OVS_GUARDED_BY(ofproto_mutex);
358 /* OpenFlow actions. See struct rule_actions for more thread-safety
360 OVSRCU_TYPE(const struct rule_actions *) actions;
362 /* In owning meter's 'rules' list. An empty list if there is no meter. */
363 struct list meter_list_node OVS_GUARDED_BY(ofproto_mutex);
365 /* Flow monitors (e.g. for NXST_FLOW_MONITOR, related to struct ofmonitor).
367 * 'add_seqno' is the sequence number when this rule was created.
368 * 'modify_seqno' is the sequence number when this rule was last modified.
369 * See 'monitor_seqno' in connmgr.c for more information. */
370 enum nx_flow_monitor_flags monitor_flags OVS_GUARDED_BY(ofproto_mutex);
371 uint64_t add_seqno OVS_GUARDED_BY(ofproto_mutex);
372 uint64_t modify_seqno OVS_GUARDED_BY(ofproto_mutex);
374 /* Optimisation for flow expiry. In ofproto's 'expirable' list if this
375 * rule is expirable, otherwise empty. */
376 struct list expirable OVS_GUARDED_BY(ofproto_mutex);
378 /* Times. Last so that they are more likely close to the stats managed
379 * by the provider. */
380 long long int created OVS_GUARDED; /* Creation time. */
382 /* Must hold 'mutex' for both read/write, 'ofproto_mutex' not needed. */
383 long long int modified OVS_GUARDED; /* Time of last modification. */
386 void ofproto_rule_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
400 * freed by code that holds a read-lock or write-lock on 'rule->mutex' (where
401 * 'rule' is the rule for which 'rule->actions == actions') or during the RCU
404 * All members are immutable: they do not change during the struct's
406 struct rule_actions {
409 * 'has_meter' is true if 'ofpacts' contains an OFPACT_METER action.
411 * 'has_learn_with_delete' is true if 'ofpacts' contains an OFPACT_LEARN
412 * action whose flags include NX_LEARN_F_DELETE_LEARNED. */
414 bool has_learn_with_delete;
417 uint32_t ofpacts_len; /* Size of 'ofpacts', in bytes. */
418 struct ofpact ofpacts[]; /* Sequence of "struct ofpacts". */
420 BUILD_ASSERT_DECL(offsetof(struct rule_actions, ofpacts) % OFPACT_ALIGNTO == 0);
422 const struct rule_actions *rule_actions_create(const struct ofpact *, size_t);
423 void rule_actions_destroy(const struct rule_actions *);
425 /* A set of rules to which an OpenFlow operation applies. */
426 struct rule_collection {
427 struct rule **rules; /* The rules. */
428 size_t n; /* Number of rules collected. */
430 size_t capacity; /* Number of rules that will fit in 'rules'. */
431 struct rule *stub[64]; /* Preallocated rules to avoid malloc(). */
434 void rule_collection_init(struct rule_collection *);
435 void rule_collection_add(struct rule_collection *, struct rule *);
436 void rule_collection_ref(struct rule_collection *) OVS_REQUIRES(ofproto_mutex);
437 void rule_collection_unref(struct rule_collection *);
438 void rule_collection_destroy(struct rule_collection *);
440 /* Limits the number of flows allowed in the datapath. Only affects the
441 * ofproto-dpif implementation. */
442 extern unsigned ofproto_flow_limit;
444 /* Maximum idle time (in ms) for flows to be cached in the datapath.
445 * Revalidators may expire flows more quickly than the configured value based
446 * on system load and other factors. This variable is subject to change. */
447 extern unsigned ofproto_max_idle;
449 /* Number of upcall handler and revalidator threads. Only affects the
450 * ofproto-dpif implementation. */
451 extern size_t n_handlers, n_revalidators;
453 static inline struct rule *rule_from_cls_rule(const struct cls_rule *);
455 void ofproto_rule_expire(struct rule *rule, uint8_t reason)
456 OVS_REQUIRES(ofproto_mutex);
457 void ofproto_rule_delete(struct ofproto *, struct rule *)
458 OVS_EXCLUDED(ofproto_mutex);
459 void ofproto_rule_reduce_timeouts(struct rule *rule, uint16_t idle_timeout,
460 uint16_t hard_timeout)
461 OVS_EXCLUDED(ofproto_mutex);
463 /* A group within a "struct ofproto".
465 * With few exceptions, ofproto implementations may look at these fields but
466 * should not modify them. */
468 struct hmap_node hmap_node OVS_GUARDED; /* In ofproto's "groups" hmap. */
470 /* Number of references.
472 * This is needed to keep track of references to the group in the xlate
475 * If the main thread removes the group from an ofproto, we need to
476 * guarantee that the group remains accessible to users of
477 * xlate_group_actions and the xlate_cache, as the xlate_cache will not be
478 * cleaned up until the corresponding datapath flows are revalidated. */
479 struct ovs_refcount ref_count;
481 /* No lock is needed to protect the fields below since they are not
482 * modified after construction. */
483 const struct ofproto *ofproto; /* The ofproto that contains this group. */
484 const uint32_t group_id;
485 const enum ofp11_group_type type; /* One of OFPGT_*. */
487 const long long int created; /* Creation time. */
488 const long long int modified; /* Time of last modification. */
490 struct list buckets; /* Contains "struct ofputil_bucket"s. */
491 const uint32_t n_buckets;
494 bool ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
495 struct ofgroup **group);
497 void ofproto_group_ref(struct ofgroup *);
498 void ofproto_group_unref(struct ofgroup *);
500 /* ofproto class structure, to be defined by each ofproto implementation.
506 * These functions work primarily with four different kinds of data
509 * - "struct ofproto", which represents an OpenFlow switch.
511 * - "struct ofport", which represents a port within an ofproto.
513 * - "struct rule", which represents an OpenFlow flow within an ofproto.
515 * - "struct ofgroup", which represents an OpenFlow 1.1+ group within an
518 * Each of these data structures contains all of the implementation-independent
519 * generic state for the respective concept, called the "base" state. None of
520 * them contains any extra space for ofproto implementations to use. Instead,
521 * each implementation is expected to declare its own data structure that
522 * contains an instance of the generic data structure plus additional
523 * implementation-specific members, called the "derived" state. The
524 * implementation can use casts or (preferably) the CONTAINER_OF macro to
525 * obtain access to derived state given only a pointer to the embedded generic
532 * Four stylized functions accompany each of these data structures:
534 * "alloc" "construct" "destruct" "dealloc"
535 * ------------ ---------------- --------------- --------------
536 * ofproto ->alloc ->construct ->destruct ->dealloc
537 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
538 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
539 * group ->group_alloc ->group_construct ->group_destruct ->group_dealloc
541 * "ofproto", "ofport", and "group" have this exact life cycle. The "rule"
542 * data structure also follow this life cycle with some additional elaborations
543 * described under "Rule Life Cycle" below.
545 * Any instance of a given data structure goes through the following life
548 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
549 * fails, skip all the other steps.
551 * 2. The client initializes all of the data structure's base state. If this
552 * fails, skip to step 7.
554 * 3. The client calls the "construct" function. The implementation
555 * initializes derived state. It may refer to the already-initialized
556 * base state. If "construct" fails, skip to step 6.
558 * 4. The data structure is now initialized and in use.
560 * 5. When the data structure is no longer needed, the client calls the
561 * "destruct" function. The implementation uninitializes derived state.
562 * The base state has not been uninitialized yet, so the implementation
563 * may still refer to it.
565 * 6. The client uninitializes all of the data structure's base state.
567 * 7. The client calls the "dealloc" to free the raw memory. The
568 * implementation must not refer to base or derived state in the data
569 * structure, because it has already been uninitialized.
571 * Each "alloc" function allocates and returns a new instance of the respective
572 * data structure. The "alloc" function is not given any information about the
573 * use of the new data structure, so it cannot perform much initialization.
574 * Its purpose is just to ensure that the new data structure has enough room
575 * for base and derived state. It may return a null pointer if memory is not
576 * available, in which case none of the other functions is called.
578 * Each "construct" function initializes derived state in its respective data
579 * structure. When "construct" is called, all of the base state has already
580 * been initialized, so the "construct" function may refer to it. The
581 * "construct" function is allowed to fail, in which case the client calls the
582 * "dealloc" function (but not the "destruct" function).
584 * Each "destruct" function uninitializes and frees derived state in its
585 * respective data structure. When "destruct" is called, the base state has
586 * not yet been uninitialized, so the "destruct" function may refer to it. The
587 * "destruct" function is not allowed to fail.
589 * Each "dealloc" function frees raw memory that was allocated by the the
590 * "alloc" function. The memory's base and derived members might not have ever
591 * been initialized (but if "construct" returned successfully, then it has been
592 * "destruct"ed already). The "dealloc" function is not allowed to fail.
598 * Most of these functions return 0 if they are successful or a positive error
599 * code on failure. Depending on the function, valid error codes are either
600 * errno values or OFPERR_* OpenFlow error codes.
602 * Most of these functions are expected to execute synchronously, that is, to
603 * block as necessary to obtain a result. Thus, these functions may return
604 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
605 * explicitly say those errors are a possibility. We may relax this
606 * requirement in the future if and when we encounter performance problems. */
607 struct ofproto_class {
608 /* ## ----------------- ## */
609 /* ## Factory Functions ## */
610 /* ## ----------------- ## */
612 /* Initializes provider. The caller may pass in 'iface_hints',
613 * which contains an shash of "struct iface_hint" elements indexed
614 * by the interface's name. The provider may use these hints to
615 * describe the startup configuration in order to reinitialize its
616 * state. The caller owns the provided data, so a provider must
617 * make copies of anything required. An ofproto provider must
618 * remove any existing state that is not described by the hint, and
619 * may choose to remove it all. */
620 void (*init)(const struct shash *iface_hints);
622 /* Enumerates the types of all support ofproto types into 'types'. The
623 * caller has already initialized 'types' and other ofproto classes might
624 * already have added names to it. */
625 void (*enumerate_types)(struct sset *types);
627 /* Enumerates the names of all existing datapath of the specified 'type'
628 * into 'names' 'all_dps'. The caller has already initialized 'names' as
631 * 'type' is one of the types enumerated by ->enumerate_types().
633 * Returns 0 if successful, otherwise a positive errno value.
635 int (*enumerate_names)(const char *type, struct sset *names);
637 /* Deletes the datapath with the specified 'type' and 'name'. The caller
638 * should have closed any open ofproto with this 'type' and 'name'; this
639 * function is allowed to fail if that is not the case.
641 * 'type' is one of the types enumerated by ->enumerate_types().
642 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
644 * Returns 0 if successful, otherwise a positive errno value.
646 int (*del)(const char *type, const char *name);
648 /* Returns the type to pass to netdev_open() when a datapath of type
649 * 'datapath_type' has a port of type 'port_type', for a few special
650 * cases when a netdev type differs from a port type. For example,
651 * when using the userspace datapath, a port of type "internal"
652 * needs to be opened as "tap".
654 * Returns either 'type' itself or a string literal, which must not
656 const char *(*port_open_type)(const char *datapath_type,
657 const char *port_type);
659 /* ## ------------------------ ## */
660 /* ## Top-Level type Functions ## */
661 /* ## ------------------------ ## */
663 /* Performs any periodic activity required on ofprotos of type
666 * An ofproto provider may implement it or not, depending on whether
667 * it needs type-level maintenance.
669 * Returns 0 if successful, otherwise a positive errno value. */
670 int (*type_run)(const char *type);
672 /* Causes the poll loop to wake up when a type 'type''s 'run'
673 * function needs to be called, e.g. by calling the timer or fd
674 * waiting functions in poll-loop.h.
676 * An ofproto provider may implement it or not, depending on whether
677 * it needs type-level maintenance. */
678 void (*type_wait)(const char *type);
680 /* ## --------------------------- ## */
681 /* ## Top-Level ofproto Functions ## */
682 /* ## --------------------------- ## */
684 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
690 * ->construct() should not modify any base members of the ofproto. The
691 * client will initialize the ofproto's 'ports' and 'tables' members after
692 * construction is complete.
694 * When ->construct() is called, the client does not yet know how many flow
695 * tables the datapath supports, so ofproto->n_tables will be 0 and
696 * ofproto->tables will be NULL. ->construct() should call
697 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
698 * ofproto->tables. Each flow table will be initially empty, so
699 * ->construct() should delete flows from the underlying datapath, if
700 * necessary, rather than populating the tables.
702 * If the ofproto knows the maximum port number that the datapath can have,
703 * then it can call ofproto_init_max_ports(). If it does so, then the
704 * client will ensure that the actions it allows to be used through
705 * OpenFlow do not refer to ports above that maximum number.
707 * Only one ofproto instance needs to be supported for any given datapath.
708 * If a datapath is already open as part of one "ofproto", then another
709 * attempt to "construct" the same datapath as part of another ofproto is
710 * allowed to fail with an error.
712 * ->construct() returns 0 if successful, otherwise a positive errno
719 * ->destruct() must also destroy all remaining rules in the ofproto's
720 * tables, by passing each remaining rule to ofproto_rule_delete().
722 * The client will destroy the flow tables themselves after ->destruct()
725 struct ofproto *(*alloc)(void);
726 int (*construct)(struct ofproto *ofproto);
727 void (*destruct)(struct ofproto *ofproto);
728 void (*dealloc)(struct ofproto *ofproto);
730 /* Performs any periodic activity required by 'ofproto'. It should:
732 * - Call connmgr_send_packet_in() for each received packet that missed
733 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
736 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
737 * its hard_timeout or idle_timeout, to expire the flow.
739 * Returns 0 if successful, otherwise a positive errno value. */
740 int (*run)(struct ofproto *ofproto);
742 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
743 * be called, e.g. by calling the timer or fd waiting functions in
745 void (*wait)(struct ofproto *ofproto);
747 /* Adds some memory usage statistics for the implementation of 'ofproto'
748 * into 'usage', for use with memory_report().
750 * This function is optional. */
751 void (*get_memory_usage)(const struct ofproto *ofproto,
752 struct simap *usage);
754 /* Adds some memory usage statistics for the implementation of 'type'
755 * into 'usage', for use with memory_report().
757 * This function is optional. */
758 void (*type_get_memory_usage)(const char *type, struct simap *usage);
760 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
761 * This function may prepare for that, for example by clearing state in
762 * advance. It should *not* actually delete any "struct rule"s from
763 * 'ofproto', only prepare for it.
765 * This function is optional; it's really just for optimization in case
766 * it's cheaper to delete all the flows from your hardware in a single pass
767 * than to do it one by one. */
768 void (*flush)(struct ofproto *ofproto);
770 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
772 * The implementation should store true in '*arp_match_ip' if the switch
773 * supports matching IP addresses inside ARP requests and replies, false
776 * The implementation should store in '*actions' a bitmap of the supported
777 * OpenFlow actions. Vendor actions are not included in '*actions'. */
778 void (*get_features)(struct ofproto *ofproto,
780 enum ofputil_action_bitmap *actions);
782 /* Helper for the OpenFlow OFPST_TABLE statistics request.
784 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
787 * - 'table_id' to the array index.
789 * - 'name' to "table#" where # is the table ID.
791 * - 'match' and 'wildcards' to OFPXMT12_MASK.
793 * - 'write_actions' and 'apply_actions' to OFPAT12_OUTPUT.
795 * - 'write_setfields' and 'apply_setfields' to OFPXMT12_MASK.
797 * - 'metadata_match' and 'metadata_write' to OVS_BE64_MAX.
799 * - 'instructions' to OFPIT11_ALL.
801 * - 'config' to OFPTC11_TABLE_MISS_MASK.
803 * - 'max_entries' to 1,000,000.
805 * - 'active_count' to the classifier_count() for the table.
807 * - 'lookup_count' and 'matched_count' to 0.
809 * The implementation should update any members in each element for which
810 * it has better values:
812 * - 'name' to a more meaningful name.
814 * - 'wildcards' to the set of wildcards actually supported by the table
815 * (if it doesn't support all OpenFlow wildcards).
817 * - 'instructions' to set the instructions actually supported by
820 * - 'write_actions' to set the write actions actually supported by
821 * the table (if it doesn't support all OpenFlow actions).
823 * - 'apply_actions' to set the apply actions actually supported by
824 * the table (if it doesn't support all OpenFlow actions).
826 * - 'write_setfields' to set the write setfields actually supported by
829 * - 'apply_setfields' to set the apply setfields actually supported by
832 * - 'max_entries' to the maximum number of flows actually supported by
835 * - 'lookup_count' to the number of packets looked up in this flow table
838 * - 'matched_count' to the number of packets looked up in this flow
839 * table so far that matched one of the flow entries.
841 * All of the members of struct ofp12_table_stats are in network byte
844 void (*get_tables)(struct ofproto *ofproto, struct ofp12_table_stats *ots);
846 /* ## ---------------- ## */
847 /* ## ofport Functions ## */
848 /* ## ---------------- ## */
850 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
852 * ->port_construct() should not modify any base members of the ofport.
853 * An ofproto implementation should use the 'ofp_port' member of
854 * "struct ofport" as the OpenFlow port number.
856 * ofports are managed by the base ofproto code. The ofproto
857 * implementation should only create and destroy them in response to calls
858 * to these functions. The base ofproto code will create and destroy
859 * ofports in the following situations:
861 * - Just after the ->construct() function is called, the base ofproto
862 * iterates over all of the implementation's ports, using
863 * ->port_dump_start() and related functions, and constructs an ofport
864 * for each dumped port.
866 * - If ->port_poll() reports that a specific port has changed, then the
867 * base ofproto will query that port with ->port_query_by_name() and
868 * construct or destruct ofports as necessary to reflect the updated
871 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
872 * change, then the base ofproto will iterate over all of the
873 * implementation's ports, in the same way as at ofproto
874 * initialization, and construct and destruct ofports to reflect all of
877 * ->port_construct() returns 0 if successful, otherwise a positive errno
880 struct ofport *(*port_alloc)(void);
881 int (*port_construct)(struct ofport *ofport);
882 void (*port_destruct)(struct ofport *ofport);
883 void (*port_dealloc)(struct ofport *ofport);
885 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
886 * the ofproto implementation uses the ofport's netdev internally, then it
887 * should switch to using the new one. The old one has been closed.
889 * An ofproto implementation that doesn't need to do anything in this
890 * function may use a null pointer. */
891 void (*port_modified)(struct ofport *ofport);
893 /* Called after an OpenFlow request changes a port's configuration.
894 * 'ofport->pp.config' contains the new configuration. 'old_config'
895 * contains the previous configuration.
897 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
898 * turn NETDEV_UP on and off, so this function doesn't have to do anything
899 * for that bit (and it won't be called if that is the only bit that
901 void (*port_reconfigured)(struct ofport *ofport,
902 enum ofputil_port_config old_config);
904 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
905 * initializes '*port' appropriately. Otherwise, returns a positive errno
908 * The caller owns the data in 'port' and must free it with
909 * ofproto_port_destroy() when it is no longer needed. */
910 int (*port_query_by_name)(const struct ofproto *ofproto,
911 const char *devname, struct ofproto_port *port);
913 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
914 * successful, otherwise a positive errno value. The caller should
915 * inform the implementation of the OpenFlow port through the
916 * ->port_construct() method.
918 * It doesn't matter whether the new port will be returned by a later call
919 * to ->port_poll(); the implementation may do whatever is more
921 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
923 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
924 * 0 if successful, otherwise a positive errno value.
926 * It doesn't matter whether the new port will be returned by a later call
927 * to ->port_poll(); the implementation may do whatever is more
929 int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
932 int (*port_get_stats)(const struct ofport *port,
933 struct netdev_stats *stats);
935 /* Port iteration functions.
937 * The client might not be entirely in control of the ports within an
938 * ofproto. Some hardware implementations, for example, might have a fixed
939 * set of ports in a datapath. For this reason, the client needs a way to
940 * iterate through all the ports that are actually in a datapath. These
941 * functions provide that functionality.
943 * The 'state' pointer provides the implementation a place to
944 * keep track of its position. Its format is opaque to the caller.
946 * The ofproto provider retains ownership of the data that it stores into
947 * ->port_dump_next()'s 'port' argument. The data must remain valid until
948 * at least the next call to ->port_dump_next() or ->port_dump_done() for
949 * 'state'. The caller will not modify or free it.
954 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
955 * On success, it should return 0 and initialize '*statep' with any data
956 * needed for iteration. On failure, returns a positive errno value, and
957 * the client will not call ->port_dump_next() or ->port_dump_done().
959 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
960 * 'state'. If there is another port, it should store the port's
961 * information into 'port' and return 0. It should return EOF if all ports
962 * have already been iterated. Otherwise, on error, it should return a
963 * positive errno value. This function will not be called again once it
964 * returns nonzero once for a given iteration (but the 'port_dump_done'
965 * function will be called afterward).
967 * ->port_dump_done() allows the implementation to release resources used
968 * for iteration. The caller might decide to stop iteration in the middle
969 * by calling this function before ->port_dump_next() returns nonzero.
977 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
980 * struct ofproto_port port;
982 * error = ofproto->ofproto_class->port_dump_next(
983 * ofproto, state, &port);
987 * // Do something with 'port' here (without modifying or freeing
988 * // any of its data).
990 * ofproto->ofproto_class->port_dump_done(ofproto, state);
992 * // 'error' is now EOF (success) or a positive errno value (failure).
994 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
995 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
996 struct ofproto_port *port);
997 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
999 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
1000 * in 'ofproto' has changed, then this function should do one of the
1003 * - Preferably: store the name of the device that was added to or deleted
1004 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
1005 * for freeing '*devnamep' (with free()) when it no longer needs it.
1007 * - Alternatively: return ENOBUFS, without indicating the device that was
1010 * Occasional 'false positives', in which the function returns 0 while
1011 * indicating a device that was not actually added or deleted or returns
1012 * ENOBUFS without any change, are acceptable.
1014 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
1015 * externally to the 'ofproto' object, e.g. by a system administrator via
1016 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
1017 * not report changes made through calls to 'port_add' or 'port_del' on the
1018 * same 'ofproto' object. (But it's OK for it to report them too, just
1019 * slightly less efficient.)
1021 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
1022 * also return other positive errno values to indicate that something has
1025 * If the set of ports in a datapath is fixed, or if the only way that the
1026 * set of ports in a datapath can change is through ->port_add() and
1027 * ->port_del(), then this function may be a null pointer.
1029 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
1031 /* Arranges for the poll loop to wake up when ->port_poll() will return a
1032 * value other than EAGAIN.
1034 * If the set of ports in a datapath is fixed, or if the only way that the
1035 * set of ports in a datapath can change is through ->port_add() and
1036 * ->port_del(), or if the poll loop will always wake up anyway when
1037 * ->port_poll() will return a value other than EAGAIN, then this function
1038 * may be a null pointer.
1040 void (*port_poll_wait)(const struct ofproto *ofproto);
1042 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
1043 * partner information for 'port' is up-to-date, 0 if LACP partner
1044 * information is not current (generally indicating a connectivity
1045 * problem), or -1 if LACP is not enabled on 'port'.
1047 * This function may be a null pointer if the ofproto implementation does
1048 * not support LACP. */
1049 int (*port_is_lacp_current)(const struct ofport *port);
1051 /* ## ----------------------- ## */
1052 /* ## OpenFlow Rule Functions ## */
1053 /* ## ----------------------- ## */
1055 /* Chooses an appropriate table for 'match' within 'ofproto'. On
1056 * success, stores the table ID into '*table_idp' and returns 0. On
1057 * failure, returns an OpenFlow error code.
1059 * The choice of table should be a function of 'match' and 'ofproto''s
1060 * datapath capabilities. It should not depend on the flows already in
1061 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
1062 * 'match' as its matching condition can never be inserted into 'ofproto',
1063 * even starting from an empty flow table.
1065 * If multiple tables are candidates for inserting the flow, the function
1066 * should choose one arbitrarily (but deterministically).
1068 * If this function is NULL then table 0 is always chosen. */
1069 enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
1070 const struct match *match,
1071 uint8_t *table_idp);
1073 /* Life-cycle functions for a "struct rule".
1079 * The life cycle of a struct rule is an elaboration of the basic life
1080 * cycle described above under "Life Cycle".
1082 * After a rule is successfully constructed, it is then inserted. If
1083 * insertion is successful, then before it is later destructed, it is
1086 * You can think of a rule as having the following extra steps inserted
1087 * between "Life Cycle" steps 4 and 5:
1089 * 4.1. The client inserts the rule into the flow table, making it
1090 * visible in flow table lookups.
1092 * 4.2. The client calls "rule_insert" to insert the flow. The
1093 * implementation attempts to install the flow in the underlying
1094 * hardware and returns an error code indicate success or failure.
1095 * On failure, go to step 5.
1097 * 4.3. The rule is now installed in the flow table. Eventually it will
1100 * 4.4. The client removes the rule from the flow table. It is no longer
1101 * visible in flow table lookups.
1103 * 4.5. The client calls "rule_delete". The implementation uninstalls
1104 * the flow from the underlying hardware. Deletion is not allowed
1111 * When ->rule_construct() is called, 'rule' is a new rule that is not yet
1112 * inserted into a flow table. ->rule_construct() should initialize enough
1113 * of the rule's derived state for 'rule' to be suitable for inserting into
1114 * a flow table. ->rule_construct() should not modify any base members of
1117 * If ->rule_construct() fails (as indicated by returning a nonzero
1118 * OpenFlow error code), the ofproto base code will uninitialize and
1119 * deallocate 'rule'. See "Rule Life Cycle" above for more details.
1121 * ->rule_construct() may also:
1123 * - Validate that the datapath supports the matching rule in 'rule->cr'
1124 * datapath. For example, if the rule's table does not support
1125 * registers, then it is an error if 'rule->cr' does not wildcard all
1128 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
1130 * Some implementations might need to defer these tasks to ->rule_insert(),
1131 * which is also acceptable.
1137 * Following successful construction, the ofproto base case inserts 'rule'
1138 * into its flow table, then it calls ->rule_insert(). ->rule_insert()
1139 * must add the new rule to the datapath flow table and return only after
1140 * this is complete (whether it succeeds or fails).
1142 * If ->rule_insert() fails, the ofproto base code will remove 'rule' from
1143 * the flow table, destruct, uninitialize, and deallocate 'rule'. See
1144 * "Rule Life Cycle" above for more details.
1150 * The ofproto base code removes 'rule' from its flow table before it calls
1151 * ->rule_delete(). ->rule_delete() must remove 'rule' from the datapath
1152 * flow table and return only after this has completed successfully.
1154 * Rule deletion must not fail.
1160 * ->rule_destruct() must uninitialize derived state.
1162 * Rule destruction must not fail. */
1163 struct rule *(*rule_alloc)(void);
1164 enum ofperr (*rule_construct)(struct rule *rule)
1165 /* OVS_REQUIRES(ofproto_mutex) */;
1166 enum ofperr (*rule_insert)(struct rule *rule)
1167 /* OVS_REQUIRES(ofproto_mutex) */;
1168 void (*rule_delete)(struct rule *rule) /* OVS_REQUIRES(ofproto_mutex) */;
1169 void (*rule_destruct)(struct rule *rule);
1170 void (*rule_dealloc)(struct rule *rule);
1172 /* Obtains statistics for 'rule', storing the number of packets that have
1173 * matched it in '*packet_count' and the number of bytes in those packets
1174 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
1175 * count is unknown. */
1176 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
1177 uint64_t *byte_count, long long int *used)
1178 /* OVS_EXCLUDED(ofproto_mutex) */;
1180 /* Applies the actions in 'rule' to 'packet'. (This implements sending
1181 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1183 * Takes ownership of 'packet' (so it should eventually free it, with
1186 * 'flow' reflects the flow information for 'packet'. All of the
1187 * information in 'flow' is extracted from 'packet', except for
1188 * flow->tunnel and flow->in_port, which are assigned the correct values
1189 * for the incoming packet. The register values are zeroed. 'packet''s
1190 * header pointers and offsets (e.g. packet->l3) are appropriately
1191 * initialized. packet->l3 is aligned on a 32-bit boundary.
1193 * The implementation should add the statistics for 'packet' into 'rule'.
1195 * Returns 0 if successful, otherwise an OpenFlow error code. */
1196 enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1197 struct ofpbuf *packet);
1199 /* If the datapath can properly implement changing 'rule''s actions to the
1200 * 'ofpacts_len' bytes in 'ofpacts', returns 0. Otherwise, returns an enum
1201 * ofperr indicating why the new actions wouldn't work.
1203 * May be a null pointer if any set of actions is acceptable. */
1204 enum ofperr (*rule_premodify_actions)(const struct rule *rule,
1205 const struct ofpact *ofpacts,
1207 /* OVS_REQUIRES(ofproto_mutex) */;
1209 /* When ->rule_modify_actions() is called, the caller has already replaced
1210 * the OpenFlow actions in 'rule' by a new set. (If
1211 * ->rule_premodify_actions is nonnull, then it was previously called to
1212 * verify that the new set of actions is acceptable.)
1214 * ->rule_modify_actions() must:
1216 * - Update the datapath flow table with the new actions.
1218 * - Only if 'reset_counters' is true, reset any packet or byte counters
1219 * associated with the rule to zero, so that rule_get_stats() will not
1220 * longer count those packets or bytes.
1222 * Rule modification must not fail.
1224 * ->rule_modify_actions() should not modify any base members of struct
1226 void (*rule_modify_actions)(struct rule *rule, bool reset_counters)
1227 /* OVS_REQUIRES(ofproto_mutex) */;
1229 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1230 * which takes one of the following values, with the corresponding
1233 * - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1234 * as other packets, omitting TCP and UDP port numbers (always setting
1237 * - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1238 * passing them through the flow table.
1240 * - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1241 * passing packets through the flow table.
1243 * - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1244 * except that TCP and UDP port numbers should be included in fragments
1247 * Implementations are not required to support every mode.
1248 * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1250 * At the time of the call to ->set_frag_handling(), the current mode is
1251 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1252 * true if the requested mode was set, false if it is not supported.
1254 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1255 * reflect the new mode.
1257 bool (*set_frag_handling)(struct ofproto *ofproto,
1258 enum ofp_config_flags frag_handling);
1260 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1261 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1263 * The caller retains ownership of 'packet' and of 'ofpacts', so
1264 * ->packet_out() should not modify or free them.
1266 * This function must validate that it can correctly implement 'ofpacts'.
1267 * If not, then it should return an OpenFlow error code.
1269 * 'flow' reflects the flow information for 'packet'. All of the
1270 * information in 'flow' is extracted from 'packet', except for
1271 * flow->in_port (see below). flow->tunnel and its register values are
1274 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1275 * implementation should reject invalid flow->in_port values by returning
1276 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1277 * ofproto_init_max_ports(), then the client will reject these ports
1278 * itself.) For consistency, the implementation should consider valid for
1279 * flow->in_port any value that could possibly be seen in a packet that it
1280 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1281 * that never generates packet-ins (e.g. due to hardware limitations)
1282 * should still allow flow->in_port values for every possible physical port
1283 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1284 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1285 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1286 * these, treating each of them as packets generated by the controller as
1287 * opposed to packets originating from some switch port.
1289 * (Ordinarily the only effect of flow->in_port is on output actions that
1290 * involve the input port, such as actions that output to OFPP_IN_PORT,
1291 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1292 * "resubmit" actions.)
1294 * 'packet' is not matched against the OpenFlow flow table, so its
1295 * statistics should not be included in OpenFlow flow statistics.
1297 * Returns 0 if successful, otherwise an OpenFlow error code. */
1298 enum ofperr (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
1299 const struct flow *flow,
1300 const struct ofpact *ofpacts,
1301 size_t ofpacts_len);
1303 /* ## ------------------------- ## */
1304 /* ## OFPP_NORMAL configuration ## */
1305 /* ## ------------------------- ## */
1307 /* Configures NetFlow on 'ofproto' according to the options in
1308 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1310 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1311 * NetFlow, as does a null pointer. */
1312 int (*set_netflow)(struct ofproto *ofproto,
1313 const struct netflow_options *netflow_options);
1315 void (*get_netflow_ids)(const struct ofproto *ofproto,
1316 uint8_t *engine_type, uint8_t *engine_id);
1318 /* Configures sFlow on 'ofproto' according to the options in
1319 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1321 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1322 * sFlow, as does a null pointer. */
1323 int (*set_sflow)(struct ofproto *ofproto,
1324 const struct ofproto_sflow_options *sflow_options);
1326 /* Configures IPFIX on 'ofproto' according to the options in
1327 * 'bridge_exporter_options' and the 'flow_exporters_options'
1328 * array, or turns off IPFIX if 'bridge_exporter_options' and
1329 * 'flow_exporters_options' is NULL.
1331 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1332 * IPFIX, as does a null pointer. */
1334 struct ofproto *ofproto,
1335 const struct ofproto_ipfix_bridge_exporter_options
1336 *bridge_exporter_options,
1337 const struct ofproto_ipfix_flow_exporter_options
1338 *flow_exporters_options, size_t n_flow_exporters_options);
1340 /* Configures connectivity fault management on 'ofport'.
1342 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1344 * If 'cfm_settings' is null, removes any connectivity fault management
1345 * configuration from 'ofport'.
1347 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1348 * support CFM, as does a null pointer. */
1349 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1351 /* Checks the status of CFM configured on 'ofport'. Returns 0 if the
1352 * port's CFM status was successfully stored into '*status'. Returns
1353 * negative number if there is no status change since last update.
1354 * Returns positive errno otherwise.
1356 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1357 * support CFM, as does a null pointer.
1359 * The caller must provide and own '*status', and it must free the array
1360 * returned in 'status->rmps'. '*status' is indeterminate if the return
1361 * value is non-zero. */
1362 int (*get_cfm_status)(const struct ofport *ofport,
1363 struct ofproto_cfm_status *status);
1365 /* Configures BFD on 'ofport'.
1367 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1368 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1369 * according to 'cfg'.
1371 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1372 * support BFD, as does a null pointer. */
1373 int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1375 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1376 * success. Returns a negative number if there is no status change since
1377 * last update. Returns a positive errno otherwise.
1379 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1380 * 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 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1532 * This is deprecated. It is only for compatibility with broken device drivers
1533 * in old versions of Linux that do not properly support VLANs when VLAN
1534 * devices are not used. When broken device drivers are no longer in
1535 * widespread use, we will delete these interfaces. */
1537 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1538 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1539 * that has OpenFlow port number 'realdev_ofp_port'.
1541 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1542 * as a VLAN splinter port.
1544 * This function should be NULL if an implementation does not support it.
1546 int (*set_realdev)(struct ofport *ofport,
1547 ofp_port_t realdev_ofp_port, int vid);
1549 /* ## ------------------------ ## */
1550 /* ## OpenFlow meter functions ## */
1551 /* ## ------------------------ ## */
1553 /* These functions should be NULL if an implementation does not support
1554 * them. They must be all null or all non-null.. */
1556 /* Initializes 'features' to describe the metering features supported by
1558 void (*meter_get_features)(const struct ofproto *ofproto,
1559 struct ofputil_meter_features *features);
1561 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1562 * success the function must store a provider meter ID other than
1563 * UINT32_MAX in '*id'. All further references to the meter will be made
1564 * with the returned provider meter id rather than the OpenFlow meter id.
1565 * The caller does not try to interpret the provider meter id, giving the
1566 * implementation the freedom to either use the OpenFlow meter_id value
1567 * provided in the meter configuration, or any other value suitable for the
1570 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1571 * with that meter provider ID to have configuration 'config', while
1572 * leaving '*id' unchanged. On failure, the existing meter configuration
1573 * is left intact. */
1574 enum ofperr (*meter_set)(struct ofproto *ofproto, ofproto_meter_id *id,
1575 const struct ofputil_meter_config *config);
1577 /* Gets the meter and meter band packet and byte counts for maximum of
1578 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1579 * 'ofproto'. The caller fills in the other stats values. The band stats
1580 * are copied to memory at 'stats->bands' provided by the caller. The
1581 * number of returned band stats is returned in 'stats->n_bands'. */
1582 enum ofperr (*meter_get)(const struct ofproto *ofproto,
1583 ofproto_meter_id id,
1584 struct ofputil_meter_stats *stats);
1586 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1588 void (*meter_del)(struct ofproto *, ofproto_meter_id);
1591 /* ## -------------------- ## */
1592 /* ## OpenFlow 1.1+ groups ## */
1593 /* ## -------------------- ## */
1595 struct ofgroup *(*group_alloc)(void);
1596 enum ofperr (*group_construct)(struct ofgroup *);
1597 void (*group_destruct)(struct ofgroup *);
1598 void (*group_dealloc)(struct ofgroup *);
1600 enum ofperr (*group_modify)(struct ofgroup *);
1602 enum ofperr (*group_get_stats)(const struct ofgroup *,
1603 struct ofputil_group_stats *);
1606 extern const struct ofproto_class ofproto_dpif_class;
1608 int ofproto_class_register(const struct ofproto_class *);
1609 int ofproto_class_unregister(const struct ofproto_class *);
1611 int ofproto_flow_mod(struct ofproto *, struct ofputil_flow_mod *)
1612 OVS_EXCLUDED(ofproto_mutex);
1613 void ofproto_add_flow(struct ofproto *, const struct match *,
1614 unsigned int priority,
1615 const struct ofpact *ofpacts, size_t ofpacts_len)
1616 OVS_EXCLUDED(ofproto_mutex);
1617 void ofproto_delete_flow(struct ofproto *,
1618 const struct match *, unsigned int priority)
1619 OVS_EXCLUDED(ofproto_mutex);
1620 void ofproto_flush_flows(struct ofproto *);
1623 static inline const struct rule_actions *
1624 rule_get_actions(const struct rule *rule)
1626 return ovsrcu_get(const struct rule_actions *, &rule->actions);
1629 /* Returns true if 'rule' is an OpenFlow 1.3 "table-miss" rule, false
1632 * ("Table-miss" rules are special because a packet_in generated through one
1633 * uses OFPR_NO_MATCH as its reason, whereas packet_ins generated by any other
1634 * rule use OFPR_ACTION.) */
1636 rule_is_table_miss(const struct rule *rule)
1638 return rule->cr.priority == 0 && cls_rule_is_catchall(&rule->cr);
1641 /* Returns true if 'rule' should be hidden from the controller.
1643 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1644 * (e.g. by in-band control) and are intentionally hidden from the
1647 rule_is_hidden(const struct rule *rule)
1649 return rule->cr.priority > UINT16_MAX;
1652 static inline struct rule *
1653 rule_from_cls_rule(const struct cls_rule *cls_rule)
1655 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
1658 #endif /* ofproto/ofproto-provider.h */