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. */
23 #include "classifier.h"
24 #include "guarded-list.h"
28 #include "ofp-errors.h"
30 #include "ofproto/ofproto.h"
31 #include "ovs-atomic.h"
32 #include "ovs-thread.h"
39 struct ofputil_flow_mod;
43 extern struct ovs_mutex ofproto_mutex;
45 /* An OpenFlow switch.
47 * With few exceptions, ofproto implementations may look at these fields but
48 * should not modify them. */
50 struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
51 const struct ofproto_class *ofproto_class;
52 char *type; /* Datapath type. */
53 char *name; /* Datapath name. */
56 uint64_t fallback_dpid; /* Datapath ID if no better choice found. */
57 uint64_t datapath_id; /* Datapath ID. */
58 bool forward_bpdu; /* Option to allow forwarding of BPDU frames
59 * when NORMAL action is invoked. */
60 char *mfr_desc; /* Manufacturer (NULL for default)b. */
61 char *hw_desc; /* Hardware (NULL for default). */
62 char *sw_desc; /* Software version (NULL for default). */
63 char *serial_desc; /* Serial number (NULL for default). */
64 char *dp_desc; /* Datapath description (NULL for default). */
65 enum ofp_config_flags frag_handling; /* One of OFPC_*. */
68 struct hmap ports; /* Contains "struct ofport"s. */
69 struct shash port_by_name;
70 unsigned long *ofp_port_ids;/* Bitmap of used OpenFlow port numbers. */
71 struct simap ofp_requests; /* OpenFlow port number requests. */
72 uint16_t alloc_port_no; /* Last allocated OpenFlow port number. */
73 uint16_t max_ports; /* Max possible OpenFlow port num, plus one. */
76 long long int eviction_group_timer; /* For rate limited reheapification. */
77 struct oftable *tables;
80 /* Rules indexed on their cookie values, in all flow tables. */
81 struct hindex cookies OVS_GUARDED_BY(ofproto_mutex);
83 /* List of expirable flows, in all flow tables. */
84 struct list expirable OVS_GUARDED_BY(ofproto_mutex);
87 * OpenFlow meters start at 1. To avoid confusion we leave the first
88 * pointer in the array un-used, and index directly with the OpenFlow
90 struct ofputil_meter_features meter_features;
91 struct meter **meters; /* 'meter_features.max_meter' + 1 pointers. */
93 /* OpenFlow connections. */
94 struct connmgr *connmgr;
96 /* Flow table operation tracking. */
97 int state; /* Internal state. */
98 struct list pending; /* List of "struct ofopgroup"s. */
99 unsigned int n_pending; /* list_size(&pending). */
100 struct hmap deletions; /* All OFOPERATION_DELETE "ofoperation"s. */
102 /* Delayed rule executions.
104 * We delay calls to ->ofproto_class->rule_execute() past releasing
105 * ofproto_mutex during a flow_mod, because otherwise a "learn" action
106 * triggered by the executing the packet would try to recursively modify
107 * the flow table and reacquire the global lock. */
108 struct guarded_list rule_executes;
110 /* Flow table operation logging. */
111 int n_add, n_delete, n_modify; /* Number of unreported ops of each kind. */
112 long long int first_op, last_op; /* Range of times for unreported ops. */
113 long long int next_op_report; /* Time to report ops, or LLONG_MAX. */
114 long long int op_backoff; /* Earliest time to report ops again. */
116 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
118 * This is deprecated. It is only for compatibility with broken device
119 * drivers in old versions of Linux that do not properly support VLANs when
120 * VLAN devices are not used. When broken device drivers are no longer in
121 * widespread use, we will delete these interfaces. */
122 unsigned long int *vlan_bitmap; /* 4096-bit bitmap of in-use VLANs. */
123 bool vlans_changed; /* True if new VLANs are in use. */
124 int min_mtu; /* Current MTU of non-internal ports. */
127 struct ovs_rwlock groups_rwlock;
128 struct hmap groups OVS_GUARDED; /* Contains "struct ofgroup"s. */
129 uint32_t n_groups[4] OVS_GUARDED; /* # of existing groups of each type. */
130 struct ofputil_group_features ogf;
133 void ofproto_init_tables(struct ofproto *, int n_tables);
134 void ofproto_init_max_ports(struct ofproto *, uint16_t max_ports);
136 struct ofproto *ofproto_lookup(const char *name);
137 struct ofport *ofproto_get_port(const struct ofproto *, ofp_port_t ofp_port);
139 /* An OpenFlow port within a "struct ofproto".
141 * With few exceptions, ofproto implementations may look at these fields but
142 * should not modify them. */
144 struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
145 struct ofproto *ofproto; /* The ofproto that contains this port. */
146 struct netdev *netdev;
147 struct ofputil_phy_port pp;
148 ofp_port_t ofp_port; /* OpenFlow port number. */
149 unsigned int change_seq;
150 long long int created; /* Time created, in msec. */
154 void ofproto_port_set_state(struct ofport *, enum ofputil_port_state);
156 /* OpenFlow table flags:
158 * - "Hidden" tables are not included in OpenFlow operations that operate on
159 * "all tables". For example, a request for flow stats on all tables will
160 * omit flows in hidden tables, table stats requests will omit the table
161 * entirely, and the switch features reply will not count the hidden table.
163 * However, operations that specifically name the particular table still
164 * operate on it. For example, flow_mods and flow stats requests on a
167 * To avoid gaps in table IDs (which have unclear validity in OpenFlow),
168 * hidden tables must be the highest-numbered tables that a provider
171 * - "Read-only" tables can't be changed through OpenFlow operations. (At
172 * the moment all flow table operations go effectively through OpenFlow, so
173 * this means that read-only tables can't be changed at all after the
174 * read-only flag is set.)
176 * The generic ofproto layer never sets these flags. An ofproto provider can
177 * set them if it is appropriate.
180 OFTABLE_HIDDEN = 1 << 0, /* Hide from most OpenFlow operations. */
181 OFTABLE_READONLY = 1 << 1 /* Don't allow OpenFlow to change this table. */
184 /* A flow table within a "struct ofproto". */
186 enum oftable_flags flags;
187 struct classifier cls; /* Contains "struct rule"s. */
188 char *name; /* Table name exposed via OpenFlow, or NULL. */
190 /* Maximum number of flows or UINT_MAX if there is no limit besides any
191 * limit imposed by resource limitations. */
192 unsigned int max_flows;
194 /* These members determine the handling of an attempt to add a flow that
195 * would cause the table to have more than 'max_flows' flows.
197 * If 'eviction_fields' is NULL, overflows will be rejected with an error.
199 * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
200 * is nonzero), an overflow will cause a flow to be removed. The flow to
201 * be removed is chosen to give fairness among groups distinguished by
202 * different values for the subfields within 'groups'. */
203 struct mf_subfield *eviction_fields;
204 size_t n_eviction_fields;
208 * When a flow is added that would cause the table to have more than
209 * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
210 * used to decide which rule to evict: the rule is chosen from the eviction
211 * group that contains the greatest number of rules.*/
212 uint32_t eviction_group_id_basis;
213 struct hmap eviction_groups_by_id;
214 struct heap eviction_groups_by_size;
217 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
219 * All parameters are evaluated multiple times. */
220 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO) \
221 for ((TABLE) = (OFPROTO)->tables; \
222 (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
225 /* An OpenFlow flow within a "struct ofproto".
227 * With few exceptions, ofproto implementations may look at these fields but
228 * should not modify them. */
230 struct ofproto *ofproto; /* The ofproto that contains this rule. */
231 struct cls_rule cr; /* In owning ofproto's classifier. */
232 atomic_uint ref_count;
234 struct ofoperation *pending; /* Operation now in progress, if nonnull. */
236 ovs_be64 flow_cookie; /* Controller-issued identifier. Guarded by
238 struct hindex_node cookie_node OVS_GUARDED_BY(ofproto_mutex);
240 long long int created; /* Creation time. */
241 long long int modified; /* Time of last modification. */
242 long long int used; /* Last use; time created if never used. */
243 uint8_t table_id; /* Index in ofproto's 'tables' array. */
244 enum ofputil_flow_mod_flags flags;
246 uint16_t hard_timeout OVS_GUARDED; /* In seconds from ->modified. */
247 uint16_t idle_timeout OVS_GUARDED; /* In seconds from ->used. */
249 /* Eviction groups. */
250 struct heap_node evg_node; /* In eviction_group's "rules" heap. */
251 struct eviction_group *eviction_group; /* NULL if not in any group. */
253 /* The mutex is used to protect those elements in struct rule which are
254 * accessed by multiple threads. The main ofproto code is guaranteed not
255 * to change any of the elements "Guarded by mutex" without holding the
258 * While maintaining a pointer to struct rule, threads are required to hold
259 * a readlock on the classifier that holds the rule or increment the rule's
262 * A rule will not be evicted unless its classifier's write lock is
264 struct ovs_mutex mutex;
266 /* Guarded by mutex. */
267 struct rule_actions *actions;
269 struct list meter_list_node; /* In owning meter's 'rules' list. */
272 enum nx_flow_monitor_flags monitor_flags;
273 uint64_t add_seqno; /* Sequence number when added. */
274 uint64_t modify_seqno; /* Sequence number when changed. */
276 /* Optimisation for flow expiry. In ofproto's 'expirable' list if this
277 * rule is expirable, otherwise empty. */
278 struct list expirable OVS_GUARDED_BY(ofproto_mutex);
281 void ofproto_rule_ref(struct rule *);
282 void ofproto_rule_unref(struct rule *);
284 /* A set of actions within a "struct rule".
290 * A struct rule_actions 'actions' may be accessed without a risk of being
291 * freed by code that holds a read-lock or write-lock on 'rule->mutex' (where
292 * 'rule' is the rule for which 'rule->actions == actions') or that owns a
293 * reference to 'actions->ref_count' (or both). */
294 struct rule_actions {
295 atomic_uint ref_count;
297 /* These members are immutable: they do not change during the struct's
299 struct ofpact *ofpacts; /* Sequence of "struct ofpacts". */
300 unsigned int ofpacts_len; /* Size of 'ofpacts', in bytes. */
301 uint32_t meter_id; /* Non-zero OF meter_id, or zero. */
304 struct rule_actions *rule_actions_create(const struct ofpact *, size_t);
305 void rule_actions_ref(struct rule_actions *);
306 void rule_actions_unref(struct rule_actions *);
308 /* A set of rules to which an OpenFlow operation applies. */
309 struct rule_collection {
310 struct rule **rules; /* The rules. */
311 size_t n; /* Number of rules collected. */
313 size_t capacity; /* Number of rules that will fit in 'rules'. */
314 struct rule *stub[64]; /* Preallocated rules to avoid malloc(). */
317 void rule_collection_init(struct rule_collection *);
318 void rule_collection_add(struct rule_collection *, struct rule *);
319 void rule_collection_destroy(struct rule_collection *);
321 /* Threshold at which to begin flow table eviction. Only affects the
322 * ofproto-dpif implementation */
323 extern unsigned flow_eviction_threshold;
325 /* Number of upcall handler threads. Only affects the ofproto-dpif
327 extern unsigned n_handler_threads;
329 /* Determines which model to use for handling misses in the ofproto-dpif
331 extern enum ofproto_flow_miss_model flow_miss_model;
333 static inline struct rule *
334 rule_from_cls_rule(const struct cls_rule *cls_rule)
336 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
339 void ofproto_rule_expire(struct rule *rule, uint8_t reason);
340 void ofproto_rule_delete(struct ofproto *, struct classifier *cls,
341 struct rule *) OVS_REQ_WRLOCK(cls->rwlock);
342 void ofproto_rule_reduce_timeouts(struct rule *rule, uint16_t idle_timeout,
343 uint16_t hard_timeout)
344 OVS_EXCLUDED(ofproto_mutex, rule->mutex);
346 void ofoperation_complete(struct ofoperation *, enum ofperr);
348 bool ofoperation_has_out_port(const struct ofoperation *, ofp_port_t out_port);
350 /* A group within a "struct ofproto".
352 * With few exceptions, ofproto implementations may look at these fields but
353 * should not modify them. */
355 /* The rwlock is used to prevent groups from being deleted while child
356 * threads are using them to xlate flows. A read lock means the
357 * group is currently being used. A write lock means the group is
358 * in the process of being deleted or updated. Note that since
359 * a read lock on the groups container is held while searching, and
360 * a group is ever write locked only while holding a write lock
361 * on the container, the user's of groups will never face a group
362 * in the write locked state. */
363 struct ovs_rwlock rwlock;
364 struct hmap_node hmap_node; /* In struct ofproto's "groups" hmap. */
365 struct ofproto *ofproto; /* The ofproto that contains this group. */
367 enum ofp11_group_type type; /* One of OFPGT_*. */
369 long long int created; /* Creation time. */
370 long long int modified; /* Time of last modification. */
372 struct list buckets; /* Contains "struct ofputil_bucket"s. */
376 bool ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
377 struct ofgroup **group)
378 OVS_TRY_RDLOCK(true, (*group)->rwlock);
380 void ofproto_group_release(struct ofgroup *group)
381 OVS_RELEASES(group->rwlock);
383 /* ofproto class structure, to be defined by each ofproto implementation.
389 * These functions work primarily with four different kinds of data
392 * - "struct ofproto", which represents an OpenFlow switch.
394 * - "struct ofport", which represents a port within an ofproto.
396 * - "struct rule", which represents an OpenFlow flow within an ofproto.
398 * - "struct ofgroup", which represents an OpenFlow 1.1+ group within an
401 * Each of these data structures contains all of the implementation-independent
402 * generic state for the respective concept, called the "base" state. None of
403 * them contains any extra space for ofproto implementations to use. Instead,
404 * each implementation is expected to declare its own data structure that
405 * contains an instance of the generic data structure plus additional
406 * implementation-specific members, called the "derived" state. The
407 * implementation can use casts or (preferably) the CONTAINER_OF macro to
408 * obtain access to derived state given only a pointer to the embedded generic
415 * Four stylized functions accompany each of these data structures:
417 * "alloc" "construct" "destruct" "dealloc"
418 * ------------ ---------------- --------------- --------------
419 * ofproto ->alloc ->construct ->destruct ->dealloc
420 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
421 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
422 * group ->group_alloc ->group_construct ->group_destruct ->group_dealloc
424 * "ofproto", "ofport", and "group" have this exact life cycle. The "rule"
425 * data structure also follow this life cycle with some additional elaborations
426 * described under "Rule Life Cycle" below.
428 * Any instance of a given data structure goes through the following life
431 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
432 * fails, skip all the other steps.
434 * 2. The client initializes all of the data structure's base state. If this
435 * fails, skip to step 7.
437 * 3. The client calls the "construct" function. The implementation
438 * initializes derived state. It may refer to the already-initialized
439 * base state. If "construct" fails, skip to step 6.
441 * 4. The data structure is now initialized and in use.
443 * 5. When the data structure is no longer needed, the client calls the
444 * "destruct" function. The implementation uninitializes derived state.
445 * The base state has not been uninitialized yet, so the implementation
446 * may still refer to it.
448 * 6. The client uninitializes all of the data structure's base state.
450 * 7. The client calls the "dealloc" to free the raw memory. The
451 * implementation must not refer to base or derived state in the data
452 * structure, because it has already been uninitialized.
454 * Each "alloc" function allocates and returns a new instance of the respective
455 * data structure. The "alloc" function is not given any information about the
456 * use of the new data structure, so it cannot perform much initialization.
457 * Its purpose is just to ensure that the new data structure has enough room
458 * for base and derived state. It may return a null pointer if memory is not
459 * available, in which case none of the other functions is called.
461 * Each "construct" function initializes derived state in its respective data
462 * structure. When "construct" is called, all of the base state has already
463 * been initialized, so the "construct" function may refer to it. The
464 * "construct" function is allowed to fail, in which case the client calls the
465 * "dealloc" function (but not the "destruct" function).
467 * Each "destruct" function uninitializes and frees derived state in its
468 * respective data structure. When "destruct" is called, the base state has
469 * not yet been uninitialized, so the "destruct" function may refer to it. The
470 * "destruct" function is not allowed to fail.
472 * Each "dealloc" function frees raw memory that was allocated by the the
473 * "alloc" function. The memory's base and derived members might not have ever
474 * been initialized (but if "construct" returned successfully, then it has been
475 * "destruct"ed already). The "dealloc" function is not allowed to fail.
481 * Most of these functions return 0 if they are successful or a positive error
482 * code on failure. Depending on the function, valid error codes are either
483 * errno values or OFPERR_* OpenFlow error codes.
485 * Most of these functions are expected to execute synchronously, that is, to
486 * block as necessary to obtain a result. Thus, these functions may return
487 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
488 * explicitly say those errors are a possibility. We may relax this
489 * requirement in the future if and when we encounter performance problems. */
490 struct ofproto_class {
491 /* ## ----------------- ## */
492 /* ## Factory Functions ## */
493 /* ## ----------------- ## */
495 /* Initializes provider. The caller may pass in 'iface_hints',
496 * which contains an shash of "struct iface_hint" elements indexed
497 * by the interface's name. The provider may use these hints to
498 * describe the startup configuration in order to reinitialize its
499 * state. The caller owns the provided data, so a provider must
500 * make copies of anything required. An ofproto provider must
501 * remove any existing state that is not described by the hint, and
502 * may choose to remove it all. */
503 void (*init)(const struct shash *iface_hints);
505 /* Enumerates the types of all support ofproto types into 'types'. The
506 * caller has already initialized 'types' and other ofproto classes might
507 * already have added names to it. */
508 void (*enumerate_types)(struct sset *types);
510 /* Enumerates the names of all existing datapath of the specified 'type'
511 * into 'names' 'all_dps'. The caller has already initialized 'names' as
514 * 'type' is one of the types enumerated by ->enumerate_types().
516 * Returns 0 if successful, otherwise a positive errno value.
518 int (*enumerate_names)(const char *type, struct sset *names);
520 /* Deletes the datapath with the specified 'type' and 'name'. The caller
521 * should have closed any open ofproto with this 'type' and 'name'; this
522 * function is allowed to fail if that is not the case.
524 * 'type' is one of the types enumerated by ->enumerate_types().
525 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
527 * Returns 0 if successful, otherwise a positive errno value.
529 int (*del)(const char *type, const char *name);
531 /* Returns the type to pass to netdev_open() when a datapath of type
532 * 'datapath_type' has a port of type 'port_type', for a few special
533 * cases when a netdev type differs from a port type. For example,
534 * when using the userspace datapath, a port of type "internal"
535 * needs to be opened as "tap".
537 * Returns either 'type' itself or a string literal, which must not
539 const char *(*port_open_type)(const char *datapath_type,
540 const char *port_type);
542 /* ## ------------------------ ## */
543 /* ## Top-Level type Functions ## */
544 /* ## ------------------------ ## */
546 /* Performs any periodic activity required on ofprotos of type
549 * An ofproto provider may implement it or not, depending on whether
550 * it needs type-level maintenance.
552 * Returns 0 if successful, otherwise a positive errno value. */
553 int (*type_run)(const char *type);
555 /* Performs periodic activity required on ofprotos of type 'type'
556 * that needs to be done with the least possible latency.
558 * This is run multiple times per main loop. An ofproto provider may
559 * implement it or not, according to whether it provides a performance
560 * boost for that ofproto implementation.
562 * Returns 0 if successful, otherwise a positive errno value. */
563 int (*type_run_fast)(const char *type);
565 /* Causes the poll loop to wake up when a type 'type''s 'run'
566 * function needs to be called, e.g. by calling the timer or fd
567 * waiting functions in poll-loop.h.
569 * An ofproto provider may implement it or not, depending on whether
570 * it needs type-level maintenance. */
571 void (*type_wait)(const char *type);
573 /* ## --------------------------- ## */
574 /* ## Top-Level ofproto Functions ## */
575 /* ## --------------------------- ## */
577 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
583 * ->construct() should not modify any base members of the ofproto. The
584 * client will initialize the ofproto's 'ports' and 'tables' members after
585 * construction is complete.
587 * When ->construct() is called, the client does not yet know how many flow
588 * tables the datapath supports, so ofproto->n_tables will be 0 and
589 * ofproto->tables will be NULL. ->construct() should call
590 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
591 * ofproto->tables. Each flow table will be initially empty, so
592 * ->construct() should delete flows from the underlying datapath, if
593 * necessary, rather than populating the tables.
595 * If the ofproto knows the maximum port number that the datapath can have,
596 * then it can call ofproto_init_max_ports(). If it does so, then the
597 * client will ensure that the actions it allows to be used through
598 * OpenFlow do not refer to ports above that maximum number.
600 * Only one ofproto instance needs to be supported for any given datapath.
601 * If a datapath is already open as part of one "ofproto", then another
602 * attempt to "construct" the same datapath as part of another ofproto is
603 * allowed to fail with an error.
605 * ->construct() returns 0 if successful, otherwise a positive errno
612 * If 'ofproto' has any pending asynchronous operations, ->destruct()
613 * must complete all of them by calling ofoperation_complete().
615 * ->destruct() must also destroy all remaining rules in the ofproto's
616 * tables, by passing each remaining rule to ofproto_rule_delete(), and
617 * then complete each of those deletions in turn by calling
618 * ofoperation_complete().
620 * (Thus, there is a multi-step process for any rule currently being
621 * inserted or modified at the beginning of destruction: first
622 * ofoperation_complete() that operation, then ofproto_rule_delete() the
623 * rule, then ofoperation_complete() the deletion operation.)
625 * The client will destroy the flow tables themselves after ->destruct()
628 struct ofproto *(*alloc)(void);
629 int (*construct)(struct ofproto *ofproto);
630 void (*destruct)(struct ofproto *ofproto);
631 void (*dealloc)(struct ofproto *ofproto);
633 /* Performs any periodic activity required by 'ofproto'. It should:
635 * - Call connmgr_send_packet_in() for each received packet that missed
636 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
639 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
640 * its hard_timeout or idle_timeout, to expire the flow.
642 * (But rules that are part of a pending operation, e.g. rules for
643 * which ->pending is true, may not expire.)
645 * Returns 0 if successful, otherwise a positive errno value. */
646 int (*run)(struct ofproto *ofproto);
648 /* Performs periodic activity required by 'ofproto' that needs to be done
649 * with the least possible latency.
651 * This is run multiple times per main loop. An ofproto provider may
652 * implement it or not, according to whether it provides a performance
653 * boost for that ofproto implementation. */
654 int (*run_fast)(struct ofproto *ofproto);
656 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
657 * be called, e.g. by calling the timer or fd waiting functions in
659 void (*wait)(struct ofproto *ofproto);
661 /* Adds some memory usage statistics for the implementation of 'ofproto'
662 * into 'usage', for use with memory_report().
664 * This function is optional. */
665 void (*get_memory_usage)(const struct ofproto *ofproto,
666 struct simap *usage);
668 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
669 * This function may prepare for that, for example by clearing state in
670 * advance. It should *not* actually delete any "struct rule"s from
671 * 'ofproto', only prepare for it.
673 * This function is optional; it's really just for optimization in case
674 * it's cheaper to delete all the flows from your hardware in a single pass
675 * than to do it one by one. */
676 void (*flush)(struct ofproto *ofproto);
678 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
680 * The implementation should store true in '*arp_match_ip' if the switch
681 * supports matching IP addresses inside ARP requests and replies, false
684 * The implementation should store in '*actions' a bitmap of the supported
685 * OpenFlow actions. Vendor actions are not included in '*actions'. */
686 void (*get_features)(struct ofproto *ofproto,
688 enum ofputil_action_bitmap *actions);
690 /* Helper for the OpenFlow OFPST_TABLE statistics request.
692 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
695 * - 'table_id' to the array index.
697 * - 'name' to "table#" where # is the table ID.
699 * - 'match' and 'wildcards' to OFPXMT12_MASK.
701 * - 'write_actions' and 'apply_actions' to OFPAT12_OUTPUT.
703 * - 'write_setfields' and 'apply_setfields' to OFPXMT12_MASK.
705 * - 'metadata_match' and 'metadata_write' to UINT64_MAX.
707 * - 'instructions' to OFPIT11_ALL.
709 * - 'config' to OFPTC11_TABLE_MISS_MASK.
711 * - 'max_entries' to 1,000,000.
713 * - 'active_count' to the classifier_count() for the table.
715 * - 'lookup_count' and 'matched_count' to 0.
717 * The implementation should update any members in each element for which
718 * it has better values:
720 * - 'name' to a more meaningful name.
722 * - 'wildcards' to the set of wildcards actually supported by the table
723 * (if it doesn't support all OpenFlow wildcards).
725 * - 'instructions' to set the instructions actually supported by
728 * - 'write_actions' to set the write actions actually supported by
729 * the table (if it doesn't support all OpenFlow actions).
731 * - 'apply_actions' to set the apply actions actually supported by
732 * the table (if it doesn't support all OpenFlow actions).
734 * - 'write_setfields' to set the write setfields actually supported by
737 * - 'apply_setfields' to set the apply setfields actually supported by
740 * - 'max_entries' to the maximum number of flows actually supported by
743 * - 'lookup_count' to the number of packets looked up in this flow table
746 * - 'matched_count' to the number of packets looked up in this flow
747 * table so far that matched one of the flow entries.
749 * All of the members of struct ofp12_table_stats are in network byte
752 void (*get_tables)(struct ofproto *ofproto, struct ofp12_table_stats *ots);
754 /* ## ---------------- ## */
755 /* ## ofport Functions ## */
756 /* ## ---------------- ## */
758 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
760 * ->port_construct() should not modify any base members of the ofport.
761 * An ofproto implementation should use the 'ofp_port' member of
762 * "struct ofport" as the OpenFlow port number.
764 * ofports are managed by the base ofproto code. The ofproto
765 * implementation should only create and destroy them in response to calls
766 * to these functions. The base ofproto code will create and destroy
767 * ofports in the following situations:
769 * - Just after the ->construct() function is called, the base ofproto
770 * iterates over all of the implementation's ports, using
771 * ->port_dump_start() and related functions, and constructs an ofport
772 * for each dumped port.
774 * - If ->port_poll() reports that a specific port has changed, then the
775 * base ofproto will query that port with ->port_query_by_name() and
776 * construct or destruct ofports as necessary to reflect the updated
779 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
780 * change, then the base ofproto will iterate over all of the
781 * implementation's ports, in the same way as at ofproto
782 * initialization, and construct and destruct ofports to reflect all of
785 * ->port_construct() returns 0 if successful, otherwise a positive errno
788 struct ofport *(*port_alloc)(void);
789 int (*port_construct)(struct ofport *ofport);
790 void (*port_destruct)(struct ofport *ofport);
791 void (*port_dealloc)(struct ofport *ofport);
793 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
794 * the ofproto implementation uses the ofport's netdev internally, then it
795 * should switch to using the new one. The old one has been closed.
797 * An ofproto implementation that doesn't need to do anything in this
798 * function may use a null pointer. */
799 void (*port_modified)(struct ofport *ofport);
801 /* Called after an OpenFlow request changes a port's configuration.
802 * 'ofport->pp.config' contains the new configuration. 'old_config'
803 * contains the previous configuration.
805 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
806 * turn NETDEV_UP on and off, so this function doesn't have to do anything
807 * for that bit (and it won't be called if that is the only bit that
809 void (*port_reconfigured)(struct ofport *ofport,
810 enum ofputil_port_config old_config);
812 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
813 * '*port' appropriately.
815 * The caller owns the data in 'port' and must free it with
816 * ofproto_port_destroy() when it is no longer needed. */
817 int (*port_query_by_name)(const struct ofproto *ofproto,
818 const char *devname, struct ofproto_port *port);
820 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
821 * successful, otherwise a positive errno value. The caller should
822 * inform the implementation of the OpenFlow port through the
823 * ->port_construct() method.
825 * It doesn't matter whether the new port will be returned by a later call
826 * to ->port_poll(); the implementation may do whatever is more
828 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
830 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
831 * 0 if successful, otherwise a positive errno value.
833 * It doesn't matter whether the new port will be returned by a later call
834 * to ->port_poll(); the implementation may do whatever is more
836 int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
839 int (*port_get_stats)(const struct ofport *port,
840 struct netdev_stats *stats);
842 /* Port iteration functions.
844 * The client might not be entirely in control of the ports within an
845 * ofproto. Some hardware implementations, for example, might have a fixed
846 * set of ports in a datapath. For this reason, the client needs a way to
847 * iterate through all the ports that are actually in a datapath. These
848 * functions provide that functionality.
850 * The 'state' pointer provides the implementation a place to
851 * keep track of its position. Its format is opaque to the caller.
853 * The ofproto provider retains ownership of the data that it stores into
854 * ->port_dump_next()'s 'port' argument. The data must remain valid until
855 * at least the next call to ->port_dump_next() or ->port_dump_done() for
856 * 'state'. The caller will not modify or free it.
861 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
862 * On success, it should return 0 and initialize '*statep' with any data
863 * needed for iteration. On failure, returns a positive errno value, and
864 * the client will not call ->port_dump_next() or ->port_dump_done().
866 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
867 * 'state'. If there is another port, it should store the port's
868 * information into 'port' and return 0. It should return EOF if all ports
869 * have already been iterated. Otherwise, on error, it should return a
870 * positive errno value. This function will not be called again once it
871 * returns nonzero once for a given iteration (but the 'port_dump_done'
872 * function will be called afterward).
874 * ->port_dump_done() allows the implementation to release resources used
875 * for iteration. The caller might decide to stop iteration in the middle
876 * by calling this function before ->port_dump_next() returns nonzero.
884 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
887 * struct ofproto_port port;
889 * error = ofproto->ofproto_class->port_dump_next(
890 * ofproto, state, &port);
894 * // Do something with 'port' here (without modifying or freeing
895 * // any of its data).
897 * ofproto->ofproto_class->port_dump_done(ofproto, state);
899 * // 'error' is now EOF (success) or a positive errno value (failure).
901 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
902 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
903 struct ofproto_port *port);
904 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
906 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
907 * in 'ofproto' has changed, then this function should do one of the
910 * - Preferably: store the name of the device that was added to or deleted
911 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
912 * for freeing '*devnamep' (with free()) when it no longer needs it.
914 * - Alternatively: return ENOBUFS, without indicating the device that was
917 * Occasional 'false positives', in which the function returns 0 while
918 * indicating a device that was not actually added or deleted or returns
919 * ENOBUFS without any change, are acceptable.
921 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
922 * externally to the 'ofproto' object, e.g. by a system administrator via
923 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
924 * not report changes made through calls to 'port_add' or 'port_del' on the
925 * same 'ofproto' object. (But it's OK for it to report them too, just
926 * slightly less efficient.)
928 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
929 * also return other positive errno values to indicate that something has
932 * If the set of ports in a datapath is fixed, or if the only way that the
933 * set of ports in a datapath can change is through ->port_add() and
934 * ->port_del(), then this function may be a null pointer.
936 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
938 /* Arranges for the poll loop to wake up when ->port_poll() will return a
939 * value other than EAGAIN.
941 * If the set of ports in a datapath is fixed, or if the only way that the
942 * set of ports in a datapath can change is through ->port_add() and
943 * ->port_del(), or if the poll loop will always wake up anyway when
944 * ->port_poll() will return a value other than EAGAIN, then this function
945 * may be a null pointer.
947 void (*port_poll_wait)(const struct ofproto *ofproto);
949 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
950 * partner information for 'port' is up-to-date, 0 if LACP partner
951 * information is not current (generally indicating a connectivity
952 * problem), or -1 if LACP is not enabled on 'port'.
954 * This function may be a null pointer if the ofproto implementation does
955 * not support LACP. */
956 int (*port_is_lacp_current)(const struct ofport *port);
958 /* ## ----------------------- ## */
959 /* ## OpenFlow Rule Functions ## */
960 /* ## ----------------------- ## */
962 /* Chooses an appropriate table for 'match' within 'ofproto'. On
963 * success, stores the table ID into '*table_idp' and returns 0. On
964 * failure, returns an OpenFlow error code.
966 * The choice of table should be a function of 'match' and 'ofproto''s
967 * datapath capabilities. It should not depend on the flows already in
968 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
969 * 'match' as its matching condition can never be inserted into 'ofproto',
970 * even starting from an empty flow table.
972 * If multiple tables are candidates for inserting the flow, the function
973 * should choose one arbitrarily (but deterministically).
975 * If this function is NULL then table 0 is always chosen. */
976 enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
977 const struct match *match,
980 /* Life-cycle functions for a "struct rule".
986 * The life cycle of a struct rule is an elaboration of the basic life
987 * cycle described above under "Life Cycle".
989 * After a rule is successfully constructed, it is then inserted. If
990 * insertion completes successfully, then before it is later destructed, it
993 * You can think of a rule as having the following extra steps inserted
994 * between "Life Cycle" steps 4 and 5:
996 * 4.1. The client inserts the rule into the flow table, making it
997 * visible in flow table lookups.
999 * 4.2. The client calls "rule_insert". Immediately or eventually, the
1000 * implementation calls ofoperation_complete() to indicate that the
1001 * insertion completed. If the operation failed, skip to step 5.
1003 * 4.3. The rule is now installed in the flow table. Eventually it will
1006 * 4.4. The client removes the rule from the flow table. It is no longer
1007 * visible in flow table lookups.
1009 * 4.5. The client calls "rule_delete". Immediately or eventually, the
1010 * implementation calls ofoperation_complete() to indicate that the
1011 * deletion completed. Deletion is not allowed to fail, so it must
1015 * Asynchronous Operation Support
1016 * ==============================
1018 * The "insert" and "delete" life-cycle operations on rules can operate
1019 * asynchronously, meaning that ->rule_insert() and ->rule_delete() only
1020 * need to initiate their respective operations and do not need to wait for
1021 * them to complete before they return. ->rule_modify_actions() also
1022 * operates asynchronously.
1024 * An ofproto implementation reports the success or failure of an
1025 * asynchronous operation on a rule using the rule's 'pending' member,
1026 * which points to a opaque "struct ofoperation" that represents the
1027 * ongoing operation. When the operation completes, the ofproto
1028 * implementation calls ofoperation_complete(), passing the ofoperation and
1029 * an error indication.
1031 * Only the following contexts may call ofoperation_complete():
1033 * - The function called to initiate the operation, e.g. ->rule_insert()
1034 * or ->rule_delete(). This is the best choice if the operation
1035 * completes quickly.
1037 * - The implementation's ->run() function.
1039 * - The implementation's ->destruct() function.
1041 * The ofproto base code updates the flow table optimistically, assuming
1042 * that the operation will probably succeed:
1044 * - ofproto adds the rule in the flow table before calling
1047 * - ofproto updates the rule's actions and other properties before
1048 * calling ->rule_modify_actions().
1050 * - ofproto removes the rule before calling ->rule_delete().
1052 * With one exception, when an asynchronous operation completes with an
1053 * error, ofoperation_complete() backs out the already applied changes:
1055 * - If adding a rule in the flow table fails, ofproto removes the new
1058 * - If modifying a rule fails, ofproto restores the original actions
1059 * (and other properties).
1061 * - Removing a rule is not allowed to fail. It must always succeed.
1063 * The ofproto base code serializes operations: if any operation is in
1064 * progress on a given rule, ofproto postpones initiating any new operation
1065 * on that rule until the pending operation completes. Therefore, every
1066 * operation must eventually complete through a call to
1067 * ofoperation_complete() to avoid delaying new operations indefinitely
1068 * (including any OpenFlow request that affects the rule in question, even
1069 * just to query its statistics).
1075 * When ->rule_construct() is called, 'rule' is a new rule that is not yet
1076 * inserted into a flow table. ->rule_construct() should initialize enough
1077 * of the rule's derived state for 'rule' to be suitable for inserting into
1078 * a flow table. ->rule_construct() should not modify any base members of
1081 * If ->rule_construct() fails (as indicated by returning a nonzero
1082 * OpenFlow error code), the ofproto base code will uninitialize and
1083 * deallocate 'rule'. See "Rule Life Cycle" above for more details.
1085 * ->rule_construct() may also:
1087 * - Validate that the datapath supports the matching rule in 'rule->cr'
1088 * datapath. For example, if the rule's table does not support
1089 * registers, then it is an error if 'rule->cr' does not wildcard all
1092 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
1094 * Some implementations might need to defer these tasks to ->rule_insert(),
1095 * which is also acceptable.
1101 * Following successful construction, the ofproto base case inserts 'rule'
1102 * into its flow table, then it calls ->rule_insert(). ->rule_insert()
1103 * should set in motion adding the new rule to the datapath flow table. It
1104 * must act as follows:
1106 * - If it completes insertion, either by succeeding or failing, it must
1107 * call ofoperation_complete()
1109 * - If insertion is only partially complete, then it must return without
1110 * calling ofoperation_complete(). Later, when the insertion is
1111 * complete, the ->run() or ->destruct() function must call
1112 * ofoperation_complete() to report success or failure.
1114 * If ->rule_insert() fails, the ofproto base code will remove 'rule' from
1115 * the flow table, destruct, uninitialize, and deallocate 'rule'. See
1116 * "Rule Life Cycle" above for more details.
1122 * The ofproto base code removes 'rule' from its flow table before it calls
1123 * ->rule_delete(). ->rule_delete() should set in motion removing 'rule'
1124 * from the datapath flow table. It must act as follows:
1126 * - If it completes deletion, it must call ofoperation_complete().
1128 * - If deletion is only partially complete, then it must return without
1129 * calling ofoperation_complete(). Later, when the deletion is
1130 * complete, the ->run() or ->destruct() function must call
1131 * ofoperation_complete().
1133 * Rule deletion must not fail.
1139 * ->rule_destruct() must uninitialize derived state.
1141 * Rule destruction must not fail. */
1142 struct rule *(*rule_alloc)(void);
1143 enum ofperr (*rule_construct)(struct rule *rule);
1144 void (*rule_insert)(struct rule *rule);
1145 void (*rule_delete)(struct rule *rule);
1146 void (*rule_destruct)(struct rule *rule);
1147 void (*rule_dealloc)(struct rule *rule);
1149 /* Obtains statistics for 'rule', storing the number of packets that have
1150 * matched it in '*packet_count' and the number of bytes in those packets
1151 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
1152 * count is unknown. */
1153 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
1154 uint64_t *byte_count);
1156 /* Applies the actions in 'rule' to 'packet'. (This implements sending
1157 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1159 * Takes ownership of 'packet' (so it should eventually free it, with
1162 * 'flow' reflects the flow information for 'packet'. All of the
1163 * information in 'flow' is extracted from 'packet', except for
1164 * flow->tunnel and flow->in_port, which are assigned the correct values
1165 * for the incoming packet. The register values are zeroed. 'packet''s
1166 * header pointers (e.g. packet->l3) are appropriately initialized.
1167 * packet->l3 is aligned on a 32-bit boundary.
1169 * The implementation should add the statistics for 'packet' into 'rule'.
1171 * Returns 0 if successful, otherwise an OpenFlow error code. */
1172 enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1173 struct ofpbuf *packet);
1175 /* When ->rule_modify_actions() is called, the caller has already replaced
1176 * the OpenFlow actions in 'rule' by a new set. (The original actions are
1177 * in rule->pending->actions.)
1179 * ->rule_modify_actions() should set the following in motion:
1181 * - Validate that the datapath can correctly implement the actions now
1184 * - Update the datapath flow table with the new actions.
1186 * - Only if 'reset_counters' is true, reset any packet or byte counters
1187 * associated with the rule to zero, so that rule_get_stats() will not
1188 * longer count those packets or bytes.
1190 * If the operation synchronously completes, ->rule_modify_actions() may
1191 * call ofoperation_complete() before it returns. Otherwise, ->run()
1192 * should call ofoperation_complete() later, after the operation does
1195 * If the operation fails, then the base ofproto code will restore the
1196 * original 'actions' and 'n_actions' of 'rule'.
1198 * ->rule_modify_actions() should not modify any base members of struct
1200 void (*rule_modify_actions)(struct rule *rule, bool reset_counters);
1202 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1203 * which takes one of the following values, with the corresponding
1206 * - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1207 * as other packets, omitting TCP and UDP port numbers (always setting
1210 * - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1211 * passing them through the flow table.
1213 * - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1214 * passing packets through the flow table.
1216 * - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1217 * except that TCP and UDP port numbers should be included in fragments
1220 * Implementations are not required to support every mode.
1221 * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1223 * At the time of the call to ->set_frag_handling(), the current mode is
1224 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1225 * true if the requested mode was set, false if it is not supported.
1227 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1228 * reflect the new mode.
1230 bool (*set_frag_handling)(struct ofproto *ofproto,
1231 enum ofp_config_flags frag_handling);
1233 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1234 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1236 * The caller retains ownership of 'packet' and of 'ofpacts', so
1237 * ->packet_out() should not modify or free them.
1239 * This function must validate that it can correctly implement 'ofpacts'.
1240 * If not, then it should return an OpenFlow error code.
1242 * 'flow' reflects the flow information for 'packet'. All of the
1243 * information in 'flow' is extracted from 'packet', except for
1244 * flow->in_port (see below). flow->tunnel and its register values are
1247 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1248 * implementation should reject invalid flow->in_port values by returning
1249 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1250 * ofproto_init_max_ports(), then the client will reject these ports
1251 * itself.) For consistency, the implementation should consider valid for
1252 * flow->in_port any value that could possibly be seen in a packet that it
1253 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1254 * that never generates packet-ins (e.g. due to hardware limitations)
1255 * should still allow flow->in_port values for every possible physical port
1256 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1257 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1258 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1259 * these, treating each of them as packets generated by the controller as
1260 * opposed to packets originating from some switch port.
1262 * (Ordinarily the only effect of flow->in_port is on output actions that
1263 * involve the input port, such as actions that output to OFPP_IN_PORT,
1264 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1265 * "resubmit" actions.)
1267 * 'packet' is not matched against the OpenFlow flow table, so its
1268 * statistics should not be included in OpenFlow flow statistics.
1270 * Returns 0 if successful, otherwise an OpenFlow error code. */
1271 enum ofperr (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
1272 const struct flow *flow,
1273 const struct ofpact *ofpacts,
1274 size_t ofpacts_len);
1276 /* ## ------------------------- ## */
1277 /* ## OFPP_NORMAL configuration ## */
1278 /* ## ------------------------- ## */
1280 /* Configures NetFlow on 'ofproto' according to the options in
1281 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1283 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1284 * NetFlow, as does a null pointer. */
1285 int (*set_netflow)(struct ofproto *ofproto,
1286 const struct netflow_options *netflow_options);
1288 void (*get_netflow_ids)(const struct ofproto *ofproto,
1289 uint8_t *engine_type, uint8_t *engine_id);
1291 /* Configures sFlow on 'ofproto' according to the options in
1292 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1294 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1295 * sFlow, as does a null pointer. */
1296 int (*set_sflow)(struct ofproto *ofproto,
1297 const struct ofproto_sflow_options *sflow_options);
1299 /* Configures IPFIX on 'ofproto' according to the options in
1300 * 'bridge_exporter_options' and the 'flow_exporters_options'
1301 * array, or turns off IPFIX if 'bridge_exporter_options' and
1302 * 'flow_exporters_options' is NULL.
1304 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1305 * IPFIX, as does a null pointer. */
1307 struct ofproto *ofproto,
1308 const struct ofproto_ipfix_bridge_exporter_options
1309 *bridge_exporter_options,
1310 const struct ofproto_ipfix_flow_exporter_options
1311 *flow_exporters_options, size_t n_flow_exporters_options);
1313 /* Configures connectivity fault management on 'ofport'.
1315 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1317 * If 'cfm_settings' is null, removes any connectivity fault management
1318 * configuration from 'ofport'.
1320 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1321 * support CFM, as does a null pointer. */
1322 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1324 /* Checks the status of CFM configured on 'ofport'. Returns true if the
1325 * port's CFM status was successfully stored into '*status'. Returns false
1326 * if the port did not have CFM configured, in which case '*status' is
1329 * The caller must provide and owns '*status', but it does not own and must
1330 * not modify or free the array returned in 'status->rmps'. */
1331 bool (*get_cfm_status)(const struct ofport *ofport,
1332 struct ofproto_cfm_status *status);
1334 /* Configures BFD on 'ofport'.
1336 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1337 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1338 * according to 'cfg'.
1340 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1341 * support BFD, as does a null pointer. */
1342 int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1344 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1345 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1346 * that this ofproto_class does not support BFD, as does a null pointer. */
1347 int (*get_bfd_status)(struct ofport *ofport, struct smap *smap);
1349 /* Configures spanning tree protocol (STP) on 'ofproto' using the
1350 * settings defined in 's'.
1352 * If 's' is nonnull, configures STP according to its members.
1354 * If 's' is null, removes any STP configuration from 'ofproto'.
1356 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1357 * support STP, as does a null pointer. */
1358 int (*set_stp)(struct ofproto *ofproto,
1359 const struct ofproto_stp_settings *s);
1361 /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1363 * Stores STP state for 'ofproto' in 's'. If the 'enabled' member
1364 * is false, the other member values are not meaningful.
1366 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1367 * support STP, as does a null pointer. */
1368 int (*get_stp_status)(struct ofproto *ofproto,
1369 struct ofproto_stp_status *s);
1371 /* Configures spanning tree protocol (STP) on 'ofport' using the
1372 * settings defined in 's'.
1374 * If 's' is nonnull, configures STP according to its members. The
1375 * caller is responsible for assigning STP port numbers (using the
1376 * 'port_num' member in the range of 1 through 255, inclusive) and
1377 * ensuring there are no duplicates.
1379 * If 's' is null, removes any STP configuration from 'ofport'.
1381 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1382 * support STP, as does a null pointer. */
1383 int (*set_stp_port)(struct ofport *ofport,
1384 const struct ofproto_port_stp_settings *s);
1386 /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1388 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1389 * false, the other member values are not meaningful.
1391 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1392 * support STP, as does a null pointer. */
1393 int (*get_stp_port_status)(struct ofport *ofport,
1394 struct ofproto_port_stp_status *s);
1396 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1397 * 'queues' attached to 'ofport'. This data is not intended to be
1398 * sufficient to implement QoS. Instead, providers may use this
1399 * information to implement features which require knowledge of what queues
1400 * exist on a port, and some basic information about them.
1402 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1403 * support QoS, as does a null pointer. */
1404 int (*set_queues)(struct ofport *ofport,
1405 const struct ofproto_port_queue *queues, size_t n_qdscp);
1407 /* If 's' is nonnull, this function registers a "bundle" associated with
1408 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
1409 * a Port in OVSDB, that is, it consists of one or more "slave" devices
1410 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1411 * there is more than one slave, a bonding configuration. If 'aux' is
1412 * already registered then this function updates its configuration to 's'.
1413 * Otherwise, this function registers a new bundle.
1415 * If 's' is NULL, this function unregisters the bundle registered on
1416 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
1417 * has been registered, this has no effect.
1419 * This function affects only the behavior of the NXAST_AUTOPATH action and
1420 * output to the OFPP_NORMAL port. An implementation that does not support
1421 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
1422 * that supports only a subset of the functionality should implement what
1423 * it can and return 0. */
1424 int (*bundle_set)(struct ofproto *ofproto, void *aux,
1425 const struct ofproto_bundle_settings *s);
1427 /* If 'port' is part of any bundle, removes it from that bundle. If the
1428 * bundle now has no ports, deletes the bundle. If the bundle now has only
1429 * one port, deconfigures the bundle's bonding configuration. */
1430 void (*bundle_remove)(struct ofport *ofport);
1432 /* If 's' is nonnull, this function registers a mirror associated with
1433 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
1434 * a Mirror in OVSDB. If 'aux' is already registered then this function
1435 * updates its configuration to 's'. Otherwise, this function registers a
1438 * If 's' is NULL, this function unregisters the mirror registered on
1439 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
1440 * has been registered, this has no effect.
1442 * An implementation that does not support mirroring at all may set
1443 * it to NULL or return EOPNOTSUPP. An implementation that supports
1444 * only a subset of the functionality should implement what it can
1446 int (*mirror_set)(struct ofproto *ofproto, void *aux,
1447 const struct ofproto_mirror_settings *s);
1449 /* Retrieves statistics from mirror associated with client data
1450 * pointer 'aux' in 'ofproto'. Stores packet and byte counts in
1451 * 'packets' and 'bytes', respectively. If a particular counter is
1452 * not supported, the appropriate argument is set to UINT64_MAX.
1454 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1455 * support retrieving mirror statistics. */
1456 int (*mirror_get_stats)(struct ofproto *ofproto, void *aux,
1457 uint64_t *packets, uint64_t *bytes);
1459 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1460 * on which all packets are flooded, instead of using MAC learning. If
1461 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1463 * This function affects only the behavior of the OFPP_NORMAL action. An
1464 * implementation that does not support it may set it to NULL or return
1466 int (*set_flood_vlans)(struct ofproto *ofproto,
1467 unsigned long *flood_vlans);
1469 /* Returns true if 'aux' is a registered bundle that is currently in use as
1470 * the output for a mirror. */
1471 bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1473 /* When the configuration option of forward_bpdu changes, this function
1474 * will be invoked. */
1475 void (*forward_bpdu_changed)(struct ofproto *ofproto);
1477 /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1478 * seconds, and the maximum number of MAC table entries to
1481 * An implementation that doesn't support configuring these features may
1482 * set this function to NULL or implement it as a no-op. */
1483 void (*set_mac_table_config)(struct ofproto *ofproto,
1484 unsigned int idle_time, size_t max_entries);
1486 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1488 * This is deprecated. It is only for compatibility with broken device drivers
1489 * in old versions of Linux that do not properly support VLANs when VLAN
1490 * devices are not used. When broken device drivers are no longer in
1491 * widespread use, we will delete these interfaces. */
1493 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1494 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1495 * that has OpenFlow port number 'realdev_ofp_port'.
1497 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1498 * as a VLAN splinter port.
1500 * This function should be NULL if an implementation does not support it.
1502 int (*set_realdev)(struct ofport *ofport,
1503 ofp_port_t realdev_ofp_port, int vid);
1505 /* ## ------------------------ ## */
1506 /* ## OpenFlow meter functions ## */
1507 /* ## ------------------------ ## */
1509 /* These functions should be NULL if an implementation does not support
1510 * them. They must be all null or all non-null.. */
1512 /* Initializes 'features' to describe the metering features supported by
1514 void (*meter_get_features)(const struct ofproto *ofproto,
1515 struct ofputil_meter_features *features);
1517 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1518 * success the function must store a provider meter ID other than
1519 * UINT32_MAX in '*id'. All further references to the meter will be made
1520 * with the returned provider meter id rather than the OpenFlow meter id.
1521 * The caller does not try to interpret the provider meter id, giving the
1522 * implementation the freedom to either use the OpenFlow meter_id value
1523 * provided in the meter configuration, or any other value suitable for the
1526 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1527 * with that meter provider ID to have configuration 'config'. On failure,
1528 * the existing meter configuration is left intact. Regardless of success,
1529 * any change to '*id' updates the provider meter id used for this
1531 enum ofperr (*meter_set)(struct ofproto *ofproto, ofproto_meter_id *id,
1532 const struct ofputil_meter_config *config);
1534 /* Gets the meter and meter band packet and byte counts for maximum of
1535 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1536 * 'ofproto'. The caller fills in the other stats values. The band stats
1537 * are copied to memory at 'stats->bands' provided by the caller. The
1538 * number of returned band stats is returned in 'stats->n_bands'. */
1539 enum ofperr (*meter_get)(const struct ofproto *ofproto,
1540 ofproto_meter_id id,
1541 struct ofputil_meter_stats *stats);
1543 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1545 void (*meter_del)(struct ofproto *, ofproto_meter_id);
1548 /* ## -------------------- ## */
1549 /* ## OpenFlow 1.1+ groups ## */
1550 /* ## -------------------- ## */
1552 struct ofgroup *(*group_alloc)(void);
1553 enum ofperr (*group_construct)(struct ofgroup *);
1554 void (*group_destruct)(struct ofgroup *);
1555 void (*group_dealloc)(struct ofgroup *);
1557 enum ofperr (*group_modify)(struct ofgroup *, struct ofgroup *victim);
1559 enum ofperr (*group_get_stats)(const struct ofgroup *,
1560 struct ofputil_group_stats *);
1563 extern const struct ofproto_class ofproto_dpif_class;
1565 int ofproto_class_register(const struct ofproto_class *);
1566 int ofproto_class_unregister(const struct ofproto_class *);
1568 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
1569 * because it overlaps with an ongoing flow table operation that has not yet
1570 * completed. The caller should retry the operation later.
1572 * ofproto.c also uses this value internally for additional (similar) purposes.
1574 * This particular value is a good choice because it is large, so that it does
1575 * not collide with any errno value, but not large enough to collide with an
1576 * OFPERR_* value. */
1577 enum { OFPROTO_POSTPONE = 1 << 16 };
1578 BUILD_ASSERT_DECL(OFPROTO_POSTPONE < OFPERR_OFS);
1580 int ofproto_flow_mod(struct ofproto *, struct ofputil_flow_mod *);
1581 void ofproto_add_flow(struct ofproto *, const struct match *,
1582 unsigned int priority,
1583 const struct ofpact *ofpacts, size_t ofpacts_len);
1584 bool ofproto_delete_flow(struct ofproto *,
1585 const struct match *, unsigned int priority);
1586 void ofproto_flush_flows(struct ofproto *);
1588 #endif /* ofproto/ofproto-provider.h */
git://git.onelab.eu / sliver-openvswitch.git / blob