2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 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-errors.h"
44 #include "ofproto/ofproto.h"
45 #include "ovs-atomic.h"
46 #include "ovs-thread.h"
53 struct ofputil_flow_mod;
57 extern struct ovs_mutex ofproto_mutex;
59 /* An OpenFlow switch.
61 * With few exceptions, ofproto implementations may look at these fields but
62 * should not modify them. */
64 struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
65 const struct ofproto_class *ofproto_class;
66 char *type; /* Datapath type. */
67 char *name; /* Datapath name. */
70 uint64_t fallback_dpid; /* Datapath ID if no better choice found. */
71 uint64_t datapath_id; /* Datapath ID. */
72 bool forward_bpdu; /* Option to allow forwarding of BPDU frames
73 * when NORMAL action is invoked. */
74 char *mfr_desc; /* Manufacturer (NULL for default)b. */
75 char *hw_desc; /* Hardware (NULL for default). */
76 char *sw_desc; /* Software version (NULL for default). */
77 char *serial_desc; /* Serial number (NULL for default). */
78 char *dp_desc; /* Datapath description (NULL for default). */
79 enum ofp_config_flags frag_handling; /* One of OFPC_*. */
82 struct hmap ports; /* Contains "struct ofport"s. */
83 struct shash port_by_name;
84 struct simap ofp_requests; /* OpenFlow port number requests. */
85 uint16_t alloc_port_no; /* Last allocated OpenFlow port number. */
86 uint16_t max_ports; /* Max possible OpenFlow port num, plus one. */
87 struct hmap ofport_usage; /* Map ofport to last used time. */
88 uint64_t change_seq; /* Change sequence for netdev status. */
91 long long int eviction_group_timer; /* For rate limited reheapification. */
92 struct oftable *tables;
95 /* Rules indexed on their cookie values, in all flow tables. */
96 struct hindex cookies OVS_GUARDED_BY(ofproto_mutex);
98 /* List of expirable flows, in all flow tables. */
99 struct list expirable OVS_GUARDED_BY(ofproto_mutex);
102 * OpenFlow meters start at 1. To avoid confusion we leave the first
103 * pointer in the array un-used, and index directly with the OpenFlow
105 struct ofputil_meter_features meter_features;
106 struct meter **meters; /* 'meter_features.max_meter' + 1 pointers. */
108 /* OpenFlow connections. */
109 struct connmgr *connmgr;
111 /* Flow table operation tracking.
113 * 'state' is meaningful only within ofproto.c, one of the enum
114 * ofproto_state constants defined there.
116 * 'pending' is the list of "struct ofopgroup"s currently pending.
118 * 'n_pending' is the number of elements in 'pending'.
120 * 'deletions' contains pending ofoperations of type OFOPERATION_DELETE,
121 * indexed on its rule's flow.*/
123 struct list pending OVS_GUARDED_BY(ofproto_mutex);
124 unsigned int n_pending OVS_GUARDED_BY(ofproto_mutex);
125 struct hmap deletions OVS_GUARDED_BY(ofproto_mutex);
127 /* Delayed rule executions.
129 * We delay calls to ->ofproto_class->rule_execute() past releasing
130 * ofproto_mutex during a flow_mod, because otherwise a "learn" action
131 * triggered by the executing the packet would try to recursively modify
132 * the flow table and reacquire the global lock. */
133 struct guarded_list rule_executes; /* Contains "struct rule_execute"s. */
135 /* Flow table operation logging. */
136 int n_add, n_delete, n_modify; /* Number of unreported ops of each kind. */
137 long long int first_op, last_op; /* Range of times for unreported ops. */
138 long long int next_op_report; /* Time to report ops, or LLONG_MAX. */
139 long long int op_backoff; /* Earliest time to report ops again. */
141 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
143 * This is deprecated. It is only for compatibility with broken device
144 * drivers in old versions of Linux that do not properly support VLANs when
145 * VLAN devices are not used. When broken device drivers are no longer in
146 * widespread use, we will delete these interfaces. */
147 unsigned long int *vlan_bitmap; /* 4096-bit bitmap of in-use VLANs. */
148 bool vlans_changed; /* True if new VLANs are in use. */
149 int min_mtu; /* Current MTU of non-internal ports. */
152 struct ovs_rwlock groups_rwlock;
153 struct hmap groups OVS_GUARDED; /* Contains "struct ofgroup"s. */
154 uint32_t n_groups[4] OVS_GUARDED; /* # of existing groups of each type. */
155 struct ofputil_group_features ogf;
158 void ofproto_init_tables(struct ofproto *, int n_tables);
159 void ofproto_init_max_ports(struct ofproto *, uint16_t max_ports);
161 struct ofproto *ofproto_lookup(const char *name);
162 struct ofport *ofproto_get_port(const struct ofproto *, ofp_port_t ofp_port);
164 /* An OpenFlow port within a "struct ofproto".
166 * The port's name is netdev_get_name(port->netdev).
168 * With few exceptions, ofproto implementations may look at these fields but
169 * should not modify them. */
171 struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
172 struct ofproto *ofproto; /* The ofproto that contains this port. */
173 struct netdev *netdev;
174 struct ofputil_phy_port pp;
175 ofp_port_t ofp_port; /* OpenFlow port number. */
176 long long int created; /* Time created, in msec. */
180 void ofproto_port_set_state(struct ofport *, enum ofputil_port_state);
182 /* OpenFlow table flags:
184 * - "Hidden" tables are not included in OpenFlow operations that operate on
185 * "all tables". For example, a request for flow stats on all tables will
186 * omit flows in hidden tables, table stats requests will omit the table
187 * entirely, and the switch features reply will not count the hidden table.
189 * However, operations that specifically name the particular table still
190 * operate on it. For example, flow_mods and flow stats requests on a
193 * To avoid gaps in table IDs (which have unclear validity in OpenFlow),
194 * hidden tables must be the highest-numbered tables that a provider
197 * - "Read-only" tables can't be changed through OpenFlow operations. (At
198 * the moment all flow table operations go effectively through OpenFlow, so
199 * this means that read-only tables can't be changed at all after the
200 * read-only flag is set.)
202 * The generic ofproto layer never sets these flags. An ofproto provider can
203 * set them if it is appropriate.
206 OFTABLE_HIDDEN = 1 << 0, /* Hide from most OpenFlow operations. */
207 OFTABLE_READONLY = 1 << 1 /* Don't allow OpenFlow to change this table. */
210 /* A flow table within a "struct ofproto".
216 * A cls->rwlock read-lock holder prevents rules from being added or deleted.
218 * Adding or removing rules requires holding ofproto_mutex AND the cls->rwlock
221 * cls->rwlock should be held only briefly. For extended access to a rule,
222 * increment its ref_count with ofproto_rule_ref(). A rule will not be freed
223 * until its ref_count reaches zero.
225 * Modifying a rule requires the rule's own mutex. Holding cls->rwlock (for
226 * read or write) does not allow the holder to modify the rule.
228 * Freeing a rule requires ofproto_mutex and the cls->rwlock write-lock. After
229 * removing the rule from the classifier, release a ref_count from the rule
230 * ('cls''s reference to the rule).
232 * Refer to the thread-safety notes on struct rule for more information.*/
234 enum oftable_flags flags;
235 struct classifier cls; /* Contains "struct rule"s. */
236 char *name; /* Table name exposed via OpenFlow, or NULL. */
238 /* Maximum number of flows or UINT_MAX if there is no limit besides any
239 * limit imposed by resource limitations. */
240 unsigned int max_flows;
242 /* These members determine the handling of an attempt to add a flow that
243 * would cause the table to have more than 'max_flows' flows.
245 * If 'eviction_fields' is NULL, overflows will be rejected with an error.
247 * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
248 * is nonzero), an overflow will cause a flow to be removed. The flow to
249 * be removed is chosen to give fairness among groups distinguished by
250 * different values for the subfields within 'groups'. */
251 struct mf_subfield *eviction_fields;
252 size_t n_eviction_fields;
256 * When a flow is added that would cause the table to have more than
257 * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
258 * used to decide which rule to evict: the rule is chosen from the eviction
259 * group that contains the greatest number of rules.*/
260 uint32_t eviction_group_id_basis;
261 struct hmap eviction_groups_by_id;
262 struct heap eviction_groups_by_size;
264 /* Table config: contains enum ofp_table_config; accessed atomically. */
268 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
270 * All parameters are evaluated multiple times. */
271 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO) \
272 for ((TABLE) = (OFPROTO)->tables; \
273 (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
276 /* An OpenFlow flow within a "struct ofproto".
278 * With few exceptions, ofproto implementations may look at these fields but
279 * should not modify them.
285 * Except near the beginning or ending of its lifespan, rule 'rule' belongs to
286 * the classifier rule->ofproto->tables[rule->table_id].cls. The text below
287 * calls this classifier 'cls'.
292 * The thread safety rules described here for "struct rule" are motivated by
295 * - Prevent threads that read members of "struct rule" from reading bad
296 * data due to changes by some thread concurrently modifying those
299 * - Prevent two threads making changes to members of a given "struct rule"
300 * from interfering with each other.
306 * A rule 'rule' may be accessed without a risk of being freed by code that
307 * holds a read-lock or write-lock on 'cls->rwlock' or that owns a reference to
308 * 'rule->ref_count' (or both). Code that needs to hold onto a rule for a
309 * while should take 'cls->rwlock', find the rule it needs, increment
310 * 'rule->ref_count' with ofproto_rule_ref(), and drop 'cls->rwlock'.
312 * 'rule->ref_count' protects 'rule' from being freed. It doesn't protect the
313 * rule from being deleted from 'cls' (that's 'cls->rwlock') and it doesn't
314 * protect members of 'rule' from modification (that's 'rule->mutex').
316 * 'rule->mutex' protects the members of 'rule' from modification. It doesn't
317 * protect the rule from being deleted from 'cls' (that's 'cls->rwlock') and it
318 * doesn't prevent the rule from being freed (that's 'rule->ref_count').
320 * Regarding thread safety, the members of a rule fall into the following
323 * - Immutable. These members are marked 'const'.
325 * - Members that may be safely read or written only by code holding
326 * ofproto_mutex. These are marked OVS_GUARDED_BY(ofproto_mutex).
328 * - Members that may be safely read only by code holding ofproto_mutex or
329 * 'rule->mutex', and safely written only by coding holding ofproto_mutex
330 * AND 'rule->mutex'. These are marked OVS_GUARDED.
333 /* Where this rule resides in an OpenFlow switch.
335 * These are immutable once the rule is constructed, hence 'const'. */
336 struct ofproto *const ofproto; /* The ofproto that contains this rule. */
337 const struct cls_rule cr; /* In owning ofproto's classifier. */
338 const uint8_t table_id; /* Index in ofproto's 'tables' array. */
340 /* Protects members marked OVS_GUARDED.
341 * Readers only need to hold this mutex.
342 * Writers must hold both this mutex AND ofproto_mutex. */
343 struct ovs_mutex mutex OVS_ACQ_AFTER(ofproto_mutex);
345 /* Number of references.
346 * The classifier owns one reference.
347 * Any thread trying to keep a rule from being freed should hold its own
349 atomic_uint ref_count;
351 /* Operation now in progress, if nonnull. */
352 struct ofoperation *pending OVS_GUARDED_BY(ofproto_mutex);
354 /* A "flow cookie" is the OpenFlow name for a 64-bit value associated with
356 ovs_be64 flow_cookie OVS_GUARDED;
357 struct hindex_node cookie_node OVS_GUARDED_BY(ofproto_mutex);
360 long long int created OVS_GUARDED; /* Creation time. */
361 long long int modified OVS_GUARDED; /* Time of last modification. */
362 long long int used OVS_GUARDED; /* Last use; time created if never used. */
363 enum ofputil_flow_mod_flags flags OVS_GUARDED;
366 uint16_t hard_timeout OVS_GUARDED; /* In seconds from ->modified. */
367 uint16_t idle_timeout OVS_GUARDED; /* In seconds from ->used. */
369 /* Eviction groups (see comment on struct eviction_group for explanation) .
371 * 'eviction_group' is this rule's eviction group, or NULL if it is not in
372 * any eviction group. When 'eviction_group' is nonnull, 'evg_node' is in
373 * the ->eviction_group->rules hmap. */
374 struct eviction_group *eviction_group OVS_GUARDED_BY(ofproto_mutex);
375 struct heap_node evg_node OVS_GUARDED_BY(ofproto_mutex);
377 /* OpenFlow actions. See struct rule_actions for more thread-safety
379 struct rule_actions *actions OVS_GUARDED;
381 /* In owning meter's 'rules' list. An empty list if there is no meter. */
382 struct list meter_list_node OVS_GUARDED_BY(ofproto_mutex);
384 /* Flow monitors (e.g. for NXST_FLOW_MONITOR, related to struct ofmonitor).
386 * 'add_seqno' is the sequence number when this rule was created.
387 * 'modify_seqno' is the sequence number when this rule was last modified.
388 * See 'monitor_seqno' in connmgr.c for more information. */
389 enum nx_flow_monitor_flags monitor_flags OVS_GUARDED_BY(ofproto_mutex);
390 uint64_t add_seqno OVS_GUARDED_BY(ofproto_mutex);
391 uint64_t modify_seqno OVS_GUARDED_BY(ofproto_mutex);
393 /* Optimisation for flow expiry. In ofproto's 'expirable' list if this
394 * rule is expirable, otherwise empty. */
395 struct list expirable OVS_GUARDED_BY(ofproto_mutex);
398 void ofproto_rule_ref(struct rule *);
399 void ofproto_rule_unref(struct rule *);
401 struct rule_actions *rule_get_actions(const struct rule *rule)
402 OVS_EXCLUDED(rule->mutex);
403 struct rule_actions *rule_get_actions__(const struct rule *rule)
404 OVS_REQUIRES(rule->mutex);
406 /* Returns true if 'rule' is an OpenFlow 1.3 "table-miss" rule, false
409 * ("Table-miss" rules are special because a packet_in generated through one
410 * uses OFPR_NO_MATCH as its reason, whereas packet_ins generated by any other
411 * rule use OFPR_ACTION.) */
413 rule_is_table_miss(const struct rule *rule)
415 return rule->cr.priority == 0 && cls_rule_is_catchall(&rule->cr);
418 /* A set of actions within a "struct rule".
424 * A struct rule_actions 'actions' may be accessed without a risk of being
425 * freed by code that holds a read-lock or write-lock on 'rule->mutex' (where
426 * 'rule' is the rule for which 'rule->actions == actions') or that owns a
427 * reference to 'actions->ref_count' (or both). */
428 struct rule_actions {
429 atomic_uint ref_count;
431 /* These members are immutable: they do not change during the struct's
433 struct ofpact *ofpacts; /* Sequence of "struct ofpacts". */
434 unsigned int ofpacts_len; /* Size of 'ofpacts', in bytes. */
435 uint32_t provider_meter_id; /* Datapath meter_id, or UINT32_MAX. */
438 struct rule_actions *rule_actions_create(const struct ofproto *,
439 const struct ofpact *, size_t);
440 void rule_actions_ref(struct rule_actions *);
441 void rule_actions_unref(struct rule_actions *);
443 /* A set of rules to which an OpenFlow operation applies. */
444 struct rule_collection {
445 struct rule **rules; /* The rules. */
446 size_t n; /* Number of rules collected. */
448 size_t capacity; /* Number of rules that will fit in 'rules'. */
449 struct rule *stub[64]; /* Preallocated rules to avoid malloc(). */
452 void rule_collection_init(struct rule_collection *);
453 void rule_collection_add(struct rule_collection *, struct rule *);
454 void rule_collection_ref(struct rule_collection *) OVS_REQUIRES(ofproto_mutex);
455 void rule_collection_unref(struct rule_collection *);
456 void rule_collection_destroy(struct rule_collection *);
458 /* Limits the number of flows allowed in the datapath. Only affects the
459 * ofproto-dpif implementation. */
460 extern unsigned ofproto_flow_limit;
462 /* Number of upcall handler and revalidator threads. Only affects the
463 * ofproto-dpif implementation. */
464 extern size_t n_handlers, n_revalidators;
466 /* Determines which model to use for handling misses in the ofproto-dpif
468 extern enum ofproto_flow_miss_model flow_miss_model;
470 static inline struct rule *
471 rule_from_cls_rule(const struct cls_rule *cls_rule)
473 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
476 void ofproto_rule_expire(struct rule *rule, uint8_t reason)
477 OVS_REQUIRES(ofproto_mutex);
478 void ofproto_rule_delete(struct ofproto *, struct rule *)
479 OVS_EXCLUDED(ofproto_mutex);
480 void ofproto_rule_reduce_timeouts(struct rule *rule, uint16_t idle_timeout,
481 uint16_t hard_timeout)
482 OVS_EXCLUDED(ofproto_mutex);
484 void ofoperation_complete(struct ofoperation *, enum ofperr);
486 bool ofoperation_has_out_port(const struct ofoperation *, ofp_port_t out_port)
487 OVS_REQUIRES(ofproto_mutex);
489 /* A group within a "struct ofproto".
491 * With few exceptions, ofproto implementations may look at these fields but
492 * should not modify them. */
494 /* The rwlock is used to prevent groups from being deleted while child
495 * threads are using them to xlate flows. A read lock means the
496 * group is currently being used. A write lock means the group is
497 * in the process of being deleted or updated. Note that since
498 * a read lock on the groups container is held while searching, and
499 * a group is ever write locked only while holding a write lock
500 * on the container, the user's of groups will never face a group
501 * in the write locked state. */
502 struct ovs_rwlock rwlock OVS_ACQ_AFTER(ofproto_mutex);
503 struct hmap_node hmap_node; /* In struct ofproto's "groups" hmap. */
504 struct ofproto *ofproto; /* The ofproto that contains this group. */
506 enum ofp11_group_type type; /* One of OFPGT_*. */
508 long long int created; /* Creation time. */
509 long long int modified; /* Time of last modification. */
511 struct list buckets; /* Contains "struct ofputil_bucket"s. */
515 bool ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
516 struct ofgroup **group)
517 OVS_TRY_RDLOCK(true, (*group)->rwlock);
519 void ofproto_group_release(struct ofgroup *group)
520 OVS_RELEASES(group->rwlock);
522 /* ofproto class structure, to be defined by each ofproto implementation.
528 * These functions work primarily with four different kinds of data
531 * - "struct ofproto", which represents an OpenFlow switch.
533 * - "struct ofport", which represents a port within an ofproto.
535 * - "struct rule", which represents an OpenFlow flow within an ofproto.
537 * - "struct ofgroup", which represents an OpenFlow 1.1+ group within an
540 * Each of these data structures contains all of the implementation-independent
541 * generic state for the respective concept, called the "base" state. None of
542 * them contains any extra space for ofproto implementations to use. Instead,
543 * each implementation is expected to declare its own data structure that
544 * contains an instance of the generic data structure plus additional
545 * implementation-specific members, called the "derived" state. The
546 * implementation can use casts or (preferably) the CONTAINER_OF macro to
547 * obtain access to derived state given only a pointer to the embedded generic
554 * Four stylized functions accompany each of these data structures:
556 * "alloc" "construct" "destruct" "dealloc"
557 * ------------ ---------------- --------------- --------------
558 * ofproto ->alloc ->construct ->destruct ->dealloc
559 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
560 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
561 * group ->group_alloc ->group_construct ->group_destruct ->group_dealloc
563 * "ofproto", "ofport", and "group" have this exact life cycle. The "rule"
564 * data structure also follow this life cycle with some additional elaborations
565 * described under "Rule Life Cycle" below.
567 * Any instance of a given data structure goes through the following life
570 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
571 * fails, skip all the other steps.
573 * 2. The client initializes all of the data structure's base state. If this
574 * fails, skip to step 7.
576 * 3. The client calls the "construct" function. The implementation
577 * initializes derived state. It may refer to the already-initialized
578 * base state. If "construct" fails, skip to step 6.
580 * 4. The data structure is now initialized and in use.
582 * 5. When the data structure is no longer needed, the client calls the
583 * "destruct" function. The implementation uninitializes derived state.
584 * The base state has not been uninitialized yet, so the implementation
585 * may still refer to it.
587 * 6. The client uninitializes all of the data structure's base state.
589 * 7. The client calls the "dealloc" to free the raw memory. The
590 * implementation must not refer to base or derived state in the data
591 * structure, because it has already been uninitialized.
593 * Each "alloc" function allocates and returns a new instance of the respective
594 * data structure. The "alloc" function is not given any information about the
595 * use of the new data structure, so it cannot perform much initialization.
596 * Its purpose is just to ensure that the new data structure has enough room
597 * for base and derived state. It may return a null pointer if memory is not
598 * available, in which case none of the other functions is called.
600 * Each "construct" function initializes derived state in its respective data
601 * structure. When "construct" is called, all of the base state has already
602 * been initialized, so the "construct" function may refer to it. The
603 * "construct" function is allowed to fail, in which case the client calls the
604 * "dealloc" function (but not the "destruct" function).
606 * Each "destruct" function uninitializes and frees derived state in its
607 * respective data structure. When "destruct" is called, the base state has
608 * not yet been uninitialized, so the "destruct" function may refer to it. The
609 * "destruct" function is not allowed to fail.
611 * Each "dealloc" function frees raw memory that was allocated by the the
612 * "alloc" function. The memory's base and derived members might not have ever
613 * been initialized (but if "construct" returned successfully, then it has been
614 * "destruct"ed already). The "dealloc" function is not allowed to fail.
620 * Most of these functions return 0 if they are successful or a positive error
621 * code on failure. Depending on the function, valid error codes are either
622 * errno values or OFPERR_* OpenFlow error codes.
624 * Most of these functions are expected to execute synchronously, that is, to
625 * block as necessary to obtain a result. Thus, these functions may return
626 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
627 * explicitly say those errors are a possibility. We may relax this
628 * requirement in the future if and when we encounter performance problems. */
629 struct ofproto_class {
630 /* ## ----------------- ## */
631 /* ## Factory Functions ## */
632 /* ## ----------------- ## */
634 /* Initializes provider. The caller may pass in 'iface_hints',
635 * which contains an shash of "struct iface_hint" elements indexed
636 * by the interface's name. The provider may use these hints to
637 * describe the startup configuration in order to reinitialize its
638 * state. The caller owns the provided data, so a provider must
639 * make copies of anything required. An ofproto provider must
640 * remove any existing state that is not described by the hint, and
641 * may choose to remove it all. */
642 void (*init)(const struct shash *iface_hints);
644 /* Enumerates the types of all support ofproto types into 'types'. The
645 * caller has already initialized 'types' and other ofproto classes might
646 * already have added names to it. */
647 void (*enumerate_types)(struct sset *types);
649 /* Enumerates the names of all existing datapath of the specified 'type'
650 * into 'names' 'all_dps'. The caller has already initialized 'names' as
653 * 'type' is one of the types enumerated by ->enumerate_types().
655 * Returns 0 if successful, otherwise a positive errno value.
657 int (*enumerate_names)(const char *type, struct sset *names);
659 /* Deletes the datapath with the specified 'type' and 'name'. The caller
660 * should have closed any open ofproto with this 'type' and 'name'; this
661 * function is allowed to fail if that is not the case.
663 * 'type' is one of the types enumerated by ->enumerate_types().
664 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
666 * Returns 0 if successful, otherwise a positive errno value.
668 int (*del)(const char *type, const char *name);
670 /* Returns the type to pass to netdev_open() when a datapath of type
671 * 'datapath_type' has a port of type 'port_type', for a few special
672 * cases when a netdev type differs from a port type. For example,
673 * when using the userspace datapath, a port of type "internal"
674 * needs to be opened as "tap".
676 * Returns either 'type' itself or a string literal, which must not
678 const char *(*port_open_type)(const char *datapath_type,
679 const char *port_type);
681 /* ## ------------------------ ## */
682 /* ## Top-Level type Functions ## */
683 /* ## ------------------------ ## */
685 /* Performs any periodic activity required on ofprotos of type
688 * An ofproto provider may implement it or not, depending on whether
689 * it needs type-level maintenance.
691 * Returns 0 if successful, otherwise a positive errno value. */
692 int (*type_run)(const char *type);
694 /* Causes the poll loop to wake up when a type 'type''s 'run'
695 * function needs to be called, e.g. by calling the timer or fd
696 * waiting functions in poll-loop.h.
698 * An ofproto provider may implement it or not, depending on whether
699 * it needs type-level maintenance. */
700 void (*type_wait)(const char *type);
702 /* ## --------------------------- ## */
703 /* ## Top-Level ofproto Functions ## */
704 /* ## --------------------------- ## */
706 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
712 * ->construct() should not modify any base members of the ofproto. The
713 * client will initialize the ofproto's 'ports' and 'tables' members after
714 * construction is complete.
716 * When ->construct() is called, the client does not yet know how many flow
717 * tables the datapath supports, so ofproto->n_tables will be 0 and
718 * ofproto->tables will be NULL. ->construct() should call
719 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
720 * ofproto->tables. Each flow table will be initially empty, so
721 * ->construct() should delete flows from the underlying datapath, if
722 * necessary, rather than populating the tables.
724 * If the ofproto knows the maximum port number that the datapath can have,
725 * then it can call ofproto_init_max_ports(). If it does so, then the
726 * client will ensure that the actions it allows to be used through
727 * OpenFlow do not refer to ports above that maximum number.
729 * Only one ofproto instance needs to be supported for any given datapath.
730 * If a datapath is already open as part of one "ofproto", then another
731 * attempt to "construct" the same datapath as part of another ofproto is
732 * allowed to fail with an error.
734 * ->construct() returns 0 if successful, otherwise a positive errno
741 * If 'ofproto' has any pending asynchronous operations, ->destruct()
742 * must complete all of them by calling ofoperation_complete().
744 * ->destruct() must also destroy all remaining rules in the ofproto's
745 * tables, by passing each remaining rule to ofproto_rule_delete(), and
746 * then complete each of those deletions in turn by calling
747 * ofoperation_complete().
749 * (Thus, there is a multi-step process for any rule currently being
750 * inserted or modified at the beginning of destruction: first
751 * ofoperation_complete() that operation, then ofproto_rule_delete() the
752 * rule, then ofoperation_complete() the deletion operation.)
754 * The client will destroy the flow tables themselves after ->destruct()
757 struct ofproto *(*alloc)(void);
758 int (*construct)(struct ofproto *ofproto);
759 void (*destruct)(struct ofproto *ofproto);
760 void (*dealloc)(struct ofproto *ofproto);
762 /* Performs any periodic activity required by 'ofproto'. It should:
764 * - Call connmgr_send_packet_in() for each received packet that missed
765 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
768 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
769 * its hard_timeout or idle_timeout, to expire the flow.
771 * (But rules that are part of a pending operation, e.g. rules for
772 * which ->pending is true, may not expire.)
774 * Returns 0 if successful, otherwise a positive errno value. */
775 int (*run)(struct ofproto *ofproto);
777 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
778 * be called, e.g. by calling the timer or fd waiting functions in
780 void (*wait)(struct ofproto *ofproto);
782 /* Adds some memory usage statistics for the implementation of 'ofproto'
783 * into 'usage', for use with memory_report().
785 * This function is optional. */
786 void (*get_memory_usage)(const struct ofproto *ofproto,
787 struct simap *usage);
789 /* Adds some memory usage statistics for the implementation of 'type'
790 * into 'usage', for use with memory_report().
792 * This function is optional. */
793 void (*type_get_memory_usage)(const char *type, struct simap *usage);
795 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
796 * This function may prepare for that, for example by clearing state in
797 * advance. It should *not* actually delete any "struct rule"s from
798 * 'ofproto', only prepare for it.
800 * This function is optional; it's really just for optimization in case
801 * it's cheaper to delete all the flows from your hardware in a single pass
802 * than to do it one by one. */
803 void (*flush)(struct ofproto *ofproto);
805 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
807 * The implementation should store true in '*arp_match_ip' if the switch
808 * supports matching IP addresses inside ARP requests and replies, false
811 * The implementation should store in '*actions' a bitmap of the supported
812 * OpenFlow actions. Vendor actions are not included in '*actions'. */
813 void (*get_features)(struct ofproto *ofproto,
815 enum ofputil_action_bitmap *actions);
817 /* Helper for the OpenFlow OFPST_TABLE statistics request.
819 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
822 * - 'table_id' to the array index.
824 * - 'name' to "table#" where # is the table ID.
826 * - 'match' and 'wildcards' to OFPXMT12_MASK.
828 * - 'write_actions' and 'apply_actions' to OFPAT12_OUTPUT.
830 * - 'write_setfields' and 'apply_setfields' to OFPXMT12_MASK.
832 * - 'metadata_match' and 'metadata_write' to UINT64_MAX.
834 * - 'instructions' to OFPIT11_ALL.
836 * - 'config' to OFPTC11_TABLE_MISS_MASK.
838 * - 'max_entries' to 1,000,000.
840 * - 'active_count' to the classifier_count() for the table.
842 * - 'lookup_count' and 'matched_count' to 0.
844 * The implementation should update any members in each element for which
845 * it has better values:
847 * - 'name' to a more meaningful name.
849 * - 'wildcards' to the set of wildcards actually supported by the table
850 * (if it doesn't support all OpenFlow wildcards).
852 * - 'instructions' to set the instructions actually supported by
855 * - 'write_actions' to set the write actions actually supported by
856 * the table (if it doesn't support all OpenFlow actions).
858 * - 'apply_actions' to set the apply actions actually supported by
859 * the table (if it doesn't support all OpenFlow actions).
861 * - 'write_setfields' to set the write setfields actually supported by
864 * - 'apply_setfields' to set the apply setfields actually supported by
867 * - 'max_entries' to the maximum number of flows actually supported by
870 * - 'lookup_count' to the number of packets looked up in this flow table
873 * - 'matched_count' to the number of packets looked up in this flow
874 * table so far that matched one of the flow entries.
876 * All of the members of struct ofp12_table_stats are in network byte
879 void (*get_tables)(struct ofproto *ofproto, struct ofp12_table_stats *ots);
881 /* ## ---------------- ## */
882 /* ## ofport Functions ## */
883 /* ## ---------------- ## */
885 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
887 * ->port_construct() should not modify any base members of the ofport.
888 * An ofproto implementation should use the 'ofp_port' member of
889 * "struct ofport" as the OpenFlow port number.
891 * ofports are managed by the base ofproto code. The ofproto
892 * implementation should only create and destroy them in response to calls
893 * to these functions. The base ofproto code will create and destroy
894 * ofports in the following situations:
896 * - Just after the ->construct() function is called, the base ofproto
897 * iterates over all of the implementation's ports, using
898 * ->port_dump_start() and related functions, and constructs an ofport
899 * for each dumped port.
901 * - If ->port_poll() reports that a specific port has changed, then the
902 * base ofproto will query that port with ->port_query_by_name() and
903 * construct or destruct ofports as necessary to reflect the updated
906 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
907 * change, then the base ofproto will iterate over all of the
908 * implementation's ports, in the same way as at ofproto
909 * initialization, and construct and destruct ofports to reflect all of
912 * ->port_construct() returns 0 if successful, otherwise a positive errno
915 struct ofport *(*port_alloc)(void);
916 int (*port_construct)(struct ofport *ofport);
917 void (*port_destruct)(struct ofport *ofport);
918 void (*port_dealloc)(struct ofport *ofport);
920 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
921 * the ofproto implementation uses the ofport's netdev internally, then it
922 * should switch to using the new one. The old one has been closed.
924 * An ofproto implementation that doesn't need to do anything in this
925 * function may use a null pointer. */
926 void (*port_modified)(struct ofport *ofport);
928 /* Called after an OpenFlow request changes a port's configuration.
929 * 'ofport->pp.config' contains the new configuration. 'old_config'
930 * contains the previous configuration.
932 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
933 * turn NETDEV_UP on and off, so this function doesn't have to do anything
934 * for that bit (and it won't be called if that is the only bit that
936 void (*port_reconfigured)(struct ofport *ofport,
937 enum ofputil_port_config old_config);
939 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
940 * '*port' appropriately.
942 * The caller owns the data in 'port' and must free it with
943 * ofproto_port_destroy() when it is no longer needed. */
944 int (*port_query_by_name)(const struct ofproto *ofproto,
945 const char *devname, struct ofproto_port *port);
947 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
948 * successful, otherwise a positive errno value. The caller should
949 * inform the implementation of the OpenFlow port through the
950 * ->port_construct() method.
952 * It doesn't matter whether the new port will be returned by a later call
953 * to ->port_poll(); the implementation may do whatever is more
955 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
957 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
958 * 0 if successful, otherwise a positive errno value.
960 * It doesn't matter whether the new port will be returned by a later call
961 * to ->port_poll(); the implementation may do whatever is more
963 int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
966 int (*port_get_stats)(const struct ofport *port,
967 struct netdev_stats *stats);
969 /* Port iteration functions.
971 * The client might not be entirely in control of the ports within an
972 * ofproto. Some hardware implementations, for example, might have a fixed
973 * set of ports in a datapath. For this reason, the client needs a way to
974 * iterate through all the ports that are actually in a datapath. These
975 * functions provide that functionality.
977 * The 'state' pointer provides the implementation a place to
978 * keep track of its position. Its format is opaque to the caller.
980 * The ofproto provider retains ownership of the data that it stores into
981 * ->port_dump_next()'s 'port' argument. The data must remain valid until
982 * at least the next call to ->port_dump_next() or ->port_dump_done() for
983 * 'state'. The caller will not modify or free it.
988 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
989 * On success, it should return 0 and initialize '*statep' with any data
990 * needed for iteration. On failure, returns a positive errno value, and
991 * the client will not call ->port_dump_next() or ->port_dump_done().
993 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
994 * 'state'. If there is another port, it should store the port's
995 * information into 'port' and return 0. It should return EOF if all ports
996 * have already been iterated. Otherwise, on error, it should return a
997 * positive errno value. This function will not be called again once it
998 * returns nonzero once for a given iteration (but the 'port_dump_done'
999 * function will be called afterward).
1001 * ->port_dump_done() allows the implementation to release resources used
1002 * for iteration. The caller might decide to stop iteration in the middle
1003 * by calling this function before ->port_dump_next() returns nonzero.
1011 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
1014 * struct ofproto_port port;
1016 * error = ofproto->ofproto_class->port_dump_next(
1017 * ofproto, state, &port);
1021 * // Do something with 'port' here (without modifying or freeing
1022 * // any of its data).
1024 * ofproto->ofproto_class->port_dump_done(ofproto, state);
1026 * // 'error' is now EOF (success) or a positive errno value (failure).
1028 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
1029 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
1030 struct ofproto_port *port);
1031 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
1033 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
1034 * in 'ofproto' has changed, then this function should do one of the
1037 * - Preferably: store the name of the device that was added to or deleted
1038 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
1039 * for freeing '*devnamep' (with free()) when it no longer needs it.
1041 * - Alternatively: return ENOBUFS, without indicating the device that was
1044 * Occasional 'false positives', in which the function returns 0 while
1045 * indicating a device that was not actually added or deleted or returns
1046 * ENOBUFS without any change, are acceptable.
1048 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
1049 * externally to the 'ofproto' object, e.g. by a system administrator via
1050 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
1051 * not report changes made through calls to 'port_add' or 'port_del' on the
1052 * same 'ofproto' object. (But it's OK for it to report them too, just
1053 * slightly less efficient.)
1055 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
1056 * also return other positive errno values to indicate that something has
1059 * If the set of ports in a datapath is fixed, or if the only way that the
1060 * set of ports in a datapath can change is through ->port_add() and
1061 * ->port_del(), then this function may be a null pointer.
1063 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
1065 /* Arranges for the poll loop to wake up when ->port_poll() will return a
1066 * value other than EAGAIN.
1068 * If the set of ports in a datapath is fixed, or if the only way that the
1069 * set of ports in a datapath can change is through ->port_add() and
1070 * ->port_del(), or if the poll loop will always wake up anyway when
1071 * ->port_poll() will return a value other than EAGAIN, then this function
1072 * may be a null pointer.
1074 void (*port_poll_wait)(const struct ofproto *ofproto);
1076 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
1077 * partner information for 'port' is up-to-date, 0 if LACP partner
1078 * information is not current (generally indicating a connectivity
1079 * problem), or -1 if LACP is not enabled on 'port'.
1081 * This function may be a null pointer if the ofproto implementation does
1082 * not support LACP. */
1083 int (*port_is_lacp_current)(const struct ofport *port);
1085 /* ## ----------------------- ## */
1086 /* ## OpenFlow Rule Functions ## */
1087 /* ## ----------------------- ## */
1089 /* Chooses an appropriate table for 'match' within 'ofproto'. On
1090 * success, stores the table ID into '*table_idp' and returns 0. On
1091 * failure, returns an OpenFlow error code.
1093 * The choice of table should be a function of 'match' and 'ofproto''s
1094 * datapath capabilities. It should not depend on the flows already in
1095 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
1096 * 'match' as its matching condition can never be inserted into 'ofproto',
1097 * even starting from an empty flow table.
1099 * If multiple tables are candidates for inserting the flow, the function
1100 * should choose one arbitrarily (but deterministically).
1102 * If this function is NULL then table 0 is always chosen. */
1103 enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
1104 const struct match *match,
1105 uint8_t *table_idp);
1107 /* Life-cycle functions for a "struct rule".
1113 * The life cycle of a struct rule is an elaboration of the basic life
1114 * cycle described above under "Life Cycle".
1116 * After a rule is successfully constructed, it is then inserted. If
1117 * insertion completes successfully, then before it is later destructed, it
1120 * You can think of a rule as having the following extra steps inserted
1121 * between "Life Cycle" steps 4 and 5:
1123 * 4.1. The client inserts the rule into the flow table, making it
1124 * visible in flow table lookups.
1126 * 4.2. The client calls "rule_insert". Immediately or eventually, the
1127 * implementation calls ofoperation_complete() to indicate that the
1128 * insertion completed. If the operation failed, skip to step 5.
1130 * 4.3. The rule is now installed in the flow table. Eventually it will
1133 * 4.4. The client removes the rule from the flow table. It is no longer
1134 * visible in flow table lookups.
1136 * 4.5. The client calls "rule_delete". Immediately or eventually, the
1137 * implementation calls ofoperation_complete() to indicate that the
1138 * deletion completed. Deletion is not allowed to fail, so it must
1142 * Asynchronous Operation Support
1143 * ==============================
1145 * The "insert" and "delete" life-cycle operations on rules can operate
1146 * asynchronously, meaning that ->rule_insert() and ->rule_delete() only
1147 * need to initiate their respective operations and do not need to wait for
1148 * them to complete before they return. ->rule_modify_actions() also
1149 * operates asynchronously.
1151 * An ofproto implementation reports the success or failure of an
1152 * asynchronous operation on a rule using the rule's 'pending' member,
1153 * which points to a opaque "struct ofoperation" that represents the
1154 * ongoing operation. When the operation completes, the ofproto
1155 * implementation calls ofoperation_complete(), passing the ofoperation and
1156 * an error indication.
1158 * Only the following contexts may call ofoperation_complete():
1160 * - The function called to initiate the operation, e.g. ->rule_insert()
1161 * or ->rule_delete(). This is the best choice if the operation
1162 * completes quickly.
1164 * - The implementation's ->run() function.
1166 * - The implementation's ->destruct() function.
1168 * The ofproto base code updates the flow table optimistically, assuming
1169 * that the operation will probably succeed:
1171 * - ofproto adds the rule in the flow table before calling
1174 * - ofproto updates the rule's actions and other properties before
1175 * calling ->rule_modify_actions().
1177 * - ofproto removes the rule before calling ->rule_delete().
1179 * With one exception, when an asynchronous operation completes with an
1180 * error, ofoperation_complete() backs out the already applied changes:
1182 * - If adding a rule in the flow table fails, ofproto removes the new
1185 * - If modifying a rule fails, ofproto restores the original actions
1186 * (and other properties).
1188 * - Removing a rule is not allowed to fail. It must always succeed.
1190 * The ofproto base code serializes operations: if any operation is in
1191 * progress on a given rule, ofproto postpones initiating any new operation
1192 * on that rule until the pending operation completes. Therefore, every
1193 * operation must eventually complete through a call to
1194 * ofoperation_complete() to avoid delaying new operations indefinitely
1195 * (including any OpenFlow request that affects the rule in question, even
1196 * just to query its statistics).
1202 * When ->rule_construct() is called, 'rule' is a new rule that is not yet
1203 * inserted into a flow table. ->rule_construct() should initialize enough
1204 * of the rule's derived state for 'rule' to be suitable for inserting into
1205 * a flow table. ->rule_construct() should not modify any base members of
1208 * If ->rule_construct() fails (as indicated by returning a nonzero
1209 * OpenFlow error code), the ofproto base code will uninitialize and
1210 * deallocate 'rule'. See "Rule Life Cycle" above for more details.
1212 * ->rule_construct() may also:
1214 * - Validate that the datapath supports the matching rule in 'rule->cr'
1215 * datapath. For example, if the rule's table does not support
1216 * registers, then it is an error if 'rule->cr' does not wildcard all
1219 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
1221 * Some implementations might need to defer these tasks to ->rule_insert(),
1222 * which is also acceptable.
1228 * Following successful construction, the ofproto base case inserts 'rule'
1229 * into its flow table, then it calls ->rule_insert(). ->rule_insert()
1230 * should set in motion adding the new rule to the datapath flow table. It
1231 * must act as follows:
1233 * - If it completes insertion, either by succeeding or failing, it must
1234 * call ofoperation_complete()
1236 * - If insertion is only partially complete, then it must return without
1237 * calling ofoperation_complete(). Later, when the insertion is
1238 * complete, the ->run() or ->destruct() function must call
1239 * ofoperation_complete() to report success or failure.
1241 * If ->rule_insert() fails, the ofproto base code will remove 'rule' from
1242 * the flow table, destruct, uninitialize, and deallocate 'rule'. See
1243 * "Rule Life Cycle" above for more details.
1249 * The ofproto base code removes 'rule' from its flow table before it calls
1250 * ->rule_delete(). ->rule_delete() should set in motion removing 'rule'
1251 * from the datapath flow table. It must act as follows:
1253 * - If it completes deletion, it must call ofoperation_complete().
1255 * - If deletion is only partially complete, then it must return without
1256 * calling ofoperation_complete(). Later, when the deletion is
1257 * complete, the ->run() or ->destruct() function must call
1258 * ofoperation_complete().
1260 * Rule deletion must not fail.
1266 * ->rule_destruct() must uninitialize derived state.
1268 * Rule destruction must not fail. */
1269 struct rule *(*rule_alloc)(void);
1270 enum ofperr (*rule_construct)(struct rule *rule)
1271 /* OVS_REQUIRES(ofproto_mutex) */;
1272 void (*rule_insert)(struct rule *rule) /* OVS_REQUIRES(ofproto_mutex) */;
1273 void (*rule_delete)(struct rule *rule) /* OVS_REQUIRES(ofproto_mutex) */;
1274 void (*rule_destruct)(struct rule *rule);
1275 void (*rule_dealloc)(struct rule *rule);
1277 /* Obtains statistics for 'rule', storing the number of packets that have
1278 * matched it in '*packet_count' and the number of bytes in those packets
1279 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
1280 * count is unknown. */
1281 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
1282 uint64_t *byte_count)
1283 /* OVS_EXCLUDED(ofproto_mutex) */;
1285 /* Applies the actions in 'rule' to 'packet'. (This implements sending
1286 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1288 * Takes ownership of 'packet' (so it should eventually free it, with
1291 * 'flow' reflects the flow information for 'packet'. All of the
1292 * information in 'flow' is extracted from 'packet', except for
1293 * flow->tunnel and flow->in_port, which are assigned the correct values
1294 * for the incoming packet. The register values are zeroed. 'packet''s
1295 * header pointers (e.g. packet->l3) are appropriately initialized.
1296 * packet->l3 is aligned on a 32-bit boundary.
1298 * The implementation should add the statistics for 'packet' into 'rule'.
1300 * Returns 0 if successful, otherwise an OpenFlow error code. */
1301 enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1302 struct ofpbuf *packet);
1304 /* When ->rule_modify_actions() is called, the caller has already replaced
1305 * the OpenFlow actions in 'rule' by a new set. (The original actions are
1306 * in rule->pending->actions.)
1308 * ->rule_modify_actions() should set the following in motion:
1310 * - Validate that the datapath can correctly implement the actions now
1313 * - Update the datapath flow table with the new actions.
1315 * - Only if 'reset_counters' is true, reset any packet or byte counters
1316 * associated with the rule to zero, so that rule_get_stats() will not
1317 * longer count those packets or bytes.
1319 * If the operation synchronously completes, ->rule_modify_actions() may
1320 * call ofoperation_complete() before it returns. Otherwise, ->run()
1321 * should call ofoperation_complete() later, after the operation does
1324 * If the operation fails, then the base ofproto code will restore the
1325 * original 'actions' and 'n_actions' of 'rule'.
1327 * ->rule_modify_actions() should not modify any base members of struct
1329 void (*rule_modify_actions)(struct rule *rule, bool reset_counters)
1330 /* OVS_REQUIRES(ofproto_mutex) */;
1332 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1333 * which takes one of the following values, with the corresponding
1336 * - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1337 * as other packets, omitting TCP and UDP port numbers (always setting
1340 * - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1341 * passing them through the flow table.
1343 * - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1344 * passing packets through the flow table.
1346 * - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1347 * except that TCP and UDP port numbers should be included in fragments
1350 * Implementations are not required to support every mode.
1351 * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1353 * At the time of the call to ->set_frag_handling(), the current mode is
1354 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1355 * true if the requested mode was set, false if it is not supported.
1357 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1358 * reflect the new mode.
1360 bool (*set_frag_handling)(struct ofproto *ofproto,
1361 enum ofp_config_flags frag_handling);
1363 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1364 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1366 * The caller retains ownership of 'packet' and of 'ofpacts', so
1367 * ->packet_out() should not modify or free them.
1369 * This function must validate that it can correctly implement 'ofpacts'.
1370 * If not, then it should return an OpenFlow error code.
1372 * 'flow' reflects the flow information for 'packet'. All of the
1373 * information in 'flow' is extracted from 'packet', except for
1374 * flow->in_port (see below). flow->tunnel and its register values are
1377 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1378 * implementation should reject invalid flow->in_port values by returning
1379 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1380 * ofproto_init_max_ports(), then the client will reject these ports
1381 * itself.) For consistency, the implementation should consider valid for
1382 * flow->in_port any value that could possibly be seen in a packet that it
1383 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1384 * that never generates packet-ins (e.g. due to hardware limitations)
1385 * should still allow flow->in_port values for every possible physical port
1386 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1387 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1388 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1389 * these, treating each of them as packets generated by the controller as
1390 * opposed to packets originating from some switch port.
1392 * (Ordinarily the only effect of flow->in_port is on output actions that
1393 * involve the input port, such as actions that output to OFPP_IN_PORT,
1394 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1395 * "resubmit" actions.)
1397 * 'packet' is not matched against the OpenFlow flow table, so its
1398 * statistics should not be included in OpenFlow flow statistics.
1400 * Returns 0 if successful, otherwise an OpenFlow error code. */
1401 enum ofperr (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
1402 const struct flow *flow,
1403 const struct ofpact *ofpacts,
1404 size_t ofpacts_len);
1406 /* ## ------------------------- ## */
1407 /* ## OFPP_NORMAL configuration ## */
1408 /* ## ------------------------- ## */
1410 /* Configures NetFlow on 'ofproto' according to the options in
1411 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1413 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1414 * NetFlow, as does a null pointer. */
1415 int (*set_netflow)(struct ofproto *ofproto,
1416 const struct netflow_options *netflow_options);
1418 void (*get_netflow_ids)(const struct ofproto *ofproto,
1419 uint8_t *engine_type, uint8_t *engine_id);
1421 /* Configures sFlow on 'ofproto' according to the options in
1422 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1424 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1425 * sFlow, as does a null pointer. */
1426 int (*set_sflow)(struct ofproto *ofproto,
1427 const struct ofproto_sflow_options *sflow_options);
1429 /* Configures IPFIX on 'ofproto' according to the options in
1430 * 'bridge_exporter_options' and the 'flow_exporters_options'
1431 * array, or turns off IPFIX if 'bridge_exporter_options' and
1432 * 'flow_exporters_options' is NULL.
1434 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1435 * IPFIX, as does a null pointer. */
1437 struct ofproto *ofproto,
1438 const struct ofproto_ipfix_bridge_exporter_options
1439 *bridge_exporter_options,
1440 const struct ofproto_ipfix_flow_exporter_options
1441 *flow_exporters_options, size_t n_flow_exporters_options);
1443 /* Configures connectivity fault management on 'ofport'.
1445 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1447 * If 'cfm_settings' is null, removes any connectivity fault management
1448 * configuration from 'ofport'.
1450 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1451 * support CFM, as does a null pointer. */
1452 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1454 /* Checks the status of CFM configured on 'ofport'. Returns true if the
1455 * port's CFM status was successfully stored into '*status'. Returns false
1456 * if the port did not have CFM configured, in which case '*status' is
1459 * The caller must provide and owns '*status', but it does not own and must
1460 * not modify or free the array returned in 'status->rmps'. */
1461 bool (*get_cfm_status)(const struct ofport *ofport,
1462 struct ofproto_cfm_status *status);
1464 /* Configures BFD on 'ofport'.
1466 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1467 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1468 * according to 'cfg'.
1470 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1471 * support BFD, as does a null pointer. */
1472 int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1474 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1475 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1476 * that this ofproto_class does not support BFD, as does a null pointer. */
1477 int (*get_bfd_status)(struct ofport *ofport, struct smap *smap);
1479 /* Configures spanning tree protocol (STP) on 'ofproto' using the
1480 * settings defined in 's'.
1482 * If 's' is nonnull, configures STP according to its members.
1484 * If 's' is null, removes any STP configuration from 'ofproto'.
1486 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1487 * support STP, as does a null pointer. */
1488 int (*set_stp)(struct ofproto *ofproto,
1489 const struct ofproto_stp_settings *s);
1491 /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1493 * Stores STP state for 'ofproto' in 's'. If the 'enabled' member
1494 * is false, the other member values are not meaningful.
1496 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1497 * support STP, as does a null pointer. */
1498 int (*get_stp_status)(struct ofproto *ofproto,
1499 struct ofproto_stp_status *s);
1501 /* Configures spanning tree protocol (STP) on 'ofport' using the
1502 * settings defined in 's'.
1504 * If 's' is nonnull, configures STP according to its members. The
1505 * caller is responsible for assigning STP port numbers (using the
1506 * 'port_num' member in the range of 1 through 255, inclusive) and
1507 * ensuring there are no duplicates.
1509 * If 's' is null, removes any STP configuration from 'ofport'.
1511 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1512 * support STP, as does a null pointer. */
1513 int (*set_stp_port)(struct ofport *ofport,
1514 const struct ofproto_port_stp_settings *s);
1516 /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1518 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1519 * false, the other member values are not meaningful.
1521 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1522 * support STP, as does a null pointer. */
1523 int (*get_stp_port_status)(struct ofport *ofport,
1524 struct ofproto_port_stp_status *s);
1526 /* Retrieves spanning tree protocol (STP) port statistics of 'ofport'.
1528 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1529 * false, the other member values are not meaningful.
1531 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1532 * support STP, as does a null pointer. */
1533 int (*get_stp_port_stats)(struct ofport *ofport,
1534 struct ofproto_port_stp_stats *s);
1536 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1537 * 'queues' attached to 'ofport'. This data is not intended to be
1538 * sufficient to implement QoS. Instead, providers may use this
1539 * information to implement features which require knowledge of what queues
1540 * exist on a port, and some basic information about them.
1542 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1543 * support QoS, as does a null pointer. */
1544 int (*set_queues)(struct ofport *ofport,
1545 const struct ofproto_port_queue *queues, size_t n_qdscp);
1547 /* If 's' is nonnull, this function registers a "bundle" associated with
1548 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
1549 * a Port in OVSDB, that is, it consists of one or more "slave" devices
1550 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1551 * there is more than one slave, a bonding configuration. If 'aux' is
1552 * already registered then this function updates its configuration to 's'.
1553 * Otherwise, this function registers a new bundle.
1555 * If 's' is NULL, this function unregisters the bundle registered on
1556 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
1557 * has been registered, this has no effect.
1559 * This function affects only the behavior of the NXAST_AUTOPATH action and
1560 * output to the OFPP_NORMAL port. An implementation that does not support
1561 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
1562 * that supports only a subset of the functionality should implement what
1563 * it can and return 0. */
1564 int (*bundle_set)(struct ofproto *ofproto, void *aux,
1565 const struct ofproto_bundle_settings *s);
1567 /* If 'port' is part of any bundle, removes it from that bundle. If the
1568 * bundle now has no ports, deletes the bundle. If the bundle now has only
1569 * one port, deconfigures the bundle's bonding configuration. */
1570 void (*bundle_remove)(struct ofport *ofport);
1572 /* If 's' is nonnull, this function registers a mirror associated with
1573 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
1574 * a Mirror in OVSDB. If 'aux' is already registered then this function
1575 * updates its configuration to 's'. Otherwise, this function registers a
1578 * If 's' is NULL, this function unregisters the mirror registered on
1579 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
1580 * has been registered, this has no effect.
1582 * An implementation that does not support mirroring at all may set
1583 * it to NULL or return EOPNOTSUPP. An implementation that supports
1584 * only a subset of the functionality should implement what it can
1586 int (*mirror_set)(struct ofproto *ofproto, void *aux,
1587 const struct ofproto_mirror_settings *s);
1589 /* Retrieves statistics from mirror associated with client data
1590 * pointer 'aux' in 'ofproto'. Stores packet and byte counts in
1591 * 'packets' and 'bytes', respectively. If a particular counter is
1592 * not supported, the appropriate argument is set to UINT64_MAX.
1594 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1595 * support retrieving mirror statistics. */
1596 int (*mirror_get_stats)(struct ofproto *ofproto, void *aux,
1597 uint64_t *packets, uint64_t *bytes);
1599 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1600 * on which all packets are flooded, instead of using MAC learning. If
1601 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1603 * This function affects only the behavior of the OFPP_NORMAL action. An
1604 * implementation that does not support it may set it to NULL or return
1606 int (*set_flood_vlans)(struct ofproto *ofproto,
1607 unsigned long *flood_vlans);
1609 /* Returns true if 'aux' is a registered bundle that is currently in use as
1610 * the output for a mirror. */
1611 bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1613 /* When the configuration option of forward_bpdu changes, this function
1614 * will be invoked. */
1615 void (*forward_bpdu_changed)(struct ofproto *ofproto);
1617 /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1618 * seconds, and the maximum number of MAC table entries to
1621 * An implementation that doesn't support configuring these features may
1622 * set this function to NULL or implement it as a no-op. */
1623 void (*set_mac_table_config)(struct ofproto *ofproto,
1624 unsigned int idle_time, size_t max_entries);
1626 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1628 * This is deprecated. It is only for compatibility with broken device drivers
1629 * in old versions of Linux that do not properly support VLANs when VLAN
1630 * devices are not used. When broken device drivers are no longer in
1631 * widespread use, we will delete these interfaces. */
1633 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1634 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1635 * that has OpenFlow port number 'realdev_ofp_port'.
1637 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1638 * as a VLAN splinter port.
1640 * This function should be NULL if an implementation does not support it.
1642 int (*set_realdev)(struct ofport *ofport,
1643 ofp_port_t realdev_ofp_port, int vid);
1645 /* ## ------------------------ ## */
1646 /* ## OpenFlow meter functions ## */
1647 /* ## ------------------------ ## */
1649 /* These functions should be NULL if an implementation does not support
1650 * them. They must be all null or all non-null.. */
1652 /* Initializes 'features' to describe the metering features supported by
1654 void (*meter_get_features)(const struct ofproto *ofproto,
1655 struct ofputil_meter_features *features);
1657 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1658 * success the function must store a provider meter ID other than
1659 * UINT32_MAX in '*id'. All further references to the meter will be made
1660 * with the returned provider meter id rather than the OpenFlow meter id.
1661 * The caller does not try to interpret the provider meter id, giving the
1662 * implementation the freedom to either use the OpenFlow meter_id value
1663 * provided in the meter configuration, or any other value suitable for the
1666 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1667 * with that meter provider ID to have configuration 'config', while
1668 * leaving '*id' unchanged. On failure, the existing meter configuration
1669 * is left intact. */
1670 enum ofperr (*meter_set)(struct ofproto *ofproto, ofproto_meter_id *id,
1671 const struct ofputil_meter_config *config);
1673 /* Gets the meter and meter band packet and byte counts for maximum of
1674 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1675 * 'ofproto'. The caller fills in the other stats values. The band stats
1676 * are copied to memory at 'stats->bands' provided by the caller. The
1677 * number of returned band stats is returned in 'stats->n_bands'. */
1678 enum ofperr (*meter_get)(const struct ofproto *ofproto,
1679 ofproto_meter_id id,
1680 struct ofputil_meter_stats *stats);
1682 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1684 void (*meter_del)(struct ofproto *, ofproto_meter_id);
1687 /* ## -------------------- ## */
1688 /* ## OpenFlow 1.1+ groups ## */
1689 /* ## -------------------- ## */
1691 struct ofgroup *(*group_alloc)(void);
1692 enum ofperr (*group_construct)(struct ofgroup *);
1693 void (*group_destruct)(struct ofgroup *);
1694 void (*group_dealloc)(struct ofgroup *);
1696 enum ofperr (*group_modify)(struct ofgroup *, struct ofgroup *victim);
1698 enum ofperr (*group_get_stats)(const struct ofgroup *,
1699 struct ofputil_group_stats *);
1702 extern const struct ofproto_class ofproto_dpif_class;
1704 int ofproto_class_register(const struct ofproto_class *);
1705 int ofproto_class_unregister(const struct ofproto_class *);
1707 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
1708 * because it overlaps with an ongoing flow table operation that has not yet
1709 * completed. The caller should retry the operation later.
1711 * ofproto.c also uses this value internally for additional (similar) purposes.
1713 * This particular value is a good choice because it is large, so that it does
1714 * not collide with any errno value, but not large enough to collide with an
1715 * OFPERR_* value. */
1716 enum { OFPROTO_POSTPONE = 1 << 16 };
1717 BUILD_ASSERT_DECL(OFPROTO_POSTPONE < OFPERR_OFS);
1719 int ofproto_flow_mod(struct ofproto *, struct ofputil_flow_mod *)
1720 OVS_EXCLUDED(ofproto_mutex);
1721 void ofproto_add_flow(struct ofproto *, const struct match *,
1722 unsigned int priority,
1723 const struct ofpact *ofpacts, size_t ofpacts_len)
1724 OVS_EXCLUDED(ofproto_mutex);
1725 bool ofproto_delete_flow(struct ofproto *,
1726 const struct match *, unsigned int priority)
1727 OVS_EXCLUDED(ofproto_mutex);
1728 void ofproto_flush_flows(struct ofproto *);
1730 #endif /* ofproto/ofproto-provider.h */
git://git.onelab.eu / sliver-openvswitch.git / blob