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 void ofproto_init_tables(struct ofproto *, int n_tables);
128 void ofproto_init_max_ports(struct ofproto *, uint16_t max_ports);
130 struct ofproto *ofproto_lookup(const char *name);
131 struct ofport *ofproto_get_port(const struct ofproto *, ofp_port_t ofp_port);
133 /* An OpenFlow port within a "struct ofproto".
135 * With few exceptions, ofproto implementations may look at these fields but
136 * should not modify them. */
138 struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
139 struct ofproto *ofproto; /* The ofproto that contains this port. */
140 struct netdev *netdev;
141 struct ofputil_phy_port pp;
142 ofp_port_t ofp_port; /* OpenFlow port number. */
143 unsigned int change_seq;
144 long long int created; /* Time created, in msec. */
148 void ofproto_port_set_state(struct ofport *, enum ofputil_port_state);
150 /* OpenFlow table flags:
152 * - "Hidden" tables are not included in OpenFlow operations that operate on
153 * "all tables". For example, a request for flow stats on all tables will
154 * omit flows in hidden tables, table stats requests will omit the table
155 * entirely, and the switch features reply will not count the hidden table.
157 * However, operations that specifically name the particular table still
158 * operate on it. For example, flow_mods and flow stats requests on a
161 * To avoid gaps in table IDs (which have unclear validity in OpenFlow),
162 * hidden tables must be the highest-numbered tables that a provider
165 * - "Read-only" tables can't be changed through OpenFlow operations. (At
166 * the moment all flow table operations go effectively through OpenFlow, so
167 * this means that read-only tables can't be changed at all after the
168 * read-only flag is set.)
170 * The generic ofproto layer never sets these flags. An ofproto provider can
171 * set them if it is appropriate.
174 OFTABLE_HIDDEN = 1 << 0, /* Hide from most OpenFlow operations. */
175 OFTABLE_READONLY = 1 << 1 /* Don't allow OpenFlow to change this table. */
178 /* A flow table within a "struct ofproto". */
180 enum oftable_flags flags;
181 struct classifier cls; /* Contains "struct rule"s. */
182 char *name; /* Table name exposed via OpenFlow, or NULL. */
184 /* Maximum number of flows or UINT_MAX if there is no limit besides any
185 * limit imposed by resource limitations. */
186 unsigned int max_flows;
188 /* These members determine the handling of an attempt to add a flow that
189 * would cause the table to have more than 'max_flows' flows.
191 * If 'eviction_fields' is NULL, overflows will be rejected with an error.
193 * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
194 * is nonzero), an overflow will cause a flow to be removed. The flow to
195 * be removed is chosen to give fairness among groups distinguished by
196 * different values for the subfields within 'groups'. */
197 struct mf_subfield *eviction_fields;
198 size_t n_eviction_fields;
202 * When a flow is added that would cause the table to have more than
203 * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
204 * used to decide which rule to evict: the rule is chosen from the eviction
205 * group that contains the greatest number of rules.*/
206 uint32_t eviction_group_id_basis;
207 struct hmap eviction_groups_by_id;
208 struct heap eviction_groups_by_size;
211 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
213 * All parameters are evaluated multiple times. */
214 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO) \
215 for ((TABLE) = (OFPROTO)->tables; \
216 (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
219 /* An OpenFlow flow within a "struct ofproto".
221 * With few exceptions, ofproto implementations may look at these fields but
222 * should not modify them. */
224 struct ofproto *ofproto; /* The ofproto that contains this rule. */
225 struct cls_rule cr; /* In owning ofproto's classifier. */
226 atomic_uint ref_count;
228 struct ofoperation *pending; /* Operation now in progress, if nonnull. */
230 ovs_be64 flow_cookie; /* Controller-issued identifier. Guarded by
232 struct hindex_node cookie_node OVS_GUARDED_BY(ofproto_mutex);
234 long long int created; /* Creation time. */
235 long long int modified; /* Time of last modification. */
236 long long int used; /* Last use; time created if never used. */
237 uint8_t table_id; /* Index in ofproto's 'tables' array. */
238 bool send_flow_removed; /* Send a flow removed message? */
240 uint16_t hard_timeout OVS_GUARDED; /* In seconds from ->modified. */
241 uint16_t idle_timeout OVS_GUARDED; /* In seconds from ->used. */
243 /* Eviction groups. */
244 struct heap_node evg_node; /* In eviction_group's "rules" heap. */
245 struct eviction_group *eviction_group; /* NULL if not in any group. */
247 /* The mutex is used to protect those elements in struct rule which are
248 * accessed by multiple threads. The main ofproto code is guaranteed not
249 * to change any of the elements "Guarded by mutex" without holding the
252 * While maintaining a pointer to struct rule, threads are required to hold
253 * a readlock on the classifier that holds the rule or increment the rule's
256 * A rule will not be evicted unless its classifier's write lock is
258 struct ovs_mutex mutex;
260 /* Guarded by mutex. */
261 struct rule_actions *actions;
263 struct list meter_list_node; /* In owning meter's 'rules' list. */
266 enum nx_flow_monitor_flags monitor_flags;
267 uint64_t add_seqno; /* Sequence number when added. */
268 uint64_t modify_seqno; /* Sequence number when changed. */
270 /* Optimisation for flow expiry. In ofproto's 'expirable' list if this
271 * rule is expirable, otherwise empty. */
272 struct list expirable OVS_GUARDED_BY(ofproto_mutex);
275 void ofproto_rule_ref(struct rule *);
276 void ofproto_rule_unref(struct rule *);
278 /* A set of actions within a "struct rule".
284 * A struct rule_actions 'actions' may be accessed without a risk of being
285 * freed by code that holds a read-lock or write-lock on 'rule->mutex' (where
286 * 'rule' is the rule for which 'rule->actions == actions') or that owns a
287 * reference to 'actions->ref_count' (or both). */
288 struct rule_actions {
289 atomic_uint ref_count;
291 /* These members are immutable: they do not change during the struct's
293 struct ofpact *ofpacts; /* Sequence of "struct ofpacts". */
294 unsigned int ofpacts_len; /* Size of 'ofpacts', in bytes. */
295 uint32_t meter_id; /* Non-zero OF meter_id, or zero. */
298 struct rule_actions *rule_actions_create(const struct ofpact *, size_t);
299 void rule_actions_ref(struct rule_actions *);
300 void rule_actions_unref(struct rule_actions *);
302 /* A set of rules to which an OpenFlow operation applies. */
303 struct rule_collection {
304 struct rule **rules; /* The rules. */
305 size_t n; /* Number of rules collected. */
307 size_t capacity; /* Number of rules that will fit in 'rules'. */
308 struct rule *stub[64]; /* Preallocated rules to avoid malloc(). */
311 void rule_collection_init(struct rule_collection *);
312 void rule_collection_add(struct rule_collection *, struct rule *);
313 void rule_collection_destroy(struct rule_collection *);
315 /* Threshold at which to begin flow table eviction. Only affects the
316 * ofproto-dpif implementation */
317 extern unsigned flow_eviction_threshold;
319 /* Number of upcall handler threads. Only affects the ofproto-dpif
321 extern unsigned n_handler_threads;
323 /* Determines which model to use for handling misses in the ofproto-dpif
325 extern enum ofproto_flow_miss_model flow_miss_model;
327 static inline struct rule *
328 rule_from_cls_rule(const struct cls_rule *cls_rule)
330 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
333 void ofproto_rule_expire(struct rule *rule, uint8_t reason);
334 void ofproto_rule_delete(struct ofproto *, struct classifier *cls,
335 struct rule *) OVS_REQ_WRLOCK(cls->rwlock);
336 void ofproto_rule_reduce_timeouts(struct rule *rule, uint16_t idle_timeout,
337 uint16_t hard_timeout)
338 OVS_EXCLUDED(ofproto_mutex, rule->mutex);
340 void ofoperation_complete(struct ofoperation *, enum ofperr);
342 bool ofoperation_has_out_port(const struct ofoperation *, ofp_port_t out_port);
344 /* ofproto class structure, to be defined by each ofproto implementation.
350 * These functions work primarily with three different kinds of data
353 * - "struct ofproto", which represents an OpenFlow switch.
355 * - "struct ofport", which represents a port within an ofproto.
357 * - "struct rule", which represents an OpenFlow flow within an ofproto.
359 * Each of these data structures contains all of the implementation-independent
360 * generic state for the respective concept, called the "base" state. None of
361 * them contains any extra space for ofproto implementations to use. Instead,
362 * each implementation is expected to declare its own data structure that
363 * contains an instance of the generic data structure plus additional
364 * implementation-specific members, called the "derived" state. The
365 * implementation can use casts or (preferably) the CONTAINER_OF macro to
366 * obtain access to derived state given only a pointer to the embedded generic
373 * Four stylized functions accompany each of these data structures:
375 * "alloc" "construct" "destruct" "dealloc"
376 * ------------ ---------------- --------------- --------------
377 * ofproto ->alloc ->construct ->destruct ->dealloc
378 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
379 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
381 * "ofproto" and "ofport" have this exact life cycle. The "rule" data
382 * structure also follow this life cycle with some additional elaborations
383 * described under "Rule Life Cycle" below.
385 * Any instance of a given data structure goes through the following life
388 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
389 * fails, skip all the other steps.
391 * 2. The client initializes all of the data structure's base state. If this
392 * fails, skip to step 7.
394 * 3. The client calls the "construct" function. The implementation
395 * initializes derived state. It may refer to the already-initialized
396 * base state. If "construct" fails, skip to step 6.
398 * 4. The data structure is now initialized and in use.
400 * 5. When the data structure is no longer needed, the client calls the
401 * "destruct" function. The implementation uninitializes derived state.
402 * The base state has not been uninitialized yet, so the implementation
403 * may still refer to it.
405 * 6. The client uninitializes all of the data structure's base state.
407 * 7. The client calls the "dealloc" to free the raw memory. The
408 * implementation must not refer to base or derived state in the data
409 * structure, because it has already been uninitialized.
411 * Each "alloc" function allocates and returns a new instance of the respective
412 * data structure. The "alloc" function is not given any information about the
413 * use of the new data structure, so it cannot perform much initialization.
414 * Its purpose is just to ensure that the new data structure has enough room
415 * for base and derived state. It may return a null pointer if memory is not
416 * available, in which case none of the other functions is called.
418 * Each "construct" function initializes derived state in its respective data
419 * structure. When "construct" is called, all of the base state has already
420 * been initialized, so the "construct" function may refer to it. The
421 * "construct" function is allowed to fail, in which case the client calls the
422 * "dealloc" function (but not the "destruct" function).
424 * Each "destruct" function uninitializes and frees derived state in its
425 * respective data structure. When "destruct" is called, the base state has
426 * not yet been uninitialized, so the "destruct" function may refer to it. The
427 * "destruct" function is not allowed to fail.
429 * Each "dealloc" function frees raw memory that was allocated by the the
430 * "alloc" function. The memory's base and derived members might not have ever
431 * been initialized (but if "construct" returned successfully, then it has been
432 * "destruct"ed already). The "dealloc" function is not allowed to fail.
438 * Most of these functions return 0 if they are successful or a positive error
439 * code on failure. Depending on the function, valid error codes are either
440 * errno values or OFPERR_* OpenFlow error codes.
442 * Most of these functions are expected to execute synchronously, that is, to
443 * block as necessary to obtain a result. Thus, these functions may return
444 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
445 * explicitly say those errors are a possibility. We may relax this
446 * requirement in the future if and when we encounter performance problems. */
447 struct ofproto_class {
448 /* ## ----------------- ## */
449 /* ## Factory Functions ## */
450 /* ## ----------------- ## */
452 /* Initializes provider. The caller may pass in 'iface_hints',
453 * which contains an shash of "struct iface_hint" elements indexed
454 * by the interface's name. The provider may use these hints to
455 * describe the startup configuration in order to reinitialize its
456 * state. The caller owns the provided data, so a provider must
457 * make copies of anything required. An ofproto provider must
458 * remove any existing state that is not described by the hint, and
459 * may choose to remove it all. */
460 void (*init)(const struct shash *iface_hints);
462 /* Enumerates the types of all support ofproto types into 'types'. The
463 * caller has already initialized 'types' and other ofproto classes might
464 * already have added names to it. */
465 void (*enumerate_types)(struct sset *types);
467 /* Enumerates the names of all existing datapath of the specified 'type'
468 * into 'names' 'all_dps'. The caller has already initialized 'names' as
471 * 'type' is one of the types enumerated by ->enumerate_types().
473 * Returns 0 if successful, otherwise a positive errno value.
475 int (*enumerate_names)(const char *type, struct sset *names);
477 /* Deletes the datapath with the specified 'type' and 'name'. The caller
478 * should have closed any open ofproto with this 'type' and 'name'; this
479 * function is allowed to fail if that is not the case.
481 * 'type' is one of the types enumerated by ->enumerate_types().
482 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
484 * Returns 0 if successful, otherwise a positive errno value.
486 int (*del)(const char *type, const char *name);
488 /* Returns the type to pass to netdev_open() when a datapath of type
489 * 'datapath_type' has a port of type 'port_type', for a few special
490 * cases when a netdev type differs from a port type. For example,
491 * when using the userspace datapath, a port of type "internal"
492 * needs to be opened as "tap".
494 * Returns either 'type' itself or a string literal, which must not
496 const char *(*port_open_type)(const char *datapath_type,
497 const char *port_type);
499 /* ## ------------------------ ## */
500 /* ## Top-Level type Functions ## */
501 /* ## ------------------------ ## */
503 /* Performs any periodic activity required on ofprotos of type
506 * An ofproto provider may implement it or not, depending on whether
507 * it needs type-level maintenance.
509 * Returns 0 if successful, otherwise a positive errno value. */
510 int (*type_run)(const char *type);
512 /* Performs periodic activity required on ofprotos of type 'type'
513 * that needs to be done with the least possible latency.
515 * This is run multiple times per main loop. An ofproto provider may
516 * implement it or not, according to whether it provides a performance
517 * boost for that ofproto implementation.
519 * Returns 0 if successful, otherwise a positive errno value. */
520 int (*type_run_fast)(const char *type);
522 /* Causes the poll loop to wake up when a type 'type''s 'run'
523 * function needs to be called, e.g. by calling the timer or fd
524 * waiting functions in poll-loop.h.
526 * An ofproto provider may implement it or not, depending on whether
527 * it needs type-level maintenance. */
528 void (*type_wait)(const char *type);
530 /* ## --------------------------- ## */
531 /* ## Top-Level ofproto Functions ## */
532 /* ## --------------------------- ## */
534 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
540 * ->construct() should not modify any base members of the ofproto. The
541 * client will initialize the ofproto's 'ports' and 'tables' members after
542 * construction is complete.
544 * When ->construct() is called, the client does not yet know how many flow
545 * tables the datapath supports, so ofproto->n_tables will be 0 and
546 * ofproto->tables will be NULL. ->construct() should call
547 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
548 * ofproto->tables. Each flow table will be initially empty, so
549 * ->construct() should delete flows from the underlying datapath, if
550 * necessary, rather than populating the tables.
552 * If the ofproto knows the maximum port number that the datapath can have,
553 * then it can call ofproto_init_max_ports(). If it does so, then the
554 * client will ensure that the actions it allows to be used through
555 * OpenFlow do not refer to ports above that maximum number.
557 * Only one ofproto instance needs to be supported for any given datapath.
558 * If a datapath is already open as part of one "ofproto", then another
559 * attempt to "construct" the same datapath as part of another ofproto is
560 * allowed to fail with an error.
562 * ->construct() returns 0 if successful, otherwise a positive errno
569 * If 'ofproto' has any pending asynchronous operations, ->destruct()
570 * must complete all of them by calling ofoperation_complete().
572 * ->destruct() must also destroy all remaining rules in the ofproto's
573 * tables, by passing each remaining rule to ofproto_rule_delete(), and
574 * then complete each of those deletions in turn by calling
575 * ofoperation_complete().
577 * (Thus, there is a multi-step process for any rule currently being
578 * inserted or modified at the beginning of destruction: first
579 * ofoperation_complete() that operation, then ofproto_rule_delete() the
580 * rule, then ofoperation_complete() the deletion operation.)
582 * The client will destroy the flow tables themselves after ->destruct()
585 struct ofproto *(*alloc)(void);
586 int (*construct)(struct ofproto *ofproto);
587 void (*destruct)(struct ofproto *ofproto);
588 void (*dealloc)(struct ofproto *ofproto);
590 /* Performs any periodic activity required by 'ofproto'. It should:
592 * - Call connmgr_send_packet_in() for each received packet that missed
593 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
596 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
597 * its hard_timeout or idle_timeout, to expire the flow.
599 * (But rules that are part of a pending operation, e.g. rules for
600 * which ->pending is true, may not expire.)
602 * Returns 0 if successful, otherwise a positive errno value. */
603 int (*run)(struct ofproto *ofproto);
605 /* Performs periodic activity required by 'ofproto' that needs to be done
606 * with the least possible latency.
608 * This is run multiple times per main loop. An ofproto provider may
609 * implement it or not, according to whether it provides a performance
610 * boost for that ofproto implementation. */
611 int (*run_fast)(struct ofproto *ofproto);
613 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
614 * be called, e.g. by calling the timer or fd waiting functions in
616 void (*wait)(struct ofproto *ofproto);
618 /* Adds some memory usage statistics for the implementation of 'ofproto'
619 * into 'usage', for use with memory_report().
621 * This function is optional. */
622 void (*get_memory_usage)(const struct ofproto *ofproto,
623 struct simap *usage);
625 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
626 * This function may prepare for that, for example by clearing state in
627 * advance. It should *not* actually delete any "struct rule"s from
628 * 'ofproto', only prepare for it.
630 * This function is optional; it's really just for optimization in case
631 * it's cheaper to delete all the flows from your hardware in a single pass
632 * than to do it one by one. */
633 void (*flush)(struct ofproto *ofproto);
635 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
637 * The implementation should store true in '*arp_match_ip' if the switch
638 * supports matching IP addresses inside ARP requests and replies, false
641 * The implementation should store in '*actions' a bitmap of the supported
642 * OpenFlow actions. Vendor actions are not included in '*actions'. */
643 void (*get_features)(struct ofproto *ofproto,
645 enum ofputil_action_bitmap *actions);
647 /* Helper for the OpenFlow OFPST_TABLE statistics request.
649 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
652 * - 'table_id' to the array index.
654 * - 'name' to "table#" where # is the table ID.
656 * - 'match' and 'wildcards' to OFPXMT12_MASK.
658 * - 'write_actions' and 'apply_actions' to OFPAT12_OUTPUT.
660 * - 'write_setfields' and 'apply_setfields' to OFPXMT12_MASK.
662 * - 'metadata_match' and 'metadata_write' to UINT64_MAX.
664 * - 'instructions' to OFPIT11_ALL.
666 * - 'config' to OFPTC11_TABLE_MISS_MASK.
668 * - 'max_entries' to 1,000,000.
670 * - 'active_count' to the classifier_count() for the table.
672 * - 'lookup_count' and 'matched_count' to 0.
674 * The implementation should update any members in each element for which
675 * it has better values:
677 * - 'name' to a more meaningful name.
679 * - 'wildcards' to the set of wildcards actually supported by the table
680 * (if it doesn't support all OpenFlow wildcards).
682 * - 'instructions' to set the instructions actually supported by
685 * - 'write_actions' to set the write actions actually supported by
686 * the table (if it doesn't support all OpenFlow actions).
688 * - 'apply_actions' to set the apply actions actually supported by
689 * the table (if it doesn't support all OpenFlow actions).
691 * - 'write_setfields' to set the write setfields actually supported by
694 * - 'apply_setfields' to set the apply setfields actually supported by
697 * - 'max_entries' to the maximum number of flows actually supported by
700 * - 'lookup_count' to the number of packets looked up in this flow table
703 * - 'matched_count' to the number of packets looked up in this flow
704 * table so far that matched one of the flow entries.
706 * All of the members of struct ofp12_table_stats are in network byte
709 void (*get_tables)(struct ofproto *ofproto, struct ofp12_table_stats *ots);
711 /* ## ---------------- ## */
712 /* ## ofport Functions ## */
713 /* ## ---------------- ## */
715 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
717 * ->port_construct() should not modify any base members of the ofport.
718 * An ofproto implementation should use the 'ofp_port' member of
719 * "struct ofport" as the OpenFlow port number.
721 * ofports are managed by the base ofproto code. The ofproto
722 * implementation should only create and destroy them in response to calls
723 * to these functions. The base ofproto code will create and destroy
724 * ofports in the following situations:
726 * - Just after the ->construct() function is called, the base ofproto
727 * iterates over all of the implementation's ports, using
728 * ->port_dump_start() and related functions, and constructs an ofport
729 * for each dumped port.
731 * - If ->port_poll() reports that a specific port has changed, then the
732 * base ofproto will query that port with ->port_query_by_name() and
733 * construct or destruct ofports as necessary to reflect the updated
736 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
737 * change, then the base ofproto will iterate over all of the
738 * implementation's ports, in the same way as at ofproto
739 * initialization, and construct and destruct ofports to reflect all of
742 * ->port_construct() returns 0 if successful, otherwise a positive errno
745 struct ofport *(*port_alloc)(void);
746 int (*port_construct)(struct ofport *ofport);
747 void (*port_destruct)(struct ofport *ofport);
748 void (*port_dealloc)(struct ofport *ofport);
750 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
751 * the ofproto implementation uses the ofport's netdev internally, then it
752 * should switch to using the new one. The old one has been closed.
754 * An ofproto implementation that doesn't need to do anything in this
755 * function may use a null pointer. */
756 void (*port_modified)(struct ofport *ofport);
758 /* Called after an OpenFlow request changes a port's configuration.
759 * 'ofport->pp.config' contains the new configuration. 'old_config'
760 * contains the previous configuration.
762 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
763 * turn NETDEV_UP on and off, so this function doesn't have to do anything
764 * for that bit (and it won't be called if that is the only bit that
766 void (*port_reconfigured)(struct ofport *ofport,
767 enum ofputil_port_config old_config);
769 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
770 * '*port' appropriately.
772 * The caller owns the data in 'port' and must free it with
773 * ofproto_port_destroy() when it is no longer needed. */
774 int (*port_query_by_name)(const struct ofproto *ofproto,
775 const char *devname, struct ofproto_port *port);
777 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
778 * successful, otherwise a positive errno value. The caller should
779 * inform the implementation of the OpenFlow port through the
780 * ->port_construct() method.
782 * It doesn't matter whether the new port will be returned by a later call
783 * to ->port_poll(); the implementation may do whatever is more
785 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
787 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
788 * 0 if successful, otherwise a positive errno value.
790 * It doesn't matter whether the new port will be returned by a later call
791 * to ->port_poll(); the implementation may do whatever is more
793 int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
796 int (*port_get_stats)(const struct ofport *port,
797 struct netdev_stats *stats);
799 /* Port iteration functions.
801 * The client might not be entirely in control of the ports within an
802 * ofproto. Some hardware implementations, for example, might have a fixed
803 * set of ports in a datapath. For this reason, the client needs a way to
804 * iterate through all the ports that are actually in a datapath. These
805 * functions provide that functionality.
807 * The 'state' pointer provides the implementation a place to
808 * keep track of its position. Its format is opaque to the caller.
810 * The ofproto provider retains ownership of the data that it stores into
811 * ->port_dump_next()'s 'port' argument. The data must remain valid until
812 * at least the next call to ->port_dump_next() or ->port_dump_done() for
813 * 'state'. The caller will not modify or free it.
818 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
819 * On success, it should return 0 and initialize '*statep' with any data
820 * needed for iteration. On failure, returns a positive errno value, and
821 * the client will not call ->port_dump_next() or ->port_dump_done().
823 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
824 * 'state'. If there is another port, it should store the port's
825 * information into 'port' and return 0. It should return EOF if all ports
826 * have already been iterated. Otherwise, on error, it should return a
827 * positive errno value. This function will not be called again once it
828 * returns nonzero once for a given iteration (but the 'port_dump_done'
829 * function will be called afterward).
831 * ->port_dump_done() allows the implementation to release resources used
832 * for iteration. The caller might decide to stop iteration in the middle
833 * by calling this function before ->port_dump_next() returns nonzero.
841 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
844 * struct ofproto_port port;
846 * error = ofproto->ofproto_class->port_dump_next(
847 * ofproto, state, &port);
851 * // Do something with 'port' here (without modifying or freeing
852 * // any of its data).
854 * ofproto->ofproto_class->port_dump_done(ofproto, state);
856 * // 'error' is now EOF (success) or a positive errno value (failure).
858 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
859 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
860 struct ofproto_port *port);
861 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
863 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
864 * in 'ofproto' has changed, then this function should do one of the
867 * - Preferably: store the name of the device that was added to or deleted
868 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
869 * for freeing '*devnamep' (with free()) when it no longer needs it.
871 * - Alternatively: return ENOBUFS, without indicating the device that was
874 * Occasional 'false positives', in which the function returns 0 while
875 * indicating a device that was not actually added or deleted or returns
876 * ENOBUFS without any change, are acceptable.
878 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
879 * externally to the 'ofproto' object, e.g. by a system administrator via
880 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
881 * not report changes made through calls to 'port_add' or 'port_del' on the
882 * same 'ofproto' object. (But it's OK for it to report them too, just
883 * slightly less efficient.)
885 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
886 * also return other positive errno values to indicate that something has
889 * If the set of ports in a datapath is fixed, or if the only way that the
890 * set of ports in a datapath can change is through ->port_add() and
891 * ->port_del(), then this function may be a null pointer.
893 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
895 /* Arranges for the poll loop to wake up when ->port_poll() will return a
896 * value other than EAGAIN.
898 * If the set of ports in a datapath is fixed, or if the only way that the
899 * set of ports in a datapath can change is through ->port_add() and
900 * ->port_del(), or if the poll loop will always wake up anyway when
901 * ->port_poll() will return a value other than EAGAIN, then this function
902 * may be a null pointer.
904 void (*port_poll_wait)(const struct ofproto *ofproto);
906 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
907 * partner information for 'port' is up-to-date, 0 if LACP partner
908 * information is not current (generally indicating a connectivity
909 * problem), or -1 if LACP is not enabled on 'port'.
911 * This function may be a null pointer if the ofproto implementation does
912 * not support LACP. */
913 int (*port_is_lacp_current)(const struct ofport *port);
915 /* ## ----------------------- ## */
916 /* ## OpenFlow Rule Functions ## */
917 /* ## ----------------------- ## */
919 /* Chooses an appropriate table for 'match' within 'ofproto'. On
920 * success, stores the table ID into '*table_idp' and returns 0. On
921 * failure, returns an OpenFlow error code.
923 * The choice of table should be a function of 'match' and 'ofproto''s
924 * datapath capabilities. It should not depend on the flows already in
925 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
926 * 'match' as its matching condition can never be inserted into 'ofproto',
927 * even starting from an empty flow table.
929 * If multiple tables are candidates for inserting the flow, the function
930 * should choose one arbitrarily (but deterministically).
932 * If this function is NULL then table 0 is always chosen. */
933 enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
934 const struct match *match,
937 /* Life-cycle functions for a "struct rule".
943 * The life cycle of a struct rule is an elaboration of the basic life
944 * cycle described above under "Life Cycle".
946 * After a rule is successfully constructed, it is then inserted. If
947 * insertion completes successfully, then before it is later destructed, it
950 * You can think of a rule as having the following extra steps inserted
951 * between "Life Cycle" steps 4 and 5:
953 * 4.1. The client inserts the rule into the flow table, making it
954 * visible in flow table lookups.
956 * 4.2. The client calls "rule_insert". Immediately or eventually, the
957 * implementation calls ofoperation_complete() to indicate that the
958 * insertion completed. If the operation failed, skip to step 5.
960 * 4.3. The rule is now installed in the flow table. Eventually it will
963 * 4.4. The client removes the rule from the flow table. It is no longer
964 * visible in flow table lookups.
966 * 4.5. The client calls "rule_delete". Immediately or eventually, the
967 * implementation calls ofoperation_complete() to indicate that the
968 * deletion completed. Deletion is not allowed to fail, so it must
972 * Asynchronous Operation Support
973 * ==============================
975 * The "insert" and "delete" life-cycle operations on rules can operate
976 * asynchronously, meaning that ->rule_insert() and ->rule_delete() only
977 * need to initiate their respective operations and do not need to wait for
978 * them to complete before they return. ->rule_modify_actions() also
979 * operates asynchronously.
981 * An ofproto implementation reports the success or failure of an
982 * asynchronous operation on a rule using the rule's 'pending' member,
983 * which points to a opaque "struct ofoperation" that represents the
984 * ongoing operation. When the operation completes, the ofproto
985 * implementation calls ofoperation_complete(), passing the ofoperation and
986 * an error indication.
988 * Only the following contexts may call ofoperation_complete():
990 * - The function called to initiate the operation, e.g. ->rule_insert()
991 * or ->rule_delete(). This is the best choice if the operation
994 * - The implementation's ->run() function.
996 * - The implementation's ->destruct() function.
998 * The ofproto base code updates the flow table optimistically, assuming
999 * that the operation will probably succeed:
1001 * - ofproto adds the rule in the flow table before calling
1004 * - ofproto updates the rule's actions and other properties before
1005 * calling ->rule_modify_actions().
1007 * - ofproto removes the rule before calling ->rule_delete().
1009 * With one exception, when an asynchronous operation completes with an
1010 * error, ofoperation_complete() backs out the already applied changes:
1012 * - If adding a rule in the flow table fails, ofproto removes the new
1015 * - If modifying a rule fails, ofproto restores the original actions
1016 * (and other properties).
1018 * - Removing a rule is not allowed to fail. It must always succeed.
1020 * The ofproto base code serializes operations: if any operation is in
1021 * progress on a given rule, ofproto postpones initiating any new operation
1022 * on that rule until the pending operation completes. Therefore, every
1023 * operation must eventually complete through a call to
1024 * ofoperation_complete() to avoid delaying new operations indefinitely
1025 * (including any OpenFlow request that affects the rule in question, even
1026 * just to query its statistics).
1032 * When ->rule_construct() is called, 'rule' is a new rule that is not yet
1033 * inserted into a flow table. ->rule_construct() should initialize enough
1034 * of the rule's derived state for 'rule' to be suitable for inserting into
1035 * a flow table. ->rule_construct() should not modify any base members of
1038 * If ->rule_construct() fails (as indicated by returning a nonzero
1039 * OpenFlow error code), the ofproto base code will uninitialize and
1040 * deallocate 'rule'. See "Rule Life Cycle" above for more details.
1042 * ->rule_construct() may also:
1044 * - Validate that the datapath supports the matching rule in 'rule->cr'
1045 * datapath. For example, if the rule's table does not support
1046 * registers, then it is an error if 'rule->cr' does not wildcard all
1049 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
1051 * Some implementations might need to defer these tasks to ->rule_insert(),
1052 * which is also acceptable.
1058 * Following successful construction, the ofproto base case inserts 'rule'
1059 * into its flow table, then it calls ->rule_insert(). ->rule_insert()
1060 * should set in motion adding the new rule to the datapath flow table. It
1061 * must act as follows:
1063 * - If it completes insertion, either by succeeding or failing, it must
1064 * call ofoperation_complete()
1066 * - If insertion is only partially complete, then it must return without
1067 * calling ofoperation_complete(). Later, when the insertion is
1068 * complete, the ->run() or ->destruct() function must call
1069 * ofoperation_complete() to report success or failure.
1071 * If ->rule_insert() fails, the ofproto base code will remove 'rule' from
1072 * the flow table, destruct, uninitialize, and deallocate 'rule'. See
1073 * "Rule Life Cycle" above for more details.
1079 * The ofproto base code removes 'rule' from its flow table before it calls
1080 * ->rule_delete(). ->rule_delete() should set in motion removing 'rule'
1081 * from the datapath flow table. It must act as follows:
1083 * - If it completes deletion, it must call ofoperation_complete().
1085 * - If deletion is only partially complete, then it must return without
1086 * calling ofoperation_complete(). Later, when the deletion is
1087 * complete, the ->run() or ->destruct() function must call
1088 * ofoperation_complete().
1090 * Rule deletion must not fail.
1096 * ->rule_destruct() must uninitialize derived state.
1098 * Rule destruction must not fail. */
1099 struct rule *(*rule_alloc)(void);
1100 enum ofperr (*rule_construct)(struct rule *rule);
1101 void (*rule_insert)(struct rule *rule);
1102 void (*rule_delete)(struct rule *rule);
1103 void (*rule_destruct)(struct rule *rule);
1104 void (*rule_dealloc)(struct rule *rule);
1106 /* Obtains statistics for 'rule', storing the number of packets that have
1107 * matched it in '*packet_count' and the number of bytes in those packets
1108 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
1109 * count is unknown. */
1110 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
1111 uint64_t *byte_count);
1113 /* Applies the actions in 'rule' to 'packet'. (This implements sending
1114 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1116 * Takes ownership of 'packet' (so it should eventually free it, with
1119 * 'flow' reflects the flow information for 'packet'. All of the
1120 * information in 'flow' is extracted from 'packet', except for
1121 * flow->tunnel and flow->in_port, which are assigned the correct values
1122 * for the incoming packet. The register values are zeroed. 'packet''s
1123 * header pointers (e.g. packet->l3) are appropriately initialized.
1124 * packet->l3 is aligned on a 32-bit boundary.
1126 * The implementation should add the statistics for 'packet' into 'rule'.
1128 * Returns 0 if successful, otherwise an OpenFlow error code. */
1129 enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1130 struct ofpbuf *packet);
1132 /* When ->rule_modify_actions() is called, the caller has already replaced
1133 * the OpenFlow actions in 'rule' by a new set. (The original actions are
1134 * in rule->pending->actions.)
1136 * ->rule_modify_actions() should set the following in motion:
1138 * - Validate that the datapath can correctly implement the actions now
1141 * - Update the datapath flow table with the new actions.
1143 * - Only if 'reset_counters' is true, reset any packet or byte counters
1144 * associated with the rule to zero, so that rule_get_stats() will not
1145 * longer count those packets or bytes.
1147 * If the operation synchronously completes, ->rule_modify_actions() may
1148 * call ofoperation_complete() before it returns. Otherwise, ->run()
1149 * should call ofoperation_complete() later, after the operation does
1152 * If the operation fails, then the base ofproto code will restore the
1153 * original 'actions' and 'n_actions' of 'rule'.
1155 * ->rule_modify_actions() should not modify any base members of struct
1157 void (*rule_modify_actions)(struct rule *rule, bool reset_counters);
1159 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1160 * which takes one of the following values, with the corresponding
1163 * - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1164 * as other packets, omitting TCP and UDP port numbers (always setting
1167 * - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1168 * passing them through the flow table.
1170 * - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1171 * passing packets through the flow table.
1173 * - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1174 * except that TCP and UDP port numbers should be included in fragments
1177 * Implementations are not required to support every mode.
1178 * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1180 * At the time of the call to ->set_frag_handling(), the current mode is
1181 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1182 * true if the requested mode was set, false if it is not supported.
1184 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1185 * reflect the new mode.
1187 bool (*set_frag_handling)(struct ofproto *ofproto,
1188 enum ofp_config_flags frag_handling);
1190 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1191 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1193 * The caller retains ownership of 'packet' and of 'ofpacts', so
1194 * ->packet_out() should not modify or free them.
1196 * This function must validate that it can correctly implement 'ofpacts'.
1197 * If not, then it should return an OpenFlow error code.
1199 * 'flow' reflects the flow information for 'packet'. All of the
1200 * information in 'flow' is extracted from 'packet', except for
1201 * flow->in_port (see below). flow->tunnel and its register values are
1204 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1205 * implementation should reject invalid flow->in_port values by returning
1206 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1207 * ofproto_init_max_ports(), then the client will reject these ports
1208 * itself.) For consistency, the implementation should consider valid for
1209 * flow->in_port any value that could possibly be seen in a packet that it
1210 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1211 * that never generates packet-ins (e.g. due to hardware limitations)
1212 * should still allow flow->in_port values for every possible physical port
1213 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1214 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1215 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1216 * these, treating each of them as packets generated by the controller as
1217 * opposed to packets originating from some switch port.
1219 * (Ordinarily the only effect of flow->in_port is on output actions that
1220 * involve the input port, such as actions that output to OFPP_IN_PORT,
1221 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1222 * "resubmit" actions.)
1224 * 'packet' is not matched against the OpenFlow flow table, so its
1225 * statistics should not be included in OpenFlow flow statistics.
1227 * Returns 0 if successful, otherwise an OpenFlow error code. */
1228 enum ofperr (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
1229 const struct flow *flow,
1230 const struct ofpact *ofpacts,
1231 size_t ofpacts_len);
1233 /* ## ------------------------- ## */
1234 /* ## OFPP_NORMAL configuration ## */
1235 /* ## ------------------------- ## */
1237 /* Configures NetFlow on 'ofproto' according to the options in
1238 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1240 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1241 * NetFlow, as does a null pointer. */
1242 int (*set_netflow)(struct ofproto *ofproto,
1243 const struct netflow_options *netflow_options);
1245 void (*get_netflow_ids)(const struct ofproto *ofproto,
1246 uint8_t *engine_type, uint8_t *engine_id);
1248 /* Configures sFlow on 'ofproto' according to the options in
1249 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1251 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1252 * sFlow, as does a null pointer. */
1253 int (*set_sflow)(struct ofproto *ofproto,
1254 const struct ofproto_sflow_options *sflow_options);
1256 /* Configures IPFIX on 'ofproto' according to the options in
1257 * 'bridge_exporter_options' and the 'flow_exporters_options'
1258 * array, or turns off IPFIX if 'bridge_exporter_options' and
1259 * 'flow_exporters_options' is NULL.
1261 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1262 * IPFIX, as does a null pointer. */
1264 struct ofproto *ofproto,
1265 const struct ofproto_ipfix_bridge_exporter_options
1266 *bridge_exporter_options,
1267 const struct ofproto_ipfix_flow_exporter_options
1268 *flow_exporters_options, size_t n_flow_exporters_options);
1270 /* Configures connectivity fault management on 'ofport'.
1272 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1274 * If 'cfm_settings' is null, removes any connectivity fault management
1275 * configuration from 'ofport'.
1277 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1278 * support CFM, as does a null pointer. */
1279 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1281 /* Checks the status of CFM configured on 'ofport'. Returns true if the
1282 * port's CFM status was successfully stored into '*status'. Returns false
1283 * if the port did not have CFM configured, in which case '*status' is
1286 * The caller must provide and owns '*status', but it does not own and must
1287 * not modify or free the array returned in 'status->rmps'. */
1288 bool (*get_cfm_status)(const struct ofport *ofport,
1289 struct ofproto_cfm_status *status);
1291 /* Configures BFD on 'ofport'.
1293 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1294 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1295 * according to 'cfg'.
1297 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1298 * support BFD, as does a null pointer. */
1299 int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1301 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1302 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1303 * that this ofproto_class does not support BFD, as does a null pointer. */
1304 int (*get_bfd_status)(struct ofport *ofport, struct smap *smap);
1306 /* Configures spanning tree protocol (STP) on 'ofproto' using the
1307 * settings defined in 's'.
1309 * If 's' is nonnull, configures STP according to its members.
1311 * If 's' is null, removes any STP configuration from 'ofproto'.
1313 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1314 * support STP, as does a null pointer. */
1315 int (*set_stp)(struct ofproto *ofproto,
1316 const struct ofproto_stp_settings *s);
1318 /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1320 * Stores STP state for 'ofproto' in 's'. If the 'enabled' member
1321 * is false, the other member values are not meaningful.
1323 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1324 * support STP, as does a null pointer. */
1325 int (*get_stp_status)(struct ofproto *ofproto,
1326 struct ofproto_stp_status *s);
1328 /* Configures spanning tree protocol (STP) on 'ofport' using the
1329 * settings defined in 's'.
1331 * If 's' is nonnull, configures STP according to its members. The
1332 * caller is responsible for assigning STP port numbers (using the
1333 * 'port_num' member in the range of 1 through 255, inclusive) and
1334 * ensuring there are no duplicates.
1336 * If 's' is null, removes any STP configuration from 'ofport'.
1338 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1339 * support STP, as does a null pointer. */
1340 int (*set_stp_port)(struct ofport *ofport,
1341 const struct ofproto_port_stp_settings *s);
1343 /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1345 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1346 * false, the other member values are not meaningful.
1348 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1349 * support STP, as does a null pointer. */
1350 int (*get_stp_port_status)(struct ofport *ofport,
1351 struct ofproto_port_stp_status *s);
1353 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1354 * 'queues' attached to 'ofport'. This data is not intended to be
1355 * sufficient to implement QoS. Instead, providers may use this
1356 * information to implement features which require knowledge of what queues
1357 * exist on a port, and some basic information about them.
1359 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1360 * support QoS, as does a null pointer. */
1361 int (*set_queues)(struct ofport *ofport,
1362 const struct ofproto_port_queue *queues, size_t n_qdscp);
1364 /* If 's' is nonnull, this function registers a "bundle" associated with
1365 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
1366 * a Port in OVSDB, that is, it consists of one or more "slave" devices
1367 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1368 * there is more than one slave, a bonding configuration. If 'aux' is
1369 * already registered then this function updates its configuration to 's'.
1370 * Otherwise, this function registers a new bundle.
1372 * If 's' is NULL, this function unregisters the bundle registered on
1373 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
1374 * has been registered, this has no effect.
1376 * This function affects only the behavior of the NXAST_AUTOPATH action and
1377 * output to the OFPP_NORMAL port. An implementation that does not support
1378 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
1379 * that supports only a subset of the functionality should implement what
1380 * it can and return 0. */
1381 int (*bundle_set)(struct ofproto *ofproto, void *aux,
1382 const struct ofproto_bundle_settings *s);
1384 /* If 'port' is part of any bundle, removes it from that bundle. If the
1385 * bundle now has no ports, deletes the bundle. If the bundle now has only
1386 * one port, deconfigures the bundle's bonding configuration. */
1387 void (*bundle_remove)(struct ofport *ofport);
1389 /* If 's' is nonnull, this function registers a mirror associated with
1390 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
1391 * a Mirror in OVSDB. If 'aux' is already registered then this function
1392 * updates its configuration to 's'. Otherwise, this function registers a
1395 * If 's' is NULL, this function unregisters the mirror registered on
1396 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
1397 * has been registered, this has no effect.
1399 * An implementation that does not support mirroring at all may set
1400 * it to NULL or return EOPNOTSUPP. An implementation that supports
1401 * only a subset of the functionality should implement what it can
1403 int (*mirror_set)(struct ofproto *ofproto, void *aux,
1404 const struct ofproto_mirror_settings *s);
1406 /* Retrieves statistics from mirror associated with client data
1407 * pointer 'aux' in 'ofproto'. Stores packet and byte counts in
1408 * 'packets' and 'bytes', respectively. If a particular counter is
1409 * not supported, the appropriate argument is set to UINT64_MAX.
1411 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1412 * support retrieving mirror statistics. */
1413 int (*mirror_get_stats)(struct ofproto *ofproto, void *aux,
1414 uint64_t *packets, uint64_t *bytes);
1416 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1417 * on which all packets are flooded, instead of using MAC learning. If
1418 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1420 * This function affects only the behavior of the OFPP_NORMAL action. An
1421 * implementation that does not support it may set it to NULL or return
1423 int (*set_flood_vlans)(struct ofproto *ofproto,
1424 unsigned long *flood_vlans);
1426 /* Returns true if 'aux' is a registered bundle that is currently in use as
1427 * the output for a mirror. */
1428 bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1430 /* When the configuration option of forward_bpdu changes, this function
1431 * will be invoked. */
1432 void (*forward_bpdu_changed)(struct ofproto *ofproto);
1434 /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1435 * seconds, and the maximum number of MAC table entries to
1438 * An implementation that doesn't support configuring these features may
1439 * set this function to NULL or implement it as a no-op. */
1440 void (*set_mac_table_config)(struct ofproto *ofproto,
1441 unsigned int idle_time, size_t max_entries);
1443 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1445 * This is deprecated. It is only for compatibility with broken device drivers
1446 * in old versions of Linux that do not properly support VLANs when VLAN
1447 * devices are not used. When broken device drivers are no longer in
1448 * widespread use, we will delete these interfaces. */
1450 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1451 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1452 * that has OpenFlow port number 'realdev_ofp_port'.
1454 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1455 * as a VLAN splinter port.
1457 * This function should be NULL if an implementation does not support it.
1459 int (*set_realdev)(struct ofport *ofport,
1460 ofp_port_t realdev_ofp_port, int vid);
1462 /* ## ------------------------ ## */
1463 /* ## OpenFlow meter functions ## */
1464 /* ## ------------------------ ## */
1466 /* These functions should be NULL if an implementation does not support
1467 * them. They must be all null or all non-null.. */
1469 /* Initializes 'features' to describe the metering features supported by
1471 void (*meter_get_features)(const struct ofproto *ofproto,
1472 struct ofputil_meter_features *features);
1474 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1475 * success the function must store a provider meter ID other than
1476 * UINT32_MAX in '*id'. All further references to the meter will be made
1477 * with the returned provider meter id rather than the OpenFlow meter id.
1478 * The caller does not try to interpret the provider meter id, giving the
1479 * implementation the freedom to either use the OpenFlow meter_id value
1480 * provided in the meter configuration, or any other value suitable for the
1483 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1484 * with that meter provider ID to have configuration 'config'. On failure,
1485 * the existing meter configuration is left intact. Regardless of success,
1486 * any change to '*id' updates the provider meter id used for this
1488 enum ofperr (*meter_set)(struct ofproto *ofproto, ofproto_meter_id *id,
1489 const struct ofputil_meter_config *config);
1491 /* Gets the meter and meter band packet and byte counts for maximum of
1492 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1493 * 'ofproto'. The caller fills in the other stats values. The band stats
1494 * are copied to memory at 'stats->bands' provided by the caller. The
1495 * number of returned band stats is returned in 'stats->n_bands'. */
1496 enum ofperr (*meter_get)(const struct ofproto *ofproto,
1497 ofproto_meter_id id,
1498 struct ofputil_meter_stats *stats);
1500 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1502 void (*meter_del)(struct ofproto *, ofproto_meter_id);
1505 extern const struct ofproto_class ofproto_dpif_class;
1507 int ofproto_class_register(const struct ofproto_class *);
1508 int ofproto_class_unregister(const struct ofproto_class *);
1510 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
1511 * because it overlaps with an ongoing flow table operation that has not yet
1512 * completed. The caller should retry the operation later.
1514 * ofproto.c also uses this value internally for additional (similar) purposes.
1516 * This particular value is a good choice because it is large, so that it does
1517 * not collide with any errno value, but not large enough to collide with an
1518 * OFPERR_* value. */
1519 enum { OFPROTO_POSTPONE = 1 << 16 };
1520 BUILD_ASSERT_DECL(OFPROTO_POSTPONE < OFPERR_OFS);
1522 int ofproto_flow_mod(struct ofproto *, struct ofputil_flow_mod *);
1523 void ofproto_add_flow(struct ofproto *, const struct match *,
1524 unsigned int priority,
1525 const struct ofpact *ofpacts, size_t ofpacts_len);
1526 bool ofproto_delete_flow(struct ofproto *,
1527 const struct match *, unsigned int priority);
1528 void ofproto_flush_flows(struct ofproto *);
1530 #endif /* ofproto/ofproto-provider.h */