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 void ofproto_init_tables(struct ofproto *, int n_tables);
117 void ofproto_init_max_ports(struct ofproto *, uint16_t max_ports);
119 struct ofproto *ofproto_lookup(const char *name);
120 struct ofport *ofproto_get_port(const struct ofproto *, ofp_port_t ofp_port);
122 /* An OpenFlow port within a "struct ofproto".
124 * With few exceptions, ofproto implementations may look at these fields but
125 * should not modify them. */
127 struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
128 struct ofproto *ofproto; /* The ofproto that contains this port. */
129 struct netdev *netdev;
130 struct ofputil_phy_port pp;
131 ofp_port_t ofp_port; /* OpenFlow port number. */
132 unsigned int change_seq;
133 long long int created; /* Time created, in msec. */
137 void ofproto_port_set_state(struct ofport *, enum ofputil_port_state);
139 /* OpenFlow table flags:
141 * - "Hidden" tables are not included in OpenFlow operations that operate on
142 * "all tables". For example, a request for flow stats on all tables will
143 * omit flows in hidden tables, table stats requests will omit the table
144 * entirely, and the switch features reply will not count the hidden table.
146 * However, operations that specifically name the particular table still
147 * operate on it. For example, flow_mods and flow stats requests on a
150 * To avoid gaps in table IDs (which have unclear validity in OpenFlow),
151 * hidden tables must be the highest-numbered tables that a provider
154 * - "Read-only" tables can't be changed through OpenFlow operations. (At
155 * the moment all flow table operations go effectively through OpenFlow, so
156 * this means that read-only tables can't be changed at all after the
157 * read-only flag is set.)
159 * The generic ofproto layer never sets these flags. An ofproto provider can
160 * set them if it is appropriate.
163 OFTABLE_HIDDEN = 1 << 0, /* Hide from most OpenFlow operations. */
164 OFTABLE_READONLY = 1 << 1 /* Don't allow OpenFlow to change this table. */
167 /* A flow table within a "struct ofproto". */
169 enum oftable_flags flags;
170 struct classifier cls; /* Contains "struct rule"s. */
171 char *name; /* Table name exposed via OpenFlow, or NULL. */
173 /* Maximum number of flows or UINT_MAX if there is no limit besides any
174 * limit imposed by resource limitations. */
175 unsigned int max_flows;
177 /* These members determine the handling of an attempt to add a flow that
178 * would cause the table to have more than 'max_flows' flows.
180 * If 'eviction_fields' is NULL, overflows will be rejected with an error.
182 * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
183 * is nonzero), an overflow will cause a flow to be removed. The flow to
184 * be removed is chosen to give fairness among groups distinguished by
185 * different values for the subfields within 'groups'. */
186 struct mf_subfield *eviction_fields;
187 size_t n_eviction_fields;
191 * When a flow is added that would cause the table to have more than
192 * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
193 * used to decide which rule to evict: the rule is chosen from the eviction
194 * group that contains the greatest number of rules.*/
195 uint32_t eviction_group_id_basis;
196 struct hmap eviction_groups_by_id;
197 struct heap eviction_groups_by_size;
200 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
202 * All parameters are evaluated multiple times. */
203 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO) \
204 for ((TABLE) = (OFPROTO)->tables; \
205 (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
208 /* An OpenFlow flow within a "struct ofproto".
210 * With few exceptions, ofproto implementations may look at these fields but
211 * should not modify them. */
213 struct list ofproto_node; /* Owned by ofproto base code. */
214 struct ofproto *ofproto; /* The ofproto that contains this rule. */
215 struct cls_rule cr; /* In owning ofproto's classifier. */
217 struct ofoperation *pending; /* Operation now in progress, if nonnull. */
219 ovs_be64 flow_cookie; /* Controller-issued identifier. */
220 struct hindex_node cookie_node; /* In owning ofproto's 'cookies' index. */
222 long long int created; /* Creation time. */
223 long long int modified; /* Time of last modification. */
224 long long int used; /* Last use; time created if never used. */
225 uint8_t table_id; /* Index in ofproto's 'tables' array. */
226 bool send_flow_removed; /* Send a flow removed message? */
228 struct ovs_mutex timeout_mutex;
229 uint16_t hard_timeout OVS_GUARDED; /* In seconds from ->modified. */
230 uint16_t idle_timeout OVS_GUARDED; /* In seconds from ->used. */
232 /* Eviction groups. */
233 struct heap_node evg_node; /* In eviction_group's "rules" heap. */
234 struct eviction_group *eviction_group; /* NULL if not in any group. */
236 /* The evict lock is used to prevent rules from being evicted while child
237 * threads are using them to xlate flows. A read lock means the rule is
238 * currently being used. A write lock means the rule is in the process of
239 * being evicted and should be considered gone. A rule will not be evicted
240 * unless both its own and its classifiers write locks are held.
241 * Therefore, while holding a classifier readlock, one can be assured that
242 * even write locked rules are safe. */
243 struct ovs_rwlock evict;
245 struct ofpact *ofpacts; /* Sequence of "struct ofpacts". */
246 unsigned int ofpacts_len; /* Size of 'ofpacts', in bytes. */
248 uint32_t meter_id; /* Non-zero OF meter_id, or zero. */
249 struct list meter_list_node; /* In owning meter's 'rules' list. */
252 enum nx_flow_monitor_flags monitor_flags;
253 uint64_t add_seqno; /* Sequence number when added. */
254 uint64_t modify_seqno; /* Sequence number when changed. */
256 /* Optimisation for flow expiry. */
257 struct list expirable; /* In ofproto's 'expirable' list if this rule
258 * is expirable, otherwise empty. */
261 /* Threshold at which to begin flow table eviction. Only affects the
262 * ofproto-dpif implementation */
263 extern unsigned flow_eviction_threshold;
265 /* Number of upcall handler threads. Only affects the ofproto-dpif
267 extern unsigned n_handler_threads;
269 /* Determines which model to use for handling misses in the ofproto-dpif
271 extern enum ofproto_flow_miss_model flow_miss_model;
273 static inline struct rule *
274 rule_from_cls_rule(const struct cls_rule *cls_rule)
276 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
279 void ofproto_rule_update_used(struct rule *, long long int used);
280 void ofproto_rule_expire(struct rule *rule, uint8_t reason);
281 void ofproto_rule_delete(struct ofproto *, struct classifier *cls,
282 struct rule *) OVS_REQ_WRLOCK(cls->rwlock);
283 void ofproto_rule_reduce_timeouts(struct rule *rule, uint16_t idle_timeout,
284 uint16_t hard_timeout)
285 OVS_EXCLUDED(rule->ofproto->expirable_mutex, rule->timeout_mutex);
287 bool ofproto_rule_has_out_port(const struct rule *, ofp_port_t out_port);
289 void ofoperation_complete(struct ofoperation *, enum ofperr);
291 bool ofoperation_has_out_port(const struct ofoperation *, ofp_port_t out_port);
293 bool ofproto_rule_is_hidden(const struct rule *);
295 /* ofproto class structure, to be defined by each ofproto implementation.
301 * These functions work primarily with three different kinds of data
304 * - "struct ofproto", which represents an OpenFlow switch.
306 * - "struct ofport", which represents a port within an ofproto.
308 * - "struct rule", which represents an OpenFlow flow within an ofproto.
310 * Each of these data structures contains all of the implementation-independent
311 * generic state for the respective concept, called the "base" state. None of
312 * them contains any extra space for ofproto implementations to use. Instead,
313 * each implementation is expected to declare its own data structure that
314 * contains an instance of the generic data structure plus additional
315 * implementation-specific members, called the "derived" state. The
316 * implementation can use casts or (preferably) the CONTAINER_OF macro to
317 * obtain access to derived state given only a pointer to the embedded generic
324 * Four stylized functions accompany each of these data structures:
326 * "alloc" "construct" "destruct" "dealloc"
327 * ------------ ---------------- --------------- --------------
328 * ofproto ->alloc ->construct ->destruct ->dealloc
329 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
330 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
332 * "ofproto" and "ofport" have this exact life cycle. The "rule" data
333 * structure also follow this life cycle with some additional elaborations
334 * described under "Rule Life Cycle" below.
336 * Any instance of a given data structure goes through the following life
339 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
340 * fails, skip all the other steps.
342 * 2. The client initializes all of the data structure's base state. If this
343 * fails, skip to step 7.
345 * 3. The client calls the "construct" function. The implementation
346 * initializes derived state. It may refer to the already-initialized
347 * base state. If "construct" fails, skip to step 6.
349 * 4. The data structure is now initialized and in use.
351 * 5. When the data structure is no longer needed, the client calls the
352 * "destruct" function. The implementation uninitializes derived state.
353 * The base state has not been uninitialized yet, so the implementation
354 * may still refer to it.
356 * 6. The client uninitializes all of the data structure's base state.
358 * 7. The client calls the "dealloc" to free the raw memory. The
359 * implementation must not refer to base or derived state in the data
360 * structure, because it has already been uninitialized.
362 * Each "alloc" function allocates and returns a new instance of the respective
363 * data structure. The "alloc" function is not given any information about the
364 * use of the new data structure, so it cannot perform much initialization.
365 * Its purpose is just to ensure that the new data structure has enough room
366 * for base and derived state. It may return a null pointer if memory is not
367 * available, in which case none of the other functions is called.
369 * Each "construct" function initializes derived state in its respective data
370 * structure. When "construct" is called, all of the base state has already
371 * been initialized, so the "construct" function may refer to it. The
372 * "construct" function is allowed to fail, in which case the client calls the
373 * "dealloc" function (but not the "destruct" function).
375 * Each "destruct" function uninitializes and frees derived state in its
376 * respective data structure. When "destruct" is called, the base state has
377 * not yet been uninitialized, so the "destruct" function may refer to it. The
378 * "destruct" function is not allowed to fail.
380 * Each "dealloc" function frees raw memory that was allocated by the the
381 * "alloc" function. The memory's base and derived members might not have ever
382 * been initialized (but if "construct" returned successfully, then it has been
383 * "destruct"ed already). The "dealloc" function is not allowed to fail.
389 * Most of these functions return 0 if they are successful or a positive error
390 * code on failure. Depending on the function, valid error codes are either
391 * errno values or OFPERR_* OpenFlow error codes.
393 * Most of these functions are expected to execute synchronously, that is, to
394 * block as necessary to obtain a result. Thus, these functions may return
395 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
396 * explicitly say those errors are a possibility. We may relax this
397 * requirement in the future if and when we encounter performance problems. */
398 struct ofproto_class {
399 /* ## ----------------- ## */
400 /* ## Factory Functions ## */
401 /* ## ----------------- ## */
403 /* Initializes provider. The caller may pass in 'iface_hints',
404 * which contains an shash of "struct iface_hint" elements indexed
405 * by the interface's name. The provider may use these hints to
406 * describe the startup configuration in order to reinitialize its
407 * state. The caller owns the provided data, so a provider must
408 * make copies of anything required. An ofproto provider must
409 * remove any existing state that is not described by the hint, and
410 * may choose to remove it all. */
411 void (*init)(const struct shash *iface_hints);
413 /* Enumerates the types of all support ofproto types into 'types'. The
414 * caller has already initialized 'types' and other ofproto classes might
415 * already have added names to it. */
416 void (*enumerate_types)(struct sset *types);
418 /* Enumerates the names of all existing datapath of the specified 'type'
419 * into 'names' 'all_dps'. The caller has already initialized 'names' as
422 * 'type' is one of the types enumerated by ->enumerate_types().
424 * Returns 0 if successful, otherwise a positive errno value.
426 int (*enumerate_names)(const char *type, struct sset *names);
428 /* Deletes the datapath with the specified 'type' and 'name'. The caller
429 * should have closed any open ofproto with this 'type' and 'name'; this
430 * function is allowed to fail if that is not the case.
432 * 'type' is one of the types enumerated by ->enumerate_types().
433 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
435 * Returns 0 if successful, otherwise a positive errno value.
437 int (*del)(const char *type, const char *name);
439 /* Returns the type to pass to netdev_open() when a datapath of type
440 * 'datapath_type' has a port of type 'port_type', for a few special
441 * cases when a netdev type differs from a port type. For example,
442 * when using the userspace datapath, a port of type "internal"
443 * needs to be opened as "tap".
445 * Returns either 'type' itself or a string literal, which must not
447 const char *(*port_open_type)(const char *datapath_type,
448 const char *port_type);
450 /* ## ------------------------ ## */
451 /* ## Top-Level type Functions ## */
452 /* ## ------------------------ ## */
454 /* Performs any periodic activity required on ofprotos of type
457 * An ofproto provider may implement it or not, depending on whether
458 * it needs type-level maintenance.
460 * Returns 0 if successful, otherwise a positive errno value. */
461 int (*type_run)(const char *type);
463 /* Performs periodic activity required on ofprotos of type 'type'
464 * that needs to be done with the least possible latency.
466 * This is run multiple times per main loop. An ofproto provider may
467 * implement it or not, according to whether it provides a performance
468 * boost for that ofproto implementation.
470 * Returns 0 if successful, otherwise a positive errno value. */
471 int (*type_run_fast)(const char *type);
473 /* Causes the poll loop to wake up when a type 'type''s 'run'
474 * function needs to be called, e.g. by calling the timer or fd
475 * waiting functions in poll-loop.h.
477 * An ofproto provider may implement it or not, depending on whether
478 * it needs type-level maintenance. */
479 void (*type_wait)(const char *type);
481 /* ## --------------------------- ## */
482 /* ## Top-Level ofproto Functions ## */
483 /* ## --------------------------- ## */
485 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
491 * ->construct() should not modify any base members of the ofproto. The
492 * client will initialize the ofproto's 'ports' and 'tables' members after
493 * construction is complete.
495 * When ->construct() is called, the client does not yet know how many flow
496 * tables the datapath supports, so ofproto->n_tables will be 0 and
497 * ofproto->tables will be NULL. ->construct() should call
498 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
499 * ofproto->tables. Each flow table will be initially empty, so
500 * ->construct() should delete flows from the underlying datapath, if
501 * necessary, rather than populating the tables.
503 * If the ofproto knows the maximum port number that the datapath can have,
504 * then it can call ofproto_init_max_ports(). If it does so, then the
505 * client will ensure that the actions it allows to be used through
506 * OpenFlow do not refer to ports above that maximum number.
508 * Only one ofproto instance needs to be supported for any given datapath.
509 * If a datapath is already open as part of one "ofproto", then another
510 * attempt to "construct" the same datapath as part of another ofproto is
511 * allowed to fail with an error.
513 * ->construct() returns 0 if successful, otherwise a positive errno
520 * If 'ofproto' has any pending asynchronous operations, ->destruct()
521 * must complete all of them by calling ofoperation_complete().
523 * ->destruct() must also destroy all remaining rules in the ofproto's
524 * tables, by passing each remaining rule to ofproto_rule_delete(), and
525 * then complete each of those deletions in turn by calling
526 * ofoperation_complete().
528 * (Thus, there is a multi-step process for any rule currently being
529 * inserted or modified at the beginning of destruction: first
530 * ofoperation_complete() that operation, then ofproto_rule_delete() the
531 * rule, then ofoperation_complete() the deletion operation.)
533 * The client will destroy the flow tables themselves after ->destruct()
536 struct ofproto *(*alloc)(void);
537 int (*construct)(struct ofproto *ofproto);
538 void (*destruct)(struct ofproto *ofproto);
539 void (*dealloc)(struct ofproto *ofproto);
541 /* Performs any periodic activity required by 'ofproto'. It should:
543 * - Call connmgr_send_packet_in() for each received packet that missed
544 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
547 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
548 * its hard_timeout or idle_timeout, to expire the flow.
550 * (But rules that are part of a pending operation, e.g. rules for
551 * which ->pending is true, may not expire.)
553 * Returns 0 if successful, otherwise a positive errno value. */
554 int (*run)(struct ofproto *ofproto);
556 /* Performs periodic activity required by 'ofproto' that needs to be done
557 * with the least possible latency.
559 * This is run multiple times per main loop. An ofproto provider may
560 * implement it or not, according to whether it provides a performance
561 * boost for that ofproto implementation. */
562 int (*run_fast)(struct ofproto *ofproto);
564 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
565 * be called, e.g. by calling the timer or fd waiting functions in
567 void (*wait)(struct ofproto *ofproto);
569 /* Adds some memory usage statistics for the implementation of 'ofproto'
570 * into 'usage', for use with memory_report().
572 * This function is optional. */
573 void (*get_memory_usage)(const struct ofproto *ofproto,
574 struct simap *usage);
576 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
577 * This function may prepare for that, for example by clearing state in
578 * advance. It should *not* actually delete any "struct rule"s from
579 * 'ofproto', only prepare for it.
581 * This function is optional; it's really just for optimization in case
582 * it's cheaper to delete all the flows from your hardware in a single pass
583 * than to do it one by one. */
584 void (*flush)(struct ofproto *ofproto);
586 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
588 * The implementation should store true in '*arp_match_ip' if the switch
589 * supports matching IP addresses inside ARP requests and replies, false
592 * The implementation should store in '*actions' a bitmap of the supported
593 * OpenFlow actions. Vendor actions are not included in '*actions'. */
594 void (*get_features)(struct ofproto *ofproto,
596 enum ofputil_action_bitmap *actions);
598 /* Helper for the OpenFlow OFPST_TABLE statistics request.
600 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
603 * - 'table_id' to the array index.
605 * - 'name' to "table#" where # is the table ID.
607 * - 'match' and 'wildcards' to OFPXMT12_MASK.
609 * - 'write_actions' and 'apply_actions' to OFPAT12_OUTPUT.
611 * - 'write_setfields' and 'apply_setfields' to OFPXMT12_MASK.
613 * - 'metadata_match' and 'metadata_write' to UINT64_MAX.
615 * - 'instructions' to OFPIT11_ALL.
617 * - 'config' to OFPTC11_TABLE_MISS_MASK.
619 * - 'max_entries' to 1,000,000.
621 * - 'active_count' to the classifier_count() for the table.
623 * - 'lookup_count' and 'matched_count' to 0.
625 * The implementation should update any members in each element for which
626 * it has better values:
628 * - 'name' to a more meaningful name.
630 * - 'wildcards' to the set of wildcards actually supported by the table
631 * (if it doesn't support all OpenFlow wildcards).
633 * - 'instructions' to set the instructions actually supported by
636 * - 'write_actions' to set the write actions actually supported by
637 * the table (if it doesn't support all OpenFlow actions).
639 * - 'apply_actions' to set the apply actions actually supported by
640 * the table (if it doesn't support all OpenFlow actions).
642 * - 'write_setfields' to set the write setfields actually supported by
645 * - 'apply_setfields' to set the apply setfields actually supported by
648 * - 'max_entries' to the maximum number of flows actually supported by
651 * - 'lookup_count' to the number of packets looked up in this flow table
654 * - 'matched_count' to the number of packets looked up in this flow
655 * table so far that matched one of the flow entries.
657 * All of the members of struct ofp12_table_stats are in network byte
660 void (*get_tables)(struct ofproto *ofproto, struct ofp12_table_stats *ots);
662 /* ## ---------------- ## */
663 /* ## ofport Functions ## */
664 /* ## ---------------- ## */
666 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
668 * ->port_construct() should not modify any base members of the ofport.
669 * An ofproto implementation should use the 'ofp_port' member of
670 * "struct ofport" as the OpenFlow port number.
672 * ofports are managed by the base ofproto code. The ofproto
673 * implementation should only create and destroy them in response to calls
674 * to these functions. The base ofproto code will create and destroy
675 * ofports in the following situations:
677 * - Just after the ->construct() function is called, the base ofproto
678 * iterates over all of the implementation's ports, using
679 * ->port_dump_start() and related functions, and constructs an ofport
680 * for each dumped port.
682 * - If ->port_poll() reports that a specific port has changed, then the
683 * base ofproto will query that port with ->port_query_by_name() and
684 * construct or destruct ofports as necessary to reflect the updated
687 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
688 * change, then the base ofproto will iterate over all of the
689 * implementation's ports, in the same way as at ofproto
690 * initialization, and construct and destruct ofports to reflect all of
693 * ->port_construct() returns 0 if successful, otherwise a positive errno
696 struct ofport *(*port_alloc)(void);
697 int (*port_construct)(struct ofport *ofport);
698 void (*port_destruct)(struct ofport *ofport);
699 void (*port_dealloc)(struct ofport *ofport);
701 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
702 * the ofproto implementation uses the ofport's netdev internally, then it
703 * should switch to using the new one. The old one has been closed.
705 * An ofproto implementation that doesn't need to do anything in this
706 * function may use a null pointer. */
707 void (*port_modified)(struct ofport *ofport);
709 /* Called after an OpenFlow request changes a port's configuration.
710 * 'ofport->pp.config' contains the new configuration. 'old_config'
711 * contains the previous configuration.
713 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
714 * turn NETDEV_UP on and off, so this function doesn't have to do anything
715 * for that bit (and it won't be called if that is the only bit that
717 void (*port_reconfigured)(struct ofport *ofport,
718 enum ofputil_port_config old_config);
720 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
721 * '*port' appropriately.
723 * The caller owns the data in 'port' and must free it with
724 * ofproto_port_destroy() when it is no longer needed. */
725 int (*port_query_by_name)(const struct ofproto *ofproto,
726 const char *devname, struct ofproto_port *port);
728 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
729 * successful, otherwise a positive errno value. The caller should
730 * inform the implementation of the OpenFlow port through the
731 * ->port_construct() method.
733 * It doesn't matter whether the new port will be returned by a later call
734 * to ->port_poll(); the implementation may do whatever is more
736 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
738 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
739 * 0 if successful, otherwise a positive errno value.
741 * It doesn't matter whether the new port will be returned by a later call
742 * to ->port_poll(); the implementation may do whatever is more
744 int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
747 int (*port_get_stats)(const struct ofport *port,
748 struct netdev_stats *stats);
750 /* Port iteration functions.
752 * The client might not be entirely in control of the ports within an
753 * ofproto. Some hardware implementations, for example, might have a fixed
754 * set of ports in a datapath. For this reason, the client needs a way to
755 * iterate through all the ports that are actually in a datapath. These
756 * functions provide that functionality.
758 * The 'state' pointer provides the implementation a place to
759 * keep track of its position. Its format is opaque to the caller.
761 * The ofproto provider retains ownership of the data that it stores into
762 * ->port_dump_next()'s 'port' argument. The data must remain valid until
763 * at least the next call to ->port_dump_next() or ->port_dump_done() for
764 * 'state'. The caller will not modify or free it.
769 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
770 * On success, it should return 0 and initialize '*statep' with any data
771 * needed for iteration. On failure, returns a positive errno value, and
772 * the client will not call ->port_dump_next() or ->port_dump_done().
774 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
775 * 'state'. If there is another port, it should store the port's
776 * information into 'port' and return 0. It should return EOF if all ports
777 * have already been iterated. Otherwise, on error, it should return a
778 * positive errno value. This function will not be called again once it
779 * returns nonzero once for a given iteration (but the 'port_dump_done'
780 * function will be called afterward).
782 * ->port_dump_done() allows the implementation to release resources used
783 * for iteration. The caller might decide to stop iteration in the middle
784 * by calling this function before ->port_dump_next() returns nonzero.
792 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
795 * struct ofproto_port port;
797 * error = ofproto->ofproto_class->port_dump_next(
798 * ofproto, state, &port);
802 * // Do something with 'port' here (without modifying or freeing
803 * // any of its data).
805 * ofproto->ofproto_class->port_dump_done(ofproto, state);
807 * // 'error' is now EOF (success) or a positive errno value (failure).
809 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
810 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
811 struct ofproto_port *port);
812 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
814 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
815 * in 'ofproto' has changed, then this function should do one of the
818 * - Preferably: store the name of the device that was added to or deleted
819 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
820 * for freeing '*devnamep' (with free()) when it no longer needs it.
822 * - Alternatively: return ENOBUFS, without indicating the device that was
825 * Occasional 'false positives', in which the function returns 0 while
826 * indicating a device that was not actually added or deleted or returns
827 * ENOBUFS without any change, are acceptable.
829 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
830 * externally to the 'ofproto' object, e.g. by a system administrator via
831 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
832 * not report changes made through calls to 'port_add' or 'port_del' on the
833 * same 'ofproto' object. (But it's OK for it to report them too, just
834 * slightly less efficient.)
836 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
837 * also return other positive errno values to indicate that something has
840 * If the set of ports in a datapath is fixed, or if the only way that the
841 * set of ports in a datapath can change is through ->port_add() and
842 * ->port_del(), then this function may be a null pointer.
844 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
846 /* Arranges for the poll loop to wake up when ->port_poll() will return a
847 * value other than EAGAIN.
849 * If the set of ports in a datapath is fixed, or if the only way that the
850 * set of ports in a datapath can change is through ->port_add() and
851 * ->port_del(), or if the poll loop will always wake up anyway when
852 * ->port_poll() will return a value other than EAGAIN, then this function
853 * may be a null pointer.
855 void (*port_poll_wait)(const struct ofproto *ofproto);
857 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
858 * partner information for 'port' is up-to-date, 0 if LACP partner
859 * information is not current (generally indicating a connectivity
860 * problem), or -1 if LACP is not enabled on 'port'.
862 * This function may be a null pointer if the ofproto implementation does
863 * not support LACP. */
864 int (*port_is_lacp_current)(const struct ofport *port);
866 /* ## ----------------------- ## */
867 /* ## OpenFlow Rule Functions ## */
868 /* ## ----------------------- ## */
870 /* Chooses an appropriate table for 'match' within 'ofproto'. On
871 * success, stores the table ID into '*table_idp' and returns 0. On
872 * failure, returns an OpenFlow error code.
874 * The choice of table should be a function of 'match' and 'ofproto''s
875 * datapath capabilities. It should not depend on the flows already in
876 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
877 * 'match' as its matching condition can never be inserted into 'ofproto',
878 * even starting from an empty flow table.
880 * If multiple tables are candidates for inserting the flow, the function
881 * should choose one arbitrarily (but deterministically).
883 * If this function is NULL then table 0 is always chosen. */
884 enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
885 const struct match *match,
888 /* Life-cycle functions for a "struct rule".
894 * The life cycle of a struct rule is an elaboration of the basic life
895 * cycle described above under "Life Cycle".
897 * After a rule is successfully constructed, it is then inserted. If
898 * insertion completes successfully, then before it is later destructed, it
901 * You can think of a rule as having the following extra steps inserted
902 * between "Life Cycle" steps 4 and 5:
904 * 4.1. The client inserts the rule into the flow table, making it
905 * visible in flow table lookups.
907 * 4.2. The client calls "rule_insert". Immediately or eventually, the
908 * implementation calls ofoperation_complete() to indicate that the
909 * insertion completed. If the operation failed, skip to step 5.
911 * 4.3. The rule is now installed in the flow table. Eventually it will
914 * 4.4. The client removes the rule from the flow table. It is no longer
915 * visible in flow table lookups.
917 * 4.5. The client calls "rule_delete". Immediately or eventually, the
918 * implementation calls ofoperation_complete() to indicate that the
919 * deletion completed. Deletion is not allowed to fail, so it must
923 * Asynchronous Operation Support
924 * ==============================
926 * The "insert" and "delete" life-cycle operations on rules can operate
927 * asynchronously, meaning that ->rule_insert() and ->rule_delete() only
928 * need to initiate their respective operations and do not need to wait for
929 * them to complete before they return. ->rule_modify_actions() also
930 * operates asynchronously.
932 * An ofproto implementation reports the success or failure of an
933 * asynchronous operation on a rule using the rule's 'pending' member,
934 * which points to a opaque "struct ofoperation" that represents the
935 * ongoing operation. When the operation completes, the ofproto
936 * implementation calls ofoperation_complete(), passing the ofoperation and
937 * an error indication.
939 * Only the following contexts may call ofoperation_complete():
941 * - The function called to initiate the operation, e.g. ->rule_insert()
942 * or ->rule_delete(). This is the best choice if the operation
945 * - The implementation's ->run() function.
947 * - The implementation's ->destruct() function.
949 * The ofproto base code updates the flow table optimistically, assuming
950 * that the operation will probably succeed:
952 * - ofproto adds the rule in the flow table before calling
955 * - ofproto updates the rule's actions and other properties before
956 * calling ->rule_modify_actions().
958 * - ofproto removes the rule before calling ->rule_delete().
960 * With one exception, when an asynchronous operation completes with an
961 * error, ofoperation_complete() backs out the already applied changes:
963 * - If adding a rule in the flow table fails, ofproto removes the new
966 * - If modifying a rule fails, ofproto restores the original actions
967 * (and other properties).
969 * - Removing a rule is not allowed to fail. It must always succeed.
971 * The ofproto base code serializes operations: if any operation is in
972 * progress on a given rule, ofproto postpones initiating any new operation
973 * on that rule until the pending operation completes. Therefore, every
974 * operation must eventually complete through a call to
975 * ofoperation_complete() to avoid delaying new operations indefinitely
976 * (including any OpenFlow request that affects the rule in question, even
977 * just to query its statistics).
983 * When ->rule_construct() is called, 'rule' is a new rule that is not yet
984 * inserted into a flow table. ->rule_construct() should initialize enough
985 * of the rule's derived state for 'rule' to be suitable for inserting into
986 * a flow table. ->rule_construct() should not modify any base members of
989 * If ->rule_construct() fails (as indicated by returning a nonzero
990 * OpenFlow error code), the ofproto base code will uninitialize and
991 * deallocate 'rule'. See "Rule Life Cycle" above for more details.
993 * ->rule_construct() may also:
995 * - Validate that the datapath supports the matching rule in 'rule->cr'
996 * datapath. For example, if the rule's table does not support
997 * registers, then it is an error if 'rule->cr' does not wildcard all
1000 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
1002 * Some implementations might need to defer these tasks to ->rule_insert(),
1003 * which is also acceptable.
1009 * Following successful construction, the ofproto base case inserts 'rule'
1010 * into its flow table, then it calls ->rule_insert(). ->rule_insert()
1011 * should set in motion adding the new rule to the datapath flow table. It
1012 * must act as follows:
1014 * - If it completes insertion, either by succeeding or failing, it must
1015 * call ofoperation_complete()
1017 * - If insertion is only partially complete, then it must return without
1018 * calling ofoperation_complete(). Later, when the insertion is
1019 * complete, the ->run() or ->destruct() function must call
1020 * ofoperation_complete() to report success or failure.
1022 * If ->rule_insert() fails, the ofproto base code will remove 'rule' from
1023 * the flow table, destruct, uninitialize, and deallocate 'rule'. See
1024 * "Rule Life Cycle" above for more details.
1030 * The ofproto base code removes 'rule' from its flow table before it calls
1031 * ->rule_delete(). ->rule_delete() should set in motion removing 'rule'
1032 * from the datapath flow table. It must act as follows:
1034 * - If it completes deletion, it must call ofoperation_complete().
1036 * - If deletion is only partially complete, then it must return without
1037 * calling ofoperation_complete(). Later, when the deletion is
1038 * complete, the ->run() or ->destruct() function must call
1039 * ofoperation_complete().
1041 * Rule deletion must not fail.
1047 * ->rule_destruct() must uninitialize derived state.
1049 * Rule destruction must not fail. */
1050 struct rule *(*rule_alloc)(void);
1051 enum ofperr (*rule_construct)(struct rule *rule);
1052 void (*rule_insert)(struct rule *rule);
1053 void (*rule_delete)(struct rule *rule);
1054 void (*rule_destruct)(struct rule *rule);
1055 void (*rule_dealloc)(struct rule *rule);
1057 /* Obtains statistics for 'rule', storing the number of packets that have
1058 * matched it in '*packet_count' and the number of bytes in those packets
1059 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
1060 * count is unknown. */
1061 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
1062 uint64_t *byte_count);
1064 /* Applies the actions in 'rule' to 'packet'. (This implements sending
1065 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1067 * Takes ownership of 'packet' (so it should eventually free it, with
1070 * 'flow' reflects the flow information for 'packet'. All of the
1071 * information in 'flow' is extracted from 'packet', except for
1072 * flow->tunnel and flow->in_port, which are assigned the correct values
1073 * for the incoming packet. The register values are zeroed. 'packet''s
1074 * header pointers (e.g. packet->l3) are appropriately initialized.
1075 * packet->l3 is aligned on a 32-bit boundary.
1077 * The implementation should add the statistics for 'packet' into 'rule'.
1079 * Returns 0 if successful, otherwise an OpenFlow error code. */
1080 enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1081 struct ofpbuf *packet);
1083 /* When ->rule_modify_actions() is called, the caller has already replaced
1084 * the OpenFlow actions in 'rule' by a new set. (The original actions are
1085 * in rule->pending->actions.)
1087 * ->rule_modify_actions() should set the following in motion:
1089 * - Validate that the datapath can correctly implement the actions now
1092 * - Update the datapath flow table with the new actions.
1094 * - Only if 'reset_counters' is true, reset any packet or byte counters
1095 * associated with the rule to zero, so that rule_get_stats() will not
1096 * longer count those packets or bytes.
1098 * If the operation synchronously completes, ->rule_modify_actions() may
1099 * call ofoperation_complete() before it returns. Otherwise, ->run()
1100 * should call ofoperation_complete() later, after the operation does
1103 * If the operation fails, then the base ofproto code will restore the
1104 * original 'actions' and 'n_actions' of 'rule'.
1106 * ->rule_modify_actions() should not modify any base members of struct
1108 void (*rule_modify_actions)(struct rule *rule, bool reset_counters);
1110 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1111 * which takes one of the following values, with the corresponding
1114 * - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1115 * as other packets, omitting TCP and UDP port numbers (always setting
1118 * - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1119 * passing them through the flow table.
1121 * - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1122 * passing packets through the flow table.
1124 * - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1125 * except that TCP and UDP port numbers should be included in fragments
1128 * Implementations are not required to support every mode.
1129 * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1131 * At the time of the call to ->set_frag_handling(), the current mode is
1132 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1133 * true if the requested mode was set, false if it is not supported.
1135 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1136 * reflect the new mode.
1138 bool (*set_frag_handling)(struct ofproto *ofproto,
1139 enum ofp_config_flags frag_handling);
1141 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1142 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1144 * The caller retains ownership of 'packet' and of 'ofpacts', so
1145 * ->packet_out() should not modify or free them.
1147 * This function must validate that it can correctly implement 'ofpacts'.
1148 * If not, then it should return an OpenFlow error code.
1150 * 'flow' reflects the flow information for 'packet'. All of the
1151 * information in 'flow' is extracted from 'packet', except for
1152 * flow->in_port (see below). flow->tunnel and its register values are
1155 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1156 * implementation should reject invalid flow->in_port values by returning
1157 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1158 * ofproto_init_max_ports(), then the client will reject these ports
1159 * itself.) For consistency, the implementation should consider valid for
1160 * flow->in_port any value that could possibly be seen in a packet that it
1161 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1162 * that never generates packet-ins (e.g. due to hardware limitations)
1163 * should still allow flow->in_port values for every possible physical port
1164 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1165 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1166 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1167 * these, treating each of them as packets generated by the controller as
1168 * opposed to packets originating from some switch port.
1170 * (Ordinarily the only effect of flow->in_port is on output actions that
1171 * involve the input port, such as actions that output to OFPP_IN_PORT,
1172 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1173 * "resubmit" actions.)
1175 * 'packet' is not matched against the OpenFlow flow table, so its
1176 * statistics should not be included in OpenFlow flow statistics.
1178 * Returns 0 if successful, otherwise an OpenFlow error code. */
1179 enum ofperr (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
1180 const struct flow *flow,
1181 const struct ofpact *ofpacts,
1182 size_t ofpacts_len);
1184 /* ## ------------------------- ## */
1185 /* ## OFPP_NORMAL configuration ## */
1186 /* ## ------------------------- ## */
1188 /* Configures NetFlow on 'ofproto' according to the options in
1189 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1191 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1192 * NetFlow, as does a null pointer. */
1193 int (*set_netflow)(struct ofproto *ofproto,
1194 const struct netflow_options *netflow_options);
1196 void (*get_netflow_ids)(const struct ofproto *ofproto,
1197 uint8_t *engine_type, uint8_t *engine_id);
1199 /* Configures sFlow on 'ofproto' according to the options in
1200 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1202 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1203 * sFlow, as does a null pointer. */
1204 int (*set_sflow)(struct ofproto *ofproto,
1205 const struct ofproto_sflow_options *sflow_options);
1207 /* Configures IPFIX on 'ofproto' according to the options in
1208 * 'bridge_exporter_options' and the 'flow_exporters_options'
1209 * array, or turns off IPFIX if 'bridge_exporter_options' and
1210 * 'flow_exporters_options' is NULL.
1212 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1213 * IPFIX, as does a null pointer. */
1215 struct ofproto *ofproto,
1216 const struct ofproto_ipfix_bridge_exporter_options
1217 *bridge_exporter_options,
1218 const struct ofproto_ipfix_flow_exporter_options
1219 *flow_exporters_options, size_t n_flow_exporters_options);
1221 /* Configures connectivity fault management on 'ofport'.
1223 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1225 * If 'cfm_settings' is null, removes any connectivity fault management
1226 * configuration from 'ofport'.
1228 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1229 * support CFM, as does a null pointer. */
1230 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1232 /* Checks the status of CFM configured on 'ofport'. Returns true if the
1233 * port's CFM status was successfully stored into '*status'. Returns false
1234 * if the port did not have CFM configured, in which case '*status' is
1237 * The caller must provide and owns '*status', but it does not own and must
1238 * not modify or free the array returned in 'status->rmps'. */
1239 bool (*get_cfm_status)(const struct ofport *ofport,
1240 struct ofproto_cfm_status *status);
1242 /* Configures BFD on 'ofport'.
1244 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1245 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1246 * according to 'cfg'.
1248 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1249 * support BFD, as does a null pointer. */
1250 int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1252 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1253 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1254 * that this ofproto_class does not support BFD, as does a null pointer. */
1255 int (*get_bfd_status)(struct ofport *ofport, struct smap *smap);
1257 /* Configures spanning tree protocol (STP) on 'ofproto' using the
1258 * settings defined in 's'.
1260 * If 's' is nonnull, configures STP according to its members.
1262 * If 's' is null, removes any STP configuration from 'ofproto'.
1264 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1265 * support STP, as does a null pointer. */
1266 int (*set_stp)(struct ofproto *ofproto,
1267 const struct ofproto_stp_settings *s);
1269 /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1271 * Stores STP state for 'ofproto' in 's'. If the 'enabled' member
1272 * is false, the other member values are not meaningful.
1274 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1275 * support STP, as does a null pointer. */
1276 int (*get_stp_status)(struct ofproto *ofproto,
1277 struct ofproto_stp_status *s);
1279 /* Configures spanning tree protocol (STP) on 'ofport' using the
1280 * settings defined in 's'.
1282 * If 's' is nonnull, configures STP according to its members. The
1283 * caller is responsible for assigning STP port numbers (using the
1284 * 'port_num' member in the range of 1 through 255, inclusive) and
1285 * ensuring there are no duplicates.
1287 * If 's' is null, removes any STP configuration from 'ofport'.
1289 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1290 * support STP, as does a null pointer. */
1291 int (*set_stp_port)(struct ofport *ofport,
1292 const struct ofproto_port_stp_settings *s);
1294 /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1296 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1297 * false, the other member values are not meaningful.
1299 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1300 * support STP, as does a null pointer. */
1301 int (*get_stp_port_status)(struct ofport *ofport,
1302 struct ofproto_port_stp_status *s);
1304 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1305 * 'queues' attached to 'ofport'. This data is not intended to be
1306 * sufficient to implement QoS. Instead, providers may use this
1307 * information to implement features which require knowledge of what queues
1308 * exist on a port, and some basic information about them.
1310 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1311 * support QoS, as does a null pointer. */
1312 int (*set_queues)(struct ofport *ofport,
1313 const struct ofproto_port_queue *queues, size_t n_qdscp);
1315 /* If 's' is nonnull, this function registers a "bundle" associated with
1316 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
1317 * a Port in OVSDB, that is, it consists of one or more "slave" devices
1318 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1319 * there is more than one slave, a bonding configuration. If 'aux' is
1320 * already registered then this function updates its configuration to 's'.
1321 * Otherwise, this function registers a new bundle.
1323 * If 's' is NULL, this function unregisters the bundle registered on
1324 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
1325 * has been registered, this has no effect.
1327 * This function affects only the behavior of the NXAST_AUTOPATH action and
1328 * output to the OFPP_NORMAL port. An implementation that does not support
1329 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
1330 * that supports only a subset of the functionality should implement what
1331 * it can and return 0. */
1332 int (*bundle_set)(struct ofproto *ofproto, void *aux,
1333 const struct ofproto_bundle_settings *s);
1335 /* If 'port' is part of any bundle, removes it from that bundle. If the
1336 * bundle now has no ports, deletes the bundle. If the bundle now has only
1337 * one port, deconfigures the bundle's bonding configuration. */
1338 void (*bundle_remove)(struct ofport *ofport);
1340 /* If 's' is nonnull, this function registers a mirror associated with
1341 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
1342 * a Mirror in OVSDB. If 'aux' is already registered then this function
1343 * updates its configuration to 's'. Otherwise, this function registers a
1346 * If 's' is NULL, this function unregisters the mirror registered on
1347 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
1348 * has been registered, this has no effect.
1350 * An implementation that does not support mirroring at all may set
1351 * it to NULL or return EOPNOTSUPP. An implementation that supports
1352 * only a subset of the functionality should implement what it can
1354 int (*mirror_set)(struct ofproto *ofproto, void *aux,
1355 const struct ofproto_mirror_settings *s);
1357 /* Retrieves statistics from mirror associated with client data
1358 * pointer 'aux' in 'ofproto'. Stores packet and byte counts in
1359 * 'packets' and 'bytes', respectively. If a particular counter is
1360 * not supported, the appropriate argument is set to UINT64_MAX.
1362 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1363 * support retrieving mirror statistics. */
1364 int (*mirror_get_stats)(struct ofproto *ofproto, void *aux,
1365 uint64_t *packets, uint64_t *bytes);
1367 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1368 * on which all packets are flooded, instead of using MAC learning. If
1369 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1371 * This function affects only the behavior of the OFPP_NORMAL action. An
1372 * implementation that does not support it may set it to NULL or return
1374 int (*set_flood_vlans)(struct ofproto *ofproto,
1375 unsigned long *flood_vlans);
1377 /* Returns true if 'aux' is a registered bundle that is currently in use as
1378 * the output for a mirror. */
1379 bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1381 /* When the configuration option of forward_bpdu changes, this function
1382 * will be invoked. */
1383 void (*forward_bpdu_changed)(struct ofproto *ofproto);
1385 /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1386 * seconds, and the maximum number of MAC table entries to
1389 * An implementation that doesn't support configuring these features may
1390 * set this function to NULL or implement it as a no-op. */
1391 void (*set_mac_table_config)(struct ofproto *ofproto,
1392 unsigned int idle_time, size_t max_entries);
1394 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1396 * This is deprecated. It is only for compatibility with broken device drivers
1397 * in old versions of Linux that do not properly support VLANs when VLAN
1398 * devices are not used. When broken device drivers are no longer in
1399 * widespread use, we will delete these interfaces. */
1401 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1402 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1403 * that has OpenFlow port number 'realdev_ofp_port'.
1405 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1406 * as a VLAN splinter port.
1408 * This function should be NULL if an implementation does not support it.
1410 int (*set_realdev)(struct ofport *ofport,
1411 ofp_port_t realdev_ofp_port, int vid);
1413 /* ## ------------------------ ## */
1414 /* ## OpenFlow meter functions ## */
1415 /* ## ------------------------ ## */
1417 /* These functions should be NULL if an implementation does not support
1418 * them. They must be all null or all non-null.. */
1420 /* Initializes 'features' to describe the metering features supported by
1422 void (*meter_get_features)(const struct ofproto *ofproto,
1423 struct ofputil_meter_features *features);
1425 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1426 * success the function must store a provider meter ID other than
1427 * UINT32_MAX in '*id'. All further references to the meter will be made
1428 * with the returned provider meter id rather than the OpenFlow meter id.
1429 * The caller does not try to interpret the provider meter id, giving the
1430 * implementation the freedom to either use the OpenFlow meter_id value
1431 * provided in the meter configuration, or any other value suitable for the
1434 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1435 * with that meter provider ID to have configuration 'config'. On failure,
1436 * the existing meter configuration is left intact. Regardless of success,
1437 * any change to '*id' updates the provider meter id used for this
1439 enum ofperr (*meter_set)(struct ofproto *ofproto, ofproto_meter_id *id,
1440 const struct ofputil_meter_config *config);
1442 /* Gets the meter and meter band packet and byte counts for maximum of
1443 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1444 * 'ofproto'. The caller fills in the other stats values. The band stats
1445 * are copied to memory at 'stats->bands' provided by the caller. The
1446 * number of returned band stats is returned in 'stats->n_bands'. */
1447 enum ofperr (*meter_get)(const struct ofproto *ofproto,
1448 ofproto_meter_id id,
1449 struct ofputil_meter_stats *stats);
1451 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1453 void (*meter_del)(struct ofproto *, ofproto_meter_id);
1456 extern const struct ofproto_class ofproto_dpif_class;
1458 int ofproto_class_register(const struct ofproto_class *);
1459 int ofproto_class_unregister(const struct ofproto_class *);
1461 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
1462 * because it overlaps with an ongoing flow table operation that has not yet
1463 * completed. The caller should retry the operation later.
1465 * ofproto.c also uses this value internally for additional (similar) purposes.
1467 * This particular value is a good choice because it is large, so that it does
1468 * not collide with any errno value, but not large enough to collide with an
1469 * OFPERR_* value. */
1470 enum { OFPROTO_POSTPONE = 1 << 16 };
1471 BUILD_ASSERT_DECL(OFPROTO_POSTPONE < OFPERR_OFS);
1473 int ofproto_flow_mod(struct ofproto *, struct ofputil_flow_mod *);
1474 void ofproto_add_flow(struct ofproto *, const struct match *,
1475 unsigned int priority,
1476 const struct ofpact *ofpacts, size_t ofpacts_len);
1477 bool ofproto_delete_flow(struct ofproto *,
1478 const struct match *, unsigned int priority);
1479 void ofproto_flush_flows(struct ofproto *);
1481 #endif /* ofproto/ofproto-provider.h */