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"
27 #include "ofp-errors.h"
29 #include "ofproto/ofproto.h"
30 #include "ovs-thread.h"
37 struct ofputil_flow_mod;
41 /* An OpenFlow switch.
43 * With few exceptions, ofproto implementations may look at these fields but
44 * should not modify them. */
46 struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
47 const struct ofproto_class *ofproto_class;
48 char *type; /* Datapath type. */
49 char *name; /* Datapath name. */
52 uint64_t fallback_dpid; /* Datapath ID if no better choice found. */
53 uint64_t datapath_id; /* Datapath ID. */
54 bool forward_bpdu; /* Option to allow forwarding of BPDU frames
55 * when NORMAL action is invoked. */
56 char *mfr_desc; /* Manufacturer (NULL for default)b. */
57 char *hw_desc; /* Hardware (NULL for default). */
58 char *sw_desc; /* Software version (NULL for default). */
59 char *serial_desc; /* Serial number (NULL for default). */
60 char *dp_desc; /* Datapath description (NULL for default). */
61 enum ofp_config_flags frag_handling; /* One of OFPC_*. */
64 struct hmap ports; /* Contains "struct ofport"s. */
65 struct shash port_by_name;
66 unsigned long *ofp_port_ids;/* Bitmap of used OpenFlow port numbers. */
67 struct simap ofp_requests; /* OpenFlow port number requests. */
68 uint16_t alloc_port_no; /* Last allocated OpenFlow port number. */
69 uint16_t max_ports; /* Max possible OpenFlow port num, plus one. */
72 struct oftable *tables;
75 struct hindex cookies; /* Rules indexed on their cookie values. */
77 /* Optimisation for flow expiry.
78 * These flows should all be present in tables. */
79 struct ovs_mutex expirable_mutex;
80 struct list expirable OVS_GUARDED; /* Expirable 'struct rule"s in all
84 * OpenFlow meters start at 1. To avoid confusion we leave the first
85 * pointer in the array un-used, and index directly with the OpenFlow
87 struct ofputil_meter_features meter_features;
88 struct meter **meters; /* 'meter_features.max_meter' + 1 pointers. */
90 /* OpenFlow connections. */
91 struct connmgr *connmgr;
93 /* Flow table operation tracking. */
94 int state; /* Internal state. */
95 struct list pending; /* List of "struct ofopgroup"s. */
96 unsigned int n_pending; /* list_size(&pending). */
97 struct hmap deletions; /* All OFOPERATION_DELETE "ofoperation"s. */
99 /* Flow table operation logging. */
100 int n_add, n_delete, n_modify; /* Number of unreported ops of each kind. */
101 long long int first_op, last_op; /* Range of times for unreported ops. */
102 long long int next_op_report; /* Time to report ops, or LLONG_MAX. */
103 long long int op_backoff; /* Earliest time to report ops again. */
105 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
107 * This is deprecated. It is only for compatibility with broken device
108 * drivers in old versions of Linux that do not properly support VLANs when
109 * VLAN devices are not used. When broken device drivers are no longer in
110 * widespread use, we will delete these interfaces. */
111 unsigned long int *vlan_bitmap; /* 4096-bit bitmap of in-use VLANs. */
112 bool vlans_changed; /* True if new VLANs are in use. */
113 int min_mtu; /* Current MTU of non-internal ports. */
116 struct ovs_rwlock groups_rwlock;
117 struct hmap groups OVS_GUARDED; /* Contains "struct ofgroup"s. */
118 uint32_t n_groups[4] OVS_GUARDED; /* # of existing groups of each type. */
119 struct ofputil_group_features ogf;
122 void ofproto_init_tables(struct ofproto *, int n_tables);
123 void ofproto_init_max_ports(struct ofproto *, uint16_t max_ports);
125 struct ofproto *ofproto_lookup(const char *name);
126 struct ofport *ofproto_get_port(const struct ofproto *, ofp_port_t ofp_port);
128 /* An OpenFlow port within a "struct ofproto".
130 * With few exceptions, ofproto implementations may look at these fields but
131 * should not modify them. */
133 struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
134 struct ofproto *ofproto; /* The ofproto that contains this port. */
135 struct netdev *netdev;
136 struct ofputil_phy_port pp;
137 ofp_port_t ofp_port; /* OpenFlow port number. */
138 unsigned int change_seq;
139 long long int created; /* Time created, in msec. */
143 void ofproto_port_set_state(struct ofport *, enum ofputil_port_state);
145 /* OpenFlow table flags:
147 * - "Hidden" tables are not included in OpenFlow operations that operate on
148 * "all tables". For example, a request for flow stats on all tables will
149 * omit flows in hidden tables, table stats requests will omit the table
150 * entirely, and the switch features reply will not count the hidden table.
152 * However, operations that specifically name the particular table still
153 * operate on it. For example, flow_mods and flow stats requests on a
156 * To avoid gaps in table IDs (which have unclear validity in OpenFlow),
157 * hidden tables must be the highest-numbered tables that a provider
160 * - "Read-only" tables can't be changed through OpenFlow operations. (At
161 * the moment all flow table operations go effectively through OpenFlow, so
162 * this means that read-only tables can't be changed at all after the
163 * read-only flag is set.)
165 * The generic ofproto layer never sets these flags. An ofproto provider can
166 * set them if it is appropriate.
169 OFTABLE_HIDDEN = 1 << 0, /* Hide from most OpenFlow operations. */
170 OFTABLE_READONLY = 1 << 1 /* Don't allow OpenFlow to change this table. */
173 /* A flow table within a "struct ofproto". */
175 enum oftable_flags flags;
176 struct classifier cls; /* Contains "struct rule"s. */
177 char *name; /* Table name exposed via OpenFlow, or NULL. */
179 /* Maximum number of flows or UINT_MAX if there is no limit besides any
180 * limit imposed by resource limitations. */
181 unsigned int max_flows;
183 /* These members determine the handling of an attempt to add a flow that
184 * would cause the table to have more than 'max_flows' flows.
186 * If 'eviction_fields' is NULL, overflows will be rejected with an error.
188 * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
189 * is nonzero), an overflow will cause a flow to be removed. The flow to
190 * be removed is chosen to give fairness among groups distinguished by
191 * different values for the subfields within 'groups'. */
192 struct mf_subfield *eviction_fields;
193 size_t n_eviction_fields;
197 * When a flow is added that would cause the table to have more than
198 * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
199 * used to decide which rule to evict: the rule is chosen from the eviction
200 * group that contains the greatest number of rules.*/
201 uint32_t eviction_group_id_basis;
202 struct hmap eviction_groups_by_id;
203 struct heap eviction_groups_by_size;
206 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
208 * All parameters are evaluated multiple times. */
209 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO) \
210 for ((TABLE) = (OFPROTO)->tables; \
211 (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
214 /* An OpenFlow flow within a "struct ofproto".
216 * With few exceptions, ofproto implementations may look at these fields but
217 * should not modify them. */
219 struct list ofproto_node; /* Owned by ofproto base code. */
220 struct ofproto *ofproto; /* The ofproto that contains this rule. */
221 struct cls_rule cr; /* In owning ofproto's classifier. */
223 struct ofoperation *pending; /* Operation now in progress, if nonnull. */
225 ovs_be64 flow_cookie; /* Controller-issued identifier. */
226 struct hindex_node cookie_node; /* In owning ofproto's 'cookies' index. */
228 long long int created; /* Creation time. */
229 long long int modified; /* Time of last modification. */
230 long long int used; /* Last use; time created if never used. */
231 uint8_t table_id; /* Index in ofproto's 'tables' array. */
232 bool send_flow_removed; /* Send a flow removed message? */
234 struct ovs_mutex timeout_mutex;
235 uint16_t hard_timeout OVS_GUARDED; /* In seconds from ->modified. */
236 uint16_t idle_timeout OVS_GUARDED; /* In seconds from ->used. */
238 /* Eviction groups. */
239 struct heap_node evg_node; /* In eviction_group's "rules" heap. */
240 struct eviction_group *eviction_group; /* NULL if not in any group. */
242 /* The evict lock is used to prevent rules from being evicted while child
243 * threads are using them to xlate flows. A read lock means the rule is
244 * currently being used. A write lock means the rule is in the process of
245 * being evicted and should be considered gone. A rule will not be evicted
246 * unless both its own and its classifiers write locks are held.
247 * Therefore, while holding a classifier readlock, one can be assured that
248 * even write locked rules are safe. */
249 struct ovs_rwlock evict;
251 struct ofpact *ofpacts; /* Sequence of "struct ofpacts". */
252 unsigned int ofpacts_len; /* Size of 'ofpacts', in bytes. */
254 uint32_t meter_id; /* Non-zero OF meter_id, or zero. */
255 struct list meter_list_node; /* In owning meter's 'rules' list. */
258 enum nx_flow_monitor_flags monitor_flags;
259 uint64_t add_seqno; /* Sequence number when added. */
260 uint64_t modify_seqno; /* Sequence number when changed. */
262 /* Optimisation for flow expiry. */
263 struct list expirable; /* In ofproto's 'expirable' list if this rule
264 * is expirable, otherwise empty. */
267 /* Threshold at which to begin flow table eviction. Only affects the
268 * ofproto-dpif implementation */
269 extern unsigned flow_eviction_threshold;
271 /* Number of upcall handler threads. Only affects the ofproto-dpif
273 extern unsigned n_handler_threads;
275 /* Determines which model to use for handling misses in the ofproto-dpif
277 extern enum ofproto_flow_miss_model flow_miss_model;
279 static inline struct rule *
280 rule_from_cls_rule(const struct cls_rule *cls_rule)
282 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
285 void ofproto_rule_update_used(struct rule *, long long int used);
286 void ofproto_rule_expire(struct rule *rule, uint8_t reason);
287 void ofproto_rule_delete(struct ofproto *, struct classifier *cls,
288 struct rule *) OVS_REQ_WRLOCK(cls->rwlock);
289 void ofproto_rule_reduce_timeouts(struct rule *rule, uint16_t idle_timeout,
290 uint16_t hard_timeout)
291 OVS_EXCLUDED(rule->ofproto->expirable_mutex, rule->timeout_mutex);
293 bool ofproto_rule_has_out_port(const struct rule *, ofp_port_t out_port);
295 void ofoperation_complete(struct ofoperation *, enum ofperr);
297 bool ofoperation_has_out_port(const struct ofoperation *, ofp_port_t out_port);
298 bool ofproto_rule_has_out_group(const struct rule *, uint32_t group_id);
300 bool ofproto_rule_is_hidden(const struct rule *);
302 /* A group within a "struct ofproto".
304 * With few exceptions, ofproto implementations may look at these fields but
305 * should not modify them. */
307 /* The rwlock is used to prevent groups from being deleted while child
308 * threads are using them to xlate flows. A read lock means the
309 * group is currently being used. A write lock means the group is
310 * in the process of being deleted or updated. Note that since
311 * a read lock on the groups container is held while searching, and
312 * a group is ever write locked only while holding a write lock
313 * on the container, the user's of groups will never face a group
314 * in the write locked state. */
315 struct ovs_rwlock rwlock;
316 struct hmap_node hmap_node; /* In struct ofproto's "groups" hmap. */
317 struct ofproto *ofproto; /* The ofproto that contains this group. */
319 uint8_t type; /* One of OFPGT_*. */
321 long long int created; /* Creation time. */
322 long long int modified; /* Time of last modification. */
324 struct list buckets; /* Contains "struct ofputil_bucket"s. */
328 bool ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
329 struct ofgroup **group)
330 OVS_TRY_RDLOCK(true, (*group)->rwlock);
332 void ofproto_group_release(struct ofgroup *group)
333 OVS_RELEASES(group->rwlock);
335 /* ofproto class structure, to be defined by each ofproto implementation.
341 * These functions work primarily with four different kinds of data
344 * - "struct ofproto", which represents an OpenFlow switch.
346 * - "struct ofport", which represents a port within an ofproto.
348 * - "struct rule", which represents an OpenFlow flow within an ofproto.
350 * - "struct ofgroup", which represents an OpenFlow 1.1+ group within an
353 * Each of these data structures contains all of the implementation-independent
354 * generic state for the respective concept, called the "base" state. None of
355 * them contains any extra space for ofproto implementations to use. Instead,
356 * each implementation is expected to declare its own data structure that
357 * contains an instance of the generic data structure plus additional
358 * implementation-specific members, called the "derived" state. The
359 * implementation can use casts or (preferably) the CONTAINER_OF macro to
360 * obtain access to derived state given only a pointer to the embedded generic
367 * Four stylized functions accompany each of these data structures:
369 * "alloc" "construct" "destruct" "dealloc"
370 * ------------ ---------------- --------------- --------------
371 * ofproto ->alloc ->construct ->destruct ->dealloc
372 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
373 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
374 * group ->group_alloc ->group_construct ->group_destruct ->group_dealloc
376 * "ofproto", "ofport", and "group" have this exact life cycle. The "rule"
377 * data structure also follow this life cycle with some additional elaborations
378 * described under "Rule Life Cycle" below.
380 * Any instance of a given data structure goes through the following life
383 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
384 * fails, skip all the other steps.
386 * 2. The client initializes all of the data structure's base state. If this
387 * fails, skip to step 7.
389 * 3. The client calls the "construct" function. The implementation
390 * initializes derived state. It may refer to the already-initialized
391 * base state. If "construct" fails, skip to step 6.
393 * 4. The data structure is now initialized and in use.
395 * 5. When the data structure is no longer needed, the client calls the
396 * "destruct" function. The implementation uninitializes derived state.
397 * The base state has not been uninitialized yet, so the implementation
398 * may still refer to it.
400 * 6. The client uninitializes all of the data structure's base state.
402 * 7. The client calls the "dealloc" to free the raw memory. The
403 * implementation must not refer to base or derived state in the data
404 * structure, because it has already been uninitialized.
406 * Each "alloc" function allocates and returns a new instance of the respective
407 * data structure. The "alloc" function is not given any information about the
408 * use of the new data structure, so it cannot perform much initialization.
409 * Its purpose is just to ensure that the new data structure has enough room
410 * for base and derived state. It may return a null pointer if memory is not
411 * available, in which case none of the other functions is called.
413 * Each "construct" function initializes derived state in its respective data
414 * structure. When "construct" is called, all of the base state has already
415 * been initialized, so the "construct" function may refer to it. The
416 * "construct" function is allowed to fail, in which case the client calls the
417 * "dealloc" function (but not the "destruct" function).
419 * Each "destruct" function uninitializes and frees derived state in its
420 * respective data structure. When "destruct" is called, the base state has
421 * not yet been uninitialized, so the "destruct" function may refer to it. The
422 * "destruct" function is not allowed to fail.
424 * Each "dealloc" function frees raw memory that was allocated by the the
425 * "alloc" function. The memory's base and derived members might not have ever
426 * been initialized (but if "construct" returned successfully, then it has been
427 * "destruct"ed already). The "dealloc" function is not allowed to fail.
433 * Most of these functions return 0 if they are successful or a positive error
434 * code on failure. Depending on the function, valid error codes are either
435 * errno values or OFPERR_* OpenFlow error codes.
437 * Most of these functions are expected to execute synchronously, that is, to
438 * block as necessary to obtain a result. Thus, these functions may return
439 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
440 * explicitly say those errors are a possibility. We may relax this
441 * requirement in the future if and when we encounter performance problems. */
442 struct ofproto_class {
443 /* ## ----------------- ## */
444 /* ## Factory Functions ## */
445 /* ## ----------------- ## */
447 /* Initializes provider. The caller may pass in 'iface_hints',
448 * which contains an shash of "struct iface_hint" elements indexed
449 * by the interface's name. The provider may use these hints to
450 * describe the startup configuration in order to reinitialize its
451 * state. The caller owns the provided data, so a provider must
452 * make copies of anything required. An ofproto provider must
453 * remove any existing state that is not described by the hint, and
454 * may choose to remove it all. */
455 void (*init)(const struct shash *iface_hints);
457 /* Enumerates the types of all support ofproto types into 'types'. The
458 * caller has already initialized 'types' and other ofproto classes might
459 * already have added names to it. */
460 void (*enumerate_types)(struct sset *types);
462 /* Enumerates the names of all existing datapath of the specified 'type'
463 * into 'names' 'all_dps'. The caller has already initialized 'names' as
466 * 'type' is one of the types enumerated by ->enumerate_types().
468 * Returns 0 if successful, otherwise a positive errno value.
470 int (*enumerate_names)(const char *type, struct sset *names);
472 /* Deletes the datapath with the specified 'type' and 'name'. The caller
473 * should have closed any open ofproto with this 'type' and 'name'; this
474 * function is allowed to fail if that is not the case.
476 * 'type' is one of the types enumerated by ->enumerate_types().
477 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
479 * Returns 0 if successful, otherwise a positive errno value.
481 int (*del)(const char *type, const char *name);
483 /* Returns the type to pass to netdev_open() when a datapath of type
484 * 'datapath_type' has a port of type 'port_type', for a few special
485 * cases when a netdev type differs from a port type. For example,
486 * when using the userspace datapath, a port of type "internal"
487 * needs to be opened as "tap".
489 * Returns either 'type' itself or a string literal, which must not
491 const char *(*port_open_type)(const char *datapath_type,
492 const char *port_type);
494 /* ## ------------------------ ## */
495 /* ## Top-Level type Functions ## */
496 /* ## ------------------------ ## */
498 /* Performs any periodic activity required on ofprotos of type
501 * An ofproto provider may implement it or not, depending on whether
502 * it needs type-level maintenance.
504 * Returns 0 if successful, otherwise a positive errno value. */
505 int (*type_run)(const char *type);
507 /* Performs periodic activity required on ofprotos of type 'type'
508 * that needs to be done with the least possible latency.
510 * This is run multiple times per main loop. An ofproto provider may
511 * implement it or not, according to whether it provides a performance
512 * boost for that ofproto implementation.
514 * Returns 0 if successful, otherwise a positive errno value. */
515 int (*type_run_fast)(const char *type);
517 /* Causes the poll loop to wake up when a type 'type''s 'run'
518 * function needs to be called, e.g. by calling the timer or fd
519 * waiting functions in poll-loop.h.
521 * An ofproto provider may implement it or not, depending on whether
522 * it needs type-level maintenance. */
523 void (*type_wait)(const char *type);
525 /* ## --------------------------- ## */
526 /* ## Top-Level ofproto Functions ## */
527 /* ## --------------------------- ## */
529 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
535 * ->construct() should not modify any base members of the ofproto. The
536 * client will initialize the ofproto's 'ports' and 'tables' members after
537 * construction is complete.
539 * When ->construct() is called, the client does not yet know how many flow
540 * tables the datapath supports, so ofproto->n_tables will be 0 and
541 * ofproto->tables will be NULL. ->construct() should call
542 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
543 * ofproto->tables. Each flow table will be initially empty, so
544 * ->construct() should delete flows from the underlying datapath, if
545 * necessary, rather than populating the tables.
547 * If the ofproto knows the maximum port number that the datapath can have,
548 * then it can call ofproto_init_max_ports(). If it does so, then the
549 * client will ensure that the actions it allows to be used through
550 * OpenFlow do not refer to ports above that maximum number.
552 * Only one ofproto instance needs to be supported for any given datapath.
553 * If a datapath is already open as part of one "ofproto", then another
554 * attempt to "construct" the same datapath as part of another ofproto is
555 * allowed to fail with an error.
557 * ->construct() returns 0 if successful, otherwise a positive errno
564 * If 'ofproto' has any pending asynchronous operations, ->destruct()
565 * must complete all of them by calling ofoperation_complete().
567 * ->destruct() must also destroy all remaining rules in the ofproto's
568 * tables, by passing each remaining rule to ofproto_rule_delete(), and
569 * then complete each of those deletions in turn by calling
570 * ofoperation_complete().
572 * (Thus, there is a multi-step process for any rule currently being
573 * inserted or modified at the beginning of destruction: first
574 * ofoperation_complete() that operation, then ofproto_rule_delete() the
575 * rule, then ofoperation_complete() the deletion operation.)
577 * The client will destroy the flow tables themselves after ->destruct()
580 struct ofproto *(*alloc)(void);
581 int (*construct)(struct ofproto *ofproto);
582 void (*destruct)(struct ofproto *ofproto);
583 void (*dealloc)(struct ofproto *ofproto);
585 /* Performs any periodic activity required by 'ofproto'. It should:
587 * - Call connmgr_send_packet_in() for each received packet that missed
588 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
591 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
592 * its hard_timeout or idle_timeout, to expire the flow.
594 * (But rules that are part of a pending operation, e.g. rules for
595 * which ->pending is true, may not expire.)
597 * Returns 0 if successful, otherwise a positive errno value. */
598 int (*run)(struct ofproto *ofproto);
600 /* Performs periodic activity required by 'ofproto' that needs to be done
601 * with the least possible latency.
603 * This is run multiple times per main loop. An ofproto provider may
604 * implement it or not, according to whether it provides a performance
605 * boost for that ofproto implementation. */
606 int (*run_fast)(struct ofproto *ofproto);
608 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
609 * be called, e.g. by calling the timer or fd waiting functions in
611 void (*wait)(struct ofproto *ofproto);
613 /* Adds some memory usage statistics for the implementation of 'ofproto'
614 * into 'usage', for use with memory_report().
616 * This function is optional. */
617 void (*get_memory_usage)(const struct ofproto *ofproto,
618 struct simap *usage);
620 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
621 * This function may prepare for that, for example by clearing state in
622 * advance. It should *not* actually delete any "struct rule"s from
623 * 'ofproto', only prepare for it.
625 * This function is optional; it's really just for optimization in case
626 * it's cheaper to delete all the flows from your hardware in a single pass
627 * than to do it one by one. */
628 void (*flush)(struct ofproto *ofproto);
630 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
632 * The implementation should store true in '*arp_match_ip' if the switch
633 * supports matching IP addresses inside ARP requests and replies, false
636 * The implementation should store in '*actions' a bitmap of the supported
637 * OpenFlow actions. Vendor actions are not included in '*actions'. */
638 void (*get_features)(struct ofproto *ofproto,
640 enum ofputil_action_bitmap *actions);
642 /* Helper for the OpenFlow OFPST_TABLE statistics request.
644 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
647 * - 'table_id' to the array index.
649 * - 'name' to "table#" where # is the table ID.
651 * - 'match' and 'wildcards' to OFPXMT12_MASK.
653 * - 'write_actions' and 'apply_actions' to OFPAT12_OUTPUT.
655 * - 'write_setfields' and 'apply_setfields' to OFPXMT12_MASK.
657 * - 'metadata_match' and 'metadata_write' to UINT64_MAX.
659 * - 'instructions' to OFPIT11_ALL.
661 * - 'config' to OFPTC11_TABLE_MISS_MASK.
663 * - 'max_entries' to 1,000,000.
665 * - 'active_count' to the classifier_count() for the table.
667 * - 'lookup_count' and 'matched_count' to 0.
669 * The implementation should update any members in each element for which
670 * it has better values:
672 * - 'name' to a more meaningful name.
674 * - 'wildcards' to the set of wildcards actually supported by the table
675 * (if it doesn't support all OpenFlow wildcards).
677 * - 'instructions' to set the instructions actually supported by
680 * - 'write_actions' to set the write actions actually supported by
681 * the table (if it doesn't support all OpenFlow actions).
683 * - 'apply_actions' to set the apply actions actually supported by
684 * the table (if it doesn't support all OpenFlow actions).
686 * - 'write_setfields' to set the write setfields actually supported by
689 * - 'apply_setfields' to set the apply setfields actually supported by
692 * - 'max_entries' to the maximum number of flows actually supported by
695 * - 'lookup_count' to the number of packets looked up in this flow table
698 * - 'matched_count' to the number of packets looked up in this flow
699 * table so far that matched one of the flow entries.
701 * All of the members of struct ofp12_table_stats are in network byte
704 void (*get_tables)(struct ofproto *ofproto, struct ofp12_table_stats *ots);
706 /* ## ---------------- ## */
707 /* ## ofport Functions ## */
708 /* ## ---------------- ## */
710 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
712 * ->port_construct() should not modify any base members of the ofport.
713 * An ofproto implementation should use the 'ofp_port' member of
714 * "struct ofport" as the OpenFlow port number.
716 * ofports are managed by the base ofproto code. The ofproto
717 * implementation should only create and destroy them in response to calls
718 * to these functions. The base ofproto code will create and destroy
719 * ofports in the following situations:
721 * - Just after the ->construct() function is called, the base ofproto
722 * iterates over all of the implementation's ports, using
723 * ->port_dump_start() and related functions, and constructs an ofport
724 * for each dumped port.
726 * - If ->port_poll() reports that a specific port has changed, then the
727 * base ofproto will query that port with ->port_query_by_name() and
728 * construct or destruct ofports as necessary to reflect the updated
731 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
732 * change, then the base ofproto will iterate over all of the
733 * implementation's ports, in the same way as at ofproto
734 * initialization, and construct and destruct ofports to reflect all of
737 * ->port_construct() returns 0 if successful, otherwise a positive errno
740 struct ofport *(*port_alloc)(void);
741 int (*port_construct)(struct ofport *ofport);
742 void (*port_destruct)(struct ofport *ofport);
743 void (*port_dealloc)(struct ofport *ofport);
745 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
746 * the ofproto implementation uses the ofport's netdev internally, then it
747 * should switch to using the new one. The old one has been closed.
749 * An ofproto implementation that doesn't need to do anything in this
750 * function may use a null pointer. */
751 void (*port_modified)(struct ofport *ofport);
753 /* Called after an OpenFlow request changes a port's configuration.
754 * 'ofport->pp.config' contains the new configuration. 'old_config'
755 * contains the previous configuration.
757 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
758 * turn NETDEV_UP on and off, so this function doesn't have to do anything
759 * for that bit (and it won't be called if that is the only bit that
761 void (*port_reconfigured)(struct ofport *ofport,
762 enum ofputil_port_config old_config);
764 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
765 * '*port' appropriately.
767 * The caller owns the data in 'port' and must free it with
768 * ofproto_port_destroy() when it is no longer needed. */
769 int (*port_query_by_name)(const struct ofproto *ofproto,
770 const char *devname, struct ofproto_port *port);
772 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
773 * successful, otherwise a positive errno value. The caller should
774 * inform the implementation of the OpenFlow port through the
775 * ->port_construct() method.
777 * It doesn't matter whether the new port will be returned by a later call
778 * to ->port_poll(); the implementation may do whatever is more
780 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
782 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
783 * 0 if successful, otherwise a positive errno value.
785 * It doesn't matter whether the new port will be returned by a later call
786 * to ->port_poll(); the implementation may do whatever is more
788 int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
791 int (*port_get_stats)(const struct ofport *port,
792 struct netdev_stats *stats);
794 /* Port iteration functions.
796 * The client might not be entirely in control of the ports within an
797 * ofproto. Some hardware implementations, for example, might have a fixed
798 * set of ports in a datapath. For this reason, the client needs a way to
799 * iterate through all the ports that are actually in a datapath. These
800 * functions provide that functionality.
802 * The 'state' pointer provides the implementation a place to
803 * keep track of its position. Its format is opaque to the caller.
805 * The ofproto provider retains ownership of the data that it stores into
806 * ->port_dump_next()'s 'port' argument. The data must remain valid until
807 * at least the next call to ->port_dump_next() or ->port_dump_done() for
808 * 'state'. The caller will not modify or free it.
813 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
814 * On success, it should return 0 and initialize '*statep' with any data
815 * needed for iteration. On failure, returns a positive errno value, and
816 * the client will not call ->port_dump_next() or ->port_dump_done().
818 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
819 * 'state'. If there is another port, it should store the port's
820 * information into 'port' and return 0. It should return EOF if all ports
821 * have already been iterated. Otherwise, on error, it should return a
822 * positive errno value. This function will not be called again once it
823 * returns nonzero once for a given iteration (but the 'port_dump_done'
824 * function will be called afterward).
826 * ->port_dump_done() allows the implementation to release resources used
827 * for iteration. The caller might decide to stop iteration in the middle
828 * by calling this function before ->port_dump_next() returns nonzero.
836 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
839 * struct ofproto_port port;
841 * error = ofproto->ofproto_class->port_dump_next(
842 * ofproto, state, &port);
846 * // Do something with 'port' here (without modifying or freeing
847 * // any of its data).
849 * ofproto->ofproto_class->port_dump_done(ofproto, state);
851 * // 'error' is now EOF (success) or a positive errno value (failure).
853 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
854 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
855 struct ofproto_port *port);
856 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
858 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
859 * in 'ofproto' has changed, then this function should do one of the
862 * - Preferably: store the name of the device that was added to or deleted
863 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
864 * for freeing '*devnamep' (with free()) when it no longer needs it.
866 * - Alternatively: return ENOBUFS, without indicating the device that was
869 * Occasional 'false positives', in which the function returns 0 while
870 * indicating a device that was not actually added or deleted or returns
871 * ENOBUFS without any change, are acceptable.
873 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
874 * externally to the 'ofproto' object, e.g. by a system administrator via
875 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
876 * not report changes made through calls to 'port_add' or 'port_del' on the
877 * same 'ofproto' object. (But it's OK for it to report them too, just
878 * slightly less efficient.)
880 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
881 * also return other positive errno values to indicate that something has
884 * If the set of ports in a datapath is fixed, or if the only way that the
885 * set of ports in a datapath can change is through ->port_add() and
886 * ->port_del(), then this function may be a null pointer.
888 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
890 /* Arranges for the poll loop to wake up when ->port_poll() will return a
891 * value other than EAGAIN.
893 * If the set of ports in a datapath is fixed, or if the only way that the
894 * set of ports in a datapath can change is through ->port_add() and
895 * ->port_del(), or if the poll loop will always wake up anyway when
896 * ->port_poll() will return a value other than EAGAIN, then this function
897 * may be a null pointer.
899 void (*port_poll_wait)(const struct ofproto *ofproto);
901 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
902 * partner information for 'port' is up-to-date, 0 if LACP partner
903 * information is not current (generally indicating a connectivity
904 * problem), or -1 if LACP is not enabled on 'port'.
906 * This function may be a null pointer if the ofproto implementation does
907 * not support LACP. */
908 int (*port_is_lacp_current)(const struct ofport *port);
910 /* ## ----------------------- ## */
911 /* ## OpenFlow Rule Functions ## */
912 /* ## ----------------------- ## */
914 /* Chooses an appropriate table for 'match' within 'ofproto'. On
915 * success, stores the table ID into '*table_idp' and returns 0. On
916 * failure, returns an OpenFlow error code.
918 * The choice of table should be a function of 'match' and 'ofproto''s
919 * datapath capabilities. It should not depend on the flows already in
920 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
921 * 'match' as its matching condition can never be inserted into 'ofproto',
922 * even starting from an empty flow table.
924 * If multiple tables are candidates for inserting the flow, the function
925 * should choose one arbitrarily (but deterministically).
927 * If this function is NULL then table 0 is always chosen. */
928 enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
929 const struct match *match,
932 /* Life-cycle functions for a "struct rule".
938 * The life cycle of a struct rule is an elaboration of the basic life
939 * cycle described above under "Life Cycle".
941 * After a rule is successfully constructed, it is then inserted. If
942 * insertion completes successfully, then before it is later destructed, it
945 * You can think of a rule as having the following extra steps inserted
946 * between "Life Cycle" steps 4 and 5:
948 * 4.1. The client inserts the rule into the flow table, making it
949 * visible in flow table lookups.
951 * 4.2. The client calls "rule_insert". Immediately or eventually, the
952 * implementation calls ofoperation_complete() to indicate that the
953 * insertion completed. If the operation failed, skip to step 5.
955 * 4.3. The rule is now installed in the flow table. Eventually it will
958 * 4.4. The client removes the rule from the flow table. It is no longer
959 * visible in flow table lookups.
961 * 4.5. The client calls "rule_delete". Immediately or eventually, the
962 * implementation calls ofoperation_complete() to indicate that the
963 * deletion completed. Deletion is not allowed to fail, so it must
967 * Asynchronous Operation Support
968 * ==============================
970 * The "insert" and "delete" life-cycle operations on rules can operate
971 * asynchronously, meaning that ->rule_insert() and ->rule_delete() only
972 * need to initiate their respective operations and do not need to wait for
973 * them to complete before they return. ->rule_modify_actions() also
974 * operates asynchronously.
976 * An ofproto implementation reports the success or failure of an
977 * asynchronous operation on a rule using the rule's 'pending' member,
978 * which points to a opaque "struct ofoperation" that represents the
979 * ongoing operation. When the operation completes, the ofproto
980 * implementation calls ofoperation_complete(), passing the ofoperation and
981 * an error indication.
983 * Only the following contexts may call ofoperation_complete():
985 * - The function called to initiate the operation, e.g. ->rule_insert()
986 * or ->rule_delete(). This is the best choice if the operation
989 * - The implementation's ->run() function.
991 * - The implementation's ->destruct() function.
993 * The ofproto base code updates the flow table optimistically, assuming
994 * that the operation will probably succeed:
996 * - ofproto adds the rule in the flow table before calling
999 * - ofproto updates the rule's actions and other properties before
1000 * calling ->rule_modify_actions().
1002 * - ofproto removes the rule before calling ->rule_delete().
1004 * With one exception, when an asynchronous operation completes with an
1005 * error, ofoperation_complete() backs out the already applied changes:
1007 * - If adding a rule in the flow table fails, ofproto removes the new
1010 * - If modifying a rule fails, ofproto restores the original actions
1011 * (and other properties).
1013 * - Removing a rule is not allowed to fail. It must always succeed.
1015 * The ofproto base code serializes operations: if any operation is in
1016 * progress on a given rule, ofproto postpones initiating any new operation
1017 * on that rule until the pending operation completes. Therefore, every
1018 * operation must eventually complete through a call to
1019 * ofoperation_complete() to avoid delaying new operations indefinitely
1020 * (including any OpenFlow request that affects the rule in question, even
1021 * just to query its statistics).
1027 * When ->rule_construct() is called, 'rule' is a new rule that is not yet
1028 * inserted into a flow table. ->rule_construct() should initialize enough
1029 * of the rule's derived state for 'rule' to be suitable for inserting into
1030 * a flow table. ->rule_construct() should not modify any base members of
1033 * If ->rule_construct() fails (as indicated by returning a nonzero
1034 * OpenFlow error code), the ofproto base code will uninitialize and
1035 * deallocate 'rule'. See "Rule Life Cycle" above for more details.
1037 * ->rule_construct() may also:
1039 * - Validate that the datapath supports the matching rule in 'rule->cr'
1040 * datapath. For example, if the rule's table does not support
1041 * registers, then it is an error if 'rule->cr' does not wildcard all
1044 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
1046 * Some implementations might need to defer these tasks to ->rule_insert(),
1047 * which is also acceptable.
1053 * Following successful construction, the ofproto base case inserts 'rule'
1054 * into its flow table, then it calls ->rule_insert(). ->rule_insert()
1055 * should set in motion adding the new rule to the datapath flow table. It
1056 * must act as follows:
1058 * - If it completes insertion, either by succeeding or failing, it must
1059 * call ofoperation_complete()
1061 * - If insertion is only partially complete, then it must return without
1062 * calling ofoperation_complete(). Later, when the insertion is
1063 * complete, the ->run() or ->destruct() function must call
1064 * ofoperation_complete() to report success or failure.
1066 * If ->rule_insert() fails, the ofproto base code will remove 'rule' from
1067 * the flow table, destruct, uninitialize, and deallocate 'rule'. See
1068 * "Rule Life Cycle" above for more details.
1074 * The ofproto base code removes 'rule' from its flow table before it calls
1075 * ->rule_delete(). ->rule_delete() should set in motion removing 'rule'
1076 * from the datapath flow table. It must act as follows:
1078 * - If it completes deletion, it must call ofoperation_complete().
1080 * - If deletion is only partially complete, then it must return without
1081 * calling ofoperation_complete(). Later, when the deletion is
1082 * complete, the ->run() or ->destruct() function must call
1083 * ofoperation_complete().
1085 * Rule deletion must not fail.
1091 * ->rule_destruct() must uninitialize derived state.
1093 * Rule destruction must not fail. */
1094 struct rule *(*rule_alloc)(void);
1095 enum ofperr (*rule_construct)(struct rule *rule);
1096 void (*rule_insert)(struct rule *rule);
1097 void (*rule_delete)(struct rule *rule);
1098 void (*rule_destruct)(struct rule *rule);
1099 void (*rule_dealloc)(struct rule *rule);
1101 /* Obtains statistics for 'rule', storing the number of packets that have
1102 * matched it in '*packet_count' and the number of bytes in those packets
1103 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
1104 * count is unknown. */
1105 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
1106 uint64_t *byte_count);
1108 /* Applies the actions in 'rule' to 'packet'. (This implements sending
1109 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1111 * Takes ownership of 'packet' (so it should eventually free it, with
1114 * 'flow' reflects the flow information for 'packet'. All of the
1115 * information in 'flow' is extracted from 'packet', except for
1116 * flow->tunnel and flow->in_port, which are assigned the correct values
1117 * for the incoming packet. The register values are zeroed. 'packet''s
1118 * header pointers (e.g. packet->l3) are appropriately initialized.
1119 * packet->l3 is aligned on a 32-bit boundary.
1121 * The implementation should add the statistics for 'packet' into 'rule'.
1123 * Returns 0 if successful, otherwise an OpenFlow error code. */
1124 enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1125 struct ofpbuf *packet);
1127 /* When ->rule_modify_actions() is called, the caller has already replaced
1128 * the OpenFlow actions in 'rule' by a new set. (The original actions are
1129 * in rule->pending->actions.)
1131 * ->rule_modify_actions() should set the following in motion:
1133 * - Validate that the datapath can correctly implement the actions now
1136 * - Update the datapath flow table with the new actions.
1138 * - Only if 'reset_counters' is true, reset any packet or byte counters
1139 * associated with the rule to zero, so that rule_get_stats() will not
1140 * longer count those packets or bytes.
1142 * If the operation synchronously completes, ->rule_modify_actions() may
1143 * call ofoperation_complete() before it returns. Otherwise, ->run()
1144 * should call ofoperation_complete() later, after the operation does
1147 * If the operation fails, then the base ofproto code will restore the
1148 * original 'actions' and 'n_actions' of 'rule'.
1150 * ->rule_modify_actions() should not modify any base members of struct
1152 void (*rule_modify_actions)(struct rule *rule, bool reset_counters);
1154 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1155 * which takes one of the following values, with the corresponding
1158 * - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1159 * as other packets, omitting TCP and UDP port numbers (always setting
1162 * - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1163 * passing them through the flow table.
1165 * - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1166 * passing packets through the flow table.
1168 * - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1169 * except that TCP and UDP port numbers should be included in fragments
1172 * Implementations are not required to support every mode.
1173 * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1175 * At the time of the call to ->set_frag_handling(), the current mode is
1176 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1177 * true if the requested mode was set, false if it is not supported.
1179 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1180 * reflect the new mode.
1182 bool (*set_frag_handling)(struct ofproto *ofproto,
1183 enum ofp_config_flags frag_handling);
1185 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1186 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1188 * The caller retains ownership of 'packet' and of 'ofpacts', so
1189 * ->packet_out() should not modify or free them.
1191 * This function must validate that it can correctly implement 'ofpacts'.
1192 * If not, then it should return an OpenFlow error code.
1194 * 'flow' reflects the flow information for 'packet'. All of the
1195 * information in 'flow' is extracted from 'packet', except for
1196 * flow->in_port (see below). flow->tunnel and its register values are
1199 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1200 * implementation should reject invalid flow->in_port values by returning
1201 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1202 * ofproto_init_max_ports(), then the client will reject these ports
1203 * itself.) For consistency, the implementation should consider valid for
1204 * flow->in_port any value that could possibly be seen in a packet that it
1205 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1206 * that never generates packet-ins (e.g. due to hardware limitations)
1207 * should still allow flow->in_port values for every possible physical port
1208 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1209 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1210 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1211 * these, treating each of them as packets generated by the controller as
1212 * opposed to packets originating from some switch port.
1214 * (Ordinarily the only effect of flow->in_port is on output actions that
1215 * involve the input port, such as actions that output to OFPP_IN_PORT,
1216 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1217 * "resubmit" actions.)
1219 * 'packet' is not matched against the OpenFlow flow table, so its
1220 * statistics should not be included in OpenFlow flow statistics.
1222 * Returns 0 if successful, otherwise an OpenFlow error code. */
1223 enum ofperr (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
1224 const struct flow *flow,
1225 const struct ofpact *ofpacts,
1226 size_t ofpacts_len);
1228 /* ## ------------------------- ## */
1229 /* ## OFPP_NORMAL configuration ## */
1230 /* ## ------------------------- ## */
1232 /* Configures NetFlow on 'ofproto' according to the options in
1233 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1235 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1236 * NetFlow, as does a null pointer. */
1237 int (*set_netflow)(struct ofproto *ofproto,
1238 const struct netflow_options *netflow_options);
1240 void (*get_netflow_ids)(const struct ofproto *ofproto,
1241 uint8_t *engine_type, uint8_t *engine_id);
1243 /* Configures sFlow on 'ofproto' according to the options in
1244 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1246 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1247 * sFlow, as does a null pointer. */
1248 int (*set_sflow)(struct ofproto *ofproto,
1249 const struct ofproto_sflow_options *sflow_options);
1251 /* Configures IPFIX on 'ofproto' according to the options in
1252 * 'bridge_exporter_options' and the 'flow_exporters_options'
1253 * array, or turns off IPFIX if 'bridge_exporter_options' and
1254 * 'flow_exporters_options' is NULL.
1256 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1257 * IPFIX, as does a null pointer. */
1259 struct ofproto *ofproto,
1260 const struct ofproto_ipfix_bridge_exporter_options
1261 *bridge_exporter_options,
1262 const struct ofproto_ipfix_flow_exporter_options
1263 *flow_exporters_options, size_t n_flow_exporters_options);
1265 /* Configures connectivity fault management on 'ofport'.
1267 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1269 * If 'cfm_settings' is null, removes any connectivity fault management
1270 * configuration from 'ofport'.
1272 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1273 * support CFM, as does a null pointer. */
1274 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1276 /* Checks the status of CFM configured on 'ofport'. Returns true if the
1277 * port's CFM status was successfully stored into '*status'. Returns false
1278 * if the port did not have CFM configured, in which case '*status' is
1281 * The caller must provide and owns '*status', but it does not own and must
1282 * not modify or free the array returned in 'status->rmps'. */
1283 bool (*get_cfm_status)(const struct ofport *ofport,
1284 struct ofproto_cfm_status *status);
1286 /* Configures BFD on 'ofport'.
1288 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1289 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1290 * according to 'cfg'.
1292 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1293 * support BFD, as does a null pointer. */
1294 int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1296 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1297 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1298 * that this ofproto_class does not support BFD, as does a null pointer. */
1299 int (*get_bfd_status)(struct ofport *ofport, struct smap *smap);
1301 /* Configures spanning tree protocol (STP) on 'ofproto' using the
1302 * settings defined in 's'.
1304 * If 's' is nonnull, configures STP according to its members.
1306 * If 's' is null, removes any STP configuration from 'ofproto'.
1308 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1309 * support STP, as does a null pointer. */
1310 int (*set_stp)(struct ofproto *ofproto,
1311 const struct ofproto_stp_settings *s);
1313 /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1315 * Stores STP state for 'ofproto' in 's'. If the 'enabled' member
1316 * is false, the other member values are not meaningful.
1318 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1319 * support STP, as does a null pointer. */
1320 int (*get_stp_status)(struct ofproto *ofproto,
1321 struct ofproto_stp_status *s);
1323 /* Configures spanning tree protocol (STP) on 'ofport' using the
1324 * settings defined in 's'.
1326 * If 's' is nonnull, configures STP according to its members. The
1327 * caller is responsible for assigning STP port numbers (using the
1328 * 'port_num' member in the range of 1 through 255, inclusive) and
1329 * ensuring there are no duplicates.
1331 * If 's' is null, removes any STP configuration from 'ofport'.
1333 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1334 * support STP, as does a null pointer. */
1335 int (*set_stp_port)(struct ofport *ofport,
1336 const struct ofproto_port_stp_settings *s);
1338 /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1340 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1341 * false, the other member values are not meaningful.
1343 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1344 * support STP, as does a null pointer. */
1345 int (*get_stp_port_status)(struct ofport *ofport,
1346 struct ofproto_port_stp_status *s);
1348 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1349 * 'queues' attached to 'ofport'. This data is not intended to be
1350 * sufficient to implement QoS. Instead, providers may use this
1351 * information to implement features which require knowledge of what queues
1352 * exist on a port, and some basic information about them.
1354 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1355 * support QoS, as does a null pointer. */
1356 int (*set_queues)(struct ofport *ofport,
1357 const struct ofproto_port_queue *queues, size_t n_qdscp);
1359 /* If 's' is nonnull, this function registers a "bundle" associated with
1360 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
1361 * a Port in OVSDB, that is, it consists of one or more "slave" devices
1362 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1363 * there is more than one slave, a bonding configuration. If 'aux' is
1364 * already registered then this function updates its configuration to 's'.
1365 * Otherwise, this function registers a new bundle.
1367 * If 's' is NULL, this function unregisters the bundle registered on
1368 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
1369 * has been registered, this has no effect.
1371 * This function affects only the behavior of the NXAST_AUTOPATH action and
1372 * output to the OFPP_NORMAL port. An implementation that does not support
1373 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
1374 * that supports only a subset of the functionality should implement what
1375 * it can and return 0. */
1376 int (*bundle_set)(struct ofproto *ofproto, void *aux,
1377 const struct ofproto_bundle_settings *s);
1379 /* If 'port' is part of any bundle, removes it from that bundle. If the
1380 * bundle now has no ports, deletes the bundle. If the bundle now has only
1381 * one port, deconfigures the bundle's bonding configuration. */
1382 void (*bundle_remove)(struct ofport *ofport);
1384 /* If 's' is nonnull, this function registers a mirror associated with
1385 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
1386 * a Mirror in OVSDB. If 'aux' is already registered then this function
1387 * updates its configuration to 's'. Otherwise, this function registers a
1390 * If 's' is NULL, this function unregisters the mirror registered on
1391 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
1392 * has been registered, this has no effect.
1394 * An implementation that does not support mirroring at all may set
1395 * it to NULL or return EOPNOTSUPP. An implementation that supports
1396 * only a subset of the functionality should implement what it can
1398 int (*mirror_set)(struct ofproto *ofproto, void *aux,
1399 const struct ofproto_mirror_settings *s);
1401 /* Retrieves statistics from mirror associated with client data
1402 * pointer 'aux' in 'ofproto'. Stores packet and byte counts in
1403 * 'packets' and 'bytes', respectively. If a particular counter is
1404 * not supported, the appropriate argument is set to UINT64_MAX.
1406 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1407 * support retrieving mirror statistics. */
1408 int (*mirror_get_stats)(struct ofproto *ofproto, void *aux,
1409 uint64_t *packets, uint64_t *bytes);
1411 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1412 * on which all packets are flooded, instead of using MAC learning. If
1413 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1415 * This function affects only the behavior of the OFPP_NORMAL action. An
1416 * implementation that does not support it may set it to NULL or return
1418 int (*set_flood_vlans)(struct ofproto *ofproto,
1419 unsigned long *flood_vlans);
1421 /* Returns true if 'aux' is a registered bundle that is currently in use as
1422 * the output for a mirror. */
1423 bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1425 /* When the configuration option of forward_bpdu changes, this function
1426 * will be invoked. */
1427 void (*forward_bpdu_changed)(struct ofproto *ofproto);
1429 /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1430 * seconds, and the maximum number of MAC table entries to
1433 * An implementation that doesn't support configuring these features may
1434 * set this function to NULL or implement it as a no-op. */
1435 void (*set_mac_table_config)(struct ofproto *ofproto,
1436 unsigned int idle_time, size_t max_entries);
1438 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1440 * This is deprecated. It is only for compatibility with broken device drivers
1441 * in old versions of Linux that do not properly support VLANs when VLAN
1442 * devices are not used. When broken device drivers are no longer in
1443 * widespread use, we will delete these interfaces. */
1445 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1446 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1447 * that has OpenFlow port number 'realdev_ofp_port'.
1449 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1450 * as a VLAN splinter port.
1452 * This function should be NULL if an implementation does not support it.
1454 int (*set_realdev)(struct ofport *ofport,
1455 ofp_port_t realdev_ofp_port, int vid);
1457 /* ## ------------------------ ## */
1458 /* ## OpenFlow meter functions ## */
1459 /* ## ------------------------ ## */
1461 /* These functions should be NULL if an implementation does not support
1462 * them. They must be all null or all non-null.. */
1464 /* Initializes 'features' to describe the metering features supported by
1466 void (*meter_get_features)(const struct ofproto *ofproto,
1467 struct ofputil_meter_features *features);
1469 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1470 * success the function must store a provider meter ID other than
1471 * UINT32_MAX in '*id'. All further references to the meter will be made
1472 * with the returned provider meter id rather than the OpenFlow meter id.
1473 * The caller does not try to interpret the provider meter id, giving the
1474 * implementation the freedom to either use the OpenFlow meter_id value
1475 * provided in the meter configuration, or any other value suitable for the
1478 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1479 * with that meter provider ID to have configuration 'config'. On failure,
1480 * the existing meter configuration is left intact. Regardless of success,
1481 * any change to '*id' updates the provider meter id used for this
1483 enum ofperr (*meter_set)(struct ofproto *ofproto, ofproto_meter_id *id,
1484 const struct ofputil_meter_config *config);
1486 /* Gets the meter and meter band packet and byte counts for maximum of
1487 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1488 * 'ofproto'. The caller fills in the other stats values. The band stats
1489 * are copied to memory at 'stats->bands' provided by the caller. The
1490 * number of returned band stats is returned in 'stats->n_bands'. */
1491 enum ofperr (*meter_get)(const struct ofproto *ofproto,
1492 ofproto_meter_id id,
1493 struct ofputil_meter_stats *stats);
1495 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1497 void (*meter_del)(struct ofproto *, ofproto_meter_id);
1500 /* ## -------------------- ## */
1501 /* ## OpenFlow 1.1+ groups ## */
1502 /* ## -------------------- ## */
1504 struct ofgroup *(*group_alloc)(void);
1505 enum ofperr (*group_construct)(struct ofgroup *);
1506 void (*group_destruct)(struct ofgroup *);
1507 void (*group_dealloc)(struct ofgroup *);
1509 enum ofperr (*group_modify)(struct ofgroup *, struct ofgroup *victim);
1511 enum ofperr (*group_get_stats)(const struct ofgroup *,
1512 struct ofputil_group_stats *);
1515 extern const struct ofproto_class ofproto_dpif_class;
1517 int ofproto_class_register(const struct ofproto_class *);
1518 int ofproto_class_unregister(const struct ofproto_class *);
1520 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
1521 * because it overlaps with an ongoing flow table operation that has not yet
1522 * completed. The caller should retry the operation later.
1524 * ofproto.c also uses this value internally for additional (similar) purposes.
1526 * This particular value is a good choice because it is large, so that it does
1527 * not collide with any errno value, but not large enough to collide with an
1528 * OFPERR_* value. */
1529 enum { OFPROTO_POSTPONE = 1 << 16 };
1530 BUILD_ASSERT_DECL(OFPROTO_POSTPONE < OFPERR_OFS);
1532 int ofproto_flow_mod(struct ofproto *, struct ofputil_flow_mod *);
1533 void ofproto_add_flow(struct ofproto *, const struct match *,
1534 unsigned int priority,
1535 const struct ofpact *ofpacts, size_t ofpacts_len);
1536 bool ofproto_delete_flow(struct ofproto *,
1537 const struct match *, unsigned int priority);
1538 void ofproto_flush_flows(struct ofproto *);
1540 #endif /* ofproto/ofproto-provider.h */