bfd: Fix typo in comment.
[sliver-openvswitch.git] / ofproto / ofproto-provider.h
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef OFPROTO_OFPROTO_PROVIDER_H
18 #define OFPROTO_OFPROTO_PROVIDER_H 1
19
20 /* Definitions for use within ofproto. */
21
22 #include "ofproto/ofproto.h"
23 #include "cfm.h"
24 #include "classifier.h"
25 #include "heap.h"
26 #include "hindex.h"
27 #include "list.h"
28 #include "ofp-errors.h"
29 #include "ofp-util.h"
30 #include "shash.h"
31 #include "simap.h"
32 #include "timeval.h"
33
34 struct match;
35 struct ofpact;
36 struct ofputil_flow_mod;
37 struct bfd_cfg;
38
39 /* An OpenFlow switch.
40  *
41  * With few exceptions, ofproto implementations may look at these fields but
42  * should not modify them. */
43 struct ofproto {
44     struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
45     const struct ofproto_class *ofproto_class;
46     char *type;                 /* Datapath type. */
47     char *name;                 /* Datapath name. */
48
49     /* Settings. */
50     uint64_t fallback_dpid;     /* Datapath ID if no better choice found. */
51     uint64_t datapath_id;       /* Datapath ID. */
52     bool forward_bpdu;          /* Option to allow forwarding of BPDU frames
53                                  * when NORMAL action is invoked. */
54     char *mfr_desc;             /* Manufacturer (NULL for default)b. */
55     char *hw_desc;              /* Hardware (NULL for default). */
56     char *sw_desc;              /* Software version (NULL for default). */
57     char *serial_desc;          /* Serial number (NULL for default). */
58     char *dp_desc;              /* Datapath description (NULL for default). */
59     enum ofp_config_flags frag_handling; /* One of OFPC_*.  */
60
61     /* Datapath. */
62     struct hmap ports;          /* Contains "struct ofport"s. */
63     struct shash port_by_name;
64     unsigned long *ofp_port_ids;/* Bitmap of used OpenFlow port numbers. */
65     struct simap ofp_requests;  /* OpenFlow port number requests. */
66     ofp_port_t alloc_port_no;   /* Last allocated OpenFlow port number. */
67     ofp_port_t max_ports;       /* Max possible OpenFlow port num, plus one. */
68
69     /* Flow tables. */
70     struct oftable *tables;
71     int n_tables;
72
73     struct hindex cookies;      /* Rules indexed on their cookie values. */
74
75     /* Optimisation for flow expiry.
76      * These flows should all be present in tables. */
77     struct list expirable;      /* Expirable 'struct rule"s in all tables. */
78
79     /* OpenFlow connections. */
80     struct connmgr *connmgr;
81
82     /* Flow table operation tracking. */
83     int state;                  /* Internal state. */
84     struct list pending;        /* List of "struct ofopgroup"s. */
85     unsigned int n_pending;     /* list_size(&pending). */
86     struct hmap deletions;      /* All OFOPERATION_DELETE "ofoperation"s. */
87
88     /* Flow table operation logging. */
89     int n_add, n_delete, n_modify; /* Number of unreported ops of each kind. */
90     long long int first_op, last_op; /* Range of times for unreported ops. */
91     long long int next_op_report;    /* Time to report ops, or LLONG_MAX. */
92     long long int op_backoff;        /* Earliest time to report ops again. */
93
94     /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
95      *
96      * This is deprecated.  It is only for compatibility with broken device
97      * drivers in old versions of Linux that do not properly support VLANs when
98      * VLAN devices are not used.  When broken device drivers are no longer in
99      * widespread use, we will delete these interfaces. */
100     unsigned long int *vlan_bitmap; /* 4096-bit bitmap of in-use VLANs. */
101     bool vlans_changed;             /* True if new VLANs are in use. */
102     int min_mtu;                    /* Current MTU of non-internal ports. */
103 };
104
105 void ofproto_init_tables(struct ofproto *, int n_tables);
106 void ofproto_init_max_ports(struct ofproto *, ofp_port_t max_ports);
107
108 struct ofproto *ofproto_lookup(const char *name);
109 struct ofport *ofproto_get_port(const struct ofproto *, ofp_port_t ofp_port);
110
111 /* An OpenFlow port within a "struct ofproto".
112  *
113  * With few exceptions, ofproto implementations may look at these fields but
114  * should not modify them. */
115 struct ofport {
116     struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
117     struct ofproto *ofproto;    /* The ofproto that contains this port. */
118     struct netdev *netdev;
119     struct ofputil_phy_port pp;
120     ofp_port_t ofp_port;        /* OpenFlow port number. */
121     unsigned int change_seq;
122     long long int created;      /* Time created, in msec. */
123     int mtu;
124 };
125
126 void ofproto_port_set_state(struct ofport *, enum ofputil_port_state);
127
128 /* OpenFlow table flags:
129  *
130  *   - "Hidden" tables are not included in OpenFlow operations that operate on
131  *     "all tables".  For example, a request for flow stats on all tables will
132  *     omit flows in hidden tables, table stats requests will omit the table
133  *     entirely, and the switch features reply will not count the hidden table.
134  *
135  *     However, operations that specifically name the particular table still
136  *     operate on it.  For example, flow_mods and flow stats requests on a
137  *     hidden table work.
138  *
139  *     To avoid gaps in table IDs (which have unclear validity in OpenFlow),
140  *     hidden tables must be the highest-numbered tables that a provider
141  *     implements.
142  *
143  *   - "Read-only" tables can't be changed through OpenFlow operations.  (At
144  *     the moment all flow table operations go effectively through OpenFlow, so
145  *     this means that read-only tables can't be changed at all after the
146  *     read-only flag is set.)
147  *
148  * The generic ofproto layer never sets these flags.  An ofproto provider can
149  * set them if it is appropriate.
150  */
151 enum oftable_flags {
152     OFTABLE_HIDDEN = 1 << 0,   /* Hide from most OpenFlow operations. */
153     OFTABLE_READONLY = 1 << 1  /* Don't allow OpenFlow to change this table. */
154 };
155
156 /* A flow table within a "struct ofproto". */
157 struct oftable {
158     enum oftable_flags flags;
159     struct classifier cls;      /* Contains "struct rule"s. */
160     char *name;                 /* Table name exposed via OpenFlow, or NULL. */
161
162     /* Maximum number of flows or UINT_MAX if there is no limit besides any
163      * limit imposed by resource limitations. */
164     unsigned int max_flows;
165
166     /* These members determine the handling of an attempt to add a flow that
167      * would cause the table to have more than 'max_flows' flows.
168      *
169      * If 'eviction_fields' is NULL, overflows will be rejected with an error.
170      *
171      * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
172      * is nonzero), an overflow will cause a flow to be removed.  The flow to
173      * be removed is chosen to give fairness among groups distinguished by
174      * different values for the subfields within 'groups'. */
175     struct mf_subfield *eviction_fields;
176     size_t n_eviction_fields;
177
178     /* Eviction groups.
179      *
180      * When a flow is added that would cause the table to have more than
181      * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
182      * used to decide which rule to evict: the rule is chosen from the eviction
183      * group that contains the greatest number of rules.*/
184     uint32_t eviction_group_id_basis;
185     struct hmap eviction_groups_by_id;
186     struct heap eviction_groups_by_size;
187 };
188
189 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
190  *
191  * All parameters are evaluated multiple times. */
192 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO)              \
193     for ((TABLE) = (OFPROTO)->tables;                       \
194          (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
195          (TABLE)++)
196
197 /* An OpenFlow flow within a "struct ofproto".
198  *
199  * With few exceptions, ofproto implementations may look at these fields but
200  * should not modify them. */
201 struct rule {
202     struct list ofproto_node;    /* Owned by ofproto base code. */
203     struct ofproto *ofproto;     /* The ofproto that contains this rule. */
204     struct cls_rule cr;          /* In owning ofproto's classifier. */
205
206     struct ofoperation *pending; /* Operation now in progress, if nonnull. */
207
208     ovs_be64 flow_cookie;        /* Controller-issued identifier. */
209     struct hindex_node cookie_node; /* In owning ofproto's 'cookies' index. */
210
211     long long int created;       /* Creation time. */
212     long long int modified;      /* Time of last modification. */
213     long long int used;          /* Last use; time created if never used. */
214     uint16_t hard_timeout;       /* In seconds from ->modified. */
215     uint16_t idle_timeout;       /* In seconds from ->used. */
216     uint8_t table_id;            /* Index in ofproto's 'tables' array. */
217     bool send_flow_removed;      /* Send a flow removed message? */
218
219     /* Eviction groups. */
220     bool evictable;              /* If false, prevents eviction. */
221     struct heap_node evg_node;   /* In eviction_group's "rules" heap. */
222     struct eviction_group *eviction_group; /* NULL if not in any group. */
223
224     struct ofpact *ofpacts;      /* Sequence of "struct ofpacts". */
225     unsigned int ofpacts_len;    /* Size of 'ofpacts', in bytes. */
226
227     /* Flow monitors. */
228     enum nx_flow_monitor_flags monitor_flags;
229     uint64_t add_seqno;         /* Sequence number when added. */
230     uint64_t modify_seqno;      /* Sequence number when changed. */
231
232     /* Optimisation for flow expiry. */
233     struct list expirable;      /* In ofproto's 'expirable' list if this rule
234                                  * is expirable, otherwise empty. */
235 };
236
237 /* Threshold at which to begin flow table eviction. Only affects the
238  * ofproto-dpif implementation */
239 extern unsigned flow_eviction_threshold;
240
241 /* Determines which model to use for handling misses in the ofproto-dpif
242  * implementation */
243 extern enum ofproto_flow_miss_model flow_miss_model;
244
245 static inline struct rule *
246 rule_from_cls_rule(const struct cls_rule *cls_rule)
247 {
248     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
249 }
250
251 void ofproto_rule_update_used(struct rule *, long long int used);
252 void ofproto_rule_expire(struct rule *, uint8_t reason);
253 void ofproto_rule_destroy(struct rule *);
254
255 bool ofproto_rule_has_out_port(const struct rule *, ofp_port_t out_port);
256
257 void ofoperation_complete(struct ofoperation *, enum ofperr);
258 struct rule *ofoperation_get_victim(struct ofoperation *);
259
260 bool ofoperation_has_out_port(const struct ofoperation *, ofp_port_t out_port);
261
262 bool ofproto_rule_is_hidden(const struct rule *);
263
264 /* ofproto class structure, to be defined by each ofproto implementation.
265  *
266  *
267  * Data Structures
268  * ===============
269  *
270  * These functions work primarily with three different kinds of data
271  * structures:
272  *
273  *   - "struct ofproto", which represents an OpenFlow switch.
274  *
275  *   - "struct ofport", which represents a port within an ofproto.
276  *
277  *   - "struct rule", which represents an OpenFlow flow within an ofproto.
278  *
279  * Each of these data structures contains all of the implementation-independent
280  * generic state for the respective concept, called the "base" state.  None of
281  * them contains any extra space for ofproto implementations to use.  Instead,
282  * each implementation is expected to declare its own data structure that
283  * contains an instance of the generic data structure plus additional
284  * implementation-specific members, called the "derived" state.  The
285  * implementation can use casts or (preferably) the CONTAINER_OF macro to
286  * obtain access to derived state given only a pointer to the embedded generic
287  * data structure.
288  *
289  *
290  * Life Cycle
291  * ==========
292  *
293  * Four stylized functions accompany each of these data structures:
294  *
295  *            "alloc"       "construct"       "destruct"       "dealloc"
296  *            ------------  ----------------  ---------------  --------------
297  *   ofproto  ->alloc       ->construct       ->destruct       ->dealloc
298  *   ofport   ->port_alloc  ->port_construct  ->port_destruct  ->port_dealloc
299  *   rule     ->rule_alloc  ->rule_construct  ->rule_destruct  ->rule_dealloc
300  *
301  * Any instance of a given data structure goes through the following life
302  * cycle:
303  *
304  *   1. The client calls the "alloc" function to obtain raw memory.  If "alloc"
305  *      fails, skip all the other steps.
306  *
307  *   2. The client initializes all of the data structure's base state.  If this
308  *      fails, skip to step 7.
309  *
310  *   3. The client calls the "construct" function.  The implementation
311  *      initializes derived state.  It may refer to the already-initialized
312  *      base state.  If "construct" fails, skip to step 6.
313  *
314  *   4. The data structure is now initialized and in use.
315  *
316  *   5. When the data structure is no longer needed, the client calls the
317  *      "destruct" function.  The implementation uninitializes derived state.
318  *      The base state has not been uninitialized yet, so the implementation
319  *      may still refer to it.
320  *
321  *   6. The client uninitializes all of the data structure's base state.
322  *
323  *   7. The client calls the "dealloc" to free the raw memory.  The
324  *      implementation must not refer to base or derived state in the data
325  *      structure, because it has already been uninitialized.
326  *
327  * Each "alloc" function allocates and returns a new instance of the respective
328  * data structure.  The "alloc" function is not given any information about the
329  * use of the new data structure, so it cannot perform much initialization.
330  * Its purpose is just to ensure that the new data structure has enough room
331  * for base and derived state.  It may return a null pointer if memory is not
332  * available, in which case none of the other functions is called.
333  *
334  * Each "construct" function initializes derived state in its respective data
335  * structure.  When "construct" is called, all of the base state has already
336  * been initialized, so the "construct" function may refer to it.  The
337  * "construct" function is allowed to fail, in which case the client calls the
338  * "dealloc" function (but not the "destruct" function).
339  *
340  * Each "destruct" function uninitializes and frees derived state in its
341  * respective data structure.  When "destruct" is called, the base state has
342  * not yet been uninitialized, so the "destruct" function may refer to it.  The
343  * "destruct" function is not allowed to fail.
344  *
345  * Each "dealloc" function frees raw memory that was allocated by the the
346  * "alloc" function.  The memory's base and derived members might not have ever
347  * been initialized (but if "construct" returned successfully, then it has been
348  * "destruct"ed already).  The "dealloc" function is not allowed to fail.
349  *
350  *
351  * Conventions
352  * ===========
353  *
354  * Most of these functions return 0 if they are successful or a positive error
355  * code on failure.  Depending on the function, valid error codes are either
356  * errno values or OFPERR_* OpenFlow error codes.
357  *
358  * Most of these functions are expected to execute synchronously, that is, to
359  * block as necessary to obtain a result.  Thus, these functions may return
360  * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
361  * explicitly say those errors are a possibility.  We may relax this
362  * requirement in the future if and when we encounter performance problems. */
363 struct ofproto_class {
364 /* ## ----------------- ## */
365 /* ## Factory Functions ## */
366 /* ## ----------------- ## */
367
368     /* Initializes provider.  The caller may pass in 'iface_hints',
369      * which contains an shash of "struct iface_hint" elements indexed
370      * by the interface's name.  The provider may use these hints to
371      * describe the startup configuration in order to reinitialize its
372      * state.  The caller owns the provided data, so a provider must
373      * make copies of anything required.  An ofproto provider must
374      * remove any existing state that is not described by the hint, and
375      * may choose to remove it all. */
376     void (*init)(const struct shash *iface_hints);
377
378     /* Enumerates the types of all support ofproto types into 'types'.  The
379      * caller has already initialized 'types' and other ofproto classes might
380      * already have added names to it. */
381     void (*enumerate_types)(struct sset *types);
382
383     /* Enumerates the names of all existing datapath of the specified 'type'
384      * into 'names' 'all_dps'.  The caller has already initialized 'names' as
385      * an empty sset.
386      *
387      * 'type' is one of the types enumerated by ->enumerate_types().
388      *
389      * Returns 0 if successful, otherwise a positive errno value.
390      */
391     int (*enumerate_names)(const char *type, struct sset *names);
392
393     /* Deletes the datapath with the specified 'type' and 'name'.  The caller
394      * should have closed any open ofproto with this 'type' and 'name'; this
395      * function is allowed to fail if that is not the case.
396      *
397      * 'type' is one of the types enumerated by ->enumerate_types().
398      * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
399      *
400      * Returns 0 if successful, otherwise a positive errno value.
401      */
402     int (*del)(const char *type, const char *name);
403
404     /* Returns the type to pass to netdev_open() when a datapath of type
405      * 'datapath_type' has a port of type 'port_type', for a few special
406      * cases when a netdev type differs from a port type.  For example,
407      * when using the userspace datapath, a port of type "internal"
408      * needs to be opened as "tap".
409      *
410      * Returns either 'type' itself or a string literal, which must not
411      * be freed. */
412     const char *(*port_open_type)(const char *datapath_type,
413                                   const char *port_type);
414
415 /* ## ------------------------ ## */
416 /* ## Top-Level type Functions ## */
417 /* ## ------------------------ ## */
418
419     /* Performs any periodic activity required on ofprotos of type
420      * 'type'.
421      *
422      * An ofproto provider may implement it or not, depending on whether
423      * it needs type-level maintenance.
424      *
425      * Returns 0 if successful, otherwise a positive errno value. */
426     int (*type_run)(const char *type);
427
428     /* Performs periodic activity required on ofprotos of type 'type'
429      * that needs to be done with the least possible latency.
430      *
431      * This is run multiple times per main loop.  An ofproto provider may
432      * implement it or not, according to whether it provides a performance
433      * boost for that ofproto implementation.
434      *
435      * Returns 0 if successful, otherwise a positive errno value. */
436     int (*type_run_fast)(const char *type);
437
438     /* Causes the poll loop to wake up when a type 'type''s 'run'
439      * function needs to be called, e.g. by calling the timer or fd
440      * waiting functions in poll-loop.h.
441      *
442      * An ofproto provider may implement it or not, depending on whether
443      * it needs type-level maintenance. */
444     void (*type_wait)(const char *type);
445
446 /* ## --------------------------- ## */
447 /* ## Top-Level ofproto Functions ## */
448 /* ## --------------------------- ## */
449
450     /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
451      *
452      *
453      * Construction
454      * ============
455      *
456      * ->construct() should not modify any base members of the ofproto.  The
457      * client will initialize the ofproto's 'ports' and 'tables' members after
458      * construction is complete.
459      *
460      * When ->construct() is called, the client does not yet know how many flow
461      * tables the datapath supports, so ofproto->n_tables will be 0 and
462      * ofproto->tables will be NULL.  ->construct() should call
463      * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
464      * ofproto->tables.  Each flow table will be initially empty, so
465      * ->construct() should delete flows from the underlying datapath, if
466      * necessary, rather than populating the tables.
467      *
468      * If the ofproto knows the maximum port number that the datapath can have,
469      * then it can call ofproto_init_max_ports().  If it does so, then the
470      * client will ensure that the actions it allows to be used through
471      * OpenFlow do not refer to ports above that maximum number.
472      *
473      * Only one ofproto instance needs to be supported for any given datapath.
474      * If a datapath is already open as part of one "ofproto", then another
475      * attempt to "construct" the same datapath as part of another ofproto is
476      * allowed to fail with an error.
477      *
478      * ->construct() returns 0 if successful, otherwise a positive errno
479      * value.
480      *
481      *
482      * Destruction
483      * ===========
484      *
485      * If 'ofproto' has any pending asynchronous operations, ->destruct()
486      * must complete all of them by calling ofoperation_complete().
487      *
488      * ->destruct() must also destroy all remaining rules in the ofproto's
489      * tables, by passing each remaining rule to ofproto_rule_destroy().  The
490      * client will destroy the flow tables themselves after ->destruct()
491      * returns.
492      */
493     struct ofproto *(*alloc)(void);
494     int (*construct)(struct ofproto *ofproto);
495     void (*destruct)(struct ofproto *ofproto);
496     void (*dealloc)(struct ofproto *ofproto);
497
498     /* Performs any periodic activity required by 'ofproto'.  It should:
499      *
500      *   - Call connmgr_send_packet_in() for each received packet that missed
501      *     in the OpenFlow flow table or that had a OFPP_CONTROLLER output
502      *     action.
503      *
504      *   - Call ofproto_rule_expire() for each OpenFlow flow that has reached
505      *     its hard_timeout or idle_timeout, to expire the flow.
506      *
507      *     (But rules that are part of a pending operation, e.g. rules for
508      *     which ->pending is true, may not expire.)
509      *
510      * Returns 0 if successful, otherwise a positive errno value. */
511     int (*run)(struct ofproto *ofproto);
512
513     /* Performs periodic activity required by 'ofproto' that needs to be done
514      * with the least possible latency.
515      *
516      * This is run multiple times per main loop.  An ofproto provider may
517      * implement it or not, according to whether it provides a performance
518      * boost for that ofproto implementation. */
519     int (*run_fast)(struct ofproto *ofproto);
520
521     /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
522      * be called, e.g. by calling the timer or fd waiting functions in
523      * poll-loop.h.  */
524     void (*wait)(struct ofproto *ofproto);
525
526     /* Adds some memory usage statistics for the implementation of 'ofproto'
527      * into 'usage', for use with memory_report().
528      *
529      * This function is optional. */
530     void (*get_memory_usage)(const struct ofproto *ofproto,
531                              struct simap *usage);
532
533     /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
534      * This function may prepare for that, for example by clearing state in
535      * advance.  It should *not* actually delete any "struct rule"s from
536      * 'ofproto', only prepare for it.
537      *
538      * This function is optional; it's really just for optimization in case
539      * it's cheaper to delete all the flows from your hardware in a single pass
540      * than to do it one by one. */
541     void (*flush)(struct ofproto *ofproto);
542
543     /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
544      *
545      * The implementation should store true in '*arp_match_ip' if the switch
546      * supports matching IP addresses inside ARP requests and replies, false
547      * otherwise.
548      *
549      * The implementation should store in '*actions' a bitmap of the supported
550      * OpenFlow actions.  Vendor actions are not included in '*actions'. */
551     void (*get_features)(struct ofproto *ofproto,
552                          bool *arp_match_ip,
553                          enum ofputil_action_bitmap *actions);
554
555     /* Helper for the OpenFlow OFPST_TABLE statistics request.
556      *
557      * The 'ots' array contains 'ofproto->n_tables' elements.  Each element is
558      * initialized as:
559      *
560      *   - 'table_id' to the array index.
561      *
562      *   - 'name' to "table#" where # is the table ID.
563      *
564      *   - 'match' and 'wildcards' to OFPXMT12_MASK.
565      *
566      *   - 'write_actions' and 'apply_actions' to OFPAT12_OUTPUT.
567      *
568      *   - 'write_setfields' and 'apply_setfields' to OFPXMT12_MASK.
569      *
570      *   - 'metadata_match' and 'metadata_write' to UINT64_MAX.
571      *
572      *   - 'instructions' to OFPIT11_ALL.
573      *
574      *   - 'config' to OFPTC11_TABLE_MISS_MASK.
575      *
576      *   - 'max_entries' to 1,000,000.
577      *
578      *   - 'active_count' to the classifier_count() for the table.
579      *
580      *   - 'lookup_count' and 'matched_count' to 0.
581      *
582      * The implementation should update any members in each element for which
583      * it has better values:
584      *
585      *   - 'name' to a more meaningful name.
586      *
587      *   - 'wildcards' to the set of wildcards actually supported by the table
588      *     (if it doesn't support all OpenFlow wildcards).
589      *
590      *   - 'instructions' to set the instructions actually supported by
591      *     the table.
592      *
593      *   - 'write_actions' to set the write actions actually supported by
594      *     the table (if it doesn't support all OpenFlow actions).
595      *
596      *   - 'apply_actions' to set the apply actions actually supported by
597      *     the table (if it doesn't support all OpenFlow actions).
598      *
599      *   - 'write_setfields' to set the write setfields actually supported by
600      *     the table.
601      *
602      *   - 'apply_setfields' to set the apply setfields actually supported by
603      *     the table.
604      *
605      *   - 'max_entries' to the maximum number of flows actually supported by
606      *     the hardware.
607      *
608      *   - 'lookup_count' to the number of packets looked up in this flow table
609      *     so far.
610      *
611      *   - 'matched_count' to the number of packets looked up in this flow
612      *     table so far that matched one of the flow entries.
613      *
614      * All of the members of struct ofp12_table_stats are in network byte
615      * order.
616      */
617     void (*get_tables)(struct ofproto *ofproto, struct ofp12_table_stats *ots);
618
619 /* ## ---------------- ## */
620 /* ## ofport Functions ## */
621 /* ## ---------------- ## */
622
623     /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
624      *
625      * ->port_construct() should not modify any base members of the ofport.
626      * An ofproto implementation should use the 'ofp_port' member of
627      * "struct ofport" as the OpenFlow port number.
628      *
629      * ofports are managed by the base ofproto code.  The ofproto
630      * implementation should only create and destroy them in response to calls
631      * to these functions.  The base ofproto code will create and destroy
632      * ofports in the following situations:
633      *
634      *   - Just after the ->construct() function is called, the base ofproto
635      *     iterates over all of the implementation's ports, using
636      *     ->port_dump_start() and related functions, and constructs an ofport
637      *     for each dumped port.
638      *
639      *   - If ->port_poll() reports that a specific port has changed, then the
640      *     base ofproto will query that port with ->port_query_by_name() and
641      *     construct or destruct ofports as necessary to reflect the updated
642      *     set of ports.
643      *
644      *   - If ->port_poll() returns ENOBUFS to report an unspecified port set
645      *     change, then the base ofproto will iterate over all of the
646      *     implementation's ports, in the same way as at ofproto
647      *     initialization, and construct and destruct ofports to reflect all of
648      *     the changes.
649      *
650      * ->port_construct() returns 0 if successful, otherwise a positive errno
651      * value.
652      */
653     struct ofport *(*port_alloc)(void);
654     int (*port_construct)(struct ofport *ofport);
655     void (*port_destruct)(struct ofport *ofport);
656     void (*port_dealloc)(struct ofport *ofport);
657
658     /* Called after 'ofport->netdev' is replaced by a new netdev object.  If
659      * the ofproto implementation uses the ofport's netdev internally, then it
660      * should switch to using the new one.  The old one has been closed.
661      *
662      * An ofproto implementation that doesn't need to do anything in this
663      * function may use a null pointer. */
664     void (*port_modified)(struct ofport *ofport);
665
666     /* Called after an OpenFlow request changes a port's configuration.
667      * 'ofport->pp.config' contains the new configuration.  'old_config'
668      * contains the previous configuration.
669      *
670      * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
671      * turn NETDEV_UP on and off, so this function doesn't have to do anything
672      * for that bit (and it won't be called if that is the only bit that
673      * changes). */
674     void (*port_reconfigured)(struct ofport *ofport,
675                               enum ofputil_port_config old_config);
676
677     /* Looks up a port named 'devname' in 'ofproto'.  On success, initializes
678      * '*port' appropriately.
679      *
680      * The caller owns the data in 'port' and must free it with
681      * ofproto_port_destroy() when it is no longer needed. */
682     int (*port_query_by_name)(const struct ofproto *ofproto,
683                               const char *devname, struct ofproto_port *port);
684
685     /* Attempts to add 'netdev' as a port on 'ofproto'.  Returns 0 if
686      * successful, otherwise a positive errno value.  The caller should
687      * inform the implementation of the OpenFlow port through the
688      * ->port_construct() method.
689      *
690      * It doesn't matter whether the new port will be returned by a later call
691      * to ->port_poll(); the implementation may do whatever is more
692      * convenient. */
693     int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
694
695     /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.  Returns
696      * 0 if successful, otherwise a positive errno value.
697      *
698      * It doesn't matter whether the new port will be returned by a later call
699      * to ->port_poll(); the implementation may do whatever is more
700      * convenient. */
701     int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
702
703     /* Get port stats */
704     int (*port_get_stats)(const struct ofport *port,
705                           struct netdev_stats *stats);
706
707     /* Port iteration functions.
708      *
709      * The client might not be entirely in control of the ports within an
710      * ofproto.  Some hardware implementations, for example, might have a fixed
711      * set of ports in a datapath.  For this reason, the client needs a way to
712      * iterate through all the ports that are actually in a datapath.  These
713      * functions provide that functionality.
714      *
715      * The 'state' pointer provides the implementation a place to
716      * keep track of its position.  Its format is opaque to the caller.
717      *
718      * The ofproto provider retains ownership of the data that it stores into
719      * ->port_dump_next()'s 'port' argument.  The data must remain valid until
720      * at least the next call to ->port_dump_next() or ->port_dump_done() for
721      * 'state'.  The caller will not modify or free it.
722      *
723      * Details
724      * =======
725      *
726      * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
727      * On success, it should return 0 and initialize '*statep' with any data
728      * needed for iteration.  On failure, returns a positive errno value, and
729      * the client will not call ->port_dump_next() or ->port_dump_done().
730      *
731      * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
732      * 'state'.  If there is another port, it should store the port's
733      * information into 'port' and return 0.  It should return EOF if all ports
734      * have already been iterated.  Otherwise, on error, it should return a
735      * positive errno value.  This function will not be called again once it
736      * returns nonzero once for a given iteration (but the 'port_dump_done'
737      * function will be called afterward).
738      *
739      * ->port_dump_done() allows the implementation to release resources used
740      * for iteration.  The caller might decide to stop iteration in the middle
741      * by calling this function before ->port_dump_next() returns nonzero.
742      *
743      * Usage Example
744      * =============
745      *
746      * int error;
747      * void *state;
748      *
749      * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
750      * if (!error) {
751      *     for (;;) {
752      *         struct ofproto_port port;
753      *
754      *         error = ofproto->ofproto_class->port_dump_next(
755      *                     ofproto, state, &port);
756      *         if (error) {
757      *             break;
758      *         }
759      *         // Do something with 'port' here (without modifying or freeing
760      *         // any of its data).
761      *     }
762      *     ofproto->ofproto_class->port_dump_done(ofproto, state);
763      * }
764      * // 'error' is now EOF (success) or a positive errno value (failure).
765      */
766     int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
767     int (*port_dump_next)(const struct ofproto *ofproto, void *state,
768                           struct ofproto_port *port);
769     int (*port_dump_done)(const struct ofproto *ofproto, void *state);
770
771     /* Polls for changes in the set of ports in 'ofproto'.  If the set of ports
772      * in 'ofproto' has changed, then this function should do one of the
773      * following:
774      *
775      * - Preferably: store the name of the device that was added to or deleted
776      *   from 'ofproto' in '*devnamep' and return 0.  The caller is responsible
777      *   for freeing '*devnamep' (with free()) when it no longer needs it.
778      *
779      * - Alternatively: return ENOBUFS, without indicating the device that was
780      *   added or deleted.
781      *
782      * Occasional 'false positives', in which the function returns 0 while
783      * indicating a device that was not actually added or deleted or returns
784      * ENOBUFS without any change, are acceptable.
785      *
786      * The purpose of 'port_poll' is to let 'ofproto' know about changes made
787      * externally to the 'ofproto' object, e.g. by a system administrator via
788      * ovs-dpctl.  Therefore, it's OK, and even preferable, for port_poll() to
789      * not report changes made through calls to 'port_add' or 'port_del' on the
790      * same 'ofproto' object.  (But it's OK for it to report them too, just
791      * slightly less efficient.)
792      *
793      * If the set of ports in 'ofproto' has not changed, returns EAGAIN.  May
794      * also return other positive errno values to indicate that something has
795      * gone wrong.
796      *
797      * If the set of ports in a datapath is fixed, or if the only way that the
798      * set of ports in a datapath can change is through ->port_add() and
799      * ->port_del(), then this function may be a null pointer.
800      */
801     int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
802
803     /* Arranges for the poll loop to wake up when ->port_poll() will return a
804      * value other than EAGAIN.
805      *
806      * If the set of ports in a datapath is fixed, or if the only way that the
807      * set of ports in a datapath can change is through ->port_add() and
808      * ->port_del(), or if the poll loop will always wake up anyway when
809      * ->port_poll() will return a value other than EAGAIN, then this function
810      * may be a null pointer.
811      */
812     void (*port_poll_wait)(const struct ofproto *ofproto);
813
814     /* Checks the status of LACP negotiation for 'port'.  Returns 1 if LACP
815      * partner information for 'port' is up-to-date, 0 if LACP partner
816      * information is not current (generally indicating a connectivity
817      * problem), or -1 if LACP is not enabled on 'port'.
818      *
819      * This function may be a null pointer if the ofproto implementation does
820      * not support LACP. */
821     int (*port_is_lacp_current)(const struct ofport *port);
822
823 /* ## ----------------------- ## */
824 /* ## OpenFlow Rule Functions ## */
825 /* ## ----------------------- ## */
826
827     /* Chooses an appropriate table for 'match' within 'ofproto'.  On
828      * success, stores the table ID into '*table_idp' and returns 0.  On
829      * failure, returns an OpenFlow error code.
830      *
831      * The choice of table should be a function of 'match' and 'ofproto''s
832      * datapath capabilities.  It should not depend on the flows already in
833      * 'ofproto''s flow tables.  Failure implies that an OpenFlow rule with
834      * 'match' as its matching condition can never be inserted into 'ofproto',
835      * even starting from an empty flow table.
836      *
837      * If multiple tables are candidates for inserting the flow, the function
838      * should choose one arbitrarily (but deterministically).
839      *
840      * If this function is NULL then table 0 is always chosen. */
841     enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
842                                      const struct match *match,
843                                      uint8_t *table_idp);
844
845     /* Life-cycle functions for a "struct rule" (see "Life Cycle" above).
846      *
847      *
848      * Asynchronous Operation Support
849      * ==============================
850      *
851      * The life-cycle operations on rules can operate asynchronously, meaning
852      * that ->rule_construct() and ->rule_destruct() only need to initiate
853      * their respective operations and do not need to wait for them to complete
854      * before they return.  ->rule_modify_actions() also operates
855      * asynchronously.
856      *
857      * An ofproto implementation reports the success or failure of an
858      * asynchronous operation on a rule using the rule's 'pending' member,
859      * which points to a opaque "struct ofoperation" that represents the
860      * ongoing opreation.  When the operation completes, the ofproto
861      * implementation calls ofoperation_complete(), passing the ofoperation and
862      * an error indication.
863      *
864      * Only the following contexts may call ofoperation_complete():
865      *
866      *   - The function called to initiate the operation,
867      *     e.g. ->rule_construct() or ->rule_destruct().  This is the best
868      *     choice if the operation completes quickly.
869      *
870      *   - The implementation's ->run() function.
871      *
872      *   - The implementation's ->destruct() function.
873      *
874      * The ofproto base code updates the flow table optimistically, assuming
875      * that the operation will probably succeed:
876      *
877      *   - ofproto adds or replaces the rule in the flow table before calling
878      *     ->rule_construct().
879      *
880      *   - ofproto updates the rule's actions before calling
881      *     ->rule_modify_actions().
882      *
883      *   - ofproto removes the rule before calling ->rule_destruct().
884      *
885      * With one exception, when an asynchronous operation completes with an
886      * error, ofoperation_complete() backs out the already applied changes:
887      *
888      *   - If adding or replacing a rule in the flow table fails, ofproto
889      *     removes the new rule or restores the original rule.
890      *
891      *   - If modifying a rule's actions fails, ofproto restores the original
892      *     actions.
893      *
894      *   - Removing a rule is not allowed to fail.  It must always succeed.
895      *
896      * The ofproto base code serializes operations: if any operation is in
897      * progress on a given rule, ofproto postpones initiating any new operation
898      * on that rule until the pending operation completes.  Therefore, every
899      * operation must eventually complete through a call to
900      * ofoperation_complete() to avoid delaying new operations indefinitely
901      * (including any OpenFlow request that affects the rule in question, even
902      * just to query its statistics).
903      *
904      *
905      * Construction
906      * ============
907      *
908      * When ->rule_construct() is called, the caller has already inserted
909      * 'rule' into 'rule->ofproto''s flow table numbered 'rule->table_id'.
910      * There are two cases:
911      *
912      *   - 'rule' is a new rule in its flow table.  In this case,
913      *     ofoperation_get_victim(rule) returns NULL.
914      *
915      *   - 'rule' is replacing an existing rule in its flow table that had the
916      *     same matching criteria and priority.  In this case,
917      *     ofoperation_get_victim(rule) returns the rule being replaced (the
918      *     "victim" rule).
919      *
920      * ->rule_construct() should set the following in motion:
921      *
922      *   - Validate that the matching rule in 'rule->cr' is supported by the
923      *     datapath.  For example, if the rule's table does not support
924      *     registers, then it is an error if 'rule->cr' does not wildcard all
925      *     registers.
926      *
927      *   - Validate that the datapath can correctly implement 'rule->ofpacts'.
928      *
929      *   - If the rule is valid, update the datapath flow table, adding the new
930      *     rule or replacing the existing one.
931      *
932      *   - If 'rule' is replacing an existing rule, uninitialize any derived
933      *     state for the victim rule, as in step 5 in the "Life Cycle"
934      *     described above.
935      *
936      * (On failure, the ofproto code will roll back the insertion from the flow
937      * table, either removing 'rule' or replacing it by the victim rule if
938      * there is one.)
939      *
940      * ->rule_construct() must act in one of the following ways:
941      *
942      *   - If it succeeds, it must call ofoperation_complete() and return 0.
943      *
944      *   - If it fails, it must act in one of the following ways:
945      *
946      *       * Call ofoperation_complete() and return 0.
947      *
948      *       * Return an OpenFlow error code.  (Do not call
949      *         ofoperation_complete() in this case.)
950      *
951      *     Either way, ->rule_destruct() will not be called for 'rule', but
952      *     ->rule_dealloc() will be.
953      *
954      *   - If the operation is only partially complete, then it must return 0.
955      *     Later, when the operation is complete, the ->run() or ->destruct()
956      *     function must call ofoperation_complete() to report success or
957      *     failure.
958      *
959      * ->rule_construct() should not modify any base members of struct rule.
960      *
961      *
962      * Destruction
963      * ===========
964      *
965      * When ->rule_destruct() is called, the caller has already removed 'rule'
966      * from 'rule->ofproto''s flow table.  ->rule_destruct() should set in
967      * motion removing 'rule' from the datapath flow table.  If removal
968      * completes synchronously, it should call ofoperation_complete().
969      * Otherwise, the ->run() or ->destruct() function must later call
970      * ofoperation_complete() after the operation completes.
971      *
972      * Rule destruction must not fail. */
973     struct rule *(*rule_alloc)(void);
974     enum ofperr (*rule_construct)(struct rule *rule);
975     void (*rule_destruct)(struct rule *rule);
976     void (*rule_dealloc)(struct rule *rule);
977
978     /* Obtains statistics for 'rule', storing the number of packets that have
979      * matched it in '*packet_count' and the number of bytes in those packets
980      * in '*byte_count'.  UINT64_MAX indicates that the packet count or byte
981      * count is unknown. */
982     void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
983                            uint64_t *byte_count);
984
985     /* Applies the actions in 'rule' to 'packet'.  (This implements sending
986      * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
987      *
988      * Takes ownership of 'packet' (so it should eventually free it, with
989      * ofpbuf_delete()).
990      *
991      * 'flow' reflects the flow information for 'packet'.  All of the
992      * information in 'flow' is extracted from 'packet', except for
993      * flow->tunnel and flow->in_port, which are assigned the correct values
994      * for the incoming packet.  The register values are zeroed.  'packet''s
995      * header pointers (e.g. packet->l3) are appropriately initialized.
996      *
997      * The implementation should add the statistics for 'packet' into 'rule'.
998      *
999      * Returns 0 if successful, otherwise an OpenFlow error code. */
1000     enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1001                                 struct ofpbuf *packet);
1002
1003     /* When ->rule_modify_actions() is called, the caller has already replaced
1004      * the OpenFlow actions in 'rule' by a new set.  (The original actions are
1005      * in rule->pending->actions.)
1006      *
1007      * ->rule_modify_actions() should set the following in motion:
1008      *
1009      *   - Validate that the datapath can correctly implement the actions now
1010      *     in 'rule'.
1011      *
1012      *   - Update the datapath flow table with the new actions.
1013      *
1014      * If the operation synchronously completes, ->rule_modify_actions() may
1015      * call ofoperation_complete() before it returns.  Otherwise, ->run()
1016      * should call ofoperation_complete() later, after the operation does
1017      * complete.
1018      *
1019      * If the operation fails, then the base ofproto code will restore the
1020      * original 'actions' and 'n_actions' of 'rule'.
1021      *
1022      * ->rule_modify_actions() should not modify any base members of struct
1023      * rule. */
1024     void (*rule_modify_actions)(struct rule *rule);
1025
1026     /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1027      * which takes one of the following values, with the corresponding
1028      * meanings:
1029      *
1030      *  - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1031      *    as other packets, omitting TCP and UDP port numbers (always setting
1032      *    them to 0).
1033      *
1034      *  - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1035      *    passing them through the flow table.
1036      *
1037      *  - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1038      *    passing packets through the flow table.
1039      *
1040      *  - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1041      *    except that TCP and UDP port numbers should be included in fragments
1042      *    with offset 0.
1043      *
1044      * Implementations are not required to support every mode.
1045      * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1046      *
1047      * At the time of the call to ->set_frag_handling(), the current mode is
1048      * available in 'ofproto->frag_handling'.  ->set_frag_handling() returns
1049      * true if the requested mode was set, false if it is not supported.
1050      *
1051      * Upon successful return, the caller changes 'ofproto->frag_handling' to
1052      * reflect the new mode.
1053      */
1054     bool (*set_frag_handling)(struct ofproto *ofproto,
1055                               enum ofp_config_flags frag_handling);
1056
1057     /* Implements the OpenFlow OFPT_PACKET_OUT command.  The datapath should
1058      * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1059      *
1060      * The caller retains ownership of 'packet' and of 'ofpacts', so
1061      * ->packet_out() should not modify or free them.
1062      *
1063      * This function must validate that it can correctly implement 'ofpacts'.
1064      * If not, then it should return an OpenFlow error code.
1065      *
1066      * 'flow' reflects the flow information for 'packet'.  All of the
1067      * information in 'flow' is extracted from 'packet', except for
1068      * flow->in_port (see below).  flow->tunnel and its register values are
1069      * zeroed.
1070      *
1071      * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message.  The
1072      * implementation should reject invalid flow->in_port values by returning
1073      * OFPERR_OFPBRC_BAD_PORT.  (If the implementation called
1074      * ofproto_init_max_ports(), then the client will reject these ports
1075      * itself.)  For consistency, the implementation should consider valid for
1076      * flow->in_port any value that could possibly be seen in a packet that it
1077      * passes to connmgr_send_packet_in().  Ideally, even an implementation
1078      * that never generates packet-ins (e.g. due to hardware limitations)
1079      * should still allow flow->in_port values for every possible physical port
1080      * and OFPP_LOCAL.  The only virtual ports (those above OFPP_MAX) that the
1081      * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1082      * OFPP_NONE and OFPP_CONTROLLER.  The implementation should allow both of
1083      * these, treating each of them as packets generated by the controller as
1084      * opposed to packets originating from some switch port.
1085      *
1086      * (Ordinarily the only effect of flow->in_port is on output actions that
1087      * involve the input port, such as actions that output to OFPP_IN_PORT,
1088      * OFPP_FLOOD, or OFPP_ALL.  flow->in_port can also affect Nicira extension
1089      * "resubmit" actions.)
1090      *
1091      * 'packet' is not matched against the OpenFlow flow table, so its
1092      * statistics should not be included in OpenFlow flow statistics.
1093      *
1094      * Returns 0 if successful, otherwise an OpenFlow error code. */
1095     enum ofperr (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
1096                               const struct flow *flow,
1097                               const struct ofpact *ofpacts,
1098                               size_t ofpacts_len);
1099
1100 /* ## ------------------------- ## */
1101 /* ## OFPP_NORMAL configuration ## */
1102 /* ## ------------------------- ## */
1103
1104     /* Configures NetFlow on 'ofproto' according to the options in
1105      * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1106      *
1107      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1108      * NetFlow, as does a null pointer. */
1109     int (*set_netflow)(struct ofproto *ofproto,
1110                        const struct netflow_options *netflow_options);
1111
1112     void (*get_netflow_ids)(const struct ofproto *ofproto,
1113                             uint8_t *engine_type, uint8_t *engine_id);
1114
1115     /* Configures sFlow on 'ofproto' according to the options in
1116      * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1117      *
1118      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1119      * sFlow, as does a null pointer. */
1120     int (*set_sflow)(struct ofproto *ofproto,
1121                      const struct ofproto_sflow_options *sflow_options);
1122
1123     /* Configures IPFIX on 'ofproto' according to the options in
1124      * 'bridge_exporter_options' and the 'flow_exporters_options'
1125      * array, or turns off IPFIX if 'bridge_exporter_options' and
1126      * 'flow_exporters_options' is NULL.
1127      *
1128      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1129      * IPFIX, as does a null pointer. */
1130     int (*set_ipfix)(
1131         struct ofproto *ofproto,
1132         const struct ofproto_ipfix_bridge_exporter_options
1133             *bridge_exporter_options,
1134         const struct ofproto_ipfix_flow_exporter_options
1135             *flow_exporters_options, size_t n_flow_exporters_options);
1136
1137     /* Configures connectivity fault management on 'ofport'.
1138      *
1139      * If 'cfm_settings' is nonnull, configures CFM according to its members.
1140      *
1141      * If 'cfm_settings' is null, removes any connectivity fault management
1142      * configuration from 'ofport'.
1143      *
1144      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1145      * support CFM, as does a null pointer. */
1146     int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1147
1148     /* Checks the status of CFM configured on 'ofport'.  Returns true if the
1149      * port's CFM status was successfully stored into '*status'.  Returns false
1150      * if the port did not have CFM configured, in which case '*status' is
1151      * indeterminate.
1152      *
1153      * The caller must provide and owns '*status', but it does not own and must
1154      * not modify or free the array returned in 'status->rmps'. */
1155     bool (*get_cfm_status)(const struct ofport *ofport,
1156                            struct ofproto_cfm_status *status);
1157
1158     /* Configures BFD on 'ofport'.
1159      *
1160      * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1161      * "enable=true", removes BFD from 'ofport'.  Otherwise, configures BFD
1162      * according to 'cfg'.
1163      *
1164      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1165      * support BFD, as does a null pointer. */
1166     int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1167
1168     /* Populates 'smap' with the status of BFD on 'ofport'.  Returns 0 on
1169      * success, or a positive errno.  EOPNOTSUPP as a return value indicates
1170      * that this ofproto_class does not support BFD, as does a null pointer. */
1171     int (*get_bfd_status)(struct ofport *ofport, struct smap *smap);
1172
1173     /* Configures spanning tree protocol (STP) on 'ofproto' using the
1174      * settings defined in 's'.
1175      *
1176      * If 's' is nonnull, configures STP according to its members.
1177      *
1178      * If 's' is null, removes any STP configuration from 'ofproto'.
1179      *
1180      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1181      * support STP, as does a null pointer. */
1182     int (*set_stp)(struct ofproto *ofproto,
1183                    const struct ofproto_stp_settings *s);
1184
1185     /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1186      *
1187      * Stores STP state for 'ofproto' in 's'.  If the 'enabled' member
1188      * is false, the other member values are not meaningful.
1189      *
1190      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1191      * support STP, as does a null pointer. */
1192     int (*get_stp_status)(struct ofproto *ofproto,
1193                           struct ofproto_stp_status *s);
1194
1195     /* Configures spanning tree protocol (STP) on 'ofport' using the
1196      * settings defined in 's'.
1197      *
1198      * If 's' is nonnull, configures STP according to its members.  The
1199      * caller is responsible for assigning STP port numbers (using the
1200      * 'port_num' member in the range of 1 through 255, inclusive) and
1201      * ensuring there are no duplicates.
1202      *
1203      * If 's' is null, removes any STP configuration from 'ofport'.
1204      *
1205      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1206      * support STP, as does a null pointer. */
1207     int (*set_stp_port)(struct ofport *ofport,
1208                         const struct ofproto_port_stp_settings *s);
1209
1210     /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1211      *
1212      * Stores STP state for 'ofport' in 's'.  If the 'enabled' member is
1213      * false, the other member values are not meaningful.
1214      *
1215      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1216      * support STP, as does a null pointer. */
1217     int (*get_stp_port_status)(struct ofport *ofport,
1218                                struct ofproto_port_stp_status *s);
1219
1220     /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1221      * 'queues' attached to 'ofport'.  This data is not intended to be
1222      * sufficient to implement QoS.  Instead, providers may use this
1223      * information to implement features which require knowledge of what queues
1224      * exist on a port, and some basic information about them.
1225      *
1226      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1227      * support QoS, as does a null pointer. */
1228     int (*set_queues)(struct ofport *ofport,
1229                       const struct ofproto_port_queue *queues, size_t n_qdscp);
1230
1231     /* If 's' is nonnull, this function registers a "bundle" associated with
1232      * client data pointer 'aux' in 'ofproto'.  A bundle is the same concept as
1233      * a Port in OVSDB, that is, it consists of one or more "slave" devices
1234      * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1235      * there is more than one slave, a bonding configuration.  If 'aux' is
1236      * already registered then this function updates its configuration to 's'.
1237      * Otherwise, this function registers a new bundle.
1238      *
1239      * If 's' is NULL, this function unregisters the bundle registered on
1240      * 'ofproto' associated with client data pointer 'aux'.  If no such bundle
1241      * has been registered, this has no effect.
1242      *
1243      * This function affects only the behavior of the NXAST_AUTOPATH action and
1244      * output to the OFPP_NORMAL port.  An implementation that does not support
1245      * it at all may set it to NULL or return EOPNOTSUPP.  An implementation
1246      * that supports only a subset of the functionality should implement what
1247      * it can and return 0. */
1248     int (*bundle_set)(struct ofproto *ofproto, void *aux,
1249                       const struct ofproto_bundle_settings *s);
1250
1251     /* If 'port' is part of any bundle, removes it from that bundle.  If the
1252      * bundle now has no ports, deletes the bundle.  If the bundle now has only
1253      * one port, deconfigures the bundle's bonding configuration. */
1254     void (*bundle_remove)(struct ofport *ofport);
1255
1256     /* If 's' is nonnull, this function registers a mirror associated with
1257      * client data pointer 'aux' in 'ofproto'.  A mirror is the same concept as
1258      * a Mirror in OVSDB.  If 'aux' is already registered then this function
1259      * updates its configuration to 's'.  Otherwise, this function registers a
1260      * new mirror.
1261      *
1262      * If 's' is NULL, this function unregisters the mirror registered on
1263      * 'ofproto' associated with client data pointer 'aux'.  If no such mirror
1264      * has been registered, this has no effect.
1265      *
1266      * An implementation that does not support mirroring at all may set
1267      * it to NULL or return EOPNOTSUPP.  An implementation that supports
1268      * only a subset of the functionality should implement what it can
1269      * and return 0. */
1270     int (*mirror_set)(struct ofproto *ofproto, void *aux,
1271                       const struct ofproto_mirror_settings *s);
1272
1273     /* Retrieves statistics from mirror associated with client data
1274      * pointer 'aux' in 'ofproto'.  Stores packet and byte counts in
1275      * 'packets' and 'bytes', respectively.  If a particular counter is
1276      * not supported, the appropriate argument is set to UINT64_MAX.
1277      *
1278      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1279      * support retrieving mirror statistics. */
1280     int (*mirror_get_stats)(struct ofproto *ofproto, void *aux,
1281                             uint64_t *packets, uint64_t *bytes);
1282
1283     /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1284      * on which all packets are flooded, instead of using MAC learning.  If
1285      * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1286      *
1287      * This function affects only the behavior of the OFPP_NORMAL action.  An
1288      * implementation that does not support it may set it to NULL or return
1289      * EOPNOTSUPP. */
1290     int (*set_flood_vlans)(struct ofproto *ofproto,
1291                            unsigned long *flood_vlans);
1292
1293     /* Returns true if 'aux' is a registered bundle that is currently in use as
1294      * the output for a mirror. */
1295     bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1296
1297     /* When the configuration option of forward_bpdu changes, this function
1298      * will be invoked. */
1299     void (*forward_bpdu_changed)(struct ofproto *ofproto);
1300
1301     /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1302      * seconds, and the maximum number of MAC table entries to
1303      * 'max_entries'.
1304      *
1305      * An implementation that doesn't support configuring these features may
1306      * set this function to NULL or implement it as a no-op. */
1307     void (*set_mac_table_config)(struct ofproto *ofproto,
1308                                  unsigned int idle_time, size_t max_entries);
1309
1310 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1311  *
1312  * This is deprecated.  It is only for compatibility with broken device drivers
1313  * in old versions of Linux that do not properly support VLANs when VLAN
1314  * devices are not used.  When broken device drivers are no longer in
1315  * widespread use, we will delete these interfaces. */
1316
1317     /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1318      * as a VLAN splinter port for VLAN 'vid', associated with the real device
1319      * that has OpenFlow port number 'realdev_ofp_port'.
1320      *
1321      * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1322      * as a VLAN splinter port.
1323      *
1324      * This function should be NULL if a an implementation does not support
1325      * it. */
1326     int (*set_realdev)(struct ofport *ofport,
1327                        ofp_port_t realdev_ofp_port, int vid);
1328 };
1329
1330 extern const struct ofproto_class ofproto_dpif_class;
1331
1332 int ofproto_class_register(const struct ofproto_class *);
1333 int ofproto_class_unregister(const struct ofproto_class *);
1334
1335 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
1336  * because it overlaps with an ongoing flow table operation that has not yet
1337  * completed.  The caller should retry the operation later.
1338  *
1339  * ofproto.c also uses this value internally for additional (similar) purposes.
1340  *
1341  * This particular value is a good choice because it is large, so that it does
1342  * not collide with any errno value, but not large enough to collide with an
1343  * OFPERR_* value. */
1344 enum { OFPROTO_POSTPONE = 1 << 16 };
1345 BUILD_ASSERT_DECL(OFPROTO_POSTPONE < OFPERR_OFS);
1346
1347 int ofproto_flow_mod(struct ofproto *, const struct ofputil_flow_mod *);
1348 void ofproto_add_flow(struct ofproto *, const struct match *,
1349                       unsigned int priority,
1350                       const struct ofpact *ofpacts, size_t ofpacts_len);
1351 bool ofproto_delete_flow(struct ofproto *,
1352                          const struct match *, unsigned int priority);
1353 void ofproto_flush_flows(struct ofproto *);
1354
1355 #endif /* ofproto/ofproto-provider.h */